debuggerplugin.cpp 133 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3
** Copyright (C) 2014 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
#include "debuggerkitconfigwidget.h"
37 38
#include "debuggerdialogs.h"
#include "debuggerengine.h"
39
#include "debuggeritemmanager.h"
40
#include "debuggermainwindow.h"
con's avatar
con committed
41
#include "debuggerrunner.h"
42
#include "debuggerrunconfigurationaspect.h"
43
#include "debuggerruncontrolfactory.h"
44
#include "debuggerstringutils.h"
45
#include "debuggeroptionspage.h"
Tobias Hunger's avatar
Tobias Hunger committed
46
#include "debuggerkitinformation.h"
47
#include "memoryagent.h"
48
#include "breakhandler.h"
49
#include "breakwindow.h"
50
#include "disassemblerlines.h"
51
#include "logwindow.h"
52
#include "moduleswindow.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
53
#include "moduleshandler.h"
54 55
#include "registerwindow.h"
#include "snapshotwindow.h"
hjk's avatar
hjk committed
56
#include "stackhandler.h"
57 58 59
#include "stackwindow.h"
#include "sourcefileswindow.h"
#include "threadswindow.h"
hjk's avatar
hjk committed
60
#include "watchhandler.h"
61
#include "watchwindow.h"
hjk's avatar
hjk committed
62
#include "watchutils.h"
63
#include "unstartedappwatcherdialog.h"
64
#include "debuggertooltipmanager.h"
65
#include "localsandexpressionswindow.h"
66
#include "loadcoredialog.h"
67
#include "sourceutils.h"
68
#include <debugger/shared/hostutils.h>
69

70 71
#include "snapshothandler.h"
#include "threadshandler.h"
72
#include "commonoptionspage.h"
73
#include "gdb/startgdbserverdialog.h"
con's avatar
con committed
74

75
#include <coreplugin/actionmanager/actionmanager.h>
76
#include <coreplugin/actionmanager/actioncontainer.h>
77
#include <coreplugin/find/treeviewfind.h>
78
#include <coreplugin/imode.h>
con's avatar
con committed
79 80
#include <coreplugin/coreconstants.h>
#include <coreplugin/icore.h>
81
#include <coreplugin/messagemanager.h>
con's avatar
con committed
82
#include <coreplugin/modemanager.h>
hjk's avatar
hjk committed
83

con's avatar
con committed
84
#include <cppeditor/cppeditorconstants.h>
85
#include <cpptools/cppmodelmanagerinterface.h>
hjk's avatar
hjk committed
86

87
#include <extensionsystem/invoker.h>
88

89
#include <projectexplorer/localapplicationrunconfiguration.h>
90
#include <projectexplorer/buildmanager.h>
91
#include <projectexplorer/taskhub.h>
92
#include <projectexplorer/toolchain.h>
93
#include <projectexplorer/devicesupport/deviceprocesslist.h>
94
#include <projectexplorer/devicesupport/deviceprocessesdialog.h>
95 96 97
#include <projectexplorer/projectexplorer.h>
#include <projectexplorer/projectexplorersettings.h>
#include <projectexplorer/project.h>
con's avatar
con committed
98
#include <projectexplorer/session.h>
99
#include <projectexplorer/target.h>
100

hjk's avatar
hjk committed
101
#include <texteditor/basetexteditor.h>
102
#include <texteditor/fontsettings.h>
103
#include <texteditor/texteditorsettings.h>
hjk's avatar
hjk committed
104

105
#include <utils/basetreeview.h>
106
#include <utils/hostosinfo.h>
107
#include <utils/proxyaction.h>
108 109
#include <utils/qtcassert.h>
#include <utils/savedaction.h>
110
#include <utils/statuslabel.h>
111
#include <utils/styledbar.h>
hjk's avatar
hjk committed
112
#include <utils/winutils.h>
con's avatar
con committed
113

