8b3af63b89
A lot of comments in LLDB are surrounded by an ASCII line to delimit the begging and end of the comment. Its use is not really consistent across the code base, sometimes the lines are longer, sometimes they are shorter and sometimes they are omitted. Furthermore, it looks kind of weird with the 80 column limit, where the comment actually extends past the line, but not by much. Furthermore, when /// is used for Doxygen comments, it looks particularly odd. And when // is used, it incorrectly gives the impression that it's actually a Doxygen comment. I assume these lines were added to improve distinguishing between comments and code. However, given that todays editors and IDEs do a great job at highlighting comments, I think it's worth to drop this for the sake of consistency. The alternative is fixing all the inconsistencies, which would create a lot more churn. Differential revision: https://reviews.llvm.org/D60508 llvm-svn: 358135
487 lines
18 KiB
C++
487 lines
18 KiB
C++
//===-- ManualDWARFIndex.cpp -----------------------------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "Plugins/SymbolFile/DWARF/ManualDWARFIndex.h"
|
|
#include "Plugins/Language/ObjC/ObjCLanguage.h"
|
|
#include "Plugins/SymbolFile/DWARF/DWARFDebugInfo.h"
|
|
#include "Plugins/SymbolFile/DWARF/DWARFDeclContext.h"
|
|
#include "Plugins/SymbolFile/DWARF/LogChannelDWARF.h"
|
|
#include "Plugins/SymbolFile/DWARF/SymbolFileDWARFDwo.h"
|
|
#include "lldb/Core/Module.h"
|
|
#include "lldb/Host/TaskPool.h"
|
|
#include "lldb/Symbol/ObjectFile.h"
|
|
#include "lldb/Utility/Stream.h"
|
|
#include "lldb/Utility/Timer.h"
|
|
|
|
using namespace lldb_private;
|
|
using namespace lldb;
|
|
|
|
void ManualDWARFIndex::Index() {
|
|
if (!m_debug_info)
|
|
return;
|
|
|
|
DWARFDebugInfo &debug_info = *m_debug_info;
|
|
m_debug_info = nullptr;
|
|
|
|
static Timer::Category func_cat(LLVM_PRETTY_FUNCTION);
|
|
Timer scoped_timer(func_cat, "%p", static_cast<void *>(&debug_info));
|
|
|
|
std::vector<DWARFUnit *> units_to_index;
|
|
units_to_index.reserve(debug_info.GetNumCompileUnits());
|
|
for (size_t U = 0; U < debug_info.GetNumCompileUnits(); ++U) {
|
|
DWARFUnit *unit = debug_info.GetCompileUnitAtIndex(U);
|
|
if (unit && m_units_to_avoid.count(unit->GetOffset()) == 0)
|
|
units_to_index.push_back(unit);
|
|
}
|
|
if (units_to_index.empty())
|
|
return;
|
|
|
|
std::vector<IndexSet> sets(units_to_index.size());
|
|
|
|
// Keep memory down by clearing DIEs for any compile units if indexing
|
|
// caused us to load the compile unit's DIEs.
|
|
std::vector<llvm::Optional<DWARFUnit::ScopedExtractDIEs>> clear_cu_dies(
|
|
units_to_index.size());
|
|
auto parser_fn = [&](size_t cu_idx) {
|
|
IndexUnit(*units_to_index[cu_idx], sets[cu_idx]);
|
|
};
|
|
|
|
auto extract_fn = [&units_to_index, &clear_cu_dies](size_t cu_idx) {
|
|
clear_cu_dies[cu_idx] = units_to_index[cu_idx]->ExtractDIEsScoped();
|
|
};
|
|
|
|
// Create a task runner that extracts dies for each DWARF compile unit in a
|
|
// separate thread
|
|
// First figure out which compile units didn't have their DIEs already
|
|
// parsed and remember this. If no DIEs were parsed prior to this index
|
|
// function call, we are going to want to clear the CU dies after we are
|
|
// done indexing to make sure we don't pull in all DWARF dies, but we need
|
|
// to wait until all compile units have been indexed in case a DIE in one
|
|
// compile unit refers to another and the indexes accesses those DIEs.
|
|
TaskMapOverInt(0, units_to_index.size(), extract_fn);
|
|
|
|
// Now create a task runner that can index each DWARF compile unit in a
|
|
// separate thread so we can index quickly.
|
|
|
|
TaskMapOverInt(0, units_to_index.size(), parser_fn);
|
|
|
|
auto finalize_fn = [this, &sets](NameToDIE(IndexSet::*index)) {
|
|
NameToDIE &result = m_set.*index;
|
|
for (auto &set : sets)
|
|
result.Append(set.*index);
|
|
result.Finalize();
|
|
};
|
|
|
|
TaskPool::RunTasks([&]() { finalize_fn(&IndexSet::function_basenames); },
|
|
[&]() { finalize_fn(&IndexSet::function_fullnames); },
|
|
[&]() { finalize_fn(&IndexSet::function_methods); },
|
|
[&]() { finalize_fn(&IndexSet::function_selectors); },
|
|
[&]() { finalize_fn(&IndexSet::objc_class_selectors); },
|
|
[&]() { finalize_fn(&IndexSet::globals); },
|
|
[&]() { finalize_fn(&IndexSet::types); },
|
|
[&]() { finalize_fn(&IndexSet::namespaces); });
|
|
}
|
|
|
|
void ManualDWARFIndex::IndexUnit(DWARFUnit &unit, IndexSet &set) {
|
|
assert(!unit.GetSymbolFileDWARF()->GetBaseCompileUnit() &&
|
|
"DWARFUnit associated with .dwo or .dwp should not be indexed directly");
|
|
|
|
Log *log = LogChannelDWARF::GetLogIfAll(DWARF_LOG_LOOKUPS);
|
|
|
|
if (log) {
|
|
m_module.LogMessage(
|
|
log, "ManualDWARFIndex::IndexUnit for compile unit at .debug_info[0x%8.8x]",
|
|
unit.GetOffset());
|
|
}
|
|
|
|
const LanguageType cu_language = unit.GetLanguageType();
|
|
DWARFFormValue::FixedFormSizes fixed_form_sizes = unit.GetFixedFormSizes();
|
|
|
|
IndexUnitImpl(unit, cu_language, fixed_form_sizes, unit.GetOffset(), set);
|
|
|
|
SymbolFileDWARFDwo *dwo_symbol_file = unit.GetDwoSymbolFile();
|
|
if (dwo_symbol_file && dwo_symbol_file->GetCompileUnit()) {
|
|
IndexUnitImpl(*dwo_symbol_file->GetCompileUnit(), cu_language,
|
|
fixed_form_sizes, unit.GetOffset(), set);
|
|
}
|
|
}
|
|
|
|
void ManualDWARFIndex::IndexUnitImpl(
|
|
DWARFUnit &unit, const LanguageType cu_language,
|
|
const DWARFFormValue::FixedFormSizes &fixed_form_sizes,
|
|
const dw_offset_t cu_offset, IndexSet &set) {
|
|
for (const DWARFDebugInfoEntry &die : unit.dies()) {
|
|
const dw_tag_t tag = die.Tag();
|
|
|
|
switch (tag) {
|
|
case DW_TAG_array_type:
|
|
case DW_TAG_base_type:
|
|
case DW_TAG_class_type:
|
|
case DW_TAG_constant:
|
|
case DW_TAG_enumeration_type:
|
|
case DW_TAG_inlined_subroutine:
|
|
case DW_TAG_namespace:
|
|
case DW_TAG_string_type:
|
|
case DW_TAG_structure_type:
|
|
case DW_TAG_subprogram:
|
|
case DW_TAG_subroutine_type:
|
|
case DW_TAG_typedef:
|
|
case DW_TAG_union_type:
|
|
case DW_TAG_unspecified_type:
|
|
case DW_TAG_variable:
|
|
break;
|
|
|
|
default:
|
|
continue;
|
|
}
|
|
|
|
DWARFAttributes attributes;
|
|
const char *name = NULL;
|
|
const char *mangled_cstr = NULL;
|
|
bool is_declaration = false;
|
|
// bool is_artificial = false;
|
|
bool has_address = false;
|
|
bool has_location_or_const_value = false;
|
|
bool is_global_or_static_variable = false;
|
|
|
|
DWARFFormValue specification_die_form;
|
|
const size_t num_attributes =
|
|
die.GetAttributes(&unit, fixed_form_sizes, attributes);
|
|
if (num_attributes > 0) {
|
|
for (uint32_t i = 0; i < num_attributes; ++i) {
|
|
dw_attr_t attr = attributes.AttributeAtIndex(i);
|
|
DWARFFormValue form_value;
|
|
switch (attr) {
|
|
case DW_AT_name:
|
|
if (attributes.ExtractFormValueAtIndex(i, form_value))
|
|
name = form_value.AsCString();
|
|
break;
|
|
|
|
case DW_AT_declaration:
|
|
if (attributes.ExtractFormValueAtIndex(i, form_value))
|
|
is_declaration = form_value.Unsigned() != 0;
|
|
break;
|
|
|
|
// case DW_AT_artificial:
|
|
// if (attributes.ExtractFormValueAtIndex(i,
|
|
// form_value))
|
|
// is_artificial = form_value.Unsigned() != 0;
|
|
// break;
|
|
|
|
case DW_AT_MIPS_linkage_name:
|
|
case DW_AT_linkage_name:
|
|
if (attributes.ExtractFormValueAtIndex(i, form_value))
|
|
mangled_cstr = form_value.AsCString();
|
|
break;
|
|
|
|
case DW_AT_low_pc:
|
|
case DW_AT_high_pc:
|
|
case DW_AT_ranges:
|
|
has_address = true;
|
|
break;
|
|
|
|
case DW_AT_entry_pc:
|
|
has_address = true;
|
|
break;
|
|
|
|
case DW_AT_location:
|
|
case DW_AT_const_value:
|
|
has_location_or_const_value = true;
|
|
if (tag == DW_TAG_variable) {
|
|
const DWARFDebugInfoEntry *parent_die = die.GetParent();
|
|
while (parent_die != NULL) {
|
|
switch (parent_die->Tag()) {
|
|
case DW_TAG_subprogram:
|
|
case DW_TAG_lexical_block:
|
|
case DW_TAG_inlined_subroutine:
|
|
// Even if this is a function level static, we don't add it. We
|
|
// could theoretically add these if we wanted to by
|
|
// introspecting into the DW_AT_location and seeing if the
|
|
// location describes a hard coded address, but we don't want
|
|
// the performance penalty of that right now.
|
|
is_global_or_static_variable = false;
|
|
// if (attributes.ExtractFormValueAtIndex(dwarf, i,
|
|
// form_value)) {
|
|
// // If we have valid block data, then we have location
|
|
// // expression bytesthat are fixed (not a location list).
|
|
// const uint8_t *block_data = form_value.BlockData();
|
|
// if (block_data) {
|
|
// uint32_t block_length = form_value.Unsigned();
|
|
// if (block_length == 1 +
|
|
// attributes.CompileUnitAtIndex(i)->GetAddressByteSize()) {
|
|
// if (block_data[0] == DW_OP_addr)
|
|
// add_die = true;
|
|
// }
|
|
// }
|
|
// }
|
|
parent_die = NULL; // Terminate the while loop.
|
|
break;
|
|
|
|
case DW_TAG_compile_unit:
|
|
case DW_TAG_partial_unit:
|
|
is_global_or_static_variable = true;
|
|
parent_die = NULL; // Terminate the while loop.
|
|
break;
|
|
|
|
default:
|
|
parent_die =
|
|
parent_die->GetParent(); // Keep going in the while loop.
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
break;
|
|
|
|
case DW_AT_specification:
|
|
if (attributes.ExtractFormValueAtIndex(i, form_value))
|
|
specification_die_form = form_value;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
switch (tag) {
|
|
case DW_TAG_inlined_subroutine:
|
|
case DW_TAG_subprogram:
|
|
if (has_address) {
|
|
if (name) {
|
|
ObjCLanguage::MethodName objc_method(name, true);
|
|
if (objc_method.IsValid(true)) {
|
|
ConstString objc_class_name_with_category(
|
|
objc_method.GetClassNameWithCategory());
|
|
ConstString objc_selector_name(objc_method.GetSelector());
|
|
ConstString objc_fullname_no_category_name(
|
|
objc_method.GetFullNameWithoutCategory(true));
|
|
ConstString objc_class_name_no_category(objc_method.GetClassName());
|
|
set.function_fullnames.Insert(ConstString(name),
|
|
DIERef(cu_offset, die.GetOffset()));
|
|
if (objc_class_name_with_category)
|
|
set.objc_class_selectors.Insert(
|
|
objc_class_name_with_category,
|
|
DIERef(cu_offset, die.GetOffset()));
|
|
if (objc_class_name_no_category &&
|
|
objc_class_name_no_category != objc_class_name_with_category)
|
|
set.objc_class_selectors.Insert(
|
|
objc_class_name_no_category,
|
|
DIERef(cu_offset, die.GetOffset()));
|
|
if (objc_selector_name)
|
|
set.function_selectors.Insert(objc_selector_name,
|
|
DIERef(cu_offset, die.GetOffset()));
|
|
if (objc_fullname_no_category_name)
|
|
set.function_fullnames.Insert(objc_fullname_no_category_name,
|
|
DIERef(cu_offset, die.GetOffset()));
|
|
}
|
|
// If we have a mangled name, then the DW_AT_name attribute is
|
|
// usually the method name without the class or any parameters
|
|
bool is_method = DWARFDIE(&unit, &die).IsMethod();
|
|
|
|
if (is_method)
|
|
set.function_methods.Insert(ConstString(name),
|
|
DIERef(cu_offset, die.GetOffset()));
|
|
else
|
|
set.function_basenames.Insert(ConstString(name),
|
|
DIERef(cu_offset, die.GetOffset()));
|
|
|
|
if (!is_method && !mangled_cstr && !objc_method.IsValid(true))
|
|
set.function_fullnames.Insert(ConstString(name),
|
|
DIERef(cu_offset, die.GetOffset()));
|
|
}
|
|
if (mangled_cstr) {
|
|
// Make sure our mangled name isn't the same string table entry as
|
|
// our name. If it starts with '_', then it is ok, else compare the
|
|
// string to make sure it isn't the same and we don't end up with
|
|
// duplicate entries
|
|
if (name && name != mangled_cstr &&
|
|
((mangled_cstr[0] == '_') ||
|
|
(::strcmp(name, mangled_cstr) != 0))) {
|
|
set.function_fullnames.Insert(ConstString(mangled_cstr),
|
|
DIERef(cu_offset, die.GetOffset()));
|
|
}
|
|
}
|
|
}
|
|
break;
|
|
|
|
case DW_TAG_array_type:
|
|
case DW_TAG_base_type:
|
|
case DW_TAG_class_type:
|
|
case DW_TAG_constant:
|
|
case DW_TAG_enumeration_type:
|
|
case DW_TAG_string_type:
|
|
case DW_TAG_structure_type:
|
|
case DW_TAG_subroutine_type:
|
|
case DW_TAG_typedef:
|
|
case DW_TAG_union_type:
|
|
case DW_TAG_unspecified_type:
|
|
if (name && !is_declaration)
|
|
set.types.Insert(ConstString(name), DIERef(cu_offset, die.GetOffset()));
|
|
if (mangled_cstr && !is_declaration)
|
|
set.types.Insert(ConstString(mangled_cstr),
|
|
DIERef(cu_offset, die.GetOffset()));
|
|
break;
|
|
|
|
case DW_TAG_namespace:
|
|
if (name)
|
|
set.namespaces.Insert(ConstString(name),
|
|
DIERef(cu_offset, die.GetOffset()));
|
|
break;
|
|
|
|
case DW_TAG_variable:
|
|
if (name && has_location_or_const_value && is_global_or_static_variable) {
|
|
set.globals.Insert(ConstString(name),
|
|
DIERef(cu_offset, die.GetOffset()));
|
|
// Be sure to include variables by their mangled and demangled names if
|
|
// they have any since a variable can have a basename "i", a mangled
|
|
// named "_ZN12_GLOBAL__N_11iE" and a demangled mangled name
|
|
// "(anonymous namespace)::i"...
|
|
|
|
// Make sure our mangled name isn't the same string table entry as our
|
|
// name. If it starts with '_', then it is ok, else compare the string
|
|
// to make sure it isn't the same and we don't end up with duplicate
|
|
// entries
|
|
if (mangled_cstr && name != mangled_cstr &&
|
|
((mangled_cstr[0] == '_') || (::strcmp(name, mangled_cstr) != 0))) {
|
|
set.globals.Insert(ConstString(mangled_cstr),
|
|
DIERef(cu_offset, die.GetOffset()));
|
|
}
|
|
}
|
|
break;
|
|
|
|
default:
|
|
continue;
|
|
}
|
|
}
|
|
}
|
|
|
|
void ManualDWARFIndex::GetGlobalVariables(ConstString basename, DIEArray &offsets) {
|
|
Index();
|
|
m_set.globals.Find(basename, offsets);
|
|
}
|
|
|
|
void ManualDWARFIndex::GetGlobalVariables(const RegularExpression ®ex,
|
|
DIEArray &offsets) {
|
|
Index();
|
|
m_set.globals.Find(regex, offsets);
|
|
}
|
|
|
|
void ManualDWARFIndex::GetGlobalVariables(const DWARFUnit &cu,
|
|
DIEArray &offsets) {
|
|
Index();
|
|
m_set.globals.FindAllEntriesForCompileUnit(cu.GetOffset(), offsets);
|
|
}
|
|
|
|
void ManualDWARFIndex::GetObjCMethods(ConstString class_name,
|
|
DIEArray &offsets) {
|
|
Index();
|
|
m_set.objc_class_selectors.Find(class_name, offsets);
|
|
}
|
|
|
|
void ManualDWARFIndex::GetCompleteObjCClass(ConstString class_name,
|
|
bool must_be_implementation,
|
|
DIEArray &offsets) {
|
|
Index();
|
|
m_set.types.Find(class_name, offsets);
|
|
}
|
|
|
|
void ManualDWARFIndex::GetTypes(ConstString name, DIEArray &offsets) {
|
|
Index();
|
|
m_set.types.Find(name, offsets);
|
|
}
|
|
|
|
void ManualDWARFIndex::GetTypes(const DWARFDeclContext &context,
|
|
DIEArray &offsets) {
|
|
Index();
|
|
m_set.types.Find(ConstString(context[0].name), offsets);
|
|
}
|
|
|
|
void ManualDWARFIndex::GetNamespaces(ConstString name, DIEArray &offsets) {
|
|
Index();
|
|
m_set.namespaces.Find(name, offsets);
|
|
}
|
|
|
|
void ManualDWARFIndex::GetFunctions(ConstString name, DWARFDebugInfo &info,
|
|
const CompilerDeclContext &parent_decl_ctx,
|
|
uint32_t name_type_mask,
|
|
std::vector<DWARFDIE> &dies) {
|
|
Index();
|
|
|
|
if (name_type_mask & eFunctionNameTypeFull) {
|
|
DIEArray offsets;
|
|
m_set.function_basenames.Find(name, offsets);
|
|
m_set.function_methods.Find(name, offsets);
|
|
m_set.function_fullnames.Find(name, offsets);
|
|
for (const DIERef &die_ref: offsets) {
|
|
DWARFDIE die = info.GetDIE(die_ref);
|
|
if (!die)
|
|
continue;
|
|
if (SymbolFileDWARF::DIEInDeclContext(&parent_decl_ctx, die))
|
|
dies.push_back(die);
|
|
}
|
|
}
|
|
if (name_type_mask & eFunctionNameTypeBase) {
|
|
DIEArray offsets;
|
|
m_set.function_basenames.Find(name, offsets);
|
|
for (const DIERef &die_ref: offsets) {
|
|
DWARFDIE die = info.GetDIE(die_ref);
|
|
if (!die)
|
|
continue;
|
|
if (SymbolFileDWARF::DIEInDeclContext(&parent_decl_ctx, die))
|
|
dies.push_back(die);
|
|
}
|
|
offsets.clear();
|
|
}
|
|
|
|
if (name_type_mask & eFunctionNameTypeMethod && !parent_decl_ctx.IsValid()) {
|
|
DIEArray offsets;
|
|
m_set.function_methods.Find(name, offsets);
|
|
for (const DIERef &die_ref: offsets) {
|
|
if (DWARFDIE die = info.GetDIE(die_ref))
|
|
dies.push_back(die);
|
|
}
|
|
}
|
|
|
|
if (name_type_mask & eFunctionNameTypeSelector &&
|
|
!parent_decl_ctx.IsValid()) {
|
|
DIEArray offsets;
|
|
m_set.function_selectors.Find(name, offsets);
|
|
for (const DIERef &die_ref: offsets) {
|
|
if (DWARFDIE die = info.GetDIE(die_ref))
|
|
dies.push_back(die);
|
|
}
|
|
}
|
|
}
|
|
|
|
void ManualDWARFIndex::GetFunctions(const RegularExpression ®ex,
|
|
DIEArray &offsets) {
|
|
Index();
|
|
|
|
m_set.function_basenames.Find(regex, offsets);
|
|
m_set.function_fullnames.Find(regex, offsets);
|
|
}
|
|
|
|
void ManualDWARFIndex::Dump(Stream &s) {
|
|
s.Format("Manual DWARF index for ({0}) '{1:F}':",
|
|
m_module.GetArchitecture().GetArchitectureName(),
|
|
m_module.GetObjectFile()->GetFileSpec());
|
|
s.Printf("\nFunction basenames:\n");
|
|
m_set.function_basenames.Dump(&s);
|
|
s.Printf("\nFunction fullnames:\n");
|
|
m_set.function_fullnames.Dump(&s);
|
|
s.Printf("\nFunction methods:\n");
|
|
m_set.function_methods.Dump(&s);
|
|
s.Printf("\nFunction selectors:\n");
|
|
m_set.function_selectors.Dump(&s);
|
|
s.Printf("\nObjective-C class selectors:\n");
|
|
m_set.objc_class_selectors.Dump(&s);
|
|
s.Printf("\nGlobals and statics:\n");
|
|
m_set.globals.Dump(&s);
|
|
s.Printf("\nTypes:\n");
|
|
m_set.types.Dump(&s);
|
|
s.Printf("\nNamespaces:\n");
|
|
m_set.namespaces.Dump(&s);
|
|
}
|