gdbengine.h 13.2 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
26
** contact the sales department at http://www.qtsoftware.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>
con's avatar
con committed
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
#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;

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

hjk's avatar
hjk committed
74

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

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

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

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

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

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

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

124 125
    Q_SLOT void setDebugDebuggingHelpers(const QVariant &on);
    Q_SLOT void setUseDebuggingHelpers(const QVariant &on);
126

con's avatar
con committed
127 128 129
    //
    // Own stuff
    //
130

con's avatar
con committed
131
    int currentFrame() const;
132
    //QString currentWorkingDirectory() const { return m_pwd; }
con's avatar
con committed
133 134 135

    bool supportsThreads() const;

136 137
    void initializeConnections();
    void initializeVariables();
con's avatar
con committed
138 139 140 141 142 143
    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 &);

144 145 146 147 148 149
public: // otherwise the Qt flag macros are unhappy
    enum GdbCommandFlag {
        NoFlags = 0,
        NeedsStop = 1,
        Discardable = 2,
        RebuildModel = 4,
150 151
        WatchUpdate = Discardable|RebuildModel,
        EmbedToken = 8
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
    };
    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;
    };

con's avatar
con committed
169 170 171 172
    // 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.
173
    void flushCommand(GdbCommand &cmd);
174
    void postCommand(const QString &command,
175 176 177 178
                     GdbCommandFlags flags,
                     GdbCommandCallback callback = 0,
                     const char *callbackName = 0,
                     const QVariant &cookie = QVariant());
179
    void postCommand(const QString &command,
180 181 182
                     GdbCommandCallback callback = 0,
                     const char *callbackName = 0,
                     const QVariant &cookie = QVariant());
con's avatar
con committed
183 184 185 186 187 188 189 190 191

    void setTokenBarrier();

    void updateLocals();

private slots:
    void gdbProcError(QProcess::ProcessError error);
    void readGdbStandardOutput();
    void readGdbStandardError();
192 193
    void readUploadStandardOutput();
    void readUploadStandardError();
194
    void readDebugeeOutput(const QByteArray &data);
195 196
    void stubStarted();
    void stubError(const QString &msg);
197
    void uploadProcError(QProcess::ProcessError error);
con's avatar
con committed
198 199 200

private:
    int terminationIndex(const QByteArray &buffer, int &length);
201
    void handleResponse(const QByteArray &buff);
202 203 204
    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
205
    void handleAqcuiredInferior();
206
    void handleAsyncOutput2(const GdbResultRecord &, const QVariant &cookie);
con's avatar
con committed
207 208 209
    void handleAsyncOutput2(const GdbMi &data);
    void handleAsyncOutput(const GdbMi &data);
    void handleResultRecord(const GdbResultRecord &response);
210 211 212 213 214 215 216 217 218 219 220 221
    void handleFileExecAndSymbols(const GdbResultRecord &response, const QVariant &);
    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 &);
222 223
    void handleSetTargetAsync(const GdbResultRecord &, const QVariant &);
    void handleTargetRemote(const GdbResultRecord &, const QVariant &);
224
    void handleWatchPoint(const GdbResultRecord &, const QVariant &);
hjk's avatar
hjk committed
225
    void debugMessage(const QString &msg);
226
    bool showToolTip();
con's avatar
con committed
227

228 229
    const bool m_dumperInjectionLoad;

230 231 232 233
    OutputCollector m_outputCollector;
    QTextCodec *m_outputCodec;
    QTextCodec::ConverterState m_outputCodecState;

con's avatar
con committed
234 235 236
    QByteArray m_inbuffer;

    QProcess m_gdbProc;
237
    QProcess m_uploadProc;
con's avatar
con committed
238

239 240
    Core::Utils::ConsoleProcess m_stubProc;

241
    QHash<int, GdbCommand> m_cookieForToken;
con's avatar
con committed
242 243 244 245 246 247 248 249 250 251 252 253
    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
254
    int m_gdbBuildVersion; // MAC only? 
con's avatar
con committed
255 256

    // awful hack to keep track of used files
257 258
    QMap<QString, QString> m_shortToFullName;
    QMap<QString, QString> m_fullToShortName;
con's avatar
con committed
259 260 261 262

    //
    // Breakpoint specific stuff
    //
263
    void handleBreakList(const GdbResultRecord &record, const QVariant &);
con's avatar
con committed
264
    void handleBreakList(const GdbMi &table);
265 266 267 268 269
    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
