debuggerengine.cpp 41.8 KB
Newer Older
1 2 3 4 5 6 7 8
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
con's avatar
con committed
9
** No Commercial Usage
10
**
con's avatar
con committed
11 12 13 14
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
15 16 17 18 19 20 21 22 23 24
**
** 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.
**
con's avatar
con committed
25 26 27 28 29 30
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
31 32 33 34 35 36
**
**************************************************************************/

#include "debuggerengine.h"

#include "debuggeractions.h"
37
#include "debuggercore.h"
38
#include "debuggerplugin.h"
39
#include "debuggerrunner.h"
40
#include "debuggerstringutils.h"
41
#include "debuggertooltip.h"
42

43 44
#include "memoryagent.h"
#include "disassembleragent.h"
45 46 47 48 49 50 51 52 53
#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
54
#include <coreplugin/icore.h>
55
#include <coreplugin/ifile.h>
hjk's avatar
hjk committed
56
#include <coreplugin/editormanager/editormanager.h>
57 58
#include <coreplugin/progressmanager/progressmanager.h>
#include <coreplugin/progressmanager/futureprogress.h>
hjk's avatar
hjk committed
59

hjk's avatar
hjk committed
60
#include <projectexplorer/toolchain.h>
61
#include <projectexplorer/toolchaintype.h>
62

hjk's avatar
hjk committed
63
#include <texteditor/itexteditor.h>
64
#include <texteditor/basetextmark.h>
hjk's avatar
hjk committed
65

66
#include <utils/environment.h>
67 68 69 70 71
#include <utils/savedaction.h>
#include <utils/qtcassert.h>

#include <QtCore/QDebug>
#include <QtCore/QTimer>
72
#include <QtCore/QFutureInterface>
73

74
#include <QtGui/QMessageBox>
75

hjk's avatar
hjk committed
76
using namespace Core;
77
using namespace Debugger::Internal;
hjk's avatar
hjk committed
78 79
using namespace ProjectExplorer;
using namespace TextEditor;
80

hjk's avatar
hjk committed
81 82 83 84 85 86 87
//#define DEBUG_STATE 1
#if DEBUG_STATE
#   define SDEBUG(s) qDebug() << s
#else
#   define SDEBUG(s)
#endif
# define XSDEBUG(s) qDebug() << s
88

89

90 91 92 93 94 95
///////////////////////////////////////////////////////////////////////
//
// DebuggerStartParameters
//
///////////////////////////////////////////////////////////////////////

96 97
namespace Debugger {

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

hjk's avatar
hjk committed
111
QString DebuggerStartParameters::toolChainName() const
112
{
hjk's avatar
hjk committed
113
    return ToolChain::toolChainName(ProjectExplorer::ToolChainType(toolChainType));
114 115 116 117
}

QDebug operator<<(QDebug d, DebuggerState state)
{
hjk's avatar
hjk committed
118 119
    //return d << DebuggerEngine::stateName(state) << '(' << int(state) << ')';
    return d << DebuggerEngine::stateName(state);
120 121 122 123 124 125 126
}

QDebug operator<<(QDebug str, const DebuggerStartParameters &sp)
{
    QDebug nospace = str.nospace();
    nospace << "executable=" << sp.executable
            << " coreFile=" << sp.coreFile
127
            << " processArgs=" << sp.processArgs
128 129 130 131 132 133 134
            << " 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
135
            << " useServerStartScript=" << sp.useServerStartScript
136 137 138 139 140 141 142 143 144 145
            << " 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
146
        SN(EngineSetupRequested)
147 148
        SN(EngineSetupOk)
        SN(EngineSetupFailed)
hjk's avatar
hjk committed
149 150
        SN(EngineRunFailed)
        SN(InferiorSetupRequested)
hjk's avatar
hjk committed
151
        SN(InferiorSetupFailed)
hjk's avatar
hjk committed
152 153 154 155
        SN(EngineRunRequested)
        SN(InferiorRunRequested)
        SN(InferiorRunOk)
        SN(InferiorRunFailed)
156
        SN(InferiorUnrunnable)
hjk's avatar
hjk committed
157 158
        SN(InferiorStopRequested)
        SN(InferiorStopOk)
159
        SN(InferiorStopFailed)
hjk's avatar
hjk committed
160 161
        SN(InferiorShutdownRequested)
        SN(InferiorShutdownOk)
162
        SN(InferiorShutdownFailed)
hjk's avatar
hjk committed
163 164 165 166
        SN(EngineShutdownRequested)
        SN(EngineShutdownOk)
        SN(EngineShutdownFailed)
        SN(DebuggerFinished)
167 168 169 170 171
    }
    return "<unknown>";
#    undef SN
}

