tools/obj2yaml/coff2yaml.cpp

   1 //===------ utils/obj2yaml.cpp - obj2yaml conversion tool -------*- 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 "obj2yaml.h"
  11 #include "llvm/Object/COFF.h"
  12
  13
  14 template <typename One, typename Two>
  15 struct pod_pair { // I'd much rather use std::pair, but it's not a POD
  16   One first;
  17   Two second;
  18 };
  19
  20 #define STRING_PAIR(x)  {llvm::COFF::x, #x}
  21 static const pod_pair<llvm::COFF::MachineTypes, const char *>
  22 MachineTypePairs [] = {
  23   STRING_PAIR(IMAGE_FILE_MACHINE_UNKNOWN),
  24   STRING_PAIR(IMAGE_FILE_MACHINE_AM33),
  25   STRING_PAIR(IMAGE_FILE_MACHINE_AMD64),
  26   STRING_PAIR(IMAGE_FILE_MACHINE_ARM),
  27   STRING_PAIR(IMAGE_FILE_MACHINE_ARMV7),
  28   STRING_PAIR(IMAGE_FILE_MACHINE_EBC),
  29   STRING_PAIR(IMAGE_FILE_MACHINE_I386),
  30   STRING_PAIR(IMAGE_FILE_MACHINE_IA64),
  31   STRING_PAIR(IMAGE_FILE_MACHINE_M32R),
  32   STRING_PAIR(IMAGE_FILE_MACHINE_MIPS16),
  33   STRING_PAIR(IMAGE_FILE_MACHINE_MIPSFPU),
  34   STRING_PAIR(IMAGE_FILE_MACHINE_MIPSFPU16),
  35   STRING_PAIR(IMAGE_FILE_MACHINE_POWERPC),
  36   STRING_PAIR(IMAGE_FILE_MACHINE_POWERPCFP),
  37   STRING_PAIR(IMAGE_FILE_MACHINE_R4000),
  38   STRING_PAIR(IMAGE_FILE_MACHINE_SH3),
  39   STRING_PAIR(IMAGE_FILE_MACHINE_SH3DSP),
  40   STRING_PAIR(IMAGE_FILE_MACHINE_SH4),
  41   STRING_PAIR(IMAGE_FILE_MACHINE_SH5),
  42   STRING_PAIR(IMAGE_FILE_MACHINE_THUMB),
  43   STRING_PAIR(IMAGE_FILE_MACHINE_WCEMIPSV2)
  44 };
  45
  46 static const pod_pair<llvm::COFF::SectionCharacteristics, const char *>
  47 SectionCharacteristicsPairs1 [] = {
  48   STRING_PAIR(IMAGE_SCN_TYPE_NO_PAD),
  49   STRING_PAIR(IMAGE_SCN_CNT_CODE),
  50   STRING_PAIR(IMAGE_SCN_CNT_INITIALIZED_DATA),
  51   STRING_PAIR(IMAGE_SCN_CNT_UNINITIALIZED_DATA),
  52   STRING_PAIR(IMAGE_SCN_LNK_OTHER),
  53   STRING_PAIR(IMAGE_SCN_LNK_INFO),
  54   STRING_PAIR(IMAGE_SCN_LNK_REMOVE),
  55   STRING_PAIR(IMAGE_SCN_LNK_COMDAT),
  56   STRING_PAIR(IMAGE_SCN_GPREL),
  57   STRING_PAIR(IMAGE_SCN_MEM_PURGEABLE),
  58   STRING_PAIR(IMAGE_SCN_MEM_16BIT),
  59   STRING_PAIR(IMAGE_SCN_MEM_LOCKED),
  60   STRING_PAIR(IMAGE_SCN_MEM_PRELOAD)
  61 };
  62
  63 static const pod_pair<llvm::COFF::SectionCharacteristics, const char *>
  64 SectionCharacteristicsPairsAlignment [] = {
  65   STRING_PAIR(IMAGE_SCN_ALIGN_1BYTES),
  66   STRING_PAIR(IMAGE_SCN_ALIGN_2BYTES),
  67   STRING_PAIR(IMAGE_SCN_ALIGN_4BYTES),
  68   STRING_PAIR(IMAGE_SCN_ALIGN_8BYTES),
  69   STRING_PAIR(IMAGE_SCN_ALIGN_16BYTES),
  70   STRING_PAIR(IMAGE_SCN_ALIGN_32BYTES),
  71   STRING_PAIR(IMAGE_SCN_ALIGN_64BYTES),
  72   STRING_PAIR(IMAGE_SCN_ALIGN_128BYTES),
  73   STRING_PAIR(IMAGE_SCN_ALIGN_256BYTES),
  74   STRING_PAIR(IMAGE_SCN_ALIGN_512BYTES),
  75   STRING_PAIR(IMAGE_SCN_ALIGN_1024BYTES),
  76   STRING_PAIR(IMAGE_SCN_ALIGN_2048BYTES),
  77   STRING_PAIR(IMAGE_SCN_ALIGN_4096BYTES),
  78   STRING_PAIR(IMAGE_SCN_ALIGN_8192BYTES)
  79 };
  80
  81 static const pod_pair<llvm::COFF::SectionCharacteristics, const char *>
  82 SectionCharacteristicsPairs2 [] = {
  83   STRING_PAIR(IMAGE_SCN_LNK_NRELOC_OVFL),
  84   STRING_PAIR(IMAGE_SCN_MEM_DISCARDABLE),
  85   STRING_PAIR(IMAGE_SCN_MEM_NOT_CACHED),
  86   STRING_PAIR(IMAGE_SCN_MEM_NOT_PAGED),
  87   STRING_PAIR(IMAGE_SCN_MEM_SHARED),
  88   STRING_PAIR(IMAGE_SCN_MEM_EXECUTE),
  89   STRING_PAIR(IMAGE_SCN_MEM_READ),
  90   STRING_PAIR(IMAGE_SCN_MEM_WRITE)
  91 };
  92
  93 static const pod_pair<llvm::COFF::SymbolBaseType, const char *>
  94 SymbolBaseTypePairs [] = {
  95   STRING_PAIR(IMAGE_SYM_TYPE_NULL),
  96   STRING_PAIR(IMAGE_SYM_TYPE_VOID),
  97   STRING_PAIR(IMAGE_SYM_TYPE_CHAR),
  98   STRING_PAIR(IMAGE_SYM_TYPE_SHORT),
  99   STRING_PAIR(IMAGE_SYM_TYPE_INT),
 100   STRING_PAIR(IMAGE_SYM_TYPE_LONG),
 101   STRING_PAIR(IMAGE_SYM_TYPE_FLOAT),
 102   STRING_PAIR(IMAGE_SYM_TYPE_DOUBLE),
 103   STRING_PAIR(IMAGE_SYM_TYPE_STRUCT),
 104   STRING_PAIR(IMAGE_SYM_TYPE_UNION),
 105   STRING_PAIR(IMAGE_SYM_TYPE_ENUM),
 106   STRING_PAIR(IMAGE_SYM_TYPE_MOE),
 107   STRING_PAIR(IMAGE_SYM_TYPE_BYTE),
 108   STRING_PAIR(IMAGE_SYM_TYPE_WORD),
 109   STRING_PAIR(IMAGE_SYM_TYPE_UINT),
 110   STRING_PAIR(IMAGE_SYM_TYPE_DWORD)
 111 };
 112
 113 static const pod_pair<llvm::COFF::SymbolComplexType, const char *>
 114 SymbolComplexTypePairs [] = {
 115   STRING_PAIR(IMAGE_SYM_DTYPE_NULL),
 116   STRING_PAIR(IMAGE_SYM_DTYPE_POINTER),
 117   STRING_PAIR(IMAGE_SYM_DTYPE_FUNCTION),
 118   STRING_PAIR(IMAGE_SYM_DTYPE_ARRAY),
 119 };
 120
 121 static const pod_pair<llvm::COFF::SymbolStorageClass, const char *>
 122 SymbolStorageClassPairs [] = {
 123   STRING_PAIR(IMAGE_SYM_CLASS_END_OF_FUNCTION),
 124   STRING_PAIR(IMAGE_SYM_CLASS_NULL),
 125   STRING_PAIR(IMAGE_SYM_CLASS_AUTOMATIC),
 126   STRING_PAIR(IMAGE_SYM_CLASS_EXTERNAL),
 127   STRING_PAIR(IMAGE_SYM_CLASS_STATIC),
 128   STRING_PAIR(IMAGE_SYM_CLASS_REGISTER),
 129   STRING_PAIR(IMAGE_SYM_CLASS_EXTERNAL_DEF),
 130   STRING_PAIR(IMAGE_SYM_CLASS_LABEL),
 131   STRING_PAIR(IMAGE_SYM_CLASS_UNDEFINED_LABEL),
 132   STRING_PAIR(IMAGE_SYM_CLASS_MEMBER_OF_STRUCT),
 133   STRING_PAIR(IMAGE_SYM_CLASS_ARGUMENT),
 134   STRING_PAIR(IMAGE_SYM_CLASS_STRUCT_TAG),
 135   STRING_PAIR(IMAGE_SYM_CLASS_MEMBER_OF_UNION),
 136   STRING_PAIR(IMAGE_SYM_CLASS_UNION_TAG),
 137   STRING_PAIR(IMAGE_SYM_CLASS_TYPE_DEFINITION),
 138   STRING_PAIR(IMAGE_SYM_CLASS_UNDEFINED_STATIC),
 139   STRING_PAIR(IMAGE_SYM_CLASS_ENUM_TAG),
 140   STRING_PAIR(IMAGE_SYM_CLASS_MEMBER_OF_ENUM),
 141   STRING_PAIR(IMAGE_SYM_CLASS_REGISTER_PARAM),
 142   STRING_PAIR(IMAGE_SYM_CLASS_BIT_FIELD),
 143   STRING_PAIR(IMAGE_SYM_CLASS_BLOCK),
 144   STRING_PAIR(IMAGE_SYM_CLASS_FUNCTION),
 145   STRING_PAIR(IMAGE_SYM_CLASS_END_OF_STRUCT),
 146   STRING_PAIR(IMAGE_SYM_CLASS_FILE),
 147   STRING_PAIR(IMAGE_SYM_CLASS_SECTION),
 148   STRING_PAIR(IMAGE_SYM_CLASS_WEAK_EXTERNAL),
 149   STRING_PAIR(IMAGE_SYM_CLASS_CLR_TOKEN),
 150 };
 151
 152 static const pod_pair<llvm::COFF::RelocationTypeX86, const char *>
 153 RelocationTypeX86Pairs [] = {
 154   STRING_PAIR(IMAGE_REL_I386_ABSOLUTE),
 155   STRING_PAIR(IMAGE_REL_I386_DIR16),
 156   STRING_PAIR(IMAGE_REL_I386_REL16),
 157   STRING_PAIR(IMAGE_REL_I386_DIR32),
 158   STRING_PAIR(IMAGE_REL_I386_DIR32NB),
 159   STRING_PAIR(IMAGE_REL_I386_SEG12),
 160   STRING_PAIR(IMAGE_REL_I386_SECTION),
 161   STRING_PAIR(IMAGE_REL_I386_SECREL),
 162   STRING_PAIR(IMAGE_REL_I386_TOKEN),
 163   STRING_PAIR(IMAGE_REL_I386_SECREL7),
 164   STRING_PAIR(IMAGE_REL_I386_REL32),
 165   STRING_PAIR(IMAGE_REL_AMD64_ABSOLUTE),
 166   STRING_PAIR(IMAGE_REL_AMD64_ADDR64),
 167   STRING_PAIR(IMAGE_REL_AMD64_ADDR32),
 168   STRING_PAIR(IMAGE_REL_AMD64_ADDR32NB),
 169   STRING_PAIR(IMAGE_REL_AMD64_REL32),
 170   STRING_PAIR(IMAGE_REL_AMD64_REL32_1),
 171   STRING_PAIR(IMAGE_REL_AMD64_REL32_2),
 172   STRING_PAIR(IMAGE_REL_AMD64_REL32_3),
 173   STRING_PAIR(IMAGE_REL_AMD64_REL32_4),
 174   STRING_PAIR(IMAGE_REL_AMD64_REL32_5),
 175   STRING_PAIR(IMAGE_REL_AMD64_SECTION),
 176   STRING_PAIR(IMAGE_REL_AMD64_SECREL),
 177   STRING_PAIR(IMAGE_REL_AMD64_SECREL7),
 178   STRING_PAIR(IMAGE_REL_AMD64_TOKEN),
 179   STRING_PAIR(IMAGE_REL_AMD64_SREL32),
 180   STRING_PAIR(IMAGE_REL_AMD64_PAIR),
 181   STRING_PAIR(IMAGE_REL_AMD64_SSPAN32)
 182 };
 183
 184 static const pod_pair<llvm::COFF::RelocationTypesARM, const char *>
 185 RelocationTypesARMPairs [] = {
 186   STRING_PAIR(IMAGE_REL_ARM_ABSOLUTE),
 187   STRING_PAIR(IMAGE_REL_ARM_ADDR32),
 188   STRING_PAIR(IMAGE_REL_ARM_ADDR32NB),
 189   STRING_PAIR(IMAGE_REL_ARM_BRANCH24),
 190   STRING_PAIR(IMAGE_REL_ARM_BRANCH11),
 191   STRING_PAIR(IMAGE_REL_ARM_TOKEN),
 192   STRING_PAIR(IMAGE_REL_ARM_BLX24),
 193   STRING_PAIR(IMAGE_REL_ARM_BLX11),
 194   STRING_PAIR(IMAGE_REL_ARM_SECTION),
 195   STRING_PAIR(IMAGE_REL_ARM_SECREL),
 196   STRING_PAIR(IMAGE_REL_ARM_MOV32A),
 197   STRING_PAIR(IMAGE_REL_ARM_MOV32T),
 198   STRING_PAIR(IMAGE_REL_ARM_BRANCH20T),
 199   STRING_PAIR(IMAGE_REL_ARM_BRANCH24T),
 200   STRING_PAIR(IMAGE_REL_ARM_BLX23T)
 201 };
 202 #undef STRING_PAIR
 203
 204 namespace yaml {  // COFF-specific yaml-writing specific routines
 205
 206 static llvm::raw_ostream &writeName(llvm::raw_ostream &Out,
 207                              const char *Name, std::size_t NameSize) {
 208   for (std::size_t i = 0; i < NameSize; ++i) {
 209     if (!Name[i]) break;
 210     Out << Name[i];
 211   }
 212   return Out;
 213 }
 214
 215 // Given an array of pod_pair<enum, const char *>, write all enums that match
 216 template <typename T, std::size_t N>
 217 static llvm::raw_ostream &writeBitMask(llvm::raw_ostream &Out,
 218               const pod_pair<T, const char *> (&Arr)[N], unsigned long Val) {
 219   for (std::size_t i = 0; i < N; ++i)
 220     if (Val & Arr[i].first)
 221       Out << Arr[i].second << ", ";
 222   return Out;
 223 }
 224
 225 } // end of yaml namespace
 226
 227 // Given an array of pod_pair<enum, const char *>, look up a value
 228 template <typename T, std::size_t N>
 229 const char *nameLookup(const pod_pair<T, const char *> (&Arr)[N],
 230                            unsigned long Val, const char *NotFound = NULL) {
 231   T n = static_cast<T>(Val);
 232   for (std::size_t i = 0; i < N; ++i)
 233     if (n == Arr[i].first)
 234       return Arr[i].second;
 235   return NotFound;
 236 }
 237
 238
 239 static llvm::raw_ostream &yamlCOFFHeader(
 240           const llvm::object::coff_file_header *Header,llvm::raw_ostream &Out) {
 241
 242   Out << "header: !Header\n";
 243   Out << "  Machine: ";
 244   Out << nameLookup(MachineTypePairs, Header->Machine, "# Unknown_MachineTypes")
 245       << " # (";
 246   return yaml::writeHexNumber(Out, Header->Machine) << ")\n\n";
 247 }
 248
 249
 250 static llvm::raw_ostream &yamlCOFFSections(llvm::object::COFFObjectFile &Obj,
 251                             std::size_t NumSections, llvm::raw_ostream &Out) {
 252   llvm::error_code ec;
 253   Out << "sections:\n";
 254   for (llvm::object::section_iterator iter = Obj.begin_sections();
 255                              iter != Obj.end_sections(); iter.increment(ec)) {
 256     const llvm::object::coff_section *sect = Obj.getCOFFSection(iter);
 257
 258     Out << "  - !Section\n";
 259     Out << "    Name: ";
 260     yaml::writeName(Out, sect->Name, sizeof(sect->Name)) << '\n';
 261
 262     Out << "    Characteristics: [";
 263     yaml::writeBitMask(Out, SectionCharacteristicsPairs1, sect->Characteristics);
 264     Out << nameLookup(SectionCharacteristicsPairsAlignment,
 265         sect->Characteristics & 0x00F00000, "# Unrecognized_IMAGE_SCN_ALIGN")
 266         << ", ";
 267     yaml::writeBitMask(Out, SectionCharacteristicsPairs2, sect->Characteristics);
 268     Out << "] # ";
 269     yaml::writeHexNumber(Out, sect->Characteristics) << '\n';
 270
 271     llvm::ArrayRef<uint8_t> sectionData;
 272     Obj.getSectionContents(sect, sectionData);
 273     Out << "    SectionData: ";
 274     yaml::writeHexStream(Out, sectionData) << '\n';
 275     if (iter->begin_relocations() != iter->end_relocations())
 276       Out << "    Relocations:\n";
 277     for (llvm::object::relocation_iterator rIter = iter->begin_relocations();
 278                        rIter != iter->end_relocations(); rIter.increment(ec)) {
 279       const llvm::object::coff_relocation *reloc = Obj.getCOFFRelocation(rIter);
 280
 281         Out << "      - !Relocation\n";
 282         Out << "        VirtualAddress: " ;
 283         yaml::writeHexNumber(Out, reloc->VirtualAddress) << '\n';
 284         Out << "        SymbolTableIndex: " << reloc->SymbolTableIndex << '\n';
 285         Out << "        Type: "
 286             << nameLookup(RelocationTypeX86Pairs, reloc->Type) << '\n';
 287     // TODO: Use the correct reloc type for the machine.
 288         Out << '\n';
 289       }
 290
 291   }
 292   return Out;
 293 }
 294
 295 static llvm::raw_ostream& yamlCOFFSymbols(llvm::object::COFFObjectFile &Obj,
 296                               std::size_t NumSymbols, llvm::raw_ostream &Out) {
 297   llvm::error_code ec;
 298   Out << "symbols:\n";
 299   for (llvm::object::symbol_iterator iter = Obj.begin_symbols();
 300                              iter != Obj.end_symbols(); iter.increment(ec)) {
 301  // Gather all the info that we need
 302     llvm::StringRef str;
 303     const llvm::object::coff_symbol *symbol = Obj.getCOFFSymbol(iter);
 304     Obj.getSymbolName(symbol, str);
 305     std::size_t  simpleType  = symbol->getBaseType();
 306     std::size_t complexType  = symbol->getComplexType();
 307     std::size_t storageClass = symbol->StorageClass;
 308
 309     Out << "  - !Symbol\n";
 310     Out << "    Name: " << str << '\n';
 311
 312     Out << "    Value: "         << symbol->Value << '\n';
 313     Out << "    SectionNumber: " << symbol->SectionNumber << '\n';
 314
 315     Out << "    SimpleType: "
 316         << nameLookup(SymbolBaseTypePairs, simpleType,
 317             "# Unknown_SymbolBaseType")
 318         << " # (" << simpleType << ")\n";
 319
 320     Out << "    ComplexType: "
 321         << nameLookup(SymbolComplexTypePairs, complexType,
 322                 "# Unknown_SymbolComplexType")
 323         << " # (" << complexType << ")\n";
 324
 325     Out << "    StorageClass: "
 326         << nameLookup(SymbolStorageClassPairs, storageClass,
 327               "# Unknown_StorageClass")
 328         << " # (" << (int) storageClass << ")\n";
 329
 330     if (symbol->NumberOfAuxSymbols > 0) {
 331       llvm::ArrayRef<uint8_t> aux = Obj.getSymbolAuxData(symbol);
 332       Out << "    NumberOfAuxSymbols: "
 333           << (int) symbol->NumberOfAuxSymbols << '\n';
 334       Out << "    AuxillaryData: ";
 335       yaml::writeHexStream(Out, aux);
 336     }
 337
 338     Out << '\n';
 339   }
 340
 341   return Out;
 342 }
 343
 344
 345 llvm::error_code coff2yaml(llvm::raw_ostream &Out, llvm::MemoryBuffer *TheObj) {
 346   llvm::error_code ec;
 347   llvm::object::COFFObjectFile obj(TheObj, ec);
 348   if (!ec) {
 349     const llvm::object::coff_file_header *hd;
 350     ec = obj.getHeader(hd);
 351     if (!ec) {
 352       yamlCOFFHeader(hd, Out);
 353       yamlCOFFSections(obj, hd->NumberOfSections, Out);
 354       yamlCOFFSymbols(obj, hd->NumberOfSymbols, Out);
 355     }
 356   }
 357   return ec;
 358 }