debuggerplugin.cpp 128 KB
Newer Older
<
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
Eike Ziller's avatar
Eike Ziller committed
7
** Contact: http://www.qt-project.org/
con's avatar
con committed
8
**
9
**
10
** GNU Lesser General Public License Usage
11
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** 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.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
**
29
**************************************************************************/
hjk's avatar
hjk committed
30

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

Friedemann Kleint's avatar
Friedemann Kleint committed
33
#include "debuggerstartparameters.h"
34
#include "debuggeractions.h"
con's avatar
con committed
35
#include "debuggerconstants.h"
36
#include "debuggerinternalconstants.h"
37
#include "debuggercore.h"
38 39
#include "debuggerdialogs.h"
#include "debuggerengine.h"
40
#include "debuggermainwindow.h"
con's avatar
con committed
41
#include "debuggerrunner.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 47
#include "breakpoint.h"
#include "breakhandler.h"
48
#include "breakwindow.h"
49
#include "qtmessagelogwindow.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 "debuggertooltipmanager.h"
64
#include "localsandexpressionswindow.h"
65
#include "loadcoredialog.h"
66
#include "hostutils.h"
67

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

73
#include <coreplugin/actionmanager/actionmanager.h>
74 75
#include <coreplugin/actionmanager/actioncontainer.h>
#include <coreplugin/actionmanager/command.h>
76
#include <coreplugin/id.h>
77
#include <coreplugin/imode.h>
con's avatar
con committed
78
#include <coreplugin/coreconstants.h>
79
#include <coreplugin/dialogs/ioptionspage.h>
con's avatar
con committed
80
#include <coreplugin/editormanager/editormanager.h>
hjk's avatar
hjk committed
81
#include <coreplugin/findplaceholder.h>
82
#include <coreplugin/icontext.h>
con's avatar
con committed
83
#include <coreplugin/icore.h>
84
#include <coreplugin/imode.h>
85
#include <coreplugin/icorelistener.h>
hjk's avatar
hjk committed
86
#include <coreplugin/minisplitter.h>
con's avatar
con committed
87
#include <coreplugin/modemanager.h>
hjk's avatar
hjk committed
88

con's avatar
con committed
89
#include <cppeditor/cppeditorconstants.h>
90
#include <cpptools/ModelManagerInterface.h>
hjk's avatar
hjk committed
91

92
#include <extensionsystem/pluginmanager.h>
93
#include <extensionsystem/invoker.h>
94

95
#include <projectexplorer/abi.h>
hjk's avatar
hjk committed
96 97
#include <projectexplorer/applicationrunconfiguration.h>
#include <projectexplorer/buildconfiguration.h>
98
#include <projectexplorer/devicesupport/deviceprocessesdialog.h>
con's avatar
con committed
99
#include <projectexplorer/projectexplorerconstants.h>
100 101 102
#include <projectexplorer/projectexplorer.h>
#include <projectexplorer/projectexplorersettings.h>
#include <projectexplorer/project.h>
con's avatar
con committed
103
#include <projectexplorer/session.h>
Tobias Hunger's avatar
Tobias Hunger committed
104 105 106
#include <projectexplorer/kitchooser.h>
#include <projectexplorer/kitinformation.h>
#include <projectexplorer/kitmanager.h>
107
#include <projectexplorer/target.h>
108 109
#include <projectexplorer/toolchain.h>
#include <projectexplorer/toolchainmanager.h>
110
#include <projectexplorer/devicesupport/deviceprocesslist.h>
hjk's avatar
hjk committed
111

112
#include <qtsupport/qtsupportconstants.h>
113

hjk's avatar
hjk committed
114
#include <texteditor/basetexteditor.h>
115
#include <texteditor/fontsettings.h>
116
#include <texteditor/texteditorsettings.h>
hjk's avatar
hjk committed
117 118

#include <utils/qtcassert.h>
119
#include <utils/savedaction.h>
120
#include <utils/styledbar.h>
121
#include <utils/proxyaction.h>
122
#include <utils/statuslabel.h>
123
#include <utils/fileutils.h>
124 125 126
#ifdef Q_OS_WIN
#  include <utils/winutils.h>
#endif
con's avatar
con committed
127

