debuggerengine.cpp 44.9 KB
Newer Older
1 2 3 4
/**************************************************************************
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
6 7 8
**
** 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"
Friedemann Kleint's avatar
Friedemann Kleint committed
42
#include "debuggerstartparameters.h"
43

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

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

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

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

81 82 83 84
enum { debug = 0 };

#define SDEBUG(s) if (!debug) {} else qDebug() << s;
#define XSDEBUG(s) qDebug() << s
85

86

87 88 89 90 91 92
///////////////////////////////////////////////////////////////////////
//
// DebuggerStartParameters
//
///////////////////////////////////////////////////////////////////////

93 94
namespace Debugger {

Friedemann Kleint's avatar
Friedemann Kleint committed
95 96 97 98 99 100 101 102 103 104 105
Internal::Location::Location(const StackFrame &frame, bool marker)
{
    init();
    m_fileName = frame.file;
    m_lineNumber = frame.line;
    m_needsMarker = marker;
    m_functionName = frame.function;
    m_hasDebugInfo = frame.isUsable();
    m_address = frame.address;
}

106 107
QDebug operator<<(QDebug d, DebuggerState state)
{
hjk's avatar
hjk committed
108 109
    //return d << DebuggerEngine::stateName(state) << '(' << int(state) << ')';
    return d << DebuggerEngine::stateName(state);
110 111 112 113 114 115 116
}

QDebug operator<<(QDebug str, const DebuggerStartParameters &sp)
{
    QDebug nospace = str.nospace();
    nospace << "executable=" << sp.executable
            << " coreFile=" << sp.coreFile
117
            << " processArgs=" << sp.processArgs
118 119 120 121 122 123 124
            << " 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
125
            << " useServerStartScript=" << sp.useServerStartScript
126 127 128 129 130
            << " serverStartScript=" << sp.serverStartScript
            << " toolchain=" << sp.toolChainType << '\n';
    return str;
}

131

132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
///////////////////////////////////////////////////////////////////////
//
// 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() {}
};



154 155 156 157 158 159
//////////////////////////////////////////////////////////////////////
//
// DebuggerEnginePrivate
//
//////////////////////////////////////////////////////////////////////

160
class DebuggerEnginePrivate : public QObject
161
{
162 163
    Q_OBJECT

164
public:
165 166 167
    DebuggerEnginePrivate(DebuggerEngine *engine,
            DebuggerEngine *masterEngine,
            const DebuggerStartParameters &sp)
168
      : m_engine(engine),
169
        m_masterEngine(masterEngine),
170 171 172
        m_runControl(0),
        m_startParameters(sp),
        m_state(DebuggerNotReady),
hjk's avatar
hjk committed
173
        m_lastGoodState(DebuggerNotReady),
Friedemann Kleint's avatar
Friedemann Kleint committed
174
        m_targetState(DebuggerNotReady),
175
        m_modulesHandler(),
176
        m_registerHandler(),
177 178
        m_sourceFilesHandler(),
        m_stackHandler(),
hjk's avatar
hjk committed
179
        m_threadsHandler(),
180
        m_watchHandler(engine),
181
        m_disassemblerAgent(engine),
182 183
        m_memoryAgent(engine),
        m_isStateDebugging(false)
184
    {
185
        connect(&m_locationTimer, SIGNAL(timeout()), SLOT(resetLocation()));
186
    }
187 188

    ~DebuggerEnginePrivate() {}
189

190
public slots:
191
    void doSetupEngine();
hjk's avatar
hjk committed
192 193
    void doSetupInferior();
    void doRunEngine();
hjk's avatar
hjk committed
194 195
    void doShutdownEngine();
    void doShutdownInferior();
196
    void doInterruptInferior();
hjk's avatar
hjk committed
197
    void doFinishDebugger();
hjk's avatar
hjk committed
198

199 200 201 202 203 204 205 206 207 208 209 210 211 212
    void queueSetupEngine()
    {
        m_engine->setState(EngineSetupRequested);
        m_engine->showMessage(_("QUEUE: SETUP ENGINE"));
        QTimer::singleShot(0, this, SLOT(doSetupEngine()));
    }

    void queueSetupInferior()
    {
        m_engine->setState(InferiorSetupRequested);
        m_engine->showMessage(_("QUEUE: SETUP INFERIOR"));
        QTimer::singleShot(0, this, SLOT(doSetupInferior()));
    }

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

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

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

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

243 244
    void raiseApplication()
    {
245 246
        QTC_ASSERT(runControl(), return);
        runControl()->bringApplicationToForeground(m_inferiorPid);
247 248
    }

249
    void scheduleResetLocation()
250
    {
251
        m_stackHandler.scheduleResetLocation();
252 253 254 255
        m_locationTimer.setSingleShot(true);
        m_locationTimer.start(80);
    }

256
    void resetLocation()
257 258 259
    {
        m_locationTimer.stop();
        m_locationMark.reset();
260 261
        m_stackHandler.resetLocation();
        m_disassemblerAgent.resetLocation();
262 263
    }

264
public:
hjk's avatar
hjk committed
265
    DebuggerState state() const { return m_state; }
266 267 268
    bool isMasterEngine() const { return m_engine->isMasterEngine(); }
    DebuggerRunControl *runControl() const
        { return m_masterEngine ? m_masterEngine->runControl() : m_runControl; }
hjk's avatar
hjk committed
269

270
    DebuggerEngine *m_engine; // Not owned.
271
    DebuggerEngine *m_masterEngine; // Not owned
272 273 274
    DebuggerRunControl *m_runControl;  // Not owned.

    DebuggerStartParameters m_startParameters;
hjk's avatar
hjk committed
275 276

    // The current state.
277 278
    DebuggerState m_state;

hjk's avatar
hjk committed
279 280 281 282 283 284
    // The state we had before something unexpected happend.
    DebuggerState m_lastGoodState;

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

285 286 287 288 289 290 291 292
    qint64 m_inferiorPid;

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

295 296
    DisassemblerAgent m_disassemblerAgent;
    MemoryAgent m_memoryAgent;
297 298
    QScopedPointer<TextEditor::BaseTextMark> m_locationMark;
    QTimer m_locationTimer;
299 300

    bool m_isStateDebugging;
301 302 303 304 305 306 307 308 309
};


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

310 311 312
DebuggerEngine::DebuggerEngine(const DebuggerStartParameters &startParameters,
        DebuggerEngine *parentEngine)
  : d(new DebuggerEnginePrivate(this, parentEngine, startParameters))
313 314 315 316 317
{
}

DebuggerEngine::~DebuggerEngine()
{
318 319
    disconnect();
    delete d;
320 321
}

322 323 324 325 326 327 328 329 330 331 332
const char *DebuggerEngine::stateName(int s)
{
#    define SN(x) case x: return #x;
    switch (s) {
        SN(DebuggerNotReady)
        SN(EngineSetupRequested)
        SN(EngineSetupOk)
        SN(EngineSetupFailed)
        SN(EngineRunFailed)
        SN(InferiorSetupRequested)
        SN(InferiorSetupFailed)
333
        SN(InferiorSetupOk)
334 335 336 337 338 339 340 341
        SN(EngineRunRequested)
        SN(InferiorRunRequested)
        SN(InferiorRunOk)
        SN(InferiorRunFailed)
        SN(InferiorUnrunnable)
        SN(InferiorStopRequested)
        SN(InferiorStopOk)
        SN(InferiorStopFailed)
342
        SN(InferiorExitOk)
343 344 345 346 347 348 349 350 351 352 353 354
        SN(InferiorShutdownRequested)
        SN(InferiorShutdownOk)
        SN(InferiorShutdownFailed)
        SN(EngineShutdownRequested)
        SN(EngineShutdownOk)
        SN(EngineShutdownFailed)
        SN(DebuggerFinished)
    }
    return "<unknown>";
#    undef SN
}

355
void DebuggerEngine::showStatusMessage(const QString &msg, int timeout) const
356
{
357
    showMessage(msg, StatusBar, timeout);
358
}
359

360 361 362 363 364 365
void DebuggerEngine::removeTooltip()
{
    watchHandler()->removeTooltip();
    hideDebuggerToolTip();
}

366 367 368 369 370 371 372 373 374 375 376 377 378 379
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
{
380 381 382
    return d->m_masterEngine
        ? d->m_masterEngine->modulesHandler()
        : &d->m_modulesHandler;
383 384 385 386
}

RegisterHandler *DebuggerEngine::registerHandler() const
{
387 388 389
    return d->m_masterEngine
        ? d->m_masterEngine->registerHandler()
        : &d->m_registerHandler;
390 391 392 393
}

StackHandler *DebuggerEngine::stackHandler() const
{
hjk's avatar
hjk committed
394 395 396 397
    //return d->m_masterEngine
    //    ? d->m_masterEngine->stackHandler()
    //    : &d->m_stackHandler;
    return &d->m_stackHandler;
398 399 400 401
}

ThreadsHandler *DebuggerEngine::threadsHandler() const
{
402 403 404
    return d->m_masterEngine
        ? d->m_masterEngine->threadsHandler()
        : &d->m_threadsHandler;
405 406 407 408
}

WatchHandler *DebuggerEngine::watchHandler() const
{
409 410 411
    return d->m_masterEngine
        ? d->m_masterEngine->watchHandler()
        : &d->m_watchHandler;
412 413 414 415
}

SourceFilesHandler *DebuggerEngine::sourceFilesHandler() const
{
416 417 418
    return d->m_masterEngine
        ? d->m_masterEngine->sourceFilesHandler()
        : &d->m_sourceFilesHandler;
419 420 421 422
}

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

QAbstractItemModel *DebuggerEngine::registerModel() const
{
431
    QAbstractItemModel *model = registerHandler()->model();
Friedemann Kleint's avatar
Friedemann Kleint committed
432 433 434
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("RegisterModel"));
    return model;
435 436 437 438
}

QAbstractItemModel *DebuggerEngine::stackModel() const
{
439
    QAbstractItemModel *model = stackHandler()->model();
Friedemann Kleint's avatar
Friedemann Kleint committed
440 441 442
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("StackModel"));
    return model;
443 444 445 446
}

QAbstractItemModel *DebuggerEngine::threadsModel() const
{
447
    QAbstractItemModel *model = threadsHandler()->model();
Friedemann Kleint's avatar
Friedemann Kleint committed
448 449 450
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("ThreadsModel"));
    return model;
451 452 453 454
}

QAbstractItemModel *DebuggerEngine::localsModel() const
{
455
    QAbstractItemModel *model = watchHandler()->model(LocalsWatch);
Friedemann Kleint's avatar
Friedemann Kleint committed
456 457 458
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("LocalsModel"));
    return model;
459 460 461 462
}

QAbstractItemModel *DebuggerEngine::watchersModel() const
{
463
    QAbstractItemModel *model = watchHandler()->model(WatchersWatch);
Friedemann Kleint's avatar
Friedemann Kleint committed
464 465 466
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("WatchersModel"));
    return model;
467 468 469 470
}

QAbstractItemModel *DebuggerEngine::returnModel() const
{
471
    QAbstractItemModel *model = watchHandler()->model(ReturnWatch);
Friedemann Kleint's avatar
Friedemann Kleint committed
472 473 474
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("ReturnModel"));
    return model;
475 476 477 478
}

QAbstractItemModel *DebuggerEngine::sourceFilesModel() const
{
479
    QAbstractItemModel *model = sourceFilesHandler()->model();
Friedemann Kleint's avatar
Friedemann Kleint committed
480 481 482
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("SourceFilesModel"));
    return model;
483 484
}

485
void DebuggerEngine::fetchMemory(MemoryAgent *, QObject *,
486 487 488 489 490 491 492 493 494 495 496 497 498 499
        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
{
500 501 502 503
    if (d->m_masterEngine) {
        d->m_masterEngine->showMessage(msg, channel, timeout);
        return;
    }
504 505
    //if (msg.size() && msg.at(0).isUpper() && msg.at(1).isUpper())
    //    qDebug() << qPrintable(msg) << "IN STATE" << state();
506
    debuggerCore()->showMessage(msg, channel, timeout);
507 508 509 510 511
    if (d->m_runControl) {
        d->m_runControl->showMessage(msg, channel);
    } else {
        qWarning("Warning: %s (no active run control)", qPrintable(msg));
    }
512 513 514 515
}

void DebuggerEngine::startDebugger(DebuggerRunControl *runControl)
{
516 517
    QTC_ASSERT(runControl, notifyEngineSetupFailed(); return);
    QTC_ASSERT(!d->m_runControl, notifyEngineSetupFailed(); return);
518

519 520 521 522 523 524 525
    d->m_progress.setProgressRange(0, 1000);
    Core::FutureProgress *fp = Core::ICore::instance()->progressManager()
        ->addTask(d->m_progress.future(),
        tr("Launching"), _("Debugger.Launcher"));
    fp->setKeepOnFinish(Core::FutureProgress::DontKeepOnFinish);
    d->m_progress.reportStarted();

526 527 528 529 530
    d->m_runControl = runControl;

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

531 532
    if (!d->m_startParameters.environment.size())
        d->m_startParameters.environment = Utils::Environment();
533 534

    const unsigned engineCapabilities = debuggerCapabilities();
hjk's avatar
hjk committed
535
    debuggerCore()->action(OperateByInstruction)
536 537
        ->setEnabled(engineCapabilities & DisassemblerCapability);

538 539
    QTC_ASSERT(state() == DebuggerNotReady || state() == DebuggerFinished,
         qDebug() << state());
540 541
    d->m_lastGoodState = DebuggerNotReady;
    d->m_targetState = DebuggerNotReady;
542
    d->m_progress.setProgressValue(200);
543
    d->queueSetupEngine();
544 545 546 547
}

void DebuggerEngine::resetLocation()
{
548 549
    // Do it after some delay to avoid flicker.
    d->scheduleResetLocation();
550 551
}

552
void DebuggerEngine::gotoLocation(const Location &loc)
553
{
554 555 556 557 558
    if (debuggerCore()->boolSetting(OperateByInstruction) || !loc.hasDebugInfo()) {
        d->m_disassemblerAgent.setTryMixed(true);
        d->m_disassemblerAgent.setLocation(loc);
        return;
    }
559 560 561 562
    // CDB might hit on breakpoints while shutting down.
    //if (m_shuttingDown)
    //    return;

563
    d->resetLocation();
564

565 566
    const QString file = loc.fileName();
    const int line = loc.lineNumber();
hjk's avatar
hjk committed
567 568
    EditorManager *editorManager = EditorManager::instance();
    QList<IEditor *> editors = editorManager->editorsForFileName(file);
569
    IEditor *editor = 0;
hjk's avatar
hjk committed
570
    if (editors.isEmpty()) {
571 572 573 574 575 576 577 578
        editor = editorManager->openEditor(file, QString(),
            EditorManager::IgnoreNavigationHistory);
        if (editor) {
            editors.append(editor);
            editor->setProperty(Constants::OPENED_BY_DEBUGGER, true);
        }
    } else {
        editor = editors.back();
hjk's avatar
hjk committed
579
    }
580
    ITextEditor *texteditor = qobject_cast<ITextEditor *>(editor);
hjk's avatar
hjk committed
581 582 583
    if (texteditor)
        texteditor->gotoLine(line, 0);

584
    if (loc.needsMarker())
585
        d->m_locationMark.reset(new LocationMark(file, line));
586 587

    // FIXME: Breaks with split views.
588
    if (!d->m_memoryAgent.hasVisibleEditor() || loc.needsRaise())
589
        editorManager->activateEditor(editor);
590
    //qDebug() << "MEMORY: " << d->m_memoryAgent.hasVisibleEditor();
591 592
}

593 594 595
// Called from RunControl.
void DebuggerEngine::handleStartFailed()
{
596
    showMessage("HANDLE RUNCONTROL START FAILED");
597
    d->m_runControl = 0;
598
    d->m_progress.setProgressValue(900);
599 600
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
601 602
}

603 604
// Called from RunControl.
void DebuggerEngine::handleFinished()
605
{
606
    showMessage("HANDLE RUNCONTROL FINISHED");
607
    d->m_runControl = 0;
608 609 610 611
    modulesHandler()->removeAll();
    stackHandler()->removeAll();
    threadsHandler()->removeAll();
    watchHandler()->cleanup();
612
    d->m_progress.setProgressValue(1000);
613
    d->m_progress.reportFinished();
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
}

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
638
    return debuggerCore()->boolSetting(UseDebuggingHelpers);
639 640 641 642
}

QStringList DebuggerEngine::qtDumperLibraryLocations() const
{
hjk's avatar
hjk committed
643
    if (debuggerCore()->action(UseCustomDebuggingHelperLocation)->value().toBool()) {
644
        const QString customLocation =
hjk's avatar
hjk committed
645
            debuggerCore()->action(CustomDebuggingHelperLocation)->value().toString();
646 647 648 649 650 651 652 653 654
        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)
{
655
    debuggerCore()->showQtDumperLibraryWarning(details);
656 657 658 659
}

QString DebuggerEngine::qtDumperLibraryName() const
{
hjk's avatar
hjk committed
660 661
    if (debuggerCore()->action(UseCustomDebuggingHelperLocation)->value().toBool())
        return debuggerCore()->action(CustomDebuggingHelperLocation)->value().toString();
662 663 664 665 666 667 668 669
    return startParameters().dumperLibrary;
}

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

hjk's avatar
hjk committed
670
DebuggerState DebuggerEngine::lastGoodState() const
671
{
hjk's avatar
hjk committed
672 673 674 675 676 677 678
    return d->m_lastGoodState;
}

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

hjk's avatar
hjk committed
680 681 682
static bool isAllowedTransition(DebuggerState from, DebuggerState to)
{
    switch (from) {
683
    case DebuggerNotReady:
684
        return to == EngineSetupRequested;
685

hjk's avatar
hjk committed
686
    case EngineSetupRequested:
687 688
        return to == EngineSetupOk || to == EngineSetupFailed;
    case EngineSetupFailed:
689 690 691
        // In is the engine's task to go into a proper "Shutdown"
        // state before calling notifyEngineSetupFailed
        return to == DebuggerFinished;
692
    case EngineSetupOk:
hjk's avatar
hjk committed
693
        return to == InferiorSetupRequested || to == EngineShutdownRequested;
694

hjk's avatar
hjk committed
695
    case InferiorSetupRequested:
696
        return to == InferiorSetupOk || to == InferiorSetupFailed;
hjk's avatar
hjk committed
697
    case InferiorSetupFailed:
hjk's avatar
hjk committed
698
        return to == EngineShutdownRequested;
699 700
    case InferiorSetupOk:
        return to == EngineRunRequested;
hjk's avatar
hjk committed
701 702

    case EngineRunRequested:
hjk's avatar
hjk committed
703 704 705 706
        return to == EngineRunFailed
            || to == InferiorRunOk
            || to == InferiorStopOk
            || to == InferiorUnrunnable;
hjk's avatar
hjk committed
707
    case EngineRunFailed:
708
        return to == EngineShutdownRequested;
hjk's avatar
hjk committed
709 710 711 712 713 714

    case InferiorRunRequested:
        return to == InferiorRunOk || to == InferiorRunFailed;
    case InferiorRunFailed:
        return to == InferiorStopOk;
    case InferiorRunOk:
715 716 717
        return to == InferiorStopRequested
            || to == InferiorStopOk // A spontaneous stop.
            || to == InferiorExitOk;
hjk's avatar
hjk committed
718 719 720 721 722

    case InferiorStopRequested:
        return to == InferiorStopOk || to == InferiorStopFailed;
    case InferiorStopOk:
        return to == InferiorRunRequested || to == InferiorShutdownRequested
723
            || to == InferiorStopOk || InferiorExitOk;
724
    case InferiorStopFailed:
hjk's avatar
hjk committed
725
        return to == EngineShutdownRequested;
726

727 728 729
    case InferiorExitOk:
        return to == InferiorShutdownOk;

730
    case InferiorUnrunnable:
hjk's avatar
hjk committed
731 732 733 734 735
        return to == InferiorShutdownRequested;
    case InferiorShutdownRequested:
        return to == InferiorShutdownOk || to == InferiorShutdownFailed;
    case InferiorShutdownOk:
        return to == EngineShutdownRequested;
736
    case InferiorShutdownFailed:
hjk's avatar
hjk committed
737
        return to == EngineShutdownRequested;
738

hjk's avatar
hjk committed
739
    case EngineShutdownRequested:
740
        return to == EngineShutdownOk || to == EngineShutdownFailed;
hjk's avatar
hjk committed
741 742 743 744 745 746
    case EngineShutdownOk:
        return to == DebuggerFinished;
    case EngineShutdownFailed:
        return to == DebuggerFinished;

    case DebuggerFinished:
747
        return to == EngineSetupRequested; // Happens on restart.
748 749
    }

750
    qDebug() << "UNKNOWN DEBUGGER STATE:" << from;
751 752 753
    return false;
}

754 755 756 757 758 759 760 761 762 763 764 765 766
void DebuggerEngine::setupSlaveEngine()
{
    QTC_ASSERT(state() == DebuggerNotReady, /**/);
    d->queueSetupEngine();
}

