debuggerengine.cpp 39.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
#include <QtGui/QMessageBox>
67

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

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

82

83 84 85 86 87 88
///////////////////////////////////////////////////////////////////////
//
// DebuggerStartParameters
//
///////////////////////////////////////////////////////////////////////

89 90
namespace Debugger {

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

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

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

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

166

167 168 169 170 171 172
//////////////////////////////////////////////////////////////////////
//
// DebuggerEnginePrivate
//
//////////////////////////////////////////////////////////////////////

173
class DebuggerEnginePrivate : public QObject
174
{
175 176
    Q_OBJECT

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

    ~DebuggerEnginePrivate() {}
196

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

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

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

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

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

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

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

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

    DebuggerStartParameters m_startParameters;
hjk's avatar
hjk committed
248 249

    // The current state.
250 251
    DebuggerState m_state;

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

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

258 259 260 261 262 263 264 265 266
    qint64 m_inferiorPid;

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    d->m_runControl = runControl;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

hjk's avatar
hjk committed
611 612
    case InferiorSetupRequested:
        return to == EngineRunRequested || to == InferiorSetupFailed;
hjk's avatar
hjk committed
613
    case InferiorSetupFailed:
hjk's avatar
hjk committed
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
        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;
635
    case InferiorStopFailed:
hjk's avatar
hjk committed
636
        return to == EngineShutdownRequested;
637 638

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

953 954
void DebuggerEngine::setState(DebuggerState state, bool forced)
{
hjk's avatar
hjk committed
955 956
    //qDebug() << "STATUS CHANGE: FROM " << stateName(d->m_state)
    //         << " TO " << stateName(state);
957

958 959 960
    DebuggerState oldState = d->m_state;
    d->m_state = state;

hjk's avatar
hjk committed
961 962 963
    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" : "");
964
    if (!forced &&