debuggerplugin.cpp 128 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
hjk's avatar
hjk committed
3 4
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** 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"
con's avatar
con committed
34
#include "debuggerconstants.h"
35
#include "debuggerinternalconstants.h"
36
#include "debuggercore.h"
37 38
#include "debuggerdialogs.h"
#include "debuggerengine.h"
39
#include "debuggermainwindow.h"
con's avatar
con committed
40
#include "debuggerrunner.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 46
#include "breakpoint.h"
#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 "hostutils.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 73
#include <coreplugin/actionmanager/actioncontainer.h>
#include <coreplugin/actionmanager/command.h>
74
#include <coreplugin/id.h>
75
#include <coreplugin/imode.h>
con's avatar
con committed
76
#include <coreplugin/coreconstants.h>
77
#include <coreplugin/dialogs/ioptionspage.h>
con's avatar
con committed
78
#include <coreplugin/editormanager/editormanager.h>
hjk's avatar
hjk committed
79
#include <coreplugin/findplaceholder.h>
80
#include <coreplugin/icontext.h>
con's avatar
con committed
81
#include <coreplugin/icore.h>
82
#include <coreplugin/imode.h>
83
#include <coreplugin/icorelistener.h>
hjk's avatar
hjk committed
84
#include <coreplugin/minisplitter.h>
con's avatar
con committed
85
#include <coreplugin/modemanager.h>
hjk's avatar
hjk committed
86

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

90
#include <extensionsystem/pluginmanager.h>
91
#include <extensionsystem/invoker.h>
92

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

110
#include <qtsupport/qtsupportconstants.h>
111

hjk's avatar
hjk committed
112
#include <texteditor/basetexteditor.h>
113
#include <texteditor/fontsettings.h>
114
#include <texteditor/texteditorsettings.h>
hjk's avatar
hjk committed
115

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

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

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

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

152 153
#endif // WITH_TESTS

154 155
#include <climits>

156 157 158 159 160 161 162 163 164 165
#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

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

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

/*!
    \class Debugger::DebuggerEngine

    \brief Base class of a debugger engine.

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

    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
301

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

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


346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
/*!
    \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}
368 369 370



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

383
\endcode */
384

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

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

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

namespace Debugger {
namespace Constants {

} // namespace Constants


402 403
namespace Internal {

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

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

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

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


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

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

434 435 436 437

namespace Debugger {
namespace Internal {

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

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

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

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

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

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

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

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

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

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

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

521 522 523 524 525 526
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

549 550 551 552 553 554
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

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

private:
    const QList<Abi> m_abis;
};

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

private:
    const QList<Abi> m_abis;
};

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

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

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

private:
    const char m_wordWidth;
};

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

664 665 666 667 668 669 670
    // Verify that debugger and profile are valid
    if (!kit) {
        sp->startMode = NoStartMode;
        if (errorMessage)
            *errorMessage = DebuggerKitInformation::tr("No kit found.");
        return false;
    }
671 672 673 674 675 676 677 678 679 680 681
    // validate debugger if C++ debugging is enabled
    if (sp->languages & CppLanguage) {
        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);
                }
682
            }
683
            return false;
684 685 686
        }
    }
    sp->cppEngineType = DebuggerKitInformation::engineType(kit);
Tobias Hunger's avatar
Tobias Hunger committed
687 688
    sp->sysRoot = SysRootKitInformation::sysRoot(kit).toString();
    sp->debuggerCommand = DebuggerKitInformation::debuggerCommand(kit).toString();
689

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

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

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

707 708
static bool currentTextEditorPosition(ContextData *data)
{
709 710 711
    TextEditor::ITextEditor *textEditor = currentTextEditor();
    if (!textEditor)
        return false;
hjk's avatar
hjk committed
712
    const IDocument *document = textEditor->document();
713 714
    QTC_ASSERT(document, return false);
    data->fileName = document->fileName();
715 716 717 718 719 720 721
    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();
722
    }
723
    return true;
724
}
725

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

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

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

748
class DebuggerPluginPrivate : public DebuggerCore
749 750
{
    Q_OBJECT
751

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

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

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

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

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

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

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

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

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

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

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

851

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

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

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

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

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

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

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

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

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

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

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

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

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

    bool isReverseDebugging() const;
943

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

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

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

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

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

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
965

966
    void executeDebuggerCommand(const QString &command, DebuggerLanguages languages);
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);