void DebuggerEnginePrivate::doSetupEngine()
{
    m_engine->showMessage(_("CALL: SETUP ENGINE"));
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << m_engine << state());
    m_engine->setupEngine();
}

767
void DebuggerEngine::notifyEngineSetupFailed()
hjk's avatar
hjk committed
768
{
hjk's avatar
hjk committed
769
    showMessage(_("NOTE: ENGINE SETUP FAILED"));
770
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << this << state());
771
    setState(EngineSetupFailed);
hjk's avatar
hjk committed
772
    if (isMasterEngine() && runControl())
773
        runControl()->startFailed();
hjk's avatar
hjk committed
774
    setState(DebuggerFinished);
hjk's avatar
hjk committed
775 776
}

777
void DebuggerEngine::notifyEngineSetupOk()
778
{
hjk's avatar
hjk committed
779
    showMessage(_("NOTE: ENGINE SETUP OK"));
780
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << this << state());
781
    setState(EngineSetupOk);
hjk's avatar
hjk committed
782
    showMessage(_("QUEUE: SETUP INFERIOR"));
783
    if (isMasterEngine())
784 785 786 787 788 789 790
        d->queueSetupInferior();
}

void DebuggerEngine::setupSlaveInferior()
{
    QTC_ASSERT(state() == EngineSetupOk, /**/);
    d->queueSetupInferior();
791 792
}