172

173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
///////////////////////////////////////////////////////////////////////
//
// LocationMark
//
///////////////////////////////////////////////////////////////////////

// Used in "real" editors
class LocationMark : public TextEditor::BaseTextMark
{
public:
    LocationMark(const QString &fileName, int linenumber)
        : BaseTextMark(fileName, linenumber)
    {}

    QIcon icon() const { return debuggerCore()->locationMarkIcon(); }
    void updateLineNumber(int /*lineNumber*/) {}
    void updateBlock(const QTextBlock & /*block*/) {}
    void removedFromEditor() {}
};



195 196 197 198 199 200
//////////////////////////////////////////////////////////////////////
//
// DebuggerEnginePrivate
//
//////////////////////////////////////////////////////////////////////

201
class DebuggerEnginePrivate : public QObject
202
{
203 204
    Q_OBJECT

205 206 207 208 209 210
public:
    DebuggerEnginePrivate(DebuggerEngine *engine, const DebuggerStartParameters &sp)
      : m_engine(engine),
        m_runControl(0),
        m_startParameters(sp),
        m_state(DebuggerNotReady),
hjk's avatar
hjk committed
211
        m_lastGoodState(DebuggerNotReady),
Friedemann Kleint's avatar
Friedemann Kleint committed
212
        m_targetState(DebuggerNotReady),
213
        m_modulesHandler(),
214
        m_registerHandler(),
215 216
        m_sourceFilesHandler(),
        m_stackHandler(),
hjk's avatar
hjk committed
217
        m_threadsHandler(),
218
        m_watchHandler(engine),
219
        m_isSlaveEngine(false),
220 221
        m_disassemblerAgent(engine),
        m_memoryAgent(engine)
222
    {
223
        connect(&m_locationTimer, SIGNAL(timeout()), SLOT(resetLocation()));
224
    }
225 226

    ~DebuggerEnginePrivate() {}
227

228
public slots:
hjk's avatar
hjk committed
229 230
    void doSetupInferior();
    void doRunEngine();
hjk's avatar
hjk committed
231 232
    void doShutdownEngine();
    void doShutdownInferior();
233
    void doInterruptInferior();
hjk's avatar
hjk committed
234
    void doFinishDebugger();
hjk's avatar
hjk committed
235

236 237
    void queueRunEngine()
    {
hjk's avatar
hjk committed
238 239 240 241 242
        m_engine->setState(EngineRunRequested);
        m_engine->showMessage(_("QUEUE: RUN ENGINE"));
        QTimer::singleShot(0, this, SLOT(doRunEngine()));
    }

243 244
    void queueShutdownEngine()
    {
hjk's avatar
hjk committed
245 246 247 248 249
        m_engine->setState(EngineShutdownRequested);
        m_engine->showMessage(_("QUEUE: SHUTDOWN ENGINE"));
        QTimer::singleShot(0, this, SLOT(doShutdownEngine()));
    }

250 251
    void queueShutdownInferior()
    {
hjk's avatar
hjk committed
252 253 254 255 256
        m_engine->setState(InferiorShutdownRequested);
        m_engine->showMessage(_("QUEUE: SHUTDOWN INFERIOR"));
        QTimer::singleShot(0, this, SLOT(doShutdownInferior()));
    }

257 258
    void queueFinishDebugger()
    {
259 260 261 262
        QTC_ASSERT(state() == EngineShutdownOk
            || state() == EngineShutdownFailed, qDebug() << state());
        m_engine->setState(DebuggerFinished);
        m_engine->showMessage(_("QUEUE: FINISH DEBUGGER"));
hjk's avatar
hjk committed
263 264 265
        QTimer::singleShot(0, this, SLOT(doFinishDebugger()));
    }

266 267
    void raiseApplication()
    {
hjk's avatar
hjk committed
268
        QTC_ASSERT(m_runControl, return);
269 270 271
        m_runControl->bringApplicationToForeground(m_inferiorPid);
    }

272
    void scheduleResetLocation()
273
    {
274
        m_stackHandler.scheduleResetLocation();
275 276 277 278
        m_locationTimer.setSingleShot(true);
        m_locationTimer.start(80);
    }

279
    void resetLocation()
280 281 282
    {
        m_locationTimer.stop();
        m_locationMark.reset();
283 284
        m_stackHandler.resetLocation();
        m_disassemblerAgent.resetLocation();
285 286
    }

287
public:
hjk's avatar
hjk committed
288 289
    DebuggerState state() const { return m_state; }

290 291 292 293
    DebuggerEngine *m_engine; // Not owned.
    DebuggerRunControl *m_runControl;  // Not owned.

    DebuggerStartParameters m_startParameters;
hjk's avatar
hjk committed
294 295

    // The current state.
296 297
    DebuggerState m_state;

hjk's avatar
hjk committed
298 299 300 301 302 303
    // The state we had before something unexpected happend.
    DebuggerState m_lastGoodState;

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

304 305 306 307 308 309 310 311
    qint64 m_inferiorPid;

    ModulesHandler m_modulesHandler;
    RegisterHandler m_registerHandler;
    SourceFilesHandler m_sourceFilesHandler;
    StackHandler m_stackHandler;
    ThreadsHandler m_threadsHandler;
    WatchHandler m_watchHandler;
312
    QFutureInterface<void> m_progress;
313

314
    bool m_isSlaveEngine;
315 316
    DisassemblerAgent m_disassemblerAgent;
    MemoryAgent m_memoryAgent;
317 318
    QScopedPointer<TextEditor::BaseTextMark> m_locationMark;
    QTimer m_locationTimer;
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
};


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

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

