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