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

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

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

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

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

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

82
#include <extensionsystem/invoker.h>
83

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

96 97
#include <android/androidconstants.h>

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

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

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

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

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

130 131
#endif // WITH_TESTS

132 133
#include <climits>

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

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

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

/*!
    \class Debugger::DebuggerEngine

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

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

    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
279

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

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


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

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



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

362
\endcode */
363

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

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

con's avatar
con committed
374 375

namespace Debugger {
376 377
namespace Internal {

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

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

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

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


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

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

408 409 410 411

namespace Debugger {
namespace Internal {

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

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

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

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

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

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

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

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

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

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

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

496 497 498 499 500 501
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

523 524 525 526 527 528
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

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

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

private:
    const QList<Abi> m_abis;
};

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

private:
    const QList<Abi> m_abis;
};

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

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

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

private:
    const char m_wordWidth;
};

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

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

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

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

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

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

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

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

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

724
class DebuggerPluginPrivate : public DebuggerCore
725 726
{
    Q_OBJECT
727

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

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

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

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

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

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

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

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

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

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

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

828

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

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

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

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

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

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

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

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

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

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

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

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

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

    bool isReverseDebugging() const;
920

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

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

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

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

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

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
942

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