DebuggerEngine::~DebuggerEngine()
{
335 336
    disconnect();
    delete d;
337 338
}

339
void DebuggerEngine::showStatusMessage(const QString &msg, int timeout) const
340
{
341
    showMessage(msg, StatusBar, timeout);
342
}
343

344 345 346 347 348 349
void DebuggerEngine::removeTooltip()
{
    watchHandler()->removeTooltip();
    hideDebuggerToolTip();
}

350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
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;
}

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

QAbstractItemModel *DebuggerEngine::modulesModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
394 395 396 397
    QAbstractItemModel *model = d->m_modulesHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("ModulesModel"));
    return model;
398 399 400 401
}

QAbstractItemModel *DebuggerEngine::registerModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
402 403 404 405
    QAbstractItemModel *model = d->m_registerHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("RegisterModel"));
    return model;
406 407 408 409
}

QAbstractItemModel *DebuggerEngine::stackModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
410 411 412 413
    QAbstractItemModel *model = d->m_stackHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("StackModel"));
    return model;
414 415 416 417
}

QAbstractItemModel *DebuggerEngine::threadsModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
418 419 420 421
    QAbstractItemModel *model = d->m_threadsHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("ThreadsModel"));
    return model;
422 423 424 425
}

QAbstractItemModel *DebuggerEngine::localsModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
426 427 428 429
    QAbstractItemModel *model = d->m_watchHandler.model(LocalsWatch);
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("LocalsModel"));
    return model;
430 431 432 433
}

QAbstractItemModel *DebuggerEngine::watchersModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
434 435 436 437
    QAbstractItemModel *model = d->m_watchHandler.model(WatchersWatch);
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("WatchersModel"));
    return model;
