gdbengine.h 18.9 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
5
** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
9
** Commercial Usage
10
**
11 12 13 14
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
15
**
16
** GNU Lesser General Public License Usage
17
**
18 19 20 21 22 23
** 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.
24
**
25
** If you are unsure which license is appropriate for your use, please
hjk's avatar
hjk committed
26
** contact the sales department at http://qt.nokia.com/contact.
con's avatar
con committed
27
**
28
**************************************************************************/
hjk's avatar
hjk committed
29

con's avatar
con committed
30 31 32
#ifndef DEBUGGER_GDBENGINE_H
#define DEBUGGER_GDBENGINE_H

33
#include "idebuggerengine.h"
hjk's avatar
hjk committed
34
#include "debuggermanager.h" // only for StartParameters
35
#include "gdbmi.h"
36
#include "watchutils.h"
37

con's avatar
con committed
38 39 40 41 42 43
#include <QtCore/QByteArray>
#include <QtCore/QHash>
#include <QtCore/QMap>
#include <QtCore/QObject>
#include <QtCore/QProcess>
#include <QtCore/QPoint>
hjk's avatar
hjk committed
44
#include <QtCore/QSet>
45
#include <QtCore/QTextCodec>
46
#include <QtCore/QTime>
con's avatar
con committed
47 48 49 50
#include <QtCore/QVariant>

QT_BEGIN_NAMESPACE
class QAbstractItemModel;
51 52 53
class QAction;
class QMainWindow;
class QMessageBox;
54
class QTimer;
con's avatar
con committed
55 56 57 58
class QWidget;
QT_END_NAMESPACE

namespace Debugger {
59
class DebuggerManager;
con's avatar
con committed
60 61
namespace Internal {

hjk's avatar
hjk committed
62
class AbstractGdbAdapter;
hjk's avatar
hjk committed
63
class GdbResponse;
con's avatar
con committed
64 65 66
class GdbMi;

class BreakpointData;
67
class WatchData;
con's avatar
con committed
68

69 70
class AttachGdbAdapter;
class CoreGdbAdapter;
71 72
class PlainGdbAdapter;
class RemoteGdbAdapter;
73
class TrkGdbAdapter;
74
struct TrkOptions;
75

76
enum DebuggingHelperState
con's avatar
con committed
77
{
78 79 80 81
    DebuggingHelperUninitialized,
    DebuggingHelperLoadTried,
    DebuggingHelperAvailable,
    DebuggingHelperUnavailable,
con's avatar
con committed
82 83 84 85 86 87 88
};

class GdbEngine : public IDebuggerEngine
{
    Q_OBJECT

public:
hjk's avatar
hjk committed
89
    explicit GdbEngine(DebuggerManager *manager);
con's avatar
con committed
90 91 92
    ~GdbEngine();

private:
93
    friend class AbstractGdbAdapter;
94 95
    friend class AttachGdbAdapter;
    friend class CoreGdbAdapter;
hjk's avatar
hjk committed
96
    friend class PlainGdbAdapter;
97
    friend class TermGdbAdapter;
98
    friend class RemoteGdbAdapter;
99
    friend class TrkGdbAdapter;
hjk's avatar
hjk committed
100

101
private: ////////// General Interface //////////
con's avatar
con committed
102

103
    virtual void addOptionPages(QList<Core::IOptionsPage*> *opts) const;
con's avatar
con committed
104

105 106
    virtual bool checkConfiguration(int toolChain, QString *errorMessage, QString *settingsPage= 0) const;
    virtual void startDebugger(const DebuggerStartParametersPtr &sp);
107
    virtual unsigned debuggerCapabilities() const;
108 109 110
    virtual void exitDebugger();
    virtual void detachDebugger();
    virtual void shutdown();
con's avatar
con committed
111

112
    virtual void executeDebuggerCommand(const QString &command);
113
    virtual QString qtNamespace() const { return m_dumperHelper.qtNamespace(); }
con's avatar
con committed
114

115
private: ////////// General State //////////
con's avatar
con committed
116

117 118 119 120 121
    void initializeVariables();
    DebuggerStartMode startMode() const;
    const DebuggerStartParameters &startParameters() const
        { return *m_startParameters; }
    Q_SLOT void setAutoDerefPointers(const QVariant &on);
122

123 124
    DebuggerStartParametersPtr m_startParameters;
    QSharedPointer<TrkOptions> m_trkOptions;
125
    bool m_registerNamesListed;
126

127
private: ////////// Gdb Process Management //////////
128

129 130
    AbstractGdbAdapter *createAdapter(const DebuggerStartParametersPtr &dp);
    void connectAdapter();
131 132 133
    bool startGdb(const QStringList &args = QStringList(),
                  const QString &gdb = QString(),
                  const QString &settingsIdHint = QString());
134
    void startInferiorPhase2();
135

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
136 137 138
    void handleInferiorShutdown(const GdbResponse &response);
    void handleGdbExit(const GdbResponse &response);

139 140 141 142
    void showDebuggerInput(int channel, const QString &msg)
        { m_manager->showDebuggerInput(channel, msg); }
    void showDebuggerOutput(int channel, const QString &msg)
        { m_manager->showDebuggerOutput(channel, msg); }
143

144
private slots:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
145 146
    void handleGdbFinished(int, QProcess::ExitStatus status);
    void handleGdbError(QProcess::ProcessError error);
147 148 149
    void readGdbStandardOutput();
    void readGdbStandardError();
    void readDebugeeOutput(const QByteArray &data);
con's avatar
con committed
150

151 152
    void handleAdapterStarted();
    void handleAdapterStartFailed(const QString &msg, const QString &settingsIdHint = QString());
con's avatar
con committed
153

154 155
    void handleInferiorPrepared();

156 157 158
    void handleInferiorStartFailed(const QString &msg);

