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