lib/Object/COFFYAML.cpp

   1 //===- COFFYAML.cpp - COFF YAMLIO implementation --------------------------===//
   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 // This file defines classes for handling the YAML representation of COFF.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Object/COFFYAML.h"
  15
  16 #define ECase(X) IO.enumCase(Value, #X, COFF::X);
  17 namespace llvm {
  18
  19 namespace COFFYAML {
  20 Section::Section() { memset(&Header, 0, sizeof(COFF::section)); }
  21 Symbol::Symbol() { memset(&Header, 0, sizeof(COFF::symbol)); }
  22 Object::Object() { memset(&Header, 0, sizeof(COFF::header)); }
  23 }
  24
  25 namespace yaml {
  26 void ScalarEnumerationTraits<COFFYAML::COMDATType>::enumeration(
  27     IO &IO, COFFYAML::COMDATType &Value) {
  28   IO.enumCase(Value, "0", 0);
  29   ECase(IMAGE_COMDAT_SELECT_NODUPLICATES);
  30   ECase(IMAGE_COMDAT_SELECT_ANY);
  31   ECase(IMAGE_COMDAT_SELECT_SAME_SIZE);
  32   ECase(IMAGE_COMDAT_SELECT_EXACT_MATCH);
  33   ECase(IMAGE_COMDAT_SELECT_ASSOCIATIVE);
  34   ECase(IMAGE_COMDAT_SELECT_LARGEST);
  35   ECase(IMAGE_COMDAT_SELECT_NEWEST);
  36 }
  37
  38 void
  39 ScalarEnumerationTraits<COFFYAML::WeakExternalCharacteristics>::enumeration(
  40     IO &IO, COFFYAML::WeakExternalCharacteristics &Value) {
  41   ECase(IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY);
  42   ECase(IMAGE_WEAK_EXTERN_SEARCH_LIBRARY);
  43   ECase(IMAGE_WEAK_EXTERN_SEARCH_ALIAS);
  44 }
  45
  46 void ScalarEnumerationTraits<COFFYAML::AuxSymbolType>::enumeration(
  47     IO &IO, COFFYAML::AuxSymbolType &Value) {
  48   ECase(IMAGE_AUX_SYMBOL_TYPE_TOKEN_DEF);
  49 }
  50
  51 void ScalarEnumerationTraits<COFF::MachineTypes>::enumeration(
  52     IO &IO, COFF::MachineTypes &Value) {
  53   ECase(IMAGE_FILE_MACHINE_UNKNOWN);
  54   ECase(IMAGE_FILE_MACHINE_AM33);
  55   ECase(IMAGE_FILE_MACHINE_AMD64);
  56   ECase(IMAGE_FILE_MACHINE_ARM);
  57   ECase(IMAGE_FILE_MACHINE_ARMNT);
  58   ECase(IMAGE_FILE_MACHINE_EBC);
  59   ECase(IMAGE_FILE_MACHINE_I386);
  60   ECase(IMAGE_FILE_MACHINE_IA64);
  61   ECase(IMAGE_FILE_MACHINE_M32R);
  62   ECase(IMAGE_FILE_MACHINE_MIPS16);
  63   ECase(IMAGE_FILE_MACHINE_MIPSFPU);
  64   ECase(IMAGE_FILE_MACHINE_MIPSFPU16);
  65   ECase(IMAGE_FILE_MACHINE_POWERPC);
  66   ECase(IMAGE_FILE_MACHINE_POWERPCFP);
  67   ECase(IMAGE_FILE_MACHINE_R4000);
  68   ECase(IMAGE_FILE_MACHINE_SH3);
  69   ECase(IMAGE_FILE_MACHINE_SH3DSP);
  70   ECase(IMAGE_FILE_MACHINE_SH4);
  71   ECase(IMAGE_FILE_MACHINE_SH5);
  72   ECase(IMAGE_FILE_MACHINE_THUMB);
  73   ECase(IMAGE_FILE_MACHINE_WCEMIPSV2);
  74 }
  75
  76 void ScalarEnumerationTraits<COFF::SymbolBaseType>::enumeration(
  77     IO &IO, COFF::SymbolBaseType &Value) {
  78   ECase(IMAGE_SYM_TYPE_NULL);
  79   ECase(IMAGE_SYM_TYPE_VOID);
  80   ECase(IMAGE_SYM_TYPE_CHAR);
  81   ECase(IMAGE_SYM_TYPE_SHORT);
  82   ECase(IMAGE_SYM_TYPE_INT);
  83   ECase(IMAGE_SYM_TYPE_LONG);
  84   ECase(IMAGE_SYM_TYPE_FLOAT);
  85   ECase(IMAGE_SYM_TYPE_DOUBLE);
  86   ECase(IMAGE_SYM_TYPE_STRUCT);
  87   ECase(IMAGE_SYM_TYPE_UNION);
  88   ECase(IMAGE_SYM_TYPE_ENUM);
  89   ECase(IMAGE_SYM_TYPE_MOE);
  90   ECase(IMAGE_SYM_TYPE_BYTE);
  91   ECase(IMAGE_SYM_TYPE_WORD);
  92   ECase(IMAGE_SYM_TYPE_UINT);
  93   ECase(IMAGE_SYM_TYPE_DWORD);
  94 }
  95
  96 void ScalarEnumerationTraits<COFF::SymbolStorageClass>::enumeration(
  97     IO &IO, COFF::SymbolStorageClass &Value) {
  98   ECase(IMAGE_SYM_CLASS_END_OF_FUNCTION);
  99   ECase(IMAGE_SYM_CLASS_NULL);
 100   ECase(IMAGE_SYM_CLASS_AUTOMATIC);
 101   ECase(IMAGE_SYM_CLASS_EXTERNAL);
 102   ECase(IMAGE_SYM_CLASS_STATIC);
 103   ECase(IMAGE_SYM_CLASS_REGISTER);
 104   ECase(IMAGE_SYM_CLASS_EXTERNAL_DEF);
 105   ECase(IMAGE_SYM_CLASS_LABEL);
 106   ECase(IMAGE_SYM_CLASS_UNDEFINED_LABEL);
 107   ECase(IMAGE_SYM_CLASS_MEMBER_OF_STRUCT);
 108   ECase(IMAGE_SYM_CLASS_ARGUMENT);
 109   ECase(IMAGE_SYM_CLASS_STRUCT_TAG);
 110   ECase(IMAGE_SYM_CLASS_MEMBER_OF_UNION);
 111   ECase(IMAGE_SYM_CLASS_UNION_TAG);
 112   ECase(IMAGE_SYM_CLASS_TYPE_DEFINITION);
 113   ECase(IMAGE_SYM_CLASS_UNDEFINED_STATIC);
 114   ECase(IMAGE_SYM_CLASS_ENUM_TAG);
 115   ECase(IMAGE_SYM_CLASS_MEMBER_OF_ENUM);
 116   ECase(IMAGE_SYM_CLASS_REGISTER_PARAM);
 117   ECase(IMAGE_SYM_CLASS_BIT_FIELD);
 118   ECase(IMAGE_SYM_CLASS_BLOCK);
 119   ECase(IMAGE_SYM_CLASS_FUNCTION);
 120   ECase(IMAGE_SYM_CLASS_END_OF_STRUCT);
 121   ECase(IMAGE_SYM_CLASS_FILE);
 122   ECase(IMAGE_SYM_CLASS_SECTION);
 123   ECase(IMAGE_SYM_CLASS_WEAK_EXTERNAL);
 124   ECase(IMAGE_SYM_CLASS_CLR_TOKEN);
 125 }
 126
 127 void ScalarEnumerationTraits<COFF::SymbolComplexType>::enumeration(
 128     IO &IO, COFF::SymbolComplexType &Value) {
 129   ECase(IMAGE_SYM_DTYPE_NULL);
 130   ECase(IMAGE_SYM_DTYPE_POINTER);
 131   ECase(IMAGE_SYM_DTYPE_FUNCTION);
 132   ECase(IMAGE_SYM_DTYPE_ARRAY);
 133 }
 134
 135 void ScalarEnumerationTraits<COFF::RelocationTypeI386>::enumeration(
 136     IO &IO, COFF::RelocationTypeI386 &Value) {
 137   ECase(IMAGE_REL_I386_ABSOLUTE);
 138   ECase(IMAGE_REL_I386_DIR16);
 139   ECase(IMAGE_REL_I386_REL16);
 140   ECase(IMAGE_REL_I386_DIR32);
 141   ECase(IMAGE_REL_I386_DIR32NB);
 142   ECase(IMAGE_REL_I386_SEG12);
 143   ECase(IMAGE_REL_I386_SECTION);
 144   ECase(IMAGE_REL_I386_SECREL);
 145   ECase(IMAGE_REL_I386_TOKEN);
 146   ECase(IMAGE_REL_I386_SECREL7);
 147   ECase(IMAGE_REL_I386_REL32);
 148 }
 149
 150 void ScalarEnumerationTraits<COFF::RelocationTypeAMD64>::enumeration(
 151     IO &IO, COFF::RelocationTypeAMD64 &Value) {
 152   ECase(IMAGE_REL_AMD64_ABSOLUTE);
 153   ECase(IMAGE_REL_AMD64_ADDR64);
 154   ECase(IMAGE_REL_AMD64_ADDR32);
 155   ECase(IMAGE_REL_AMD64_ADDR32NB);
 156   ECase(IMAGE_REL_AMD64_REL32);
 157   ECase(IMAGE_REL_AMD64_REL32_1);
 158   ECase(IMAGE_REL_AMD64_REL32_2);
 159   ECase(IMAGE_REL_AMD64_REL32_3);
 160   ECase(IMAGE_REL_AMD64_REL32_4);
 161   ECase(IMAGE_REL_AMD64_REL32_5);
 162   ECase(IMAGE_REL_AMD64_SECTION);
 163   ECase(IMAGE_REL_AMD64_SECREL);
 164   ECase(IMAGE_REL_AMD64_SECREL7);
 165   ECase(IMAGE_REL_AMD64_TOKEN);
 166   ECase(IMAGE_REL_AMD64_SREL32);
 167   ECase(IMAGE_REL_AMD64_PAIR);
 168   ECase(IMAGE_REL_AMD64_SSPAN32);
 169 }
 170 #undef ECase
 171
 172 #define BCase(X) IO.bitSetCase(Value, #X, COFF::X);
 173 void ScalarBitSetTraits<COFF::Characteristics>::bitset(
 174     IO &IO, COFF::Characteristics &Value) {
 175   BCase(IMAGE_FILE_RELOCS_STRIPPED);
 176   BCase(IMAGE_FILE_EXECUTABLE_IMAGE);
 177   BCase(IMAGE_FILE_LINE_NUMS_STRIPPED);
 178   BCase(IMAGE_FILE_LOCAL_SYMS_STRIPPED);
 179   BCase(IMAGE_FILE_AGGRESSIVE_WS_TRIM);
 180   BCase(IMAGE_FILE_LARGE_ADDRESS_AWARE);
 181   BCase(IMAGE_FILE_BYTES_REVERSED_LO);
 182   BCase(IMAGE_FILE_32BIT_MACHINE);
 183   BCase(IMAGE_FILE_DEBUG_STRIPPED);
 184   BCase(IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP);
 185   BCase(IMAGE_FILE_NET_RUN_FROM_SWAP);
 186   BCase(IMAGE_FILE_SYSTEM);
 187   BCase(IMAGE_FILE_DLL);
 188   BCase(IMAGE_FILE_UP_SYSTEM_ONLY);
 189   BCase(IMAGE_FILE_BYTES_REVERSED_HI);
 190 }
 191
 192 void ScalarBitSetTraits<COFF::SectionCharacteristics>::bitset(
 193     IO &IO, COFF::SectionCharacteristics &Value) {
 194   BCase(IMAGE_SCN_TYPE_NO_PAD);
 195   BCase(IMAGE_SCN_CNT_CODE);
 196   BCase(IMAGE_SCN_CNT_INITIALIZED_DATA);
 197   BCase(IMAGE_SCN_CNT_UNINITIALIZED_DATA);
 198   BCase(IMAGE_SCN_LNK_OTHER);
 199   BCase(IMAGE_SCN_LNK_INFO);
 200   BCase(IMAGE_SCN_LNK_REMOVE);
 201   BCase(IMAGE_SCN_LNK_COMDAT);
 202   BCase(IMAGE_SCN_GPREL);
 203   BCase(IMAGE_SCN_MEM_PURGEABLE);
 204   BCase(IMAGE_SCN_MEM_16BIT);
 205   BCase(IMAGE_SCN_MEM_LOCKED);
 206   BCase(IMAGE_SCN_MEM_PRELOAD);
 207   BCase(IMAGE_SCN_LNK_NRELOC_OVFL);
 208   BCase(IMAGE_SCN_MEM_DISCARDABLE);
 209   BCase(IMAGE_SCN_MEM_NOT_CACHED);
 210   BCase(IMAGE_SCN_MEM_NOT_PAGED);
 211   BCase(IMAGE_SCN_MEM_SHARED);
 212   BCase(IMAGE_SCN_MEM_EXECUTE);
 213   BCase(IMAGE_SCN_MEM_READ);
 214   BCase(IMAGE_SCN_MEM_WRITE);
 215 }
 216 #undef BCase
 217
 218 namespace {
 219 struct NSectionSelectionType {
 220   NSectionSelectionType(IO &)
 221       : SelectionType(COFFYAML::COMDATType(0)) {}
 222   NSectionSelectionType(IO &, uint8_t C)
 223       : SelectionType(COFFYAML::COMDATType(C)) {}
 224   uint8_t denormalize(IO &) { return SelectionType; }
 225   COFFYAML::COMDATType SelectionType;
 226 };
 227
 228 struct NWeakExternalCharacteristics {
 229   NWeakExternalCharacteristics(IO &)
 230       : Characteristics(COFFYAML::WeakExternalCharacteristics(0)) {}
 231   NWeakExternalCharacteristics(IO &, uint32_t C)
 232       : Characteristics(COFFYAML::WeakExternalCharacteristics(C)) {}
 233   uint32_t denormalize(IO &) { return Characteristics; }
 234   COFFYAML::WeakExternalCharacteristics Characteristics;
 235 };
 236
 237 struct NSectionCharacteristics {
 238   NSectionCharacteristics(IO &)
 239       : Characteristics(COFF::SectionCharacteristics(0)) {}
 240   NSectionCharacteristics(IO &, uint32_t C)
 241       : Characteristics(COFF::SectionCharacteristics(C)) {}
 242   uint32_t denormalize(IO &) { return Characteristics; }
 243   COFF::SectionCharacteristics Characteristics;
 244 };
 245
 246 struct NAuxTokenType {
 247   NAuxTokenType(IO &)
 248       : AuxType(COFFYAML::AuxSymbolType(0)) {}
 249   NAuxTokenType(IO &, uint8_t C)
 250       : AuxType(COFFYAML::AuxSymbolType(C)) {}
 251   uint32_t denormalize(IO &) { return AuxType; }
 252   COFFYAML::AuxSymbolType AuxType;
 253 };
 254
 255 struct NStorageClass {
 256   NStorageClass(IO &) : StorageClass(COFF::SymbolStorageClass(0)) {}
 257   NStorageClass(IO &, uint8_t S) : StorageClass(COFF::SymbolStorageClass(S)) {}
 258   uint8_t denormalize(IO &) { return StorageClass; }
 259
 260   COFF::SymbolStorageClass StorageClass;
 261 };
 262
 263 struct NMachine {
 264   NMachine(IO &) : Machine(COFF::MachineTypes(0)) {}
 265   NMachine(IO &, uint16_t M) : Machine(COFF::MachineTypes(M)) {}
 266   uint16_t denormalize(IO &) { return Machine; }
 267   COFF::MachineTypes Machine;
 268 };
 269
 270 struct NHeaderCharacteristics {
 271   NHeaderCharacteristics(IO &) : Characteristics(COFF::Characteristics(0)) {}
 272   NHeaderCharacteristics(IO &, uint16_t C)
 273       : Characteristics(COFF::Characteristics(C)) {}
 274   uint16_t denormalize(IO &) { return Characteristics; }
 275
 276   COFF::Characteristics Characteristics;
 277 };
 278
 279 template <typename RelocType>
 280 struct NType {
 281   NType(IO &) : Type(RelocType(0)) {}
 282   NType(IO &, uint16_t T) : Type(RelocType(T)) {}
 283   uint16_t denormalize(IO &) { return Type; }
 284   RelocType Type;
 285 };
 286
 287 }
 288
 289 void MappingTraits<COFFYAML::Relocation>::mapping(IO &IO,
 290                                                   COFFYAML::Relocation &Rel) {
 291   IO.mapRequired("VirtualAddress", Rel.VirtualAddress);
 292   IO.mapRequired("SymbolName", Rel.SymbolName);
 293
 294   COFF::header &H = *static_cast<COFF::header *>(IO.getContext());
 295   if (H.Machine == COFF::IMAGE_FILE_MACHINE_I386) {
 296     MappingNormalization<NType<COFF::RelocationTypeI386>, uint16_t> NT(
 297         IO, Rel.Type);
 298     IO.mapRequired("Type", NT->Type);
 299   } else if (H.Machine == COFF::IMAGE_FILE_MACHINE_AMD64) {
 300     MappingNormalization<NType<COFF::RelocationTypeAMD64>, uint16_t> NT(
 301         IO, Rel.Type);
 302     IO.mapRequired("Type", NT->Type);
 303   } else {
 304     IO.mapRequired("Type", Rel.Type);
 305   }
 306 }
 307
 308 void MappingTraits<COFF::header>::mapping(IO &IO, COFF::header &H) {
 309   MappingNormalization<NMachine, uint16_t> NM(IO, H.Machine);
 310   MappingNormalization<NHeaderCharacteristics, uint16_t> NC(IO,
 311                                                             H.Characteristics);
 312
 313   IO.mapRequired("Machine", NM->Machine);
 314   IO.mapOptional("Characteristics", NC->Characteristics);
 315   IO.setContext(static_cast<void *>(&H));
 316 }
 317
 318 void MappingTraits<COFF::AuxiliaryFunctionDefinition>::mapping(
 319     IO &IO, COFF::AuxiliaryFunctionDefinition &AFD) {
 320   IO.mapRequired("TagIndex", AFD.TagIndex);
 321   IO.mapRequired("TotalSize", AFD.TotalSize);
 322   IO.mapRequired("PointerToLinenumber", AFD.PointerToLinenumber);
 323   IO.mapRequired("PointerToNextFunction", AFD.PointerToNextFunction);
 324 }
 325
 326 void MappingTraits<COFF::AuxiliarybfAndefSymbol>::mapping(
 327     IO &IO, COFF::AuxiliarybfAndefSymbol &AAS) {
 328   IO.mapRequired("Linenumber", AAS.Linenumber);
 329   IO.mapRequired("PointerToNextFunction", AAS.PointerToNextFunction);
 330 }
 331
 332 void MappingTraits<COFF::AuxiliaryWeakExternal>::mapping(
 333     IO &IO, COFF::AuxiliaryWeakExternal &AWE) {
 334   MappingNormalization<NWeakExternalCharacteristics, uint32_t> NWEC(
 335       IO, AWE.Characteristics);
 336   IO.mapRequired("TagIndex", AWE.TagIndex);
 337   IO.mapRequired("Characteristics", NWEC->Characteristics);
 338 }
 339
 340 void MappingTraits<COFF::AuxiliarySectionDefinition>::mapping(
 341     IO &IO, COFF::AuxiliarySectionDefinition &ASD) {
 342   MappingNormalization<NSectionSelectionType, uint8_t> NSST(
 343       IO, ASD.Selection);
 344
 345   IO.mapRequired("Length", ASD.Length);
 346   IO.mapRequired("NumberOfRelocations", ASD.NumberOfRelocations);
 347   IO.mapRequired("NumberOfLinenumbers", ASD.NumberOfLinenumbers);
 348   IO.mapRequired("CheckSum", ASD.CheckSum);
 349   IO.mapRequired("Number", ASD.Number);
 350   IO.mapOptional("Selection", NSST->SelectionType, COFFYAML::COMDATType(0));
 351 }
 352
 353 void MappingTraits<COFF::AuxiliaryCLRToken>::mapping(
 354     IO &IO, COFF::AuxiliaryCLRToken &ACT) {
 355   MappingNormalization<NAuxTokenType, uint8_t> NATT(IO, ACT.AuxType);
 356   IO.mapRequired("AuxType", NATT->AuxType);
 357   IO.mapRequired("SymbolTableIndex", ACT.SymbolTableIndex);
 358 }
 359
 360 void MappingTraits<COFFYAML::Symbol>::mapping(IO &IO, COFFYAML::Symbol &S) {
 361   MappingNormalization<NStorageClass, uint8_t> NS(IO, S.Header.StorageClass);
 362
 363   IO.mapRequired("Name", S.Name);
 364   IO.mapRequired("Value", S.Header.Value);
 365   IO.mapRequired("SectionNumber", S.Header.SectionNumber);
 366   IO.mapRequired("SimpleType", S.SimpleType);
 367   IO.mapRequired("ComplexType", S.ComplexType);
 368   IO.mapRequired("StorageClass", NS->StorageClass);
 369   IO.mapOptional("FunctionDefinition", S.FunctionDefinition);
 370   IO.mapOptional("bfAndefSymbol", S.bfAndefSymbol);
 371   IO.mapOptional("WeakExternal", S.WeakExternal);
 372   IO.mapOptional("File", S.File, StringRef());
 373   IO.mapOptional("SectionDefinition", S.SectionDefinition);
 374   IO.mapOptional("CLRToken", S.CLRToken);
 375 }
 376
 377 void MappingTraits<COFFYAML::Section>::mapping(IO &IO, COFFYAML::Section &Sec) {
 378   MappingNormalization<NSectionCharacteristics, uint32_t> NC(
 379       IO, Sec.Header.Characteristics);
 380   IO.mapRequired("Name", Sec.Name);
 381   IO.mapRequired("Characteristics", NC->Characteristics);
 382   IO.mapOptional("Alignment", Sec.Alignment);
 383   IO.mapRequired("SectionData", Sec.SectionData);
 384   IO.mapOptional("Relocations", Sec.Relocations);
 385 }
 386
 387 void MappingTraits<COFFYAML::Object>::mapping(IO &IO, COFFYAML::Object &Obj) {
 388   IO.mapRequired("header", Obj.Header);
 389   IO.mapRequired("sections", Obj.Sections);
 390   IO.mapRequired("symbols", Obj.Symbols);
 391 }
 392
 393 }
 394 }