1 //===- PDBFile.cpp - 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 #include "llvm/DebugInfo/PDB/Native/PDBFile.h"
11 #include "llvm/ADT/ArrayRef.h"
12 #include "llvm/ADT/STLExtras.h"
13 #include "llvm/DebugInfo/MSF/MSFCommon.h"
14 #include "llvm/DebugInfo/MSF/MappedBlockStream.h"
15 #include "llvm/DebugInfo/PDB/Native/DbiStream.h"
16 #include "llvm/DebugInfo/PDB/Native/GlobalsStream.h"
17 #include "llvm/DebugInfo/PDB/Native/InfoStream.h"
18 #include "llvm/DebugInfo/PDB/Native/PDBStringTable.h"
19 #include "llvm/DebugInfo/PDB/Native/PublicsStream.h"
20 #include "llvm/DebugInfo/PDB/Native/RawError.h"
21 #include "llvm/DebugInfo/PDB/Native/SymbolStream.h"
22 #include "llvm/DebugInfo/PDB/Native/TpiStream.h"
23 #include "llvm/Support/BinaryStream.h"
24 #include "llvm/Support/BinaryStreamArray.h"
25 #include "llvm/Support/BinaryStreamReader.h"
26 #include "llvm/Support/Endian.h"
27 #include "llvm/Support/Error.h"
28 #include "llvm/Support/Path.h"
34 using namespace llvm::codeview;
35 using namespace llvm::msf;
36 using namespace llvm::pdb;
39 typedef FixedStreamArray<support::ulittle32_t> ulittle_array;
40 } // end anonymous namespace
42 PDBFile::PDBFile(StringRef Path, std::unique_ptr<BinaryStream> PdbFileBuffer,
43 BumpPtrAllocator &Allocator)
44 : FilePath(Path), Allocator(Allocator), Buffer(std::move(PdbFileBuffer)) {}
46 PDBFile::~PDBFile() = default;
48 StringRef PDBFile::getFilePath() const { return FilePath; }
50 StringRef PDBFile::getFileDirectory() const {
51 return sys::path::parent_path(FilePath);
54 uint32_t PDBFile::getBlockSize() const { return ContainerLayout.SB->BlockSize; }
56 uint32_t PDBFile::getFreeBlockMapBlock() const {
57 return ContainerLayout.SB->FreeBlockMapBlock;
60 uint32_t PDBFile::getBlockCount() const {
61 return ContainerLayout.SB->NumBlocks;
64 uint32_t PDBFile::getNumDirectoryBytes() const {
65 return ContainerLayout.SB->NumDirectoryBytes;
68 uint32_t PDBFile::getBlockMapIndex() const {
69 return ContainerLayout.SB->BlockMapAddr;
72 uint32_t PDBFile::getUnknown1() const { return ContainerLayout.SB->Unknown1; }
74 uint32_t PDBFile::getNumDirectoryBlocks() const {
75 return msf::bytesToBlocks(ContainerLayout.SB->NumDirectoryBytes,
76 ContainerLayout.SB->BlockSize);
79 uint64_t PDBFile::getBlockMapOffset() const {
80 return (uint64_t)ContainerLayout.SB->BlockMapAddr *
81 ContainerLayout.SB->BlockSize;
84 uint32_t PDBFile::getNumStreams() const {
85 return ContainerLayout.StreamSizes.size();
88 uint32_t PDBFile::getMaxStreamSize() const {
89 return *std::max_element(ContainerLayout.StreamSizes.begin(),
90 ContainerLayout.StreamSizes.end());
93 uint32_t PDBFile::getStreamByteSize(uint32_t StreamIndex) const {
94 return ContainerLayout.StreamSizes[StreamIndex];
97 ArrayRef<support::ulittle32_t>
98 PDBFile::getStreamBlockList(uint32_t StreamIndex) const {
99 return ContainerLayout.StreamMap[StreamIndex];
102 uint32_t PDBFile::getFileSize() const { return Buffer->getLength(); }
104 Expected<ArrayRef<uint8_t>> PDBFile::getBlockData(uint32_t BlockIndex,
105 uint32_t NumBytes) const {
106 uint64_t StreamBlockOffset = msf::blockToOffset(BlockIndex, getBlockSize());
108 ArrayRef<uint8_t> Result;
109 if (auto EC = Buffer->readBytes(StreamBlockOffset, NumBytes, Result))
110 return std::move(EC);
114 Error PDBFile::setBlockData(uint32_t BlockIndex, uint32_t Offset,
115 ArrayRef<uint8_t> Data) const {
116 return make_error<RawError>(raw_error_code::not_writable,
117 "PDBFile is immutable");
120 Error PDBFile::parseFileHeaders() {
121 BinaryStreamReader Reader(*Buffer);
124 const msf::SuperBlock *SB = nullptr;
125 if (auto EC = Reader.readObject(SB)) {
126 consumeError(std::move(EC));
127 return make_error<RawError>(raw_error_code::corrupt_file,
128 "Does not contain superblock");
131 if (auto EC = msf::validateSuperBlock(*SB))
134 if (Buffer->getLength() % SB->BlockSize != 0)
135 return make_error<RawError>(raw_error_code::corrupt_file,
136 "File size is not a multiple of block size");
137 ContainerLayout.SB = SB;
139 // Initialize Free Page Map.
140 ContainerLayout.FreePageMap.resize(SB->NumBlocks);
141 // The Fpm exists either at block 1 or block 2 of the MSF. However, this
142 // allows for a maximum of getBlockSize() * 8 blocks bits in the Fpm, and
143 // thusly an equal number of total blocks in the file. For a block size
144 // of 4KiB (very common), this would yield 32KiB total blocks in file, for a
145 // maximum file size of 32KiB * 4KiB = 128MiB. Obviously this won't do, so
146 // the Fpm is split across the file at `getBlockSize()` intervals. As a
147 // result, every block whose index is of the form |{1,2} + getBlockSize() * k|
148 // for any non-negative integer k is an Fpm block. In theory, we only really
149 // need to reserve blocks of the form |{1,2} + getBlockSize() * 8 * k|, but
150 // current versions of the MSF format already expect the Fpm to be arranged
151 // at getBlockSize() intervals, so we have to be compatible.
152 // See the function fpmPn() for more information:
153 // https://github.com/Microsoft/microsoft-pdb/blob/master/PDB/msf/msf.cpp#L489
155 MappedBlockStream::createFpmStream(ContainerLayout, *Buffer, Allocator);
156 BinaryStreamReader FpmReader(*FpmStream);
157 ArrayRef<uint8_t> FpmBytes;
158 if (auto EC = FpmReader.readBytes(FpmBytes, FpmReader.bytesRemaining()))
160 uint32_t BlocksRemaining = getBlockCount();
162 for (auto Byte : FpmBytes) {
163 uint32_t BlocksThisByte = std::min(BlocksRemaining, 8U);
164 for (uint32_t I = 0; I < BlocksThisByte; ++I) {
166 ContainerLayout.FreePageMap[BI] = true;
172 Reader.setOffset(getBlockMapOffset());
173 if (auto EC = Reader.readArray(ContainerLayout.DirectoryBlocks,
174 getNumDirectoryBlocks()))
177 return Error::success();
180 Error PDBFile::parseStreamData() {
181 assert(ContainerLayout.SB);
183 return Error::success();
185 uint32_t NumStreams = 0;
187 // Normally you can't use a MappedBlockStream without having fully parsed the
188 // PDB file, because it accesses the directory and various other things, which
189 // is exactly what we are attempting to parse. By specifying a custom
190 // subclass of IPDBStreamData which only accesses the fields that have already
191 // been parsed, we can avoid this and reuse MappedBlockStream.
192 auto DS = MappedBlockStream::createDirectoryStream(ContainerLayout, *Buffer,
194 BinaryStreamReader Reader(*DS);
195 if (auto EC = Reader.readInteger(NumStreams))
198 if (auto EC = Reader.readArray(ContainerLayout.StreamSizes, NumStreams))
200 for (uint32_t I = 0; I < NumStreams; ++I) {
201 uint32_t StreamSize = getStreamByteSize(I);
202 // FIXME: What does StreamSize ~0U mean?
203 uint64_t NumExpectedStreamBlocks =
204 StreamSize == UINT32_MAX
206 : msf::bytesToBlocks(StreamSize, ContainerLayout.SB->BlockSize);
208 // For convenience, we store the block array contiguously. This is because
209 // if someone calls setStreamMap(), it is more convenient to be able to call
210 // it with an ArrayRef instead of setting up a StreamRef. Since the
211 // DirectoryStream is cached in the class and thus lives for the life of the
212 // class, we can be guaranteed that readArray() will return a stable
213 // reference, even if it has to allocate from its internal pool.
214 ArrayRef<support::ulittle32_t> Blocks;
215 if (auto EC = Reader.readArray(Blocks, NumExpectedStreamBlocks))
217 for (uint32_t Block : Blocks) {
218 uint64_t BlockEndOffset =
219 (uint64_t)(Block + 1) * ContainerLayout.SB->BlockSize;
220 if (BlockEndOffset > getFileSize())
221 return make_error<RawError>(raw_error_code::corrupt_file,
222 "Stream block map is corrupt.");
224 ContainerLayout.StreamMap.push_back(Blocks);
227 // We should have read exactly SB->NumDirectoryBytes bytes.
228 assert(Reader.bytesRemaining() == 0);
229 DirectoryStream = std::move(DS);
230 return Error::success();
233 ArrayRef<support::ulittle32_t> PDBFile::getDirectoryBlockArray() const {
234 return ContainerLayout.DirectoryBlocks;
237 std::unique_ptr<MappedBlockStream> PDBFile::createIndexedStream(uint16_t SN) {
238 if (SN == kInvalidStreamIndex)
240 return MappedBlockStream::createIndexedStream(ContainerLayout, *Buffer, SN,
244 MSFStreamLayout PDBFile::getStreamLayout(uint32_t StreamIdx) const {
245 MSFStreamLayout Result;
246 auto Blocks = getStreamBlockList(StreamIdx);
247 Result.Blocks.assign(Blocks.begin(), Blocks.end());
248 Result.Length = getStreamByteSize(StreamIdx);
252 msf::MSFStreamLayout PDBFile::getFpmStreamLayout() const {
253 return msf::getFpmStreamLayout(ContainerLayout);
256 Expected<GlobalsStream &> PDBFile::getPDBGlobalsStream() {
258 auto DbiS = getPDBDbiStream();
260 return DbiS.takeError();
262 auto GlobalS = safelyCreateIndexedStream(
263 ContainerLayout, *Buffer, DbiS->getGlobalSymbolStreamIndex());
265 return GlobalS.takeError();
266 auto TempGlobals = llvm::make_unique<GlobalsStream>(std::move(*GlobalS));
267 if (auto EC = TempGlobals->reload())
268 return std::move(EC);
269 Globals = std::move(TempGlobals);
274 Expected<InfoStream &> PDBFile::getPDBInfoStream() {
276 auto InfoS = safelyCreateIndexedStream(ContainerLayout, *Buffer, StreamPDB);
278 return InfoS.takeError();
279 auto TempInfo = llvm::make_unique<InfoStream>(std::move(*InfoS));
280 if (auto EC = TempInfo->reload())
281 return std::move(EC);
282 Info = std::move(TempInfo);
287 Expected<DbiStream &> PDBFile::getPDBDbiStream() {
289 auto DbiS = safelyCreateIndexedStream(ContainerLayout, *Buffer, StreamDBI);
291 return DbiS.takeError();
292 auto TempDbi = llvm::make_unique<DbiStream>(*this, std::move(*DbiS));
293 if (auto EC = TempDbi->reload())
294 return std::move(EC);
295 Dbi = std::move(TempDbi);
300 Expected<TpiStream &> PDBFile::getPDBTpiStream() {
302 auto TpiS = safelyCreateIndexedStream(ContainerLayout, *Buffer, StreamTPI);
304 return TpiS.takeError();
305 auto TempTpi = llvm::make_unique<TpiStream>(*this, std::move(*TpiS));
306 if (auto EC = TempTpi->reload())
307 return std::move(EC);
308 Tpi = std::move(TempTpi);
313 Expected<TpiStream &> PDBFile::getPDBIpiStream() {
315 if (!hasPDBIpiStream())
316 return make_error<RawError>(raw_error_code::no_stream);
318 auto IpiS = safelyCreateIndexedStream(ContainerLayout, *Buffer, StreamIPI);
320 return IpiS.takeError();
321 auto TempIpi = llvm::make_unique<TpiStream>(*this, std::move(*IpiS));
322 if (auto EC = TempIpi->reload())
323 return std::move(EC);
324 Ipi = std::move(TempIpi);
329 Expected<PublicsStream &> PDBFile::getPDBPublicsStream() {
331 auto DbiS = getPDBDbiStream();
333 return DbiS.takeError();
335 auto PublicS = safelyCreateIndexedStream(
336 ContainerLayout, *Buffer, DbiS->getPublicSymbolStreamIndex());
338 return PublicS.takeError();
339 auto TempPublics = llvm::make_unique<PublicsStream>(std::move(*PublicS));
340 if (auto EC = TempPublics->reload())
341 return std::move(EC);
342 Publics = std::move(TempPublics);
347 Expected<SymbolStream &> PDBFile::getPDBSymbolStream() {
349 auto DbiS = getPDBDbiStream();
351 return DbiS.takeError();
353 uint32_t SymbolStreamNum = DbiS->getSymRecordStreamIndex();
355 safelyCreateIndexedStream(ContainerLayout, *Buffer, SymbolStreamNum);
357 return SymbolS.takeError();
359 auto TempSymbols = llvm::make_unique<SymbolStream>(std::move(*SymbolS));
360 if (auto EC = TempSymbols->reload())
361 return std::move(EC);
362 Symbols = std::move(TempSymbols);
367 Expected<PDBStringTable &> PDBFile::getStringTable() {
369 auto IS = getPDBInfoStream();
371 return IS.takeError();
373 uint32_t NameStreamIndex = IS->getNamedStreamIndex("/names");
376 safelyCreateIndexedStream(ContainerLayout, *Buffer, NameStreamIndex);
378 return NS.takeError();
380 auto N = llvm::make_unique<PDBStringTable>();
381 BinaryStreamReader Reader(**NS);
382 if (auto EC = N->reload(Reader))
383 return std::move(EC);
384 assert(Reader.bytesRemaining() == 0);
385 StringTableStream = std::move(*NS);
386 Strings = std::move(N);
391 uint32_t PDBFile::getPointerSize() {
392 auto DbiS = getPDBDbiStream();
395 PDB_Machine Machine = DbiS->getMachineType();
396 if (Machine == PDB_Machine::Amd64)
401 bool PDBFile::hasPDBDbiStream() const { return StreamDBI < getNumStreams(); }
403 bool PDBFile::hasPDBGlobalsStream() {
404 auto DbiS = getPDBDbiStream();
406 consumeError(DbiS.takeError());
410 return DbiS->getGlobalSymbolStreamIndex() < getNumStreams();
413 bool PDBFile::hasPDBInfoStream() const { return StreamPDB < getNumStreams(); }
415 bool PDBFile::hasPDBIpiStream() const {
416 if (!hasPDBInfoStream())
419 if (StreamIPI >= getNumStreams())
422 auto &InfoStream = cantFail(const_cast<PDBFile *>(this)->getPDBInfoStream());
423 return InfoStream.containsIdStream();
426 bool PDBFile::hasPDBPublicsStream() {
427 auto DbiS = getPDBDbiStream();
429 consumeError(DbiS.takeError());
432 return DbiS->getPublicSymbolStreamIndex() < getNumStreams();
435 bool PDBFile::hasPDBSymbolStream() {
436 auto DbiS = getPDBDbiStream();
439 return DbiS->getSymRecordStreamIndex() < getNumStreams();
442 bool PDBFile::hasPDBTpiStream() const { return StreamTPI < getNumStreams(); }
444 bool PDBFile::hasPDBStringTable() {
445 auto IS = getPDBInfoStream();
448 return IS->getNamedStreamIndex("/names") < getNumStreams();
451 /// Wrapper around MappedBlockStream::createIndexedStream() that checks if a
452 /// stream with that index actually exists. If it does not, the return value
453 /// will have an MSFError with code msf_error_code::no_stream. Else, the return
454 /// value will contain the stream returned by createIndexedStream().
455 Expected<std::unique_ptr<MappedBlockStream>>
456 PDBFile::safelyCreateIndexedStream(const MSFLayout &Layout,
457 BinaryStreamRef MsfData,
458 uint32_t StreamIndex) const {
459 if (StreamIndex >= getNumStreams())
460 return make_error<RawError>(raw_error_code::no_stream);
461 return MappedBlockStream::createIndexedStream(Layout, MsfData, StreamIndex,