LLVM  10.0.0svn
PDBFile.h
Go to the documentation of this file.
1 //===- PDBFile.h - Low level interface to a PDB file ------------*- 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_RAW_PDBFILE_H
10 #define LLVM_DEBUGINFO_PDB_RAW_PDBFILE_H
11 
12 #include "llvm/ADT/DenseMap.h"
15 #include "llvm/Support/Allocator.h"
17 #include "llvm/Support/Endian.h"
18 #include "llvm/Support/Error.h"
20 
21 #include <memory>
22 
23 namespace llvm {
24 
25 class BinaryStream;
26 
27 namespace msf {
28 class MappedBlockStream;
29 }
30 
31 namespace pdb {
32 class DbiStream;
33 class GlobalsStream;
34 class InfoStream;
35 class InjectedSourceStream;
36 class PDBStringTable;
37 class PDBFileBuilder;
38 class PublicsStream;
39 class SymbolStream;
40 class TpiStream;
41 
42 class PDBFile : public msf::IMSFFile {
43  friend PDBFileBuilder;
44 
45 public:
46  PDBFile(StringRef Path, std::unique_ptr<BinaryStream> PdbFileBuffer,
48  ~PDBFile() override;
49 
50  StringRef getFileDirectory() const;
51  StringRef getFilePath() const;
52 
53  uint32_t getFreeBlockMapBlock() const;
54  uint32_t getUnknown1() const;
55 
56  uint32_t getBlockSize() const override;
57  uint32_t getBlockCount() const override;
58  uint32_t getNumDirectoryBytes() const;
59  uint32_t getBlockMapIndex() const;
60  uint32_t getNumDirectoryBlocks() const;
61  uint64_t getBlockMapOffset() const;
62 
63  uint32_t getNumStreams() const override;
64  uint32_t getMaxStreamSize() const;
65  uint32_t getStreamByteSize(uint32_t StreamIndex) const override;
67  getStreamBlockList(uint32_t StreamIndex) const override;
68  uint32_t getFileSize() const;
69 
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;
74 
76  return ContainerLayout.StreamSizes;
77  }
79  return ContainerLayout.StreamMap;
80  }
81 
82  const msf::MSFLayout &getMsfLayout() const { return ContainerLayout; }
83  BinaryStreamRef getMsfBuffer() const { return *Buffer; }
84 
85  ArrayRef<support::ulittle32_t> getDirectoryBlockArray() const;
86 
87  std::unique_ptr<msf::MappedBlockStream>
88  createIndexedStream(uint16_t SN) const;
90  safelyCreateIndexedStream(uint32_t StreamIndex) const;
92  safelyCreateNamedStream(StringRef Name);
93 
94  msf::MSFStreamLayout getStreamLayout(uint32_t StreamIdx) const;
96 
97  Error parseFileHeaders();
98  Error parseStreamData();
99 
100  Expected<InfoStream &> getPDBInfoStream();
101  Expected<DbiStream &> getPDBDbiStream();
102  Expected<GlobalsStream &> getPDBGlobalsStream();
103  Expected<TpiStream &> getPDBTpiStream();
104  Expected<TpiStream &> getPDBIpiStream();
105  Expected<PublicsStream &> getPDBPublicsStream();
106  Expected<SymbolStream &> getPDBSymbolStream();
107  Expected<PDBStringTable &> getStringTable();
108  Expected<InjectedSourceStream &> getInjectedSourceStream();
109 
111 
112  bool hasPDBDbiStream() const;
113  bool hasPDBGlobalsStream();
114  bool hasPDBInfoStream() const;
115  bool hasPDBIpiStream() const;
116  bool hasPDBPublicsStream();
117  bool hasPDBSymbolStream();
118  bool hasPDBTpiStream() const;
119  bool hasPDBStringTable();
120  bool hasPDBInjectedSourceStream();
121 
123 
124 private:
125  std::string FilePath;
127 
128  std::unique_ptr<BinaryStream> Buffer;
129 
130  msf::MSFLayout ContainerLayout;
131 
132  std::unique_ptr<GlobalsStream> Globals;
133  std::unique_ptr<InfoStream> Info;
134  std::unique_ptr<DbiStream> Dbi;
135  std::unique_ptr<TpiStream> Tpi;
136  std::unique_ptr<TpiStream> Ipi;
137  std::unique_ptr<PublicsStream> Publics;
138  std::unique_ptr<SymbolStream> Symbols;
139  std::unique_ptr<msf::MappedBlockStream> DirectoryStream;
140  std::unique_ptr<msf::MappedBlockStream> StringTableStream;
141  std::unique_ptr<InjectedSourceStream> InjectedSources;
142  std::unique_ptr<PDBStringTable> Strings;
143 };
144 }
145 }
146 
147 #endif
This class represents lattice values for constants.
Definition: AllocatorList.h:23
amdgpu Simplify well known AMD library false FunctionCallee Value const Twine & Name
This file defines the MallocAllocator and BumpPtrAllocator interfaces.
Describes the layout of a stream in an MSF layout.
Definition: MSFCommon.h:77
MSFStreamLayout getFpmStreamLayout(const MSFLayout &Msf, bool IncludeUnusedFpmData=false, bool AltFpm=false)
Determine the layout of the FPM stream, given the MSF layout.
Definition: MSFCommon.cpp:62
Tagged union holding either a T or a Error.
Definition: yaml2obj.h:21
static uint64_t getPointerSize(const Value *V, const DataLayout &DL, const TargetLibraryInfo &TLI, const Function *F)
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory)...
Definition: APInt.h:32
BinaryStreamRef getMsfBuffer() const
Definition: PDBFile.h:83
Analysis containing CSE Info
Definition: CSEInfo.cpp:20
BumpPtrAllocator & getAllocator()
Definition: PDBFile.h:110
Allocate memory in an ever growing pool, as if by bump-pointer.
Definition: Allocator.h:140
ArrayRef< support::ulittle32_t > getStreamSizes() const
Definition: PDBFile.h:75
Basic Register Allocator
BinaryStreamRef is to BinaryStream what ArrayRef is to an Array.
ArrayRef< ArrayRef< support::ulittle32_t > > getStreamMap() const
Definition: PDBFile.h:78
const msf::MSFLayout & getMsfLayout() const
Definition: PDBFile.h:82
Lightweight error class with error context and mandatory checking.
Definition: Error.h:157
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48