debuggerplugin.cpp 132 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
con's avatar
con committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
con's avatar
con committed
7
**
hjk's avatar
hjk committed
8 9 10 11 12
** 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
Eike Ziller's avatar
Eike Ziller committed
13 14
** conditions see http://www.qt.io/licensing.  For further information
** use the contact form at http://www.qt.io/contact-us.
15
**
16
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18 19 20 21 22 23
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
hjk's avatar
hjk committed
24 25 26
**
** 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
27 28
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
29
****************************************************************************/
hjk's avatar
hjk committed
30

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

Friedemann Kleint's avatar
Friedemann Kleint committed
33
#include "debuggerstartparameters.h"
34
#include "debuggeractions.h"
35
#include "debuggerinternalconstants.h"
36
#include "debuggercore.h"
37
#include "debuggerkitconfigwidget.h"
38 39
#include "debuggerdialogs.h"
#include "debuggerengine.h"
40
#include "debuggeritemmanager.h"
41
#include "debuggermainwindow.h"
con's avatar
con committed
42
#include "debuggerrunner.h"
43
#include "debuggerrunconfigurationaspect.h"
44
#include "debuggerruncontrolfactory.h"
45
#include "debuggerstringutils.h"
46
#include "debuggeroptionspage.h"
Tobias Hunger's avatar
Tobias Hunger committed
47
#include "debuggerkitinformation.h"
48
#include "memoryagent.h"
49
#include "breakhandler.h"
50
#include "breakwindow.h"
51
#include "disassemblerlines.h"
52
#include "logwindow.h"
53
#include "moduleswindow.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
54
#include "moduleshandler.h"
55 56
#include "registerwindow.h"
#include "snapshotwindow.h"
hjk's avatar
hjk committed
57
#include "stackhandler.h"
58 59 60
#include "stackwindow.h"
#include "sourcefileswindow.h"
#include "threadswindow.h"
hjk's avatar
hjk committed
61
#include "watchhandler.h"
62
#include "watchwindow.h"
hjk's avatar
hjk committed
63
#include "watchutils.h"
64
#include "unstartedappwatcherdialog.h"
65
#include "debuggertooltipmanager.h"
66
#include "localsandexpressionswindow.h"
67
#include "loadcoredialog.h"
68
#include "sourceutils.h"
69
#include <debugger/shared/hostutils.h>
70

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

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

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

88
#include <extensionsystem/invoker.h>
89

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

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

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

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

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

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

140 141
#endif // WITH_TESTS

142 143
#include <climits>

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

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

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

/*!
    \class Debugger::DebuggerEngine

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

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

    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
289

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

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


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

    GdbEngine specific startup. All happens in EngineSetupRequested state:

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

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

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



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

374
\endcode */
375

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

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

con's avatar
con committed
386 387

