gdbengine.h 16.5 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"
hjk's avatar
hjk committed
37
#include "outputcollector.h"
38

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

QT_BEGIN_NAMESPACE
class QAction;
class QAbstractItemModel;
class QWidget;
QT_END_NAMESPACE

namespace Debugger {
namespace Internal {

hjk's avatar
hjk committed
59
class AbstractGdbAdapter;
con's avatar
con committed
60 61 62 63 64 65 66 67
class DebuggerManager;
class IDebuggerManagerAccessForEngines;
class GdbResultRecord;
class GdbMi;

class WatchData;
class BreakpointData;

68 69 70
class PlainGdbAdapter;
class TrkGdbAdapter;
class RemoteGdbAdapter;
71
class CoreGdbAdapter;
72

73
enum DebuggingHelperState
con's avatar
con committed
74
{
75 76 77 78
    DebuggingHelperUninitialized,
    DebuggingHelperLoadTried,
    DebuggingHelperAvailable,
    DebuggingHelperUnavailable,
con's avatar
con committed
79 80 81 82 83 84 85
};

class GdbEngine : public IDebuggerEngine
{
    Q_OBJECT

public:
hjk's avatar
hjk committed
86
    explicit GdbEngine(DebuggerManager *parent);
con's avatar
con committed
87 88 89
    ~GdbEngine();

signals:
90 91
    void gdbInputAvailable(int channel, const QString &msg);
    void gdbOutputAvailable(int channel, const QString &msg);
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
92
    void applicationOutputAvailable(const QString &output);
con's avatar
con committed
93 94

private:
hjk's avatar
hjk committed
95 96
    friend class PlainGdbAdapter;
    friend class TrkGdbAdapter;
97
    friend class RemoteGdbAdapter;
98
    friend class CoreGdbAdapter;
hjk's avatar
hjk committed
99

con's avatar
con committed
100 101 102 103 104 105 106 107 108 109
    //
    // IDebuggerEngine implementation
    //
    void stepExec();
    void stepOutExec();
    void nextExec();
    void stepIExec();
    void nextIExec();

    void shutdown();
110
    void setToolTipExpression(const QPoint &mousePos, TextEditor::ITextEditor *editor, int cursorPos);
hjk's avatar
hjk committed
111
    void startDebugger(const DebuggerStartParametersPtr &sp);
con's avatar
con committed
112
    void exitDebugger();
113
    void detachDebugger();
con's avatar
con committed
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128

    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);
129
    void watchPoint(const QPoint &);
con's avatar
con committed
130 131 132

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

135 136 137
    void fetchMemory(MemoryViewAgent *agent, quint64 addr, quint64 length);
    void handleFetchMemory(const GdbResultRecord &record, const QVariant &cookie);

138 139 140 141 142 143 144 145 146 147 148
    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);

149 150
    Q_SLOT void setDebugDebuggingHelpers(const QVariant &on);
    Q_SLOT void setUseDebuggingHelpers(const QVariant &on);
151

con's avatar
con committed
152 153 154
    //
    // Own stuff
    //
155

con's avatar
con committed
156 157 158
    int currentFrame() const;

    bool supportsThreads() const;
hjk's avatar
hjk committed
159
    void gotoLocation(const StackFrame &frame, bool setLocationMarker);
con's avatar
con committed
160

161 162
    void connectAdapter();
    void disconnectAdapter();
163
    void initializeVariables();
con's avatar
con committed
164 165 166 167 168 169
    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 &);

170 171 172 173 174 175
public: // otherwise the Qt flag macros are unhappy
    enum GdbCommandFlag {
        NoFlags = 0,
        NeedsStop = 1,
        Discardable = 2,
        RebuildModel = 4,
176
        WatchUpdate = Discardable | RebuildModel,
177
        EmbedToken = 8
178 179 180
    };
    Q_DECLARE_FLAGS(GdbCommandFlags, GdbCommandFlag)

hjk's avatar
hjk committed
181

182
private:
hjk's avatar
hjk committed
183 184 185 186
    typedef void (GdbEngine::*GdbCommandCallback)
        (const GdbResultRecord &record, const QVariant &cookie);
    typedef void (AbstractGdbAdapter::*AdapterCallback)
        (const GdbResultRecord &record, const QVariant &cookie);
187 188 189

    struct GdbCommand
    {
hjk's avatar
hjk committed
190 191 192
        GdbCommand()
            : flags(0), callback(0), adapterCallback(0), callbackName(0)
        {}
193 194 195

        int flags;
        GdbCommandCallback callback;
hjk's avatar
hjk committed
196
        AdapterCallback adapterCallback;
197 198 199
        const char *callbackName;
        QString command;
        QVariant cookie;
200
        QTime postTime;
201 202
    };

con's avatar
con committed
203 204 205 206
    // 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.
hjk's avatar
hjk committed
207
    void flushCommand(const GdbCommand &cmd);
208
    void postCommand(const QString &command,
209 210 211 212
                     GdbCommandFlags flags,
                     GdbCommandCallback callback = 0,
                     const char *callbackName = 0,
                     const QVariant &cookie = QVariant());
213
    void postCommand(const QString &command,
214 215 216
                     GdbCommandCallback callback = 0,
                     const char *callbackName = 0,
                     const QVariant &cookie = QVariant());
