debuggerengine.cpp 55.8 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 36
#include "debuggercore.h"
#include "debuggerrunner.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 64
#include <utils/savedaction.h>
#include <utils/qtcassert.h>
65
#include <utils/fileinprojectfinder.h>
66

67
#include <qmljs/consolemanagerinterface.h>
68

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

74
#include <QMessageBox>
75

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

81 82 83 84
enum { debug = 0 };

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

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

91 92 93 94 95 96
///////////////////////////////////////////////////////////////////////
//
// DebuggerStartParameters
//
///////////////////////////////////////////////////////////////////////

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

100 101
namespace Debugger {

Friedemann Kleint's avatar
Friedemann Kleint committed
102 103 104 105 106 107 108 109 110
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;
111
    m_from = frame.from;
Friedemann Kleint's avatar
Friedemann Kleint committed
112 113
}

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

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

136

137 138 139 140 141 142
//////////////////////////////////////////////////////////////////////
//
// DebuggerEnginePrivate
//
//////////////////////////////////////////////////////////////////////

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

152
class DebuggerEnginePrivate : public QObject
153
{
154 155
    Q_OBJECT

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

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

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

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

200 201 202 203 204 205 206 207 208 209 210 211 212 213
    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()));
    }

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

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

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

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

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

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

263
    void resetLocation()
264 265 266
    {
        m_locationTimer.stop();
        m_locationMark.reset();
267
        m_stackHandler.resetLocation();
268
        m_watchHandler.resetLocation();
269
        m_threadsHandler.resetLocation();
270
        m_disassemblerAgent.resetLocation();
271 272
    }

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

281
    DebuggerEngine *m_engine; // Not owned.
282
    DebuggerEngine *m_masterEngine; // Not owned
283 284 285
    DebuggerRunControl *m_runControl;  // Not owned.

    DebuggerStartParameters m_startParameters;
hjk's avatar
hjk committed
286 287

    // The current state.
288 289
    DebuggerState m_state;

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

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

296 297 298
    // State of RemoteSetup signal/slots.
    RemoteSetupState m_remoteSetupState;

299 300 301 302 303 304 305 306
    qint64 m_inferiorPid;

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

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

    bool m_isStateDebugging;
315

316
    Utils::FileInProjectFinder m_fileFinder;
317

318 319 320 321 322 323 324 325 326
};


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

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

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

337 338 339 340 341 342 343 344 345 346 347
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)
348
        SN(InferiorSetupOk)
349 350 351 352 353 354 355 356
        SN(EngineRunRequested)
        SN(InferiorRunRequested)
        SN(InferiorRunOk)
        SN(InferiorRunFailed)
        SN(InferiorUnrunnable)
        SN(InferiorStopRequested)
        SN(InferiorStopOk)
        SN(InferiorStopFailed)
357
        SN(InferiorExitOk)
358 359 360 361 362 363 364 365 366 367 368 369
        SN(InferiorShutdownRequested)
        SN(InferiorShutdownOk)
        SN(InferiorShutdownFailed)
        SN(EngineShutdownRequested)
        SN(EngineShutdownOk)
        SN(EngineShutdownFailed)
        SN(DebuggerFinished)
    }
    return "<unknown>";
#    undef SN
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

496
    debuggerCore()->showMessage(msg, channel, timeout);
497
    if (d->m_runControl)
498
        d->m_runControl->showMessage(msg, channel);
499
    else
500
        qWarning("Warning: %s (no active run control)", qPrintable(msg));
501 502 503 504
}

