lib/Target/X86/X86AsmBackend.cpp

   1 //===-- X86AsmBackend.cpp - X86 Assembler Backend -------------------------===//
   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/Target/TargetAsmBackend.h"
  11 #include "X86.h"
  12 #include "X86FixupKinds.h"
  13 #include "llvm/ADT/Twine.h"
  14 #include "llvm/MC/MCAssembler.h"
  15 #include "llvm/MC/MCExpr.h"
  16 #include "llvm/MC/MCFixupKindInfo.h"
  17 #include "llvm/MC/MCMachObjectWriter.h"
  18 #include "llvm/MC/MCObjectFormat.h"
  19 #include "llvm/MC/MCObjectWriter.h"
  20 #include "llvm/MC/MCSectionCOFF.h"
  21 #include "llvm/MC/MCSectionELF.h"
  22 #include "llvm/MC/MCSectionMachO.h"
  23 #include "llvm/Object/MachOFormat.h"
  24 #include "llvm/Support/ELF.h"
  25 #include "llvm/Support/ErrorHandling.h"
  26 #include "llvm/Support/raw_ostream.h"
  27 #include "llvm/Target/TargetRegistry.h"
  28 #include "llvm/Target/TargetAsmBackend.h"
  29 using namespace llvm;
  30
  31 static unsigned getFixupKindLog2Size(unsigned Kind) {
  32   switch (Kind) {
  33   default: assert(0 && "invalid fixup kind!");
  34   case FK_PCRel_1:
  35   case FK_Data_1: return 0;
  36   case FK_PCRel_2:
  37   case FK_Data_2: return 1;
  38   case FK_PCRel_4:
  39   case X86::reloc_riprel_4byte:
  40   case X86::reloc_riprel_4byte_movq_load:
  41   case X86::reloc_signed_4byte:
  42   case X86::reloc_global_offset_table:
  43   case FK_Data_4: return 2;
  44   case FK_Data_8: return 3;
  45   }
  46 }
  47
  48 namespace {
  49 class X86MachObjectWriter : public MCMachObjectTargetWriter {
  50 public:
  51   X86MachObjectWriter(bool Is64Bit, uint32_t CPUType,
  52                       uint32_t CPUSubtype)
  53     : MCMachObjectTargetWriter(Is64Bit, CPUType, CPUSubtype,
  54                                /*UseAggressiveSymbolFolding=*/Is64Bit) {}
  55 };
  56
  57 class X86AsmBackend : public TargetAsmBackend {
  58 public:
  59   X86AsmBackend(const Target &T)
  60     : TargetAsmBackend() {}
  61
  62   unsigned getNumFixupKinds() const {
  63     return X86::NumTargetFixupKinds;
  64   }
  65
  66   const MCFixupKindInfo &getFixupKindInfo(MCFixupKind Kind) const {
  67     const static MCFixupKindInfo Infos[X86::NumTargetFixupKinds] = {
  68       { "reloc_riprel_4byte", 0, 4 * 8, MCFixupKindInfo::FKF_IsPCRel },
  69       { "reloc_riprel_4byte_movq_load", 0, 4 * 8, MCFixupKindInfo::FKF_IsPCRel},
  70       { "reloc_signed_4byte", 0, 4 * 8, 0},
  71       { "reloc_global_offset_table", 0, 4 * 8, 0}
  72     };
  73
  74     if (Kind < FirstTargetFixupKind)
  75       return TargetAsmBackend::getFixupKindInfo(Kind);
  76
  77     assert(unsigned(Kind - FirstTargetFixupKind) < getNumFixupKinds() &&
  78            "Invalid kind!");
  79     return Infos[Kind - FirstTargetFixupKind];
  80   }
  81
  82   void ApplyFixup(const MCFixup &Fixup, char *Data, unsigned DataSize,
  83                   uint64_t Value) const {
  84     unsigned Size = 1 << getFixupKindLog2Size(Fixup.getKind());
  85
  86     assert(Fixup.getOffset() + Size <= DataSize &&
  87            "Invalid fixup offset!");
  88     for (unsigned i = 0; i != Size; ++i)
  89       Data[Fixup.getOffset() + i] = uint8_t(Value >> (i * 8));
  90   }
  91
  92   bool MayNeedRelaxation(const MCInst &Inst) const;
  93
  94   void RelaxInstruction(const MCInst &Inst, MCInst &Res) const;
  95
  96   bool WriteNopData(uint64_t Count, MCObjectWriter *OW) const;
  97 };
  98 } // end anonymous namespace
  99
 100 static unsigned getRelaxedOpcodeBranch(unsigned Op) {
 101   switch (Op) {
 102   default:
 103     return Op;
 104
 105   case X86::JAE_1: return X86::JAE_4;
 106   case X86::JA_1:  return X86::JA_4;
 107   case X86::JBE_1: return X86::JBE_4;
 108   case X86::JB_1:  return X86::JB_4;
 109   case X86::JE_1:  return X86::JE_4;
 110   case X86::JGE_1: return X86::JGE_4;
 111   case X86::JG_1:  return X86::JG_4;
 112   case X86::JLE_1: return X86::JLE_4;
 113   case X86::JL_1:  return X86::JL_4;
 114   case X86::JMP_1: return X86::JMP_4;
 115   case X86::JNE_1: return X86::JNE_4;
 116   case X86::JNO_1: return X86::JNO_4;
 117   case X86::JNP_1: return X86::JNP_4;
 118   case X86::JNS_1: return X86::JNS_4;
 119   case X86::JO_1:  return X86::JO_4;
 120   case X86::JP_1:  return X86::JP_4;
 121   case X86::JS_1:  return X86::JS_4;
 122   }
 123 }
 124
 125 static unsigned getRelaxedOpcodeArith(unsigned Op) {
 126   switch (Op) {
 127   default:
 128     return Op;
 129
 130     // IMUL
 131   case X86::IMUL16rri8: return X86::IMUL16rri;
 132   case X86::IMUL16rmi8: return X86::IMUL16rmi;
 133   case X86::IMUL32rri8: return X86::IMUL32rri;
 134   case X86::IMUL32rmi8: return X86::IMUL32rmi;
 135   case X86::IMUL64rri8: return X86::IMUL64rri32;
 136   case X86::IMUL64rmi8: return X86::IMUL64rmi32;
 137
 138     // AND
 139   case X86::AND16ri8: return X86::AND16ri;
 140   case X86::AND16mi8: return X86::AND16mi;
 141   case X86::AND32ri8: return X86::AND32ri;
 142   case X86::AND32mi8: return X86::AND32mi;
 143   case X86::AND64ri8: return X86::AND64ri32;
 144   case X86::AND64mi8: return X86::AND64mi32;
 145
 146     // OR
 147   case X86::OR16ri8: return X86::OR16ri;
 148   case X86::OR16mi8: return X86::OR16mi;
 149   case X86::OR32ri8: return X86::OR32ri;
 150   case X86::OR32mi8: return X86::OR32mi;
 151   case X86::OR64ri8: return X86::OR64ri32;
 152   case X86::OR64mi8: return X86::OR64mi32;
 153
 154     // XOR
 155   case X86::XOR16ri8: return X86::XOR16ri;
 156   case X86::XOR16mi8: return X86::XOR16mi;
 157   case X86::XOR32ri8: return X86::XOR32ri;
 158   case X86::XOR32mi8: return X86::XOR32mi;
 159   case X86::XOR64ri8: return X86::XOR64ri32;
 160   case X86::XOR64mi8: return X86::XOR64mi32;
 161
 162     // ADD
 163   case X86::ADD16ri8: return X86::ADD16ri;
 164   case X86::ADD16mi8: return X86::ADD16mi;
 165   case X86::ADD32ri8: return X86::ADD32ri;
 166   case X86::ADD32mi8: return X86::ADD32mi;
 167   case X86::ADD64ri8: return X86::ADD64ri32;
 168   case X86::ADD64mi8: return X86::ADD64mi32;
 169
 170     // SUB
 171   case X86::SUB16ri8: return X86::SUB16ri;
 172   case X86::SUB16mi8: return X86::SUB16mi;
 173   case X86::SUB32ri8: return X86::SUB32ri;
 174   case X86::SUB32mi8: return X86::SUB32mi;
 175   case X86::SUB64ri8: return X86::SUB64ri32;
 176   case X86::SUB64mi8: return X86::SUB64mi32;
 177
 178     // CMP
 179   case X86::CMP16ri8: return X86::CMP16ri;
 180   case X86::CMP16mi8: return X86::CMP16mi;
 181   case X86::CMP32ri8: return X86::CMP32ri;
 182   case X86::CMP32mi8: return X86::CMP32mi;
 183   case X86::CMP64ri8: return X86::CMP64ri32;
 184   case X86::CMP64mi8: return X86::CMP64mi32;
 185   }
 186 }
 187
 188 static unsigned getRelaxedOpcode(unsigned Op) {
 189   unsigned R = getRelaxedOpcodeArith(Op);
 190   if (R != Op)
 191     return R;
 192   return getRelaxedOpcodeBranch(Op);
 193 }
 194
 195 bool X86AsmBackend::MayNeedRelaxation(const MCInst &Inst) const {
 196   // Branches can always be relaxed.
 197   if (getRelaxedOpcodeBranch(Inst.getOpcode()) != Inst.getOpcode())
 198     return true;
 199
 200   // Check if this instruction is ever relaxable.
 201   if (getRelaxedOpcodeArith(Inst.getOpcode()) == Inst.getOpcode())
 202     return false;
 203
 204
 205   // Check if it has an expression and is not RIP relative.
 206   bool hasExp = false;
 207   bool hasRIP = false;
 208   for (unsigned i = 0; i < Inst.getNumOperands(); ++i) {
 209     const MCOperand &Op = Inst.getOperand(i);
 210     if (Op.isExpr())
 211       hasExp = true;
 212
 213     if (Op.isReg() && Op.getReg() == X86::RIP)
 214       hasRIP = true;
 215   }
 216
 217   // FIXME: Why exactly do we need the !hasRIP? Is it just a limitation on
 218   // how we do relaxations?
 219   return hasExp && !hasRIP;
 220 }
 221
 222 // FIXME: Can tblgen help at all here to verify there aren't other instructions
 223 // we can relax?
 224 void X86AsmBackend::RelaxInstruction(const MCInst &Inst, MCInst &Res) const {
 225   // The only relaxations X86 does is from a 1byte pcrel to a 4byte pcrel.
 226   unsigned RelaxedOp = getRelaxedOpcode(Inst.getOpcode());
 227
 228   if (RelaxedOp == Inst.getOpcode()) {
 229     SmallString<256> Tmp;
 230     raw_svector_ostream OS(Tmp);
 231     Inst.dump_pretty(OS);
 232     OS << "\n";
 233     report_fatal_error("unexpected instruction to relax: " + OS.str());
 234   }
 235
 236   Res = Inst;
 237   Res.setOpcode(RelaxedOp);
 238 }
 239
 240 /// WriteNopData - Write optimal nops to the output file for the \arg Count
 241 /// bytes.  This returns the number of bytes written.  It may return 0 if
 242 /// the \arg Count is more than the maximum optimal nops.
 243 bool X86AsmBackend::WriteNopData(uint64_t Count, MCObjectWriter *OW) const {
 244   static const uint8_t Nops[10][10] = {
 245     // nop
 246     {0x90},
 247     // xchg %ax,%ax
 248     {0x66, 0x90},
 249     // nopl (%[re]ax)
 250     {0x0f, 0x1f, 0x00},
 251     // nopl 0(%[re]ax)
 252     {0x0f, 0x1f, 0x40, 0x00},
 253     // nopl 0(%[re]ax,%[re]ax,1)
 254     {0x0f, 0x1f, 0x44, 0x00, 0x00},
 255     // nopw 0(%[re]ax,%[re]ax,1)
 256     {0x66, 0x0f, 0x1f, 0x44, 0x00, 0x00},
 257     // nopl 0L(%[re]ax)
 258     {0x0f, 0x1f, 0x80, 0x00, 0x00, 0x00, 0x00},
 259     // nopl 0L(%[re]ax,%[re]ax,1)
 260     {0x0f, 0x1f, 0x84, 0x00, 0x00, 0x00, 0x00, 0x00},
 261     // nopw 0L(%[re]ax,%[re]ax,1)
 262     {0x66, 0x0f, 0x1f, 0x84, 0x00, 0x00, 0x00, 0x00, 0x00},
 263     // nopw %cs:0L(%[re]ax,%[re]ax,1)
 264     {0x66, 0x2e, 0x0f, 0x1f, 0x84, 0x00, 0x00, 0x00, 0x00, 0x00},
 265   };
 266
 267   // Write an optimal sequence for the first 15 bytes.
 268   const uint64_t OptimalCount = (Count < 16) ? Count : 15;
 269   const uint64_t Prefixes = OptimalCount <= 10 ? 0 : OptimalCount - 10;
 270   for (uint64_t i = 0, e = Prefixes; i != e; i++)
 271     OW->Write8(0x66);
 272   const uint64_t Rest = OptimalCount - Prefixes;
 273   for (uint64_t i = 0, e = Rest; i != e; i++)
 274     OW->Write8(Nops[Rest - 1][i]);
 275
 276   // Finish with single byte nops.
 277   for (uint64_t i = OptimalCount, e = Count; i != e; ++i)
 278    OW->Write8(0x90);
 279
 280   return true;
 281 }
 282
 283 /* *** */
 284
 285 namespace {
 286 class ELFX86AsmBackend : public X86AsmBackend {
 287   MCELFObjectFormat Format;
 288
 289 public:
 290   Triple::OSType OSType;
 291   ELFX86AsmBackend(const Target &T, Triple::OSType _OSType)
 292     : X86AsmBackend(T), OSType(_OSType) {
 293     HasReliableSymbolDifference = true;
 294   }
 295
 296   virtual const MCObjectFormat &getObjectFormat() const {
 297     return Format;
 298   }
 299
 300   virtual bool doesSectionRequireSymbols(const MCSection &Section) const {
 301     const MCSectionELF &ES = static_cast<const MCSectionELF&>(Section);
 302     return ES.getFlags() & MCSectionELF::SHF_MERGE;
 303   }
 304 };
 305
 306 class ELFX86_32AsmBackend : public ELFX86AsmBackend {
 307 public:
 308   ELFX86_32AsmBackend(const Target &T, Triple::OSType OSType)
 309     : ELFX86AsmBackend(T, OSType) {}
 310
 311   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
 312     return createELFObjectWriter(OS, /*Is64Bit=*/false,
 313                                  OSType, ELF::EM_386,
 314                                  /*IsLittleEndian=*/true,
 315                                  /*HasRelocationAddend=*/false);
 316   }
 317 };
 318
 319 class ELFX86_64AsmBackend : public ELFX86AsmBackend {
 320 public:
 321   ELFX86_64AsmBackend(const Target &T, Triple::OSType OSType)
 322     : ELFX86AsmBackend(T, OSType) {}
 323
 324   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
 325     return createELFObjectWriter(OS, /*Is64Bit=*/true,
 326                                  OSType, ELF::EM_X86_64,
 327                                  /*IsLittleEndian=*/true,
 328                                  /*HasRelocationAddend=*/true);
 329   }
 330 };
 331
 332 class WindowsX86AsmBackend : public X86AsmBackend {
 333   bool Is64Bit;
 334   MCCOFFObjectFormat Format;
 335
 336 public:
 337   WindowsX86AsmBackend(const Target &T, bool is64Bit)
 338     : X86AsmBackend(T)
 339     , Is64Bit(is64Bit) {
 340   }
 341
 342   virtual const MCObjectFormat &getObjectFormat() const {
 343     return Format;
 344   }
 345
 346   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
 347     return createWinCOFFObjectWriter(OS, Is64Bit);
 348   }
 349 };
 350
 351 class DarwinX86AsmBackend : public X86AsmBackend {
 352   MCMachOObjectFormat Format;
 353
 354 public:
 355   DarwinX86AsmBackend(const Target &T)
 356     : X86AsmBackend(T) { }
 357
 358   virtual const MCObjectFormat &getObjectFormat() const {
 359     return Format;
 360   }
 361 };
 362
 363 class DarwinX86_32AsmBackend : public DarwinX86AsmBackend {
 364 public:
 365   DarwinX86_32AsmBackend(const Target &T)
 366     : DarwinX86AsmBackend(T) {}
 367
 368   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
 369     return createMachObjectWriter(new X86MachObjectWriter(
 370                                     /*Is64Bit=*/false,
 371                                     object::mach::CTM_i386,
 372                                     object::mach::CSX86_ALL),
 373                                   OS, /*IsLittleEndian=*/true);
 374   }
 375 };
 376
 377 class DarwinX86_64AsmBackend : public DarwinX86AsmBackend {
 378 public:
 379   DarwinX86_64AsmBackend(const Target &T)
 380     : DarwinX86AsmBackend(T) {
 381     HasReliableSymbolDifference = true;
 382   }
 383
 384   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
 385     return createMachObjectWriter(new X86MachObjectWriter(
 386                                     /*Is64Bit=*/true,
 387                                     object::mach::CTM_x86_64,
 388                                     object::mach::CSX86_ALL),
 389                                   OS, /*IsLittleEndian=*/true);
 390   }
 391
 392   virtual bool doesSectionRequireSymbols(const MCSection &Section) const {
 393     // Temporary labels in the string literals sections require symbols. The
 394     // issue is that the x86_64 relocation format does not allow symbol +
 395     // offset, and so the linker does not have enough information to resolve the
 396     // access to the appropriate atom unless an external relocation is used. For
 397     // non-cstring sections, we expect the compiler to use a non-temporary label
 398     // for anything that could have an addend pointing outside the symbol.
 399     //
 400     // See <rdar://problem/4765733>.
 401     const MCSectionMachO &SMO = static_cast<const MCSectionMachO&>(Section);
 402     return SMO.getType() == MCSectionMachO::S_CSTRING_LITERALS;
 403   }
 404
 405   virtual bool isSectionAtomizable(const MCSection &Section) const {
 406     const MCSectionMachO &SMO = static_cast<const MCSectionMachO&>(Section);
 407     // Fixed sized data sections are uniqued, they cannot be diced into atoms.
 408     switch (SMO.getType()) {
 409     default:
 410       return true;
 411
 412     case MCSectionMachO::S_4BYTE_LITERALS:
 413     case MCSectionMachO::S_8BYTE_LITERALS:
 414     case MCSectionMachO::S_16BYTE_LITERALS:
 415     case MCSectionMachO::S_LITERAL_POINTERS:
 416     case MCSectionMachO::S_NON_LAZY_SYMBOL_POINTERS:
 417     case MCSectionMachO::S_LAZY_SYMBOL_POINTERS:
 418     case MCSectionMachO::S_MOD_INIT_FUNC_POINTERS:
 419     case MCSectionMachO::S_MOD_TERM_FUNC_POINTERS:
 420     case MCSectionMachO::S_INTERPOSING:
 421       return false;
 422     }
 423   }
 424 };
 425
 426 } // end anonymous namespace
 427
 428 TargetAsmBackend *llvm::createX86_32AsmBackend(const Target &T,
 429                                                const std::string &TT) {
 430   switch (Triple(TT).getOS()) {
 431   case Triple::Darwin:
 432     return new DarwinX86_32AsmBackend(T);
 433   case Triple::MinGW32:
 434   case Triple::Cygwin:
 435   case Triple::Win32:
 436     return new WindowsX86AsmBackend(T, false);
 437   default:
 438     return new ELFX86_32AsmBackend(T, Triple(TT).getOS());
 439   }
 440 }
 441
 442 TargetAsmBackend *llvm::createX86_64AsmBackend(const Target &T,
 443                                                const std::string &TT) {
 444   switch (Triple(TT).getOS()) {
 445   case Triple::Darwin:
 446     return new DarwinX86_64AsmBackend(T);
 447   case Triple::MinGW64:
 448   case Triple::Cygwin:
 449   case Triple::Win32:
 450     return new WindowsX86AsmBackend(T, true);
 451   default:
 452     return new ELFX86_64AsmBackend(T, Triple(TT).getOS());
 453   }
 454 }