debuggerplugin.cpp 131 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 37
#include "debuggerdialogs.h"
#include "debuggerengine.h"
38
#include "debuggermainwindow.h"
con's avatar
con committed
39
#include "debuggerrunner.h"
40
#include "debuggerrunconfigurationaspect.h"
41
#include "debuggerruncontrolfactory.h"
42
#include "debuggerstringutils.h"
Tobias Hunger's avatar
Tobias Hunger committed
43
#include "debuggerkitinformation.h"
44
#include "memoryagent.h"
45
#include "breakhandler.h"
46
#include "breakwindow.h"
47
#include "disassemblerlines.h"
48
#include "logwindow.h"
49
#include "moduleswindow.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
50
#include "moduleshandler.h"
51 52
#include "registerwindow.h"
#include "snapshotwindow.h"
hjk's avatar
hjk committed
53
#include "stackhandler.h"
54 55 56
#include "stackwindow.h"
#include "sourcefileswindow.h"
#include "threadswindow.h"
hjk's avatar
hjk committed
57
#include "watchhandler.h"
58
#include "watchwindow.h"
hjk's avatar
hjk committed
59
#include "watchutils.h"
60
#include "debuggertooltipmanager.h"
61
#include "localsandexpressionswindow.h"
62
#include "loadcoredialog.h"
63
#include "hostutils.h"
64
#include "sourceutils.h"
65

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

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

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

82
#include <extensionsystem/invoker.h>
83

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

95 96
#include <android/androidconstants.h>

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

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

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

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

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

129 130
#endif // WITH_TESTS

131 132
#include <climits>

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

143 144 145 146 147 148 149 150
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

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

/*!
    \class Debugger::DebuggerEngine

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

    Note: the Debugger process itself and any helper processes like
160 161
    gdbserver are referred to as 'Engine', whereas the debugged process
    is referred to as 'Inferior'.
162 163 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

    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
278

279 280 281
/* 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
282

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


323 324
/*!
    \class Debugger::Internal::GdbEngine
325 326
    \brief The GdbEngine class implements Debugger::Engine driving a GDB
    executable.
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345

    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}
346 347 348



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

361
\endcode */
362

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

hjk's avatar
hjk committed
370 371 372
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
373 374

namespace Debugger {
375 376
namespace Internal {

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

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

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

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


401 402 403 404
} // namespace Internal
} // namespace Debugger

Q_DECLARE_METATYPE(Debugger::Internal::BreakpointMenuContextData)
405 406
Q_DECLARE_METATYPE(Debugger::Internal::TestCallBack)

407 408 409 410

namespace Debugger {
namespace Internal {

411 412 413 414 415 416
// 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.

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

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

hjk's avatar
hjk committed
426
static SessionManager *sessionManager()
427
{
hjk's avatar
hjk committed
428
    return ProjectExplorerPlugin::instance()->session();
429 430
}

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

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

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

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

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

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

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

495 496 497 498 499 500
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

hjk's avatar
hjk committed
514 515 516 517 518 519
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        //EditorManager::instance()->setParent(0);
        delete m_widget;
    }
520
};
hjk's avatar
hjk committed
521

522 523 524 525 526 527
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

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

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

private:
    const QList<Abi> m_abis;
};

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

private:
    const QList<Abi> m_abis;
};

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

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

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

private:
    const char m_wordWidth;
};

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

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

Tobias Hunger's avatar
Tobias Hunger committed
663
    ToolChain *tc = ToolChainKitInformation::toolChain(kit);
hjk's avatar
hjk committed
664 665
    if (tc)
        sp->toolChainAbi = tc->targetAbi();
666

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

677
static TextEditor::ITextEditor *currentTextEditor()
678
{
hjk's avatar
hjk committed
679
    return qobject_cast<TextEditor::ITextEditor *>(EditorManager::currentEditor());
680
}
con's avatar
con committed
681

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

701 702
///////////////////////////////////////////////////////////////////////
//
703
// DebuggerPluginPrivate
704 705
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
706

707
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
708

