debuggerplugin.cpp 130 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 162 163 164 165 166
#define DEBUG_STATE 1
#ifdef DEBUG_STATE
//#   define STATE_DEBUG(s)
//    do { QString msg; QTextStream ts(&msg); ts << s;
//      showMessage(msg, LogDebug); } while (0)
#   define STATE_DEBUG(s) do { qDebug() << s; } while(0)
#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 398 399 400 401 402

namespace Debugger {
namespace Constants {

} // namespace Constants


403 404
namespace Internal {

405 406 407 408 409 410 411 412 413 414 415 416 417
// To be passed through margin menu action's data
struct BreakpointMenuContextData : public ContextData
{
    enum Mode
    {
        Breakpoint,
        MessageTracePoint
    };

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

418 419 420 421 422 423 424 425 426 427 428
struct TestCallBack
{
    TestCallBack() : receiver(0), slot(0) {}
    TestCallBack(QObject *ob, const char *s) : receiver(ob), slot(s) {}

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


429 430 431 432
} // namespace Internal
} // namespace Debugger

Q_DECLARE_METATYPE(Debugger::Internal::BreakpointMenuContextData)
433 434
Q_DECLARE_METATYPE(Debugger::Internal::TestCallBack)

435 436 437 438

namespace Debugger {
namespace Internal {

439 440 441 442 443 444
// 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.

445
void addCdbOptionPages(QList<IOptionsPage*> *opts);
446 447 448
void addGdbOptionPages(QList<IOptionsPage*> *opts);
void addScriptOptionPages(QList<IOptionsPage*> *opts);
void addTcfOptionPages(QList<IOptionsPage*> *opts);
449

450 451 452 453
#ifdef WITH_LLDB
void addLldbOptionPages(QList<IOptionsPage*> *opts);
#endif

hjk's avatar
hjk committed
454
static SessionManager *sessionManager()
455
{
hjk's avatar
hjk committed
456
    return ProjectExplorerPlugin::instance()->session();
457 458
}

459 460 461 462 463 464 465
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

Orgad Shaneh's avatar
Orgad Shaneh committed
466
static void setProxyAction(ProxyAction *proxy, Core::Id id)
467
{
hjk's avatar
hjk committed
468
    proxy->setAction(ActionManager::command(id)->action());
469 470
}

Orgad Shaneh's avatar
Orgad Shaneh committed
471
static QToolButton *toolButton(Core::Id id)
472
{
hjk's avatar
hjk committed
473
    return toolButton(ActionManager::command(id)->action());
474 475
}

476 477 478 479 480 481 482 483 484 485 486
///////////////////////////////////////////////////////////////////////
//
// DummyEngine
//
///////////////////////////////////////////////////////////////////////

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
487
    DummyEngine() : DebuggerEngine(DebuggerStartParameters()) {}
488 489 490 491 492 493 494
    ~DummyEngine() {}

    void setupEngine() {}
    void setupInferior() {}
    void runEngine() {}
    void shutdownEngine() {}
    void shutdownInferior() {}
495
    bool hasCapability(unsigned cap) const;
496
    bool acceptsBreakpoint(BreakpointModelId) const { return false; }
497
    bool acceptsDebuggerCommands() const { return false; }
hjk's avatar
hjk committed
498
    void selectThread(ThreadId) {}
499 500
};

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

    // This is a Qml or unknown engine.
520
    return cap & AddWatcherCapability;
521 522
}

523 524 525 526 527 528
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

hjk's avatar
hjk committed
543 544 545 546 547 548
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        //EditorManager::instance()->setParent(0);
        delete m_widget;
    }
549
};
hjk's avatar
hjk committed
550

551 552 553 554 555 556
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

557 558 559 560 561 562 563 564
static inline QString executableForPid(qint64 pid)
{
    foreach (const ProjectExplorer::DeviceProcess &p, ProjectExplorer::DeviceProcessList::localProcesses())
        if (p.pid == pid)
            return p.exe;
    return QString();
}

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

private:
    const QList<Abi> m_abis;
};

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

private:
    const QList<Abi> m_abis;
};

Tobias Hunger's avatar
Tobias Hunger committed
599
class CdbMatcher : KitMatcher
hjk's avatar
hjk committed
600
{
601 602 603
public:
    CdbMatcher(char wordWidth = 0) : m_wordWidth(wordWidth) {}

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

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

private:
    const char m_wordWidth;
};

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

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

Tobias Hunger's avatar
Tobias Hunger committed
692
    ToolChain *tc = ToolChainKitInformation::toolChain(kit);
hjk's avatar
hjk committed
693 694
    if (tc)
        sp->toolChainAbi = tc->targetAbi();
695

Tobias Hunger's avatar
Tobias Hunger committed
696
    IDevice::ConstPtr device = DeviceKitInformation::device(kit);
