LLVM  15.0.0git
TpiStreamBuilder.h
Go to the documentation of this file.
1 //===- TpiStreamBuilder.h - PDB Tpi Stream Creation -------------*- 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_TPISTREAMBUILDER_H
10 #define LLVM_DEBUGINFO_PDB_NATIVE_TPISTREAMBUILDER_H
11 
12 #include "llvm/ADT/Optional.h"
16 #include "llvm/Support/Allocator.h"
18 #include "llvm/Support/Error.h"
19 
20 #include <vector>
21 
22 namespace llvm {
23 class BinaryByteStream;
24 template <typename T> struct BinaryItemTraits;
25 
26 template <> struct BinaryItemTraits<llvm::codeview::CVType> {
27  static size_t length(const codeview::CVType &Item) { return Item.length(); }
29  return Item.data();
30  }
31 };
32 
33 namespace msf {
34 class MSFBuilder;
35 struct MSFLayout;
36 }
37 namespace pdb {
38 struct TpiStreamHeader;
39 
41 public:
42  explicit TpiStreamBuilder(msf::MSFBuilder &Msf, uint32_t StreamIdx);
44 
45  TpiStreamBuilder(const TpiStreamBuilder &) = delete;
46  TpiStreamBuilder &operator=(const TpiStreamBuilder &) = delete;
47 
51  ArrayRef<uint32_t> Hashes);
52 
54 
55  uint32_t getRecordCount() const { return TypeRecordCount; }
56 
57  Error commit(const msf::MSFLayout &Layout, WritableBinaryStreamRef Buffer);
58 
60 
61 private:
62  void updateTypeIndexOffsets(ArrayRef<uint16_t> Sizes);
63 
64  uint32_t calculateHashBufferSize() const;
65  uint32_t calculateIndexOffsetSize() const;
66  Error finalize();
67 
68  msf::MSFBuilder &Msf;
69  BumpPtrAllocator &Allocator;
70 
71  uint32_t TypeRecordCount = 0;
72  size_t TypeRecordBytes = 0;
73 
75  std::vector<ArrayRef<uint8_t>> TypeRecBuffers;
76  std::vector<uint32_t> TypeHashes;
77  std::vector<codeview::TypeIndexOffset> TypeIndexOffsets;
78  uint32_t HashStreamIndex = kInvalidStreamIndex;
79  std::unique_ptr<BinaryByteStream> HashValueStream;
80 
81  const TpiStreamHeader *Header;
82  uint32_t Idx;
83 };
84 } // namespace pdb
85 }
86 
87 #endif
RawConstants.h
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:17
Optional.h
llvm::pdb::TpiStreamBuilder::addTypeRecords
void addTypeRecords(ArrayRef< uint8_t > Types, ArrayRef< uint16_t > Sizes, ArrayRef< uint32_t > Hashes)
Definition: TpiStreamBuilder.cpp:72
Allocator.h
llvm::pdb::kInvalidStreamIndex
const uint16_t kInvalidStreamIndex
Definition: RawConstants.h:19
Error.h
llvm::Type
The instances of the Type class are immutable: once they are created, they are never changed.
Definition: Type.h:45
llvm::pdb::TpiStreamBuilder::~TpiStreamBuilder
~TpiStreamBuilder()
llvm::Optional< uint32_t >
llvm::BinaryItemTraits< llvm::codeview::CVType >::bytes
static ArrayRef< uint8_t > bytes(const codeview::CVType &Item)
Definition: TpiStreamBuilder.h:28
llvm::pdb::PdbTpiV80
@ PdbTpiV80
Definition: RawConstants.h:64
llvm::msf::MSFBuilder
Definition: MSFBuilder.h:27
llvm::msf::MSFLayout
Definition: MSFCommon.h:51
llvm::pdb::TpiStreamBuilder::finalizeMsfLayout
Error finalizeMsfLayout()
Definition: TpiStreamBuilder.cpp:142
llvm::pdb::PdbRaw_TpiVer
PdbRaw_TpiVer
Definition: RawConstants.h:59
llvm::pdb::TpiStreamBuilder::getRecordCount
uint32_t getRecordCount() const
Definition: TpiStreamBuilder.h:55
llvm::BumpPtrAllocatorImpl
Allocate memory in an ever growing pool, as if by bump-pointer.
Definition: Allocator.h:63
llvm::pdb::TpiStreamBuilder::calculateSerializedLength
uint32_t calculateSerializedLength()
Definition: TpiStreamBuilder.cpp:128
llvm::pdb::TpiStreamBuilder
Definition: TpiStreamBuilder.h:40
llvm::BinaryItemTraits< llvm::codeview::CVType >::length
static size_t length(const codeview::CVType &Item)
Definition: TpiStreamBuilder.h:27
llvm::ArrayRef< uint8_t >
BinaryStreamRef.h
llvm::codeview::CVRecord< TypeLeafKind >
uint32_t
llvm::pdb::TpiStreamBuilder::setVersionHeader
void setVersionHeader(PdbRaw_TpiVer Version)
Definition: TpiStreamBuilder.cpp:37
llvm::Error
Lightweight error class with error context and mandatory checking.
Definition: Error.h:155
llvm::codeview::CVRecord::data
ArrayRef< uint8_t > data() const
Definition: CVRecord.h:49
CVRecord.h
llvm::pdb::TpiStreamBuilder::addTypeRecord
void addTypeRecord(ArrayRef< uint8_t > Type, Optional< uint32_t > Hash)
Definition: TpiStreamBuilder.cpp:57
TypeIndex.h
llvm::pdb::TpiStreamBuilder::commit
Error commit(const msf::MSFLayout &Layout, WritableBinaryStreamRef Buffer)
Definition: TpiStreamBuilder.cpp:172
Version
uint64_t Version
Definition: RawMemProfReader.cpp:40
llvm::pdb::TpiStreamHeader
Definition: RawTypes.h:277
llvm::pdb::TpiStreamBuilder::operator=
TpiStreamBuilder & operator=(const TpiStreamBuilder &)=delete
llvm::BinaryItemTraits
Definition: GSIStreamBuilder.h:26
llvm::WritableBinaryStreamRef
Definition: BinaryStreamRef.h:220
llvm::pdb::TpiStreamBuilder::TpiStreamBuilder
TpiStreamBuilder(msf::MSFBuilder &Msf, uint32_t StreamIdx)
Definition: TpiStreamBuilder.cpp:31
llvm::codeview::CVRecord::length
uint32_t length() const
Definition: CVRecord.h:40