128 129 130
#include <QComboBox>
#include <QDockWidget>
#include <QFileDialog>
hjk's avatar
hjk committed
131
#include <QInputDialog>
132 133 134
#include <QMenu>
#include <QMessageBox>
#include <QPushButton>
hjk's avatar
hjk committed
135
#include <QTemporaryFile>
136 137
#include <QTextBlock>
#include <QTextCursor>
hjk's avatar
hjk committed
138
#include <QTimer>
139
#include <QToolButton>
hjk's avatar
hjk committed
140
#include <QtPlugin>
141
#include <QTreeWidget>
con's avatar
con committed
142

hjk's avatar
hjk committed
143
#ifdef WITH_TESTS
144 145 146
#include <QTest>
#include <QSignalSpy>
#include <QTestEventLoop>
147 148 149 150

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

153 154
#endif // WITH_TESTS

155 156
#include <climits>

157 158 159 160 161 162 163 164 165 166
#define DEBUG_STATE 1
#ifdef DEBUG_STATE
//#   define STATE_DEBUG(s)
//    do { QString msg; QTextStream ts(&msg); ts << s;
//      showMessage(msg, LogDebug); } while (0)
#   define STATE_DEBUG(s) do { qDebug() << s; } while(0)
#else
#   define STATE_DEBUG(s)
#endif

167 168 169 170 171 172 173 174
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
175
    \internal
176 177 178 179 180 181 182 183
*/

/*!
    \class Debugger::DebuggerEngine

    \brief Base class of a debugger engine.

    Note: the Debugger process itself and any helper processes like
184 185
    gdbserver are referred to as 'Engine', whereas the debugged process
    is referred to as 'Inferior'.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301

    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
302

303 304 305
/* 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
306

307 308 309 310 311 312
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" ];
313
sg1:   InferiorSetupRequested -> InferiorSetupOk [ label="notifyInferiorSetupOk", style="dashed" ];
314
sg1:   InferiorSetupRequested -> InferiorSetupFailed [ label="notifyInferiorFailed", style="dashed" ];
315
sg1:   InferiorSetupOk -> EngineRunRequested
316 317 318 319 320 321 322 323 324 325 326 327 328 329
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
330 331
sg1:   InferiorStopOk -> InferiorShutdownRequested [ label="Close event" ];
sg1:   InferiorUnrunnable -> InferiorShutdownRequested [ label="Close event" ];
332 333
sg1:   InferiorShutdownRequested -> InferiorShutdownOk [ label= "Engine::shutdownInferior\nnotifyInferiorShutdownOk", style="dashed" ];
sg1:   InferiorShutdownRequested -> InferiorShutdownFailed [ label="Engine::shutdownInferior\nnotifyInferiorShutdownFailed", style="dashed" ];
334 335
sg1:   InferiorExited -> InferiorExitOk [ label="notifyInferiorExited", style="dashed"];
sg1:   InferiorExitOk -> InferiorShutdownOk
336 337 338 339 340 341 342 343
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
344
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
345 346


347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
/*!
    \class Debugger::Internal::GdbEngine
    \brief Implementation of Debugger::Engine driving a gdb executable.

    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}
369 370 371



372 373 374 375 376 377 378 379 380 381 382
                GdbEngine::setupInferior()
                          +
            (calls *Adapter->prepareInferior())
                          |      |
                          |      `---> handlePrepareInferiorFailed()
                          |                   +
                          |             {notifyInferiorSetupFailed}
                          |
                handleInferiorPrepared()
                          +
                {notifyInferiorSetupOk}
383

384
\endcode */
385

con's avatar
con committed
386
using namespace Core;
hjk's avatar
hjk committed
387
using namespace Debugger::Constants;
388
using namespace ExtensionSystem;
con's avatar
con committed
389
using namespace ProjectExplorer;
hjk's avatar
hjk committed
390
using namespace TextEditor;
391
using namespace Utils;
con's avatar
con committed
392

hjk's avatar
hjk committed
393 394 395
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
396 397 398 399 400 401 402

