debuggerplugin.cpp 131 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
hjk's avatar
hjk committed
3 4
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** 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"
con's avatar
con committed
34
#include "debuggerconstants.h"
35
#include "debuggerinternalconstants.h"
36
#include "debuggercore.h"
37 38
#include "debuggerdialogs.h"
#include "debuggerengine.h"
39
#include "debuggermainwindow.h"
con's avatar
con committed
40
#include "debuggerrunner.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 46
#include "breakpoint.h"
#include "breakhandler.h"
47
#include "breakwindow.h"
48
#include "disassemblerlines.h"
49
#include "logwindow.h"
50
#include "moduleswindow.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
51
#include "moduleshandler.h"
52 53
#include "registerwindow.h"
#include "snapshotwindow.h"
hjk's avatar
hjk committed
54
#include "stackhandler.h"
55 56 57
#include "stackwindow.h"
#include "sourcefileswindow.h"
#include "threadswindow.h"
hjk's avatar
hjk committed
58
#include "watchhandler.h"
59
#include "watchwindow.h"
hjk's avatar
hjk committed
60
#include "watchutils.h"
61
#include "debuggertooltipmanager.h"
62
#include "localsandexpressionswindow.h"
63
#include "loadcoredialog.h"
64
#include "hostutils.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 73
#include <coreplugin/actionmanager/actioncontainer.h>
#include <coreplugin/actionmanager/command.h>
74
#include <coreplugin/id.h>
75
#include <coreplugin/imode.h>
con's avatar
con committed
76
#include <coreplugin/coreconstants.h>
77
#include <coreplugin/dialogs/ioptionspage.h>
con's avatar
con committed
78
#include <coreplugin/editormanager/editormanager.h>
hjk's avatar
hjk committed
79
#include <coreplugin/findplaceholder.h>
80
#include <coreplugin/icontext.h>
con's avatar
con committed
81
#include <coreplugin/icore.h>
82
#include <coreplugin/imode.h>
83
#include <coreplugin/icorelistener.h>
hjk's avatar
hjk committed
84
#include <coreplugin/minisplitter.h>
con's avatar
con committed
85
#include <coreplugin/modemanager.h>
hjk's avatar
hjk committed
86

con's avatar
con committed
87
#include <cppeditor/cppeditorconstants.h>
88
#include <cpptools/ModelManagerInterface.h>
hjk's avatar
hjk committed
89

90
#include <extensionsystem/pluginmanager.h>
91
#include <extensionsystem/invoker.h>
92

93
#include <projectexplorer/abi.h>
hjk's avatar
hjk committed
94 95
#include <projectexplorer/applicationrunconfiguration.h>
#include <projectexplorer/buildconfiguration.h>
96
#include <projectexplorer/buildmanager.h>
97
#include <projectexplorer/devicesupport/deviceprocessesdialog.h>
con's avatar
con committed
98
#include <projectexplorer/projectexplorerconstants.h>
99 100 101
#include <projectexplorer/projectexplorer.h>
#include <projectexplorer/projectexplorersettings.h>
#include <projectexplorer/project.h>
con's avatar
con committed
102
#include <projectexplorer/session.h>
Tobias Hunger's avatar
Tobias Hunger committed
103 104 105
#include <projectexplorer/kitchooser.h>
#include <projectexplorer/kitinformation.h>
#include <projectexplorer/kitmanager.h>
106
#include <projectexplorer/target.h>
107 108
#include <projectexplorer/toolchain.h>
#include <projectexplorer/toolchainmanager.h>
109
#include <projectexplorer/devicesupport/deviceprocesslist.h>
hjk's avatar
hjk committed
110

111
#include <qtsupport/qtsupportconstants.h>
112

hjk's avatar
hjk committed
113
#include <texteditor/basetexteditor.h>
114
#include <texteditor/fontsettings.h>
115
#include <texteditor/texteditorsettings.h>
hjk's avatar
hjk committed
116

117
#include <utils/hostosinfo.h>
hjk's avatar
hjk committed
118
#include <utils/qtcassert.h>
119
#include <utils/savedaction.h>
120
#include <utils/styledbar.h>
121
#include <utils/proxyaction.h>
122
#include <utils/statuslabel.h>
123
#include <utils/fileutils.h>
124 125 126
#ifdef Q_OS_WIN
#  include <utils/winutils.h>
#endif
con's avatar
con committed
127

128 129 130
#include <QComboBox>
#include <QDockWidget>
#include <QFileDialog>
hjk's avatar
hjk committed
131
#include <QInputDialog>
132 133 134
#include <QMenu>
#include <QMessageBox>
#include <QPushButton>
hjk's avatar
hjk committed
135
#include <QTemporaryFile>
136 137
#include <QTextBlock>
#include <QTextCursor>
hjk's avatar
hjk committed
138
#include <QTimer>
139
#include <QToolButton>
hjk's avatar
hjk committed
140
#include <QtPlugin>
141
#include <QTreeWidget>
con's avatar
con committed
142

