gdbengine.h 18.5 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2010 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 "debuggerengine.h"
34

35
#include "gdbmi.h"
ck's avatar
ck committed
36
#include "localgdbprocess.h"
37
#include "stackframe.h"
38
#include "watchutils.h"
39

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

QT_BEGIN_NAMESPACE
54 55
class QMainWindow;
class QMessageBox;
56
class QTimer;
con's avatar
con committed
57 58 59 60 61
QT_END_NAMESPACE

namespace Debugger {
namespace Internal {

hjk's avatar
hjk committed
62
class AbstractGdbAdapter;
ck's avatar
ck committed
63
class AbstractGdbProcess;
hjk's avatar
hjk committed
64
class GdbResponse;
con's avatar
con committed
65 66 67
class GdbMi;

class BreakpointData;
68
class WatchData;
69
class DisassemblerAgentCookie;
con's avatar
con committed
70

71 72
class AttachGdbAdapter;
class CoreGdbAdapter;
ck's avatar
ck committed
73 74
class LocalPlainGdbAdapter;
class RemoteGdbServerAdapter;
75
class TrkGdbAdapter;
76

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

85

86
class GdbEngine : public DebuggerEngine
con's avatar
con committed
87 88 89 90
{
    Q_OBJECT

public:
91
    explicit GdbEngine(const DebuggerStartParameters &startParameters);
con's avatar
con committed
92 93 94
    ~GdbEngine();

private:
95
    friend class AbstractGdbAdapter;
ck's avatar
ck committed
96
    friend class AbstractPlainGdbAdapter;
97 98
    friend class AttachGdbAdapter;
    friend class CoreGdbAdapter;
ck's avatar
ck committed
99
    friend class LocalPlainGdbAdapter;
100
    friend class TermGdbAdapter;
ck's avatar
ck committed
101 102
    friend class RemoteGdbServerAdapter;
    friend class RemotePlainGdbAdapter;
103
    friend class TrkGdbAdapter;
104
    friend class TcfTrkGdbAdapter;
hjk's avatar
hjk committed
105

106
private: ////////// General Interface //////////
con's avatar
con committed
107

108
    virtual void startDebugger();
109
    virtual unsigned debuggerCapabilities() const;
110
    virtual void exitDebugger();
111
    virtual void quitDebugger();
112 113
    virtual void detachDebugger();
    virtual void shutdown();
con's avatar
con committed
114

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

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

120 121 122
    void initializeVariables();
    DebuggerStartMode startMode() const;
    Q_SLOT void setAutoDerefPointers(const QVariant &on);
123

124
    bool m_registerNamesListed;
125

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

128
    AbstractGdbAdapter *createAdapter();
129
    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
private slots:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
139 140
    void handleGdbFinished(int, QProcess::ExitStatus status);
    void handleGdbError(QProcess::ProcessError error);
141 142 143
    void readGdbStandardOutput();
    void readGdbStandardError();
    void readDebugeeOutput(const QByteArray &data);
con's avatar
con committed
144

145
    void handleAdapterStarted();
146 147
    void handleAdapterStartFailed(const QString &msg,
        const QString &settingsIdHint = QString());
con's avatar
con committed
148

149 150
    void handleInferiorPrepared();

151 152 153
    void handleInferiorStartFailed(const QString &msg);

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

155 156 157 158 159
private:
    QTextCodec *m_outputCodec;
    QTextCodec::ConverterState m_outputCodecState;

    QByteArray m_inbuffer;
160
    bool m_busy;
con's avatar
con committed
161

162 163
    AbstractGdbAdapter *m_gdbAdapter;

164 165 166 167
    // Name of the convenience variable containing the last
    // known function return value.
    QByteArray m_resultVarName;

168 169
private: ////////// Gdb Command Management //////////

170
    public: // Otherwise the Qt flag macros are unhappy.
171 172
    enum GdbCommandFlag {
        NoFlags = 0,
173 174 175 176 177 178
        // The command needs a stopped inferior.
        NeedsStop = 1, 
        // No need to wait for the reply before continuing inferior.
        Discardable = 2,
        // Trigger watch model rebuild when no such commands are pending anymore.
        RebuildWatchModel = 4,
179
        WatchUpdate = Discardable | RebuildWatchModel,
hjk's avatar
hjk committed
180
        // We can live without receiving an answer.
181 182 183 184 185 186 187 188 189
        NonCriticalResponse = 8,
        // Callback expects GdbResultRunning instead of GdbResultDone.
        RunRequest = 16,
        // Callback expects GdbResultExit instead of GdbResultDone.
        ExitRequest = 32,
        // Auto-set inferior shutdown related states.
        LosesChild = 64,
        // Trigger breakpoint model rebuild when no such commands are pending anymore.
        RebuildBreakpointModel = 128,
190 191
        // This command needs to be send immediately.
        Immediate = 256,
192 193
        // This is a command that needs to be wrapped into -interpreter-exec console
        ConsoleCommand = 512,
194 195
    };
    Q_DECLARE_FLAGS(GdbCommandFlags, GdbCommandFlag)
196
    private:
197

hjk's avatar
hjk committed
198
    typedef void (GdbEngine::*GdbCommandCallback)
hjk's avatar
hjk committed
199
        (const GdbResponse &response);
hjk's avatar
hjk committed
200
    typedef void (AbstractGdbAdapter::*AdapterCallback)
hjk's avatar
hjk committed
201
        (const GdbResponse &response);
202 203 204

    struct GdbCommand
    {
hjk's avatar
hjk committed
205 206 207
        GdbCommand()
            : flags(0), callback(0), adapterCallback(0), callbackName(0)
        {}
208 209 210

        int flags;
        GdbCommandCallback callback;
hjk's avatar
hjk committed
211
        AdapterCallback adapterCallback;
212
        const char *callbackName;
213
        QByteArray command;
214
        QVariant cookie;
215
        QTime postTime;
216 217
    };

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

246
    QHash<int, GdbCommand> m_cookieForToken;
247
    int commandTimeoutTime() const;
248
    QTimer *m_commandTimer;
con's avatar
con committed
249

250 251
    QByteArray m_pendingConsoleStreamOutput;
    QByteArray m_pendingLogStreamOutput;
252

253
    // This contains the first token number for the current round
254 255 256
    // of evaluation. Responses with older tokens are considers
    // out of date and discarded.
    int m_oldestAcceptableToken;
con's avatar
con committed
257

258
    int m_pendingWatchRequests; // Watch updating commands in flight
259
    int m_pendingBreakpointRequests; // Watch updating commands in flight
hjk's avatar
hjk committed
260

261
    typedef void (GdbEngine::*CommandsDoneCallback)();
262
    // This function is called after all previous responses have been received.
263
    CommandsDoneCallback m_commandsDoneCallback;
hjk's avatar
hjk committed
264

265
    QList<GdbCommand> m_commandsToRunOnTemporaryBreak;
hjk's avatar
hjk committed
266
    int gdbVersion() const { return m_gdbVersion; }
267 268

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

270
    void handleResponse(const QByteArray &buff);
271
    void handleStopResponse(const GdbMi &data);
272
    void handleResultRecord(GdbResponse *response);
hjk's avatar
hjk committed
273
    void handleStop1(const GdbResponse &response);
274
    void handleStop1(const GdbMi &data);
275 276
    StackFrame parseStackFrame(const GdbMi &mi, int level);

hjk's avatar
hjk committed
277
    bool isSynchroneous() const { return hasPython(); }
278
    virtual bool hasPython() const;
279 280 281
    bool supportsThreads() const;

    // Gdb initialization sequence
hjk's avatar
hjk committed
282
    void handleShowVersion(const GdbResponse &response);
283
    void handleHasPython(const GdbResponse &response);
con's avatar
con committed
284

285
    int m_gdbVersion; // 6.8.0 is 60800
286
    int m_gdbBuildVersion; // MAC only?
287
    bool m_isMacGdb;
288
    bool m_hasPython;
hjk's avatar
hjk committed
289

290
private: ////////// Inferior Management //////////
291

292
    // This should be always the last call in a function.
293
    Q_SLOT virtual void attemptBreakpointSynchronization();
294

hjk's avatar
hjk committed
295 296 297 298 299
    virtual void executeStep();
    virtual void executeStepOut();
    virtual void executeNext();
    virtual void executeStepI();
    virtual void executeNextI();
con's avatar
con committed
300

301 302 303 304
    void continueInferiorInternal();
    void autoContinueInferior();
    virtual void continueInferior();
    virtual void interruptInferior();
305
    void interruptInferiorTemporarily();
con's avatar
con committed
306

hjk's avatar
hjk committed
307 308 309 310
    virtual void executeRunToLine(const QString &fileName, int lineNumber);
    virtual void executeRunToFunction(const QString &functionName);
    virtual void executeJumpToLine(const QString &fileName, int lineNumber);
    virtual void executeReturn();
con's avatar
con committed
311

hjk's avatar
hjk committed
312 313 314 315
    void handleExecuteContinue(const GdbResponse &response);
    void handleExecuteStep(const GdbResponse &response);
    void handleExecuteNext(const GdbResponse &response);
    void handleExecuteReturn(const GdbResponse &response);
316
    void handleExecuteJumpToLine(const GdbResponse &response);
317 318
    void handleExecuteRunToLine(const GdbResponse &response);
    //void handleExecuteRunToFunction(const GdbResponse &response);
con's avatar
con committed
319

320
    void maybeHandleInferiorPidChanged(const QString &pid);
321 322
    void handleInfoProc(const GdbResponse &response);

323
    QByteArray m_entryPoint;
hjk's avatar
hjk committed
324
    QFutureInterface<void> *m_progress;
325

326 327 328 329 330
private: ////////// View & Data Stuff //////////

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

con's avatar
con committed
331 332 333
    //
    // Breakpoint specific stuff
    //
hjk's avatar
hjk committed
334
    void handleBreakList(const GdbResponse &response);
con's avatar
con committed
335
    void handleBreakList(const GdbMi &table);
hjk's avatar
hjk committed
336
    void handleBreakIgnore(const GdbResponse &response);
337
    void handleBreakDisable(const GdbResponse &response);
hjk's avatar
hjk committed
338
    void handleBreakInsert1(const GdbResponse &response);
339
    void handleBreakInsert2(const GdbResponse &response);
hjk's avatar
hjk committed
340 341
    void handleBreakCondition(const GdbResponse &response);
    void handleBreakInfo(const GdbResponse &response);
342
    void handleWatchInsert(const GdbResponse &response);
343
    void handleInfoLine(const GdbResponse &response);
con's avatar
con committed
344
    void extractDataFromInfoBreak(const QString &output, BreakpointData *data);
345
    void setBreakpointDataFromOutput(BreakpointData *data, const GdbMi &bkpt);
346
    QByteArray breakpointLocation(const BreakpointData *data);
con's avatar
con committed
347
    void sendInsertBreakpoint(int index);
348
    QString breakLocation(const QString &file) const;
349
    void reloadBreakListInternal();
con's avatar
con committed
350 351 352 353

    //
    // Modules specific stuff
    //
354 355
    virtual void loadSymbols(const QString &moduleName);
    virtual void loadAllSymbols();
hjk's avatar
hjk committed
356
    virtual void requestModuleSymbols(const QString &moduleName);
357
    virtual void reloadModules();
358
    void reloadModulesInternal();
hjk's avatar
hjk committed
359
    void handleModulesList(const GdbResponse &response);
con's avatar
con committed
360

361
    bool m_modulesListOutdated;
con's avatar
con committed
362

363 364 365 366 367 368 369 370 371
    //
    // Snapshot specific stuff
    //
    virtual void makeSnapshot();
    void handleMakeSnapshot(const GdbResponse &response);
    void handleActivateSnapshot(const GdbResponse &response);
    void activateSnapshot(int index);
    void activateSnapshot2();

con's avatar
con committed
372 373
    //
    // Register specific stuff
hjk's avatar
hjk committed
374
    //
375 376
    Q_SLOT virtual void reloadRegisters();
    virtual void setRegisterValue(int nr, const QString &value);
hjk's avatar
hjk committed
377 378
    void handleRegisterListNames(const GdbResponse &response);
    void handleRegisterListValues(const GdbResponse &response);
con's avatar
con committed
379

380 381 382
    //
    // Disassembler specific stuff
    //
383
    virtual void fetchDisassembler(DisassemblerViewAgent *agent);
384
    void fetchDisassemblerByAddress(const DisassemblerAgentCookie &ac,
385
        bool useMixedMode);
386
    void fetchDisassemblerByCli(const DisassemblerAgentCookie &ac,
387
        bool useMixedMode);
388
    void fetchDisassemblerByAddressCli(const DisassemblerAgentCookie &ac);
389
    void handleFetchDisassemblerByCli(const GdbResponse &response);
390 391 392 393 394
    void handleFetchDisassemblerByLine(const GdbResponse &response);
    void handleFetchDisassemblerByAddress1(const GdbResponse &response);
    void handleFetchDisassemblerByAddress0(const GdbResponse &response);
    QString parseDisassembler(const GdbMi &lines);

395 396
    //
    // Source file specific stuff
hjk's avatar
hjk committed
397
    //
398
    virtual void reloadSourceFiles();
399
    void reloadSourceFilesInternal();
400 401 402
    void handleQuerySources(const GdbResponse &response);

    QString fullName(const QString &fileName);
403 404 405 406 407
#ifdef Q_OS_WIN
    QString cleanupFullName(const QString &fileName);
#else
    QString cleanupFullName(const QString &fileName) { return fileName; }
#endif
408 409 410 411

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

413
    void invalidateSourcesList();
414 415
    bool m_sourcesListOutdated;
    bool m_sourcesListUpdating;
416
    bool m_breakListOutdated;
417

con's avatar
con committed
418 419
    //
    // Stack specific stuff
hjk's avatar
hjk committed
420
    //
421
    void updateAll();
422 423
        void updateAllClassic();
        void updateAllPython();
hjk's avatar
hjk committed
424 425
    void handleStackListFrames(const GdbResponse &response);
    void handleStackSelectThread(const GdbResponse &response);
426
    void handleStackSelectFrame(const GdbResponse &response);
427 428
    void handleThreadListIds(const GdbResponse &response);
    void handleThreadInfo(const GdbResponse &response);
hjk's avatar
hjk committed
429
    Q_SLOT void reloadStack(bool forceGotoLocation);
430
    Q_SLOT virtual void reloadFullStack();
431
    int currentFrame() const;
con's avatar
con committed
432

433 434
    QList<GdbMi> m_currentFunctionArgs;
    QString m_currentFrame;
con's avatar
con committed
435 436

    //
437
    // Watch specific stuff
hjk's avatar
hjk committed
438
    //
hjk's avatar
hjk committed
439 440
    virtual void setToolTipExpression(const QPoint &mousePos,
        TextEditor::ITextEditor *editor, int cursorPos);
con's avatar
con committed
441

442 443
    virtual void assignValueInDebugger(const QString &expr, const QString &value);

444 445
    virtual void fetchMemory(MemoryViewAgent *agent, QObject *token,
        quint64 addr, quint64 length);
446 447 448 449
    void handleFetchMemory(const GdbResponse &response);

    virtual void watchPoint(const QPoint &);
    void handleWatchPoint(const GdbResponse &response);
con's avatar
con committed
450 451

    // FIXME: BaseClass. called to improve situation for a watch item
452
    void updateSubItemClassic(const WatchData &data);
con's avatar
con committed
453

454
    void virtual updateWatchData(const WatchData &data);
455
    Q_SLOT void updateWatchDataHelper(const WatchData &data);
456
    void rebuildWatchModel();
457
    bool showToolTip();
con's avatar
con committed
458 459 460

    void insertData(const WatchData &data);
    void sendWatchParameters(const QByteArray &params0);
461
    void createGdbVariableClassic(const WatchData &data);
con's avatar
con committed
462

463 464
    void runDebuggingHelperClassic(const WatchData &data, bool dumpChildren);
    void runDirectDebuggingHelperClassic(const WatchData &data, bool dumpChildren);
465
    bool hasDebuggingHelperForType(const QString &type) const;
con's avatar
con committed
466

467 468
    void handleVarListChildrenClassic(const GdbResponse &response);
    void handleVarListChildrenHelperClassic(const GdbMi &child,
469
        const WatchData &parent);
hjk's avatar
hjk committed
470 471
    void handleVarCreate(const GdbResponse &response);
    void handleVarAssign(const GdbResponse &response);
472
    void handleEvaluateExpressionClassic(const GdbResponse &response);
473 474 475
    void handleQueryDebuggingHelperClassic(const GdbResponse &response);
    void handleDebuggingHelperValue2Classic(const GdbResponse &response);
    void handleDebuggingHelperValue3Classic(const GdbResponse &response);
hjk's avatar
hjk committed
476 477
    void handleDebuggingHelperEditValue(const GdbResponse &response);
    void handleDebuggingHelperSetup(const GdbResponse &response);
478
    void handleDebuggingHelperVersionCheckClassic(const GdbResponse &response);
479

480 481 482
    Q_SLOT void createFullBacktrace();
    void handleCreateFullBacktrace(const GdbResponse &response);

483
    void updateLocals(const QVariant &cookie = QVariant());
484 485 486
        void updateLocalsClassic(const QVariant &cookie);
        void updateLocalsPython(const QByteArray &varList);
            void handleStackFramePython(const GdbResponse &response);
487

488 489 490
    void handleStackListLocalsClassic(const GdbResponse &response);
    void handleStackListLocalsPython(const GdbResponse &response);

491 492 493 494
    WatchData localVariable(const GdbMi &item,
                            const QStringList &uninitializedVariables,
                            QMap<QByteArray, int> *seen);
    void setLocals(const QList<GdbMi> &locals);
495
    void handleStackListArgumentsClassic(const GdbResponse &response);
con's avatar
con committed
496

497
    QSet<QByteArray> m_processedNames;
con's avatar
con committed
498

499 500 501
    //
    // Dumper Management
    //
502
    bool checkDebuggingHelpers();
503 504 505 506 507
        bool checkDebuggingHelpersClassic();
    void setDebuggingHelperStateClassic(DebuggingHelperState);
    void tryLoadDebuggingHelpersClassic();
    void tryQueryDebuggingHelpersClassic();
    Q_SLOT void recheckDebuggingHelperAvailabilityClassic();
508 509
    void connectDebuggingHelperActions();
    void disconnectDebuggingHelperActions();
510
    Q_SLOT void setDebugDebuggingHelpersClassic(const QVariant &on);
511
    Q_SLOT void setUseDebuggingHelpers(const QVariant &on);
512

513 514
    DebuggingHelperState m_debuggingHelperState;
    QtDumperHelper m_dumperHelper;
515
    QString m_gdb;
516

517 518 519
    // 
    // Convenience Functions
    //
520
    QString errorMessage(QProcess::ProcessError error);
521 522
    QMessageBox *showMessageBox(int icon, const QString &title, const QString &text,
        int buttons = 0);
523
    QMainWindow *mainWindow() const;
ck's avatar
ck committed
524
    AbstractGdbProcess *gdbProc() const;
525

526 527
    static QString m_toolTipExpression;
    static QPoint m_toolTipPos;
528
    static QByteArray tooltipIName(const QString &exp);
529 530 531

    // HACK:
    StackFrame m_targetFrame;
con's avatar
con committed
532 533 534 535 536
};

} // namespace Internal
} // namespace Debugger

537 538
Q_DECLARE_OPERATORS_FOR_FLAGS(Debugger::Internal::GdbEngine::GdbCommandFlags)

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