gdbengine.h 16.5 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 TermGdbAdapter;
96
    friend class RemoteGdbAdapter;
97
    friend class TrkGdbAdapter;
hjk's avatar
hjk committed
98

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

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

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

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

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

112
    virtual void executeDebuggerCommand(const QString &command);
con's avatar
con committed
113

114
private: ////////// General State //////////
con's avatar
con committed
115

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

122 123
    DebuggerStartParametersPtr m_startParameters;
    QSharedPointer<TrkOptions> m_trkOptions;
124
    bool m_registerNamesListed;
125

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

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

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

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

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

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

153 154
    void handleInferiorPrepared();

155 156 157
    void handleInferiorStartFailed(const QString &msg);

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

159 160 161 162 163
private:
    QTextCodec *m_outputCodec;
    QTextCodec::ConverterState m_outputCodecState;

    QByteArray m_inbuffer;
164
    bool m_busy;
con's avatar
con committed
165

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

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

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

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);
230
    void flushQueuedCommands();
con's avatar
con committed
231 232
    void setTokenBarrier();

233
    QHash<int, GdbCommand> m_cookieForToken;
con's avatar
con committed
234

235 236
    QByteArray m_pendingConsoleStreamOutput;
    QByteArray m_pendingLogStreamOutput;
237

238 239 240 241
    // 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
242

243
    int m_pendingRequests; // Watch updating commands in flight
hjk's avatar
hjk committed
244

245 246 247
    typedef void (GdbEngine::*CommandsDoneCallback)();
    // function called after all previous responses have been received
    CommandsDoneCallback m_commandsDoneCallback;
hjk's avatar
hjk committed
248

249 250 251
    QList<GdbCommand> m_commandsToRunOnTemporaryBreak;

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

253
    void handleResponse(const QByteArray &buff);
254
    void handleStopResponse(const GdbMi &data);
255
    void handleResultRecord(GdbResponse *response);
hjk's avatar
hjk committed
256
    void handleStop1(const GdbResponse &response);
257
    void handleStop1(const GdbMi &data);
258 259 260 261 262 263
    StackFrame parseStackFrame(const GdbMi &mi, int level);

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

    // Gdb initialization sequence
hjk's avatar
hjk committed
264
    void handleShowVersion(const GdbResponse &response);
hjk's avatar
hjk committed
265
    void handleIsSynchroneous(const GdbResponse &response);
con's avatar
con committed
266

267
    int m_gdbVersion; // 6.8.0 is 60800
268
    int m_gdbBuildVersion; // MAC only?
269
    bool m_isMacGdb;
270
    bool m_isSynchroneous; // Can act synchroneously?
hjk's avatar
hjk committed
271

272
private: ////////// Inferior Management //////////
273

274
    // This should be always the last call in a function.
275
    Q_SLOT virtual void attemptBreakpointSynchronization();
276

277 278 279 280 281
    virtual void stepExec();
    virtual void stepOutExec();
    virtual void nextExec();
    virtual void stepIExec();
    virtual void nextIExec();
con's avatar
con committed
282

283 284 285 286
    void continueInferiorInternal();
    void autoContinueInferior();
    virtual void continueInferior();
    virtual void interruptInferior();
287
    void interruptInferiorTemporarily();
con's avatar
con committed
288

289 290 291 292
    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
293

294
    void handleExecContinue(const GdbResponse &response);
con's avatar
con committed
295

296 297 298
    qint64 inferiorPid() const { return m_manager->inferiorPid(); }
    void handleInferiorPidChanged(qint64 pid) { manager()->notifyInferiorPidChanged(pid); }
    void maybeHandleInferiorPidChanged(const QString &pid);
con's avatar
con committed
299

300 301 302 303
#ifdef Q_OS_LINUX
    QByteArray m_entryPoint;
#endif

304 305 306 307 308 309
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
310 311 312 313

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

    //
    // Modules specific stuff
    //
329 330 331
    virtual void loadSymbols(const QString &moduleName);
    virtual void loadAllSymbols();
    virtual QList<Symbol> moduleSymbols(const QString &moduleName);
332
    virtual void reloadModules();
333
    void reloadModulesInternal();
hjk's avatar
hjk committed
334
    void handleModulesList(const GdbResponse &response);
con's avatar
con committed
335

336
    bool m_modulesListOutdated;
con's avatar
con committed
337 338 339

    //
    // Register specific stuff
hjk's avatar
hjk committed
340
    //
