debuggerengine.cpp 56.5 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
3
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
7
**
hjk's avatar
hjk committed
8 9 10 11 12
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
Eike Ziller's avatar
Eike Ziller committed
13 14
** conditions see http://www.qt.io/licensing.  For further information
** use the contact form at http://www.qt.io/contact-us.
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18 19 20 21 22 23
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
hjk's avatar
hjk committed
24 25 26
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
27 28
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
29
****************************************************************************/
30 31 32

#include "debuggerengine.h"

33
#include "debuggerinternalconstants.h"
34
#include "debuggeractions.h"
35
#include "debuggercore.h"
36
#include "debuggerruncontrol.h"
37
#include "debuggerstringutils.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
38
#include "debuggerstartparameters.h"
39
#include "debuggertooltipmanager.h"
40 41

#include "breakhandler.h"
David Schulz's avatar
David Schulz committed
42 43
#include "disassembleragent.h"
#include "memoryagent.h"
44 45 46 47 48 49
#include "moduleshandler.h"
#include "registerhandler.h"
#include "sourcefileshandler.h"
#include "stackhandler.h"
#include "threadshandler.h"
#include "watchhandler.h"
50
#include <debugger/shared/peutils.h>
51

hjk's avatar
hjk committed
52
#include <coreplugin/editormanager/editormanager.h>
53
#include <coreplugin/editormanager/ieditor.h>
hjk's avatar
hjk committed
54
#include <coreplugin/icore.h>
55 56
#include <coreplugin/progressmanager/progressmanager.h>
#include <coreplugin/progressmanager/futureprogress.h>
hjk's avatar
hjk committed
57

hjk's avatar
hjk committed
58
#include <projectexplorer/projectexplorer.h>
59 60
#include <projectexplorer/taskhub.h>

61
#include <texteditor/texteditor.h>
62

63
#include <utils/fileinprojectfinder.h>
hjk's avatar
hjk committed
64 65 66
#include <utils/macroexpander.h>
#include <utils/qtcassert.h>
#include <utils/savedaction.h>
67

68
#include <qmljs/consolemanagerinterface.h>
69

70 71 72
#include <QDebug>
#include <QTimer>
#include <QFileInfo>
73
#include <QDir>
74

75
#include <QMessageBox>
76

hjk's avatar
hjk committed
77
using namespace Core;
78
using namespace Debugger::Internal;
hjk's avatar
hjk committed
79 80
using namespace ProjectExplorer;
using namespace TextEditor;
81

82 83 84 85
enum { debug = 0 };

#define SDEBUG(s) if (!debug) {} else qDebug() << s;
#define XSDEBUG(s) qDebug() << s
86

87 88 89 90
//#define WITH_BENCHMARK
#ifdef WITH_BENCHMARK
#include <valgrind/callgrind.h>
#endif
91

92 93 94 95 96 97
///////////////////////////////////////////////////////////////////////
//
// DebuggerStartParameters
//
///////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
98 99 100
// VariableManager Prefix
const char PrefixDebugExecutable[]  = "DebuggedExecutable";

