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

#include "debuggerengine.h"

#include "debuggeractions.h"
33
#include "debuggercore.h"
34
#include "debuggerplugin.h"
35
#include "debuggerrunner.h"
36
#include "debuggerstringutils.h"
37
#include "debuggertooltip.h"
38

39 40
#include "memoryagent.h"
#include "disassembleragent.h"
41 42 43 44 45 46 47 48 49
#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
50
#include <coreplugin/icore.h>
51
#include <coreplugin/ifile.h>
52 53
#include <coreplugin/progressmanager/progressmanager.h>
#include <coreplugin/progressmanager/futureprogress.h>
hjk's avatar
hjk committed
54

hjk's avatar
hjk committed
55
#include <projectexplorer/toolchain.h>
56
#include <projectexplorer/toolchaintype.h>
57

hjk's avatar
hjk committed
58 59
#include <texteditor/itexteditor.h>

60
#include <utils/environment.h>
61 62 63 64 65
#include <utils/savedaction.h>
#include <utils/qtcassert.h>

#include <QtCore/QDebug>
#include <QtCore/QTimer>
66
#include <QtCore/QFutureInterface>
67

68
#include <QtGui/QMessageBox>
69

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

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

83

84 85 86 87 88 89
///////////////////////////////////////////////////////////////////////
//
// DebuggerStartParameters
//
///////////////////////////////////////////////////////////////////////

90 91
namespace Debugger {

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

hjk's avatar
hjk committed
106
QString DebuggerStartParameters::toolChainName() const
107
{
hjk's avatar
hjk committed
108
    return ToolChain::toolChainName(ProjectExplorer::ToolChainType(toolChainType));
109 110 111 112
}

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

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

167

168 169 170 171 172 173
//////////////////////////////////////////////////////////////////////
//
// DebuggerEnginePrivate
//
//////////////////////////////////////////////////////////////////////

174
class DebuggerEnginePrivate : public QObject
175
{
176 177
    Q_OBJECT

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

    ~DebuggerEnginePrivate() {}
198

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

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

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

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

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

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

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

246 247 248 249
    DebuggerEngine *m_engine; // Not owned.
    DebuggerRunControl *m_runControl;  // Not owned.

    DebuggerStartParameters m_startParameters;
hjk's avatar
hjk committed
250 251

    // The current state.
252 253
    DebuggerState m_state;

hjk's avatar
hjk committed
254 255 256 257 258 259
    // The state we had before something unexpected happend.
    DebuggerState m_lastGoodState;

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

260 261 262 263 264 265 266 267
    qint64 m_inferiorPid;

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

270
    bool m_isSlaveEngine;
271 272
    DisassemblerViewAgent m_disassemblerViewAgent;
    MemoryViewAgent m_memoryViewAgent;
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
};


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

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

DebuggerEngine::~DebuggerEngine()
{
289 290
    disconnect();
    delete d;
291 292
}

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

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

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 335 336 337 338 339 340
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;
}

341 342 343 344
//SnapshotHandler *DebuggerEngine::snapshotHandler() const
//{
//    return &d->m_snapshotHandler;
//}
345 346 347 348 349 350 351 352

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

QAbstractItemModel *DebuggerEngine::modulesModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
353 354 355 356
    QAbstractItemModel *model = d->m_modulesHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("ModulesModel"));
    return model;
357 358 359 360
}

QAbstractItemModel *DebuggerEngine::registerModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
361 362 363 364
    QAbstractItemModel *model = d->m_registerHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("RegisterModel"));
    return model;
365 366 367 368
}

QAbstractItemModel *DebuggerEngine::stackModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
369 370 371 372
    QAbstractItemModel *model = d->m_stackHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("StackModel"));
    return model;
373 374 375 376
}

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

QAbstractItemModel *DebuggerEngine::localsModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
385 386 387 388
    QAbstractItemModel *model = d->m_watchHandler.model(LocalsWatch);
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("LocalsModel"));
    return model;
389 390 391 392
}

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

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

QAbstractItemModel *DebuggerEngine::sourceFilesModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
409 410 411 412
    QAbstractItemModel *model = d->m_sourceFilesHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("SourceFilesModel"));
    return model;
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
}

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

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

