debuggerengine.cpp 38.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/

#include "debuggerengine.h"

#include "debuggeractions.h"
#include "debuggeragents.h"
34
#include "debuggercore.h"
35
#include "debuggerplugin.h"
36
#include "debuggerrunner.h"
37
#include "debuggerstringutils.h"
38
#include "debuggertooltip.h"
39 40 41 42 43 44 45 46 47 48

#include "breakhandler.h"
#include "moduleshandler.h"
#include "registerhandler.h"
#include "snapshothandler.h"
#include "sourcefileshandler.h"
#include "stackhandler.h"
#include "threadshandler.h"
#include "watchhandler.h"

hjk's avatar
hjk committed
49
#include <coreplugin/icore.h>
50
#include <coreplugin/ifile.h>
51 52
#include <coreplugin/progressmanager/progressmanager.h>
#include <coreplugin/progressmanager/futureprogress.h>
hjk's avatar
hjk committed
53

54
#include <projectexplorer/toolchaintype.h>
55

hjk's avatar
hjk committed
56 57
#include <texteditor/itexteditor.h>

58
#include <utils/environment.h>
59 60 61 62 63
#include <utils/savedaction.h>
#include <utils/qtcassert.h>

#include <QtCore/QDebug>
#include <QtCore/QTimer>
64
#include <QtCore/QFutureInterface>
65 66 67 68 69

#include <QtGui/QStandardItemModel>
#include <QtGui/QAction>
#include <QtGui/QTreeWidget>

hjk's avatar
hjk committed
70
using namespace Core;
71 72
using namespace Debugger;
using namespace Debugger::Internal;
hjk's avatar
hjk committed
73 74
using namespace ProjectExplorer;
using namespace TextEditor;
75

hjk's avatar
hjk committed
76 77 78 79 80 81 82
//#define DEBUG_STATE 1
#if DEBUG_STATE
#   define SDEBUG(s) qDebug() << s
#else
#   define SDEBUG(s)
#endif
# define XSDEBUG(s) qDebug() << s
83

84

85 86 87 88 89 90
///////////////////////////////////////////////////////////////////////
//
// DebuggerStartParameters
//
///////////////////////////////////////////////////////////////////////

