debuggerengine.cpp 40.1 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_disassemblerViewAgent(engine),
193
        m_isSlaveEngine(false)
194
    {}
195 196

    ~DebuggerEnginePrivate() {}
197

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

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

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

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

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

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

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

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

    DebuggerStartParameters m_startParameters;
hjk's avatar
hjk committed
249 250

    // The current state.
251 252
    DebuggerState m_state;

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

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

259 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;
    DisassemblerViewAgent m_disassemblerViewAgent;
268
    QFutureInterface<void> m_progress;
269

270
    bool m_isSlaveEngine;
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
};


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

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

DebuggerEngine::~DebuggerEngine()
{
287 288
    disconnect();
    delete d;
289 290
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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
{
428 429
    //if (msg.size() && msg.at(0).isUpper() && msg.at(1).isUpper())
    //    qDebug() << qPrintable(msg) << "IN STATE" << state();
430
    debuggerCore()->showMessage(msg, channel, timeout);
431 432 433 434 435
    if (d->m_runControl) {
        d->m_runControl->showMessage(msg, channel);
    } else {
        qWarning("Warning: %s (no active run control)", qPrintable(msg));
    }
436 437 438 439
}

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

    d->m_runControl = runControl;

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

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

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

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

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

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

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)
{
488
    breakHandler()->breakByFunction(functionName);
489 490 491 492 493
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    case DebuggerFinished:
656
        return to == EngineSetupRequested; // Happens on restart.
657 658
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void DebuggerEngine::notifyEngineIll()
{
hjk's avatar
hjk committed
905
    showMessage(_("NOTE: ENGINE ILL ******"));
hjk's avatar
hjk committed
906 907
    d->m_targetState = DebuggerFinished;
    d->m_lastGoodState = d->m_state;
hjk's avatar
hjk committed
908 909 910
    switch (state()) {
        case InferiorRunRequested:
        case InferiorRunOk:
911 912 913 914 915 916 917
            // 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
918 919
        case InferiorStopRequested:
        case InferiorStopOk:
920
            showMessage(_("FORWARDING STATE TO InferiorShutdownFailed"));
hjk's avatar
hjk committed
921
            setState(InferiorShutdownFailed, true);
922
            d->queueShutdownEngine();
hjk's avatar
hjk committed
923 924
            break;
        default:
925
            d->queueShutdownEngine();
hjk's avatar
hjk committed
926
            break;
hjk's avatar
hjk committed
927 928 929 930 931
    }
}

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

void DebuggerEngine::notifyInferiorExited()
{
hjk's avatar
hjk committed
939
    showMessage(_("NOTE: INFERIOR EXITED"));
hjk's avatar
hjk committed
940 941 942 943 944 945 946 947 948 949 950
    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);
951
    d->queueShutdownEngine();
952 953
}