namespace Debugger {
388 389
namespace Internal {

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

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

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

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


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

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

420 421 422 423

namespace Debugger {
namespace Internal {

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

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

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

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

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

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

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

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

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

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

503 504 505 506 507 508
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

528 529 530 531 532 533
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

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

Daniel Teske's avatar
Daniel Teske committed
542
    QWidget *widget = ItemViewFind::createSearchableWrapper(treeView);
543 544 545 546 547
    widget->setObjectName(QLatin1String(objectName));
    widget->setWindowTitle(title);
    return widget;
}

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

556
static std::function<bool(const Kit *)> cdbMatcher(char wordWidth = 0)
557
{
558
    return [wordWidth](const Kit *k) -> bool {
559 560
        if (DebuggerKitInformation::engineType(k) != CdbEngineType
            || !DebuggerKitInformation::isValidDebugger(k)) {
561
            return false;
562
        }
563
        if (wordWidth) {
564
            const ToolChain *tc = ToolChainKitInformation::toolChain(k);
565
            return tc && wordWidth == tc->targetAbi().wordWidth();
566
        }
567
        return true;
568 569
    };
}
570

571 572 573 574 575 576 577
// Find a CDB kit for debugging unknown processes.
// On a 64bit OS, prefer a 64bit debugger.
static Kit *findUniversalCdbKit()
{
    if (Utils::is64BitWindowsSystem()) {
        if (Kit *cdb64Kit = KitManager::find(cdbMatcher(64)))
            return cdb64Kit;
578
    }
579 580
    return KitManager::find(cdbMatcher());
}
581

582
bool fillParameters(DebuggerStartParameters *sp, const Kit *kit, QString *errorMessage /* = 0 */)
583
{
Tobias Hunger's avatar
Tobias Hunger committed
584
    if (!kit) {
585 586
        // 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
587
        // without specifying a kit. Try to find a kit via ABI.
588 589 590 591 592 593 594 595 596 597 598
        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));
599
        }
600
        if (!abis.isEmpty()) {
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
            // Try exact abis.
            kit = KitManager::find(std::function<bool (const Kit *)>([abis](const Kit *k) -> bool {
                if (const ToolChain *tc = ToolChainKitInformation::toolChain(k)) {
                    return abis.contains(tc->targetAbi())
                           && DebuggerKitInformation::isValidDebugger(k);
                }
                return false;
            }));
            if (!kit) {
                // Or something compatible.
                kit = KitManager::find(std::function<bool (const Kit *)>([abis](const Kit *k) -> bool {
                    if (const ToolChain *tc = ToolChainKitInformation::toolChain(k))
                        foreach (const Abi &a, abis)
                            if (a.isCompatibleWith(tc->targetAbi()) && DebuggerKitInformation::isValidDebugger(k))
                                return true;
                    return false;
                }));
            }
619
        }
Tobias Hunger's avatar
Tobias Hunger committed
620
        if (!kit)
621
            kit = KitManager::defaultKit();
622 623
    }

624 625 626 627 628 629 630
    // Verify that debugger and profile are valid
    if (!kit) {
        sp->startMode = NoStartMode;
        if (errorMessage)
            *errorMessage = DebuggerKitInformation::tr("No kit found.");
        return false;
    }
631 632
    // validate debugger if C++ debugging is enabled
    if (sp->languages & CppLanguage) {
hjk's avatar
hjk committed
633
        const QList<Task> tasks = DebuggerKitInformation::validateDebugger(kit);
634 635 636
        if (!tasks.isEmpty()) {
            sp->startMode = NoStartMode;
            if (errorMessage) {
hjk's avatar
hjk committed
637
                foreach (const Task &t, tasks) {
638 639 640 641
                    if (errorMessage->isEmpty())
                        errorMessage->append(QLatin1Char('\n'));
                    errorMessage->append(t.description);
                }
642
            }
643
            return false;
644 645 646
        }
    }
    sp->cppEngineType = DebuggerKitInformation::engineType(kit);
Tobias Hunger's avatar
Tobias Hunger committed
647 648
    sp->sysRoot = SysRootKitInformation::sysRoot(kit).toString();
    sp->debuggerCommand = DebuggerKitInformation::debuggerCommand(kit).toString();
649

Tobias Hunger's avatar
Tobias Hunger committed
650
    ToolChain *tc = ToolChainKitInformation::toolChain(kit);
hjk's avatar
hjk committed
651 652
    if (tc)
        sp->toolChainAbi = tc->targetAbi();
653

654 655 656
    sp->device = DeviceKitInformation::device(kit);
    if (sp->device) {
        sp->connParams = sp->device->sshParameters();
657 658 659
        // Could have been set from command line.
        if (sp->remoteChannel.isEmpty())
            sp->remoteChannel = sp->connParams.host + QLatin1Char(':') + QString::number(sp->connParams.port);
660
    }
661
    return true;
hjk's avatar
hjk committed
662 663
}

664 665
static bool currentTextEditorPosition(ContextData *data)
{
666
    BaseTextEditor *textEditor = BaseTextEditor::currentTextEditor();
667 668
    if (!textEditor)
        return false;
669
    const TextDocument *document = textEditor->textDocument();
670
    QTC_ASSERT(document, return false);
671
    data->fileName = document->filePath();
672
    if (document->property(Constants::OPENED_WITH_DISASSEMBLY).toBool()) {
673
        int lineNumber = textEditor->currentLine();
674
        QString line = textEditor->textDocument()->plainText()
675 676 677 678
            .section(QLatin1Char('\n'), lineNumber - 1, lineNumber - 1);
        data->address = DisassemblerLine::addressFromDisassemblyLine(line);
    } else {
        data->lineNumber = textEditor->currentLine();
679
    }
680
    return true;
681
}
682

683 684
///////////////////////////////////////////////////////////////////////
//
685
// DebuggerPluginPrivate
686 687
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
688

689
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
690

691 692 693 694 695 696 697 698 699 700 701 702 703 704
/*!
    \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.
*/

705
class DebuggerPluginPrivate : public DebuggerCore
706 707
{
    Q_OBJECT
708

709 710
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
711
    ~DebuggerPluginPrivate();
712

713
    bool initialize(const QStringList &arguments, QString *errorMessage);
714 715 716
    void extensionsInitialized();
    void aboutToShutdown();

717
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
718
    void disconnectEngine() { connectEngine(0); }
719
    DebuggerEngine *dummyEngine();
720

721 722 723 724 725 726 727 728 729
    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);
    }
730
    DebuggerRunControl *attachToRunningProcess(Kit *kit, DeviceProcessItem process);
731

732
public slots:
733 734 735 736 737 738
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

739 740
    void selectThread(int index)
    {
hjk's avatar
hjk committed
741 742
        ThreadId id = m_currentEngine->threadsHandler()->threadAt(index);
        m_currentEngine->selectThread(id);
743
    }
744

hjk's avatar
hjk committed
745
    void breakpointSetMarginActionTriggered()
746
    {
747 748
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
hjk's avatar
hjk committed
749 750
        const BreakpointMenuContextData data =
            action->data().value<BreakpointMenuContextData>();
751 752 753 754 755 756 757 758 759 760 761 762 763
        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
764
              & ~(Qt::WindowContextHelpButtonHint|Qt::MSWindowsFixedSizeDialogHint));