101 102
namespace Debugger {

Friedemann Kleint's avatar
Friedemann Kleint committed
103 104 105 106 107 108 109 110 111
Internal::Location::Location(const StackFrame &frame, bool marker)
{
    init();
    m_fileName = frame.file;
    m_lineNumber = frame.line;
    m_needsMarker = marker;
    m_functionName = frame.function;
    m_hasDebugInfo = frame.isUsable();
    m_address = frame.address;
112
    m_from = frame.from;
Friedemann Kleint's avatar
Friedemann Kleint committed
113 114
}

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

QDebug operator<<(QDebug str, const DebuggerStartParameters &sp)
{
    QDebug nospace = str.nospace();
    nospace << "executable=" << sp.executable
            << " coreFile=" << sp.coreFile
126
            << " processArgs=" << sp.processArgs
127 128 129 130 131 132
            << " environment=<" << sp.environment.size() << " variables>"
            << " workingDir=" << sp.workingDirectory
            << " attachPID=" << sp.attachPID
            << " useTerminal=" << sp.useTerminal
            << " remoteChannel=" << sp.remoteChannel
            << " serverStartScript=" << sp.serverStartScript
133
            << " abi=" << sp.toolChainAbi.toString() << '\n';
134 135 136
    return str;
}

137

138 139 140 141 142 143
//////////////////////////////////////////////////////////////////////
//
// DebuggerEnginePrivate
//
//////////////////////////////////////////////////////////////////////

144 145 146 147 148 149 150 151 152
// transitions:
//   None->Requested
//   Requested->Succeeded
//   Requested->Failed
//   Requested->Cancelled
enum RemoteSetupState { RemoteSetupNone, RemoteSetupRequested,
                        RemoteSetupSucceeded, RemoteSetupFailed,
                        RemoteSetupCancelled };

153
class DebuggerEnginePrivate : public QObject
154
{
155 156
    Q_OBJECT

157
public:
158
    DebuggerEnginePrivate(DebuggerEngine *engine, const DebuggerStartParameters &sp)
159
      : m_engine(engine),
160
        m_masterEngine(0),
161 162 163
        m_runControl(0),
        m_startParameters(sp),
        m_state(DebuggerNotReady),
hjk's avatar
hjk committed
164
        m_lastGoodState(DebuggerNotReady),
Friedemann Kleint's avatar
Friedemann Kleint committed
165
        m_targetState(DebuggerNotReady),
166
        m_remoteSetupState(RemoteSetupNone),
167
        m_inferiorPid(0),
168
        m_modulesHandler(engine),
169
        m_registerHandler(),
170 171
        m_sourceFilesHandler(),
        m_stackHandler(),
hjk's avatar
hjk committed
172
        m_threadsHandler(),
173
        m_watchHandler(engine),
174
        m_disassemblerAgent(engine),
175
        m_memoryAgent(engine),
176
        m_isStateDebugging(false)
177
    {
178
        connect(&m_locationTimer, SIGNAL(timeout()), SLOT(resetLocation()));
hjk's avatar
hjk committed
179
        connect(action(IntelFlavor), SIGNAL(valueChanged(QVariant)),
180
                SLOT(reloadDisassembly()));
181

hjk's avatar
hjk committed
182
        Utils::globalMacroExpander()->registerFileVariables(PrefixDebugExecutable,
183
            tr("Debugged executable"),
Orgad Shaneh's avatar
Orgad Shaneh committed
184
            [this]() { return m_startParameters.executable; });
185
    }
186

187
public slots:
188
    void doSetupEngine();
hjk's avatar
hjk committed
189 190
    void doSetupInferior();
    void doRunEngine();
hjk's avatar
hjk committed
191 192
    void doShutdownEngine();
    void doShutdownInferior();
193
    void doInterruptInferior();
hjk's avatar
hjk committed
194
    void doFinishDebugger();
hjk's avatar
hjk committed
195

196 197 198 199 200
    void reloadDisassembly()
    {
        m_disassemblerAgent.reload();
    }

201 202 203 204 205 206 207 208 209 210 211 212 213 214
    void queueSetupEngine()
    {
        m_engine->setState(EngineSetupRequested);
        m_engine->showMessage(_("QUEUE: SETUP ENGINE"));
        QTimer::singleShot(0, this, SLOT(doSetupEngine()));
    }

    void queueSetupInferior()
    {
        m_engine->setState(InferiorSetupRequested);
        m_engine->showMessage(_("QUEUE: SETUP INFERIOR"));
        QTimer::singleShot(0, this, SLOT(doSetupInferior()));
    }

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

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

229 230
    void queueShutdownInferior()
    {
hjk's avatar
hjk committed
231 232 233 234 235
        m_engine->setState(InferiorShutdownRequested);
        m_engine->showMessage(_("QUEUE: SHUTDOWN INFERIOR"));
        QTimer::singleShot(0, this, SLOT(doShutdownInferior()));
    }

236 237
    void queueFinishDebugger()
    {
238 239 240
        QTC_ASSERT(state() == EngineShutdownOk
            || state() == EngineShutdownFailed, qDebug() << state());
        m_engine->setState(DebuggerFinished);
241 242 243 244 245
        resetLocation();
        if (isMasterEngine()) {
            m_engine->showMessage(_("QUEUE: FINISH DEBUGGER"));
            QTimer::singleShot(0, this, SLOT(doFinishDebugger()));
        }
hjk's avatar
hjk committed
246 247
    }

248 249
    void raiseApplication()
    {
250 251
        QTC_ASSERT(runControl(), return);
        runControl()->bringApplicationToForeground(m_inferiorPid);
252 253
    }

254
    void scheduleResetLocation()
255
    {
256
        m_stackHandler.scheduleResetLocation();
257
        m_watchHandler.scheduleResetLocation();
258
        m_threadsHandler.scheduleResetLocation();
259
        m_disassemblerAgent.scheduleResetLocation();
260 261 262 263
        m_locationTimer.setSingleShot(true);
        m_locationTimer.start(80);
    }

264
    void resetLocation()
265 266 267
    {
        m_locationTimer.stop();
        m_locationMark.reset();
268
        m_stackHandler.resetLocation();
269
        m_watchHandler.resetLocation();
270
        m_threadsHandler.resetLocation();
271
        m_disassemblerAgent.resetLocation();
hjk's avatar
hjk committed
272
        DebuggerToolTipManager::resetLocation();
273 274
    }

275
public:
hjk's avatar
hjk committed
276
    DebuggerState state() const { return m_state; }
277
    RemoteSetupState remoteSetupState() const { return m_remoteSetupState; }
278 279 280
    bool isMasterEngine() const { return m_engine->isMasterEngine(); }
    DebuggerRunControl *runControl() const
        { return m_masterEngine ? m_masterEngine->runControl() : m_runControl; }
281
    void setRemoteSetupState(RemoteSetupState state);
hjk's avatar
hjk committed
282

283
    DebuggerEngine *m_engine; // Not owned.
284
    DebuggerEngine *m_masterEngine; // Not owned
285 286 287
    DebuggerRunControl *m_runControl;  // Not owned.

    DebuggerStartParameters m_startParameters;
hjk's avatar
hjk committed
288 289

    // The current state.
290 291
    DebuggerState m_state;

hjk's avatar
hjk committed
292 293 294 295 296 297
    // The state we had before something unexpected happend.
    DebuggerState m_lastGoodState;

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

298 299 300
    // State of RemoteSetup signal/slots.
    RemoteSetupState m_remoteSetupState;

301 302 303 304 305 306 307 308
    qint64 m_inferiorPid;

    ModulesHandler m_modulesHandler;
    RegisterHandler m_registerHandler;
    SourceFilesHandler m_sourceFilesHandler;
    StackHandler m_stackHandler;
    ThreadsHandler m_threadsHandler;
    WatchHandler m_watchHandler;
309
    QFutureInterface<void> m_progress;
310

311 312
    DisassemblerAgent m_disassemblerAgent;
    MemoryAgent m_memoryAgent;
hjk's avatar
hjk committed
313
    QScopedPointer<TextEditor::TextMark> m_locationMark;
314
    QTimer m_locationTimer;
315 316

    bool m_isStateDebugging;
317

318
    Utils::FileInProjectFinder m_fileFinder;
319 320 321 322 323 324 325 326 327
};


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

328 329
DebuggerEngine::DebuggerEngine(const DebuggerStartParameters &startParameters)
  : d(new DebuggerEnginePrivate(this, startParameters))
330
{}
331 332 333

DebuggerEngine::~DebuggerEngine()
{
334 335
    disconnect();
    delete d;
336 337
}

338 339 340 341 342 343 344 345 346 347 348
const char *DebuggerEngine::stateName(int s)
{
#    define SN(x) case x: return #x;
    switch (s) {
        SN(DebuggerNotReady)
        SN(EngineSetupRequested)
        SN(EngineSetupOk)
        SN(EngineSetupFailed)
        SN(EngineRunFailed)
        SN(InferiorSetupRequested)
        SN(InferiorSetupFailed)
349
        SN(InferiorSetupOk)
350 351 352 353 354 355 356 357
        SN(EngineRunRequested)
        SN(InferiorRunRequested)
        SN(InferiorRunOk)
        SN(InferiorRunFailed)
        SN(InferiorUnrunnable)
        SN(InferiorStopRequested)
        SN(InferiorStopOk)
        SN(InferiorStopFailed)
358
        SN(InferiorExitOk)
359 360 361 362 363 364 365 366 367 368 369 370
        SN(InferiorShutdownRequested)
        SN(InferiorShutdownOk)
        SN(InferiorShutdownFailed)
        SN(EngineShutdownRequested)
        SN(EngineShutdownOk)
        SN(EngineShutdownFailed)
        SN(DebuggerFinished)
    }
    return "<unknown>";
#    undef SN
}

371
void DebuggerEngine::showStatusMessage(const QString &msg, int timeout) const
372
{
373
    showMessage(msg, StatusBar, timeout);
374
}
375

376 377 378 379 380 381 382 383 384 385 386 387
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));
}