void DebuggerEngine::showMessage(const QString &msg, int channel, int timeout) const
{
430 431
    //if (msg.size() && msg.at(0).isUpper() && msg.at(1).isUpper())
    //    qDebug() << qPrintable(msg) << "IN STATE" << state();
432
    debuggerCore()->showMessage(msg, channel, timeout);
433 434 435 436 437
    if (d->m_runControl) {
        d->m_runControl->showMessage(msg, channel);
    } else {
        qWarning("Warning: %s (no active run control)", qPrintable(msg));
    }
438 439 440 441
}

void DebuggerEngine::startDebugger(DebuggerRunControl *runControl)
{
hjk's avatar
hjk committed
442
    if (!isSlaveEngine()) {
443
        d->m_progress.setProgressRange(0, 1000);
444 445 446
        Core::FutureProgress *fp = Core::ICore::instance()->progressManager()
            ->addTask(d->m_progress.future(),
            tr("Launching"), _("Debugger.Launcher"));
447
        fp->setKeepOnFinish(Core::FutureProgress::DontKeepOnFinish);
448 449
        d->m_progress.reportStarted();
    }
450 451
    QTC_ASSERT(runControl, notifyEngineSetupFailed(); return);
    QTC_ASSERT(!d->m_runControl, notifyEngineSetupFailed(); return);
452 453 454 455 456 457

    d->m_runControl = runControl;

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

458 459
    if (!d->m_startParameters.environment.size())
        d->m_startParameters.environment = Utils::Environment();
460 461 462 463 464

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

    const unsigned engineCapabilities = debuggerCapabilities();
hjk's avatar
hjk committed
465
    debuggerCore()->action(OperateByInstruction)
466 467
        ->setEnabled(engineCapabilities & DisassemblerCapability);

468 469
    QTC_ASSERT(state() == DebuggerNotReady || state() == DebuggerFinished,
         qDebug() << state());
470 471
    d->m_lastGoodState = DebuggerNotReady;
    d->m_targetState = DebuggerNotReady;
hjk's avatar
hjk committed
472
    setState(EngineSetupRequested);
473

474
    d->m_progress.setProgressValue(200);
hjk's avatar
hjk committed
475
    setupEngine();
476 477 478 479 480 481 482 483 484 485 486 487 488 489
}

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

void DebuggerEngine::breakByFunction(const QString &functionName)
{
490
    breakHandler()->breakByFunction(functionName);
491 492 493 494 495
}

void DebuggerEngine::resetLocation()
{
    d->m_disassemblerViewAgent.resetLocation();
496
    debuggerCore()->removeLocationMark();
497 498 499 500
}

void DebuggerEngine::gotoLocation(const QString &fileName, int lineNumber, bool setMarker)
{
501
    debuggerCore()->gotoLocation(fileName, lineNumber, setMarker);
502 503 504 505
}

void DebuggerEngine::gotoLocation(const StackFrame &frame, bool setMarker)
{
506 507 508
    if (debuggerCore()->boolSetting(OperateByInstruction) || !frame.isUsable())
        d->m_disassemblerViewAgent.setFrame(frame, true, setMarker);
    else
509
        debuggerCore()->gotoLocation(frame.file, frame.line, setMarker);
510 511
}

512 513 514
// Called from RunControl.
void DebuggerEngine::handleStartFailed()
{
515
    showMessage("HANDLE RUNCONTROL START FAILED");
516
    d->m_runControl = 0;
517
    d->m_progress.setProgressValue(900);
518 519
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
520 521
}

522 523
// Called from RunControl.
void DebuggerEngine::handleFinished()
524
{
525
    showMessage("HANDLE RUNCONTROL FINISHED");
526
    d->m_runControl = 0;
527 528 529 530
    modulesHandler()->removeAll();
    stackHandler()->removeAll();
    threadsHandler()->removeAll();
    watchHandler()->cleanup();
531
    d->m_progress.setProgressValue(1000);
532
    d->m_progress.reportFinished();
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556
}

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
557
    return debuggerCore()->boolSetting(UseDebuggingHelpers);
558 559 560 561
}

