gdbengine.h 18.9 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2010 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 "debuggerengine.h"
34

35
#include "gdbmi.h"
ck's avatar
ck committed
36
#include "localgdbprocess.h"
37
#include "stackframe.h"
38
#include "watchutils.h"
39

con's avatar
con committed
40
#include <QtCore/QByteArray>
hjk's avatar
hjk committed
41
#include <QtCore/QFutureInterface>
con's avatar
con committed
42 43
#include <QtCore/QHash>
#include <QtCore/QMap>
44
#include <QtCore/QMultiMap>
con's avatar
con committed
45 46
#include <QtCore/QObject>
#include <QtCore/QPoint>
hjk's avatar
hjk committed
47
#include <QtCore/QSet>
48
#include <QtCore/QTextCodec>
49
#include <QtCore/QTime>
con's avatar
con committed
50
#include <QtCore/QVariant>
51
#include <QtCore/QSharedPointer>
con's avatar
con committed
52 53

QT_BEGIN_NAMESPACE
54 55
class QMainWindow;
class QMessageBox;
56
class QTimer;
con's avatar
con committed
57 58 59 60 61
QT_END_NAMESPACE

namespace Debugger {
namespace Internal {

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

class BreakpointData;
68
class WatchData;
69
class DisassemblerAgentCookie;
con's avatar
con committed
70

71 72
class AttachGdbAdapter;
class CoreGdbAdapter;
ck's avatar
ck committed
73 74
class LocalPlainGdbAdapter;
class RemoteGdbServerAdapter;
75
class TrkGdbAdapter;
76

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

85

86
class GdbEngine : public DebuggerEngine
con's avatar
con committed
87 88 89 90
{
    Q_OBJECT

public:
91
    explicit GdbEngine(const DebuggerStartParameters &startParameters);
con's avatar
con committed
92 93 94
    ~GdbEngine();

private:
95
    friend class AbstractGdbAdapter;
ck's avatar
ck committed
96
    friend class AbstractPlainGdbAdapter;
97 98
    friend class AttachGdbAdapter;
    friend class CoreGdbAdapter;
ck's avatar
ck committed
99
    friend class LocalPlainGdbAdapter;
100
    friend class TermGdbAdapter;
ck's avatar
ck committed
101 102
    friend class RemoteGdbServerAdapter;
    friend class RemotePlainGdbAdapter;
103
    friend class TrkGdbAdapter;
104
    friend class TcfTrkGdbAdapter;
hjk's avatar
hjk committed
105

106
private: ////////// General Interface //////////
con's avatar
con committed
107

108
    virtual void startDebugger();
109
    virtual unsigned debuggerCapabilities() const;
110
    virtual void exitDebugger();
111
    virtual void quitDebugger();
112 113
    virtual void detachDebugger();
    virtual void shutdown();
con's avatar
con committed
114

115
    virtual void executeDebuggerCommand(const QString &command);
116
    virtual QString qtNamespace() const { return m_dumperHelper.qtNamespace(); }
con's avatar
con committed
117

118
private: ////////// General State //////////
con's avatar
con committed
119

120 121 122
    void initializeVariables();
    DebuggerStartMode startMode() const;
    Q_SLOT void setAutoDerefPointers(const QVariant &on);
123

124
    bool m_registerNamesListed;
125

126
private: ////////// Gdb Process Management //////////
127

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

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

137
    void handleAdapterStarted();
138 139
    // Something went wrong with the adapter *before* adapterStarted() was emitted.
    // Make sure to clean up everything before emitting this signal.
140 141
    void handleAdapterStartFailed(const QString &msg,
        const QString &settingsIdHint = QString());
con's avatar
con committed
142

143 144
    // This triggers the initial breakpoint synchronization and causes
    // startInferiorPhase2() being called once done.
145 146
    void handleInferiorPrepared();

147
    // The adapter is still running just fine, but it failed to acquire a debuggee.
148 149
    void handleInferiorStartFailed(const QString &msg);

150 151
    // Something went wrong with the adapter *after* adapterStarted() was emitted.
    // Make sure to clean up everything before emitting this signal.
152
    void handleAdapterCrashed(const QString &msg);
con's avatar
con committed
153

154 155 156 157 158 159 160
private slots:
    void handleGdbFinished(int, QProcess::ExitStatus status);
    void handleGdbError(QProcess::ProcessError error);
    void readGdbStandardOutput();
    void readGdbStandardError();
    void readDebugeeOutput(const QByteArray &data);

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

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

168 169
    AbstractGdbAdapter *m_gdbAdapter;

170 171 172 173
    // Name of the convenience variable containing the last
    // known function return value.
    QByteArray m_resultVarName;

174 175
private: ////////// Gdb Command Management //////////

176
    public: // Otherwise the Qt flag macros are unhappy.
177 178
    enum GdbCommandFlag {
        NoFlags = 0,
179 180 181 182 183 184
        // The command needs a stopped inferior.
        NeedsStop = 1, 
        // No need to wait for the reply before continuing inferior.
        Discardable = 2,
        // Trigger watch model rebuild when no such commands are pending anymore.
        RebuildWatchModel = 4,
185
        WatchUpdate = Discardable | RebuildWatchModel,
hjk's avatar
hjk committed
186
        // We can live without receiving an answer.
187 188 189 190 191 192 193 194 195
        NonCriticalResponse = 8,
        // Callback expects GdbResultRunning instead of GdbResultDone.
        RunRequest = 16,
        // Callback expects GdbResultExit instead of GdbResultDone.
        ExitRequest = 32,
        // Auto-set inferior shutdown related states.
        LosesChild = 64,
        // Trigger breakpoint model rebuild when no such commands are pending anymore.
        RebuildBreakpointModel = 128,
196 197
        // This command needs to be send immediately.
        Immediate = 256,
198 199
        // This is a command that needs to be wrapped into -interpreter-exec console
        ConsoleCommand = 512,
200 201
    };
    Q_DECLARE_FLAGS(GdbCommandFlags, GdbCommandFlag)
202
    private:
203

hjk's avatar
hjk committed
204
    typedef void (GdbEngine::*GdbCommandCallback)
hjk's avatar
hjk committed
205
        (const GdbResponse &response);
hjk's avatar
hjk committed
206
    typedef void (AbstractGdbAdapter::*AdapterCallback)
hjk's avatar
hjk committed
207
        (const GdbResponse &response);
208 209 210

    struct GdbCommand
    {
hjk's avatar
hjk committed
211 212 213
        GdbCommand()
            : flags(0), callback(0), adapterCallback(0), callbackName(0)
        {}
214 215 216

        int flags;
        GdbCommandCallback callback;
hjk's avatar
hjk committed
217
        AdapterCallback adapterCallback;
218
        const char *callbackName;
219
        QByteArray command;
220
        QVariant cookie;
221
        QTime postTime;
222 223
    };

224
    // Type and cookie are sender-internal data, opaque for the "event
con's avatar
con committed
225
    // queue". resultNeeded == true increments m_pendingResults on
hjk's avatar
hjk committed
226
    // send and decrements on receipt, effectively preventing
con's avatar
con committed
227
    // watch model updates before everything is finished.
hjk's avatar
hjk committed
228
    void flushCommand(const GdbCommand &cmd);
229
    void postCommand(const QByteArray &command,
230 231 232 233
                     GdbCommandFlags flags,
                     GdbCommandCallback callback = 0,
                     const char *callbackName = 0,
                     const QVariant &cookie = QVariant());
234
    void postCommand(const QByteArray &command,
235 236 237
                     GdbCommandCallback callback = 0,
                     const char *callbackName = 0,
                     const QVariant &cookie = QVariant());
238
    void postCommand(const QByteArray &command,
hjk's avatar
hjk committed
239 240 241
                     AdapterCallback callback,
                     const char *callbackName,
                     const QVariant &cookie = QVariant());
242
    void postCommand(const QByteArray &command,
243 244 245 246
                     GdbCommandFlags flags,
                     AdapterCallback callback,
                     const char *callbackName,
                     const QVariant &cookie = QVariant());
hjk's avatar
hjk committed
247
    void postCommandHelper(const GdbCommand &cmd);
248
    void flushQueuedCommands();
249
    Q_SLOT void commandTimeout();
con's avatar
con committed
250 251
    void setTokenBarrier();

252
    QHash<int, GdbCommand> m_cookieForToken;
253
    int commandTimeoutTime() const;
254
    QTimer *m_commandTimer;
con's avatar
con committed
255

256 257
    QByteArray m_pendingConsoleStreamOutput;
    QByteArray m_pendingLogStreamOutput;
258

259
    // This contains the first token number for the current round
260 261 262
    // of evaluation. Responses with older tokens are considers
    // out of date and discarded.
    int m_oldestAcceptableToken;
con's avatar
con committed
263

264
    int m_pendingWatchRequests; // Watch updating commands in flight
265
    int m_pendingBreakpointRequests; // Watch updating commands in flight
hjk's avatar
hjk committed
266

267
    typedef void (GdbEngine::*CommandsDoneCallback)();
268
    // This function is called after all previous responses have been received.
269
    CommandsDoneCallback m_commandsDoneCallback;
hjk's avatar
hjk committed
270

271
    QList<GdbCommand> m_commandsToRunOnTemporaryBreak;
hjk's avatar
hjk committed
272
    int gdbVersion() const { return m_gdbVersion; }
273 274

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

276
    void handleResponse(const QByteArray &buff);
277
    void handleStopResponse(const GdbMi &data);
278
    void handleResultRecord(GdbResponse *response);
hjk's avatar
hjk committed
279
    void handleStop1(const GdbResponse &response);
280
    void handleStop1(const GdbMi &data);
281 282
    StackFrame parseStackFrame(const GdbMi &mi, int level);

hjk's avatar
hjk committed
283
    bool isSynchroneous() const { return hasPython(); }
284
    virtual bool hasPython() const;
285 286 287
    bool supportsThreads() const;

    // Gdb initialization sequence
hjk's avatar
hjk committed
288
    void handleShowVersion(const GdbResponse &response);
289
    void handleHasPython(const GdbResponse &response);
con's avatar
con committed
290

291
    int m_gdbVersion; // 6.8.0 is 60800
292
    int m_gdbBuildVersion; // MAC only?
293
    bool m_isMacGdb;
294
    bool m_hasPython;
hjk's avatar
hjk committed
295

296
private: ////////// Inferior Management //////////
297

298
    // This should be always the last call in a function.
299
    Q_SLOT virtual void attemptBreakpointSynchronization();
300

hjk's avatar
hjk committed
301 302 303 304 305
    virtual void executeStep();
    virtual void executeStepOut();
    virtual void executeNext();
    virtual void executeStepI();
    virtual void executeNextI();
con's avatar
con committed
306

307 308 309 310
    void continueInferiorInternal();
    void autoContinueInferior();
    virtual void continueInferior();
    virtual void interruptInferior();
311
    void interruptInferiorTemporarily();
con's avatar
con committed
312

hjk's avatar
hjk committed
313 314 315 316
    virtual void executeRunToLine(const QString &fileName, int lineNumber);
    virtual void executeRunToFunction(const QString &functionName);
    virtual void executeJumpToLine(const QString &fileName, int lineNumber);
    virtual void executeReturn();
con's avatar
con committed
317

hjk's avatar
hjk committed
318 319 320 321
    void handleExecuteContinue(const GdbResponse &response);
    void handleExecuteStep(const GdbResponse &response);
    void handleExecuteNext(const GdbResponse &response);
    void handleExecuteReturn(const GdbResponse &response);
322
    void handleExecuteJumpToLine(const GdbResponse &response);
323 324
    void handleExecuteRunToLine(const GdbResponse &response);
    //void handleExecuteRunToFunction(const GdbResponse &response);
con's avatar
con committed
325

326
    void maybeHandleInferiorPidChanged(const QString &pid);
327 328
    void handleInfoProc(const GdbResponse &response);

329
    QByteArray m_entryPoint;
hjk's avatar
hjk committed
330
    QFutureInterface<void> *m_progress;
331

332 333 334 335 336
private: ////////// View & Data Stuff //////////

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

con's avatar
con committed
337 338 339
    //
    // Breakpoint specific stuff
    //
hjk's avatar
hjk committed
340
    void handleBreakList(const GdbResponse &response);
con's avatar
con committed
341
    void handleBreakList(const GdbMi &table);
hjk's avatar
hjk committed
342
    void handleBreakIgnore(const GdbResponse &response);
343
    void handleBreakDisable(const GdbResponse &response);
hjk's avatar
hjk committed
344
    void handleBreakInsert1(const GdbResponse &response);
345
    void handleBreakInsert2(const GdbResponse &response);
hjk's avatar
hjk committed
346 347
    void handleBreakCondition(const GdbResponse &response);
    void handleBreakInfo(const GdbResponse &response);
348
    void handleWatchInsert(const GdbResponse &response);
349
    void handleInfoLine(const GdbResponse &response);
con's avatar
con committed
350
    void extractDataFromInfoBreak(const QString &output, BreakpointData *data);
351
    void setBreakpointDataFromOutput(BreakpointData *data, const GdbMi &bkpt);
352
    QByteArray breakpointLocation(const BreakpointData *data);
con's avatar
con committed
353
    void sendInsertBreakpoint(int index);
354
    QString breakLocation(const QString &file) const;
355
    void reloadBreakListInternal();
con's avatar
con committed
356 357 358 359

    //
    // Modules specific stuff
    //
360 361
    virtual void loadSymbols(const QString &moduleName);
    virtual void loadAllSymbols();
hjk's avatar
hjk committed
362
    virtual void requestModuleSymbols(const QString &moduleName);
363
    virtual void reloadModules();
364
    void reloadModulesInternal();
hjk's avatar
hjk committed
365
    void handleModulesList(const GdbResponse &response);
con's avatar
con committed
366

367
    bool m_modulesListOutdated;
con's avatar
con committed
368

369 370 371 372 373 374 375 376 377
    //
    // 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
378 379
    //
    // Register specific stuff
hjk's avatar
hjk committed
380
    //
381 382
    Q_SLOT virtual void reloadRegisters();
    virtual void setRegisterValue(int nr, const QString &value);
hjk's avatar
hjk committed
383 384
    void handleRegisterListNames(const GdbResponse &response);
    void handleRegisterListValues(const GdbResponse &response);
con's avatar
con committed
385

386 387 388
    //
    // Disassembler specific stuff
    //
389
    virtual void fetchDisassembler(DisassemblerViewAgent *agent);
390
    void fetchDisassemblerByAddress(const DisassemblerAgentCookie &ac,
391
        bool useMixedMode);
392
    void fetchDisassemblerByCli(const DisassemblerAgentCookie &ac,
393
        bool useMixedMode);
394
    void fetchDisassemblerByAddressCli(const DisassemblerAgentCookie &ac);
395
    void handleFetchDisassemblerByCli(const GdbResponse &response);
396 397 398 399 400
    void handleFetchDisassemblerByLine(const GdbResponse &response);
    void handleFetchDisassemblerByAddress1(const GdbResponse &response);
    void handleFetchDisassemblerByAddress0(const GdbResponse &response);
    QString parseDisassembler(const GdbMi &lines);

401 402
    //
    // Source file specific stuff
hjk's avatar
hjk committed
403
    //
404
    virtual void reloadSourceFiles();
405
    void reloadSourceFilesInternal();
406 407 408
    void handleQuerySources(const GdbResponse &response);

    QString fullName(const QString &fileName);
409 410 411 412 413
#ifdef Q_OS_WIN
    QString cleanupFullName(const QString &fileName);
#else
    QString cleanupFullName(const QString &fileName) { return fileName; }
#endif
414 415 416 417

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

419
    void invalidateSourcesList();
420 421
    bool m_sourcesListOutdated;
    bool m_sourcesListUpdating;
422
    bool m_breakListOutdated;
423

con's avatar
con committed
424 425
    //
    // Stack specific stuff
hjk's avatar
hjk committed
426
    //
427
    void updateAll();
428 429
        void updateAllClassic();
        void updateAllPython();
hjk's avatar
hjk committed
430 431
    void handleStackListFrames(const GdbResponse &response);
    void handleStackSelectThread(const GdbResponse &response);
432
    void handleStackSelectFrame(const GdbResponse &response);
433 434
    void handleThreadListIds(const GdbResponse &response);
    void handleThreadInfo(const GdbResponse &response);
hjk's avatar
hjk committed
435
    Q_SLOT void reloadStack(bool forceGotoLocation);
436
    Q_SLOT virtual void reloadFullStack();
437
    int currentFrame() const;
con's avatar
con committed
438

439 440
    QList<GdbMi> m_currentFunctionArgs;
    QString m_currentFrame;
con's avatar
con committed
441 442

    //
443
    // Watch specific stuff
hjk's avatar
hjk committed
444
    //
hjk's avatar
hjk committed
445 446
    virtual void setToolTipExpression(const QPoint &mousePos,
        TextEditor::ITextEditor *editor, int cursorPos);
con's avatar
con committed
447

448 449
    virtual void assignValueInDebugger(const QString &expr, const QString &value);

450 451
    virtual void fetchMemory(MemoryViewAgent *agent, QObject *token,
        quint64 addr, quint64 length);
452 453 454 455
    void handleFetchMemory(const GdbResponse &response);

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

    // FIXME: BaseClass. called to improve situation for a watch item
458
    void updateSubItemClassic(const WatchData &data);
con's avatar
con committed
459

460
    void virtual updateWatchData(const WatchData &data);
461
    Q_SLOT void updateWatchDataHelper(const WatchData &data);
462
    void rebuildWatchModel();
463
    bool showToolTip();
con's avatar
con committed
464 465 466

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

469 470
    void runDebuggingHelperClassic(const WatchData &data, bool dumpChildren);
    void runDirectDebuggingHelperClassic(const WatchData &data, bool dumpChildren);
471
    bool hasDebuggingHelperForType(const QString &type) const;
con's avatar
con committed
472

473 474
    void handleVarListChildrenClassic(const GdbResponse &response);
    void handleVarListChildrenHelperClassic(const GdbMi &child,
475
        const WatchData &parent);
hjk's avatar
hjk committed
476 477
    void handleVarCreate(const GdbResponse &response);
    void handleVarAssign(const GdbResponse &response);
478
    void handleEvaluateExpressionClassic(const GdbResponse &response);
479 480 481
    void handleQueryDebuggingHelperClassic(const GdbResponse &response);
    void handleDebuggingHelperValue2Classic(const GdbResponse &response);
    void handleDebuggingHelperValue3Classic(const GdbResponse &response);
hjk's avatar
hjk committed
482 483
    void handleDebuggingHelperEditValue(const GdbResponse &response);
    void handleDebuggingHelperSetup(const GdbResponse &response);
484
    void handleDebuggingHelperVersionCheckClassic(const GdbResponse &response);
485

486 487 488
    Q_SLOT void createFullBacktrace();
    void handleCreateFullBacktrace(const GdbResponse &response);

489
    void updateLocals(const QVariant &cookie = QVariant());
490 491 492
        void updateLocalsClassic(const QVariant &cookie);
        void updateLocalsPython(const QByteArray &varList);
            void handleStackFramePython(const GdbResponse &response);
493

494 495 496
    void handleStackListLocalsClassic(const GdbResponse &response);
    void handleStackListLocalsPython(const GdbResponse &response);

497 498 499 500
    WatchData localVariable(const GdbMi &item,
                            const QStringList &uninitializedVariables,
                            QMap<QByteArray, int> *seen);
    void setLocals(const QList<GdbMi> &locals);
501
    void handleStackListArgumentsClassic(const GdbResponse &response);
con's avatar
con committed
502

503
    QSet<QByteArray> m_processedNames;
con's avatar
con committed
504

505 506 507
    //
    // Dumper Management
    //
508
    bool checkDebuggingHelpers();
509 510 511 512 513 514
        bool checkDebuggingHelpersClassic();
    void setDebuggingHelperStateClassic(DebuggingHelperState);
    void tryLoadDebuggingHelpersClassic();
    void tryQueryDebuggingHelpersClassic();
    Q_SLOT void recheckDebuggingHelperAvailabilityClassic();
    Q_SLOT void setDebugDebuggingHelpersClassic(const QVariant &on);
515
    Q_SLOT void setUseDebuggingHelpers(const QVariant &on);
516

517 518
    DebuggingHelperState m_debuggingHelperState;
    QtDumperHelper m_dumperHelper;
519
    QString m_gdb;
520

521 522 523
    // 
    // Convenience Functions
    //
524
    QString errorMessage(QProcess::ProcessError error);
525 526
    QMessageBox *showMessageBox(int icon, const QString &title, const QString &text,
        int buttons = 0);
527
    QMainWindow *mainWindow() const;
ck's avatar
ck committed
528
    AbstractGdbProcess *gdbProc() const;
529

530 531
    static QString m_toolTipExpression;
    static QPoint m_toolTipPos;
532
    static QByteArray tooltipIName(const QString &exp);
533 534 535

    // HACK:
    StackFrame m_targetFrame;
con's avatar
con committed
536 537 538 539 540
};

} // namespace Internal
} // namespace Debugger

541 542
Q_DECLARE_OPERATORS_FOR_FLAGS(Debugger::Internal::GdbEngine::GdbCommandFlags)

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