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/MCObjectWriter.h"
  16 #include "llvm/MC/MCSectionELF.h"
  17 #include "llvm/MC/MCSectionMachO.h"
  18 #include "llvm/MC/MachObjectWriter.h"
  19 #include "llvm/Support/ErrorHandling.h"
  20 #include "llvm/Support/raw_ostream.h"
  21 #include "llvm/Target/TargetRegistry.h"
  22 #include "llvm/Target/TargetAsmBackend.h"
  23 using namespace llvm;
  24
  25 namespace {
  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 FK_Data_2: return 1;
  33   case X86::reloc_pcrel_4byte:
  34   case X86::reloc_riprel_4byte:
  35   case X86::reloc_riprel_4byte_movq_load:
  36   case FK_Data_4: return 2;
  37   case FK_Data_8: return 3;
  38   }
  39 }
  40
  41 class X86AsmBackend : public TargetAsmBackend {
  42 public:
  43   X86AsmBackend(const Target &T)
  44     : TargetAsmBackend(T) {}
  45
  46   void ApplyFixup(const MCAsmFixup &Fixup, MCDataFragment &DF,
  47                   uint64_t Value) const {
  48     unsigned Size = 1 << getFixupKindLog2Size(Fixup.Kind);
  49
  50     assert(Fixup.Offset + Size <= DF.getContents().size() &&
  51            "Invalid fixup offset!");
  52     for (unsigned i = 0; i != Size; ++i)
  53       DF.getContents()[Fixup.Offset + i] = uint8_t(Value >> (i * 8));
  54   }
  55
  56   bool MayNeedRelaxation(const MCInst &Inst,
  57                          const SmallVectorImpl<MCAsmFixup> &Fixups) const;
  58
  59   void RelaxInstruction(const MCInstFragment *IF, MCInst &Res) const;
  60
  61   bool WriteNopData(uint64_t Count, MCObjectWriter *OW) const;
  62 };
  63
  64 static unsigned getRelaxedOpcode(unsigned Op) {
  65   switch (Op) {
  66   default:
  67     return Op;
  68
  69   case X86::JAE_1: return X86::JAE_4;
  70   case X86::JA_1:  return X86::JA_4;
  71   case X86::JBE_1: return X86::JBE_4;
  72   case X86::JB_1:  return X86::JB_4;
  73   case X86::JE_1:  return X86::JE_4;
  74   case X86::JGE_1: return X86::JGE_4;
  75   case X86::JG_1:  return X86::JG_4;
  76   case X86::JLE_1: return X86::JLE_4;
  77   case X86::JL_1:  return X86::JL_4;
  78   case X86::JMP_1: return X86::JMP_4;
  79   case X86::JNE_1: return X86::JNE_4;
  80   case X86::JNO_1: return X86::JNO_4;
  81   case X86::JNP_1: return X86::JNP_4;
  82   case X86::JNS_1: return X86::JNS_4;
  83   case X86::JO_1:  return X86::JO_4;
  84   case X86::JP_1:  return X86::JP_4;
  85   case X86::JS_1:  return X86::JS_4;
  86   }
  87 }
  88
  89 bool X86AsmBackend::MayNeedRelaxation(const MCInst &Inst,
  90                               const SmallVectorImpl<MCAsmFixup> &Fixups) const {
  91   // Check for a 1byte pcrel fixup, and enforce that we would know how to relax
  92   // this instruction.
  93   for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
  94     if (unsigned(Fixups[i].Kind) == X86::reloc_pcrel_1byte) {
  95       assert(getRelaxedOpcode(Inst.getOpcode()) != Inst.getOpcode());
  96       return true;
  97     }
  98   }
  99
 100   return false;
 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 MCInstFragment *IF,
 106                                      MCInst &Res) const {
 107   // The only relaxations X86 does is from a 1byte pcrel to a 4byte pcrel.
 108   unsigned RelaxedOp = getRelaxedOpcode(IF->getInst().getOpcode());
 109
 110   if (RelaxedOp == IF->getInst().getOpcode()) {
 111     SmallString<256> Tmp;
 112     raw_svector_ostream OS(Tmp);
 113     IF->getInst().dump_pretty(OS);
 114     llvm_report_error("unexpected instruction to relax: " + OS.str());
 115   }
 116
 117   Res = IF->getInst();
 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 class ELFX86AsmBackend : public X86AsmBackend {
 185 public:
 186   ELFX86AsmBackend(const Target &T)
 187     : X86AsmBackend(T) {
 188     HasAbsolutizedSet = true;
 189     HasScatteredSymbols = true;
 190   }
 191
 192   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
 193     return 0;
 194   }
 195
 196   bool isVirtualSection(const MCSection &Section) const {
 197     const MCSectionELF &SE = static_cast<const MCSectionELF&>(Section);
 198     return SE.getType() == MCSectionELF::SHT_NOBITS;;
 199   }
 200 };
 201
 202 class DarwinX86AsmBackend : public X86AsmBackend {
 203 public:
 204   DarwinX86AsmBackend(const Target &T)
 205     : X86AsmBackend(T) {
 206     HasAbsolutizedSet = true;
 207     HasScatteredSymbols = true;
 208   }
 209
 210   bool isVirtualSection(const MCSection &Section) const {
 211     const MCSectionMachO &SMO = static_cast<const MCSectionMachO&>(Section);
 212     return (SMO.getType() == MCSectionMachO::S_ZEROFILL ||
 213             SMO.getType() == MCSectionMachO::S_GB_ZEROFILL);
 214   }
 215 };
 216
 217 class DarwinX86_32AsmBackend : public DarwinX86AsmBackend {
 218 public:
 219   DarwinX86_32AsmBackend(const Target &T)
 220     : DarwinX86AsmBackend(T) {}
 221
 222   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
 223     return new MachObjectWriter(OS, /*Is64Bit=*/false);
 224   }
 225 };
 226
 227 class DarwinX86_64AsmBackend : public DarwinX86AsmBackend {
 228 public:
 229   DarwinX86_64AsmBackend(const Target &T)
 230     : DarwinX86AsmBackend(T) {
 231     HasReliableSymbolDifference = true;
 232   }
 233
 234   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
 235     return new MachObjectWriter(OS, /*Is64Bit=*/true);
 236   }
 237
 238   virtual bool doesSectionRequireSymbols(const MCSection &Section) const {
 239     // Temporary labels in the string literals sections require symbols. The
 240     // issue is that the x86_64 relocation format does not allow symbol +
 241     // offset, and so the linker does not have enough information to resolve the
 242     // access to the appropriate atom unless an external relocation is used. For
 243     // non-cstring sections, we expect the compiler to use a non-temporary label
 244     // for anything that could have an addend pointing outside the symbol.
 245     //
 246     // See <rdar://problem/4765733>.
 247     const MCSectionMachO &SMO = static_cast<const MCSectionMachO&>(Section);
 248     return SMO.getType() == MCSectionMachO::S_CSTRING_LITERALS;
 249   }
 250 };
 251
 252 }
 253
 254 TargetAsmBackend *llvm::createX86_32AsmBackend(const Target &T,
 255                                                const std::string &TT) {
 256   switch (Triple(TT).getOS()) {
 257   case Triple::Darwin:
 258     return new DarwinX86_32AsmBackend(T);
 259   default:
 260     return new ELFX86AsmBackend(T);
 261   }
 262 }
 263
 264 TargetAsmBackend *llvm::createX86_64AsmBackend(const Target &T,
 265                                                const std::string &TT) {
 266   switch (Triple(TT).getOS()) {
 267   case Triple::Darwin:
 268     return new DarwinX86_64AsmBackend(T);
 269   default:
 270     return new ELFX86AsmBackend(T);
 271   }
 272 }