debuggerplugin.cpp 132 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
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
con's avatar
con committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
con's avatar
con committed
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** 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
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
15
**
16
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** 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.
**
** 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
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
hjk's avatar
hjk committed
29

con's avatar
con committed
30 31
#include "debuggerplugin.h"

Friedemann Kleint's avatar
Friedemann Kleint committed
32
#include "debuggerstartparameters.h"
33
#include "debuggeractions.h"
34
#include "debuggerinternalconstants.h"
35
#include "debuggercore.h"
36
#include "debuggerkitconfigwidget.h"
37 38
#include "debuggerdialogs.h"
#include "debuggerengine.h"
39
#include "debuggeritemmanager.h"
40
#include "debuggermainwindow.h"
con's avatar
con committed
41
#include "debuggerrunner.h"
42
#include "debuggerrunconfigurationaspect.h"
43
#include "debuggerruncontrolfactory.h"
44
#include "debuggerstringutils.h"
45
#include "debuggeroptionspage.h"
Tobias Hunger's avatar
Tobias Hunger committed
46
#include "debuggerkitinformation.h"
47
#include "memoryagent.h"
48
#include "breakhandler.h"
49
#include "breakwindow.h"
50
#include "disassemblerlines.h"
51
#include "logwindow.h"
52
#include "moduleswindow.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
53
#include "moduleshandler.h"
54 55
#include "registerwindow.h"
#include "snapshotwindow.h"
hjk's avatar
hjk committed
56
#include "stackhandler.h"
57 58 59
#include "stackwindow.h"
#include "sourcefileswindow.h"
#include "threadswindow.h"
hjk's avatar
hjk committed
60
#include "watchhandler.h"
61
#include "watchwindow.h"
hjk's avatar
hjk committed
62
#include "watchutils.h"
63
#include "unstartedappwatcherdialog.h"
64
#include "debuggertooltipmanager.h"
65
#include "localsandexpressionswindow.h"
66
#include "loadcoredialog.h"
67
#include "sourceutils.h"
68
#include <debugger/shared/hostutils.h>
69

70 71
#include "snapshothandler.h"
#include "threadshandler.h"
72
#include "commonoptionspage.h"
73
#include "gdb/startgdbserverdialog.h"
con's avatar
con committed
74

75
#include <coreplugin/actionmanager/actionmanager.h>
76
#include <coreplugin/actionmanager/actioncontainer.h>
77
#include <coreplugin/imode.h>
con's avatar
con committed
78 79
#include <coreplugin/coreconstants.h>
#include <coreplugin/icore.h>
80
#include <coreplugin/messagemanager.h>
con's avatar
con committed
81
#include <coreplugin/modemanager.h>
hjk's avatar
hjk committed
82

con's avatar
con committed
83
#include <cppeditor/cppeditorconstants.h>
84
#include <cpptools/cppmodelmanagerinterface.h>
hjk's avatar
hjk committed
85

86
#include <extensionsystem/invoker.h>
87

88
#include <projectexplorer/localapplicationrunconfiguration.h>
89
#include <projectexplorer/buildmanager.h>
90
#include <projectexplorer/taskhub.h>
91
#include <projectexplorer/toolchain.h>
92
#include <projectexplorer/devicesupport/deviceprocesslist.h>
93
#include <projectexplorer/devicesupport/deviceprocessesdialog.h>
94 95 96
#include <projectexplorer/projectexplorer.h>
#include <projectexplorer/projectexplorersettings.h>
#include <projectexplorer/project.h>
con's avatar
con committed
97
#include <projectexplorer/session.h>
98
#include <projectexplorer/target.h>
99

hjk's avatar
hjk committed
100
#include <texteditor/basetexteditor.h>
101
#include <texteditor/fontsettings.h>
102
#include <texteditor/texteditorsettings.h>
hjk's avatar
hjk committed
103

104
#include <utils/hostosinfo.h>
hjk's avatar
hjk committed
105
#include <utils/qtcassert.h>
106
#include <utils/styledbar.h>
107
#include <utils/proxyaction.h>
108
#include <utils/statuslabel.h>
109 110 111
#ifdef Q_OS_WIN
#  include <utils/winutils.h>
#endif
con's avatar
con committed
112

113
#include <QComboBox>
114 115
#include <QDockWidget>
#include <QFileDialog>
hjk's avatar
hjk committed
116
#include <QInputDialog>
117 118 119
#include <QMessageBox>
#include <QTextBlock>
#include <QToolButton>
hjk's avatar
hjk committed
120
#include <QtPlugin>
121
#include <QTreeWidget>
con's avatar
con committed
122

