gdbengine.h 15.7 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 "gdbprocessbase.h"
36
#include "outputcollector.h"
37
#include "watchutils.h"
38

39 40
#include <consoleprocess.h>

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

QT_BEGIN_NAMESPACE
class QAction;
class QAbstractItemModel;
class QWidget;
QT_END_NAMESPACE

namespace Debugger {
namespace Internal {

60

con's avatar
con committed
61 62 63 64 65 66 67 68
class DebuggerManager;
class IDebuggerManagerAccessForEngines;
class GdbResultRecord;
class GdbMi;

class WatchData;
class BreakpointData;

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

77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
class GdbProcess : public GdbProcessBase
{
public:
    GdbProcess(QObject *parent = 0)
        : GdbProcessBase(parent)
    {
        connect(&m_proc, SIGNAL(error(QProcess::ProcessError)),
            this, SIGNAL(error(QProcess::ProcessError)));
        connect(&m_proc, SIGNAL(readyReadStandardOutput()),
            this, SIGNAL(readyReadStandardOutput()));
        connect(&m_proc, SIGNAL(readyReadStandardError()),
            this, SIGNAL(readyReadStandardError()));
        connect(&m_proc, SIGNAL(finished(int, QProcess::ExitStatus)),
            this, SIGNAL(finished(int, QProcess::ExitStatus)));
    }

    void start(const QString &program, const QStringList &args,
        QIODevice::OpenMode mode) { m_proc.start(program, args, mode); }
    void kill() { m_proc.kill(); }
    void terminate() { m_proc.terminate(); }
    bool waitForStarted(int msecs) { return m_proc.waitForStarted(msecs); }
    bool waitForFinished(int msecs) { return m_proc.waitForFinished(msecs); }
    QProcess::ProcessState state() const { return m_proc.state(); }
    QString errorString() const { return m_proc.errorString(); }
    QByteArray readAllStandardError() { return m_proc.readAllStandardError(); }
    QByteArray readAllStandardOutput() { return m_proc.readAllStandardOutput(); }
    qint64 write(const char *data) { return m_proc.write(data); }
    void setWorkingDirectory(const QString &dir) { m_proc.setWorkingDirectory(dir); }
    void setEnvironment(const QStringList &env) { m_proc.setEnvironment(env); }

private:
    QProcess m_proc;
};
hjk's avatar
hjk committed
110

con's avatar
con committed
111 112 113 114 115
class GdbEngine : public IDebuggerEngine
{
    Q_OBJECT

public:
116
    GdbEngine(DebuggerManager *parent, GdbProcessBase *gdbProc);
con's avatar
con committed
117 118 119
    ~GdbEngine();

signals:
120 121
    void gdbInputAvailable(int channel, const QString &msg);
    void gdbOutputAvailable(int channel, const QString &msg);
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
122
    void applicationOutputAvailable(const QString &output);
con's avatar
con committed
123 124 125 126 127 128 129 130 131 132 133 134

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

    void shutdown();
135
    void setToolTipExpression(const QPoint &mousePos, TextEditor::ITextEditor *editor, int cursorPos);
136
    bool startDebugger(const QSharedPointer<DebuggerStartParameters> &sp);
con's avatar
con committed
137
    void exitDebugger();
138
    void detachDebugger();
con's avatar
con committed
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153

    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);
154
    void watchPoint(const QPoint &);
con's avatar
con committed
155 156 157

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

160 161 162
    void fetchMemory(MemoryViewAgent *agent, quint64 addr, quint64 length);
    void handleFetchMemory(const GdbResultRecord &record, const QVariant &cookie);

163 164 165 166 167 168 169 170 171 172 173
    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);

174 175
    Q_SLOT void setDebugDebuggingHelpers(const QVariant &on);
    Q_SLOT void setUseDebuggingHelpers(const QVariant &on);
176

con's avatar
con committed
177 178 179
    //
    // Own stuff
    //
180

con's avatar
con committed
181 182 183 184
    int currentFrame() const;

    bool supportsThreads() const;

185 186
    void initializeConnections();
    void initializeVariables();
con's avatar
con committed
187 188 189 190 191 192
    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 &);