void DebuggerEngine::startDebugger(DebuggerRunControl *runControl)
{
505 506
    QTC_ASSERT(runControl, notifyEngineSetupFailed(); return);
    QTC_ASSERT(!d->m_runControl, notifyEngineSetupFailed(); return);
507

508
    d->m_progress.setProgressRange(0, 1000);
509
    FutureProgress *fp = ProgressManager::addTask(d->m_progress.future(),
510
        tr("Launching Debugger"), "Debugger.Launcher");
511
    connect(fp, SIGNAL(canceled()), this, SLOT(quitDebugger()));
512
    fp->setKeepOnFinish(FutureProgress::HideOnFinish);
513 514
    d->m_progress.reportStarted();

515 516 517 518
    d->m_runControl = runControl;

    d->m_inferiorPid = d->m_startParameters.attachPID > 0
        ? d->m_startParameters.attachPID : 0;
519 520
    if (d->m_inferiorPid)
        d->m_runControl->setApplicationProcessHandle(ProcessHandle(d->m_inferiorPid));
521

522 523
    if (!d->m_startParameters.environment.size())
        d->m_startParameters.environment = Utils::Environment();
524

hjk's avatar
hjk committed
525
    action(OperateByInstruction)->setEnabled(hasCapability(DisassemblerCapability));
526

527 528
    QTC_ASSERT(state() == DebuggerNotReady || state() == DebuggerFinished,
         qDebug() << state());
529 530
    d->m_lastGoodState = DebuggerNotReady;
    d->m_targetState = DebuggerNotReady;
531
    d->m_progress.setProgressValue(200);
532
    d->queueSetupEngine();
533 534 535 536
}

void DebuggerEngine::resetLocation()
{
537 538
    // Do it after some delay to avoid flicker.
    d->scheduleResetLocation();
539 540
}

541
void DebuggerEngine::gotoLocation(const Location &loc)
542
{
Aurindam Jana's avatar
Aurindam Jana committed
543 544
     d->resetLocation();

Aurindam Jana's avatar
Aurindam Jana committed
545
    if ((hasCapability(OperateByInstructionCapability) &&
hjk's avatar
hjk committed
546
            boolSetting(OperateByInstruction)) || !loc.hasDebugInfo()) {
547 548 549
        d->m_disassemblerAgent.setLocation(loc);
        return;
    }
550 551 552 553 554
    // CDB might hit on breakpoints while shutting down.
    //if (m_shuttingDown)
    //    return;


555
    const QString file = QDir::cleanPath(loc.fileName());
556
    const int line = loc.lineNumber();
557
    bool newEditor = false;
558
    IEditor *editor = EditorManager::openEditor(file, Id(),
559 560
                                                EditorManager::IgnoreNavigationHistory, &newEditor);
    QTC_ASSERT(editor, return); // Unreadable file?
561

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

564 565
    if (newEditor)
        editor->document()->setProperty(Constants::OPENED_BY_DEBUGGER, true);
hjk's avatar
hjk committed
566

567
    if (loc.needsMarker()) {
hjk's avatar
hjk committed
568
        d->m_locationMark.reset(new TextEditor::TextMark(file, line));
569
        d->m_locationMark->setIcon(debuggerCore()->locationMarkIcon());
hjk's avatar
hjk committed
570
        d->m_locationMark->setPriority(TextEditor::TextMark::HighPriority);
571
    }
572 573

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

576 577 578
// Called from RunControl.
void DebuggerEngine::handleStartFailed()
{
579
    showMessage(QLatin1String("HANDLE RUNCONTROL START FAILED"));
580
    d->m_runControl = 0;
581
    d->m_progress.setProgressValue(900);
582 583
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
584 585
}

586 587
// Called from RunControl.
void DebuggerEngine::handleFinished()
588
{
589
    showMessage(QLatin1String("HANDLE RUNCONTROL FINISHED"));
590
    d->m_runControl = 0;
591 592
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
    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
614
DebuggerState DebuggerEngine::lastGoodState() const
615
{
hjk's avatar
hjk committed
616 617 618 619 620 621 622
    return d->m_lastGoodState;
}

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

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

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

hjk's avatar
hjk committed
639
    case InferiorSetupRequested:
640
        return to == InferiorSetupOk || to == InferiorSetupFailed;
hjk's avatar
hjk committed
641
    case InferiorSetupFailed:
hjk's avatar
hjk committed
642
        return to == EngineShutdownRequested;
643 644
    case InferiorSetupOk:
        return to == EngineRunRequested;
hjk's avatar
hjk committed
645 646

    case EngineRunRequested:
hjk's avatar
hjk committed
647
        return to == EngineRunFailed
648
            || to == InferiorRunRequested
hjk's avatar
hjk committed
649 650 651
            || to == InferiorRunOk
            || to == InferiorStopOk
            || to == InferiorUnrunnable;
hjk's avatar
hjk committed
652
    case EngineRunFailed:
653
        return to == EngineShutdownRequested;
hjk's avatar
hjk committed
654 655 656 657 658 659

    case InferiorRunRequested:
        return to == InferiorRunOk || to == InferiorRunFailed;
    case InferiorRunFailed:
        return to == InferiorStopOk;
    case InferiorRunOk:
660 661 662
        return to == InferiorStopRequested
            || to == InferiorStopOk // A spontaneous stop.
            || to == InferiorExitOk;
hjk's avatar
hjk committed
663 664 665 666 667

    case InferiorStopRequested:
        return to == InferiorStopOk || to == InferiorStopFailed;
    case InferiorStopOk:
        return to == InferiorRunRequested || to == InferiorShutdownRequested
Orgad Shaneh's avatar
Orgad Shaneh committed
668
            || to == InferiorStopOk || to == InferiorExitOk;
669
    case InferiorStopFailed:
hjk's avatar
hjk committed
670
        return to == EngineShutdownRequested;
671

672 673 674
    case InferiorExitOk:
        return to == InferiorShutdownOk;

675
    case InferiorUnrunnable:
hjk's avatar
hjk committed
676 677 678 679 680
        return to == InferiorShutdownRequested;
    case InferiorShutdownRequested:
        return to == InferiorShutdownOk || to == InferiorShutdownFailed;
    case InferiorShutdownOk:
        return to == EngineShutdownRequested;
681
    case InferiorShutdownFailed:
hjk's avatar
hjk committed
682
        return to == EngineShutdownRequested;
683

hjk's avatar
hjk committed
684
    case EngineShutdownRequested:
685
        return to == EngineShutdownOk || to == EngineShutdownFailed;
hjk's avatar
hjk committed
686 687 688 689 690 691
    case EngineShutdownOk:
        return to == DebuggerFinished;
    case EngineShutdownFailed:
        return to == DebuggerFinished;

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

695
    qDebug() << "UNKNOWN DEBUGGER STATE:" << from;
696 697 698
    return false;
}

699 700
void DebuggerEngine::setupSlaveEngine()
{
701
    QTC_CHECK(state() == DebuggerNotReady);
702 703 704 705 706 707 708
    d->queueSetupEngine();
}

void DebuggerEnginePrivate::doSetupEngine()
{
    m_engine->showMessage(_("CALL: SETUP ENGINE"));
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << m_engine << state());
709
    m_engine->validateExecutable(&m_startParameters);
710 711 712
    m_engine->setupEngine();
}