388 389 390 391 392
void DebuggerEngine::setTargetState(DebuggerState state)
{
    d->m_targetState = state;
}

393 394
ModulesHandler *DebuggerEngine::modulesHandler() const
{
395 396 397
    return d->m_masterEngine
        ? d->m_masterEngine->modulesHandler()
        : &d->m_modulesHandler;
398 399 400 401
}

RegisterHandler *DebuggerEngine::registerHandler() const
{
402 403 404
    return d->m_masterEngine
        ? d->m_masterEngine->registerHandler()
        : &d->m_registerHandler;
405 406 407 408
}

StackHandler *DebuggerEngine::stackHandler() const
{
Aurindam Jana's avatar
Aurindam Jana committed
409 410 411
    return d->m_masterEngine
        ? d->m_masterEngine->stackHandler()
        : &d->m_stackHandler;
412 413 414 415
}

ThreadsHandler *DebuggerEngine::threadsHandler() const
{
416 417 418
    return d->m_masterEngine
        ? d->m_masterEngine->threadsHandler()
        : &d->m_threadsHandler;
419 420 421 422
}

WatchHandler *DebuggerEngine::watchHandler() const
{
423 424 425
    return d->m_masterEngine
        ? d->m_masterEngine->watchHandler()
        : &d->m_watchHandler;
426 427 428 429
}

