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

40 41
#include <consoleprocess.h>

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

QT_BEGIN_NAMESPACE
class QAction;
class QAbstractItemModel;
class QWidget;
QT_END_NAMESPACE

namespace Debugger {
namespace Internal {

61

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

class WatchData;
class BreakpointData;

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

78 79 80 81 82 83 84 85 86 87 88 89
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()));
hjk's avatar
hjk committed
90 91
        connect(&m_proc, SIGNAL(started()),
            this, SIGNAL(started()));
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
        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); }
hjk's avatar
hjk committed
109
    bool isAdapter() const { return false; }
110 111 112 113

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

con's avatar
con committed
115 116 117 118 119
class GdbEngine : public IDebuggerEngine
{
    Q_OBJECT

public:
120
    GdbEngine(DebuggerManager *parent, GdbProcessBase *gdbProc);
con's avatar
con committed
121 122 123
    ~GdbEngine();

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

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

    void shutdown();
139
    void setToolTipExpression(const QPoint &mousePos, TextEditor::ITextEditor *editor, int cursorPos);
hjk's avatar
hjk committed
140 141
    void startDebugger(const QSharedPointer<DebuggerStartParameters> &sp);
    Q_SLOT void startDebugger2();
con's avatar
con committed
142
    void exitDebugger();
143
    void detachDebugger();
con's avatar
con committed
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158

    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);
159
    void watchPoint(const QPoint &);
con's avatar
con committed
160 161 162

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

165 166 167
    void fetchMemory(MemoryViewAgent *agent, quint64 addr, quint64 length);
    void handleFetchMemory(const GdbResultRecord &record, const QVariant &cookie);

168 169 170 171 172 173 174 175 176 177 178
    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);

179 180
    Q_SLOT void setDebugDebuggingHelpers(const QVariant &on);
    Q_SLOT void setUseDebuggingHelpers(const QVariant &on);
181

con's avatar
con committed
182 183 184
    //
    // Own stuff
    //
185

con's avatar
con committed
186 187 188 189
    int currentFrame() const;

    bool supportsThreads() const;

190 191
    void initializeConnections();
    void initializeVariables();
con's avatar
con committed
192 193 194 195 196 197
    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 &);

198 199 200 201 202 203
public: // otherwise the Qt flag macros are unhappy
    enum GdbCommandFlag {
        NoFlags = 0,
        NeedsStop = 1,
        Discardable = 2,
        RebuildModel = 4,
204
        WatchUpdate = Discardable | RebuildModel,
205
        EmbedToken = 8
206 207 208
    };
    Q_DECLARE_FLAGS(GdbCommandFlags, GdbCommandFlag)

209
private:
210 211 212 213 214 215 216 217 218 219 220
    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;
221
        QTime postTime;
222 223
    };

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

    void setTokenBarrier();

    void updateLocals();

private slots:
    void gdbProcError(QProcess::ProcessError error);
    void readGdbStandardOutput();
    void readGdbStandardError();
247 248
    void readUploadStandardOutput();
    void readUploadStandardError();
249
    void readDebugeeOutput(const QByteArray &data);
250 251
    void stubStarted();
    void stubError(const QString &msg);
252
    void uploadProcError(QProcess::ProcessError error);
253
    void emitStartFailed();
con's avatar
con committed
254 255 256

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

285 286
    void handleChildren(const WatchData &parent, const GdbMi &child,
        QList<WatchData> *insertions);
287 288
    const bool m_dumperInjectionLoad;

289 290 291 292
    OutputCollector m_outputCollector;
    QTextCodec *m_outputCodec;
    QTextCodec::ConverterState m_outputCodecState;

con's avatar
con committed
293 294
    QByteArray m_inbuffer;

295
    GdbProcessBase *m_gdbProc;
296
    QProcess m_uploadProc;
con's avatar
con committed
297

298 299
    Core::Utils::ConsoleProcess m_stubProc;

300
    QHash<int, GdbCommand> m_cookieForToken;
con's avatar
con committed
301 302 303 304 305 306 307 308 309 310 311 312
    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
313
    int m_gdbBuildVersion; // MAC only? 
con's avatar
con committed
314 315

    // awful hack to keep track of used files
316 317
    QMap<QString, QString> m_shortToFullName;
    QMap<QString, QString> m_fullToShortName;
con's avatar
con committed
318 319 320 321

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

    //
    // Modules specific stuff
    //
    void reloadModules();
337
    void handleModulesList(const GdbResultRecord &record, const QVariant &);
con's avatar
con committed
338 339 340 341 342


    //
    // Register specific stuff
    // 
343
    Q_SLOT void reloadRegisters();
344
    void setRegisterValue(int nr, const QString &value);
345 346
    void handleRegisterListNames(const GdbResultRecord &record, const QVariant &);
    void handleRegisterListValues(const GdbResultRecord &record, const QVariant &);
con's avatar
con committed
347

348 349 350 351
    //
    // Source file specific stuff
    // 
    void reloadSourceFiles();
con's avatar
con committed
352 353 354 355

    //
    // Stack specific stuff
    // 
356 357 358
    void handleStackListFrames(const GdbResultRecord &record, const QVariant &cookie);
    void handleStackSelectThread(const GdbResultRecord &, const QVariant &);
    void handleStackListThreads(const GdbResultRecord &record, const QVariant &cookie);
359 360
    Q_SLOT void reloadStack();
    Q_SLOT void reloadFullStack();
con's avatar
con committed
361 362 363 364 365 366 367 368 369 370 371 372 373 374


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

375
    void updateWatchData(const WatchData &data);
376
    Q_SLOT void updateWatchDataHelper(const WatchData &data);
hjk's avatar
hjk committed
377
    void rebuildModel();
con's avatar
con committed
378 379 380 381 382 383 384

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

    void maybeHandleInferiorPidChanged(const QString &pid);

385
    void tryLoadDebuggingHelpers();
386
    void tryQueryDebuggingHelpers();
387 388 389 390
    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
391 392

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

    int m_pendingRequests;
422
    QSet<QString> m_processedNames; 
con's avatar
con committed
423

424
    QtDumperHelper m_dumperHelper;
con's avatar
con committed
425
    
426
    DebuggingHelperState m_debuggingHelperState;
con's avatar
con committed
427 428 429 430
    QList<GdbMi> m_currentFunctionArgs;
    QString m_currentFrame;
    QMap<QString, QString> m_varToType;

431
    bool m_autoContinue;
432
    bool m_waitingForFirstBreakpointToBeHit;
433
    bool m_modulesListOutdated;
434

435
    QList<GdbCommand> m_commandsToRunOnTemporaryBreak;
hjk's avatar
hjk committed
436

437 438
    DebuggerManager * const q;
    IDebuggerManagerAccessForEngines * const qq;
hjk's avatar
hjk committed
439
    DebuggerStartParameters m_startParameters;
440
    // make sure to re-initialize new members in initializeVariables();
con's avatar
con committed
441 442 443 444 445
};

} // namespace Internal
} // namespace Debugger

446 447
Q_DECLARE_OPERATORS_FOR_FLAGS(Debugger::Internal::GdbEngine::GdbCommandFlags)

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