713
void DebuggerEngine::notifyEngineSetupFailed()
hjk's avatar
hjk committed
714
{
hjk's avatar
hjk committed
715
    showMessage(_("NOTE: ENGINE SETUP FAILED"));
716 717 718 719 720 721 722
    QTC_ASSERT(d->remoteSetupState() == RemoteSetupNone
               || d->remoteSetupState() == RemoteSetupRequested
               || d->remoteSetupState() == RemoteSetupSucceeded,
               qDebug() << this << "remoteSetupState" << d->remoteSetupState());
    if (d->remoteSetupState() == RemoteSetupRequested)
        d->setRemoteSetupState(RemoteSetupCancelled);

723
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << this << state());
724
    setState(EngineSetupFailed);
hjk's avatar
hjk committed
725
    if (isMasterEngine() && runControl())
726
        runControl()->startFailed();
hjk's avatar
hjk committed
727
    setState(DebuggerFinished);
hjk's avatar
hjk committed
728 729
}

730
void DebuggerEngine::notifyEngineSetupOk()
731
{
hjk's avatar
hjk committed
732
    showMessage(_("NOTE: ENGINE SETUP OK"));
733 734 735 736
    QTC_ASSERT(d->remoteSetupState() == RemoteSetupNone
               || d->remoteSetupState() == RemoteSetupSucceeded,
               qDebug() << this << "remoteSetupState" << d->remoteSetupState());

737
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << this << state());
738
    setState(EngineSetupOk);
hjk's avatar
hjk committed
739
    showMessage(_("QUEUE: SETUP INFERIOR"));
740
    if (isMasterEngine())
741 742 743 744 745
        d->queueSetupInferior();
}