SourceFilesHandler *DebuggerEngine::sourceFilesHandler() const
{
430 431 432
    return d->m_masterEngine
        ? d->m_masterEngine->sourceFilesHandler()
        : &d->m_sourceFilesHandler;
433 434 435 436
}

QAbstractItemModel *DebuggerEngine::modulesModel() const
{
437
   return modulesHandler()->model();
438 439 440 441
}

QAbstractItemModel *DebuggerEngine::registerModel() const
{
442
    return registerHandler()->model();
443 444 445 446
}

QAbstractItemModel *DebuggerEngine::stackModel() const
{
447
    return stackHandler()->model();
448 449 450 451
}

QAbstractItemModel *DebuggerEngine::threadsModel() const
{
452
    return threadsHandler()->model();
453 454
}

hjk's avatar
hjk committed
455 456 457
QAbstractItemModel *DebuggerEngine::watchModel() const
{
    return watchHandler()->model();
458 459
}

460 461
QAbstractItemModel *DebuggerEngine::sourceFilesModel() const
{
462
    return sourceFilesHandler()->model();
463 464
}

465
void DebuggerEngine::fetchMemory(MemoryAgent *, QObject *,
466 467 468 469 470 471
        quint64 addr, quint64 length)
{
    Q_UNUSED(addr);
    Q_UNUSED(length);
}

hjk's avatar
hjk committed
472 473 474 475 476 477 478
void DebuggerEngine::changeMemory(MemoryAgent *, QObject *,
        quint64 addr, const QByteArray &data)
{
    Q_UNUSED(addr);
    Q_UNUSED(data);
}