91 92
namespace Debugger {

93
DebuggerStartParameters::DebuggerStartParameters() :
94
    isSnapshot(false),
95 96
    attachPID(-1),
    useTerminal(false),
97 98
    breakAtMain(false),
    qmlServerAddress("127.0.0.1"),
99
    qmlServerPort(0),
hjk's avatar
hjk committed
100
    useServerStartScript(false),
101
    connParams(SshConnectionParameters::NoProxy),
102
    toolChainType(ToolChain_UNKNOWN),
103 104
    startMode(NoStartMode),
    executableUid(0)
105 106 107 108 109 110 111 112 113
{}

void DebuggerStartParameters::clear()
{
    *this = DebuggerStartParameters();
}

QDebug operator<<(QDebug d, DebuggerState state)
{
hjk's avatar
hjk committed
114 115
    //return d << DebuggerEngine::stateName(state) << '(' << int(state) << ')';
    return d << DebuggerEngine::stateName(state);
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
}

QDebug operator<<(QDebug str, const DebuggerStartParameters &sp)
{
    QDebug nospace = str.nospace();
    const QString sep = QString(QLatin1Char(','));
    nospace << "executable=" << sp.executable
            << " coreFile=" << sp.coreFile
            << " processArgs=" << sp.processArgs.join(sep)
            << " environment=<" << sp.environment.size() << " variables>"
            << " workingDir=" << sp.workingDirectory
            << " attachPID=" << sp.attachPID
            << " useTerminal=" << sp.useTerminal
            << " remoteChannel=" << sp.remoteChannel
            << " remoteArchitecture=" << sp.remoteArchitecture
            << " symbolFileName=" << sp.symbolFileName
hjk's avatar
hjk committed
132
            << " useServerStartScript=" << sp.useServerStartScript
133 134 135 136 137 138 139 140 141 142
            << " serverStartScript=" << sp.serverStartScript
            << " toolchain=" << sp.toolChainType << '\n';
    return str;
}

const char *DebuggerEngine::stateName(int s)
{
#    define SN(x) case x: return #x;
    switch (s) {
        SN(DebuggerNotReady)
hjk's avatar
hjk committed
143
        SN(EngineSetupRequested)
144 145
        SN(EngineSetupOk)
        SN(EngineSetupFailed)
hjk's avatar
hjk committed
146 147
        SN(EngineRunFailed)
        SN(InferiorSetupRequested)
hjk's avatar
hjk committed
148
        SN(InferiorSetupFailed)
hjk's avatar
hjk committed
149 150 151 152
        SN(EngineRunRequested)
        SN(InferiorRunRequested)
        SN(InferiorRunOk)
        SN(InferiorRunFailed)
153
        SN(InferiorUnrunnable)
hjk's avatar
hjk committed
154 155
        SN(InferiorStopRequested)
        SN(InferiorStopOk)
156
        SN(InferiorStopFailed)
hjk's avatar
hjk committed
157 158
        SN(InferiorShutdownRequested)
        SN(InferiorShutdownOk)
159
        SN(InferiorShutdownFailed)
hjk's avatar
hjk committed
160 161 162 163
        SN(EngineShutdownRequested)
        SN(EngineShutdownOk)
        SN(EngineShutdownFailed)
        SN(DebuggerFinished)
164 165 166 167 168
    }
    return "<unknown>";
#    undef SN
}

169

170 171 172 173 174 175
//////////////////////////////////////////////////////////////////////
//
// DebuggerEnginePrivate
//
//////////////////////////////////////////////////////////////////////

176
class DebuggerEnginePrivate : public QObject
177
{
178 179
    Q_OBJECT

180 181 182 183
public:
    DebuggerEnginePrivate(DebuggerEngine *engine, const DebuggerStartParameters &sp)
      : m_engine(engine),
        m_runControl(0),
184
        m_isActive(false),
185 186
        m_startParameters(sp),
        m_state(DebuggerNotReady),
hjk's avatar
hjk committed
187
        m_lastGoodState(DebuggerNotReady),
Friedemann Kleint's avatar
Friedemann Kleint committed
188
        m_targetState(DebuggerNotReady),
189
        m_modulesHandler(),
190
        m_registerHandler(),
191 192
        m_sourceFilesHandler(),
        m_stackHandler(),
hjk's avatar
hjk committed
193
        m_threadsHandler(),
194
        m_watchHandler(engine),
195
        m_disassemblerViewAgent(engine),
196
        m_isSlaveEngine(false)
197
    {}
198 199

    ~DebuggerEnginePrivate() {}
200

201
public slots:
hjk's avatar
hjk committed
202 203
    void doSetupInferior();
    void doRunEngine();
hjk's avatar
hjk committed
204 205
    void doShutdownEngine();
    void doShutdownInferior();
206
    void doInterruptInferior();
hjk's avatar
hjk committed
207
    void doFinishDebugger();
hjk's avatar
hjk committed
208

209 210
    void queueRunEngine()
    {
hjk's avatar
hjk committed
211 212 213 214 215
        m_engine->setState(EngineRunRequested);
        m_engine->showMessage(_("QUEUE: RUN ENGINE"));
        QTimer::singleShot(0, this, SLOT(doRunEngine()));
    }

216 217
    void queueShutdownEngine()
    {
hjk's avatar
hjk committed
218 219 220 221 222
        m_engine->setState(EngineShutdownRequested);
        m_engine->showMessage(_("QUEUE: SHUTDOWN ENGINE"));
        QTimer::singleShot(0, this, SLOT(doShutdownEngine()));
    }

223 224
    void queueShutdownInferior()
    {
hjk's avatar
hjk committed
225 226 227 228 229
        m_engine->setState(InferiorShutdownRequested);
        m_engine->showMessage(_("QUEUE: SHUTDOWN INFERIOR"));
        QTimer::singleShot(0, this, SLOT(doShutdownInferior()));
    }

230 231
    void queueFinishDebugger()
    {
232 233 234 235
        QTC_ASSERT(state() == EngineShutdownOk
            || state() == EngineShutdownFailed, qDebug() << state());
        m_engine->setState(DebuggerFinished);
        m_engine->showMessage(_("QUEUE: FINISH DEBUGGER"));
hjk's avatar
hjk committed
236 237 238
        QTimer::singleShot(0, this, SLOT(doFinishDebugger()));
    }

239 240
    void raiseApplication()
    {
hjk's avatar
hjk committed
241
        QTC_ASSERT(m_runControl, return);
242 243 244
        m_runControl->bringApplicationToForeground(m_inferiorPid);
    }

245
public:
hjk's avatar
hjk committed
246 247
    DebuggerState state() const { return m_state; }

248 249
    DebuggerEngine *m_engine; // Not owned.
    DebuggerRunControl *m_runControl;  // Not owned.
250
    bool m_isActive;
251 252

    DebuggerStartParameters m_startParameters;
hjk's avatar
hjk committed
253 254

    // The current state.
255 256
    DebuggerState m_state;

hjk's avatar
hjk committed
257 258 259 260 261 262
    // The state we had before something unexpected happend.
    DebuggerState m_lastGoodState;

    // The state we are aiming for.
    DebuggerState m_targetState;

263 264 265 266 267 268 269 270 271
    qint64 m_inferiorPid;

    ModulesHandler m_modulesHandler;
    RegisterHandler m_registerHandler;
    SourceFilesHandler m_sourceFilesHandler;
    StackHandler m_stackHandler;
    ThreadsHandler m_threadsHandler;
    WatchHandler m_watchHandler;
    DisassemblerViewAgent m_disassemblerViewAgent;
272
    QFutureInterface<void> m_progress;
273

274
    bool m_isSlaveEngine;
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
};


//////////////////////////////////////////////////////////////////////
//
// DebuggerEngine
//
//////////////////////////////////////////////////////////////////////

DebuggerEngine::DebuggerEngine(const DebuggerStartParameters &startParameters)
  : d(new DebuggerEnginePrivate(this, startParameters))
{
}

DebuggerEngine::~DebuggerEngine()
{
291 292
    disconnect();
    delete d;
293 294
}

295
void DebuggerEngine::showStatusMessage(const QString &msg, int timeout) const
296
{
297
    showMessage(msg, StatusBar, timeout);
298
}
299

300 301 302 303 304 305
void DebuggerEngine::removeTooltip()
{
    watchHandler()->removeTooltip();
    hideDebuggerToolTip();
}

306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
void DebuggerEngine::showModuleSymbols
    (const QString &moduleName, const Symbols &symbols)
{
    QTreeWidget *w = new QTreeWidget;
    w->setColumnCount(3);
    w->setRootIsDecorated(false);
    w->setAlternatingRowColors(true);
    w->setSortingEnabled(true);
    w->setHeaderLabels(QStringList() << tr("Symbol") << tr("Address") << tr("Code"));
    w->setWindowTitle(tr("Symbols in \"%1\"").arg(moduleName));
    foreach (const Symbol &s, symbols) {
        QTreeWidgetItem *it = new QTreeWidgetItem;
        it->setData(0, Qt::DisplayRole, s.name);
        it->setData(1, Qt::DisplayRole, s.address);
        it->setData(2, Qt::DisplayRole, s.state);
        w->addTopLevelItem(it);
    }
323
    debuggerCore()->createNewDock(w);
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
}

void DebuggerEngine::frameUp()
{
    int currentIndex = stackHandler()->currentIndex();
    activateFrame(qMin(currentIndex + 1, stackHandler()->stackSize() - 1));
}

void DebuggerEngine::frameDown()
{
    int currentIndex = stackHandler()->currentIndex();
    activateFrame(qMax(currentIndex - 1, 0));
}

ModulesHandler *DebuggerEngine::modulesHandler() const
{
    return &d->m_modulesHandler;
}

RegisterHandler *DebuggerEngine::registerHandler() const
{
    return &d->m_registerHandler;
}

StackHandler *DebuggerEngine::stackHandler() const
{
    return &d->m_stackHandler;
}

ThreadsHandler *DebuggerEngine::threadsHandler() const
{
    return &d->m_threadsHandler;
}

WatchHandler *DebuggerEngine::watchHandler() const
{
    return &d->m_watchHandler;
}

363 364 365 366
//SnapshotHandler *DebuggerEngine::snapshotHandler() const
//{
//    return &d->m_snapshotHandler;
//}
367 368 369 370 371 372 373 374

SourceFilesHandler *DebuggerEngine::sourceFilesHandler() const
{
    return &d->m_sourceFilesHandler;
}

QAbstractItemModel *DebuggerEngine::modulesModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
375 376 377 378
    QAbstractItemModel *model = d->m_modulesHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("ModulesModel"));
    return model;