    void handleAdapterCrashed(const QString &msg);
con's avatar
con committed
159

160 161 162 163 164
private:
    QTextCodec *m_outputCodec;
    QTextCodec::ConverterState m_outputCodecState;

    QByteArray m_inbuffer;
165
    bool m_busy;
con's avatar
con committed
166

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
167
    QProcess m_gdbProc;
168 169 170 171 172
    AbstractGdbAdapter *m_gdbAdapter;

private: ////////// Gdb Command Management //////////

    public: // otherwise the Qt flag macros are unhappy
173 174
    enum GdbCommandFlag {
        NoFlags = 0,
175 176 177
        NeedsStop = 1,    // The command needs a stopped inferior
        Discardable = 2,  // No need to wait for the reply before continuing inferior
        RebuildModel = 4, // Trigger model rebuild when no such commands are pending any more
178
        WatchUpdate = Discardable | RebuildModel,
179
        NonCriticalResponse = 8,  // We can live without recieving an answer
180 181 182
        RunRequest = 16,  // Callback expects GdbResultRunning instead of GdbResultDone
        ExitRequest = 32, // Callback expects GdbResultExit instead of GdbResultDone
        LosesChild = 64   // Auto-set inferior shutdown related states
183 184
    };
    Q_DECLARE_FLAGS(GdbCommandFlags, GdbCommandFlag)
185
    private:
186

hjk's avatar
hjk committed
187
    typedef void (GdbEngine::*GdbCommandCallback)
hjk's avatar
hjk committed
188
        (const GdbResponse &response);
hjk's avatar
hjk committed
189
    typedef void (AbstractGdbAdapter::*AdapterCallback)
hjk's avatar
hjk committed
190
        (const GdbResponse &response);
191 192 193

    struct GdbCommand
    {
hjk's avatar
hjk committed
194 195 196
        GdbCommand()
            : flags(0), callback(0), adapterCallback(0), callbackName(0)
        {}
197 198 199