479 480 481 482 483 484 485 486
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
{
487 488 489 490
    if (d->m_masterEngine) {
        d->m_masterEngine->showMessage(msg, channel, timeout);
        return;
    }
491 492
    //if (msg.size() && msg.at(0).isUpper() && msg.at(1).isUpper())
    //    qDebug() << qPrintable(msg) << "IN STATE" << state();
493
    QmlJS::ConsoleManagerInterface *consoleManager = QmlJS::ConsoleManagerInterface::instance();
494
    if (channel == ConsoleOutput && consoleManager)
495
        consoleManager->printToConsolePane(QmlJS::ConsoleItem::UndefinedType, msg);
496

497
    Internal::showMessage(msg, channel, timeout);
498 499 500 501 502 503 504 505 506 507 508 509 510
    if (d->m_runControl) {
        switch (channel) {
            case AppOutput:
                d->m_runControl->appendMessage(msg, Utils::StdOutFormatSameLine);
                break;
            case AppError:
                d->m_runControl->appendMessage(msg, Utils::StdErrFormatSameLine);
                break;
            case AppStuff:
                d->m_runControl->appendMessage(msg, Utils::DebugFormat);
                break;
        }
    } else {
511
        qWarning("Warning: %s (no active run control)", qPrintable(msg));
512
    }
513 514 515 516
}

void DebuggerEngine::startDebugger(DebuggerRunControl *runControl)
{
517 518
    QTC_ASSERT(runControl, notifyEngineSetupFailed(); return);
    QTC_ASSERT(!d->m_runControl, notifyEngineSetupFailed(); return);
519

520
    d->m_progress.setProgressRange(0, 1000);
521
    FutureProgress *fp = ProgressManager::addTask(d->m_progress.future(),
522
        tr("Launching Debugger"), "Debugger.Launcher");
523
    connect(fp, SIGNAL(canceled()), this, SLOT(quitDebugger()));
524
    fp->setKeepOnFinish(FutureProgress::HideOnFinish);
525 526
    d->m_progress.reportStarted();

527 528 529 530
    d->m_runControl = runControl;

    d->m_inferiorPid = d->m_startParameters.attachPID > 0
        ? d->m_startParameters.attachPID : 0;
531 532
    if (d->m_inferiorPid)
        d->m_runControl->setApplicationProcessHandle(ProcessHandle(d->m_inferiorPid));
533

534 535
    if (!d->m_startParameters.environment.size())
        d->m_startParameters.environment = Utils::Environment();
536

hjk's avatar
hjk committed
537
    action(OperateByInstruction)->setEnabled(hasCapability(DisassemblerCapability));
538

539 540
    QTC_ASSERT(state() == DebuggerNotReady || state() == DebuggerFinished,
         qDebug() << state());
541 542
    d->m_lastGoodState = DebuggerNotReady;
    d->m_targetState = DebuggerNotReady;
543
    d->m_progress.setProgressValue(200);
544
    d->queueSetupEngine();
545 546 547 548
}

void DebuggerEngine::resetLocation()
{
549 550
    // Do it after some delay to avoid flicker.
    d->scheduleResetLocation();
551 552
}