namespace Debugger {
namespace Constants {

} // namespace Constants


403 404
namespace Internal {

405 406 407 408 409 410 411 412 413 414 415 416 417
// To be passed through margin menu action's data
struct BreakpointMenuContextData : public ContextData
{
    enum Mode
    {
        Breakpoint,
        MessageTracePoint
    };

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

418 419 420 421 422 423 424 425 426 427 428
struct TestCallBack
{
    TestCallBack() : receiver(0), slot(0) {}
    TestCallBack(QObject *ob, const char *s) : receiver(ob), slot(s) {}

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


429 430 431 432
} // namespace Internal
} // namespace Debugger

Q_DECLARE_METATYPE(Debugger::Internal::BreakpointMenuContextData)
433 434
Q_DECLARE_METATYPE(Debugger::Internal::TestCallBack)

435 436 437 438

namespace Debugger {
namespace Internal {

439 440 441 442 443 444
// 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.

445
void addCdbOptionPages(QList<IOptionsPage*> *opts);
446 447 448
void addGdbOptionPages(QList<IOptionsPage*> *opts);
void addScriptOptionPages(QList<IOptionsPage*> *opts);
void addTcfOptionPages(QList<IOptionsPage*> *opts);
449

450 451 452 453
#ifdef WITH_LLDB
void addLldbOptionPages(QList<IOptionsPage*> *opts);
#endif

hjk's avatar
hjk committed
454
static SessionManager *sessionManager()
455
{
hjk's avatar
hjk committed
456
    return ProjectExplorerPlugin::instance()->session();
457 458
}

459 460 461 462 463 464 465
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

466
static void setProxyAction(ProxyAction *proxy, const char *id)
467
{
hjk's avatar
hjk committed
468
    proxy->setAction(ActionManager::command(id)->action());
469 470 471 472
}

static QToolButton *toolButton(const char *id)
{
hjk's avatar
hjk committed
473
    return toolButton(ActionManager::command(id)->action());
474 475
}

476 477 478 479 480 481 482 483 484 485 486
///////////////////////////////////////////////////////////////////////
//
// DummyEngine
//
///////////////////////////////////////////////////////////////////////

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
487
    DummyEngine() : DebuggerEngine(DebuggerStartParameters()) {}
488 489 490 491 492 493 494
    ~DummyEngine() {}