765 766 767 768 769 770 771 772
            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();
        }
773
        if (data.address)
774
            toggleBreakpointByAddress(data.address, message);
775
        else
776
            toggleBreakpointByFileAndLine(data.fileName, data.lineNumber, message);
777
    }
778

hjk's avatar
hjk committed
779
    void breakpointRemoveMarginActionTriggered()
780
    {
hjk's avatar
hjk committed
781 782
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
783
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
784
        m_breakHandler->removeBreakpoint(id);
hjk's avatar
hjk committed
785 786 787 788 789 790
     }

    void breakpointEnableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
791
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
792
        breakHandler()->setEnabled(id, true);
hjk's avatar
hjk committed
793 794 795 796 797 798
    }

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

803
    void updateWatchersHeader(int section, int, int newSize)
804
    {
805 806
        m_watchersView->header()->resizeSection(section, newSize);
        m_returnView->header()->resizeSection(section, newSize);
807
    }
808

809
    void sourceFilesDockToggled(bool on)
810
    {
811
        if (on && m_currentEngine->state() == InferiorStopOk)
812 813 814
            m_currentEngine->reloadSourceFiles();
    }

815
    void modulesDockToggled(bool on)
816
    {
817
        if (on && m_currentEngine->state() == InferiorStopOk)
818 819
            m_currentEngine->reloadModules();
    }
820

hjk's avatar
hjk committed
821
    void registerDockToggled(bool on)
822
    {
823
        if (on && m_currentEngine->state() == InferiorStopOk)
824 825
            m_currentEngine->reloadRegisters();
    }
826

827 828
    void synchronizeBreakpoints()
    {
829
        showMessage(QLatin1String("ATTEMPT SYNC"), LogDebug);
830
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
831
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
832 833 834 835
                engine->attemptBreakpointSynchronization();
        }
    }

836
    void editorOpened(Core::IEditor *editor);
837
    void updateBreakMenuItem(Core::IEditor *editor);
838
    void setBusyCursor(bool busy);
839
    void requestMark(TextEditor::TextEditorWidget *widget, int lineNumber,
840
                     TextEditor::TextMarkRequestKind kind);
841 842
    void requestContextMenu(TextEditor::TextEditorWidget *widget,
                            int lineNumber, QMenu *menu);
843

844 845 846
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
847 848 849 850
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber,
                                       const QString &tracePointMessage = QString());
    void toggleBreakpointByAddress(quint64 address,
                                   const QString &tracePointMessage = QString());
851
    void onModeChanged(Core::IMode *mode);
852
    void onCoreAboutToOpen();
853
    void showSettingsDialog();
854
    void updateDebugWithoutDeployMenu();
855

856
    void debugProject();
857
    void debugProjectWithoutDeploy();
858
    void debugProjectBreakMain();
859
    void startAndDebugApplication();
860
    void startRemoteCdbSession();
861
    void startRemoteServer();
862
    void attachToRemoteServer();
863
    void attachToProcess(bool startServerOnly);
hjk's avatar
hjk committed
864
    void attachToRunningApplication();
865 866 867
    void attachToUnstartedApplicationDialog();
    void attachToFoundProcess();
    void continueOnAttach(Debugger::DebuggerState state);
868
    void attachExternalApplication(ProjectExplorer::RunControl *rc);
869
    void attachToQmlPort();
870
    void runScheduled();
871
    void attachCore();
872

873
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
874
    void languagesChanged();
875
    void showStatusMessage(const QString &msg, int timeout = -1);
876
    void openMemoryEditor();
877

878 879
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

hjk's avatar
hjk committed
880
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
hjk's avatar
hjk committed
881

882
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
883 884 885 886
    {
        QDockWidget *dock = mainWindow()->findChild<QDockWidget *>(objectName);
        return dock && dock->toggleViewAction()->isChecked();
    }
887 888

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

891 892
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
893 894 895 896
    DebuggerLanguages activeLanguages() const;
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
897

898
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
899 900 901

    void dumpLog();
    void cleanupViews();
902
    void setInitialState();
903 904 905 906

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

    void updateState(DebuggerEngine *engine);
hjk's avatar
hjk committed
907
    void updateWatchersWindow(bool showWatch, bool showReturn);
908
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
909 910 911 912

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
913

914
    void coreShutdown();
915

hjk's avatar
hjk committed
916 917
#ifdef WITH_TESTS
public slots:
918
    void testLoadProject(const QString &proFile, const TestCallBack &cb);
hjk's avatar
hjk committed
919
    void testProjectLoaded(ProjectExplorer::Project *project);
920 921
    void testProjectEvaluated();
    void testProjectBuilt(bool success);
922 923 924 925
    void testUnloadProject();
    void testFinished();

    void testRunProject(const DebuggerStartParameters &sp, const TestCallBack &cb);
hjk's avatar
hjk committed
926
    void testRunControlFinished();
927

hjk's avatar
hjk committed
928 929 930
//    void testStateMachine1();
//    void testStateMachine2();
//    void testStateMachine3();
931

932 933
    void testBenchmark1();

</