xref: /openbsd-src/gnu/llvm/lldb/source/Expression/FunctionCaller.cpp (revision f6aab3d83b51b91c24247ad2c2573574de475a82)
1dda28197Spatrick //===-- FunctionCaller.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/FunctionCaller.h"
11061da546Spatrick #include "lldb/Core/Module.h"
12061da546Spatrick #include "lldb/Core/ValueObject.h"
13061da546Spatrick #include "lldb/Core/ValueObjectList.h"
14061da546Spatrick #include "lldb/Expression/DiagnosticManager.h"
15061da546Spatrick #include "lldb/Expression/IRExecutionUnit.h"
16061da546Spatrick #include "lldb/Interpreter/CommandReturnObject.h"
17061da546Spatrick #include "lldb/Symbol/Function.h"
18061da546Spatrick #include "lldb/Symbol/Type.h"
19061da546Spatrick #include "lldb/Target/ExecutionContext.h"
20061da546Spatrick #include "lldb/Target/Process.h"
21061da546Spatrick #include "lldb/Target/RegisterContext.h"
22061da546Spatrick #include "lldb/Target/Target.h"
23061da546Spatrick #include "lldb/Target/Thread.h"
24061da546Spatrick #include "lldb/Target/ThreadPlan.h"
25061da546Spatrick #include "lldb/Target/ThreadPlanCallFunction.h"
26061da546Spatrick #include "lldb/Utility/DataExtractor.h"
27*f6aab3d8Srobert #include "lldb/Utility/LLDBLog.h"
28061da546Spatrick #include "lldb/Utility/Log.h"
29061da546Spatrick #include "lldb/Utility/State.h"
30061da546Spatrick 
31061da546Spatrick using namespace lldb_private;
32061da546Spatrick 
33061da546Spatrick char FunctionCaller::ID;
34061da546Spatrick 
35061da546Spatrick // FunctionCaller constructor
FunctionCaller(ExecutionContextScope & exe_scope,const CompilerType & return_type,const Address & functionAddress,const ValueList & arg_value_list,const char * name)36061da546Spatrick FunctionCaller::FunctionCaller(ExecutionContextScope &exe_scope,
37061da546Spatrick                                const CompilerType &return_type,
38061da546Spatrick                                const Address &functionAddress,
39061da546Spatrick                                const ValueList &arg_value_list,
40061da546Spatrick                                const char *name)
41061da546Spatrick     : Expression(exe_scope), m_execution_unit_sp(), m_parser(),
42061da546Spatrick       m_jit_module_wp(), m_name(name ? name : "<unknown>"),
43061da546Spatrick       m_function_ptr(nullptr), m_function_addr(functionAddress),
44061da546Spatrick       m_function_return_type(return_type),
45061da546Spatrick       m_wrapper_function_name("__lldb_caller_function"),
46061da546Spatrick       m_wrapper_struct_name("__lldb_caller_struct"), m_wrapper_args_addrs(),
47*f6aab3d8Srobert       m_struct_valid(false), m_struct_size(0), m_return_size(0),
48*f6aab3d8Srobert       m_return_offset(0), m_arg_values(arg_value_list), m_compiled(false),
49061da546Spatrick       m_JITted(false) {
50061da546Spatrick   m_jit_process_wp = lldb::ProcessWP(exe_scope.CalculateProcess());
51061da546Spatrick   // Can't make a FunctionCaller without a process.
52061da546Spatrick   assert(m_jit_process_wp.lock());
53061da546Spatrick }
54061da546Spatrick 
55061da546Spatrick // Destructor
~FunctionCaller()56061da546Spatrick FunctionCaller::~FunctionCaller() {
57061da546Spatrick   lldb::ProcessSP process_sp(m_jit_process_wp.lock());
58061da546Spatrick   if (process_sp) {
59061da546Spatrick     lldb::ModuleSP jit_module_sp(m_jit_module_wp.lock());
60061da546Spatrick     if (jit_module_sp)
61061da546Spatrick       process_sp->GetTarget().GetImages().Remove(jit_module_sp);
62061da546Spatrick   }
63061da546Spatrick }
64061da546Spatrick 
WriteFunctionWrapper(ExecutionContext & exe_ctx,DiagnosticManager & diagnostic_manager)65061da546Spatrick bool FunctionCaller::WriteFunctionWrapper(
66061da546Spatrick     ExecutionContext &exe_ctx, DiagnosticManager &diagnostic_manager) {
67061da546Spatrick   Process *process = exe_ctx.GetProcessPtr();
68061da546Spatrick 
69*f6aab3d8Srobert   if (!process) {
70*f6aab3d8Srobert     diagnostic_manager.Printf(eDiagnosticSeverityError, "no process.");
71061da546Spatrick     return false;
72*f6aab3d8Srobert   }
73061da546Spatrick 
74061da546Spatrick   lldb::ProcessSP jit_process_sp(m_jit_process_wp.lock());
75061da546Spatrick 
76*f6aab3d8Srobert   if (process != jit_process_sp.get()) {
77*f6aab3d8Srobert     diagnostic_manager.Printf(eDiagnosticSeverityError,
78*f6aab3d8Srobert                              "process does not match the stored process.");
79061da546Spatrick     return false;
80*f6aab3d8Srobert   }
81061da546Spatrick 
82*f6aab3d8Srobert   if (process->GetState() != lldb::eStateStopped) {
83*f6aab3d8Srobert     diagnostic_manager.Printf(eDiagnosticSeverityError,
84*f6aab3d8Srobert                               "process is not stopped");
85061da546Spatrick     return false;
86*f6aab3d8Srobert   }
87*f6aab3d8Srobert 
88*f6aab3d8Srobert   if (!m_compiled) {
89*f6aab3d8Srobert     diagnostic_manager.Printf(eDiagnosticSeverityError,
90*f6aab3d8Srobert                               "function not compiled");
91*f6aab3d8Srobert     return false;
92*f6aab3d8Srobert   }
93061da546Spatrick 
94061da546Spatrick   if (m_JITted)
95061da546Spatrick     return true;
96061da546Spatrick 
97061da546Spatrick   bool can_interpret = false; // should stay that way
98061da546Spatrick 
99061da546Spatrick   Status jit_error(m_parser->PrepareForExecution(
100061da546Spatrick       m_jit_start_addr, m_jit_end_addr, m_execution_unit_sp, exe_ctx,
101061da546Spatrick       can_interpret, eExecutionPolicyAlways));
102061da546Spatrick 
103061da546Spatrick   if (!jit_error.Success()) {
104061da546Spatrick     diagnostic_manager.Printf(eDiagnosticSeverityError,
105061da546Spatrick                               "Error in PrepareForExecution: %s.",
106061da546Spatrick                               jit_error.AsCString());
107061da546Spatrick     return false;
108061da546Spatrick   }
109061da546Spatrick 
110061da546Spatrick   if (m_parser->GetGenerateDebugInfo()) {
111061da546Spatrick     lldb::ModuleSP jit_module_sp(m_execution_unit_sp->GetJITModule());
112061da546Spatrick 
113061da546Spatrick     if (jit_module_sp) {
114061da546Spatrick       ConstString const_func_name(FunctionName());
115061da546Spatrick       FileSpec jit_file;
116*f6aab3d8Srobert       jit_file.SetFilename(const_func_name);
117061da546Spatrick       jit_module_sp->SetFileSpecAndObjectName(jit_file, ConstString());
118061da546Spatrick       m_jit_module_wp = jit_module_sp;
119061da546Spatrick       process->GetTarget().GetImages().Append(jit_module_sp,
120061da546Spatrick                                               true /* notify */);
121061da546Spatrick     }
122061da546Spatrick   }
123061da546Spatrick   if (process && m_jit_start_addr)
124061da546Spatrick     m_jit_process_wp = process->shared_from_this();
125061da546Spatrick 
126061da546Spatrick   m_JITted = true;
127061da546Spatrick 
128061da546Spatrick   return true;
129061da546Spatrick }
130061da546Spatrick 
WriteFunctionArguments(ExecutionContext & exe_ctx,lldb::addr_t & args_addr_ref,DiagnosticManager & diagnostic_manager)131061da546Spatrick bool FunctionCaller::WriteFunctionArguments(
132061da546Spatrick     ExecutionContext &exe_ctx, lldb::addr_t &args_addr_ref,
133061da546Spatrick     DiagnosticManager &diagnostic_manager) {
134061da546Spatrick   return WriteFunctionArguments(exe_ctx, args_addr_ref, m_arg_values,
135061da546Spatrick                                 diagnostic_manager);
136061da546Spatrick }
137061da546Spatrick 
138061da546Spatrick // FIXME: Assure that the ValueList we were passed in is consistent with the one
139061da546Spatrick // that defined this function.
140061da546Spatrick 
WriteFunctionArguments(ExecutionContext & exe_ctx,lldb::addr_t & args_addr_ref,ValueList & arg_values,DiagnosticManager & diagnostic_manager)141061da546Spatrick bool FunctionCaller::WriteFunctionArguments(
142061da546Spatrick     ExecutionContext &exe_ctx, lldb::addr_t &args_addr_ref,
143061da546Spatrick     ValueList &arg_values, DiagnosticManager &diagnostic_manager) {
144061da546Spatrick   // All the information to reconstruct the struct is provided by the
145061da546Spatrick   // StructExtractor.
146061da546Spatrick   if (!m_struct_valid) {
147061da546Spatrick     diagnostic_manager.PutString(eDiagnosticSeverityError,
148061da546Spatrick                                  "Argument information was not correctly "
149061da546Spatrick                                  "parsed, so the function cannot be called.");
150061da546Spatrick     return false;
151061da546Spatrick   }
152061da546Spatrick 
153061da546Spatrick   Status error;
154061da546Spatrick   lldb::ExpressionResults return_value = lldb::eExpressionSetupError;
155061da546Spatrick 
156061da546Spatrick   Process *process = exe_ctx.GetProcessPtr();
157061da546Spatrick 
158061da546Spatrick   if (process == nullptr)
159061da546Spatrick     return return_value;
160061da546Spatrick 
161061da546Spatrick   lldb::ProcessSP jit_process_sp(m_jit_process_wp.lock());
162061da546Spatrick 
163061da546Spatrick   if (process != jit_process_sp.get())
164061da546Spatrick     return false;
165061da546Spatrick 
166061da546Spatrick   if (args_addr_ref == LLDB_INVALID_ADDRESS) {
167061da546Spatrick     args_addr_ref = process->AllocateMemory(
168061da546Spatrick         m_struct_size, lldb::ePermissionsReadable | lldb::ePermissionsWritable,
169061da546Spatrick         error);
170061da546Spatrick     if (args_addr_ref == LLDB_INVALID_ADDRESS)
171061da546Spatrick       return false;
172061da546Spatrick     m_wrapper_args_addrs.push_back(args_addr_ref);
173061da546Spatrick   } else {
174061da546Spatrick     // Make sure this is an address that we've already handed out.
175061da546Spatrick     if (find(m_wrapper_args_addrs.begin(), m_wrapper_args_addrs.end(),
176061da546Spatrick              args_addr_ref) == m_wrapper_args_addrs.end()) {
177061da546Spatrick       return false;
178061da546Spatrick     }
179061da546Spatrick   }
180061da546Spatrick 
181061da546Spatrick   // TODO: verify fun_addr needs to be a callable address
182061da546Spatrick   Scalar fun_addr(
183061da546Spatrick       m_function_addr.GetCallableLoadAddress(exe_ctx.GetTargetPtr()));
184061da546Spatrick   uint64_t first_offset = m_member_offsets[0];
185061da546Spatrick   process->WriteScalarToMemory(args_addr_ref + first_offset, fun_addr,
186061da546Spatrick                                process->GetAddressByteSize(), error);
187061da546Spatrick 
188061da546Spatrick   // FIXME: We will need to extend this for Variadic functions.
189061da546Spatrick 
190061da546Spatrick   Status value_error;
191061da546Spatrick 
192061da546Spatrick   size_t num_args = arg_values.GetSize();
193061da546Spatrick   if (num_args != m_arg_values.GetSize()) {
194061da546Spatrick     diagnostic_manager.Printf(
195061da546Spatrick         eDiagnosticSeverityError,
196061da546Spatrick         "Wrong number of arguments - was: %" PRIu64 " should be: %" PRIu64 "",
197061da546Spatrick         (uint64_t)num_args, (uint64_t)m_arg_values.GetSize());
198061da546Spatrick     return false;
199061da546Spatrick   }
200061da546Spatrick 
201061da546Spatrick   for (size_t i = 0; i < num_args; i++) {
202061da546Spatrick     // FIXME: We should sanity check sizes.
203061da546Spatrick 
204061da546Spatrick     uint64_t offset = m_member_offsets[i + 1]; // Clang sizes are in bytes.
205061da546Spatrick     Value *arg_value = arg_values.GetValueAtIndex(i);
206061da546Spatrick 
207061da546Spatrick     // FIXME: For now just do scalars:
208061da546Spatrick 
209061da546Spatrick     // Special case: if it's a pointer, don't do anything (the ABI supports
210061da546Spatrick     // passing cstrings)
211061da546Spatrick 
212be691f3bSpatrick     if (arg_value->GetValueType() == Value::ValueType::HostAddress &&
213be691f3bSpatrick         arg_value->GetContextType() == Value::ContextType::Invalid &&
214061da546Spatrick         arg_value->GetCompilerType().IsPointerType())
215061da546Spatrick       continue;
216061da546Spatrick 
217061da546Spatrick     const Scalar &arg_scalar = arg_value->ResolveValue(&exe_ctx);
218061da546Spatrick 
219061da546Spatrick     if (!process->WriteScalarToMemory(args_addr_ref + offset, arg_scalar,
220061da546Spatrick                                       arg_scalar.GetByteSize(), error))
221061da546Spatrick       return false;
222061da546Spatrick   }
223061da546Spatrick 
224061da546Spatrick   return true;
225061da546Spatrick }
226061da546Spatrick 
InsertFunction(ExecutionContext & exe_ctx,lldb::addr_t & args_addr_ref,DiagnosticManager & diagnostic_manager)227061da546Spatrick bool FunctionCaller::InsertFunction(ExecutionContext &exe_ctx,
228061da546Spatrick                                     lldb::addr_t &args_addr_ref,
229061da546Spatrick                                     DiagnosticManager &diagnostic_manager) {
230*f6aab3d8Srobert   // Since we might need to call allocate memory and maybe call code to make
231*f6aab3d8Srobert   // the caller, we need to be stopped.
232*f6aab3d8Srobert   Process *process = exe_ctx.GetProcessPtr();
233*f6aab3d8Srobert   if (!process) {
234*f6aab3d8Srobert     diagnostic_manager.PutString(eDiagnosticSeverityError, "no process");
235*f6aab3d8Srobert     return false;
236*f6aab3d8Srobert   }
237*f6aab3d8Srobert   if (process->GetState() != lldb::eStateStopped) {
238*f6aab3d8Srobert     diagnostic_manager.PutString(eDiagnosticSeverityError, "process running");
239*f6aab3d8Srobert     return false;
240*f6aab3d8Srobert   }
241061da546Spatrick   if (CompileFunction(exe_ctx.GetThreadSP(), diagnostic_manager) != 0)
242061da546Spatrick     return false;
243061da546Spatrick   if (!WriteFunctionWrapper(exe_ctx, diagnostic_manager))
244061da546Spatrick     return false;
245061da546Spatrick   if (!WriteFunctionArguments(exe_ctx, args_addr_ref, diagnostic_manager))
246061da546Spatrick     return false;
247061da546Spatrick 
248*f6aab3d8Srobert   Log *log = GetLog(LLDBLog::Step);
249061da546Spatrick   LLDB_LOGF(log, "Call Address: 0x%" PRIx64 " Struct Address: 0x%" PRIx64 ".\n",
250061da546Spatrick             m_jit_start_addr, args_addr_ref);
251061da546Spatrick 
252061da546Spatrick   return true;
253061da546Spatrick }
254061da546Spatrick 
GetThreadPlanToCallFunction(ExecutionContext & exe_ctx,lldb::addr_t args_addr,const EvaluateExpressionOptions & options,DiagnosticManager & diagnostic_manager)255061da546Spatrick lldb::ThreadPlanSP FunctionCaller::GetThreadPlanToCallFunction(
256061da546Spatrick     ExecutionContext &exe_ctx, lldb::addr_t args_addr,
257061da546Spatrick     const EvaluateExpressionOptions &options,
258061da546Spatrick     DiagnosticManager &diagnostic_manager) {
259*f6aab3d8Srobert   Log *log(GetLog(LLDBLog::Expressions | LLDBLog::Step));
260061da546Spatrick 
261061da546Spatrick   LLDB_LOGF(log,
262061da546Spatrick             "-- [FunctionCaller::GetThreadPlanToCallFunction] Creating "
263061da546Spatrick             "thread plan to call function \"%s\" --",
264061da546Spatrick             m_name.c_str());
265061da546Spatrick 
266061da546Spatrick   // FIXME: Use the errors Stream for better error reporting.
267061da546Spatrick   Thread *thread = exe_ctx.GetThreadPtr();
268061da546Spatrick   if (thread == nullptr) {
269061da546Spatrick     diagnostic_manager.PutString(
270061da546Spatrick         eDiagnosticSeverityError,
271061da546Spatrick         "Can't call a function without a valid thread.");
272061da546Spatrick     return nullptr;
273061da546Spatrick   }
274061da546Spatrick 
275061da546Spatrick   // Okay, now run the function:
276061da546Spatrick 
277061da546Spatrick   Address wrapper_address(m_jit_start_addr);
278061da546Spatrick 
279061da546Spatrick   lldb::addr_t args = {args_addr};
280061da546Spatrick 
281061da546Spatrick   lldb::ThreadPlanSP new_plan_sp(new ThreadPlanCallFunction(
282061da546Spatrick       *thread, wrapper_address, CompilerType(), args, options));
283*f6aab3d8Srobert   new_plan_sp->SetIsControllingPlan(true);
284061da546Spatrick   new_plan_sp->SetOkayToDiscard(false);
285061da546Spatrick   return new_plan_sp;
286061da546Spatrick }
287061da546Spatrick 
FetchFunctionResults(ExecutionContext & exe_ctx,lldb::addr_t args_addr,Value & ret_value)288061da546Spatrick bool FunctionCaller::FetchFunctionResults(ExecutionContext &exe_ctx,
289061da546Spatrick                                           lldb::addr_t args_addr,
290061da546Spatrick                                           Value &ret_value) {
291061da546Spatrick   // Read the return value - it is the last field in the struct:
292061da546Spatrick   // FIXME: How does clang tell us there's no return value?  We need to handle
293061da546Spatrick   // that case.
294061da546Spatrick   // FIXME: Create our ThreadPlanCallFunction with the return CompilerType, and
295061da546Spatrick   // then use GetReturnValueObject
296061da546Spatrick   // to fetch the value.  That way we can fetch any values we need.
297061da546Spatrick 
298*f6aab3d8Srobert   Log *log(GetLog(LLDBLog::Expressions | LLDBLog::Step));
299061da546Spatrick 
300061da546Spatrick   LLDB_LOGF(log,
301061da546Spatrick             "-- [FunctionCaller::FetchFunctionResults] Fetching function "
302061da546Spatrick             "results for \"%s\"--",
303061da546Spatrick             m_name.c_str());
304061da546Spatrick 
305061da546Spatrick   Process *process = exe_ctx.GetProcessPtr();
306061da546Spatrick 
307061da546Spatrick   if (process == nullptr)
308061da546Spatrick     return false;
309061da546Spatrick 
310061da546Spatrick   lldb::ProcessSP jit_process_sp(m_jit_process_wp.lock());
311061da546Spatrick 
312061da546Spatrick   if (process != jit_process_sp.get())
313061da546Spatrick     return false;
314061da546Spatrick 
315061da546Spatrick   Status error;
316061da546Spatrick   ret_value.GetScalar() = process->ReadUnsignedIntegerFromMemory(
317061da546Spatrick       args_addr + m_return_offset, m_return_size, 0, error);
318061da546Spatrick 
319061da546Spatrick   if (error.Fail())
320061da546Spatrick     return false;
321061da546Spatrick 
322061da546Spatrick   ret_value.SetCompilerType(m_function_return_type);
323be691f3bSpatrick   ret_value.SetValueType(Value::ValueType::Scalar);
324061da546Spatrick   return true;
325061da546Spatrick }
326061da546Spatrick 
DeallocateFunctionResults(ExecutionContext & exe_ctx,lldb::addr_t args_addr)327061da546Spatrick void FunctionCaller::DeallocateFunctionResults(ExecutionContext &exe_ctx,
328061da546Spatrick                                                lldb::addr_t args_addr) {
329061da546Spatrick   std::list<lldb::addr_t>::iterator pos;
330061da546Spatrick   pos = std::find(m_wrapper_args_addrs.begin(), m_wrapper_args_addrs.end(),
331061da546Spatrick                   args_addr);
332061da546Spatrick   if (pos != m_wrapper_args_addrs.end())
333061da546Spatrick     m_wrapper_args_addrs.erase(pos);
334061da546Spatrick 
335061da546Spatrick   exe_ctx.GetProcessRef().DeallocateMemory(args_addr);
336061da546Spatrick }
337061da546Spatrick 
ExecuteFunction(ExecutionContext & exe_ctx,lldb::addr_t * args_addr_ptr,const EvaluateExpressionOptions & options,DiagnosticManager & diagnostic_manager,Value & results)338061da546Spatrick lldb::ExpressionResults FunctionCaller::ExecuteFunction(
339061da546Spatrick     ExecutionContext &exe_ctx, lldb::addr_t *args_addr_ptr,
340061da546Spatrick     const EvaluateExpressionOptions &options,
341061da546Spatrick     DiagnosticManager &diagnostic_manager, Value &results) {
342061da546Spatrick   lldb::ExpressionResults return_value = lldb::eExpressionSetupError;
343061da546Spatrick 
344061da546Spatrick   // FunctionCaller::ExecuteFunction execution is always just to get the
345be691f3bSpatrick   // result. Unless explicitly asked for, ignore breakpoints and unwind on
346be691f3bSpatrick   // error.
347be691f3bSpatrick   const bool enable_debugging =
348be691f3bSpatrick       exe_ctx.GetTargetPtr() &&
349be691f3bSpatrick       exe_ctx.GetTargetPtr()->GetDebugUtilityExpression();
350061da546Spatrick   EvaluateExpressionOptions real_options = options;
351be691f3bSpatrick   real_options.SetDebug(false); // This halts the expression for debugging.
352be691f3bSpatrick   real_options.SetGenerateDebugInfo(enable_debugging);
353be691f3bSpatrick   real_options.SetUnwindOnError(!enable_debugging);
354be691f3bSpatrick   real_options.SetIgnoreBreakpoints(!enable_debugging);
355061da546Spatrick 
356061da546Spatrick   lldb::addr_t args_addr;
357061da546Spatrick 
358061da546Spatrick   if (args_addr_ptr != nullptr)
359061da546Spatrick     args_addr = *args_addr_ptr;
360061da546Spatrick   else
361061da546Spatrick     args_addr = LLDB_INVALID_ADDRESS;
362061da546Spatrick 
363061da546Spatrick   if (CompileFunction(exe_ctx.GetThreadSP(), diagnostic_manager) != 0)
364061da546Spatrick     return lldb::eExpressionSetupError;
365061da546Spatrick 
366061da546Spatrick   if (args_addr == LLDB_INVALID_ADDRESS) {
367061da546Spatrick     if (!InsertFunction(exe_ctx, args_addr, diagnostic_manager))
368061da546Spatrick       return lldb::eExpressionSetupError;
369061da546Spatrick   }
370061da546Spatrick 
371*f6aab3d8Srobert   Log *log(GetLog(LLDBLog::Expressions | LLDBLog::Step));
372061da546Spatrick 
373061da546Spatrick   LLDB_LOGF(log,
374061da546Spatrick             "== [FunctionCaller::ExecuteFunction] Executing function \"%s\" ==",
375061da546Spatrick             m_name.c_str());
376061da546Spatrick 
377061da546Spatrick   lldb::ThreadPlanSP call_plan_sp = GetThreadPlanToCallFunction(
378061da546Spatrick       exe_ctx, args_addr, real_options, diagnostic_manager);
379061da546Spatrick   if (!call_plan_sp)
380061da546Spatrick     return lldb::eExpressionSetupError;
381061da546Spatrick 
382061da546Spatrick   // We need to make sure we record the fact that we are running an expression
383061da546Spatrick   // here otherwise this fact will fail to be recorded when fetching an
384061da546Spatrick   // Objective-C object description
385061da546Spatrick   if (exe_ctx.GetProcessPtr())
386061da546Spatrick     exe_ctx.GetProcessPtr()->SetRunningUserExpression(true);
387061da546Spatrick 
388061da546Spatrick   return_value = exe_ctx.GetProcessRef().RunThreadPlan(
389061da546Spatrick       exe_ctx, call_plan_sp, real_options, diagnostic_manager);
390061da546Spatrick 
391061da546Spatrick   if (log) {
392061da546Spatrick     if (return_value != lldb::eExpressionCompleted) {
393061da546Spatrick       LLDB_LOGF(log,
394061da546Spatrick                 "== [FunctionCaller::ExecuteFunction] Execution of \"%s\" "
395dda28197Spatrick                 "completed abnormally: %s ==",
396dda28197Spatrick                 m_name.c_str(),
397dda28197Spatrick                 Process::ExecutionResultAsCString(return_value));
398061da546Spatrick     } else {
399061da546Spatrick       LLDB_LOGF(log,
400061da546Spatrick                 "== [FunctionCaller::ExecuteFunction] Execution of \"%s\" "
401061da546Spatrick                 "completed normally ==",
402061da546Spatrick                 m_name.c_str());
403061da546Spatrick     }
404061da546Spatrick   }
405061da546Spatrick 
406061da546Spatrick   if (exe_ctx.GetProcessPtr())
407061da546Spatrick     exe_ctx.GetProcessPtr()->SetRunningUserExpression(false);
408061da546Spatrick 
409061da546Spatrick   if (args_addr_ptr != nullptr)
410061da546Spatrick     *args_addr_ptr = args_addr;
411061da546Spatrick 
412061da546Spatrick   if (return_value != lldb::eExpressionCompleted)
413061da546Spatrick     return return_value;
414061da546Spatrick 
415061da546Spatrick   FetchFunctionResults(exe_ctx, args_addr, results);
416061da546Spatrick 
417061da546Spatrick   if (args_addr_ptr == nullptr)
418061da546Spatrick     DeallocateFunctionResults(exe_ctx, args_addr);
419061da546Spatrick 
420061da546Spatrick   return lldb::eExpressionCompleted;
421061da546Spatrick }
422