        int flags;
        GdbCommandCallback callback;
hjk's avatar
hjk committed
200
        AdapterCallback adapterCallback;
201
        const char *callbackName;
202
        QByteArray command;
203
        QVariant cookie;
204
        QTime postTime;
205 206
    };

con's avatar
con committed
207 208
    // type and cookie are sender-internal data, opaque for the "event
    // queue". resultNeeded == true increments m_pendingResults on
hjk's avatar
hjk committed
209
    // send and decrements on receipt, effectively preventing
con's avatar
con committed
210
    // watch model updates before everything is finished.
hjk's avatar
hjk committed
211
    void flushCommand(const GdbCommand &cmd);
212
    void postCommand(const QByteArray &command,
213 214 215 216
                     GdbCommandFlags flags,
                     GdbCommandCallback callback = 0,
                     const char *callbackName = 0,
                     const QVariant &cookie = QVariant());
217
    void postCommand(const QByteArray &command,
218 219 220
                     GdbCommandCallback callback = 0,
                     const char *callbackName = 0,
                     const QVariant &cookie = QVariant());
221
    void postCommand(const QByteArray &command,
hjk's avatar
hjk committed
222 223 224
                     AdapterCallback callback,
                     const char *callbackName,
                     const QVariant &cookie = QVariant());
225
    void postCommand(const QByteArray &command,
226 227 228 229
                     GdbCommandFlags flags,
                     AdapterCallback callback,
                     const char *callbackName,
                     const QVariant &cookie = QVariant());
hjk's avatar
hjk committed
230
    void postCommandHelper(const GdbCommand &cmd);
231
    void flushQueuedCommands();
232
    Q_SLOT void commandTimeout();
con's avatar
con committed
233 234
    void setTokenBarrier();

235
    QHash<int, GdbCommand> m_cookieForToken;
236
    int commandTimeoutTime() const;
237
    QTimer *m_commandTimer;
con's avatar
con committed
238

239 240
    QByteArray m_pendingConsoleStreamOutput;
    QByteArray m_pendingLogStreamOutput;
241

242 243 244 245
    // contains the first token number for the current round
    // of evaluation. Responses with older tokens are considers
    // out of date and discarded.
    int m_oldestAcceptableToken;
con's avatar
con committed
246

247
    int m_pendingRequests; // Watch updating commands in flight
hjk's avatar
hjk committed
248

249 250 251
    typedef void (GdbEngine::*CommandsDoneCallback)();
    // function called after all previous responses have been received
    CommandsDoneCallback m_commandsDoneCallback;
hjk's avatar
hjk committed
252

253
    QList<GdbCommand> m_commandsToRunOnTemporaryBreak;
hjk's avatar
hjk committed
254
    int gdbVersion() const { return m_gdbVersion; }
255 256

private: ////////// Gdb Output, State & Capability Handling //////////
hjk's avatar
hjk committed
257

258
    void handleResponse(const QByteArray &buff);
259
    void handleStopResponse(const GdbMi &data);
260
    void handleResultRecord(GdbResponse *response);
hjk's avatar
hjk committed
261
    void handleStop1(const GdbResponse &response);
262
    void handleStop1(const GdbMi &data);
263 264
    StackFrame parseStackFrame(const GdbMi &mi, int level);

hjk's avatar
hjk committed
265
    bool isSynchroneous() const { return hasPython(); }
266
    virtual bool hasPython() const;
267 268 269
    bool supportsThreads() const;

