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

95 96
#include <android/androidconstants.h>

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

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

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

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

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

129 130
#endif // WITH_TESTS

131 132
#include <climits>

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

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

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

/*!
    \class Debugger::DebuggerEngine

    \brief Base class of a debugger engine.

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

    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
278

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

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


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



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

360
\endcode */
361

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

hjk's avatar
hjk committed
369 370 371
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
372 373

namespace Debugger {
374 375
namespace Internal {

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

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

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

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


400 401 402 403
} // namespace Internal
} // namespace Debugger

Q_DECLARE_METATYPE(Debugger::Internal::BreakpointMenuContextData)
404 405
Q_DECLARE_METATYPE(Debugger::Internal::TestCallBack)

406 407 408 409

namespace Debugger {
namespace Internal {

410 411 412 413 414 415
// 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.

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

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

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

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

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

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

447 448 449 450 451 452 453 454 455 456 457
///////////////////////////////////////////////////////////////////////
//
// DummyEngine
//
///////////////////////////////////////////////////////////////////////

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

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

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

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

494 495 496 497 498 499
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

521 522 523 524 525 526
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

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

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

private:
    const QList<Abi> m_abis;
};

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

private:
    const QList<Abi> m_abis;
};

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

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

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

private:
    const char m_wordWidth;
};

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

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

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

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

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

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

700 701
///////////////////////////////////////////////////////////////////////
//
702
// DebuggerPluginPrivate
703 704
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
705

706
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
707

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

722
class DebuggerPluginPrivate : public DebuggerCore
723 724
{
    Q_OBJECT
725

726 727
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
728
    ~DebuggerPluginPrivate();
729

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

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

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

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

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

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

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

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

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

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

826

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

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

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

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

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

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

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

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

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

903 904
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

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

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

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

    bool isReverseDebugging() const;
918

919 920 921 922 923
    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;
924

925
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
926 927 928

    void dumpLog();
    void cleanupViews();
929
    void setInitialState();
930 931 932 933

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

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

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
940

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

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

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

    void test