193 194 195 196 197 198
public: // otherwise the Qt flag macros are unhappy
    enum GdbCommandFlag {
        NoFlags = 0,
        NeedsStop = 1,
        Discardable = 2,
        RebuildModel = 4,
199
        WatchUpdate = Discardable | RebuildModel,
200
        EmbedToken = 8
201 202 203
    };
    Q_DECLARE_FLAGS(GdbCommandFlags, GdbCommandFlag)

204
private:
205 206 207 208 209 210 211 212 213 214 215
    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;
216
        QTime postTime;
217 218
    };

con's avatar
con committed
219 220 221 222
    // 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.
223
    void flushCommand(GdbCommand &cmd);
224
    void postCommand(const QString &command,
225 226 227 228
                     GdbCommandFlags flags,
                     GdbCommandCallback callback = 0,
                     const char *callbackName = 0,
                     const QVariant &cookie = QVariant());
229
    void postCommand(const QString &command,
230 231 232
                     GdbCommandCallback callback = 0,
                     const char *callbackName = 0,
                     const QVariant &cookie = QVariant());
con's avatar
con committed
233 234 235 236 237 238 239 240 241

    void setTokenBarrier();

    void updateLocals();

private slots:
    void gdbProcError(QProcess::ProcessError error);
    void readGdbStandardOutput();
    void readGdbStandardError();
242 243
    void readUploadStandardOutput();
    void readUploadStandardError();
244
    void readDebugeeOutput(const QByteArray &data);
245 246
    void stubStarted();
    void stubError(const QString &msg);
247
    void uploadProcError(QProcess::ProcessError error);
con's avatar
con committed
248 249 250

private:
    int terminationIndex(const QByteArray &buffer, int &length);
251
    void handleResponse(const QByteArray &buff);
252 253 254
    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
255
    void handleAqcuiredInferior();
256
    void handleAsyncOutput2(const GdbResultRecord &, const QVariant &cookie);
con's avatar
con committed
257 258 259
    void handleAsyncOutput2(const GdbMi &data);
    void handleAsyncOutput(const GdbMi &data);
    void handleResultRecord(const GdbResultRecord &response);
260
    void handleFileExecAndSymbols(const GdbResultRecord &response, const QVariant &);
hjk's avatar
hjk committed
261
    void handleExecContinue(const GdbResultRecord &response, const QVariant &);
262 263 264 265 266 267 268 269 270 271 272
    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 &);
273 274
    void handleSetTargetAsync(const GdbResultRecord &, const QVariant &);
    void handleTargetRemote(const GdbResultRecord &, const QVariant &);
275
    void handleWatchPoint(const GdbResultRecord &, const QVariant &);
hjk's avatar
hjk committed
276
    void debugMessage(const QString &msg);
277
    bool showToolTip();
con's avatar
con committed
278

279 280
    void handleChildren(const WatchData &parent, const GdbMi &child,
        QList<WatchData> *insertions);
281 282
    const bool m_dumperInjectionLoad;

283 284 285 286
    OutputCollector m_outputCollector;
    QTextCodec *m_outputCodec;
    QTextCodec::ConverterState m_outputCodecState;

con's avatar
con committed
287 288
    QByteArray m_inbuffer;

289
    GdbProcessBase *m_gdbProc;
290
    QProcess m_uploadProc;
con's avatar
con committed
291

292 293
    Core::Utils::ConsoleProcess m_stubProc;

294
    QHash<int, GdbCommand> m_cookieForToken;
con's avatar
con committed
295 296 297 298 299 300 301 302 303 304 305 306
    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
307
    int m_gdbBuildVersion; // MAC only? 
con's avatar
con committed
308 309

    // awful hack to keep track of used files
310 311
    QMap<QString, QString> m_shortToFullName;
    QMap<QString, QString> m_fullToShortName;
con's avatar
con committed
312 313 314 315

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

    //
    // Modules specific stuff
    //
    void reloadModules();
331
    void handleModulesList(const GdbResultRecord &record, const QVariant &);
con's avatar
con committed
332 333 334 335 336


    //
    // Register specific stuff
    // 
