lib/DebugInfo/PDB/PDBExtras.cpp

   1 //===- PDBExtras.cpp - helper functions and classes for PDBs -----*- C++-*-===//
   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
  13 using namespace llvm;
  14
  15 #define CASE_OUTPUT_ENUM_CLASS_STR(Class, Value, Str, Stream)                  \
  16   case Class::Value:                                                           \
  17     Stream << Str;                                                             \
  18     break;
  19
  20 #define CASE_OUTPUT_ENUM_CLASS_NAME(Class, Value, Stream)                      \
  21   CASE_OUTPUT_ENUM_CLASS_STR(Class, Value, #Value, Stream)
  22
  23 raw_ostream &llvm::operator<<(raw_ostream &OS, const stream_indent &Indent) {
  24   OS.indent(Indent.Width);
  25   return OS;
  26 }
  27
  28 raw_ostream &llvm::operator<<(raw_ostream &OS, const PDB_RegisterId &Reg) {
  29   switch (Reg) {
  30     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, AL, OS)
  31     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, CL, OS)
  32     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, DL, OS)
  33     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, BL, OS)
  34     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, AH, OS)
  35     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, CH, OS)
  36     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, DH, OS)
  37     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, BH, OS)
  38     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, AX, OS)
  39     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, CX, OS)
  40     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, DX, OS)
  41     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, BX, OS)
  42     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, SP, OS)
  43     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, BP, OS)
  44     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, SI, OS)
  45     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, DI, OS)
  46     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, EAX, OS)
  47     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, ECX, OS)
  48     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, EDX, OS)
  49     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, EBX, OS)
  50     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, ESP, OS)
  51     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, EBP, OS)
  52     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, ESI, OS)
  53     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, EDI, OS)
  54     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, ES, OS)
  55     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, CS, OS)
  56     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, SS, OS)
  57     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, DS, OS)
  58     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, FS, OS)
  59     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, GS, OS)
  60     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, IP, OS)
  61     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, RAX, OS)
  62     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, RBX, OS)
  63     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, RCX, OS)
  64     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, RDX, OS)
  65     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, RSI, OS)
  66     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, RDI, OS)
  67     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, RBP, OS)
  68     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, RSP, OS)
  69     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, R8, OS)
  70     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, R9, OS)
  71     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, R10, OS)
  72     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, R11, OS)
  73     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, R12, OS)
  74     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, R13, OS)
  75     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, R14, OS)
  76     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_RegisterId, R15, OS)
  77   default:
  78     OS << "Unknown";
  79   }
  80   return OS;
  81 }
  82
  83 raw_ostream &llvm::operator<<(raw_ostream &OS, const PDB_LocType &Loc) {
  84   switch (Loc) {
  85     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_LocType, Static, OS)
  86     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_LocType, TLS, OS)
  87     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_LocType, RegRel, OS)
  88     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_LocType, ThisRel, OS)
  89     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_LocType, Enregistered, OS)
  90     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_LocType, BitField, OS)
  91     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_LocType, Slot, OS)
  92     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_LocType, IlRel, OS)
  93     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_LocType, MetaData, OS)
  94     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_LocType, Constant, OS)
  95   default:
  96     OS << "Unknown";
  97   }
  98   return OS;
  99 }
 100
 101 raw_ostream &llvm::operator<<(raw_ostream &OS, const PDB_ThunkOrdinal &Thunk) {
 102   switch (Thunk) {
 103     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_ThunkOrdinal, BranchIsland, OS)
 104     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_ThunkOrdinal, Pcode, OS)
 105     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_ThunkOrdinal, Standard, OS)
 106     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_ThunkOrdinal, ThisAdjustor, OS)
 107     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_ThunkOrdinal, TrampIncremental, OS)
 108     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_ThunkOrdinal, UnknownLoad, OS)
 109     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_ThunkOrdinal, Vcall, OS)
 110   default:
 111     OS << "Unknown";
 112   }
 113   return OS;
 114 }
 115
 116 raw_ostream &llvm::operator<<(raw_ostream &OS, const PDB_Checksum &Checksum) {
 117   switch (Checksum) {
 118     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Checksum, None, OS)
 119     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Checksum, MD5, OS)
 120     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Checksum, SHA1, OS)
 121   default:
 122     OS << "Unknown";
 123   }
 124   return OS;
 125 }
 126
 127 raw_ostream &llvm::operator<<(raw_ostream &OS, const PDB_Lang &Lang) {
 128   switch (Lang) {
 129     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, C, OS)
 130     CASE_OUTPUT_ENUM_CLASS_STR(PDB_Lang, Cpp, "C++", OS)
 131     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Fortran, OS)
 132     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Masm, OS)
 133     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Pascal, OS)
 134     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Basic, OS)
 135     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Cobol, OS)
 136     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Link, OS)
 137     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Cvtres, OS)
 138     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Cvtpgd, OS)
 139     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, CSharp, OS)
 140     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, VB, OS)
 141     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, ILAsm, OS)
 142     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, Java, OS)
 143     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, JScript, OS)
 144     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, MSIL, OS)
 145     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_Lang, HLSL, OS)
 146   default:
 147     OS << "Unknown";
 148   }
 149   return OS;
 150 }
 151
 152 raw_ostream &llvm::operator<<(raw_ostream &OS, const PDB_SymType &Tag) {
 153   switch (Tag) {
 154     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Exe, OS)
 155     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Compiland, OS)
 156     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, CompilandDetails, OS)
 157     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, CompilandEnv, OS)
 158     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Function, OS)
 159     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Block, OS)
 160     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Data, OS)
 161     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Annotation, OS)
 162     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Label, OS)
 163     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, PublicSymbol, OS)
 164     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, UDT, OS)
 165     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Enum, OS)
 166     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, FunctionSig, OS)
 167     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, PointerType, OS)
 168     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, ArrayType, OS)
 169     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, BuiltinType, OS)
 170     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Typedef, OS)
 171     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, BaseClass, OS)
 172     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Friend, OS)
 173     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, FunctionArg, OS)
 174     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, FuncDebugStart, OS)
 175     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, FuncDebugEnd, OS)
 176     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, UsingNamespace, OS)
 177     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, VTableShape, OS)
 178     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, VTable, OS)
 179     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Custom, OS)
 180     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Thunk, OS)
 181     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, CustomType, OS)
 182     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, ManagedType, OS)
 183     CASE_OUTPUT_ENUM_CLASS_NAME(PDB_SymType, Dimension, OS)
 184   default:
 185     OS << "Unknown";
 186   }
 187   return OS;
 188 }
 189
 190 raw_ostream &llvm::operator<<(raw_ostream &OS, const PDB_UniqueId &Id) {
 191   static const char *Lookup = "0123456789ABCDEF";
 192
 193   static_assert(sizeof(PDB_UniqueId) == 16, "Expected 16-byte GUID");
 194   ArrayRef<uint8_t> GuidBytes(reinterpret_cast<const uint8_t*>(&Id), 16);
 195   OS << "{";
 196   for (int i=0; i < 16;) {
 197     uint8_t Byte = GuidBytes[i];
 198     uint8_t HighNibble = (Byte >> 4) & 0xF;
 199     uint8_t LowNibble = Byte & 0xF;
 200     OS << Lookup[HighNibble] << Lookup[LowNibble];
 201     ++i;
 202     if (i>=4 && i<=10 && i%2==0)
 203       OS << "-";
 204   }
 205   OS << "}";
 206   return OS;
 207 }
 208
 209 raw_ostream &llvm::operator<<(raw_ostream &OS, const VersionInfo &Version) {
 210   OS << Version.Major << "." << Version.Minor << "." << Version.Build;
 211   return OS;
 212 }
 213
 214 raw_ostream &llvm::operator<<(raw_ostream &OS, const TagStats &Stats) {
 215   for (auto Tag : Stats) {
 216     OS << Tag.first << ":" << Tag.second << " ";
 217   }
 218   return OS;
 219 }