hjk's avatar
hjk committed
123
#ifdef WITH_TESTS
124 125 126
#include <QTest>
#include <QSignalSpy>
#include <QTestEventLoop>
127 128 129 130

//#define WITH_BENCHMARK
#ifdef WITH_BENCHMARK
#include <valgrind/callgrind.h>
hjk's avatar
hjk committed
131 132
#endif

133 134
#endif // WITH_TESTS

135 136
#include <climits>

137 138 139 140 141
#define DEBUG_STATE 1
#ifdef DEBUG_STATE
//#   define STATE_DEBUG(s)
//    do { QString msg; QTextStream ts(&msg); ts << s;
//      showMessage(msg, LogDebug); } while (0)
142
#   define STATE_DEBUG(s) do { qDebug() << s; } while (0)
143 144 145 146
#else
#   define STATE_DEBUG(s)
#endif

147 148 149 150 151 152 153 154
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
155
    \internal
156 157 158 159 160
*/

/*!
    \class Debugger::DebuggerEngine

161
    \brief The DebuggerEngine class is the base class of a debugger engine.
162

Leena Miettinen's avatar
Leena Miettinen committed
163
    \note The Debugger process itself and any helper processes like
164 165
    gdbserver are referred to as 'Engine', whereas the debugged process
    is referred to as 'Inferior'.
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281

    Transitions marked by '---' are done in the individual engines.
    Transitions marked by '+-+' are done in the base DebuggerEngine.
    Transitions marked by '*' are done asynchronously.

    The GdbEngine->setupEngine() function is described in more detail below.

    The engines are responsible for local roll-back to the last
    acknowledged state before calling notify*Failed. I.e. before calling
    notifyEngineSetupFailed() any process started during setupEngine()
    so far must be terminated.
    \code

                        DebuggerNotReady
                         progressmanager/progressmanager.cpp      +
                      EngineSetupRequested
                               +
                  (calls *Engine->setupEngine())
                            |      |
                            |      |
                       {notify-  {notify-
                        Engine-   Engine-
                        SetupOk}  SetupFailed}
                            +      +
                            +      `+-+-+> EngineSetupFailed
                            +                   +
                            +    [calls RunControl->startFailed]
                            +                   +
                            +             DebuggerFinished
                            v
                      EngineSetupOk
                            +
             [calls RunControl->StartSuccessful]
                            +
                  InferiorSetupRequested
                            +
             (calls *Engine->setupInferior())
                         |       |
                         |       |
                    {notify-   {notify-
                     Inferior- Inferior-
                     SetupOk}  SetupFailed}
                         +       +
                         +       ` +-+-> InferiorSetupFailed +-+-+-+-+-+->.
                         +                                                +
                  InferiorSetupOk                                         +
                         +                                                +
                  EngineRunRequested                                      +
                         +                                                +
                 (calls *Engine->runEngine())                             +
               /       |            |        \                            +
             /         |            |          \                          +
            | (core)   | (attach)   |           |                         +
            |          |            |           |                         +
      {notify-    {notifyER&- {notifyER&-  {notify-                       +
      Inferior-     Inferior-   Inferior-  EngineRun-                     +
     Unrunnable}     StopOk}     RunOk}     Failed}                       +
           +           +            +           +                         +
   InferiorUnrunnable  +     InferiorRunOk      +                         +
                       +                        +                         +
                InferiorStopOk            EngineRunFailed                 +
                                                +                         v
                                                 `-+-+-+-+-+-+-+-+-+-+-+>-+
                                                                          +
                                                                          +
                       #Interrupt@InferiorRunOk#                          +
                                  +                                       +
                          InferiorStopRequested                           +
  #SpontaneousStop                +                                       +
   @InferiorRunOk#         (calls *Engine->                               +
          +               interruptInferior())                            +
      {notify-               |          |                                 +
     Spontaneous-       {notify-    {notify-                              +
      Inferior-          Inferior-   Inferior-                            +
       StopOk}           StopOk}    StopFailed}                           +
           +              +             +                                 +
            +            +              +                                 +
            InferiorStopOk              +                                 +
                  +                     +                                 +
                  +                    +                                  +
                  +                   +                                   +
        #Stop@InferiorUnrunnable#    +                                    +
          #Creator Close Event#     +                                     +
                       +           +                                      +
                InferiorShutdownRequested                                 +
                            +                                             +
           (calls *Engine->shutdownInferior())                            +
                         |        |                                       +
                    {notify-   {notify-                                   +
                     Inferior- Inferior-                                  +
                  ShutdownOk}  ShutdownFailed}                            +
                         +        +                                       +
                         +        +                                       +
  #Inferior exited#      +        +                                       +
         |               +        +                                       +
   {notifyInferior-      +        +                                       +
      Exited}            +        +                                       +
           +             +        +                                       +
     InferiorExitOk      +        +                                       +
             +           +        +                                       +
            InferiorShutdownOk InferiorShutdownFailed                     +
                      *          *                                        +
                  EngineShutdownRequested                                 +
                            +                                             +
           (calls *Engine->shutdownEngine())  <+-+-+-+-+-+-+-+-+-+-+-+-+-+'
                         |        |
                         |        |
                    {notify-   {notify-
                     Engine-    Engine-
                  ShutdownOk}  ShutdownFailed}
                         +       +
            EngineShutdownOk  EngineShutdownFailed
                         *       *
                     DebuggerFinished

\endcode */
hjk's avatar
hjk committed
282

