LLDB  mainline
UtilityFunction.cpp
Go to the documentation of this file.
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 <cstdio>
10 #include <sys/types.h>
11 
12 #include "lldb/Core/Module.h"
13 #include "lldb/Core/StreamFile.h"
18 #include "lldb/Host/Host.h"
20 #include "lldb/Target/Process.h"
21 #include "lldb/Target/Target.h"
23 #include "lldb/Utility/Log.h"
24 #include "lldb/Utility/Stream.h"
25 
26 using namespace lldb_private;
27 using namespace lldb;
28 
30 
31 /// Constructor
32 ///
33 /// \param[in] text
34 /// The text of the function. Must be a full translation unit.
35 ///
36 /// \param[in] name
37 /// The name of the function, as used in the text.
39  std::string text, std::string name,
40  bool enable_debugging)
41  : Expression(exe_scope), m_execution_unit_sp(), m_jit_module_wp(),
42  m_function_text(std::move(text)), m_function_name(std::move(name)) {}
43 
45  lldb::ProcessSP process_sp(m_jit_process_wp.lock());
46  if (process_sp) {
47  lldb::ModuleSP jit_module_sp(m_jit_module_wp.lock());
48  if (jit_module_sp)
49  process_sp->GetTarget().GetImages().Remove(jit_module_sp);
50  }
51 }
52 
53 // FIXME: We should check that every time this is called it is called with the
54 // same return type & arguments...
55 
57  const CompilerType &return_type, const ValueList &arg_value_list,
58  lldb::ThreadSP thread_to_use_sp, Status &error) {
59  if (m_caller_up)
60  return m_caller_up.get();
61 
62  ProcessSP process_sp = m_jit_process_wp.lock();
63  if (!process_sp) {
64  error.SetErrorString("Can't make a function caller without a process.");
65  return nullptr;
66  }
67 
68  Address impl_code_address;
69  impl_code_address.SetOffset(StartAddress());
71  name.append("-caller");
72 
73  m_caller_up.reset(process_sp->GetTarget().GetFunctionCallerForLanguage(
74  Language(), return_type, impl_code_address, arg_value_list, name.c_str(),
75  error));
76  if (error.Fail()) {
77 
78  return nullptr;
79  }
80  if (m_caller_up) {
81  DiagnosticManager diagnostics;
82 
83  unsigned num_errors =
84  m_caller_up->CompileFunction(thread_to_use_sp, diagnostics);
85  if (num_errors) {
86  error.SetErrorStringWithFormat(
87  "Error compiling %s caller function: \"%s\".",
88  m_function_name.c_str(), diagnostics.GetString().c_str());
89  m_caller_up.reset();
90  return nullptr;
91  }
92 
93  diagnostics.Clear();
94  ExecutionContext exe_ctx(process_sp);
95 
96  if (!m_caller_up->WriteFunctionWrapper(exe_ctx, diagnostics)) {
97  error.SetErrorStringWithFormat(
98  "Error inserting caller function for %s: \"%s\".",
99  m_function_name.c_str(), diagnostics.GetString().c_str());
100  m_caller_up.reset();
101  return nullptr;
102  }
103  }
104  return m_caller_up.get();
105 }
lldb_private::ExecutionContext
Definition: ExecutionContext.h:292
FunctionCaller.h
lldb_private::UtilityFunction::m_jit_module_wp
lldb::ModuleWP m_jit_module_wp
Definition: UtilityFunction.h:115
lldb_private::UtilityFunction::m_function_name
std::string m_function_name
The name of the function.
Definition: UtilityFunction.h:119
Host.h
lldb_private::Expression::m_jit_process_wp
lldb::ProcessWP m_jit_process_wp
Expression's always have to have a target...
Definition: Expression.h:93
Module.h
lldb_private::ValueList
Definition: Value.h:157
lldb_private::DiagnosticManager::GetString
std::string GetString(char separator='\n')
Definition: DiagnosticManager.cpp:47
Process.h
Target.h
lldb_private::UtilityFunction::MakeFunctionCaller
FunctionCaller * MakeFunctionCaller(const CompilerType &return_type, const ValueList &arg_value_list, lldb::ThreadSP compilation_thread, Status &error)
Definition: UtilityFunction.cpp:56
error
static llvm::raw_ostream & error(Stream &strm)
Definition: CommandReturnObject.cpp:17
Log.h
lldb_private::ExecutionContextScope
Definition: ExecutionContextScope.h:32
lldb_private::UtilityFunction::UtilityFunction
UtilityFunction(ExecutionContextScope &exe_scope, std::string text, std::string name, bool enable_debugging)
Constructor.
Definition: UtilityFunction.cpp:38
IRExecutionUnit.h
string
string(SUBSTRING ${p} 10 -1 pStripped) if($
Definition: Plugins/CMakeLists.txt:40
UtilityFunction.h
lldb_private::UtilityFunction::~UtilityFunction
~UtilityFunction() override
Definition: UtilityFunction.cpp:44
StreamFile.h
lldb_private::Status
Definition: Status.h:44
lldb_private::UtilityFunction::m_caller_up
std::unique_ptr< FunctionCaller > m_caller_up
Definition: UtilityFunction.h:120
lldb_private::Language
Definition: Language.h:29
lldb_private::Address
Definition: Address.h:59
lldb_private::Expression::StartAddress
lldb::addr_t StartAddress()
Return the address of the function's JIT-compiled code, or LLDB_INVALID_ADDRESS if the function is no...
Definition: Expression.h:78
lldb_private::DiagnosticManager
Definition: DiagnosticManager.h:93
lldb_private::Address::SetOffset
bool SetOffset(lldb::addr_t offset)
Set accessor for the offset.
Definition: Address.h:429
lldb_private::CompilerType
Generic representation of a type in a programming language.
Definition: CompilerType.h:33
DiagnosticManager.h
lldb_private::DiagnosticManager::Clear
void Clear()
Definition: DiagnosticManager.h:95
lldb_private
A class that represents a running process on the host machine.
Definition: SBCommandInterpreterRunOptions.h:16
ConstString.h
Stream.h
lldb
Definition: SBAddress.h:15
lldb_private::Expression
Definition: Expression.h:33
ExecutionContext.h
lldb_private::UtilityFunction::ID
static char ID
Definition: UtilityFunction.h:32
lldb_private::FunctionCaller
Definition: FunctionCaller.h:56