gdbengine.h 18.6 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
    StackFrame parseStackFrame(const GdbMi &mi, int level);

hjk's avatar
hjk committed
267
    bool isSynchroneous() const { return hasPython(); }
268
    virtual bool hasPython() const;
269 270 271
    bool supportsThreads() const;

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

275
    int m_gdbVersion; // 6.8.0 is 60800
276
    int m_gdbBuildVersion; // MAC only?
277
    bool m_isMacGdb;
278
    bool m_hasPython;
hjk's avatar
hjk committed
279

280
private: ////////// Inferior Management //////////
281

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

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

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

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

302
    void handleExecContinue(const GdbResponse &response);
303 304
    void handleExecStep(const GdbResponse &response);
    void handleExecNext(const GdbResponse &response);
con's avatar
con committed
305

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

310
#ifdef Q_OS_LINUX
311 312
    void handleInfoProc(const GdbResponse &response);

313 314 315
    QByteArray m_entryPoint;
#endif

316 317 318 319 320 321
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
322 323 324 325

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

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

349
    bool m_modulesListOutdated;
con's avatar
con committed
350

351 352 353 354 355 356 357 358 359
    //
    // 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
360 361
    //
    // Register specific stuff
hjk's avatar
hjk committed
362
    //
363 364
    Q_SLOT virtual void reloadRegisters();
    virtual void setRegisterValue(int nr, const QString &value);
hjk's avatar
hjk committed
365 366
    void handleRegisterListNames(const GdbResponse &response);
    void handleRegisterListValues(const GdbResponse &response);
con's avatar
con committed
367

368 369 370
    //
    // Disassembler specific stuff
    //
371
    virtual void fetchDisassembler(DisassemblerViewAgent *agent);
372 373 374 375 376 377 378
    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);

379 380
    //
    // Source file specific stuff
hjk's avatar
hjk committed
381
    //
382
    virtual void reloadSourceFiles();
383
    void reloadSourceFilesInternal();
384 385 386
    void handleQuerySources(const GdbResponse &response);

    QString fullName(const QString &fileName);
387 388 389 390 391
#ifdef Q_OS_WIN
    QString cleanupFullName(const QString &fileName);
#else
    QString cleanupFullName(const QString &fileName) { return fileName; }
#endif
392 393 394 395

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

397
    void invalidateSourcesList();
398 399
    bool m_sourcesListOutdated;
    bool m_sourcesListUpdating;
400 401
    bool m_breakListOutdated;
    bool m_breakListUpdating;
402

con's avatar
con committed
403 404
    //
    // Stack specific stuff
hjk's avatar
hjk committed
405
    //
406
    void updateAll();
407 408
        void updateAllClassic();
        void updateAllPython();
hjk's avatar
hjk committed
409 410 411
    void handleStackListFrames(const GdbResponse &response);
    void handleStackSelectThread(const GdbResponse &response);
    void handleStackListThreads(const GdbResponse &response);
hjk's avatar
hjk committed
412
    Q_SLOT void reloadStack(bool forceGotoLocation);
413
    Q_SLOT virtual void reloadFullStack();
414
    int currentFrame() const;
con's avatar
con committed
415

416 417
    QList<GdbMi> m_currentFunctionArgs;
    QString m_currentFrame;
con's avatar
con committed
418 419

    //
420
    // Watch specific stuff
hjk's avatar
hjk committed
421
    //
422
    virtual void setToolTipExpression(const QPoint &mousePos, TextEditor::ITextEditor *editor, int cursorPos);
con's avatar
con committed
423

424 425 426 427 428 429 430
    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
431 432

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

437
    void virtual updateWatchData(const WatchData &data);
438
    Q_SLOT void updateWatchDataHelper(const WatchData &data);
hjk's avatar
hjk committed
439
    void rebuildModel();
440
    bool showToolTip();
con's avatar
con committed
441 442 443

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

446 447
    void runDebuggingHelperClassic(const WatchData &data, bool dumpChildren);
    void runDirectDebuggingHelperClassic(const WatchData &data, bool dumpChildren);
448
    bool hasDebuggingHelperForType(const QString &type) const;
con's avatar
con committed
449

450 451
    void handleVarListChildrenClassic(const GdbResponse &response);
    void handleVarListChildrenHelperClassic(const GdbMi &child,
452
        const WatchData &parent);
