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() : MCELFObjectTargetWriter() {}
  61 };
  62
  63 class X86AsmBackend : public TargetAsmBackend {
  64 public:
  65   X86AsmBackend(const Target &T)
  66     : TargetAsmBackend() {}
  67
  68   unsigned getNumFixupKinds() const {
  69     return X86::NumTargetFixupKinds;
  70   }
  71
  72   const MCFixupKindInfo &getFixupKindInfo(MCFixupKind Kind) const {
  73     const static MCFixupKindInfo Infos[X86::NumTargetFixupKinds] = {
  74       { "reloc_riprel_4byte", 0, 4 * 8, MCFixupKindInfo::FKF_IsPCRel },
  75       { "reloc_riprel_4byte_movq_load", 0, 4 * 8, MCFixupKindInfo::FKF_IsPCRel},
  76       { "reloc_signed_4byte", 0, 4 * 8, 0},
  77       { "reloc_global_offset_table", 0, 4 * 8, 0}
  78     };
  79
  80     if (Kind < FirstTargetFixupKind)
  81       return TargetAsmBackend::getFixupKindInfo(Kind);
  82
  83     assert(unsigned(Kind - FirstTargetFixupKind) < getNumFixupKinds() &&
  84            "Invalid kind!");
  85     return Infos[Kind - FirstTargetFixupKind];
  86   }
  87
  88   void ApplyFixup(const MCFixup &Fixup, char *Data, unsigned DataSize,
  89                   uint64_t Value) const {
  90     unsigned Size = 1 << getFixupKindLog2Size(Fixup.getKind());
  91
  92     assert(Fixup.getOffset() + Size <= DataSize &&
  93            "Invalid fixup offset!");
  94     for (unsigned i = 0; i != Size; ++i)
  95       Data[Fixup.getOffset() + i] = uint8_t(Value >> (i * 8));
  96   }
  97
  98   bool MayNeedRelaxation(const MCInst &Inst) const;
  99
 100   void RelaxInstruction(const MCInst &Inst, MCInst &Res) const;
 101
 102   bool WriteNopData(uint64_t Count, MCObjectWriter *OW) const;
 103 };
 104 } // end anonymous namespace
 105
 106 static unsigned getRelaxedOpcodeBranch(unsigned Op) {
 107   switch (Op) {
 108   default:
 109     return Op;
 110
 111   case X86::JAE_1: return X86::JAE_4;
 112   case X86::JA_1:  return X86::JA_4;
 113   case X86::JBE_1: return X86::JBE_4;
 114   case X86::JB_1:  return X86::JB_4;
 115   case X86::JE_1:  return X86::JE_4;
 116   case X86::JGE_1: return X86::JGE_4;
 117   case X86::JG_1:  return X86::JG_4;
 118   case X86::JLE_1: return X86::JLE_4;
 119   case X86::JL_1:  return X86::JL_4;
 120   case X86::JMP_1: return X86::JMP_4;
 121   case X86::JNE_1: return X86::JNE_4;
 122   case X86::JNO_1: return X86::JNO_4;
 123   case X86::JNP_1: return X86::JNP_4;
 124   case X86::JNS_1: return X86::JNS_4;
 125   case X86::JO_1:  return X86::JO_4;
 126   case X86::JP_1:  return X86::JP_4;
 127   case X86::JS_1:  return X86::JS_4;
 128   }
 129 }
 130
 131 static unsigned getRelaxedOpcodeArith(unsigned Op) {
 132   switch (Op) {
 133   default:
 134     return Op;
 135
 136     // IMUL
 137   case X86::IMUL16rri8: return X86::IMUL16rri;
 138   case X86::IMUL16rmi8: return X86::IMUL16rmi;
 139   case X86::IMUL32rri8: return X86::IMUL32rri;
 140   case X86::IMUL32rmi8: return X86::IMUL32rmi;
 141   case X86::IMUL64rri8: return X86::IMUL64rri32;
 142   case X86::IMUL64rmi8: return X86::IMUL64rmi32;
 143
 144     // AND
 145   case X86::AND16ri8: return X86::AND16ri;
 146   case X86::AND16mi8: return X86::AND16mi;
 147   case X86::AND32ri8: return X86::AND32ri;
 148   case X86::AND32mi8: return X86::AND32mi;
 149   case X86::AND64ri8: return X86::AND64ri32;
 150   case X86::AND64mi8: return X86::AND64mi32;
 151
 152     // OR
 153   case X86::OR16ri8: return X86::OR16ri;
 154   case X86::OR16mi8: return X86::OR16mi;
 155   case X86::OR32ri8: return X86::OR32ri;
 156   case X86::OR32mi8: return X86::OR32mi;
 157   case X86::OR64ri8: return X86::OR64ri32;
 158   case X86::OR64mi8: return X86::OR64mi32;
 159
 160     // XOR
 161   case X86::XOR16ri8: return X86::XOR16ri;
 162   case X86::XOR16mi8: return X86::XOR16mi;
 163   case X86::XOR32ri8: return X86::XOR32ri;
 164   case X86::XOR32mi8: return X86::XOR32mi;
 165   case X86::XOR64ri8: return X86::XOR64ri32;
 166   case X86::XOR64mi8: return X86::XOR64mi32;
 167
 168     // ADD
 169   case X86::ADD16ri8: return X86::ADD16ri;
 170   case X86::ADD16mi8: return X86::ADD16mi;
 171   case X86::ADD32ri8: return X86::ADD32ri;
 172   case X86::ADD32mi8: return X86::ADD32mi;
 173   case X86::ADD64ri8: return X86::ADD64ri32;
 174   case X86::ADD64mi8: return X86::ADD64mi32;
 175
 176     // SUB
 177   case X86::SUB16ri8: return X86::SUB16ri;
 178   case X86::SUB16mi8: return X86::SUB16mi;
 179   case X86::SUB32ri8: return X86::SUB32ri;
 180   case X86::SUB32mi8: return X86::SUB32mi;
 181   case X86::SUB64ri8: return X86::SUB64ri32;
 182   case X86::SUB64mi8: return X86::SUB64mi32;
 183
 184     // CMP
 185   case X86::CMP16ri8: return X86::CMP16ri;
 186   case X86::CMP16mi8: return X86::CMP16mi;
 187   case X86::CMP32ri8: return X86::CMP32ri;
 188   case X86::CMP32mi8: return X86::CMP32mi;
 189   case X86::CMP64ri8: return X86::CMP64ri32;
 190   case X86::CMP64mi8: return X86::CMP64mi32;
 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   MCELFObjectFormat Format;
 294
 295 public:
 296   Triple::OSType OSType;
 297   ELFX86AsmBackend(const Target &T, Triple::OSType _OSType)
 298     : X86AsmBackend(T), OSType(_OSType) {
 299     HasReliableSymbolDifference = true;
 300   }
 301
 302   virtual const MCObjectFormat &getObjectFormat() const {
 303     return Format;
 304   }
 305
 306   virtual bool doesSectionRequireSymbols(const MCSection &Section) const {
 307     const MCSectionELF &ES = static_cast<const MCSectionELF&>(Section);
 308     return ES.getFlags() & MCSectionELF::SHF_MERGE;
 309   }
 310 };
 311
 312 class ELFX86_32AsmBackend : public ELFX86AsmBackend {
 313 public:
 314   ELFX86_32AsmBackend(const Target &T, Triple::OSType OSType)
 315     : ELFX86AsmBackend(T, OSType) {}
 316
 317   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
 318     return createELFObjectWriter(new X86ELFObjectWriter(), OS,
 319                                  /*Is64Bit=*/false,
 320                                  OSType, ELF::EM_386,
 321                                  /*IsLittleEndian=*/true,
 322                                  /*HasRelocationAddend=*/false);
 323   }
 324 };
 325
 326 class ELFX86_64AsmBackend : public ELFX86AsmBackend {
 327 public:
 328   ELFX86_64AsmBackend(const Target &T, Triple::OSType OSType)
 329     : ELFX86AsmBackend(T, OSType) {}
 330
 331   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
 332     return createELFObjectWriter(new X86ELFObjectWriter(), OS, /*Is64Bit=*/true,
 333                                  OSType, ELF::EM_X86_64,
 334                                  /*IsLittleEndian=*/true,
 335                                  /*HasRelocationAddend=*/true);
 336   }
 337 };
 338
 339 class WindowsX86AsmBackend : public X86AsmBackend {
 340   bool Is64Bit;
 341   MCCOFFObjectFormat Format;
 342
 343 public:
 344   WindowsX86AsmBackend(const Target &T, bool is64Bit)
 345     : X86AsmBackend(T)
 346     , Is64Bit(is64Bit) {
 347   }
 348
 349   virtual const MCObjectFormat &getObjectFormat() const {
 350     return Format;
 351   }
 352
 353   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
 354     return createWinCOFFObjectWriter(OS, Is64Bit);
 355   }
 356 };
 357
 358 class DarwinX86AsmBackend : public X86AsmBackend {
 359   MCMachOObjectFormat Format;
 360
 361 public:
 362   DarwinX86AsmBackend(const Target &T)
 363     : X86AsmBackend(T) { }
 364
 365   virtual const MCObjectFormat &getObjectFormat() const {
 366     return Format;
 367   }
 368 };
 369
 370 class DarwinX86_32AsmBackend : public DarwinX86AsmBackend {
 371 public:
 372   DarwinX86_32AsmBackend(const Target &T)
 373     : DarwinX86AsmBackend(T) {}
 374
 375   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
 376     return createMachObjectWriter(new X86MachObjectWriter(
 377                                     /*Is64Bit=*/false,
 378                                     object::mach::CTM_i386,
 379                                     object::mach::CSX86_ALL),
 380                                   OS, /*IsLittleEndian=*/true);
 381   }
 382 };
 383
 384 class DarwinX86_64AsmBackend : public DarwinX86AsmBackend {
 385 public:
 386   DarwinX86_64AsmBackend(const Target &T)
 387     : DarwinX86AsmBackend(T) {
 388     HasReliableSymbolDifference = true;
 389   }
 390
 391   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
 392     return createMachObjectWriter(new X86MachObjectWriter(
 393                                     /*Is64Bit=*/true,
 394                                     object::mach::CTM_x86_64,
 395                                     object::mach::CSX86_ALL),
 396                                   OS, /*IsLittleEndian=*/true);
 397   }
 398
 399   virtual bool doesSectionRequireSymbols(const MCSection &Section) const {
 400     // Temporary labels in the string literals sections require symbols. The
 401     // issue is that the x86_64 relocation format does not allow symbol +
 402     // offset, and so the linker does not have enough information to resolve the
 403     // access to the appropriate atom unless an external relocation is used. For
 404     // non-cstring sections, we expect the compiler to use a non-temporary label
 405     // for anything that could have an addend pointing outside the symbol.
 406     //
 407     // See <rdar://problem/4765733>.
 408     const MCSectionMachO &SMO = static_cast<const MCSectionMachO&>(Section);
 409     return SMO.getType() == MCSectionMachO::S_CSTRING_LITERALS;
 410   }
 411
 412   virtual bool isSectionAtomizable(const MCSection &Section) const {
 413     const MCSectionMachO &SMO = static_cast<const MCSectionMachO&>(Section);
 414     // Fixed sized data sections are uniqued, they cannot be diced into atoms.
 415     switch (SMO.getType()) {
 416     default:
 417       return true;
 418
 419     case MCSectionMachO::S_4BYTE_LITERALS:
 420     case MCSectionMachO::S_8BYTE_LITERALS:
 421     case MCSectionMachO::S_16BYTE_LITERALS:
 422     case MCSectionMachO::S_LITERAL_POINTERS:
 423     case MCSectionMachO::S_NON_LAZY_SYMBOL_POINTERS:
 424     case MCSectionMachO::S_LAZY_SYMBOL_POINTERS:
 425     case MCSectionMachO::S_MOD_INIT_FUNC_POINTERS:
 426     case MCSectionMachO::S_MOD_TERM_FUNC_POINTERS:
 427     case MCSectionMachO::S_INTERPOSING:
 428       return false;
 429     }
 430   }
 431 };
 432
 433 } // end anonymous namespace
 434
 435 TargetAsmBackend *llvm::createX86_32AsmBackend(const Target &T,
 436                                                const std::string &TT) {
 437   switch (Triple(TT).getOS()) {
 438   case Triple::Darwin:
 439     return new DarwinX86_32AsmBackend(T);
 440   case Triple::MinGW32:
 441   case Triple::Cygwin:
 442   case Triple::Win32:
 443     return new WindowsX86AsmBackend(T, false);
 444   default:
 445     return new ELFX86_32AsmBackend(T, Triple(TT).getOS());
 446   }
 447 }
 448
 449 TargetAsmBackend *llvm::createX86_64AsmBackend(const Target &T,
 450                                                const std::string &TT) {
 451   switch (Triple(TT).getOS()) {
 452   case Triple::Darwin:
 453     return new DarwinX86_64AsmBackend(T);
 454   case Triple::MinGW64:
 455   case Triple::Cygwin:
 456   case Triple::Win32:
 457     return new WindowsX86AsmBackend(T, true);
 458   default:
 459     return new ELFX86_64AsmBackend(T, Triple(TT).getOS());
 460   }
 461 }