337
    Q_SLOT void reloadRegisters();
338
    void setRegisterValue(int nr, const QString &value);
339 340
    void handleRegisterListNames(const GdbResultRecord &record, const QVariant &);
    void handleRegisterListValues(const GdbResultRecord &record, const QVariant &);
con's avatar
con committed
341

342 343 344 345
    //
    // Source file specific stuff
    // 
    void reloadSourceFiles();
con's avatar
con committed
346 347 348 349

    //
    // Stack specific stuff
    // 
350 351 352
    void handleStackListFrames(const GdbResultRecord &record, const QVariant &cookie);
    void handleStackSelectThread(const GdbResultRecord &, const QVariant &);
    void handleStackListThreads(const GdbResultRecord &record, const QVariant &cookie);
353 354
    Q_SLOT void reloadStack();
    Q_SLOT void reloadFullStack();
con's avatar
con committed
355 356 357 358 359 360 361 362 363 364 365 366 367 368


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

369
    void updateWatchData(const WatchData &data);
370
    Q_SLOT void updateWatchDataHelper(const WatchData &data);
hjk's avatar
hjk committed
371
    void rebuildModel();
con's avatar
con committed
372 373 374 375 376 377 378

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

    void maybeHandleInferiorPidChanged(const QString &pid);

379
    void tryLoadDebuggingHelpers();
380
    void tryQueryDebuggingHelpers();
381 382 383 384
    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
385 386

    void handleVarListChildren(const GdbResultRecord &record,
387
        const QVariant &cookie);
con's avatar
con committed
388
    void handleVarCreate(const GdbResultRecord &record,
389 390
        const QVariant &cookie);
    void handleVarAssign(const GdbResultRecord &, const QVariant &);
con's avatar
con committed
391
    void handleEvaluateExpression(const GdbResultRecord &record,
392
        const QVariant &cookie);
393 394
    //void handleToolTip(const GdbResultRecord &record,
    //    const QVariant &cookie);
395
    void handleQueryDebuggingHelper(const GdbResultRecord &record, const QVariant &);
396
    void handleDebuggingHelperValue1(const GdbResultRecord &record,
397
        const QVariant &cookie);
398
    void handleDebuggingHelperValue2(const GdbResultRecord &record,
399
        const QVariant &cookie);
400
    void handleDebuggingHelperValue3(const GdbResultRecord &record,
401
        const QVariant &cookie);
402
    void handleDebuggingHelperEditValue(const GdbResultRecord &record);
403 404 405
    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
406 407 408
    void handleVarListChildrenHelper(const GdbMi &child,
        const WatchData &parent);
    void setWatchDataType(WatchData &data, const GdbMi &mi);
409
    void setWatchDataDisplayedType(WatchData &data, const GdbMi &mi);
hjk's avatar
hjk committed
410
    void setLocals(const QList<GdbMi> &locals);
411 412
   
    bool startModeAllowsDumpers() const;
413
    QString parseDisassembler(const GdbMi &lines);
con's avatar
con committed
414 415

    int m_pendingRequests;
416
    QSet<QString> m_processedNames; 
con's avatar
con committed
417

418
    QtDumperHelper m_dumperHelper;
con's avatar
con committed
419
    
420
    DebuggingHelperState m_debuggingHelperState;
con's avatar
con committed
421 422 423 424
    QList<GdbMi> m_currentFunctionArgs;
    QString m_currentFrame;
    QMap<QString, QString> m_varToType;

425
    bool m_autoContinue;
426
    bool m_waitingForFirstBreakpointToBeHit;
427
    bool m_modulesListOutdated;
428

429
    QList<GdbCommand> m_commandsToRunOnTemporaryBreak;
hjk's avatar
hjk committed
430

431 432 433
    DebuggerManager * const q;
    IDebuggerManagerAccessForEngines * const qq;
    // make sure to re-initialize new members in initializeVariables();
con's avatar
con committed
434 435 436 437 438
};

} // namespace Internal
} // namespace Debugger

439 440
Q_DECLARE_OPERATORS_FOR_FLAGS(Debugger::Internal::GdbEngine::GdbCommandFlags)

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