1 //===-- UtilityFunction.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 9 #include "lldb/Host/Config.h" 10 11 #include <cstdio> 12 #if HAVE_SYS_TYPES_H 13 #include <sys/types.h> 14 #endif 15 16 17 #include "lldb/Core/Module.h" 18 #include "lldb/Core/StreamFile.h" 19 #include "lldb/Expression/DiagnosticManager.h" 20 #include "lldb/Expression/FunctionCaller.h" 21 #include "lldb/Expression/IRExecutionUnit.h" 22 #include "lldb/Expression/UtilityFunction.h" 23 #include "lldb/Host/Host.h" 24 #include "lldb/Target/ExecutionContext.h" 25 #include "lldb/Target/Process.h" 26 #include "lldb/Target/Target.h" 27 #include "lldb/Utility/ConstString.h" 28 #include "lldb/Utility/Log.h" 29 #include "lldb/Utility/Stream.h" 30 31 using namespace lldb_private; 32 using namespace lldb; 33 34 char UtilityFunction::ID; 35 36 /// Constructor 37 /// 38 /// \param[in] text 39 /// The text of the function. Must be a full translation unit. 40 /// 41 /// \param[in] name 42 /// The name of the function, as used in the text. 43 UtilityFunction::UtilityFunction(ExecutionContextScope &exe_scope, 44 std::string text, std::string name, 45 bool enable_debugging) 46 : Expression(exe_scope), m_execution_unit_sp(), m_jit_module_wp(), 47 m_function_text(std::move(text)), m_function_name(std::move(name)) {} 48 49 UtilityFunction::~UtilityFunction() { 50 lldb::ProcessSP process_sp(m_jit_process_wp.lock()); 51 if (process_sp) { 52 lldb::ModuleSP jit_module_sp(m_jit_module_wp.lock()); 53 if (jit_module_sp) 54 process_sp->GetTarget().GetImages().Remove(jit_module_sp); 55 } 56 } 57 58 // FIXME: We should check that every time this is called it is called with the 59 // same return type & arguments... 60 61 FunctionCaller *UtilityFunction::MakeFunctionCaller( 62 const CompilerType &return_type, const ValueList &arg_value_list, 63 lldb::ThreadSP thread_to_use_sp, Status &error) { 64 if (m_caller_up) 65 return m_caller_up.get(); 66 67 ProcessSP process_sp = m_jit_process_wp.lock(); 68 if (!process_sp) { 69 error.SetErrorString("Can't make a function caller without a process."); 70 return nullptr; 71 } 72 73 Address impl_code_address; 74 impl_code_address.SetOffset(StartAddress()); 75 std::string name(m_function_name); 76 name.append("-caller"); 77 78 m_caller_up.reset(process_sp->GetTarget().GetFunctionCallerForLanguage( 79 Language(), return_type, impl_code_address, arg_value_list, name.c_str(), 80 error)); 81 if (error.Fail()) { 82 83 return nullptr; 84 } 85 if (m_caller_up) { 86 DiagnosticManager diagnostics; 87 88 unsigned num_errors = 89 m_caller_up->CompileFunction(thread_to_use_sp, diagnostics); 90 if (num_errors) { 91 error.SetErrorStringWithFormat( 92 "Error compiling %s caller function: \"%s\".", 93 m_function_name.c_str(), diagnostics.GetString().c_str()); 94 m_caller_up.reset(); 95 return nullptr; 96 } 97 98 diagnostics.Clear(); 99 ExecutionContext exe_ctx(process_sp); 100 101 if (!m_caller_up->WriteFunctionWrapper(exe_ctx, diagnostics)) { 102 error.SetErrorStringWithFormat( 103 "Error inserting caller function for %s: \"%s\".", 104 m_function_name.c_str(), diagnostics.GetString().c_str()); 105 m_caller_up.reset(); 106 return nullptr; 107 } 108 } 109 return m_caller_up.get(); 110 } 111