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