debuggerengine.cpp 42.3 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

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 {

Friedemann Kleint's avatar
Friedemann Kleint committed
98 99 100 101 102 103 104 105 106 107 108
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;
}

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

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

134

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



157 158 159 160 161 162
//////////////////////////////////////////////////////////////////////
//
// DebuggerEnginePrivate
//
//////////////////////////////////////////////////////////////////////

163
class DebuggerEnginePrivate : public QObject
164
{
165 166
    Q_OBJECT

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

    ~DebuggerEnginePrivate() {}
191

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

200 201
    void queueRunEngine()
    {
hjk's avatar
hjk committed
202 203 204 205 206
        m_engine->setState(EngineRunRequested);
        m_engine->showMessage(_("QUEUE: RUN ENGINE"));
        QTimer::singleShot(0, this, SLOT(doRunEngine()));
    }

207 208
    void queueShutdownEngine()
    {
hjk's avatar
hjk committed
209 210 211 212 213
        m_engine->setState(EngineShutdownRequested);
        m_engine->showMessage(_("QUEUE: SHUTDOWN ENGINE"));
        QTimer::singleShot(0, this, SLOT(doShutdownEngine()));
    }

214 215
    void queueShutdownInferior()
    {
hjk's avatar
hjk committed
216 217 218 219 220
        m_engine->setState(InferiorShutdownRequested);
        m_engine->showMessage(_("QUEUE: SHUTDOWN INFERIOR"));
        QTimer::singleShot(0, this, SLOT(doShutdownInferior()));
    }

221 222
    void queueFinishDebugger()
    {
223 224 225 226
        QTC_ASSERT(state() == EngineShutdownOk
            || state() == EngineShutdownFailed, qDebug() << state());
        m_engine->setState(DebuggerFinished);
        m_engine->showMessage(_("QUEUE: FINISH DEBUGGER"));
hjk's avatar
hjk committed
227 228 229
        QTimer::singleShot(0, this, SLOT(doFinishDebugger()));
    }

230 231
    void raiseApplication()
    {
hjk's avatar
hjk committed
232
        QTC_ASSERT(m_runControl, return);
233 234 235
        m_runControl->bringApplicationToForeground(m_inferiorPid);
    }

236
    void scheduleResetLocation()
237
    {
238
        m_stackHandler.scheduleResetLocation();
239 240 241 242
        m_locationTimer.setSingleShot(true);
        m_locationTimer.start(80);
    }

243
    void resetLocation()
244 245 246
    {
        m_locationTimer.stop();
        m_locationMark.reset();
247 248
        m_stackHandler.resetLocation();
        m_disassemblerAgent.resetLocation();
249 250
    }

251
public:
hjk's avatar
hjk committed
252 253
    DebuggerState state() const { return m_state; }

254
    DebuggerEngine *m_engine; // Not owned.
255
    DebuggerEngine *m_masterEngine; // Not owned
256 257 258
    DebuggerRunControl *m_runControl;  // Not owned.

    DebuggerStartParameters m_startParameters;
hjk's avatar
hjk committed
259 260

    // The current state.
261 262
    DebuggerState m_state;

hjk's avatar
hjk committed
263 264 265 266 267 268
    // The state we had before something unexpected happend.
    DebuggerState m_lastGoodState;

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

269 270 271 272 273 274 275 276
    qint64 m_inferiorPid;

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

279 280
    DisassemblerAgent m_disassemblerAgent;
    MemoryAgent m_memoryAgent;
281 282
    QScopedPointer<TextEditor::BaseTextMark> m_locationMark;
    QTimer m_locationTimer;
283 284 285 286 287 288 289 290 291
};


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

292 293 294
DebuggerEngine::DebuggerEngine(const DebuggerStartParameters &startParameters,
        DebuggerEngine *parentEngine)
  : d(new DebuggerEnginePrivate(this, parentEngine, startParameters))
295 296 297 298 299
{
}

DebuggerEngine::~DebuggerEngine()
{
300 301
    disconnect();
    delete d;
302 303
}

