debuggerplugin.cpp 130 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3
** Copyright (C) 2013 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 "debuggermainwindow.h"
con's avatar
con committed
40
#include "debuggerrunner.h"
41
#include "debuggerrunconfigurationaspect.h"
42
#include "debuggerruncontrolfactory.h"
43
#include "debuggerstringutils.h"
Tobias Hunger's avatar
Tobias Hunger committed
44
#include "debuggerkitinformation.h"
45
#include "memoryagent.h"
46
#include "breakhandler.h"
47
#include "breakwindow.h"
48
#include "disassemblerlines.h"
49
#include "logwindow.h"
50
#include "moduleswindow.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
51
#include "moduleshandler.h"
52 53
#include "registerwindow.h"
#include "snapshotwindow.h"
hjk's avatar
hjk committed
54
#include "stackhandler.h"
55 56 57
#include "stackwindow.h"
#include "sourcefileswindow.h"
#include "threadswindow.h"
hjk's avatar
hjk committed
58
#include "watchhandler.h"
59
#include "watchwindow.h"
hjk's avatar
hjk committed
60
#include "watchutils.h"
61
#include "debuggertooltipmanager.h"
62
#include "localsandexpressionswindow.h"
63
#include "loadcoredialog.h"
64
#include "sourceutils.h"
65
#include <debugger/shared/hostutils.h>
66

67 68
#include "snapshothandler.h"
#include "threadshandler.h"
69
#include "commonoptionspage.h"
70
#include "gdb/startgdbserverdialog.h"
con's avatar
con committed
71

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

con's avatar
con committed
80
#include <cppeditor/cppeditorconstants.h>
81
#include <cpptools/cppmodelmanagerinterface.h>
hjk's avatar
hjk committed
82

83
#include <extensionsystem/invoker.h>
84

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

97 98
#include <android/androidconstants.h>

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

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

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 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 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347

    GdbEngine specific startup. All happens in EngineSetupRequested state:

    Transitions marked by '---' are done in the individual adapters.

    Transitions marked by '+-+' are done in the GdbEngine.

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



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

363
\endcode */
364

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

hjk's avatar
hjk committed
372 373 374
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
375 376

namespace Debugger {
377 378
namespace Internal {

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

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

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

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


403 404 405 406
} // namespace Internal
} // namespace Debugger

Q_DECLARE_METATYPE(Debugger::Internal::BreakpointMenuContextData)
407 408
Q_DECLARE_METATYPE(Debugger::Internal::TestCallBack)

409 410 411 412

namespace Debugger {
namespace Internal {

413 414 415 416 417 418
// 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.

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

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

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

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

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

445 446 447 448 449 450 451 452 453 454 455
///////////////////////////////////////////////////////////////////////
//
// DummyEngine
//
///////////////////////////////////////////////////////////////////////

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

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

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

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

492 493 494 495 496 497
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

hjk's avatar
hjk committed
511 512 513 514 515 516
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        //EditorManager::instance()->setParent(0);
        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 589 590 591
    {
#ifdef Q_OS_WIN
        if (Utils::winIs64BitSystem()) {
            CdbMatcher matcher64(64);
592
            if (Kit *cdb64Kit = KitManager::find(matcher64))
Tobias Hunger's avatar
Tobias Hunger committed
593
                return cdb64Kit;
594 595 596
        }
#endif
        CdbMatcher matcher;
597
        return KitManager::find(matcher);
598 599 600 601 602 603
    }

private:
    const char m_wordWidth;
};

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

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

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

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

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

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

695 696
///////////////////////////////////////////////////////////////////////
//
697
// DebuggerPluginPrivate
698 699
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
700

701
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
702

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

717
class DebuggerPluginPrivate : public DebuggerCore
718 719
{
    Q_OBJECT
720

721 722
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
723
    ~DebuggerPluginPrivate();
724

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

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

734 735 736 737 738 739 740 741 742 743
    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);
    }

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

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

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

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

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

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

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

821

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

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

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

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

hjk's avatar
hjk committed
849 850 851
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
852
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
853
                engine->watchHandler()->updateWatchers();
hjk's avatar
hjk committed
854 855 856
        }
    }

857
    void editorOpened(Core::IEditor *editor);
858
    void updateBreakMenuItem(Core::IEditor *editor);
859
    void setBusyCursor(bool busy);
860 861 862
    void requestMark(TextEditor::ITextEditor *editor,
                     int lineNumber,
                     TextEditor::ITextEditor::MarkRequestKind kind);
863 864
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
865

866 867 868
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
869 870 871 872
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber,
                                       const QString &tracePointMessage = QString());
    void toggleBreakpointByAddress(quint64 address,
                                   const QString &tracePointMessage = QString());
873
    void onModeChanged(Core::IMode *mode);
874
    void onCoreAboutToOpen();
875
    void showSettingsDialog();
876
    void updateDebugWithoutDeployMenu();
877

878
    void debugProject();
879
    void debugProjectWithoutDeploy();
880
    void debugProjectBreakMain();
881
    void startAndDebugApplication();
882
    void startRemoteCdbSession();
883
    void startRemoteServer();
884
    void attachToRemoteServer();
885
    void attachToProcess(bool startServerOnly);
hjk's avatar
hjk committed
886
    void attachToRunningApplication();
887
    void attachExternalApplication(ProjectExplorer::RunControl *rc);
888
    void attachToQmlPort();
889
    void startRemoteEngine();
890
    void runScheduled();
891
    void attachCore();
892

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

898 899
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

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

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

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

    bool isReverseDebugging() const;
913

914 915 916
    BreakHandler *breakHandler() const { return m_breakHandler; }
    SnapshotHandler *snapshotHandler() const { return m_snapshotHandler; }

917
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
918 919 920

    void dumpLog();
    void cleanupViews();
921
    void setInitialState();
922 923 924 925

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

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

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
932

933
    void executeDebuggerCommand(const QString &command, DebuggerLanguages languages);
934
    void coreShutdown();
935

hjk's avatar
hjk committed
936 937
#ifdef WITH_TESTS
public slots:
938
    void testLoadProject(const QString &proFile, const TestCallBack &cb);
hjk's avatar
hjk committed
939
    void testProjectLoaded(ProjectExplorer::Project *project);
940 941
    void testProjectEvaluated();
    void testProjectBuilt(bool success);
942 943 944 945
    void testUnloadProject();
    void testFinished();

    void testRunProject(const DebuggerStartParameters &sp, const TestCallBack &cb);
hjk's avatar
hjk committed
946
    void testRunControlFinished();