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

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

Friedemann Kleint's avatar
Friedemann Kleint committed
32
#include "debuggerstartparameters.h"
33
#include "debuggeractions.h"
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>
hjk's avatar
hjk committed
85
#include <coreplugin/minisplitter.h>
con's avatar
con committed
86
#include <coreplugin/modemanager.h>
hjk's avatar
hjk committed
87

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

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

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

112
#include <qtsupport/qtsupportconstants.h>
113

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

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

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

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

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

154 155
#endif // WITH_TESTS

156 157
#include <climits>

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

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

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

/*!
    \class Debugger::DebuggerEngine

    \brief Base class of a debugger engine.

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

    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
303

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

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


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



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

385
\endcode */
386

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

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

con's avatar
con committed
397 398

namespace Debugger {
399 400
namespace Internal {

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

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

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

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


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

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

431 432 433 434

namespace Debugger {
namespace Internal {

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

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

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

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

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

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

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

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

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

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

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

519 520 521 522 523 524
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

547 548 549 550 551 552
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

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

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

private:
    const QList<Abi> m_abis;
};

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

private:
    const QList<Abi> m_abis;
};

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

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

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

private:
    const char m_wordWidth;
};

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

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

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

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

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

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

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

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

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

746
class DebuggerPluginPrivate : public DebuggerCore
747 748
{
    Q_OBJECT
749

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

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

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

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

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

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

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

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

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

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

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

850

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

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

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

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

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

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

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

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

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

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

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

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

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

    bool isReverseDebugging() const;
942

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

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

    void dumpLog();
    void cleanupViews();
953
    void setInitialState();