553
void DebuggerEngine::gotoLocation(const Location &loc)
554
{
Aurindam Jana's avatar
Aurindam Jana committed
555 556
     d->resetLocation();

Aurindam Jana's avatar
Aurindam Jana committed
557
    if ((hasCapability(OperateByInstructionCapability) &&
hjk's avatar
hjk committed
558
            boolSetting(OperateByInstruction)) || !loc.hasDebugInfo()) {
559 560 561
        d->m_disassemblerAgent.setLocation(loc);
        return;
    }
562 563 564 565 566
    // CDB might hit on breakpoints while shutting down.
    //if (m_shuttingDown)
    //    return;


567
    const QString file = QDir::cleanPath(loc.fileName());
568
    const int line = loc.lineNumber();
569
    bool newEditor = false;
570
    IEditor *editor = EditorManager::openEditor(file, Id(),
571 572
                                                EditorManager::IgnoreNavigationHistory, &newEditor);
    QTC_ASSERT(editor, return); // Unreadable file?
573

hjk's avatar
hjk committed
574
    editor->gotoLine(line, 0, !boolSetting(StationaryEditorWhileStepping));
575

576 577
    if (newEditor)
        editor->document()->setProperty(Constants::OPENED_BY_DEBUGGER, true);
hjk's avatar
hjk committed
578

579
    if (loc.needsMarker()) {
hjk's avatar
hjk committed
580
        d->m_locationMark.reset(new TextEditor::TextMark(file, line));
581
        d->m_locationMark->setIcon(Internal::locationMarkIcon());
hjk's avatar
hjk committed
582
        d->m_locationMark->setPriority(TextEditor::TextMark::HighPriority);
583
    }
584 585

    //qDebug() << "MEMORY: " << d->m_memoryAgent.hasVisibleEditor();
586 587
}

588 589 590
// Called from RunControl.
void DebuggerEngine::handleStartFailed()
{
591
    showMessage(QLatin1String("HANDLE RUNCONTROL START FAILED"));
592
    d->m_runControl = 0;
593
    d->m_progress.setProgressValue(900);
594 595
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
596 597
}

598 599
// Called from RunControl.
void DebuggerEngine::handleFinished()
600
{
601
    showMessage(QLatin1String("HANDLE RUNCONTROL FINISHED"));
602
    d->m_runControl = 0;
603 604
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
    modulesHandler()->removeAll();
    stackHandler()->removeAll();
    threadsHandler()->removeAll();
    watchHandler()->cleanup();
}

const DebuggerStartParameters &DebuggerEngine::startParameters() const
{
    return d->m_startParameters;
}

DebuggerStartParameters &DebuggerEngine::startParameters()
{
    return d->m_startParameters;
}

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

hjk's avatar
hjk committed
626
DebuggerState DebuggerEngine::lastGoodState() const
627
{
hjk's avatar
hjk committed
628 629 630 631 632 633 634
    return d->m_lastGoodState;
}

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

hjk's avatar
hjk committed
636 637 638
static bool isAllowedTransition(DebuggerState from, DebuggerState to)
{
    switch (from) {
639
    case DebuggerNotReady:
640
        return to == EngineSetupRequested;
641

hjk's avatar
hjk committed
642
    case EngineSetupRequested:
643 644
        return to == EngineSetupOk || to == EngineSetupFailed;
    case EngineSetupFailed:
645 646 647
        // In is the engine's task to go into a proper "Shutdown"
        // state before calling notifyEngineSetupFailed
        return to == DebuggerFinished;
648
    case EngineSetupOk:
hjk's avatar
hjk committed
649
        return to == InferiorSetupRequested || to == EngineShutdownRequested;
650

hjk's avatar
hjk committed
651
    case InferiorSetupRequested:
652
        return to == InferiorSetupOk || to == InferiorSetupFailed;
hjk's avatar
hjk committed
653
    case InferiorSetupFailed:
hjk's avatar
hjk committed
654
        return to == EngineShutdownRequested;
655 656
    case InferiorSetupOk:
        return to == EngineRunRequested;
hjk's avatar
hjk committed
657 658

    case EngineRunRequested:
hjk's avatar
hjk committed
659
        return to == EngineRunFailed
660
            || to == InferiorRunRequested
hjk's avatar
hjk committed
661 662 663
            || to == InferiorRunOk
            || to == InferiorStopOk
            || to == InferiorUnrunnable;
hjk's avatar
hjk committed
664
    case EngineRunFailed:
665
        return to == EngineShutdownRequested;
hjk's avatar
hjk committed
666 667 668 669 670 671

    case InferiorRunRequested:
        return to == InferiorRunOk || to == InferiorRunFailed;
    case InferiorRunFailed:
        return to == InferiorStopOk;
    case InferiorRunOk:
672 673 674
        return to == InferiorStopRequested
            || to == InferiorStopOk // A spontaneous stop.
            || to == InferiorExitOk;
hjk's avatar
hjk committed
675 676 677 678 679

    case InferiorStopRequested:
        return to == InferiorStopOk || to == InferiorStopFailed;
    case InferiorStopOk:
        return to == InferiorRunRequested || to == InferiorShutdownRequested
Orgad Shaneh's avatar
Orgad Shaneh committed
680
            || to == InferiorStopOk || to == InferiorExitOk;
681
    case InferiorStopFailed:
hjk's avatar
hjk committed
682
        return to == EngineShutdownRequested;
683

684 685 686
    case InferiorExitOk:
        return to == InferiorShutdownOk;

687
    case InferiorUnrunnable:
hjk's avatar
hjk committed
688 689 690 691 692
        return to == InferiorShutdownRequested;
    case InferiorShutdownRequested:
        return to == InferiorShutdownOk || to == InferiorShutdownFailed;
    case InferiorShutdownOk:
        return to == EngineShutdownRequested;
693
    case InferiorShutdownFailed:
hjk's avatar
hjk committed
694
        return to == EngineShutdownRequested;
695

hjk's avatar
hjk committed
696
    case EngineShutdownRequested:
697
        return to == EngineShutdownOk || to == EngineShutdownFailed;
hjk's avatar
hjk committed
698 699 700 701 702 703
    case EngineShutdownOk:
        return to == DebuggerFinished;
    case EngineShutdownFailed:
        return to == DebuggerFinished;

    case DebuggerFinished:
704
        return to == EngineSetupRequested; // Happens on restart.
705 706
    }

707
    qDebug() << "UNKNOWN DEBUGGER STATE:" << from;
708 709 710
    return false;
}