283 284 285
/* Here is a matching graph as a GraphViz graph. View it using
 * \code
grep "^sg1:" debuggerplugin.cpp | cut -c5- | dot -osg1.ps -Tps && gv sg1.ps
286

287 288 289 290 291 292
sg1: digraph DebuggerStates {
sg1:   DebuggerNotReady -> EngineSetupRequested
sg1:   EngineSetupRequested -> EngineSetupOk [ label="notifyEngineSetupOk", style="dashed" ];
sg1:   EngineSetupRequested -> EngineSetupFailed [ label= "notifyEngineSetupFailed", style="dashed"];
sg1:   EngineSetupFailed -> DebuggerFinished [ label= "RunControl::StartFailed" ];
sg1:   EngineSetupOk -> InferiorSetupRequested [ label= "RunControl::StartSuccessful" ];
293
sg1:   InferiorSetupRequested -> InferiorSetupOk [ label="notifyInferiorSetupOk", style="dashed" ];
294
sg1:   InferiorSetupRequested -> InferiorSetupFailed [ label="notifyInferiorFailed", style="dashed" ];
295
sg1:   InferiorSetupOk -> EngineRunRequested
296 297 298 299 300 301 302 303 304 305 306 307 308 309
sg1:   InferiorSetupFailed -> EngineShutdownRequested
sg1:   EngineRunRequested -> InferiorUnrunnable [ label="notifyInferiorUnrunnable", style="dashed" ];
sg1:   EngineRunRequested -> InferiorStopOk [ label="notifyEngineRunAndInferiorStopOk", style="dashed" ];
sg1:   EngineRunRequested -> InferiorRunOk [ label="notifyEngineRunAndInferiorRunOk", style="dashed" ];
sg1:   EngineRunRequested -> EngineRunFailed [ label="notifyEngineRunFailed", style="dashed" ];
sg1:   EngineRunFailed -> EngineShutdownRequested
sg1:   InferiorRunOk -> InferiorStopOk [ label="SpontaneousStop\nnotifyInferiorSpontaneousStop", style="dashed" ];
sg1:   InferiorRunOk -> InferiorStopRequested [ label="User stop\nEngine::interruptInferior", style="dashed"];
sg1:   InferiorStopRequested -> InferiorStopOk [ label="notifyInferiorStopOk", style="dashed" ];
sg1:   InferiorStopRequested -> InferiorShutdownRequested  [ label="notifyInferiorStopFailed", style="dashed" ];
sg1:   InferiorStopOk -> InferiorRunRequested [ label="User\nEngine::continueInferior" ];
sg1:   InferiorRunRequested -> InferiorRunOk [ label="notifyInferiorRunOk", style="dashed"];
sg1:   InferiorRunRequested -> InferiorRunFailed [ label="notifyInferiorRunFailed", style="dashed"];
sg1:   InferiorRunFailed -> InferiorStopOk
310 311
sg1:   InferiorStopOk -> InferiorShutdownRequested [ label="Close event" ];
sg1:   InferiorUnrunnable -> InferiorShutdownRequested [ label="Close event" ];
312 313
sg1:   InferiorShutdownRequested -> InferiorShutdownOk [ label= "Engine::shutdownInferior\nnotifyInferiorShutdownOk", style="dashed" ];
sg1:   InferiorShutdownRequested -> InferiorShutdownFailed [ label="Engine::shutdownInferior\nnotifyInferiorShutdownFailed", style="dashed" ];
314 315
sg1:   InferiorExited -> InferiorExitOk [ label="notifyInferiorExited", style="dashed"];
sg1:   InferiorExitOk -> InferiorShutdownOk
316 317 318 319 320 321 322 323
sg1:   InferiorShutdownOk -> EngineShutdownRequested
sg1:   InferiorShutdownFailed -> EngineShutdownRequested
sg1:   EngineShutdownRequested -> EngineShutdownOk [ label="Engine::shutdownEngine\nnotifyEngineShutdownOk", style="dashed" ];
sg1:   EngineShutdownRequested -> EngineShutdownFailed  [ label="Engine::shutdownEngine\nnotifyEngineShutdownFailed", style="dashed" ];
sg1:   EngineShutdownOk -> DebuggerFinished  [ style = "dotted" ];
sg1:   EngineShutdownFailed  -> DebuggerFinished [ style = "dotted" ];
sg1: }
* \endcode */
hjk's avatar
hjk committed
324
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
325 326


