gdbengine.h 15.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"
hjk's avatar
hjk committed
37
#include "outputcollector.h"
38

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

QT_BEGIN_NAMESPACE
class QAction;
class QAbstractItemModel;
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

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();

signals:
91 92
    void gdbInputAvailable(int channel, const QString &msg);
    void gdbOutputAvailable(int channel, const QString &msg);
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
93
    void applicationOutputAvailable(const QString &output);
con's avatar
con committed
94 95

private:
96
    friend class AbstractGdbAdapter;
97 98
    friend class AttachGdbAdapter;
    friend class CoreGdbAdapter;
hjk's avatar
hjk committed
99
    friend class PlainGdbAdapter;
100
    friend class RemoteGdbAdapter;
101
    friend class TrkGdbAdapter;
hjk's avatar
hjk committed
102

con's avatar
con committed
103 104 105 106 107 108 109 110 111 112
    //
    // IDebuggerEngine implementation
    //
    void stepExec();
    void stepOutExec();
    void nextExec();
    void stepIExec();
    void nextIExec();

    void shutdown();
113
    void setToolTipExpression(const QPoint &mousePos, TextEditor::ITextEditor *editor, int cursorPos);
hjk's avatar
hjk committed
114
    void startDebugger(const DebuggerStartParametersPtr &sp);
con's avatar
con committed
115
    void exitDebugger();
116
    void detachDebugger();
con's avatar
con committed
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131

    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);
132
    void watchPoint(const QPoint &);
con's avatar
con committed
133 134 135

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

138
    void fetchMemory(MemoryViewAgent *agent, quint64 addr, quint64 length);
hjk's avatar
hjk committed
139
    void handleFetchMemory(const GdbResponse &response);
140

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

149 150
    Q_SLOT void setDebugDebuggingHelpers(const QVariant &on);
    Q_SLOT void setUseDebuggingHelpers(const QVariant &on);
151 152
    Q_SLOT void setAutoDerefPointers(const QVariant &on);
    virtual bool isGdbEngine() const { return true; }
153

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

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

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

164 165
    void connectAdapter();
    void disconnectAdapter();
166
    void initializeVariables();
con's avatar
con committed
167 168 169 170
    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
171
    void handleResult(const GdbResponse &response);
con's avatar
con committed
172

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

hjk's avatar
hjk committed
184

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

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

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

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

232
    void updateAll();
con's avatar
con committed
233 234 235 236 237
    void updateLocals();

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

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

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

249
    void handleAdapterCrashed(const QString &msg);
hjk's avatar
hjk committed
250 251 252
    void handleAdapterShutDown();
    void handleAdapterShutdownFailed(const QString &msg);

con's avatar
con committed
253 254
private:
    int terminationIndex(const QByteArray &buffer, int &length);
255
    void handleResponse(const QByteArray &buff);
hjk's avatar
hjk committed
256
    void handleStart(const GdbResponse &response);
con's avatar
con committed
257
    void handleAsyncOutput(const GdbMi &data);
hjk's avatar
hjk committed
258 259
    void handleStop1(const GdbResponse &response);
    void handleStop2(const GdbResponse &response);
hjk's avatar
hjk committed
260
    void handleStop2(const GdbMi &data);
hjk's avatar
hjk committed
261 262 263 264 265 266 267 268 269 270
    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);
271
    bool showToolTip();
con's avatar
con committed
272

hjk's avatar
hjk committed
273
    // Convenience
274
    QMainWindow *mainWindow() const;
275
    DebuggerStartMode startMode() const;
hjk's avatar
hjk committed
276 277
    qint64 inferiorPid() const { return m_manager->inferiorPid(); }

278 279
    void handleChildren(const WatchData &parent, const GdbMi &child,
        QList<WatchData> *insertions);
280 281
    const bool m_dumperInjectionLoad;

282 283 284
    QTextCodec *m_outputCodec;
    QTextCodec::ConverterState m_outputCodecState;

con's avatar
con committed
285 286
    QByteArray m_inbuffer;

287
    QHash<int, GdbCommand> m_cookieForToken;
con's avatar
con committed
288 289 290 291 292 293 294 295 296 297 298 299
    QHash<int, QByteArray> m_customOutputForToken;

    QByteArray m_pendingConsoleStreamOutput;
    QByteArray m_pendingTargetStreamOutput;
    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
300
    int m_gdbBuildVersion; // MAC only?
con's avatar
con committed
301 302

    // awful hack to keep track of used files
