1 //===- PDBFile.h - Low level interface to a PDB file ------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLVM_DEBUGINFO_PDB_RAW_PDBFILE_H
11 #define LLVM_DEBUGINFO_PDB_RAW_PDBFILE_H
13 #include "llvm/ADT/DenseMap.h"
14 #include "llvm/DebugInfo/MSF/IMSFFile.h"
15 #include "llvm/DebugInfo/MSF/MSFCommon.h"
16 #include "llvm/DebugInfo/MSF/MSFStreamLayout.h"
17 #include "llvm/Support/Allocator.h"
18 #include "llvm/Support/BinaryStreamRef.h"
19 #include "llvm/Support/Endian.h"
20 #include "llvm/Support/Error.h"
21 #include "llvm/Support/MathExtras.h"
30 class MappedBlockStream;
43 class PDBFile : public msf::IMSFFile {
44 friend PDBFileBuilder;
47 PDBFile(StringRef Path, std::unique_ptr<BinaryStream> PdbFileBuffer,
48 BumpPtrAllocator &Allocator);
51 StringRef getFileDirectory() const;
52 StringRef getFilePath() const;
54 uint32_t getFreeBlockMapBlock() const;
55 uint32_t getUnknown1() const;
57 uint32_t getBlockSize() const override;
58 uint32_t getBlockCount() const override;
59 uint32_t getNumDirectoryBytes() const;
60 uint32_t getBlockMapIndex() const;
61 uint32_t getNumDirectoryBlocks() const;
62 uint64_t getBlockMapOffset() const;
64 uint32_t getNumStreams() const override;
65 uint32_t getStreamByteSize(uint32_t StreamIndex) const override;
66 ArrayRef<support::ulittle32_t>
67 getStreamBlockList(uint32_t StreamIndex) const override;
68 uint32_t getFileSize() const;
70 Expected<ArrayRef<uint8_t>> getBlockData(uint32_t BlockIndex,
71 uint32_t NumBytes) const override;
72 Error setBlockData(uint32_t BlockIndex, uint32_t Offset,
73 ArrayRef<uint8_t> Data) const override;
75 ArrayRef<uint32_t> getFpmPages() const { return FpmPages; }
77 ArrayRef<support::ulittle32_t> getStreamSizes() const {
78 return ContainerLayout.StreamSizes;
80 ArrayRef<ArrayRef<support::ulittle32_t>> getStreamMap() const {
81 return ContainerLayout.StreamMap;
84 const msf::MSFLayout &getMsfLayout() const { return ContainerLayout; }
85 BinaryStreamRef getMsfBuffer() const { return *Buffer; }
87 ArrayRef<support::ulittle32_t> getDirectoryBlockArray() const;
89 msf::MSFStreamLayout getStreamLayout(uint32_t StreamIdx) const;
91 Error parseFileHeaders();
92 Error parseStreamData();
94 Expected<InfoStream &> getPDBInfoStream();
95 Expected<DbiStream &> getPDBDbiStream();
96 Expected<GlobalsStream &> getPDBGlobalsStream();
97 Expected<TpiStream &> getPDBTpiStream();
98 Expected<TpiStream &> getPDBIpiStream();
99 Expected<PublicsStream &> getPDBPublicsStream();
100 Expected<SymbolStream &> getPDBSymbolStream();
101 Expected<PDBStringTable &> getStringTable();
103 BumpPtrAllocator &getAllocator() { return Allocator; }
105 bool hasPDBDbiStream() const;
106 bool hasPDBGlobalsStream();
107 bool hasPDBInfoStream();
108 bool hasPDBIpiStream() const;
109 bool hasPDBPublicsStream();
110 bool hasPDBSymbolStream();
111 bool hasPDBTpiStream() const;
112 bool hasPDBStringTable();
114 uint32_t getPointerSize();
117 Expected<std::unique_ptr<msf::MappedBlockStream>>
118 safelyCreateIndexedStream(const msf::MSFLayout &Layout,
119 BinaryStreamRef MsfData,
120 uint32_t StreamIndex) const;
122 std::string FilePath;
123 BumpPtrAllocator &Allocator;
125 std::unique_ptr<BinaryStream> Buffer;
127 std::vector<uint32_t> FpmPages;
128 msf::MSFLayout ContainerLayout;
130 std::unique_ptr<GlobalsStream> Globals;
131 std::unique_ptr<InfoStream> Info;
132 std::unique_ptr<DbiStream> Dbi;
133 std::unique_ptr<TpiStream> Tpi;
134 std::unique_ptr<TpiStream> Ipi;
135 std::unique_ptr<PublicsStream> Publics;
136 std::unique_ptr<SymbolStream> Symbols;
137 std::unique_ptr<msf::MappedBlockStream> DirectoryStream;
138 std::unique_ptr<msf::MappedBlockStream> StringTableStream;
139 std::unique_ptr<PDBStringTable> Strings;