    // Gdb initialization sequence
hjk's avatar
hjk committed
270
    void handleShowVersion(const GdbResponse &response);
271
    void handleHasPython(const GdbResponse &response);
con's avatar
con committed
272

273
    int m_gdbVersion; // 6.8.0 is 60800
274
    int m_gdbBuildVersion; // MAC only?
275
    bool m_isMacGdb;
276
    bool m_hasPython;
hjk's avatar
hjk committed
277

278
private: ////////// Inferior Management //////////
279

280
    // This should be always the last call in a function.
281
    Q_SLOT virtual void attemptBreakpointSynchronization();
282

283 284 285 286 287
    virtual void stepExec();
    virtual void stepOutExec();
    virtual void nextExec();
    virtual void stepIExec();
    virtual void nextIExec();
con's avatar
con committed
288

289 290 291 292
    void continueInferiorInternal();
    void autoContinueInferior();
    virtual void continueInferior();
    virtual void interruptInferior();
293
    void interruptInferiorTemporarily();
con's avatar
con committed
294

295 296 297 298
    virtual void runToLineExec(const QString &fileName, int lineNumber);
    virtual void runToFunctionExec(const QString &functionName);
//    void handleExecRunToFunction(const GdbResponse &response);
    virtual void jumpToLineExec(const QString &fileName, int lineNumber);
con's avatar
con committed
299

300
    void handleExecContinue(const GdbResponse &response);
301 302
    void handleExecStep(const GdbResponse &response);
    void handleExecNext(const GdbResponse &response);
con's avatar
con committed
303

304 305 306
    qint64 inferiorPid() const { return m_manager->inferiorPid(); }
    void handleInferiorPidChanged(qint64 pid) { manager()->notifyInferiorPidChanged(pid); }
    void maybeHandleInferiorPidChanged(const QString &pid);
con's avatar
con committed
307

308
#ifdef Q_OS_LINUX
309 310
    void handleInfoProc(const GdbResponse &response);

311 312 313
    QByteArray m_entryPoint;
#endif

314 315 316 317 318 319
private: ////////// View & Data Stuff //////////

    virtual void selectThread(int index);
    virtual void activateFrame(int index);

    void gotoLocation(const StackFrame &frame, bool setLocationMarker);
con's avatar
con committed
320 321 322 323

    //
    // Breakpoint specific stuff
    //
hjk's avatar
hjk committed
324
    void handleBreakList(const GdbResponse &response);
con's avatar
con committed
325
    void handleBreakList(const GdbMi &table);
hjk's avatar
hjk committed
326 327 328 329 330
    void handleBreakIgnore(const GdbResponse &response);
    void handleBreakInsert(const GdbResponse &response);
    void handleBreakInsert1(const GdbResponse &response);
    void handleBreakCondition(const GdbResponse &response);
    void handleBreakInfo(const GdbResponse &response);
con's avatar
con committed
331 332 333
    void extractDataFromInfoBreak(const QString &output, BreakpointData *data);
    void breakpointDataFromOutput(BreakpointData *data, const GdbMi &bkpt);
    void sendInsertBreakpoint(int index);
334
    QString breakLocation(const QString &file) const;
335
    void reloadBreakListInternal();
con's avatar
con committed
336 337 338 339

    //
    // Modules specific stuff
    //
340 341 342
    virtual void loadSymbols(const QString &moduleName);
    virtual void loadAllSymbols();
    virtual QList<Symbol> moduleSymbols(const QString &moduleName);
343
    virtual void reloadModules();
344
    void reloadModulesInternal();
hjk's avatar
hjk committed
345
    void handleModulesList(const GdbResponse &response);
con's avatar
con committed
346

347
    bool m_modulesListOutdated;
con's avatar
con committed
348

349 350 351 352 353 354 355 356 357
    //
    // Snapshot specific stuff
    //
    virtual void makeSnapshot();
    void handleMakeSnapshot(const GdbResponse &response);
    void handleActivateSnapshot(const GdbResponse &response);
    void activateSnapshot(int index);
    void activateSnapshot2();

con's avatar
con committed
358 359
    //
    // Register specific stuff
hjk's avatar
hjk committed
360
    //
361 362
    Q_SLOT virtual void reloadRegisters();
    virtual void setRegisterValue(int nr, const QString &value);
hjk's avatar
hjk committed
363 364
    void handleRegisterListNames(const GdbResponse &response);
    void handleRegisterListValues(const GdbResponse &response);
con's avatar
con committed
365

366 367 368
    //
    // Disassembler specific stuff
    //
369
    virtual void fetchDisassembler(DisassemblerViewAgent *agent);
370 371
    void fetchDisassemblerByAddress(DisassemblerViewAgent *agent,
        bool useMixedMode);
372 373 374 375
    void fetchDisassemblerByCli(DisassemblerViewAgent *agent,
        bool useMixedMode);
    void fetchDisassemblerByAddressCli(DisassemblerViewAgent *agent);
    void handleFetchDisassemblerByCli(const GdbResponse &response);
376 377 378 379 380
    void handleFetchDisassemblerByLine(const GdbResponse &response);
    void handleFetchDisassemblerByAddress1(const GdbResponse &response);
    void handleFetchDisassemblerByAddress0(const GdbResponse &response);
    QString parseDisassembler(const GdbMi &lines);

381 382
    //
    // Source file specific stuff
hjk's avatar
hjk committed
383
    //
384
    virtual void reloadSourceFiles();
385
    void reloadSourceFilesInternal();
386 387 388
    void handleQuerySources(const GdbResponse &response);