379 380 381 382
}

QAbstractItemModel *DebuggerEngine::registerModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
383 384 385 386
    QAbstractItemModel *model = d->m_registerHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("RegisterModel"));
    return model;
387 388 389 390
}

QAbstractItemModel *DebuggerEngine::stackModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
391 392 393 394
    QAbstractItemModel *model = d->m_stackHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("StackModel"));
    return model;
395 396 397 398
}

QAbstractItemModel *DebuggerEngine::threadsModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
399 400 401 402
    QAbstractItemModel *model = d->m_threadsHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("ThreadsModel"));
    return model;
403 404 405 406
}

QAbstractItemModel *DebuggerEngine::localsModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
407 408 409 410
    QAbstractItemModel *model = d->m_watchHandler.model(LocalsWatch);
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("LocalsModel"));
    return model;
411 412 413 414
}

QAbstractItemModel *DebuggerEngine::watchersModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
415 416 417 418
    QAbstractItemModel *model = d->m_watchHandler.model(WatchersWatch);
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("WatchersModel"));
    return model;
419 420 421 422
}

QAbstractItemModel *DebuggerEngine::returnModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
423 424 425 426
    QAbstractItemModel *model = d->m_watchHandler.model(ReturnWatch);
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("ReturnModel"));
    return model;
427 428 429 430
}

QAbstractItemModel *DebuggerEngine::sourceFilesModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
431 432 433 434
    QAbstractItemModel *model = d->m_sourceFilesHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("SourceFilesModel"));
    return model;
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
}

void DebuggerEngine::fetchMemory(MemoryViewAgent *, QObject *,
        quint64 addr, quint64 length)
{
    Q_UNUSED(addr);
    Q_UNUSED(length);
}

void DebuggerEngine::setRegisterValue(int regnr, const QString &value)
{
    Q_UNUSED(regnr);
    Q_UNUSED(value);
}

