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

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

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

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

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

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

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

class GdbEngine : public IDebuggerEngine
{
    Q_OBJECT

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

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

con's avatar
con committed
98 99 100 101 102 103 104 105 106 107
    //
    // IDebuggerEngine implementation
    //
    void stepExec();
    void stepOutExec();
    void nextExec();
    void stepIExec();
    void nextIExec();

    void shutdown();
108
    void setToolTipExpression(const QPoint &mousePos, TextEditor::ITextEditor *editor, int cursorPos);
hjk's avatar
hjk committed
109
    void startDebugger(const DebuggerStartParametersPtr &sp);
con's avatar
con committed
110
    void exitDebugger();
111
    void detachDebugger();
con's avatar
con committed
112

113 114
    void continueInferiorInternal();
    void autoContinueInferior();
con's avatar
con committed
115 116 117 118 119 120 121 122 123 124 125 126 127 128
    void continueInferior();
    void interruptInferior();

    void runToLineExec(const QString &fileName, int lineNumber);
    void runToFunctionExec(const QString &functionName);
    void jumpToLineExec(const QString &fileName, int lineNumber);

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

    Q_SLOT void attemptBreakpointSynchronization();

    void assignValueInDebugger(const QString &expr, const QString &value);
    void executeDebuggerCommand(const QString & command);
129
    void watchPoint(const QPoint &);
con's avatar
con committed
130 131 132

    void loadSymbols(const QString &moduleName);
    void loadAllSymbols();
133
    virtual QList<Symbol> moduleSymbols(const QString &moduleName);
con's avatar
con committed
134

135
    void fetchMemory(MemoryViewAgent *agent, quint64 addr, quint64 length);
hjk's avatar
hjk committed
136
    void handleFetchMemory(const GdbResponse &response);
137

138 139 140 141
    void fetchDisassembler(DisassemblerViewAgent *agent,
        const StackFrame &frame);
    void fetchDisassemblerByAddress(DisassemblerViewAgent *agent,
        bool useMixedMode);
hjk's avatar
hjk committed
142 143 144
    void handleFetchDisassemblerByLine(const GdbResponse &response);
    void handleFetchDisassemblerByAddress1(const GdbResponse &response);
    void handleFetchDisassemblerByAddress0(const GdbResponse &response);
145

146 147
    Q_SLOT void setDebugDebuggingHelpers(const QVariant &on);
    Q_SLOT void setUseDebuggingHelpers(const QVariant &on);
148 149
    Q_SLOT void setAutoDerefPointers(const QVariant &on);
    virtual bool isGdbEngine() const { return true; }
150

151 152
    virtual bool checkConfiguration(int toolChain, QString *errorMessage, QString *settingsPage= 0) const;

con's avatar
con committed
153 154 155
    //
    // Own stuff
    //
156

con's avatar
con committed
157 158 159
    int currentFrame() const;

    bool supportsThreads() const;
hjk's avatar
hjk committed
160
    void gotoLocation(const StackFrame &frame, bool setLocationMarker);
161
    StackFrame parseStackFrame(const GdbMi &mi, int level);
con's avatar
con committed
162

163
    void connectAdapter();
164
    void initializeVariables();
con's avatar
con committed
165 166 167 168
    QString fullName(const QString &fileName);
    // get one usable name out of these, try full names first
    QString fullName(const QStringList &candidates);

hjk's avatar
hjk committed
169
    void handleResult(const GdbResponse &response);
con's avatar
con committed
170

171 172 173 174 175 176
public: // otherwise the Qt flag macros are unhappy
    enum GdbCommandFlag {
        NoFlags = 0,
        NeedsStop = 1,
        Discardable = 2,
        RebuildModel = 4,
177
        WatchUpdate = Discardable | RebuildModel,
178
        EmbedToken = 8
179 180 181
    };
    Q_DECLARE_FLAGS(GdbCommandFlags, GdbCommandFlag)

hjk's avatar
hjk committed
182

183
private:
hjk's avatar
hjk committed
184
    typedef void (GdbEngine::*GdbCommandCallback)
hjk's avatar
hjk committed
185
        (const GdbResponse &response);
hjk's avatar
hjk committed
186
    typedef void (AbstractGdbAdapter::*AdapterCallback)
hjk's avatar
hjk committed
187
        (const GdbResponse &response);
188 189 190

    struct GdbCommand
    {
hjk's avatar
hjk committed
191 192 193
        GdbCommand()
            : flags(0), callback(0), adapterCallback(0), callbackName(0)
        {}
194 195 196

