1 //===-- SBFunction.cpp ----------------------------------------------------===//
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
7 //===----------------------------------------------------------------------===//
9 #include "lldb/API/SBFunction.h"
10 #include "SBReproducerPrivate.h"
11 #include "lldb/API/SBProcess.h"
12 #include "lldb/API/SBStream.h"
13 #include "lldb/Core/Disassembler.h"
14 #include "lldb/Core/Module.h"
15 #include "lldb/Symbol/CompileUnit.h"
16 #include "lldb/Symbol/Function.h"
17 #include "lldb/Symbol/Type.h"
18 #include "lldb/Symbol/VariableList.h"
19 #include "lldb/Target/ExecutionContext.h"
20 #include "lldb/Target/Target.h"
23 using namespace lldb_private;
25 SBFunction::SBFunction() : m_opaque_ptr(nullptr) {
26 LLDB_RECORD_CONSTRUCTOR_NO_ARGS(SBFunction);
29 SBFunction::SBFunction(lldb_private::Function *lldb_object_ptr)
30 : m_opaque_ptr(lldb_object_ptr) {}
32 SBFunction::SBFunction(const lldb::SBFunction &rhs)
33 : m_opaque_ptr(rhs.m_opaque_ptr) {
34 LLDB_RECORD_CONSTRUCTOR(SBFunction, (const lldb::SBFunction &), rhs);
37 const SBFunction &SBFunction::operator=(const SBFunction &rhs) {
38 LLDB_RECORD_METHOD(const lldb::SBFunction &,
39 SBFunction, operator=,(const lldb::SBFunction &), rhs);
41 m_opaque_ptr = rhs.m_opaque_ptr;
42 return LLDB_RECORD_RESULT(*this);
45 SBFunction::~SBFunction() { m_opaque_ptr = nullptr; }
47 bool SBFunction::IsValid() const {
48 LLDB_RECORD_METHOD_CONST_NO_ARGS(bool, SBFunction, IsValid);
49 return this->operator bool();
51 SBFunction::operator bool() const {
52 LLDB_RECORD_METHOD_CONST_NO_ARGS(bool, SBFunction, operator bool);
54 return m_opaque_ptr != nullptr;
57 const char *SBFunction::GetName() const {
58 LLDB_RECORD_METHOD_CONST_NO_ARGS(const char *, SBFunction, GetName);
60 const char *cstr = nullptr;
62 cstr = m_opaque_ptr->GetName().AsCString();
67 const char *SBFunction::GetDisplayName() const {
68 LLDB_RECORD_METHOD_CONST_NO_ARGS(const char *, SBFunction, GetDisplayName);
70 const char *cstr = nullptr;
72 cstr = m_opaque_ptr->GetMangled().GetDisplayDemangledName().AsCString();
77 const char *SBFunction::GetMangledName() const {
78 LLDB_RECORD_METHOD_CONST_NO_ARGS(const char *, SBFunction, GetMangledName);
80 const char *cstr = nullptr;
82 cstr = m_opaque_ptr->GetMangled().GetMangledName().AsCString();
86 bool SBFunction::operator==(const SBFunction &rhs) const {
87 LLDB_RECORD_METHOD_CONST(
88 bool, SBFunction, operator==,(const lldb::SBFunction &), rhs);
90 return m_opaque_ptr == rhs.m_opaque_ptr;
93 bool SBFunction::operator!=(const SBFunction &rhs) const {
94 LLDB_RECORD_METHOD_CONST(
95 bool, SBFunction, operator!=,(const lldb::SBFunction &), rhs);
97 return m_opaque_ptr != rhs.m_opaque_ptr;
100 bool SBFunction::GetDescription(SBStream &s) {
101 LLDB_RECORD_METHOD(bool, SBFunction, GetDescription, (lldb::SBStream &), s);
104 s.Printf("SBFunction: id = 0x%8.8" PRIx64 ", name = %s",
105 m_opaque_ptr->GetID(), m_opaque_ptr->GetName().AsCString());
106 Type *func_type = m_opaque_ptr->GetType();
108 s.Printf(", type = %s", func_type->GetName().AsCString());
111 s.Printf("No value");
115 SBInstructionList SBFunction::GetInstructions(SBTarget target) {
116 LLDB_RECORD_METHOD(lldb::SBInstructionList, SBFunction, GetInstructions,
117 (lldb::SBTarget), target);
119 return LLDB_RECORD_RESULT(GetInstructions(target, nullptr));
122 SBInstructionList SBFunction::GetInstructions(SBTarget target,
123 const char *flavor) {
124 LLDB_RECORD_METHOD(lldb::SBInstructionList, SBFunction, GetInstructions,
125 (lldb::SBTarget, const char *), target, flavor);
127 SBInstructionList sb_instructions;
129 TargetSP target_sp(target.GetSP());
130 std::unique_lock<std::recursive_mutex> lock;
132 m_opaque_ptr->GetAddressRange().GetBaseAddress().GetModule());
133 if (target_sp && module_sp) {
134 lock = std::unique_lock<std::recursive_mutex>(target_sp->GetAPIMutex());
135 const bool prefer_file_cache = false;
136 sb_instructions.SetDisassembler(Disassembler::DisassembleRange(
137 module_sp->GetArchitecture(), nullptr, flavor, *target_sp,
138 m_opaque_ptr->GetAddressRange(), prefer_file_cache));
141 return LLDB_RECORD_RESULT(sb_instructions);
144 lldb_private::Function *SBFunction::get() { return m_opaque_ptr; }
146 void SBFunction::reset(lldb_private::Function *lldb_object_ptr) {
147 m_opaque_ptr = lldb_object_ptr;
150 SBAddress SBFunction::GetStartAddress() {
151 LLDB_RECORD_METHOD_NO_ARGS(lldb::SBAddress, SBFunction, GetStartAddress);
155 addr.SetAddress(&m_opaque_ptr->GetAddressRange().GetBaseAddress());
156 return LLDB_RECORD_RESULT(addr);
159 SBAddress SBFunction::GetEndAddress() {
160 LLDB_RECORD_METHOD_NO_ARGS(lldb::SBAddress, SBFunction, GetEndAddress);
164 addr_t byte_size = m_opaque_ptr->GetAddressRange().GetByteSize();
166 addr.SetAddress(&m_opaque_ptr->GetAddressRange().GetBaseAddress());
167 addr->Slide(byte_size);
170 return LLDB_RECORD_RESULT(addr);
173 const char *SBFunction::GetArgumentName(uint32_t arg_idx) {
174 LLDB_RECORD_METHOD(const char *, SBFunction, GetArgumentName, (uint32_t),
178 Block &block = m_opaque_ptr->GetBlock(true);
179 VariableListSP variable_list_sp = block.GetBlockVariableList(true);
180 if (variable_list_sp) {
181 VariableList arguments;
182 variable_list_sp->AppendVariablesWithScope(eValueTypeVariableArgument,
184 lldb::VariableSP variable_sp = arguments.GetVariableAtIndex(arg_idx);
186 return variable_sp->GetName().GetCString();
192 uint32_t SBFunction::GetPrologueByteSize() {
193 LLDB_RECORD_METHOD_NO_ARGS(uint32_t, SBFunction, GetPrologueByteSize);
196 return m_opaque_ptr->GetPrologueByteSize();
200 SBType SBFunction::GetType() {
201 LLDB_RECORD_METHOD_NO_ARGS(lldb::SBType, SBFunction, GetType);
205 Type *function_type = m_opaque_ptr->GetType();
207 sb_type.ref().SetType(function_type->shared_from_this());
209 return LLDB_RECORD_RESULT(sb_type);
212 SBBlock SBFunction::GetBlock() {
213 LLDB_RECORD_METHOD_NO_ARGS(lldb::SBBlock, SBFunction, GetBlock);
217 sb_block.SetPtr(&m_opaque_ptr->GetBlock(true));
218 return LLDB_RECORD_RESULT(sb_block);
221 lldb::LanguageType SBFunction::GetLanguage() {
222 LLDB_RECORD_METHOD_NO_ARGS(lldb::LanguageType, SBFunction, GetLanguage);
225 if (m_opaque_ptr->GetCompileUnit())
226 return m_opaque_ptr->GetCompileUnit()->GetLanguage();
228 return lldb::eLanguageTypeUnknown;
231 bool SBFunction::GetIsOptimized() {
232 LLDB_RECORD_METHOD_NO_ARGS(bool, SBFunction, GetIsOptimized);
235 if (m_opaque_ptr->GetCompileUnit())
236 return m_opaque_ptr->GetCompileUnit()->GetIsOptimized();
241 namespace lldb_private {
245 void RegisterMethods<SBFunction>(Registry &R) {
246 LLDB_REGISTER_CONSTRUCTOR(SBFunction, ());
247 LLDB_REGISTER_CONSTRUCTOR(SBFunction, (const lldb::SBFunction &));
248 LLDB_REGISTER_METHOD(const lldb::SBFunction &,
249 SBFunction, operator=,(const lldb::SBFunction &));
250 LLDB_REGISTER_METHOD_CONST(bool, SBFunction, IsValid, ());
251 LLDB_REGISTER_METHOD_CONST(bool, SBFunction, operator bool, ());
252 LLDB_REGISTER_METHOD_CONST(const char *, SBFunction, GetName, ());
253 LLDB_REGISTER_METHOD_CONST(const char *, SBFunction, GetDisplayName, ());
254 LLDB_REGISTER_METHOD_CONST(const char *, SBFunction, GetMangledName, ());
255 LLDB_REGISTER_METHOD_CONST(
256 bool, SBFunction, operator==,(const lldb::SBFunction &));
257 LLDB_REGISTER_METHOD_CONST(
258 bool, SBFunction, operator!=,(const lldb::SBFunction &));
259 LLDB_REGISTER_METHOD(bool, SBFunction, GetDescription, (lldb::SBStream &));
260 LLDB_REGISTER_METHOD(lldb::SBInstructionList, SBFunction, GetInstructions,
262 LLDB_REGISTER_METHOD(lldb::SBInstructionList, SBFunction, GetInstructions,
263 (lldb::SBTarget, const char *));
264 LLDB_REGISTER_METHOD(lldb::SBAddress, SBFunction, GetStartAddress, ());
265 LLDB_REGISTER_METHOD(lldb::SBAddress, SBFunction, GetEndAddress, ());
266 LLDB_REGISTER_METHOD(const char *, SBFunction, GetArgumentName, (uint32_t));
267 LLDB_REGISTER_METHOD(uint32_t, SBFunction, GetPrologueByteSize, ());
268 LLDB_REGISTER_METHOD(lldb::SBType, SBFunction, GetType, ());
269 LLDB_REGISTER_METHOD(lldb::SBBlock, SBFunction, GetBlock, ());
270 LLDB_REGISTER_METHOD(lldb::LanguageType, SBFunction, GetLanguage, ());
271 LLDB_REGISTER_METHOD(bool, SBFunction, GetIsOptimized, ());