LLDB mainline
ScriptInterpreterLua.cpp
Go to the documentation of this file.
1//===-- ScriptInterpreterLua.cpp ------------------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
10#include "Lua.h"
12#include "lldb/Core/Debugger.h"
17#include "lldb/Utility/Stream.h"
19#include "lldb/Utility/Timer.h"
20#include "llvm/ADT/StringRef.h"
21#include "llvm/Support/FormatAdapters.h"
22#include <memory>
23#include <vector>
24
25using namespace lldb;
26using namespace lldb_private;
27
29
34};
35
37 public IOHandlerEditline {
38public:
40 ScriptInterpreterLua &script_interpreter,
41 ActiveIOHandler active_io_handler = eIOHandlerNone)
43 llvm::StringRef(">>> "), llvm::StringRef("..> "),
44 true, debugger.GetUseColor(), 0, *this),
45 m_script_interpreter(script_interpreter),
46 m_active_io_handler(active_io_handler) {
47 llvm::cantFail(m_script_interpreter.GetLua().ChangeIO(
48 debugger.GetOutputFile().GetStream(),
49 debugger.GetErrorFile().GetStream()));
50 llvm::cantFail(m_script_interpreter.EnterSession(debugger.GetID()));
51 }
52
54 llvm::cantFail(m_script_interpreter.LeaveSession());
55 }
56
57 void IOHandlerActivated(IOHandler &io_handler, bool interactive) override {
58 const char *instructions = nullptr;
59 switch (m_active_io_handler) {
60 case eIOHandlerNone:
61 break;
63 instructions = "Enter your Lua command(s). Type 'quit' to end.\n"
64 "The commands are compiled as the body of the following "
65 "Lua function\n"
66 "function (frame, wp) end\n";
67 SetPrompt(llvm::StringRef("..> "));
68 break;
70 instructions = "Enter your Lua command(s). Type 'quit' to end.\n"
71 "The commands are compiled as the body of the following "
72 "Lua function\n"
73 "function (frame, bp_loc, ...) end\n";
74 SetPrompt(llvm::StringRef("..> "));
75 break;
76 }
77 if (instructions == nullptr)
78 return;
79 if (interactive)
80 *io_handler.GetOutputStreamFileSP() << instructions;
81 }
82
84 StringList &lines) override {
85 size_t last = lines.GetSize() - 1;
86 if (IsQuitCommand(lines.GetStringAtIndex(last))) {
89 lines.DeleteStringAtIndex(last);
90 return true;
91 }
92 StreamString str;
93 lines.Join("\n", str);
94 if (llvm::Error E =
96 std::string error_str = toString(std::move(E));
97 // Lua always errors out to incomplete code with '<eof>'
98 return error_str.find("<eof>") == std::string::npos;
99 }
100 // The breakpoint and watchpoint handler only exits with a explicit 'quit'
103 }
104
106 std::string &data) override {
107 switch (m_active_io_handler) {
109 auto *bp_options_vec =
110 static_cast<std::vector<std::reference_wrapper<BreakpointOptions>> *>(
111 io_handler.GetUserData());
112 for (BreakpointOptions &bp_options : *bp_options_vec) {
114 bp_options, data.c_str(), /*is_callback=*/false);
115 if (error.Fail())
116 *io_handler.GetErrorStreamFileSP() << error.AsCString() << '\n';
117 }
118 io_handler.SetIsDone(true);
119 } break;
121 auto *wp_options =
122 static_cast<WatchpointOptions *>(io_handler.GetUserData());
124 data.c_str(),
125 /*is_callback=*/false);
126 io_handler.SetIsDone(true);
127 } break;
128 case eIOHandlerNone:
129 if (IsQuitCommand(data)) {
130 io_handler.SetIsDone(true);
131 return;
132 }
133 if (llvm::Error error = m_script_interpreter.GetLua().Run(data))
134 *io_handler.GetErrorStreamFileSP() << toString(std::move(error));
135 break;
136 }
137 }
138
139private:
142
143 bool IsQuitCommand(llvm::StringRef cmd) { return cmd.rtrim() == "quit"; }
144};
145
148 m_lua(std::make_unique<Lua>()) {}
149
151
153 auto info = std::make_shared<StructuredData::Dictionary>();
154 info->AddStringItem("language", "lua");
155 return info;
156}
157
158bool ScriptInterpreterLua::ExecuteOneLine(llvm::StringRef command,
159 CommandReturnObject *result,
160 const ExecuteScriptOptions &options) {
161 if (command.empty()) {
162 if (result)
163 result->AppendError("empty command passed to lua\n");
164 return false;
165 }
166
167 llvm::Expected<std::unique_ptr<ScriptInterpreterIORedirect>>
168 io_redirect_or_error = ScriptInterpreterIORedirect::Create(
169 options.GetEnableIO(), m_debugger, result);
170 if (!io_redirect_or_error) {
171 if (result)
173 "failed to redirect I/O: {0}\n",
174 llvm::fmt_consume(io_redirect_or_error.takeError()));
175 else
176 llvm::consumeError(io_redirect_or_error.takeError());
177 return false;
178 }
179
180 ScriptInterpreterIORedirect &io_redirect = **io_redirect_or_error;
181
182 if (llvm::Error e =
183 m_lua->ChangeIO(io_redirect.GetOutputFile()->GetStream(),
184 io_redirect.GetErrorFile()->GetStream())) {
185 result->AppendErrorWithFormatv("lua failed to redirect I/O: {0}\n",
186 llvm::toString(std::move(e)));
187 return false;
188 }
189
190 if (llvm::Error e = m_lua->Run(command)) {
192 "lua failed attempting to evaluate '{0}': {1}\n", command,
193 llvm::toString(std::move(e)));
194 return false;
195 }
196
197 io_redirect.Flush();
198 return true;
199}
200
203
204 // At the moment, the only time the debugger does not have an input file
205 // handle is when this is called directly from lua, in which case it is
206 // both dangerous and unnecessary (not to mention confusing) to try to embed
207 // a running interpreter loop inside the already running lua interpreter
208 // loop, so we won't do it.
210 return;
211
212 IOHandlerSP io_handler_sp(new IOHandlerLuaInterpreter(m_debugger, *this));
213 m_debugger.RunIOHandlerAsync(io_handler_sp);
214}
215
217 const char *filename, const LoadScriptOptions &options,
219 FileSpec extra_search_dir) {
220
221 if (llvm::Error e = m_lua->LoadModule(filename)) {
222 error.SetErrorStringWithFormatv("lua failed to import '{0}': {1}\n",
223 filename, llvm::toString(std::move(e)));
224 return false;
225 }
226 return true;
227}
228
230 static llvm::once_flag g_once_flag;
231
232 llvm::call_once(g_once_flag, []() {
236 });
237}
238
240
243 return llvm::Error::success();
244
245 const char *fmt_str =
246 "lldb.debugger = lldb.SBDebugger.FindDebuggerWithID({0}); "
247 "lldb.target = lldb.debugger:GetSelectedTarget(); "
248 "lldb.process = lldb.target:GetProcess(); "
249 "lldb.thread = lldb.process:GetSelectedThread(); "
250 "lldb.frame = lldb.thread:GetSelectedFrame()";
251 return m_lua->Run(llvm::formatv(fmt_str, debugger_id).str());
252}
253
256 return llvm::Error::success();
257
258 m_session_is_active = false;
259
260 llvm::StringRef str = "lldb.debugger = nil; "
261 "lldb.target = nil; "
262 "lldb.process = nil; "
263 "lldb.thread = nil; "
264 "lldb.frame = nil";
265 return m_lua->Run(str);
266}
267
269 void *baton, StoppointCallbackContext *context, user_id_t break_id,
270 user_id_t break_loc_id) {
271 assert(context);
272
273 ExecutionContext exe_ctx(context->exe_ctx_ref);
274 Target *target = exe_ctx.GetTargetPtr();
275 if (target == nullptr)
276 return true;
277
278 StackFrameSP stop_frame_sp(exe_ctx.GetFrameSP());
279 BreakpointSP breakpoint_sp = target->GetBreakpointByID(break_id);
280 BreakpointLocationSP bp_loc_sp(breakpoint_sp->FindLocationByID(break_loc_id));
281
282 Debugger &debugger = target->GetDebugger();
283 ScriptInterpreterLua *lua_interpreter = static_cast<ScriptInterpreterLua *>(
285 Lua &lua = lua_interpreter->GetLua();
286
287 CommandDataLua *bp_option_data = static_cast<CommandDataLua *>(baton);
288 llvm::Expected<bool> BoolOrErr = lua.CallBreakpointCallback(
289 baton, stop_frame_sp, bp_loc_sp, bp_option_data->m_extra_args_sp);
290 if (llvm::Error E = BoolOrErr.takeError()) {
291 debugger.GetErrorStream() << toString(std::move(E));
292 return true;
293 }
294
295 return *BoolOrErr;
296}
297
299 void *baton, StoppointCallbackContext *context, user_id_t watch_id) {
300 assert(context);
301
302 ExecutionContext exe_ctx(context->exe_ctx_ref);
303 Target *target = exe_ctx.GetTargetPtr();
304 if (target == nullptr)
305 return true;
306
307 StackFrameSP stop_frame_sp(exe_ctx.GetFrameSP());
308 WatchpointSP wp_sp = target->GetWatchpointList().FindByID(watch_id);
309
310 Debugger &debugger = target->GetDebugger();
311 ScriptInterpreterLua *lua_interpreter = static_cast<ScriptInterpreterLua *>(
313 Lua &lua = lua_interpreter->GetLua();
314
315 llvm::Expected<bool> BoolOrErr =
316 lua.CallWatchpointCallback(baton, stop_frame_sp, wp_sp);
317 if (llvm::Error E = BoolOrErr.takeError()) {
318 debugger.GetErrorStream() << toString(std::move(E));
319 return true;
320 }
321
322 return *BoolOrErr;
323}
324
326 std::vector<std::reference_wrapper<BreakpointOptions>> &bp_options_vec,
327 CommandReturnObject &result) {
328 IOHandlerSP io_handler_sp(
330 io_handler_sp->SetUserData(&bp_options_vec);
331 m_debugger.RunIOHandlerAsync(io_handler_sp);
332}
333
335 WatchpointOptions *wp_options, CommandReturnObject &result) {
336 IOHandlerSP io_handler_sp(
338 io_handler_sp->SetUserData(wp_options);
339 m_debugger.RunIOHandlerAsync(io_handler_sp);
340}
341
343 BreakpointOptions &bp_options, const char *function_name,
344 StructuredData::ObjectSP extra_args_sp) {
345 const char *fmt_str = "return {0}(frame, bp_loc, ...)";
346 std::string oneliner = llvm::formatv(fmt_str, function_name).str();
347 return RegisterBreakpointCallback(bp_options, oneliner.c_str(),
348 extra_args_sp);
349}
350
352 BreakpointOptions &bp_options, const char *command_body_text,
353 bool is_callback) {
354 return RegisterBreakpointCallback(bp_options, command_body_text, {});
355}
356
358 BreakpointOptions &bp_options, const char *command_body_text,
359 StructuredData::ObjectSP extra_args_sp) {
361 auto data_up = std::make_unique<CommandDataLua>(extra_args_sp);
362 error = m_lua->RegisterBreakpointCallback(data_up.get(), command_body_text);
363 if (error.Fail())
364 return error;
365 auto baton_sp =
366 std::make_shared<BreakpointOptions::CommandBaton>(std::move(data_up));
368 baton_sp);
369 return error;
370}
371
373 WatchpointOptions *wp_options, const char *command_body_text,
374 bool is_callback) {
375 RegisterWatchpointCallback(wp_options, command_body_text, {});
376}
377
379 WatchpointOptions *wp_options, const char *command_body_text,
380 StructuredData::ObjectSP extra_args_sp) {
382 auto data_up = std::make_unique<WatchpointOptions::CommandData>();
383 error = m_lua->RegisterWatchpointCallback(data_up.get(), command_body_text);
384 if (error.Fail())
385 return error;
386 auto baton_sp =
387 std::make_shared<WatchpointOptions::CommandBaton>(std::move(data_up));
389 baton_sp);
390 return error;
391}
392
395 return std::make_shared<ScriptInterpreterLua>(debugger);
396}
397
399 return "Lua script interpreter";
400}
401
static llvm::raw_ostream & error(Stream &strm)
#define LLDB_PLUGIN_DEFINE(PluginName)
Definition: PluginManager.h:31
@ eIOHandlerWatchpoint
@ eIOHandlerBreakpoint
@ eIOHandlerNone
#define LLDB_SCOPED_TIMER()
Definition: Timer.h:83
IOHandlerLuaInterpreter(Debugger &debugger, ScriptInterpreterLua &script_interpreter, ActiveIOHandler active_io_handler=eIOHandlerNone)
void IOHandlerActivated(IOHandler &io_handler, bool interactive) override
ScriptInterpreterLua & m_script_interpreter
bool IOHandlerIsInputComplete(IOHandler &io_handler, StringList &lines) override
Called to determine whether typing enter after the last line in lines should end input.
bool IsQuitCommand(llvm::StringRef cmd)
void IOHandlerInputComplete(IOHandler &io_handler, std::string &data) override
Called when a line or lines have been retrieved.
"lldb/Breakpoint/BreakpointOptions.h" Class that manages the options on a breakpoint or breakpoint lo...
void SetCallback(BreakpointHitCallback callback, const lldb::BatonSP &baton_sp, bool synchronous=false)
Adds a callback to the breakpoint option set.
void AppendErrorWithFormatv(const char *format, Args &&... args)
void void AppendError(llvm::StringRef in_string)
A class to manage flag bits.
Definition: Debugger.h:79
StreamFile & GetErrorStream()
Definition: Debugger.h:156
void RunIOHandlerAsync(const lldb::IOHandlerSP &reader_sp, bool cancel_top_handler=true)
Run the given IO handler and return immediately.
Definition: Debugger.cpp:1179
ScriptInterpreter * GetScriptInterpreter(bool can_create=true, std::optional< lldb::ScriptLanguage > language={})
Definition: Debugger.cpp:1652
File & GetOutputFile()
Definition: Debugger.h:150
"lldb/Target/ExecutionContext.h" A class that contains an execution context.
const lldb::StackFrameSP & GetFrameSP() const
Get accessor to get the frame shared pointer.
Target * GetTargetPtr() const
Returns a pointer to the target object.
A file utility class.
Definition: FileSpec.h:56
virtual FILE * GetStream()
Get the underlying libc stream for this file, or NULL.
Definition: File.cpp:128
bool IsValid() const override
IsValid.
Definition: File.cpp:113
A delegate class for use with IOHandler subclasses.
Definition: IOHandler.h:190
bool SetPrompt(llvm::StringRef prompt) override
Definition: IOHandler.cpp:475
lldb::StreamFileSP GetErrorStreamFileSP()
Definition: IOHandler.cpp:107
lldb::StreamFileSP GetOutputStreamFileSP()
Definition: IOHandler.cpp:105
void SetIsDone(bool b)
Definition: IOHandler.h:86
llvm::Expected< bool > CallWatchpointCallback(void *baton, lldb::StackFrameSP stop_frame_sp, lldb::WatchpointSP wp_sp)
Definition: Lua.cpp:107
llvm::Error CheckSyntax(llvm::StringRef buffer)
Definition: Lua.cpp:116
llvm::Error ChangeIO(FILE *out, FILE *err)
Definition: Lua.cpp:161
llvm::Error Run(llvm::StringRef buffer)
Definition: Lua.cpp:47
llvm::Expected< bool > CallBreakpointCallback(void *baton, lldb::StackFrameSP stop_frame_sp, lldb::BreakpointLocationSP bp_loc_sp, StructuredData::ObjectSP extra_args_sp)
Definition: Lua.cpp:79
static bool RegisterPlugin(llvm::StringRef name, llvm::StringRef description, ABICreateInstance create_callback)
void Flush()
Flush our output and error file handles.
static llvm::Expected< std::unique_ptr< ScriptInterpreterIORedirect > > Create(bool enable_io, Debugger &debugger, CommandReturnObject *result)
Create an IO redirect.
Status SetBreakpointCommandCallbackFunction(BreakpointOptions &bp_options, const char *function_name, StructuredData::ObjectSP extra_args_sp) override
Set a script function as the callback for the breakpoint.
llvm::Error EnterSession(lldb::user_id_t debugger_id)
static bool WatchpointCallbackFunction(void *baton, StoppointCallbackContext *context, lldb::user_id_t watch_id)
static lldb::ScriptInterpreterSP CreateInstance(Debugger &debugger)
Status SetBreakpointCommandCallback(BreakpointOptions &bp_options, const char *command_body_text, bool is_callback) override
void SetWatchpointCommandCallback(WatchpointOptions *wp_options, const char *command_body_text, bool is_callback) override
Set a one-liner as the callback for the watchpoint.
static bool BreakpointCallbackFunction(void *baton, StoppointCallbackContext *context, lldb::user_id_t break_id, lldb::user_id_t break_loc_id)
bool LoadScriptingModule(const char *filename, const LoadScriptOptions &options, lldb_private::Status &error, StructuredData::ObjectSP *module_sp=nullptr, FileSpec extra_search_dir={}) override
void CollectDataForWatchpointCommandCallback(WatchpointOptions *wp_options, CommandReturnObject &result) override
bool ExecuteOneLine(llvm::StringRef command, CommandReturnObject *result, const ExecuteScriptOptions &options=ExecuteScriptOptions()) override
Status RegisterBreakpointCallback(BreakpointOptions &bp_options, const char *command_body_text, StructuredData::ObjectSP extra_args_sp)
static llvm::StringRef GetPluginNameStatic()
void CollectDataForBreakpointCommandCallback(std::vector< std::reference_wrapper< BreakpointOptions > > &bp_options_vec, CommandReturnObject &result) override
StructuredData::DictionarySP GetInterpreterInfo() override
static llvm::StringRef GetPluginDescriptionStatic()
Status RegisterWatchpointCallback(WatchpointOptions *wp_options, const char *command_body_text, StructuredData::ObjectSP extra_args_sp)
An error handling class.
Definition: Status.h:44
General Outline: When we hit a breakpoint we need to package up whatever information is needed to eva...
llvm::StringRef GetString() const
const char * GetStringAtIndex(size_t idx) const
Definition: StringList.cpp:86
size_t GetSize() const
Definition: StringList.cpp:74
void DeleteStringAtIndex(size_t id)
Definition: StringList.cpp:147
void Join(const char *separator, Stream &strm)
Definition: StringList.cpp:92
std::shared_ptr< Dictionary > DictionarySP
std::shared_ptr< Object > ObjectSP
lldb::BreakpointSP GetBreakpointByID(lldb::break_id_t break_id)
Definition: Target.cpp:328
Debugger & GetDebugger()
Definition: Target.h:1055
WatchpointList & GetWatchpointList()
Definition: Target.h:765
lldb::WatchpointSP FindByID(lldb::watch_id_t watchID) const
Returns a shared pointer to the watchpoint with id watchID, const version.
"lldb/Breakpoint/WatchpointOptions.h" Class that manages the options on a watchpoint.
void SetCallback(WatchpointHitCallback callback, const lldb::BatonSP &baton_sp, bool synchronous=false)
Adds a callback to the watchpoint option set.
A class that represents a running process on the host machine.
Definition: SBAttachInfo.h:14
const char * toString(AppleArm64ExceptionClass EC)
Definition: SBAddress.h:15
@ eScriptLanguageLua
std::shared_ptr< lldb_private::StackFrame > StackFrameSP
Definition: lldb-forward.h:412
std::shared_ptr< lldb_private::BreakpointLocation > BreakpointLocationSP
Definition: lldb-forward.h:316
std::shared_ptr< lldb_private::IOHandler > IOHandlerSP
Definition: lldb-forward.h:353
std::shared_ptr< lldb_private::ScriptInterpreter > ScriptInterpreterSP
Definition: lldb-forward.h:398
std::shared_ptr< lldb_private::Breakpoint > BreakpointSP
Definition: lldb-forward.h:313
std::shared_ptr< lldb_private::Watchpoint > WatchpointSP
Definition: lldb-forward.h:477
uint64_t user_id_t
Definition: lldb-types.h:80
Definition: Debugger.h:53
lldb::user_id_t GetID() const
Get accessor for the user ID.
Definition: UserID.h:47