327 328
/*!
    \class Debugger::Internal::GdbEngine
329 330
    \brief The GdbEngine class implements Debugger::Engine driving a GDB
    executable.
331 332 333

    GdbEngine specific startup. All happens in EngineSetupRequested state:

Leena Miettinen's avatar
Leena Miettinen committed
334 335
    \list
        \li Transitions marked by '---' are done in the individual adapters.
336

Leena Miettinen's avatar
Leena Miettinen committed
337 338
        \li Transitions marked by '+-+' are done in the GdbEngine.
    \endlist
339 340 341 342 343 344 345 346 347 348 349 350 351

    \code
                  GdbEngine::setupEngine()
                          +
            (calls *Adapter->startAdapter())
                          |      |
                          |      `---> handleAdapterStartFailed()
                          |                   +
                          |             {notifyEngineSetupFailed}
                          |
                 handleAdapterStarted()
                          +
                 {notifyEngineSetupOk}
352 353 354



355 356 357 358 359 360 361 362 363 364 365
                GdbEngine::setupInferior()
                          +
            (calls *Adapter->prepareInferior())
                          |      |
                          |      `---> handlePrepareInferiorFailed()
                          |                   +
                          |             {notifyInferiorSetupFailed}
                          |
                handleInferiorPrepared()
                          +
                {notifyInferiorSetupOk}
366

367
\endcode */
368

con's avatar
con committed
369
using namespace Core;
hjk's avatar
hjk committed
370
using namespace Debugger::Constants;
371
using namespace ExtensionSystem;
con's avatar
con committed
372
using namespace ProjectExplorer;
hjk's avatar
hjk committed
373
using namespace TextEditor;
374
using namespace Utils;
con's avatar
con committed
375

hjk's avatar
hjk committed
376 377 378
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
379 380

namespace Debugger {
381 382
namespace Internal {

383 384 385 386 387 388 389 390 391 392 393 394 395
// To be passed through margin menu action's data
struct BreakpointMenuContextData : public ContextData
{
    enum Mode
    {
        Breakpoint,
        MessageTracePoint
    };

    BreakpointMenuContextData() : mode(Breakpoint) {}
    Mode mode;
};

396 397 398 399 400 401 402 403 404 405 406
struct TestCallBack
{
    TestCallBack() : receiver(0), slot(0) {}
    TestCallBack(QObject *ob, const char *s) : receiver(ob), slot(s) {}

    QObject *receiver;
    const char *slot;
    QVariant cookie;
};


407 408 409 410
} // namespace Internal
} // namespace Debugger

Q_DECLARE_METATYPE(Debugger::Internal::BreakpointMenuContextData)
411 412
Q_DECLARE_METATYPE(Debugger::Internal::TestCallBack)

413 414 415 416

namespace Debugger {
namespace Internal {

417 418 419 420 421 422
// FIXME: Outdated?
// The createCdbEngine function takes a list of options pages it can add to.
// This allows for having a "enabled" toggle on the page independently
// of the engine. That's good for not enabling the related ActiveX control
// unnecessarily.

423
void addCdbOptionPages(QList<IOptionsPage*> *opts);
424 425 426
void addGdbOptionPages(QList<IOptionsPage*> *opts);
void addScriptOptionPages(QList<IOptionsPage*> *opts);
void addTcfOptionPages(QList<IOptionsPage*> *opts);
427

428 429 430 431
#ifdef WITH_LLDB
void addLldbOptionPages(QList<IOptionsPage*> *opts);
#endif

432 433 434 435 436 437 438
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

Orgad Shaneh's avatar
Orgad Shaneh committed
439
static void setProxyAction(ProxyAction *proxy, Core::Id id)
440
{
hjk's avatar
hjk committed
441
    proxy->setAction(ActionManager::command(id)->action());
442 443
}

Orgad Shaneh's avatar
Orgad Shaneh committed
444
static QToolButton *toolButton(Core::Id id)
445
{
hjk's avatar
hjk committed
446
    return toolButton(ActionManager::command(id)->action());
447 448
}

449 450 451 452 453 454 455 456 457 458 459
///////////////////////////////////////////////////////////////////////
//
// DummyEngine
//
///////////////////////////////////////////////////////////////////////

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
460
    DummyEngine() : DebuggerEngine(DebuggerStartParameters()) {}
461 462 463 464 465 466 467
    ~DummyEngine() {}