hjk's avatar
hjk committed
793
void DebuggerEnginePrivate::doSetupInferior()
794
{
795
    m_engine->showMessage(_("CALL: SETUP INFERIOR"));
796
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << m_engine << state());
797
    m_progress.setProgressValue(250);
hjk's avatar
hjk committed
798 799 800 801 802
    m_engine->setupInferior();
}

void DebuggerEngine::notifyInferiorSetupFailed()
{
hjk's avatar
hjk committed
803
    showMessage(_("NOTE: INFERIOR SETUP FAILED"));
804
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << this << state());
hjk's avatar
hjk committed
805
    setState(InferiorSetupFailed);
806 807
    if (isMasterEngine())
        d->queueShutdownEngine();
hjk's avatar
hjk committed
808 809 810 811
}

void DebuggerEngine::notifyInferiorSetupOk()
{
hjk's avatar
hjk committed
812
    showMessage(_("NOTE: INFERIOR SETUP OK"));
813 814 815 816
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << this << state());
    setState(InferiorSetupOk);
    if (isMasterEngine())
        d->queueRunEngine();
hjk's avatar
hjk committed
817 818
}

819 820 821 822 823 824 825
void DebuggerEngine::runSlaveEngine()
{
    QTC_ASSERT(isSlaveEngine(), return);
    QTC_ASSERT(state() == InferiorSetupOk, /**/);
    d->queueRunEngine();
}

