debuggerplugin.cpp 132 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
con's avatar
con committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
con's avatar
con committed
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
15
**
16
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
hjk's avatar
hjk committed
29

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

Friedemann Kleint's avatar
Friedemann Kleint committed
32
#include "debuggerstartparameters.h"
33
#include "debuggeractions.h"
34
#include "debuggerinternalconstants.h"
35
#include "debuggercore.h"
36
#include "debuggerkitconfigwidget.h"
37 38
#include "debuggerdialogs.h"
#include "debuggerengine.h"
39
#include "debuggeritemmanager.h"
40
#include "debuggermainwindow.h"
con's avatar
con committed
41
#include "debuggerrunner.h"
42
#include "debuggerrunconfigurationaspect.h"
43
#include "debuggerruncontrolfactory.h"
44
#include "debuggerstringutils.h"
45
#include "debuggeroptionspage.h"
Tobias Hunger's avatar
Tobias Hunger committed
46
#include "debuggerkitinformation.h"
47
#include "memoryagent.h"
48
#include "breakhandler.h"
49
#include "breakwindow.h"
50
#include "disassemblerlines.h"
51
#include "logwindow.h"
52
#include "moduleswindow.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
53
#include "moduleshandler.h"
54 55
#include "registerwindow.h"
#include "snapshotwindow.h"
hjk's avatar
hjk committed
56
#include "stackhandler.h"
57 58 59
#include "stackwindow.h"
#include "sourcefileswindow.h"
#include "threadswindow.h"
hjk's avatar
hjk committed
60
#include "watchhandler.h"
61
#include "watchwindow.h"
hjk's avatar
hjk committed
62
#include "watchutils.h"
63
#include "unstartedappwatcherdialog.h"
64
#include "debuggertooltipmanager.h"
65
#include "localsandexpressionswindow.h"
66
#include "loadcoredialog.h"
67
#include "sourceutils.h"
68
#include <debugger/shared/hostutils.h>
69

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

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

con's avatar
con committed
83
#include <cppeditor/cppeditorconstants.h>
84
#include <cpptools/cppmodelmanagerinterface.h>
hjk's avatar
hjk committed
85

86
#include <extensionsystem/invoker.h>
87

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

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

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

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

hjk's avatar
hjk committed
124
#ifdef WITH_TESTS
125 126 127
#include <QTest>
#include <QSignalSpy>
#include <QTestEventLoop>
128 129 130 131

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

134 135
#endif // WITH_TESTS

136 137
#include <climits>

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

148 149 150 151 152 153 154 155
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
156
    \internal
157 158 159 160 161
*/

/*!
    \class Debugger::DebuggerEngine

162
    \brief The DebuggerEngine class is the base class of a debugger engine.
163

Leena Miettinen's avatar
Leena Miettinen committed
164
    \note The Debugger process itself and any helper processes like
165 166
    gdbserver are referred to as 'Engine', whereas the debugged process
    is referred to as 'Inferior'.
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282

    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
283

284 285 286
/* 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
287

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


328 329
/*!
    \class Debugger::Internal::GdbEngine
330 331
    \brief The GdbEngine class implements Debugger::Engine driving a GDB
    executable.
332 333 334

    GdbEngine specific startup. All happens in EngineSetupRequested state:

Leena Miettinen's avatar
Leena Miettinen committed
335 336
    \list
        \li Transitions marked by '---' are done in the individual adapters.
337

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

    \code
                  GdbEngine::setupEngine()
                          +
            (calls *Adapter->startAdapter())
                          |      |
                          |      `---> handleAdapterStartFailed()
                          |                   +
                          |             {notifyEngineSetupFailed}
                          |
                 handleAdapterStarted()
                          +
                 {notifyEngineSetupOk}
353 354 355



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

368
\endcode */
369

con's avatar
con committed
370
using namespace Core;
hjk's avatar
hjk committed
371
using namespace Debugger::Constants;
372
using namespace ExtensionSystem;
con's avatar
con committed
373
using namespace ProjectExplorer;
hjk's avatar
hjk committed
374
using namespace TextEditor;
375
using namespace Utils;
con's avatar
con committed
376

hjk's avatar
hjk committed
377 378 379
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
380 381

namespace Debugger {
382 383
namespace Internal {

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

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

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

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


408 409 410 411
} // namespace Internal
} // namespace Debugger

Q_DECLARE_METATYPE(Debugger::Internal::BreakpointMenuContextData)
412 413
Q_DECLARE_METATYPE(Debugger::Internal::TestCallBack)

414 415 416 417

namespace Debugger {
namespace Internal {

418 419 420 421 422 423
// 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.

424
void addCdbOptionPages(QList<IOptionsPage*> *opts);
425 426 427
void addGdbOptionPages(QList<IOptionsPage*> *opts);
void addScriptOptionPages(QList<IOptionsPage*> *opts);
void addTcfOptionPages(QList<IOptionsPage*> *opts);
428

429 430 431 432
#ifdef WITH_LLDB
void addLldbOptionPages(QList<IOptionsPage*> *opts);
#endif

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

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

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

450 451 452 453 454 455 456 457 458 459 460
///////////////////////////////////////////////////////////////////////
//
// DummyEngine
//
///////////////////////////////////////////////////////////////////////

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

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

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

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

497 498 499 500 501 502
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

hjk's avatar
hjk committed
516 517 518 519
    ~DebugMode()
    {
        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
{
530
    foreach (const DeviceProcessItem &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
    {
hjk's avatar
hjk committed
592
        if (Utils::is64BitWindowsSystem()) {
593
            CdbMatcher matcher64(64);
594
            if (Kit *cdb64Kit = KitManager::find(matcher64))
Tobias Hunger's avatar
Tobias Hunger committed
595
                return cdb64Kit;
596 597
        }
        CdbMatcher matcher;
598
        return KitManager::find(matcher);
599 600 601 602 603 604
    }

private:
    const char m_wordWidth;
};

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

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

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

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

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

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

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

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

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

718
class DebuggerPluginPrivate : public DebuggerCore
719 720
{
    Q_OBJECT
721

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

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

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

735 736 737 738 739 740 741 742 743
    void setThreads(const QStringList &list, int index)
    {
        const bool state = m_threadBox->blockSignals(true);
        m_threadBox->clear();
        foreach (const QString &item, list)
            m_threadBox->addItem(item);
        m_threadBox->setCurrentIndex(index);
        m_threadBox->blockSignals(state);
    }
744
    DebuggerRunControl *attachToRunningProcess(Kit *kit, DeviceProcessItem process);
745

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

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

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

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

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

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

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

823

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

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

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

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

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

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

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

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

895 896
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

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

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

904 905
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
906 907 908 909
    DebuggerLanguages activeLanguages() const;
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
910

911 912 913
    BreakHandler *breakHandler() const { return m_breakHandler; }
    SnapshotHandler *snapshotHandler() const { return m_snapshotHandler; }

914
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
915 916 917

    void dumpLog();
    void cleanupViews();
918
    void setInitialState();
919 920 921 922

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

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

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
929

930
    void coreShutdown();
931