711 712
void DebuggerEngine::setupSlaveEngine()
{
713
    QTC_CHECK(state() == DebuggerNotReady);
714 715 716 717 718 719 720
    d->queueSetupEngine();
}

void DebuggerEnginePrivate::doSetupEngine()
{
    m_engine->showMessage(_("CALL: SETUP ENGINE"));
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << m_engine << state());
721
    m_engine->validateExecutable(&m_startParameters);
722 723 724
    m_engine->setupEngine();
}

725
void DebuggerEngine::notifyEngineSetupFailed()
hjk's avatar
hjk committed
726
{
hjk's avatar
hjk committed
727
    showMessage(_("NOTE: ENGINE SETUP FAILED"));
728 729 730 731 732 733 734
    QTC_ASSERT(d->remoteSetupState() == RemoteSetupNone
               || d->remoteSetupState() == RemoteSetupRequested
               || d->remoteSetupState() == RemoteSetupSucceeded,
               qDebug() << this << "remoteSetupState" << d->remoteSetupState());
    if (d->remoteSetupState() == RemoteSetupRequested)
        d->setRemoteSetupState(RemoteSetupCancelled);

735
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << this << state());
736
    setState(EngineSetupFailed);
hjk's avatar
hjk committed
737
    if (isMasterEngine() && runControl())
738
        runControl()->startFailed();
hjk's avatar
hjk committed
739
    setState(DebuggerFinished);
hjk's avatar
hjk committed
740 741
}

742
void DebuggerEngine::notifyEngineSetupOk()
743
{
hjk's avatar
hjk committed
744
    showMessage(_("NOTE: ENGINE SETUP OK"));
745 746 747 748
    QTC_ASSERT(d->remoteSetupState() == RemoteSetupNone
               || d->remoteSetupState() == RemoteSetupSucceeded,
               qDebug() << this << "remoteSetupState" << d->remoteSetupState());

749
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << this << state());
750
    setState(EngineSetupOk);
hjk's avatar
hjk committed
751
    showMessage(_("QUEUE: SETUP INFERIOR"));
752
    if (isMasterEngine())
753 754 755 756 757
        d->queueSetupInferior();
}

void DebuggerEngine::setupSlaveInferior()
{
758
    QTC_CHECK(state() == EngineSetupOk);
759
    d->queueSetupInferior();
760 761
}