341 342
    Q_SLOT virtual void reloadRegisters();
    virtual void setRegisterValue(int nr, const QString &value);
hjk's avatar
hjk committed
343 344
    void handleRegisterListNames(const GdbResponse &response);
    void handleRegisterListValues(const GdbResponse &response);
con's avatar
con committed
345

346 347 348 349 350 351 352 353 354 355 356 357
    //
    // 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);

358 359
    //
    // Source file specific stuff
hjk's avatar
hjk committed
360
    //
361
    virtual void reloadSourceFiles();
362
    void reloadSourceFilesInternal();
363 364 365
    void handleQuerySources(const GdbResponse &response);

    QString fullName(const QString &fileName);
366 367 368 369 370
#ifdef Q_OS_WIN
    QString cleanupFullName(const QString &fileName);
#else
    QString cleanupFullName(const QString &fileName) { return fileName; }
#endif
371 372 373 374

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

376 377 378
    bool m_sourcesListOutdated;
    bool m_sourcesListUpdating;

con's avatar
con committed
379 380
    //
    // Stack specific stuff
hjk's avatar
hjk committed
381
    //
382
    void updateAll();
hjk's avatar
hjk committed
383 384 385
    void handleStackListFrames(const GdbResponse &response);
    void handleStackSelectThread(const GdbResponse &response);
    void handleStackListThreads(const GdbResponse &response);
386
    void handleStackFrame(const GdbResponse &response);
hjk's avatar
hjk committed
387
    Q_SLOT void reloadStack(bool forceGotoLocation);
388
    Q_SLOT virtual void reloadFullStack();
389
    int currentFrame() const;
con's avatar
con committed
390

391 392
    QList<GdbMi> m_currentFunctionArgs;
    QString m_currentFrame;
con's avatar
con committed
393 394

    //
395
    // Watch specific stuff
hjk's avatar
hjk committed
396
    //
397
    virtual void setToolTipExpression(const QPoint &mousePos, TextEditor::ITextEditor *editor, int cursorPos);
con's avatar
con committed
398

399 400 401 402 403 404 405
    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
406 407 408

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

412
    void virtual updateWatchData(const WatchData &data);
413
    Q_SLOT void updateWatchDataHelper(const WatchData &data);
hjk's avatar
hjk committed
414
    void rebuildModel();
415
    bool showToolTip();
con's avatar
con committed
416 417 418 419 420

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

421 422 423
    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
424

hjk's avatar
hjk committed
425
    void handleVarListChildren(const GdbResponse &response);
426 427
    void handleVarListChildrenHelper(const GdbMi &child,
        const WatchData &parent);
hjk's avatar
hjk committed
428 429 430 431 432 433 434 435 436
    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);
437 438

    void updateLocals(const QVariant &cookie = QVariant());
hjk's avatar
hjk committed
439
    void handleStackListLocals(const GdbResponse &response);
440 441 442 443
    WatchData localVariable(const GdbMi &item,
                            const QStringList &uninitializedVariables,
                            QMap<QByteArray, int> *seen);
    void setLocals(const QList<GdbMi> &locals);
hjk's avatar
hjk committed
444
    void handleStackListArguments(const GdbResponse &response);
con's avatar
con committed
445
    void setWatchDataType(WatchData &data, const GdbMi &mi);
446
    void setWatchDataDisplayedType(WatchData &data, const GdbMi &mi);
con's avatar
con committed
447

hjk's avatar
hjk committed
448
    QSet<QString> m_processedNames;
con's avatar
con committed
449 450
    QMap<QString, QString> m_varToType;

451
private: ////////// Dumper Management //////////
hjk's avatar
hjk committed
452

453 454 455 456 457 458 459 460
    bool startModeAllowsDumpers() const;
    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);
461

462 463 464
    const bool m_dumperInjectionLoad;
    DebuggingHelperState m_debuggingHelperState;
    QtDumperHelper m_dumperHelper;
465

466
private: ////////// Convenience Functions //////////
hjk's avatar
hjk committed
467

468
    QString errorMessage(QProcess::ProcessError error);
469
    void showMessageBox(int icon, const QString &title, const QString &text);
470
    void debugMessage(const QString &msg);
471
    QMainWindow *mainWindow() const;
con's avatar
con committed
472 473 474 475 476
};

} // namespace Internal
} // namespace Debugger

477 478
Q_DECLARE_OPERATORS_FOR_FLAGS(Debugger::Internal::GdbEngine::GdbCommandFlags)

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