hjk's avatar
hjk committed
143
#ifdef WITH_TESTS
144 145 146
#include <QTest>
#include <QSignalSpy>
#include <QTestEventLoop>
147 148 149 150

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

153 154
#endif // WITH_TESTS

155 156
#include <climits>

157 158 159 160 161
#define DEBUG_STATE 1
#ifdef DEBUG_STATE
//#   define STATE_DEBUG(s)
//    do { QString msg; QTextStream ts(&msg); ts << s;
//      showMessage(msg, LogDebug); } while (0)
162
#   define STATE_DEBUG(s) do { qDebug() << s; } while (0)
163 164 165 166
#else
#   define STATE_DEBUG(s)
#endif

167 168 169 170 171 172 173 174
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
175
    \internal
176 177 178 179 180 181 182 183
*/

/*!
    \class Debugger::DebuggerEngine

    \brief Base class of a debugger engine.

    Note: the Debugger process itself and any helper processes like
184 185
    gdbserver are referred to as 'Engine', whereas the debugged process
    is referred to as 'Inferior'.
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 288 289 290 291 292 293 294 295 296 297 298 299 300 301

    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
302

303 304 305
/* 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
306

307 308 309 310 311 312
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" ];
313
sg1:   InferiorSetupRequested -> InferiorSetupOk [ label="notifyInferiorSetupOk", style="dashed" ];
314
sg1:   InferiorSetupRequested -> InferiorSetupFailed [ label="notifyInferiorFailed", style="dashed" ];
315
sg1:   InferiorSetupOk -> EngineRunRequested
316 317 318 319 320 321 322 323 324 325 326 327 328 329
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
330 331
sg1:   InferiorStopOk -> InferiorShutdownRequested [ label="Close event" ];
sg1:   InferiorUnrunnable -> InferiorShutdownRequested [ label="Close event" ];
332 333
sg1:   InferiorShutdownRequested -> InferiorShutdownOk [ label= "Engine::shutdownInferior\nnotifyInferiorShutdownOk", style="dashed" ];
sg1:   InferiorShutdownRequested -> InferiorShutdownFailed [ label="Engine::shutdownInferior\nnotifyInferiorShutdownFailed", style="dashed" ];
334 335
sg1:   InferiorExited -> InferiorExitOk [ label="notifyInferiorExited", style="dashed"];
sg1:   InferiorExitOk -> InferiorShutdownOk
336 337 338 339 340 341 342 343
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
344
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
345 346


347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
/*!
    \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}
369 370 371



372 373 374 375 376 377 378 379 380 381 382
                GdbEngine::setupInferior()
                          +
            (calls *Adapter->prepareInferior())
                          |      |
                          |      `---> handlePrepareInferiorFailed()
                          |                   +
                          |             {notifyInferiorSetupFailed}
                          |
                handleInferiorPrepared()
                          +
                {notifyInferiorSetupOk}
383

384
\endcode */
385

con's avatar
con committed
386
using namespace Core;
hjk's avatar
hjk committed
387
using namespace Debugger::Constants;
388
using namespace ExtensionSystem;
con's avatar
con committed
389
using namespace ProjectExplorer;
hjk's avatar
hjk committed
390
using namespace TextEditor;
391
using namespace Utils;
con's avatar
con committed
392

hjk's avatar
hjk committed
393 394 395
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
396 397