Campbell Barton's avatar
Campbell Barton committed
114
#include <QApplication>
hjk's avatar
hjk committed
115
#include <QCheckBox>
116
#include <QComboBox>
117 118
#include <QDockWidget>
#include <QFileDialog>
hjk's avatar
hjk committed
119 120
#include <QHBoxLayout>
#include <QHeaderView>
hjk's avatar
hjk committed
121
#include <QInputDialog>
122 123 124
#include <QMessageBox>
#include <QTextBlock>
#include <QToolButton>
hjk's avatar
hjk committed
125
#include <QtPlugin>
126
#include <QTreeWidget>
127 128
#include <QVBoxLayout>

hjk's avatar
hjk committed
129
#ifdef WITH_TESTS
130 131 132
#include <QTest>
#include <QSignalSpy>
#include <QTestEventLoop>
133 134 135 136

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

139 140
#endif // WITH_TESTS

141 142
#include <climits>

143 144 145 146 147
#define DEBUG_STATE 1
#ifdef DEBUG_STATE
//#   define STATE_DEBUG(s)
//    do { QString msg; QTextStream ts(&msg); ts << s;
//      showMessage(msg, LogDebug); } while (0)
148
#   define STATE_DEBUG(s) do { qDebug() << s; } while (0)
149 150 151 152
#else
#   define STATE_DEBUG(s)
#endif

153 154 155 156 157 158 159 160
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
161
    \internal
162 163 164 165 166
*/

/*!
    \class Debugger::DebuggerEngine

167
    \brief The DebuggerEngine class is the base class of a debugger engine.
168

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

    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
288

289 290 291
/* 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
292

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


333 334
/*!
    \class Debugger::Internal::GdbEngine
335 336
    \brief The GdbEngine class implements Debugger::Engine driving a GDB
    executable.
337 338 339

    GdbEngine specific startup. All happens in EngineSetupRequested state:

Leena Miettinen's avatar
Leena Miettinen committed
340 341
    \list
        \li Transitions marked by '---' are done in the individual adapters.
342

Leena Miettinen's avatar
Leena Miettinen committed
343 344
        \li Transitions marked by '+-+' are done in the GdbEngine.
    \endlist
345 346 347 348 349 350 351 352 353 354 355 356 357

    \code
                  GdbEngine::setupEngine()
                          +
            (calls *Adapter->startAdapter())
                          |      |
                          |      `---> handleAdapterStartFailed()
                          |                   +
                          |             {notifyEngineSetupFailed}
                          |
                 handleAdapterStarted()
                          +
                 {notifyEngineSetupOk}
358 359 360



361 362 363 364 365 366 367 368 369 370 371
                GdbEngine::setupInferior()
                          +
            (calls *Adapter->prepareInferior())
                          |      |
                          |      `---> handlePrepareInferiorFailed()
                          |                   +
                          |             {notifyInferiorSetupFailed}
                          |
                handleInferiorPrepared()
                          +
                {notifyInferiorSetupOk}
372

373
\endcode */
374

con's avatar
con committed
375
using namespace Core;
hjk's avatar
hjk committed
376
using namespace Debugger::Constants;
377
using namespace ExtensionSystem;
con's avatar
con committed
378
using namespace ProjectExplorer;
hjk's avatar
hjk committed
379
using namespace TextEditor;
380
using namespace Utils;
con's avatar
con committed
381

hjk's avatar
hjk committed
382 383 384
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
385 386

