1 //===-- FunctionCaller.cpp ---------------------------------------*- C++-*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
12 // Other libraries and framework includes
15 #include "lldb/Expression/FunctionCaller.h"
16 #include "lldb/Core/DataExtractor.h"
17 #include "lldb/Core/Log.h"
18 #include "lldb/Core/Module.h"
19 #include "lldb/Core/State.h"
20 #include "lldb/Core/ValueObject.h"
21 #include "lldb/Core/ValueObjectList.h"
22 #include "lldb/Expression/DiagnosticManager.h"
23 #include "lldb/Expression/IRExecutionUnit.h"
24 #include "lldb/Interpreter/CommandReturnObject.h"
25 #include "lldb/Symbol/Function.h"
26 #include "lldb/Symbol/Type.h"
27 #include "lldb/Target/ExecutionContext.h"
28 #include "lldb/Target/Process.h"
29 #include "lldb/Target/RegisterContext.h"
30 #include "lldb/Target/Target.h"
31 #include "lldb/Target/Thread.h"
32 #include "lldb/Target/ThreadPlan.h"
33 #include "lldb/Target/ThreadPlanCallFunction.h"
35 using namespace lldb_private;
37 //----------------------------------------------------------------------
38 // FunctionCaller constructor
39 //----------------------------------------------------------------------
40 FunctionCaller::FunctionCaller(ExecutionContextScope &exe_scope,
41 const CompilerType &return_type,
42 const Address &functionAddress,
43 const ValueList &arg_value_list,
45 : Expression(exe_scope), m_execution_unit_sp(), m_parser(),
46 m_jit_module_wp(), m_name(name ? name : "<unknown>"),
47 m_function_ptr(NULL), m_function_addr(functionAddress),
48 m_function_return_type(return_type),
49 m_wrapper_function_name("__lldb_caller_function"),
50 m_wrapper_struct_name("__lldb_caller_struct"), m_wrapper_args_addrs(),
51 m_arg_values(arg_value_list), m_compiled(false), m_JITted(false) {
52 m_jit_process_wp = lldb::ProcessWP(exe_scope.CalculateProcess());
53 // Can't make a FunctionCaller without a process.
54 assert(m_jit_process_wp.lock());
57 //----------------------------------------------------------------------
59 //----------------------------------------------------------------------
60 FunctionCaller::~FunctionCaller() {
61 lldb::ProcessSP process_sp(m_jit_process_wp.lock());
63 lldb::ModuleSP jit_module_sp(m_jit_module_wp.lock());
65 process_sp->GetTarget().GetImages().Remove(jit_module_sp);
69 bool FunctionCaller::WriteFunctionWrapper(
70 ExecutionContext &exe_ctx, DiagnosticManager &diagnostic_manager) {
71 Process *process = exe_ctx.GetProcessPtr();
76 lldb::ProcessSP jit_process_sp(m_jit_process_wp.lock());
78 if (process != jit_process_sp.get())
87 bool can_interpret = false; // should stay that way
89 Error jit_error(m_parser->PrepareForExecution(
90 m_jit_start_addr, m_jit_end_addr, m_execution_unit_sp, exe_ctx,
91 can_interpret, eExecutionPolicyAlways));
93 if (!jit_error.Success())
96 if (m_parser->GetGenerateDebugInfo()) {
97 lldb::ModuleSP jit_module_sp(m_execution_unit_sp->GetJITModule());
100 ConstString const_func_name(FunctionName());
102 jit_file.GetFilename() = const_func_name;
103 jit_module_sp->SetFileSpecAndObjectName(jit_file, ConstString());
104 m_jit_module_wp = jit_module_sp;
105 process->GetTarget().GetImages().Append(jit_module_sp);
108 if (process && m_jit_start_addr)
109 m_jit_process_wp = process->shared_from_this();
116 bool FunctionCaller::WriteFunctionArguments(
117 ExecutionContext &exe_ctx, lldb::addr_t &args_addr_ref,
118 DiagnosticManager &diagnostic_manager) {
119 return WriteFunctionArguments(exe_ctx, args_addr_ref, m_arg_values,
123 // FIXME: Assure that the ValueList we were passed in is consistent with the one
124 // that defined this function.
126 bool FunctionCaller::WriteFunctionArguments(
127 ExecutionContext &exe_ctx, lldb::addr_t &args_addr_ref,
128 ValueList &arg_values, DiagnosticManager &diagnostic_manager) {
129 // All the information to reconstruct the struct is provided by the
131 if (!m_struct_valid) {
132 diagnostic_manager.PutString(eDiagnosticSeverityError,
133 "Argument information was not correctly "
134 "parsed, so the function cannot be called.");
139 lldb::ExpressionResults return_value = lldb::eExpressionSetupError;
141 Process *process = exe_ctx.GetProcessPtr();
146 lldb::ProcessSP jit_process_sp(m_jit_process_wp.lock());
148 if (process != jit_process_sp.get())
151 if (args_addr_ref == LLDB_INVALID_ADDRESS) {
152 args_addr_ref = process->AllocateMemory(
153 m_struct_size, lldb::ePermissionsReadable | lldb::ePermissionsWritable,
155 if (args_addr_ref == LLDB_INVALID_ADDRESS)
157 m_wrapper_args_addrs.push_back(args_addr_ref);
159 // Make sure this is an address that we've already handed out.
160 if (find(m_wrapper_args_addrs.begin(), m_wrapper_args_addrs.end(),
161 args_addr_ref) == m_wrapper_args_addrs.end()) {
166 // TODO: verify fun_addr needs to be a callable address
168 m_function_addr.GetCallableLoadAddress(exe_ctx.GetTargetPtr()));
169 uint64_t first_offset = m_member_offsets[0];
170 process->WriteScalarToMemory(args_addr_ref + first_offset, fun_addr,
171 process->GetAddressByteSize(), error);
173 // FIXME: We will need to extend this for Variadic functions.
177 size_t num_args = arg_values.GetSize();
178 if (num_args != m_arg_values.GetSize()) {
179 diagnostic_manager.Printf(
180 eDiagnosticSeverityError,
181 "Wrong number of arguments - was: %" PRIu64 " should be: %" PRIu64 "",
182 (uint64_t)num_args, (uint64_t)m_arg_values.GetSize());
186 for (size_t i = 0; i < num_args; i++) {
187 // FIXME: We should sanity check sizes.
189 uint64_t offset = m_member_offsets[i + 1]; // Clang sizes are in bytes.
190 Value *arg_value = arg_values.GetValueAtIndex(i);
192 // FIXME: For now just do scalars:
194 // Special case: if it's a pointer, don't do anything (the ABI supports
197 if (arg_value->GetValueType() == Value::eValueTypeHostAddress &&
198 arg_value->GetContextType() == Value::eContextTypeInvalid &&
199 arg_value->GetCompilerType().IsPointerType())
202 const Scalar &arg_scalar = arg_value->ResolveValue(&exe_ctx);
204 if (!process->WriteScalarToMemory(args_addr_ref + offset, arg_scalar,
205 arg_scalar.GetByteSize(), error))
212 bool FunctionCaller::InsertFunction(ExecutionContext &exe_ctx,
213 lldb::addr_t &args_addr_ref,
214 DiagnosticManager &diagnostic_manager) {
215 if (CompileFunction(exe_ctx.GetThreadSP(), diagnostic_manager) != 0)
217 if (!WriteFunctionWrapper(exe_ctx, diagnostic_manager))
219 if (!WriteFunctionArguments(exe_ctx, args_addr_ref, diagnostic_manager))
222 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_STEP));
224 log->Printf("Call Address: 0x%" PRIx64 " Struct Address: 0x%" PRIx64 ".\n",
225 m_jit_start_addr, args_addr_ref);
230 lldb::ThreadPlanSP FunctionCaller::GetThreadPlanToCallFunction(
231 ExecutionContext &exe_ctx, lldb::addr_t args_addr,
232 const EvaluateExpressionOptions &options,
233 DiagnosticManager &diagnostic_manager) {
234 Log *log(lldb_private::GetLogIfAnyCategoriesSet(LIBLLDB_LOG_EXPRESSIONS |
238 log->Printf("-- [FunctionCaller::GetThreadPlanToCallFunction] Creating "
239 "thread plan to call function \"%s\" --",
242 // FIXME: Use the errors Stream for better error reporting.
243 Thread *thread = exe_ctx.GetThreadPtr();
244 if (thread == NULL) {
245 diagnostic_manager.PutString(
246 eDiagnosticSeverityError,
247 "Can't call a function without a valid thread.");
251 // Okay, now run the function:
253 Address wrapper_address(m_jit_start_addr);
255 lldb::addr_t args = {args_addr};
257 lldb::ThreadPlanSP new_plan_sp(new ThreadPlanCallFunction(
258 *thread, wrapper_address, CompilerType(), args, options));
259 new_plan_sp->SetIsMasterPlan(true);
260 new_plan_sp->SetOkayToDiscard(false);
264 bool FunctionCaller::FetchFunctionResults(ExecutionContext &exe_ctx,
265 lldb::addr_t args_addr,
267 // Read the return value - it is the last field in the struct:
268 // FIXME: How does clang tell us there's no return value? We need to handle
270 // FIXME: Create our ThreadPlanCallFunction with the return CompilerType, and
271 // then use GetReturnValueObject
272 // to fetch the value. That way we can fetch any values we need.
274 Log *log(lldb_private::GetLogIfAnyCategoriesSet(LIBLLDB_LOG_EXPRESSIONS |
278 log->Printf("-- [FunctionCaller::FetchFunctionResults] Fetching function "
279 "results for \"%s\"--",
282 Process *process = exe_ctx.GetProcessPtr();
287 lldb::ProcessSP jit_process_sp(m_jit_process_wp.lock());
289 if (process != jit_process_sp.get())
293 ret_value.GetScalar() = process->ReadUnsignedIntegerFromMemory(
294 args_addr + m_return_offset, m_return_size, 0, error);
299 ret_value.SetCompilerType(m_function_return_type);
300 ret_value.SetValueType(Value::eValueTypeScalar);
304 void FunctionCaller::DeallocateFunctionResults(ExecutionContext &exe_ctx,
305 lldb::addr_t args_addr) {
306 std::list<lldb::addr_t>::iterator pos;
307 pos = std::find(m_wrapper_args_addrs.begin(), m_wrapper_args_addrs.end(),
309 if (pos != m_wrapper_args_addrs.end())
310 m_wrapper_args_addrs.erase(pos);
312 exe_ctx.GetProcessRef().DeallocateMemory(args_addr);
315 lldb::ExpressionResults FunctionCaller::ExecuteFunction(
316 ExecutionContext &exe_ctx, lldb::addr_t *args_addr_ptr,
317 const EvaluateExpressionOptions &options,
318 DiagnosticManager &diagnostic_manager, Value &results) {
319 lldb::ExpressionResults return_value = lldb::eExpressionSetupError;
321 // FunctionCaller::ExecuteFunction execution is always just to get the result.
322 // Do make sure we ignore
323 // breakpoints, unwind on error, and don't try to debug it.
324 EvaluateExpressionOptions real_options = options;
325 real_options.SetDebug(false);
326 real_options.SetUnwindOnError(true);
327 real_options.SetIgnoreBreakpoints(true);
329 lldb::addr_t args_addr;
331 if (args_addr_ptr != NULL)
332 args_addr = *args_addr_ptr;
334 args_addr = LLDB_INVALID_ADDRESS;
336 if (CompileFunction(exe_ctx.GetThreadSP(), diagnostic_manager) != 0)
337 return lldb::eExpressionSetupError;
339 if (args_addr == LLDB_INVALID_ADDRESS) {
340 if (!InsertFunction(exe_ctx, args_addr, diagnostic_manager))
341 return lldb::eExpressionSetupError;
344 Log *log(lldb_private::GetLogIfAnyCategoriesSet(LIBLLDB_LOG_EXPRESSIONS |
349 "== [FunctionCaller::ExecuteFunction] Executing function \"%s\" ==",
352 lldb::ThreadPlanSP call_plan_sp = GetThreadPlanToCallFunction(
353 exe_ctx, args_addr, real_options, diagnostic_manager);
355 return lldb::eExpressionSetupError;
357 // We need to make sure we record the fact that we are running an expression
359 // otherwise this fact will fail to be recorded when fetching an Objective-C
360 // object description
361 if (exe_ctx.GetProcessPtr())
362 exe_ctx.GetProcessPtr()->SetRunningUserExpression(true);
364 return_value = exe_ctx.GetProcessRef().RunThreadPlan(
365 exe_ctx, call_plan_sp, real_options, diagnostic_manager);
368 if (return_value != lldb::eExpressionCompleted) {
369 log->Printf("== [FunctionCaller::ExecuteFunction] Execution of \"%s\" "
370 "completed abnormally ==",
373 log->Printf("== [FunctionCaller::ExecuteFunction] Execution of \"%s\" "
374 "completed normally ==",
379 if (exe_ctx.GetProcessPtr())
380 exe_ctx.GetProcessPtr()->SetRunningUserExpression(false);
382 if (args_addr_ptr != NULL)
383 *args_addr_ptr = args_addr;
385 if (return_value != lldb::eExpressionCompleted)
388 FetchFunctionResults(exe_ctx, args_addr, results);
390 if (args_addr_ptr == NULL)
391 DeallocateFunctionResults(exe_ctx, args_addr);
393 return lldb::eExpressionCompleted;