303 304
    QMap<QString, QString> m_shortToFullName;
    QMap<QString, QString> m_fullToShortName;
con's avatar
con committed
305 306 307 308

    //
    // Breakpoint specific stuff
    //
hjk's avatar
hjk committed
309
    void handleBreakList(const GdbResponse &response);
con's avatar
con committed
310
    void handleBreakList(const GdbMi &table);
hjk's avatar
hjk committed
311 312 313 314 315
    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
316 317 318 319 320 321 322 323
    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
324
    void handleModulesList(const GdbResponse &response);
con's avatar
con committed
325 326 327 328


    //
    // Register specific stuff
hjk's avatar
hjk committed
329
    //
330
    Q_SLOT void reloadRegisters();
331
    void setRegisterValue(int nr, const QString &value);
hjk's avatar
hjk committed
332 333
    void handleRegisterListNames(const GdbResponse &response);
    void handleRegisterListValues(const GdbResponse &response);
con's avatar
con committed
334

335 336
    //
    // Source file specific stuff
hjk's avatar
hjk committed
337
    //
338
    void reloadSourceFiles();
con's avatar
con committed
339 340 341

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


    //
    // Tooltip specific stuff
hjk's avatar
hjk committed
352
    //
con's avatar
con committed
353 354 355 356 357 358 359 360 361
    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);

362
    void updateWatchData(const WatchData &data);
363
    Q_SLOT void updateWatchDataHelper(const WatchData &data);
hjk's avatar
hjk committed
364
    void rebuildModel();
con's avatar
con committed
365 366 367 368 369 370 371

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

    void maybeHandleInferiorPidChanged(const QString &pid);

372
    void tryLoadDebuggingHelpers();
373
    void tryQueryDebuggingHelpers();
374 375 376 377
    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
378

hjk's avatar
hjk committed
379 380 381 382 383 384 385 386 387 388 389 390 391
    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
392 393 394
    void handleVarListChildrenHelper(const GdbMi &child,
        const WatchData &parent);
    void setWatchDataType(WatchData &data, const GdbMi &mi);
395
    void setWatchDataDisplayedType(WatchData &data, const GdbMi &mi);
hjk's avatar
hjk committed
396
    void setLocals(const QList<GdbMi> &locals);
397 398
    void connectDebuggingHelperActions();
    void disconnectDebuggingHelperActions();
399
    AbstractGdbAdapter *determineAdapter(const DebuggerStartParametersPtr &dp) const;
hjk's avatar
hjk committed
400

401
    bool startModeAllowsDumpers() const;
402
    QString parseDisassembler(const GdbMi &lines);
con's avatar
con committed
403 404

    int m_pendingRequests;
hjk's avatar
hjk committed
405
    QSet<QString> m_processedNames;
con's avatar
con committed
406

407
    QtDumperHelper m_dumperHelper;
hjk's avatar
hjk committed
408

409
    DebuggingHelperState m_debuggingHelperState;
con's avatar
con committed
410 411 412 413
    QList<GdbMi> m_currentFunctionArgs;
    QString m_currentFrame;
    QMap<QString, QString> m_varToType;

hjk's avatar
hjk committed
414 415 416
    typedef void (GdbEngine::*Continuation)();
    // function called after all previous responses have been received
    Continuation m_continuationAfterDone;
hjk's avatar
hjk committed
417
    void startInferior();
hjk's avatar
hjk committed
418

419
    bool m_modulesListOutdated;
420

421
    QList<GdbCommand> m_commandsToRunOnTemporaryBreak;
hjk's avatar
hjk committed
422

hjk's avatar
hjk committed
423
    DebuggerStartParametersPtr m_startParameters;
424
    // make sure to re-initialize new members in initializeVariables();
425

426 427
    // only one of those is active at a given time, available in m_gdbAdapter
    AbstractGdbAdapter *m_gdbAdapter;  // pointer to one listed below
428 429
    AttachGdbAdapter *m_attachAdapter; // owned
    CoreGdbAdapter *m_coreAdapter;     // owned
430 431
    PlainGdbAdapter *m_plainAdapter;   // owned
    RemoteGdbAdapter *m_remoteAdapter; // owned
432
    TrkGdbAdapter *m_trkAdapter;       // owned
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; }
441

hjk's avatar
hjk committed
442
    OutputCollector m_outputCollector;
con's avatar
con committed
443 444 445 446 447
};

} // namespace Internal
} // namespace Debugger

448 449
Q_DECLARE_OPERATORS_FOR_FLAGS(Debugger::Internal::GdbEngine::GdbCommandFlags)

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