namespace Debugger {
387 388
namespace Internal {

389 390 391 392 393 394 395 396 397 398 399 400 401
// To be passed through margin menu action's data
struct BreakpointMenuContextData : public ContextData
{
    enum Mode
    {
        Breakpoint,
        MessageTracePoint
    };

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

402 403 404 405 406 407 408 409 410 411 412
struct TestCallBack
{
    TestCallBack() : receiver(0), slot(0) {}
    TestCallBack(QObject *ob, const char *s) : receiver(ob), slot(s) {}

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


413 414 415 416
} // namespace Internal
} // namespace Debugger

Q_DECLARE_METATYPE(Debugger::Internal::BreakpointMenuContextData)
417 418
Q_DECLARE_METATYPE(Debugger::Internal::TestCallBack)

419 420 421 422

namespace Debugger {
namespace Internal {

423 424 425 426 427 428
// 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.

429
void addCdbOptionPages(QList<IOptionsPage*> *opts);
430 431 432
void addGdbOptionPages(QList<IOptionsPage*> *opts);
void addScriptOptionPages(QList<IOptionsPage*> *opts);
void addTcfOptionPages(QList<IOptionsPage*> *opts);
433

434 435 436 437
#ifdef WITH_LLDB
void addLldbOptionPages(QList<IOptionsPage*> *opts);
#endif

438 439 440 441 442 443 444
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

Orgad Shaneh's avatar
Orgad Shaneh committed
445
static void setProxyAction(ProxyAction *proxy, Core::Id id)
446
{
hjk's avatar
hjk committed
447
    proxy->setAction(ActionManager::command(id)->action());
448 449
}

Orgad Shaneh's avatar
Orgad Shaneh committed
450
static QToolButton *toolButton(Core::Id id)
451
{
hjk's avatar
hjk committed
452
    return toolButton(ActionManager::command(id)->action());
453 454
}

455 456 457 458 459 460 461 462 463 464 465
///////////////////////////////////////////////////////////////////////
//
// DummyEngine
//
///////////////////////////////////////////////////////////////////////

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
466
    DummyEngine() : DebuggerEngine(DebuggerStartParameters()) {}
467 468 469 470 471 472 473
    ~DummyEngine() {}

    void setupEngine() {}
    void setupInferior() {}
    void runEngine() {}
    void shutdownEngine() {}
    void shutdownInferior() {}
474
    bool hasCapability(unsigned cap) const;
475
    bool acceptsBreakpoint(BreakpointModelId) const { return false; }
476
    bool acceptsDebuggerCommands() const { return false; }
hjk's avatar
hjk committed
477
    void selectThread(ThreadId) {}
478 479
};

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