void DebuggerEngine::showMessage(const QString &msg, int channel, int timeout) const
{
452 453
    //if (msg.size() && msg.at(0).isUpper() && msg.at(1).isUpper())
    //    qDebug() << qPrintable(msg) << "IN STATE" << state();
454
    debuggerCore()->showMessage(msg, channel, timeout);
455 456 457 458 459
    if (d->m_runControl) {
        d->m_runControl->showMessage(msg, channel);
    } else {
        qWarning("Warning: %s (no active run control)", qPrintable(msg));
    }
460 461 462 463
}

void DebuggerEngine::startDebugger(DebuggerRunControl *runControl)
{
hjk's avatar
hjk committed
464
    if (!isSlaveEngine()) {
465
        d->m_progress.setProgressRange(0, 1000);
466 467 468
        Core::FutureProgress *fp = Core::ICore::instance()->progressManager()
            ->addTask(d->m_progress.future(),
            tr("Launching"), _("Debugger.Launcher"));
469
        fp->setKeepOnFinish(Core::FutureProgress::DontKeepOnFinish);
470 471
        d->m_progress.reportStarted();
    }
472 473
    QTC_ASSERT(runControl, notifyEngineSetupFailed(); return);
    QTC_ASSERT(!d->m_runControl, notifyEngineSetupFailed(); return);
474 475 476 477 478 479 480

    d->m_runControl = runControl;

    d->m_inferiorPid = d->m_startParameters.attachPID > 0
        ? d->m_startParameters.attachPID : 0;

    if (d->m_startParameters.environment.empty())
481
        d->m_startParameters.environment = Utils::Environment().toStringList();
482 483 484 485 486

    if (d->m_startParameters.breakAtMain)
        breakByFunctionMain();

    const unsigned engineCapabilities = debuggerCapabilities();
hjk's avatar
hjk committed
487
    debuggerCore()->action(OperateByInstruction)
488 489
        ->setEnabled(engineCapabilities & DisassemblerCapability);

490 491
    QTC_ASSERT(state() == DebuggerNotReady || state() == DebuggerFinished,
         qDebug() << state());
hjk's avatar
hjk committed
492
    setState(EngineSetupRequested);
493

494
    d->m_progress.setProgressValue(200);
hjk's avatar
hjk committed
495
    setupEngine();
496 497 498 499 500 501 502 503 504 505 506 507 508 509
}

void DebuggerEngine::breakByFunctionMain()
{
#ifdef Q_OS_WIN
    // FIXME: wrong on non-Qt based binaries
    emit breakByFunction("qMain");
#else
    emit breakByFunction("main");
#endif
}

void DebuggerEngine::breakByFunction(const QString &functionName)
{
510
    breakHandler()->breakByFunction(functionName);
511 512 513 514 515 516
}

void DebuggerEngine::resetLocation()
{
    d->m_disassemblerViewAgent.resetLocation();
    d->m_stackHandler.setCurrentIndex(-1);
517
    debuggerCore()->removeLocationMark();
518 519 520 521 522 523 524 525 526 527 528 529
}

void DebuggerEngine::gotoLocation(const QString &fileName, int lineNumber, bool setMarker)
{
    StackFrame frame;
    frame.file = fileName;
    frame.line = lineNumber;
    gotoLocation(frame, setMarker);
}

void DebuggerEngine::gotoLocation(const StackFrame &frame, bool setMarker)
{
hjk's avatar
hjk committed
530
    if (debuggerCore()->boolSetting(OperateByInstruction) || !frame.isUsable()) {
531
        if (setMarker)
532
            resetLocation();
533 534
        d->m_disassemblerViewAgent.setFrame(frame);
    } else {
535
        debuggerCore()->gotoLocation(frame.file, frame.line, setMarker);
536 537 538
    }
}

539 540 541
// Called from RunControl.
void DebuggerEngine::handleStartFailed()
{
542
    showMessage("HANDLE RUNCONTROL START FAILED");
543
    d->m_runControl = 0;
544
    d->m_progress.setProgressValue(900);
545 546
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
547 548
}

549 550
// Called from RunControl.
void DebuggerEngine::handleFinished()
551
{
552
    showMessage("HANDLE RUNCONTROL FINISHED");
553
    d->m_runControl = 0;
554 555 556 557
    modulesHandler()->removeAll();
    stackHandler()->removeAll();
    threadsHandler()->removeAll();
    watchHandler()->cleanup();
558
    d->m_progress.setProgressValue(1000);
559
    d->m_progress.reportFinished();
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
}

const DebuggerStartParameters &DebuggerEngine::startParameters() const
{
    return d->m_startParameters;
}

DebuggerStartParameters &DebuggerEngine::startParameters()
{
    return d->m_startParameters;
}


//////////////////////////////////////////////////////////////////////
//
// Dumpers. "Custom dumpers" are a library compiled against the current
// Qt containing functions to evaluate values of Qt classes
// (such as QString, taking pointers to their addresses).
// The library must be loaded into the debuggee.
//
//////////////////////////////////////////////////////////////////////