    QString fullName(const QString &fileName);
389 390 391 392 393
#ifdef Q_OS_WIN
    QString cleanupFullName(const QString &fileName);
#else
    QString cleanupFullName(const QString &fileName) { return fileName; }
#endif
394 395 396 397

    // awful hack to keep track of used files
    QMap<QString, QString> m_shortToFullName;
    QMap<QString, QString> m_fullToShortName;
con's avatar
con committed
398

399
    void invalidateSourcesList();
400 401
    bool m_sourcesListOutdated;
    bool m_sourcesListUpdating;
402 403
    bool m_breakListOutdated;
    bool m_breakListUpdating;
404

con's avatar
con committed
405 406
    //
    // Stack specific stuff
hjk's avatar
hjk committed
407
    //
408
    void updateAll();
409 410
        void updateAllClassic();
        void updateAllPython();
hjk's avatar
hjk committed
411 412 413
    void handleStackListFrames(const GdbResponse &response);
    void handleStackSelectThread(const GdbResponse &response);
    void handleStackListThreads(const GdbResponse &response);
hjk's avatar
hjk committed
414
    Q_SLOT void reloadStack(bool forceGotoLocation);
415
    Q_SLOT virtual void reloadFullStack();
416
    int currentFrame() const;
con's avatar
con committed
417

418 419
    QList<GdbMi> m_currentFunctionArgs;
    QString m_currentFrame;
con's avatar
con committed
420 421

    //
422
    // Watch specific stuff
hjk's avatar
hjk committed
423
    //
424
    virtual void setToolTipExpression(const QPoint &mousePos, TextEditor::ITextEditor *editor, int cursorPos);
con's avatar
con committed
425

426 427 428 429 430 431 432
    virtual void assignValueInDebugger(const QString &expr, const QString &value);

    virtual void fetchMemory(MemoryViewAgent *agent, quint64 addr, quint64 length);
    void handleFetchMemory(const GdbResponse &response);

    virtual void watchPoint(const QPoint &);
    void handleWatchPoint(const GdbResponse &response);
con's avatar
con committed
433 434

    // FIXME: BaseClass. called to improve situation for a watch item
435
    void updateSubItemClassic(const WatchData &data);
436 437
    void handleChildren(const WatchData &parent, const GdbMi &child,
        QList<WatchData> *insertions);
con's avatar
con committed
438

439
    void virtual updateWatchData(const WatchData &data);
440
    Q_SLOT void updateWatchDataHelper(const WatchData &data);
hjk's avatar
hjk committed
441
    void rebuildModel();
442
    bool showToolTip();
con's avatar
con committed
443 444 445

    void insertData(const WatchData &data);
    void sendWatchParameters(const QByteArray &params0);
446
    void createGdbVariableClassic(const WatchData &data);
con's avatar
con committed
447

448 449
    void runDebuggingHelperClassic(const WatchData &data, bool dumpChildren);
    void runDirectDebuggingHelperClassic(const WatchData &data, bool dumpChildren);
450
    bool hasDebuggingHelperForType(const QString &type) const;
con's avatar
con committed
451

452 453
    void handleVarListChildrenClassic(const GdbResponse &response);
    void handleVarListChildrenHelperClassic(const GdbMi &child,
454
        const WatchData &parent);
hjk's avatar
hjk committed
455 456
    void handleVarCreate(const GdbResponse &response);
    void handleVarAssign(const GdbResponse &response);
457
    void handleEvaluateExpressionClassic(const GdbResponse &response);
hjk's avatar
hjk committed
458
    //void handleToolTip(const GdbResponse &response);
459 460 461
    void handleQueryDebuggingHelperClassic(const GdbResponse &response);
    void handleDebuggingHelperValue2Classic(const GdbResponse &response);
    void handleDebuggingHelperValue3Classic(const GdbResponse &response);
hjk's avatar
hjk committed
462 463
    void handleDebuggingHelperEditValue(const GdbResponse &response);
    void handleDebuggingHelperSetup(const GdbResponse &response);
464 465

