contrib/llvm/lib/DebugInfo/PDB/Native/TpiStream.cpp

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