    void setupEngine() {}
    void setupInferior() {}
    void runEngine() {}
    void shutdownEngine() {}
    void shutdownInferior() {}
495
    bool hasCapability(unsigned cap) const;
496
    bool acceptsBreakpoint(BreakpointModelId) const { return false; }
497
    bool acceptsDebuggerCommands() const { return false; }
498 499
};

500
bool DummyEngine::hasCapability(unsigned cap) const
501 502
{
    // This can only be a first approximation of what to expect when running.
503
    Project *project = ProjectExplorerPlugin::currentProject();
504 505 506 507 508 509 510 511
    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:
512
    if (activeRc->debuggerAspect()->useCppDebugger())
513
        return cap & (WatchpointByAddressCapability
514 515
               | BreakConditionCapability
               | TracePointCapability
516
               | OperateByInstructionCapability);
517 518

    // This is a Qml or unknown engine.
519
    return cap & AddWatcherCapability;
520 521
}

522 523 524 525 526 527
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

528
class DebugMode : public IMode
hjk's avatar
hjk committed
529 530
{
public:
531 532 533 534
    DebugMode()
    {
        setObjectName(QLatin1String("DebugMode"));
        setContext(Context(CC::C_EDITORMANAGER, C_DEBUGMODE, CC::C_NAVIGATION_PANE));
535 536
        setDisplayName(DebuggerPlugin::tr("Debug"));
        setIcon(QIcon(QLatin1String(":/fancyactionbar/images/mode_Debug.png")));
537
        setPriority(85);
538 539
        setId(MODE_DEBUG);
        setType(CC::MODE_EDIT_TYPE);
540
    }
hjk's avatar
hjk committed
541

hjk's avatar
hjk committed
542 543 544 545 546 547
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        //EditorManager::instance()->setParent(0);
        delete m_widget;
    }
548
};
hjk's avatar
hjk committed
549

550 551 552 553 554 555
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

556 557 558 559 560 561 562 563
static inline QString executableForPid(qint64 pid)
{
    foreach (const ProjectExplorer::DeviceProcess &p, ProjectExplorer::DeviceProcessList::localProcesses())
        if (p.pid == pid)
            return p.exe;
    return QString();
}

Tobias Hunger's avatar
Tobias Hunger committed
564
class AbiKitMatcher : public KitMatcher
565 566
{
public:
Tobias Hunger's avatar
Tobias Hunger committed
567
    explicit AbiKitMatcher(const QList<Abi> &abis) : m_abis(abis) {}
568
    bool matches(const Kit *k) const
569
    {
570
        if (const ToolChain *tc = ToolChainKitInformation::toolChain(k)) {
571
            return m_abis.contains(tc->targetAbi())
572
                   && DebuggerKitInformation::isValidDebugger(k);
573
        }
574 575 576 577 578 579 580
        return false;
    }

private:
    const QList<Abi> m_abis;
};

Tobias Hunger's avatar
Tobias Hunger committed
581
class CompatibleAbiKitMatcher : public KitMatcher
582 583
{
public:
Tobias Hunger's avatar
Tobias Hunger committed
584
    explicit CompatibleAbiKitMatcher(const QList<Abi> &abis) : m_abis(abis) {}
585
    bool matches(const Kit *k) const
586
    {
587
        if (const ToolChain *tc = ToolChainKitInformation::toolChain(k))
588
            foreach (const Abi &a, m_abis)
589
                if (a.isCompatibleWith(tc->targetAbi()) && DebuggerKitInformation::isValidDebugger(k))
590 591 592 593 594 595 596 597
                    return true;
        return false;
    }

private:
    const QList<Abi> m_abis;
};

Tobias Hunger's avatar
Tobias Hunger committed
598
class CdbMatcher : KitMatcher
hjk's avatar
hjk committed
599
{
600 601 602
public:
    CdbMatcher(char wordWidth = 0) : m_wordWidth(wordWidth) {}

Tobias Hunger's avatar
Tobias Hunger committed
603
    bool matches(const Kit *k) const
604
    {
605 606
        if (DebuggerKitInformation::engineType(k) != CdbEngineType
            || !DebuggerKitInformation::isValidDebugger(k)) {
607
            return false;
608 609 610 611 612
        }
        if (m_wordWidth) {
            const ToolChain *tc = ToolChainKitInformation::toolChain(k);
            return tc && m_wordWidth == tc->targetAbi().wordWidth();
        }
613 614 615
        return true;
    }

Tobias Hunger's avatar
Tobias Hunger committed
616
    // Find a CDB kit for debugging unknown processes.
617
    // On a 64bit OS, prefer a 64bit debugger.
Tobias Hunger's avatar
Tobias Hunger committed
618
    static Kit *findUniversalCdbKit()
619 620 621 622
    {
#ifdef Q_OS_WIN
        if (Utils::winIs64BitSystem()) {
            CdbMatcher matcher64(64);
Tobias Hunger's avatar
Tobias Hunger committed
623 624
            if (Kit *cdb64Kit = KitManager::instance()->find(&matcher64))
                return cdb64Kit;
625 626 627
        }
#endif
        CdbMatcher matcher;
Tobias Hunger's avatar
Tobias Hunger committed
628
        return KitManager::instance()->find(&matcher);
629 630 631 632 633 634
    }

private:
    const char m_wordWidth;
};

635
bool fillParameters(DebuggerStartParameters *sp, const Kit *kit /* = 0 */, QString *errorMessage /* = 0 */)
636
{
Tobias Hunger's avatar
Tobias Hunger committed
637
    if (!kit) {
638 639
        // 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
640
        // without specifying a kit. Try to find a kit via ABI.
641 642 643 644 645 646 647 648 649 650 651
        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));
652
        }
653
        if (!abis.isEmpty()) {
Tobias Hunger's avatar
Tobias Hunger committed
654 655 656 657 658
            AbiKitMatcher matcher(abis);
            kit = KitManager::instance()->find(&matcher);
            if (!kit) {
                CompatibleAbiKitMatcher matcher(abis);
                kit = KitManager::instance()->find(&matcher);
659 660
            }
        }
Tobias Hunger's avatar
Tobias Hunger committed
661 662
        if (!kit)
            kit = KitManager::instance()->defaultKit();
663 664
    }