709 710 711 712 713 714 715 716 717 718 719 720 721 722
/*!
    \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.
*/

723
class DebuggerPluginPrivate : public DebuggerCore
724 725
{
    Q_OBJECT
726

727 728
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
729
    ~DebuggerPluginPrivate();
730

731
    bool initialize(const QStringList &arguments, QString *errorMessage);
732 733 734
    void extensionsInitialized();
    void aboutToShutdown();

735
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
736
    void disconnectEngine() { connectEngine(0); }
737
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
738
    DebuggerEngine *dummyEngine();
739

740 741 742 743 744 745 746 747 748 749
    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);
    }

750
public slots:
751 752 753 754 755 756
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

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

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

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

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

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

821
    void updateWatchersHeader(int section, int, int newSize)
822 823
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
824
        m_returnWindow->header()->resizeSection(section, newSize);
825
    }
826

827

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

834
    void modulesDockToggled(bool on)
835
    {
836
        if (on && m_currentEngine->state() == InferiorStopOk)
837 838
            m_currentEngine->reloadModules();
    }
839

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

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

hjk's avatar
hjk committed
855 856 857
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
858
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
859
                engine->watchHandler()->updateWatchers();
hjk's avatar
hjk committed
860 861 862
        }
    }

863
    void editorOpened(Core::IEditor *editor);
864
    void updateBreakMenuItem(Core::IEditor *editor);
865
    void setBusyCursor(bool busy);
866 867 868
    void requestMark(TextEditor::ITextEditor *editor,
                     int lineNumber,
                     TextEditor::ITextEditor::MarkRequestKind kind);
869 870
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
871

872 873 874
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
875 876 877 878
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber,
                                       const QString &tracePointMessage = QString());
    void toggleBreakpointByAddress(quint64 address,
                                   const QString &tracePointMessage = QString());
879
    void onModeChanged(Core::IMode *mode);
880
    void onCoreAboutToOpen();
881
    void showSettingsDialog();
882
    void updateDebugWithoutDeployMenu();
883

884
    void debugProject();
885
    void debugProjectWithoutDeploy();
886
    void debugProjectBreakMain();
887
    void startAndDebugApplication();
888
    void startRemoteCdbSession();
889
    void startRemoteServer();
890
    void attachToRemoteServer();
891
    void attachToProcess(bool startServerOnly);
hjk's avatar
hjk committed
892
    void attachToRunningApplication();
893
    void attachExternalApplication(ProjectExplorer::RunControl *rc);
894
    void attachToQmlPort();
895
    void startRemoteEngine();
896
    void runScheduled();
897
    void attachCore();
898

899
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
900
    void languagesChanged();
901
    void showStatusMessage(const QString &msg, int timeout = -1);
902
    void openMemoryEditor();
903

904 905
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

hjk's avatar
hjk committed
906
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
907
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
908
        { return mainWindow()->isDockVisible(objectName); }
909 910

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

913 914
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
915 916 917 918
    DebuggerLanguages activeLanguages() const;
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
919

920 921 922 923 924
    BreakHandler *breakHandler() const { return m_breakHandler; }
    SnapshotHandler *snapshotHandler() const { return m_snapshotHandler; }

    void setConfigValue(const QString &name, const QVariant &value);
    QVariant configValue(const QString &name) const;
925

926
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
927 928 929

    void dumpLog();
    void cleanupViews();
930
    void setInitialState();
931 932 933 934

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

    void updateState(DebuggerEngine *engine);
hjk's avatar
hjk committed
935
    void updateWatchersWindow(bool showWatch, bool showReturn);
936
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
937 938 939 940

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
941

942
    void executeDebuggerCommand(const QString &command, DebuggerLanguages languages);
943
    void coreShutdown();
944

hjk's avatar
hjk committed
945 946
#ifdef WITH_TESTS
public slots:
947
    void testLoadProject(const QString &proFile, const TestCallBack &cb);
hjk's avatar
hjk committed
948
    void testProjectLoaded(ProjectExplorer::Project *project);
949 950
    void testProjectEvaluated();
    void testProjectBuilt(bool success);