1 //===- TpiStream.cpp - PDB Type Info (TPI) Stream 2 Access ----------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "llvm/DebugInfo/PDB/Native/TpiStream.h"
11 #include "llvm/ADT/iterator_range.h"
12 #include "llvm/DebugInfo/CodeView/TypeRecord.h"
13 #include "llvm/DebugInfo/MSF/MappedBlockStream.h"
14 #include "llvm/DebugInfo/PDB/Native/PDBFile.h"
15 #include "llvm/DebugInfo/PDB/Native/PDBTypeServerHandler.h"
16 #include "llvm/DebugInfo/PDB/Native/RawConstants.h"
17 #include "llvm/DebugInfo/PDB/Native/RawError.h"
18 #include "llvm/DebugInfo/PDB/Native/RawTypes.h"
19 #include "llvm/DebugInfo/PDB/Native/TpiHashing.h"
20 #include "llvm/Support/BinaryStreamReader.h"
21 #include "llvm/Support/Endian.h"
22 #include "llvm/Support/Error.h"
23 #include <algorithm>
24 #include <cstdint>
25 #include <vector>
26 
27 using namespace llvm;
28 using namespace llvm::codeview;
29 using namespace llvm::support;
30 using namespace llvm::msf;
31 using namespace llvm::pdb;
32 
33 TpiStream::TpiStream(const PDBFile &File,
34                      std::unique_ptr<MappedBlockStream> Stream)
35     : Pdb(File), Stream(std::move(Stream)) {}
36 
37 TpiStream::~TpiStream() = default;
38 
39 Error TpiStream::reload() {
40   BinaryStreamReader Reader(*Stream);
41 
42   if (Reader.bytesRemaining() < sizeof(TpiStreamHeader))
43     return make_error<RawError>(raw_error_code::corrupt_file,
44                                 "TPI Stream does not contain a header.");
45 
46   if (Reader.readObject(Header))
47     return make_error<RawError>(raw_error_code::corrupt_file,
48                                 "TPI Stream does not contain a header.");
49 
50   if (Header->Version != PdbTpiV80)
51     return make_error<RawError>(raw_error_code::corrupt_file,
52                                 "Unsupported TPI Version.");
53 
54   if (Header->HeaderSize != sizeof(TpiStreamHeader))
55     return make_error<RawError>(raw_error_code::corrupt_file,
56                                 "Corrupt TPI Header size.");
57 
58   if (Header->HashKeySize != sizeof(ulittle32_t))
59     return make_error<RawError>(raw_error_code::corrupt_file,
60                                 "TPI Stream expected 4 byte hash key size.");
61 
62   if (Header->NumHashBuckets < MinTpiHashBuckets ||
63       Header->NumHashBuckets > MaxTpiHashBuckets)
64     return make_error<RawError>(raw_error_code::corrupt_file,
65                                 "TPI Stream Invalid number of hash buckets.");
66 
67   // The actual type records themselves come from this stream
68   if (auto EC = Reader.readArray(TypeRecords, Header->TypeRecordBytes))
69     return EC;
70 
71   // Hash indices, hash values, etc come from the hash stream.
72   if (Header->HashStreamIndex != kInvalidStreamIndex) {
73     if (Header->HashStreamIndex >= Pdb.getNumStreams())
74       return make_error<RawError>(raw_error_code::corrupt_file,
75                                   "Invalid TPI hash stream index.");
76 
77     auto HS = MappedBlockStream::createIndexedStream(
78         Pdb.getMsfLayout(), Pdb.getMsfBuffer(), Header->HashStreamIndex);
79     BinaryStreamReader HSR(*HS);
80 
81     // There should be a hash value for every type record, or no hashes at all.
82     uint32_t NumHashValues =
83         Header->HashValueBuffer.Length / sizeof(ulittle32_t);
84     if (NumHashValues != getNumTypeRecords() && NumHashValues != 0)
85       return make_error<RawError>(
86           raw_error_code::corrupt_file,
87           "TPI hash count does not match with the number of type records.");
88     HSR.setOffset(Header->HashValueBuffer.Off);
89     if (auto EC = HSR.readArray(HashValues, NumHashValues))
90       return EC;
91 
92     HSR.setOffset(Header->IndexOffsetBuffer.Off);
93     uint32_t NumTypeIndexOffsets =
94         Header->IndexOffsetBuffer.Length / sizeof(TypeIndexOffset);
95     if (auto EC = HSR.readArray(TypeIndexOffsets, NumTypeIndexOffsets))
96       return EC;
97 
98     if (Header->HashAdjBuffer.Length > 0) {
99       HSR.setOffset(Header->HashAdjBuffer.Off);
100       if (auto EC = HashAdjusters.load(HSR))
101         return EC;
102     }
103 
104     HashStream = std::move(HS);
105   }
106 
107   return Error::success();
108 }
109 
110 PdbRaw_TpiVer TpiStream::getTpiVersion() const {
111   uint32_t Value = Header->Version;
112   return static_cast<PdbRaw_TpiVer>(Value);
113 }
114 
115 uint32_t TpiStream::TypeIndexBegin() const { return Header->TypeIndexBegin; }
116 
117 uint32_t TpiStream::TypeIndexEnd() const { return Header->TypeIndexEnd; }
118 
119 uint32_t TpiStream::getNumTypeRecords() const {
120   return TypeIndexEnd() - TypeIndexBegin();
121 }
122 
123 uint16_t TpiStream::getTypeHashStreamIndex() const {
124   return Header->HashStreamIndex;
125 }
126 
127 uint16_t TpiStream::getTypeHashStreamAuxIndex() const {
128   return Header->HashAuxStreamIndex;
129 }
130 
131 uint32_t TpiStream::getNumHashBuckets() const { return Header->NumHashBuckets; }
132 uint32_t TpiStream::getHashKeySize() const { return Header->HashKeySize; }
133 
134 FixedStreamArray<support::ulittle32_t> TpiStream::getHashValues() const {
135   return HashValues;
136 }
137 
138 FixedStreamArray<TypeIndexOffset> TpiStream::getTypeIndexOffsets() const {
139   return TypeIndexOffsets;
140 }
141 
142 HashTable &TpiStream::getHashAdjusters() { return HashAdjusters; }
143 
144 CVTypeRange TpiStream::types(bool *HadError) const {
145   return make_range(TypeRecords.begin(HadError), TypeRecords.end());
146 }
147 
148 Error TpiStream::commit() { return Error::success(); }
149