270 271 272 273 274 275 276 277 278
    void extractDataFromInfoBreak(const QString &output, BreakpointData *data);
    void breakpointDataFromOutput(BreakpointData *data, const GdbMi &bkpt);
    void sendInsertBreakpoint(int index);


    //
    // Disassembler specific stuff
    //
    void handleDisassemblerList(const GdbResultRecord &record,
279
        const QVariant &cookie);
con's avatar
con committed
280 281 282 283 284 285 286 287
    void reloadDisassembler();
    QString m_address;


    //
    // Modules specific stuff
    //
    void reloadModules();
288
    void handleModulesList(const GdbResultRecord &record, const QVariant &);
con's avatar
con committed
289 290 291 292 293


    //
    // Register specific stuff
    // 
294
    Q_SLOT void reloadRegisters();
295 296
    void handleRegisterListNames(const GdbResultRecord &record, const QVariant &);
    void handleRegisterListValues(const GdbResultRecord &record, const QVariant &);
con's avatar
con committed
297

298 299 300 301
    //
    // Source file specific stuff
    // 
    void reloadSourceFiles();
con's avatar
con committed
302 303 304 305

    //
    // Stack specific stuff
    // 
306 307 308
    void handleStackListFrames(const GdbResultRecord &record, const QVariant &cookie);
    void handleStackSelectThread(const GdbResultRecord &, const QVariant &);
    void handleStackListThreads(const GdbResultRecord &record, const QVariant &cookie);
309 310
    Q_SLOT void reloadStack();
    Q_SLOT void reloadFullStack();
con's avatar
con committed
311 312 313 314 315 316 317 318 319 320 321 322 323 324


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

hjk's avatar
hjk committed
325 326
    void updateWatchData(const WatchData &data);
    void rebuildModel();
con's avatar
con committed
327 328 329 330 331 332 333

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

    void maybeHandleInferiorPidChanged(const QString &pid);

334
    void tryLoadDebuggingHelpers();
335
    void tryQueryDebuggingHelpers();
336 337 338 339
    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
340 341

    void handleVarListChildren(const GdbResultRecord &record,
342
        const QVariant &cookie);
con's avatar
con committed
343
    void handleVarCreate(const GdbResultRecord &record,
344 345
        const QVariant &cookie);
    void handleVarAssign(const GdbResultRecord &, const QVariant &);
con's avatar
con committed
346
    void handleEvaluateExpression(const GdbResultRecord &record,
347
        const QVariant &cookie);
348 349
    //void handleToolTip(const GdbResultRecord &record,
    //    const QVariant &cookie);
350
    void handleQueryDebuggingHelper(const GdbResultRecord &record, const QVariant &);
351
    void handleDebuggingHelperValue1(const GdbResultRecord &record,
352
        const QVariant &cookie);
353
    void handleDebuggingHelperValue2(const GdbResultRecord &record,
354
        const QVariant &cookie);
355
    void handleDebuggingHelperValue3(const GdbResultRecord &record,
356
        const QVariant &cookie);
357
    void handleDebuggingHelperEditValue(const GdbResultRecord &record);
358 359 360
    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
361 362 363
    void handleVarListChildrenHelper(const GdbMi &child,
        const WatchData &parent);
    void setWatchDataType(WatchData &data, const GdbMi &mi);
hjk's avatar
hjk committed
364
    void setLocals(const QList<GdbMi> &locals);
365 366
   
    bool startModeAllowsDumpers() const;
con's avatar
con committed
367 368 369

    int m_pendingRequests;

370
    QtDumperHelper m_dumperHelper;
con's avatar
con committed
371
    
372
    DebuggingHelperState m_debuggingHelperState;
con's avatar
con committed
373 374 375 376
    QList<GdbMi> m_currentFunctionArgs;
    QString m_currentFrame;
    QMap<QString, QString> m_varToType;

377
    bool m_autoContinue;
378
    bool m_waitingForFirstBreakpointToBeHit;
379
    bool m_modulesListOutdated;
380

381
    QList<GdbCommand> m_commandsToRunOnTemporaryBreak;
hjk's avatar
hjk committed
382

383 384 385
    DebuggerManager * const q;
    IDebuggerManagerAccessForEngines * const qq;
    // make sure to re-initialize new members in initializeVariables();
con's avatar
con committed
386 387 388 389 390
};

} // namespace Internal
} // namespace Debugger

391 392
Q_DECLARE_OPERATORS_FOR_FLAGS(Debugger::Internal::GdbEngine::GdbCommandFlags)

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