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/Support/raw_ostream.h" 13 14 using namespace llvm; 15 using namespace llvm::pdb; 16 17 #define CASE_OUTPUT_ENUM_CLASS_STR(Class, Value, Str, Stream) \ 18 case Class::Value: \ 19 Stream << Str; \ 20 break; 21 22 #define CASE_OUTPUT_ENUM_CLASS_NAME(Class, Value, Stream) \ 23 CASE_OUTPUT_ENUM_CLASS_STR(Class, Value, #Value, Stream) 24 25 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, 26 const PDB_VariantType &Type) { 27 switch (Type) { 28 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, Bool, OS) 29 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, Single, OS) 30 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, Double, OS) 31 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, Int8, OS) 32 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, Int16, OS) 33 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, Int32, OS) 34 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, Int64, OS) 35 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, UInt8, OS) 36 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, UInt16, OS) 37 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, UInt32, OS) 38 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_VariantType, UInt64, OS) 39 default: 40 OS << "Unknown"; 41 } 42 return OS; 43 } 44 45 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, 46 const PDB_BuiltinType &Type) { 47 switch (Type) { 48 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_BuiltinType, None, OS) 49 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_BuiltinType, Void, OS) 50 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_BuiltinType, Char, OS) 51 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_BuiltinType, WCharT, OS) 52 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_BuiltinType, Int, OS) 53 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_BuiltinType, UInt, OS) 54 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_BuiltinType, Float, OS) 55 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_BuiltinType, BCD, OS) 56 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_BuiltinType, Bool, OS) 57 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_BuiltinType, Long, OS) 58 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_BuiltinType, ULong, OS) 59 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_BuiltinType, Currency, OS) 60 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_BuiltinType, Date, OS) 61 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_BuiltinType, Variant, OS) 62 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_BuiltinType, Complex, OS) 63 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_BuiltinType, Bitfield, OS) 64 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_BuiltinType, BSTR, OS) 65 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_BuiltinType, HResult, OS) 66 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_BuiltinType, Char16, OS) 67 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_BuiltinType, Char32, OS) 68 } 69 return OS; 70 } 71 72 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, 73 const PDB_CallingConv &Conv) { 74 OS << "__"; 75 switch (Conv) { 76 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, NearC , "cdecl", OS) 77 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, FarC , "cdecl", OS) 78 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, NearPascal , "pascal", OS) 79 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, FarPascal , "pascal", OS) 80 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, NearFast , "fastcall", OS) 81 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, FarFast , "fastcall", OS) 82 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, NearStdCall, "stdcall", OS) 83 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, FarStdCall , "stdcall", OS) 84 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, NearSysCall, "syscall", OS) 85 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, FarSysCall , "syscall", OS) 86 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, ThisCall , "thiscall", OS) 87 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, MipsCall , "mipscall", OS) 88 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, Generic , "genericcall", OS) 89 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, AlphaCall , "alphacall", OS) 90 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, PpcCall , "ppccall", OS) 91 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, SHCall , "superhcall", OS) 92 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, ArmCall , "armcall", OS) 93 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, AM33Call , "am33call", OS) 94 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, TriCall , "tricall", OS) 95 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, SH5Call , "sh5call", OS) 96 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, M32RCall , "m32rcall", OS) 97 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, ClrCall , "clrcall", OS) 98 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, Inline , "inlinecall", OS) 99 CASE_OUTPUT_ENUM_CLASS_STR(PDB_CallingConv, NearVector , "vectorcall", OS) 100 } 101 return OS; 102 } 103 104 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, const PDB_DataKind &Data) { 105 switch (Data) { 106 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, Unknown, "unknown", OS) 107 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, Local, "local", OS) 108 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, StaticLocal, "static local", OS) 109 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, Param, "param", OS) 110 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, ObjectPtr, "this ptr", OS) 111 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, FileStatic, "static global", OS) 112 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, Global, "global", OS) 113 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, Member, "member", OS) 114 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, StaticMember, "static member", OS) 115 CASE_OUTPUT_ENUM_CLASS_STR(PDB_DataKind, Constant, "const", OS) 116 } 117 return OS; 118 } 119 120 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, 121 const codeview::RegisterId &Reg) { 122 switch (Reg) { 123 #define CV_REGISTER(name, val) case codeview::RegisterId::name: OS << #name; return OS; 124 #include "llvm/DebugInfo/CodeView/CodeViewRegisters.def" 125 #undef CV_REGISTER 126 } 127 OS << static_cast<int>(Reg); 128 return OS; 129 } 130 131 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, const PDB_LocType &Loc) { 132 switch (Loc) { 133 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, Static, "static", OS) 134 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, TLS, "tls", OS) 135 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, RegRel, "regrel", OS) 136 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, ThisRel, "thisrel", OS) 137 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, Enregistered, "register", OS) 138 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, BitField, "bitfield", OS) 139 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, Slot, "slot", OS) 140 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, IlRel, "IL rel", OS) 141 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, MetaData, "metadata", OS) 142 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, Constant, "constant", OS) 143 CASE_OUTPUT_ENUM_CLASS_STR(PDB_LocType, RegRelAliasIndir, 144 "regrelaliasindir", OS) 145 default: 146 OS << "Unknown"; 147 } 148 return OS; 149 } 150 151 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, 152 const codeview::ThunkOrdinal &Thunk) { 153 switch (Thunk) { 154 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::ThunkOrdinal, BranchIsland, OS) 155 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::ThunkOrdinal, Pcode, OS) 156 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::ThunkOrdinal, Standard, OS) 157 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::ThunkOrdinal, ThisAdjustor, OS) 158 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::ThunkOrdinal, TrampIncremental, OS) 159 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::ThunkOrdinal, UnknownLoad, OS) 160 CASE_OUTPUT_ENUM_CLASS_NAME(codeview::ThunkOrdinal, Vcall, OS) 161 } 162 return OS; 163 } 164 165 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, 166 const PDB_Checksum &Checksum) { 167 switch (Checksum) { 168 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Checksum, None, OS) 169 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Checksum, MD5, OS) 170 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Checksum, SHA1, OS) 171 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Checksum, SHA256, OS) 172 } 173 return OS; 174 } 175 176 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, const PDB_Lang &Lang) { 177 switch (Lang) { 178 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, C, OS) 179 CASE_OUTPUT_ENUM_CLASS_STR(PDB_Lang, Cpp, "C++", OS) 180 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Fortran, OS) 181 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Masm, OS) 182 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Pascal, OS) 183 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Basic, OS) 184 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Cobol, OS) 185 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Link, OS) 186 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Cvtres, OS) 187 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Cvtpgd, OS) 188 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, CSharp, OS) 189 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, VB, OS) 190 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, ILAsm, OS) 191 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Java, OS) 192 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, JScript, OS) 193 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, MSIL, OS) 194 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, HLSL, OS) 195 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, D, OS) 196 } 197 return OS; 198 } 199 200 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, const PDB_SymType &Tag) { 201 switch (Tag) { 202 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Exe, OS) 203 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Compiland, OS) 204 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, CompilandDetails, OS) 205 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, CompilandEnv, OS) 206 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Function, OS) 207 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Block, OS) 208 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Data, OS) 209 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Annotation, OS) 210 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Label, OS) 211 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, PublicSymbol, OS) 212 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, UDT, OS) 213 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Enum, OS) 214 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, FunctionSig, OS) 215 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, PointerType, OS) 216 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, ArrayType, OS) 217 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, BuiltinType, OS) 218 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Typedef, OS) 219 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, BaseClass, OS) 220 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Friend, OS) 221 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, FunctionArg, OS) 222 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, FuncDebugStart, OS) 223 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, FuncDebugEnd, OS) 224 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, UsingNamespace, OS) 225 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, VTableShape, OS) 226 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, VTable, OS) 227 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Custom, OS) 228 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Thunk, OS) 229 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, CustomType, OS) 230 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, ManagedType, OS) 231 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Dimension, OS) 232 default: 233 OS << "Unknown"; 234 } 235 return OS; 236 } 237 238 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, 239 const PDB_MemberAccess &Access) { 240 switch (Access) { 241 CASE_OUTPUT_ENUM_CLASS_STR(PDB_MemberAccess, Public, "public", OS) 242 CASE_OUTPUT_ENUM_CLASS_STR(PDB_MemberAccess, Protected, "protected", OS) 243 CASE_OUTPUT_ENUM_CLASS_STR(PDB_MemberAccess, Private, "private", OS) 244 } 245 return OS; 246 } 247 248 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, const PDB_UdtType &Type) { 249 switch (Type) { 250 CASE_OUTPUT_ENUM_CLASS_STR(PDB_UdtType, Class, "class", OS) 251 CASE_OUTPUT_ENUM_CLASS_STR(PDB_UdtType, Struct, "struct", OS) 252 CASE_OUTPUT_ENUM_CLASS_STR(PDB_UdtType, Interface, "interface", OS) 253 CASE_OUTPUT_ENUM_CLASS_STR(PDB_UdtType, Union, "union", OS) 254 } 255 return OS; 256 } 257 258 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, 259 const PDB_Machine &Machine) { 260 switch (Machine) { 261 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, Am33, OS) 262 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, Amd64, OS) 263 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, Arm, OS) 264 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, ArmNT, OS) 265 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, Ebc, OS) 266 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, x86, OS) 267 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, Ia64, OS) 268 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, M32R, OS) 269 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, Mips16, OS) 270 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, MipsFpu, OS) 271 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, MipsFpu16, OS) 272 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, PowerPC, OS) 273 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, PowerPCFP, OS) 274 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, R4000, OS) 275 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, SH3, OS) 276 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, SH3DSP, OS) 277 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, SH4, OS) 278 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, SH5, OS) 279 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, Thumb, OS) 280 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Machine, WceMipsV2, OS) 281 default: 282 OS << "Unknown"; 283 } 284 return OS; 285 } 286 287 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, 288 const PDB_SourceCompression &Compression) { 289 switch (Compression) { 290 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SourceCompression, None, OS) 291 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SourceCompression, Huffman, OS) 292 CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SourceCompression, LZ, OS) 293 CASE_OUTPUT_ENUM_CLASS_STR(PDB_SourceCompression, RunLengthEncoded, "RLE", 294 OS) 295 } 296 return OS; 297 } 298 299 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, const Variant &Value) { 300 switch (Value.Type) { 301 case PDB_VariantType::Bool: 302 OS << (Value.Value.Bool ? "true" : "false"); 303 break; 304 case PDB_VariantType::Double: 305 OS << Value.Value.Double; 306 break; 307 case PDB_VariantType::Int16: 308 OS << Value.Value.Int16; 309 break; 310 case PDB_VariantType::Int32: 311 OS << Value.Value.Int32; 312 break; 313 case PDB_VariantType::Int64: 314 OS << Value.Value.Int64; 315 break; 316 case PDB_VariantType::Int8: 317 OS << static_cast<int>(Value.Value.Int8); 318 break; 319 case PDB_VariantType::Single: 320 OS << Value.Value.Single; 321 break; 322 case PDB_VariantType::UInt16: 323 OS << Value.Value.UInt16; 324 break; 325 case PDB_VariantType::UInt32: 326 OS << Value.Value.UInt32; 327 break; 328 case PDB_VariantType::UInt64: 329 OS << Value.Value.UInt64; 330 break; 331 case PDB_VariantType::UInt8: 332 OS << static_cast<unsigned>(Value.Value.UInt8); 333 break; 334 case PDB_VariantType::String: 335 OS << Value.Value.String; 336 break; 337 default: 338 OS << Value.Type; 339 } 340 return OS; 341 } 342 343 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, 344 const VersionInfo &Version) { 345 OS << Version.Major << "." << Version.Minor << "." << Version.Build; 346 return OS; 347 } 348 349 raw_ostream &llvm::pdb::operator<<(raw_ostream &OS, const TagStats &Stats) { 350 for (auto Tag : Stats) { 351 OS << Tag.first << ":" << Tag.second << " "; 352 } 353 return OS; 354 } 355