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

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

53
#include <projectexplorer/toolchaintype.h>
54

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

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

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

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

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

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

83

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

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

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


namespace Debugger {

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 123 124 125 126 127 128 129 130 131
}

QDebug operator<<(QDebug str, const DebuggerStartParameters &sp)
{
    QDebug nospace = str.nospace();
    const QString sep = QString(QLatin1Char(','));
    nospace << "executable=" << sp.executable
            << " coreFile=" << sp.coreFile
            << " processArgs=" << sp.processArgs.join(sep)
            << " 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
public:
    DebuggerEnginePrivate(DebuggerEngine *engine, const DebuggerStartParameters &sp)
      : m_engine(engine),
        m_runControl(0),
184
        m_isActive(false),
185 186
        m_startParameters(sp),
        m_state(DebuggerNotReady),
hjk's avatar
hjk committed
187
        m_lastGoodState(DebuggerNotReady),
Friedemann Kleint's avatar
Friedemann Kleint committed
188
        m_targetState(DebuggerNotReady),
189
        m_modulesHandler(),
190
        m_registerHandler(),
191 192
        m_sourceFilesHandler(),
        m_stackHandler(),
hjk's avatar
hjk committed
193
        m_threadsHandler(),
194
        m_watchHandler(engine),
195
        m_disassemblerViewAgent(engine),
196
        m_isSlaveEngine(false)
197
    {}
198 199

    ~DebuggerEnginePrivate() {}
200

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

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

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

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

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

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

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

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

    DebuggerStartParameters m_startParameters;
hjk's avatar
hjk committed
253 254

    // The current state.
255 256
    DebuggerState m_state;

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

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

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

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

274
    QHash<quint64, Internal::BreakpointData *> m_breakpoints;
275
    bool m_isSlaveEngine;
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
};


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

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

DebuggerEngine::~DebuggerEngine()
{
292 293
    disconnect();
    delete d;
294 295
}

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

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

307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
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);
    }
    plugin()->createNewDock(w);
}

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

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

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

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

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

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

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

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

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

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

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

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

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

    d->m_runControl = runControl;

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

    if (d->m_startParameters.environment.empty())
482
        d->m_startParameters.environment = Utils::Environment().toStringList();
483 484 485 486 487 488 489 490

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

    const unsigned engineCapabilities = debuggerCapabilities();
    theDebuggerAction(OperateByInstruction)
        ->setEnabled(engineCapabilities & DisassemblerCapability);

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

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

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)
{
511 512
    breakHandler()->breakByFunction(functionName);
    breakHandler()->synchronizeBreakpoints();
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
}

void DebuggerEngine::resetLocation()
{
    d->m_disassemblerViewAgent.resetLocation();
    d->m_stackHandler.setCurrentIndex(-1);
    plugin()->resetLocation();
}

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)
{
    if (theDebuggerBoolSetting(OperateByInstruction) || !frame.isUsable()) {
        if (setMarker)
            plugin()->resetLocation();
        d->m_disassemblerViewAgent.setFrame(frame);
    } else {
        plugin()->gotoLocation(frame.file, frame.line, setMarker);
    }
}

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

551 552
// Called from RunControl.
void DebuggerEngine::handleFinished()
553
{
554
    showMessage("HANDLE RUNCONTROL FINISHED");
555
    d->m_runControl = 0;
556 557 558 559
    modulesHandler()->removeAll();
    stackHandler()->removeAll();
    threadsHandler()->removeAll();
    watchHandler()->cleanup();
560
    d->m_progress.setProgressValue(1000);
561
    d->m_progress.reportFinished();
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
}

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
{
    return theDebuggerBoolSetting(UseDebuggingHelpers);
}

QStringList DebuggerEngine::qtDumperLibraryLocations() const
{
    if (theDebuggerAction(UseCustomDebuggingHelperLocation)->value().toBool()) {
        const QString customLocation =
            theDebuggerAction(CustomDebuggingHelperLocation)->value().toString();
        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)
{
603
    plugin()->showQtDumperLibraryWarning(details);
604 605 606 607 608 609 610 611 612 613 614 615 616 617
}

QString DebuggerEngine::qtDumperLibraryName() const
{
    if (theDebuggerAction(UseCustomDebuggingHelperLocation)->value().toBool())
        return theDebuggerAction(CustomDebuggingHelperLocation)->value().toString();
    return startParameters().dumperLibrary;
}

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

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

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

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

hjk's avatar
hjk committed
634
    case EngineSetupRequested:
635 636
        return to == EngineSetupOk || to == EngineSetupFailed;
    case EngineSetupFailed:
637
        // FIXME: In therory it's the engine's task to go into a
638 639 640
        // proper "Shutdown" state before calling notifyEngineSetupFailed
        //return to == DebuggerFinished;
        return to == EngineShutdownRequested;
641
    case EngineSetupOk:
hjk's avatar
hjk committed
642
        return to == InferiorSetupRequested || to == EngineShutdownRequested;
643

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

    case InferiorUnrunnable:
hjk's avatar
hjk committed
672 673 674 675 676
        return to == InferiorShutdownRequested;
    case InferiorShutdownRequested:
        return to == InferiorShutdownOk || to == InferiorShutdownFailed;
    case InferiorShutdownOk:
        return to == EngineShutdownRequested;
677
    case InferiorShutdownFailed:
hjk's avatar
hjk committed
678
        return to == EngineShutdownRequested;
679

hjk's avatar
hjk committed
680
    case EngineShutdownRequested:
681
        return to == EngineShutdownOk || to == EngineShutdownFailed;
hjk's avatar
hjk committed
682 683 684 685 686 687
    case EngineShutdownOk:
        return to == DebuggerFinished;
    case EngineShutdownFailed:
        return to == DebuggerFinished;

    case DebuggerFinished:
688
        return to == EngineSetupRequested; // Happens on restart.
689 690 691 692 693 694
    }

    qDebug() << "UNKNOWN STATE:" << from;
    return false;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

984 985
void DebuggerEngine::setState(DebuggerState state, bool forced)
{
986
    //qDebug() << "STATUS CHANGE: FROM " << stateName(d->m_state)
987
    //         << " TO " << stateName(state);
988

989 990 991
    DebuggerState oldState = d->m_state;
    d->m_state = state;

hjk's avatar
hjk committed
992 993 994
    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" : "");
995
    if (!forced && !isAllowedTransition(oldState, state))
996 997
        qDebug() << "UNEXPECTED STATE TRANSITION: " << msg;

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

1002
    showMessage(msg, LogDebug);
1003
    updateViews();
1004 1005 1006 1007

    emit stateChanged(d->m_state);
}

1008 1009
void DebuggerEngine::updateViews()
{
1010 1011