bool DebuggerEngine::qtDumperLibraryEnabled() const
{
hjk's avatar
hjk committed
584
    return debuggerCore()->boolSetting(UseDebuggingHelpers);
585 586 587 588
}

QStringList DebuggerEngine::qtDumperLibraryLocations() const
{
hjk's avatar
hjk committed
589
    if (debuggerCore()->action(UseCustomDebuggingHelperLocation)->value().toBool()) {
590
        const QString customLocation =
hjk's avatar
hjk committed
591
            debuggerCore()->action(CustomDebuggingHelperLocation)->value().toString();
592 593 594 595 596 597 598 599 600
        const QString location =
            tr("%1 (explicitly set in the Debugger Options)").arg(customLocation);
        return QStringList(location);
    }
    return d->m_startParameters.dumperLibraryLocations;
}

void DebuggerEngine::showQtDumperLibraryWarning(const QString &details)
{
601
    debuggerCore()->showQtDumperLibraryWarning(details);
602 603 604 605
}

QString DebuggerEngine::qtDumperLibraryName() const
{
hjk's avatar
hjk committed
606 607
    if (debuggerCore()->action(UseCustomDebuggingHelperLocation)->value().toBool())
        return debuggerCore()->action(CustomDebuggingHelperLocation)->value().toString();
608 609 610 611 612 613 614 615
    return startParameters().dumperLibrary;
}

DebuggerState DebuggerEngine::state() const
{
    return d->m_state;
}

hjk's avatar
hjk committed
616
DebuggerState DebuggerEngine::lastGoodState() const
617
{
hjk's avatar
hjk committed
618 619 620 621 622 623 624
    return d->m_lastGoodState;
}

DebuggerState DebuggerEngine::targetState() const
{
    return d->m_targetState;
}
625

hjk's avatar
hjk committed
626 627 628
static bool isAllowedTransition(DebuggerState from, DebuggerState to)
{
    switch (from) {
629
    case DebuggerNotReady:
630
        return to == EngineSetupRequested;
631

hjk's avatar
hjk committed
632
    case EngineSetupRequested:
633 634
        return to == EngineSetupOk || to == EngineSetupFailed;
    case EngineSetupFailed:
635 636 637
        // In is the engine's task to go into a proper "Shutdown"
        // state before calling notifyEngineSetupFailed
        return to == DebuggerFinished;
638
    case EngineSetupOk:
hjk's avatar
hjk committed
639
        return to == InferiorSetupRequested || to == EngineShutdownRequested;
640

hjk's avatar
hjk committed
641 642
    case InferiorSetupRequested:
        return to == EngineRunRequested || to == InferiorSetupFailed;
hjk's avatar
hjk committed
643
    case InferiorSetupFailed:
hjk's avatar
hjk committed
644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
        return to == EngineShutdownRequested;

    case EngineRunRequested:
        return to == InferiorRunRequested || to == InferiorStopRequested
            || to == InferiorUnrunnable || to == EngineRunFailed;

    case EngineRunFailed:
        return to == InferiorShutdownRequested;

    case InferiorRunRequested:
        return to == InferiorRunOk || to == InferiorRunFailed;
    case InferiorRunFailed:
        return to == InferiorStopOk;
    case InferiorRunOk:
        return to == InferiorStopRequested || to == InferiorStopOk;

    case InferiorStopRequested:
        return to == InferiorStopOk || to == InferiorStopFailed;
    case InferiorStopOk:
        return to == InferiorRunRequested || to == InferiorShutdownRequested
            || to == InferiorStopOk;
665
    case InferiorStopFailed:
hjk's avatar
hjk committed
666
        return to == EngineShutdownRequested;
667 668

    case InferiorUnrunnable:
hjk's avatar
hjk committed
669 670 671 672 673
        return to == InferiorShutdownRequested;
    case InferiorShutdownRequested:
        return to == InferiorShutdownOk || to == InferiorShutdownFailed;
    case InferiorShutdownOk:
        return to == EngineShutdownRequested;
674
    case InferiorShutdownFailed:
hjk's avatar
hjk committed
675
        return to == EngineShutdownRequested;
676

hjk's avatar
hjk committed
677
    case EngineShutdownRequested:
678
        return to == EngineShutdownOk || to == EngineShutdownFailed;
hjk's avatar
hjk committed
679 680 681 682 683 684
    case EngineShutdownOk:
        return to == DebuggerFinished;
    case EngineShutdownFailed:
        return to == DebuggerFinished;

    case DebuggerFinished:
685
        return to == EngineSetupRequested; // Happens on restart.
686 687 688 689 690 691
    }

    qDebug() << "UNKNOWN STATE:" << from;
    return false;
}

