1 //===- DbiModuleList.h - PDB module information list ------------*- 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 LLVM_DEBUGINFO_PDB_NATIVE_DBIMODULELIST_H 10 #define LLVM_DEBUGINFO_PDB_NATIVE_DBIMODULELIST_H 11 12 #include "llvm/ADT/StringRef.h" 13 #include "llvm/ADT/iterator.h" 14 #include "llvm/ADT/iterator_range.h" 15 #include "llvm/DebugInfo/PDB/Native/DbiModuleDescriptor.h" 16 #include "llvm/Support/BinaryStreamArray.h" 17 #include "llvm/Support/BinaryStreamRef.h" 18 #include "llvm/Support/Compiler.h" 19 #include "llvm/Support/Endian.h" 20 #include "llvm/Support/Error.h" 21 #include <cstddef> 22 #include <cstdint> 23 #include <iterator> 24 #include <vector> 25 26 namespace llvm { 27 namespace pdb { 28 29 class DbiModuleList; 30 struct FileInfoSubstreamHeader; 31 32 class DbiModuleSourceFilesIterator 33 : public iterator_facade_base<DbiModuleSourceFilesIterator, 34 std::random_access_iterator_tag, StringRef> { 35 using BaseType = typename DbiModuleSourceFilesIterator::iterator_facade_base; 36 37 public: 38 LLVM_ABI DbiModuleSourceFilesIterator(const DbiModuleList &Modules, 39 uint32_t Modi, uint16_t Filei); 40 DbiModuleSourceFilesIterator() = default; 41 DbiModuleSourceFilesIterator(const DbiModuleSourceFilesIterator &R) = default; 42 DbiModuleSourceFilesIterator & 43 operator=(const DbiModuleSourceFilesIterator &R) = default; 44 45 LLVM_ABI bool operator==(const DbiModuleSourceFilesIterator &R) const; 46 47 const StringRef &operator*() const { return ThisValue; } 48 StringRef &operator*() { return ThisValue; } 49 50 LLVM_ABI bool operator<(const DbiModuleSourceFilesIterator &RHS) const; 51 LLVM_ABI std::ptrdiff_t 52 operator-(const DbiModuleSourceFilesIterator &R) const; 53 LLVM_ABI DbiModuleSourceFilesIterator &operator+=(std::ptrdiff_t N); 54 LLVM_ABI DbiModuleSourceFilesIterator &operator-=(std::ptrdiff_t N); 55 56 private: 57 void setValue(); 58 59 bool isEnd() const; 60 bool isCompatible(const DbiModuleSourceFilesIterator &R) const; 61 bool isUniversalEnd() const; 62 63 StringRef ThisValue; 64 const DbiModuleList *Modules{nullptr}; 65 uint32_t Modi{0}; 66 uint16_t Filei{0}; 67 }; 68 69 class DbiModuleList { 70 friend DbiModuleSourceFilesIterator; 71 72 public: 73 LLVM_ABI Error initialize(BinaryStreamRef ModInfo, BinaryStreamRef FileInfo); 74 75 LLVM_ABI Expected<StringRef> getFileName(uint32_t Index) const; 76 LLVM_ABI uint32_t getModuleCount() const; 77 LLVM_ABI uint32_t getSourceFileCount() const; 78 LLVM_ABI uint16_t getSourceFileCount(uint32_t Modi) const; 79 80 LLVM_ABI iterator_range<DbiModuleSourceFilesIterator> 81 source_files(uint32_t Modi) const; 82 83 LLVM_ABI DbiModuleDescriptor getModuleDescriptor(uint32_t Modi) const; 84 85 private: 86 Error initializeModInfo(BinaryStreamRef ModInfo); 87 Error initializeFileInfo(BinaryStreamRef FileInfo); 88 89 VarStreamArray<DbiModuleDescriptor> Descriptors; 90 91 FixedStreamArray<support::little32_t> FileNameOffsets; 92 FixedStreamArray<support::ulittle16_t> ModFileCountArray; 93 94 // For each module, there are multiple filenames, which can be obtained by 95 // knowing the index of the file. Given the index of the file, one can use 96 // that as an offset into the FileNameOffsets array, which contains the 97 // absolute offset of the file name in NamesBuffer. Thus, for each module 98 // we store the first index in the FileNameOffsets array for this module. 99 // The number of files for the corresponding module is stored in 100 // ModFileCountArray. 101 std::vector<uint32_t> ModuleInitialFileIndex; 102 103 // In order to provide random access into the Descriptors array, we iterate it 104 // once up front to find the offsets of the individual items and store them in 105 // this array. 106 std::vector<uint32_t> ModuleDescriptorOffsets; 107 108 const FileInfoSubstreamHeader *FileInfoHeader = nullptr; 109 110 BinaryStreamRef ModInfoSubstream; 111 BinaryStreamRef FileInfoSubstream; 112 BinaryStreamRef NamesBuffer; 113 }; 114 115 } // end namespace pdb 116 } // end namespace llvm 117 118 #endif // LLVM_DEBUGINFO_PDB_NATIVE_DBIMODULELIST_H 119