hjk's avatar
hjk committed
826 827
void DebuggerEnginePrivate::doRunEngine()
{
hjk's avatar
hjk committed
828
    m_engine->showMessage(_("CALL: RUN ENGINE"));
829
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << m_engine << state());
830
    m_progress.setProgressValue(300);
hjk's avatar
hjk committed
831 832 833
    m_engine->runEngine();
}

hjk's avatar
hjk committed
834 835
void DebuggerEngine::notifyInferiorUnrunnable()
{
hjk's avatar
hjk committed
836
    showMessage(_("NOTE: INFERIOR UNRUNNABLE"));
837 838
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
839
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << this << state());
hjk's avatar
hjk committed
840 841 842 843 844
    setState(InferiorUnrunnable);
}

void DebuggerEngine::notifyEngineRunFailed()
{
hjk's avatar
hjk committed
845
    showMessage(_("NOTE: ENGINE RUN FAILED"));
846
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << this << state());
847 848 849
    d->m_progress.setProgressValue(900);
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
850
    setState(EngineRunFailed);
851 852
    if (isMasterEngine())
        d->queueShutdownEngine();
hjk's avatar
hjk committed
853 854 855 856
}

void DebuggerEngine::notifyEngineRunAndInferiorRunOk()
{
hjk's avatar
hjk committed
857
    showMessage(_("NOTE: ENGINE RUN AND INFERIOR RUN OK"));
858 859
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
860
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << this << state());
hjk's avatar
hjk committed
861
    setState(InferiorRunOk);
