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