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/devicesupport/deviceprocesslist.h>
86
#include <projectexplorer/devicesupport/deviceprocessesdialog.h>
87 88 89
#include <projectexplorer/projectexplorer.h>
#include <projectexplorer/projectexplorersettings.h>
#include <projectexplorer/project.h>
con's avatar
con committed
90
#include <projectexplorer/session.h>
91
#include <projectexplorer/target.h>
92

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

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

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

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

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

125 126
#endif // WITH_TESTS

127 128
#include <climits>

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

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

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

/*!
    \class Debugger::DebuggerEngine

    \brief Base class of a debugger engine.

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

    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
274

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

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


319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
/*!
    \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}
341 342 343



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

356
\endcode */
357

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

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

con's avatar
con committed
368 369

namespace Debugger {
370 371
namespace Internal {

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

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

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

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


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

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

402 403 404 405

namespace Debugger {
namespace Internal {

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

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

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

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

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

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

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

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

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

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

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

490 491 492 493 494 495
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

518 519 520 521 522 523
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

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

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

private:
    const QList<Abi> m_abis;
};

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

private:
    const QList<Abi> m_abis;
};

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

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

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

private:
    const char m_wordWidth;
};

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

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

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

Tobias Hunger's avatar
Tobias Hunger committed
663
    IDevice::ConstPtr device = DeviceKitInformation::device(kit);
664 665
    if (device) {
        sp->connParams = device->sshParameters();
666
        sp->remoteChannel = sp->connParams.host + QLatin1Char(':') + QString::number(sp->connParams.port);
667
    }
668
    return true;
hjk's avatar
hjk committed
669 670
}

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

676 677
static bool currentTextEditorPosition(ContextData *data)
{
678 679 680
    TextEditor::ITextEditor *textEditor = currentTextEditor();
    if (!textEditor)
        return false;
hjk's avatar
hjk committed
681
    const IDocument *document = textEditor->document();
682 683
    QTC_ASSERT(document, return false);
    data->fileName = document->fileName();
684 685 686 687 688 689 690
    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();
691
    }
692
    return true;
693
}
694

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

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

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

717
class DebuggerPluginPrivate : public DebuggerCore
718 719
{
    Q_OBJECT
720

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

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

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

734 735 736 737 738 739 740 741 742 743
    void setThreads(const QStringList &list, int index)
    {
        const bool state = m_threadBox->blockSignals(true);
        m_threadBox->clear();
        foreach (const QString &item, list)
            m_threadBox->addItem(item);
        m_threadBox->setCurrentIndex(index);
        m_threadBox->blockSignals(state);
    }

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

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

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

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

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

    void breakpointDisableMarginActionTriggered()
    {
        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, false);
813 814
    }

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

821

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

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

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

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

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

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

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

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

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

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

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

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

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

    bool isReverseDebugging() const;
913

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

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

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

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

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

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
935

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

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

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

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

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

959 960
    void testBenchmark1();

961
public:
hjk's avatar
hjk committed
962
    Project *m_testProject;
963