692
void DebuggerEngine::notifyEngineSetupFailed()
hjk's avatar
hjk committed
693
{
hjk's avatar
hjk committed
694
    showMessage(_("NOTE: ENGINE SETUP FAILED"));
hjk's avatar
hjk committed
695
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << state());
696
    setState(EngineSetupFailed);
hjk's avatar
hjk committed
697 698
    QTC_ASSERT(d->m_runControl, return);
    d->m_runControl->startFailed();
hjk's avatar
hjk committed
699
    setState(DebuggerFinished);
hjk's avatar
hjk committed
700 701
}

702
void DebuggerEngine::notifyEngineSetupOk()
703
{
hjk's avatar
hjk committed
704
    showMessage(_("NOTE: ENGINE SETUP OK"));
hjk's avatar
hjk committed
705
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << state());
706
    setState(EngineSetupOk);
hjk's avatar
hjk committed
707
    QTC_ASSERT(d->m_runControl, return);
hjk's avatar
hjk committed
708
    showMessage(_("QUEUE: SETUP INFERIOR"));
hjk's avatar
hjk committed
709
    QTimer::singleShot(0, d, SLOT(doSetupInferior()));
710 711
}

hjk's avatar
hjk committed
712
void DebuggerEnginePrivate::doSetupInferior()
713
{
714
    m_engine->showMessage(_("CALL: SETUP INFERIOR"));
hjk's avatar
hjk committed
715
    QTC_ASSERT(state() == EngineSetupOk, qDebug() << state());
716
    m_progress.setProgressValue(250);
hjk's avatar
hjk committed
717
    m_engine->setState(InferiorSetupRequested);
hjk's avatar
hjk committed
718 719 720 721 722
    m_engine->setupInferior();
}

void DebuggerEngine::notifyInferiorSetupFailed()
{
hjk's avatar
hjk committed
723
    showMessage(_("NOTE: INFERIOR SETUP FAILED"));
hjk's avatar
hjk committed
724
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
hjk's avatar
hjk committed
725
    setState(InferiorSetupFailed);
hjk's avatar
hjk committed
726
    d->queueShutdownEngine();
hjk's avatar
hjk committed
727 728 729 730
}

void DebuggerEngine::notifyInferiorSetupOk()
{
hjk's avatar
hjk committed
731
    showMessage(_("NOTE: INFERIOR SETUP OK"));
hjk's avatar
hjk committed
732
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
hjk's avatar
hjk committed
733
    d->queueRunEngine();
hjk's avatar
hjk committed
734 735 736 737
}

void DebuggerEnginePrivate::doRunEngine()
{
hjk's avatar
hjk committed
738
    m_engine->showMessage(_("CALL: RUN ENGINE"));
hjk's avatar
hjk committed
739
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
740
    m_progress.setProgressValue(300);
hjk's avatar
hjk committed
741 742 743
    m_engine->runEngine();
}

hjk's avatar
hjk committed
744 745
void DebuggerEngine::notifyInferiorUnrunnable()
{
hjk's avatar
hjk committed
746
    showMessage(_("NOTE: INFERIOR UNRUNNABLE"));
747 748
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
749 750 751 752 753 754
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(InferiorUnrunnable);
}

void DebuggerEngine::notifyEngineRunFailed()
{
hjk's avatar
hjk committed
755
    showMessage(_("NOTE: ENGINE RUN FAILED"));
hjk's avatar
hjk committed
756
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
757 758 759
    d->m_progress.setProgressValue(900);
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
760
    setState(EngineRunFailed);
761
    d->queueShutdownEngine();
hjk's avatar
hjk committed
762 763 764 765
}

void DebuggerEngine::notifyEngineRunAndInferiorRunOk()
{
hjk's avatar
hjk committed
766
    showMessage(_("NOTE: ENGINE RUN AND INFERIOR RUN OK"));
767 768
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
769 770 771 772 773 774 775
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(InferiorRunRequested);
    notifyInferiorRunOk();
}

void DebuggerEngine::notifyEngineRunAndInferiorStopOk()
{
hjk's avatar
hjk committed
776
    showMessage(_("NOTE: ENGINE RUN AND INFERIOR STOP OK"));
777 778
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
779 780 781 782 783 784 785
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(InferiorStopRequested);
    notifyInferiorStopOk();
}

void DebuggerEngine::notifyInferiorRunRequested()
{
hjk's avatar
hjk committed
786
    showMessage(_("NOTE: INFERIOR RUN REQUESTED"));
hjk's avatar
hjk committed
787 788 789 790 791 792
    QTC_ASSERT(state() == InferiorStopOk, qDebug() << state());
    setState(InferiorRunRequested);
}

void DebuggerEngine::notifyInferiorRunOk()
{
hjk's avatar
hjk committed
793
    showMessage(_("NOTE: INFERIOR RUN OK"));
hjk's avatar
hjk committed
794 795 796 797 798 799
    QTC_ASSERT(state() == InferiorRunRequested, qDebug() << state());
    setState(InferiorRunOk);
}

