debugger: overhaul "state machine"

This mainly allows for more precise shutdown and tightens the set
of allowed transitions.

src/plugins/debugger/cdb/cdbengine.h

@@ -55,12 +55,12 @@ public:
     static DebuggerEngine *create(const DebuggerStartParameters &sp,
                                    QString *errorMessage);
 
-    virtual void shutdown();
     virtual void setToolTipExpression(const QPoint &mousePos, TextEditor::ITextEditor *editor, int cursorPos);
     virtual void setupEngine();
     virtual void setupInferior();
     virtual void runEngine();
-    virtual void exitDebugger();
+    virtual void shutdownInferior();
+    virtual void shutdownEngine();
     virtual void detachDebugger();
     virtual void updateWatchData(const WatchData &data);
     virtual unsigned debuggerCapabilities() const;

src/plugins/debugger/debuggerconstants.h

@@ -79,29 +79,34 @@ enum DebuggerState
 {
     DebuggerNotReady,          // Debugger not started
 
-    EngineSettingUp,            // Engine starts
+    EngineSetupRequested,      // Engine starts
     EngineSetupFailed,
     EngineSetupOk,
 
-    InferiorUnrunnable,         // Used in the core dump adapter
-    InferiorSettingUp,
+    InferiorSetupRequested,
     InferiorSetupFailed,
-    InferiorSetupOk,
 
-    InferiorRunningRequested,   // Debuggee requested to run
-    InferiorRunningRequested_Kill, // Debuggee requested to run, but want to kill it
-    InferiorRunning,            // Debuggee running
+    EngineRunRequested,
+    EngineRunFailed,
+    InferiorUnrunnable,        // Used in the core dump adapter
 
-    InferiorStopping,           // Debuggee running, stop requested
-    InferiorStopping_Kill,      // Debuggee running, stop requested, want to kill it
-    InferiorStopped,            // Debuggee stopped
-    InferiorStopFailed,         // Debuggee not stopped, will kill debugger
+    InferiorRunRequested,      // Debuggee requested to run
+    InferiorRunOk,             // Debuggee running
+    InferiorRunFailed,         // Debuggee running
 
-    InferiorShuttingDown,
-    InferiorShutDown,
+    InferiorStopRequested,     // Debuggee running, stop requested
+    InferiorStopOk,            // Debuggee stopped
+    InferiorStopFailed,        // Debuggee not stopped, will kill debugger
+
+    InferiorShutdownRequested,
+    InferiorShutdownOk,
     InferiorShutdownFailed,
 
-    EngineShuttingDown
+    EngineShutdownRequested,
+    EngineShutdownOk,
+    EngineShutdownFailed,
+
+    DebuggerFinished
 };
 
 enum DebuggerStartMode
