LLVM  8.0.1
NativeSession.h
Go to the documentation of this file.
1 //===- NativeSession.h - Native implementation of IPDBSession ---*- C++ -*-===//
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 #ifndef LLVM_DEBUGINFO_PDB_NATIVE_NATIVESESSION_H
11 #define LLVM_DEBUGINFO_PDB_NATIVE_NATIVESESSION_H
12 
13 #include "llvm/ADT/DenseMap.h"
14 #include "llvm/ADT/StringRef.h"
20 #include "llvm/Support/Allocator.h"
21 #include "llvm/Support/Error.h"
22 
23 namespace llvm {
24 class MemoryBuffer;
25 namespace pdb {
26 class PDBFile;
27 class NativeExeSymbol;
28 
29 class NativeSession : public IPDBSession {
30 public:
31  NativeSession(std::unique_ptr<PDBFile> PdbFile,
32  std::unique_ptr<BumpPtrAllocator> Allocator);
33  ~NativeSession() override;
34 
35  static Error createFromPdb(std::unique_ptr<MemoryBuffer> MB,
36  std::unique_ptr<IPDBSession> &Session);
37  static Error createFromExe(StringRef Path,
38  std::unique_ptr<IPDBSession> &Session);
39 
40  uint64_t getLoadAddress() const override;
41  bool setLoadAddress(uint64_t Address) override;
42  std::unique_ptr<PDBSymbolExe> getGlobalScope() override;
43  std::unique_ptr<PDBSymbol> getSymbolById(SymIndexId SymbolId) const override;
44 
45  bool addressForVA(uint64_t VA, uint32_t &Section,
46  uint32_t &Offset) const override;
47  bool addressForRVA(uint32_t RVA, uint32_t &Section,
48  uint32_t &Offset) const override;
49 
50  std::unique_ptr<PDBSymbol>
51  findSymbolByAddress(uint64_t Address, PDB_SymType Type) const override;
52  std::unique_ptr<PDBSymbol> findSymbolByRVA(uint32_t RVA,
53  PDB_SymType Type) const override;
54  std::unique_ptr<PDBSymbol>
56  PDB_SymType Type) const override;
57 
58  std::unique_ptr<IPDBEnumLineNumbers>
60  const IPDBSourceFile &File) const override;
61  std::unique_ptr<IPDBEnumLineNumbers>
62  findLineNumbersByAddress(uint64_t Address, uint32_t Length) const override;
63  std::unique_ptr<IPDBEnumLineNumbers>
64  findLineNumbersByRVA(uint32_t RVA, uint32_t Length) const override;
65  std::unique_ptr<IPDBEnumLineNumbers>
67  uint32_t Length) const override;
68 
69  std::unique_ptr<IPDBEnumSourceFiles>
70  findSourceFiles(const PDBSymbolCompiland *Compiland, llvm::StringRef Pattern,
71  PDB_NameSearchFlags Flags) const override;
72  std::unique_ptr<IPDBSourceFile>
73  findOneSourceFile(const PDBSymbolCompiland *Compiland,
74  llvm::StringRef Pattern,
75  PDB_NameSearchFlags Flags) const override;
76  std::unique_ptr<IPDBEnumChildren<PDBSymbolCompiland>>
78  PDB_NameSearchFlags Flags) const override;
79  std::unique_ptr<PDBSymbolCompiland>
81  PDB_NameSearchFlags Flags) const override;
82  std::unique_ptr<IPDBEnumSourceFiles> getAllSourceFiles() const override;
83  std::unique_ptr<IPDBEnumSourceFiles> getSourceFilesForCompiland(
84  const PDBSymbolCompiland &Compiland) const override;
85  std::unique_ptr<IPDBSourceFile>
86  getSourceFileById(uint32_t FileId) const override;
87 
88  std::unique_ptr<IPDBEnumDataStreams> getDebugStreams() const override;
89 
90  std::unique_ptr<IPDBEnumTables> getEnumTables() const override;
91 
92  std::unique_ptr<IPDBEnumInjectedSources> getInjectedSources() const override;
93 
94  std::unique_ptr<IPDBEnumSectionContribs> getSectionContribs() const override;
95 
96  std::unique_ptr<IPDBEnumFrameData> getFrameData() const override;
97 
98  PDBFile &getPDBFile() { return *Pdb; }
99  const PDBFile &getPDBFile() const { return *Pdb; }
100 
102  SymbolCache &getSymbolCache() { return Cache; }
103  const SymbolCache &getSymbolCache() const { return Cache; }
104 
105 private:
106  void initializeExeSymbol();
107 
108  std::unique_ptr<PDBFile> Pdb;
109  std::unique_ptr<BumpPtrAllocator> Allocator;
110 
111  SymbolCache Cache;
112  SymIndexId ExeSymbol = 0;
113 };
114 } // namespace pdb
115 } // namespace llvm
116 
117 #endif
std::unique_ptr< IPDBEnumSourceFiles > getAllSourceFiles() const override
static Error createFromExe(StringRef Path, std::unique_ptr< IPDBSession > &Session)
std::unique_ptr< IPDBEnumLineNumbers > findLineNumbersBySectOffset(uint32_t Section, uint32_t Offset, uint32_t Length) const override
IPDBSession defines an interface used to provide a context for querying debug information from a debu...
Definition: IPDBSession.h:26
This class represents lattice values for constants.
Definition: AllocatorList.h:24
std::unique_ptr< IPDBEnumSectionContribs > getSectionContribs() const override
PDB_NameSearchFlags
Defines flags used for enumerating child symbols.
Definition: PDBTypes.h:101
This file defines the MallocAllocator and BumpPtrAllocator interfaces.
std::unique_ptr< PDBSymbol > findSymbolByAddress(uint64_t Address, PDB_SymType Type) const override
IPDBSourceFile defines an interface used to represent source files whose information are stored in th...
std::unique_ptr< IPDBEnumSourceFiles > findSourceFiles(const PDBSymbolCompiland *Compiland, llvm::StringRef Pattern, PDB_NameSearchFlags Flags) const override
NativeExeSymbol & getNativeGlobalScope() const
std::unique_ptr< IPDBEnumFrameData > getFrameData() const override
std::unique_ptr< IPDBEnumTables > getEnumTables() const override
std::unique_ptr< IPDBEnumLineNumbers > findLineNumbersByRVA(uint32_t RVA, uint32_t Length) const override
const SymbolCache & getSymbolCache() const
PDB_SymType
These values correspond to the SymTagEnum enumeration, and are documented here: https://msdn.microsoft.com/en-us/library/bkedss5f.aspx.
Definition: PDBTypes.h:183
std::unique_ptr< PDBSymbol > getSymbolById(SymIndexId SymbolId) const override
The instances of the Type class are immutable: once they are created, they are never changed...
Definition: Type.h:46
std::unique_ptr< PDBSymbol > findSymbolByRVA(uint32_t RVA, PDB_SymType Type) const override
uint64_t getLoadAddress() const override
std::unique_ptr< IPDBEnumLineNumbers > findLineNumbers(const PDBSymbolCompiland &Compiland, const IPDBSourceFile &File) const override
std::unique_ptr< PDBSymbol > findSymbolBySectOffset(uint32_t Sect, uint32_t Offset, PDB_SymType Type) const override
std::unique_ptr< IPDBEnumSourceFiles > getSourceFilesForCompiland(const PDBSymbolCompiland &Compiland) const override
std::unique_ptr< PDBSymbolExe > getGlobalScope() override
bool setLoadAddress(uint64_t Address) override
std::unique_ptr< IPDBEnumLineNumbers > findLineNumbersByAddress(uint64_t Address, uint32_t Length) const override
SymbolCache & getSymbolCache()
std::unique_ptr< PDBSymbolCompiland > findOneCompilandForSourceFile(llvm::StringRef Pattern, PDB_NameSearchFlags Flags) const override
std::unique_ptr< IPDBSourceFile > getSourceFileById(uint32_t FileId) const override
NativeSession(std::unique_ptr< PDBFile > PdbFile, std::unique_ptr< BumpPtrAllocator > Allocator)
std::unique_ptr< IPDBEnumChildren< PDBSymbolCompiland > > findCompilandsForSourceFile(llvm::StringRef Pattern, PDB_NameSearchFlags Flags) const override
std::unique_ptr< IPDBSourceFile > findOneSourceFile(const PDBSymbolCompiland *Compiland, llvm::StringRef Pattern, PDB_NameSearchFlags Flags) const override
Lightweight error class with error context and mandatory checking.
Definition: Error.h:158
static Error createFromPdb(std::unique_ptr< MemoryBuffer > MB, std::unique_ptr< IPDBSession > &Session)
bool addressForRVA(uint32_t RVA, uint32_t &Section, uint32_t &Offset) const override
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:49
std::unique_ptr< IPDBEnumDataStreams > getDebugStreams() const override
bool addressForVA(uint64_t VA, uint32_t &Section, uint32_t &Offset) const override
std::unique_ptr< IPDBEnumInjectedSources > getInjectedSources() const override
const PDBFile & getPDBFile() const
Definition: NativeSession.h:99