665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
    // Verify that debugger and profile are valid
    if (!kit) {
        sp->startMode = NoStartMode;
        if (errorMessage)
            *errorMessage = DebuggerKitInformation::tr("No kit found.");
        return false;
    }
    const QList<ProjectExplorer::Task> tasks = DebuggerKitInformation::validateDebugger(kit);
    if (!tasks.isEmpty()) {
        sp->startMode = NoStartMode;
        if (errorMessage) {
            foreach (const ProjectExplorer::Task &t, tasks) {
                if (errorMessage->isEmpty())
                    errorMessage->append(QLatin1Char('\n'));
                errorMessage->append(t.description);
            }
        }
        return false;
    }

    sp->cppEngineType = DebuggerKitInformation::engineType(kit);
Tobias Hunger's avatar
Tobias Hunger committed
686 687
    sp->sysRoot = SysRootKitInformation::sysRoot(kit).toString();
    sp->debuggerCommand = DebuggerKitInformation::debuggerCommand(kit).toString();
688

Tobias Hunger's avatar
Tobias Hunger committed
689
    ToolChain *tc = ToolChainKitInformation::toolChain(kit);
hjk's avatar
hjk committed
690 691
    if (tc)
        sp->toolChainAbi = tc->targetAbi();
692

Tobias Hunger's avatar
Tobias Hunger committed
693
    IDevice::ConstPtr device = DeviceKitInformation::device(kit);
694 695
    if (device) {
        sp->connParams = device->sshParameters();
696
        sp->remoteChannel = sp->connParams.host + QLatin1Char(':') + QString::number(sp->connParams.port);
697
    }
698
    return true;
hjk's avatar
hjk committed
699 700
}

701
static TextEditor::ITextEditor *currentTextEditor()
702
{
hjk's avatar
hjk committed
703
    return qobject_cast<TextEditor::ITextEditor *>(EditorManager::currentEditor());
704
}
con's avatar
con committed
705

706 707
static bool currentTextEditorPosition(ContextData *data)
{
708 709 710
    TextEditor::ITextEditor *textEditor = currentTextEditor();
    if (!textEditor)
        return false;
hjk's avatar
hjk committed
711
    const IDocument *document = textEditor->document();
712 713
    QTC_ASSERT(document, return false);
    data->fileName = document->fileName();
714 715 716 717 718 719 720
    if (textEditor->property("DisassemblerView").toBool()) {
        int lineNumber = textEditor->currentLine();
        QString line = textEditor->contents()
            .section(QLatin1Char('\n'), lineNumber - 1, lineNumber - 1);
        data->address = DisassemblerLine::addressFromDisassemblyLine(line);
    } else {
        data->lineNumber = textEditor->currentLine();
721
    }
722
    return true;
723
}
724

725 726
///////////////////////////////////////////////////////////////////////
//
727
// DebuggerPluginPrivate
728 729
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
730

731
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
732

733 734 735 736 737 738 739 740 741 742 743 744 745 746
/*!
    \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.
*/

747
class DebuggerPluginPrivate : public DebuggerCore
748 749
{
    Q_OBJECT
750

751 752
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
753
    ~DebuggerPluginPrivate();
754

755
    bool initialize(const QStringList &arguments, QString *errorMessage);
756 757 758
    void extensionsInitialized();
    void aboutToShutdown();

759
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
760
    void disconnectEngine() { connectEngine(0); }
761
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
762
    DebuggerEngine *dummyEngine();
763

764 765 766 767 768 769 770 771 772 773
    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);
    }

774
public slots:
775 776 777 778 779 780
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

781 782 783 784
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
785

hjk's avatar
hjk committed
786
    void breakpointSetMarginActionTriggered()
787
    {
788 789
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
hjk's avatar
hjk committed
790 791
        const BreakpointMenuContextData data =
            action->data().value<BreakpointMenuContextData>();
792 793 794 795 796 797 798 799 800 801 802 803 804
        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
805
              & ~(Qt::WindowContextHelpButtonHint|Qt::MSWindowsFixedSizeDialogHint));
806 807 808 809 810 811 812 813
            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();
        }
814
        if (data.address)
815
            toggleBreakpointByAddress(data.address, message);
816
        else
817
            toggleBreakpointByFileAndLine(data.fileName, data.lineNumber, message);
818
    }
819

hjk's avatar
hjk committed
820
    void breakpointRemoveMarginActionTriggered()
