1 //===-- Block.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 //===----------------------------------------------------------------------===//
10 #include "lldb/Symbol/Block.h"
12 #include "lldb/Core/Module.h"
13 #include "lldb/Core/Section.h"
14 #include "lldb/Symbol/Function.h"
15 #include "lldb/Symbol/SymbolFile.h"
16 #include "lldb/Symbol/SymbolVendor.h"
17 #include "lldb/Symbol/VariableList.h"
18 #include "lldb/Utility/Log.h"
21 using namespace lldb_private;
23 Block::Block(lldb::user_id_t uid)
24 : UserID(uid), m_parent_scope(nullptr), m_children(), m_ranges(),
25 m_inlineInfoSP(), m_variable_list_sp(), m_parsed_block_info(false),
26 m_parsed_block_variables(false), m_parsed_child_blocks(false) {}
30 void Block::GetDescription(Stream *s, Function *function,
31 lldb::DescriptionLevel level, Target *target) const {
32 *s << "id = " << ((const UserID &)*this);
34 size_t num_ranges = m_ranges.GetSize();
37 addr_t base_addr = LLDB_INVALID_ADDRESS;
40 function->GetAddressRange().GetBaseAddress().GetLoadAddress(target);
41 if (base_addr == LLDB_INVALID_ADDRESS)
42 base_addr = function->GetAddressRange().GetBaseAddress().GetFileAddress();
44 s->Printf(", range%s = ", num_ranges > 1 ? "s" : "");
45 for (size_t i = 0; i < num_ranges; ++i) {
46 const Range &range = m_ranges.GetEntryRef(i);
47 s->AddressRange(base_addr + range.GetRangeBase(),
48 base_addr + range.GetRangeEnd(), 4);
52 if (m_inlineInfoSP.get() != nullptr) {
53 bool show_fullpaths = (level == eDescriptionLevelVerbose);
54 m_inlineInfoSP->Dump(s, show_fullpaths);
58 void Block::Dump(Stream *s, addr_t base_addr, int32_t depth,
59 bool show_context) const {
61 Block *parent = GetParent();
63 // We have a depth that is less than zero, print our parent blocks
65 parent->Dump(s, base_addr, depth + 1, show_context);
69 s->Printf("%p: ", static_cast<const void *>(this));
71 *s << "Block" << static_cast<const UserID &>(*this);
72 const Block *parent_block = GetParent();
74 s->Printf(", parent = {0x%8.8" PRIx64 "}", parent_block->GetID());
76 if (m_inlineInfoSP.get() != nullptr) {
77 bool show_fullpaths = false;
78 m_inlineInfoSP->Dump(s, show_fullpaths);
81 if (!m_ranges.IsEmpty()) {
84 size_t num_ranges = m_ranges.GetSize();
85 for (size_t i = 0; i < num_ranges; ++i) {
86 const Range &range = m_ranges.GetEntryRef(i);
87 if (parent_block != nullptr && parent_block->Contains(range) == false)
91 s->AddressRange(base_addr + range.GetRangeBase(),
92 base_addr + range.GetRangeEnd(), 4);
100 if (m_variable_list_sp.get()) {
101 m_variable_list_sp->Dump(s, show_context);
104 collection::const_iterator pos, end = m_children.end();
105 for (pos = m_children.begin(); pos != end; ++pos)
106 (*pos)->Dump(s, base_addr, depth - 1, show_context);
112 Block *Block::FindBlockByID(user_id_t block_id) {
113 if (block_id == GetID())
116 Block *matching_block = nullptr;
117 collection::const_iterator pos, end = m_children.end();
118 for (pos = m_children.begin(); pos != end; ++pos) {
119 matching_block = (*pos)->FindBlockByID(block_id);
123 return matching_block;
126 void Block::CalculateSymbolContext(SymbolContext *sc) {
128 m_parent_scope->CalculateSymbolContext(sc);
132 lldb::ModuleSP Block::CalculateSymbolContextModule() {
134 return m_parent_scope->CalculateSymbolContextModule();
135 return lldb::ModuleSP();
138 CompileUnit *Block::CalculateSymbolContextCompileUnit() {
140 return m_parent_scope->CalculateSymbolContextCompileUnit();
144 Function *Block::CalculateSymbolContextFunction() {
146 return m_parent_scope->CalculateSymbolContextFunction();
150 Block *Block::CalculateSymbolContextBlock() { return this; }
152 void Block::DumpSymbolContext(Stream *s) {
153 Function *function = CalculateSymbolContextFunction();
155 function->DumpSymbolContext(s);
156 s->Printf(", Block{0x%8.8" PRIx64 "}", GetID());
159 void Block::DumpAddressRanges(Stream *s, lldb::addr_t base_addr) {
160 if (!m_ranges.IsEmpty()) {
161 size_t num_ranges = m_ranges.GetSize();
162 for (size_t i = 0; i < num_ranges; ++i) {
163 const Range &range = m_ranges.GetEntryRef(i);
164 s->AddressRange(base_addr + range.GetRangeBase(),
165 base_addr + range.GetRangeEnd(), 4);
170 bool Block::Contains(addr_t range_offset) const {
171 return m_ranges.FindEntryThatContains(range_offset) != nullptr;
174 bool Block::Contains(const Block *block) const {
176 return false; // This block doesn't contain itself...
178 // Walk the parent chain for "block" and see if any if them match this block
179 const Block *block_parent;
180 for (block_parent = block->GetParent(); block_parent != nullptr;
181 block_parent = block_parent->GetParent()) {
182 if (this == block_parent)
183 return true; // One of the parents of "block" is this object!
188 bool Block::Contains(const Range &range) const {
189 return m_ranges.FindEntryThatContains(range) != nullptr;
192 Block *Block::GetParent() const {
194 return m_parent_scope->CalculateSymbolContextBlock();
198 Block *Block::GetContainingInlinedBlock() {
199 if (GetInlinedFunctionInfo())
201 return GetInlinedParent();
204 Block *Block::GetInlinedParent() {
205 Block *parent_block = GetParent();
207 if (parent_block->GetInlinedFunctionInfo())
210 return parent_block->GetInlinedParent();
215 bool Block::GetRangeContainingOffset(const addr_t offset, Range &range) {
216 const Range *range_ptr = m_ranges.FindEntryThatContains(offset);
225 bool Block::GetRangeContainingAddress(const Address &addr,
226 AddressRange &range) {
227 Function *function = CalculateSymbolContextFunction();
229 const AddressRange &func_range = function->GetAddressRange();
230 if (addr.GetSection() == func_range.GetBaseAddress().GetSection()) {
231 const addr_t addr_offset = addr.GetOffset();
232 const addr_t func_offset = func_range.GetBaseAddress().GetOffset();
233 if (addr_offset >= func_offset &&
234 addr_offset < func_offset + func_range.GetByteSize()) {
235 addr_t offset = addr_offset - func_offset;
237 const Range *range_ptr = m_ranges.FindEntryThatContains(offset);
240 range.GetBaseAddress() = func_range.GetBaseAddress();
241 range.GetBaseAddress().SetOffset(func_offset +
242 range_ptr->GetRangeBase());
243 range.SetByteSize(range_ptr->GetByteSize());
253 bool Block::GetRangeContainingLoadAddress(lldb::addr_t load_addr,
254 Target &target, AddressRange &range) {
255 Address load_address;
256 load_address.SetLoadAddress(load_addr, &target);
257 AddressRange containing_range;
258 return GetRangeContainingAddress(load_address, containing_range);
261 uint32_t Block::GetRangeIndexContainingAddress(const Address &addr) {
262 Function *function = CalculateSymbolContextFunction();
264 const AddressRange &func_range = function->GetAddressRange();
265 if (addr.GetSection() == func_range.GetBaseAddress().GetSection()) {
266 const addr_t addr_offset = addr.GetOffset();
267 const addr_t func_offset = func_range.GetBaseAddress().GetOffset();
268 if (addr_offset >= func_offset &&
269 addr_offset < func_offset + func_range.GetByteSize()) {
270 addr_t offset = addr_offset - func_offset;
271 return m_ranges.FindEntryIndexThatContains(offset);
278 bool Block::GetRangeAtIndex(uint32_t range_idx, AddressRange &range) {
279 if (range_idx < m_ranges.GetSize()) {
280 Function *function = CalculateSymbolContextFunction();
282 const Range &vm_range = m_ranges.GetEntryRef(range_idx);
283 range.GetBaseAddress() = function->GetAddressRange().GetBaseAddress();
284 range.GetBaseAddress().Slide(vm_range.GetRangeBase());
285 range.SetByteSize(vm_range.GetByteSize());
292 bool Block::GetStartAddress(Address &addr) {
293 if (m_ranges.IsEmpty())
296 Function *function = CalculateSymbolContextFunction();
298 addr = function->GetAddressRange().GetBaseAddress();
299 addr.Slide(m_ranges.GetEntryRef(0).GetRangeBase());
305 void Block::FinalizeRanges() {
307 m_ranges.CombineConsecutiveRanges();
310 void Block::AddRange(const Range &range) {
311 Block *parent_block = GetParent();
312 if (parent_block && !parent_block->Contains(range)) {
313 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_SYMBOLS));
315 ModuleSP module_sp(m_parent_scope->CalculateSymbolContextModule());
316 Function *function = m_parent_scope->CalculateSymbolContextFunction();
317 const addr_t function_file_addr =
318 function->GetAddressRange().GetBaseAddress().GetFileAddress();
319 const addr_t block_start_addr = function_file_addr + range.GetRangeBase();
320 const addr_t block_end_addr = function_file_addr + range.GetRangeEnd();
321 Type *func_type = function->GetType();
323 const Declaration &func_decl = func_type->GetDeclaration();
324 if (func_decl.GetLine()) {
325 log->Printf("warning: %s:%u block {0x%8.8" PRIx64
326 "} has range[%u] [0x%" PRIx64 " - 0x%" PRIx64
327 ") which is not contained in parent block {0x%8.8" PRIx64
328 "} in function {0x%8.8" PRIx64 "} from %s",
329 func_decl.GetFile().GetPath().c_str(), func_decl.GetLine(),
330 GetID(), (uint32_t)m_ranges.GetSize(), block_start_addr,
331 block_end_addr, parent_block->GetID(), function->GetID(),
332 module_sp->GetFileSpec().GetPath().c_str());
334 log->Printf("warning: block {0x%8.8" PRIx64
335 "} has range[%u] [0x%" PRIx64 " - 0x%" PRIx64
336 ") which is not contained in parent block {0x%8.8" PRIx64
337 "} in function {0x%8.8" PRIx64 "} from %s",
338 GetID(), (uint32_t)m_ranges.GetSize(), block_start_addr,
339 block_end_addr, parent_block->GetID(), function->GetID(),
340 module_sp->GetFileSpec().GetPath().c_str());
343 parent_block->AddRange(range);
345 m_ranges.Append(range);
348 // Return the current number of bytes that this object occupies in memory
349 size_t Block::MemorySize() const {
350 size_t mem_size = sizeof(Block) + m_ranges.GetSize() * sizeof(Range);
351 if (m_inlineInfoSP.get())
352 mem_size += m_inlineInfoSP->MemorySize();
353 if (m_variable_list_sp.get())
354 mem_size += m_variable_list_sp->MemorySize();
358 void Block::AddChild(const BlockSP &child_block_sp) {
359 if (child_block_sp) {
360 child_block_sp->SetParentScope(this);
361 m_children.push_back(child_block_sp);
365 void Block::SetInlinedFunctionInfo(const char *name, const char *mangled,
366 const Declaration *decl_ptr,
367 const Declaration *call_decl_ptr) {
368 m_inlineInfoSP.reset(
369 new InlineFunctionInfo(name, mangled, decl_ptr, call_decl_ptr));
372 VariableListSP Block::GetBlockVariableList(bool can_create) {
373 if (m_parsed_block_variables == false) {
374 if (m_variable_list_sp.get() == nullptr && can_create) {
375 m_parsed_block_variables = true;
377 CalculateSymbolContext(&sc);
378 assert(sc.module_sp);
379 sc.module_sp->GetSymbolVendor()->ParseVariablesForContext(sc);
382 return m_variable_list_sp;
386 Block::AppendBlockVariables(bool can_create, bool get_child_block_variables,
387 bool stop_if_child_block_is_inlined_function,
388 const std::function<bool(Variable *)> &filter,
389 VariableList *variable_list) {
390 uint32_t num_variables_added = 0;
391 VariableList *block_var_list = GetBlockVariableList(can_create).get();
392 if (block_var_list) {
393 for (size_t i = 0; i < block_var_list->GetSize(); ++i) {
394 VariableSP variable = block_var_list->GetVariableAtIndex(i);
395 if (filter(variable.get())) {
396 num_variables_added++;
397 variable_list->AddVariable(variable);
402 if (get_child_block_variables) {
403 collection::const_iterator pos, end = m_children.end();
404 for (pos = m_children.begin(); pos != end; ++pos) {
405 Block *child_block = pos->get();
406 if (stop_if_child_block_is_inlined_function == false ||
407 child_block->GetInlinedFunctionInfo() == nullptr) {
408 num_variables_added += child_block->AppendBlockVariables(
409 can_create, get_child_block_variables,
410 stop_if_child_block_is_inlined_function, filter, variable_list);
414 return num_variables_added;
417 uint32_t Block::AppendVariables(bool can_create, bool get_parent_variables,
418 bool stop_if_block_is_inlined_function,
419 const std::function<bool(Variable *)> &filter,
420 VariableList *variable_list) {
421 uint32_t num_variables_added = 0;
422 VariableListSP variable_list_sp(GetBlockVariableList(can_create));
424 bool is_inlined_function = GetInlinedFunctionInfo() != nullptr;
425 if (variable_list_sp) {
426 for (size_t i = 0; i < variable_list_sp->GetSize(); ++i) {
427 VariableSP variable = variable_list_sp->GetVariableAtIndex(i);
428 if (filter(variable.get())) {
429 num_variables_added++;
430 variable_list->AddVariable(variable);
435 if (get_parent_variables) {
436 if (stop_if_block_is_inlined_function && is_inlined_function)
437 return num_variables_added;
439 Block *parent_block = GetParent();
441 num_variables_added += parent_block->AppendVariables(
442 can_create, get_parent_variables, stop_if_block_is_inlined_function,
443 filter, variable_list);
445 return num_variables_added;
448 CompilerDeclContext Block::GetDeclContext() {
449 ModuleSP module_sp = CalculateSymbolContextModule();
452 SymbolVendor *sym_vendor = module_sp->GetSymbolVendor();
455 SymbolFile *sym_file = sym_vendor->GetSymbolFile();
458 return sym_file->GetDeclContextForUID(GetID());
461 return CompilerDeclContext();
464 void Block::SetBlockInfoHasBeenParsed(bool b, bool set_children) {
465 m_parsed_block_info = b;
467 m_parsed_child_blocks = true;
468 collection::const_iterator pos, end = m_children.end();
469 for (pos = m_children.begin(); pos != end; ++pos)
470 (*pos)->SetBlockInfoHasBeenParsed(b, true);
474 void Block::SetDidParseVariables(bool b, bool set_children) {
475 m_parsed_block_variables = b;
477 collection::const_iterator pos, end = m_children.end();
478 for (pos = m_children.begin(); pos != end; ++pos)
479 (*pos)->SetDidParseVariables(b, true);
483 Block *Block::GetSibling() const {
484 if (m_parent_scope) {
485 Block *parent_block = GetParent();
487 return parent_block->GetSiblingForChild(this);
491 // A parent of child blocks can be asked to find a sibling block given
492 // one of its child blocks
493 Block *Block::GetSiblingForChild(const Block *child_block) const {
494 if (!m_children.empty()) {
495 collection::const_iterator pos, end = m_children.end();
496 for (pos = m_children.begin(); pos != end; ++pos) {
497 if (pos->get() == child_block) {