QStringList DebuggerEngine::qtDumperLibraryLocations() const
{
hjk's avatar
hjk committed
562
    if (debuggerCore()->action(UseCustomDebuggingHelperLocation)->value().toBool()) {
563
        const QString customLocation =
hjk's avatar
hjk committed
564
            debuggerCore()->action(CustomDebuggingHelperLocation)->value().toString();
565 566 567 568 569 570 571 572 573
        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)
{
574
    debuggerCore()->showQtDumperLibraryWarning(details);
575 576 577 578
}

QString DebuggerEngine::qtDumperLibraryName() const
{
hjk's avatar
hjk committed
579 580
    if (debuggerCore()->action(UseCustomDebuggingHelperLocation)->value().toBool())
        return debuggerCore()->action(CustomDebuggingHelperLocation)->value().toString();
581 582 583 584 585 586 587 588
    return startParameters().dumperLibrary;
}

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

hjk's avatar
hjk committed
589
DebuggerState DebuggerEngine::lastGoodState() const
590
{
hjk's avatar
hjk committed
591 592 593 594 595 596 597
    return d->m_lastGoodState;
}

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

hjk's avatar
hjk committed
599 600 601
static bool isAllowedTransition(DebuggerState from, DebuggerState to)
{
    switch (from) {
602
    case DebuggerNotReady:
603
        return to == EngineSetupRequested;
604

hjk's avatar
hjk committed
605
    case EngineSetupRequested:
606 607
        return to == EngineSetupOk || to == EngineSetupFailed;
    case EngineSetupFailed:
608 609 610
        // In is the engine's task to go into a proper "Shutdown"
        // state before calling notifyEngineSetupFailed
        return to == DebuggerFinished;
611
    case EngineSetupOk:
hjk's avatar
hjk committed
612
        return to == InferiorSetupRequested || to == EngineShutdownRequested;
613

hjk's avatar
hjk committed
614 615
    case InferiorSetupRequested:
        return to == EngineRunRequested || to == InferiorSetupFailed;
hjk's avatar
hjk committed
616
    case InferiorSetupFailed:
hjk's avatar
hjk committed
617 618 619 620 621 622 623
        return to == EngineShutdownRequested;

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

    case EngineRunFailed:
624
        return to == EngineShutdownRequested;
hjk's avatar
hjk committed
625 626 627 628 629 630 631 632 633 634 635 636 637

    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;
638
    case InferiorStopFailed:
hjk's avatar
hjk committed
639
        return to == EngineShutdownRequested;
640 641

    case InferiorUnrunnable:
hjk's avatar
hjk committed
642 643 644 645 646
        return to == InferiorShutdownRequested;
    case InferiorShutdownRequested:
        return to == InferiorShutdownOk || to == InferiorShutdownFailed;
    case InferiorShutdownOk:
        return to == EngineShutdownRequested;
647
    case InferiorShutdownFailed:
hjk's avatar
hjk committed
648
        return to == EngineShutdownRequested;
649

hjk's avatar
hjk committed
650
    case EngineShutdownRequested:
651
        return to == EngineShutdownOk || to == EngineShutdownFailed;
hjk's avatar
hjk committed
652 653 654 655 656 657
    case EngineShutdownOk:
        return to == DebuggerFinished;
    case EngineShutdownFailed:
        return to == DebuggerFinished;

    case DebuggerFinished:
658
        return to == EngineSetupRequested; // Happens on restart.
659 660
    }

661
    qDebug() << "UNKNOWN DEBUGGER STATE:" << from;
662 663 664
    return false;
}

665
void DebuggerEngine::notifyEngineSetupFailed()
hjk's avatar
hjk committed
666
{
hjk's avatar
hjk committed
667
    showMessage(_("NOTE: ENGINE SETUP FAILED"));
hjk's avatar
hjk committed
668
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << state());
669
    setState(EngineSetupFailed);
hjk's avatar
hjk committed
670 671
    QTC_ASSERT(d->m_runControl, return);
    d->m_runControl->startFailed();
hjk's avatar
hjk committed
672
    setState(DebuggerFinished);
hjk's avatar
hjk committed
673 674
}

