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

#include <QtGui/QStandardItemModel>
#include <QtGui/QAction>
#include <QtGui/QTreeWidget>
69
#include <QtGui/QMessageBox>
70

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

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

85

86 87 88 89 90 91
///////////////////////////////////////////////////////////////////////
//
// DebuggerStartParameters
//
///////////////////////////////////////////////////////////////////////

92 93
namespace Debugger {

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

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

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

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

169

170 171 172 173 174 175
//////////////////////////////////////////////////////////////////////
//
// DebuggerEnginePrivate
//
//////////////////////////////////////////////////////////////////////

176
class DebuggerEnginePrivate : public QObject
177
{
178 179
    Q_OBJECT

180 181 182 183 184 185
public:
    DebuggerEnginePrivate(DebuggerEngine *engine, const DebuggerStartParameters &sp)
      : m_engine(engine),
        m_runControl(0),
        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 249 250
    DebuggerEngine *m_engine; // Not owned.
    DebuggerRunControl *m_runControl;  // Not owned.

    DebuggerStartParameters m_startParameters;
hjk's avatar
hjk committed
251 252

    // The current state.
253 254
    DebuggerState m_state;

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

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

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

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

272
    bool m_isSlaveEngine;
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
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);
    }
321
    debuggerCore()->createNewDock(w);
322 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
}

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

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

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

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

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

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

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

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

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

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

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

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

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

    d->m_runControl = runControl;

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

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

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

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

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

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

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

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

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
528
    if (debuggerCore()->boolSetting(OperateByInstruction) || !frame.isUsable()) {
529
        if (setMarker)
530
            resetLocation();
531 532
        d->m_disassemblerViewAgent.setFrame(frame);
    } else {
533
        debuggerCore()->gotoLocation(frame.file, frame.line, setMarker);
534 535 536
    }
}

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

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

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

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

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

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

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

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

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

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

hjk's avatar
hjk committed
639 640
    case InferiorSetupRequested:
        return to == EngineRunRequested || to == InferiorSetupFailed;
hjk's avatar
hjk committed
641
    case InferiorSetupFailed:
hjk's avatar
hjk committed
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
        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;
663
    case InferiorStopFailed:
hjk's avatar
hjk committed
664
        return to == EngineShutdownRequested;
665 666

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

979 980
void DebuggerEngine::setState(DebuggerState state, bool forced)
{
hjk's avatar
hjk committed
981 982
    //qDebug() << "STATUS CHANGE: FROM " << stateName(d->m_state)
    //         << " TO " << stateName(state);
983

984 985 986
    DebuggerState oldState = d->m_state;
    d->m_state = state;

hjk's avatar
hjk committed
987 988 989
    QString msg = _("State changed%5 from %1(%2) to %3(%4).")
     .arg(stateName(oldState)).arg(oldState).arg(stateName(state)).arg(state)
     .arg(forced ? " BY FORCE" : "");
990
    if (!forced && !isAllowedTransition(oldState, state))
991 992
        qDebug() << "UNEXPECTED STATE TRANSITION: " << msg;

hjk's avatar
hjk committed
993 994 995 996 997 998 999
    if (state == DebuggerFinished) {
        // Give up ownership on claimed breakpoints.
        BreakHandler *handler = breakHandler();
        foreach (BreakpointId id, handler->engineBreakpointIds(this))
            handler->notifyBreakpointReleased(id);
    }

1000 1001 1002 1003
    const bool running = d->m_state == InferiorRunOk;
    if (running)
        threadsHandler()->notifyRunning();

1004
    showMessage(msg, LogDebug);
1005
    updateViews();
1006 1007 1008 1009

    emit stateChanged(d->m_state);
}

1010 1011
void DebuggerEngine::updateViews()
{
1012 1013 1014
    // The slave engines are not entitled to change the view. Their wishes
    // should be coordinated by their master engine.
    if (isSlaveEngine())
hjk's avatar
x  
hjk committed
1015
        return;