diff options
Diffstat (limited to 'contrib/llvm-project/lldb/source/Symbol/SymbolFile.cpp')
-rw-r--r-- | contrib/llvm-project/lldb/source/Symbol/SymbolFile.cpp | 261 |
1 files changed, 261 insertions, 0 deletions
diff --git a/contrib/llvm-project/lldb/source/Symbol/SymbolFile.cpp b/contrib/llvm-project/lldb/source/Symbol/SymbolFile.cpp new file mode 100644 index 000000000000..16ed98d7840f --- /dev/null +++ b/contrib/llvm-project/lldb/source/Symbol/SymbolFile.cpp @@ -0,0 +1,261 @@ +//===-- SymbolFile.cpp ----------------------------------------------------===// +// +// 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 "lldb/Symbol/SymbolFile.h" + +#include "lldb/Core/Module.h" +#include "lldb/Core/PluginManager.h" +#include "lldb/Symbol/CompileUnit.h" +#include "lldb/Symbol/ObjectFile.h" +#include "lldb/Symbol/SymbolFileOnDemand.h" +#include "lldb/Symbol/TypeMap.h" +#include "lldb/Symbol/TypeSystem.h" +#include "lldb/Symbol/VariableList.h" +#include "lldb/Utility/Log.h" +#include "lldb/Utility/StreamString.h" +#include "lldb/Utility/StructuredData.h" +#include "lldb/lldb-private.h" + +#include <future> + +using namespace lldb_private; +using namespace lldb; + +char SymbolFile::ID; +char SymbolFileCommon::ID; + +void SymbolFile::PreloadSymbols() { + // No-op for most implementations. +} + +std::recursive_mutex &SymbolFile::GetModuleMutex() const { + return GetObjectFile()->GetModule()->GetMutex(); +} + +SymbolFile *SymbolFile::FindPlugin(ObjectFileSP objfile_sp) { + std::unique_ptr<SymbolFile> best_symfile_up; + if (objfile_sp != nullptr) { + + // We need to test the abilities of this section list. So create what it + // would be with this new objfile_sp. + lldb::ModuleSP module_sp(objfile_sp->GetModule()); + if (module_sp) { + // Default to the main module section list. + ObjectFile *module_obj_file = module_sp->GetObjectFile(); + if (module_obj_file != objfile_sp.get()) { + // Make sure the main object file's sections are created + module_obj_file->GetSectionList(); + objfile_sp->CreateSections(*module_sp->GetUnifiedSectionList()); + } + } + + // TODO: Load any plug-ins in the appropriate plug-in search paths and + // iterate over all of them to find the best one for the job. + + uint32_t best_symfile_abilities = 0; + + SymbolFileCreateInstance create_callback; + for (uint32_t idx = 0; + (create_callback = PluginManager::GetSymbolFileCreateCallbackAtIndex( + idx)) != nullptr; + ++idx) { + std::unique_ptr<SymbolFile> curr_symfile_up(create_callback(objfile_sp)); + + if (curr_symfile_up) { + const uint32_t sym_file_abilities = curr_symfile_up->GetAbilities(); + if (sym_file_abilities > best_symfile_abilities) { + best_symfile_abilities = sym_file_abilities; + best_symfile_up.reset(curr_symfile_up.release()); + // If any symbol file parser has all of the abilities, then we should + // just stop looking. + if ((kAllAbilities & sym_file_abilities) == kAllAbilities) + break; + } + } + } + if (best_symfile_up) { + // If symbol on-demand is enabled the winning symbol file parser is + // wrapped with SymbolFileOnDemand so that hydration of the debug info + // can be controlled to improve performance. + // + // Currently the supported on-demand symbol files include: + // executables, shared libraries and debug info files. + // + // To reduce unnecessary wrapping files with zero debug abilities are + // skipped. + ObjectFile::Type obj_file_type = objfile_sp->CalculateType(); + if (ModuleList::GetGlobalModuleListProperties().GetLoadSymbolOnDemand() && + best_symfile_abilities > 0 && + (obj_file_type == ObjectFile::eTypeExecutable || + obj_file_type == ObjectFile::eTypeSharedLibrary || + obj_file_type == ObjectFile::eTypeDebugInfo)) { + best_symfile_up = + std::make_unique<SymbolFileOnDemand>(std::move(best_symfile_up)); + } + // Let the winning symbol file parser initialize itself more completely + // now that it has been chosen + best_symfile_up->InitializeObject(); + } + } + return best_symfile_up.release(); +} + +uint32_t +SymbolFile::ResolveSymbolContext(const SourceLocationSpec &src_location_spec, + lldb::SymbolContextItem resolve_scope, + SymbolContextList &sc_list) { + return 0; +} + +void SymbolFile::FindGlobalVariables(ConstString name, + const CompilerDeclContext &parent_decl_ctx, + uint32_t max_matches, + VariableList &variables) {} + +void SymbolFile::FindGlobalVariables(const RegularExpression ®ex, + uint32_t max_matches, + VariableList &variables) {} + +void SymbolFile::FindFunctions(const Module::LookupInfo &lookup_info, + const CompilerDeclContext &parent_decl_ctx, + bool include_inlines, + SymbolContextList &sc_list) {} + +void SymbolFile::FindFunctions(const RegularExpression ®ex, + bool include_inlines, + SymbolContextList &sc_list) {} + +void SymbolFile::GetMangledNamesForFunction( + const std::string &scope_qualified_name, + std::vector<ConstString> &mangled_names) {} + +void SymbolFile::AssertModuleLock() { + // The code below is too expensive to leave enabled in release builds. It's + // enabled in debug builds or when the correct macro is set. +#if defined(LLDB_CONFIGURATION_DEBUG) + // We assert that we have to module lock by trying to acquire the lock from a + // different thread. Note that we must abort if the result is true to + // guarantee correctness. + assert(std::async( + std::launch::async, + [this] { + return this->GetModuleMutex().try_lock(); + }).get() == false && + "Module is not locked"); +#endif +} + +SymbolFile::RegisterInfoResolver::~RegisterInfoResolver() = default; + +Symtab *SymbolFileCommon::GetSymtab() { + std::lock_guard<std::recursive_mutex> guard(GetModuleMutex()); + // Fetch the symtab from the main object file. + auto *symtab = GetMainObjectFile()->GetSymtab(); + if (m_symtab != symtab) { + m_symtab = symtab; + + // Then add our symbols to it. + if (m_symtab) + AddSymbols(*m_symtab); + } + return m_symtab; +} + +ObjectFile *SymbolFileCommon::GetMainObjectFile() { + return m_objfile_sp->GetModule()->GetObjectFile(); +} + +void SymbolFileCommon::SectionFileAddressesChanged() { + ObjectFile *module_objfile = GetMainObjectFile(); + ObjectFile *symfile_objfile = GetObjectFile(); + if (symfile_objfile != module_objfile) + symfile_objfile->SectionFileAddressesChanged(); + if (auto *symtab = GetSymtab()) + symtab->SectionFileAddressesChanged(); +} + +uint32_t SymbolFileCommon::GetNumCompileUnits() { + std::lock_guard<std::recursive_mutex> guard(GetModuleMutex()); + if (!m_compile_units) { + // Create an array of compile unit shared pointers -- which will each + // remain NULL until someone asks for the actual compile unit information. + m_compile_units.emplace(CalculateNumCompileUnits()); + } + return m_compile_units->size(); +} + +CompUnitSP SymbolFileCommon::GetCompileUnitAtIndex(uint32_t idx) { + std::lock_guard<std::recursive_mutex> guard(GetModuleMutex()); + uint32_t num = GetNumCompileUnits(); + if (idx >= num) + return nullptr; + lldb::CompUnitSP &cu_sp = (*m_compile_units)[idx]; + if (!cu_sp) + cu_sp = ParseCompileUnitAtIndex(idx); + return cu_sp; +} + +void SymbolFileCommon::SetCompileUnitAtIndex(uint32_t idx, + const CompUnitSP &cu_sp) { + std::lock_guard<std::recursive_mutex> guard(GetModuleMutex()); + const size_t num_compile_units = GetNumCompileUnits(); + assert(idx < num_compile_units); + UNUSED_IF_ASSERT_DISABLED(num_compile_units); + + // Fire off an assertion if this compile unit already exists for now. The + // partial parsing should take care of only setting the compile unit + // once, so if this assertion fails, we need to make sure that we don't + // have a race condition, or have a second parse of the same compile + // unit. + assert((*m_compile_units)[idx] == nullptr); + (*m_compile_units)[idx] = cu_sp; +} + +llvm::Expected<TypeSystemSP> +SymbolFileCommon::GetTypeSystemForLanguage(lldb::LanguageType language) { + auto type_system_or_err = + m_objfile_sp->GetModule()->GetTypeSystemForLanguage(language); + if (type_system_or_err) { + if (auto ts = *type_system_or_err) + ts->SetSymbolFile(this); + } + return type_system_or_err; +} + +uint64_t SymbolFileCommon::GetDebugInfoSize(bool load_all_debug_info) { + if (!m_objfile_sp) + return 0; + ModuleSP module_sp(m_objfile_sp->GetModule()); + if (!module_sp) + return 0; + const SectionList *section_list = module_sp->GetSectionList(); + if (section_list) + return section_list->GetDebugInfoSize(); + return 0; +} + +void SymbolFileCommon::Dump(Stream &s) { + s.Format("SymbolFile {0} ({1})\n", GetPluginName(), + GetMainObjectFile()->GetFileSpec()); + s.PutCString("Types:\n"); + m_type_list.Dump(&s, /*show_context*/ false); + s.PutChar('\n'); + + s.PutCString("Compile units:\n"); + if (m_compile_units) { + for (const CompUnitSP &cu_sp : *m_compile_units) { + // We currently only dump the compile units that have been parsed + if (cu_sp) + cu_sp->Dump(&s, /*show_context*/ false); + } + } + s.PutChar('\n'); + + if (Symtab *symtab = GetSymtab()) + symtab->Dump(&s, nullptr, eSortOrderNone); +} |