    void setupEngine() {}
    void setupInferior() {}
    void runEngine() {}
    void shutdownEngine() {}
    void shutdownInferior() {}
468
    bool hasCapability(unsigned cap) const;
469
    bool acceptsBreakpoint(BreakpointModelId) const { return false; }
470
    bool acceptsDebuggerCommands() const { return false; }
hjk's avatar
hjk committed
471
    void selectThread(ThreadId) {}
472 473
};

474
bool DummyEngine::hasCapability(unsigned cap) const
475 476
{
    // This can only be a first approximation of what to expect when running.
477
    Project *project = ProjectExplorerPlugin::currentProject();
478 479 480 481 482 483 484 485
    if (!project)
        return 0;
    Target *target = project->activeTarget();
    QTC_ASSERT(target, return 0);
    RunConfiguration *activeRc = target->activeRunConfiguration();
    QTC_ASSERT(activeRc, return 0);

    // This is a non-started Cdb or Gdb engine:
486
    if (activeRc->extraAspect<Debugger::DebuggerRunConfigurationAspect>()->useCppDebugger())
487
        return cap & (WatchpointByAddressCapability
488 489
               | BreakConditionCapability
               | TracePointCapability
490
               | OperateByInstructionCapability);
491 492

    // This is a Qml or unknown engine.
493
    return cap & AddWatcherCapability;
494 495
}

496 497 498 499 500 501
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

502
class DebugMode : public IMode
hjk's avatar
hjk committed
503 504
{
public:
505 506 507 508
    DebugMode()
    {
        setObjectName(QLatin1String("DebugMode"));
        setContext(Context(CC::C_EDITORMANAGER, C_DEBUGMODE, CC::C_NAVIGATION_PANE));
509 510
        setDisplayName(DebuggerPlugin::tr("Debug"));
        setIcon(QIcon(QLatin1String(":/fancyactionbar/images/mode_Debug.png")));
511
        setPriority(85);
512
        setId(MODE_DEBUG);
513
    }
hjk's avatar
hjk committed
514

hjk's avatar
hjk committed
515 516 517 518
    ~DebugMode()
    {
        delete m_widget;
    }
519
};
hjk's avatar
hjk committed
520

521 522 523 524 525 526
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
527
static QString executableForPid(qint64 pid)
528
{
529
    foreach (const DeviceProcessItem &p, DeviceProcessList::localProcesses())
530 531 532 533 534
        if (p.pid == pid)
            return p.exe;
    return QString();
}

Tobias Hunger's avatar
Tobias Hunger committed
535
class AbiKitMatcher : public KitMatcher
536 537
{
public:
Tobias Hunger's avatar
Tobias Hunger committed
538
    explicit AbiKitMatcher(const QList<Abi> &abis) : m_abis(abis) {}
539
    bool matches(const Kit *k) const
540
    {
541
        if (const ToolChain *tc = ToolChainKitInformation::toolChain(k)) {
542
            return m_abis.contains(tc->targetAbi())
543
                   && DebuggerKitInformation::isValidDebugger(k);
544
        }
545 546 547 548 549 550 551
        return false;
    }

private:
    const QList<Abi> m_abis;
};

Tobias Hunger's avatar
Tobias Hunger committed
552
class CompatibleAbiKitMatcher : public KitMatcher
553 554
{
public:
Tobias Hunger's avatar
Tobias Hunger committed
555
    explicit CompatibleAbiKitMatcher(const QList<Abi> &abis) : m_abis(abis) {}
556
    bool matches(const Kit *k) const
557
    {
558
        if (const ToolChain *tc = ToolChainKitInformation::toolChain(k))
559
            foreach (const Abi &a, m_abis)
560
                if (a.isCompatibleWith(tc->targetAbi()) && DebuggerKitInformation::isValidDebugger(k))
561 562 563 564 565 566 567 568
                    return true;
        return false;
    }

private:
    const QList<Abi> m_abis;
};

Tobias Hunger's avatar
Tobias Hunger committed
569
class CdbMatcher : KitMatcher
hjk's avatar
hjk committed
570
{
571 572 573
public:
    CdbMatcher(char wordWidth = 0) : m_wordWidth(wordWidth) {}

Tobias Hunger's avatar
Tobias Hunger committed
574
    bool matches(const Kit *k) const
575
    {
576 577
        if (DebuggerKitInformation::engineType(k) != CdbEngineType
            || !DebuggerKitInformation::isValidDebugger(k)) {
578
            return false;
579 580 581 582 583
        }
        if (m_wordWidth) {
            const ToolChain *tc = ToolChainKitInformation::toolChain(k);
            return tc && m_wordWidth == tc->targetAbi().wordWidth();
        }
584 585 586
        return true;
    }

Tobias Hunger's avatar
Tobias Hunger committed
587
    // Find a CDB kit for debugging unknown processes.
588
    // On a 64bit OS, prefer a 64bit debugger.
Tobias Hunger's avatar
Tobias Hunger committed
589
    static Kit *findUniversalCdbKit()
590 591 592 593
    {
#ifdef Q_OS_WIN
        if (Utils::winIs64BitSystem()) {
            CdbMatcher matcher64(64);
594
            if (Kit *cdb64Kit = KitManager::find(matcher64))
Tobias Hunger's avatar
Tobias Hunger committed
595
                return cdb64Kit;
596 597 598
        }
#endif
        CdbMatcher matcher;
599
        return KitManager::find(matcher);
600 601 602 603 604 605
    }

private:
    const char m_wordWidth;
};

606
bool fillParameters(DebuggerStartParameters *sp, const Kit *kit, QString *errorMessage /* = 0 */)
607
{
Tobias Hunger's avatar
Tobias Hunger committed
608
    if (!kit) {
609 610
        // This code can only be reached when starting via the command line
        // (-debug pid or executable) or attaching from runconfiguration
Tobias Hunger's avatar
Tobias Hunger committed
611
        // without specifying a kit. Try to find a kit via ABI.
612 613 614 615 616 617 618 619 620 621 622
        QList<Abi> abis;
        if (sp->toolChainAbi.isValid()) {
            abis.push_back(sp->toolChainAbi);
        } else {
            // Try via executable.
            if (sp->executable.isEmpty()
                && (sp->startMode == AttachExternal || sp->startMode == AttachCrashedExternal)) {
                sp->executable = executableForPid(sp->attachPID);
            }
            if (!sp->executable.isEmpty())
                abis = Abi::abisOfBinary(Utils::FileName::fromString(sp->executable));
623
        }
624
        if (!abis.isEmpty()) {
625 626 627
            kit = KitManager::find(AbiKitMatcher(abis));
            if (!kit)
                kit = KitManager::find(CompatibleAbiKitMatcher(abis));
628
        }
Tobias Hunger's avatar
Tobias Hunger committed
629
        if (!kit)
630
            kit = KitManager::defaultKit();
631 632
    }

633 634 635 636 637 638 639
    // Verify that debugger and profile are valid
    if (!kit) {
        sp->startMode = NoStartMode;
        if (errorMessage)
            *errorMessage = DebuggerKitInformation::tr("No kit found.");
        return false;
    }
640 641
    // validate debugger if C++ debugging is enabled
    if (sp->languages & CppLanguage) {
hjk's avatar
hjk committed
642
        const QList<Task> tasks = DebuggerKitInformation::validateDebugger(kit);
643 644 645
        if (!tasks.isEmpty()) {
            sp->startMode = NoStartMode;
            if (errorMessage) {
hjk's avatar
hjk committed
646
                foreach (const Task &t, tasks) {
647 648 649 650
                    if (errorMessage->isEmpty())
                        errorMessage->append(QLatin1Char('\n'));
                    errorMessage->append(t.description);
                }
651
            }
652
            return false;
653 654 655
        }
    }
    sp->cppEngineType = DebuggerKitInformation::engineType(kit);
Tobias Hunger's avatar
Tobias Hunger committed
656 657
    sp->sysRoot = SysRootKitInformation::sysRoot(kit).toString();
    sp->debuggerCommand = DebuggerKitInformation::debuggerCommand(kit).toString();
658

Tobias Hunger's avatar
Tobias Hunger committed
659
    ToolChain *tc = ToolChainKitInformation::toolChain(kit);
hjk's avatar
hjk committed
660 661
    if (tc)
        sp->toolChainAbi = tc->targetAbi();
662

663 664 665
    sp->device = DeviceKitInformation::device(kit);
    if (sp->device) {
        sp->connParams = sp->device->sshParameters();
666 667 668
        // Could have been set from command line.
        if (sp->remoteChannel.isEmpty())
            sp->remoteChannel = sp->connParams.host + QLatin1Char(':') + QString::number(sp->connParams.port);
669
    }
670
    return true;
hjk's avatar
hjk committed
671 672
}

673
static TextEditor::ITextEditor *currentTextEditor()
674
{
hjk's avatar
hjk committed
675
    return qobject_cast<TextEditor::ITextEditor *>(EditorManager::currentEditor());
676
}
con's avatar
con committed
677

678 679
static bool currentTextEditorPosition(ContextData *data)
{
680 681 682
    TextEditor::ITextEditor *textEditor = currentTextEditor();
    if (!textEditor)
        return false;
hjk's avatar
hjk committed
683
    const IDocument *document = textEditor->document();
684
    QTC_ASSERT(document, return false);
685
    data->fileName = document->filePath();
686
    if (document->property(Constants::OPENED_WITH_DISASSEMBLY).toBool()) {
687
        int lineNumber = textEditor->currentLine();
688
        QString line = textEditor->textDocument()->plainText()
689 690 691 692
            .section(QLatin1Char('\n'), lineNumber - 1, lineNumber - 1);
        data->address = DisassemblerLine::addressFromDisassemblyLine(line);
    } else {
        data->lineNumber = textEditor->currentLine();
693
    }
694
    return true;
695
}
696

697 698
///////////////////////////////////////////////////////////////////////
//
699
// DebuggerPluginPrivate
700 701
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
702

703
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
704

705 706 707 708 709 710 711 712 713 714 715 716 717 718
/*!
    \class Debugger::Internal::DebuggerCore

    This is the "internal" interface of the debugger plugin that's
    used by debugger views and debugger engines. The interface is
    implemented in DebuggerPluginPrivate.
*/

/*!
    \class Debugger::Internal::DebuggerPluginPrivate

    Implementation of DebuggerCore.
*/

719
class DebuggerPluginPrivate : public DebuggerCore
720 721
{
    Q_OBJECT
722

723 724
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
725
    ~DebuggerPluginPrivate();
726

727
    bool initialize(const QStringList &arguments, QString *errorMessage);
728 729 730
    void extensionsInitialized();
    void aboutToShutdown();

731
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
732
    void disconnectEngine() { connectEngine(0); }
733
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
734
    DebuggerEngine *dummyEngine();
735

736 737 738 739 740 741 742 743 744
    void setThreads(const QStringList &list, int index)
    {
        const bool state = m_threadBox->blockSignals(true);
        m_threadBox->clear();
        foreach (const QString &item, list)
            m_threadBox->addItem(item);
        m_threadBox->setCurrentIndex(index);
        m_threadBox->blockSignals(state);
    }
745
    DebuggerRunControl *attachToRunningProcess(Kit *kit, DeviceProcessItem process);
746

747
public slots:
748 749 750 751 752 753
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

754 755
    void selectThread(int index)
    {
hjk's avatar
hjk committed
756 757
        ThreadId id = m_currentEngine->threadsHandler()->threadAt(index);
        m_currentEngine->selectThread(id);
758
    }
759

hjk's avatar
hjk committed
760
    void breakpointSetMarginActionTriggered()
761
    {
762 763
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
hjk's avatar
hjk committed
764 765
        const BreakpointMenuContextData data =
            action->data().value<BreakpointMenuContextData>();
766 767 768 769 770 771 772 773 774 775 776 777 778
        QString message;
        if (data.mode == BreakpointMenuContextData::MessageTracePoint) {
            if (data.address) {
                //: Message tracepoint: Address hit.
                message = tr("0x%1 hit").arg(data.address, 0, 16);
            } else {
                //: Message tracepoint: %1 file, %2 line %3 function hit.
                message = tr("%1:%2 %3() hit").arg(QFileInfo(data.fileName).fileName()).
                        arg(data.lineNumber).
                        arg(cppFunctionAt(data.fileName, data.lineNumber));
            }
            QInputDialog dialog; // Create wide input dialog.
            dialog.setWindowFlags(dialog.windowFlags()
hjk's avatar
hjk committed
779
              & ~(Qt::WindowContextHelpButtonHint|Qt::MSWindowsFixedSizeDialogHint));
780 781 782 783 784 785 786 787
            dialog.resize(600, dialog.height());
            dialog.setWindowTitle(tr("Add Message Tracepoint"));
            dialog.setLabelText (tr("Message:"));
            dialog.setTextValue(message);
            if (dialog.exec() != QDialog::Accepted || dialog.textValue().isEmpty())
                return;
            message = dialog.textValue();
        }
788
        if (data.address)
789
            toggleBreakpointByAddress(data.address, message);
790
        else
791
            toggleBreakpointByFileAndLine(data.fileName, data.lineNumber, message);
792
    }
793

hjk's avatar
hjk committed
794
    void breakpointRemoveMarginActionTriggered()
795
    {
hjk's avatar
hjk committed
796 797
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
798
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
799
        m_breakHandler->removeBreakpoint(id);
hjk's avatar
hjk committed
800 801 802 803 804 805
     }

    void breakpointEnableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
806
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
807
        breakHandler()->setEnabled(id, true);
hjk's avatar
hjk committed
808 809 810 811 812 813
    }

