blob: f3bfa8f7b35354ced66f27ea7ecf8bcd691a8224 [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
Zachary Turnere79b07e2017-06-26 17:22:36 +0000117cl::ValuesClass ChunkValues = cl::values(
118 clEnumValN(ModuleSubsection::CrossScopeExports, "cme",
119 "Cross module exports (DEBUG_S_CROSSSCOPEEXPORTS subsection)"),
120 clEnumValN(ModuleSubsection::CrossScopeImports, "cmi",
121 "Cross module imports (DEBUG_S_CROSSSCOPEIMPORTS subsection)"),
122 clEnumValN(ModuleSubsection::FileChecksums, "fc",
123 "File checksums (DEBUG_S_CHECKSUMS subsection)"),
124 clEnumValN(ModuleSubsection::InlineeLines, "ilines",
125 "Inlinee lines (DEBUG_S_INLINEELINES subsection)"),
126 clEnumValN(ModuleSubsection::Lines, "lines",
127 "Lines (DEBUG_S_LINES subsection)"),
128 clEnumValN(ModuleSubsection::StringTable, "strings",
129 "String Table (DEBUG_S_STRINGTABLE subsection) (not "
130 "typically present in PDB file)"),
131 clEnumValN(ModuleSubsection::FrameData, "frames",
132 "Frame Data (DEBUG_S_FRAMEDATA subsection)"),
133 clEnumValN(ModuleSubsection::Symbols, "symbols",
134 "Symbols (DEBUG_S_SYMBOLS subsection) (not typically "
135 "present in PDB file)"),
136 clEnumValN(ModuleSubsection::CoffSymbolRVAs, "rvas",
137 "COFF Symbol RVAs (DEBUG_S_COFF_SYMBOL_RVA subsection)"),
138 clEnumValN(ModuleSubsection::Unknown, "unknown",
139 "Any subsection not covered by another option"),
140 clEnumValN(ModuleSubsection::All, "all", "All known subsections"));
141
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000142namespace pretty {
143cl::list<std::string> InputFilenames(cl::Positional,
144 cl::desc("<input PDB files>"),
145 cl::OneOrMore, cl::sub(PrettySubcommand));
Zachary Turner7797c722015-03-02 04:39:56 +0000146
147cl::opt<bool> Compilands("compilands", cl::desc("Display compilands"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000148 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
Zachary Turner0683be22017-05-14 01:13:40 +0000149cl::opt<bool> Symbols("module-syms",
150 cl::desc("Display symbols for each compiland"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000151 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
Zachary Turner7797c722015-03-02 04:39:56 +0000152cl::opt<bool> Globals("globals", cl::desc("Dump global symbols"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000153 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
Zachary Turnere5cb2692015-05-01 20:24:26 +0000154cl::opt<bool> Externals("externals", cl::desc("Dump external symbols"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000155 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
Zachary Turner0683be22017-05-14 01:13:40 +0000156cl::list<SymLevel> SymTypes(
157 "sym-types", cl::desc("Type of symbols to dump (default all)"),
158 cl::cat(TypeCategory), cl::sub(PrettySubcommand), cl::ZeroOrMore,
159 cl::values(
160 clEnumValN(SymLevel::Thunks, "thunks", "Display thunk symbols"),
161 clEnumValN(SymLevel::Data, "data", "Display data symbols"),
162 clEnumValN(SymLevel::Functions, "funcs", "Display function symbols"),
163 clEnumValN(SymLevel::All, "all", "Display all symbols (default)")));
164
Zachary Turner63230a4e2017-04-06 23:43:12 +0000165cl::opt<bool>
166 Types("types",
167 cl::desc("Display all types (implies -classes, -enums, -typedefs)"),
168 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
169cl::opt<bool> Classes("classes", cl::desc("Display class types"),
170 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
171cl::opt<bool> Enums("enums", cl::desc("Display enum types"),
172 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
173cl::opt<bool> Typedefs("typedefs", cl::desc("Display typedef types"),
174 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
Zachary Turner0683be22017-05-14 01:13:40 +0000175cl::opt<SymbolSortMode> SymbolOrder(
176 "symbol-order", cl::desc("symbol sort order"),
177 cl::init(SymbolSortMode::None),
178 cl::values(clEnumValN(SymbolSortMode::None, "none",
179 "Undefined / no particular sort order"),
180 clEnumValN(SymbolSortMode::Name, "name", "Sort symbols by name"),
181 clEnumValN(SymbolSortMode::Size, "size",
182 "Sort symbols by size")),
183 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
184
Zachary Turner4dc4f012017-04-13 21:11:00 +0000185cl::opt<ClassSortMode> ClassOrder(
186 "class-order", cl::desc("Class sort order"), cl::init(ClassSortMode::None),
Zachary Turner16901642017-04-24 17:47:24 +0000187 cl::values(
188 clEnumValN(ClassSortMode::None, "none",
189 "Undefined / no particular sort order"),
190 clEnumValN(ClassSortMode::Name, "name", "Sort classes by name"),
191 clEnumValN(ClassSortMode::Size, "size", "Sort classes by size"),
192 clEnumValN(ClassSortMode::Padding, "padding",
193 "Sort classes by amount of padding"),
194 clEnumValN(ClassSortMode::PaddingPct, "padding-pct",
Zachary Turnerda307b62017-04-25 20:22:29 +0000195 "Sort classes by percentage of space consumed by padding"),
196 clEnumValN(ClassSortMode::PaddingImmediate, "padding-imm",
197 "Sort classes by amount of immediate padding"),
198 clEnumValN(ClassSortMode::PaddingPctImmediate, "padding-pct-imm",
199 "Sort classes by percentage of space consumed by immediate "
200 "padding")),
Zachary Turner4dc4f012017-04-13 21:11:00 +0000201 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
202
Zachary Turnerc883a8c2017-04-12 23:18:21 +0000203cl::opt<ClassDefinitionFormat> ClassFormat(
204 "class-definitions", cl::desc("Class definition format"),
Zachary Turnerda949c12017-04-24 17:47:52 +0000205 cl::init(ClassDefinitionFormat::All),
Zachary Turnerc883a8c2017-04-12 23:18:21 +0000206 cl::values(
Zachary Turnerda949c12017-04-24 17:47:52 +0000207 clEnumValN(ClassDefinitionFormat::All, "all",
Zachary Turner9e7dda32017-04-12 23:18:51 +0000208 "Display all class members including data, constants, "
Zachary Turner4dc4f012017-04-13 21:11:00 +0000209 "typedefs, functions, etc"),
Zachary Turnerda949c12017-04-24 17:47:52 +0000210 clEnumValN(ClassDefinitionFormat::Layout, "layout",
Zachary Turnerc883a8c2017-04-12 23:18:21 +0000211 "Only display members that contribute to class size."),
212 clEnumValN(ClassDefinitionFormat::None, "none",
213 "Don't display class definitions")),
214 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
Zachary Turnerda949c12017-04-24 17:47:52 +0000215cl::opt<uint32_t> ClassRecursionDepth(
216 "class-recurse-depth", cl::desc("Class recursion depth (0=no limit)"),
217 cl::init(0), cl::cat(TypeCategory), cl::sub(PrettySubcommand));
Zachary Turner63230a4e2017-04-06 23:43:12 +0000218
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000219cl::opt<bool> Lines("lines", cl::desc("Line tables"), cl::cat(TypeCategory),
220 cl::sub(PrettySubcommand));
Zachary Turner7797c722015-03-02 04:39:56 +0000221cl::opt<bool>
Zachary Turner7797c722015-03-02 04:39:56 +0000222 All("all", cl::desc("Implies all other options in 'Symbol Types' category"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000223 cl::cat(TypeCategory), cl::sub(PrettySubcommand));
Zachary Turnerf5abda22015-03-01 06:49:49 +0000224
Zachary Turnere5cb2692015-05-01 20:24:26 +0000225cl::opt<uint64_t> LoadAddress(
226 "load-address",
227 cl::desc("Assume the module is loaded at the specified address"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000228 cl::cat(OtherOptions), cl::sub(PrettySubcommand));
Adrian McCarthy65d26882017-03-15 20:17:58 +0000229cl::opt<bool> Native("native", cl::desc("Use native PDB reader instead of DIA"),
Adrian McCarthy1aa207d2017-03-23 15:28:15 +0000230 cl::cat(OtherOptions), cl::sub(PrettySubcommand));
231cl::opt<cl::boolOrDefault>
232 ColorOutput("color-output",
233 cl::desc("Override use of color (default = isatty)"),
234 cl::cat(OtherOptions), cl::sub(PrettySubcommand));
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000235cl::list<std::string> ExcludeTypes(
236 "exclude-types", cl::desc("Exclude types by regular expression"),
237 cl::ZeroOrMore, cl::cat(FilterCategory), cl::sub(PrettySubcommand));
238cl::list<std::string> ExcludeSymbols(
239 "exclude-symbols", cl::desc("Exclude symbols by regular expression"),
240 cl::ZeroOrMore, cl::cat(FilterCategory), cl::sub(PrettySubcommand));
241cl::list<std::string> ExcludeCompilands(
242 "exclude-compilands", cl::desc("Exclude compilands by regular expression"),
243 cl::ZeroOrMore, cl::cat(FilterCategory), cl::sub(PrettySubcommand));
Zachary Turner4dddcc62015-09-29 19:49:06 +0000244
245cl::list<std::string> IncludeTypes(
246 "include-types",
247 cl::desc("Include only types which match a regular expression"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000248 cl::ZeroOrMore, cl::cat(FilterCategory), cl::sub(PrettySubcommand));
Zachary Turner4dddcc62015-09-29 19:49:06 +0000249cl::list<std::string> IncludeSymbols(
250 "include-symbols",
251 cl::desc("Include only symbols which match a regular expression"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000252 cl::ZeroOrMore, cl::cat(FilterCategory), cl::sub(PrettySubcommand));
Zachary Turner4dddcc62015-09-29 19:49:06 +0000253cl::list<std::string> IncludeCompilands(
254 "include-compilands",
255 cl::desc("Include only compilands those which match a regular expression"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000256 cl::ZeroOrMore, cl::cat(FilterCategory), cl::sub(PrettySubcommand));
Zachary Turner4dc4f012017-04-13 21:11:00 +0000257cl::opt<uint32_t> SizeThreshold(
258 "min-type-size", cl::desc("Displays only those types which are greater "
259 "than or equal to the specified size."),
260 cl::init(0), cl::cat(FilterCategory), cl::sub(PrettySubcommand));
261cl::opt<uint32_t> PaddingThreshold(
262 "min-class-padding", cl::desc("Displays only those classes which have at "
263 "least the specified amount of padding."),
264 cl::init(0), cl::cat(FilterCategory), cl::sub(PrettySubcommand));
Zachary Turnerda307b62017-04-25 20:22:29 +0000265cl::opt<uint32_t> ImmediatePaddingThreshold(
266 "min-class-padding-imm",
267 cl::desc("Displays only those classes which have at least the specified "
268 "amount of immediate padding, ignoring padding internal to bases "
269 "and aggregates."),
270 cl::init(0), cl::cat(FilterCategory), cl::sub(PrettySubcommand));
Zachary Turner4dddcc62015-09-29 19:49:06 +0000271
Zachary Turner7797c722015-03-02 04:39:56 +0000272cl::opt<bool> ExcludeCompilerGenerated(
273 "no-compiler-generated",
274 cl::desc("Don't show compiler generated types and symbols"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000275 cl::cat(FilterCategory), cl::sub(PrettySubcommand));
Zachary Turner7797c722015-03-02 04:39:56 +0000276cl::opt<bool>
277 ExcludeSystemLibraries("no-system-libs",
278 cl::desc("Don't show symbols from system libraries"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000279 cl::cat(FilterCategory), cl::sub(PrettySubcommand));
Zachary Turner10169b62017-04-06 23:43:39 +0000280
Zachary Turner65323652015-03-04 06:09:53 +0000281cl::opt<bool> NoEnumDefs("no-enum-definitions",
282 cl::desc("Don't display full enum definitions"),
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000283 cl::cat(FilterCategory), cl::sub(PrettySubcommand));
284}
285
Zachary Turner6ac232c2017-03-13 23:28:25 +0000286namespace diff {
Zachary Turner6ac232c2017-03-13 23:28:25 +0000287cl::list<std::string> InputFilenames(cl::Positional,
288 cl::desc("<first> <second>"),
289 cl::OneOrMore, cl::sub(DiffSubcommand));
290}
291
Zachary Turner63055452017-06-15 22:24:24 +0000292cl::OptionCategory FileOptions("Module & File Options");
293
Zachary Turner99402032017-06-22 20:58:11 +0000294namespace bytes {
Zachary Turnerdd739682017-06-23 21:11:54 +0000295cl::OptionCategory MsfBytes("MSF File Options");
296cl::OptionCategory DbiBytes("Dbi Stream Options");
297cl::OptionCategory PdbBytes("PDB Stream Options");
Zachary Turnerc2f5b4b2017-06-23 21:50:54 +0000298cl::OptionCategory Types("Type Options");
Zachary Turnerfa332822017-06-23 23:08:57 +0000299cl::OptionCategory ModuleCategory("Module Options");
Zachary Turnerdd739682017-06-23 21:11:54 +0000300
Zachary Turner6b124f22017-06-23 19:54:44 +0000301llvm::Optional<NumberRange> DumpBlockRange;
302llvm::Optional<NumberRange> DumpByteRange;
303
304cl::opt<std::string> DumpBlockRangeOpt(
305 "block-range", cl::value_desc("start[-end]"),
306 cl::desc("Dump binary data from specified range of blocks."),
Zachary Turnerdd739682017-06-23 21:11:54 +0000307 cl::sub(BytesSubcommand), cl::cat(MsfBytes));
Zachary Turner99402032017-06-22 20:58:11 +0000308
309cl::opt<std::string>
Zachary Turner6b124f22017-06-23 19:54:44 +0000310 DumpByteRangeOpt("byte-range", cl::value_desc("start[-end]"),
311 cl::desc("Dump binary data from specified range of bytes"),
Zachary Turnerdd739682017-06-23 21:11:54 +0000312 cl::sub(BytesSubcommand), cl::cat(MsfBytes));
Zachary Turner99402032017-06-22 20:58:11 +0000313
314cl::list<std::string>
315 DumpStreamData("stream-data", cl::CommaSeparated, cl::ZeroOrMore,
316 cl::desc("Dump binary data from specified streams. Format "
317 "is SN[:Start][@Size]"),
Zachary Turnerdd739682017-06-23 21:11:54 +0000318 cl::sub(BytesSubcommand), cl::cat(MsfBytes));
Zachary Turner99402032017-06-22 20:58:11 +0000319
Zachary Turner6c3e41b2017-06-23 20:18:38 +0000320cl::opt<bool> NameMap("name-map", cl::desc("Dump bytes of PDB Name Map"),
Zachary Turnerdd739682017-06-23 21:11:54 +0000321 cl::sub(BytesSubcommand), cl::cat(PdbBytes));
322
323cl::opt<bool> SectionContributions("sc", cl::desc("Dump section contributions"),
324 cl::sub(BytesSubcommand), cl::cat(DbiBytes));
325cl::opt<bool> SectionMap("sm", cl::desc("Dump section map"),
326 cl::sub(BytesSubcommand), cl::cat(DbiBytes));
327cl::opt<bool> ModuleInfos("modi", cl::desc("Dump module info"),
328 cl::sub(BytesSubcommand), cl::cat(DbiBytes));
329cl::opt<bool> FileInfo("files", cl::desc("Dump source file info"),
330 cl::sub(BytesSubcommand), cl::cat(DbiBytes));
331cl::opt<bool> TypeServerMap("type-server", cl::desc("Dump type server map"),
332 cl::sub(BytesSubcommand), cl::cat(DbiBytes));
333cl::opt<bool> ECData("ec", cl::desc("Dump edit and continue map"),
334 cl::sub(BytesSubcommand), cl::cat(DbiBytes));
Zachary Turner6c3e41b2017-06-23 20:18:38 +0000335
Zachary Turnerc2f5b4b2017-06-23 21:50:54 +0000336cl::list<uint32_t>
337 TypeIndex("type",
338 cl::desc("Dump the type record with the given type index"),
339 cl::ZeroOrMore, cl::CommaSeparated, cl::sub(BytesSubcommand),
340 cl::cat(TypeCategory));
341cl::list<uint32_t>
342 IdIndex("id", cl::desc("Dump the id record with the given type index"),
343 cl::ZeroOrMore, cl::CommaSeparated, cl::sub(BytesSubcommand),
344 cl::cat(TypeCategory));
345
Zachary Turnerfa332822017-06-23 23:08:57 +0000346cl::opt<uint32_t> ModuleIndex(
347 "mod",
348 cl::desc(
349 "Limit options in the Modules category to the specified module index"),
350 cl::Optional, cl::sub(BytesSubcommand), cl::cat(ModuleCategory));
351cl::opt<bool> ModuleSyms("syms", cl::desc("Dump symbol record substream"),
352 cl::sub(BytesSubcommand), cl::cat(ModuleCategory));
353cl::opt<bool> ModuleC11("c11-chunks", cl::Hidden,
354 cl::desc("Dump C11 CodeView debug chunks"),
355 cl::sub(BytesSubcommand), cl::cat(ModuleCategory));
Zachary Turnere79b07e2017-06-26 17:22:36 +0000356cl::opt<bool> ModuleC13("chunks",
357 cl::desc("Dump C13 CodeView debug chunk subsection"),
Zachary Turnerfa332822017-06-23 23:08:57 +0000358 cl::sub(BytesSubcommand), cl::cat(ModuleCategory));
Zachary Turnere79b07e2017-06-26 17:22:36 +0000359cl::opt<bool> SplitChunks(
360 "split-chunks",
361 cl::desc(
362 "When dumping debug chunks, show a different section for each chunk"),
363 cl::sub(BytesSubcommand), cl::cat(ModuleCategory));
Zachary Turner99402032017-06-22 20:58:11 +0000364cl::list<std::string> InputFilenames(cl::Positional,
365 cl::desc("<input PDB files>"),
366 cl::OneOrMore, cl::sub(BytesSubcommand));
367
368} // namespace bytes
369
Zachary Turner7df69952017-06-22 20:57:39 +0000370namespace dump {
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000371
372cl::OptionCategory MsfOptions("MSF Container Options");
373cl::OptionCategory TypeOptions("Type Record Options");
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000374cl::OptionCategory SymbolOptions("Symbol Options");
375cl::OptionCategory MiscOptions("Miscellaneous Options");
376
377// MSF OPTIONS
Zachary Turner63055452017-06-15 22:24:24 +0000378cl::opt<bool> DumpSummary("summary", cl::desc("dump file summary"),
Zachary Turner7df69952017-06-22 20:57:39 +0000379 cl::cat(MsfOptions), cl::sub(DumpSubcommand));
Zachary Turner63055452017-06-15 22:24:24 +0000380cl::opt<bool> DumpStreams("streams",
381 cl::desc("dump summary of the PDB streams"),
Zachary Turner7df69952017-06-22 20:57:39 +0000382 cl::cat(MsfOptions), cl::sub(DumpSubcommand));
Zachary Turner5f098522017-06-23 20:28:14 +0000383cl::opt<bool> DumpStreamBlocks(
384 "stream-blocks",
385 cl::desc("Add block information to the output of -streams"),
386 cl::cat(MsfOptions), cl::sub(DumpSubcommand));
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000387
388// TYPE OPTIONS
Zachary Turner63055452017-06-15 22:24:24 +0000389cl::opt<bool> DumpTypes("types",
390 cl::desc("dump CodeView type records from TPI stream"),
Zachary Turner7df69952017-06-22 20:57:39 +0000391 cl::cat(TypeOptions), cl::sub(DumpSubcommand));
Zachary Turner63055452017-06-15 22:24:24 +0000392cl::opt<bool> DumpTypeData(
393 "type-data",
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000394 cl::desc("dump CodeView type record raw bytes from TPI stream"),
Zachary Turner7df69952017-06-22 20:57:39 +0000395 cl::cat(TypeOptions), cl::sub(DumpSubcommand));
Zachary Turner63055452017-06-15 22:24:24 +0000396
Zachary Turnerf8a2e042017-06-15 23:04:42 +0000397cl::opt<bool> DumpTypeExtras("type-extras",
398 cl::desc("dump type hashes and index offsets"),
Zachary Turner7df69952017-06-22 20:57:39 +0000399 cl::cat(TypeOptions), cl::sub(DumpSubcommand));
Zachary Turner63055452017-06-15 22:24:24 +0000400
Zachary Turner59224cb2017-06-16 23:42:15 +0000401cl::list<uint32_t> DumpTypeIndex(
Zachary Turnereae44df2017-07-05 18:43:25 +0000402 "type-index", cl::ZeroOrMore, cl::CommaSeparated,
Zachary Turner59224cb2017-06-16 23:42:15 +0000403 cl::desc("only dump types with the specified hexadecimal type index"),
Zachary Turner7df69952017-06-22 20:57:39 +0000404 cl::cat(TypeOptions), cl::sub(DumpSubcommand));
Zachary Turner59224cb2017-06-16 23:42:15 +0000405
Zachary Turner63055452017-06-15 22:24:24 +0000406cl::opt<bool> DumpIds("ids",
407 cl::desc("dump CodeView type records from IPI stream"),
Zachary Turner7df69952017-06-22 20:57:39 +0000408 cl::cat(TypeOptions), cl::sub(DumpSubcommand));
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000409cl::opt<bool>
Zachary Turner63055452017-06-15 22:24:24 +0000410 DumpIdData("id-data",
411 cl::desc("dump CodeView type record raw bytes from IPI stream"),
Zachary Turner7df69952017-06-22 20:57:39 +0000412 cl::cat(TypeOptions), cl::sub(DumpSubcommand));
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000413
Zachary Turnerf8a2e042017-06-15 23:04:42 +0000414cl::opt<bool> DumpIdExtras("id-extras",
415 cl::desc("dump id hashes and index offsets"),
Zachary Turner7df69952017-06-22 20:57:39 +0000416 cl::cat(TypeOptions), cl::sub(DumpSubcommand));
Zachary Turner59224cb2017-06-16 23:42:15 +0000417cl::list<uint32_t> DumpIdIndex(
Zachary Turnereae44df2017-07-05 18:43:25 +0000418 "id-index", cl::ZeroOrMore, cl::CommaSeparated,
Zachary Turner59224cb2017-06-16 23:42:15 +0000419 cl::desc("only dump ids with the specified hexadecimal type index"),
Zachary Turner7df69952017-06-22 20:57:39 +0000420 cl::cat(TypeOptions), cl::sub(DumpSubcommand));
Zachary Turnerf8a2e042017-06-15 23:04:42 +0000421
Zachary Turner02a26772017-06-30 18:15:47 +0000422cl::opt<bool> DumpTypeDependents(
423 "dependents",
424 cl::desc("In conjunection with -type-index and -id-index, dumps the entire "
425 "dependency graph for the specified index instead of "
426 "just the single record with the specified index"),
427 cl::cat(TypeOptions), cl::sub(DumpSubcommand));
428
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000429// SYMBOL OPTIONS
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000430cl::opt<bool> DumpPublics("publics", cl::desc("dump Publics stream data"),
Zachary Turner7df69952017-06-22 20:57:39 +0000431 cl::cat(SymbolOptions), cl::sub(DumpSubcommand));
Zachary Turner63055452017-06-15 22:24:24 +0000432cl::opt<bool> DumpSymbols("symbols", cl::desc("dump module symbols"),
Zachary Turner7df69952017-06-22 20:57:39 +0000433 cl::cat(SymbolOptions), cl::sub(DumpSubcommand));
Zachary Turner63055452017-06-15 22:24:24 +0000434
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000435cl::opt<bool>
Zachary Turner63055452017-06-15 22:24:24 +0000436 DumpSymRecordBytes("sym-data",
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000437 cl::desc("dump CodeView symbol record raw bytes"),
Zachary Turner7df69952017-06-22 20:57:39 +0000438 cl::cat(SymbolOptions), cl::sub(DumpSubcommand));
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000439
Zachary Turner63055452017-06-15 22:24:24 +0000440// MODULE & FILE OPTIONS
441cl::opt<bool> DumpModules("modules", cl::desc("dump compiland information"),
Zachary Turner7df69952017-06-22 20:57:39 +0000442 cl::cat(FileOptions), cl::sub(DumpSubcommand));
Zachary Turner63055452017-06-15 22:24:24 +0000443cl::opt<bool> DumpModuleFiles(
444 "files",
Zachary Turner4e950642017-06-15 23:56:19 +0000445 cl::desc("Dump the source files that contribute to each module's."),
Zachary Turner7df69952017-06-22 20:57:39 +0000446 cl::cat(FileOptions), cl::sub(DumpSubcommand));
Zachary Turner4e950642017-06-15 23:56:19 +0000447cl::opt<bool> DumpLines(
448 "l",
449 cl::desc("dump source file/line information (DEBUG_S_LINES subsection)"),
Zachary Turner7df69952017-06-22 20:57:39 +0000450 cl::cat(FileOptions), cl::sub(DumpSubcommand));
Zachary Turner4e950642017-06-15 23:56:19 +0000451cl::opt<bool> DumpInlineeLines(
452 "il",
453 cl::desc("dump inlinee line information (DEBUG_S_INLINEELINES subsection)"),
Zachary Turner7df69952017-06-22 20:57:39 +0000454 cl::cat(FileOptions), cl::sub(DumpSubcommand));
Zachary Turner47d9a562017-06-16 00:04:24 +0000455cl::opt<bool> DumpXmi(
456 "xmi",
457 cl::desc(
458 "dump cross module imports (DEBUG_S_CROSSSCOPEIMPORTS subsection)"),
Zachary Turner7df69952017-06-22 20:57:39 +0000459 cl::cat(FileOptions), cl::sub(DumpSubcommand));
Zachary Turner47d9a562017-06-16 00:04:24 +0000460cl::opt<bool> DumpXme(
461 "xme",
462 cl::desc(
463 "dump cross module exports (DEBUG_S_CROSSSCOPEEXPORTS subsection)"),
Zachary Turner7df69952017-06-22 20:57:39 +0000464 cl::cat(FileOptions), cl::sub(DumpSubcommand));
Zachary Turner63055452017-06-15 22:24:24 +0000465
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000466// MISCELLANEOUS OPTIONS
Zachary Turner760ad4d2017-01-20 22:42:09 +0000467cl::opt<bool> DumpStringTable("string-table", cl::desc("dump PDB String Table"),
Zachary Turner7df69952017-06-22 20:57:39 +0000468 cl::cat(MiscOptions), cl::sub(DumpSubcommand));
Zachary Turner760ad4d2017-01-20 22:42:09 +0000469
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000470cl::opt<bool> DumpSectionContribs("section-contribs",
471 cl::desc("dump section contributions"),
Zachary Turner7df69952017-06-22 20:57:39 +0000472 cl::cat(MiscOptions),
473 cl::sub(DumpSubcommand));
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000474cl::opt<bool> DumpSectionMap("section-map", cl::desc("dump section map"),
Zachary Turner7df69952017-06-22 20:57:39 +0000475 cl::cat(MiscOptions), cl::sub(DumpSubcommand));
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000476
Zachary Turnerab58ae82016-06-30 17:43:00 +0000477cl::opt<bool> RawAll("all", cl::desc("Implies most other options."),
Zachary Turner7df69952017-06-22 20:57:39 +0000478 cl::cat(MiscOptions), cl::sub(DumpSubcommand));
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000479
480cl::list<std::string> InputFilenames(cl::Positional,
481 cl::desc("<input PDB files>"),
Zachary Turner7df69952017-06-22 20:57:39 +0000482 cl::OneOrMore, cl::sub(DumpSubcommand));
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000483}
484
485namespace yaml2pdb {
486cl::opt<std::string>
487 YamlPdbOutputFile("pdb", cl::desc("the name of the PDB file to write"),
488 cl::sub(YamlToPdbSubcommand));
489
Bob Haarmande33a6372017-05-17 20:46:48 +0000490cl::opt<std::string> InputFilename(cl::Positional,
491 cl::desc("<input YAML file>"), cl::Required,
492 cl::sub(YamlToPdbSubcommand));
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000493}
494
495namespace pdb2yaml {
Bob Haarman69fd2b72017-05-26 23:46:20 +0000496cl::opt<bool> All("all",
497 cl::desc("Dump everything we know how to dump."),
498 cl::sub(PdbToYamlSubcommand), cl::init(false));
Zachary Turner3eedd162017-06-08 23:39:33 +0000499cl::opt<bool> NoFileHeaders("no-file-headers",
500 cl::desc("Do not dump MSF file headers"),
501 cl::sub(PdbToYamlSubcommand), cl::init(false));
Zachary Turnerea4e6072017-03-15 22:18:53 +0000502cl::opt<bool> Minimal("minimal",
503 cl::desc("Don't write fields with default values"),
504 cl::sub(PdbToYamlSubcommand), cl::init(false));
Zachary Turnerf6b93822016-07-11 21:45:09 +0000505
Zachary Turnerab58ae82016-06-30 17:43:00 +0000506cl::opt<bool> StreamMetadata(
507 "stream-metadata",
508 cl::desc("Dump the number of streams and each stream's size"),
Zachary Turnerf6b93822016-07-11 21:45:09 +0000509 cl::sub(PdbToYamlSubcommand), cl::init(false));
Zachary Turnerab58ae82016-06-30 17:43:00 +0000510cl::opt<bool> StreamDirectory(
511 "stream-directory",
512 cl::desc("Dump each stream's block map (implies -stream-metadata)"),
Zachary Turnerf6b93822016-07-11 21:45:09 +0000513 cl::sub(PdbToYamlSubcommand), cl::init(false));
Zachary Turnerfaa554b2016-07-15 22:16:56 +0000514cl::opt<bool> PdbStream("pdb-stream",
515 cl::desc("Dump the PDB Stream (Stream 1)"),
516 cl::sub(PdbToYamlSubcommand), cl::init(false));
Zachary Turner760ad4d2017-01-20 22:42:09 +0000517
518cl::opt<bool> StringTable("string-table", cl::desc("Dump the PDB String Table"),
519 cl::sub(PdbToYamlSubcommand), cl::init(false));
520
Zachary Turnerfaa554b2016-07-15 22:16:56 +0000521cl::opt<bool> DbiStream("dbi-stream",
Zachary Turner3eedd162017-06-08 23:39:33 +0000522 cl::desc("Dump the DBI Stream Headers (Stream 2)"),
Zachary Turnerfaa554b2016-07-15 22:16:56 +0000523 cl::sub(PdbToYamlSubcommand), cl::init(false));
Zachary Turneree3b9c22017-04-25 20:22:02 +0000524
Zachary Turnerac5763e2016-08-18 16:49:29 +0000525cl::opt<bool> TpiStream("tpi-stream",
526 cl::desc("Dump the TPI Stream (Stream 3)"),
527 cl::sub(PdbToYamlSubcommand), cl::init(false));
528
Zachary Turnerde9ba152016-09-15 18:22:31 +0000529cl::opt<bool> IpiStream("ipi-stream",
530 cl::desc("Dump the IPI Stream (Stream 5)"),
531 cl::sub(PdbToYamlSubcommand), cl::init(false));
532
Zachary Turner3eedd162017-06-08 23:39:33 +0000533// MODULE & FILE OPTIONS
534cl::opt<bool> DumpModules("modules", cl::desc("dump compiland information"),
Zachary Turner63055452017-06-15 22:24:24 +0000535 cl::cat(FileOptions), cl::sub(PdbToYamlSubcommand));
Zachary Turner3eedd162017-06-08 23:39:33 +0000536cl::opt<bool> DumpModuleFiles("module-files", cl::desc("dump file information"),
Zachary Turner63055452017-06-15 22:24:24 +0000537 cl::cat(FileOptions),
Zachary Turner3eedd162017-06-08 23:39:33 +0000538 cl::sub(PdbToYamlSubcommand));
539cl::list<ModuleSubsection> DumpModuleSubsections(
540 "subsections", cl::ZeroOrMore, cl::CommaSeparated,
Zachary Turnere79b07e2017-06-26 17:22:36 +0000541 cl::desc("dump subsections from each module's debug stream"), ChunkValues,
Zachary Turner63055452017-06-15 22:24:24 +0000542 cl::cat(FileOptions), cl::sub(PdbToYamlSubcommand));
Zachary Turner3eedd162017-06-08 23:39:33 +0000543cl::opt<bool> DumpModuleSyms("module-syms", cl::desc("dump module symbols"),
Zachary Turner63055452017-06-15 22:24:24 +0000544 cl::cat(FileOptions),
Zachary Turner3eedd162017-06-08 23:39:33 +0000545 cl::sub(PdbToYamlSubcommand));
Zachary Turner63055452017-06-15 22:24:24 +0000546
547cl::list<std::string> InputFilename(cl::Positional,
548 cl::desc("<input PDB file>"), cl::Required,
549 cl::sub(PdbToYamlSubcommand));
550} // namespace pdb2yaml
Zachary Turner3eedd162017-06-08 23:39:33 +0000551
Zachary Turnerd50c0132017-02-01 18:30:22 +0000552namespace analyze {
553cl::opt<bool> StringTable("hash-collisions", cl::desc("Find hash collisions"),
554 cl::sub(AnalyzeSubcommand), cl::init(false));
555cl::list<std::string> InputFilename(cl::Positional,
556 cl::desc("<input PDB file>"), cl::Required,
557 cl::sub(AnalyzeSubcommand));
558}
Zachary Turner8fb441a2017-05-18 23:03:41 +0000559
560namespace merge {
561cl::list<std::string> InputFilenames(cl::Positional,
562 cl::desc("<input PDB files>"),
563 cl::OneOrMore, cl::sub(MergeSubcommand));
564cl::opt<std::string>
565 PdbOutputFile("pdb", cl::desc("the name of the PDB file to write"),
566 cl::sub(MergeSubcommand));
567}
Zachary Turner49693b42015-01-28 01:22:33 +0000568}
569
David Majnemerc165c882016-05-28 18:25:15 +0000570static ExitOnError ExitOnErr;
571
Zachary Turner1dc9fd32016-06-14 20:48:36 +0000572static void yamlToPdb(StringRef Path) {
Zachary Turnere109dc62016-07-22 19:56:26 +0000573 BumpPtrAllocator Allocator;
Zachary Turner1dc9fd32016-06-14 20:48:36 +0000574 ErrorOr<std::unique_ptr<MemoryBuffer>> ErrorOrBuffer =
575 MemoryBuffer::getFileOrSTDIN(Path, /*FileSize=*/-1,
576 /*RequiresNullTerminator=*/false);
577
578 if (ErrorOrBuffer.getError()) {
579 ExitOnErr(make_error<GenericError>(generic_error_code::invalid_path, Path));
580 }
581
582 std::unique_ptr<MemoryBuffer> &Buffer = ErrorOrBuffer.get();
583
584 llvm::yaml::Input In(Buffer->getBuffer());
Zachary Turnerc6d54da2016-09-09 17:46:17 +0000585 pdb::yaml::PdbObject YamlObj(Allocator);
Zachary Turner1dc9fd32016-06-14 20:48:36 +0000586 In >> YamlObj;
587
Zachary Turnere109dc62016-07-22 19:56:26 +0000588 PDBFileBuilder Builder(Allocator);
Zachary Turnerdbeaea72016-07-11 21:45:26 +0000589
Zachary Turnerea4e6072017-03-15 22:18:53 +0000590 uint32_t BlockSize = 4096;
591 if (YamlObj.Headers.hasValue())
592 BlockSize = YamlObj.Headers->SuperBlock.BlockSize;
593 ExitOnErr(Builder.initialize(BlockSize));
Zachary Turner620961d2016-09-14 23:00:02 +0000594 // Add each of the reserved streams. We ignore stream metadata in the
595 // yaml, because we will reconstruct our own view of the streams. For
596 // example, the YAML may say that there were 20 streams in the original
597 // PDB, but maybe we only dump a subset of those 20 streams, so we will
598 // have fewer, and the ones we do have may end up with different indices
599 // than the ones in the original PDB. So we just start with a clean slate.
600 for (uint32_t I = 0; I < kSpecialStreamCount; ++I)
601 ExitOnErr(Builder.getMsfBuilder().addStream(0));
Zachary Turner8848a7a2016-07-06 18:05:57 +0000602
Zachary Turnera8cfc292017-06-14 15:59:27 +0000603 StringsAndChecksums Strings;
604 Strings.setStrings(std::make_shared<DebugStringTableSubsection>());
605
Zachary Turner760ad4d2017-01-20 22:42:09 +0000606 if (YamlObj.StringTable.hasValue()) {
Zachary Turner760ad4d2017-01-20 22:42:09 +0000607 for (auto S : *YamlObj.StringTable)
Zachary Turnera8cfc292017-06-14 15:59:27 +0000608 Strings.strings()->insert(S);
Zachary Turner760ad4d2017-01-20 22:42:09 +0000609 }
610
Zachary Turnerea4e6072017-03-15 22:18:53 +0000611 pdb::yaml::PdbInfoStream DefaultInfoStream;
612 pdb::yaml::PdbDbiStream DefaultDbiStream;
613 pdb::yaml::PdbTpiStream DefaultTpiStream;
Zachary Turnerd4136e92017-05-22 21:07:43 +0000614 pdb::yaml::PdbTpiStream DefaultIpiStream;
Zachary Turner1dc9fd32016-06-14 20:48:36 +0000615
Zachary Turnerea4e6072017-03-15 22:18:53 +0000616 const auto &Info = YamlObj.PdbStream.getValueOr(DefaultInfoStream);
617
618 auto &InfoBuilder = Builder.getInfoBuilder();
619 InfoBuilder.setAge(Info.Age);
620 InfoBuilder.setGuid(Info.Guid);
621 InfoBuilder.setSignature(Info.Signature);
622 InfoBuilder.setVersion(Info.Version);
Zachary Turner05d5e612017-03-16 20:19:11 +0000623 for (auto F : Info.Features)
624 InfoBuilder.addFeature(F);
Zachary Turnerea4e6072017-03-15 22:18:53 +0000625
626 const auto &Dbi = YamlObj.DbiStream.getValueOr(DefaultDbiStream);
627 auto &DbiBuilder = Builder.getDbiBuilder();
628 DbiBuilder.setAge(Dbi.Age);
629 DbiBuilder.setBuildNumber(Dbi.BuildNumber);
630 DbiBuilder.setFlags(Dbi.Flags);
631 DbiBuilder.setMachineType(Dbi.MachineType);
632 DbiBuilder.setPdbDllRbld(Dbi.PdbDllRbld);
633 DbiBuilder.setPdbDllVersion(Dbi.PdbDllVersion);
634 DbiBuilder.setVersionHeader(Dbi.VerHeader);
635 for (const auto &MI : Dbi.ModInfos) {
Zachary Turner05d5e612017-03-16 20:19:11 +0000636 auto &ModiBuilder = ExitOnErr(DbiBuilder.addModuleInfo(MI.Mod));
Bob Haarmanea91faf2017-05-25 18:04:17 +0000637 ModiBuilder.setObjFileName(MI.Obj);
Zachary Turnerea4e6072017-03-15 22:18:53 +0000638
639 for (auto S : MI.SourceFiles)
640 ExitOnErr(DbiBuilder.addModuleSourceFile(MI.Mod, S));
641 if (MI.Modi.hasValue()) {
642 const auto &ModiStream = *MI.Modi;
Zachary Turnerebd3ae82017-06-01 21:52:41 +0000643 for (auto Symbol : ModiStream.Symbols) {
644 ModiBuilder.addSymbol(
645 Symbol.toCodeViewSymbol(Allocator, CodeViewContainer::Pdb));
646 }
Zachary Turnerd218c262016-07-22 15:46:37 +0000647 }
Zachary Turner8a2ebfb2017-05-01 23:27:42 +0000648
Zachary Turnera8cfc292017-06-14 15:59:27 +0000649 // Each module has its own checksum subsection, so scan for it every time.
650 Strings.setChecksums(nullptr);
651 CodeViewYAML::initializeStringsAndChecksums(MI.Subsections, Strings);
652
Zachary Turnerdeb39132017-06-09 00:28:08 +0000653 auto CodeViewSubsections = ExitOnErr(CodeViewYAML::toCodeViewSubsectionList(
654 Allocator, MI.Subsections, Strings));
Zachary Turner92dcdda2017-06-02 19:49:14 +0000655 for (auto &SS : CodeViewSubsections) {
Zachary Turnera8cfc292017-06-14 15:59:27 +0000656 ModiBuilder.addDebugSubsection(SS);
Zachary Turner8a2ebfb2017-05-01 23:27:42 +0000657 }
Zachary Turnerdbeaea72016-07-11 21:45:26 +0000658 }
659
Zachary Turnerea4e6072017-03-15 22:18:53 +0000660 auto &TpiBuilder = Builder.getTpiBuilder();
661 const auto &Tpi = YamlObj.TpiStream.getValueOr(DefaultTpiStream);
662 TpiBuilder.setVersionHeader(Tpi.Version);
Zachary Turnerd4273832017-05-30 21:53:05 +0000663 for (const auto &R : Tpi.Records) {
664 CVType Type = R.toCodeViewRecord(Allocator);
665 TpiBuilder.addTypeRecord(Type.RecordData, None);
666 }
Zachary Turnerc6d54da2016-09-09 17:46:17 +0000667
Zachary Turnerd4136e92017-05-22 21:07:43 +0000668 const auto &Ipi = YamlObj.IpiStream.getValueOr(DefaultIpiStream);
Zachary Turnerea4e6072017-03-15 22:18:53 +0000669 auto &IpiBuilder = Builder.getIpiBuilder();
670 IpiBuilder.setVersionHeader(Ipi.Version);
Zachary Turnerd4273832017-05-30 21:53:05 +0000671 for (const auto &R : Ipi.Records) {
672 CVType Type = R.toCodeViewRecord(Allocator);
673 IpiBuilder.addTypeRecord(Type.RecordData, None);
674 }
Zachary Turnerde9ba152016-09-15 18:22:31 +0000675
Zachary Turnera8cfc292017-06-14 15:59:27 +0000676 Builder.getStringTableBuilder().setStrings(*Strings.strings());
677
Rui Ueyamafc22cef2016-09-30 20:34:44 +0000678 ExitOnErr(Builder.commit(opts::yaml2pdb::YamlPdbOutputFile));
Zachary Turner1dc9fd32016-06-14 20:48:36 +0000679}
680
Zachary Turner6ac232c2017-03-13 23:28:25 +0000681static PDBFile &loadPDB(StringRef Path, std::unique_ptr<IPDBSession> &Session) {
Adrian McCarthy8f713192017-01-27 00:01:55 +0000682 ExitOnErr(loadDataForPDB(PDB_ReaderType::Native, Path, Session));
Zachary Turner8848a7a2016-07-06 18:05:57 +0000683
Zachary Turner6ac232c2017-03-13 23:28:25 +0000684 NativeSession *NS = static_cast<NativeSession *>(Session.get());
685 return NS->getPDBFile();
686}
687
688static void pdb2Yaml(StringRef Path) {
689 std::unique_ptr<IPDBSession> Session;
690 auto &File = loadPDB(Path, Session);
691
Zachary Turner8848a7a2016-07-06 18:05:57 +0000692 auto O = llvm::make_unique<YAMLOutputStyle>(File);
693 O = llvm::make_unique<YAMLOutputStyle>(File);
694
695 ExitOnErr(O->dump());
696}
697
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000698static void dumpRaw(StringRef Path) {
David Majnemer1573b242016-04-28 23:47:27 +0000699 std::unique_ptr<IPDBSession> Session;
Zachary Turner6ac232c2017-03-13 23:28:25 +0000700 auto &File = loadPDB(Path, Session);
David Majnemer1573b242016-04-28 23:47:27 +0000701
Zachary Turner7df69952017-06-22 20:57:39 +0000702 auto O = llvm::make_unique<DumpOutputStyle>(File);
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000703
704 ExitOnErr(O->dump());
705}
706
Zachary Turner99402032017-06-22 20:58:11 +0000707static void dumpBytes(StringRef Path) {
708 std::unique_ptr<IPDBSession> Session;
709 auto &File = loadPDB(Path, Session);
710
711 auto O = llvm::make_unique<BytesOutputStyle>(File);
712
713 ExitOnErr(O->dump());
714}
715
Zachary Turnerd50c0132017-02-01 18:30:22 +0000716static void dumpAnalysis(StringRef Path) {
717 std::unique_ptr<IPDBSession> Session;
Zachary Turner6ac232c2017-03-13 23:28:25 +0000718 auto &File = loadPDB(Path, Session);
Zachary Turnerd50c0132017-02-01 18:30:22 +0000719 auto O = llvm::make_unique<AnalysisStyle>(File);
720
721 ExitOnErr(O->dump());
722}
723
Zachary Turner6ac232c2017-03-13 23:28:25 +0000724static void diff(StringRef Path1, StringRef Path2) {
725 std::unique_ptr<IPDBSession> Session1;
726 std::unique_ptr<IPDBSession> Session2;
727
728 auto &File1 = loadPDB(Path1, Session1);
729 auto &File2 = loadPDB(Path2, Session2);
730
731 auto O = llvm::make_unique<DiffStyle>(File1, File2);
732
733 ExitOnErr(O->dump());
734}
735
Zachary Turner0683be22017-05-14 01:13:40 +0000736bool opts::pretty::shouldDumpSymLevel(SymLevel Search) {
737 if (SymTypes.empty())
738 return true;
739 if (llvm::find(SymTypes, Search) != SymTypes.end())
740 return true;
741 if (llvm::find(SymTypes, SymLevel::All) != SymTypes.end())
742 return true;
743 return false;
744}
745
746uint32_t llvm::pdb::getTypeLength(const PDBSymbolData &Symbol) {
747 auto SymbolType = Symbol.getType();
748 const IPDBRawSymbol &RawType = SymbolType->getRawSymbol();
749
750 return RawType.getLength();
751}
752
753bool opts::pretty::compareFunctionSymbols(
754 const std::unique_ptr<PDBSymbolFunc> &F1,
755 const std::unique_ptr<PDBSymbolFunc> &F2) {
756 assert(opts::pretty::SymbolOrder != opts::pretty::SymbolSortMode::None);
757
758 if (opts::pretty::SymbolOrder == opts::pretty::SymbolSortMode::Name)
759 return F1->getName() < F2->getName();
760
761 // Note that we intentionally sort in descending order on length, since
762 // long functions are more interesting than short functions.
763 return F1->getLength() > F2->getLength();
764}
765
766bool opts::pretty::compareDataSymbols(
767 const std::unique_ptr<PDBSymbolData> &F1,
768 const std::unique_ptr<PDBSymbolData> &F2) {
769 assert(opts::pretty::SymbolOrder != opts::pretty::SymbolSortMode::None);
770
771 if (opts::pretty::SymbolOrder == opts::pretty::SymbolSortMode::Name)
772 return F1->getName() < F2->getName();
773
774 // Note that we intentionally sort in descending order on length, since
775 // large types are more interesting than short ones.
776 return getTypeLength(*F1) > getTypeLength(*F2);
777}
778
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000779static void dumpPretty(StringRef Path) {
780 std::unique_ptr<IPDBSession> Session;
David Majnemer1573b242016-04-28 23:47:27 +0000781
Adrian McCarthy65d26882017-03-15 20:17:58 +0000782 const auto ReaderType =
783 opts::pretty::Native ? PDB_ReaderType::Native : PDB_ReaderType::DIA;
784 ExitOnErr(loadDataForPDB(ReaderType, Path, Session));
David Majnemer1573b242016-04-28 23:47:27 +0000785
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000786 if (opts::pretty::LoadAddress)
787 Session->setLoadAddress(opts::pretty::LoadAddress);
Zachary Turner7058dfc2015-01-27 22:40:14 +0000788
Adrian McCarthy1aa207d2017-03-23 15:28:15 +0000789 auto &Stream = outs();
790 const bool UseColor = opts::pretty::ColorOutput == cl::BOU_UNSET
791 ? Stream.has_colors()
792 : opts::pretty::ColorOutput == cl::BOU_TRUE;
793 LinePrinter Printer(2, UseColor, Stream);
Zachary Turner2d11c202015-02-27 09:15:59 +0000794
Zachary Turnera5549172015-02-10 22:43:25 +0000795 auto GlobalScope(Session->getGlobalScope());
Zachary Turner9a818ad2015-02-22 22:03:38 +0000796 std::string FileName(GlobalScope->getSymbolsFileName());
797
Zachary Turner2d11c202015-02-27 09:15:59 +0000798 WithColor(Printer, PDB_ColorItem::None).get() << "Summary for ";
799 WithColor(Printer, PDB_ColorItem::Path).get() << FileName;
800 Printer.Indent();
Zachary Turner9a818ad2015-02-22 22:03:38 +0000801 uint64_t FileSize = 0;
Zachary Turner9a818ad2015-02-22 22:03:38 +0000802
Zachary Turner2d11c202015-02-27 09:15:59 +0000803 Printer.NewLine();
804 WithColor(Printer, PDB_ColorItem::Identifier).get() << "Size";
David Majnemer6e081262015-10-15 01:27:19 +0000805 if (!sys::fs::file_size(FileName, FileSize)) {
Zachary Turner2d11c202015-02-27 09:15:59 +0000806 Printer << ": " << FileSize << " bytes";
807 } else {
808 Printer << ": (Unable to obtain file size)";
809 }
810
811 Printer.NewLine();
812 WithColor(Printer, PDB_ColorItem::Identifier).get() << "Guid";
813 Printer << ": " << GlobalScope->getGuid();
814
815 Printer.NewLine();
816 WithColor(Printer, PDB_ColorItem::Identifier).get() << "Age";
817 Printer << ": " << GlobalScope->getAge();
818
819 Printer.NewLine();
820 WithColor(Printer, PDB_ColorItem::Identifier).get() << "Attributes";
821 Printer << ": ";
Zachary Turner9a818ad2015-02-22 22:03:38 +0000822 if (GlobalScope->hasCTypes())
823 outs() << "HasCTypes ";
824 if (GlobalScope->hasPrivateSymbols())
825 outs() << "HasPrivateSymbols ";
Zachary Turner2d11c202015-02-27 09:15:59 +0000826 Printer.Unindent();
Zachary Turner9a818ad2015-02-22 22:03:38 +0000827
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000828 if (opts::pretty::Compilands) {
Zachary Turner2d11c202015-02-27 09:15:59 +0000829 Printer.NewLine();
830 WithColor(Printer, PDB_ColorItem::SectionHeader).get()
831 << "---COMPILANDS---";
832 Printer.Indent();
Zachary Turnerc074de02015-02-12 21:09:24 +0000833 auto Compilands = GlobalScope->findAllChildren<PDBSymbolCompiland>();
Zachary Turner2d11c202015-02-27 09:15:59 +0000834 CompilandDumper Dumper(Printer);
Zachary Turnera99000d2016-03-08 21:42:24 +0000835 CompilandDumpFlags options = CompilandDumper::Flags::None;
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000836 if (opts::pretty::Lines)
Zachary Turnera99000d2016-03-08 21:42:24 +0000837 options = options | CompilandDumper::Flags::Lines;
Zachary Turner9a818ad2015-02-22 22:03:38 +0000838 while (auto Compiland = Compilands->getNext())
Zachary Turnera99000d2016-03-08 21:42:24 +0000839 Dumper.start(*Compiland, options);
Zachary Turner2d11c202015-02-27 09:15:59 +0000840 Printer.Unindent();
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000841 }
842
Zachary Turner63230a4e2017-04-06 23:43:12 +0000843 if (opts::pretty::Classes || opts::pretty::Enums || opts::pretty::Typedefs) {
Zachary Turner2d11c202015-02-27 09:15:59 +0000844 Printer.NewLine();
845 WithColor(Printer, PDB_ColorItem::SectionHeader).get() << "---TYPES---";
846 Printer.Indent();
Zachary Turner65323652015-03-04 06:09:53 +0000847 TypeDumper Dumper(Printer);
Zachary Turnerb52d08d2015-03-01 06:51:29 +0000848 Dumper.start(*GlobalScope);
Zachary Turner2d11c202015-02-27 09:15:59 +0000849 Printer.Unindent();
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000850 }
851
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000852 if (opts::pretty::Symbols) {
Zachary Turner2d11c202015-02-27 09:15:59 +0000853 Printer.NewLine();
854 WithColor(Printer, PDB_ColorItem::SectionHeader).get() << "---SYMBOLS---";
855 Printer.Indent();
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000856 auto Compilands = GlobalScope->findAllChildren<PDBSymbolCompiland>();
Zachary Turner2d11c202015-02-27 09:15:59 +0000857 CompilandDumper Dumper(Printer);
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000858 while (auto Compiland = Compilands->getNext())
Zachary Turnerb52d08d2015-03-01 06:51:29 +0000859 Dumper.start(*Compiland, true);
Zachary Turner2d11c202015-02-27 09:15:59 +0000860 Printer.Unindent();
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000861 }
862
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000863 if (opts::pretty::Globals) {
Zachary Turner2d11c202015-02-27 09:15:59 +0000864 Printer.NewLine();
865 WithColor(Printer, PDB_ColorItem::SectionHeader).get() << "---GLOBALS---";
866 Printer.Indent();
Zachary Turner0683be22017-05-14 01:13:40 +0000867 if (shouldDumpSymLevel(opts::pretty::SymLevel::Functions)) {
Zachary Turner2d11c202015-02-27 09:15:59 +0000868 FunctionDumper Dumper(Printer);
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000869 auto Functions = GlobalScope->findAllChildren<PDBSymbolFunc>();
Zachary Turner0683be22017-05-14 01:13:40 +0000870 if (opts::pretty::SymbolOrder == opts::pretty::SymbolSortMode::None) {
871 while (auto Function = Functions->getNext()) {
872 Printer.NewLine();
873 Dumper.start(*Function, FunctionDumper::PointerType::None);
874 }
875 } else {
876 std::vector<std::unique_ptr<PDBSymbolFunc>> Funcs;
877 while (auto Func = Functions->getNext())
878 Funcs.push_back(std::move(Func));
879 std::sort(Funcs.begin(), Funcs.end(),
880 opts::pretty::compareFunctionSymbols);
881 for (const auto &Func : Funcs) {
882 Printer.NewLine();
883 Dumper.start(*Func, FunctionDumper::PointerType::None);
884 }
Zachary Turner2d11c202015-02-27 09:15:59 +0000885 }
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000886 }
Zachary Turner0683be22017-05-14 01:13:40 +0000887 if (shouldDumpSymLevel(opts::pretty::SymLevel::Data)) {
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000888 auto Vars = GlobalScope->findAllChildren<PDBSymbolData>();
Zachary Turner2d11c202015-02-27 09:15:59 +0000889 VariableDumper Dumper(Printer);
Zachary Turner0683be22017-05-14 01:13:40 +0000890 if (opts::pretty::SymbolOrder == opts::pretty::SymbolSortMode::None) {
891 while (auto Var = Vars->getNext())
892 Dumper.start(*Var);
893 } else {
894 std::vector<std::unique_ptr<PDBSymbolData>> Datas;
895 while (auto Var = Vars->getNext())
896 Datas.push_back(std::move(Var));
897 std::sort(Datas.begin(), Datas.end(), opts::pretty::compareDataSymbols);
898 for (const auto &Var : Datas)
899 Dumper.start(*Var);
900 }
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000901 }
Zachary Turner0683be22017-05-14 01:13:40 +0000902 if (shouldDumpSymLevel(opts::pretty::SymLevel::Thunks)) {
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000903 auto Thunks = GlobalScope->findAllChildren<PDBSymbolThunk>();
Zachary Turner2d11c202015-02-27 09:15:59 +0000904 CompilandDumper Dumper(Printer);
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000905 while (auto Thunk = Thunks->getNext())
Zachary Turnerb52d08d2015-03-01 06:51:29 +0000906 Dumper.dump(*Thunk);
Zachary Turnerdb18f5c2015-02-27 09:15:18 +0000907 }
Zachary Turner2d11c202015-02-27 09:15:59 +0000908 Printer.Unindent();
Zachary Turner7058dfc2015-01-27 22:40:14 +0000909 }
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000910 if (opts::pretty::Externals) {
Zachary Turnere5cb2692015-05-01 20:24:26 +0000911 Printer.NewLine();
912 WithColor(Printer, PDB_ColorItem::SectionHeader).get() << "---EXTERNALS---";
913 Printer.Indent();
914 ExternalSymbolDumper Dumper(Printer);
915 Dumper.start(*GlobalScope);
916 }
Zachary Turnera30bd1a2016-06-30 17:42:48 +0000917 if (opts::pretty::Lines) {
Zachary Turnera99000d2016-03-08 21:42:24 +0000918 Printer.NewLine();
919 }
Zachary Turnera5549172015-02-10 22:43:25 +0000920 outs().flush();
Zachary Turnerfcb14ad2015-01-27 20:46:21 +0000921}
922
Zachary Turner8fb441a2017-05-18 23:03:41 +0000923static void mergePdbs() {
924 BumpPtrAllocator Allocator;
925 TypeTableBuilder MergedTpi(Allocator);
926 TypeTableBuilder MergedIpi(Allocator);
927
928 // Create a Tpi and Ipi type table with all types from all input files.
929 for (const auto &Path : opts::merge::InputFilenames) {
930 std::unique_ptr<IPDBSession> Session;
931 auto &File = loadPDB(Path, Session);
Zachary Turnerd4136e92017-05-22 21:07:43 +0000932 SmallVector<TypeIndex, 128> TypeMap;
933 SmallVector<TypeIndex, 128> IdMap;
Zachary Turner8fb441a2017-05-18 23:03:41 +0000934 if (File.hasPDBTpiStream()) {
935 auto &Tpi = ExitOnErr(File.getPDBTpiStream());
Zachary Turnerd4136e92017-05-22 21:07:43 +0000936 ExitOnErr(codeview::mergeTypeRecords(MergedTpi, TypeMap, nullptr,
Zachary Turnercfd80652017-05-24 00:35:32 +0000937 Tpi.typeArray()));
Zachary Turner8fb441a2017-05-18 23:03:41 +0000938 }
939 if (File.hasPDBIpiStream()) {
940 auto &Ipi = ExitOnErr(File.getPDBIpiStream());
Zachary Turnerd4136e92017-05-22 21:07:43 +0000941 ExitOnErr(codeview::mergeIdRecords(MergedIpi, TypeMap, IdMap,
Zachary Turnercfd80652017-05-24 00:35:32 +0000942 Ipi.typeArray()));
Zachary Turner8fb441a2017-05-18 23:03:41 +0000943 }
944 }
945
946 // Then write the PDB.
947 PDBFileBuilder Builder(Allocator);
948 ExitOnErr(Builder.initialize(4096));
949 // Add each of the reserved streams. We might not put any data in them,
950 // but at least they have to be present.
951 for (uint32_t I = 0; I < kSpecialStreamCount; ++I)
952 ExitOnErr(Builder.getMsfBuilder().addStream(0));
953
954 auto &DestTpi = Builder.getTpiBuilder();
955 auto &DestIpi = Builder.getIpiBuilder();
Reid Klecknerded38802017-05-23 18:23:59 +0000956 MergedTpi.ForEachRecord([&DestTpi](TypeIndex TI, ArrayRef<uint8_t> Data) {
957 DestTpi.addTypeRecord(Data, None);
958 });
959 MergedIpi.ForEachRecord([&DestIpi](TypeIndex TI, ArrayRef<uint8_t> Data) {
960 DestIpi.addTypeRecord(Data, None);
961 });
Zachary Turner990d0c82017-06-12 21:34:53 +0000962 Builder.getInfoBuilder().addFeature(PdbRaw_FeatureSig::VC140);
Zachary Turner8fb441a2017-05-18 23:03:41 +0000963
Zachary Turnerbdc16ed2017-05-19 06:25:09 +0000964 SmallString<64> OutFile(opts::merge::PdbOutputFile);
Zachary Turner8fb441a2017-05-18 23:03:41 +0000965 if (OutFile.empty()) {
966 OutFile = opts::merge::InputFilenames[0];
967 llvm::sys::path::replace_extension(OutFile, "merged.pdb");
968 }
969 ExitOnErr(Builder.commit(OutFile));
970}
971
Zachary Turner6b124f22017-06-23 19:54:44 +0000972static bool parseRange(StringRef Str,
973 Optional<opts::bytes::NumberRange> &Parsed) {
974 if (Str.empty())
Zachary Turner99402032017-06-22 20:58:11 +0000975 return true;
976
977 llvm::Regex R("^([^-]+)(-([^-]+))?$");
978 llvm::SmallVector<llvm::StringRef, 2> Matches;
Zachary Turner6b124f22017-06-23 19:54:44 +0000979 if (!R.match(Str, &Matches))
Zachary Turner99402032017-06-22 20:58:11 +0000980 return false;
981
Zachary Turner6b124f22017-06-23 19:54:44 +0000982 Parsed.emplace();
983 if (!to_integer(Matches[1], Parsed->Min))
Zachary Turner99402032017-06-22 20:58:11 +0000984 return false;
985
986 if (!Matches[3].empty()) {
Zachary Turner6b124f22017-06-23 19:54:44 +0000987 Parsed->Max.emplace();
988 if (!to_integer(Matches[3], *Parsed->Max))
Zachary Turner99402032017-06-22 20:58:11 +0000989 return false;
990 }
991 return true;
992}
993
Zachary Turnere79b07e2017-06-26 17:22:36 +0000994static void simplifyChunkList(llvm::cl::list<opts::ModuleSubsection> &Chunks) {
995 // If this list contains "All" plus some other stuff, remove the other stuff
996 // and just keep "All" in the list.
997 if (!llvm::is_contained(Chunks, opts::ModuleSubsection::All))
998 return;
999 Chunks.reset();
1000 Chunks.push_back(opts::ModuleSubsection::All);
1001}
1002
Zachary Turnerfcb14ad2015-01-27 20:46:21 +00001003int main(int argc_, const char *argv_[]) {
1004 // Print a stack trace if we signal out.
Richard Smith2ad6d482016-06-09 00:53:21 +00001005 sys::PrintStackTraceOnErrorSignal(argv_[0]);
Zachary Turnerfcb14ad2015-01-27 20:46:21 +00001006 PrettyStackTraceProgram X(argc_, argv_);
1007
Zachary Turnerbd336e42017-06-09 20:46:17 +00001008 ExitOnErr.setBanner("llvm-pdbutil: ");
David Majnemerc165c882016-05-28 18:25:15 +00001009
Zachary Turnerfcb14ad2015-01-27 20:46:21 +00001010 SmallVector<const char *, 256> argv;
David Majnemer6e081262015-10-15 01:27:19 +00001011 SpecificBumpPtrAllocator<char> ArgAllocator;
David Majnemerc165c882016-05-28 18:25:15 +00001012 ExitOnErr(errorCodeToError(sys::Process::GetArgumentVector(
1013 argv, makeArrayRef(argv_, argc_), ArgAllocator)));
Zachary Turnerfcb14ad2015-01-27 20:46:21 +00001014
1015 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
1016
1017 cl::ParseCommandLineOptions(argv.size(), argv.data(), "LLVM PDB Dumper\n");
Zachary Turner6b124f22017-06-23 19:54:44 +00001018
1019 if (opts::BytesSubcommand) {
1020 if (!parseRange(opts::bytes::DumpBlockRangeOpt,
1021 opts::bytes::DumpBlockRange)) {
1022 errs() << "Argument '" << opts::bytes::DumpBlockRangeOpt
1023 << "' invalid format.\n";
1024 errs().flush();
1025 exit(1);
1026 }
1027 if (!parseRange(opts::bytes::DumpByteRangeOpt,
1028 opts::bytes::DumpByteRange)) {
1029 errs() << "Argument '" << opts::bytes::DumpByteRangeOpt
1030 << "' invalid format.\n";
1031 errs().flush();
1032 exit(1);
1033 }
Zachary Turner72c5b642016-09-09 18:17:52 +00001034 }
Zachary Turnera99000d2016-03-08 21:42:24 +00001035
Zachary Turner7df69952017-06-22 20:57:39 +00001036 if (opts::DumpSubcommand) {
1037 if (opts::dump::RawAll) {
1038 opts::dump::DumpLines = true;
1039 opts::dump::DumpInlineeLines = true;
1040 opts::dump::DumpXme = true;
1041 opts::dump::DumpXmi = true;
1042 opts::dump::DumpIds = true;
1043 opts::dump::DumpPublics = true;
1044 opts::dump::DumpSectionContribs = true;
1045 opts::dump::DumpSectionMap = true;
1046 opts::dump::DumpStreams = true;
Zachary Turner5f098522017-06-23 20:28:14 +00001047 opts::dump::DumpStreamBlocks = true;
Zachary Turner7df69952017-06-22 20:57:39 +00001048 opts::dump::DumpStringTable = true;
1049 opts::dump::DumpSummary = true;
1050 opts::dump::DumpSymbols = true;
1051 opts::dump::DumpIds = true;
1052 opts::dump::DumpIdExtras = true;
1053 opts::dump::DumpTypes = true;
1054 opts::dump::DumpTypeExtras = true;
1055 opts::dump::DumpModules = true;
1056 opts::dump::DumpModuleFiles = true;
Zachary Turner44a643c2017-01-12 22:28:15 +00001057 }
Zachary Turner7797c722015-03-02 04:39:56 +00001058 }
Zachary Turner3eedd162017-06-08 23:39:33 +00001059 if (opts::PdbToYamlSubcommand) {
1060 if (opts::pdb2yaml::All) {
1061 opts::pdb2yaml::StreamMetadata = true;
1062 opts::pdb2yaml::StreamDirectory = true;
1063 opts::pdb2yaml::PdbStream = true;
1064 opts::pdb2yaml::StringTable = true;
1065 opts::pdb2yaml::DbiStream = true;
1066 opts::pdb2yaml::TpiStream = true;
1067 opts::pdb2yaml::IpiStream = true;
Zachary Turner63055452017-06-15 22:24:24 +00001068 opts::pdb2yaml::DumpModules = true;
1069 opts::pdb2yaml::DumpModuleFiles = true;
1070 opts::pdb2yaml::DumpModuleSyms = true;
1071 opts::pdb2yaml::DumpModuleSubsections.push_back(
1072 opts::ModuleSubsection::All);
Zachary Turner3eedd162017-06-08 23:39:33 +00001073 }
Zachary Turnere79b07e2017-06-26 17:22:36 +00001074 simplifyChunkList(opts::pdb2yaml::DumpModuleSubsections);
Zachary Turner63055452017-06-15 22:24:24 +00001075
1076 if (opts::pdb2yaml::DumpModuleSyms || opts::pdb2yaml::DumpModuleFiles)
1077 opts::pdb2yaml::DumpModules = true;
1078
1079 if (opts::pdb2yaml::DumpModules)
1080 opts::pdb2yaml::DbiStream = true;
Zachary Turner3eedd162017-06-08 23:39:33 +00001081 }
Zachary Turnerfcb14ad2015-01-27 20:46:21 +00001082
Zachary Turner93839cb2016-06-02 05:07:49 +00001083 llvm::sys::InitializeCOMRAII COM(llvm::sys::COMThreadingMode::MultiThreaded);
Zachary Turnerfcb14ad2015-01-27 20:46:21 +00001084
Zachary Turnera30bd1a2016-06-30 17:42:48 +00001085 if (opts::PdbToYamlSubcommand) {
Zachary Turner8848a7a2016-07-06 18:05:57 +00001086 pdb2Yaml(opts::pdb2yaml::InputFilename.front());
Zachary Turnera30bd1a2016-06-30 17:42:48 +00001087 } else if (opts::YamlToPdbSubcommand) {
Bob Haarmande33a6372017-05-17 20:46:48 +00001088 if (opts::yaml2pdb::YamlPdbOutputFile.empty()) {
1089 SmallString<16> OutputFilename(opts::yaml2pdb::InputFilename.getValue());
1090 sys::path::replace_extension(OutputFilename, ".pdb");
1091 opts::yaml2pdb::YamlPdbOutputFile = OutputFilename.str();
1092 }
1093 yamlToPdb(opts::yaml2pdb::InputFilename);
Zachary Turnerd50c0132017-02-01 18:30:22 +00001094 } else if (opts::AnalyzeSubcommand) {
1095 dumpAnalysis(opts::analyze::InputFilename.front());
Zachary Turnera30bd1a2016-06-30 17:42:48 +00001096 } else if (opts::PrettySubcommand) {
1097 if (opts::pretty::Lines)
1098 opts::pretty::Compilands = true;
1099
1100 if (opts::pretty::All) {
1101 opts::pretty::Compilands = true;
1102 opts::pretty::Symbols = true;
1103 opts::pretty::Globals = true;
1104 opts::pretty::Types = true;
1105 opts::pretty::Externals = true;
1106 opts::pretty::Lines = true;
1107 }
1108
Zachary Turner63230a4e2017-04-06 23:43:12 +00001109 if (opts::pretty::Types) {
1110 opts::pretty::Classes = true;
1111 opts::pretty::Typedefs = true;
1112 opts::pretty::Enums = true;
1113 }
1114
Zachary Turnera30bd1a2016-06-30 17:42:48 +00001115 // When adding filters for excluded compilands and types, we need to
Zachary Turner72c5b642016-09-09 18:17:52 +00001116 // remember that these are regexes. So special characters such as * and \
1117 // need to be escaped in the regex. In the case of a literal \, this means
1118 // it needs to be escaped again in the C++. So matching a single \ in the
1119 // input requires 4 \es in the C++.
Zachary Turnera30bd1a2016-06-30 17:42:48 +00001120 if (opts::pretty::ExcludeCompilerGenerated) {
1121 opts::pretty::ExcludeTypes.push_back("__vc_attributes");
1122 opts::pretty::ExcludeCompilands.push_back("\\* Linker \\*");
1123 }
1124 if (opts::pretty::ExcludeSystemLibraries) {
1125 opts::pretty::ExcludeCompilands.push_back(
1126 "f:\\\\binaries\\\\Intermediate\\\\vctools\\\\crt_bld");
1127 opts::pretty::ExcludeCompilands.push_back("f:\\\\dd\\\\vctools\\\\crt");
1128 opts::pretty::ExcludeCompilands.push_back(
1129 "d:\\\\th.obj.x86fre\\\\minkernel");
1130 }
1131 std::for_each(opts::pretty::InputFilenames.begin(),
1132 opts::pretty::InputFilenames.end(), dumpPretty);
Zachary Turner7df69952017-06-22 20:57:39 +00001133 } else if (opts::DumpSubcommand) {
1134 std::for_each(opts::dump::InputFilenames.begin(),
1135 opts::dump::InputFilenames.end(), dumpRaw);
Zachary Turner99402032017-06-22 20:58:11 +00001136 } else if (opts::BytesSubcommand) {
1137 std::for_each(opts::bytes::InputFilenames.begin(),
1138 opts::bytes::InputFilenames.end(), dumpBytes);
Zachary Turner6ac232c2017-03-13 23:28:25 +00001139 } else if (opts::DiffSubcommand) {
1140 if (opts::diff::InputFilenames.size() != 2) {
1141 errs() << "diff subcommand expects exactly 2 arguments.\n";
1142 exit(1);
1143 }
1144 diff(opts::diff::InputFilenames[0], opts::diff::InputFilenames[1]);
Zachary Turner8fb441a2017-05-18 23:03:41 +00001145 } else if (opts::MergeSubcommand) {
1146 if (opts::merge::InputFilenames.size() < 2) {
1147 errs() << "merge subcommand requires at least 2 input files.\n";
1148 exit(1);
1149 }
1150 mergePdbs();
Zachary Turner1dc9fd32016-06-14 20:48:36 +00001151 }
Zachary Turnerfcb14ad2015-01-27 20:46:21 +00001152
Zachary Turner819e77d2016-05-06 20:51:57 +00001153 outs().flush();
Zachary Turnerfcb14ad2015-01-27 20:46:21 +00001154 return 0;
1155}