675
void DebuggerEngine::notifyEngineSetupOk()
676
{
hjk's avatar
hjk committed
677
    showMessage(_("NOTE: ENGINE SETUP OK"));
hjk's avatar
hjk committed
678
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << state());
679
    setState(EngineSetupOk);
hjk's avatar
hjk committed
680
    QTC_ASSERT(d->m_runControl, return);
hjk's avatar
hjk committed
681
    showMessage(_("QUEUE: SETUP INFERIOR"));
hjk's avatar
hjk committed
682
    QTimer::singleShot(0, d, SLOT(doSetupInferior()));
683 684
}

hjk's avatar
hjk committed
685
void DebuggerEnginePrivate::doSetupInferior()
686
{
687
    m_engine->showMessage(_("CALL: SETUP INFERIOR"));
hjk's avatar
hjk committed
688
    QTC_ASSERT(state() == EngineSetupOk, qDebug() << state());
689
    m_progress.setProgressValue(250);
hjk's avatar
hjk committed
690
    m_engine->setState(InferiorSetupRequested);
hjk's avatar
hjk committed
691 692 693 694 695
    m_engine->setupInferior();
}

void DebuggerEngine::notifyInferiorSetupFailed()
{
hjk's avatar
hjk committed
696
    showMessage(_("NOTE: INFERIOR SETUP FAILED"));
hjk's avatar
hjk committed
697
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
hjk's avatar
hjk committed
698
    setState(InferiorSetupFailed);
hjk's avatar
hjk committed
699
    d->queueShutdownEngine();
hjk's avatar
hjk committed
700 701 702 703
}

void DebuggerEngine::notifyInferiorSetupOk()
{
hjk's avatar
hjk committed
704
    showMessage(_("NOTE: INFERIOR SETUP OK"));
hjk's avatar
hjk committed
705
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
hjk's avatar
hjk committed
706
    d->queueRunEngine();
hjk's avatar
hjk committed
707 708 709 710
}

void DebuggerEnginePrivate::doRunEngine()
{
hjk's avatar
hjk committed
711
    m_engine->showMessage(_("CALL: RUN ENGINE"));
hjk's avatar
hjk committed
712
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
713
    m_progress.setProgressValue(300);
hjk's avatar
hjk committed
714 715 716
    m_engine->runEngine();
}

hjk's avatar
hjk committed
717 718
void DebuggerEngine::notifyInferiorUnrunnable()
{
hjk's avatar
hjk committed
719
    showMessage(_("NOTE: INFERIOR UNRUNNABLE"));
720 721
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
722 723 724 725 726 727
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(InferiorUnrunnable);
}

void DebuggerEngine::notifyEngineRunFailed()
{
hjk's avatar
hjk committed
728
    showMessage(_("NOTE: ENGINE RUN FAILED"));
hjk's avatar
hjk committed
729
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
730 731 732
    d->m_progress.setProgressValue(900);
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
733
    setState(EngineRunFailed);
734
    d->queueShutdownEngine();
hjk's avatar
hjk committed
735 736 737 738
}

void DebuggerEngine::notifyEngineRunAndInferiorRunOk()
{
hjk's avatar
hjk committed
739
    showMessage(_("NOTE: ENGINE RUN AND INFERIOR RUN OK"));
740 741
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
742 743 744 745 746 747 748
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(InferiorRunRequested);
    notifyInferiorRunOk();
}

void DebuggerEngine::notifyEngineRunAndInferiorStopOk()
{
hjk's avatar
hjk committed
749
    showMessage(_("NOTE: ENGINE RUN AND INFERIOR STOP OK"));
750 751
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
752 753 754 755 756 757 758
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(InferiorStopRequested);
    notifyInferiorStopOk();
}

void DebuggerEngine::notifyInferiorRunRequested()
{
hjk's avatar
hjk committed
759
    showMessage(_("NOTE: INFERIOR RUN REQUESTED"));
hjk's avatar
hjk committed
760 761 762 763 764 765
    QTC_ASSERT(state() == InferiorStopOk, qDebug() << state());
    setState(InferiorRunRequested);
}