438 439 440 441
}

QAbstractItemModel *DebuggerEngine::returnModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
442 443 444 445
    QAbstractItemModel *model = d->m_watchHandler.model(ReturnWatch);
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("ReturnModel"));
    return model;
446 447 448 449
}

QAbstractItemModel *DebuggerEngine::sourceFilesModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
450 451 452 453
    QAbstractItemModel *model = d->m_sourceFilesHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("SourceFilesModel"));
    return model;
454 455
}

456
void DebuggerEngine::fetchMemory(MemoryAgent *, QObject *,
457 458 459 460 461 462 463 464 465 466 467 468 469 470
        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
{
471 472
    //if (msg.size() && msg.at(0).isUpper() && msg.at(1).isUpper())
    //    qDebug() << qPrintable(msg) << "IN STATE" << state();
473
    debuggerCore()->showMessage(msg, channel, timeout);
474 475 476 477 478
    if (d->m_runControl) {
        d->m_runControl->showMessage(msg, channel);
    } else {
        qWarning("Warning: %s (no active run control)", qPrintable(msg));
    }
479 480 481 482
}

void DebuggerEngine::startDebugger(DebuggerRunControl *runControl)
{
hjk's avatar
hjk committed
483
    if (!isSlaveEngine()) {
484
        d->m_progress.setProgressRange(0, 1000);
485 486 487
        Core::FutureProgress *fp = Core::ICore::instance()->progressManager()
            ->addTask(d->m_progress.future(),
            tr("Launching"), _("Debugger.Launcher"));
488
        fp->setKeepOnFinish(Core::FutureProgress::DontKeepOnFinish);
489 490
        d->m_progress.reportStarted();
    }
491 492
    QTC_ASSERT(runControl, notifyEngineSetupFailed(); return);
    QTC_ASSERT(!d->m_runControl, notifyEngineSetupFailed(); return);
493 494 495 496 497 498

    d->m_runControl = runControl;

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

499 500
    if (!d->m_startParameters.environment.size())
        d->m_startParameters.environment = Utils::Environment();
501 502

    const unsigned engineCapabilities = debuggerCapabilities();
hjk's avatar
hjk committed
503
    debuggerCore()->action(OperateByInstruction)
504 505
        ->setEnabled(engineCapabilities & DisassemblerCapability);

506 507
    QTC_ASSERT(state() == DebuggerNotReady || state() == DebuggerFinished,
         qDebug() << state());
508 509
    d->m_lastGoodState = DebuggerNotReady;
    d->m_targetState = DebuggerNotReady;
hjk's avatar
hjk committed
510
    setState(EngineSetupRequested);
511

512
    d->m_progress.setProgressValue(200);
hjk's avatar
hjk committed
513
    setupEngine();
514 515 516 517
}

void DebuggerEngine::resetLocation()
{
518 519
    // Do it after some delay to avoid flicker.
    d->scheduleResetLocation();
520 521
}

522
void DebuggerEngine::gotoLocation(const Location &loc)
523
{
524 525 526 527 528
    if (debuggerCore()->boolSetting(OperateByInstruction) || !loc.hasDebugInfo()) {
        d->m_disassemblerAgent.setTryMixed(true);
        d->m_disassemblerAgent.setLocation(loc);
        return;
    }
529 530 531 532
    // CDB might hit on breakpoints while shutting down.
    //if (m_shuttingDown)
    //    return;

533
    d->resetLocation();
534

535 536
    const QString file = loc.fileName();
    const int line = loc.lineNumber();
hjk's avatar
hjk committed
537 538 539 540 541 542 543 544 545 546 547
    EditorManager *editorManager = EditorManager::instance();
    QList<IEditor *> editors = editorManager->editorsForFileName(file);
    if (editors.isEmpty()) {
        editors.append(editorManager->openEditor(file, QString(),
            EditorManager::IgnoreNavigationHistory));
        editors.back()->setProperty(Constants::OPENED_BY_DEBUGGER, true);
    }
    ITextEditor *texteditor = qobject_cast<ITextEditor *>(editors.back());
    if (texteditor)
        texteditor->gotoLine(line, 0);

548
    if (loc.needsMarker())
549
        d->m_locationMark.reset(new LocationMark(file, line));
550 551

    // FIXME: Breaks with split views.
552
    if (!d->m_memoryAgent.hasVisibleEditor() || loc.needsRaise())
553 554
        editorManager->activateEditor(editors.back());
    //qDebug() << "MEMORY: " << d->m_memoryAgent.hasVisibleEditor();
555 556
}

557 558 559
// Called from RunControl.
void DebuggerEngine::handleStartFailed()
{
560
    showMessage("HANDLE RUNCONTROL START FAILED");
561
    d->m_runControl = 0;
562
    d->m_progress.setProgressValue(900);
563 564
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
565 566
}

567 568
// Called from RunControl.
void DebuggerEngine::handleFinished()
569
{
570
    showMessage("HANDLE RUNCONTROL FINISHED");
571
    d->m_runControl = 0;
572 573 574 575
    modulesHandler()->removeAll();
    stackHandler()->removeAll();
    threadsHandler()->removeAll();
    watchHandler()->cleanup();
576
    d->m_progress.setProgressValue(1000);
577
    d->m_progress.reportFinished();
578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
}

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
602
    return debuggerCore()->boolSetting(UseDebuggingHelpers);
603 604 605 606
}

