gdbengine.h 17.1 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
    virtual bool checkConfiguration(int toolChain, QString *errorMessage, QString *settingsPage= 0) const;
con's avatar
con committed
106

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

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

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

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

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

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

129
private: ////////// Gdb Process Management //////////
130

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

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

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

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

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

156
157
    void handleInferiorPrepared();

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

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

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

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

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

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

    public: // otherwise the Qt flag macros are unhappy
175
176
    enum GdbCommandFlag {
        NoFlags = 0,
177
178
179
        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
180
        WatchUpdate = Discardable | RebuildModel,
181
        NonCriticalResponse = 8,  // We can live without recieving an answer
182
183
184
        RunRequest = 16,  // Callback expects GdbResultRunning instead of GdbResultDone
        ExitRequest = 32, // Callback expects GdbResultExit instead of GdbResultDone
        LosesChild = 64   // Auto-set inferior shutdown related states
185
186
    };
    Q_DECLARE_FLAGS(GdbCommandFlags, GdbCommandFlag)
187
    private:
188

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

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

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

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

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

241
242
    QByteArray m_pendingConsoleStreamOutput;
    QByteArray m_pendingLogStreamOutput;
243

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

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

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

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

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

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

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

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

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

279
private: ////////// Inferior Management //////////
280

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

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

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

296
297
298
299
    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
300

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

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

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

310
311
312
    QByteArray m_entryPoint;
#endif

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

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

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

346
    bool m_modulesListOutdated;
con's avatar
con committed
347
348
349

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

356
357
358
359
360
361
362
363
364
365
366
367
    //
    // 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);

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

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

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

386
    void invalidateSourcesList();
387
388
    bool m_sourcesListOutdated;
    bool m_sourcesListUpdating;
389
390
    bool m_breakListOutdated;
    bool m_breakListUpdating;
391

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

404
405
    QList<GdbMi> m_currentFunctionArgs;
    QString m_currentFrame;
con's avatar
con committed
406
407

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

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

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

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

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

434
435
436
    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
437

hjk's avatar
hjk committed
438
    void handleVarListChildren(const GdbResponse &response);
439
440
    void handleVarListChildrenHelper(const GdbMi &child,
        const WatchData &parent);
hjk's avatar
hjk committed
441
442
443
444
445
446
447
448
449
    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);
450
451

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

461
    QSet<QByteArray> m_processedNames;
con's avatar
con committed
462
463
    QMap<QString, QString> m_varToType;

464
private: ////////// Dumper Management //////////
465
466
467
    QString qtDumperLibraryName() const;
    bool checkDebuggingHelpers();
    void setDebuggingHelperState(DebuggingHelperState);
468
469
470
471
472
473
474
    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);
475

476
477
478
    const bool m_dumperInjectionLoad;
    DebuggingHelperState m_debuggingHelperState;
    QtDumperHelper m_dumperHelper;
479

480
private: ////////// Convenience Functions //////////
hjk's avatar
hjk committed
481

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

} // namespace Internal
} // namespace Debugger

492
493
Q_DECLARE_OPERATORS_FOR_FLAGS(Debugger::Internal::GdbEngine::GdbCommandFlags)

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