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

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

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

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

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

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

83
#include <extensionsystem/invoker.h>
84

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

97 98
#include <android/androidconstants.h>

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

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

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

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

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

131 132
#endif // WITH_TESTS

133 134
#include <climits>

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

145 146 147 148 149 150 151 152
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

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

/*!
    \class Debugger::DebuggerEngine

159
    \brief The DebuggerEngine class is the base class of a debugger engine.
160 161

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

    Transitions marked by '---' are done in the individual engines.
    Transitions marked by '+-+' are done in the base DebuggerEngine.
    Transitions marked by '*' are done asynchronously.

    The GdbEngine->setupEngine() function is described in more detail below.

    The engines are responsible for local roll-back to the last
    acknowledged state before calling notify*Failed. I.e. before calling
    notifyEngineSetupFailed() any process started during setupEngine()
    so far must be terminated.
    \code

                        DebuggerNotReady
                         progressmanager/progressmanager.cpp      +
                      EngineSetupRequested
                               +
                  (calls *Engine->setupEngine())
                            |      |
                            |      |
                       {notify-  {notify-
                        Engine-   Engine-
                        SetupOk}  SetupFailed}
                            +      +
                            +      `+-+-+> EngineSetupFailed
                            +                   +
                            +    [calls RunControl->startFailed]
                            +                   +
                            +             DebuggerFinished
                            v
                      EngineSetupOk
                            +
             [calls RunControl->StartSuccessful]
                            +
                  InferiorSetupRequested
                            +
             (calls *Engine->setupInferior())
                         |       |
                         |       |
                    {notify-   {notify-
                     Inferior- Inferior-
                     SetupOk}  SetupFailed}
                         +       +
                         +       ` +-+-> InferiorSetupFailed +-+-+-+-+-+->.
                         +                                                +
                  InferiorSetupOk                                         +
                         +                                                +
                  EngineRunRequested                                      +
                         +                                                +
                 (calls *Engine->runEngine())                             +
               /       |            |        \                            +
             /         |            |          \                          +
            | (core)   | (attach)   |           |                         +
            |          |            |           |                         +
      {notify-    {notifyER&- {notifyER&-  {notify-                       +
      Inferior-     Inferior-   Inferior-  EngineRun-                     +
     Unrunnable}     StopOk}     RunOk}     Failed}                       +
           +           +            +           +                         +
   InferiorUnrunnable  +     InferiorRunOk      +                         +
                       +                        +                         +
                InferiorStopOk            EngineRunFailed                 +
                                                +                         v
                                                 `-+-+-+-+-+-+-+-+-+-+-+>-+
                                                                          +
                                                                          +
                       #Interrupt@InferiorRunOk#                          +
                                  +                                       +
                          InferiorStopRequested                           +
  #SpontaneousStop                +                                       +
   @InferiorRunOk#         (calls *Engine->                               +
          +               interruptInferior())                            +
      {notify-               |          |                                 +
     Spontaneous-       {notify-    {notify-                              +
      Inferior-          Inferior-   Inferior-                            +
       StopOk}           StopOk}    StopFailed}                           +
           +              +             +                                 +
            +            +              +                                 +
            InferiorStopOk              +                                 +
                  +                     +                                 +
                  +                    +                                  +
                  +                   +                                   +
        #Stop@InferiorUnrunnable#    +                                    +
          #Creator Close Event#     +                                     +
                       +           +                                      +
                InferiorShutdownRequested                                 +
                            +                                             +
           (calls *Engine->shutdownInferior())                            +
                         |        |                                       +
                    {notify-   {notify-                                   +
                     Inferior- Inferior-                                  +
                  ShutdownOk}  ShutdownFailed}                            +
                         +        +                                       +
                         +        +                                       +
  #Inferior exited#      +        +                                       +
         |               +        +                                       +
   {notifyInferior-      +        +                                       +
      Exited}            +        +                                       +
           +             +        +                                       +
     InferiorExitOk      +        +                                       +
             +           +        +                                       +
            InferiorShutdownOk InferiorShutdownFailed                     +
                      *          *                                        +
                  EngineShutdownRequested                                 +
                            +                                             +
           (calls *Engine->shutdownEngine())  <+-+-+-+-+-+-+-+-+-+-+-+-+-+'
                         |        |
                         |        |
                    {notify-   {notify-
                     Engine-    Engine-
                  ShutdownOk}  ShutdownFailed}
                         +       +
            EngineShutdownOk  EngineShutdownFailed
                         *       *
                     DebuggerFinished

\endcode */
hjk's avatar
hjk committed
280