        int flags;
        GdbCommandCallback callback;
hjk's avatar
hjk committed
197
        AdapterCallback adapterCallback;
198 199 200
        const char *callbackName;
        QString command;
        QVariant cookie;
201
        QTime postTime;
202 203
    };

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

230
    void updateAll();
con's avatar
con committed
231 232
    void updateLocals();

233 234 235 236 237
    void gdbInputAvailable(int channel, const QString &msg)
    { m_manager->showDebuggerInput(channel, msg); }
    void gdbOutputAvailable(int channel, const QString &msg)
    { m_manager->showDebuggerOutput(channel, msg); }

con's avatar
con committed
238 239 240
private slots:
    void readGdbStandardOutput();
    void readGdbStandardError();
241
    void readDebugeeOutput(const QByteArray &data);
con's avatar
con committed
242

hjk's avatar
hjk committed
243
    void handleAdapterStarted();
244
    void handleAdapterStartFailed(const QString &msg, const QString &settingsIdHint = QString());
hjk's avatar
hjk committed
245 246 247 248 249 250 251

    void handleInferiorPrepared();
    void handleInferiorPreparationFailed(const QString &msg);
    void handleInferiorStartFailed(const QString &msg);
    void handleInferiorShutDown();
    void handleInferiorShutdownFailed(const QString &msg);

252
    void handleAdapterCrashed(const QString &msg);
hjk's avatar
hjk committed
253 254 255
    void handleAdapterShutDown();
    void handleAdapterShutdownFailed(const QString &msg);

con's avatar
con committed
256 257
private:
    int terminationIndex(const QByteArray &buffer, int &length);
258
    void handleResponse(const QByteArray &buff);
hjk's avatar
hjk committed
259
    void handleStart(const GdbResponse &response);
260
    void handleStopResponse(const GdbMi &data);
hjk's avatar
hjk committed
261
    void handleStop1(const GdbResponse &response);
262
    void handleStop1(const GdbMi &data);
hjk's avatar
hjk committed
263
    void handleStop2(const GdbResponse &response);
hjk's avatar
hjk committed
264
    void handleStop2(const GdbMi &data);
hjk's avatar
hjk committed
265 266 267 268 269 270 271 272 273 274
    void handleResultRecord(const GdbResponse &response);
    void handleFileExecAndSymbols(const GdbResponse &response);
    void handleExecContinue(const GdbResponse &response);
    void handleExecJumpToLine(const GdbResponse &response);
    void handleExecRunToFunction(const GdbResponse &response);
    void handleInfoShared(const GdbResponse &response);
    void handleShowVersion(const GdbResponse &response);
    void handleQueryPwd(const GdbResponse &response);
    void handleQuerySources(const GdbResponse &response);
    void handleWatchPoint(const GdbResponse &response);
275
    bool showToolTip();
con's avatar
con committed
276

hjk's avatar
hjk committed
277
    // Convenience
278
    QMainWindow *mainWindow() const;
279
    DebuggerStartMode startMode() const;
hjk's avatar
hjk committed
280
    qint64 inferiorPid() const { return m_manager->inferiorPid(); }
281
    void handleInferiorPidChanged(qint64 pid) { manager()->notifyInferiorPidChanged(pid); }
hjk's avatar
hjk committed
282

283 284
    void handleChildren(const WatchData &parent, const GdbMi &child,
        QList<WatchData> *insertions);
285 286
    const bool m_dumperInjectionLoad;

287 288 289
    QTextCodec *m_outputCodec;
    QTextCodec::ConverterState m_outputCodecState;

con's avatar
con committed
290 291
    QByteArray m_inbuffer;

292
    QHash<int, GdbCommand> m_cookieForToken;
con's avatar
con committed
293 294 295 296 297 298 299 300 301 302 303
    QHash<int, QByteArray> m_customOutputForToken;

    QByteArray m_pendingConsoleStreamOutput;
    QByteArray m_pendingLogStreamOutput;

    // 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;

    int m_gdbVersion; // 6.8.0 is 680
hjk's avatar
hjk committed
304
    int m_gdbBuildVersion; // MAC only?
con's avatar
con committed
305 306

    // awful hack to keep track of used files
307 308
    QMap<QString, QString> m_shortToFullName;
    QMap<QString, QString> m_fullToShortName;
con's avatar
con committed
309 310 311 312

    //
    // Breakpoint specific stuff
    //
hjk's avatar
hjk committed
313
    void handleBreakList(const GdbResponse &response);
con's avatar
con committed
314
    void handleBreakList(const GdbMi &table);
hjk's avatar
hjk committed
315 316 317 318 319
    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
320 321 322 323 324 325 326 327
    void extractDataFromInfoBreak(const QString &output, BreakpointData *data);
    void breakpointDataFromOutput(BreakpointData *data, const GdbMi &bkpt);
    void sendInsertBreakpoint(int index);

    //
    // Modules specific stuff
    //
    void reloadModules();
hjk's avatar
hjk committed
328
    void handleModulesList(const GdbResponse &response);
con's avatar
con committed
329 330 331 332


    //
    // Register specific stuff
hjk's avatar
hjk committed
333
    //
334
    Q_SLOT void reloadRegisters();
335
    void setRegisterValue(int nr, const QString &value);
hjk's avatar
hjk committed
336 337
    void handleRegisterListNames(const GdbResponse &response);
    void handleRegisterListValues(const GdbResponse &response);
con's avatar
con committed
338

339 340
    //
    // Source file specific stuff
hjk's avatar
hjk committed
341
    //
342
    void reloadSourceFiles();
con's avatar
con committed
343 344 345