QStringList DebuggerEngine::qtDumperLibraryLocations() const
{
hjk's avatar
hjk committed
607
    if (debuggerCore()->action(UseCustomDebuggingHelperLocation)->value().toBool()) {
608
        const QString customLocation =
hjk's avatar
hjk committed
609
            debuggerCore()->action(CustomDebuggingHelperLocation)->value().toString();
610 611 612 613 614 615 616 617 618
        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)
{
619
    debuggerCore()->showQtDumperLibraryWarning(details);
620 621 622 623
}

QString DebuggerEngine::qtDumperLibraryName() const
{
hjk's avatar
hjk committed
624 625
    if (debuggerCore()->action(UseCustomDebuggingHelperLocation)->value().toBool())
        return debuggerCore()->action(CustomDebuggingHelperLocation)->value().toString();
626 627 628 629 630 631 632 633
    return startParameters().dumperLibrary;
}

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

hjk's avatar
hjk committed
634
DebuggerState DebuggerEngine::lastGoodState() const
635
{
hjk's avatar
hjk committed
636 637 638 639 640 641 642
    return d->m_lastGoodState;
}

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

hjk's avatar
hjk committed
644 645 646
static bool isAllowedTransition(DebuggerState from, DebuggerState to)
{
    switch (from) {
647
    case DebuggerNotReady:
648
        return to == EngineSetupRequested;
649

hjk's avatar
hjk committed
650
    case EngineSetupRequested:
651 652
        return to == EngineSetupOk || to == EngineSetupFailed;
    case EngineSetupFailed:
653 654 655
        // In is the engine's task to go into a proper "Shutdown"
        // state before calling notifyEngineSetupFailed
        return to == DebuggerFinished;
656
    case EngineSetupOk:
hjk's avatar
hjk committed
657
        return to == InferiorSetupRequested || to == EngineShutdownRequested;
658

hjk's avatar
hjk committed
659 660
    case InferiorSetupRequested:
        return to == EngineRunRequested || to == InferiorSetupFailed;
hjk's avatar
hjk committed
661
    case InferiorSetupFailed:
hjk's avatar
hjk committed
662 663 664 665 666 667 668
        return to == EngineShutdownRequested;

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

    case EngineRunFailed:
669
        return to == EngineShutdownRequested;
hjk's avatar
hjk committed
670 671 672 673 674 675 676 677 678 679 680 681 682

    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;
683
    case InferiorStopFailed:
hjk's avatar
hjk committed
684
        return to == EngineShutdownRequested;
685 686

    case InferiorUnrunnable:
hjk's avatar
hjk committed
687 688 689 690 691
        return to == InferiorShutdownRequested;
    case InferiorShutdownRequested:
        return to == InferiorShutdownOk || to == InferiorShutdownFailed;
    case InferiorShutdownOk:
        return to == EngineShutdownRequested;
692
    case InferiorShutdownFailed:
hjk's avatar
hjk committed
693
        return to == EngineShutdownRequested;
694

hjk's avatar
hjk committed
695
    case EngineShutdownRequested:
696
        return to == EngineShutdownOk || to == EngineShutdownFailed;
hjk's avatar
hjk committed
697 698 699 700 701 702
    case EngineShutdownOk:
        return to == DebuggerFinished;
    case EngineShutdownFailed:
        return to == DebuggerFinished;

    case DebuggerFinished:
703
        return to == EngineSetupRequested; // Happens on restart.
704 705
    }

706
    qDebug() << "UNKNOWN DEBUGGER STATE:" << from;
707 708 709
    return false;
}

710
void DebuggerEngine::notifyEngineSetupFailed()
hjk's avatar
hjk committed
711
{
hjk's avatar
hjk committed
712
    showMessage(_("NOTE: ENGINE SETUP FAILED"));
hjk's avatar
hjk committed
713
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << state());
714
    setState(EngineSetupFailed);
hjk's avatar
hjk committed
715 716
    QTC_ASSERT(d->m_runControl, return);
    d->m_runControl->startFailed();
hjk's avatar
hjk committed
717
    setState(DebuggerFinished);
hjk's avatar
hjk committed
718 719
}

