lldbengine.h 8.14 KB
Newer Older
1 2
/****************************************************************************
**
3
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** 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.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#ifndef DEBUGGER_LLDBENGINE
#define DEBUGGER_LLDBENGINE

33 34 35
#include <debugger/debuggerengine.h>
#include <debugger/disassembleragent.h>
#include <debugger/memoryagent.h>
36
#include <debugger/watchhandler.h>
37
#include <debugger/debuggertooltipmanager.h>
38

hjk's avatar
hjk committed
39 40
#include <utils/consoleprocess.h>

41
#include <QPointer>
42 43
#include <QProcess>
#include <QQueue>
44
#include <QMap>
45
#include <QStack>
46 47 48 49 50 51 52 53 54
#include <QVariant>


namespace Debugger {
namespace Internal {

class WatchData;
class GdbMi;

hjk's avatar
hjk committed
55 56
/* A debugger engine interfacing the LLDB debugger
 * using its Python interface.
57 58 59 60 61 62 63 64 65
 */

class LldbEngine : public DebuggerEngine
{
    Q_OBJECT

public:
    explicit LldbEngine(const DebuggerStartParameters &startParameters);
    ~LldbEngine();
66

67
private:
hjk's avatar
hjk committed
68 69 70 71 72 73
    // Convenience struct to build up backend commands.
    struct Command
    {
        Command() {}
        Command(const char *f) : function(f) {}

74
        const Command &arg(const char *name) const;
hjk's avatar
hjk committed
75
        const Command &arg(const char *name, int value) const;
76 77
        const Command &arg(const char *name, qlonglong value) const;
        const Command &arg(const char *name, qulonglong value) const;
hjk's avatar
hjk committed
78 79 80 81 82 83 84 85
        const Command &arg(const char *name, const QString &value) const;
        const Command &arg(const char *name, const QByteArray &value) const;
        const Command &arg(const char *name, const char *value) const;
        const Command &beginList(const char *name = 0) const;
        void endList() const;
        const Command &beginGroup(const char *name = 0) const;
        void endGroup() const;

86 87 88
        static QByteArray toData(const QList<QByteArray> &value);
        static QByteArray toData(const QHash<QByteArray, QByteArray> &value);

hjk's avatar
hjk committed
89 90
        QByteArray function;
        mutable QByteArray args;
91 92
        private:
        const Command &argHelper(const char *name, const QByteArray &value) const;
hjk's avatar
hjk committed
93 94
    };

95 96 97 98 99 100 101 102
    // DebuggerEngine implementation
    void executeStep();
    void executeStepOut();
    void executeNext();
    void executeStepI();
    void executeNextI();

    void setupEngine();
Fawzi Mohamed's avatar
Fawzi Mohamed committed
103
    void startLldb();
104 105 106 107
    void setupInferior();
    void runEngine();
    void shutdownInferior();
    void shutdownEngine();
108
    void abortDebugger();
109
    void resetLocation();
110

111
    bool setToolTipExpression(TextEditor::BaseTextEditor *editor,
hjk's avatar
hjk committed
112
        const DebuggerToolTipContext &);
113 114 115 116 117 118 119 120 121 122 123 124

    void continueInferior();
    void interruptInferior();

    void executeRunToLine(const ContextData &data);
    void executeRunToFunction(const QString &functionName);
    void executeJumpToLine(const ContextData &data);

    void activateFrame(int index);
    void selectThread(ThreadId threadId);

    bool acceptsBreakpoint(BreakpointModelId id) const;
125
    void attemptBreakpointSynchronization();
hjk's avatar
hjk committed
126
    bool attemptBreakpointSynchronizationHelper(Command *command);
127 128 129 130 131 132 133 134 135

    void assignValueInDebugger(const WatchData *data,
        const QString &expr, const QVariant &value);
    void executeDebuggerCommand(const QString &command, DebuggerLanguages languages);

    void loadSymbols(const QString &moduleName);
    void loadAllSymbols();
    void requestModuleSymbols(const QString &moduleName);
    void reloadModules();
136
    void reloadRegisters();
137
    void reloadSourceFiles() {}
138
    void reloadFullStack();
139
    void fetchDisassembler(Internal::DisassemblerAgent *);
140
    void refreshDisassembly(const GdbMi &data);
141 142 143 144

    bool supportsThreads() const { return true; }
    bool isSynchronous() const { return true; }
    void updateWatchData(const WatchData &data, const WatchUpdateFlags &flags);
145 146 147 148 149
    void setRegisterValue(int regnr, const QString &value);