    //
    // Stack specific stuff
hjk's avatar
hjk committed
346
    //
hjk's avatar
hjk committed
347 348 349
    void handleStackListFrames(const GdbResponse &response);
    void handleStackSelectThread(const GdbResponse &response);
    void handleStackListThreads(const GdbResponse &response);
hjk's avatar
hjk committed
350
    Q_SLOT void reloadStack(bool forceGotoLocation);
351
    Q_SLOT void reloadFullStack();
con's avatar
con committed
352 353 354 355


    //
    // Tooltip specific stuff
hjk's avatar
hjk committed
356
    //
con's avatar
con committed
357 358 359 360 361 362 363 364 365
    void sendToolTipCommand(const QString &command, const QString &cookie);


    //
    // Watch specific stuff
    //
    // FIXME: BaseClass. called to improve situation for a watch item
    void updateSubItem(const WatchData &data);

366
    void updateWatchData(const WatchData &data);
367
    Q_SLOT void updateWatchDataHelper(const WatchData &data);
hjk's avatar
hjk committed
368
    void rebuildModel();
con's avatar
con committed
369 370 371 372 373 374 375

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

    void maybeHandleInferiorPidChanged(const QString &pid);

376
    void tryLoadDebuggingHelpers();
377
    void tryQueryDebuggingHelpers();
378 379 380 381
    Q_SLOT void recheckDebuggingHelperAvailability();
    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
382

hjk's avatar
hjk committed
383 384 385 386 387 388 389 390 391 392 393 394 395
    void handleVarListChildren(const GdbResponse &response);
    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 handleDebuggingHelperValue1(const GdbResponse &response);
    void handleDebuggingHelperValue2(const GdbResponse &response);
    void handleDebuggingHelperValue3(const GdbResponse &response);
    void handleDebuggingHelperEditValue(const GdbResponse &response);
    void handleDebuggingHelperSetup(const GdbResponse &response);
    void handleStackListLocals(const GdbResponse &response);
    void handleStackListArguments(const GdbResponse &response);
con's avatar
con committed
396 397 398
    void handleVarListChildrenHelper(const GdbMi &child,
        const WatchData &parent);
    void setWatchDataType(WatchData &data, const GdbMi &mi);
399
    void setWatchDataDisplayedType(WatchData &data, const GdbMi &mi);
hjk's avatar
hjk committed
400
    void setLocals(const QList<GdbMi> &locals);
401 402
    void connectDebuggingHelperActions();
    void disconnectDebuggingHelperActions();
403
    AbstractGdbAdapter *createAdapter(const DebuggerStartParametersPtr &dp);
hjk's avatar
hjk committed
404

405
    bool startModeAllowsDumpers() const;
406
    QString parseDisassembler(const GdbMi &lines);
con's avatar
con committed
407 408

    int m_pendingRequests;
hjk's avatar
hjk committed
409
    QSet<QString> m_processedNames;
con's avatar
con committed
410

411
    QtDumperHelper m_dumperHelper;
hjk's avatar
hjk committed
412

413
    DebuggingHelperState m_debuggingHelperState;
con's avatar
con committed
414 415 416 417
    QList<GdbMi> m_currentFunctionArgs;
    QString m_currentFrame;
    QMap<QString, QString> m_varToType;

418
    typedef void (GdbEngine::*CommandsDoneCallback)();
hjk's avatar
hjk committed
419
    // function called after all previous responses have been received
420
    CommandsDoneCallback m_commandsDoneCallback;
hjk's avatar
hjk committed
421
    void startInferior();
hjk's avatar
hjk committed
422

423
    bool m_modulesListOutdated;
424

425
    QList<GdbCommand> m_commandsToRunOnTemporaryBreak;
hjk's avatar
hjk committed
426

hjk's avatar
hjk committed
427
    DebuggerStartParametersPtr m_startParameters;
428
    // make sure to re-initialize new members in initializeVariables();
429

430 431 432
    QSharedPointer<TrkOptions> m_trkOptions;

    AbstractGdbAdapter *m_gdbAdapter;
hjk's avatar
hjk committed
433

hjk's avatar
hjk committed
434
public:
435
    QString errorMessage(QProcess::ProcessError error);
436
    void showMessageBox(int icon, const QString &title, const QString &text);
437
    void debugMessage(const QString &msg);
438
    void addOptionPages(QList<Core::IOptionsPage*> *opts) const;
439 440
    const DebuggerStartParameters &startParameters() const
        { return *m_startParameters; }
con's avatar
con committed
441 442 443 444 445
};

} // namespace Internal
} // namespace Debugger

446 447
Q_DECLARE_OPERATORS_FOR_FLAGS(Debugger::Internal::GdbEngine::GdbCommandFlags)

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