gdbengine.h 17 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
51
#include <QtCore/QVariant>

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

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

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

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

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

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

class GdbEngine : public IDebuggerEngine
{
    Q_OBJECT

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

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

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

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

104
    virtual bool checkConfiguration(int toolChain, QString *errorMessage, QString *settingsPage= 0) const;
con's avatar
con committed
105

106
    virtual bool isGdbEngine() const { return true; }
con's avatar
con committed
107

108
109
110
111
    virtual void startDebugger(const DebuggerStartParametersPtr &sp);
    virtual void exitDebugger();
    virtual void detachDebugger();
    virtual void shutdown();
con's avatar
con committed
112

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

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

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

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

128
private: ////////// Gdb Process Management //////////
129

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

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

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

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

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

155
156
    void handleInferiorPrepared();

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

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

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

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

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

    public: // otherwise the Qt flag macros are unhappy
174
175
    enum GdbCommandFlag {
        NoFlags = 0,
176
177
178
        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
179
        WatchUpdate = Discardable | RebuildModel,
180
        EmbedToken = 8,   // Expand %1 in the command to the command token
181
182
183
        RunRequest = 16,  // Callback expects GdbResultRunning instead of GdbResultDone
        ExitRequest = 32, // Callback expects GdbResultExit instead of GdbResultDone
        LosesChild = 64   // Auto-set inferior shutdown related states
184
185
    };
    Q_DECLARE_FLAGS(GdbCommandFlags, GdbCommandFlag)
186
    private:
187

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

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

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

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

236
    QHash<int, GdbCommand> m_cookieForToken;
237
238
    QTimer *m_commandTimer;
    enum { COMMAND_TIMEOUT = 20000 };
con's avatar
con committed
239

240
241
    QByteArray m_pendingConsoleStreamOutput;
    QByteArray m_pendingLogStreamOutput;
242

243
244
245
246
    // 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
247

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

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

254
255
256
    QList<GdbCommand> m_commandsToRunOnTemporaryBreak;

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
265
266
267
268
    StackFrame parseStackFrame(const GdbMi &mi, int level);

    virtual bool isSynchroneous() const;
    bool supportsThreads() const;

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

272
    int m_gdbVersion; // 6.8.0 is 60800
273
    int m_gdbBuildVersion; // MAC only?
274
    bool m_isMacGdb;
275
    bool m_isSynchroneous; // Can act synchroneously?
hjk's avatar
hjk committed
276

277
private: ////////// Inferior Management //////////
278

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

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

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

294
295
296
297
    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
298

299
    void handleExecContinue(const GdbResponse &response);
con's avatar
con committed
300

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

305
#ifdef Q_OS_LINUX
306
307
    void handleInfoProc(const GdbResponse &response);

308
309
310
    QByteArray m_entryPoint;
#endif

311
312
313
314
315
316
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
317
318
319
320

    //
    // Breakpoint specific stuff
    //
hjk's avatar
hjk committed
321
    void handleBreakList(const GdbResponse &response);
con's avatar
con committed
322
    void handleBreakList(const GdbMi &table);
hjk's avatar
hjk committed
323
324
325
326
327
    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
328
329
330
    void extractDataFromInfoBreak(const QString &output, BreakpointData *data);
    void breakpointDataFromOutput(BreakpointData *data, const GdbMi &bkpt);
    void sendInsertBreakpoint(int index);
331
    QString breakLocation(const QString &file) const;
332
    void reloadBreakListInternal();
con's avatar
con committed
333
334
335
336

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

344
    bool m_modulesListOutdated;
con's avatar
con committed
345
346
347

    //
    // Register specific stuff
hjk's avatar
hjk committed
348
    //
349
350
    Q_SLOT virtual void reloadRegisters();
    virtual void setRegisterValue(int nr, const QString &value);
hjk's avatar
hjk committed
351
352
    void handleRegisterListNames(const GdbResponse &response);
    void handleRegisterListValues(const GdbResponse &response);
con's avatar
con committed
353

354
355
356
357
358
359
360
361
362
363
364
365
    //
    // Disassembler specific stuff
    //
    virtual void fetchDisassembler(DisassemblerViewAgent *agent,
        const StackFrame &frame);
    void fetchDisassemblerByAddress(DisassemblerViewAgent *agent,
        bool useMixedMode);
    void handleFetchDisassemblerByLine(const GdbResponse &response);
    void handleFetchDisassemblerByAddress1(const GdbResponse &response);
    void handleFetchDisassemblerByAddress0(const GdbResponse &response);
    QString parseDisassembler(const GdbMi &lines);

366
367
    //
    // Source file specific stuff
hjk's avatar
hjk committed
368
    //
369
    virtual void reloadSourceFiles();
370
    void reloadSourceFilesInternal();
371
372
373
    void handleQuerySources(const GdbResponse &response);

