581 lines · c
1//===-- SymbolFileDWARF.h --------------------------------------*- C++ -*-===//2//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-exception6//7//===----------------------------------------------------------------------===//8 9#ifndef LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_SYMBOLFILEDWARF_H10#define LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_SYMBOLFILEDWARF_H11 12#include <list>13#include <map>14#include <mutex>15#include <optional>16#include <unordered_map>17#include <vector>18 19#include "llvm/ADT/DenseMap.h"20#include "llvm/ADT/SetVector.h"21#include "llvm/Support/Threading.h"22 23#include "lldb/Core/UniqueCStringMap.h"24#include "lldb/Core/dwarf.h"25#include "lldb/Expression/DWARFExpressionList.h"26#include "lldb/Symbol/DebugMacros.h"27#include "lldb/Symbol/SymbolContext.h"28#include "lldb/Symbol/SymbolFile.h"29#include "lldb/Target/Statistics.h"30#include "lldb/Utility/ConstString.h"31#include "lldb/Utility/Flags.h"32#include "lldb/Utility/RangeMap.h"33#include "lldb/Utility/StructuredData.h"34#include "lldb/lldb-private.h"35 36#include "DWARFContext.h"37#include "DWARFDataExtractor.h"38#include "DWARFDefines.h"39#include "DWARFIndex.h"40#include "UniqueDWARFASTType.h"41 42class DWARFASTParserClang;43 44namespace llvm {45class DWARFDebugAbbrev;46} // namespace llvm47 48namespace lldb_private::plugin {49namespace dwarf {50// Forward Declarations for this DWARF plugin51class DebugMapModule;52class DWARFCompileUnit;53class DWARFDebugAranges;54class DWARFDebugInfo;55class DWARFDebugInfoEntry;56class DWARFDebugLine;57class DWARFDeclContext;58class DWARFFormValue;59class DWARFTypeUnit;60class SymbolFileDWARFDebugMap;61class SymbolFileDWARFDwo;62class SymbolFileDWARFDwp;63 64#define DIE_IS_BEING_PARSED ((lldb_private::Type *)1)65 66class SymbolFileDWARF : public SymbolFileCommon {67 /// LLVM RTTI support.68 static char ID;69 70public:71 /// LLVM RTTI support.72 /// \{73 bool isA(const void *ClassID) const override {74 return ClassID == &ID || SymbolFileCommon::isA(ClassID);75 }76 static bool classof(const SymbolFile *obj) { return obj->isA(&ID); }77 /// \}78 79 friend class SymbolFileDWARFDebugMap;80 friend class SymbolFileDWARFDwo;81 friend class DebugMapModule;82 friend class DWARFCompileUnit;83 friend class DWARFDIE;84 friend class DWARFASTParser;85 86 // Static Functions87 static void Initialize();88 89 static void Terminate();90 91 static void DebuggerInitialize(Debugger &debugger);92 93 static llvm::StringRef GetPluginNameStatic() { return "dwarf"; }94 95 static llvm::StringRef GetPluginDescriptionStatic();96 97 static SymbolFile *CreateInstance(lldb::ObjectFileSP objfile_sp);98 99 // Constructors and Destructors100 101 SymbolFileDWARF(lldb::ObjectFileSP objfile_sp, SectionList *dwo_section_list);102 103 ~SymbolFileDWARF() override;104 105 uint32_t CalculateAbilities() override;106 107 void InitializeObject() override;108 109 // Compile Unit function calls110 111 lldb::LanguageType ParseLanguage(CompileUnit &comp_unit) override;112 113 XcodeSDK ParseXcodeSDK(CompileUnit &comp_unit) override;114 115 size_t ParseFunctions(CompileUnit &comp_unit) override;116 117 bool ParseLineTable(CompileUnit &comp_unit) override;118 119 bool ParseDebugMacros(CompileUnit &comp_unit) override;120 121 bool ForEachExternalModule(CompileUnit &, llvm::DenseSet<SymbolFile *> &,122 llvm::function_ref<bool(Module &)>) override;123 124 bool ParseSupportFiles(CompileUnit &comp_unit,125 SupportFileList &support_files) override;126 127 bool ParseIsOptimized(CompileUnit &comp_unit) override;128 129 size_t ParseTypes(CompileUnit &comp_unit) override;130 131 bool132 ParseImportedModules(const SymbolContext &sc,133 std::vector<SourceModule> &imported_modules) override;134 135 size_t ParseBlocksRecursive(Function &func) override;136 137 size_t ParseVariablesForContext(const SymbolContext &sc) override;138 139 std::optional<ArrayInfo>140 GetDynamicArrayInfoForUID(lldb::user_id_t type_uid,141 const ExecutionContext *exe_ctx) override;142 143 bool CompleteType(CompilerType &compiler_type) override;144 145 Type *ResolveType(const DWARFDIE &die, bool assert_not_being_parsed = true,146 bool resolve_function_context = false);147 148 CompilerDecl GetDeclForUID(lldb::user_id_t uid) override;149 150 CompilerDeclContext GetDeclContextForUID(lldb::user_id_t uid) override;151 152 CompilerDeclContext GetDeclContextContainingUID(lldb::user_id_t uid) override;153 154 std::vector<CompilerContext>155 GetCompilerContextForUID(lldb::user_id_t uid) override;156 157 void ParseDeclsForContext(CompilerDeclContext decl_ctx) override;158 159 uint32_t ResolveSymbolContext(const Address &so_addr,160 lldb::SymbolContextItem resolve_scope,161 SymbolContext &sc) override;162 163 Status CalculateFrameVariableError(StackFrame &frame) override;164 165 uint32_t ResolveSymbolContext(const SourceLocationSpec &src_location_spec,166 lldb::SymbolContextItem resolve_scope,167 SymbolContextList &sc_list) override;168 169 void FindGlobalVariables(ConstString name,170 const CompilerDeclContext &parent_decl_ctx,171 uint32_t max_matches,172 VariableList &variables) override;173 174 void FindGlobalVariables(const RegularExpression ®ex, uint32_t max_matches,175 VariableList &variables) override;176 177 void FindFunctions(const Module::LookupInfo &lookup_info,178 const CompilerDeclContext &parent_decl_ctx,179 bool include_inlines, SymbolContextList &sc_list) override;180 181 void FindFunctions(const RegularExpression ®ex, bool include_inlines,182 SymbolContextList &sc_list) override;183 184 void185 GetMangledNamesForFunction(const std::string &scope_qualified_name,186 std::vector<ConstString> &mangled_names) override;187 188 uint64_t GetDebugInfoSize(bool load_all_debug_info = false) override;189 190 void FindTypes(const lldb_private::TypeQuery &match,191 lldb_private::TypeResults &results) override;192 193 void GetTypes(SymbolContextScope *sc_scope, lldb::TypeClass type_mask,194 TypeList &type_list) override;195 196 llvm::Expected<lldb::TypeSystemSP>197 GetTypeSystemForLanguage(lldb::LanguageType language) override;198 199 CompilerDeclContext FindNamespace(ConstString name,200 const CompilerDeclContext &parent_decl_ctx,201 bool only_root_namespaces) override;202 203 void PreloadSymbols() override;204 205 std::recursive_mutex &GetModuleMutex() const override;206 207 // PluginInterface protocol208 llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }209 210 llvm::DWARFDebugAbbrev *DebugAbbrev();211 212 DWARFDebugInfo &DebugInfo();213 214 static bool SupportedVersion(uint16_t version);215 216 DWARFDIE217 GetDeclContextDIEContainingDIE(const DWARFDIE &die);218 219 bool HasForwardDeclForCompilerType(const CompilerType &compiler_type);220 221 CompileUnit *GetCompUnitForDWARFCompUnit(DWARFCompileUnit &dwarf_cu);222 223 virtual void224 GetObjCMethods(ConstString class_name,225 llvm::function_ref<IterationAction(DWARFDIE die)> callback);226 227 DebugMacrosSP ParseDebugMacros(lldb::offset_t *offset);228 229 static DWARFDIE GetParentSymbolContextDIE(const DWARFDIE &die);230 231 lldb::ModuleSP GetExternalModule(ConstString name);232 233 typedef std::map<ConstString, lldb::ModuleSP> ExternalTypeModuleMap;234 235 /// Return the list of Clang modules imported by this SymbolFile.236 const ExternalTypeModuleMap &getExternalTypeModules() const {237 return m_external_type_modules;238 }239 240 /// Given a DIERef, find the correct SymbolFileDWARF.241 ///242 /// A DIERef contains a file index that can uniquely identify a N_OSO file for243 /// DWARF in .o files on mac, or a .dwo or .dwp file index for split DWARF.244 /// Calling this function will find the correct symbol file to use so that245 /// further lookups can be done on the correct symbol file so that the DIE246 /// offset makes sense in the DIERef.247 virtual SymbolFileDWARF *GetDIERefSymbolFile(const DIERef &die_ref);248 249 virtual DWARFDIE GetDIE(const DIERef &die_ref);250 251 DWARFDIE GetDIE(lldb::user_id_t uid);252 253 std::shared_ptr<SymbolFileDWARFDwo>254 GetDwoSymbolFileForCompileUnit(DWARFUnit &dwarf_cu,255 const DWARFDebugInfoEntry &cu_die);256 257 /// If this is a DWARF object with a single CU, return its DW_AT_dwo_id.258 std::optional<uint64_t> GetDWOId();259 260 /// Given a DWO DWARFUnit, find the corresponding skeleton DWARFUnit261 /// in the main symbol file. DWP files can have their DWARFUnits262 /// parsed without the skeleton compile units having been parsed, so263 /// sometimes we need to find the skeleton compile unit for a DWO264 /// DWARFUnit so we can fill in this link. Currently unless the265 /// skeleton compile unit has been parsed _and_ the Unit DIE has been266 /// parsed, the DWO unit will not have a backward link setup correctly267 /// which was causing crashes due to an assertion that was firing268 /// in SymbolFileDWARF::GetCompUnitForDWARFCompUnit().269 DWARFUnit *GetSkeletonUnit(DWARFUnit *dwo_unit);270 271 static bool DIEInDeclContext(const CompilerDeclContext &parent_decl_ctx,272 const DWARFDIE &die,273 bool only_root_namespaces = false);274 275 std::vector<std::unique_ptr<CallEdge>>276 ParseCallEdgesInFunction(UserID func_id) override;277 278 void Dump(Stream &s) override;279 280 void DumpClangAST(Stream &s, llvm::StringRef filter,281 bool show_colors) override;282 283 /// List separate dwo files.284 bool GetSeparateDebugInfo(StructuredData::Dictionary &d, bool errors_only,285 bool load_all_debug_info = false) override;286 287 /// Gets statistics about dwo files associated with this symbol file.288 /// For split-dwarf files, this reports the counts for successfully loaded DWO289 /// CUs, total DWO CUs, and the number of DWO CUs with loading errors.290 /// For non-split-dwarf files, this reports 0 for all.291 DWOStats GetDwoStats() override;292 293 DWARFContext &GetDWARFContext() { return m_context; }294 295 const std::shared_ptr<SymbolFileDWARFDwo> &GetDwpSymbolFile();296 297 FileSpec GetFile(DWARFUnit &unit, size_t file_idx);298 299 static llvm::Expected<lldb::TypeSystemSP> GetTypeSystem(DWARFUnit &unit);300 301 static DWARFASTParser *GetDWARFParser(DWARFUnit &unit);302 303 // CompilerDecl related functions304 305 static CompilerDecl GetDecl(const DWARFDIE &die);306 307 static CompilerDeclContext GetDeclContext(const DWARFDIE &die);308 309 static CompilerDeclContext GetContainingDeclContext(const DWARFDIE &die);310 311 static lldb::LanguageType LanguageTypeFromDWARF(uint64_t val);312 313 static lldb::LanguageType GetLanguage(DWARFUnit &unit);314 /// Same as GetLanguage() but reports all C++ versions as C++ (no version).315 static lldb::LanguageType GetLanguageFamily(DWARFUnit &unit);316 317 StatsDuration::Duration GetDebugInfoParseTime() override {318 return m_parse_time;319 }320 StatsDuration::Duration GetDebugInfoIndexTime() override;321 322 StatsDuration &GetDebugInfoParseTimeRef() { return m_parse_time; }323 324 void ResetStatistics() override;325 326 virtual lldb::offset_t327 GetVendorDWARFOpcodeSize(const DataExtractor &data,328 const lldb::offset_t data_offset,329 const uint8_t op) const {330 return LLDB_INVALID_OFFSET;331 }332 333 virtual bool ParseVendorDWARFOpcode(uint8_t op, const DataExtractor &opcodes,334 lldb::offset_t &offset,335 RegisterContext *reg_ctx,336 lldb::RegisterKind reg_kind,337 std::vector<Value> &stack) const {338 return false;339 }340 341 ConstString ConstructFunctionDemangledName(const DWARFDIE &die);342 343 std::optional<uint64_t> GetFileIndex() const { return m_file_index; }344 void SetFileIndex(std::optional<uint64_t> file_index) {345 m_file_index = file_index;346 }347 348 virtual llvm::DenseMap<const DWARFDebugInfoEntry *, Type *> &GetDIEToType();349 350 virtual llvm::DenseMap<lldb::opaque_compiler_type_t, DIERef> &351 GetForwardDeclCompilerTypeToDIE();352 353 typedef llvm::DenseMap<const DWARFDebugInfoEntry *, lldb::VariableSP>354 DIEToVariableSP;355 356 virtual DIEToVariableSP &GetDIEToVariable() { return m_die_to_variable_sp; }357 358 virtual UniqueDWARFASTTypeMap &GetUniqueDWARFASTTypeMap();359 360 bool ClassOrStructIsVirtual(const DWARFDIE &die);361 362 SymbolFileDWARFDebugMap *GetDebugMapSymfile();363 364 virtual DWARFDIE FindDefinitionDIE(const DWARFDIE &die);365 366 virtual lldb::TypeSP FindCompleteObjCDefinitionTypeForDIE(367 const DWARFDIE &die, ConstString type_name, bool must_be_implementation);368 369 Type *ResolveTypeUID(lldb::user_id_t type_uid) override;370 371 Type *ResolveTypeUID(const DWARFDIE &die, bool assert_not_being_parsed);372 373 Type *ResolveTypeUID(const DIERef &die_ref);374 375 /// Returns the DWARFIndex for this symbol, if it exists.376 DWARFIndex *getIndex() { return m_index.get(); }377 378private:379 /// Find the definition DIE for the specified \c label in this380 /// SymbolFile.381 ///382 /// \returns A valid definition DIE on success.383 llvm::Expected<DWARFDIE>384 FindFunctionDefinition(const FunctionCallLabel &label,385 const DWARFDIE &declaration);386 387protected:388 SymbolFileDWARF(const SymbolFileDWARF &) = delete;389 const SymbolFileDWARF &operator=(const SymbolFileDWARF &) = delete;390 391 virtual void LoadSectionData(lldb::SectionType sect_type,392 DWARFDataExtractor &data);393 394 bool DeclContextMatchesThisSymbolFile(const CompilerDeclContext &decl_ctx);395 396 uint32_t CalculateNumCompileUnits() override;397 398 lldb::CompUnitSP ParseCompileUnitAtIndex(uint32_t index) override;399 400 TypeList &GetTypeList() override;401 402 lldb::CompUnitSP ParseCompileUnit(DWARFCompileUnit &dwarf_cu);403 404 virtual DWARFCompileUnit *GetDWARFCompileUnit(CompileUnit *comp_unit);405 406 DWARFUnit *GetNextUnparsedDWARFCompileUnit(DWARFUnit *prev_cu);407 408 bool GetFunction(const DWARFDIE &die, SymbolContext &sc);409 410 Function *ParseFunction(CompileUnit &comp_unit, const DWARFDIE &die);411 412 size_t ParseBlocksRecursive(CompileUnit &comp_unit, Block *parent_block,413 DWARFDIE die, lldb::addr_t function_file_addr);414 415 size_t ParseTypes(const SymbolContext &sc, const DWARFDIE &die,416 bool parse_siblings, bool parse_children);417 418 lldb::TypeSP ParseType(const SymbolContext &sc, const DWARFDIE &die,419 bool *type_is_new);420 421 bool ParseSupportFiles(DWARFUnit &dwarf_cu, const lldb::ModuleSP &module,422 SupportFileList &support_files);423 424 lldb::VariableSP ParseVariableDIE(const SymbolContext &sc,425 const DWARFDIE &die,426 const lldb::addr_t func_low_pc);427 lldb::VariableSP ParseVariableDIECached(const SymbolContext &sc,428 const DWARFDIE &die);429 430 void ParseAndAppendGlobalVariable(const SymbolContext &sc,431 const DWARFDIE &die,432 VariableList &cc_variable_list);433 434 size_t ParseVariablesInFunctionContext(const SymbolContext &sc,435 const DWARFDIE &die,436 const lldb::addr_t func_low_pc);437 438 size_t ParseVariablesInFunctionContextRecursive(const SymbolContext &sc,439 const DWARFDIE &die,440 lldb::addr_t func_low_pc,441 DIEArray &accumulator);442 443 size_t PopulateBlockVariableList(VariableList &variable_list,444 const SymbolContext &sc,445 llvm::ArrayRef<DIERef> variable_dies,446 lldb::addr_t func_low_pc);447 448 DIEArray MergeBlockAbstractParameters(const DWARFDIE &block_die,449 DIEArray &&variable_dies);450 451 llvm::Expected<SymbolContext>452 ResolveFunctionCallLabel(FunctionCallLabel &label) override;453 454 // Given a die_offset, figure out the symbol context representing that die.455 bool ResolveFunction(const DWARFDIE &die, bool include_inlines,456 SymbolContextList &sc_list);457 458 /// Resolve functions and (possibly) blocks for the given file address and a459 /// compile unit. The compile unit comes from the sc argument and it must be460 /// set. The results of the lookup (if any) are written back to the symbol461 /// context.462 void ResolveFunctionAndBlock(lldb::addr_t file_vm_addr, bool lookup_block,463 SymbolContext &sc);464 465 Symbol *GetObjCClassSymbol(ConstString objc_class_name);466 467 lldb::TypeSP GetTypeForDIE(const DWARFDIE &die,468 bool resolve_function_context = false);469 470 void SetDebugMapModule(const lldb::ModuleSP &module_sp) {471 m_debug_map_module_wp = module_sp;472 }473 474 DWARFDIE475 FindBlockContainingSpecification(const DIERef &func_die_ref,476 dw_offset_t spec_block_die_offset);477 478 DWARFDIE479 FindBlockContainingSpecification(const DWARFDIE &die,480 dw_offset_t spec_block_die_offset);481 482 bool ClassContainsSelector(const DWARFDIE &class_die, ConstString selector);483 484 /// Parse call site entries (DW_TAG_call_site), including any nested call site485 /// parameters (DW_TAG_call_site_parameter).486 std::vector<std::unique_ptr<CallEdge>>487 CollectCallEdges(lldb::ModuleSP module, DWARFDIE function_die);488 489 /// If this symbol file is linked to by a debug map (see490 /// SymbolFileDWARFDebugMap), and \p file_addr is a file address relative to491 /// an object file, adjust \p file_addr so that it is relative to the main492 /// binary. Returns the adjusted address, or \p file_addr if no adjustment is493 /// needed, on success and LLDB_INVALID_ADDRESS otherwise.494 lldb::addr_t FixupAddress(lldb::addr_t file_addr);495 496 bool FixupAddress(Address &addr);497 498 typedef llvm::SetVector<Type *> TypeSet;499 500 void GetTypes(const DWARFDIE &die, dw_offset_t min_die_offset,501 dw_offset_t max_die_offset, uint32_t type_mask,502 TypeSet &type_set);503 504 typedef RangeDataVector<lldb::addr_t, lldb::addr_t, Variable *>505 GlobalVariableMap;506 507 GlobalVariableMap &GetGlobalAranges();508 509 void UpdateExternalModuleListIfNeeded();510 511 void BuildCuTranslationTable();512 std::optional<uint32_t> GetDWARFUnitIndex(uint32_t cu_idx);513 514 void FindDwpSymbolFile();515 516 const SupportFileList *GetTypeUnitSupportFiles(DWARFTypeUnit &tu);517 518 void InitializeFirstCodeAddressRecursive(const SectionList §ion_list);519 520 void InitializeFirstCodeAddress();521 522 void523 GetCompileOptions(std::unordered_map<lldb::CompUnitSP, Args> &args) override;524 525 lldb::ModuleWP m_debug_map_module_wp;526 SymbolFileDWARFDebugMap *m_debug_map_symfile;527 528 llvm::once_flag m_dwp_symfile_once_flag;529 std::shared_ptr<SymbolFileDWARFDwo> m_dwp_symfile;530 531 DWARFContext m_context;532 533 llvm::once_flag m_info_once_flag;534 std::unique_ptr<DWARFDebugInfo> m_info;535 536 std::unique_ptr<llvm::DWARFDebugAbbrev> m_abbr;537 std::unique_ptr<GlobalVariableMap> m_global_aranges_up;538 539 typedef std::unordered_map<lldb::offset_t, DebugMacrosSP> DebugMacrosMap;540 DebugMacrosMap m_debug_macros_map;541 542 ExternalTypeModuleMap m_external_type_modules;543 std::unique_ptr<DWARFIndex> m_index;544 bool m_fetched_external_modules : 1;545 546 typedef std::set<DIERef> DIERefSet;547 typedef llvm::StringMap<DIERefSet> NameToOffsetMap;548 NameToOffsetMap m_function_scope_qualified_name_map;549 UniqueDWARFASTTypeMap m_unique_ast_type_map;550 // A map from DIE to lldb_private::Type. For record type, the key might be551 // either declaration DIE or definition DIE.552 llvm::DenseMap<const DWARFDebugInfoEntry *, Type *> m_die_to_type;553 DIEToVariableSP m_die_to_variable_sp;554 // A map from CompilerType to the struct/class/union/enum DIE (might be a555 // declaration or a definition) that is used to construct it.556 llvm::DenseMap<lldb::opaque_compiler_type_t, DIERef>557 m_forward_decl_compiler_type_to_die;558 llvm::DenseMap<dw_offset_t, std::unique_ptr<SupportFileList>>559 m_type_unit_support_files;560 std::vector<uint32_t> m_lldb_cu_to_dwarf_unit;561 /// DWARF does not provide a good way for traditional (concatenating) linkers562 /// to invalidate debug info describing dead-stripped code. These linkers will563 /// keep the debug info but resolve any addresses referring to such code as564 /// zero (BFD) or a small positive integer (zero + relocation addend -- GOLD).565 /// Try to filter out this debug info by comparing it to the lowest code566 /// address in the module.567 lldb::addr_t m_first_code_address = LLDB_INVALID_ADDRESS;568 StatsDuration m_parse_time;569 std::atomic_flag m_dwo_warning_issued = ATOMIC_FLAG_INIT;570 /// If this DWARF file a .DWO file or a DWARF .o file on mac when571 /// no dSYM file is being used, this file index will be set to a572 /// valid value that can be used in DIERef objects which will contain573 /// an index that identifies the .DWO or .o file.574 std::optional<uint64_t> m_file_index;575};576 577} // namespace dwarf578} // namespace lldb_private::plugin579 580#endif // LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_SYMBOLFILEDWARF_H581