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