gdbengine.h 13.8 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 34
#include "idebuggerengine.h"
#include "gdbmi.h"
35
#include "outputcollector.h"
36
#include "watchutils.h"
37

38 39
#include <consoleprocess.h>

con's avatar
con committed
40 41 42 43 44 45
#include <QtCore/QByteArray>
#include <QtCore/QHash>
#include <QtCore/QMap>
#include <QtCore/QObject>
#include <QtCore/QProcess>
#include <QtCore/QPoint>
46
#include <QtCore/QTextCodec>
47
#include <QtCore/QTime>
con's avatar
con committed
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
#include <QtCore/QVariant>

QT_BEGIN_NAMESPACE
class QAction;
class QAbstractItemModel;
class QWidget;
QT_END_NAMESPACE

namespace Debugger {
namespace Internal {

class DebuggerManager;
class IDebuggerManagerAccessForEngines;
class GdbResultRecord;
class GdbMi;

class WatchData;
class BreakpointData;

67
enum DebuggingHelperState
con's avatar
con committed
68
{
69 70 71 72
    DebuggingHelperUninitialized,
    DebuggingHelperLoadTried,
    DebuggingHelperAvailable,
    DebuggingHelperUnavailable,
con's avatar
con committed
73 74
};

hjk's avatar
hjk committed
75

con's avatar
con committed
76 77 78 79 80 81 82 83 84
class GdbEngine : public IDebuggerEngine
{
    Q_OBJECT

public:
    GdbEngine(DebuggerManager *parent);
    ~GdbEngine();

signals:
85 86
    void gdbInputAvailable(int channel, const QString &msg);
    void gdbOutputAvailable(int channel, const QString &msg);
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
87
    void applicationOutputAvailable(const QString &output);
con's avatar
con committed
88 89 90 91 92 93 94 95 96 97 98 99

private:
    //
    // IDebuggerEngine implementation
    //
    void stepExec();
    void stepOutExec();
    void nextExec();
    void stepIExec();
    void nextIExec();

    void shutdown();
100
    void setToolTipExpression(const QPoint &mousePos, TextEditor::ITextEditor *editor, int cursorPos);
101
    bool startDebugger(const QSharedPointer<DebuggerStartParameters> &sp);
con's avatar
con committed
102
    void exitDebugger();
103
    void detachDebugger();
con's avatar
con committed
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118

    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);
119
    void watchPoint(const QPoint &);
con's avatar
con committed
120 121 122

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

125 126 127
    void fetchMemory(MemoryViewAgent *agent, quint64 addr, quint64 length);
    void handleFetchMemory(const GdbResultRecord &record, const QVariant &cookie);

128 129 130 131 132 133 134 135 136 137 138
    void fetchDisassembler(DisassemblerViewAgent *agent,
        const StackFrame &frame);
    void fetchDisassemblerByAddress(DisassemblerViewAgent *agent,
        bool useMixedMode);
    void handleFetchDisassemblerByLine(const GdbResultRecord &record,
        const QVariant &cookie);
    void handleFetchDisassemblerByAddress1(const GdbResultRecord &record,
        const QVariant &cookie);
    void handleFetchDisassemblerByAddress0(const GdbResultRecord &record,
        const QVariant &cookie);

139 140
    Q_SLOT void setDebugDebuggingHelpers(const QVariant &on);
    Q_SLOT void setUseDebuggingHelpers(const QVariant &on);
141

con's avatar
con committed
142 143 144
    //
    // Own stuff
    //
145

con's avatar
con committed
146
    int currentFrame() const;
147
    //QString currentWorkingDirectory() const { return m_pwd; }
con's avatar
con committed
148 149 150

    bool supportsThreads() const;

151 152
    void initializeConnections();
    void initializeVariables();
con's avatar
con committed
153 154 155 156 157 158
    QString fullName(const QString &fileName);
    // get one usable name out of these, try full names first
    QString fullName(const QStringList &candidates);

    void handleResult(const GdbResultRecord &, int type, const QVariant &);

159 160 161 162 163 164
public: // otherwise the Qt flag macros are unhappy
    enum GdbCommandFlag {
        NoFlags = 0,
        NeedsStop = 1,
        Discardable = 2,
        RebuildModel = 4,
165 166
        WatchUpdate = Discardable|RebuildModel,
        EmbedToken = 8
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
    };
    Q_DECLARE_FLAGS(GdbCommandFlags, GdbCommandFlag)
private:

    typedef void (GdbEngine::*GdbCommandCallback)(const GdbResultRecord &record, const QVariant &cookie);

    struct GdbCommand
    {
        GdbCommand() : flags(0), callback(0), callbackName(0) {}