304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
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)
        SN(EngineRunRequested)
        SN(InferiorRunRequested)
        SN(InferiorRunOk)
        SN(InferiorRunFailed)
        SN(InferiorUnrunnable)
        SN(InferiorStopRequested)
        SN(InferiorStopOk)
        SN(InferiorStopFailed)
        SN(InferiorShutdownRequested)
        SN(InferiorShutdownOk)
        SN(InferiorShutdownFailed)
        SN(EngineShutdownRequested)
        SN(EngineShutdownOk)
        SN(EngineShutdownFailed)
        SN(DebuggerFinished)
    }
    return "<unknown>";
#    undef SN
}

335
void DebuggerEngine::showStatusMessage(const QString &msg, int timeout) const
336
{
337
    showMessage(msg, StatusBar, timeout);
338
}
339

340 341 342 343 344 345
void DebuggerEngine::removeTooltip()
{
    watchHandler()->removeTooltip();
    hideDebuggerToolTip();
}

346 347 348 349 350 351 352 353 354 355 356 357 358 359
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
{
360 361 362
    return d->m_masterEngine
        ? d->m_masterEngine->modulesHandler()
        : &d->m_modulesHandler;
363 364 365 366
}

RegisterHandler *DebuggerEngine::registerHandler() const
{
367 368 369
    return d->m_masterEngine
        ? d->m_masterEngine->registerHandler()
        : &d->m_registerHandler;
370 371 372 373
}

StackHandler *DebuggerEngine::stackHandler() const
{
374 375 376
    return d->m_masterEngine
        ? d->m_masterEngine->stackHandler()
        : &d->m_stackHandler;
377 378 379 380
}

ThreadsHandler *DebuggerEngine::threadsHandler() const
{
381 382 383
    return d->m_masterEngine
        ? d->m_masterEngine->threadsHandler()
        : &d->m_threadsHandler;
384 385 386 387
}

WatchHandler *DebuggerEngine::watchHandler() const
{
388 389 390
    return d->m_masterEngine
        ? d->m_masterEngine->watchHandler()
        : &d->m_watchHandler;
391 392 393 394
}

SourceFilesHandler *DebuggerEngine::sourceFilesHandler() const
{
395 396 397
    return d->m_masterEngine
        ? d->m_masterEngine->sourceFilesHandler()
        : &d->m_sourceFilesHandler;
398 399 400 401
}

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

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

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

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

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

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

QAbstractItemModel *DebuggerEngine::returnModel() const
{
450
    QAbstractItemModel *model = watchHandler()->model(ReturnWatch);
Friedemann Kleint's avatar
Friedemann Kleint committed
451 452 453
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("ReturnModel"));
    return model;
454 455 456 457
}

QAbstractItemModel *DebuggerEngine::sourceFilesModel() const
{
458
    QAbstractItemModel *model = sourceFilesHandler()->model();
Friedemann Kleint's avatar
Friedemann Kleint committed
459 460 461
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("SourceFilesModel"));
    return model;
462 463
}

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

void DebuggerEngine::startDebugger(DebuggerRunControl *runControl)
{
hjk's avatar
hjk committed
491
    if (!isSlaveEngine()) {
492
        d->m_progress.setProgressRange(0, 1000);
493 494 495
        Core::FutureProgress *fp = Core::ICore::instance()->progressManager()
            ->addTask(d->m_progress.future(),
            tr("Launching"), _("Debugger.Launcher"));
496
        fp->setKeepOnFinish(Core::FutureProgress::DontKeepOnFinish);
497 498
        d->m_progress.reportStarted();
    }
499 500
    QTC_ASSERT(runControl, notifyEngineSetupFailed(); return);
    QTC_ASSERT(!d->m_runControl, notifyEngineSetupFailed(); return);
501 502 503 504 505 506

    d->m_runControl = runControl;

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

507 508
    if (!d->m_startParameters.environment.size())
        d->m_startParameters.environment = Utils::Environment();
509 510

    const unsigned engineCapabilities = debuggerCapabilities();
hjk's avatar
hjk committed
511
    debuggerCore()->action(OperateByInstruction)
512 513
        ->setEnabled(engineCapabilities & DisassemblerCapability);

514 515
    QTC_ASSERT(state() == DebuggerNotReady || state() == DebuggerFinished,
         qDebug() << state());
516 517
    d->m_lastGoodState = DebuggerNotReady;
    d->m_targetState = DebuggerNotReady;
hjk's avatar
hjk committed
518
    setState(EngineSetupRequested);
519

520
    d->m_progress.setProgressValue(200);
hjk's avatar
hjk committed
521
    setupEngine();
522 523 524 525
}