hjk's avatar
hjk committed
453 454
    void handleVarCreate(const GdbResponse &response);
    void handleVarAssign(const GdbResponse &response);
455
    void handleEvaluateExpressionClassic(const GdbResponse &response);
hjk's avatar
hjk committed
456
    //void handleToolTip(const GdbResponse &response);
457 458 459
    void handleQueryDebuggingHelperClassic(const GdbResponse &response);
    void handleDebuggingHelperValue2Classic(const GdbResponse &response);
    void handleDebuggingHelperValue3Classic(const GdbResponse &response);
hjk's avatar
hjk committed
460 461
    void handleDebuggingHelperEditValue(const GdbResponse &response);
    void handleDebuggingHelperSetup(const GdbResponse &response);
462 463

    void updateLocals(const QVariant &cookie = QVariant());
464 465 466
        void updateLocalsClassic(const QVariant &cookie);
        void updateLocalsPython(const QByteArray &varList);
            void handleStackFramePython(const GdbResponse &response);
467

468 469 470
    void handleStackListLocalsClassic(const GdbResponse &response);
    void handleStackListLocalsPython(const GdbResponse &response);

471 472 473 474
    WatchData localVariable(const GdbMi &item,
                            const QStringList &uninitializedVariables,
                            QMap<QByteArray, int> *seen);
    void setLocals(const QList<GdbMi> &locals);
475
    void handleStackListArgumentsClassic(const GdbResponse &response);
con's avatar
con committed
476
    void setWatchDataType(WatchData &data, const GdbMi &mi);
477
    void setWatchDataDisplayedType(WatchData &data, const GdbMi &mi);
con's avatar
con committed
478

479
    QSet<QByteArray> m_processedNames;
con's avatar
con committed
480 481
    QMap<QString, QString> m_varToType;

482
private: ////////// Dumper Management //////////
483 484
    QString qtDumperLibraryName() const;
    bool checkDebuggingHelpers();
485 486 487 488 489
        bool checkDebuggingHelpersClassic();
    void setDebuggingHelperStateClassic(DebuggingHelperState);
    void tryLoadDebuggingHelpersClassic();
    void tryQueryDebuggingHelpersClassic();
    Q_SLOT void recheckDebuggingHelperAvailabilityClassic();
490 491
    void connectDebuggingHelperActions();
    void disconnectDebuggingHelperActions();
492
    Q_SLOT void setDebugDebuggingHelpersClassic(const QVariant &on);
493
    Q_SLOT void setUseDebuggingHelpers(const QVariant &on);
494

495 496
    DebuggingHelperState m_debuggingHelperState;
    QtDumperHelper m_dumperHelper;
497

498
private: ////////// Convenience Functions //////////
hjk's avatar
hjk committed
499

500
    QString errorMessage(QProcess::ProcessError error);
501 502
    QMessageBox *showMessageBox(int icon, const QString &title, const QString &text,
        int buttons = 0);
503
    void debugMessage(const QString &msg);
504
    QMainWindow *mainWindow() const;
505

506 507 508
    static QString m_toolTipExpression;
    static QPoint m_toolTipPos;
    static QByteArray tooltipINameForExpression(const QByteArray &exp);
509 510 511 512 513 514 515 516 517 518 519 520

    static void setWatchDataValue(WatchData &data, const GdbMi &mi,
        int encoding = 0);
    static void setWatchDataEditValue(WatchData &data, const GdbMi &mi);
    static void setWatchDataValueToolTip(WatchData &data, const GdbMi &mi,
            int encoding = 0);
    static void setWatchDataChildCount(WatchData &data, const GdbMi &mi);
    static void setWatchDataValueEnabled(WatchData &data, const GdbMi &mi);
    static void setWatchDataValueEditable(WatchData &data, const GdbMi &mi);
    static void setWatchDataExpression(WatchData &data, const GdbMi &mi);
    static void setWatchDataAddress(WatchData &data, const GdbMi &mi);
    static void setWatchDataSAddress(WatchData &data, const GdbMi &mi);
con's avatar
con committed
521 522 523 524 525
};

} // namespace Internal
} // namespace Debugger

526 527
Q_DECLARE_OPERATORS_FOR_FLAGS(Debugger::Internal::GdbEngine::GdbCommandFlags)

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