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/MCObjectWriter.h"
  17 #include "llvm/MC/MCSectionELF.h"
  18 #include "llvm/MC/MCSectionMachO.h"
  19 #include "llvm/MC/MachObjectWriter.h"
  20 #include "llvm/Support/ErrorHandling.h"
  21 #include "llvm/Support/raw_ostream.h"
  22 #include "llvm/Target/TargetRegistry.h"
  23 #include "llvm/Target/TargetAsmBackend.h"
  24 using namespace llvm;
  25
  26
  27 static unsigned getFixupKindLog2Size(unsigned Kind) {
  28   switch (Kind) {
  29   default: assert(0 && "invalid fixup kind!");
  30   case X86::reloc_pcrel_1byte:
  31   case FK_Data_1: return 0;
  32   case X86::reloc_pcrel_2byte:
  33   case FK_Data_2: return 1;
  34   case X86::reloc_pcrel_4byte:
  35   case X86::reloc_riprel_4byte:
  36   case X86::reloc_riprel_4byte_movq_load:
  37   case FK_Data_4: return 2;
  38   case FK_Data_8: return 3;
  39   }
  40 }
  41
  42 namespace {
  43 class X86AsmBackend : public TargetAsmBackend {
  44 public:
  45   X86AsmBackend(const Target &T)
  46     : TargetAsmBackend(T) {}
  47
  48   void ApplyFixup(const MCFixup &Fixup, MCDataFragment &DF,
  49                   uint64_t Value) const {
  50     unsigned Size = 1 << getFixupKindLog2Size(Fixup.getKind());
  51
  52     assert(Fixup.getOffset() + Size <= DF.getContents().size() &&
  53            "Invalid fixup offset!");
  54     for (unsigned i = 0; i != Size; ++i)
  55       DF.getContents()[Fixup.getOffset() + i] = uint8_t(Value >> (i * 8));
  56   }
  57
  58   bool MayNeedRelaxation(const MCInst &Inst) const;
  59
  60   void RelaxInstruction(const MCInst &Inst, MCInst &Res) const;
  61
  62   bool WriteNopData(uint64_t Count, MCObjectWriter *OW) const;
  63 };
  64 } // end anonymous namespace
  65
  66 static unsigned getRelaxedOpcode(unsigned Op) {
  67   switch (Op) {
  68   default:
  69     return Op;
  70
  71   case X86::JAE_1: return X86::JAE_4;
  72   case X86::JA_1:  return X86::JA_4;
  73   case X86::JBE_1: return X86::JBE_4;
  74   case X86::JB_1:  return X86::JB_4;
  75   case X86::JE_1:  return X86::JE_4;
  76   case X86::JGE_1: return X86::JGE_4;
  77   case X86::JG_1:  return X86::JG_4;
  78   case X86::JLE_1: return X86::JLE_4;
  79   case X86::JL_1:  return X86::JL_4;
  80   case X86::JMP_1: return X86::JMP_4;
  81   case X86::JNE_1: return X86::JNE_4;
  82   case X86::JNO_1: return X86::JNO_4;
  83   case X86::JNP_1: return X86::JNP_4;
  84   case X86::JNS_1: return X86::JNS_4;
  85   case X86::JO_1:  return X86::JO_4;
  86   case X86::JP_1:  return X86::JP_4;
  87   case X86::JS_1:  return X86::JS_4;
  88   }
  89 }
  90
  91 bool X86AsmBackend::MayNeedRelaxation(const MCInst &Inst) const {
  92   // Check if this instruction is ever relaxable.
  93   if (getRelaxedOpcode(Inst.getOpcode()) == Inst.getOpcode())
  94     return false;
  95
  96   // If so, just assume it can be relaxed. Once we support relaxing more complex
  97   // instructions we should check that the instruction actually has symbolic
  98   // operands before doing this, but we need to be careful about things like
  99   // PCrel.
 100   return true;
 101 }
 102
 103 // FIXME: Can tblgen help at all here to verify there aren't other instructions
 104 // we can relax?
 105 void X86AsmBackend::RelaxInstruction(const MCInst &Inst, MCInst &Res) const {
 106   // The only relaxations X86 does is from a 1byte pcrel to a 4byte pcrel.
 107   unsigned RelaxedOp = getRelaxedOpcode(Inst.getOpcode());
 108
 109   if (RelaxedOp == Inst.getOpcode()) {
 110     SmallString<256> Tmp;
 111     raw_svector_ostream OS(Tmp);
 112     Inst.dump_pretty(OS);
 113     OS << "\n";
 114     report_fatal_error("unexpected instruction to relax: " + OS.str());
 115   }
 116
 117   Res = Inst;
 118   Res.setOpcode(RelaxedOp);
 119 }
 120
 121 /// WriteNopData - Write optimal nops to the output file for the \arg Count
 122 /// bytes.  This returns the number of bytes written.  It may return 0 if
 123 /// the \arg Count is more than the maximum optimal nops.
 124 ///
 125 /// FIXME this is X86 32-bit specific and should move to a better place.
 126 bool X86AsmBackend::WriteNopData(uint64_t Count, MCObjectWriter *OW) const {
 127   static const uint8_t Nops[16][16] = {
 128     // nop
 129     {0x90},
 130     // xchg %ax,%ax
 131     {0x66, 0x90},
 132     // nopl (%[re]ax)
 133     {0x0f, 0x1f, 0x00},
 134     // nopl 0(%[re]ax)
 135     {0x0f, 0x1f, 0x40, 0x00},
 136     // nopl 0(%[re]ax,%[re]ax,1)
 137     {0x0f, 0x1f, 0x44, 0x00, 0x00},
 138     // nopw 0(%[re]ax,%[re]ax,1)
 139     {0x66, 0x0f, 0x1f, 0x44, 0x00, 0x00},
 140     // nopl 0L(%[re]ax)
 141     {0x0f, 0x1f, 0x80, 0x00, 0x00, 0x00, 0x00},
 142     // nopl 0L(%[re]ax,%[re]ax,1)
 143     {0x0f, 0x1f, 0x84, 0x00, 0x00, 0x00, 0x00, 0x00},
 144     // nopw 0L(%[re]ax,%[re]ax,1)
 145     {0x66, 0x0f, 0x1f, 0x84, 0x00, 0x00, 0x00, 0x00, 0x00},
 146     // nopw %cs:0L(%[re]ax,%[re]ax,1)
 147     {0x66, 0x2e, 0x0f, 0x1f, 0x84, 0x00, 0x00, 0x00, 0x00, 0x00},
 148     // nopl 0(%[re]ax,%[re]ax,1)
 149     // nopw 0(%[re]ax,%[re]ax,1)
 150     {0x0f, 0x1f, 0x44, 0x00, 0x00,
 151      0x66, 0x0f, 0x1f, 0x44, 0x00, 0x00},
 152     // nopw 0(%[re]ax,%[re]ax,1)
 153     // nopw 0(%[re]ax,%[re]ax,1)
 154     {0x66, 0x0f, 0x1f, 0x44, 0x00, 0x00,
 155      0x66, 0x0f, 0x1f, 0x44, 0x00, 0x00},
 156     // nopw 0(%[re]ax,%[re]ax,1)
 157     // nopl 0L(%[re]ax) */
 158     {0x66, 0x0f, 0x1f, 0x44, 0x00, 0x00,
 159      0x0f, 0x1f, 0x80, 0x00, 0x00, 0x00, 0x00},
 160     // nopl 0L(%[re]ax)
 161     // nopl 0L(%[re]ax)
 162     {0x0f, 0x1f, 0x80, 0x00, 0x00, 0x00, 0x00,
 163      0x0f, 0x1f, 0x80, 0x00, 0x00, 0x00, 0x00},
 164     // nopl 0L(%[re]ax)
 165     // nopl 0L(%[re]ax,%[re]ax,1)
 166     {0x0f, 0x1f, 0x80, 0x00, 0x00, 0x00, 0x00,
 167      0x0f, 0x1f, 0x84, 0x00, 0x00, 0x00, 0x00, 0x00}
 168   };
 169
 170   // Write an optimal sequence for the first 15 bytes.
 171   uint64_t OptimalCount = (Count < 16) ? Count : 15;
 172   for (uint64_t i = 0, e = OptimalCount; i != e; i++)
 173     OW->Write8(Nops[OptimalCount - 1][i]);
 174
 175   // Finish with single byte nops.
 176   for (uint64_t i = OptimalCount, e = Count; i != e; ++i)
 177    OW->Write8(0x90);
 178
 179   return true;
 180 }
 181
 182 /* *** */
 183
 184 namespace {
 185 class ELFX86AsmBackend : public X86AsmBackend {
 186 public:
 187   ELFX86AsmBackend(const Target &T)
 188     : X86AsmBackend(T) {
 189     HasAbsolutizedSet = true;
 190     HasScatteredSymbols = true;
 191   }
 192
 193   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
 194     return 0;
 195   }
 196
 197   bool isVirtualSection(const MCSection &Section) const {
 198     const MCSectionELF &SE = static_cast<const MCSectionELF&>(Section);
 199     return SE.getType() == MCSectionELF::SHT_NOBITS;;
 200   }
 201 };
 202
 203 class ELFX86_32AsmBackend : public ELFX86AsmBackend {
 204 public:
 205   ELFX86_32AsmBackend(const Target &T)
 206     : ELFX86AsmBackend(T) {}
 207 };
 208
 209 class ELFX86_64AsmBackend : public ELFX86AsmBackend {
 210 public:
 211   ELFX86_64AsmBackend(const Target &T)
 212     : ELFX86AsmBackend(T) {}
 213 };
 214
 215 class DarwinX86AsmBackend : public X86AsmBackend {
 216 public:
 217   DarwinX86AsmBackend(const Target &T)
 218     : X86AsmBackend(T) {
 219     HasAbsolutizedSet = true;
 220     HasScatteredSymbols = true;
 221   }
 222
 223   bool isVirtualSection(const MCSection &Section) const {
 224     const MCSectionMachO &SMO = static_cast<const MCSectionMachO&>(Section);
 225     return (SMO.getType() == MCSectionMachO::S_ZEROFILL ||
 226             SMO.getType() == MCSectionMachO::S_GB_ZEROFILL ||
 227             SMO.getType() == MCSectionMachO::S_THREAD_LOCAL_ZEROFILL);
 228   }
 229 };
 230
 231 class DarwinX86_32AsmBackend : public DarwinX86AsmBackend {
 232 public:
 233   DarwinX86_32AsmBackend(const Target &T)
 234     : DarwinX86AsmBackend(T) {}
 235
 236   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
 237     return new MachObjectWriter(OS, /*Is64Bit=*/false);
 238   }
 239 };
 240
 241 class DarwinX86_64AsmBackend : public DarwinX86AsmBackend {
 242 public:
 243   DarwinX86_64AsmBackend(const Target &T)
 244     : DarwinX86AsmBackend(T) {
 245     HasReliableSymbolDifference = true;
 246   }
 247
 248   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
 249     return new MachObjectWriter(OS, /*Is64Bit=*/true);
 250   }
 251
 252   virtual bool doesSectionRequireSymbols(const MCSection &Section) const {
 253     // Temporary labels in the string literals sections require symbols. The
 254     // issue is that the x86_64 relocation format does not allow symbol +
 255     // offset, and so the linker does not have enough information to resolve the
 256     // access to the appropriate atom unless an external relocation is used. For
 257     // non-cstring sections, we expect the compiler to use a non-temporary label
 258     // for anything that could have an addend pointing outside the symbol.
 259     //
 260     // See <rdar://problem/4765733>.
 261     const MCSectionMachO &SMO = static_cast<const MCSectionMachO&>(Section);
 262     return SMO.getType() == MCSectionMachO::S_CSTRING_LITERALS;
 263   }
 264
 265   virtual bool isSectionAtomizable(const MCSection &Section) const {
 266     const MCSectionMachO &SMO = static_cast<const MCSectionMachO&>(Section);
 267     // Fixed sized data sections are uniqued, they cannot be diced into atoms.
 268     switch (SMO.getType()) {
 269     default:
 270       return true;
 271
 272     case MCSectionMachO::S_4BYTE_LITERALS:
 273     case MCSectionMachO::S_8BYTE_LITERALS:
 274     case MCSectionMachO::S_16BYTE_LITERALS:
 275     case MCSectionMachO::S_LITERAL_POINTERS:
 276     case MCSectionMachO::S_NON_LAZY_SYMBOL_POINTERS:
 277     case MCSectionMachO::S_LAZY_SYMBOL_POINTERS:
 278     case MCSectionMachO::S_MOD_INIT_FUNC_POINTERS:
 279     case MCSectionMachO::S_MOD_TERM_FUNC_POINTERS:
 280     case MCSectionMachO::S_INTERPOSING:
 281       return false;
 282     }
 283   }
 284 };
 285
 286 } // end anonymous namespace
 287
 288 TargetAsmBackend *llvm::createX86_32AsmBackend(const Target &T,
 289                                                const std::string &TT) {
 290   switch (Triple(TT).getOS()) {
 291   case Triple::Darwin:
 292     return new DarwinX86_32AsmBackend(T);
 293   default:
 294     return new ELFX86_32AsmBackend(T);
 295   }
 296 }
 297
 298 TargetAsmBackend *llvm::createX86_64AsmBackend(const Target &T,
 299                                                const std::string &TT) {
 300   switch (Triple(TT).getOS()) {
 301   case Triple::Darwin:
 302     return new DarwinX86_64AsmBackend(T);
 303   default:
 304     return new ELFX86_64AsmBackend(T);
 305   }
 306 }