LLVM  4.0.0
IPDBSession.h
Go to the documentation of this file.
1 //===- IPDBSession.h - base interface for a PDB symbol context --*- 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_IPDBSESSION_H
11 #define LLVM_DEBUGINFO_PDB_IPDBSESSION_H
12 
13 #include "PDBTypes.h"
14 #include "llvm/ADT/StringRef.h"
15 #include "llvm/Support/Casting.h"
16 #include <memory>
17 
18 namespace llvm {
19 namespace pdb {
20 class PDBSymbolCompiland;
21 class PDBSymbolExe;
22 
23 /// IPDBSession defines an interface used to provide a context for querying
24 /// debug information from a debug data source (for example, a PDB).
25 class IPDBSession {
26 public:
27  virtual ~IPDBSession();
28 
29  virtual uint64_t getLoadAddress() const = 0;
30  virtual void setLoadAddress(uint64_t Address) = 0;
31  virtual std::unique_ptr<PDBSymbolExe> getGlobalScope() const = 0;
32  virtual std::unique_ptr<PDBSymbol> getSymbolById(uint32_t SymbolId) const = 0;
33 
34  template <typename T>
35  std::unique_ptr<T> getConcreteSymbolById(uint32_t SymbolId) const {
36  auto Symbol(getSymbolById(SymbolId));
37  if (!Symbol)
38  return nullptr;
39 
40  T *ConcreteSymbol = dyn_cast<T>(Symbol.get());
41  if (!ConcreteSymbol)
42  return nullptr;
43  (void)Symbol.release();
44  return std::unique_ptr<T>(ConcreteSymbol);
45  }
46 
47  virtual std::unique_ptr<PDBSymbol>
48  findSymbolByAddress(uint64_t Address, PDB_SymType Type) const = 0;
49 
50  virtual std::unique_ptr<IPDBEnumLineNumbers>
52  const IPDBSourceFile &File) const = 0;
53  virtual std::unique_ptr<IPDBEnumLineNumbers>
54  findLineNumbersByAddress(uint64_t Address, uint32_t Length) const = 0;
55 
56  virtual std::unique_ptr<IPDBEnumSourceFiles>
58  PDB_NameSearchFlags Flags) const = 0;
59  virtual std::unique_ptr<IPDBSourceFile>
61  llvm::StringRef Pattern,
62  PDB_NameSearchFlags Flags) const = 0;
63  virtual std::unique_ptr<IPDBEnumChildren<PDBSymbolCompiland>>
65  PDB_NameSearchFlags Flags) const = 0;
66  virtual std::unique_ptr<PDBSymbolCompiland>
68  PDB_NameSearchFlags Flags) const = 0;
69 
70  virtual std::unique_ptr<IPDBEnumSourceFiles> getAllSourceFiles() const = 0;
71  virtual std::unique_ptr<IPDBEnumSourceFiles>
73  virtual std::unique_ptr<IPDBSourceFile>
74  getSourceFileById(uint32_t FileId) const = 0;
75 
76  virtual std::unique_ptr<IPDBEnumDataStreams> getDebugStreams() const = 0;
77 };
78 }
79 }
80 
81 #endif
IPDBSession defines an interface used to provide a context for querying debug information from a debu...
Definition: IPDBSession.h:25
PDB_NameSearchFlags
Defines flags used for enumerating child symbols.
Definition: PDBTypes.h:91
IPDBSourceFile defines an interface used to represent source files whose information are stored in th...
virtual uint64_t getLoadAddress() const =0
struct fuzzer::@269 Flags
virtual std::unique_ptr< IPDBEnumSourceFiles > getSourceFilesForCompiland(const PDBSymbolCompiland &Compiland) const =0
virtual void setLoadAddress(uint64_t Address)=0
virtual std::unique_ptr< IPDBEnumChildren< PDBSymbolCompiland > > findCompilandsForSourceFile(llvm::StringRef Pattern, PDB_NameSearchFlags Flags) const =0
virtual std::unique_ptr< PDBSymbolExe > getGlobalScope() const =0
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:162
virtual std::unique_ptr< IPDBEnumLineNumbers > findLineNumbersByAddress(uint64_t Address, uint32_t Length) const =0
std::unique_ptr< T > getConcreteSymbolById(uint32_t SymbolId) const
Definition: IPDBSession.h:35
The instances of the Type class are immutable: once they are created, they are never changed...
Definition: Type.h:45
virtual std::unique_ptr< PDBSymbolCompiland > findOneCompilandForSourceFile(llvm::StringRef Pattern, PDB_NameSearchFlags Flags) const =0
virtual std::unique_ptr< PDBSymbol > getSymbolById(uint32_t SymbolId) const =0
virtual std::unique_ptr< IPDBSourceFile > getSourceFileById(uint32_t FileId) const =0
virtual std::unique_ptr< IPDBSourceFile > findOneSourceFile(const PDBSymbolCompiland *Compiland, llvm::StringRef Pattern, PDB_NameSearchFlags Flags) const =0
virtual std::unique_ptr< IPDBEnumDataStreams > getDebugStreams() const =0
virtual std::unique_ptr< PDBSymbol > findSymbolByAddress(uint64_t Address, PDB_SymType Type) const =0
virtual std::unique_ptr< IPDBEnumSourceFiles > findSourceFiles(const PDBSymbolCompiland *Compiland, llvm::StringRef Pattern, PDB_NameSearchFlags Flags) const =0
LLVM_NODISCARD std::enable_if<!is_simple_type< Y >::value, typename cast_retty< X, const Y >::ret_type >::type dyn_cast(const Y &Val)
Definition: Casting.h:287
virtual std::unique_ptr< IPDBEnumSourceFiles > getAllSourceFiles() const =0
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:47
virtual std::unique_ptr< IPDBEnumLineNumbers > findLineNumbers(const PDBSymbolCompiland &Compiland, const IPDBSourceFile &File) const =0