Skip to content

Commit

Permalink
Revert D104488 and friends since it broke the windows bot
Browse files Browse the repository at this point in the history 
Reverts commits:
"Fix failing tests after https://reviews.llvm.org/D104488."
"Fix buildbot failure after https://reviews.llvm.org/D104488."
"Create synthetic symbol names on demand to improve memory consumption and startup times."

This series of commits broke the windows lldb bot and then failed to fix all of the failing tests.
  • Loading branch information
@sstamenova
sstamenova committed Jun 29, 2021
1 parent c1194c2 commit bb2cfca
Show file tree
Hide file tree
Showing 10 changed files with 67 additions and 143 deletions.
2 changes: 2 additions & 0 deletions lldb/include/lldb/Symbol/ObjectFile.h
View file
Expand Up @@ -712,6 +712,8 @@ class ObjectFile : public std::enable_shared_from_this<ObjectFile>,
/// false otherwise.
bool SetModulesArchitecture(const ArchSpec &new_arch);

ConstString GetNextSyntheticSymbolName();

static lldb::DataBufferSP MapFileData(const FileSpec &file, uint64_t Size,
uint64_t Offset);

Expand Down
24 changes: 6 additions & 18 deletions lldb/include/lldb/Symbol/Symbol.h
View file
Expand Up @@ -113,20 +113,14 @@ class Symbol : public SymbolContextScope {
lldb::LanguageType GetLanguage() const {
// TODO: See if there is a way to determine the language for a symbol
// somehow, for now just return our best guess
return GetMangled().GuessLanguage();
return m_mangled.GuessLanguage();
}

void SetID(uint32_t uid) { m_uid = uid; }

Mangled &GetMangled() {
SynthesizeNameIfNeeded();
return m_mangled;
}
Mangled &GetMangled() { return m_mangled; }

const Mangled &GetMangled() const {
SynthesizeNameIfNeeded();
return m_mangled;
}
const Mangled &GetMangled() const { return m_mangled; }

ConstString GetReExportedSymbolName() const;

Expand Down Expand Up @@ -172,9 +166,9 @@ class Symbol : public SymbolContextScope {
bool IsTrampoline() const;

bool IsIndirect() const;

bool IsWeak() const { return m_is_weak; }

void SetIsWeak (bool b) { m_is_weak = b; }

bool GetByteSizeIsValid() const { return m_size_is_valid; }
Expand Down Expand Up @@ -229,10 +223,6 @@ class Symbol : public SymbolContextScope {

bool ContainsFileAddress(lldb::addr_t file_addr) const;

static llvm::StringRef GetSyntheticSymbolPrefix() {
return "___lldb_unnamed_symbol";
}

protected:
// This is the internal guts of ResolveReExportedSymbol, it assumes
// reexport_name is not null, and that module_spec is valid. We track the
Expand All @@ -243,8 +233,6 @@ class Symbol : public SymbolContextScope {
lldb_private::ModuleSpec &module_spec,
lldb_private::ModuleList &seen_modules) const;

void SynthesizeNameIfNeeded() const;

uint32_t m_uid =
UINT32_MAX; // User ID (usually the original symbol table index)
uint16_t m_type_data = 0; // data specific to m_type
Expand All @@ -270,7 +258,7 @@ class Symbol : public SymbolContextScope {
// doing name lookups
m_is_weak : 1,
m_type : 6; // Values from the lldb::SymbolType enum.
mutable Mangled m_mangled; // uniqued symbol name/mangled name pair
Mangled m_mangled; // uniqued symbol name/mangled name pair
AddressRange m_addr_range; // Contains the value, or the section offset
// address when the value is an address in a
// section, and the size (if any)
Expand Down
20 changes: 0 additions & 20 deletions lldb/include/lldb/Symbol/Symtab.h
View file
Expand Up @@ -219,26 +219,6 @@ class Symtab {
return false;
}

/// A helper function that looks up full function names.
///
/// We generate unique names for synthetic symbols so that users can look
/// them up by name when needed. But because doing so is uncommon in normal
/// debugger use, we trade off some performance at lookup time for faster
/// symbol table building by detecting these symbols and generating their
/// names lazily, rather than adding them to the normal symbol indexes. This
/// function does the job of first consulting the name indexes, and if that
/// fails it extracts the information it needs from the synthetic name and
/// locates the symbol.
///
/// @param[in] symbol_name The symbol name to search for.
///
/// @param[out] indexes The vector if symbol indexes to update with results.
///
/// @returns The number of indexes added to the index vector. Zero if no
/// matches were found.
uint32_t GetNameIndexes(ConstString symbol_name,
std::vector<uint32_t> &indexes);

void SymbolIndicesToSymbolContextList(std::vector<uint32_t> &symbol_indexes,
SymbolContextList &sc_list);

Expand Down
64 changes: 29 additions & 35 deletions lldb/source/Plugins/ObjectFile/ELF/ObjectFileELF.cpp
View file
Expand Up @@ -1880,7 +1880,7 @@ void ObjectFileELF::CreateSections(SectionList &unified_section_list) {
unified_section_list.AddSection(symtab_section_sp);
}
}
}
}
}