void DebuggerEngine::notifyInferiorRunOk()
{
hjk's avatar
hjk committed
766
    showMessage(_("NOTE: INFERIOR RUN OK"));
hjk's avatar
hjk committed
767 768 769 770 771 772
    QTC_ASSERT(state() == InferiorRunRequested, qDebug() << state());
    setState(InferiorRunOk);
}

void DebuggerEngine::notifyInferiorRunFailed()
{
hjk's avatar
hjk committed
773
    showMessage(_("NOTE: INFERIOR RUN FAILED"));
hjk's avatar
hjk committed
774 775 776
    QTC_ASSERT(state() == InferiorRunRequested, qDebug() << state());
    setState(InferiorRunFailed);
    setState(InferiorStopOk);
hjk's avatar
hjk committed
777 778
    if (isDying())
        d->queueShutdownInferior();
hjk's avatar
hjk committed
779 780 781 782
}

void DebuggerEngine::notifyInferiorStopOk()
{
hjk's avatar
hjk committed
783 784
    showMessage(_("NOTE: INFERIOR STOP OK"));
    // Ignore spurious notifications after we are set to die.
hjk's avatar
hjk committed
785
    if (isDying()) {
hjk's avatar
hjk committed
786 787 788 789 790 791 792 793 794 795 796 797 798
        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
799
    }
hjk's avatar
hjk committed
800 801
    QTC_ASSERT(state() == InferiorStopRequested, qDebug() << state());
    setState(InferiorStopOk);
hjk's avatar
hjk committed
802 803
}

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

hjk's avatar
hjk committed
811
void DebuggerEngine::notifyInferiorStopFailed()
812
{
hjk's avatar
hjk committed
813
    showMessage(_("NOTE: INFERIOR STOP FAILED"));
hjk's avatar
hjk committed
814 815
    QTC_ASSERT(state() == InferiorStopRequested, qDebug() << state());
    setState(InferiorStopFailed);
hjk's avatar
hjk committed
816
    d->queueShutdownEngine();
817 818 819 820
}

void DebuggerEnginePrivate::doInterruptInferior()
{
hjk's avatar
hjk committed
821 822
    QTC_ASSERT(state() == InferiorRunOk, qDebug() << state());
    m_engine->setState(InferiorStopRequested);
hjk's avatar
hjk committed
823
    m_engine->showMessage(_("CALL: INTERRUPT INFERIOR"));
824 825 826
    m_engine->interruptInferior();
}

hjk's avatar
hjk committed
827 828
void DebuggerEnginePrivate::doShutdownInferior()
{
829
    QTC_ASSERT(state() == InferiorShutdownRequested, qDebug() << state());
hjk's avatar
hjk committed
830 831
    m_engine->resetLocation();
    m_targetState = DebuggerFinished;
hjk's avatar
hjk committed
832
    m_engine->showMessage(_("CALL: SHUTDOWN INFERIOR"));
hjk's avatar
hjk committed
833 834 835 836 837 838
    m_engine->shutdownInferior();
}

void DebuggerEngine::notifyInferiorShutdownOk()
{
    showMessage(_("INFERIOR SUCCESSFULLY SHUT DOWN"));
hjk's avatar
hjk committed
839
    QTC_ASSERT(state() == InferiorShutdownRequested, qDebug() << state());
hjk's avatar
hjk committed
840 841
    d->m_lastGoodState = DebuggerNotReady; // A "neutral" value.
    setState(InferiorShutdownOk);
hjk's avatar
hjk committed
842
    d->queueShutdownEngine();
hjk's avatar
hjk committed
843 844 845 846 847
}

void DebuggerEngine::notifyInferiorShutdownFailed()
{
    showMessage(_("INFERIOR SHUTDOWN FAILED"));
Friedemann Kleint's avatar
Friedemann Kleint committed
848
    QTC_ASSERT(state() == InferiorShutdownRequested, qDebug() << this << state());
hjk's avatar
hjk committed
849
    setState(InferiorShutdownFailed);
hjk's avatar
hjk committed
850
    d->queueShutdownEngine();
hjk's avatar
hjk committed
851 852 853 854
}

void DebuggerEngine::notifyInferiorIll()
{
hjk's avatar
hjk committed
855
    showMessage(_("NOTE: INFERIOR ILL"));
hjk's avatar
hjk committed
856 857 858 859 860 861 862 863 864 865 866
    // 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
867
    d->queueShutdownInferior();
hjk's avatar
hjk committed
868 869 870 871
}