720
void DebuggerEngine::notifyEngineSetupOk()
721
{
hjk's avatar
hjk committed
722
    showMessage(_("NOTE: ENGINE SETUP OK"));
hjk's avatar
hjk committed
723
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << state());
724
    setState(EngineSetupOk);
hjk's avatar
hjk committed
725
    QTC_ASSERT(d->m_runControl, return);
hjk's avatar
hjk committed
726
    showMessage(_("QUEUE: SETUP INFERIOR"));
hjk's avatar
hjk committed
727
    QTimer::singleShot(0, d, SLOT(doSetupInferior()));
728 729
}

hjk's avatar
hjk committed
730
void DebuggerEnginePrivate::doSetupInferior()
731
{
732
    m_engine->showMessage(_("CALL: SETUP INFERIOR"));
hjk's avatar
hjk committed
733
    QTC_ASSERT(state() == EngineSetupOk, qDebug() << state());
734
    m_progress.setProgressValue(250);
hjk's avatar
hjk committed
735
    m_engine->setState(InferiorSetupRequested);
hjk's avatar
hjk committed
736 737 738 739 740
    m_engine->setupInferior();
}

void DebuggerEngine::notifyInferiorSetupFailed()
{
hjk's avatar
hjk committed
741
    showMessage(_("NOTE: INFERIOR SETUP FAILED"));
hjk's avatar
hjk committed
742
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
hjk's avatar
hjk committed
743
    setState(InferiorSetupFailed);
hjk's avatar
hjk committed
744
    d->queueShutdownEngine();
hjk's avatar
hjk committed
745 746 747 748
}

void DebuggerEngine::notifyInferiorSetupOk()
{
hjk's avatar
hjk committed
749
    showMessage(_("NOTE: INFERIOR SETUP OK"));
hjk's avatar
hjk committed
750
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
hjk's avatar
hjk committed
751
    d->queueRunEngine();
hjk's avatar
hjk committed
752 753 754 755
}

void DebuggerEnginePrivate::doRunEngine()
{
hjk's avatar
hjk committed
756
    m_engine->showMessage(_("CALL: RUN ENGINE"));
hjk's avatar
hjk committed
757
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
758
    m_progress.setProgressValue(300);
hjk's avatar
hjk committed
759 760 761
    m_engine->runEngine();
}

