xref: /openbsd-src/gnu/llvm/lldb/source/Expression/UtilityFunction.cpp (revision f6aab3d83b51b91c24247ad2c2573574de475a82)
1dda28197Spatrick //===-- UtilityFunction.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 
9be691f3bSpatrick #include <cstdio>
10061da546Spatrick #include <sys/types.h>
11061da546Spatrick 
12061da546Spatrick #include "lldb/Core/Module.h"
13061da546Spatrick #include "lldb/Core/StreamFile.h"
14061da546Spatrick #include "lldb/Expression/DiagnosticManager.h"
15061da546Spatrick #include "lldb/Expression/FunctionCaller.h"
16061da546Spatrick #include "lldb/Expression/IRExecutionUnit.h"
17061da546Spatrick #include "lldb/Expression/UtilityFunction.h"
18061da546Spatrick #include "lldb/Host/Host.h"
19061da546Spatrick #include "lldb/Target/ExecutionContext.h"
20061da546Spatrick #include "lldb/Target/Process.h"
21061da546Spatrick #include "lldb/Target/Target.h"
22061da546Spatrick #include "lldb/Utility/ConstString.h"
23061da546Spatrick #include "lldb/Utility/Log.h"
24061da546Spatrick #include "lldb/Utility/Stream.h"
25061da546Spatrick 
26061da546Spatrick using namespace lldb_private;
27061da546Spatrick using namespace lldb;
28061da546Spatrick 
29061da546Spatrick char UtilityFunction::ID;
30061da546Spatrick 
31061da546Spatrick /// Constructor
32061da546Spatrick ///
33061da546Spatrick /// \param[in] text
34061da546Spatrick ///     The text of the function.  Must be a full translation unit.
35061da546Spatrick ///
36061da546Spatrick /// \param[in] name
37061da546Spatrick ///     The name of the function, as used in the text.
UtilityFunction(ExecutionContextScope & exe_scope,std::string text,std::string name,bool enable_debugging)38061da546Spatrick UtilityFunction::UtilityFunction(ExecutionContextScope &exe_scope,
39be691f3bSpatrick                                  std::string text, std::string name,
40be691f3bSpatrick                                  bool enable_debugging)
41061da546Spatrick     : Expression(exe_scope), m_execution_unit_sp(), m_jit_module_wp(),
42be691f3bSpatrick       m_function_text(std::move(text)), m_function_name(std::move(name)) {}
43061da546Spatrick 
~UtilityFunction()44061da546Spatrick UtilityFunction::~UtilityFunction() {
45061da546Spatrick   lldb::ProcessSP process_sp(m_jit_process_wp.lock());
46061da546Spatrick   if (process_sp) {
47061da546Spatrick     lldb::ModuleSP jit_module_sp(m_jit_module_wp.lock());
48061da546Spatrick     if (jit_module_sp)
49061da546Spatrick       process_sp->GetTarget().GetImages().Remove(jit_module_sp);
50061da546Spatrick   }
51061da546Spatrick }
52061da546Spatrick 
53061da546Spatrick // FIXME: We should check that every time this is called it is called with the
54061da546Spatrick // same return type & arguments...
55061da546Spatrick 
MakeFunctionCaller(const CompilerType & return_type,const ValueList & arg_value_list,lldb::ThreadSP thread_to_use_sp,Status & error)56061da546Spatrick FunctionCaller *UtilityFunction::MakeFunctionCaller(
57061da546Spatrick     const CompilerType &return_type, const ValueList &arg_value_list,
58061da546Spatrick     lldb::ThreadSP thread_to_use_sp, Status &error) {
59061da546Spatrick   if (m_caller_up)
60061da546Spatrick     return m_caller_up.get();
61061da546Spatrick 
62061da546Spatrick   ProcessSP process_sp = m_jit_process_wp.lock();
63061da546Spatrick   if (!process_sp) {
64061da546Spatrick     error.SetErrorString("Can't make a function caller without a process.");
65061da546Spatrick     return nullptr;
66061da546Spatrick   }
67*f6aab3d8Srobert   // Since we might need to call allocate memory and maybe call code to make
68*f6aab3d8Srobert   // the caller, we need to be stopped.
69*f6aab3d8Srobert   if (process_sp->GetState() != lldb::eStateStopped) {
70*f6aab3d8Srobert     error.SetErrorString("Can't make a function caller while the process is "
71*f6aab3d8Srobert                          "running");
72*f6aab3d8Srobert     return nullptr;
73*f6aab3d8Srobert   }
74061da546Spatrick 
75061da546Spatrick   Address impl_code_address;
76061da546Spatrick   impl_code_address.SetOffset(StartAddress());
77061da546Spatrick   std::string name(m_function_name);
78061da546Spatrick   name.append("-caller");
79061da546Spatrick 
80061da546Spatrick   m_caller_up.reset(process_sp->GetTarget().GetFunctionCallerForLanguage(
81061da546Spatrick       Language(), return_type, impl_code_address, arg_value_list, name.c_str(),
82061da546Spatrick       error));
83061da546Spatrick   if (error.Fail()) {
84061da546Spatrick 
85061da546Spatrick     return nullptr;
86061da546Spatrick   }
87061da546Spatrick   if (m_caller_up) {
88061da546Spatrick     DiagnosticManager diagnostics;
89061da546Spatrick 
90061da546Spatrick     unsigned num_errors =
91061da546Spatrick         m_caller_up->CompileFunction(thread_to_use_sp, diagnostics);
92061da546Spatrick     if (num_errors) {
93061da546Spatrick       error.SetErrorStringWithFormat(
94061da546Spatrick           "Error compiling %s caller function: \"%s\".",
95061da546Spatrick           m_function_name.c_str(), diagnostics.GetString().c_str());
96061da546Spatrick       m_caller_up.reset();
97061da546Spatrick       return nullptr;
98061da546Spatrick     }
99061da546Spatrick 
100061da546Spatrick     diagnostics.Clear();
101061da546Spatrick     ExecutionContext exe_ctx(process_sp);
102061da546Spatrick 
103061da546Spatrick     if (!m_caller_up->WriteFunctionWrapper(exe_ctx, diagnostics)) {
104061da546Spatrick       error.SetErrorStringWithFormat(
105061da546Spatrick           "Error inserting caller function for %s: \"%s\".",
106061da546Spatrick           m_function_name.c_str(), diagnostics.GetString().c_str());
107061da546Spatrick       m_caller_up.reset();
108061da546Spatrick       return nullptr;
109061da546Spatrick     }
110061da546Spatrick   }
111061da546Spatrick   return m_caller_up.get();
112061da546Spatrick }
113