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 "debuggerruncontrolfactory.h"
41
#include "debuggerstringutils.h"
Tobias Hunger's avatar
Tobias Hunger committed
42
#include "debuggerkitinformation.h"
43
#include "memoryagent.h"
44
#include "breakhandler.h"
45
#include "breakwindow.h"
46
#include "disassemblerlines.h"
47
#include "logwindow.h"
48
#include "moduleswindow.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
49
#include "moduleshandler.h"
50 51
#include "registerwindow.h"
#include "snapshotwindow.h"
hjk's avatar
hjk committed
52
#include "stackhandler.h"
53 54 55
#include "stackwindow.h"
#include "sourcefileswindow.h"
#include "threadswindow.h"
hjk's avatar
hjk committed
56
#include "watchhandler.h"
57
#include "watchwindow.h"
hjk's avatar
hjk committed
58
#include "watchutils.h"
59
#include "debuggertooltipmanager.h"
60
#include "localsandexpressionswindow.h"
61
#include "loadcoredialog.h"
62
#include "hostutils.h"
63
#include "sourceutils.h"
64

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

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

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

81
#include <extensionsystem/invoker.h>
82

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

hjk's avatar
hjk committed
94
#include <texteditor/basetexteditor.h>
95
#include <texteditor/fontsettings.h>
96
#include <texteditor/texteditorsettings.h>
hjk's avatar
hjk committed
97

98
#include <utils/hostosinfo.h>
hjk's avatar
hjk committed
99
#include <utils/qtcassert.h>
100
#include <utils/styledbar.h>
101
#include <utils/proxyaction.h>
102
#include <utils/statuslabel.h>
103 104 105
#ifdef Q_OS_WIN
#  include <utils/winutils.h>
#endif
con's avatar
con committed
106

107 108
#include <QDockWidget>
#include <QFileDialog>
hjk's avatar
hjk committed
109
#include <QInputDialog>
110 111 112
#include <QMessageBox>
#include <QTextBlock>
#include <QToolButton>
hjk's avatar
hjk committed
113
#include <QtPlugin>
114
#include <QTreeWidget>
con's avatar
con committed
115

hjk's avatar
hjk committed
116
#ifdef WITH_TESTS
117 118 119
#include <QTest>
#include <QSignalSpy>
#include <QTestEventLoop>
120 121 122 123

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

126 127
#endif // WITH_TESTS

128 129
#include <climits>

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

140 141 142 143 144 145 146 147
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
148
    \internal
149 150 151 152 153 154 155 156
*/

/*!
    \class Debugger::DebuggerEngine

    \brief Base class of a debugger engine.

    Note: the Debugger process itself and any helper processes like
157 158
    gdbserver are referred to as 'Engine', whereas the debugged process
    is referred to as 'Inferior'.
159 160 161 162 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

    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
275

276 277 278
/* 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
279

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


320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
/*!
    \class Debugger::Internal::GdbEngine
    \brief Implementation of Debugger::Engine driving a gdb executable.

    GdbEngine specific startup. All happens in EngineSetupRequested state:

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

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

    \code
                  GdbEngine::setupEngine()
                          +
            (calls *Adapter->startAdapter())
                          |      |
                          |      `---> handleAdapterStartFailed()
                          |                   +
                          |             {notifyEngineSetupFailed}
                          |
                 handleAdapterStarted()
                          +
                 {notifyEngineSetupOk}
342 343 344



345 346 347 348 349 350 351 352 353 354 355
                GdbEngine::setupInferior()
                          +
            (calls *Adapter->prepareInferior())
                          |      |
                          |      `---> handlePrepareInferiorFailed()
                          |                   +
                          |             {notifyInferiorSetupFailed}
                          |
                handleInferiorPrepared()
                          +
                {notifyInferiorSetupOk}
356

357
\endcode */
358

con's avatar
con committed
359
using namespace Core;
hjk's avatar
hjk committed
360
using namespace Debugger::Constants;
361
using namespace ExtensionSystem;
con's avatar
con committed
362
using namespace ProjectExplorer;
hjk's avatar
hjk committed
363
using namespace TextEditor;
364
using namespace Utils;
con's avatar
con committed
365