void DebuggerEngine::resetLocation()
{
526 527
    // Do it after some delay to avoid flicker.
    d->scheduleResetLocation();
528 529
}

530
void DebuggerEngine::gotoLocation(const Location &loc)
531
{
532 533 534 535 536
    if (debuggerCore()->boolSetting(OperateByInstruction) || !loc.hasDebugInfo()) {
        d->m_disassemblerAgent.setTryMixed(true);
        d->m_disassemblerAgent.setLocation(loc);
        return;
    }
537 538 539 540
    // CDB might hit on breakpoints while shutting down.
    //if (m_shuttingDown)
    //    return;

541
    d->resetLocation();
542

543 544
    const QString file = loc.fileName();
    const int line = loc.lineNumber();
hjk's avatar
hjk committed
545 546
    EditorManager *editorManager = EditorManager::instance();
    QList<IEditor *> editors = editorManager->editorsForFileName(file);
547
    IEditor *editor = 0;
hjk's avatar
hjk committed
548
    if (editors.isEmpty()) {
549 550 551 552 553 554 555 556
        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
557
    }
558
    ITextEditor *texteditor = qobject_cast<ITextEditor *>(editor);
hjk's avatar
hjk committed
559 560 561
    if (texteditor)
        texteditor->gotoLine(line, 0);

562
    if (loc.needsMarker())
563
        d->m_locationMark.reset(new LocationMark(file, line));
564 565

    // FIXME: Breaks with split views.
566
    if (!d->m_memoryAgent.hasVisibleEditor() || loc.needsRaise())
567
        editorManager->activateEditor(editor);
568
    //qDebug() << "MEMORY: " << d->m_memoryAgent.hasVisibleEditor();
569 570
}

571 572 573
// Called from RunControl.
void DebuggerEngine::handleStartFailed()
{
574
    showMessage("HANDLE RUNCONTROL START FAILED");
575
    d->m_runControl = 0;
576
    d->m_progress.setProgressValue(900);
577 578
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
579 580
}

581 582
// Called from RunControl.
void DebuggerEngine::handleFinished()
583
{
584
    showMessage("HANDLE RUNCONTROL FINISHED");
585
    d->m_runControl = 0;
586 587 588 589
    modulesHandler()->removeAll();
    stackHandler()->removeAll();
    threadsHandler()->removeAll();
    watchHandler()->cleanup();
590
    d->m_progress.setProgressValue(1000);
591
    d->m_progress.reportFinished();
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
}

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
616
    return debuggerCore()->boolSetting(UseDebuggingHelpers);
617 618 619 620
}