    void fetchMemory(Internal::MemoryAgent *, QObject *, quint64 addr, quint64 length);
    void changeMemory(Internal::MemoryAgent *, QObject *, quint64 addr, const QByteArray &data);
    void refreshMemory(const GdbMi &data);
150 151 152 153 154 155 156 157 158 159 160 161

signals:
    void outputReady(const QByteArray &data);

private:
    QString errorMessage(QProcess::ProcessError error) const;
    bool hasCapability(unsigned cap) const;

    Q_SLOT void handleLldbFinished(int, QProcess::ExitStatus status);
    Q_SLOT void handleLldbError(QProcess::ProcessError error);
    Q_SLOT void readLldbStandardOutput();
    Q_SLOT void readLldbStandardError();
162
    Q_SLOT void handleResponse(const QByteArray &data);
163
    Q_SLOT void runEngine2();
164
    Q_SLOT void updateAll();
165
    Q_SLOT void updateStack();
166
    Q_SLOT void updateLocals();
167
    Q_SLOT void createFullBacktrace();
168
    void doUpdateLocals(UpdateParameters params);
169 170 171
    void refreshAll(const GdbMi &all);
    void refreshThreads(const GdbMi &threads);
    void refreshStack(const GdbMi &stack);
172 173 174
    void refreshStackPosition(const GdbMi &position);
    void refreshStackTop(const GdbMi &position);
    void setStackPosition(int index);
175
    void refreshRegisters(const GdbMi &registers);
176
    void refreshLocals(const GdbMi &vars);
177 178
    void refreshTypeInfo(const GdbMi &typeInfo);
    void refreshState(const GdbMi &state);
179
    void refreshLocation(const GdbMi &location);
180
    void refreshModules(const GdbMi &modules);
181
    void refreshSymbols(const GdbMi &symbols);
182
    void refreshOutput(const GdbMi &output);
183 184 185
    void refreshAddedBreakpoint(const GdbMi &bkpts);
    void refreshChangedBreakpoint(const GdbMi &bkpts);
    void refreshRemovedBreakpoint(const GdbMi &bkpts);
186
    void runContinuation(const GdbMi &data);
187
    void showFullBacktrace(const GdbMi &data);
188

189
    typedef void (LldbEngine::*LldbCommandContinuation)();
190

191 192 193 194
    void handleListLocals(const QByteArray &response);
    void handleListModules(const QByteArray &response);
    void handleListSymbols(const QByteArray &response);
    void handleBreakpointsSynchronized(const QByteArray &response);
195
    void updateBreakpointData(const GdbMi &bkpt, bool added);
196 197
    void handleUpdateStack(const QByteArray &response);
    void handleUpdateThreads(const QByteArray &response);
198

199
    void notifyEngineRemoteSetupFinished(const RemoteSetupResult &result);
Fawzi Mohamed's avatar
Fawzi Mohamed committed
200

201 202
    void handleChildren(const WatchData &data0, const GdbMi &item,
        QList<WatchData> *list);
hjk's avatar
hjk committed
203 204

    void runCommand(const Command &cmd);
205 206
    void debugLastCommand();
    Command m_lastDebuggableCommand;
207 208 209 210

    QByteArray m_inbuffer;
    QString m_scriptFileName;
    QProcess m_lldbProc;
211
    QString m_lldbCmd;
212 213 214

    // FIXME: Make generic.
    int m_lastAgentId;
hjk's avatar
hjk committed
215
    int m_lastToken;
216
    int m_continueAtNextSpontaneousStop;
217 218 219
    QMap<QPointer<DisassemblerAgent>, int> m_disassemblerAgents;
    QMap<QPointer<MemoryAgent>, int> m_memoryAgents;
    QHash<int, QPointer<QObject> > m_memoryAgentTokens;
220
    DebuggerToolTipContext m_toolTipContext;
221 222

    void showToolTip();
hjk's avatar
hjk committed
223 224 225 226 227 228 229

    // Console handling.
    Q_SLOT void stubError(const QString &msg);
    Q_SLOT void stubExited();
    Q_SLOT void stubStarted();
    bool prepareCommand();
    Utils::ConsoleProcess m_stubProc;
230 231 232 233 234 235
};

} // namespace Internal
} // namespace Debugger

#endif // DEBUGGER_LLDBENGINE