hjk's avatar
hjk committed
762
void DebuggerEnginePrivate::doSetupInferior()
763
{
764
    m_engine->showMessage(_("CALL: SETUP INFERIOR"));
765
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << m_engine << state());
766
    m_progress.setProgressValue(250);
hjk's avatar
hjk committed
767 768 769 770 771
    m_engine->setupInferior();
}

void DebuggerEngine::notifyInferiorSetupFailed()
{
hjk's avatar
hjk committed
772
    showMessage(_("NOTE: INFERIOR SETUP FAILED"));
773
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << this << state());
774
    showStatusMessage(tr("Setup failed."));
hjk's avatar
hjk committed
775
    setState(InferiorSetupFailed);
776 777
    if (isMasterEngine())
        d->queueShutdownEngine();
hjk's avatar
hjk committed
778 779 780 781
}

void DebuggerEngine::notifyInferiorSetupOk()
{
782 783 784
#ifdef WITH_BENCHMARK
    CALLGRIND_START_INSTRUMENTATION;
#endif
hjk's avatar
hjk committed
785
    showMessage(_("NOTE: INFERIOR SETUP OK"));
786 787 788 789
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << this << state());
    setState(InferiorSetupOk);
    if (isMasterEngine())
        d->queueRunEngine();
hjk's avatar
hjk committed
790 791
}

792 793 794
void DebuggerEngine::runSlaveEngine()
{
    QTC_ASSERT(isSlaveEngine(), return);
795
    QTC_CHECK(state() == InferiorSetupOk);
796 797 798
    d->queueRunEngine();
}

hjk's avatar
hjk committed
799 800
void DebuggerEnginePrivate::doRunEngine()
{
hjk's avatar
hjk committed
801
    m_engine->showMessage(_("CALL: RUN ENGINE"));
802
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << m_engine << state());
803
    m_progress.setProgressValue(300);
hjk's avatar
hjk committed
804 805 806
    m_engine->runEngine();
}

hjk's avatar
hjk committed
807 808
void DebuggerEngine::notifyInferiorUnrunnable()
{
hjk's avatar
hjk committed
809
    showMessage(_("NOTE: INFERIOR UNRUNNABLE"));
810 811
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
812
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << this << state());
813
    showStatusMessage(tr("Loading finished."));
hjk's avatar
hjk committed
814 815 816 817 818
    setState(InferiorUnrunnable);
}

void DebuggerEngine::notifyEngineRunFailed()
{
hjk's avatar
hjk committed
819
    showMessage(_("NOTE: ENGINE RUN FAILED"));
820
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << this << state());
821 822 823
    d->m_progress.setProgressValue(900);
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
824
    showStatusMessage(tr("Run failed."));
hjk's avatar
hjk committed
825
    setState(EngineRunFailed);
826 827
    if (isMasterEngine())
        d->queueShutdownEngine();
hjk's avatar
hjk committed
828 829
}

830 831 832 833 834 835 836 837 838 839 840
void DebuggerEngine::notifyEngineRequestRemoteSetup()
{
    showMessage(_("NOTE: REQUEST REMOTE SETUP"));
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << this << state());
    QTC_ASSERT(d->remoteSetupState() == RemoteSetupNone, qDebug() << this
               << "remoteSetupState" << d->remoteSetupState());

    d->setRemoteSetupState(RemoteSetupRequested);
    emit requestRemoteSetup();
}

hjk's avatar
hjk committed
841 842 843 844 845
void DebuggerEngine::notifyEngineRemoteServerRunning(const QByteArray &, int /*pid*/)
{
    showMessage(_("NOTE: REMOTE SERVER RUNNING IN MULTIMODE"));
}

846
void DebuggerEngine::notifyEngineRemoteSetupFinished(const RemoteSetupResult &result)
847 848 849 850 851 852 853 854 855
{
    QTC_ASSERT(state() == EngineSetupRequested
               || state() == EngineSetupFailed
               || state() == DebuggerFinished, qDebug() << this << state());

    QTC_ASSERT(d->remoteSetupState() == RemoteSetupRequested