void DebuggerEngine::setupSlaveInferior()
{
746
    QTC_CHECK(state() == EngineSetupOk);
747
    d->queueSetupInferior();
748 749
}

hjk's avatar
hjk committed
750
void DebuggerEnginePrivate::doSetupInferior()
751
{
752
    m_engine->showMessage(_("CALL: SETUP INFERIOR"));
753
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << m_engine << state());
754
    m_progress.setProgressValue(250);
hjk's avatar
hjk committed
755 756 757 758 759
    m_engine->setupInferior();
}

void DebuggerEngine::notifyInferiorSetupFailed()
{
hjk's avatar
hjk committed
760
    showMessage(_("NOTE: INFERIOR SETUP FAILED"));
761
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << this << state());
762
    showStatusMessage(tr("Setup failed."));
hjk's avatar
hjk committed
763
    setState(InferiorSetupFailed);
764 765
    if (isMasterEngine())
        d->queueShutdownEngine();
hjk's avatar
hjk committed
766 767 768 769
}

void DebuggerEngine::notifyInferiorSetupOk()
{
770 771 772
#ifdef WITH_BENCHMARK
    CALLGRIND_START_INSTRUMENTATION;
#endif
hjk's avatar
hjk committed
773
    showMessage(_("NOTE: INFERIOR SETUP OK"));
774 775 776 777
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << this << state());
    setState(InferiorSetupOk);
    if (isMasterEngine())
        d->queueRunEngine();
hjk's avatar
hjk committed
778 779
}

780 781 782
void DebuggerEngine::runSlaveEngine()
{
    QTC_ASSERT(isSlaveEngine(), return);
783
    QTC_CHECK(state() == InferiorSetupOk);
784 785 786
    d->queueRunEngine();
}

hjk's avatar
hjk committed
787 788
void DebuggerEnginePrivate::doRunEngine()
{
hjk's avatar
hjk committed
789
    m_engine->showMessage(_("CALL: RUN ENGINE"));
790
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << m_engine << state());
791
    m_progress.setProgressValue(300);
hjk's avatar
hjk committed
792 793 794
    m_engine->runEngine();
}

hjk's avatar
hjk committed
795 796
void DebuggerEngine::notifyInferiorUnrunnable()
{
hjk's avatar
hjk committed
797
    showMessage(_("NOTE: INFERIOR UNRUNNABLE"));
798 799
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
800
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << this << state());
801
    showStatusMessage(tr("Loading finished."));
hjk's avatar
hjk committed
802 803 804 805 806
    setState(InferiorUnrunnable);
}

void DebuggerEngine::notifyEngineRunFailed()
{
hjk's avatar
hjk committed
807
    showMessage(_("NOTE: ENGINE RUN FAILED"));
808
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << this << state());
809 810 811
    d->m_progress.setProgressValue(900);
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
812
    showStatusMessage(tr("Run failed."));
hjk's avatar
hjk committed
813
    setState(EngineRunFailed);
814 815
    if (isMasterEngine())
        d->queueShutdownEngine();
hjk's avatar
hjk committed
816 817
}

818 819 820 821 822 823 824 825 826 827 828
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
829 830 831 832 833
void DebuggerEngine::notifyEngineRemoteServerRunning(const QByteArray &, int /*pid*/)
{
    showMessage(_("NOTE: REMOTE SERVER RUNNING IN MULTIMODE"));
}

834
void DebuggerEngine::notifyEngineRemoteSetupFinished(const RemoteSetupResult &result)
835 836 837 838 839 840 841 842 843
{
    QTC_ASSERT(state() == EngineSetupRequested
               || state() == EngineSetupFailed
               || state() == DebuggerFinished, qDebug() << this << state());

    QTC_ASSERT(d->remoteSetupState() == RemoteSetupRequested
               || d->remoteSetupState() == RemoteSetupCancelled,
               qDebug() << this << "remoteSetupState" << d->remoteSetupState());

844 845 846
    if (result.success) {
        showMessage(_("NOTE: REMOTE SETUP DONE: GDB SERVER PORT: %1  QML PORT %2")
                    .arg(result.gdbServerPort).arg(result.qmlServerPort));