blob: bdd8dfa164f4af6e6a746c5b257a58f7e6c01a9f [file] [log] [blame]
Zachary Turnerbd336e42017-06-09 20:46:17 +00001//===- llvm-pdbutil.cpp - Dump debug info from a PDB file -------*- C++ -*-===//
Zachary Turnerfcb14ad2015-01-27 20:46:21 +00002//
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//
Zachary Turner6ac232c2017-03-13 23:28:25 +000010// Dumps debug information present in PDB files.
Zachary Turnerfcb14ad2015-01-27 20:46:21 +000011//
12//===----------------------------------------------------------------------===//
13
Zachary Turnerbd336e42017-06-09 20:46:17 +000014#include "llvm-pdbutil.h"
Zachary Turnerd50c0132017-02-01 18:30:22 +000015
16#include "Analyze.h"
Zachary Turner99402032017-06-22 20:58:11 +000017#include "BytesOutputStyle.h"
Zachary Turner6ac232c2017-03-13 23:28:25 +000018#include "Diff.h"
Zachary Turner7df69952017-06-22 20:57:39 +000019#include "DumpOutputStyle.h"
Zachary Turner2d11c202015-02-27 09:15:59 +000020#include "LinePrinter.h"
Zachary Turnerd3117392016-06-03 19:28:33 +000021#include "OutputStyle.h"
Zachary Turnera9054dd2017-01-11 00:35:43 +000022#include "PrettyCompilandDumper.h"
23#include "PrettyExternalSymbolDumper.h"
24#include "PrettyFunctionDumper.h"
25#include "PrettyTypeDumper.h"
26#include "PrettyVariableDumper.h"
Zachary Turner7120a472016-06-06 20:37:05 +000027#include "YAMLOutputStyle.h"
Zachary Turner9a818ad2015-02-22 22:03:38 +000028
Zachary Turnerfcb14ad2015-01-27 20:46:21 +000029#include "llvm/ADT/ArrayRef.h"
David Majnemer6e081262015-10-15 01:27:19 +000030#include "llvm/ADT/BitVector.h"
31#include "llvm/ADT/DenseMap.h"
Zachary Turner8a2ebfb2017-05-01 23:27:42 +000032#include "llvm/ADT/STLExtras.h"
Zachary Turnerfcb14ad2015-01-27 20:46:21 +000033#include "llvm/ADT/StringExtras.h"
Zachary Turner8d7fa9b2015-02-10 22:47:14 +000034#include "llvm/Config/config.h"
Zachary Turner8c099fe2017-05-30 16:36:15 +000035#include "llvm/DebugInfo/CodeView/DebugChecksumsSubsection.h"
36#include "llvm/DebugInfo/CodeView/DebugInlineeLinesSubsection.h"
37#include "llvm/DebugInfo/CodeView/DebugLinesSubsection.h"
Zachary Turner526f4f22017-05-19 19:26:58 +000038#include "llvm/DebugInfo/CodeView/LazyRandomTypeCollection.h"
Zachary Turnera8cfc292017-06-14 15:59:27 +000039#include "llvm/DebugInfo/CodeView/StringsAndChecksums.h"
Zachary Turner8fb441a2017-05-18 23:03:41 +000040#include "llvm/DebugInfo/CodeView/TypeStreamMerger.h"
Zachary Turnerb32ec022017-05-18 23:04:08 +000041#include "llvm/DebugInfo/CodeView/TypeTableBuilder.h"
Zachary Turnera3225b02016-07-29 20:56:36 +000042#include "llvm/DebugInfo/MSF/MSFBuilder.h"
Zachary Turner819e77d2016-05-06 20:51:57 +000043#include "llvm/DebugInfo/PDB/GenericError.h"
Zachary Turnera5549172015-02-10 22:43:25 +000044#include "llvm/DebugInfo/PDB/IPDBEnumChildren.h"
Zachary Turnera5549172015-02-10 22:43:25 +000045#include "llvm/DebugInfo/PDB/IPDBRawSymbol.h"
Chandler Carruth71f308a2015-02-13 09:09:03 +000046#include "llvm/DebugInfo/PDB/IPDBSession.h"
Zachary Turner67c56012017-04-27 16:11:19 +000047#include "llvm/DebugInfo/PDB/Native/DbiModuleDescriptorBuilder.h"
Adrian McCarthy6b6b8c42017-01-25 22:38:55 +000048#include "llvm/DebugInfo/PDB/Native/DbiStream.h"
49#include "llvm/DebugInfo/PDB/Native/DbiStreamBuilder.h"
50#include "llvm/DebugInfo/PDB/Native/InfoStream.h"
51#include "llvm/DebugInfo/PDB/Native/InfoStreamBuilder.h"
52#include "llvm/DebugInfo/PDB/Native/NativeSession.h"
53#include "llvm/DebugInfo/PDB/Native/PDBFile.h"
54#include "llvm/DebugInfo/PDB/Native/PDBFileBuilder.h"
Zachary Turnere204a6c2017-05-02 18:00:13 +000055#include "llvm/DebugInfo/PDB/Native/PDBStringTableBuilder.h"
Adrian McCarthy6b6b8c42017-01-25 22:38:55 +000056#include "llvm/DebugInfo/PDB/Native/RawConstants.h"
57#include "llvm/DebugInfo/PDB/Native/RawError.h"
Adrian McCarthy6b6b8c42017-01-25 22:38:55 +000058#include "llvm/DebugInfo/PDB/Native/TpiStream.h"
59#include "llvm/DebugInfo/PDB/Native/TpiStreamBuilder.h"
Chandler Carruth71f308a2015-02-13 09:09:03 +000060#include "llvm/DebugInfo/PDB/PDB.h"
Zachary Turnera5549172015-02-10 22:43:25 +000061#include "llvm/DebugInfo/PDB/PDBSymbolCompiland.h"
Zachary Turnerdb18f5c2015-02-27 09:15:18 +000062#include "llvm/DebugInfo/PDB/PDBSymbolData.h"
Chandler Carruth71f308a2015-02-13 09:09:03 +000063#include "llvm/DebugInfo/PDB/PDBSymbolExe.h"
Zachary Turnerdb18f5c2015-02-27 09:15:18 +000064#include "llvm/DebugInfo/PDB/PDBSymbolFunc.h"
65#include "llvm/DebugInfo/PDB/PDBSymbolThunk.h"
Zachary Turnerd9dc2822017-03-02 20:52:51 +000066#include "llvm/Support/BinaryByteStream.h"
Zachary Turner93839cb2016-06-02 05:07:49 +000067#include "llvm/Support/COM.h"
Zachary Turnerfcb14ad2015-01-27 20:46:21 +000068#include "llvm/Support/CommandLine.h"
69#include "llvm/Support/ConvertUTF.h"
Zachary Turner1dc9fd32016-06-14 20:48:36 +000070#include "llvm/Support/FileOutputBuffer.h"
Zachary Turner9a818ad2015-02-22 22:03:38 +000071#include "llvm/Support/FileSystem.h"
Zachary Turnerfcb14ad2015-01-27 20:46:21 +000072#include "llvm/Support/Format.h"
73#include "llvm/Support/ManagedStatic.h"
David Majnemer6e081262015-10-15 01:27:19 +000074#include "llvm/Support/MemoryBuffer.h"
Bob Haarmande33a6372017-05-17 20:46:48 +000075#include "llvm/Support/Path.h"
Zachary Turnerfcb14ad2015-01-27 20:46:21 +000076#include "llvm/Support/PrettyStackTrace.h"
Chandler Carruth71f308a2015-02-13 09:09:03 +000077#include "llvm/Support/Process.h"
Zachary Turner72c5b642016-09-09 18:17:52 +000078#include "llvm/Support/Regex.h"
Reid Klecknerb0345262016-05-04 16:09:04 +000079#include "llvm/Support/ScopedPrinter.h"
Daniel Sandersd41718e2016-04-22 12:04:42 +000080#include "llvm/Support/Signals.h"
Zachary Turner0a43efe2016-04-25 17:38:08 +000081#include "llvm/Support/raw_ostream.h"
Zachary Turnerfcb14ad2015-01-27 20:46:21 +000082
Zachary Turnerfcb14ad2015-01-27 20:46:21 +000083using namespace llvm;
Zachary Turnera96cce62016-06-03 03:25:59 +000084using namespace llvm::codeview;
Zachary Turnerbac69d32016-07-22 19:56:05 +000085using namespace llvm::msf;
Zachary Turner2f09b502016-04-29 17:28:47 +000086using namespace llvm::pdb;
Zachary Turnerfcb14ad2015-01-27 20:46:21 +000087
88namespace opts {
Zachary Turnerc0acf682015-02-15 20:27:53 +000089
Zachary Turner7df69952017-06-22 20:57:39 +000090cl::SubCommand DumpSubcommand("dump", "Dump MSF and CodeView debug info");
Zachary Turner99402032017-06-22 20:58:11 +000091cl::SubCommand BytesSubcommand("bytes", "Dump raw bytes from the PDB file");
92
Zachary Turnera30bd1a2016-06-30 17:42:48 +000093cl::SubCommand
94 PrettySubcommand("pretty",
95 "Dump semantic information about types and symbols");
Zachary Turner6ac232c2017-03-13 23:28:25 +000096
97cl::SubCommand DiffSubcommand("diff", "Diff the contents of 2 PDB files");
98
Zachary Turnerab58ae82016-06-30 17:43:00 +000099cl::SubCommand
100 YamlToPdbSubcommand("yaml2pdb",
101 "Generate a PDB file from a YAML description");
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000102cl::SubCommand
103 PdbToYamlSubcommand("pdb2yaml",
104 "Generate a detailed YAML description of a PDB File");
Zachary Turnerfcb14ad2015-01-27 20:46:21 +0000105
Zachary Turnerd50c0132017-02-01 18:30:22 +0000106cl::SubCommand
107 AnalyzeSubcommand("analyze",
108 "Analyze various aspects of a PDB's structure");
109
Zachary Turner8fb441a2017-05-18 23:03:41 +0000110cl::SubCommand MergeSubcommand("merge",
111 "Merge multiple PDBs into a single PDB");
112
Zachary Turner7797c722015-03-02 04:39:56 +0000113cl::OptionCategory TypeCategory("Symbol Type Options");
Zachary Turnerc883a8c2017-04-12 23:18:21 +0000114cl::OptionCategory FilterCategory("Filtering and Sorting Options");
Zachary Turnere5cb2692015-05-01 20:24:26 +0000115cl::OptionCategory OtherOptions("Other Options");
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000116
117namespace pretty {
118cl::list<std::string> InputFilenames(cl::Positional,
119 cl::desc("<input PDB files>"),
120 cl::OneOrMore, cl::sub(PrettySubcommand));
Zachary Turner7797c722015-03-02 04:39:56 +0000121
122cl::opt<bool> Compilands("compilands", cl::desc("Display compilands"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000123 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
Zachary Turner0683be22017-05-14 01:13:40 +0000124cl::opt<bool> Symbols("module-syms",
125 cl::desc("Display symbols for each compiland"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000126 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
Zachary Turner7797c722015-03-02 04:39:56 +0000127cl::opt<bool> Globals("globals", cl::desc("Dump global symbols"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000128 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
Zachary Turnere5cb2692015-05-01 20:24:26 +0000129cl::opt<bool> Externals("externals", cl::desc("Dump external symbols"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000130 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
Zachary Turner0683be22017-05-14 01:13:40 +0000131cl::list<SymLevel> SymTypes(
132 "sym-types", cl::desc("Type of symbols to dump (default all)"),
133 cl::cat(TypeCategory), cl::sub(PrettySubcommand), cl::ZeroOrMore,
134 cl::values(
135 clEnumValN(SymLevel::Thunks, "thunks", "Display thunk symbols"),
136 clEnumValN(SymLevel::Data, "data", "Display data symbols"),
137 clEnumValN(SymLevel::Functions, "funcs", "Display function symbols"),
138 clEnumValN(SymLevel::All, "all", "Display all symbols (default)")));
139
Zachary Turner63230a4e2017-04-06 23:43:12 +0000140cl::opt<bool>
141 Types("types",
142 cl::desc("Display all types (implies -classes, -enums, -typedefs)"),
143 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
144cl::opt<bool> Classes("classes", cl::desc("Display class types"),
145 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
146cl::opt<bool> Enums("enums", cl::desc("Display enum types"),
147 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
148cl::opt<bool> Typedefs("typedefs", cl::desc("Display typedef types"),
149 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
Zachary Turner0683be22017-05-14 01:13:40 +0000150cl::opt<SymbolSortMode> SymbolOrder(
151 "symbol-order", cl::desc("symbol sort order"),
152 cl::init(SymbolSortMode::None),
153 cl::values(clEnumValN(SymbolSortMode::None, "none",
154 "Undefined / no particular sort order"),
155 clEnumValN(SymbolSortMode::Name, "name", "Sort symbols by name"),
156 clEnumValN(SymbolSortMode::Size, "size",
157 "Sort symbols by size")),
158 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
159
Zachary Turner4dc4f012017-04-13 21:11:00 +0000160cl::opt<ClassSortMode> ClassOrder(
161 "class-order", cl::desc("Class sort order"), cl::init(ClassSortMode::None),
Zachary Turner16901642017-04-24 17:47:24 +0000162 cl::values(
163 clEnumValN(ClassSortMode::None, "none",
164 "Undefined / no particular sort order"),
165 clEnumValN(ClassSortMode::Name, "name", "Sort classes by name"),
166 clEnumValN(ClassSortMode::Size, "size", "Sort classes by size"),
167 clEnumValN(ClassSortMode::Padding, "padding",
168 "Sort classes by amount of padding"),
169 clEnumValN(ClassSortMode::PaddingPct, "padding-pct",
Zachary Turnerda307b62017-04-25 20:22:29 +0000170 "Sort classes by percentage of space consumed by padding"),
171 clEnumValN(ClassSortMode::PaddingImmediate, "padding-imm",
172 "Sort classes by amount of immediate padding"),
173 clEnumValN(ClassSortMode::PaddingPctImmediate, "padding-pct-imm",
174 "Sort classes by percentage of space consumed by immediate "
175 "padding")),
Zachary Turner4dc4f012017-04-13 21:11:00 +0000176 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
177
Zachary Turnerc883a8c2017-04-12 23:18:21 +0000178cl::opt<ClassDefinitionFormat> ClassFormat(
179 "class-definitions", cl::desc("Class definition format"),
Zachary Turnerda949c12017-04-24 17:47:52 +0000180 cl::init(ClassDefinitionFormat::All),
Zachary Turnerc883a8c2017-04-12 23:18:21 +0000181 cl::values(
Zachary Turnerda949c12017-04-24 17:47:52 +0000182 clEnumValN(ClassDefinitionFormat::All, "all",
Zachary Turner9e7dda32017-04-12 23:18:51 +0000183 "Display all class members including data, constants, "
Zachary Turner4dc4f012017-04-13 21:11:00 +0000184 "typedefs, functions, etc"),
Zachary Turnerda949c12017-04-24 17:47:52 +0000185 clEnumValN(ClassDefinitionFormat::Layout, "layout",
Zachary Turnerc883a8c2017-04-12 23:18:21 +0000186 "Only display members that contribute to class size."),
187 clEnumValN(ClassDefinitionFormat::None, "none",
188 "Don't display class definitions")),
189 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
Zachary Turnerda949c12017-04-24 17:47:52 +0000190cl::opt<uint32_t> ClassRecursionDepth(
191 "class-recurse-depth", cl::desc("Class recursion depth (0=no limit)"),
192 cl::init(0), cl::cat(TypeCategory), cl::sub(PrettySubcommand));
Zachary Turner63230a4e2017-04-06 23:43:12 +0000193
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000194cl::opt<bool> Lines("lines", cl::desc("Line tables"), cl::cat(TypeCategory),
195 cl::sub(PrettySubcommand));
Zachary Turner7797c722015-03-02 04:39:56 +0000196cl::opt<bool>
Zachary Turner7797c722015-03-02 04:39:56 +0000197 All("all", cl::desc("Implies all other options in 'Symbol Types' category"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000198 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
Zachary Turnerf5abda22015-03-01 06:49:49 +0000199
Zachary Turnere5cb2692015-05-01 20:24:26 +0000200cl::opt<uint64_t> LoadAddress(
201 "load-address",
202 cl::desc("Assume the module is loaded at the specified address"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000203 cl::cat(OtherOptions), cl::sub(PrettySubcommand));
Adrian McCarthy65d26882017-03-15 20:17:58 +0000204cl::opt<bool> Native("native", cl::desc("Use native PDB reader instead of DIA"),
Adrian McCarthy1aa207d2017-03-23 15:28:15 +0000205 cl::cat(OtherOptions), cl::sub(PrettySubcommand));
206cl::opt<cl::boolOrDefault>
207 ColorOutput("color-output",
208 cl::desc("Override use of color (default = isatty)"),
209 cl::cat(OtherOptions), cl::sub(PrettySubcommand));
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000210cl::list<std::string> ExcludeTypes(
211 "exclude-types", cl::desc("Exclude types by regular expression"),
212 cl::ZeroOrMore, cl::cat(FilterCategory), cl::sub(PrettySubcommand));
213cl::list<std::string> ExcludeSymbols(
214 "exclude-symbols", cl::desc("Exclude symbols by regular expression"),
215 cl::ZeroOrMore, cl::cat(FilterCategory), cl::sub(PrettySubcommand));
216cl::list<std::string> ExcludeCompilands(
217 "exclude-compilands", cl::desc("Exclude compilands by regular expression"),
218 cl::ZeroOrMore, cl::cat(FilterCategory), cl::sub(PrettySubcommand));
Zachary Turner4dddcc62015-09-29 19:49:06 +0000219
220cl::list<std::string> IncludeTypes(
221 "include-types",
222 cl::desc("Include only types which match a regular expression"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000223 cl::ZeroOrMore, cl::cat(FilterCategory), cl::sub(PrettySubcommand));
Zachary Turner4dddcc62015-09-29 19:49:06 +0000224cl::list<std::string> IncludeSymbols(
225 "include-symbols",
226 cl::desc("Include only symbols which match a regular expression"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000227 cl::ZeroOrMore, cl::cat(FilterCategory), cl::sub(PrettySubcommand));
Zachary Turner4dddcc62015-09-29 19:49:06 +0000228cl::list<std::string> IncludeCompilands(
229 "include-compilands",
230 cl::desc("Include only compilands those which match a regular expression"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000231 cl::ZeroOrMore, cl::cat(FilterCategory), cl::sub(PrettySubcommand));
Zachary Turner4dc4f012017-04-13 21:11:00 +0000232cl::opt<uint32_t> SizeThreshold(
233 "min-type-size", cl::desc("Displays only those types which are greater "
234 "than or equal to the specified size."),
235 cl::init(0), cl::cat(FilterCategory), cl::sub(PrettySubcommand));
236cl::opt<uint32_t> PaddingThreshold(
237 "min-class-padding", cl::desc("Displays only those classes which have at "
238 "least the specified amount of padding."),
239 cl::init(0), cl::cat(FilterCategory), cl::sub(PrettySubcommand));
Zachary Turnerda307b62017-04-25 20:22:29 +0000240cl::opt<uint32_t> ImmediatePaddingThreshold(
241 "min-class-padding-imm",
242 cl::desc("Displays only those classes which have at least the specified "
243 "amount of immediate padding, ignoring padding internal to bases "
244 "and aggregates."),
245 cl::init(0), cl::cat(FilterCategory), cl::sub(PrettySubcommand));
Zachary Turner4dddcc62015-09-29 19:49:06 +0000246
Zachary Turner7797c722015-03-02 04:39:56 +0000247cl::opt<bool> ExcludeCompilerGenerated(
248 "no-compiler-generated",
249 cl::desc("Don't show compiler generated types and symbols"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000250 cl::cat(FilterCategory), cl::sub(PrettySubcommand));
Zachary Turner7797c722015-03-02 04:39:56 +0000251cl::opt<bool>
252 ExcludeSystemLibraries("no-system-libs",
253 cl::desc("Don't show symbols from system libraries"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000254 cl::cat(FilterCategory), cl::sub(PrettySubcommand));
Zachary Turner10169b62017-04-06 23:43:39 +0000255
Zachary Turner65323652015-03-04 06:09:53 +0000256cl::opt<bool> NoEnumDefs("no-enum-definitions",
257 cl::desc("Don't display full enum definitions"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000258 cl::cat(FilterCategory), cl::sub(PrettySubcommand));
259}
260
Zachary Turner6ac232c2017-03-13 23:28:25 +0000261namespace diff {
Zachary Turner6ac232c2017-03-13 23:28:25 +0000262cl::list<std::string> InputFilenames(cl::Positional,
263 cl::desc("<first> <second>"),
264 cl::OneOrMore, cl::sub(DiffSubcommand));
265}
266
Zachary Turner63055452017-06-15 22:24:24 +0000267cl::OptionCategory FileOptions("Module & File Options");
268
Zachary Turner99402032017-06-22 20:58:11 +0000269namespace bytes {
Zachary Turner6b124f22017-06-23 19:54:44 +0000270llvm::Optional<NumberRange> DumpBlockRange;
271llvm::Optional<NumberRange> DumpByteRange;
272
273cl::opt<std::string> DumpBlockRangeOpt(
274 "block-range", cl::value_desc("start[-end]"),
275 cl::desc("Dump binary data from specified range of blocks."),
276 cl::sub(BytesSubcommand));
Zachary Turner99402032017-06-22 20:58:11 +0000277
278cl::opt<std::string>
Zachary Turner6b124f22017-06-23 19:54:44 +0000279 DumpByteRangeOpt("byte-range", cl::value_desc("start[-end]"),
280 cl::desc("Dump binary data from specified range of bytes"),
281 cl::sub(BytesSubcommand));
Zachary Turner99402032017-06-22 20:58:11 +0000282
283cl::list<std::string>
284 DumpStreamData("stream-data", cl::CommaSeparated, cl::ZeroOrMore,
285 cl::desc("Dump binary data from specified streams. Format "
286 "is SN[:Start][@Size]"),
287 cl::sub(BytesSubcommand));
288
289cl::list<std::string> InputFilenames(cl::Positional,
290 cl::desc("<input PDB files>"),
291 cl::OneOrMore, cl::sub(BytesSubcommand));
292
293} // namespace bytes
294
Zachary Turner7df69952017-06-22 20:57:39 +0000295namespace dump {
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000296
297cl::OptionCategory MsfOptions("MSF Container Options");
298cl::OptionCategory TypeOptions("Type Record Options");
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000299cl::OptionCategory SymbolOptions("Symbol Options");
300cl::OptionCategory MiscOptions("Miscellaneous Options");
301
302// MSF OPTIONS
Zachary Turner63055452017-06-15 22:24:24 +0000303cl::opt<bool> DumpSummary("summary", cl::desc("dump file summary"),
Zachary Turner7df69952017-06-22 20:57:39 +0000304 cl::cat(MsfOptions), cl::sub(DumpSubcommand));
Zachary Turner63055452017-06-15 22:24:24 +0000305cl::opt<bool> DumpStreams("streams",
306 cl::desc("dump summary of the PDB streams"),
Zachary Turner7df69952017-06-22 20:57:39 +0000307 cl::cat(MsfOptions), cl::sub(DumpSubcommand));
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000308
309// TYPE OPTIONS
Zachary Turner63055452017-06-15 22:24:24 +0000310cl::opt<bool> DumpTypes("types",
311 cl::desc("dump CodeView type records from TPI stream"),
Zachary Turner7df69952017-06-22 20:57:39 +0000312 cl::cat(TypeOptions), cl::sub(DumpSubcommand));
Zachary Turner63055452017-06-15 22:24:24 +0000313cl::opt<bool> DumpTypeData(
314 "type-data",
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000315 cl::desc("dump CodeView type record raw bytes from TPI stream"),
Zachary Turner7df69952017-06-22 20:57:39 +0000316 cl::cat(TypeOptions), cl::sub(DumpSubcommand));
Zachary Turner63055452017-06-15 22:24:24 +0000317
Zachary Turnerf8a2e042017-06-15 23:04:42 +0000318cl::opt<bool> DumpTypeExtras("type-extras",
319 cl::desc("dump type hashes and index offsets"),
Zachary Turner7df69952017-06-22 20:57:39 +0000320 cl::cat(TypeOptions), cl::sub(DumpSubcommand));
Zachary Turner63055452017-06-15 22:24:24 +0000321
Zachary Turner59224cb2017-06-16 23:42:15 +0000322cl::list<uint32_t> DumpTypeIndex(
323 "type-index", cl::ZeroOrMore,
324 cl::desc("only dump types with the specified hexadecimal type index"),
Zachary Turner7df69952017-06-22 20:57:39 +0000325 cl::cat(TypeOptions), cl::sub(DumpSubcommand));
Zachary Turner59224cb2017-06-16 23:42:15 +0000326
Zachary Turner63055452017-06-15 22:24:24 +0000327cl::opt<bool> DumpIds("ids",
328 cl::desc("dump CodeView type records from IPI stream"),
Zachary Turner7df69952017-06-22 20:57:39 +0000329 cl::cat(TypeOptions), cl::sub(DumpSubcommand));
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000330cl::opt<bool>
Zachary Turner63055452017-06-15 22:24:24 +0000331 DumpIdData("id-data",
332 cl::desc("dump CodeView type record raw bytes from IPI stream"),
Zachary Turner7df69952017-06-22 20:57:39 +0000333 cl::cat(TypeOptions), cl::sub(DumpSubcommand));
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000334
Zachary Turnerf8a2e042017-06-15 23:04:42 +0000335cl::opt<bool> DumpIdExtras("id-extras",
336 cl::desc("dump id hashes and index offsets"),
Zachary Turner7df69952017-06-22 20:57:39 +0000337 cl::cat(TypeOptions), cl::sub(DumpSubcommand));
Zachary Turner59224cb2017-06-16 23:42:15 +0000338cl::list<uint32_t> DumpIdIndex(
339 "id-index", cl::ZeroOrMore,
340 cl::desc("only dump ids with the specified hexadecimal type index"),
Zachary Turner7df69952017-06-22 20:57:39 +0000341 cl::cat(TypeOptions), cl::sub(DumpSubcommand));
Zachary Turnerf8a2e042017-06-15 23:04:42 +0000342
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000343// SYMBOL OPTIONS
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000344cl::opt<bool> DumpPublics("publics", cl::desc("dump Publics stream data"),
Zachary Turner7df69952017-06-22 20:57:39 +0000345 cl::cat(SymbolOptions), cl::sub(DumpSubcommand));
Zachary Turner63055452017-06-15 22:24:24 +0000346cl::opt<bool> DumpSymbols("symbols", cl::desc("dump module symbols"),
Zachary Turner7df69952017-06-22 20:57:39 +0000347 cl::cat(SymbolOptions), cl::sub(DumpSubcommand));
Zachary Turner63055452017-06-15 22:24:24 +0000348
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000349cl::opt<bool>
Zachary Turner63055452017-06-15 22:24:24 +0000350 DumpSymRecordBytes("sym-data",
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000351 cl::desc("dump CodeView symbol record raw bytes"),
Zachary Turner7df69952017-06-22 20:57:39 +0000352 cl::cat(SymbolOptions), cl::sub(DumpSubcommand));
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000353
Zachary Turner63055452017-06-15 22:24:24 +0000354// MODULE & FILE OPTIONS
355cl::opt<bool> DumpModules("modules", cl::desc("dump compiland information"),
Zachary Turner7df69952017-06-22 20:57:39 +0000356 cl::cat(FileOptions), cl::sub(DumpSubcommand));
Zachary Turner63055452017-06-15 22:24:24 +0000357cl::opt<bool> DumpModuleFiles(
358 "files",
Zachary Turner4e950642017-06-15 23:56:19 +0000359 cl::desc("Dump the source files that contribute to each module's."),
Zachary Turner7df69952017-06-22 20:57:39 +0000360 cl::cat(FileOptions), cl::sub(DumpSubcommand));
Zachary Turner4e950642017-06-15 23:56:19 +0000361cl::opt<bool> DumpLines(
362 "l",
363 cl::desc("dump source file/line information (DEBUG_S_LINES subsection)"),
Zachary Turner7df69952017-06-22 20:57:39 +0000364 cl::cat(FileOptions), cl::sub(DumpSubcommand));
Zachary Turner4e950642017-06-15 23:56:19 +0000365cl::opt<bool> DumpInlineeLines(
366 "il",
367 cl::desc("dump inlinee line information (DEBUG_S_INLINEELINES subsection)"),
Zachary Turner7df69952017-06-22 20:57:39 +0000368 cl::cat(FileOptions), cl::sub(DumpSubcommand));
Zachary Turner47d9a562017-06-16 00:04:24 +0000369cl::opt<bool> DumpXmi(
370 "xmi",
371 cl::desc(
372 "dump cross module imports (DEBUG_S_CROSSSCOPEIMPORTS subsection)"),
Zachary Turner7df69952017-06-22 20:57:39 +0000373 cl::cat(FileOptions), cl::sub(DumpSubcommand));
Zachary Turner47d9a562017-06-16 00:04:24 +0000374cl::opt<bool> DumpXme(
375 "xme",
376 cl::desc(
377 "dump cross module exports (DEBUG_S_CROSSSCOPEEXPORTS subsection)"),
Zachary Turner7df69952017-06-22 20:57:39 +0000378 cl::cat(FileOptions), cl::sub(DumpSubcommand));
Zachary Turner63055452017-06-15 22:24:24 +0000379
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000380// MISCELLANEOUS OPTIONS
Zachary Turner760ad4d2017-01-20 22:42:09 +0000381cl::opt<bool> DumpStringTable("string-table", cl::desc("dump PDB String Table"),
Zachary Turner7df69952017-06-22 20:57:39 +0000382 cl::cat(MiscOptions), cl::sub(DumpSubcommand));
Zachary Turner760ad4d2017-01-20 22:42:09 +0000383
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000384cl::opt<bool> DumpSectionContribs("section-contribs",
385 cl::desc("dump section contributions"),
Zachary Turner7df69952017-06-22 20:57:39 +0000386 cl::cat(MiscOptions),
387 cl::sub(DumpSubcommand));
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000388cl::opt<bool> DumpSectionMap("section-map", cl::desc("dump section map"),
Zachary Turner7df69952017-06-22 20:57:39 +0000389 cl::cat(MiscOptions), cl::sub(DumpSubcommand));
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000390
Zachary Turnerab58ae82016-06-30 17:43:00 +0000391cl::opt<bool> RawAll("all", cl::desc("Implies most other options."),
Zachary Turner7df69952017-06-22 20:57:39 +0000392 cl::cat(MiscOptions), cl::sub(DumpSubcommand));
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000393
394cl::list<std::string> InputFilenames(cl::Positional,
395 cl::desc("<input PDB files>"),
Zachary Turner7df69952017-06-22 20:57:39 +0000396 cl::OneOrMore, cl::sub(DumpSubcommand));
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000397}
398
399namespace yaml2pdb {
400cl::opt<std::string>
401 YamlPdbOutputFile("pdb", cl::desc("the name of the PDB file to write"),
402 cl::sub(YamlToPdbSubcommand));
403
Bob Haarmande33a6372017-05-17 20:46:48 +0000404cl::opt<std::string> InputFilename(cl::Positional,
405 cl::desc("<input YAML file>"), cl::Required,
406 cl::sub(YamlToPdbSubcommand));
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000407}
408
409namespace pdb2yaml {
Bob Haarman69fd2b72017-05-26 23:46:20 +0000410cl::opt<bool> All("all",
411 cl::desc("Dump everything we know how to dump."),
412 cl::sub(PdbToYamlSubcommand), cl::init(false));
Zachary Turner3eedd162017-06-08 23:39:33 +0000413cl::opt<bool> NoFileHeaders("no-file-headers",
414 cl::desc("Do not dump MSF file headers"),
415 cl::sub(PdbToYamlSubcommand), cl::init(false));
Zachary Turnerea4e6072017-03-15 22:18:53 +0000416cl::opt<bool> Minimal("minimal",
417 cl::desc("Don't write fields with default values"),
418 cl::sub(PdbToYamlSubcommand), cl::init(false));
Zachary Turnerf6b93822016-07-11 21:45:09 +0000419
Zachary Turnerab58ae82016-06-30 17:43:00 +0000420cl::opt<bool> StreamMetadata(
421 "stream-metadata",
422 cl::desc("Dump the number of streams and each stream's size"),
Zachary Turnerf6b93822016-07-11 21:45:09 +0000423 cl::sub(PdbToYamlSubcommand), cl::init(false));
Zachary Turnerab58ae82016-06-30 17:43:00 +0000424cl::opt<bool> StreamDirectory(
425 "stream-directory",
426 cl::desc("Dump each stream's block map (implies -stream-metadata)"),
Zachary Turnerf6b93822016-07-11 21:45:09 +0000427 cl::sub(PdbToYamlSubcommand), cl::init(false));
Zachary Turnerfaa554b2016-07-15 22:16:56 +0000428cl::opt<bool> PdbStream("pdb-stream",
429 cl::desc("Dump the PDB Stream (Stream 1)"),
430 cl::sub(PdbToYamlSubcommand), cl::init(false));
Zachary Turner760ad4d2017-01-20 22:42:09 +0000431
432cl::opt<bool> StringTable("string-table", cl::desc("Dump the PDB String Table"),
433 cl::sub(PdbToYamlSubcommand), cl::init(false));
434
Zachary Turnerfaa554b2016-07-15 22:16:56 +0000435cl::opt<bool> DbiStream("dbi-stream",
Zachary Turner3eedd162017-06-08 23:39:33 +0000436 cl::desc("Dump the DBI Stream Headers (Stream 2)"),
Zachary Turnerfaa554b2016-07-15 22:16:56 +0000437 cl::sub(PdbToYamlSubcommand), cl::init(false));
Zachary Turneree3b9c22017-04-25 20:22:02 +0000438
Zachary Turnerac5763e2016-08-18 16:49:29 +0000439cl::opt<bool> TpiStream("tpi-stream",
440 cl::desc("Dump the TPI Stream (Stream 3)"),
441 cl::sub(PdbToYamlSubcommand), cl::init(false));
442
Zachary Turnerde9ba152016-09-15 18:22:31 +0000443cl::opt<bool> IpiStream("ipi-stream",
444 cl::desc("Dump the IPI Stream (Stream 5)"),
445 cl::sub(PdbToYamlSubcommand), cl::init(false));
446
Zachary Turner3eedd162017-06-08 23:39:33 +0000447// MODULE & FILE OPTIONS
448cl::opt<bool> DumpModules("modules", cl::desc("dump compiland information"),
Zachary Turner63055452017-06-15 22:24:24 +0000449 cl::cat(FileOptions), cl::sub(PdbToYamlSubcommand));
Zachary Turner3eedd162017-06-08 23:39:33 +0000450cl::opt<bool> DumpModuleFiles("module-files", cl::desc("dump file information"),
Zachary Turner63055452017-06-15 22:24:24 +0000451 cl::cat(FileOptions),
Zachary Turner3eedd162017-06-08 23:39:33 +0000452 cl::sub(PdbToYamlSubcommand));
453cl::list<ModuleSubsection> DumpModuleSubsections(
454 "subsections", cl::ZeroOrMore, cl::CommaSeparated,
455 cl::desc("dump subsections from each module's debug stream"),
456 cl::values(
457 clEnumValN(
458 ModuleSubsection::CrossScopeExports, "cme",
459 "Cross module exports (DEBUG_S_CROSSSCOPEEXPORTS subsection)"),
460 clEnumValN(
461 ModuleSubsection::CrossScopeImports, "cmi",
462 "Cross module imports (DEBUG_S_CROSSSCOPEIMPORTS subsection)"),
463 clEnumValN(ModuleSubsection::FileChecksums, "fc",
464 "File checksums (DEBUG_S_CHECKSUMS subsection)"),
465 clEnumValN(ModuleSubsection::InlineeLines, "ilines",
466 "Inlinee lines (DEBUG_S_INLINEELINES subsection)"),
467 clEnumValN(ModuleSubsection::Lines, "lines",
468 "Lines (DEBUG_S_LINES subsection)"),
Zachary Turnerdeb39132017-06-09 00:28:08 +0000469 clEnumValN(ModuleSubsection::StringTable, "strings",
470 "String Table (DEBUG_S_STRINGTABLE subsection) (not "
471 "typically present in PDB file)"),
472 clEnumValN(ModuleSubsection::FrameData, "frames",
473 "Frame Data (DEBUG_S_FRAMEDATA subsection)"),
474 clEnumValN(ModuleSubsection::Symbols, "symbols",
475 "Symbols (DEBUG_S_SYMBOLS subsection) (not typically "
476 "present in PDB file)"),
Zachary Turner3226fe92017-06-09 20:46:52 +0000477 clEnumValN(ModuleSubsection::CoffSymbolRVAs, "rvas",
478 "COFF Symbol RVAs (DEBUG_S_COFF_SYMBOL_RVA subsection)"),
Zachary Turner28c22c82017-06-09 00:53:59 +0000479 clEnumValN(ModuleSubsection::Unknown, "unknown",
480 "Any subsection not covered by another option"),
Zachary Turner3eedd162017-06-08 23:39:33 +0000481 clEnumValN(ModuleSubsection::All, "all", "All known subsections")),
Zachary Turner63055452017-06-15 22:24:24 +0000482 cl::cat(FileOptions), cl::sub(PdbToYamlSubcommand));
Zachary Turner3eedd162017-06-08 23:39:33 +0000483cl::opt<bool> DumpModuleSyms("module-syms", cl::desc("dump module symbols"),
Zachary Turner63055452017-06-15 22:24:24 +0000484 cl::cat(FileOptions),
Zachary Turner3eedd162017-06-08 23:39:33 +0000485 cl::sub(PdbToYamlSubcommand));
Zachary Turner63055452017-06-15 22:24:24 +0000486
487cl::list<std::string> InputFilename(cl::Positional,
488 cl::desc("<input PDB file>"), cl::Required,
489 cl::sub(PdbToYamlSubcommand));
490} // namespace pdb2yaml
Zachary Turner3eedd162017-06-08 23:39:33 +0000491
Zachary Turnerd50c0132017-02-01 18:30:22 +0000492namespace analyze {
493cl::opt<bool> StringTable("hash-collisions", cl::desc("Find hash collisions"),
494 cl::sub(AnalyzeSubcommand), cl::init(false));
495cl::list<std::string> InputFilename(cl::Positional,
496 cl::desc("<input PDB file>"), cl::Required,
497 cl::sub(AnalyzeSubcommand));
498}
Zachary Turner8fb441a2017-05-18 23:03:41 +0000499
500namespace merge {
501cl::list<std::string> InputFilenames(cl::Positional,
502 cl::desc("<input PDB files>"),
503 cl::OneOrMore, cl::sub(MergeSubcommand));
504cl::opt<std::string>
505 PdbOutputFile("pdb", cl::desc("the name of the PDB file to write"),
506 cl::sub(MergeSubcommand));
507}
Zachary Turner49693b42015-01-28 01:22:33 +0000508}
509
David Majnemerc165c882016-05-28 18:25:15 +0000510static ExitOnError ExitOnErr;
511
Zachary Turner1dc9fd32016-06-14 20:48:36 +0000512static void yamlToPdb(StringRef Path) {
Zachary Turnere109dc62016-07-22 19:56:26 +0000513 BumpPtrAllocator Allocator;
Zachary Turner1dc9fd32016-06-14 20:48:36 +0000514 ErrorOr<std::unique_ptr<MemoryBuffer>> ErrorOrBuffer =
515 MemoryBuffer::getFileOrSTDIN(Path, /*FileSize=*/-1,
516 /*RequiresNullTerminator=*/false);
517
518 if (ErrorOrBuffer.getError()) {
519 ExitOnErr(make_error<GenericError>(generic_error_code::invalid_path, Path));
520 }
521
522 std::unique_ptr<MemoryBuffer> &Buffer = ErrorOrBuffer.get();
523
524 llvm::yaml::Input In(Buffer->getBuffer());
Zachary Turnerc6d54da2016-09-09 17:46:17 +0000525 pdb::yaml::PdbObject YamlObj(Allocator);
Zachary Turner1dc9fd32016-06-14 20:48:36 +0000526 In >> YamlObj;
527
Zachary Turnere109dc62016-07-22 19:56:26 +0000528 PDBFileBuilder Builder(Allocator);
Zachary Turnerdbeaea72016-07-11 21:45:26 +0000529
Zachary Turnerea4e6072017-03-15 22:18:53 +0000530 uint32_t BlockSize = 4096;
531 if (YamlObj.Headers.hasValue())
532 BlockSize = YamlObj.Headers->SuperBlock.BlockSize;
533 ExitOnErr(Builder.initialize(BlockSize));
Zachary Turner620961d2016-09-14 23:00:02 +0000534 // Add each of the reserved streams. We ignore stream metadata in the
535 // yaml, because we will reconstruct our own view of the streams. For
536 // example, the YAML may say that there were 20 streams in the original
537 // PDB, but maybe we only dump a subset of those 20 streams, so we will
538 // have fewer, and the ones we do have may end up with different indices
539 // than the ones in the original PDB. So we just start with a clean slate.
540 for (uint32_t I = 0; I < kSpecialStreamCount; ++I)
541 ExitOnErr(Builder.getMsfBuilder().addStream(0));
Zachary Turner8848a7a2016-07-06 18:05:57 +0000542
Zachary Turnera8cfc292017-06-14 15:59:27 +0000543 StringsAndChecksums Strings;
544 Strings.setStrings(std::make_shared<DebugStringTableSubsection>());
545
Zachary Turner760ad4d2017-01-20 22:42:09 +0000546 if (YamlObj.StringTable.hasValue()) {
Zachary Turner760ad4d2017-01-20 22:42:09 +0000547 for (auto S : *YamlObj.StringTable)
Zachary Turnera8cfc292017-06-14 15:59:27 +0000548 Strings.strings()->insert(S);
Zachary Turner760ad4d2017-01-20 22:42:09 +0000549 }
550
Zachary Turnerea4e6072017-03-15 22:18:53 +0000551 pdb::yaml::PdbInfoStream DefaultInfoStream;
552 pdb::yaml::PdbDbiStream DefaultDbiStream;
553 pdb::yaml::PdbTpiStream DefaultTpiStream;
Zachary Turnerd4136e92017-05-22 21:07:43 +0000554 pdb::yaml::PdbTpiStream DefaultIpiStream;
Zachary Turner1dc9fd32016-06-14 20:48:36 +0000555
Zachary Turnerea4e6072017-03-15 22:18:53 +0000556 const auto &Info = YamlObj.PdbStream.getValueOr(DefaultInfoStream);
557
558 auto &InfoBuilder = Builder.getInfoBuilder();
559 InfoBuilder.setAge(Info.Age);
560 InfoBuilder.setGuid(Info.Guid);
561 InfoBuilder.setSignature(Info.Signature);
562 InfoBuilder.setVersion(Info.Version);
Zachary Turner05d5e612017-03-16 20:19:11 +0000563 for (auto F : Info.Features)
564 InfoBuilder.addFeature(F);
Zachary Turnerea4e6072017-03-15 22:18:53 +0000565
566 const auto &Dbi = YamlObj.DbiStream.getValueOr(DefaultDbiStream);
567 auto &DbiBuilder = Builder.getDbiBuilder();
568 DbiBuilder.setAge(Dbi.Age);
569 DbiBuilder.setBuildNumber(Dbi.BuildNumber);
570 DbiBuilder.setFlags(Dbi.Flags);
571 DbiBuilder.setMachineType(Dbi.MachineType);
572 DbiBuilder.setPdbDllRbld(Dbi.PdbDllRbld);
573 DbiBuilder.setPdbDllVersion(Dbi.PdbDllVersion);
574 DbiBuilder.setVersionHeader(Dbi.VerHeader);
575 for (const auto &MI : Dbi.ModInfos) {
Zachary Turner05d5e612017-03-16 20:19:11 +0000576 auto &ModiBuilder = ExitOnErr(DbiBuilder.addModuleInfo(MI.Mod));
Bob Haarmanea91faf2017-05-25 18:04:17 +0000577 ModiBuilder.setObjFileName(MI.Obj);
Zachary Turnerea4e6072017-03-15 22:18:53 +0000578
579 for (auto S : MI.SourceFiles)
580 ExitOnErr(DbiBuilder.addModuleSourceFile(MI.Mod, S));
581 if (MI.Modi.hasValue()) {
582 const auto &ModiStream = *MI.Modi;
Zachary Turnerebd3ae82017-06-01 21:52:41 +0000583 for (auto Symbol : ModiStream.Symbols) {
584 ModiBuilder.addSymbol(
585 Symbol.toCodeViewSymbol(Allocator, CodeViewContainer::Pdb));
586 }
Zachary Turnerd218c262016-07-22 15:46:37 +0000587 }
Zachary Turner8a2ebfb2017-05-01 23:27:42 +0000588
Zachary Turnera8cfc292017-06-14 15:59:27 +0000589 // Each module has its own checksum subsection, so scan for it every time.
590 Strings.setChecksums(nullptr);
591 CodeViewYAML::initializeStringsAndChecksums(MI.Subsections, Strings);
592
Zachary Turnerdeb39132017-06-09 00:28:08 +0000593 auto CodeViewSubsections = ExitOnErr(CodeViewYAML::toCodeViewSubsectionList(
594 Allocator, MI.Subsections, Strings));
Zachary Turner92dcdda2017-06-02 19:49:14 +0000595 for (auto &SS : CodeViewSubsections) {
Zachary Turnera8cfc292017-06-14 15:59:27 +0000596 ModiBuilder.addDebugSubsection(SS);
Zachary Turner8a2ebfb2017-05-01 23:27:42 +0000597 }
Zachary Turnerdbeaea72016-07-11 21:45:26 +0000598 }
599
Zachary Turnerea4e6072017-03-15 22:18:53 +0000600 auto &TpiBuilder = Builder.getTpiBuilder();
601 const auto &Tpi = YamlObj.TpiStream.getValueOr(DefaultTpiStream);
602 TpiBuilder.setVersionHeader(Tpi.Version);
Zachary Turnerd4273832017-05-30 21:53:05 +0000603 for (const auto &R : Tpi.Records) {
604 CVType Type = R.toCodeViewRecord(Allocator);
605 TpiBuilder.addTypeRecord(Type.RecordData, None);
606 }
Zachary Turnerc6d54da2016-09-09 17:46:17 +0000607
Zachary Turnerd4136e92017-05-22 21:07:43 +0000608 const auto &Ipi = YamlObj.IpiStream.getValueOr(DefaultIpiStream);
Zachary Turnerea4e6072017-03-15 22:18:53 +0000609 auto &IpiBuilder = Builder.getIpiBuilder();
610 IpiBuilder.setVersionHeader(Ipi.Version);
Zachary Turnerd4273832017-05-30 21:53:05 +0000611 for (const auto &R : Ipi.Records) {
612 CVType Type = R.toCodeViewRecord(Allocator);
613 IpiBuilder.addTypeRecord(Type.RecordData, None);
614 }
Zachary Turnerde9ba152016-09-15 18:22:31 +0000615
Zachary Turnera8cfc292017-06-14 15:59:27 +0000616 Builder.getStringTableBuilder().setStrings(*Strings.strings());
617
Rui Ueyamafc22cef2016-09-30 20:34:44 +0000618 ExitOnErr(Builder.commit(opts::yaml2pdb::YamlPdbOutputFile));
Zachary Turner1dc9fd32016-06-14 20:48:36 +0000619}
620
Zachary Turner6ac232c2017-03-13 23:28:25 +0000621static PDBFile &loadPDB(StringRef Path, std::unique_ptr<IPDBSession> &Session) {
Adrian McCarthy8f713192017-01-27 00:01:55 +0000622 ExitOnErr(loadDataForPDB(PDB_ReaderType::Native, Path, Session));
Zachary Turner8848a7a2016-07-06 18:05:57 +0000623
Zachary Turner6ac232c2017-03-13 23:28:25 +0000624 NativeSession *NS = static_cast<NativeSession *>(Session.get());
625 return NS->getPDBFile();
626}
627
628static void pdb2Yaml(StringRef Path) {
629 std::unique_ptr<IPDBSession> Session;
630 auto &File = loadPDB(Path, Session);
631
Zachary Turner8848a7a2016-07-06 18:05:57 +0000632 auto O = llvm::make_unique<YAMLOutputStyle>(File);
633 O = llvm::make_unique<YAMLOutputStyle>(File);
634
635 ExitOnErr(O->dump());
636}
637
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000638static void dumpRaw(StringRef Path) {
David Majnemer1573b242016-04-28 23:47:27 +0000639 std::unique_ptr<IPDBSession> Session;
Zachary Turner6ac232c2017-03-13 23:28:25 +0000640 auto &File = loadPDB(Path, Session);
David Majnemer1573b242016-04-28 23:47:27 +0000641
Zachary Turner7df69952017-06-22 20:57:39 +0000642 auto O = llvm::make_unique<DumpOutputStyle>(File);
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000643
644 ExitOnErr(O->dump());
645}
646
Zachary Turner99402032017-06-22 20:58:11 +0000647static void dumpBytes(StringRef Path) {
648 std::unique_ptr<IPDBSession> Session;
649 auto &File = loadPDB(Path, Session);
650
651 auto O = llvm::make_unique<BytesOutputStyle>(File);
652
653 ExitOnErr(O->dump());
654}
655
Zachary Turnerd50c0132017-02-01 18:30:22 +0000656static void dumpAnalysis(StringRef Path) {
657 std::unique_ptr<IPDBSession> Session;
Zachary Turner6ac232c2017-03-13 23:28:25 +0000658 auto &File = loadPDB(Path, Session);
Zachary Turnerd50c0132017-02-01 18:30:22 +0000659 auto O = llvm::make_unique<AnalysisStyle>(File);
660
661 ExitOnErr(O->dump());
662}
663
Zachary Turner6ac232c2017-03-13 23:28:25 +0000664static void diff(StringRef Path1, StringRef Path2) {
665 std::unique_ptr<IPDBSession> Session1;
666 std::unique_ptr<IPDBSession> Session2;
667
668 auto &File1 = loadPDB(Path1, Session1);
669 auto &File2 = loadPDB(Path2, Session2);
670
671 auto O = llvm::make_unique<DiffStyle>(File1, File2);
672
673 ExitOnErr(O->dump());
674}
675
Zachary Turner0683be22017-05-14 01:13:40 +0000676bool opts::pretty::shouldDumpSymLevel(SymLevel Search) {
677 if (SymTypes.empty())
678 return true;
679 if (llvm::find(SymTypes, Search) != SymTypes.end())
680 return true;
681 if (llvm::find(SymTypes, SymLevel::All) != SymTypes.end())
682 return true;
683 return false;
684}
685
686uint32_t llvm::pdb::getTypeLength(const PDBSymbolData &Symbol) {
687 auto SymbolType = Symbol.getType();
688 const IPDBRawSymbol &RawType = SymbolType->getRawSymbol();
689
690 return RawType.getLength();
691}
692
693bool opts::pretty::compareFunctionSymbols(
694 const std::unique_ptr<PDBSymbolFunc> &F1,
695 const std::unique_ptr<PDBSymbolFunc> &F2) {
696 assert(opts::pretty::SymbolOrder != opts::pretty::SymbolSortMode::None);
697
698 if (opts::pretty::SymbolOrder == opts::pretty::SymbolSortMode::Name)
699 return F1->getName() < F2->getName();
700
701 // Note that we intentionally sort in descending order on length, since
702 // long functions are more interesting than short functions.
703 return F1->getLength() > F2->getLength();
704}
705
706bool opts::pretty::compareDataSymbols(
707 const std::unique_ptr<PDBSymbolData> &F1,
708 const std::unique_ptr<PDBSymbolData> &F2) {
709 assert(opts::pretty::SymbolOrder != opts::pretty::SymbolSortMode::None);
710
711 if (opts::pretty::SymbolOrder == opts::pretty::SymbolSortMode::Name)
712 return F1->getName() < F2->getName();
713
714 // Note that we intentionally sort in descending order on length, since
715 // large types are more interesting than short ones.
716 return getTypeLength(*F1) > getTypeLength(*F2);
717}
718
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000719static void dumpPretty(StringRef Path) {
720 std::unique_ptr<IPDBSession> Session;
David Majnemer1573b242016-04-28 23:47:27 +0000721
Adrian McCarthy65d26882017-03-15 20:17:58 +0000722 const auto ReaderType =
723 opts::pretty::Native ? PDB_ReaderType::Native : PDB_ReaderType::DIA;
724 ExitOnErr(loadDataForPDB(ReaderType, Path, Session));
David Majnemer1573b242016-04-28 23:47:27 +0000725
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000726 if (opts::pretty::LoadAddress)
727 Session->setLoadAddress(opts::pretty::LoadAddress);
Zachary Turner7058dfc2015-01-27 22:40:14 +0000728
Adrian McCarthy1aa207d2017-03-23 15:28:15 +0000729 auto &Stream = outs();
730 const bool UseColor = opts::pretty::ColorOutput == cl::BOU_UNSET
731 ? Stream.has_colors()
732 : opts::pretty::ColorOutput == cl::BOU_TRUE;
733 LinePrinter Printer(2, UseColor, Stream);
Zachary Turner2d11c202015-02-27 09:15:59 +0000734
Zachary Turnera5549172015-02-10 22:43:25 +0000735 auto GlobalScope(Session->getGlobalScope());
Zachary Turner9a818ad2015-02-22 22:03:38 +0000736 std::string FileName(GlobalScope->getSymbolsFileName());
737
Zachary Turner2d11c202015-02-27 09:15:59 +0000738 WithColor(Printer, PDB_ColorItem::None).get() << "Summary for ";
739 WithColor(Printer, PDB_ColorItem::Path).get() << FileName;
740 Printer.Indent();
Zachary Turner9a818ad2015-02-22 22:03:38 +0000741 uint64_t FileSize = 0;
Zachary Turner9a818ad2015-02-22 22:03:38 +0000742
Zachary Turner2d11c202015-02-27 09:15:59 +0000743 Printer.NewLine();
744 WithColor(Printer, PDB_ColorItem::Identifier).get() << "Size";
David Majnemer6e081262015-10-15 01:27:19 +0000745 if (!sys::fs::file_size(FileName, FileSize)) {
Zachary Turner2d11c202015-02-27 09:15:59 +0000746 Printer << ": " << FileSize << " bytes";
747 } else {
748 Printer << ": (Unable to obtain file size)";
749 }
750
751 Printer.NewLine();
752 WithColor(Printer, PDB_ColorItem::Identifier).get() << "Guid";
753 Printer << ": " << GlobalScope->getGuid();
754
755 Printer.NewLine();
756 WithColor(Printer, PDB_ColorItem::Identifier).get() << "Age";
757 Printer << ": " << GlobalScope->getAge();
758
759 Printer.NewLine();
760 WithColor(Printer, PDB_ColorItem::Identifier).get() << "Attributes";
761 Printer << ": ";
Zachary Turner9a818ad2015-02-22 22:03:38 +0000762 if (GlobalScope->hasCTypes())
763 outs() << "HasCTypes ";
764 if (GlobalScope->hasPrivateSymbols())
765 outs() << "HasPrivateSymbols ";
Zachary Turner2d11c202015-02-27 09:15:59 +0000766 Printer.Unindent();
Zachary Turner9a818ad2015-02-22 22:03:38 +0000767
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000768 if (opts::pretty::Compilands) {
Zachary Turner2d11c202015-02-27 09:15:59 +0000769 Printer.NewLine();
770 WithColor(Printer, PDB_ColorItem::SectionHeader).get()
771 << "---COMPILANDS---";
772 Printer.Indent();
Zachary Turnerc074de02015-02-12 21:09:24 +0000773 auto Compilands = GlobalScope->findAllChildren<PDBSymbolCompiland>();
Zachary Turner2d11c202015-02-27 09:15:59 +0000774 CompilandDumper Dumper(Printer);
Zachary Turnera99000d2016-03-08 21:42:24 +0000775 CompilandDumpFlags options = CompilandDumper::Flags::None;
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000776 if (opts::pretty::Lines)
Zachary Turnera99000d2016-03-08 21:42:24 +0000777 options = options | CompilandDumper::Flags::Lines;
Zachary Turner9a818ad2015-02-22 22:03:38 +0000778 while (auto Compiland = Compilands->getNext())
Zachary Turnera99000d2016-03-08 21:42:24 +0000779 Dumper.start(*Compiland, options);
Zachary Turner2d11c202015-02-27 09:15:59 +0000780 Printer.Unindent();
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000781 }
782
Zachary Turner63230a4e2017-04-06 23:43:12 +0000783 if (opts::pretty::Classes || opts::pretty::Enums || opts::pretty::Typedefs) {
Zachary Turner2d11c202015-02-27 09:15:59 +0000784 Printer.NewLine();
785 WithColor(Printer, PDB_ColorItem::SectionHeader).get() << "---TYPES---";
786 Printer.Indent();
Zachary Turner65323652015-03-04 06:09:53 +0000787 TypeDumper Dumper(Printer);
Zachary Turnerb52d08d2015-03-01 06:51:29 +0000788 Dumper.start(*GlobalScope);
Zachary Turner2d11c202015-02-27 09:15:59 +0000789 Printer.Unindent();
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000790 }
791
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000792 if (opts::pretty::Symbols) {
Zachary Turner2d11c202015-02-27 09:15:59 +0000793 Printer.NewLine();
794 WithColor(Printer, PDB_ColorItem::SectionHeader).get() << "---SYMBOLS---";
795 Printer.Indent();
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000796 auto Compilands = GlobalScope->findAllChildren<PDBSymbolCompiland>();
Zachary Turner2d11c202015-02-27 09:15:59 +0000797 CompilandDumper Dumper(Printer);
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000798 while (auto Compiland = Compilands->getNext())
Zachary Turnerb52d08d2015-03-01 06:51:29 +0000799 Dumper.start(*Compiland, true);
Zachary Turner2d11c202015-02-27 09:15:59 +0000800 Printer.Unindent();
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000801 }
802
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000803 if (opts::pretty::Globals) {
Zachary Turner2d11c202015-02-27 09:15:59 +0000804 Printer.NewLine();
805 WithColor(Printer, PDB_ColorItem::SectionHeader).get() << "---GLOBALS---";
806 Printer.Indent();
Zachary Turner0683be22017-05-14 01:13:40 +0000807 if (shouldDumpSymLevel(opts::pretty::SymLevel::Functions)) {
Zachary Turner2d11c202015-02-27 09:15:59 +0000808 FunctionDumper Dumper(Printer);
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000809 auto Functions = GlobalScope->findAllChildren<PDBSymbolFunc>();
Zachary Turner0683be22017-05-14 01:13:40 +0000810 if (opts::pretty::SymbolOrder == opts::pretty::SymbolSortMode::None) {
811 while (auto Function = Functions->getNext()) {
812 Printer.NewLine();
813 Dumper.start(*Function, FunctionDumper::PointerType::None);
814 }
815 } else {
816 std::vector<std::unique_ptr<PDBSymbolFunc>> Funcs;
817 while (auto Func = Functions->getNext())
818 Funcs.push_back(std::move(Func));
819 std::sort(Funcs.begin(), Funcs.end(),
820 opts::pretty::compareFunctionSymbols);
821 for (const auto &Func : Funcs) {
822 Printer.NewLine();
823 Dumper.start(*Func, FunctionDumper::PointerType::None);
824 }
Zachary Turner2d11c202015-02-27 09:15:59 +0000825 }
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000826 }
Zachary Turner0683be22017-05-14 01:13:40 +0000827 if (shouldDumpSymLevel(opts::pretty::SymLevel::Data)) {
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000828 auto Vars = GlobalScope->findAllChildren<PDBSymbolData>();
Zachary Turner2d11c202015-02-27 09:15:59 +0000829 VariableDumper Dumper(Printer);
Zachary Turner0683be22017-05-14 01:13:40 +0000830 if (opts::pretty::SymbolOrder == opts::pretty::SymbolSortMode::None) {
831 while (auto Var = Vars->getNext())
832 Dumper.start(*Var);
833 } else {
834 std::vector<std::unique_ptr<PDBSymbolData>> Datas;
835 while (auto Var = Vars->getNext())
836 Datas.push_back(std::move(Var));
837 std::sort(Datas.begin(), Datas.end(), opts::pretty::compareDataSymbols);
838 for (const auto &Var : Datas)
839 Dumper.start(*Var);
840 }
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000841 }
Zachary Turner0683be22017-05-14 01:13:40 +0000842 if (shouldDumpSymLevel(opts::pretty::SymLevel::Thunks)) {
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000843 auto Thunks = GlobalScope->findAllChildren<PDBSymbolThunk>();
Zachary Turner2d11c202015-02-27 09:15:59 +0000844 CompilandDumper Dumper(Printer);
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000845 while (auto Thunk = Thunks->getNext())
Zachary Turnerb52d08d2015-03-01 06:51:29 +0000846 Dumper.dump(*Thunk);
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000847 }
Zachary Turner2d11c202015-02-27 09:15:59 +0000848 Printer.Unindent();
Zachary Turner7058dfc2015-01-27 22:40:14 +0000849 }
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000850 if (opts::pretty::Externals) {
Zachary Turnere5cb2692015-05-01 20:24:26 +0000851 Printer.NewLine();
852 WithColor(Printer, PDB_ColorItem::SectionHeader).get() << "---EXTERNALS---";
853 Printer.Indent();
854 ExternalSymbolDumper Dumper(Printer);
855 Dumper.start(*GlobalScope);
856 }
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000857 if (opts::pretty::Lines) {
Zachary Turnera99000d2016-03-08 21:42:24 +0000858 Printer.NewLine();
859 }
Zachary Turnera5549172015-02-10 22:43:25 +0000860 outs().flush();
Zachary Turnerfcb14ad2015-01-27 20:46:21 +0000861}
862
Zachary Turner8fb441a2017-05-18 23:03:41 +0000863static void mergePdbs() {
864 BumpPtrAllocator Allocator;
865 TypeTableBuilder MergedTpi(Allocator);
866 TypeTableBuilder MergedIpi(Allocator);
867
868 // Create a Tpi and Ipi type table with all types from all input files.
869 for (const auto &Path : opts::merge::InputFilenames) {
870 std::unique_ptr<IPDBSession> Session;
871 auto &File = loadPDB(Path, Session);
Zachary Turnerd4136e92017-05-22 21:07:43 +0000872 SmallVector<TypeIndex, 128> TypeMap;
873 SmallVector<TypeIndex, 128> IdMap;
Zachary Turner8fb441a2017-05-18 23:03:41 +0000874 if (File.hasPDBTpiStream()) {
875 auto &Tpi = ExitOnErr(File.getPDBTpiStream());
Zachary Turnerd4136e92017-05-22 21:07:43 +0000876 ExitOnErr(codeview::mergeTypeRecords(MergedTpi, TypeMap, nullptr,
Zachary Turnercfd80652017-05-24 00:35:32 +0000877 Tpi.typeArray()));
Zachary Turner8fb441a2017-05-18 23:03:41 +0000878 }
879 if (File.hasPDBIpiStream()) {
880 auto &Ipi = ExitOnErr(File.getPDBIpiStream());
Zachary Turnerd4136e92017-05-22 21:07:43 +0000881 ExitOnErr(codeview::mergeIdRecords(MergedIpi, TypeMap, IdMap,
Zachary Turnercfd80652017-05-24 00:35:32 +0000882 Ipi.typeArray()));
Zachary Turner8fb441a2017-05-18 23:03:41 +0000883 }
884 }
885
886 // Then write the PDB.
887 PDBFileBuilder Builder(Allocator);
888 ExitOnErr(Builder.initialize(4096));
889 // Add each of the reserved streams. We might not put any data in them,
890 // but at least they have to be present.
891 for (uint32_t I = 0; I < kSpecialStreamCount; ++I)
892 ExitOnErr(Builder.getMsfBuilder().addStream(0));
893
894 auto &DestTpi = Builder.getTpiBuilder();
895 auto &DestIpi = Builder.getIpiBuilder();
Reid Klecknerded38802017-05-23 18:23:59 +0000896 MergedTpi.ForEachRecord([&DestTpi](TypeIndex TI, ArrayRef<uint8_t> Data) {
897 DestTpi.addTypeRecord(Data, None);
898 });
899 MergedIpi.ForEachRecord([&DestIpi](TypeIndex TI, ArrayRef<uint8_t> Data) {
900 DestIpi.addTypeRecord(Data, None);
901 });
Zachary Turner990d0c82017-06-12 21:34:53 +0000902 Builder.getInfoBuilder().addFeature(PdbRaw_FeatureSig::VC140);
Zachary Turner8fb441a2017-05-18 23:03:41 +0000903
Zachary Turnerbdc16ed2017-05-19 06:25:09 +0000904 SmallString<64> OutFile(opts::merge::PdbOutputFile);
Zachary Turner8fb441a2017-05-18 23:03:41 +0000905 if (OutFile.empty()) {
906 OutFile = opts::merge::InputFilenames[0];
907 llvm::sys::path::replace_extension(OutFile, "merged.pdb");
908 }
909 ExitOnErr(Builder.commit(OutFile));
910}
911
Zachary Turner6b124f22017-06-23 19:54:44 +0000912static bool parseRange(StringRef Str,
913 Optional<opts::bytes::NumberRange> &Parsed) {
914 if (Str.empty())
Zachary Turner99402032017-06-22 20:58:11 +0000915 return true;
916
917 llvm::Regex R("^([^-]+)(-([^-]+))?$");
918 llvm::SmallVector<llvm::StringRef, 2> Matches;
Zachary Turner6b124f22017-06-23 19:54:44 +0000919 if (!R.match(Str, &Matches))
Zachary Turner99402032017-06-22 20:58:11 +0000920 return false;
921
Zachary Turner6b124f22017-06-23 19:54:44 +0000922 Parsed.emplace();
923 if (!to_integer(Matches[1], Parsed->Min))
Zachary Turner99402032017-06-22 20:58:11 +0000924 return false;
925
926 if (!Matches[3].empty()) {
Zachary Turner6b124f22017-06-23 19:54:44 +0000927 Parsed->Max.emplace();
928 if (!to_integer(Matches[3], *Parsed->Max))
Zachary Turner99402032017-06-22 20:58:11 +0000929 return false;
930 }
931 return true;
932}
933
Zachary Turnerfcb14ad2015-01-27 20:46:21 +0000934int main(int argc_, const char *argv_[]) {
935 // Print a stack trace if we signal out.
Richard Smith2ad6d482016-06-09 00:53:21 +0000936 sys::PrintStackTraceOnErrorSignal(argv_[0]);
Zachary Turnerfcb14ad2015-01-27 20:46:21 +0000937 PrettyStackTraceProgram X(argc_, argv_);
938
Zachary Turnerbd336e42017-06-09 20:46:17 +0000939 ExitOnErr.setBanner("llvm-pdbutil: ");
David Majnemerc165c882016-05-28 18:25:15 +0000940
Zachary Turnerfcb14ad2015-01-27 20:46:21 +0000941 SmallVector<const char *, 256> argv;
David Majnemer6e081262015-10-15 01:27:19 +0000942 SpecificBumpPtrAllocator<char> ArgAllocator;
David Majnemerc165c882016-05-28 18:25:15 +0000943 ExitOnErr(errorCodeToError(sys::Process::GetArgumentVector(
944 argv, makeArrayRef(argv_, argc_), ArgAllocator)));
Zachary Turnerfcb14ad2015-01-27 20:46:21 +0000945
946 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
947
948 cl::ParseCommandLineOptions(argv.size(), argv.data(), "LLVM PDB Dumper\n");
Zachary Turner6b124f22017-06-23 19:54:44 +0000949
950 if (opts::BytesSubcommand) {
951 if (!parseRange(opts::bytes::DumpBlockRangeOpt,
952 opts::bytes::DumpBlockRange)) {
953 errs() << "Argument '" << opts::bytes::DumpBlockRangeOpt
954 << "' invalid format.\n";
955 errs().flush();
956 exit(1);
957 }
958 if (!parseRange(opts::bytes::DumpByteRangeOpt,
959 opts::bytes::DumpByteRange)) {
960 errs() << "Argument '" << opts::bytes::DumpByteRangeOpt
961 << "' invalid format.\n";
962 errs().flush();
963 exit(1);
964 }
Zachary Turner72c5b642016-09-09 18:17:52 +0000965 }
Zachary Turnera99000d2016-03-08 21:42:24 +0000966
Zachary Turner7df69952017-06-22 20:57:39 +0000967 if (opts::DumpSubcommand) {
968 if (opts::dump::RawAll) {
969 opts::dump::DumpLines = true;
970 opts::dump::DumpInlineeLines = true;
971 opts::dump::DumpXme = true;
972 opts::dump::DumpXmi = true;
973 opts::dump::DumpIds = true;
974 opts::dump::DumpPublics = true;
975 opts::dump::DumpSectionContribs = true;
976 opts::dump::DumpSectionMap = true;
977 opts::dump::DumpStreams = true;
978 opts::dump::DumpStringTable = true;
979 opts::dump::DumpSummary = true;
980 opts::dump::DumpSymbols = true;
981 opts::dump::DumpIds = true;
982 opts::dump::DumpIdExtras = true;
983 opts::dump::DumpTypes = true;
984 opts::dump::DumpTypeExtras = true;
985 opts::dump::DumpModules = true;
986 opts::dump::DumpModuleFiles = true;
Zachary Turner44a643c2017-01-12 22:28:15 +0000987 }
Zachary Turner7797c722015-03-02 04:39:56 +0000988 }
Zachary Turner3eedd162017-06-08 23:39:33 +0000989 if (opts::PdbToYamlSubcommand) {
990 if (opts::pdb2yaml::All) {
991 opts::pdb2yaml::StreamMetadata = true;
992 opts::pdb2yaml::StreamDirectory = true;
993 opts::pdb2yaml::PdbStream = true;
994 opts::pdb2yaml::StringTable = true;
995 opts::pdb2yaml::DbiStream = true;
996 opts::pdb2yaml::TpiStream = true;
997 opts::pdb2yaml::IpiStream = true;
Zachary Turner63055452017-06-15 22:24:24 +0000998 opts::pdb2yaml::DumpModules = true;
999 opts::pdb2yaml::DumpModuleFiles = true;
1000 opts::pdb2yaml::DumpModuleSyms = true;
1001 opts::pdb2yaml::DumpModuleSubsections.push_back(
1002 opts::ModuleSubsection::All);
1003 if (llvm::is_contained(opts::pdb2yaml::DumpModuleSubsections,
1004 opts::ModuleSubsection::All)) {
1005 opts::pdb2yaml::DumpModuleSubsections.reset();
1006 opts::pdb2yaml::DumpModuleSubsections.push_back(
1007 opts::ModuleSubsection::All);
1008 }
Zachary Turner3eedd162017-06-08 23:39:33 +00001009 }
Zachary Turner63055452017-06-15 22:24:24 +00001010
1011 if (opts::pdb2yaml::DumpModuleSyms || opts::pdb2yaml::DumpModuleFiles)
1012 opts::pdb2yaml::DumpModules = true;
1013
1014 if (opts::pdb2yaml::DumpModules)
1015 opts::pdb2yaml::DbiStream = true;
Zachary Turner3eedd162017-06-08 23:39:33 +00001016 }
Zachary Turnerfcb14ad2015-01-27 20:46:21 +00001017
Zachary Turner93839cb2016-06-02 05:07:49 +00001018 llvm::sys::InitializeCOMRAII COM(llvm::sys::COMThreadingMode::MultiThreaded);
Zachary Turnerfcb14ad2015-01-27 20:46:21 +00001019
Zachary Turnera30bd1a2016-06-30 17:42:48 +00001020 if (opts::PdbToYamlSubcommand) {
Zachary Turner8848a7a2016-07-06 18:05:57 +00001021 pdb2Yaml(opts::pdb2yaml::InputFilename.front());
Zachary Turnera30bd1a2016-06-30 17:42:48 +00001022 } else if (opts::YamlToPdbSubcommand) {
Bob Haarmande33a6372017-05-17 20:46:48 +00001023 if (opts::yaml2pdb::YamlPdbOutputFile.empty()) {
1024 SmallString<16> OutputFilename(opts::yaml2pdb::InputFilename.getValue());
1025 sys::path::replace_extension(OutputFilename, ".pdb");
1026 opts::yaml2pdb::YamlPdbOutputFile = OutputFilename.str();
1027 }
1028 yamlToPdb(opts::yaml2pdb::InputFilename);
Zachary Turnerd50c0132017-02-01 18:30:22 +00001029 } else if (opts::AnalyzeSubcommand) {
1030 dumpAnalysis(opts::analyze::InputFilename.front());
Zachary Turnera30bd1a2016-06-30 17:42:48 +00001031 } else if (opts::PrettySubcommand) {
1032 if (opts::pretty::Lines)
1033 opts::pretty::Compilands = true;
1034
1035 if (opts::pretty::All) {
1036 opts::pretty::Compilands = true;
1037 opts::pretty::Symbols = true;
1038 opts::pretty::Globals = true;
1039 opts::pretty::Types = true;
1040 opts::pretty::Externals = true;
1041 opts::pretty::Lines = true;
1042 }
1043
Zachary Turner63230a4e2017-04-06 23:43:12 +00001044 if (opts::pretty::Types) {
1045 opts::pretty::Classes = true;
1046 opts::pretty::Typedefs = true;
1047 opts::pretty::Enums = true;
1048 }
1049
Zachary Turnera30bd1a2016-06-30 17:42:48 +00001050 // When adding filters for excluded compilands and types, we need to
Zachary Turner72c5b642016-09-09 18:17:52 +00001051 // remember that these are regexes. So special characters such as * and \
1052 // need to be escaped in the regex. In the case of a literal \, this means
1053 // it needs to be escaped again in the C++. So matching a single \ in the
1054 // input requires 4 \es in the C++.
Zachary Turnera30bd1a2016-06-30 17:42:48 +00001055 if (opts::pretty::ExcludeCompilerGenerated) {
1056 opts::pretty::ExcludeTypes.push_back("__vc_attributes");
1057 opts::pretty::ExcludeCompilands.push_back("\\* Linker \\*");
1058 }
1059 if (opts::pretty::ExcludeSystemLibraries) {
1060 opts::pretty::ExcludeCompilands.push_back(
1061 "f:\\\\binaries\\\\Intermediate\\\\vctools\\\\crt_bld");
1062 opts::pretty::ExcludeCompilands.push_back("f:\\\\dd\\\\vctools\\\\crt");
1063 opts::pretty::ExcludeCompilands.push_back(
1064 "d:\\\\th.obj.x86fre\\\\minkernel");
1065 }
1066 std::for_each(opts::pretty::InputFilenames.begin(),
1067 opts::pretty::InputFilenames.end(), dumpPretty);
Zachary Turner7df69952017-06-22 20:57:39 +00001068 } else if (opts::DumpSubcommand) {
1069 std::for_each(opts::dump::InputFilenames.begin(),
1070 opts::dump::InputFilenames.end(), dumpRaw);
Zachary Turner99402032017-06-22 20:58:11 +00001071 } else if (opts::BytesSubcommand) {
1072 std::for_each(opts::bytes::InputFilenames.begin(),
1073 opts::bytes::InputFilenames.end(), dumpBytes);
Zachary Turner6ac232c2017-03-13 23:28:25 +00001074 } else if (opts::DiffSubcommand) {
1075 if (opts::diff::InputFilenames.size() != 2) {
1076 errs() << "diff subcommand expects exactly 2 arguments.\n";
1077 exit(1);
1078 }
1079 diff(opts::diff::InputFilenames[0], opts::diff::InputFilenames[1]);
Zachary Turner8fb441a2017-05-18 23:03:41 +00001080 } else if (opts::MergeSubcommand) {
1081 if (opts::merge::InputFilenames.size() < 2) {
1082 errs() << "merge subcommand requires at least 2 input files.\n";
1083 exit(1);
1084 }
1085 mergePdbs();
Zachary Turner1dc9fd32016-06-14 20:48:36 +00001086 }
Zachary Turnerfcb14ad2015-01-27 20:46:21 +00001087
Zachary Turner819e77d2016-05-06 20:51:57 +00001088 outs().flush();
Zachary Turnerfcb14ad2015-01-27 20:46:21 +00001089 return 0;
1090}