        int flags;
        GdbCommandCallback callback;
        const char *callbackName;
        QString command;
        QVariant cookie;
182
        QTime postTime;
183 184
    };

con's avatar
con committed
185 186 187 188
    // type and cookie are sender-internal data, opaque for the "event
    // queue". resultNeeded == true increments m_pendingResults on
    // send and decrements on receipt, effectively preventing 
    // watch model updates before everything is finished.
189
    void flushCommand(GdbCommand &cmd);
190
    void postCommand(const QString &command,
191 192 193 194
                     GdbCommandFlags flags,
                     GdbCommandCallback callback = 0,
                     const char *callbackName = 0,
                     const QVariant &cookie = QVariant());
195
    void postCommand(const QString &command,
196 197 198
                     GdbCommandCallback callback = 0,
                     const char *callbackName = 0,
                     const QVariant &cookie = QVariant());
con's avatar
con committed
199 200 201 202 203 204 205 206 207

    void setTokenBarrier();

    void updateLocals();

private slots:
    void gdbProcError(QProcess::ProcessError error);
    void readGdbStandardOutput();
    void readGdbStandardError();
208 209
    void readUploadStandardOutput();
    void readUploadStandardError();
210
    void readDebugeeOutput(const QByteArray &data);
211 212
    void stubStarted();
    void stubError(const QString &msg);
213
    void uploadProcError(QProcess::ProcessError error);
con's avatar
con committed
214 215 216

private:
    int terminationIndex(const QByteArray &buffer, int &length);
217
    void handleResponse(const QByteArray &buff);
218 219 220
    void handleStart(const GdbResultRecord &response, const QVariant &);
    void handleAttach(const GdbResultRecord &, const QVariant &);
    void handleStubAttached(const GdbResultRecord &, const QVariant &);
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
221
    void handleAqcuiredInferior();
222
    void handleAsyncOutput2(const GdbResultRecord &, const QVariant &cookie);
con's avatar
con committed
223 224 225
    void handleAsyncOutput2(const GdbMi &data);
    void handleAsyncOutput(const GdbMi &data);
    void handleResultRecord(const GdbResultRecord &response);
226
    void handleFileExecAndSymbols(const GdbResultRecord &response, const QVariant &);
hjk's avatar
hjk committed
227
    void handleExecContinue(const GdbResultRecord &response, const QVariant &);
228 229 230 231 232 233 234 235 236 237 238
    void handleExecRun(const GdbResultRecord &response, const QVariant &);
    void handleExecJumpToLine(const GdbResultRecord &response, const QVariant &);
    void handleExecRunToFunction(const GdbResultRecord &response, const QVariant &);
    void handleInfoShared(const GdbResultRecord &response, const QVariant &);
    void handleInfoProc(const GdbResultRecord &response, const QVariant &);
    void handleInfoThreads(const GdbResultRecord &response, const QVariant &);
    void handleShowVersion(const GdbResultRecord &response, const QVariant &);
    void handleQueryPwd(const GdbResultRecord &response, const QVariant &);
    void handleQuerySources(const GdbResultRecord &response, const QVariant &);
    void handleTargetCore(const GdbResultRecord &, const QVariant &);
    void handleExit(const GdbResultRecord &, const QVariant &);
239 240
    void handleSetTargetAsync(const GdbResultRecord &, const QVariant &);
    void handleTargetRemote(const GdbResultRecord &, const QVariant &);
241
    void handleWatchPoint(const GdbResultRecord &, const QVariant &);
hjk's avatar
hjk committed
242
    void debugMessage(const QString &msg);
243
    bool showToolTip();
con's avatar
con committed
244

245 246
    const bool m_dumperInjectionLoad;

247 248 249 250
    OutputCollector m_outputCollector;
    QTextCodec *m_outputCodec;
    QTextCodec::ConverterState m_outputCodecState;

con's avatar
con committed
251 252 253
    QByteArray m_inbuffer;

    QProcess m_gdbProc;
254
    QProcess m_uploadProc;
con's avatar
con committed
255

256 257
    Core::Utils::ConsoleProcess m_stubProc;

258
    QHash<int, GdbCommand> m_cookieForToken;
con's avatar
con committed
259 260 261 262 263 264 265 266 267 268 269 270
    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
271
    int m_gdbBuildVersion; // MAC only? 
con's avatar
con committed
272 273

    // awful hack to keep track of used files
274 275
    QMap<QString, QString> m_shortToFullName;
    QMap<QString, QString> m_fullToShortName;
con's avatar
con committed
276 277 278 279