697 698
    if (device) {
        sp->connParams = device->sshParameters();
699
        sp->remoteChannel = sp->connParams.host + QLatin1Char(':') + QString::number(sp->connParams.port);
700
    }
701
    return true;
hjk's avatar
hjk committed
702 703
}

704
static TextEditor::ITextEditor *currentTextEditor()
705
{
hjk's avatar
hjk committed
706
    return qobject_cast<TextEditor::ITextEditor *>(EditorManager::currentEditor());
707
}
con's avatar
con committed
708

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

728 729
///////////////////////////////////////////////////////////////////////
//
730
// DebuggerPluginPrivate
731 732
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
733

734
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
735

736 737 738 739 740 741 742 743 744 745 746 747 748 749
/*!
    \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.
*/

750
class DebuggerPluginPrivate : public DebuggerCore
751 752
{
    Q_OBJECT
753

754 755
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
756
    ~DebuggerPluginPrivate();
757

758
    bool initialize(const QStringList &arguments, QString *errorMessage);
759 760 761
    void extensionsInitialized();
    void aboutToShutdown();

762
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
763
    void disconnectEngine() { connectEngine(0); }
764
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
765
    DebuggerEngine *dummyEngine();
766

767 768 769 770 771 772 773 774 775 776
    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);
    }

777
public slots:
778 779 780 781 782 783
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

784 785
    void selectThread(int index)
    {
hjk's avatar
hjk committed
786 787
        ThreadId id = m_currentEngine->threadsHandler()->threadAt(index);
        m_currentEngine->selectThread(id);
788
    }
789

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

hjk's avatar
hjk committed
824
    void breakpointRemoveMarginActionTriggered()
825
    {
hjk's avatar
hjk committed
826 827
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
828
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
829
        m_breakHandler->removeBreakpoint(id);
hjk's avatar
hjk committed
830 831 832 833 834 835
     }

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

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

848
    void updateWatchersHeader(int section, int, int newSize)
849 850
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
851
        m_returnWindow->header()->resizeSection(section, newSize);
852
    }
853

854

855
    void sourceFilesDockToggled(bool on)
856
    {
857
        if (on && m_currentEngine->state() == InferiorStopOk)
858 859 860
            m_currentEngine->reloadSourceFiles();
    }

861
    void modulesDockToggled(bool on)
862
    {
863
        if (on && m_currentEngine->state() == InferiorStopOk)
864 865
            m_currentEngine->reloadModules();
    }
866

hjk's avatar
hjk committed
867
    void registerDockToggled(bool on)
868
    {
869
        if (on && m_currentEngine->state() == InferiorStopOk)
870 871
            m_currentEngine->reloadRegisters();
    }
872

873 874
    void synchronizeBreakpoints()
    {
875
        showMessage(QLatin1String("ATTEMPT SYNC"), LogDebug);
876
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
877
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
878 879 880 881
                engine->attemptBreakpointSynchronization();
        }
    }

hjk's avatar
hjk committed
882 883 884
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
885
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
886
                engine->watchHandler()->updateWatchers();
hjk's avatar
hjk committed
887 888 889
        }
    }

890
    void editorOpened(Core::IEditor *editor);
891
    void updateBreakMenuItem(Core::IEditor *editor);
892
    void setBusyCursor(bool busy);
893 894 895
    void requestMark(TextEditor::ITextEditor *editor,
                     int lineNumber,
                     TextEditor::ITextEditor::MarkRequestKind kind);
896 897
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
898

899 900 901
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
902 903 904 905
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber,
                                       const QString &tracePointMessage = QString());
    void toggleBreakpointByAddress(quint64 address,
                                   const QString &tracePointMessage = QString());
906
    void onModeChanged(Core::IMode *mode);
907
    void onCoreAboutToOpen();
908
    void showSettingsDialog();
909
    void updateDebugWithoutDeployMenu();
910

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

926
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
927
    void languagesChanged();
928
    void showStatusMessage(const QString &msg, int timeout = -1);
929
    void openMemoryEditor();
930

931 932
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

hjk's avatar
hjk committed
933
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
934
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
935
        { return mainWindow()->isDockVisible(objectName); }
936 937

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

940 941
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
942 943 944 945
    DebuggerLanguages activeLanguages() const;
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
946

947 948 949 950 951
    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;
952

953
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
954 955 956

    void dumpLog();
    void cleanupViews();
957
    void setInitialState();
958 959 960 961

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

    void updateState(DebuggerEngine *engine);
hjk's avatar
hjk committed
962
    void updateWatchersWindow(bool showWatch, bool showReturn);
963
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
964 965 966 967

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
968

969
    void executeDebuggerCommand(const QString &command, DebuggerLanguages languages);
970
    void coreShutdown();
971