    QString fullName(const QString &fileName);
374
375
376
377
378
#ifdef Q_OS_WIN
    QString cleanupFullName(const QString &fileName);
#else
    QString cleanupFullName(const QString &fileName) { return fileName; }
#endif
379
380
381
382

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

384
    void invalidateSourcesList();
385
386
    bool m_sourcesListOutdated;
    bool m_sourcesListUpdating;
387
388
    bool m_breakListOutdated;
    bool m_breakListUpdating;
389

con's avatar
con committed
390
391
    //
    // Stack specific stuff
hjk's avatar
hjk committed
392
    //
393
    void updateAll();
hjk's avatar
hjk committed
394
395
396
    void handleStackListFrames(const GdbResponse &response);
    void handleStackSelectThread(const GdbResponse &response);
    void handleStackListThreads(const GdbResponse &response);
397
    void handleStackFrame(const GdbResponse &response);
hjk's avatar
hjk committed
398
    Q_SLOT void reloadStack(bool forceGotoLocation);
399
    Q_SLOT virtual void reloadFullStack();
400
    int currentFrame() const;
con's avatar
con committed
401

402
403
    QList<GdbMi> m_currentFunctionArgs;
    QString m_currentFrame;
con's avatar
con committed
404
405

    //
406
    // Watch specific stuff
hjk's avatar
hjk committed
407
    //
408
    virtual void setToolTipExpression(const QPoint &mousePos, TextEditor::ITextEditor *editor, int cursorPos);
con's avatar
con committed
409

410
411
412
413
414
415
416
    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
417
418
419

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

423
    void virtual updateWatchData(const WatchData &data);
424
    Q_SLOT void updateWatchDataHelper(const WatchData &data);
hjk's avatar
hjk committed
425
    void rebuildModel();
426
    bool showToolTip();
con's avatar
con committed
427
428
429
430
431

    void insertData(const WatchData &data);
    void sendWatchParameters(const QByteArray &params0);
    void createGdbVariable(const WatchData &data);

432
433
434
    void runDebuggingHelper(const WatchData &data, bool dumpChildren);
    void runDirectDebuggingHelper(const WatchData &data, bool dumpChildren);
    bool hasDebuggingHelperForType(const QString &type) const;
con's avatar
con committed
435

hjk's avatar
hjk committed
436
    void handleVarListChildren(const GdbResponse &response);
437
438
    void handleVarListChildrenHelper(const GdbMi &child,
        const WatchData &parent);
hjk's avatar
hjk committed
439
440
441
442
443
444
445
446
447
    void handleVarCreate(const GdbResponse &response);
    void handleVarAssign(const GdbResponse &response);
    void handleEvaluateExpression(const GdbResponse &response);
    //void handleToolTip(const GdbResponse &response);
    void handleQueryDebuggingHelper(const GdbResponse &response);
    void handleDebuggingHelperValue2(const GdbResponse &response);
    void handleDebuggingHelperValue3(const GdbResponse &response);
    void handleDebuggingHelperEditValue(const GdbResponse &response);
    void handleDebuggingHelperSetup(const GdbResponse &response);
448
449

    void updateLocals(const QVariant &cookie = QVariant());
hjk's avatar
hjk committed
450
    void handleStackListLocals(const GdbResponse &response);
451
452
453
454
    WatchData localVariable(const GdbMi &item,
                            const QStringList &uninitializedVariables,
                            QMap<QByteArray, int> *seen);
    void setLocals(const QList<GdbMi> &locals);
hjk's avatar
hjk committed
455
    void handleStackListArguments(const GdbResponse &response);
con's avatar
con committed
456
    void setWatchDataType(WatchData &data, const GdbMi &mi);
457
    void setWatchDataDisplayedType(WatchData &data, const GdbMi &mi);
con's avatar
con committed
458

hjk's avatar
hjk committed
459
    QSet<QString> m_processedNames;
con's avatar
con committed
460
461
    QMap<QString, QString> m_varToType;

462
private: ////////// Dumper Management //////////
463
464
465
    QString qtDumperLibraryName() const;
    bool checkDebuggingHelpers();
    void setDebuggingHelperState(DebuggingHelperState);
466
467
468
469
470
471
472
    void tryLoadDebuggingHelpers();
    void tryQueryDebuggingHelpers();
    Q_SLOT void recheckDebuggingHelperAvailability();
    void connectDebuggingHelperActions();
    void disconnectDebuggingHelperActions();
    Q_SLOT void setDebugDebuggingHelpers(const QVariant &on);
    Q_SLOT void setUseDebuggingHelpers(const QVariant &on);
473

474
475
476
    const bool m_dumperInjectionLoad;
    DebuggingHelperState m_debuggingHelperState;
    QtDumperHelper m_dumperHelper;
477

478
private: ////////// Convenience Functions //////////
hjk's avatar
hjk committed
479

480
    QString errorMessage(QProcess::ProcessError error);
481
    void showMessageBox(int icon, const QString &title, const QString &text);
482
    void debugMessage(const QString &msg);
483
    QMainWindow *mainWindow() const;
con's avatar
con committed
484
485
486
487
488
};

} // namespace Internal
} // namespace Debugger

489
490
Q_DECLARE_OPERATORS_FOR_FLAGS(Debugger::Internal::GdbEngine::GdbCommandFlags)

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