hjk's avatar
hjk committed
366 367 368
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
369 370

namespace Debugger {
371 372
namespace Internal {

373 374 375 376 377 378 379 380 381 382 383 384 385
// To be passed through margin menu action's data
struct BreakpointMenuContextData : public ContextData
{
    enum Mode
    {
        Breakpoint,
        MessageTracePoint
    };

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

386 387 388 389 390 391 392 393 394 395 396
struct TestCallBack
{
    TestCallBack() : receiver(0), slot(0) {}
    TestCallBack(QObject *ob, const char *s) : receiver(ob), slot(s) {}

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


397 398 399 400
} // namespace Internal
} // namespace Debugger

Q_DECLARE_METATYPE(Debugger::Internal::BreakpointMenuContextData)
401 402
Q_DECLARE_METATYPE(Debugger::Internal::TestCallBack)

403 404 405 406

namespace Debugger {
namespace Internal {

407 408 409 410 411 412
// 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.

413
void addCdbOptionPages(QList<IOptionsPage*> *opts);
414 415 416
void addGdbOptionPages(QList<IOptionsPage*> *opts);
void addScriptOptionPages(QList<IOptionsPage*> *opts);
void addTcfOptionPages(QList<IOptionsPage*> *opts);
417

418 419 420 421
#ifdef WITH_LLDB
void addLldbOptionPages(QList<IOptionsPage*> *opts);
#endif

hjk's avatar
hjk committed
422
static SessionManager *sessionManager()
423
{
hjk's avatar
hjk committed
424
    return ProjectExplorerPlugin::instance()->session();
425 426
}

427 428 429 430 431 432 433
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

Orgad Shaneh's avatar
Orgad Shaneh committed
434
static void setProxyAction(ProxyAction *proxy, Core::Id id)
435
{
hjk's avatar
hjk committed
436
    proxy->setAction(ActionManager::command(id)->action());
437 438
}

Orgad Shaneh's avatar
Orgad Shaneh committed
439
static QToolButton *toolButton(Core::Id id)
440
{
hjk's avatar
hjk committed
441
    return toolButton(ActionManager::command(id)->action());
442 443
}

444 445 446 447 448 449 450 451 452 453 454
///////////////////////////////////////////////////////////////////////
//
// DummyEngine
//
///////////////////////////////////////////////////////////////////////

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
455
    DummyEngine() : DebuggerEngine(DebuggerStartParameters()) {}
456 457 458 459 460 461 462
    ~DummyEngine() {}

    void setupEngine() {}
    void setupInferior() {}
    void runEngine() {}
    void shutdownEngine() {}
    void shutdownInferior() {}
463
    bool hasCapability(unsigned cap) const;
464
    bool acceptsBreakpoint(BreakpointModelId) const { return false; }
465
    bool acceptsDebuggerCommands() const { return false; }
hjk's avatar
hjk committed
466
    void selectThread(ThreadId) {}
467 468
};

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

    // This is a Qml or unknown engine.
488
    return cap & AddWatcherCapability;
489 490
}

491 492 493 494 495 496
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

519 520 521 522 523 524
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
525
static QString executableForPid(qint64 pid)
526
{
hjk's avatar
hjk committed
527
    foreach (const DeviceProcess &p, DeviceProcessList::localProcesses())
528 529 530 531 532
        if (p.pid == pid)
            return p.exe;
    return QString();
}

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

private:
    const QList<Abi> m_abis;
};

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

private:
    const QList<Abi> m_abis;
};

Tobias Hunger's avatar
Tobias Hunger committed
567
class CdbMatcher : KitMatcher
hjk's avatar
hjk committed
568
{
569 570 571
public:
    CdbMatcher(char wordWidth = 0) : m_wordWidth(wordWidth) {}

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

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

private:
    const char m_wordWidth;
};

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

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

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

Tobias Hunger's avatar
Tobias Hunger committed
664
    IDevice::ConstPtr device = DeviceKitInformation::device(kit);