QStringList DebuggerEngine::qtDumperLibraryLocations() const
{
hjk's avatar
hjk committed
621
    if (debuggerCore()->action(UseCustomDebuggingHelperLocation)->value().toBool()) {
622
        const QString customLocation =
hjk's avatar
hjk committed
623
            debuggerCore()->action(CustomDebuggingHelperLocation)->value().toString();
624 625 626 627 628 629 630 631 632
        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)
{
633
    debuggerCore()->showQtDumperLibraryWarning(details);
634 635 636 637
}

QString DebuggerEngine::qtDumperLibraryName() const
{
hjk's avatar
hjk committed
638 639
    if (debuggerCore()->action(UseCustomDebuggingHelperLocation)->value().toBool())
        return debuggerCore()->action(CustomDebuggingHelperLocation)->value().toString();
640 641 642 643 644 645 646 647
    return startParameters().dumperLibrary;
}

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

hjk's avatar
hjk committed
648
DebuggerState DebuggerEngine::lastGoodState() const
649
{
hjk's avatar
hjk committed
650 651 652 653 654 655 656
    return d->m_lastGoodState;
}

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

hjk's avatar
hjk committed
658 659 660
static bool isAllowedTransition(DebuggerState from, DebuggerState to)
{
    switch (from) {
661
    case DebuggerNotReady:
662
        return to == EngineSetupRequested;
663

hjk's avatar
hjk committed
664
    case EngineSetupRequested:
665 666
        return to == EngineSetupOk || to == EngineSetupFailed;
    case EngineSetupFailed:
667 668 669
        // In is the engine's task to go into a proper "Shutdown"
        // state before calling notifyEngineSetupFailed
        return to == DebuggerFinished;
670
    case EngineSetupOk:
hjk's avatar
hjk committed
671
        return to == InferiorSetupRequested || to == EngineShutdownRequested;
672

hjk's avatar
hjk committed
673 674
    case InferiorSetupRequested:
        return to == EngineRunRequested || to == InferiorSetupFailed;
hjk's avatar
hjk committed
675
    case InferiorSetupFailed:
hjk's avatar
hjk committed
676 677 678 679 680 681 682
        return to == EngineShutdownRequested;

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

    case EngineRunFailed:
683
        return to == EngineShutdownRequested;
hjk's avatar
hjk committed
684 685 686 687 688 689 690 691 692 693 694 695 696

    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;
697
    case InferiorStopFailed:
hjk's avatar
hjk committed
698
        return to == EngineShutdownRequested;
699 700

    case InferiorUnrunnable:
hjk's avatar
hjk committed
701 702 703 704 705
        return to == InferiorShutdownRequested;
    case InferiorShutdownRequested:
        return to == InferiorShutdownOk || to == InferiorShutdownFailed;
    case InferiorShutdownOk:
        return to == EngineShutdownRequested;
706
    case InferiorShutdownFailed:
hjk's avatar
hjk committed
707
        return to == EngineShutdownRequested;
708

hjk's avatar
hjk committed
709
    case EngineShutdownRequested:
710
        return to == EngineShutdownOk || to == EngineShutdownFailed;
hjk's avatar
hjk committed
711 712 713 714 715 716
    case EngineShutdownOk:
        return to == DebuggerFinished;
    case EngineShutdownFailed:
        return to == DebuggerFinished;

    case DebuggerFinished:
717
        return to == EngineSetupRequested; // Happens on restart.
718 719
    }

720
    qDebug() << "UNKNOWN DEBUGGER STATE:" << from;
721 722 723
    return false;
}

724
void DebuggerEngine::notifyEngineSetupFailed()
hjk's avatar
hjk committed
725
{
hjk's avatar
hjk committed
726
    showMessage(_("NOTE: ENGINE SETUP FAILED"));
hjk's avatar
hjk committed
727
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << state());
728
    setState(EngineSetupFailed);
hjk's avatar
hjk committed
729 730
    QTC_ASSERT(d->m_runControl, return);
    d->m_runControl->startFailed();
hjk's avatar
hjk committed
731
    setState(DebuggerFinished);
hjk's avatar
hjk committed
732 733
}

734
void DebuggerEngine::notifyEngineSetupOk()
735
{
hjk's avatar
hjk committed
736
    showMessage(_("NOTE: ENGINE SETUP OK"));
hjk's avatar
hjk committed
737
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << state());
738
    setState(EngineSetupOk);
hjk's avatar
hjk committed
739
    QTC_ASSERT(d->m_runControl, return);
hjk's avatar
hjk committed
740
    showMessage(_("QUEUE: SETUP INFERIOR"));
hjk's avatar
hjk committed
741
    QTimer::singleShot(0, d, SLOT(doSetupInferior()));
742 743
}

hjk's avatar
hjk committed
744
void DebuggerEnginePrivate::doSetupInferior()
745
{
746
    m_engine->showMessage(_("CALL: SETUP INFERIOR"));
hjk's avatar
hjk committed
747
    QTC_ASSERT(state() == EngineSetupOk, qDebug() << state());
748
    m_progress.setProgressValue(250);
hjk's avatar
hjk committed
749
    m_engine->setState(InferiorSetupRequested);
hjk's avatar
hjk committed
750 751 752 753 754
    m_engine->setupInferior();
}

