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>
hjk's avatar
hjk committed
109
#include <utils/winutils.h>
con's avatar
con committed
110

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

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

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

131 132
#endif // WITH_TESTS

133 134
#include <climits>

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

145 146 147 148 149 150 151 152
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

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

/*!
    \class Debugger::DebuggerEngine

159
    \brief The DebuggerEngine class is the base class of a debugger engine.
160

Leena Miettinen's avatar
Leena Miettinen committed
161
    \note The Debugger process itself and any helper processes like
162 163
    gdbserver are referred to as 'Engine', whereas the debugged process
    is referred to as 'Inferior'.
164 165 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

    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
280

281 282 283
/* 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
284

285 286 287 288 289 290
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" ];
291
sg1:   InferiorSetupRequested -> InferiorSetupOk [ label="notifyInferiorSetupOk", style="dashed" ];
292
sg1:   InferiorSetupRequested -> InferiorSetupFailed [ label="notifyInferiorFailed", style="dashed" ];
293
sg1:   InferiorSetupOk -> EngineRunRequested
294 295 296 297 298 299 300 301 302 303 304 305 306 307
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
308 309
sg1:   InferiorStopOk -> InferiorShutdownRequested [ label="Close event" ];
sg1:   InferiorUnrunnable -> InferiorShutdownRequested [ label="Close event" ];
310 311
sg1:   InferiorShutdownRequested -> InferiorShutdownOk [ label= "Engine::shutdownInferior\nnotifyInferiorShutdownOk", style="dashed" ];
sg1:   InferiorShutdownRequested -> InferiorShutdownFailed [ label="Engine::shutdownInferior\nnotifyInferiorShutdownFailed", style="dashed" ];
312 313
sg1:   InferiorExited -> InferiorExitOk [ label="notifyInferiorExited", style="dashed"];
sg1:   InferiorExitOk -> InferiorShutdownOk
314 315 316 317 318 319 320 321
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
322
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
323 324


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

    GdbEngine specific startup. All happens in EngineSetupRequested state:

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

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

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



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

365
\endcode */
366

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

hjk's avatar
hjk committed
374 375 376
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
377 378

namespace Debugger {
379 380
namespace Internal {

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

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

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

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


405 406 407 408
} // namespace Internal
} // namespace Debugger

Q_DECLARE_METATYPE(Debugger::Internal::BreakpointMenuContextData)
409 410
Q_DECLARE_METATYPE(Debugger::Internal::TestCallBack)

411 412 413 414

namespace Debugger {
namespace Internal {

415 416 417 418 419 420
// 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.

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

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

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

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

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

447 448 449 450 451 452 453 454 455 456 457
///////////////////////////////////////////////////////////////////////
//
// DummyEngine
//
///////////////////////////////////////////////////////////////////////

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

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

472
bool DummyEngine::hasCapability(unsigned cap) const
473 474
{
    // This can only be a first approximation of what to expect when running.
475
    Project *project = ProjectExplorerPlugin::currentProject();
476 477 478 479 480 481 482 483
    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:
484
    if (activeRc->extraAspect<Debugger::DebuggerRunConfigurationAspect>()->useCppDebugger())
485
        return cap & (WatchpointByAddressCapability
486 487
               | BreakConditionCapability
               | TracePointCapability
488
               | OperateByInstructionCapability);
489 490

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

494 495 496 497 498 499
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

519 520 521 522 523 524
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

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

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

private:
    const QList<Abi> m_abis;
};

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

private:
    const QList<Abi> m_abis;
};

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

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

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

private:
    const char m_wordWidth;
};

602
bool fillParameters(DebuggerStartParameters *sp, const Kit *kit, QString *errorMessage /* = 0 */)
603
{
Tobias Hunger's avatar
Tobias Hunger committed
604
    if (!kit) {
605 606
        // 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
607
        // without specifying a kit. Try to find a kit via ABI.
608 609 610 611 612 613 614 615 616 617 618
        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));
619
        }
620
        if (!abis.isEmpty()) {
621 622 623
            kit = KitManager::find(AbiKitMatcher(abis));
            if (!kit)
                kit = KitManager::find(CompatibleAbiKitMatcher(abis));
624
        }
Tobias Hunger's avatar
Tobias Hunger committed
625
        if (!kit)
626
            kit = KitManager::defaultKit();
627 628
    }

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

Tobias Hunger's avatar
Tobias Hunger committed
655
    ToolChain *tc = ToolChainKitInformation::toolChain(kit);
