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

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

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

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

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

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

127 128
#endif // WITH_TESTS

129 130
#include <climits>

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

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

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

/*!
    \class Debugger::DebuggerEngine

    \brief Base class of a debugger engine.

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

    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
276

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

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


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



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

358
\endcode */
359

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

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

con's avatar
con committed
370 371

namespace Debugger {
372 373
namespace Internal {

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

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

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

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


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

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

404 405 406 407

namespace Debugger {
namespace Internal {

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

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

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

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

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

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

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

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

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

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

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

492 493 494 495 496 497
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

520 521 522 523 524 525
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

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

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

private:
    const QList<Abi> m_abis;
};

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

private:
    const QList<Abi> m_abis;
};

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

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

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

private:
    const char m_wordWidth;
};

605
bool fillParameters(DebuggerStartParameters *sp, const Kit *kit /* = 0 */, QString *errorMessage /* = 0 */)
606
{
Tobias Hunger's avatar
Tobias Hunger committed
607
    if (!kit) {
608 609
        // This code can only be reached when starting via the command line
        // (-debug pid or executable) or attaching from runconfiguration
Tobias Hunger's avatar
Tobias Hunger committed
610
        // without specifying a kit. Try to find a kit via ABI.
611 612 613 614 615 616 617 618 619 620 621
        QList<Abi> abis;
        if (sp->toolChainAbi.isValid()) {
            abis.push_back(sp->toolChainAbi);
        } else {
            // Try via executable.
            if (sp->executable.isEmpty()
                && (sp->startMode == AttachExternal || sp->startMode == AttachCrashedExternal)) {
                sp->executable = executableForPid(sp->attachPID);
            }
            if (!sp->executable.isEmpty())
                abis = Abi::abisOfBinary(Utils::FileName::fromString(sp->executable));
622
        }
623
        if (!abis.isEmpty()) {
Tobias Hunger's avatar
Tobias Hunger committed
624 625 626 627 628
            AbiKitMatcher matcher(abis);
            kit = KitManager::instance()->find(&matcher);
            if (!kit) {
                CompatibleAbiKitMatcher matcher(abis);
                kit = KitManager::instance()->find(&matcher);
629 630
            }
        }
Tobias Hunger's avatar
Tobias Hunger committed
631 632
        if (!kit)
            kit = KitManager::instance()->defaultKit();
633 634
    }

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

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

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

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

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

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

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

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

719
class DebuggerPluginPrivate : public DebuggerCore
720 721
{
    Q_OBJECT
722

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

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

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

736 737 738 739 740 741 742 743 744 745
    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);
    }

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

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

hjk's avatar
hjk committed
759
    void breakpointSetMarginActionTriggered()
760
    {
761 762
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
hjk's avatar
hjk committed
763 764
        const BreakpointMenuContextData data =
            action->data().value<BreakpointMenuContextData>();
765 766 767 768 769 770 771 772 773 774 775 776 777
        QString message;
        if (data.mode == BreakpointMenuContextData::MessageTracePoint) {
            if (data.address) {
                //: Message tracepoint: Address hit.
                message = tr("0x%1 hit").arg(data.address, 0, 16);
            } else {
                //: Message tracepoint: %1 file, %2 line %3 function hit.
                message = tr("%1:%2 %3() hit").arg(QFileInfo(data.fileName).fileName()).
                        arg(data.lineNumber).
                        arg(cppFunctionAt(data.fileName, data.lineNumber));
            }
            QInputDialog dialog; // Create wide input dialog.
            dialog.setWindowFlags(dialog.windowFlags()
hjk's avatar
hjk committed
778
              & ~(Qt::WindowContextHelpButtonHint|Qt::MSWindowsFixedSizeDialogHint));
779 780 781 782 783 784 785 786
            dialog.resize(600, dialog.height());
            dialog.setWindowTitle(tr("Add Message Tracepoint"));
            dialog.setLabelText (tr("Message:"));
            dialog.setTextValue(message);
            if (dialog.exec() != QDialog::Accepted || dialog.textValue().isEmpty())
                return;
            message = dialog.textValue();
        }
787
        if (data.address)
788
            toggleBreakpointByAddress(data.address, message);
789
        else
790
            toggleBreakpointByFileAndLine(data.fileName, data.lineNumber, message);
791
    }
792

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

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

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

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

823

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

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

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

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

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

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

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

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

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

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

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

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

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

    bool isReverseDebugging() const;
915

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

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

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

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

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

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
937

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

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

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

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

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

961 962
    void testBenchmark1();