1 //===- PDBExtras.cpp - helper functions and classes for PDBs --------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "llvm/DebugInfo/PDB/PDBExtras.h"
11 #include "llvm/ADT/ArrayRef.h"
12 #include "llvm/DebugInfo/CodeView/Formatters.h"
13 #include "llvm/Support/raw_ostream.h"
16 using namespace llvm::pdb;
18 #define CASE_OUTPUT_ENUM_CLASS_STR(Class, Value, Str, Stream) \
23 #define CASE_OUTPUT_ENUM_CLASS_NAME(Class, Value, Stream) \
24 CASE_OUTPUT_ENUM_CLASS_STR(Class, Value, #Value, Stream)
26 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS,
27 const PDB_VariantType &Type) {
29 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, Bool, OS)
30 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, Single, OS)
31 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, Double, OS)
32 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, Int8, OS)
33 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, Int16, OS)
34 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, Int32, OS)
35 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, Int64, OS)
36 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, UInt8, OS)
37 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, UInt16, OS)
38 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, UInt32, OS)
39 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, UInt64, OS)
46 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS,
47 const PDB_CallingConv &Conv) {
50 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, NearC , "cdecl", OS)
51 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, FarC , "cdecl", OS)
52 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, NearPascal , "pascal", OS)
53 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, FarPascal , "pascal", OS)
54 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, NearFast , "fastcall", OS)
55 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, FarFast , "fastcall", OS)
56 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, NearStdCall, "stdcall", OS)
57 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, FarStdCall , "stdcall", OS)
58 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, NearSysCall, "syscall", OS)
59 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, FarSysCall , "syscall", OS)
60 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, ThisCall , "thiscall", OS)
61 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, MipsCall , "mipscall", OS)
62 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, Generic , "genericcall", OS)
63 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, AlphaCall , "alphacall", OS)
64 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, PpcCall , "ppccall", OS)
65 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, SHCall , "superhcall", OS)
66 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, ArmCall , "armcall", OS)
67 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, AM33Call , "am33call", OS)
68 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, TriCall , "tricall", OS)
69 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, SH5Call , "sh5call", OS)
70 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, M32RCall , "m32rcall", OS)
71 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, ClrCall , "clrcall", OS)
72 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, Inline , "inlinecall", OS)
73 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, NearVector , "vectorcall", OS)
78 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, const PDB_DataKind &Data) {
80 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, Unknown, "unknown", OS)
81 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, Local, "local", OS)
82 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, StaticLocal, "static local", OS)
83 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, Param, "param", OS)
84 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, ObjectPtr, "this ptr", OS)
85 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, FileStatic, "static global", OS)
86 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, Global, "global", OS)
87 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, Member, "member", OS)
88 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, StaticMember, "static member", OS)
89 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, Constant, "const", OS)
94 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS,
95 const codeview::RegisterId &Reg) {
97 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, AL, OS)
98 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, CL, OS)
99 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, DL, OS)
100 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, BL, OS)
101 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, AH, OS)
102 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, CH, OS)
103 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, DH, OS)
104 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, BH, OS)
105 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, AX, OS)
106 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, CX, OS)
107 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, DX, OS)
108 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, BX, OS)
109 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, SP, OS)
110 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, BP, OS)
111 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, SI, OS)
112 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, DI, OS)
113 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, EAX, OS)
114 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, ECX, OS)
115 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, EDX, OS)
116 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, EBX, OS)
117 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, ESP, OS)
118 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, EBP, OS)
119 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, ESI, OS)
120 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, EDI, OS)
121 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, ES, OS)
122 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, CS, OS)
123 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, SS, OS)
124 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, DS, OS)
125 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, FS, OS)
126 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, GS, OS)
127 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, IP, OS)
128 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, RAX, OS)
129 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, RBX, OS)
130 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, RCX, OS)
131 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, RDX, OS)
132 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, RSI, OS)
133 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, RDI, OS)
134 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, RBP, OS)
135 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, RSP, OS)
136 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, R8, OS)
137 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, R9, OS)
138 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, R10, OS)
139 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, R11, OS)
140 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, R12, OS)
141 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, R13, OS)
142 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, R14, OS)
143 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::RegisterId, R15, OS)
145 OS << static_cast<int>(Reg);
150 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, const PDB_LocType &Loc) {
152 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, Static, "static", OS)
153 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, TLS, "tls", OS)
154 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, RegRel, "regrel", OS)
155 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, ThisRel, "thisrel", OS)
156 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, Enregistered, "register", OS)
157 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, BitField, "bitfield", OS)
158 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, Slot, "slot", OS)
159 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, IlRel, "IL rel", OS)
160 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, MetaData, "metadata", OS)
161 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, Constant, "constant", OS)
168 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS,
169 const codeview::ThunkOrdinal &Thunk) {
171 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::ThunkOrdinal, BranchIsland, OS)
172 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::ThunkOrdinal, Pcode, OS)
173 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::ThunkOrdinal, Standard, OS)
174 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::ThunkOrdinal, ThisAdjustor, OS)
175 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::ThunkOrdinal, TrampIncremental, OS)
176 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::ThunkOrdinal, UnknownLoad, OS)
177 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::ThunkOrdinal, Vcall, OS)
182 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS,
183 const PDB_Checksum &Checksum) {
185 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Checksum, None, OS)
186 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Checksum, MD5, OS)
187 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Checksum, SHA1, OS)
192 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, const PDB_Lang &Lang) {
194 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, C, OS)
195 CASE_OUTPUT_ENUM_CLASS_STR(PDB_Lang, Cpp, "C++", OS)
196 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Fortran, OS)
197 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Masm, OS)
198 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Pascal, OS)
199 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Basic, OS)
200 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Cobol, OS)
201 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Link, OS)
202 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Cvtres, OS)
203 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Cvtpgd, OS)
204 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, CSharp, OS)
205 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, VB, OS)
206 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, ILAsm, OS)
207 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Java, OS)
208 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, JScript, OS)
209 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, MSIL, OS)
210 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, HLSL, OS)
215 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, const PDB_SymType &Tag) {
217 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Exe, OS)
218 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Compiland, OS)
219 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, CompilandDetails, OS)
220 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, CompilandEnv, OS)
221 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Function, OS)
222 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Block, OS)
223 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Data, OS)
224 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Annotation, OS)
225 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Label, OS)
226 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, PublicSymbol, OS)
227 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, UDT, OS)
228 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Enum, OS)
229 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, FunctionSig, OS)
230 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, PointerType, OS)
231 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, ArrayType, OS)
232 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, BuiltinType, OS)
233 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Typedef, OS)
234 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, BaseClass, OS)
235 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Friend, OS)
236 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, FunctionArg, OS)
237 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, FuncDebugStart, OS)
238 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, FuncDebugEnd, OS)
239 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, UsingNamespace, OS)
240 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, VTableShape, OS)
241 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, VTable, OS)
242 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Custom, OS)
243 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Thunk, OS)
244 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, CustomType, OS)
245 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, ManagedType, OS)
246 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Dimension, OS)
253 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS,
254 const PDB_MemberAccess &Access) {
256 CASE_OUTPUT_ENUM_CLASS_STR(PDB_MemberAccess, Public, "public", OS)
257 CASE_OUTPUT_ENUM_CLASS_STR(PDB_MemberAccess, Protected, "protected", OS)
258 CASE_OUTPUT_ENUM_CLASS_STR(PDB_MemberAccess, Private, "private", OS)
263 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, const PDB_UdtType &Type) {
265 CASE_OUTPUT_ENUM_CLASS_STR(PDB_UdtType, Class, "class", OS)
266 CASE_OUTPUT_ENUM_CLASS_STR(PDB_UdtType, Struct, "struct", OS)
267 CASE_OUTPUT_ENUM_CLASS_STR(PDB_UdtType, Interface, "interface", OS)
268 CASE_OUTPUT_ENUM_CLASS_STR(PDB_UdtType, Union, "union", OS)
273 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS,
274 const PDB_Machine &Machine) {
276 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, Am33, OS)
277 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, Amd64, OS)
278 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, Arm, OS)
279 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, ArmNT, OS)
280 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, Ebc, OS)
281 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, x86, OS)
282 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, Ia64, OS)
283 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, M32R, OS)
284 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, Mips16, OS)
285 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, MipsFpu, OS)
286 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, MipsFpu16, OS)
287 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, PowerPC, OS)
288 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, PowerPCFP, OS)
289 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, R4000, OS)
290 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, SH3, OS)
291 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, SH3DSP, OS)
292 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, SH4, OS)
293 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, SH5, OS)
294 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, Thumb, OS)
295 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, WceMipsV2, OS)
302 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, const Variant &Value) {
303 switch (Value.Type) {
304 case PDB_VariantType::Bool:
305 OS << (Value.Value.Bool ? "true" : "false");
307 case PDB_VariantType::Double:
308 OS << Value.Value.Double;
310 case PDB_VariantType::Int16:
311 OS << Value.Value.Int16;
313 case PDB_VariantType::Int32:
314 OS << Value.Value.Int32;
316 case PDB_VariantType::Int64:
317 OS << Value.Value.Int64;
319 case PDB_VariantType::Int8:
320 OS << static_cast<int>(Value.Value.Int8);
322 case PDB_VariantType::Single:
323 OS << Value.Value.Single;
325 case PDB_VariantType::UInt16:
326 OS << Value.Value.Double;
328 case PDB_VariantType::UInt32:
329 OS << Value.Value.UInt32;
331 case PDB_VariantType::UInt64:
332 OS << Value.Value.UInt64;
334 case PDB_VariantType::UInt8:
335 OS << static_cast<unsigned>(Value.Value.UInt8);
337 case PDB_VariantType::String:
338 OS << Value.Value.String;
346 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS,
347 const VersionInfo &Version) {
348 OS << Version.Major << "." << Version.Minor << "." << Version.Build;
352 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, const TagStats &Stats) {
353 for (auto Tag : Stats) {
354 OS << Tag.first << ":" << Tag.second << " ";