    // This is a Qml or unknown engine.
499
    return cap & AddWatcherCapability;
500 501
}

502 503 504 505 506 507
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

508
class DebugMode : public IMode
hjk's avatar
hjk committed
509 510
{
public:
511 512 513 514
    DebugMode()
    {
        setObjectName(QLatin1String("DebugMode"));
        setContext(Context(CC::C_EDITORMANAGER, C_DEBUGMODE, CC::C_NAVIGATION_PANE));
515
        setDisplayName(DebuggerPlugin::tr("Debug"));
516
        setIcon(QIcon(QLatin1String(":/debugger/images/mode_debug.png")));
517
        setPriority(85);
518
        setId(MODE_DEBUG);
519
    }
hjk's avatar
hjk committed
520

hjk's avatar
hjk committed
521 522 523 524
    ~DebugMode()
    {
        delete m_widget;
    }
525
};
hjk's avatar
hjk committed
526

527 528 529 530 531 532
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

533 534 535 536 537 538 539 540 541 542 543 544
static QWidget *addSearch(BaseTreeView *treeView, const QString &title, const char *objectName)
{
    QAction *act = debuggerCore()->action(UseAlternatingRowColors);
    treeView->setAlternatingRowColors(act->isChecked());
    QObject::connect(act, SIGNAL(toggled(bool)),
            treeView, SLOT(setAlternatingRowColorsHelper(bool)));

    act = debuggerCore()->action(AlwaysAdjustColumnWidths);
    treeView->setAlwaysAdjustColumns(act->isChecked());
    QObject::connect(act, SIGNAL(toggled(bool)),
            treeView, SLOT(setAlwaysAdjustColumns(bool)));

545
    QWidget *widget = TreeViewFind::createSearchableWrapper(treeView);
546 547 548 549 550
    widget->setObjectName(QLatin1String(objectName));
    widget->setWindowTitle(title);
    return widget;
}

hjk's avatar
hjk committed
551
static QString executableForPid(qint64 pid)
552
{
553
    foreach (const DeviceProcessItem &p, DeviceProcessList::localProcesses())
554 555 556 557 558
        if (p.pid == pid)
            return p.exe;
    return QString();
}

Tobias Hunger's avatar
Tobias Hunger committed
559
class AbiKitMatcher : public KitMatcher
560 561
{
public:
Tobias Hunger's avatar
Tobias Hunger committed
562
    explicit AbiKitMatcher(const QList<Abi> &abis) : m_abis(abis) {}
563
    bool matches(const Kit *k) const
564
    {
565
        if (const ToolChain *tc = ToolChainKitInformation::toolChain(k)) {
566
            return m_abis.contains(tc->targetAbi())
567
                   && DebuggerKitInformation::isValidDebugger(k);
568
        }
569 570 571 572 573 574 575
        return false;
    }

private:
    const QList<Abi> m_abis;
};

Tobias Hunger's avatar
Tobias Hunger committed
576
class CompatibleAbiKitMatcher : public KitMatcher
577 578
{
public:
Tobias Hunger's avatar
Tobias Hunger committed
579
    explicit CompatibleAbiKitMatcher(const QList<Abi> &abis) : m_abis(abis) {}
580
    bool matches(const Kit *k) const
581
    {
582
        if (const ToolChain *tc = ToolChainKitInformation::toolChain(k))
583
            foreach (const Abi &a, m_abis)
584
                if (a.isCompatibleWith(tc->targetAbi()) && DebuggerKitInformation::isValidDebugger(k))
585 586 587 588 589 590 591 592
                    return true;
        return false;
    }

private:
    const QList<Abi> m_abis;
};

Tobias Hunger's avatar
Tobias Hunger committed
593
class CdbMatcher : KitMatcher
hjk's avatar
hjk committed
594
{
595 596 597
public:
    CdbMatcher(char wordWidth = 0) : m_wordWidth(wordWidth) {}

Tobias Hunger's avatar
Tobias Hunger committed
598
    bool matches(const Kit *k) const
599
    {
600 601
        if (DebuggerKitInformation::engineType(k) != CdbEngineType
            || !DebuggerKitInformation::isValidDebugger(k)) {
602
            return false;
603 604 605 606 607
        }
        if (m_wordWidth) {
            const ToolChain *tc = ToolChainKitInformation::toolChain(k);
            return tc && m_wordWidth == tc->targetAbi().wordWidth();
        }
608 609 610
        return true;
    }

Tobias Hunger's avatar
Tobias Hunger committed
611
    // Find a CDB kit for debugging unknown processes.
612
    // On a 64bit OS, prefer a 64bit debugger.
Tobias Hunger's avatar
Tobias Hunger committed
613
    static Kit *findUniversalCdbKit()
614
    {
hjk's avatar
hjk committed
615
        if (Utils::is64BitWindowsSystem()) {
616
            CdbMatcher matcher64(64);
617
            if (Kit *cdb64Kit = KitManager::find(matcher64))
Tobias Hunger's avatar
Tobias Hunger committed
618
                return cdb64Kit;
619 620
        }
        CdbMatcher matcher;
621
        return KitManager::find(matcher);
622 623 624 625 626 627
    }

private:
    const char m_wordWidth;
};

628
bool fillParameters(DebuggerStartParameters *sp, const Kit *kit, QString *errorMessage /* = 0 */)
629
{
Tobias Hunger's avatar
Tobias Hunger committed
630
    if (!kit) {
631 632
        // 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
633
        // without specifying a kit. Try to find a kit via ABI.
634 635 636 637 638 639 640 641 642 643 644
        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));
645
        }
646
        if (!abis.isEmpty()) {
647 648 649
            kit = KitManager::find(AbiKitMatcher(abis));
            if (!kit)
                kit = KitManager::find(CompatibleAbiKitMatcher(abis));
650
        }
Tobias Hunger's avatar
Tobias Hunger committed
651
        if (!kit)
652
            kit = KitManager::defaultKit();
653 654
    }

655 656 657 658 659 660 661
    // Verify that debugger and profile are valid
    if (!kit) {
        sp->startMode = NoStartMode;
        if (errorMessage)
            *errorMessage = DebuggerKitInformation::tr("No kit found.");
        return false;
    }