    void updateLocals(const QVariant &cookie = QVariant());
466 467 468
        void updateLocalsClassic(const QVariant &cookie);
        void updateLocalsPython(const QByteArray &varList);
            void handleStackFramePython(const GdbResponse &response);
469

470 471 472
    void handleStackListLocalsClassic(const GdbResponse &response);
    void handleStackListLocalsPython(const GdbResponse &response);

473 474 475 476
    WatchData localVariable(const GdbMi &item,
                            const QStringList &uninitializedVariables,
                            QMap<QByteArray, int> *seen);
    void setLocals(const QList<GdbMi> &locals);
477
    void handleStackListArgumentsClassic(const GdbResponse &response);
con's avatar
con committed
478
    void setWatchDataType(WatchData &data, const GdbMi &mi);
479
    void setWatchDataDisplayedType(WatchData &data, const GdbMi &mi);
con's avatar
con committed
480

481
    QSet<QByteArray> m_processedNames;
con's avatar
con committed
482 483
    QMap<QString, QString> m_varToType;

484
private: ////////// Dumper Management //////////
485 486
    QString qtDumperLibraryName() const;
    bool checkDebuggingHelpers();
487 488 489 490 491
        bool checkDebuggingHelpersClassic();
    void setDebuggingHelperStateClassic(DebuggingHelperState);
    void tryLoadDebuggingHelpersClassic();
    void tryQueryDebuggingHelpersClassic();
    Q_SLOT void recheckDebuggingHelperAvailabilityClassic();
492 493
    void connectDebuggingHelperActions();
    void disconnectDebuggingHelperActions();
494
    Q_SLOT void setDebugDebuggingHelpersClassic(const QVariant &on);
495
    Q_SLOT void setUseDebuggingHelpers(const QVariant &on);
496

497 498
    DebuggingHelperState m_debuggingHelperState;
    QtDumperHelper m_dumperHelper;
499

500
private: ////////// Convenience Functions //////////
hjk's avatar
hjk committed
501

502
    QString errorMessage(QProcess::ProcessError error);
503 504
    QMessageBox *showMessageBox(int icon, const QString &title, const QString &text,
        int buttons = 0);
505
    void debugMessage(const QString &msg);
506
    QMainWindow *mainWindow() const;
507

508 509 510
    static QString m_toolTipExpression;
    static QPoint m_toolTipPos;
    static QByteArray tooltipINameForExpression(const QByteArray &exp);
511 512 513 514 515 516 517 518 519 520 521 522

    static void setWatchDataValue(WatchData &data, const GdbMi &mi,
        int encoding = 0);
    static void setWatchDataEditValue(WatchData &data, const GdbMi &mi);
    static void setWatchDataValueToolTip(WatchData &data, const GdbMi &mi,
            int encoding = 0);
    static void setWatchDataChildCount(WatchData &data, const GdbMi &mi);
    static void setWatchDataValueEnabled(WatchData &data, const GdbMi &mi);
    static void setWatchDataValueEditable(WatchData &data, const GdbMi &mi);
    static void setWatchDataExpression(WatchData &data, const GdbMi &mi);
    static void setWatchDataAddress(WatchData &data, const GdbMi &mi);
    static void setWatchDataSAddress(WatchData &data, const GdbMi &mi);
con's avatar
con committed
523 524 525 526 527
};

} // namespace Internal
} // namespace Debugger

528 529
Q_DECLARE_OPERATORS_FOR_FLAGS(Debugger::Internal::GdbEngine::GdbCommandFlags)

con's avatar
con committed
530
#endif // DEBUGGER_GDBENGINE_H