821
    {
hjk's avatar
hjk committed
822 823
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
824
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
825
        m_breakHandler->removeBreakpoint(id);
hjk's avatar
hjk committed
826 827 828 829 830 831
     }

    void breakpointEnableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
832
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
833
        breakHandler()->setEnabled(id, true);
hjk's avatar
hjk committed
834 835 836 837 838 839
    }

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

844
    void updateWatchersHeader(int section, int, int newSize)
845 846
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
847
        m_returnWindow->header()->resizeSection(section, newSize);
848
    }
849

850

851
    void sourceFilesDockToggled(bool on)
852
    {
853
        if (on && m_currentEngine->state() == InferiorStopOk)
854 855 856
            m_currentEngine->reloadSourceFiles();
    }

857
    void modulesDockToggled(bool on)
858
    {
859
        if (on && m_currentEngine->state() == InferiorStopOk)
860 861
            m_currentEngine->reloadModules();
    }
862

hjk's avatar
hjk committed
863
    void registerDockToggled(bool on)
864
    {
865
        if (on && m_currentEngine->state() == InferiorStopOk)
866 867
            m_currentEngine->reloadRegisters();
    }
868

869 870
    void synchronizeBreakpoints()
    {
871
        showMessage(QLatin1String("ATTEMPT SYNC"), LogDebug);
872
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
873
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
874 875 876 877
                engine->attemptBreakpointSynchronization();
        }
    }

hjk's avatar
hjk committed
878 879 880
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
881
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
882
                engine->watchHandler()->updateWatchers();
hjk's avatar
hjk committed
883 884 885
        }
    }

886
    void editorOpened(Core::IEditor *editor);
887
    void updateBreakMenuItem(Core::IEditor *editor);
888
    void setBusyCursor(bool busy);
889 890 891
    void requestMark(TextEditor::ITextEditor *editor,
                     int lineNumber,
                     TextEditor::ITextEditor::MarkRequestKind kind);
892 893
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
894

895 896 897
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
898 899 900 901
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber,
                                       const QString &tracePointMessage = QString());
    void toggleBreakpointByAddress(quint64 address,
                                   const QString &tracePointMessage = QString());
902
    void onModeChanged(Core::IMode *mode);
903
    void onCoreAboutToOpen();
904
    void showSettingsDialog();
905
    void updateDebugWithoutDeployMenu();
906

907
    void debugProject();
908
    void debugProjectWithoutDeploy();
909
    void debugProjectBreakMain();
910
    void startAndDebugApplication();
911
    void startRemoteCdbSession();
912
    void startRemoteServer();
913
    void attachToRemoteServer();
914
    void attachToProcess(bool startServerOnly);
hjk's avatar
hjk committed
915
    void attachToRunningApplication();
916
    void attachExternalApplication(ProjectExplorer::RunControl *rc);
917
    void attachToQmlPort();
918
    void startRemoteEngine();
919
    void runScheduled();
920
    void attachCore();
921

922
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
923
    void languagesChanged();
924
    void showStatusMessage(const QString &msg, int timeout = -1);
925
    void openMemoryEditor();
926

927 928
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

hjk's avatar
hjk committed
929
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
930
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
931
        { return mainWindow()->isDockVisible(objectName); }
932 933

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

936 937
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
938 939 940 941
    DebuggerLanguages activeLanguages() const;
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
942

943 944 945 946 947
    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;
948

949
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
950 951 952

    void dumpLog();
    void cleanupViews();
953
    void setInitialState();
954 955 956 957

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

    void updateState(DebuggerEngine *engine);
hjk's avatar
hjk committed
958
    void updateWatchersWindow(bool showWatch, bool showReturn);
959
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
960 961 962 963

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
964

965
    void executeDebuggerCommand(const QString &command, DebuggerLanguages languages);
966
    bool evaluateScriptExpression(const QString &expression);
967
    void coreShutdown();
968

hjk's avatar
hjk committed
969 970
#ifdef WITH_TESTS
public slots:
971
    void testLoadProject(const QString &proFile, const TestCallBack &cb);
hjk's avatar
hjk committed
972
    void testProjectLoaded(ProjectExplorer::Project *project);
973 974 975 976
    void testUnloadProject();
    void testFinished();

    void testRunProject(const DebuggerStartParameters &sp, const TestCallBack &cb);