hjk's avatar
hjk committed
762 763
void DebuggerEngine::notifyInferiorUnrunnable()
{
hjk's avatar
hjk committed
764
    showMessage(_("NOTE: INFERIOR UNRUNNABLE"));
765 766
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
767 768 769 770 771 772
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(InferiorUnrunnable);
}

void DebuggerEngine::notifyEngineRunFailed()
{
hjk's avatar
hjk committed
773
    showMessage(_("NOTE: ENGINE RUN FAILED"));
hjk's avatar
hjk committed
774
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
775 776 777
    d->m_progress.setProgressValue(900);
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
778
    setState(EngineRunFailed);
779
    d->queueShutdownEngine();
hjk's avatar
hjk committed
780 781 782 783
}

void DebuggerEngine::notifyEngineRunAndInferiorRunOk()
{
hjk's avatar
hjk committed
784
    showMessage(_("NOTE: ENGINE RUN AND INFERIOR RUN OK"));
785 786
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
787 788 789 790 791 792 793
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(InferiorRunRequested);
    notifyInferiorRunOk();
}

void DebuggerEngine::notifyEngineRunAndInferiorStopOk()
{
hjk's avatar
hjk committed
794
    showMessage(_("NOTE: ENGINE RUN AND INFERIOR STOP OK"));
795 796
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
797 798 799 800 801 802 803
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(InferiorStopRequested);
    notifyInferiorStopOk();
}

void DebuggerEngine::notifyInferiorRunRequested()
{
hjk's avatar
hjk committed
804
    showMessage(_("NOTE: INFERIOR RUN REQUESTED"));
hjk's avatar
hjk committed
805 806 807 808 809 810
    QTC_ASSERT(state() == InferiorStopOk, qDebug() << state());
    setState(InferiorRunRequested);
}

void DebuggerEngine::notifyInferiorRunOk()
{
hjk's avatar
hjk committed
811
    showMessage(_("NOTE: INFERIOR RUN OK"));
hjk's avatar
hjk committed
812 813 814 815 816 817
    QTC_ASSERT(state() == InferiorRunRequested, qDebug() << state());
    setState(InferiorRunOk);
}

void DebuggerEngine::notifyInferiorRunFailed()
{
hjk's avatar
hjk committed
818
    showMessage(_("NOTE: INFERIOR RUN FAILED"));
hjk's avatar
hjk committed
819 820 821
    QTC_ASSERT(state() == InferiorRunRequested, qDebug() << state());
    setState(InferiorRunFailed);
    setState(InferiorStopOk);
hjk's avatar
hjk committed
822 823
    if (isDying())
        d->queueShutdownInferior();
hjk's avatar
hjk committed
824 825 826 827
}

void DebuggerEngine::notifyInferiorStopOk()
{
hjk's avatar
hjk committed
828 829
    showMessage(_("NOTE: INFERIOR STOP OK"));
    // Ignore spurious notifications after we are set to die.
hjk's avatar
hjk committed
830
    if (isDying()) {
hjk's avatar
hjk committed
831 832 833 834 835 836 837 838 839 840 841 842 843
        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
844
    }
hjk's avatar
hjk committed
845 846
    QTC_ASSERT(state() == InferiorStopRequested, qDebug() << state());
    setState(InferiorStopOk);
hjk's avatar
hjk committed
847 848
}

hjk's avatar
hjk committed
849
void DebuggerEngine::notifyInferiorSpontaneousStop()
850
{
hjk's avatar
hjk committed
851
    showMessage(_("NOTE: INFERIOR SPONTANEOUES STOP"));
hjk's avatar
hjk committed
852 853
    QTC_ASSERT(state() == InferiorRunOk, qDebug() << state());
    setState(InferiorStopOk);
854 855
}

hjk's avatar
hjk committed
856
void DebuggerEngine::notifyInferiorStopFailed()
857
{
hjk's avatar
hjk committed
858
    showMessage(_("NOTE: INFERIOR STOP FAILED"));
hjk's avatar
hjk committed
859 860
    QTC_ASSERT(state() == InferiorStopRequested, qDebug() << state());
    setState(InferiorStopFailed);
hjk's avatar
hjk committed
861
    d->queueShutdownEngine();
862 863 864 865
}