    void breakpointDisableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
Nikolai Kosjar's avatar
Nikolai Kosjar committed
814
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
815
        breakHandler()->setEnabled(id, false);
816 817
    }

818
    void updateWatchersHeader(int section, int, int newSize)
819 820
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
821
        m_returnWindow->header()->resizeSection(section, newSize);
822
    }
823

824

825
    void sourceFilesDockToggled(bool on)
826
    {
827
        if (on && m_currentEngine->state() == InferiorStopOk)
828 829 830
            m_currentEngine->reloadSourceFiles();
    }

831
    void modulesDockToggled(bool on)
832
    {
833
        if (on && m_currentEngine->state() == InferiorStopOk)
834 835
            m_currentEngine->reloadModules();
    }
836

hjk's avatar
hjk committed
837
    void registerDockToggled(bool on)
838
    {
839
        if (on && m_currentEngine->state() == InferiorStopOk)
840 841
            m_currentEngine->reloadRegisters();
    }
842

843 844
    void synchronizeBreakpoints()
    {
845
        showMessage(QLatin1String("ATTEMPT SYNC"), LogDebug);
846
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
847
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
848 849 850 851
                engine->attemptBreakpointSynchronization();
        }
    }

852
    void editorOpened(Core::IEditor *editor);
853
    void updateBreakMenuItem(Core::IEditor *editor);