void DebuggerEngine::notifyInferiorRunFailed()
{
hjk's avatar
hjk committed
800
    showMessage(_("NOTE: INFERIOR RUN FAILED"));
hjk's avatar
hjk committed
801 802 803
    QTC_ASSERT(state() == InferiorRunRequested, qDebug() << state());
    setState(InferiorRunFailed);
    setState(InferiorStopOk);
hjk's avatar
hjk committed
804 805
    if (isDying())
        d->queueShutdownInferior();
hjk's avatar
hjk committed
806 807 808 809
}

void DebuggerEngine::notifyInferiorStopOk()
{
hjk's avatar
hjk committed
810 811
    showMessage(_("NOTE: INFERIOR STOP OK"));
    // Ignore spurious notifications after we are set to die.
hjk's avatar
hjk committed
812
    if (isDying()) {
hjk's avatar
hjk committed
813 814 815 816 817 818 819 820 821 822 823 824 825
        showMessage(_("NOTE: ... WHILE DYING. "));
        // Forward state to "StopOk" if needed.
        if (state() == InferiorStopRequested
                || state() == InferiorRunRequested
                || state() == InferiorRunOk) {
            showMessage(_("NOTE: ... FORWARDING TO 'STOP OK'. "));
            setState(InferiorStopOk);
        }
        if (state() == InferiorStopOk || state() == InferiorStopFailed) {
            d->queueShutdownInferior();
        }
        showMessage(_("NOTE: ... IGNORING STOP MESSAGE"));
        return;
hjk's avatar
hjk committed
826
    }
hjk's avatar
hjk committed
827 828
    QTC_ASSERT(state() == InferiorStopRequested, qDebug() << state());
    setState(InferiorStopOk);
hjk's avatar
hjk committed
829 830
}

hjk's avatar
hjk committed
831
void DebuggerEngine::notifyInferiorSpontaneousStop()
832
{
hjk's avatar
hjk committed
833
    showMessage(_("NOTE: INFERIOR SPONTANEOUES STOP"));
hjk's avatar
hjk committed
834 835
    QTC_ASSERT(state() == InferiorRunOk, qDebug() << state());
    setState(InferiorStopOk);
836 837
}

hjk's avatar
hjk committed
838
void DebuggerEngine::notifyInferiorStopFailed()
839
{
hjk's avatar
hjk committed
840
    showMessage(_("NOTE: INFERIOR STOP FAILED"));
hjk's avatar
hjk committed
841 842
    QTC_ASSERT(state() == InferiorStopRequested, qDebug() << state());
    setState(InferiorStopFailed);
hjk's avatar
hjk committed
843
    d->queueShutdownEngine();
844 845 846 847
}

void DebuggerEnginePrivate::doInterruptInferior()
{
hjk's avatar
hjk committed
848 849
    QTC_ASSERT(state() == InferiorRunOk, qDebug() << state());
    m_engine->setState(InferiorStopRequested);
hjk's avatar
hjk committed
850
    m_engine->showMessage(_("CALL: INTERRUPT INFERIOR"));
851 852 853
    m_engine->interruptInferior();
}

hjk's avatar
hjk committed
854 855
void DebuggerEnginePrivate::doShutdownInferior()
{
856
    QTC_ASSERT(state() == InferiorShutdownRequested, qDebug() << state());
hjk's avatar
hjk committed
857 858
    m_engine->resetLocation();
    m_targetState = DebuggerFinished;
hjk's avatar
hjk committed
859
    m_engine->showMessage(_("CALL: SHUTDOWN INFERIOR"));
hjk's avatar
hjk committed
860 861 862 863 864 865
    m_engine->shutdownInferior();
}

void DebuggerEngine::notifyInferiorShutdownOk()
{
    showMessage(_("INFERIOR SUCCESSFULLY SHUT DOWN"));
hjk's avatar
hjk committed
866
    QTC_ASSERT(state() == InferiorShutdownRequested, qDebug() << state());
hjk's avatar
hjk committed
867 868
    d->m_lastGoodState = DebuggerNotReady; // A "neutral" value.
    setState(InferiorShutdownOk);
hjk's avatar
hjk committed
869
    d->queueShutdownEngine();
hjk's avatar
hjk committed
870 871 872 873 874
}

void DebuggerEngine::notifyInferiorShutdownFailed()
{
    showMessage(_("INFERIOR SHUTDOWN FAILED"));
Friedemann Kleint's avatar
Friedemann Kleint committed
875
    QTC_ASSERT(state() == InferiorShutdownRequested, qDebug() << this << state());
hjk's avatar
hjk committed
876
    setState(InferiorShutdownFailed);
hjk's avatar
hjk committed
877
    d->queueShutdownEngine();
hjk's avatar
hjk committed
878 879 880 881
}

