debuggerengine.cpp 37.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 33
/**************************************************************************
**
** 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"
#include "debuggeragents.h"
34
#include "debuggercore.h"
35
#include "debuggerplugin.h"
36
#include "debuggerrunner.h"
37
#include "debuggerstringutils.h"
38
#include "debuggertooltip.h"
39 40 41 42 43 44 45 46 47 48

#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
49
#include <coreplugin/icore.h>
50
#include <coreplugin/ifile.h>
51 52
#include <coreplugin/progressmanager/progressmanager.h>
#include <coreplugin/progressmanager/futureprogress.h>
hjk's avatar
hjk committed
53

54
#include <projectexplorer/toolchaintype.h>
55

hjk's avatar
hjk committed
56 57
#include <texteditor/itexteditor.h>

58
#include <utils/environment.h>
59 60 61 62 63
#include <utils/savedaction.h>
#include <utils/qtcassert.h>

#include <QtCore/QDebug>
#include <QtCore/QTimer>
64
#include <QtCore/QFutureInterface>
65 66 67 68 69

#include <QtGui/QStandardItemModel>
#include <QtGui/QAction>
#include <QtGui/QTreeWidget>

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

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

84

85 86 87 88 89 90
///////////////////////////////////////////////////////////////////////
//
// DebuggerStartParameters
//
///////////////////////////////////////////////////////////////////////

91 92
namespace Debugger {

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

void DebuggerStartParameters::clear()
{
    *this = DebuggerStartParameters();
}

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

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

168

169 170 171 172 173 174
//////////////////////////////////////////////////////////////////////
//
// DebuggerEnginePrivate
//
//////////////////////////////////////////////////////////////////////

175
class DebuggerEnginePrivate : public QObject
176
{
177 178
    Q_OBJECT

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

    ~DebuggerEnginePrivate() {}
199

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

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

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

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

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

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

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

247 248
    DebuggerEngine *m_engine; // Not owned.
    DebuggerRunControl *m_runControl;  // Not owned.
249
    bool m_isActive;
250 251

    DebuggerStartParameters m_startParameters;
hjk's avatar
hjk committed
252 253

    // The current state.
254 255
    DebuggerState m_state;

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

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

262 263 264 265 266 267 268 269 270
    qint64 m_inferiorPid;

    ModulesHandler m_modulesHandler;
    RegisterHandler m_registerHandler;
    SourceFilesHandler m_sourceFilesHandler;
    StackHandler m_stackHandler;
    ThreadsHandler m_threadsHandler;
    WatchHandler m_watchHandler;
    DisassemblerViewAgent m_disassemblerViewAgent;
271
    QFutureInterface<void> m_progress;
272

273
    bool m_isSlaveEngine;
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
};


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

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

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

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

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

305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
void DebuggerEngine::showModuleSymbols
    (const QString &moduleName, const Symbols &symbols)
{
    QTreeWidget *w = new QTreeWidget;
    w->setColumnCount(3);
    w->setRootIsDecorated(false);
    w->setAlternatingRowColors(true);
    w->setSortingEnabled(true);
    w->setHeaderLabels(QStringList() << tr("Symbol") << tr("Address") << tr("Code"));
    w->setWindowTitle(tr("Symbols in \"%1\"").arg(moduleName));
    foreach (const Symbol &s, symbols) {
        QTreeWidgetItem *it = new QTreeWidgetItem;
        it->setData(0, Qt::DisplayRole, s.name);
        it->setData(1, Qt::DisplayRole, s.address);
        it->setData(2, Qt::DisplayRole, s.state);
        w->addTopLevelItem(it);
    }
322
    debuggerCore()->createNewDock(w);
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
}

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;
}

362 363 364 365
//SnapshotHandler *DebuggerEngine::snapshotHandler() const
//{
//    return &d->m_snapshotHandler;
//}
366 367 368 369 370 371 372 373

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

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

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

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

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

QAbstractItemModel *DebuggerEngine::localsModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
406 407 408 409
    QAbstractItemModel *model = d->m_watchHandler.model(LocalsWatch);
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("LocalsModel"));
    return model;
410 411 412 413
}

QAbstractItemModel *DebuggerEngine::watchersModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
414 415 416 417
    QAbstractItemModel *model = d->m_watchHandler.model(WatchersWatch);
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("WatchersModel"));
    return model;
418 419 420 421
}

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

QAbstractItemModel *DebuggerEngine::sourceFilesModel() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
430 431 432 433
    QAbstractItemModel *model = d->m_sourceFilesHandler.model();
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("SourceFilesModel"));
    return model;
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
}

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
{
451 452
    //if (msg.size() && msg.at(0).isUpper() && msg.at(1).isUpper())
    //    qDebug() << qPrintable(msg) << "IN STATE" << state();
453
    debuggerCore()->showMessage(msg, channel, timeout);
454 455 456 457 458
    if (d->m_runControl) {
        d->m_runControl->showMessage(msg, channel);
    } else {
        qWarning("Warning: %s (no active run control)", qPrintable(msg));
    }
459 460 461 462
}

void DebuggerEngine::startDebugger(DebuggerRunControl *runControl)
{
hjk's avatar
hjk committed
463
    if (!isSlaveEngine()) {
464
        d->m_progress.setProgressRange(0, 1000);
465 466 467
        Core::FutureProgress *fp = Core::ICore::instance()->progressManager()
            ->addTask(d->m_progress.future(),
            tr("Launching"), _("Debugger.Launcher"));
468
        fp->setKeepOnFinish(Core::FutureProgress::DontKeepOnFinish);
469 470
        d->m_progress.reportStarted();
    }
471 472
    QTC_ASSERT(runControl, notifyEngineSetupFailed(); return);
    QTC_ASSERT(!d->m_runControl, notifyEngineSetupFailed(); return);
473 474 475 476 477 478

    d->m_runControl = runControl;

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

479 480
    if (!d->m_startParameters.environment.size())
        d->m_startParameters.environment = Utils::Environment();
481 482 483 484 485

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

    const unsigned engineCapabilities = debuggerCapabilities();
hjk's avatar
hjk committed
486
    debuggerCore()->action(OperateByInstruction)
487 488
        ->setEnabled(engineCapabilities & DisassemblerCapability);

489 490
    QTC_ASSERT(state() == DebuggerNotReady || state() == DebuggerFinished,
         qDebug() << state());
hjk's avatar
hjk committed
491
    setState(EngineSetupRequested);
492

493
    d->m_progress.setProgressValue(200);
hjk's avatar
hjk committed
494
    setupEngine();
495 496 497 498 499 500 501 502 503 504 505 506 507 508
}

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)
{
509
    breakHandler()->breakByFunction(functionName);
510 511 512 513 514 515
}

void DebuggerEngine::resetLocation()
{
    d->m_disassemblerViewAgent.resetLocation();
    d->m_stackHandler.setCurrentIndex(-1);
516
    debuggerCore()->removeLocationMark();
517 518 519 520 521 522 523 524 525 526 527 528
}

void DebuggerEngine::gotoLocation(const QString &fileName, int lineNumber, bool setMarker)
{
    StackFrame frame;
    frame.file = fileName;
    frame.line = lineNumber;
    gotoLocation(frame, setMarker);
}

void DebuggerEngine::gotoLocation(const StackFrame &frame, bool setMarker)
{
hjk's avatar
hjk committed
529
    if (debuggerCore()->boolSetting(OperateByInstruction) || !frame.isUsable()) {
530
        if (setMarker)
531
            resetLocation();
532 533
        d->m_disassemblerViewAgent.setFrame(frame);
    } else {
534
        debuggerCore()->gotoLocation(frame.file, frame.line, setMarker);
535 536 537
    }
}

538 539 540
// Called from RunControl.
void DebuggerEngine::handleStartFailed()
{
541
    showMessage("HANDLE RUNCONTROL START FAILED");
542
    d->m_runControl = 0;
543
    d->m_progress.setProgressValue(900);
544 545
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
546 547
}

548 549
// Called from RunControl.
void DebuggerEngine::handleFinished()
550
{
551
    showMessage("HANDLE RUNCONTROL FINISHED");
552
    d->m_runControl = 0;
553 554 555 556
    modulesHandler()->removeAll();
    stackHandler()->removeAll();
    threadsHandler()->removeAll();
    watchHandler()->cleanup();
557
    d->m_progress.setProgressValue(1000);
558
    d->m_progress.reportFinished();
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
}

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
583
    return debuggerCore()->boolSetting(UseDebuggingHelpers);
584 585 586 587
}

QStringList DebuggerEngine::qtDumperLibraryLocations() const
{
hjk's avatar
hjk committed
588
    if (debuggerCore()->action(UseCustomDebuggingHelperLocation)->value().toBool()) {
589
        const QString customLocation =
hjk's avatar
hjk committed
590
            debuggerCore()->action(CustomDebuggingHelperLocation)->value().toString();
591 592 593 594 595 596 597 598 599
        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)
{
600
    debuggerCore()->showQtDumperLibraryWarning(details);
601 602 603 604
}

QString DebuggerEngine::qtDumperLibraryName() const
{
hjk's avatar
hjk committed
605 606
    if (debuggerCore()->action(UseCustomDebuggingHelperLocation)->value().toBool())
        return debuggerCore()->action(CustomDebuggingHelperLocation)->value().toString();
607 608 609 610 611 612 613 614
    return startParameters().dumperLibrary;
}

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

hjk's avatar
hjk committed
615
DebuggerState DebuggerEngine::lastGoodState() const
616
{
hjk's avatar
hjk committed
617 618 619 620 621 622 623
    return d->m_lastGoodState;
}

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

hjk's avatar
hjk committed
625 626 627
static bool isAllowedTransition(DebuggerState from, DebuggerState to)
{
    switch (from) {
628
    case DebuggerNotReady:
629
        return to == EngineSetupRequested;
630

hjk's avatar
hjk committed
631
    case EngineSetupRequested:
632 633
        return to == EngineSetupOk || to == EngineSetupFailed;
    case EngineSetupFailed:
634 635 636
        // In is the engine's task to go into a proper "Shutdown"
        // state before calling notifyEngineSetupFailed
        return to == DebuggerFinished;
637
    case EngineSetupOk:
hjk's avatar
hjk committed
638
        return to == InferiorSetupRequested || to == EngineShutdownRequested;
639

hjk's avatar
hjk committed
640 641
    case InferiorSetupRequested:
        return to == EngineRunRequested || to == InferiorSetupFailed;
hjk's avatar
hjk committed
642
    case InferiorSetupFailed:
hjk's avatar
hjk committed
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
        return to == EngineShutdownRequested;

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

    case EngineRunFailed:
        return to == InferiorShutdownRequested;

    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;
664
    case InferiorStopFailed:
hjk's avatar
hjk committed
665
        return to == EngineShutdownRequested;
666 667

    case InferiorUnrunnable:
hjk's avatar
hjk committed
668 669 670 671 672
        return to == InferiorShutdownRequested;
    case InferiorShutdownRequested:
        return to == InferiorShutdownOk || to == InferiorShutdownFailed;
    case InferiorShutdownOk:
        return to == EngineShutdownRequested;
673
    case InferiorShutdownFailed:
hjk's avatar
hjk committed
674
        return to == EngineShutdownRequested;
675

hjk's avatar
hjk committed
676
    case EngineShutdownRequested:
677
        return to == EngineShutdownOk || to == EngineShutdownFailed;
hjk's avatar
hjk committed
678 679 680 681 682 683
    case EngineShutdownOk:
        return to == DebuggerFinished;
    case EngineShutdownFailed:
        return to == DebuggerFinished;

    case DebuggerFinished:
684
        return to == EngineSetupRequested; // Happens on restart.
685 686
    }

687
    qDebug() << "UNKNOWN DEBUGGER STATE:" << from;
688 689 690
    return false;
}

691
void DebuggerEngine::notifyEngineSetupFailed()
hjk's avatar
hjk committed
692
{
hjk's avatar
hjk committed
693
    showMessage(_("NOTE: ENGINE SETUP FAILED"));
hjk's avatar
hjk committed
694
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << state());
695
    setState(EngineSetupFailed);
hjk's avatar
hjk committed
696 697
    QTC_ASSERT(d->m_runControl, return);
    d->m_runControl->startFailed();
hjk's avatar
hjk committed
698
    setState(DebuggerFinished);
hjk's avatar
hjk committed
699 700
}

701
void DebuggerEngine::notifyEngineSetupOk()
702
{
hjk's avatar
hjk committed
703
    showMessage(_("NOTE: ENGINE SETUP OK"));
hjk's avatar
hjk committed
704
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << state());
705
    setState(EngineSetupOk);
hjk's avatar
hjk committed
706
    QTC_ASSERT(d->m_runControl, return);
hjk's avatar
hjk committed
707
    showMessage(_("QUEUE: SETUP INFERIOR"));
hjk's avatar
hjk committed
708
    QTimer::singleShot(0, d, SLOT(doSetupInferior()));
709 710
}

hjk's avatar
hjk committed
711
void DebuggerEnginePrivate::doSetupInferior()
712
{
713
    m_engine->showMessage(_("CALL: SETUP INFERIOR"));
hjk's avatar
hjk committed
714
    QTC_ASSERT(state() == EngineSetupOk, qDebug() << state());
715
    m_progress.setProgressValue(250);
hjk's avatar
hjk committed
716
    m_engine->setState(InferiorSetupRequested);
hjk's avatar
hjk committed
717 718 719 720 721
    m_engine->setupInferior();
}

void DebuggerEngine::notifyInferiorSetupFailed()
{
hjk's avatar
hjk committed
722
    showMessage(_("NOTE: INFERIOR SETUP FAILED"));
hjk's avatar
hjk committed
723
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
hjk's avatar
hjk committed
724
    setState(InferiorSetupFailed);
hjk's avatar
hjk committed
725
    d->queueShutdownEngine();
hjk's avatar
hjk committed
726 727 728 729
}

void DebuggerEngine::notifyInferiorSetupOk()
{
hjk's avatar
hjk committed
730
    showMessage(_("NOTE: INFERIOR SETUP OK"));
hjk's avatar
hjk committed
731
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
hjk's avatar
hjk committed
732
    d->queueRunEngine();
hjk's avatar
hjk committed
733 734 735 736
}

void DebuggerEnginePrivate::doRunEngine()
{
hjk's avatar
hjk committed
737
    m_engine->showMessage(_("CALL: RUN ENGINE"));
hjk's avatar
hjk committed
738
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
739
    m_progress.setProgressValue(300);
hjk's avatar
hjk committed
740 741 742
    m_engine->runEngine();
}

hjk's avatar
hjk committed
743 744
void DebuggerEngine::notifyInferiorUnrunnable()
{
hjk's avatar
hjk committed
745
    showMessage(_("NOTE: INFERIOR UNRUNNABLE"));
746 747
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
748 749 750 751 752 753
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(InferiorUnrunnable);
}

void DebuggerEngine::notifyEngineRunFailed()
{
hjk's avatar
hjk committed
754
    showMessage(_("NOTE: ENGINE RUN FAILED"));
hjk's avatar
hjk committed
755
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
756 757 758
    d->m_progress.setProgressValue(900);
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
759
    setState(EngineRunFailed);
760
    d->queueShutdownInferior();
hjk's avatar
hjk committed
761 762 763 764
}

void DebuggerEngine::notifyEngineRunAndInferiorRunOk()
{
hjk's avatar
hjk committed
765
    showMessage(_("NOTE: ENGINE RUN AND INFERIOR RUN OK"));
766 767
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
768 769 770 771 772 773 774
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(InferiorRunRequested);
    notifyInferiorRunOk();
}

void DebuggerEngine::notifyEngineRunAndInferiorStopOk()
{
hjk's avatar
hjk committed
775
    showMessage(_("NOTE: ENGINE RUN AND INFERIOR STOP OK"));
776 777
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
778 779 780 781 782 783 784
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    setState(InferiorStopRequested);
    notifyInferiorStopOk();
}

void DebuggerEngine::notifyInferiorRunRequested()
{
hjk's avatar
hjk committed
785
    showMessage(_("NOTE: INFERIOR RUN REQUESTED"));
hjk's avatar
hjk committed
786 787 788 789 790 791
    QTC_ASSERT(state() == InferiorStopOk, qDebug() << state());
    setState(InferiorRunRequested);
}

void DebuggerEngine::notifyInferiorRunOk()
{
hjk's avatar
hjk committed
792
    showMessage(_("NOTE: INFERIOR RUN OK"));
hjk's avatar
hjk committed
793 794 795 796 797 798
    QTC_ASSERT(state() == InferiorRunRequested, qDebug() << state());
    setState(InferiorRunOk);
}

void DebuggerEngine::notifyInferiorRunFailed()
{
hjk's avatar
hjk committed
799
    showMessage(_("NOTE: INFERIOR RUN FAILED"));
hjk's avatar
hjk committed
800 801 802
    QTC_ASSERT(state() == InferiorRunRequested, qDebug() << state());
    setState(InferiorRunFailed);
    setState(InferiorStopOk);
hjk's avatar
hjk committed
803 804
    if (isDying())
        d->queueShutdownInferior();
hjk's avatar
hjk committed
805 806 807 808
}

void DebuggerEngine::notifyInferiorStopOk()
{
hjk's avatar
hjk committed
809 810
    showMessage(_("NOTE: INFERIOR STOP OK"));
    // Ignore spurious notifications after we are set to die.
hjk's avatar
hjk committed
811
    if (isDying()) {
hjk's avatar
hjk committed
812 813 814 815 816 817 818 819 820 821 822 823 824
        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
825
    }
hjk's avatar
hjk committed
826 827
    QTC_ASSERT(state() == InferiorStopRequested, qDebug() << state());
    setState(InferiorStopOk);
hjk's avatar
hjk committed
828 829
}

hjk's avatar
hjk committed
830
void DebuggerEngine::notifyInferiorSpontaneousStop()
831
{
hjk's avatar
hjk committed
832
    showMessage(_("NOTE: INFERIOR SPONTANEOUES STOP"));
hjk's avatar
hjk committed
833 834
    QTC_ASSERT(state() == InferiorRunOk, qDebug() << state());
    setState(InferiorStopOk);
835 836
}

hjk's avatar
hjk committed
837
void DebuggerEngine::notifyInferiorStopFailed()
838
{
hjk's avatar
hjk committed
839
    showMessage(_("NOTE: INFERIOR STOP FAILED"));
hjk's avatar
hjk committed
840 841
    QTC_ASSERT(state() == InferiorStopRequested, qDebug() << state());
    setState(InferiorStopFailed);
hjk's avatar
hjk committed
842
    d->queueShutdownEngine();
843 844 845 846
}

void DebuggerEnginePrivate::doInterruptInferior()
{
hjk's avatar
hjk committed
847 848
    QTC_ASSERT(state() == InferiorRunOk, qDebug() << state());
    m_engine->setState(InferiorStopRequested);
hjk's avatar
hjk committed
849
    m_engine->showMessage(_("CALL: INTERRUPT INFERIOR"));
850 851 852
    m_engine->interruptInferior();
}

hjk's avatar
hjk committed
853 854
void DebuggerEnginePrivate::doShutdownInferior()
{
855
    QTC_ASSERT(state() == InferiorShutdownRequested, qDebug() << state());
hjk's avatar
hjk committed
856 857
    m_engine->resetLocation();
    m_targetState = DebuggerFinished;
hjk's avatar
hjk committed
858
    m_engine->showMessage(_("CALL: SHUTDOWN INFERIOR"));
hjk's avatar
hjk committed
859 860 861 862 863 864
    m_engine->shutdownInferior();
}

void DebuggerEngine::notifyInferiorShutdownOk()
{
    showMessage(_("INFERIOR SUCCESSFULLY SHUT DOWN"));
hjk's avatar
hjk committed
865
    QTC_ASSERT(state() == InferiorShutdownRequested, qDebug() << state());
hjk's avatar
hjk committed
866 867
    d->m_lastGoodState = DebuggerNotReady; // A "neutral" value.
    setState(InferiorShutdownOk);
hjk's avatar
hjk committed
868
    d->queueShutdownEngine();
hjk's avatar
hjk committed
869 870 871 872 873
}

void DebuggerEngine::notifyInferiorShutdownFailed()
{
    showMessage(_("INFERIOR SHUTDOWN FAILED"));
Friedemann Kleint's avatar
Friedemann Kleint committed
874
    QTC_ASSERT(state() == InferiorShutdownRequested, qDebug() << this << state());
hjk's avatar
hjk committed
875
    setState(InferiorShutdownFailed);
hjk's avatar
hjk committed
876
    d->queueShutdownEngine();
hjk's avatar
hjk committed
877 878 879 880
}

void DebuggerEngine::notifyInferiorIll()
{
hjk's avatar
hjk committed
881
    showMessage(_("NOTE: INFERIOR ILL"));
hjk's avatar
hjk committed
882 883 884 885 886 887 888 889 890 891 892
    // 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
893
    d->queueShutdownInferior();
hjk's avatar
hjk committed
894 895 896 897
}

void DebuggerEnginePrivate::doShutdownEngine()
{
898
    QTC_ASSERT(state() == EngineShutdownRequested, qDebug() << state());
hjk's avatar
hjk committed
899
    m_targetState = DebuggerFinished;
hjk's avatar
hjk committed
900
    m_engine->showMessage(_("CALL: SHUTDOWN ENGINE"));
hjk's avatar
hjk committed
901 902 903 904 905
    m_engine->shutdownEngine();
}

void DebuggerEngine::notifyEngineShutdownOk()
{
hjk's avatar
hjk committed
906
    showMessage(_("NOTE: ENGINE SHUTDOWN OK"));
hjk's avatar
hjk committed
907 908
    QTC_ASSERT(state() == EngineShutdownRequested, qDebug() << state());
    setState(EngineShutdownOk);
909
    d->queueFinishDebugger();
hjk's avatar
hjk committed
910 911 912
}

void DebuggerEngine::notifyEngineShutdownFailed()
hjk's avatar
hjk committed
913
{
hjk's avatar
hjk committed
914
    showMessage(_("NOTE: ENGINE SHUTDOWN FAILED"));
hjk's avatar
hjk committed
915 916
    QTC_ASSERT(state() == EngineShutdownRequested, qDebug() << state());
    setState(EngineShutdownFailed);
917
    d->queueFinishDebugger();
hjk's avatar
hjk committed
918 919 920 921
}

void DebuggerEnginePrivate::doFinishDebugger()
{
hjk's avatar
hjk committed
922
    m_engine->showMessage(_("NOTE: FINISH DEBUGGER"));
923
    QTC_ASSERT(state() == DebuggerFinished, qDebug() << state());
hjk's avatar
hjk committed
924
    m_engine->resetLocation();
hjk's avatar
hjk committed
925
    QTC_ASSERT(m_runControl, return);
hjk's avatar
hjk committed
926 927 928 929 930
    m_runControl->debuggingFinished();
}

void DebuggerEngine::notifyEngineIll()
{
hjk's avatar
hjk committed
931
    showMessage(_("NOTE: ENGINE ILL ******"));
hjk's avatar
hjk committed
932 933
    d->m_targetState = DebuggerFinished;
    d->m_lastGoodState = d->m_state;
hjk's avatar
hjk committed
934 935 936
    switch (state()) {
        case InferiorRunRequested:
        case InferiorRunOk:
937 938 939 940 941 942 943
            // 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
944 945
        case InferiorStopRequested:
        case InferiorStopOk:
946
            showMessage(_("FORWARDING STATE TO InferiorShutdownFailed"));
hjk's avatar
hjk committed
947
            setState(InferiorShutdownFailed, true);
948
            d->queueShutdownEngine();
hjk's avatar
hjk committed
949 950
            break;
        default:
951
            d->queueShutdownEngine();
hjk's avatar
hjk committed
952
            break;
hjk's avatar
hjk committed
953 954 955 956 957
    }
}

void DebuggerEngine::notifyEngineSpontaneousShutdown()
{
hjk's avatar
hjk committed
958
    showMessage(_("NOTE: ENGINE SPONTANEOUS SHUTDOWN"));
959
    setState(EngineShutdownOk, true);
hjk's avatar
hjk committed
960
    d->queueFinishDebugger();
hjk's avatar
hjk committed
961 962 963 964
}

void DebuggerEngine::notifyInferiorExited()
{
hjk's avatar
hjk committed
965
    showMessage(_("NOTE: INFERIOR EXITED"));
hjk's avatar
hjk committed
966 967 968 969 970 971 972 973 974 975 976
    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);