namespace Debugger {
398 399
namespace Internal {

400 401 402 403 404 405 406 407 408 409 410 411 412
// To be passed through margin menu action's data
struct BreakpointMenuContextData : public ContextData
{
    enum Mode
    {
        Breakpoint,
        MessageTracePoint
    };

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

413 414 415 416 417 418 419 420 421 422 423
struct TestCallBack
{
    TestCallBack() : receiver(0), slot(0) {}
    TestCallBack(QObject *ob, const char *s) : receiver(ob), slot(s) {}

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


424 425 426 427
} // namespace Internal
} // namespace Debugger

Q_DECLARE_METATYPE(Debugger::Internal::BreakpointMenuContextData)
428 429
Q_DECLARE_METATYPE(Debugger::Internal::TestCallBack)

430 431 432 433

namespace Debugger {
namespace Internal {

434 435 436 437 438 439
// 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.

440
void addCdbOptionPages(QList<IOptionsPage*> *opts);
441 442 443
void addGdbOptionPages(QList<IOptionsPage*> *opts);
void addScriptOptionPages(QList<IOptionsPage*> *opts);
void addTcfOptionPages(QList<IOptionsPage*> *opts);
444

445 446 447 448
#ifdef WITH_LLDB
void addLldbOptionPages(QList<IOptionsPage*> *opts);
#endif

hjk's avatar
hjk committed
449
static SessionManager *sessionManager()
450
{
hjk's avatar
hjk committed
451
    return ProjectExplorerPlugin::instance()->session();
452 453
}

454 455 456 457 458 459 460
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

Orgad Shaneh's avatar
Orgad Shaneh committed
461
static void setProxyAction(ProxyAction *proxy, Core::Id id)
462
{
hjk's avatar
hjk committed
463
    proxy->setAction(ActionManager::command(id)->action());
464 465
}

Orgad Shaneh's avatar
Orgad Shaneh committed
466
static QToolButton *toolButton(Core::Id id)
467
{
hjk's avatar
hjk committed
468
    return toolButton(ActionManager::command(id)->action());
469 470
}

471 472 473 474 475 476 477 478 479 480 481
///////////////////////////////////////////////////////////////////////
//
// DummyEngine
//
///////////////////////////////////////////////////////////////////////

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
482
    DummyEngine() : DebuggerEngine(DebuggerStartParameters()) {}
483 484 485 486 487 488 489
    ~DummyEngine() {}

    void setupEngine() {}
    void setupInferior() {}
    void runEngine() {}
    void shutdownEngine() {}
    void shutdownInferior() {}
490
    bool hasCapability(unsigned cap) const;
491
    bool acceptsBreakpoint(BreakpointModelId) const { return false; }
492
    bool acceptsDebuggerCommands() const { return false; }
hjk's avatar
hjk committed
493
    void selectThread(ThreadId) {}
494 495
};

496
bool DummyEngine::hasCapability(unsigned cap) const
497 498
{
    // This can only be a first approximation of what to expect when running.
499
    Project *project = ProjectExplorerPlugin::currentProject();
500 501 502 503 504 505 506 507
    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:
508
    if (activeRc->debuggerAspect()->useCppDebugger())
509
        return cap & (WatchpointByAddressCapability
510 511
               | BreakConditionCapability
               | TracePointCapability
512
               | OperateByInstructionCapability);
513 514

    // This is a Qml or unknown engine.
515
    return cap & AddWatcherCapability;
516 517
}

518 519 520 521 522 523
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

524
class DebugMode : public IMode
hjk's avatar
hjk committed
525 526
{
public:
527 528 529 530
    DebugMode()
    {
        setObjectName(QLatin1String("DebugMode"));
        setContext(Context(CC::C_EDITORMANAGER, C_DEBUGMODE, CC::C_NAVIGATION_PANE));
531 532
        setDisplayName(DebuggerPlugin::tr("Debug"));
        setIcon(QIcon(QLatin1String(":/fancyactionbar/images/mode_Debug.png")));
533
        setPriority(85);
534 535
        setId(MODE_DEBUG);
        setType(CC::MODE_EDIT_TYPE);
536
    }
hjk's avatar
hjk committed
537

hjk's avatar
hjk committed
538 539 540 541 542 543
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        //EditorManager::instance()->setParent(0);
        delete m_widget;
    }
544
};
hjk's avatar
hjk committed
545

546 547 548 549 550 551
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

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

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

private:
    const QList<Abi> m_abis;
};

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

private:
    const QList<Abi> m_abis;
};

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

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

Tobias Hunger's avatar
Tobias Hunger committed
612
    // Find a CDB kit for debugging unknown processes.
613
    // On a 64bit OS, prefer a 64bit debugger.
Tobias Hunger's avatar
Tobias Hunger committed
614
    static Kit *findUniversalCdbKit()
615 616 617 618
    {
#ifdef Q_OS_WIN
        if (Utils::winIs64BitSystem()) {
            CdbMatcher matcher64(64);
Tobias Hunger's avatar
Tobias Hunger committed
619 620
            if (Kit *cdb64Kit = KitManager::instance()->find(&matcher64))
                return cdb64Kit;
621 622 623
        }
#endif
        CdbMatcher matcher;
Tobias Hunger's avatar
Tobias Hunger committed
624
        return KitManager::instance()->find(&matcher);
625 626 627 628 629 630
    }

private:
    const char m_wordWidth;
};

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

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

Tobias Hunger's avatar
Tobias Hunger committed
687
    ToolChain *tc = ToolChainKitInformation::toolChain(kit);
hjk's avatar
hjk committed
688 689
    if (tc)
        sp->toolChainAbi = tc->targetAbi();
690

Tobias Hunger's avatar
Tobias Hunger committed
691
    IDevice::ConstPtr device = DeviceKitInformation::device(kit);