hjk's avatar
hjk committed
656 657
    if (tc)
        sp->toolChainAbi = tc->targetAbi();
658

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

669
static TextEditor::ITextEditor *currentTextEditor()
670
{
hjk's avatar
hjk committed
671
    return qobject_cast<TextEditor::ITextEditor *>(EditorManager::currentEditor());
672
}
con's avatar
con committed
673

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

693 694
///////////////////////////////////////////////////////////////////////
//
695
// DebuggerPluginPrivate
696 697
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
698

699
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
700

701 702 703 704 705 706 707 708 709 710 711 712 713 714
/*!
    \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.
*/

715
class DebuggerPluginPrivate : public DebuggerCore
716 717
{
    Q_OBJECT
718

719 720
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
721
    ~DebuggerPluginPrivate();
722

723
    bool initialize(const QStringList &arguments, QString *errorMessage);
724 725 726
    void extensionsInitialized();
    void aboutToShutdown();

727
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
728
    void disconnectEngine() { connectEngine(0); }
729
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
730
    DebuggerEngine *dummyEngine();
731

732 733 734 735 736 737 738 739 740
    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);
    }
741
    DebuggerRunControl *attachToRunningProcess(Kit *kit, DeviceProcessItem process);
742

743
public slots:
744 745 746 747 748 749
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

750 751
    void selectThread(int index)
    {
hjk's avatar
hjk committed
752 753
        ThreadId id = m_currentEngine->threadsHandler()->threadAt(index);
        m_currentEngine->selectThread(id);
754
    }
755

hjk's avatar
hjk committed
756
    void breakpointSetMarginActionTriggered()
757
    {
758 759
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
hjk's avatar
hjk committed
760 761
        const BreakpointMenuContextData data =
            action->data().value<BreakpointMenuContextData>();
762 763 764 765 766 767 768 769 770 771 772 773 774
        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
775
              & ~(Qt::WindowContextHelpButtonHint|Qt::MSWindowsFixedSizeDialogHint));
776 777 778 779 780 781 782 783
            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();
        }
784
        if (data.address)
785
            toggleBreakpointByAddress(data.address, message);
786
        else
787
            toggleBreakpointByFileAndLine(data.fileName, data.lineNumber, message);
788
    }
789

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

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

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

814
    void updateWatchersHeader(int section, int, int newSize)
815 816
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
817
        m_returnWindow->header()->resizeSection(section, newSize);
818
    }
819

820

821
    void sourceFilesDockToggled(bool on)
822
    {
823
        if (on && m_currentEngine->state() == InferiorStopOk)
824 825 826
            m_currentEngine->reloadSourceFiles();
    }

827
    void modulesDockToggled(bool on)
828
    {
829
        if (on && m_currentEngine->state() == InferiorStopOk)
830 831
            m_currentEngine->reloadModules();
    }
832

hjk's avatar
hjk committed
833
    void registerDockToggled(bool on)
834
    {
835
        if (on && m_currentEngine->state() == InferiorStopOk)
836 837
            m_currentEngine->reloadRegisters();
    }
838

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

848
    void editorOpened(Core::IEditor *editor);
849
    void updateBreakMenuItem(Core::IEditor *editor);
850
    void setBusyCursor(bool busy);
851 852 853
    void requestMark(TextEditor::ITextEditor *editor,
                     int lineNumber,
                     TextEditor::ITextEditor::MarkRequestKind kind);
854 855
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
856

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

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

887
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
888
    void languagesChanged();
889
    void showStatusMessage(const QString &msg, int timeout = -1);
890
    void openMemoryEditor();
891

892 893
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

hjk's avatar
hjk committed
894
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
895
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
896
        { return mainWindow()->isDockVisible(objectName); }
897 898

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

901 902
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
903 904 905 906
    DebuggerLanguages activeLanguages() const;
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
907

908 909 910
    BreakHandler *breakHandler() const { return m_breakHandler; }
    SnapshotHandler *snapshotHandler() const { return m_snapshotHandler; }

911
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
912 913 914

    void dumpLog();
    void cleanupViews();
915
    void setInitialState();
916 917 918 919

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

    void updateState(DebuggerEngine *engine);
hjk's avatar
hjk committed
920
    void updateWatchersWindow(bool showWatch, bool showReturn);
921
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
922 923 924 925

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
926

927
    void coreShutdown();
928

hjk's avatar
hjk committed
929 930
#ifdef WITH_TESTS
public slots:
931
    void testLoadProject(const QString &proFile, const TestCallBack &cb);
hjk's avatar