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