1dda28197Spatrick //===-- LLVMUserExpression.cpp --------------------------------------------===//
2061da546Spatrick //
3061da546Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4061da546Spatrick // See https://llvm.org/LICENSE.txt for license information.
5061da546Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6061da546Spatrick //
7061da546Spatrick //===----------------------------------------------------------------------===//
8061da546Spatrick
9061da546Spatrick
10061da546Spatrick #include "lldb/Expression/LLVMUserExpression.h"
11061da546Spatrick #include "lldb/Core/Module.h"
12061da546Spatrick #include "lldb/Core/StreamFile.h"
13061da546Spatrick #include "lldb/Core/ValueObjectConstResult.h"
14061da546Spatrick #include "lldb/Expression/DiagnosticManager.h"
15061da546Spatrick #include "lldb/Expression/ExpressionVariable.h"
16061da546Spatrick #include "lldb/Expression/IRExecutionUnit.h"
17061da546Spatrick #include "lldb/Expression/IRInterpreter.h"
18061da546Spatrick #include "lldb/Expression/Materializer.h"
19061da546Spatrick #include "lldb/Host/HostInfo.h"
20061da546Spatrick #include "lldb/Symbol/Block.h"
21061da546Spatrick #include "lldb/Symbol/Function.h"
22061da546Spatrick #include "lldb/Symbol/ObjectFile.h"
23061da546Spatrick #include "lldb/Symbol/SymbolVendor.h"
24061da546Spatrick #include "lldb/Symbol/Type.h"
25061da546Spatrick #include "lldb/Symbol/VariableList.h"
26061da546Spatrick #include "lldb/Target/ExecutionContext.h"
27061da546Spatrick #include "lldb/Target/Process.h"
28061da546Spatrick #include "lldb/Target/StackFrame.h"
29061da546Spatrick #include "lldb/Target/Target.h"
30061da546Spatrick #include "lldb/Target/ThreadPlan.h"
31061da546Spatrick #include "lldb/Target/ThreadPlanCallUserExpression.h"
32061da546Spatrick #include "lldb/Utility/ConstString.h"
33*f6aab3d8Srobert #include "lldb/Utility/LLDBLog.h"
34061da546Spatrick #include "lldb/Utility/Log.h"
35061da546Spatrick #include "lldb/Utility/StreamString.h"
36061da546Spatrick
37061da546Spatrick using namespace lldb_private;
38061da546Spatrick
39061da546Spatrick char LLVMUserExpression::ID;
40061da546Spatrick
LLVMUserExpression(ExecutionContextScope & exe_scope,llvm::StringRef expr,llvm::StringRef prefix,lldb::LanguageType language,ResultType desired_type,const EvaluateExpressionOptions & options)41061da546Spatrick LLVMUserExpression::LLVMUserExpression(ExecutionContextScope &exe_scope,
42061da546Spatrick llvm::StringRef expr,
43061da546Spatrick llvm::StringRef prefix,
44061da546Spatrick lldb::LanguageType language,
45061da546Spatrick ResultType desired_type,
46061da546Spatrick const EvaluateExpressionOptions &options)
47061da546Spatrick : UserExpression(exe_scope, expr, prefix, language, desired_type, options),
48061da546Spatrick m_stack_frame_bottom(LLDB_INVALID_ADDRESS),
49061da546Spatrick m_stack_frame_top(LLDB_INVALID_ADDRESS), m_allow_cxx(false),
50061da546Spatrick m_allow_objc(false), m_transformed_text(), m_execution_unit_sp(),
51*f6aab3d8Srobert m_materializer_up(), m_jit_module_wp(), m_target(nullptr),
52*f6aab3d8Srobert m_can_interpret(false), m_materialized_address(LLDB_INVALID_ADDRESS) {}
53061da546Spatrick
~LLVMUserExpression()54061da546Spatrick LLVMUserExpression::~LLVMUserExpression() {
55061da546Spatrick if (m_target) {
56061da546Spatrick lldb::ModuleSP jit_module_sp(m_jit_module_wp.lock());
57061da546Spatrick if (jit_module_sp)
58061da546Spatrick m_target->GetImages().Remove(jit_module_sp);
59061da546Spatrick }
60061da546Spatrick }
61061da546Spatrick
62061da546Spatrick lldb::ExpressionResults
DoExecute(DiagnosticManager & diagnostic_manager,ExecutionContext & exe_ctx,const EvaluateExpressionOptions & options,lldb::UserExpressionSP & shared_ptr_to_me,lldb::ExpressionVariableSP & result)63061da546Spatrick LLVMUserExpression::DoExecute(DiagnosticManager &diagnostic_manager,
64061da546Spatrick ExecutionContext &exe_ctx,
65061da546Spatrick const EvaluateExpressionOptions &options,
66061da546Spatrick lldb::UserExpressionSP &shared_ptr_to_me,
67061da546Spatrick lldb::ExpressionVariableSP &result) {
68061da546Spatrick // The expression log is quite verbose, and if you're just tracking the
69061da546Spatrick // execution of the expression, it's quite convenient to have these logs come
70061da546Spatrick // out with the STEP log as well.
71*f6aab3d8Srobert Log *log(GetLog(LLDBLog::Expressions | LLDBLog::Step));
72061da546Spatrick
73061da546Spatrick if (m_jit_start_addr == LLDB_INVALID_ADDRESS && !m_can_interpret) {
74061da546Spatrick diagnostic_manager.PutString(
75061da546Spatrick eDiagnosticSeverityError,
76061da546Spatrick "Expression can't be run, because there is no JIT compiled function");
77061da546Spatrick return lldb::eExpressionSetupError;
78061da546Spatrick }
79061da546Spatrick
80061da546Spatrick lldb::addr_t struct_address = LLDB_INVALID_ADDRESS;
81061da546Spatrick
82061da546Spatrick if (!PrepareToExecuteJITExpression(diagnostic_manager, exe_ctx,
83061da546Spatrick struct_address)) {
84061da546Spatrick diagnostic_manager.Printf(
85061da546Spatrick eDiagnosticSeverityError,
86061da546Spatrick "errored out in %s, couldn't PrepareToExecuteJITExpression",
87061da546Spatrick __FUNCTION__);
88061da546Spatrick return lldb::eExpressionSetupError;
89061da546Spatrick }
90061da546Spatrick
91061da546Spatrick lldb::addr_t function_stack_bottom = LLDB_INVALID_ADDRESS;
92061da546Spatrick lldb::addr_t function_stack_top = LLDB_INVALID_ADDRESS;
93061da546Spatrick
94061da546Spatrick if (m_can_interpret) {
95061da546Spatrick llvm::Module *module = m_execution_unit_sp->GetModule();
96061da546Spatrick llvm::Function *function = m_execution_unit_sp->GetFunction();
97061da546Spatrick
98061da546Spatrick if (!module || !function) {
99061da546Spatrick diagnostic_manager.PutString(
100061da546Spatrick eDiagnosticSeverityError,
101061da546Spatrick "supposed to interpret, but nothing is there");
102061da546Spatrick return lldb::eExpressionSetupError;
103061da546Spatrick }
104061da546Spatrick
105061da546Spatrick Status interpreter_error;
106061da546Spatrick
107061da546Spatrick std::vector<lldb::addr_t> args;
108061da546Spatrick
109061da546Spatrick if (!AddArguments(exe_ctx, args, struct_address, diagnostic_manager)) {
110061da546Spatrick diagnostic_manager.Printf(eDiagnosticSeverityError,
111061da546Spatrick "errored out in %s, couldn't AddArguments",
112061da546Spatrick __FUNCTION__);
113061da546Spatrick return lldb::eExpressionSetupError;
114061da546Spatrick }
115061da546Spatrick
116061da546Spatrick function_stack_bottom = m_stack_frame_bottom;
117061da546Spatrick function_stack_top = m_stack_frame_top;
118061da546Spatrick
119061da546Spatrick IRInterpreter::Interpret(*module, *function, args, *m_execution_unit_sp,
120061da546Spatrick interpreter_error, function_stack_bottom,
121061da546Spatrick function_stack_top, exe_ctx);
122061da546Spatrick
123061da546Spatrick if (!interpreter_error.Success()) {
124061da546Spatrick diagnostic_manager.Printf(eDiagnosticSeverityError,
125061da546Spatrick "supposed to interpret, but failed: %s",
126061da546Spatrick interpreter_error.AsCString());
127061da546Spatrick return lldb::eExpressionDiscarded;
128061da546Spatrick }
129061da546Spatrick } else {
130061da546Spatrick if (!exe_ctx.HasThreadScope()) {
131061da546Spatrick diagnostic_manager.Printf(eDiagnosticSeverityError,
132061da546Spatrick "%s called with no thread selected",
133061da546Spatrick __FUNCTION__);
134061da546Spatrick return lldb::eExpressionSetupError;
135061da546Spatrick }
136061da546Spatrick
137dda28197Spatrick // Store away the thread ID for error reporting, in case it exits
138dda28197Spatrick // during execution:
139dda28197Spatrick lldb::tid_t expr_thread_id = exe_ctx.GetThreadRef().GetID();
140dda28197Spatrick
141061da546Spatrick Address wrapper_address(m_jit_start_addr);
142061da546Spatrick
143061da546Spatrick std::vector<lldb::addr_t> args;
144061da546Spatrick
145061da546Spatrick if (!AddArguments(exe_ctx, args, struct_address, diagnostic_manager)) {
146061da546Spatrick diagnostic_manager.Printf(eDiagnosticSeverityError,
147061da546Spatrick "errored out in %s, couldn't AddArguments",
148061da546Spatrick __FUNCTION__);
149061da546Spatrick return lldb::eExpressionSetupError;
150061da546Spatrick }
151061da546Spatrick
152061da546Spatrick lldb::ThreadPlanSP call_plan_sp(new ThreadPlanCallUserExpression(
153061da546Spatrick exe_ctx.GetThreadRef(), wrapper_address, args, options,
154061da546Spatrick shared_ptr_to_me));
155061da546Spatrick
156061da546Spatrick StreamString ss;
157061da546Spatrick if (!call_plan_sp || !call_plan_sp->ValidatePlan(&ss)) {
158061da546Spatrick diagnostic_manager.PutString(eDiagnosticSeverityError, ss.GetString());
159061da546Spatrick return lldb::eExpressionSetupError;
160061da546Spatrick }
161061da546Spatrick
162061da546Spatrick ThreadPlanCallUserExpression *user_expression_plan =
163061da546Spatrick static_cast<ThreadPlanCallUserExpression *>(call_plan_sp.get());
164061da546Spatrick
165061da546Spatrick lldb::addr_t function_stack_pointer =
166061da546Spatrick user_expression_plan->GetFunctionStackPointer();
167061da546Spatrick
168061da546Spatrick function_stack_bottom = function_stack_pointer - HostInfo::GetPageSize();
169061da546Spatrick function_stack_top = function_stack_pointer;
170061da546Spatrick
171061da546Spatrick LLDB_LOGF(log,
172061da546Spatrick "-- [UserExpression::Execute] Execution of expression begins --");
173061da546Spatrick
174061da546Spatrick if (exe_ctx.GetProcessPtr())
175061da546Spatrick exe_ctx.GetProcessPtr()->SetRunningUserExpression(true);
176061da546Spatrick
177061da546Spatrick lldb::ExpressionResults execution_result =
178061da546Spatrick exe_ctx.GetProcessRef().RunThreadPlan(exe_ctx, call_plan_sp, options,
179061da546Spatrick diagnostic_manager);
180061da546Spatrick
181061da546Spatrick if (exe_ctx.GetProcessPtr())
182061da546Spatrick exe_ctx.GetProcessPtr()->SetRunningUserExpression(false);
183061da546Spatrick
184061da546Spatrick LLDB_LOGF(log, "-- [UserExpression::Execute] Execution of expression "
185061da546Spatrick "completed --");
186061da546Spatrick
187061da546Spatrick if (execution_result == lldb::eExpressionInterrupted ||
188061da546Spatrick execution_result == lldb::eExpressionHitBreakpoint) {
189061da546Spatrick const char *error_desc = nullptr;
190061da546Spatrick
191be691f3bSpatrick if (user_expression_plan) {
192be691f3bSpatrick if (auto real_stop_info_sp = user_expression_plan->GetRealStopInfo())
193061da546Spatrick error_desc = real_stop_info_sp->GetDescription();
194061da546Spatrick }
195061da546Spatrick if (error_desc)
196061da546Spatrick diagnostic_manager.Printf(eDiagnosticSeverityError,
197061da546Spatrick "Execution was interrupted, reason: %s.",
198061da546Spatrick error_desc);
199061da546Spatrick else
200061da546Spatrick diagnostic_manager.PutString(eDiagnosticSeverityError,
201061da546Spatrick "Execution was interrupted.");
202061da546Spatrick
203061da546Spatrick if ((execution_result == lldb::eExpressionInterrupted &&
204061da546Spatrick options.DoesUnwindOnError()) ||
205061da546Spatrick (execution_result == lldb::eExpressionHitBreakpoint &&
206061da546Spatrick options.DoesIgnoreBreakpoints()))
207061da546Spatrick diagnostic_manager.AppendMessageToDiagnostic(
208061da546Spatrick "The process has been returned to the state before expression "
209061da546Spatrick "evaluation.");
210061da546Spatrick else {
211061da546Spatrick if (execution_result == lldb::eExpressionHitBreakpoint)
212061da546Spatrick user_expression_plan->TransferExpressionOwnership();
213061da546Spatrick diagnostic_manager.AppendMessageToDiagnostic(
214061da546Spatrick "The process has been left at the point where it was "
215061da546Spatrick "interrupted, "
216061da546Spatrick "use \"thread return -x\" to return to the state before "
217061da546Spatrick "expression evaluation.");
218061da546Spatrick }
219061da546Spatrick
220061da546Spatrick return execution_result;
221061da546Spatrick } else if (execution_result == lldb::eExpressionStoppedForDebug) {
222061da546Spatrick diagnostic_manager.PutString(
223061da546Spatrick eDiagnosticSeverityRemark,
224061da546Spatrick "Execution was halted at the first instruction of the expression "
225061da546Spatrick "function because \"debug\" was requested.\n"
226061da546Spatrick "Use \"thread return -x\" to return to the state before expression "
227061da546Spatrick "evaluation.");
228061da546Spatrick return execution_result;
229dda28197Spatrick } else if (execution_result == lldb::eExpressionThreadVanished) {
230dda28197Spatrick diagnostic_manager.Printf(
231dda28197Spatrick eDiagnosticSeverityError,
232dda28197Spatrick "Couldn't complete execution; the thread "
233dda28197Spatrick "on which the expression was being run: 0x%" PRIx64
234dda28197Spatrick " exited during its execution.",
235dda28197Spatrick expr_thread_id);
236dda28197Spatrick return execution_result;
237061da546Spatrick } else if (execution_result != lldb::eExpressionCompleted) {
238061da546Spatrick diagnostic_manager.Printf(
239061da546Spatrick eDiagnosticSeverityError, "Couldn't execute function; result was %s",
240061da546Spatrick Process::ExecutionResultAsCString(execution_result));
241061da546Spatrick return execution_result;
242061da546Spatrick }
243061da546Spatrick }
244061da546Spatrick
245061da546Spatrick if (FinalizeJITExecution(diagnostic_manager, exe_ctx, result,
246061da546Spatrick function_stack_bottom, function_stack_top)) {
247061da546Spatrick return lldb::eExpressionCompleted;
248061da546Spatrick } else {
249061da546Spatrick return lldb::eExpressionResultUnavailable;
250061da546Spatrick }
251061da546Spatrick }
252061da546Spatrick
FinalizeJITExecution(DiagnosticManager & diagnostic_manager,ExecutionContext & exe_ctx,lldb::ExpressionVariableSP & result,lldb::addr_t function_stack_bottom,lldb::addr_t function_stack_top)253061da546Spatrick bool LLVMUserExpression::FinalizeJITExecution(
254061da546Spatrick DiagnosticManager &diagnostic_manager, ExecutionContext &exe_ctx,
255061da546Spatrick lldb::ExpressionVariableSP &result, lldb::addr_t function_stack_bottom,
256061da546Spatrick lldb::addr_t function_stack_top) {
257*f6aab3d8Srobert Log *log = GetLog(LLDBLog::Expressions);
258061da546Spatrick
259061da546Spatrick LLDB_LOGF(log, "-- [UserExpression::FinalizeJITExecution] Dematerializing "
260061da546Spatrick "after execution --");
261061da546Spatrick
262061da546Spatrick if (!m_dematerializer_sp) {
263061da546Spatrick diagnostic_manager.Printf(eDiagnosticSeverityError,
264061da546Spatrick "Couldn't apply expression side effects : no "
265061da546Spatrick "dematerializer is present");
266061da546Spatrick return false;
267061da546Spatrick }
268061da546Spatrick
269061da546Spatrick Status dematerialize_error;
270061da546Spatrick
271061da546Spatrick m_dematerializer_sp->Dematerialize(dematerialize_error, function_stack_bottom,
272061da546Spatrick function_stack_top);
273061da546Spatrick
274061da546Spatrick if (!dematerialize_error.Success()) {
275061da546Spatrick diagnostic_manager.Printf(eDiagnosticSeverityError,
276061da546Spatrick "Couldn't apply expression side effects : %s",
277061da546Spatrick dematerialize_error.AsCString("unknown error"));
278061da546Spatrick return false;
279061da546Spatrick }
280061da546Spatrick
281061da546Spatrick result =
282061da546Spatrick GetResultAfterDematerialization(exe_ctx.GetBestExecutionContextScope());
283061da546Spatrick
284061da546Spatrick if (result)
285061da546Spatrick result->TransferAddress();
286061da546Spatrick
287061da546Spatrick m_dematerializer_sp.reset();
288061da546Spatrick
289061da546Spatrick return true;
290061da546Spatrick }
291061da546Spatrick
PrepareToExecuteJITExpression(DiagnosticManager & diagnostic_manager,ExecutionContext & exe_ctx,lldb::addr_t & struct_address)292061da546Spatrick bool LLVMUserExpression::PrepareToExecuteJITExpression(
293061da546Spatrick DiagnosticManager &diagnostic_manager, ExecutionContext &exe_ctx,
294061da546Spatrick lldb::addr_t &struct_address) {
295061da546Spatrick lldb::TargetSP target;
296061da546Spatrick lldb::ProcessSP process;
297061da546Spatrick lldb::StackFrameSP frame;
298061da546Spatrick
299061da546Spatrick if (!LockAndCheckContext(exe_ctx, target, process, frame)) {
300061da546Spatrick diagnostic_manager.PutString(
301061da546Spatrick eDiagnosticSeverityError,
302061da546Spatrick "The context has changed before we could JIT the expression!");
303061da546Spatrick return false;
304061da546Spatrick }
305061da546Spatrick
306061da546Spatrick if (m_jit_start_addr != LLDB_INVALID_ADDRESS || m_can_interpret) {
307061da546Spatrick if (m_materialized_address == LLDB_INVALID_ADDRESS) {
308061da546Spatrick Status alloc_error;
309061da546Spatrick
310061da546Spatrick IRMemoryMap::AllocationPolicy policy =
311061da546Spatrick m_can_interpret ? IRMemoryMap::eAllocationPolicyHostOnly
312061da546Spatrick : IRMemoryMap::eAllocationPolicyMirror;
313061da546Spatrick
314061da546Spatrick const bool zero_memory = false;
315061da546Spatrick
316061da546Spatrick m_materialized_address = m_execution_unit_sp->Malloc(
317061da546Spatrick m_materializer_up->GetStructByteSize(),
318061da546Spatrick m_materializer_up->GetStructAlignment(),
319061da546Spatrick lldb::ePermissionsReadable | lldb::ePermissionsWritable, policy,
320061da546Spatrick zero_memory, alloc_error);
321061da546Spatrick
322061da546Spatrick if (!alloc_error.Success()) {
323061da546Spatrick diagnostic_manager.Printf(
324061da546Spatrick eDiagnosticSeverityError,
325061da546Spatrick "Couldn't allocate space for materialized struct: %s",
326061da546Spatrick alloc_error.AsCString());
327061da546Spatrick return false;
328061da546Spatrick }
329061da546Spatrick }
330061da546Spatrick
331061da546Spatrick struct_address = m_materialized_address;
332061da546Spatrick
333061da546Spatrick if (m_can_interpret && m_stack_frame_bottom == LLDB_INVALID_ADDRESS) {
334061da546Spatrick Status alloc_error;
335061da546Spatrick
336061da546Spatrick const size_t stack_frame_size = 512 * 1024;
337061da546Spatrick
338061da546Spatrick const bool zero_memory = false;
339061da546Spatrick
340061da546Spatrick m_stack_frame_bottom = m_execution_unit_sp->Malloc(
341061da546Spatrick stack_frame_size, 8,
342061da546Spatrick lldb::ePermissionsReadable | lldb::ePermissionsWritable,
343061da546Spatrick IRMemoryMap::eAllocationPolicyHostOnly, zero_memory, alloc_error);
344061da546Spatrick
345061da546Spatrick m_stack_frame_top = m_stack_frame_bottom + stack_frame_size;
346061da546Spatrick
347061da546Spatrick if (!alloc_error.Success()) {
348061da546Spatrick diagnostic_manager.Printf(
349061da546Spatrick eDiagnosticSeverityError,
350061da546Spatrick "Couldn't allocate space for the stack frame: %s",
351061da546Spatrick alloc_error.AsCString());
352061da546Spatrick return false;
353061da546Spatrick }
354061da546Spatrick }
355061da546Spatrick
356061da546Spatrick Status materialize_error;
357061da546Spatrick
358061da546Spatrick m_dematerializer_sp = m_materializer_up->Materialize(
359061da546Spatrick frame, *m_execution_unit_sp, struct_address, materialize_error);
360061da546Spatrick
361061da546Spatrick if (!materialize_error.Success()) {
362061da546Spatrick diagnostic_manager.Printf(eDiagnosticSeverityError,
363061da546Spatrick "Couldn't materialize: %s",
364061da546Spatrick materialize_error.AsCString());
365061da546Spatrick return false;
366061da546Spatrick }
367061da546Spatrick }
368061da546Spatrick return true;
369061da546Spatrick }
370061da546Spatrick
371