std::shared_ptr<ObjectFileELF> ObjectFileELF::GetGnuDebugDataObjectFile() {
Expand Down Expand Up @@ -2813,24 +2813,20 @@ Symtab *ObjectFileELF::GetSymtab() {
if (is_valid_entry_point && !m_symtab_up->FindSymbolContainingFileAddress(
entry_point_file_addr)) {
uint64_t symbol_id = m_symtab_up->GetNumSymbols();
// Don't set the name for any synthetic symbols, the Symbol
// object will generate one if needed when the name is accessed
// via accessors.
SectionSP section_sp = entry_point_addr.GetSection();
Symbol symbol(
/*symID=*/symbol_id,
/*name=*/llvm::StringRef(), // Name will be auto generated.
/*type=*/eSymbolTypeCode,
/*external=*/true,
/*is_debug=*/false,
/*is_trampoline=*/false,
/*is_artificial=*/true,
/*section_sp=*/section_sp,
/*offset=*/entry_point_addr.GetOffset(),
/*size=*/0, // FDE can span multiple symbols so don't use its size.
/*size_is_valid=*/false,
/*contains_linker_annotations=*/false,
/*flags=*/0);
Symbol symbol(symbol_id,
GetNextSyntheticSymbolName().GetCString(), // Symbol name.
eSymbolTypeCode, // Type of this symbol.
true, // Is this globally visible?
false, // Is this symbol debug info?
false, // Is this symbol a trampoline?
true, // Is this symbol artificial?
entry_point_addr.GetSection(), // Section where this
// symbol is defined.
0, // Offset in section or symbol value.
0, // Size.
false, // Size is valid.
false, // Contains linker annotations?
0); // Symbol flags.
m_symtab_up->AddSymbol(symbol);
// When the entry point is arm thumb we need to explicitly set its
// class address to reflect that. This is important because expression
Expand Down Expand Up @@ -2921,24 +2917,22 @@ void ObjectFileELF::ParseUnwindSymbols(Symtab *symbol_table,
section_list->FindSectionContainingFileAddress(file_addr);
if (section_sp) {
addr_t offset = file_addr - section_sp->GetFileAddress();
const char *symbol_name = GetNextSyntheticSymbolName().GetCString();
uint64_t symbol_id = ++last_symbol_id;
// Don't set the name for any synthetic symbols, the Symbol
// object will generate one if needed when the name is accessed
// via accessors.
Symbol eh_symbol(
/*symID=*/symbol_id,
/*name=*/llvm::StringRef(), // Name will be auto generated.
/*type=*/eSymbolTypeCode,
/*external=*/true,
/*is_debug=*/false,
/*is_trampoline=*/false,
/*is_artificial=*/true,
/*section_sp=*/section_sp,
/*offset=*/offset,
/*size=*/0, // FDE can span multiple symbols so don't use its size.
/*size_is_valid=*/false,
/*contains_linker_annotations=*/false,
/*flags=*/0);
symbol_id, // Symbol table index.
symbol_name, // Symbol name.
eSymbolTypeCode, // Type of this symbol.
true, // Is this globally visible?
false, // Is this symbol debug info?
false, // Is this symbol a trampoline?
true, // Is this symbol artificial?
section_sp, // Section in which this symbol is defined or null.
offset, // Offset in section or symbol value.
0, // Size: Don't specify the size as an FDE can
false, // Size is valid: cover multiple symbols.
false, // Contains linker annotations?
0); // Symbol flags.
new_symbols.push_back(eh_symbol);
}
}
Expand Down
6 changes: 2 additions & 4 deletions lldb/source/Plugins/ObjectFile/Mach-O/ObjectFileMachO.cpp
View file
Expand Up @@ -4696,10 +4696,8 @@ size_t ObjectFileMachO::ParseSymtab() {
symbol_byte_size = section_end_file_addr - symbol_file_addr;
}
sym[sym_idx].SetID(synthetic_sym_id++);
// Don't set the name for any synthetic symbols, the Symbol
// object will generate one if needed when the name is accessed
// via accessors.
sym[sym_idx].GetMangled().SetDemangledName(ConstString());
sym[sym_idx].GetMangled().SetDemangledName(
GetNextSyntheticSymbolName());
sym[sym_idx].SetType(eSymbolTypeCode);
sym[sym_idx].SetIsSynthetic(true);
sym[sym_idx].GetAddressRef() = symbol_addr;
Expand Down
10 changes: 10 additions & 0 deletions lldb/source/Symbol/ObjectFile.cpp
View file
Expand Up @@ -616,6 +616,16 @@ ObjectFile::GetSymbolTypeFromName(llvm::StringRef name,
return symbol_type_hint;
}

ConstString ObjectFile::GetNextSyntheticSymbolName() {
llvm::SmallString<256> name;
llvm::raw_svector_ostream os(name);
ConstString file_name = GetModule()->GetFileSpec().GetFilename();
++m_synthetic_symbol_idx;
os << "___lldb_unnamed_symbol" << m_synthetic_symbol_idx << "$$"
<< file_name.GetStringRef();
return ConstString(os.str());
}

std::vector<ObjectFile::LoadableData>
ObjectFile::GetLoadableData(Target &target) {
std::vector<LoadableData> loadables;
Expand Down
40 changes: 10 additions & 30 deletions lldb/source/Symbol/Symbol.cpp
View file
Expand Up @@ -56,8 +56,8 @@ Symbol::Symbol(uint32_t symID, const Mangled &mangled, SymbolType type,
m_size_is_synthesized(false),
m_size_is_valid(size_is_valid || range.GetByteSize() > 0),
m_demangled_is_synthesized(false),
m_contains_linker_annotations(contains_linker_annotations),
m_is_weak(false), m_type(type), m_mangled(mangled), m_addr_range(range),
m_contains_linker_annotations(contains_linker_annotations),
m_is_weak(false), m_type(type), m_mangled(mangled), m_addr_range(range),
m_flags(flags) {}

Symbol::Symbol(const Symbol &rhs)
Expand Down Expand Up @@ -119,7 +119,7 @@ bool Symbol::ValueIsAddress() const {
}

ConstString Symbol::GetDisplayName() const {
return GetMangled().GetDisplayDemangledName();
return m_mangled.GetDisplayDemangledName();
}

ConstString Symbol::GetReExportedSymbolName() const {
Expand Down Expand Up @@ -202,7 +202,7 @@ void Symbol::GetDescription(Stream *s, lldb::DescriptionLevel level,
s->Printf(", value = 0x%16.16" PRIx64,
m_addr_range.GetBaseAddress().GetOffset());
}
ConstString demangled = GetMangled().GetDemangledName();
ConstString demangled = m_mangled.GetDemangledName();
if (demangled)
s->Printf(", name=\"%s\"", demangled.AsCString());
if (m_mangled.GetMangledName())
Expand All @@ -218,7 +218,7 @@ void Symbol::Dump(Stream *s, Target *target, uint32_t index,
// Make sure the size of the symbol is up to date before dumping
GetByteSize();

ConstString name = GetMangled().GetName(name_preference);
ConstString name = m_mangled.GetName(name_preference);
if (ValueIsAddress()) {
if (!m_addr_range.GetBaseAddress().Dump(s, nullptr,
Address::DumpStyleFileAddress))
Expand Down Expand Up @@ -330,11 +330,9 @@ uint32_t Symbol::GetPrologueByteSize() {
}

bool Symbol::Compare(ConstString name, SymbolType type) const {
if (type == eSymbolTypeAny || m_type == type) {
const Mangled &mangled = GetMangled();
return mangled.GetMangledName() == name ||
mangled.GetDemangledName() == name;
}
if (type == eSymbolTypeAny || m_type == type)
return m_mangled.GetMangledName() == name ||
m_mangled.GetDemangledName() == name;
return false;
}

Expand Down Expand Up @@ -497,10 +495,10 @@ lldb::addr_t Symbol::GetLoadAddress(Target *target) const {
return LLDB_INVALID_ADDRESS;
}

ConstString Symbol::GetName() const { return GetMangled().GetName(); }
ConstString Symbol::GetName() const { return m_mangled.GetName(); }

ConstString Symbol::GetNameNoArguments() const {
return GetMangled().GetName(Mangled::ePreferDemangledWithoutArguments);
return m_mangled.GetName(Mangled::ePreferDemangledWithoutArguments);
}

lldb::addr_t Symbol::ResolveCallableAddress(Target &target) const {
Expand Down Expand Up @@ -567,21 +565,3 @@ bool Symbol::GetDisassembly(const ExecutionContext &exe_ctx, const char *flavor,
bool Symbol::ContainsFileAddress(lldb::addr_t file_addr) const {
return m_addr_range.ContainsFileAddress(file_addr);
}

void Symbol::SynthesizeNameIfNeeded() const {
if (m_is_synthetic && !m_mangled) {
// Synthetic symbol names don't mean anything, but they do uniquely
// identify individual symbols so we give them a unique name. The name
// starts with the synthetic symbol prefix, followed by a unique number.
// Typically the UserID of a real symbol is the symbol table index of the
// symbol in the object file's symbol table(s), so it will be the same
// every time you read in the object file. We want the same persistence for
// synthetic symbols so that users can identify them across multiple debug
// sessions, to understand crashes in those symbols and to reliably set
// breakpoints on them.
llvm::SmallString<256> name;
llvm::raw_svector_ostream os(name);
os << GetSyntheticSymbolPrefix() << GetID();
m_mangled.SetDemangledName(ConstString(os.str()));
}
}
38 changes: 5 additions & 33 deletions lldb/source/Symbol/Symtab.cpp
View file
Expand Up @@ -301,7 +301,7 @@ void Symtab::InitNameIndexes() {
// the trampoline symbols to be searchable by name we can remove this and
// then possibly add a new bool to any of the Symtab functions that
// lookup symbols by name to indicate if they want trampolines.
if (symbol->IsTrampoline() || symbol->IsSynthetic())
if (symbol->IsTrampoline())
continue;

// If the symbol's name string matched a Mangled::ManglingScheme, it is
Expand Down Expand Up @@ -628,36 +628,6 @@ void Symtab::SortSymbolIndexesByValue(std::vector<uint32_t> &indexes,
}
}

uint32_t Symtab::GetNameIndexes(ConstString symbol_name,
std::vector<uint32_t> &indexes) {
auto &name_to_index = GetNameToSymbolIndexMap(lldb::eFunctionNameTypeNone);
const uint32_t count = name_to_index.GetValues(symbol_name, indexes);
if (count)
return count;
// Synthetic symbol names are not added to the name indexes, but they start
// with a prefix and end with a the symbol UserID. This allows users to find
// these symbols without having to add them to the name indexes. These
// queries will not happen very often since the names don't mean anything, so
// performance is not paramount in this case.
llvm::StringRef name = symbol_name.GetStringRef();
// String the synthetic prefix if the name starts with it.
if (!name.consume_front(Symbol::GetSyntheticSymbolPrefix()))
return 0; // Not a synthetic symbol name

// Extract the user ID from the symbol name
unsigned long long uid = 0;
if (getAsUnsignedInteger(name, /*Radix=*/10, uid))
return 0; // Failed to extract the user ID as an integer
Symbol *symbol = FindSymbolByID(uid);
if (symbol == nullptr)
return 0;
const uint32_t symbol_idx = GetIndexForSymbol(symbol);
if (symbol_idx == UINT32_MAX)
return 0;
indexes.push_back(symbol_idx);
return 1;
}

uint32_t Symtab::AppendSymbolIndexesWithName(ConstString symbol_name,
std::vector<uint32_t> &indexes) {
std::lock_guard<std::recursive_mutex> guard(m_mutex);
Expand All @@ -667,7 +637,8 @@ uint32_t Symtab::AppendSymbolIndexesWithName(ConstString symbol_name,
if (!m_name_indexes_computed)
InitNameIndexes();

return GetNameIndexes(symbol_name, indexes);
auto &name_to_index = GetNameToSymbolIndexMap(lldb::eFunctionNameTypeNone);
return name_to_index.GetValues(symbol_name, indexes);
}
return 0;
}
Expand All @@ -684,9 +655,10 @@ uint32_t Symtab::AppendSymbolIndexesWithName(ConstString symbol_name,
if (!m_name_indexes_computed)
InitNameIndexes();

auto &name_to_index = GetNameToSymbolIndexMap(lldb::eFunctionNameTypeNone);
std::vector<uint32_t> all_name_indexes;
const size_t name_match_count =
GetNameIndexes(symbol_name, all_name_indexes);
name_to_index.GetValues(symbol_name, all_name_indexes);
for (size_t i = 0; i < name_match_count; ++i) {
if (CheckSymbolAtIndex(all_name_indexes[i], symbol_debug_type,
symbol_visibility))
Expand Down
4 changes: 2 additions & 2 deletions lldb/test/Shell/ObjectFile/ELF/eh_frame-symbols.yaml
View file
Expand Up @@ -3,8 +3,8 @@

# CHECK: Index UserID DSX Type File Address/Value Load Address Size Flags Name
# CHECK: [ 0] 1 SourceFile 0x0000000000000000 0x0000000000000000 0x00000004 -
# CHECK: [ 1] 2 SX Code 0x0000000000201180 0x0000000000000010 0x00000000 ___lldb_unnamed_symbol{{[0-9]*}}
# CHECK: [ 2] 3 SX Code 0x0000000000201190 0x0000000000000006 0x00000000 ___lldb_unnamed_symbol{{[0-9]*}}
# CHECK: [ 1] 2 SX Code 0x0000000000201180 0x0000000000000010 0x00000000 ___lldb_unnamed_symbol1$${{.*}}
# CHECK: [ 2] 3 SX Code 0x0000000000201190 0x0000000000000006 0x00000000 ___lldb_unnamed_symbol2$${{.*}}

--- !ELF
FileHeader:
Expand Down
2 changes: 1 addition & 1 deletion lldb/test/Shell/SymbolFile/Breakpad/symtab.test
View file
Expand Up @@ -5,7 +5,7 @@
# CHECK-LABEL: (lldb) image dump symtab symtab.out
# CHECK: Symtab, file = {{.*}}symtab.out, num_symbols = 5:
# CHECK: Index UserID DSX Type File Address/Value Load Address Size Flags Name
# CHECK: [ 0] 0 SX Code 0x0000000000400000 0x00000000000000b0 0x00000000 ___lldb_unnamed_symbol{{[0-9]*}}
# CHECK: [ 0] 0 SX Code 0x0000000000400000 0x00000000000000b0 0x00000000 ___lldb_unnamed_symbol{{[0-9]*}}$$symtab.out
# CHECK: [ 1] 0 X Code 0x00000000004000b0 0x000000000000000c 0x00000000 f1_func
# CHECK: [ 2] 0 X Code 0x00000000004000a0 0x000000000000000d 0x00000000 func_only
# CHECK: [ 3] 0 X Code 0x00000000004000c0 0x0000000000000010 0x00000000 f2
Expand Down

0 comments on commit bb2cfca

Please sign in to comment.