void DebuggerEngine::notifyInferiorSetupFailed()
{
hjk's avatar
hjk committed
755
    showMessage(_("NOTE: INFERIOR SETUP FAILED"));
hjk's avatar
hjk committed
756
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
hjk's avatar
hjk committed
757
    setState(InferiorSetupFailed);
hjk's avatar
hjk committed
758
    d->queueShutdownEngine();
hjk's avatar
hjk committed
759 760 761 762
}

void DebuggerEngine::notifyInferiorSetupOk()
{
hjk's avatar
hjk committed
763
    showMessage(_("NOTE: INFERIOR SETUP OK"));
hjk's avatar
hjk committed
764
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
hjk's avatar
hjk committed
765
    d->queueRunEngine();
hjk's avatar
hjk committed
766 767 768 769
}

void DebuggerEnginePrivate::doRunEngine()
{
hjk's avatar
hjk committed
770
    m_engine->showMessage(_("CALL: RUN ENGINE"));
hjk's avatar
hjk committed
771
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
772
    m_progress.setProgressValue(300);
hjk's avatar
hjk committed
773 774 775
    m_engine->runEngine();
}

hjk's avatar
hjk committed
776 777
void DebuggerEngine::notifyInferiorUnrunnable()
{
hjk's avatar
hjk committed
778
    showMessage(_("NOTE: INFERIOR UNRUNNABLE"));
779 780
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
781 782 783 784 785 786
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(InferiorUnrunnable);
}

void DebuggerEngine::notifyEngineRunFailed()
{
hjk's avatar
hjk committed
787
    showMessage(_("NOTE: ENGINE RUN FAILED"));
hjk's avatar
hjk committed
788
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
789 790 791
    d->m_progress.setProgressValue(900);
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
792
    setState(EngineRunFailed);
793
    d->queueShutdownEngine();
hjk's avatar
hjk committed
794 795 796 797
}

void DebuggerEngine::notifyEngineRunAndInferiorRunOk()
{
hjk's avatar
hjk committed
798
    showMessage(_("NOTE: ENGINE RUN AND INFERIOR RUN OK"));
799 800
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
801 802 803 804 805 806 807
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(InferiorRunRequested);
    notifyInferiorRunOk();
}

void DebuggerEngine::notifyEngineRunAndInferiorStopOk()
{
hjk's avatar
hjk committed
808
    showMessage(_("NOTE: ENGINE RUN AND INFERIOR STOP OK"));
809 810
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
811 812 813 814 815 816 817
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(InferiorStopRequested);
    notifyInferiorStopOk();
}

void DebuggerEngine::notifyInferiorRunRequested()
{
hjk's avatar
hjk committed
818
    showMessage(_("NOTE: INFERIOR RUN REQUESTED"));
hjk's avatar
hjk committed
819 820 821 822 823 824
    QTC_ASSERT(state() == InferiorStopOk, qDebug() << state());
    setState(InferiorRunRequested);
}

void DebuggerEngine::notifyInferiorRunOk()
{
hjk's avatar
hjk committed
825
    showMessage(_("NOTE: INFERIOR RUN OK"));
hjk's avatar
hjk committed
826 827 828 829 830 831
    QTC_ASSERT(state() == InferiorRunRequested, qDebug() << state());
    setState(InferiorRunOk);
}

void DebuggerEngine::notifyInferiorRunFailed()
{
hjk's avatar
hjk committed
832
    showMessage(_("NOTE: INFERIOR RUN FAILED"));
hjk's avatar
hjk committed
833 834 835
    QTC_ASSERT(state() == InferiorRunRequested, qDebug() << state());
    setState(InferiorRunFailed);
    setState(InferiorStopOk);
hjk's avatar
hjk committed
836 837
    if (isDying())
        d->queueShutdownInferior();
hjk's avatar
hjk committed
838 839 840 841
}