void DebuggerEnginePrivate::doInterruptInferior()
{
hjk's avatar
hjk committed
866 867
    QTC_ASSERT(state() == InferiorRunOk, qDebug() << state());
    m_engine->setState(InferiorStopRequested);
hjk's avatar
hjk committed
868
    m_engine->showMessage(_("CALL: INTERRUPT INFERIOR"));
869 870 871
    m_engine->interruptInferior();
}

hjk's avatar
hjk committed
872 873
void DebuggerEnginePrivate::doShutdownInferior()
{
874
    QTC_ASSERT(state() == InferiorShutdownRequested, qDebug() << state());
875
    resetLocation();
hjk's avatar
hjk committed
876
    m_targetState = DebuggerFinished;
hjk's avatar
hjk committed
877
    m_engine->showMessage(_("CALL: SHUTDOWN INFERIOR"));
hjk's avatar
hjk committed
878 879 880 881 882 883
    m_engine->shutdownInferior();
}

void DebuggerEngine::notifyInferiorShutdownOk()
{
    showMessage(_("INFERIOR SUCCESSFULLY SHUT DOWN"));
hjk's avatar
hjk committed
884
    QTC_ASSERT(state() == InferiorShutdownRequested, qDebug() << state());
hjk's avatar
hjk committed
885 886
    d->m_lastGoodState = DebuggerNotReady; // A "neutral" value.
    setState(InferiorShutdownOk);
hjk's avatar
hjk committed
887
    d->queueShutdownEngine();
hjk's avatar
hjk committed
888 889 890 891 892
}

void DebuggerEngine::notifyInferiorShutdownFailed()
{
    showMessage(_("INFERIOR SHUTDOWN FAILED"));
Friedemann Kleint's avatar
Friedemann Kleint committed
893
    QTC_ASSERT(state() == InferiorShutdownRequested, qDebug() << this << state());
hjk's avatar
hjk committed
894
    setState(InferiorShutdownFailed);
hjk's avatar
hjk committed
895
    d->queueShutdownEngine();
hjk's avatar
hjk committed
896 897 898 899
}

void DebuggerEngine::notifyInferiorIll()
{
hjk's avatar
hjk committed
900
    showMessage(_("NOTE: INFERIOR ILL"));
hjk's avatar
hjk committed
901 902 903 904 905 906 907 908 909 910 911
    // 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
912
    d->queueShutdownInferior();
hjk's avatar
hjk committed
913 914 915 916
}

void DebuggerEnginePrivate::doShutdownEngine()
{
917
    QTC_ASSERT(state() == EngineShutdownRequested, qDebug() << state());
hjk's avatar
hjk committed
918
    m_targetState = DebuggerFinished;
hjk's avatar
hjk committed
919
    m_engine->showMessage(_("CALL: SHUTDOWN ENGINE"));
hjk's avatar
hjk committed
920 921 922 923 924
    m_engine->shutdownEngine();
}

void DebuggerEngine::notifyEngineShutdownOk()
{
hjk's avatar
hjk committed
925
    showMessage(_("NOTE: ENGINE SHUTDOWN OK"));
hjk's avatar
hjk committed
926 927
    QTC_ASSERT(state() == EngineShutdownRequested, qDebug() << state());
    setState(EngineShutdownOk);
928
    d->queueFinishDebugger();
hjk's avatar
hjk committed
929 930 931
}

void DebuggerEngine::notifyEngineShutdownFailed()
hjk's avatar
hjk committed
932
{
hjk's avatar
hjk committed
933
    showMessage(_("NOTE: ENGINE SHUTDOWN FAILED"));
hjk's avatar
hjk committed
934 935
    QTC_ASSERT(state() == EngineShutdownRequested, qDebug() << state());
    setState(EngineShutdownFailed);
936
    d->queueFinishDebugger();