281 282 283
/* Here is a matching graph as a GraphViz graph. View it using
 * \code
grep "^sg1:" debuggerplugin.cpp | cut -c5- | dot -osg1.ps -Tps && gv sg1.ps
284

285 286 287 288 289 290
sg1: digraph DebuggerStates {
sg1:   DebuggerNotReady -> EngineSetupRequested
sg1:   EngineSetupRequested -> EngineSetupOk [ label="notifyEngineSetupOk", style="dashed" ];
sg1:   EngineSetupRequested -> EngineSetupFailed [ label= "notifyEngineSetupFailed", style="dashed"];
sg1:   EngineSetupFailed -> DebuggerFinished [ label= "RunControl::StartFailed" ];
sg1:   EngineSetupOk -> InferiorSetupRequested [ label= "RunControl::StartSuccessful" ];
291
sg1:   InferiorSetupRequested -> InferiorSetupOk [ label="notifyInferiorSetupOk", style="dashed" ];
292
sg1:   InferiorSetupRequested -> InferiorSetupFailed [ label="notifyInferiorFailed", style="dashed" ];
293
sg1:   InferiorSetupOk -> EngineRunRequested
294 295 296 297 298 299 300 301 302 303 304 305 306 307
sg1:   InferiorSetupFailed -> EngineShutdownRequested
sg1:   EngineRunRequested -> InferiorUnrunnable [ label="notifyInferiorUnrunnable", style="dashed" ];
sg1:   EngineRunRequested -> InferiorStopOk [ label="notifyEngineRunAndInferiorStopOk", style="dashed" ];
sg1:   EngineRunRequested -> InferiorRunOk [ label="notifyEngineRunAndInferiorRunOk", style="dashed" ];
sg1:   EngineRunRequested -> EngineRunFailed [ label="notifyEngineRunFailed", style="dashed" ];
sg1:   EngineRunFailed -> EngineShutdownRequested
sg1:   InferiorRunOk -> InferiorStopOk [ label="SpontaneousStop\nnotifyInferiorSpontaneousStop", style="dashed" ];
sg1:   InferiorRunOk -> InferiorStopRequested [ label="User stop\nEngine::interruptInferior", style="dashed"];
sg1:   InferiorStopRequested -> InferiorStopOk [ label="notifyInferiorStopOk", style="dashed" ];
sg1:   InferiorStopRequested -> InferiorShutdownRequested  [ label="notifyInferiorStopFailed", style="dashed" ];
sg1:   InferiorStopOk -> InferiorRunRequested [ label="User\nEngine::continueInferior" ];
sg1:   InferiorRunRequested -> InferiorRunOk [ label="notifyInferiorRunOk", style="dashed"];
sg1:   InferiorRunRequested -> InferiorRunFailed [ label="notifyInferiorRunFailed", style="dashed"];
sg1:   InferiorRunFailed -> InferiorStopOk
308 309
sg1:   InferiorStopOk -> InferiorShutdownRequested [ label="Close event" ];
sg1:   InferiorUnrunnable -> InferiorShutdownRequested [ label="Close event" ];
310 311
sg1:   InferiorShutdownRequested -> InferiorShutdownOk [ label= "Engine::shutdownInferior\nnotifyInferiorShutdownOk", style="dashed" ];
sg1:   InferiorShutdownRequested -> InferiorShutdownFailed [ label="Engine::shutdownInferior\nnotifyInferiorShutdownFailed", style="dashed" ];
312 313
sg1:   InferiorExited -> InferiorExitOk [ label="notifyInferiorExited", style="dashed"];
sg1:   InferiorExitOk -> InferiorShutdownOk
314 315 316 317 318 319 320 321
sg1:   InferiorShutdownOk -> EngineShutdownRequested
sg1:   InferiorShutdownFailed -> EngineShutdownRequested
sg1:   EngineShutdownRequested -> EngineShutdownOk [ label="Engine::shutdownEngine\nnotifyEngineShutdownOk", style="dashed" ];
sg1:   EngineShutdownRequested -> EngineShutdownFailed  [ label="Engine::shutdownEngine\nnotifyEngineShutdownFailed", style="dashed" ];
sg1:   EngineShutdownOk -> DebuggerFinished  [ style = "dotted" ];
sg1:   EngineShutdownFailed  -> DebuggerFinished [ style = "dotted" ];
sg1: }
* \endcode */
hjk's avatar
hjk committed
322
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
323 324


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

    GdbEngine specific startup. All happens in EngineSetupRequested state:

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

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

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



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

363
\endcode */
364

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

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

con's avatar
con committed
375 376

namespace Debugger {
377 378
namespace Internal {

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

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

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

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


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

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

409 410 411 412

namespace Debugger {
namespace Internal {

413 414 415 416 417 418
// FIXME: Outdated?
// The createCdbEngine function takes a list of options pages it can add to.
// This allows for having a "enabled" toggle on the page independently
// of the engine. That's good for not enabling the related ActiveX control
// unnecessarily.

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

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

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

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 520 521
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        //EditorManager::instance()->setParent(0);
        delete m_widget;
    }
522
};
hjk's avatar
hjk committed
523

524 525 526 527 528 529
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

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

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

private:
    const QList<Abi> m_abis;
};

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

private:
    const QList<Abi> m_abis;
};

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

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

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

private:
    const char m_wordWidth;
};

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

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

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

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

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

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

703 704
///////////////////////////////////////////////////////////////////////
//
705
// DebuggerPluginPrivate
706 707
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
708

709
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
710

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

725
class DebuggerPluginPrivate : public DebuggerCore
726 727
{
    Q_OBJECT
728

729 730
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
731
    ~DebuggerPluginPrivate();
732

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

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

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

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

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

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

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

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

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

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

829

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

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

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

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

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

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

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

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

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

906 907
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

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

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

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

    bool isReverseDebugging() const;
921

922 923 924 925 926
    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;
927

928
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
929 930 931

    void dumpLog();
    void cleanupViews();
932
    void setInitialState();
933 934 935 936

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

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

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
943

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