lib/ObjectYAML/ELFYAML.cpp

   1 //===- ELFYAML.cpp - ELF 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 ELF.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/ObjectYAML/ELFYAML.h"
  15 #include "llvm/ADT/StringRef.h"
  16 #include "llvm/BinaryFormat/ELF.h"
  17 #include "llvm/Support/Casting.h"
  18 #include "llvm/Support/ErrorHandling.h"
  19 #include "llvm/Support/MipsABIFlags.h"
  20 #include "llvm/Support/YAMLTraits.h"
  21 #include <cassert>
  22 #include <cstdint>
  23
  24 namespace llvm {
  25
  26 ELFYAML::Section::~Section() = default;
  27
  28 namespace yaml {
  29
  30 void ScalarEnumerationTraits<ELFYAML::ELF_ET>::enumeration(
  31     IO &IO, ELFYAML::ELF_ET &Value) {
  32 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
  33   ECase(ET_NONE);
  34   ECase(ET_REL);
  35   ECase(ET_EXEC);
  36   ECase(ET_DYN);
  37   ECase(ET_CORE);
  38 #undef ECase
  39   IO.enumFallback<Hex16>(Value);
  40 }
  41
  42 void ScalarEnumerationTraits<ELFYAML::ELF_PT>::enumeration(
  43     IO &IO, ELFYAML::ELF_PT &Value) {
  44 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
  45   ECase(PT_NULL);
  46   ECase(PT_LOAD);
  47   ECase(PT_DYNAMIC);
  48   ECase(PT_INTERP);
  49   ECase(PT_NOTE);
  50   ECase(PT_SHLIB);
  51   ECase(PT_PHDR);
  52   ECase(PT_TLS);
  53 #undef ECase
  54   IO.enumFallback<Hex32>(Value);
  55 }
  56
  57 void ScalarEnumerationTraits<ELFYAML::ELF_EM>::enumeration(
  58     IO &IO, ELFYAML::ELF_EM &Value) {
  59 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
  60   ECase(EM_NONE);
  61   ECase(EM_M32);
  62   ECase(EM_SPARC);
  63   ECase(EM_386);
  64   ECase(EM_68K);
  65   ECase(EM_88K);
  66   ECase(EM_IAMCU);
  67   ECase(EM_860);
  68   ECase(EM_MIPS);
  69   ECase(EM_S370);
  70   ECase(EM_MIPS_RS3_LE);
  71   ECase(EM_PARISC);
  72   ECase(EM_VPP500);
  73   ECase(EM_SPARC32PLUS);
  74   ECase(EM_960);
  75   ECase(EM_PPC);
  76   ECase(EM_PPC64);
  77   ECase(EM_S390);
  78   ECase(EM_SPU);
  79   ECase(EM_V800);
  80   ECase(EM_FR20);
  81   ECase(EM_RH32);
  82   ECase(EM_RCE);
  83   ECase(EM_ARM);
  84   ECase(EM_ALPHA);
  85   ECase(EM_SH);
  86   ECase(EM_SPARCV9);
  87   ECase(EM_TRICORE);
  88   ECase(EM_ARC);
  89   ECase(EM_H8_300);
  90   ECase(EM_H8_300H);
  91   ECase(EM_H8S);
  92   ECase(EM_H8_500);
  93   ECase(EM_IA_64);
  94   ECase(EM_MIPS_X);
  95   ECase(EM_COLDFIRE);
  96   ECase(EM_68HC12);
  97   ECase(EM_MMA);
  98   ECase(EM_PCP);
  99   ECase(EM_NCPU);
 100   ECase(EM_NDR1);
 101   ECase(EM_STARCORE);
 102   ECase(EM_ME16);
 103   ECase(EM_ST100);
 104   ECase(EM_TINYJ);
 105   ECase(EM_X86_64);
 106   ECase(EM_PDSP);
 107   ECase(EM_PDP10);
 108   ECase(EM_PDP11);
 109   ECase(EM_FX66);
 110   ECase(EM_ST9PLUS);
 111   ECase(EM_ST7);
 112   ECase(EM_68HC16);
 113   ECase(EM_68HC11);
 114   ECase(EM_68HC08);
 115   ECase(EM_68HC05);
 116   ECase(EM_SVX);
 117   ECase(EM_ST19);
 118   ECase(EM_VAX);
 119   ECase(EM_CRIS);
 120   ECase(EM_JAVELIN);
 121   ECase(EM_FIREPATH);
 122   ECase(EM_ZSP);
 123   ECase(EM_MMIX);
 124   ECase(EM_HUANY);
 125   ECase(EM_PRISM);
 126   ECase(EM_AVR);
 127   ECase(EM_FR30);
 128   ECase(EM_D10V);
 129   ECase(EM_D30V);
 130   ECase(EM_V850);
 131   ECase(EM_M32R);
 132   ECase(EM_MN10300);
 133   ECase(EM_MN10200);
 134   ECase(EM_PJ);
 135   ECase(EM_OPENRISC);
 136   ECase(EM_ARC_COMPACT);
 137   ECase(EM_XTENSA);
 138   ECase(EM_VIDEOCORE);
 139   ECase(EM_TMM_GPP);
 140   ECase(EM_NS32K);
 141   ECase(EM_TPC);
 142   ECase(EM_SNP1K);
 143   ECase(EM_ST200);
 144   ECase(EM_IP2K);
 145   ECase(EM_MAX);
 146   ECase(EM_CR);
 147   ECase(EM_F2MC16);
 148   ECase(EM_MSP430);
 149   ECase(EM_BLACKFIN);
 150   ECase(EM_SE_C33);
 151   ECase(EM_SEP);
 152   ECase(EM_ARCA);
 153   ECase(EM_UNICORE);
 154   ECase(EM_EXCESS);
 155   ECase(EM_DXP);
 156   ECase(EM_ALTERA_NIOS2);
 157   ECase(EM_CRX);
 158   ECase(EM_XGATE);
 159   ECase(EM_C166);
 160   ECase(EM_M16C);
 161   ECase(EM_DSPIC30F);
 162   ECase(EM_CE);
 163   ECase(EM_M32C);
 164   ECase(EM_TSK3000);
 165   ECase(EM_RS08);
 166   ECase(EM_SHARC);
 167   ECase(EM_ECOG2);
 168   ECase(EM_SCORE7);
 169   ECase(EM_DSP24);
 170   ECase(EM_VIDEOCORE3);
 171   ECase(EM_LATTICEMICO32);
 172   ECase(EM_SE_C17);
 173   ECase(EM_TI_C6000);
 174   ECase(EM_TI_C2000);
 175   ECase(EM_TI_C5500);
 176   ECase(EM_MMDSP_PLUS);
 177   ECase(EM_CYPRESS_M8C);
 178   ECase(EM_R32C);
 179   ECase(EM_TRIMEDIA);
 180   ECase(EM_HEXAGON);
 181   ECase(EM_8051);
 182   ECase(EM_STXP7X);
 183   ECase(EM_NDS32);
 184   ECase(EM_ECOG1);
 185   ECase(EM_ECOG1X);
 186   ECase(EM_MAXQ30);
 187   ECase(EM_XIMO16);
 188   ECase(EM_MANIK);
 189   ECase(EM_CRAYNV2);
 190   ECase(EM_RX);
 191   ECase(EM_METAG);
 192   ECase(EM_MCST_ELBRUS);
 193   ECase(EM_ECOG16);
 194   ECase(EM_CR16);
 195   ECase(EM_ETPU);
 196   ECase(EM_SLE9X);
 197   ECase(EM_L10M);
 198   ECase(EM_K10M);
 199   ECase(EM_AARCH64);
 200   ECase(EM_AVR32);
 201   ECase(EM_STM8);
 202   ECase(EM_TILE64);
 203   ECase(EM_TILEPRO);
 204   ECase(EM_CUDA);
 205   ECase(EM_TILEGX);
 206   ECase(EM_CLOUDSHIELD);
 207   ECase(EM_COREA_1ST);
 208   ECase(EM_COREA_2ND);
 209   ECase(EM_ARC_COMPACT2);
 210   ECase(EM_OPEN8);
 211   ECase(EM_RL78);
 212   ECase(EM_VIDEOCORE5);
 213   ECase(EM_78KOR);
 214   ECase(EM_56800EX);
 215   ECase(EM_AMDGPU);
 216   ECase(EM_RISCV);
 217   ECase(EM_LANAI);
 218   ECase(EM_BPF);
 219 #undef ECase
 220 }
 221
 222 void ScalarEnumerationTraits<ELFYAML::ELF_ELFCLASS>::enumeration(
 223     IO &IO, ELFYAML::ELF_ELFCLASS &Value) {
 224 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
 225   // Since the semantics of ELFCLASSNONE is "invalid", just don't accept it
 226   // here.
 227   ECase(ELFCLASS32);
 228   ECase(ELFCLASS64);
 229 #undef ECase
 230 }
 231
 232 void ScalarEnumerationTraits<ELFYAML::ELF_ELFDATA>::enumeration(
 233     IO &IO, ELFYAML::ELF_ELFDATA &Value) {
 234 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
 235   // Since the semantics of ELFDATANONE is "invalid", just don't accept it
 236   // here.
 237   ECase(ELFDATA2LSB);
 238   ECase(ELFDATA2MSB);
 239 #undef ECase
 240 }
 241
 242 void ScalarEnumerationTraits<ELFYAML::ELF_ELFOSABI>::enumeration(
 243     IO &IO, ELFYAML::ELF_ELFOSABI &Value) {
 244 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
 245   ECase(ELFOSABI_NONE);
 246   ECase(ELFOSABI_HPUX);
 247   ECase(ELFOSABI_NETBSD);
 248   ECase(ELFOSABI_GNU);
 249   ECase(ELFOSABI_GNU);
 250   ECase(ELFOSABI_HURD);
 251   ECase(ELFOSABI_SOLARIS);
 252   ECase(ELFOSABI_AIX);
 253   ECase(ELFOSABI_IRIX);
 254   ECase(ELFOSABI_FREEBSD);
 255   ECase(ELFOSABI_TRU64);
 256   ECase(ELFOSABI_MODESTO);
 257   ECase(ELFOSABI_OPENBSD);
 258   ECase(ELFOSABI_OPENVMS);
 259   ECase(ELFOSABI_NSK);
 260   ECase(ELFOSABI_AROS);
 261   ECase(ELFOSABI_FENIXOS);
 262   ECase(ELFOSABI_CLOUDABI);
 263   ECase(ELFOSABI_C6000_ELFABI);
 264   ECase(ELFOSABI_AMDGPU_HSA);
 265   ECase(ELFOSABI_C6000_LINUX);
 266   ECase(ELFOSABI_ARM);
 267   ECase(ELFOSABI_STANDALONE);
 268 #undef ECase
 269 }
 270
 271 void ScalarBitSetTraits<ELFYAML::ELF_EF>::bitset(IO &IO,
 272                                                  ELFYAML::ELF_EF &Value) {
 273   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
 274   assert(Object && "The IO context is not initialized");
 275 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
 276 #define BCaseMask(X, M) IO.maskedBitSetCase(Value, #X, ELF::X, ELF::M)
 277   switch (Object->Header.Machine) {
 278   case ELF::EM_ARM:
 279     BCase(EF_ARM_SOFT_FLOAT);
 280     BCase(EF_ARM_VFP_FLOAT);
 281     BCaseMask(EF_ARM_EABI_UNKNOWN, EF_ARM_EABIMASK);
 282     BCaseMask(EF_ARM_EABI_VER1, EF_ARM_EABIMASK);
 283     BCaseMask(EF_ARM_EABI_VER2, EF_ARM_EABIMASK);
 284     BCaseMask(EF_ARM_EABI_VER3, EF_ARM_EABIMASK);
 285     BCaseMask(EF_ARM_EABI_VER4, EF_ARM_EABIMASK);
 286     BCaseMask(EF_ARM_EABI_VER5, EF_ARM_EABIMASK);
 287     break;
 288   case ELF::EM_MIPS:
 289     BCase(EF_MIPS_NOREORDER);
 290     BCase(EF_MIPS_PIC);
 291     BCase(EF_MIPS_CPIC);
 292     BCase(EF_MIPS_ABI2);
 293     BCase(EF_MIPS_32BITMODE);
 294     BCase(EF_MIPS_FP64);
 295     BCase(EF_MIPS_NAN2008);
 296     BCase(EF_MIPS_MICROMIPS);
 297     BCase(EF_MIPS_ARCH_ASE_M16);
 298     BCase(EF_MIPS_ARCH_ASE_MDMX);
 299     BCaseMask(EF_MIPS_ABI_O32, EF_MIPS_ABI);
 300     BCaseMask(EF_MIPS_ABI_O64, EF_MIPS_ABI);
 301     BCaseMask(EF_MIPS_ABI_EABI32, EF_MIPS_ABI);
 302     BCaseMask(EF_MIPS_ABI_EABI64, EF_MIPS_ABI);
 303     BCaseMask(EF_MIPS_MACH_3900, EF_MIPS_MACH);
 304     BCaseMask(EF_MIPS_MACH_4010, EF_MIPS_MACH);
 305     BCaseMask(EF_MIPS_MACH_4100, EF_MIPS_MACH);
 306     BCaseMask(EF_MIPS_MACH_4650, EF_MIPS_MACH);
 307     BCaseMask(EF_MIPS_MACH_4120, EF_MIPS_MACH);
 308     BCaseMask(EF_MIPS_MACH_4111, EF_MIPS_MACH);
 309     BCaseMask(EF_MIPS_MACH_SB1, EF_MIPS_MACH);
 310     BCaseMask(EF_MIPS_MACH_OCTEON, EF_MIPS_MACH);
 311     BCaseMask(EF_MIPS_MACH_XLR, EF_MIPS_MACH);
 312     BCaseMask(EF_MIPS_MACH_OCTEON2, EF_MIPS_MACH);
 313     BCaseMask(EF_MIPS_MACH_OCTEON3, EF_MIPS_MACH);
 314     BCaseMask(EF_MIPS_MACH_5400, EF_MIPS_MACH);
 315     BCaseMask(EF_MIPS_MACH_5900, EF_MIPS_MACH);
 316     BCaseMask(EF_MIPS_MACH_5500, EF_MIPS_MACH);
 317     BCaseMask(EF_MIPS_MACH_9000, EF_MIPS_MACH);
 318     BCaseMask(EF_MIPS_MACH_LS2E, EF_MIPS_MACH);
 319     BCaseMask(EF_MIPS_MACH_LS2F, EF_MIPS_MACH);
 320     BCaseMask(EF_MIPS_MACH_LS3A, EF_MIPS_MACH);
 321     BCaseMask(EF_MIPS_ARCH_1, EF_MIPS_ARCH);
 322     BCaseMask(EF_MIPS_ARCH_2, EF_MIPS_ARCH);
 323     BCaseMask(EF_MIPS_ARCH_3, EF_MIPS_ARCH);
 324     BCaseMask(EF_MIPS_ARCH_4, EF_MIPS_ARCH);
 325     BCaseMask(EF_MIPS_ARCH_5, EF_MIPS_ARCH);
 326     BCaseMask(EF_MIPS_ARCH_32, EF_MIPS_ARCH);
 327     BCaseMask(EF_MIPS_ARCH_64, EF_MIPS_ARCH);
 328     BCaseMask(EF_MIPS_ARCH_32R2, EF_MIPS_ARCH);
 329     BCaseMask(EF_MIPS_ARCH_64R2, EF_MIPS_ARCH);
 330     BCaseMask(EF_MIPS_ARCH_32R6, EF_MIPS_ARCH);
 331     BCaseMask(EF_MIPS_ARCH_64R6, EF_MIPS_ARCH);
 332     break;
 333   case ELF::EM_HEXAGON:
 334     BCase(EF_HEXAGON_MACH_V2);
 335     BCase(EF_HEXAGON_MACH_V3);
 336     BCase(EF_HEXAGON_MACH_V4);
 337     BCase(EF_HEXAGON_MACH_V5);
 338     BCase(EF_HEXAGON_ISA_V2);
 339     BCase(EF_HEXAGON_ISA_V3);
 340     BCase(EF_HEXAGON_ISA_V4);
 341     BCase(EF_HEXAGON_ISA_V5);
 342     break;
 343   case ELF::EM_AVR:
 344     BCase(EF_AVR_ARCH_AVR1);
 345     BCase(EF_AVR_ARCH_AVR2);
 346     BCase(EF_AVR_ARCH_AVR25);
 347     BCase(EF_AVR_ARCH_AVR3);
 348     BCase(EF_AVR_ARCH_AVR31);
 349     BCase(EF_AVR_ARCH_AVR35);
 350     BCase(EF_AVR_ARCH_AVR4);
 351     BCase(EF_AVR_ARCH_AVR51);
 352     BCase(EF_AVR_ARCH_AVR6);
 353     BCase(EF_AVR_ARCH_AVRTINY);
 354     BCase(EF_AVR_ARCH_XMEGA1);
 355     BCase(EF_AVR_ARCH_XMEGA2);
 356     BCase(EF_AVR_ARCH_XMEGA3);
 357     BCase(EF_AVR_ARCH_XMEGA4);
 358     BCase(EF_AVR_ARCH_XMEGA5);
 359     BCase(EF_AVR_ARCH_XMEGA6);
 360     BCase(EF_AVR_ARCH_XMEGA7);
 361     break;
 362   case ELF::EM_AMDGPU:
 363   case ELF::EM_X86_64:
 364     break;
 365   default:
 366     llvm_unreachable("Unsupported architecture");
 367   }
 368 #undef BCase
 369 #undef BCaseMask
 370 }
 371
 372 void ScalarEnumerationTraits<ELFYAML::ELF_SHT>::enumeration(
 373     IO &IO, ELFYAML::ELF_SHT &Value) {
 374   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
 375   assert(Object && "The IO context is not initialized");
 376 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
 377   ECase(SHT_NULL);
 378   ECase(SHT_PROGBITS);
 379   // No SHT_SYMTAB. Use the top-level `Symbols` key instead.
 380   // FIXME: Issue a diagnostic with this information.
 381   ECase(SHT_STRTAB);
 382   ECase(SHT_RELA);
 383   ECase(SHT_HASH);
 384   ECase(SHT_DYNAMIC);
 385   ECase(SHT_NOTE);
 386   ECase(SHT_NOBITS);
 387   ECase(SHT_REL);
 388   ECase(SHT_SHLIB);
 389   ECase(SHT_DYNSYM);
 390   ECase(SHT_INIT_ARRAY);
 391   ECase(SHT_FINI_ARRAY);
 392   ECase(SHT_PREINIT_ARRAY);
 393   ECase(SHT_GROUP);
 394   ECase(SHT_SYMTAB_SHNDX);
 395   ECase(SHT_LOOS);
 396   ECase(SHT_LLVM_ODRTAB);
 397   ECase(SHT_GNU_ATTRIBUTES);
 398   ECase(SHT_GNU_HASH);
 399   ECase(SHT_GNU_verdef);
 400   ECase(SHT_GNU_verneed);
 401   ECase(SHT_GNU_versym);
 402   ECase(SHT_HIOS);
 403   ECase(SHT_LOPROC);
 404   switch (Object->Header.Machine) {
 405   case ELF::EM_ARM:
 406     ECase(SHT_ARM_EXIDX);
 407     ECase(SHT_ARM_PREEMPTMAP);
 408     ECase(SHT_ARM_ATTRIBUTES);
 409     ECase(SHT_ARM_DEBUGOVERLAY);
 410     ECase(SHT_ARM_OVERLAYSECTION);
 411     break;
 412   case ELF::EM_HEXAGON:
 413     ECase(SHT_HEX_ORDERED);
 414     break;
 415   case ELF::EM_X86_64:
 416     ECase(SHT_X86_64_UNWIND);
 417     break;
 418   case ELF::EM_MIPS:
 419     ECase(SHT_MIPS_REGINFO);
 420     ECase(SHT_MIPS_OPTIONS);
 421     ECase(SHT_MIPS_ABIFLAGS);
 422     break;
 423   default:
 424     // Nothing to do.
 425     break;
 426   }
 427 #undef ECase
 428 }
 429
 430 void ScalarBitSetTraits<ELFYAML::ELF_PF>::bitset(IO &IO,
 431                                                  ELFYAML::ELF_PF &Value) {
 432 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
 433   BCase(PF_X);
 434   BCase(PF_W);
 435   BCase(PF_R);
 436 }
 437
 438 void ScalarBitSetTraits<ELFYAML::ELF_SHF>::bitset(IO &IO,
 439                                                   ELFYAML::ELF_SHF &Value) {
 440   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
 441 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
 442   BCase(SHF_WRITE);
 443   BCase(SHF_ALLOC);
 444   BCase(SHF_EXCLUDE);
 445   BCase(SHF_EXECINSTR);
 446   BCase(SHF_MERGE);
 447   BCase(SHF_STRINGS);
 448   BCase(SHF_INFO_LINK);
 449   BCase(SHF_LINK_ORDER);
 450   BCase(SHF_OS_NONCONFORMING);
 451   BCase(SHF_GROUP);
 452   BCase(SHF_TLS);
 453   BCase(SHF_COMPRESSED);
 454   switch (Object->Header.Machine) {
 455   case ELF::EM_ARM:
 456     BCase(SHF_ARM_PURECODE);
 457     break;
 458   case ELF::EM_HEXAGON:
 459     BCase(SHF_HEX_GPREL);
 460     break;
 461   case ELF::EM_MIPS:
 462     BCase(SHF_MIPS_NODUPES);
 463     BCase(SHF_MIPS_NAMES);
 464     BCase(SHF_MIPS_LOCAL);
 465     BCase(SHF_MIPS_NOSTRIP);
 466     BCase(SHF_MIPS_GPREL);
 467     BCase(SHF_MIPS_MERGE);
 468     BCase(SHF_MIPS_ADDR);
 469     BCase(SHF_MIPS_STRING);
 470     break;
 471   case ELF::EM_X86_64:
 472     BCase(SHF_X86_64_LARGE);
 473     break;
 474   default:
 475     // Nothing to do.
 476     break;
 477   }
 478 #undef BCase
 479 }
 480
 481 void ScalarEnumerationTraits<ELFYAML::ELF_SHN>::enumeration(
 482     IO &IO, ELFYAML::ELF_SHN &Value) {
 483 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
 484   ECase(SHN_UNDEF);
 485   ECase(SHN_LORESERVE);
 486   ECase(SHN_LOPROC);
 487   ECase(SHN_HIPROC);
 488   ECase(SHN_LOOS);
 489   ECase(SHN_HIOS);
 490   ECase(SHN_ABS);
 491   ECase(SHN_COMMON);
 492   ECase(SHN_XINDEX);
 493   ECase(SHN_HIRESERVE);
 494   ECase(SHN_HEXAGON_SCOMMON);
 495   ECase(SHN_HEXAGON_SCOMMON_1);
 496   ECase(SHN_HEXAGON_SCOMMON_2);
 497   ECase(SHN_HEXAGON_SCOMMON_4);
 498   ECase(SHN_HEXAGON_SCOMMON_8);
 499 #undef ECase
 500   IO.enumFallback<Hex32>(Value);
 501 }
 502
 503 void ScalarEnumerationTraits<ELFYAML::ELF_STT>::enumeration(
 504     IO &IO, ELFYAML::ELF_STT &Value) {
 505 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
 506   ECase(STT_NOTYPE);
 507   ECase(STT_OBJECT);
 508   ECase(STT_FUNC);
 509   ECase(STT_SECTION);
 510   ECase(STT_FILE);
 511   ECase(STT_COMMON);
 512   ECase(STT_TLS);
 513   ECase(STT_GNU_IFUNC);
 514 #undef ECase
 515 }
 516
 517 void ScalarEnumerationTraits<ELFYAML::ELF_STV>::enumeration(
 518     IO &IO, ELFYAML::ELF_STV &Value) {
 519 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
 520   ECase(STV_DEFAULT);
 521   ECase(STV_INTERNAL);
 522   ECase(STV_HIDDEN);
 523   ECase(STV_PROTECTED);
 524 #undef ECase
 525 }
 526
 527 void ScalarBitSetTraits<ELFYAML::ELF_STO>::bitset(IO &IO,
 528                                                   ELFYAML::ELF_STO &Value) {
 529   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
 530   assert(Object && "The IO context is not initialized");
 531 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
 532   switch (Object->Header.Machine) {
 533   case ELF::EM_MIPS:
 534     BCase(STO_MIPS_OPTIONAL);
 535     BCase(STO_MIPS_PLT);
 536     BCase(STO_MIPS_PIC);
 537     BCase(STO_MIPS_MICROMIPS);
 538     break;
 539   default:
 540     break; // Nothing to do
 541   }
 542 #undef BCase
 543 #undef BCaseMask
 544 }
 545
 546 void ScalarEnumerationTraits<ELFYAML::ELF_RSS>::enumeration(
 547     IO &IO, ELFYAML::ELF_RSS &Value) {
 548 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
 549   ECase(RSS_UNDEF);
 550   ECase(RSS_GP);
 551   ECase(RSS_GP0);
 552   ECase(RSS_LOC);
 553 #undef ECase
 554 }
 555
 556 void ScalarEnumerationTraits<ELFYAML::ELF_REL>::enumeration(
 557     IO &IO, ELFYAML::ELF_REL &Value) {
 558   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
 559   assert(Object && "The IO context is not initialized");
 560 #define ELF_RELOC(X, Y) IO.enumCase(Value, #X, ELF::X);
 561   switch (Object->Header.Machine) {
 562   case ELF::EM_X86_64:
 563 #include "llvm/BinaryFormat/ELFRelocs/x86_64.def"
 564     break;
 565   case ELF::EM_MIPS:
 566 #include "llvm/BinaryFormat/ELFRelocs/Mips.def"
 567     break;
 568   case ELF::EM_HEXAGON:
 569 #include "llvm/BinaryFormat/ELFRelocs/Hexagon.def"
 570     break;
 571   case ELF::EM_386:
 572   case ELF::EM_IAMCU:
 573 #include "llvm/BinaryFormat/ELFRelocs/i386.def"
 574     break;
 575   case ELF::EM_AARCH64:
 576 #include "llvm/BinaryFormat/ELFRelocs/AArch64.def"
 577     break;
 578   case ELF::EM_ARM:
 579 #include "llvm/BinaryFormat/ELFRelocs/ARM.def"
 580     break;
 581   case ELF::EM_ARC:
 582 #include "llvm/BinaryFormat/ELFRelocs/ARC.def"
 583     break;
 584   case ELF::EM_RISCV:
 585 #include "llvm/BinaryFormat/ELFRelocs/RISCV.def"
 586     break;
 587   case ELF::EM_LANAI:
 588 #include "llvm/BinaryFormat/ELFRelocs/Lanai.def"
 589     break;
 590   case ELF::EM_AMDGPU:
 591 #include "llvm/BinaryFormat/ELFRelocs/AMDGPU.def"
 592     break;
 593   case ELF::EM_BPF:
 594 #include "llvm/BinaryFormat/ELFRelocs/BPF.def"
 595     break;
 596   default:
 597     llvm_unreachable("Unsupported architecture");
 598   }
 599 #undef ELF_RELOC
 600   IO.enumFallback<Hex32>(Value);
 601 }
 602
 603 void ScalarEnumerationTraits<ELFYAML::MIPS_AFL_REG>::enumeration(
 604     IO &IO, ELFYAML::MIPS_AFL_REG &Value) {
 605 #define ECase(X) IO.enumCase(Value, #X, Mips::AFL_##X)
 606   ECase(REG_NONE);
 607   ECase(REG_32);
 608   ECase(REG_64);
 609   ECase(REG_128);
 610 #undef ECase
 611 }
 612
 613 void ScalarEnumerationTraits<ELFYAML::MIPS_ABI_FP>::enumeration(
 614     IO &IO, ELFYAML::MIPS_ABI_FP &Value) {
 615 #define ECase(X) IO.enumCase(Value, #X, Mips::Val_GNU_MIPS_ABI_##X)
 616   ECase(FP_ANY);
 617   ECase(FP_DOUBLE);
 618   ECase(FP_SINGLE);
 619   ECase(FP_SOFT);
 620   ECase(FP_OLD_64);
 621   ECase(FP_XX);
 622   ECase(FP_64);
 623   ECase(FP_64A);
 624 #undef ECase
 625 }
 626
 627 void ScalarEnumerationTraits<ELFYAML::MIPS_AFL_EXT>::enumeration(
 628     IO &IO, ELFYAML::MIPS_AFL_EXT &Value) {
 629 #define ECase(X) IO.enumCase(Value, #X, Mips::AFL_##X)
 630   ECase(EXT_NONE);
 631   ECase(EXT_XLR);
 632   ECase(EXT_OCTEON2);
 633   ECase(EXT_OCTEONP);
 634   ECase(EXT_LOONGSON_3A);
 635   ECase(EXT_OCTEON);
 636   ECase(EXT_5900);
 637   ECase(EXT_4650);
 638   ECase(EXT_4010);
 639   ECase(EXT_4100);
 640   ECase(EXT_3900);
 641   ECase(EXT_10000);
 642   ECase(EXT_SB1);
 643   ECase(EXT_4111);
 644   ECase(EXT_4120);
 645   ECase(EXT_5400);
 646   ECase(EXT_5500);
 647   ECase(EXT_LOONGSON_2E);
 648   ECase(EXT_LOONGSON_2F);
 649   ECase(EXT_OCTEON3);
 650 #undef ECase
 651 }
 652
 653 void ScalarEnumerationTraits<ELFYAML::MIPS_ISA>::enumeration(
 654     IO &IO, ELFYAML::MIPS_ISA &Value) {
 655   IO.enumCase(Value, "MIPS1", 1);
 656   IO.enumCase(Value, "MIPS2", 2);
 657   IO.enumCase(Value, "MIPS3", 3);
 658   IO.enumCase(Value, "MIPS4", 4);
 659   IO.enumCase(Value, "MIPS5", 5);
 660   IO.enumCase(Value, "MIPS32", 32);
 661   IO.enumCase(Value, "MIPS64", 64);
 662 }
 663
 664 void ScalarBitSetTraits<ELFYAML::MIPS_AFL_ASE>::bitset(
 665     IO &IO, ELFYAML::MIPS_AFL_ASE &Value) {
 666 #define BCase(X) IO.bitSetCase(Value, #X, Mips::AFL_ASE_##X)
 667   BCase(DSP);
 668   BCase(DSPR2);
 669   BCase(EVA);
 670   BCase(MCU);
 671   BCase(MDMX);
 672   BCase(MIPS3D);
 673   BCase(MT);
 674   BCase(SMARTMIPS);
 675   BCase(VIRT);
 676   BCase(MSA);
 677   BCase(MIPS16);
 678   BCase(MICROMIPS);
 679   BCase(XPA);
 680 #undef BCase
 681 }
 682
 683 void ScalarBitSetTraits<ELFYAML::MIPS_AFL_FLAGS1>::bitset(
 684     IO &IO, ELFYAML::MIPS_AFL_FLAGS1 &Value) {
 685 #define BCase(X) IO.bitSetCase(Value, #X, Mips::AFL_FLAGS1_##X)
 686   BCase(ODDSPREG);
 687 #undef BCase
 688 }
 689
 690 void MappingTraits<ELFYAML::FileHeader>::mapping(IO &IO,
 691                                                  ELFYAML::FileHeader &FileHdr) {
 692   IO.mapRequired("Class", FileHdr.Class);
 693   IO.mapRequired("Data", FileHdr.Data);
 694   IO.mapOptional("OSABI", FileHdr.OSABI, ELFYAML::ELF_ELFOSABI(0));
 695   IO.mapRequired("Type", FileHdr.Type);
 696   IO.mapRequired("Machine", FileHdr.Machine);
 697   IO.mapOptional("Flags", FileHdr.Flags, ELFYAML::ELF_EF(0));
 698   IO.mapOptional("Entry", FileHdr.Entry, Hex64(0));
 699 }
 700
 701 void MappingTraits<ELFYAML::ProgramHeader>::mapping(
 702     IO &IO, ELFYAML::ProgramHeader &Phdr) {
 703   IO.mapRequired("Type", Phdr.Type);
 704   IO.mapOptional("Flags", Phdr.Flags, ELFYAML::ELF_PF(0));
 705   IO.mapOptional("Sections", Phdr.Sections);
 706   IO.mapOptional("VAddr", Phdr.VAddr, Hex64(0));
 707   IO.mapOptional("PAddr", Phdr.PAddr, Hex64(0));
 708 }
 709
 710 namespace {
 711
 712 struct NormalizedOther {
 713   NormalizedOther(IO &)
 714       : Visibility(ELFYAML::ELF_STV(0)), Other(ELFYAML::ELF_STO(0)) {}
 715   NormalizedOther(IO &, uint8_t Original)
 716       : Visibility(Original & 0x3), Other(Original & ~0x3) {}
 717
 718   uint8_t denormalize(IO &) { return Visibility | Other; }
 719
 720   ELFYAML::ELF_STV Visibility;
 721   ELFYAML::ELF_STO Other;
 722 };
 723
 724 } // end anonymous namespace
 725
 726 void MappingTraits<ELFYAML::Symbol>::mapping(IO &IO, ELFYAML::Symbol &Symbol) {
 727   IO.mapOptional("Name", Symbol.Name, StringRef());
 728   IO.mapOptional("Type", Symbol.Type, ELFYAML::ELF_STT(0));
 729   IO.mapOptional("Section", Symbol.Section, StringRef());
 730   IO.mapOptional("Index", Symbol.Index);
 731   IO.mapOptional("Value", Symbol.Value, Hex64(0));
 732   IO.mapOptional("Size", Symbol.Size, Hex64(0));
 733
 734   MappingNormalization<NormalizedOther, uint8_t> Keys(IO, Symbol.Other);
 735   IO.mapOptional("Visibility", Keys->Visibility, ELFYAML::ELF_STV(0));
 736   IO.mapOptional("Other", Keys->Other, ELFYAML::ELF_STO(0));
 737 }
 738
 739 StringRef MappingTraits<ELFYAML::Symbol>::validate(IO &IO,
 740                                                    ELFYAML::Symbol &Symbol) {
 741   if (Symbol.Index && Symbol.Section.data()) {
 742     return "Index and Section cannot both be specified for Symbol";
 743   }
 744   if (Symbol.Index && *Symbol.Index == ELFYAML::ELF_SHN(ELF::SHN_XINDEX)) {
 745     return "Large indexes are not supported";
 746   }
 747   if (Symbol.Index && *Symbol.Index < ELFYAML::ELF_SHN(ELF::SHN_LORESERVE)) {
 748     return "Use a section name to define which section a symbol is defined in";
 749   }
 750   return StringRef();
 751 }
 752
 753 void MappingTraits<ELFYAML::LocalGlobalWeakSymbols>::mapping(
 754     IO &IO, ELFYAML::LocalGlobalWeakSymbols &Symbols) {
 755   IO.mapOptional("Local", Symbols.Local);
 756   IO.mapOptional("Global", Symbols.Global);
 757   IO.mapOptional("Weak", Symbols.Weak);
 758 }
 759
 760 static void commonSectionMapping(IO &IO, ELFYAML::Section &Section) {
 761   IO.mapOptional("Name", Section.Name, StringRef());
 762   IO.mapRequired("Type", Section.Type);
 763   IO.mapOptional("Flags", Section.Flags, ELFYAML::ELF_SHF(0));
 764   IO.mapOptional("Address", Section.Address, Hex64(0));
 765   IO.mapOptional("Link", Section.Link, StringRef());
 766   IO.mapOptional("AddressAlign", Section.AddressAlign, Hex64(0));
 767   IO.mapOptional("Info", Section.Info, StringRef());
 768 }
 769
 770 static void sectionMapping(IO &IO, ELFYAML::RawContentSection &Section) {
 771   commonSectionMapping(IO, Section);
 772   IO.mapOptional("Content", Section.Content);
 773   IO.mapOptional("Size", Section.Size, Hex64(Section.Content.binary_size()));
 774 }
 775
 776 static void sectionMapping(IO &IO, ELFYAML::NoBitsSection &Section) {
 777   commonSectionMapping(IO, Section);
 778   IO.mapOptional("Size", Section.Size, Hex64(0));
 779 }
 780
 781 static void sectionMapping(IO &IO, ELFYAML::RelocationSection &Section) {
 782   commonSectionMapping(IO, Section);
 783   IO.mapOptional("Relocations", Section.Relocations);
 784 }
 785
 786 static void groupSectionMapping(IO &IO, ELFYAML::Group &group) {
 787   commonSectionMapping(IO, group);
 788   IO.mapRequired("Members", group.Members);
 789 }
 790
 791 void MappingTraits<ELFYAML::SectionOrType>::mapping(
 792     IO &IO, ELFYAML::SectionOrType &sectionOrType) {
 793   IO.mapRequired("SectionOrType", sectionOrType.sectionNameOrType);
 794 }
 795
 796 void MappingTraits<ELFYAML::SectionName>::mapping(
 797     IO &IO, ELFYAML::SectionName &sectionName) {
 798   IO.mapRequired("Section", sectionName.Section);
 799 }
 800
 801 static void sectionMapping(IO &IO, ELFYAML::MipsABIFlags &Section) {
 802   commonSectionMapping(IO, Section);
 803   IO.mapOptional("Version", Section.Version, Hex16(0));
 804   IO.mapRequired("ISA", Section.ISALevel);
 805   IO.mapOptional("ISARevision", Section.ISARevision, Hex8(0));
 806   IO.mapOptional("ISAExtension", Section.ISAExtension,
 807                  ELFYAML::MIPS_AFL_EXT(Mips::AFL_EXT_NONE));
 808   IO.mapOptional("ASEs", Section.ASEs, ELFYAML::MIPS_AFL_ASE(0));
 809   IO.mapOptional("FpABI", Section.FpABI,
 810                  ELFYAML::MIPS_ABI_FP(Mips::Val_GNU_MIPS_ABI_FP_ANY));
 811   IO.mapOptional("GPRSize", Section.GPRSize,
 812                  ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
 813   IO.mapOptional("CPR1Size", Section.CPR1Size,
 814                  ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
 815   IO.mapOptional("CPR2Size", Section.CPR2Size,
 816                  ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
 817   IO.mapOptional("Flags1", Section.Flags1, ELFYAML::MIPS_AFL_FLAGS1(0));
 818   IO.mapOptional("Flags2", Section.Flags2, Hex32(0));
 819 }
 820
 821 void MappingTraits<std::unique_ptr<ELFYAML::Section>>::mapping(
 822     IO &IO, std::unique_ptr<ELFYAML::Section> &Section) {
 823   ELFYAML::ELF_SHT sectionType;
 824   if (IO.outputting())
 825     sectionType = Section->Type;
 826   else
 827     IO.mapRequired("Type", sectionType);
 828
 829   switch (sectionType) {
 830   case ELF::SHT_REL:
 831   case ELF::SHT_RELA:
 832     if (!IO.outputting())
 833       Section.reset(new ELFYAML::RelocationSection());
 834     sectionMapping(IO, *cast<ELFYAML::RelocationSection>(Section.get()));
 835     break;
 836   case ELF::SHT_GROUP:
 837     if (!IO.outputting())
 838       Section.reset(new ELFYAML::Group());
 839     groupSectionMapping(IO, *cast<ELFYAML::Group>(Section.get()));
 840     break;
 841   case ELF::SHT_NOBITS:
 842     if (!IO.outputting())
 843       Section.reset(new ELFYAML::NoBitsSection());
 844     sectionMapping(IO, *cast<ELFYAML::NoBitsSection>(Section.get()));
 845     break;
 846   case ELF::SHT_MIPS_ABIFLAGS:
 847     if (!IO.outputting())
 848       Section.reset(new ELFYAML::MipsABIFlags());
 849     sectionMapping(IO, *cast<ELFYAML::MipsABIFlags>(Section.get()));
 850     break;
 851   default:
 852     if (!IO.outputting())
 853       Section.reset(new ELFYAML::RawContentSection());
 854     sectionMapping(IO, *cast<ELFYAML::RawContentSection>(Section.get()));
 855   }
 856 }
 857
 858 StringRef MappingTraits<std::unique_ptr<ELFYAML::Section>>::validate(
 859     IO &io, std::unique_ptr<ELFYAML::Section> &Section) {
 860   const auto *RawSection = dyn_cast<ELFYAML::RawContentSection>(Section.get());
 861   if (!RawSection || RawSection->Size >= RawSection->Content.binary_size())
 862     return StringRef();
 863   return "Section size must be greater or equal to the content size";
 864 }
 865
 866 namespace {
 867
 868 struct NormalizedMips64RelType {
 869   NormalizedMips64RelType(IO &)
 870       : Type(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
 871         Type2(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
 872         Type3(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
 873         SpecSym(ELFYAML::ELF_REL(ELF::RSS_UNDEF)) {}
 874   NormalizedMips64RelType(IO &, ELFYAML::ELF_REL Original)
 875       : Type(Original & 0xFF), Type2(Original >> 8 & 0xFF),
 876         Type3(Original >> 16 & 0xFF), SpecSym(Original >> 24 & 0xFF) {}
 877
 878   ELFYAML::ELF_REL denormalize(IO &) {
 879     ELFYAML::ELF_REL Res = Type | Type2 << 8 | Type3 << 16 | SpecSym << 24;
 880     return Res;
 881   }
 882
 883   ELFYAML::ELF_REL Type;
 884   ELFYAML::ELF_REL Type2;
 885   ELFYAML::ELF_REL Type3;
 886   ELFYAML::ELF_RSS SpecSym;
 887 };
 888
 889 } // end anonymous namespace
 890
 891 void MappingTraits<ELFYAML::Relocation>::mapping(IO &IO,
 892                                                  ELFYAML::Relocation &Rel) {
 893   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
 894   assert(Object && "The IO context is not initialized");
 895
 896   IO.mapRequired("Offset", Rel.Offset);
 897   IO.mapOptional("Symbol", Rel.Symbol);
 898
 899   if (Object->Header.Machine == ELFYAML::ELF_EM(ELF::EM_MIPS) &&
 900       Object->Header.Class == ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64)) {
 901     MappingNormalization<NormalizedMips64RelType, ELFYAML::ELF_REL> Key(
 902         IO, Rel.Type);
 903     IO.mapRequired("Type", Key->Type);
 904     IO.mapOptional("Type2", Key->Type2, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
 905     IO.mapOptional("Type3", Key->Type3, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
 906     IO.mapOptional("SpecSym", Key->SpecSym, ELFYAML::ELF_RSS(ELF::RSS_UNDEF));
 907   } else
 908     IO.mapRequired("Type", Rel.Type);
 909
 910   IO.mapOptional("Addend", Rel.Addend, (int64_t)0);
 911 }
 912
 913 void MappingTraits<ELFYAML::Object>::mapping(IO &IO, ELFYAML::Object &Object) {
 914   assert(!IO.getContext() && "The IO context is initialized already");
 915   IO.setContext(&Object);
 916   IO.mapTag("!ELF", true);
 917   IO.mapRequired("FileHeader", Object.Header);
 918   IO.mapOptional("ProgramHeaders", Object.ProgramHeaders);
 919   IO.mapOptional("Sections", Object.Sections);
 920   IO.mapOptional("Symbols", Object.Symbols);
 921   IO.setContext(nullptr);
 922 }
 923
 924 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_AFL_REG)
 925 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_ABI_FP)
 926 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_EXT)
 927 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_ASE)
 928 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_FLAGS1)
 929
 930 } // end namespace yaml
 931
 932 } // end namespace llvm