854
    void setBusyCursor(bool busy);
855 856 857
    void requestMark(TextEditor::ITextEditor *editor,
                     int lineNumber,
                     TextEditor::ITextEditor::MarkRequestKind kind);
858 859
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
860

861 862 863
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
864 865 866 867
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber,
                                       const QString &tracePointMessage = QString());
    void toggleBreakpointByAddress(quint64 address,
                                   const QString &tracePointMessage = QString());
868
    void onModeChanged(Core::IMode *mode);
869
    void onCoreAboutToOpen();
870
    void showSettingsDialog();
871
    void updateDebugWithoutDeployMenu();
872

873
    void debugProject();
874
    void debugProjectWithoutDeploy();
875
    void debugProjectBreakMain();
876
    void startAndDebugApplication();
877
    void startRemoteCdbSession();
878
    void startRemoteServer();
879
    void attachToRemoteServer();
880
    void attachToProcess(bool startServerOnly);
hjk's avatar
hjk committed
881
    void attachToRunningApplication();
882 883 884
    void attachToUnstartedApplicationDialog();
    void attachToFoundProcess();
    void continueOnAttach(Debugger::DebuggerState state);
885
    void attachExternalApplication(ProjectExplorer::RunControl *rc);
886
    void attachToQmlPort();
887
    void startRemoteEngine();