void DebuggerEngine::notifyInferiorStopOk()
{
hjk's avatar
hjk committed
842 843
    showMessage(_("NOTE: INFERIOR STOP OK"));
    // Ignore spurious notifications after we are set to die.
hjk's avatar
hjk committed
844
    if (isDying()) {
hjk's avatar
hjk committed
845 846 847 848 849 850 851 852 853 854 855 856 857
        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
858
    }
hjk's avatar
hjk committed
859 860
    QTC_ASSERT(state() == InferiorStopRequested, qDebug() << state());
    setState(InferiorStopOk);
hjk's avatar
hjk committed
861 862
}

hjk's avatar
hjk committed
863
void DebuggerEngine::notifyInferiorSpontaneousStop()
864
{
hjk's avatar
hjk committed
865
    showMessage(_("NOTE: INFERIOR SPONTANEOUES STOP"));
hjk's avatar
hjk committed
866 867
    QTC_ASSERT(state() == InferiorRunOk, qDebug() << state());
    setState(InferiorStopOk);
868 869
}

hjk's avatar
hjk committed
870
void DebuggerEngine::notifyInferiorStopFailed()
871
{
hjk's avatar
hjk committed
872
    showMessage(_("NOTE: INFERIOR STOP FAILED"));
hjk's avatar
hjk committed
873 874
    QTC_ASSERT(state() == InferiorStopRequested, qDebug() << state());
    setState(InferiorStopFailed);
hjk's avatar
hjk committed
875
    d->queueShutdownEngine();
876 877 878 879
}

void DebuggerEnginePrivate::doInterruptInferior()
{
hjk's avatar
hjk committed
880 881
    QTC_ASSERT(state() == InferiorRunOk, qDebug() << state());
    m_engine->setState(InferiorStopRequested);
hjk's avatar
hjk committed
882
    m_engine->showMessage(_("CALL: INTERRUPT INFERIOR"));
883 884 885
    m_engine->interruptInferior();
}

hjk's avatar
hjk committed
886 887
void DebuggerEnginePrivate::doShutdownInferior()
{
888
    QTC_ASSERT(state() == InferiorShutdownRequested, qDebug() << state());
889
    resetLocation();
hjk's avatar
hjk committed
890
    m_targetState = DebuggerFinished;
hjk's avatar
hjk committed
891
    m_engine->showMessage(_("CALL: SHUTDOWN INFERIOR"));
hjk's avatar
hjk committed
892 893 894 895 896 897
    m_engine->shutdownInferior();
}

void DebuggerEngine::notifyInferiorShutdownOk()
{
    showMessage(_("INFERIOR SUCCESSFULLY SHUT DOWN"));
hjk's avatar
hjk committed
898
    QTC_ASSERT(state() == InferiorShutdownRequested, qDebug() << state());
hjk's avatar
hjk committed
899 900
    d->m_lastGoodState = DebuggerNotReady; // A "neutral" value.
    setState(InferiorShutdownOk);
hjk's avatar
hjk committed
901
    d->queueShutdownEngine();
hjk's avatar
hjk committed
902 903 904 905 906
}

void DebuggerEngine::notifyInferiorShutdownFailed()
{
    showMessage(_("INFERIOR SHUTDOWN FAILED"));
Friedemann Kleint's avatar
Friedemann Kleint committed
907
    QTC_ASSERT(state() == InferiorShutdownRequested, qDebug() << this << state());
hjk's avatar
hjk committed
908
    setState(InferiorShutdownFailed);
hjk's avatar
hjk committed
909
    d->queueShutdownEngine();
hjk's avatar
hjk committed
910 911 912 913
}

void DebuggerEngine::notifyInferiorIll()
{
hjk's avatar
hjk committed
914
    showMessage(_("NOTE: INFERIOR ILL"));
hjk's avatar
hjk committed
915 916 917 918 919 920 921 922 923 924 925
    // 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
926
    d->queueShutdownInferior();
hjk's avatar
hjk committed
927 928 929 930
}

void DebuggerEnginePrivate::doShutdownEngine()
{
931
    QTC_ASSERT(state() == EngineShutdownRequested, qDebug() << state());
hjk's avatar
hjk committed