@@ -139,21 +144,21 @@ enum LogChannel
 {
     LogInput,                // Used for user input
     LogMiscInput,            // Used for misc stuff in the input pane
-    LogOutput,               
-    LogWarning,              
-    LogError,                
+    LogOutput,
+    LogWarning,
+    LogError,
     LogStatus,               // Used for status changed messages
     LogTime,                 // Used for time stamp messages
-    LogDebug,                
-    LogMisc,                 
-    AppOutput,               
-    AppError,                
+    LogDebug,
+    LogMisc,
+    AppOutput,
+    AppError,
     AppStuff,
     StatusBar                // LogStatus and also put to the status bar
-};                           
-                             
-enum ModelRoles              
-{                            
+};
+
+enum ModelRoles
+{
     DisplaySourceRole = 32,  // Qt::UserRole
 
     EngineStateRole,

src/plugins/debugger/debuggerengine.h

@@ -121,7 +121,6 @@ public:
     DebuggerEngine(const DebuggerStartParameters &sp);
     virtual ~DebuggerEngine();
 
-    virtual void shutdown() {}
     virtual void setToolTipExpression(const QPoint & /* mousePos */,
             TextEditor::ITextEditor * /* editor */, int /* cursorPos */) { }
     void initializeFromTemplate(DebuggerEngine *other);
@@ -164,8 +163,6 @@ public:
         { Q_UNUSED(expr); Q_UNUSED(value); }
 
 protected:
-    virtual void setupEngine() {}
-    virtual void exitDebugger() {}
     virtual void detachDebugger() {}
     virtual void executeStep() {}
     virtual void executeStepOut()  {}
@@ -229,6 +226,9 @@ public:
     void executeReturnX();
 
     DebuggerState state() const;
+    DebuggerState lastGoodState() const;
+    DebuggerState targetState() const;
+    bool isDying() const { return targetState() == DebuggerFinished; }
 
     // Dumper stuff (common to cdb and gdb).
     bool qtDumperLibraryEnabled() const;
@@ -251,24 +251,46 @@ public:
     void openFile(const QString &fileName, int lineNumber = -1);
     void gotoLocation(const QString &fileName, int lineNumber, bool setMarker);
     void gotoLocation(const StackFrame &frame, bool setMarker);
-    void raiseApplication();
-    virtual void quitDebugger() { exitDebugger(); } // called by DebuggerRunControl
+    Q_SLOT void raiseApplication();
+    virtual void quitDebugger(); // called by DebuggerRunControl
 
 protected:
     void notifyEngineSetupOk();
     void notifyEngineSetupFailed();
+    void notifyEngineRunFailed();
 
     void notifyInferiorSetupOk();
     void notifyInferiorSetupFailed();
 
-    void notifyInferiorRunning();
-    void notifyInferiorStopped();
+    void notifyEngineRunAndInferiorRunOk();
+    void notifyEngineRunAndInferiorStopOk();
+    void notifyInferiorUnrunnable(); // Called by CoreAdapter.
+    //void notifyInferiorSpontaneousRun();
+
+    void notifyInferiorRunRequested();
+    void notifyInferiorRunOk();
+    void notifyInferiorRunFailed();
+
+    void notifyInferiorStopOk();
+    void notifyInferiorSpontaneousStop();
+    void notifyInferiorStopFailed();
+    void notifyInferiorExited();
+
+    void notifyInferiorShutdownOk();
+    void notifyInferiorShutdownFailed();
+
+    void notifyEngineSpontaneousShutdown();
+    void notifyEngineShutdownOk();
+    void notifyEngineShutdownFailed();
 
-    // Called to initiate shutdown.
     void notifyInferiorIll();
+    void notifyEngineIll();
 
-    virtual void setupInferior();
-    virtual void runEngine();
+    virtual void setupEngine() = 0;
+    virtual void setupInferior() = 0;
+    virtual void runEngine() = 0;
+    virtual void shutdownInferior() = 0;
+    virtual void shutdownEngine() = 0;
 
 //private: // FIXME. State transitions 
     void setState(DebuggerState state, bool forced = false);

src/plugins/debugger/gdb/abstractgdbadapter.cpp

@@ -39,7 +39,7 @@ namespace Debugger {
 namespace Internal {
 
 AbstractGdbAdapter::AbstractGdbAdapter(GdbEngine *engine, QObject *parent)
-        : QObject(parent), m_engine(engine)
+  : QObject(parent), m_engine(engine)
 {
 }
 
@@ -48,19 +48,20 @@ AbstractGdbAdapter::~AbstractGdbAdapter()
     disconnect();
 }
 
-void AbstractGdbAdapter::shutdown()
-{
-}
+//void AbstractGdbAdapter::shutdown()
+//{
+//}
 
-void AbstractGdbAdapter::runAdapter()
-{
-    qDebug() << "START INFERIOR PHASE 2";
-}
+//void AbstractGdbAdapter::runEngine()
+//{
+//}
 
+/*
 const char *AbstractGdbAdapter::inferiorShutdownCommand() const
 {
     return "kill";
 }
+*/
 
 void AbstractGdbAdapter::write(const QByteArray &data)
 {
@@ -87,7 +88,7 @@ QString AbstractGdbAdapter::msgInferiorSetupOk()
     return tr("Application started");
 }
 
-QString AbstractGdbAdapter::msgInferiorRunning()
+QString AbstractGdbAdapter::msgInferiorRunOk()
 {
     return tr("Application running");
 }

src/plugins/debugger/gdb/abstractgdbadapter.h

@@ -65,10 +65,11 @@ public:
 
     virtual void startAdapter() = 0;
     virtual void setupInferior() = 0;
-    virtual void runAdapter();
+    virtual void runEngine() = 0;
     virtual void interruptInferior() = 0;
-    virtual void shutdown();
-    virtual const char *inferiorShutdownCommand() const;
+    virtual void shutdownInferior() = 0;
+    virtual void shutdownAdapter() = 0;
+    //virtual const char *inferiorShutdownCommand() const;
     virtual AbstractGdbProcess *gdbProc() = 0;
 
     virtual DumperHandling dumperHandling() const = 0;
@@ -77,7 +78,7 @@ public:
     static QString msgInferiorStopFailed(const QString &why);
     static QString msgAttachedToStoppedInferior();
     static QString msgInferiorSetupOk();
-    static QString msgInferiorRunning();
+    static QString msgInferiorRunOk();
     static QString msgConnectRemoteServerFailed(const QString &why);
 
     // Trk specific stuff

src/plugins/debugger/gdb/abstractplaingdbadapter.cpp

@@ -49,7 +49,7 @@ AbstractPlainGdbAdapter::AbstractPlainGdbAdapter(GdbEngine *engine,
 
 void AbstractPlainGdbAdapter::setupInferior()
 {
-    QTC_ASSERT(state() == InferiorSettingUp, qDebug() << state());
+    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
     if (!startParameters().processArgs.isEmpty()) {
         QString args = startParameters().processArgs.join(_(" "));
         m_engine->postCommand("-exec-arguments " + toLocalEncoding(args));
@@ -60,7 +60,7 @@ void AbstractPlainGdbAdapter::setupInferior()
 
 void AbstractPlainGdbAdapter::handleFileExecAndSymbols(const GdbResponse &response)
 {
-    QTC_ASSERT(state() == InferiorSettingUp, qDebug() << state());
+    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
     if (response.resultClass == GdbResultDone) {
         if (infoTargetNecessary()) {
             // Old gdbs do not announce the PID for programs without pthreads.
@@ -76,31 +76,33 @@ void AbstractPlainGdbAdapter::handleFileExecAndSymbols(const GdbResponse &respon
         // Extend the message a bit in unknown cases.
         if (!ba.endsWith("File format not recognized"))
             msg = tr("Starting executable failed:\n") + msg;
-        m_engine->handleInferiorSetupFailed(msg);
+        m_engine->notifyInferiorSetupFailed(msg);
     }
 }
 
-void AbstractPlainGdbAdapter::runAdapter()
+void AbstractPlainGdbAdapter::runEngine()
 {
-    setState(InferiorRunningRequested);
+    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
     m_engine->postCommand("-exec-run", GdbEngine::RunRequest, CB(handleExecRun));
 }
 
 void AbstractPlainGdbAdapter::handleExecRun(const GdbResponse &response)
 {
+    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
     if (response.resultClass == GdbResultRunning) {
-        QTC_ASSERT(state() == InferiorRunning, qDebug() << state());
+        m_engine->notifyEngineRunAndInferiorRunOk();
+        //showStatusMessage(tr("Running..."));
         showMessage(_("INFERIOR STARTED"));
         showMessage(msgInferiorSetupOk(), StatusBar);
         // FIXME: That's the wrong place for it.
         if (theDebuggerBoolSetting(EnableReverseDebugging))
             m_engine->postCommand("target record");
     } else {
-        QTC_ASSERT(state() == InferiorRunningRequested, qDebug() << state());
         QString msg = fromLocalEncoding(response.data.findChild("msg").data());
-        //QTC_ASSERT(status() == InferiorRunning, /**/);
+        //QTC_ASSERT(status() == InferiorRunOk, /**/);
         //interruptInferior();
-        m_engine->handleInferiorSetupFailed(msg);
+        showMessage(msg);
+        m_engine->notifyEngineRunFailed();
     }
 }
 
@@ -118,10 +120,10 @@ void AbstractPlainGdbAdapter::handleInfoTarget(const GdbResponse &response)
             m_engine->postCommand("tbreak *0x" + needle.cap(1).toAscii());
             // Do nothing here - inferiorPrepared handles the sequencing.
         } else {
-            m_engine->handleInferiorSetupFailed(_("Parsing start address failed"));
+            m_engine->notifyInferiorSetupFailed(_("Parsing start address failed"));
         }
     } else if (response.resultClass == GdbResultError) {
-        m_engine->handleInferiorSetupFailed(_("Fetching start address failed"));
+        m_engine->notifyInferiorSetupFailed(_("Fetching start address failed"));
     }
 }
 

src/plugins/debugger/gdb/abstractplaingdbadapter.h

@@ -36,13 +36,15 @@ namespace Debugger {
 namespace Internal {
 
 class AbstractPlainGdbAdapter : public AbstractGdbAdapter
-{   // Needs tr - context
+{
+    // Needs tr - context
     Q_OBJECT
+
 public:
     AbstractPlainGdbAdapter(GdbEngine *engine, QObject *parent = 0);
 
-    virtual void setupInferior();
-    virtual void runAdapter();
+    void setupInferior();
+    void runEngine();
 
 protected:
     void handleInfoTarget(const GdbResponse &response);

src/plugins/debugger/gdb/attachgdbadapter.cpp

@@ -56,7 +56,7 @@ AttachGdbAdapter::AttachGdbAdapter(GdbEngine *engine, QObject *parent)
 
 void AttachGdbAdapter::startAdapter()
 {
-    QTC_ASSERT(state() == EngineSettingUp, qDebug() << state());
+    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << state());
     showMessage(_("TRYING TO START ADAPTER"));
 
     if (!m_engine->startGdb())
@@ -67,34 +67,52 @@ void AttachGdbAdapter::startAdapter()
 
 void AttachGdbAdapter::setupInferior()
 {
-    QTC_ASSERT(state() == InferiorSettingUp, qDebug() << state());
+    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
     const qint64 pid = startParameters().attachPID;
     m_engine->postCommand("attach " + QByteArray::number(pid), CB(handleAttach));
     // Task 254674 does not want to remove them
     //qq->breakHandler()->removeAllBreakpoints();
 }
 
+void AttachGdbAdapter::runEngine()
+{
+    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
+    m_engine->notifyInferiorStopOk();
+}
+
 void AttachGdbAdapter::handleAttach(const GdbResponse &response)
 {
-    QTC_ASSERT(state() == InferiorSettingUp, qDebug() << state());
+    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
     if (response.resultClass == GdbResultDone) {
-        setState(InferiorStopped);
         showMessage(_("INFERIOR ATTACHED"));
         showMessage(msgAttachedToStoppedInferior(), StatusBar);
         m_engine->handleInferiorPrepared();
         m_engine->updateAll();
     } else {
         QString msg = QString::fromLocal8Bit(response.data.findChild("msg").data());
-        m_engine->handleInferiorSetupFailed(msg);
+        m_engine->notifyInferiorSetupFailed(msg);
     }
 }
 
 void AttachGdbAdapter::interruptInferior()
 {
+    QTC_ASSERT(state() == InferiorStopRequested, qDebug() << state(); return);
     const qint64 pid = startParameters().attachPID;
     QTC_ASSERT(pid > 0, return);
-    if (!interruptProcess(pid))
+    if (!interruptProcess(pid)) {
         showMessage(_("CANNOT INTERRUPT %1").arg(pid));
+        m_engine->notifyInferiorStopFailed();
+    }
+}
+
+void AttachGdbAdapter::shutdownInferior()
+{
+    m_engine->defaultInferiorShutdown("detach");
+}
+
+void AttachGdbAdapter::shutdownAdapter()
+{
+    m_engine->notifyAdapterShutdownOk();
 }
 
 } // namespace Internal

src/plugins/debugger/gdb/attachgdbadapter.h

@@ -50,15 +50,17 @@ class AttachGdbAdapter : public AbstractGdbAdapter
 public:
     AttachGdbAdapter(GdbEngine *engine, QObject *parent = 0);
 
-    virtual DumperHandling dumperHandling() const { return DumperLoadedByGdb; }
+private:
+    DumperHandling dumperHandling() const { return DumperLoadedByGdb; }
 
     void startAdapter();
     void setupInferior();
+    void runEngine();
     void interruptInferior();
-    const char *inferiorShutdownCommand() const { return "detach"; }
-    AbstractGdbProcess *gdbProc() { return &m_gdbProc; }
+    void shutdownInferior();
+    void shutdownAdapter();
 
-private:
+    AbstractGdbProcess *gdbProc() { return &m_gdbProc; }
     void handleAttach(const GdbResponse &response);
 
     LocalGdbProcess m_gdbProc;

src/plugins/debugger/gdb/classicgdbengine.cpp

@@ -574,7 +574,7 @@ void GdbEngine::updateAllClassic()
 {
     PRECONDITION;
     PENDING_DEBUG("UPDATING ALL\n");
-    QTC_ASSERT(state() == InferiorUnrunnable || state() == InferiorStopped, /**/);
+    QTC_ASSERT(state() == InferiorUnrunnable || state() == InferiorStopOk, /**/);
     tryLoadDebuggingHelpersClassic();
     reloadModulesInternal();
     postCommand("-stack-list-frames", WatchUpdate,

src/plugins/debugger/gdb/coregdbadapter.cpp

@@ -59,7 +59,7 @@ CoreGdbAdapter::CoreGdbAdapter(GdbEngine *engine, QObject *parent)
 
 void CoreGdbAdapter::startAdapter()
 {
-    QTC_ASSERT(state() == EngineSettingUp, qDebug() << state());
+    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << state());