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