692 693
    if (device) {
        sp->connParams = device->sshParameters();
694
        sp->remoteChannel = sp->connParams.host + QLatin1Char(':') + QString::number(sp->connParams.port);
695
    }
696
    return true;
hjk's avatar
hjk committed
697 698
}

699
static TextEditor::ITextEditor *currentTextEditor()
700
{
hjk's avatar
hjk committed
701
    return qobject_cast<TextEditor::ITextEditor *>(EditorManager::currentEditor());
702
}
con's avatar
con committed
703

704 705
static bool currentTextEditorPosition(ContextData *data)
{
706 707 708
    TextEditor::ITextEditor *textEditor = currentTextEditor();
    if (!textEditor)
        return false;
hjk's avatar
hjk committed
709
    const IDocument *document = textEditor->document();
710 711
    QTC_ASSERT(document, return false);
    data->fileName = document->fileName();
712 713 714 715 716 717 718
    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();
719
    }
720
    return true;
721
}
722

723 724
///////////////////////////////////////////////////////////////////////
//
725
// DebuggerPluginPrivate
726 727
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
728

729
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
730

731 732 733 734 735 736 737 738 739 740 741 742 743 744
/*!
    \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.
*/

745
class DebuggerPluginPrivate : public DebuggerCore
746 747
{
    Q_OBJECT
748

749 750
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
751
    ~DebuggerPluginPrivate();
752

753
    bool initialize(const QStringList &arguments, QString *errorMessage);
754 755 756
    void extensionsInitialized();
    void aboutToShutdown();

757
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
758
    void disconnectEngine() { connectEngine(0); }
759
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
760
    DebuggerEngine *dummyEngine();
761

762 763 764 765 766 767 768 769 770 771
    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);
    }

772
public slots:
773 774 775 776 777 778
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

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

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

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

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

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

843
    void updateWatchersHeader(int section, int, int newSize)
844 845
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
846
        m_returnWindow->header()->resizeSection(section, newSize);
847
    }
848

849

850
    void sourceFilesDockToggled(bool on)
851
    {
852
        if (on && m_currentEngine->state() == InferiorStopOk)
853 854 855
            m_currentEngine->reloadSourceFiles();
    }

856
    void modulesDockToggled(bool on)
857
    {
858
        if (on && m_currentEngine->state() == InferiorStopOk)
859 860
            m_currentEngine->reloadModules();
    }
861

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

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

hjk's avatar
hjk committed
877 878 879
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
880
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
881
                engine->watchHandler()->updateWatchers();
hjk's avatar
hjk committed
882 883 884
        }
    }

885
    void editorOpened(Core::IEditor *editor);
886
    void updateBreakMenuItem(Core::IEditor *editor);
887
    void setBusyCursor(bool busy);
888 889 890
    void requestMark(TextEditor::ITextEditor *editor,
                     int lineNumber,
                     TextEditor::ITextEditor::MarkRequestKind kind);
891 892
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
893

894 895 896
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
897 898 899 900
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber,
                                       const QString &tracePointMessage = QString());
    void toggleBreakpointByAddress(quint64 address,
                                   const QString &tracePointMessage = QString());
901
    void onModeChanged(Core::IMode *mode);
902
    void onCoreAboutToOpen();
903
    void showSettingsDialog();
904
    void updateDebugWithoutDeployMenu();
905

906
    void debugProject();
907
    void debugProjectWithoutDeploy();
908
    void debugProjectBreakMain();
909
    void startAndDebugApplication();
910
    void startRemoteCdbSession();
911
    void startRemoteServer();
912
    void attachToRemoteServer();
913
    void attachToProcess(bool startServerOnly);
hjk's avatar
hjk committed
914
    void attachToRunningApplication();
915
    void attachExternalApplication(ProjectExplorer::RunControl *rc);
916
    void attachToQmlPort();
917
    void startRemoteEngine();
918
    void runScheduled();
919
    void attachCore();
920

921
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
922
    void languagesChanged();
923
    void showStatusMessage(const QString &msg, int timeout = -1);
924
    void openMemoryEditor();
925

926 927
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

hjk's avatar
hjk committed
928
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
929
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
930
        { return mainWindow()->isDockVisible(objectName); }
931 932

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

935 936
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
937 938 939 940
    DebuggerLanguages activeLanguages() const;
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
941

942 943 944 945 946
    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;
947

948
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
949 950 951

    void dumpLog();
    void cleanupViews();
952
    void setInitialState();
953 954 955 956

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

    void updateState(DebuggerEngine *engine);
hjk's avatar
hjk committed
957
    void updateWatchersWindow(bool showWatch, bool showReturn);