void DebuggerEngine::notifyInferiorIll()
{
hjk's avatar
hjk committed
882
    showMessage(_("NOTE: INFERIOR ILL"));
hjk's avatar
hjk committed
883 884 885 886 887 888 889 890 891 892 893
    // This can be issued in almost any state. The inferior could still be
    // alive as some previous notifications might have been bogus.
    d->m_targetState = DebuggerFinished;
    d->m_lastGoodState = d->m_state;
    if (state() == InferiorRunRequested) {
        // We asked for running, but did not see a response.
        // Assume the inferior is dead.
        // FIXME: Use timeout?
        setState(InferiorRunFailed);
        setState(InferiorStopOk);
    }
hjk's avatar
hjk committed
894
    d->queueShutdownInferior();
hjk's avatar
hjk committed
895 896 897 898
}

void DebuggerEnginePrivate::doShutdownEngine()
{
899
    QTC_ASSERT(state() == EngineShutdownRequested, qDebug() << state());
hjk's avatar
hjk committed
900
    m_targetState = DebuggerFinished;
hjk's avatar
hjk committed
901
    m_engine->showMessage(_("CALL: SHUTDOWN ENGINE"));
hjk's avatar
hjk committed
902 903 904 905 906
    m_engine->shutdownEngine();
}

void DebuggerEngine::notifyEngineShutdownOk()
{
hjk's avatar
hjk committed
907
    showMessage(_("NOTE: ENGINE SHUTDOWN OK"));
hjk's avatar
hjk committed
908 909
    QTC_ASSERT(state() == EngineShutdownRequested, qDebug() << state());
    setState(EngineShutdownOk);
910
    d->queueFinishDebugger();
hjk's avatar
hjk committed
911 912 913
}

void DebuggerEngine::notifyEngineShutdownFailed()
hjk's avatar
hjk committed
914
{
hjk's avatar
hjk committed
915
    showMessage(_("NOTE: ENGINE SHUTDOWN FAILED"));
hjk's avatar
hjk committed
916 917
    QTC_ASSERT(state() == EngineShutdownRequested, qDebug() << state());
    setState(EngineShutdownFailed);
918
    d->queueFinishDebugger();
hjk's avatar
hjk committed
919 920 921 922
}

void DebuggerEnginePrivate::doFinishDebugger()
{
hjk's avatar
hjk committed
923
    m_engine->showMessage(_("NOTE: FINISH DEBUGGER"));
924
    QTC_ASSERT(state() == DebuggerFinished, qDebug() << state());
hjk's avatar
hjk committed
925
    m_engine->resetLocation();
hjk's avatar
hjk committed
926
    QTC_ASSERT(m_runControl, return);
hjk's avatar
hjk committed
927 928 929 930 931
    m_runControl->debuggingFinished();
}

void DebuggerEngine::notifyEngineIll()
{
hjk's avatar
hjk committed
932
    showMessage(_("NOTE: ENGINE ILL ******"));
hjk's avatar
hjk committed
933 934
    d->m_targetState = DebuggerFinished;
    d->m_lastGoodState = d->m_state;
hjk's avatar
hjk committed
935 936 937
    switch (state()) {
        case InferiorRunRequested:
        case InferiorRunOk:
938 939 940 941 942 943 944
            // The engine does not look overly ill right now, so attempt to
            // properly interrupt at least once. If that fails, we are on the
            // shutdown path due to d->m_targetState anyways.
            setState(InferiorStopRequested, true);
            showMessage(_("ATTEMPT TO INTERRUPT INFERIOR"));
            interruptInferior();
            break;
hjk's avatar
hjk committed
945 946
        case InferiorStopRequested:
        case InferiorStopOk:
947
            showMessage(_("FORWARDING STATE TO InferiorShutdownFailed"));
hjk's avatar
hjk committed
948
            setState(InferiorShutdownFailed, true);
949
            d->queueShutdownEngine();
hjk's avatar
hjk committed
950 951
            break;
        default:
952
            d->queueShutdownEngine();
hjk's avatar
hjk committed
953
            break;
hjk's avatar
hjk committed
954 955 956 957 958
    }
}

void DebuggerEngine::notifyEngineSpontaneousShutdown()
{
hjk's avatar
hjk committed
959
    showMessage(_("NOTE: ENGINE SPONTANEOUS SHUTDOWN"));
960
    setState(EngineShutdownOk, true);
hjk's avatar
hjk committed
961
    d->queueFinishDebugger();
hjk's avatar
hjk committed
962 963 964 965
}

void DebuggerEngine::notifyInferiorExited()
{
hjk's avatar
hjk committed
966
    showMessage(_("NOTE: INFERIOR EXITED"));
hjk's avatar
hjk committed
967 968 969 970 971 972 973 974 975 976 977
    resetLocation();

    // This can be issued in almost any state. We assume, though,
    // that at this point of time the inferior is not running anymore,
    // even if stop notification were not issued or got lost.
    if (state() == InferiorRunOk) {
        setState(InferiorStopRequested);
        setState(InferiorStopOk);
    }
    setState(InferiorShutdownRequested);
    setState(InferiorShutdownOk);
978
    d->queueShutdownEngine();
979 980
}