888
    void runScheduled();
889
    void attachCore();
890

891
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
892
    void languagesChanged();
893
    void showStatusMessage(const QString &msg, int timeout = -1);
894
    void openMemoryEditor();
895

896 897
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

hjk's avatar
hjk committed
898
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
899
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
900
        { return mainWindow()->isDockVisible(objectName); }
901 902

    bool hasSnapshots() const { return m_snapshotHandler->size(); }
hjk's avatar
hjk committed
903
    void createNewDock(QWidget *widget);
904

905 906
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
907 908 909 910
    DebuggerLanguages activeLanguages() const;
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
911

912 913 914
    BreakHandler *breakHandler() const { return m_breakHandler; }
    SnapshotHandler *snapshotHandler() const { return m_snapshotHandler; }

915
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
916 917 918

    void dumpLog();
    void cleanupViews();
919
    void setInitialState();
920 921 922 923

    void fontSettingsChanged(const TextEditor::FontSettings &settings);

    void updateState(DebuggerEngine *engine);
hjk's avatar
hjk committed
924
    void updateWatchersWindow(bool showWatch, bool showReturn);
925
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
926 927 928 929

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
930

931
    void coreShutdown();
932

hjk's avatar
hjk committed
933 934
#ifdef WITH_TESTS
public slots:
935
    void testLoadProject(const QString &proFile, const TestCallBack &cb);
hjk's avatar
hjk committed
936
    void testProjectLoaded(ProjectExplorer::Project *project);