1 //===- llvm-pdbutil.h ----------------------------------------- *- C++ --*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLVM_TOOLS_LLVMPDBDUMP_LLVMPDBDUMP_H
10 #define LLVM_TOOLS_LLVMPDBDUMP_LLVMPDBDUMP_H
11 
12 #include "llvm/ADT/DenseMap.h"
13 #include "llvm/ADT/Optional.h"
14 #include "llvm/ADT/PointerUnion.h"
15 #include "llvm/DebugInfo/PDB/Native/LinePrinter.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 extern FilterOptions Filters;
55 
56 namespace pretty {
57 
58 enum class ClassDefinitionFormat { None, Layout, All };
59 enum class ClassSortMode {
60   None,
61   Name,
62   Size,
63   Padding,
64   PaddingPct,
65   PaddingImmediate,
66   PaddingPctImmediate
67 };
68 
69 enum class SymbolSortMode { None, Name, Size };
70 
71 enum class SymLevel { Functions, Data, Thunks, All };
72 
73 bool shouldDumpSymLevel(SymLevel Level);
74 bool compareFunctionSymbols(
75     const std::unique_ptr<llvm::pdb::PDBSymbolFunc> &F1,
76     const std::unique_ptr<llvm::pdb::PDBSymbolFunc> &F2);
77 bool compareDataSymbols(const std::unique_ptr<llvm::pdb::PDBSymbolData> &F1,
78                         const std::unique_ptr<llvm::pdb::PDBSymbolData> &F2);
79 
80 extern llvm::cl::list<std::string> WithName;
81 
82 extern llvm::cl::opt<bool> Compilands;
83 extern llvm::cl::opt<bool> Symbols;
84 extern llvm::cl::opt<bool> Globals;
85 extern llvm::cl::opt<bool> Classes;
86 extern llvm::cl::opt<bool> Enums;
87 extern llvm::cl::opt<bool> Funcsigs;
88 extern llvm::cl::opt<bool> Arrays;
89 extern llvm::cl::opt<bool> Typedefs;
90 extern llvm::cl::opt<bool> Pointers;
91 extern llvm::cl::opt<bool> VTShapes;
92 extern llvm::cl::opt<bool> All;
93 extern llvm::cl::opt<bool> ExcludeCompilerGenerated;
94 
95 extern llvm::cl::opt<bool> NoEnumDefs;
96 extern llvm::cl::list<std::string> ExcludeTypes;
97 extern llvm::cl::list<std::string> ExcludeSymbols;
98 extern llvm::cl::list<std::string> ExcludeCompilands;
99 extern llvm::cl::list<std::string> IncludeTypes;
100 extern llvm::cl::list<std::string> IncludeSymbols;
101 extern llvm::cl::list<std::string> IncludeCompilands;
102 extern llvm::cl::opt<SymbolSortMode> SymbolOrder;
103 extern llvm::cl::opt<ClassSortMode> ClassOrder;
104 extern llvm::cl::opt<uint32_t> SizeThreshold;
105 extern llvm::cl::opt<uint32_t> PaddingThreshold;
106 extern llvm::cl::opt<uint32_t> ImmediatePaddingThreshold;
107 extern llvm::cl::opt<ClassDefinitionFormat> ClassFormat;
108 extern llvm::cl::opt<uint32_t> ClassRecursionDepth;
109 }
110 
111 namespace bytes {
112 struct NumberRange {
113   uint64_t Min;
114   llvm::Optional<uint64_t> Max;
115 };
116 
117 extern llvm::Optional<NumberRange> DumpBlockRange;
118 extern llvm::Optional<NumberRange> DumpByteRange;
119 extern llvm::cl::list<std::string> DumpStreamData;
120 extern llvm::cl::opt<bool> NameMap;
121 extern llvm::cl::opt<bool> Fpm;
122 
123 extern llvm::cl::opt<bool> SectionContributions;
124 extern llvm::cl::opt<bool> SectionMap;
125 extern llvm::cl::opt<bool> ModuleInfos;
126 extern llvm::cl::opt<bool> FileInfo;
127 extern llvm::cl::opt<bool> TypeServerMap;
128 extern llvm::cl::opt<bool> ECData;
129 
130 extern llvm::cl::list<uint32_t> TypeIndex;
131 extern llvm::cl::list<uint32_t> IdIndex;
132 
133 extern llvm::cl::opt<uint32_t> ModuleIndex;
134 extern llvm::cl::opt<bool> ModuleSyms;
135 extern llvm::cl::opt<bool> ModuleC11;
136 extern llvm::cl::opt<bool> ModuleC13;
137 extern llvm::cl::opt<bool> SplitChunks;
138 } // namespace bytes
139 
140 namespace dump {
141 
142 extern llvm::cl::opt<bool> DumpSummary;
143 extern llvm::cl::opt<bool> DumpFpm;
144 extern llvm::cl::opt<bool> DumpStreams;
145 extern llvm::cl::opt<bool> DumpSymbolStats;
146 extern llvm::cl::opt<bool> DumpTypeStats;
147 extern llvm::cl::opt<bool> DumpIDStats;
148 extern llvm::cl::opt<bool> DumpUdtStats;
149 extern llvm::cl::opt<bool> DumpStreamBlocks;
150 
151 extern llvm::cl::opt<bool> DumpLines;
152 extern llvm::cl::opt<bool> DumpInlineeLines;
153 extern llvm::cl::opt<bool> DumpXmi;
154 extern llvm::cl::opt<bool> DumpXme;
155 extern llvm::cl::opt<bool> DumpNamedStreams;
156 extern llvm::cl::opt<bool> DumpStringTable;
157 extern llvm::cl::opt<bool> DumpStringTableDetails;
158 extern llvm::cl::opt<bool> DumpTypes;
159 extern llvm::cl::opt<bool> DumpTypeData;
160 extern llvm::cl::opt<bool> DumpTypeExtras;
161 extern llvm::cl::list<uint32_t> DumpTypeIndex;
162 extern llvm::cl::opt<bool> DumpTypeDependents;
163 extern llvm::cl::opt<bool> DumpTypeRefStats;
164 extern llvm::cl::opt<bool> DumpSectionHeaders;
165 
166 extern llvm::cl::opt<bool> DumpIds;
167 extern llvm::cl::opt<bool> DumpIdData;
168 extern llvm::cl::opt<bool> DumpIdExtras;
169 extern llvm::cl::list<uint32_t> DumpIdIndex;
170 extern llvm::cl::opt<uint32_t> DumpModi;
171 extern llvm::cl::opt<bool> JustMyCode;
172 extern llvm::cl::opt<bool> DontResolveForwardRefs;
173 extern llvm::cl::opt<bool> DumpSymbols;
174 extern llvm::cl::opt<bool> DumpSymRecordBytes;
175 extern llvm::cl::opt<bool> DumpGSIRecords;
176 extern llvm::cl::opt<bool> DumpGlobals;
177 extern llvm::cl::list<std::string> DumpGlobalNames;
178 extern llvm::cl::opt<bool> DumpGlobalExtras;
179 extern llvm::cl::opt<bool> DumpPublics;
180 extern llvm::cl::opt<bool> DumpPublicExtras;
181 extern llvm::cl::opt<bool> DumpSectionContribs;
182 extern llvm::cl::opt<bool> DumpSectionMap;
183 extern llvm::cl::opt<bool> DumpModules;
184 extern llvm::cl::opt<bool> DumpModuleFiles;
185 extern llvm::cl::opt<bool> DumpFpo;
186 extern llvm::cl::opt<bool> RawAll;
187 }
188 
189 namespace pdb2yaml {
190 extern llvm::cl::opt<bool> All;
191 extern llvm::cl::opt<bool> NoFileHeaders;
192 extern llvm::cl::opt<bool> Minimal;
193 extern llvm::cl::opt<bool> StreamMetadata;
194 extern llvm::cl::opt<bool> StreamDirectory;
195 extern llvm::cl::opt<bool> StringTable;
196 extern llvm::cl::opt<bool> PdbStream;
197 extern llvm::cl::opt<bool> DbiStream;
198 extern llvm::cl::opt<bool> TpiStream;
199 extern llvm::cl::opt<bool> IpiStream;
200 extern llvm::cl::opt<bool> PublicsStream;
201 extern llvm::cl::list<std::string> InputFilename;
202 extern llvm::cl::opt<bool> DumpModules;
203 extern llvm::cl::opt<bool> DumpModuleFiles;
204 extern llvm::cl::list<ModuleSubsection> DumpModuleSubsections;
205 extern llvm::cl::opt<bool> DumpModuleSyms;
206 } // namespace pdb2yaml
207 
208 namespace explain {
209 enum class InputFileType { PDBFile, PDBStream, DBIStream, Names, ModuleStream };
210 
211 extern llvm::cl::list<std::string> InputFilename;
212 extern llvm::cl::list<uint64_t> Offsets;
213 extern llvm::cl::opt<InputFileType> InputType;
214 } // namespace explain
215 
216 namespace exportstream {
217 extern llvm::cl::opt<std::string> OutputFile;
218 extern llvm::cl::opt<std::string> Stream;
219 extern llvm::cl::opt<bool> ForceName;
220 } // namespace exportstream
221 }
222 
223 #endif
224