hjk's avatar
hjk committed
862 863 864 865
}

void DebuggerEngine::notifyEngineRunAndInferiorStopOk()
{
hjk's avatar
hjk committed
866
    showMessage(_("NOTE: ENGINE RUN AND INFERIOR STOP OK"));
867 868
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
869
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << this << state());
hjk's avatar
hjk committed
870
    setState(InferiorStopOk);
hjk's avatar
hjk committed
871 872 873 874
}

void DebuggerEngine::notifyInferiorRunRequested()
{
hjk's avatar
hjk committed
875
    showMessage(_("NOTE: INFERIOR RUN REQUESTED"));
876
    QTC_ASSERT(state() == InferiorStopOk, qDebug() << this << state());
hjk's avatar
hjk committed
877 878 879 880 881
    setState(InferiorRunRequested);
}

void DebuggerEngine::notifyInferiorRunOk()
{
hjk's avatar
hjk committed
882
    showMessage(_("NOTE: INFERIOR RUN OK"));
883
    QTC_ASSERT(state() == InferiorRunRequested, qDebug() << this << state());
hjk's avatar
hjk committed
884 885 886 887 888
    setState(InferiorRunOk);
}

void DebuggerEngine::notifyInferiorRunFailed()
{
hjk's avatar
hjk committed
889
    showMessage(_("NOTE: INFERIOR RUN FAILED"));
890
    QTC_ASSERT(state() == InferiorRunRequested, qDebug() << this << state());
hjk's avatar
hjk committed
891 892
    setState(InferiorRunFailed);
    setState(InferiorStopOk);
hjk's avatar
hjk committed
893 894
    if (isDying())
        d->queueShutdownInferior();
hjk's avatar
hjk committed
895 896 897 898
}

void DebuggerEngine::notifyInferiorStopOk()
{
hjk's avatar
hjk committed
899 900
    showMessage(_("NOTE: INFERIOR STOP OK"));
    // Ignore spurious notifications after we are set to die.
hjk's avatar
hjk committed
901
    if (isDying()) {
hjk's avatar
hjk committed
902 903 904 905 906 907 908 909 910 911 912 913 914
        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
915
    }
916
    QTC_ASSERT(state() == InferiorStopRequested, qDebug() << this << state());
hjk's avatar
hjk committed
917
    setState(InferiorStopOk);
hjk's avatar
hjk committed
918 919
}

hjk's avatar
hjk committed
920
void DebuggerEngine::notifyInferiorSpontaneousStop()
921
{
hjk's avatar
hjk committed
922
    showMessage(_("NOTE: INFERIOR SPONTANEOUES STOP"));
923
    QTC_ASSERT(state() == InferiorRunOk, qDebug() << this << state());
924
    setState(InferiorStopOk);
925 926
}

hjk's avatar
hjk committed
927
void DebuggerEngine::notifyInferiorStopFailed()