1 //===-- CompileUnitIndex.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_NATIVEPDB_COMPILEUNITINDEX_H 10 #define LLDB_SOURCE_PLUGINS_SYMBOLFILE_NATIVEPDB_COMPILEUNITINDEX_H 11 12 #include "lldb/Utility/RangeMap.h" 13 #include "llvm/ADT/DenseMap.h" 14 #include "llvm/ADT/DenseSet.h" 15 #include "llvm/ADT/IntervalMap.h" 16 #include "llvm/DebugInfo/CodeView/DebugInlineeLinesSubsection.h" 17 #include "llvm/DebugInfo/CodeView/StringsAndChecksums.h" 18 #include "llvm/DebugInfo/CodeView/SymbolRecord.h" 19 #include "llvm/DebugInfo/CodeView/TypeIndex.h" 20 #include "llvm/DebugInfo/PDB/Native/DbiModuleDescriptor.h" 21 #include "llvm/DebugInfo/PDB/Native/ModuleDebugStream.h" 22 #include "llvm/DebugInfo/PDB/PDBTypes.h" 23 24 #include "PdbSymUid.h" 25 26 #include <map> 27 #include <memory> 28 #include <optional> 29 30 namespace lldb_private { 31 32 namespace npdb { 33 class PdbIndex; 34 35 /// Represents a single compile unit. This class is useful for collecting the 36 /// important accessors and information about a compile unit from disparate 37 /// parts of the PDB into a single place, simplifying acess to compile unit 38 /// information for the callers. 39 struct CompilandIndexItem { 40 CompilandIndexItem(PdbCompilandId m_id, 41 llvm::pdb::ModuleDebugStreamRef debug_stream, 42 llvm::pdb::DbiModuleDescriptor descriptor); 43 44 // index of this compile unit. 45 PdbCompilandId m_id; 46 47 // debug stream. 48 llvm::pdb::ModuleDebugStreamRef m_debug_stream; 49 50 // dbi module descriptor. 51 llvm::pdb::DbiModuleDescriptor m_module_descriptor; 52 53 llvm::codeview::StringsAndChecksumsRef m_strings; 54 55 // List of files which contribute to this compiland. 56 std::vector<llvm::StringRef> m_file_list; 57 58 // Maps virtual address to global symbol id, which can then be used to 59 // locate the exact compile unit and offset of the symbol. Note that this 60 // is intentionally an ordered map so that we can find all symbols up to a 61 // given starting address. 62 std::map<lldb::addr_t, PdbSymUid> m_symbols_by_va; 63 64 // S_COMPILE3 sym describing compilation settings for the module. 65 std::optional<llvm::codeview::Compile3Sym> m_compile_opts; 66 67 // S_OBJNAME sym describing object name. 68 std::optional<llvm::codeview::ObjNameSym> m_obj_name; 69 70 // LF_BUILDINFO sym describing source file name, working directory, 71 // command line, etc. This usually contains exactly 5 items which 72 // are references to other strings. 73 llvm::SmallVector<llvm::codeview::TypeIndex, 5> m_build_info; 74 75 // Inlinee lines table in this compile unit. 76 std::map<llvm::codeview::TypeIndex, llvm::codeview::InlineeSourceLine> 77 m_inline_map; 78 79 // It's the line table parsed from DEBUG_S_LINES sections, mapping the file 80 // address range to file index and source line number. 81 using GlobalLineTable = 82 lldb_private::RangeDataVector<lldb::addr_t, uint32_t, 83 std::pair<uint32_t, uint32_t>>; 84 GlobalLineTable m_global_line_table; 85 }; 86 87 /// Indexes information about all compile units. This is really just a map of 88 /// global compile unit index to |CompilandIndexItem| structures. 89 class CompileUnitIndex { 90 PdbIndex &m_index; 91 llvm::DenseMap<uint16_t, std::unique_ptr<CompilandIndexItem>> m_comp_units; 92 93 public: 94 explicit CompileUnitIndex(PdbIndex &index) : m_index(index) {} 95 96 CompilandIndexItem &GetOrCreateCompiland(uint16_t modi); 97 98 const CompilandIndexItem *GetCompiland(uint16_t modi) const; 99 100 CompilandIndexItem *GetCompiland(uint16_t modi); 101 102 llvm::SmallString<64> GetMainSourceFile(const CompilandIndexItem &item) const; 103 }; 104 } // namespace npdb 105 } // namespace lldb_private 106 107 #endif 108