debuggerplugin.cpp 132 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
con's avatar
con committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
con's avatar
con committed
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
15
**
16
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
hjk's avatar
hjk committed
29

con's avatar
con committed
30 31
#include "debuggerplugin.h"

Friedemann Kleint's avatar
Friedemann Kleint committed
32
#include "debuggerstartparameters.h"
33
#include "debuggeractions.h"
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
#include "sourceutils.h"
66

67 68
#include "snapshothandler.h"
#include "threadshandler.h"
69
#include "commonoptionspage.h"
70
#include "gdb/startgdbserverdialog.h"
con's avatar
con committed
71

72
#include <coreplugin/actionmanager/actionmanager.h>
73 74
#include <coreplugin/actionmanager/actioncontainer.h>
#include <coreplugin/actionmanager/command.h>
75
#include <coreplugin/id.h>
76
#include <coreplugin/imode.h>
con's avatar
con committed
77
#include <coreplugin/coreconstants.h>
78
#include <coreplugin/dialogs/ioptionspage.h>
con's avatar
con committed
79
#include <coreplugin/editormanager/editormanager.h>
hjk's avatar
hjk committed
80
#include <coreplugin/findplaceholder.h>
81
#include <coreplugin/icontext.h>
con's avatar
con committed
82
#include <coreplugin/icore.h>
83
#include <coreplugin/imode.h>
84
#include <coreplugin/icorelistener.h>
85
#include <coreplugin/messagemanager.h>
hjk's avatar
hjk committed
86
#include <coreplugin/minisplitter.h>
con's avatar
con committed
87
#include <coreplugin/modemanager.h>
hjk's avatar
hjk committed
88

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

92
#include <extensionsystem/pluginmanager.h>
93
#include <extensionsystem/invoker.h>
94

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

113
#include <qtsupport/qtsupportconstants.h>
114

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

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

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

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

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

155 156
#endif // WITH_TESTS

157 158
#include <climits>

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

169 170 171 172 173 174 175 176
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

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

/*!
    \class Debugger::DebuggerEngine

    \brief Base class of a debugger engine.

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

    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
304

305 306 307
/* 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
308

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


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



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

386
\endcode */
387

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

hjk's avatar
hjk committed
395 396 397
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
398 399

namespace Debugger {
400 401
namespace Internal {

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

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

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

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


426 427 428 429
} // namespace Internal
} // namespace Debugger

Q_DECLARE_METATYPE(Debugger::Internal::BreakpointMenuContextData)
430 431
Q_DECLARE_METATYPE(Debugger::Internal::TestCallBack)

432 433 434 435

namespace Debugger {
namespace Internal {

436 437 438 439 440 441
// 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.

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

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

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

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

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

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

473 474 475 476 477 478 479 480 481 482 483
///////////////////////////////////////////////////////////////////////
//
// DummyEngine
//
///////////////////////////////////////////////////////////////////////

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

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

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

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

520 521 522 523 524 525
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

548 549 550 551 552 553
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

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

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

private:
    const QList<Abi> m_abis;
};

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

private:
    const QList<Abi> m_abis;
};

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

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

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

private:
    const char m_wordWidth;
};

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

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

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

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

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

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

725 726
///////////////////////////////////////////////////////////////////////
//
727
// DebuggerPluginPrivate
728 729
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
730

731
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
732

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

747
class DebuggerPluginPrivate : public DebuggerCore
748 749
{
    Q_OBJECT
750

751 752
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
753
    ~DebuggerPluginPrivate();
754

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

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

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

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

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

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

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

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

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

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

851

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

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

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

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

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

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

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

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

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

928 929
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

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

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

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

    bool isReverseDebugging() const;
943

944 945 946 947 948
    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;
949

950
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
951 952 953

    void dumpLog();
    void cleanupViews();