contrib/llvm/tools/llvm-pdbutil/llvm-pdbutil.h

   1 //===- llvm-pdbutil.h ----------------------------------------- *- 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_TOOLS_LLVMPDBDUMP_LLVMPDBDUMP_H
  11 #define LLVM_TOOLS_LLVMPDBDUMP_LLVMPDBDUMP_H
  12
  13 #include "llvm/ADT/DenseMap.h"
  14 #include "llvm/ADT/Optional.h"
  15 #include "llvm/ADT/PointerUnion.h"
  16 #include "llvm/Support/CommandLine.h"
  17 #include "llvm/Support/raw_ostream.h"
  18
  19 #include <memory>
  20 #include <stdint.h>
  21
  22 namespace llvm {
  23 namespace object {
  24 class COFFObjectFile;
  25 }
  26 namespace pdb {
  27 class PDBSymbolData;
  28 class PDBSymbolFunc;
  29 class PDBFile;
  30 uint32_t getTypeLength(const PDBSymbolData &Symbol);
  31 }
  32 typedef llvm::PointerUnion<object::COFFObjectFile *, pdb::PDBFile *>
  33     PdbOrCoffObj;
  34 }
  35
  36 namespace opts {
  37
  38 enum class DumpLevel { None, Basic, Verbose };
  39
  40 enum class ModuleSubsection {
  41   Unknown,
  42   Lines,
  43   FileChecksums,
  44   InlineeLines,
  45   CrossScopeImports,
  46   CrossScopeExports,
  47   StringTable,
  48   Symbols,
  49   FrameData,
  50   CoffSymbolRVAs,
  51   All
  52 };
  53
  54 namespace pretty {
  55
  56 enum class ClassDefinitionFormat { None, Layout, All };
  57 enum class ClassSortMode {
  58   None,
  59   Name,
  60   Size,
  61   Padding,
  62   PaddingPct,
  63   PaddingImmediate,
  64   PaddingPctImmediate
  65 };
  66
  67 enum class SymbolSortMode { None, Name, Size };
  68
  69 enum class SymLevel { Functions, Data, Thunks, All };
  70
  71 bool shouldDumpSymLevel(SymLevel Level);
  72 bool compareFunctionSymbols(
  73     const std::unique_ptr<llvm::pdb::PDBSymbolFunc> &F1,
  74     const std::unique_ptr<llvm::pdb::PDBSymbolFunc> &F2);
  75 bool compareDataSymbols(const std::unique_ptr<llvm::pdb::PDBSymbolData> &F1,
  76                         const std::unique_ptr<llvm::pdb::PDBSymbolData> &F2);
  77
  78 extern llvm::cl::list<std::string> WithName;
  79
  80 extern llvm::cl::opt<bool> Compilands;
  81 extern llvm::cl::opt<bool> Symbols;
  82 extern llvm::cl::opt<bool> Globals;
  83 extern llvm::cl::opt<bool> Classes;
  84 extern llvm::cl::opt<bool> Enums;
  85 extern llvm::cl::opt<bool> Funcsigs;
  86 extern llvm::cl::opt<bool> Arrays;
  87 extern llvm::cl::opt<bool> Typedefs;
  88 extern llvm::cl::opt<bool> Pointers;
  89 extern llvm::cl::opt<bool> VTShapes;
  90 extern llvm::cl::opt<bool> All;
  91 extern llvm::cl::opt<bool> ExcludeCompilerGenerated;
  92
  93 extern llvm::cl::opt<bool> NoEnumDefs;
  94 extern llvm::cl::list<std::string> ExcludeTypes;
  95 extern llvm::cl::list<std::string> ExcludeSymbols;
  96 extern llvm::cl::list<std::string> ExcludeCompilands;
  97 extern llvm::cl::list<std::string> IncludeTypes;
  98 extern llvm::cl::list<std::string> IncludeSymbols;
  99 extern llvm::cl::list<std::string> IncludeCompilands;
 100 extern llvm::cl::opt<SymbolSortMode> SymbolOrder;
 101 extern llvm::cl::opt<ClassSortMode> ClassOrder;
 102 extern llvm::cl::opt<uint32_t> SizeThreshold;
 103 extern llvm::cl::opt<uint32_t> PaddingThreshold;
 104 extern llvm::cl::opt<uint32_t> ImmediatePaddingThreshold;
 105 extern llvm::cl::opt<ClassDefinitionFormat> ClassFormat;
 106 extern llvm::cl::opt<uint32_t> ClassRecursionDepth;
 107 }
 108
 109 namespace bytes {
 110 struct NumberRange {
 111   uint64_t Min;
 112   llvm::Optional<uint64_t> Max;
 113 };
 114
 115 extern llvm::Optional<NumberRange> DumpBlockRange;
 116 extern llvm::Optional<NumberRange> DumpByteRange;
 117 extern llvm::cl::list<std::string> DumpStreamData;
 118 extern llvm::cl::opt<bool> NameMap;
 119 extern llvm::cl::opt<bool> Fpm;
 120
 121 extern llvm::cl::opt<bool> SectionContributions;
 122 extern llvm::cl::opt<bool> SectionMap;
 123 extern llvm::cl::opt<bool> ModuleInfos;
 124 extern llvm::cl::opt<bool> FileInfo;
 125 extern llvm::cl::opt<bool> TypeServerMap;
 126 extern llvm::cl::opt<bool> ECData;
 127
 128 extern llvm::cl::list<uint32_t> TypeIndex;
 129 extern llvm::cl::list<uint32_t> IdIndex;
 130
 131 extern llvm::cl::opt<uint32_t> ModuleIndex;
 132 extern llvm::cl::opt<bool> ModuleSyms;
 133 extern llvm::cl::opt<bool> ModuleC11;
 134 extern llvm::cl::opt<bool> ModuleC13;
 135 extern llvm::cl::opt<bool> SplitChunks;
 136 } // namespace bytes
 137
 138 namespace dump {
 139
 140 extern llvm::cl::opt<bool> DumpSummary;
 141 extern llvm::cl::opt<bool> DumpFpm;
 142 extern llvm::cl::opt<bool> DumpStreams;
 143 extern llvm::cl::opt<bool> DumpSymbolStats;
 144 extern llvm::cl::opt<bool> DumpUdtStats;
 145 extern llvm::cl::opt<bool> DumpStreamBlocks;
 146
 147 extern llvm::cl::opt<bool> DumpLines;
 148 extern llvm::cl::opt<bool> DumpInlineeLines;
 149 extern llvm::cl::opt<bool> DumpXmi;
 150 extern llvm::cl::opt<bool> DumpXme;
 151 extern llvm::cl::opt<bool> DumpNamedStreams;
 152 extern llvm::cl::opt<bool> DumpStringTable;
 153 extern llvm::cl::opt<bool> DumpStringTableDetails;
 154 extern llvm::cl::opt<bool> DumpTypes;
 155 extern llvm::cl::opt<bool> DumpTypeData;
 156 extern llvm::cl::opt<bool> DumpTypeExtras;
 157 extern llvm::cl::list<uint32_t> DumpTypeIndex;
 158 extern llvm::cl::opt<bool> DumpTypeDependents;
 159 extern llvm::cl::opt<bool> DumpSectionHeaders;
 160
 161 extern llvm::cl::opt<bool> DumpIds;
 162 extern llvm::cl::opt<bool> DumpIdData;
 163 extern llvm::cl::opt<bool> DumpIdExtras;
 164 extern llvm::cl::list<uint32_t> DumpIdIndex;
 165 extern llvm::cl::opt<uint32_t> DumpModi;
 166 extern llvm::cl::opt<bool> JustMyCode;
 167 extern llvm::cl::opt<bool> DontResolveForwardRefs;
 168 extern llvm::cl::opt<bool> DumpSymbols;
 169 extern llvm::cl::opt<bool> DumpSymRecordBytes;
 170 extern llvm::cl::opt<bool> DumpGSIRecords;
 171 extern llvm::cl::opt<bool> DumpGlobals;
 172 extern llvm::cl::list<std::string> DumpGlobalNames;
 173 extern llvm::cl::opt<bool> DumpGlobalExtras;
 174 extern llvm::cl::opt<bool> DumpPublics;
 175 extern llvm::cl::opt<bool> DumpPublicExtras;
 176 extern llvm::cl::opt<bool> DumpSectionContribs;
 177 extern llvm::cl::opt<bool> DumpSectionMap;
 178 extern llvm::cl::opt<bool> DumpModules;
 179 extern llvm::cl::opt<bool> DumpModuleFiles;
 180 extern llvm::cl::opt<bool> DumpFpo;
 181 extern llvm::cl::opt<bool> RawAll;
 182 }
 183
 184 namespace pdb2yaml {
 185 extern llvm::cl::opt<bool> All;
 186 extern llvm::cl::opt<bool> NoFileHeaders;
 187 extern llvm::cl::opt<bool> Minimal;
 188 extern llvm::cl::opt<bool> StreamMetadata;
 189 extern llvm::cl::opt<bool> StreamDirectory;
 190 extern llvm::cl::opt<bool> StringTable;
 191 extern llvm::cl::opt<bool> PdbStream;
 192 extern llvm::cl::opt<bool> DbiStream;
 193 extern llvm::cl::opt<bool> TpiStream;
 194 extern llvm::cl::opt<bool> IpiStream;
 195 extern llvm::cl::opt<bool> PublicsStream;
 196 extern llvm::cl::list<std::string> InputFilename;
 197 extern llvm::cl::opt<bool> DumpModules;
 198 extern llvm::cl::opt<bool> DumpModuleFiles;
 199 extern llvm::cl::list<ModuleSubsection> DumpModuleSubsections;
 200 extern llvm::cl::opt<bool> DumpModuleSyms;
 201 } // namespace pdb2yaml
 202
 203 namespace explain {
 204 enum class InputFileType { PDBFile, PDBStream, DBIStream, Names, ModuleStream };
 205
 206 extern llvm::cl::list<std::string> InputFilename;
 207 extern llvm::cl::list<uint64_t> Offsets;
 208 extern llvm::cl::opt<InputFileType> InputType;
 209 } // namespace explain
 210
 211 namespace exportstream {
 212 extern llvm::cl::opt<std::string> OutputFile;
 213 extern llvm::cl::opt<std::string> Stream;
 214 extern llvm::cl::opt<bool> ForceName;
 215 } // namespace exportstream
 216 }
 217
 218 #endif