665 666
    if (device) {
        sp->connParams = device->sshParameters();
667
        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 684
    QTC_ASSERT(document, return false);
    data->fileName = document->fileName();
685 686 687 688 689 690 691
    if (textEditor->property("DisassemblerView").toBool()) {
        int lineNumber = textEditor->currentLine();
        QString line = textEditor->contents()
            .section(QLatin1Char('\n'), lineNumber - 1, lineNumber - 1);
        data->address = DisassemblerLine::addressFromDisassemblyLine(line);
    } else {
        data->lineNumber = textEditor->currentLine();
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 744
    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);
    }

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

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

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

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

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

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

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

822

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

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

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

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

hjk's avatar
hjk committed
850 851 852
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
853
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
854
                engine->watchHandler()->updateWatchers();
hjk's avatar
hjk committed
855 856 857
        }
    }

858
    void editorOpened(Core::IEditor *editor);
859
    void updateBreakMenuItem(Core::IEditor *editor);
860
    void setBusyCursor(bool busy);
861 862 863
    void requestMark(TextEditor::ITextEditor *editor,
                     int lineNumber,
                     TextEditor::ITextEditor::MarkRequestKind kind);
864 865
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
866

867 868 869
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
870 871 872 873
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber,
                                       const QString &tracePointMessage = QString());
    void toggleBreakpointByAddress(quint64 address,
                                   const QString &tracePointMessage = QString());
874
    void onModeChanged(Core::IMode *mode);
875
    void onCoreAboutToOpen();
876
    void showSettingsDialog();
877
    void updateDebugWithoutDeployMenu();
878

879
    void debugProject();
880
    void debugProjectWithoutDeploy();
881
    void debugProjectBreakMain();
882
    void startAndDebugApplication();
883
    void startRemoteCdbSession();
884
    void startRemoteServer();
885
    void attachToRemoteServer();
886
    void attachToProcess(bool startServerOnly);
hjk's avatar
hjk committed
887
    void attachToRunningApplication();
888
    void attachExternalApplication(ProjectExplorer::RunControl *rc);
889
    void attachToQmlPort();
890
    void startRemoteEngine();
891
    void runScheduled();
892
    void attachCore();
893

894
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
895
    void languagesChanged();
896
    void showStatusMessage(const QString &msg, int timeout = -1);
897
    void openMemoryEditor();
898

899 900
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

hjk's avatar
hjk committed
901
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
902
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
903
        { return mainWindow()->isDockVisible(objectName); }
904 905

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

908 909
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
910 911 912 913
    DebuggerLanguages activeLanguages() const;
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
914

915 916 917 918 919
    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;
920

921
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
922 923 924

    void dumpLog();
    void cleanupViews();
925
    void setInitialState();
926 927 928 929

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

    void updateState(DebuggerEngine *engine);
hjk's avatar
hjk committed
930
    void updateWatchersWindow(bool showWatch, bool showReturn);
931
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
932 933 934 935

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
936

937
    void executeDebuggerCommand(const QString &command, DebuggerLanguages languages);
938
    void coreShutdown();
939

hjk's avatar
hjk committed
940 941
#ifdef WITH_TESTS
public slots:
942
    void testLoadProject(const QString &proFile, const TestCallBack &cb);
hjk's avatar
hjk committed
943
    void testProjectLoaded(ProjectExplorer::Project *project);
944 945
    void testProjectEvaluated();
    void testProjectBuilt(bool success);
946 947 948 949
    void testUnloadProject();
    void testFinished();

    void testRunProject(const DebuggerStartParameters &sp, const TestCallBack &cb);
hjk's avatar
hjk committed
950
    void testRunControlFinished();
951 952 953 954 955 956 957 958 959

    void testPythonDumpers1();
    void testPythonDumpers2();
    void testPythonDumpers3();

    void testStateMachine1();
    void testStateMachine2();
    void testStateMachine3();

960 961
    void testBenchmark1();

962
public:
hjk's avatar
hjk committed
963
    Proje