1 //===- PDBExtras.cpp - helper functions and classes for PDBs --------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #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"
14 
15 using namespace llvm;
16 using namespace llvm::pdb;
17 
18 #define CASE_OUTPUT_ENUM_CLASS_STR(Class, Value, Str, Stream)                  \
19   case Class::Value:                                                           \
20     Stream << Str;                                                             \
21     break;
22 
23 #define CASE_OUTPUT_ENUM_CLASS_NAME(Class, Value, Stream)                      \
24   CASE_OUTPUT_ENUM_CLASS_STR(Class, Value, #Value, Stream)
25 
26 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS,
27                                    const PDB_VariantType &Type) {
28   switch (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)
40     default:
41       OS << "Unknown";
42   }
43   return OS;
44 }
45 
46 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS,
47                                    const PDB_CallingConv &Conv) {
48   OS << "__";
49   switch (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)
74   }
75   return OS;
76 }
77 
78 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, const PDB_DataKind &Data) {
79   switch (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)
90   }
91   return OS;
92 }
93 
94 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS,
95                                    const codeview::RegisterId &Reg) {
96   switch (Reg) {
97 #define CV_REGISTER(name, val) case codeview::RegisterId::name: OS << #name; return OS;
98 #include "llvm/DebugInfo/CodeView/CodeViewRegisters.def"
99 #undef CV_REGISTER
100   }
101   OS << static_cast<int>(Reg);
102   return OS;
103 }
104 
105 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, const PDB_LocType &Loc) {
106   switch (Loc) {
107     CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, Static, "static", OS)
108     CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, TLS, "tls", OS)
109     CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, RegRel, "regrel", OS)
110     CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, ThisRel, "thisrel", OS)
111     CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, Enregistered, "register", OS)
112     CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, BitField, "bitfield", OS)
113     CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, Slot, "slot", OS)
114     CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, IlRel, "IL rel", OS)
115     CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, MetaData, "metadata", OS)
116     CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, Constant, "constant", OS)
117   default:
118     OS << "Unknown";
119   }
120   return OS;
121 }
122 
123 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS,
124                                    const codeview::ThunkOrdinal &Thunk) {
125   switch (Thunk) {
126     CASE_OUTPUT_ENUM_CLASS_NAME(codeview::ThunkOrdinal, BranchIsland, OS)
127     CASE_OUTPUT_ENUM_CLASS_NAME(codeview::ThunkOrdinal, Pcode, OS)
128     CASE_OUTPUT_ENUM_CLASS_NAME(codeview::ThunkOrdinal, Standard, OS)
129     CASE_OUTPUT_ENUM_CLASS_NAME(codeview::ThunkOrdinal, ThisAdjustor, OS)
130     CASE_OUTPUT_ENUM_CLASS_NAME(codeview::ThunkOrdinal, TrampIncremental, OS)
131     CASE_OUTPUT_ENUM_CLASS_NAME(codeview::ThunkOrdinal, UnknownLoad, OS)
132     CASE_OUTPUT_ENUM_CLASS_NAME(codeview::ThunkOrdinal, Vcall, OS)
133   }
134   return OS;
135 }
136 
137 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS,
138                                    const PDB_Checksum &Checksum) {
139   switch (Checksum) {
140     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Checksum, None, OS)
141     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Checksum, MD5, OS)
142     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Checksum, SHA1, OS)
143   }
144   return OS;
145 }
146 
147 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, const PDB_Lang &Lang) {
148   switch (Lang) {
149     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, C, OS)
150     CASE_OUTPUT_ENUM_CLASS_STR(PDB_Lang, Cpp, "C++", OS)
151     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Fortran, OS)
152     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Masm, OS)
153     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Pascal, OS)
154     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Basic, OS)
155     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Cobol, OS)
156     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Link, OS)
157     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Cvtres, OS)
158     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Cvtpgd, OS)
159     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, CSharp, OS)
160     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, VB, OS)
161     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, ILAsm, OS)
162     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Java, OS)
163     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, JScript, OS)
164     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, MSIL, OS)
165     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, HLSL, OS)
166     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, D, OS)
167   }
168   return OS;
169 }
170 
171 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, const PDB_SymType &Tag) {
172   switch (Tag) {
173     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Exe, OS)
174     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Compiland, OS)
175     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, CompilandDetails, OS)
176     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, CompilandEnv, OS)
177     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Function, OS)
178     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Block, OS)
179     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Data, OS)
180     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Annotation, OS)
181     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Label, OS)
182     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, PublicSymbol, OS)
183     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, UDT, OS)
184     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Enum, OS)
185     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, FunctionSig, OS)
186     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, PointerType, OS)
187     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, ArrayType, OS)
188     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, BuiltinType, OS)
189     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Typedef, OS)
190     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, BaseClass, OS)
191     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Friend, OS)
192     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, FunctionArg, OS)
193     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, FuncDebugStart, OS)
194     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, FuncDebugEnd, OS)
195     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, UsingNamespace, OS)
196     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, VTableShape, OS)
197     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, VTable, OS)
198     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Custom, OS)
199     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Thunk, OS)
200     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, CustomType, OS)
201     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, ManagedType, OS)
202     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Dimension, OS)
203   default:
204     OS << "Unknown";
205   }
206   return OS;
207 }
208 
209 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS,
210                                    const PDB_MemberAccess &Access) {
211   switch (Access) {
212     CASE_OUTPUT_ENUM_CLASS_STR(PDB_MemberAccess, Public, "public", OS)
213     CASE_OUTPUT_ENUM_CLASS_STR(PDB_MemberAccess, Protected, "protected", OS)
214     CASE_OUTPUT_ENUM_CLASS_STR(PDB_MemberAccess, Private, "private", OS)
215   }
216   return OS;
217 }
218 
219 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, const PDB_UdtType &Type) {
220   switch (Type) {
221     CASE_OUTPUT_ENUM_CLASS_STR(PDB_UdtType, Class, "class", OS)
222     CASE_OUTPUT_ENUM_CLASS_STR(PDB_UdtType, Struct, "struct", OS)
223     CASE_OUTPUT_ENUM_CLASS_STR(PDB_UdtType, Interface, "interface", OS)
224     CASE_OUTPUT_ENUM_CLASS_STR(PDB_UdtType, Union, "union", OS)
225   }
226   return OS;
227 }
228 
229 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS,
230                                    const PDB_Machine &Machine) {
231   switch (Machine) {
232     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, Am33, OS)
233     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, Amd64, OS)
234     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, Arm, OS)
235     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, ArmNT, OS)
236     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, Ebc, OS)
237     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, x86, OS)
238     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, Ia64, OS)
239     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, M32R, OS)
240     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, Mips16, OS)
241     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, MipsFpu, OS)
242     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, MipsFpu16, OS)
243     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, PowerPC, OS)
244     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, PowerPCFP, OS)
245     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, R4000, OS)
246     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, SH3, OS)
247     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, SH3DSP, OS)
248     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, SH4, OS)
249     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, SH5, OS)
250     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, Thumb, OS)
251     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, WceMipsV2, OS)
252   default:
253     OS << "Unknown";
254   }
255   return OS;
256 }
257 
258 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, const Variant &Value) {
259   switch (Value.Type) {
260     case PDB_VariantType::Bool:
261       OS << (Value.Value.Bool ? "true" : "false");
262       break;
263     case PDB_VariantType::Double:
264       OS << Value.Value.Double;
265       break;
266     case PDB_VariantType::Int16:
267       OS << Value.Value.Int16;
268       break;
269     case PDB_VariantType::Int32:
270       OS << Value.Value.Int32;
271       break;
272     case PDB_VariantType::Int64:
273       OS << Value.Value.Int64;
274       break;
275     case PDB_VariantType::Int8:
276       OS << static_cast<int>(Value.Value.Int8);
277       break;
278     case PDB_VariantType::Single:
279       OS << Value.Value.Single;
280       break;
281     case PDB_VariantType::UInt16:
282       OS << Value.Value.Double;
283       break;
284     case PDB_VariantType::UInt32:
285       OS << Value.Value.UInt32;
286       break;
287     case PDB_VariantType::UInt64:
288       OS << Value.Value.UInt64;
289       break;
290     case PDB_VariantType::UInt8:
291       OS << static_cast<unsigned>(Value.Value.UInt8);
292       break;
293     case PDB_VariantType::String:
294       OS << Value.Value.String;
295       break;
296     default:
297       OS << Value.Type;
298   }
299   return OS;
300 }
301 
302 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS,
303                                    const VersionInfo &Version) {
304   OS << Version.Major << "." << Version.Minor << "." << Version.Build;
305   return OS;
306 }
307 
308 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, const TagStats &Stats) {
309   for (auto Tag : Stats) {
310     OS << Tag.first << ":" << Tag.second << " ";
311   }
312   return OS;
313 }
314