void DebuggerEnginePrivate::doShutdownEngine()
{
872
    QTC_ASSERT(state() == EngineShutdownRequested, qDebug() << state());
hjk's avatar
hjk committed
873
    m_targetState = DebuggerFinished;
hjk's avatar
hjk committed
874
    m_engine->showMessage(_("CALL: SHUTDOWN ENGINE"));
hjk's avatar
hjk committed
875 876 877 878 879
    m_engine->shutdownEngine();
}

void DebuggerEngine::notifyEngineShutdownOk()
{
hjk's avatar
hjk committed
880
    showMessage(_("NOTE: ENGINE SHUTDOWN OK"));
hjk's avatar
hjk committed
881 882
    QTC_ASSERT(state() == EngineShutdownRequested, qDebug() << state());
    setState(EngineShutdownOk);
883
    d->queueFinishDebugger();
hjk's avatar
hjk committed
884 885 886
}

void DebuggerEngine::notifyEngineShutdownFailed()
hjk's avatar
hjk committed
887
{
hjk's avatar
hjk committed
888
    showMessage(_("NOTE: ENGINE SHUTDOWN FAILED"));
hjk's avatar
hjk committed
889 890
    QTC_ASSERT(state() == EngineShutdownRequested, qDebug() << state());
    setState(EngineShutdownFailed);
891
    d->queueFinishDebugger();
hjk's avatar
hjk committed
892 893 894 895
}

void DebuggerEnginePrivate::doFinishDebugger()
{
hjk's avatar
hjk committed
896
    m_engine->showMessage(_("NOTE: FINISH DEBUGGER"));
897
    QTC_ASSERT(state() == DebuggerFinished, qDebug() << state());
hjk's avatar
hjk committed
898
    m_engine->resetLocation();
899 900 901 902
    if (!m_engine->isSlaveEngine()) {
        QTC_ASSERT(m_runControl, return);
        m_runControl->debuggingFinished();
    }
hjk's avatar
hjk committed
903 904 905 906
}

void DebuggerEngine::notifyEngineIll()
{
hjk's avatar
hjk committed
907
    showMessage(_("NOTE: ENGINE ILL ******"));
hjk's avatar
hjk committed
908 909
    d->m_targetState = DebuggerFinished;
    d->m_lastGoodState = d->m_state;
hjk's avatar
hjk committed
910 911 912
    switch (state()) {
        case InferiorRunRequested:
        case InferiorRunOk:
913 914 915 916 917 918 919
            // The engine does not look overly ill right now, so attempt to
            // properly interrupt at least once. If that fails, we are on the
            // shutdown path due to d->m_targetState anyways.
            setState(InferiorStopRequested, true);
            showMessage(_("ATTEMPT TO INTERRUPT INFERIOR"));
            interruptInferior();
            break;
hjk's avatar
hjk committed
920 921
        case InferiorStopRequested:
        case InferiorStopOk:
922
            showMessage(_("FORWARDING STATE TO InferiorShutdownFailed"));
hjk's avatar
hjk committed
923
            setState(InferiorShutdownFailed, true);
924
            d->queueShutdownEngine();
hjk's avatar
hjk committed
925 926
            break;
        default:
927
            d->queueShutdownEngine();
hjk's avatar
hjk committed
928
            break;
hjk's avatar
hjk committed
929 930 931 932 933
    }
}

void DebuggerEngine::notifyEngineSpontaneousShutdown()
{
hjk's avatar
hjk committed
934
    showMessage(_("NOTE: ENGINE SPONTANEOUS SHUTDOWN"));
935
    setState(EngineShutdownOk, true);
hjk's avatar
hjk committed
936
    d->queueFinishDebugger();
hjk's avatar
hjk committed
937 938 939 940
}

void DebuggerEngine::notifyInferiorExited()
{
hjk's avatar
hjk committed
941
    showMessage(_("NOTE: INFERIOR EXITED"));
hjk's avatar
hjk committed
942 943 944 945 946 947 948 949 950 951 952
    resetLocation();

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