    //
    // Breakpoint specific stuff
    //
280
    void handleBreakList(const GdbResultRecord &record, const QVariant &);
con's avatar
con committed
281
    void handleBreakList(const GdbMi &table);
282 283 284 285 286
    void handleBreakIgnore(const GdbResultRecord &record, const QVariant &cookie);
    void handleBreakInsert(const GdbResultRecord &record, const QVariant &cookie);
    void handleBreakInsert1(const GdbResultRecord &record, const QVariant &cookie);
    void handleBreakCondition(const GdbResultRecord &record, const QVariant &cookie);
    void handleBreakInfo(const GdbResultRecord &record, const QVariant &cookie);
con's avatar
con committed
287 288 289 290 291 292 293 294
    void extractDataFromInfoBreak(const QString &output, BreakpointData *data);
    void breakpointDataFromOutput(BreakpointData *data, const GdbMi &bkpt);
    void sendInsertBreakpoint(int index);

    //
    // Modules specific stuff
    //
    void reloadModules();
295
    void handleModulesList(const GdbResultRecord &record, const QVariant &);
con's avatar
con committed
296 297 298 299 300


    //
    // Register specific stuff
    // 
301
    Q_SLOT void reloadRegisters();
302 303
    void handleRegisterListNames(const GdbResultRecord &record, const QVariant &);
    void handleRegisterListValues(const GdbResultRecord &record, const QVariant &);
con's avatar
con committed
304

305 306 307 308
    //
    // Source file specific stuff
    // 
    void reloadSourceFiles();
con's avatar
con committed
309 310 311 312

    //
    // Stack specific stuff
    // 
313 314 315
    void handleStackListFrames(const GdbResultRecord &record, const QVariant &cookie);
    void handleStackSelectThread(const GdbResultRecord &, const QVariant &);
    void handleStackListThreads(const GdbResultRecord &record, const QVariant &cookie);
316 317
    Q_SLOT void reloadStack();
    Q_SLOT void reloadFullStack();
con's avatar
con committed
318 319 320 321 322 323 324 325 326 327 328 329 330 331


    //
    // Tooltip specific stuff
    // 
    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);

332
    void updateWatchData(const WatchData &data);
hjk's avatar
hjk committed
333
    void rebuildModel();
con's avatar
con committed
334 335 336 337 338 339 340

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

    void maybeHandleInferiorPidChanged(const QString &pid);

341
    void tryLoadDebuggingHelpers();
342
    void tryQueryDebuggingHelpers();
343 344 345 346
    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
347 348

    void handleVarListChildren(const GdbResultRecord &record,
349
        const QVariant &cookie);
con's avatar
con committed
350
    void handleVarCreate(const GdbResultRecord &record,
351 352
        const QVariant &cookie);
    void handleVarAssign(const GdbResultRecord &, const QVariant &);
con's avatar
con committed
353
    void handleEvaluateExpression(const GdbResultRecord &record,
354
        const QVariant &cookie);
355 356
    //void handleToolTip(const GdbResultRecord &record,
    //    const QVariant &cookie);
357
    void handleQueryDebuggingHelper(const GdbResultRecord &record, const QVariant &);
358
    void handleDebuggingHelperValue1(const GdbResultRecord &record,
359
        const QVariant &cookie);
360
    void handleDebuggingHelperValue2(const GdbResultRecord &record,
361
        const QVariant &cookie);
362
    void handleDebuggingHelperValue3(const GdbResultRecord &record,
363
        const QVariant &cookie);
364
    void handleDebuggingHelperEditValue(const GdbResultRecord &record);
365 366 367
    void handleDebuggingHelperSetup(const GdbResultRecord &record, const QVariant &);
    void handleStackListLocals(const GdbResultRecord &record, const QVariant &);
    void handleStackListArguments(const GdbResultRecord &record, const QVariant &);
con's avatar
con committed
368 369 370
    void handleVarListChildrenHelper(const GdbMi &child,
        const WatchData &parent);
    void setWatchDataType(WatchData &data, const GdbMi &mi);
hjk's avatar
hjk committed
371
    void setLocals(const QList<GdbMi> &locals);
372 373
   
    bool startModeAllowsDumpers() const;
con's avatar
con committed
374 375 376

    int m_pendingRequests;

377
    QtDumperHelper m_dumperHelper;
con's avatar
con committed
378
    
379
    DebuggingHelperState m_debuggingHelperState;
con's avatar
con committed
380 381 382 383
    QList<GdbMi> m_currentFunctionArgs;
    QString m_currentFrame;
    QMap<QString, QString> m_varToType;

384
    bool m_autoContinue;
385
    bool m_waitingForFirstBreakpointToBeHit;
386
    bool m_modulesListOutdated;
387

388
    QList<GdbCommand> m_commandsToRunOnTemporaryBreak;
hjk's avatar
hjk committed
389

390 391 392
    DebuggerManager * const q;
    IDebuggerManagerAccessForEngines * const qq;
    // make sure to re-initialize new members in initializeVariables();
con's avatar
con committed
393 394 395 396 397
};

} // namespace Internal
} // namespace Debugger

398 399
Q_DECLARE_OPERATORS_FOR_FLAGS(Debugger::Internal::GdbEngine::GdbCommandFlags)

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