662 663
    // validate debugger if C++ debugging is enabled
    if (sp->languages & CppLanguage) {
hjk's avatar
hjk committed
664
        const QList<Task> tasks = DebuggerKitInformation::validateDebugger(kit);
665 666 667
        if (!tasks.isEmpty()) {
            sp->startMode = NoStartMode;
            if (errorMessage) {
hjk's avatar
hjk committed
668
                foreach (const Task &t, tasks) {
669 670 671 672
                    if (errorMessage->isEmpty())
                        errorMessage->append(QLatin1Char('\n'));
                    errorMessage->append(t.description);
                }
673
            }
674
            return false;
675 676 677
        }
    }
    sp->cppEngineType = DebuggerKitInformation::engineType(kit);
Tobias Hunger's avatar
Tobias Hunger committed
678 679
    sp->sysRoot = SysRootKitInformation::sysRoot(kit).toString();
    sp->debuggerCommand = DebuggerKitInformation::debuggerCommand(kit).toString();
680

Tobias Hunger's avatar
Tobias Hunger committed
681
    ToolChain *tc = ToolChainKitInformation::toolChain(kit);
hjk's avatar
hjk committed
682 683
    if (tc)
        sp->toolChainAbi = tc->targetAbi();
684

685 686 687
    sp->device = DeviceKitInformation::device(kit);
    if (sp->device) {
        sp->connParams = sp->device->sshParameters();
688 689 690
        // Could have been set from command line.
        if (sp->remoteChannel.isEmpty())
            sp->remoteChannel = sp->connParams.host + QLatin1Char(':') + QString::number(sp->connParams.port);
691
    }
692
    return true;
hjk's avatar
hjk committed
693 694
}

695
static TextEditor::ITextEditor *currentTextEditor()
696
{
hjk's avatar
hjk committed
697
    return qobject_cast<TextEditor::ITextEditor *>(EditorManager::currentEditor());
698
}
con's avatar
con committed
699

700 701
static bool currentTextEditorPosition(ContextData *data)
{
702 703 704
    TextEditor::ITextEditor *textEditor = currentTextEditor();
    if (!textEditor)
        return false;
hjk's avatar
hjk committed
705
    const IDocument *document = textEditor->document();
706
    QTC_ASSERT(document, return false);
707
    data->fileName = document->filePath();
708
    if (document->property(Constants::OPENED_WITH_DISASSEMBLY).toBool()) {
709
        int lineNumber = textEditor->currentLine();
710
        QString line = textEditor->textDocument()->plainText()
711 712 713 714
            .section(QLatin1Char('\n'), lineNumber - 1, lineNumber - 1);
        data->address = DisassemblerLine::addressFromDisassemblyLine(line);
    } else {
        data->lineNumber = textEditor->currentLine();
715
    }
716
    return true;
717
}
718

719 720
///////////////////////////////////////////////////////////////////////
//
721
// DebuggerPluginPrivate
722 723
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
724

725
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
726

727 728 729 730 731 732 733 734 735 736 737 738 739 740
/*!
    \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.
*/

741
class DebuggerPluginPrivate : public DebuggerCore
742 743
{
    Q_OBJECT
744

745 746
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
747
    ~DebuggerPluginPrivate();
748

749
    bool initialize(const QStringList &arguments, QString *errorMessage);
750 751 752
    void extensionsInitialized();
    void aboutToShutdown();

753
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
754
    void disconnectEngine() { connectEngine(0); }
755
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
756
    DebuggerEngine *dummyEngine();
757

758 759 760 761 762 763 764 765 766
    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);
    }
767
    DebuggerRunControl *attachToRunningProcess(Kit *kit, DeviceProcessItem process);
768

769
public slots:
770 771 772 773 774 775
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

776 777
    void selectThread(int index)
    {
hjk's avatar
hjk committed
778 779
        ThreadId id = m_currentEngine->threadsHandler()->threadAt(index);
        m_currentEngine->selectThread(id);
780
    }
781

hjk's avatar
hjk committed
782
    void breakpointSetMarginActionTriggered()
783
    {
784 785
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
hjk's avatar
hjk committed
786 787
        const BreakpointMenuContextData data =
            action->data().value<BreakpointMenuContextData>();
788 789 790 791 792 793 794 795 796 797 798 799 800
        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
801
              & ~(Qt::WindowContextHelpButtonHint|Qt::MSWindowsFixedSizeDialogHint));
