1 //===-- SymbolFileDWARFDebugMap.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-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #ifndef LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_SYMBOLFILEDWARFDEBUGMAP_H 10 #define LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_SYMBOLFILEDWARFDEBUGMAP_H 11 12 #include "lldb/Symbol/SymbolFile.h" 13 #include "lldb/Utility/RangeMap.h" 14 #include "llvm/Support/Chrono.h" 15 #include <bitset> 16 #include <map> 17 #include <vector> 18 19 #include "UniqueDWARFASTType.h" 20 21 class SymbolFileDWARF; 22 class DWARFDebugAranges; 23 class DWARFDeclContext; 24 25 class SymbolFileDWARFDebugMap : public lldb_private::SymbolFile { 26 /// LLVM RTTI support. 27 static char ID; 28 29 public: 30 /// LLVM RTTI support. 31 /// \{ 32 bool isA(const void *ClassID) const override { 33 return ClassID == &ID || SymbolFile::isA(ClassID); 34 } 35 static bool classof(const SymbolFile *obj) { return obj->isA(&ID); } 36 /// \} 37 38 // Static Functions 39 static void Initialize(); 40 41 static void Terminate(); 42 43 static llvm::StringRef GetPluginNameStatic() { return "dwarf-debugmap"; } 44 45 static llvm::StringRef GetPluginDescriptionStatic(); 46 47 static lldb_private::SymbolFile * 48 CreateInstance(lldb::ObjectFileSP objfile_sp); 49 50 // Constructors and Destructors 51 SymbolFileDWARFDebugMap(lldb::ObjectFileSP objfile_sp); 52 ~SymbolFileDWARFDebugMap() override; 53 54 uint32_t CalculateAbilities() override; 55 void InitializeObject() override; 56 57 // Compile Unit function calls 58 lldb::LanguageType 59 ParseLanguage(lldb_private::CompileUnit &comp_unit) override; 60 lldb_private::XcodeSDK 61 ParseXcodeSDK(lldb_private::CompileUnit &comp_unit) override; 62 size_t ParseFunctions(lldb_private::CompileUnit &comp_unit) override; 63 bool ParseLineTable(lldb_private::CompileUnit &comp_unit) override; 64 bool ParseDebugMacros(lldb_private::CompileUnit &comp_unit) override; 65 66 bool ForEachExternalModule( 67 lldb_private::CompileUnit &, llvm::DenseSet<lldb_private::SymbolFile *> &, 68 llvm::function_ref<bool(lldb_private::Module &)>) override; 69 70 bool ParseSupportFiles(lldb_private::CompileUnit &comp_unit, 71 lldb_private::FileSpecList &support_files) override; 72 73 bool ParseIsOptimized(lldb_private::CompileUnit &comp_unit) override; 74 75 size_t ParseTypes(lldb_private::CompileUnit &comp_unit) override; 76 77 bool ParseImportedModules( 78 const lldb_private::SymbolContext &sc, 79 std::vector<lldb_private::SourceModule> &imported_modules) override; 80 size_t ParseBlocksRecursive(lldb_private::Function &func) override; 81 size_t 82 ParseVariablesForContext(const lldb_private::SymbolContext &sc) override; 83 84 lldb_private::Type *ResolveTypeUID(lldb::user_id_t type_uid) override; 85 llvm::Optional<ArrayInfo> GetDynamicArrayInfoForUID( 86 lldb::user_id_t type_uid, 87 const lldb_private::ExecutionContext *exe_ctx) override; 88 89 lldb_private::CompilerDeclContext 90 GetDeclContextForUID(lldb::user_id_t uid) override; 91 lldb_private::CompilerDeclContext 92 GetDeclContextContainingUID(lldb::user_id_t uid) override; 93 void 94 ParseDeclsForContext(lldb_private::CompilerDeclContext decl_ctx) override; 95 96 bool CompleteType(lldb_private::CompilerType &compiler_type) override; 97 uint32_t ResolveSymbolContext(const lldb_private::Address &so_addr, 98 lldb::SymbolContextItem resolve_scope, 99 lldb_private::SymbolContext &sc) override; 100 uint32_t ResolveSymbolContext( 101 const lldb_private::SourceLocationSpec &src_location_spec, 102 lldb::SymbolContextItem resolve_scope, 103 lldb_private::SymbolContextList &sc_list) override; 104 void 105 FindGlobalVariables(lldb_private::ConstString name, 106 const lldb_private::CompilerDeclContext &parent_decl_ctx, 107 uint32_t max_matches, 108 lldb_private::VariableList &variables) override; 109 void FindGlobalVariables(const lldb_private::RegularExpression ®ex, 110 uint32_t max_matches, 111 lldb_private::VariableList &variables) override; 112 void FindFunctions(lldb_private::ConstString name, 113 const lldb_private::CompilerDeclContext &parent_decl_ctx, 114 lldb::FunctionNameType name_type_mask, 115 bool include_inlines, 116 lldb_private::SymbolContextList &sc_list) override; 117 void FindFunctions(const lldb_private::RegularExpression ®ex, 118 bool include_inlines, 119 lldb_private::SymbolContextList &sc_list) override; 120 void 121 FindTypes(lldb_private::ConstString name, 122 const lldb_private::CompilerDeclContext &parent_decl_ctx, 123 uint32_t max_matches, 124 llvm::DenseSet<lldb_private::SymbolFile *> &searched_symbol_files, 125 lldb_private::TypeMap &types) override; 126 void 127 FindTypes(llvm::ArrayRef<lldb_private::CompilerContext> context, 128 lldb_private::LanguageSet languages, 129 llvm::DenseSet<lldb_private::SymbolFile *> &searched_symbol_files, 130 lldb_private::TypeMap &types) override; 131 lldb_private::CompilerDeclContext FindNamespace( 132 lldb_private::ConstString name, 133 const lldb_private::CompilerDeclContext &parent_decl_ctx) override; 134 void GetTypes(lldb_private::SymbolContextScope *sc_scope, 135 lldb::TypeClass type_mask, 136 lldb_private::TypeList &type_list) override; 137 std::vector<std::unique_ptr<lldb_private::CallEdge>> 138 ParseCallEdgesInFunction(lldb_private::UserID func_id) override; 139 140 void DumpClangAST(lldb_private::Stream &s) override; 141 142 // PluginInterface protocol 143 llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); } 144 145 uint64_t GetDebugInfoSize() override; 146 lldb_private::StatsDuration::Duration GetDebugInfoParseTime() override; 147 lldb_private::StatsDuration::Duration GetDebugInfoIndexTime() override; 148 149 protected: 150 enum { kHaveInitializedOSOs = (1 << 0), kNumFlags }; 151 152 friend class DebugMapModule; 153 friend class DWARFASTParserClang; 154 friend class DWARFCompileUnit; 155 friend class SymbolFileDWARF; 156 struct OSOInfo { 157 lldb::ModuleSP module_sp; 158 159 OSOInfo() : module_sp() {} 160 }; 161 162 typedef std::shared_ptr<OSOInfo> OSOInfoSP; 163 164 typedef lldb_private::RangeDataVector<lldb::addr_t, lldb::addr_t, 165 lldb::addr_t> 166 FileRangeMap; 167 168 // Class specific types 169 struct CompileUnitInfo { 170 lldb_private::FileSpec so_file; 171 lldb_private::ConstString oso_path; 172 llvm::sys::TimePoint<> oso_mod_time; 173 OSOInfoSP oso_sp; 174 lldb::CompUnitSP compile_unit_sp; 175 uint32_t first_symbol_index = UINT32_MAX; 176 uint32_t last_symbol_index = UINT32_MAX; 177 uint32_t first_symbol_id = UINT32_MAX; 178 uint32_t last_symbol_id = UINT32_MAX; 179 FileRangeMap file_range_map; 180 bool file_range_map_valid = false; 181 182 CompileUnitInfo() 183 : so_file(), oso_path(), oso_mod_time(), oso_sp(), compile_unit_sp(), 184 185 file_range_map() {} 186 187 const FileRangeMap &GetFileRangeMap(SymbolFileDWARFDebugMap *exe_symfile); 188 }; 189 190 // Protected Member Functions 191 void InitOSO(); 192 193 uint32_t CalculateNumCompileUnits() override; 194 lldb::CompUnitSP ParseCompileUnitAtIndex(uint32_t index) override; 195 196 static uint32_t GetOSOIndexFromUserID(lldb::user_id_t uid) { 197 return (uint32_t)((uid >> 32ull) - 1ull); 198 } 199 200 static SymbolFileDWARF *GetSymbolFileAsSymbolFileDWARF(SymbolFile *sym_file); 201 202 bool GetFileSpecForSO(uint32_t oso_idx, lldb_private::FileSpec &file_spec); 203 204 CompileUnitInfo *GetCompUnitInfo(const lldb_private::SymbolContext &sc); 205 CompileUnitInfo *GetCompUnitInfo(const lldb_private::CompileUnit &comp_unit); 206 207 size_t GetCompUnitInfosForModule(const lldb_private::Module *oso_module, 208 std::vector<CompileUnitInfo *> &cu_infos); 209 210 lldb_private::Module * 211 GetModuleByCompUnitInfo(CompileUnitInfo *comp_unit_info); 212 213 lldb_private::Module *GetModuleByOSOIndex(uint32_t oso_idx); 214 215 lldb_private::ObjectFile * 216 GetObjectFileByCompUnitInfo(CompileUnitInfo *comp_unit_info); 217 218 lldb_private::ObjectFile *GetObjectFileByOSOIndex(uint32_t oso_idx); 219 220 uint32_t GetCompUnitInfoIndex(const CompileUnitInfo *comp_unit_info); 221 222 SymbolFileDWARF *GetSymbolFile(const lldb_private::SymbolContext &sc); 223 SymbolFileDWARF *GetSymbolFile(const lldb_private::CompileUnit &comp_unit); 224 225 SymbolFileDWARF *GetSymbolFileByCompUnitInfo(CompileUnitInfo *comp_unit_info); 226 227 SymbolFileDWARF *GetSymbolFileByOSOIndex(uint32_t oso_idx); 228 229 // If closure returns "false", iteration continues. If it returns 230 // "true", iteration terminates. 231 void ForEachSymbolFile(std::function<bool(SymbolFileDWARF *)> closure) { 232 for (uint32_t oso_idx = 0, num_oso_idxs = m_compile_unit_infos.size(); 233 oso_idx < num_oso_idxs; ++oso_idx) { 234 if (SymbolFileDWARF *oso_dwarf = GetSymbolFileByOSOIndex(oso_idx)) { 235 if (closure(oso_dwarf)) 236 return; 237 } 238 } 239 } 240 241 CompileUnitInfo *GetCompileUnitInfoForSymbolWithIndex(uint32_t symbol_idx, 242 uint32_t *oso_idx_ptr); 243 244 CompileUnitInfo *GetCompileUnitInfoForSymbolWithID(lldb::user_id_t symbol_id, 245 uint32_t *oso_idx_ptr); 246 247 static int 248 SymbolContainsSymbolWithIndex(uint32_t *symbol_idx_ptr, 249 const CompileUnitInfo *comp_unit_info); 250 251 static int SymbolContainsSymbolWithID(lldb::user_id_t *symbol_idx_ptr, 252 const CompileUnitInfo *comp_unit_info); 253 254 void PrivateFindGlobalVariables( 255 lldb_private::ConstString name, 256 const lldb_private::CompilerDeclContext &parent_decl_ctx, 257 const std::vector<uint32_t> &name_symbol_indexes, uint32_t max_matches, 258 lldb_private::VariableList &variables); 259 260 void SetCompileUnit(SymbolFileDWARF *oso_dwarf, 261 const lldb::CompUnitSP &cu_sp); 262 263 lldb::CompUnitSP GetCompileUnit(SymbolFileDWARF *oso_dwarf); 264 265 CompileUnitInfo *GetCompileUnitInfo(SymbolFileDWARF *oso_dwarf); 266 267 lldb::TypeSP 268 FindDefinitionTypeForDWARFDeclContext(const DWARFDeclContext &die_decl_ctx); 269 270 bool Supports_DW_AT_APPLE_objc_complete_type(SymbolFileDWARF *skip_dwarf_oso); 271 272 lldb::TypeSP FindCompleteObjCDefinitionTypeForDIE( 273 const DWARFDIE &die, lldb_private::ConstString type_name, 274 bool must_be_implementation); 275 276 UniqueDWARFASTTypeMap &GetUniqueDWARFASTTypeMap() { 277 return m_unique_ast_type_map; 278 } 279 280 // OSOEntry 281 class OSOEntry { 282 public: 283 OSOEntry() = default; 284 285 OSOEntry(uint32_t exe_sym_idx, lldb::addr_t oso_file_addr) 286 : m_exe_sym_idx(exe_sym_idx), m_oso_file_addr(oso_file_addr) {} 287 288 uint32_t GetExeSymbolIndex() const { return m_exe_sym_idx; } 289 290 bool operator<(const OSOEntry &rhs) const { 291 return m_exe_sym_idx < rhs.m_exe_sym_idx; 292 } 293 294 lldb::addr_t GetOSOFileAddress() const { return m_oso_file_addr; } 295 296 void SetOSOFileAddress(lldb::addr_t oso_file_addr) { 297 m_oso_file_addr = oso_file_addr; 298 } 299 300 protected: 301 uint32_t m_exe_sym_idx = UINT32_MAX; 302 lldb::addr_t m_oso_file_addr = LLDB_INVALID_ADDRESS; 303 }; 304 305 typedef lldb_private::RangeDataVector<lldb::addr_t, lldb::addr_t, OSOEntry> 306 DebugMap; 307 308 // Member Variables 309 std::bitset<kNumFlags> m_flags; 310 std::vector<CompileUnitInfo> m_compile_unit_infos; 311 std::vector<uint32_t> m_func_indexes; // Sorted by address 312 std::vector<uint32_t> m_glob_indexes; 313 std::map<std::pair<lldb_private::ConstString, llvm::sys::TimePoint<>>, 314 OSOInfoSP> 315 m_oso_map; 316 UniqueDWARFASTTypeMap m_unique_ast_type_map; 317 lldb_private::LazyBool m_supports_DW_AT_APPLE_objc_complete_type; 318 DebugMap m_debug_map; 319 320 // When an object file from the debug map gets parsed in 321 // SymbolFileDWARF, it needs to tell the debug map about the object 322 // files addresses by calling this function once for each N_FUN, 323 // N_GSYM and N_STSYM and after all entries in the debug map have 324 // been matched up, FinalizeOSOFileRanges() should be called. 325 bool AddOSOFileRange(CompileUnitInfo *cu_info, lldb::addr_t exe_file_addr, 326 lldb::addr_t exe_byte_size, lldb::addr_t oso_file_addr, 327 lldb::addr_t oso_byte_size); 328 329 // Called after calling AddOSOFileRange() for each object file debug 330 // map entry to finalize the info for the unlinked compile unit. 331 void FinalizeOSOFileRanges(CompileUnitInfo *cu_info); 332 333 /// Convert \a addr from a .o file address, to an executable address. 334 /// 335 /// \param[in] addr 336 /// A section offset address from a .o file 337 /// 338 /// \return 339 /// Returns true if \a addr was converted to be an executable 340 /// section/offset address, false otherwise. 341 bool LinkOSOAddress(lldb_private::Address &addr); 342 343 /// Convert a .o file "file address" to an executable "file address". 344 /// 345 /// \param[in] oso_symfile 346 /// The DWARF symbol file that contains \a oso_file_addr 347 /// 348 /// \param[in] oso_file_addr 349 /// A .o file "file address" to convert. 350 /// 351 /// \return 352 /// LLDB_INVALID_ADDRESS if \a oso_file_addr is not in the 353 /// linked executable, otherwise a valid "file address" from the 354 /// linked executable that contains the debug map. 355 lldb::addr_t LinkOSOFileAddress(SymbolFileDWARF *oso_symfile, 356 lldb::addr_t oso_file_addr); 357 358 /// Given a line table full of lines with "file addresses" that are 359 /// for a .o file represented by \a oso_symfile, link a new line table 360 /// and return it. 361 /// 362 /// \param[in] oso_symfile 363 /// The DWARF symbol file that produced the \a line_table 364 /// 365 /// \param[in] line_table 366 /// A pointer to the line table. 367 /// 368 /// \return 369 /// Returns a valid line table full of linked addresses, or NULL 370 /// if none of the line table addresses exist in the main 371 /// executable. 372 lldb_private::LineTable * 373 LinkOSOLineTable(SymbolFileDWARF *oso_symfile, 374 lldb_private::LineTable *line_table); 375 376 size_t AddOSOARanges(SymbolFileDWARF *dwarf2Data, 377 DWARFDebugAranges *debug_aranges); 378 }; 379 380 #endif // LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_SYMBOLFILEDWARFDEBUGMAP_H 381