hjk's avatar
hjk committed
217 218 219 220
    void postCommand(const QString &command,
                     AdapterCallback callback,
                     const char *callbackName,
                     const QVariant &cookie = QVariant());
221 222 223 224 225
    void postCommand(const QString &command,
                     GdbCommandFlags flags,
                     AdapterCallback callback,
                     const char *callbackName,
                     const QVariant &cookie = QVariant());
hjk's avatar
hjk committed
226
    void postCommandHelper(const GdbCommand &cmd);
con's avatar
con committed
227 228 229 230 231 232 233 234
    void setTokenBarrier();

    void updateLocals();

private slots:
    void gdbProcError(QProcess::ProcessError error);
    void readGdbStandardOutput();
    void readGdbStandardError();
235
    void readDebugeeOutput(const QByteArray &data);
con's avatar
con committed
236

hjk's avatar
hjk committed
237 238 239 240 241 242 243 244 245 246 247 248 249
    void handleAdapterStarted();
    void handleAdapterStartFailed(const QString &msg);

    void handleInferiorPrepared();
    void handleInferiorPreparationFailed(const QString &msg);
    void handleInferiorStarted();
    void handleInferiorStartFailed(const QString &msg);
    void handleInferiorShutDown();
    void handleInferiorShutdownFailed(const QString &msg);

    void handleAdapterShutDown();
    void handleAdapterShutdownFailed(const QString &msg);

con's avatar
con committed
250 251
private:
    int terminationIndex(const QByteArray &buffer, int &length);
252
    void handleResponse(const QByteArray &buff);
253
    void handleStart(const GdbResultRecord &response, const QVariant &);
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
254
    void handleAqcuiredInferior();
con's avatar
con committed
255
    void handleAsyncOutput(const GdbMi &data);
hjk's avatar
hjk committed
256 257 258
    void handleStop1(const GdbResultRecord &, const QVariant &cookie);
    void handleStop2(const GdbResultRecord &, const QVariant &cookie);
    void handleStop2(const GdbMi &data);
con's avatar
con committed
259
    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
    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 handleExit(const GdbResultRecord &, const QVariant &);
hjk's avatar
hjk committed
271 272 273
    void handleDetach(const GdbResultRecord &, const QVariant &);
    //void handleSetTargetAsync(const GdbResultRecord &, const QVariant &);
    //void handleTargetRemote(const GdbResultRecord &, const QVariant &);
274
    void handleWatchPoint(const GdbResultRecord &, const QVariant &);
275
    void handleTargetCore();
276
    bool showToolTip();
con's avatar
con committed
277

hjk's avatar
hjk committed
278 279 280 281 282 283
    // Convenience
    DebuggerManager *manager() { return m_manager; }
    void showStatusMessage(const QString &msg, int timeout = -1)
        { m_manager->showStatusMessage(msg, timeout); }
    int status() const { return m_manager->status(); }
    QMainWindow *mainWindow() const { return m_manager->mainWindow(); }
284
    DebuggerStartMode startMode() const;
hjk's avatar
hjk committed
285 286
    qint64 inferiorPid() const { return m_manager->inferiorPid(); }

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

291 292 293
    QTextCodec *m_outputCodec;
    QTextCodec::ConverterState m_outputCodecState;

con's avatar
con committed
294 295
    QByteArray m_inbuffer;

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

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

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

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


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

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

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


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

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

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

    void maybeHandleInferiorPidChanged(const QString &pid);

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

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

    int m_pendingRequests;
419
    QSet<QString> m_processedNames; 
con's avatar
con committed
420

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

hjk's avatar
hjk committed
428 429 430 431 432
    typedef void (GdbEngine::*Continuation)();
    // function called after all previous responses have been received
    Continuation m_continuationAfterDone;
    void handleInitialBreakpointsSet();

433
    bool m_modulesListOutdated;
434

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

hjk's avatar
hjk committed
437
    DebuggerManager * const m_manager;
438
    IDebuggerManagerAccessForEngines * const qq;
hjk's avatar
hjk committed
439
    DebuggerStartParametersPtr m_startParameters;
440
    // make sure to re-initialize new members in initializeVariables();
441

442 443 444 445 446 447
    // only one of those is active at a given time, available in m_gdbAdapter
    AbstractGdbAdapter *m_gdbAdapter;  // pointer to one listed below
    PlainGdbAdapter *m_plainAdapter;   // owned
    TrkGdbAdapter *m_trkAdapter;       // owned
    RemoteGdbAdapter *m_remoteAdapter; // owned
    CoreGdbAdapter *m_coreAdapter;     // owned
448
    
hjk's avatar
hjk committed
449
public:
450
    void showMessageBox(int icon, const QString &title, const QString &text);
451
    void debugMessage(const QString &msg);
452
    void addOptionPages(QList<Core::IOptionsPage*> *opts) const;
453 454
    const DebuggerStartParameters &startParameters() const
        { return *m_startParameters; }
455

hjk's avatar
hjk committed
456
    OutputCollector m_outputCollector;
con's avatar
con committed
457 458 459 460 461
};

} // namespace Internal
} // namespace Debugger

462 463
Q_DECLARE_OPERATORS_FOR_FLAGS(Debugger::Internal::GdbEngine::GdbCommandFlags)

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