1 //===- PDBExtras.cpp - helper functions and classes for PDBs -----*- C++-*-===//
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"
15 #define CASE_OUTPUT_ENUM_CLASS_STR(Class, Value, Str, Stream) \
20 #define CASE_OUTPUT_ENUM_CLASS_NAME(Class, Value, Stream) \
21 CASE_OUTPUT_ENUM_CLASS_STR(Class, Value, #Value, Stream)
23 raw_ostream &llvm::operator<<(raw_ostream &OS, const stream_indent &Indent) {
24 OS.indent(Indent.Width);
28 raw_ostream &llvm::operator<<(raw_ostream &OS, const PDB_VariantType &Type) {
30 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, Bool, OS)
31 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, Single, OS)
32 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, Double, OS)
33 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, Int8, OS)
34 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, Int16, OS)
35 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, Int32, OS)
36 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, Int64, OS)
37 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, UInt8, OS)
38 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, UInt16, OS)
39 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, UInt32, OS)
40 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, UInt64, OS)
47 raw_ostream &llvm::operator<<(raw_ostream &OS, const PDB_DataKind &Data) {
49 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, Unknown, "unknown", OS)
50 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, Local, "local", OS)
51 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, StaticLocal, "static local", OS)
52 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, Param, "param", OS)
53 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, ObjectPtr, "this ptr", OS)
54 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, FileStatic, "static global", OS)
55 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, Global, "global", OS)
56 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, Member, "member", OS)
57 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, StaticMember, "static member", OS)
58 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, Constant, "const", OS)
63 raw_ostream &llvm::operator<<(raw_ostream &OS, const PDB_RegisterId &Reg) {
65 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, AL, OS)
66 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, CL, OS)
67 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, DL, OS)
68 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, BL, OS)
69 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, AH, OS)
70 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, CH, OS)
71 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, DH, OS)
72 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, BH, OS)
73 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, AX, OS)
74 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, CX, OS)
75 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, DX, OS)
76 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, BX, OS)
77 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, SP, OS)
78 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, BP, OS)
79 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, SI, OS)
80 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, DI, OS)
81 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, EAX, OS)
82 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, ECX, OS)
83 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, EDX, OS)
84 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, EBX, OS)
85 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, ESP, OS)
86 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, EBP, OS)
87 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, ESI, OS)
88 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, EDI, OS)
89 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, ES, OS)
90 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, CS, OS)
91 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, SS, OS)
92 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, DS, OS)
93 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, FS, OS)
94 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, GS, OS)
95 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, IP, OS)
96 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, RAX, OS)
97 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, RBX, OS)
98 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, RCX, OS)
99 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, RDX, OS)
100 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, RSI, OS)
101 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, RDI, OS)
102 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, RBP, OS)
103 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, RSP, OS)
104 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, R8, OS)
105 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, R9, OS)
106 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, R10, OS)
107 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, R11, OS)
108 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, R12, OS)
109 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, R13, OS)
110 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, R14, OS)
111 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, R15, OS)
113 OS << static_cast<int>(Reg);
118 raw_ostream &llvm::operator<<(raw_ostream &OS, const PDB_LocType &Loc) {
120 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, Static, "static", OS)
121 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, TLS, "tls", OS)
122 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, RegRel, "regrel", OS)
123 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, ThisRel, "thisrel", OS)
124 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, Enregistered, "register", OS)
125 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, BitField, "bitfield", OS)
126 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, Slot, "slot", OS)
127 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, IlRel, "IL rel", OS)
128 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, MetaData, "metadata", OS)
129 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, Constant, "constant", OS)
136 raw_ostream &llvm::operator<<(raw_ostream &OS, const PDB_ThunkOrdinal &Thunk) {
138 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_ThunkOrdinal, BranchIsland, OS)
139 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_ThunkOrdinal, Pcode, OS)
140 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_ThunkOrdinal, Standard, OS)
141 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_ThunkOrdinal, ThisAdjustor, OS)
142 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_ThunkOrdinal, TrampIncremental, OS)
143 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_ThunkOrdinal, UnknownLoad, OS)
144 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_ThunkOrdinal, Vcall, OS)
149 raw_ostream &llvm::operator<<(raw_ostream &OS, const PDB_Checksum &Checksum) {
151 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Checksum, None, OS)
152 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Checksum, MD5, OS)
153 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Checksum, SHA1, OS)
158 raw_ostream &llvm::operator<<(raw_ostream &OS, const PDB_Lang &Lang) {
160 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, C, OS)
161 CASE_OUTPUT_ENUM_CLASS_STR(PDB_Lang, Cpp, "C++", OS)
162 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Fortran, OS)
163 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Masm, OS)
164 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Pascal, OS)
165 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Basic, OS)
166 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Cobol, OS)
167 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Link, OS)
168 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Cvtres, OS)
169 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Cvtpgd, OS)
170 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, CSharp, OS)
171 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, VB, OS)
172 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, ILAsm, OS)
173 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Java, OS)
174 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, JScript, OS)
175 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, MSIL, OS)
176 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, HLSL, OS)
181 raw_ostream &llvm::operator<<(raw_ostream &OS, const PDB_SymType &Tag) {
183 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Exe, OS)
184 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Compiland, OS)
185 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, CompilandDetails, OS)
186 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, CompilandEnv, OS)
187 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Function, OS)
188 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Block, OS)
189 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Data, OS)
190 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Annotation, OS)
191 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Label, OS)
192 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, PublicSymbol, OS)
193 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, UDT, OS)
194 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Enum, OS)
195 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, FunctionSig, OS)
196 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, PointerType, OS)
197 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, ArrayType, OS)
198 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, BuiltinType, OS)
199 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Typedef, OS)
200 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, BaseClass, OS)
201 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Friend, OS)
202 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, FunctionArg, OS)
203 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, FuncDebugStart, OS)
204 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, FuncDebugEnd, OS)
205 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, UsingNamespace, OS)
206 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, VTableShape, OS)
207 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, VTable, OS)
208 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Custom, OS)
209 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Thunk, OS)
210 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, CustomType, OS)
211 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, ManagedType, OS)
212 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Dimension, OS)
219 raw_ostream &llvm::operator<<(raw_ostream &OS, const PDB_UniqueId &Id) {
220 static const char *Lookup = "0123456789ABCDEF";
222 static_assert(sizeof(PDB_UniqueId) == 16, "Expected 16-byte GUID");
223 ArrayRef<uint8_t> GuidBytes(reinterpret_cast<const uint8_t*>(&Id), 16);
225 for (int i=0; i < 16;) {
226 uint8_t Byte = GuidBytes[i];
227 uint8_t HighNibble = (Byte >> 4) & 0xF;
228 uint8_t LowNibble = Byte & 0xF;
229 OS << Lookup[HighNibble] << Lookup[LowNibble];
231 if (i>=4 && i<=10 && i%2==0)
238 raw_ostream &llvm::operator<<(raw_ostream &OS, const Variant &Value) {
239 switch (Value.Type) {
240 case PDB_VariantType::Bool:
241 OS << (Value.Bool ? "true" : "false");
243 case PDB_VariantType::Double:
246 case PDB_VariantType::Int16:
249 case PDB_VariantType::Int32:
252 case PDB_VariantType::Int64:
255 case PDB_VariantType::Int8:
258 case PDB_VariantType::Single:
261 case PDB_VariantType::UInt16:
264 case PDB_VariantType::UInt32:
267 case PDB_VariantType::UInt64:
270 case PDB_VariantType::UInt8:
276 OS << " {" << Value.Type << "}";
280 raw_ostream &llvm::operator<<(raw_ostream &OS, const VersionInfo &Version) {
281 OS << Version.Major << "." << Version.Minor << "." << Version.Build;
285 raw_ostream &llvm::operator<<(raw_ostream &OS, const TagStats &Stats) {
286 for (auto Tag : Stats) {
287 OS << Tag.first << ":" << Tag.second << " ";