802 803 804 805 806 807 808 809
            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();
        }
810
        if (data.address)
811
            toggleBreakpointByAddress(data.address, message);
812
        else
813
            toggleBreakpointByFileAndLine(data.fileName, data.lineNumber, message);
814
    }
815

hjk's avatar
hjk committed
816
    void breakpointRemoveMarginActionTriggered()
817
    {
hjk's avatar
hjk committed
818 819
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
820
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
821
        m_breakHandler->removeBreakpoint(id);
hjk's avatar
hjk committed
822 823 824 825 826 827
     }

    void breakpointEnableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
828
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
829
        breakHandler()->setEnabled(id, true);
hjk's avatar
hjk committed
830 831 832 833 834 835
    }

    void breakpointDisableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
Nikolai Kosjar's avatar
Nikolai Kosjar committed
836
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
837
        breakHandler()->setEnabled(id, false);
838 839
    }

840
    void updateWatchersHeader(int section, int, int newSize)
841
    {
842 843
        m_watchersView->header()->resizeSection(section, newSize);
        m_returnView->header()->resizeSection(section, newSize);
844
    }
845

846

847
    void sourceFilesDockToggled(bool on)
848
    {
849
        if (on && m_currentEngine->state() == InferiorStopOk)
850 851 852
            m_currentEngine->reloadSourceFiles();
    }

853
    void modulesDockToggled(bool on)
854
    {
855
        if (on && m_currentEngine->state() == InferiorStopOk)
856 857
            m_currentEngine->reloadModules();
    }
858

hjk's avatar
hjk committed
859
    void registerDockToggled(bool on)
860
    {
861
        if (on && m_currentEngine->state() == InferiorStopOk)
862 863
            m_currentEngine->reloadRegisters();
    }
864

865 866
    void synchronizeBreakpoints()
    {
867
        showMessage(QLatin1String("ATTEMPT SYNC"), LogDebug);
868
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
869
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
870 871 872 873
                engine->attemptBreakpointSynchronization();
        }
    }

874
    void editorOpened(Core::IEditor *editor);
875
    void updateBreakMenuItem(Core::IEditor *editor);
876
    void setBusyCursor(bool busy);
877 878 879
    void requestMark(TextEditor::ITextEditor *editor,
                     int lineNumber,
                     TextEditor::ITextEditor::MarkRequestKind kind);
880 881
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
882

883 884 885
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
886 887 888 889
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber,
                                       const QString &tracePointMessage = QString());
    void toggleBreakpointByAddress(quint64 address,
                                   const QString &tracePointMessage = QString());
890
    void onModeChanged(Core::IMode *mode);
891
    void onCoreAboutToOpen();
892
    void showSettingsDialog();
893
    void updateDebugWithoutDeployMenu();
894

895
    void debugProject();
896
    void debugProjectWithoutDeploy();
897
    void debugProjectBreakMain();
898
    void startAndDebugApplication();
899
    void startRemoteCdbSession();
900
    void startRemoteServer();
901
    void attachToRemoteServer();
902
    void attachToProcess(bool startServerOnly);
hjk's avatar
hjk committed
903
    void attachToRunningApplication();
904 905 906
    void attachToUnstartedApplicationDialog();
    void attachToFoundProcess();
    void continueOnAttach(Debugger::DebuggerState state);
907
    void attachExternalApplication(ProjectExplorer::RunControl *rc);
908
    void attachToQmlPort();
909
    void startRemoteEngine();
910
    void runScheduled();
911
    void attachCore();
912

913
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
914
    void languagesChanged();
915
    void showStatusMessage(const QString &msg, int timeout = -1);
916
    void openMemoryEditor();
917

918 919
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

hjk's avatar
hjk committed
920
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
921
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
922
        { return mainWindow()->isDockVisible(objectName); }
923 924

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

927 928
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
929 930 931 932
    DebuggerLanguages activeLanguages() const;
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
933

934 935 936
    BreakHandler *breakHandler() const { return m_breakHandler; }
    SnapshotHandler *snapshotHandler() const { return m_snapshotHandler; }