lib/Target/ARM/ARMAsmBackend.cpp

   1 //===-- ARMAsmBackend.cpp - ARM 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 "ARM.h"
  11 #include "ARMAddressingModes.h"
  12 #include "ARMFixupKinds.h"
  13 #include "llvm/ADT/Twine.h"
  14 #include "llvm/MC/MCAssembler.h"
  15 #include "llvm/MC/MCDirectives.h"
  16 #include "llvm/MC/MCExpr.h"
  17 #include "llvm/MC/MCObjectFormat.h"
  18 #include "llvm/MC/MCObjectWriter.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/TargetAsmBackend.h"
  26 #include "llvm/Target/TargetRegistry.h"
  27 using namespace llvm;
  28
  29 namespace {
  30 class ARMAsmBackend : public TargetAsmBackend {
  31   bool isThumbMode;  // Currently emitting Thumb code.
  32 public:
  33   ARMAsmBackend(const Target &T) : TargetAsmBackend(), isThumbMode(false) {}
  34
  35   bool MayNeedRelaxation(const MCInst &Inst) const;
  36
  37   void RelaxInstruction(const MCInst &Inst, MCInst &Res) const;
  38
  39   bool WriteNopData(uint64_t Count, MCObjectWriter *OW) const;
  40
  41   void HandleAssemblerFlag(MCAssemblerFlag Flag) {
  42     switch (Flag) {
  43     default: break;
  44     case MCAF_Code16:
  45       setIsThumb(true);
  46       break;
  47     case MCAF_Code32:
  48       setIsThumb(false);
  49       break;
  50     }
  51   }
  52
  53   unsigned getPointerSize() const { return 4; }
  54   bool isThumb() const { return isThumbMode; }
  55   void setIsThumb(bool it) { isThumbMode = it; }
  56 };
  57 } // end anonymous namespace
  58
  59 bool ARMAsmBackend::MayNeedRelaxation(const MCInst &Inst) const {
  60   // FIXME: Thumb targets, different move constant targets..
  61   return false;
  62 }
  63
  64 void ARMAsmBackend::RelaxInstruction(const MCInst &Inst, MCInst &Res) const {
  65   assert(0 && "ARMAsmBackend::RelaxInstruction() unimplemented");
  66   return;
  67 }
  68
  69 bool ARMAsmBackend::WriteNopData(uint64_t Count, MCObjectWriter *OW) const {
  70   if (isThumb()) {
  71     assert (((Count & 1) == 0) && "Unaligned Nop data fragment!");
  72     // FIXME: 0xbf00 is the ARMv7 value. For v6 and before, we'll need to
  73     // use 0x46c0 (which is a 'mov r8, r8' insn).
  74     Count /= 2;
  75     for (uint64_t i = 0; i != Count; ++i)
  76       OW->Write16(0xbf00);
  77     return true;
  78   }
  79   // ARM mode
  80   Count /= 4;
  81   for (uint64_t i = 0; i != Count; ++i)
  82     OW->Write32(0xe1a00000);
  83   return true;
  84 }
  85
  86 static unsigned adjustFixupValue(unsigned Kind, uint64_t Value) {
  87   switch (Kind) {
  88   default:
  89     llvm_unreachable("Unknown fixup kind!");
  90   case FK_Data_4:
  91     return Value;
  92   case ARM::fixup_arm_movt_hi16:
  93   case ARM::fixup_arm_movw_lo16: {
  94     unsigned Hi4 = (Value & 0xF000) >> 12;
  95     unsigned Lo12 = Value & 0x0FFF;
  96     // inst{19-16} = Hi4;
  97     // inst{11-0} = Lo12;
  98     Value = (Hi4 << 16) | (Lo12);
  99     return Value;
 100   }
 101   case ARM::fixup_arm_ldst_pcrel_12: {
 102     bool isAdd = true;
 103     // ARM PC-relative values are offset by 8.
 104     Value -= 8;
 105     if ((int64_t)Value < 0) {
 106       Value = -Value;
 107       isAdd = false;
 108     }
 109     assert ((Value < 4096) && "Out of range pc-relative fixup value!");
 110     Value |= isAdd << 23;
 111     return Value;
 112   }
 113   case ARM::fixup_arm_adr_pcrel_12: {
 114     // ARM PC-relative values are offset by 8.
 115     Value -= 8;
 116     unsigned opc = 4; // bits {24-21}. Default to add: 0b0100
 117     if ((int64_t)Value < 0) {
 118       Value = -Value;
 119       opc = 2; // 0b0010
 120     }
 121     assert(ARM_AM::getSOImmVal(Value) != -1 &&
 122            "Out of range pc-relative fixup value!");
 123     // Encode the immediate and shift the opcode into place.
 124     return ARM_AM::getSOImmVal(Value) | (opc << 21);
 125   }
 126   case ARM::fixup_arm_branch:
 127     // These values don't encode the low two bits since they're always zero.
 128     // Offset by 8 just as above.
 129     return 0xffffff & ((Value - 8) >> 2);
 130   case ARM::fixup_t2_branch: {
 131     Value = Value - 6;
 132     Value >>= 1; // Low bit is not encoded.
 133
 134     uint64_t out = 0;
 135     Value |= (Value & 0x80000) << 7; // S bit
 136     Value |= (Value & 0x40000) >> 7; // J2 bit
 137     Value |= (Value & 0x20000) >> 4; // J1 bit
 138     Value |= (Value & 0x1F800) << 5; // imm6 field
 139     Value |= (Value & 0x007FF);      // imm11 field
 140
 141     uint64_t swapped = (out & 0xFFFF0000) >> 16;
 142     swapped |= (out & 0x0000FFFF) << 16;
 143     return swapped;
 144   }
 145   case ARM::fixup_arm_thumb_bl: {
 146     // The value doesn't encode the low bit (always zero) and is offset by
 147     // four. The value is encoded into disjoint bit positions in the destination
 148     // opcode. x = unchanged, I = immediate value bit, S = sign extension bit
 149     //
 150     //   BL:  xxxxxSIIIIIIIIII xxxxxIIIIIIIIIII
 151     //
 152     // Note that the halfwords are stored high first, low second; so we need
 153     // to transpose the fixup value here to map properly.
 154     unsigned isNeg = (int64_t(Value) < 0) ? 1 : 0;
 155     uint32_t Binary = 0x3fffff & ((Value - 4) >> 1);
 156     Binary  = (Binary & 0x7ff) << 16;    // Low imm11 value.
 157     Binary |= (Binary & 0x1ffc00) >> 11; // High imm10 value.
 158     Binary |= isNeg << 10;               // Sign bit.
 159     return Binary;
 160   }
 161   case ARM::fixup_arm_thumb_blx: {
 162     // The value doesn't encode the low two bits (always zero) and is offset by
 163     // four (see fixup_arm_thumb_cp). The value is encoded into disjoint bit
 164     // positions in the destination opcode. x = unchanged, I = immediate value
 165     // bit, S = sign extension bit, 0 = zero.
 166     //
 167     //   BLX: xxxxxSIIIIIIIIII xxxxxIIIIIIIIII0
 168     //
 169     // Note that the halfwords are stored high first, low second; so we need
 170     // to transpose the fixup value here to map properly.
 171     unsigned isNeg = (int64_t(Value) < 0) ? 1 : 0;
 172     uint32_t Binary = 0xfffff & ((Value - 2) >> 2);
 173     Binary  = (Binary & 0x3ff) << 17;    // Low imm10L value.
 174     Binary |= (Binary & 0xffc00) >> 10;  // High imm10H value.
 175     Binary |= isNeg << 10;               // Sign bit.
 176     return Binary;
 177   }
 178   case ARM::fixup_arm_thumb_cp:
 179     // Offset by 4, and don't encode the low two bits. Two bytes of that
 180     // 'off by 4' is implicitly handled by the half-word ordering of the
 181     // Thumb encoding, so we only need to adjust by 2 here.
 182     return ((Value - 2) >> 2) & 0xff;
 183   case ARM::fixup_arm_thumb_br: {
 184     // Offset by 4 and don't encode the lower bit, which is always 0.
 185     uint32_t Binary = (Value - 4) >> 1;
 186     return ((Binary & 0x20) << 9) | ((Binary & 0x1f) << 3);
 187   }
 188   case ARM::fixup_arm_pcrel_10:
 189     Value = Value - 6; // ARM fixups offset by an additional word and don't
 190                        // need to adjust for the half-word ordering.
 191     // Fall through.
 192   case ARM::fixup_t2_pcrel_10: {
 193     // Offset by 4, adjusted by two due to the half-word ordering of thumb.
 194     Value = Value - 2;
 195     bool isAdd = true;
 196     if ((int64_t)Value < 0) {
 197       Value = -Value;
 198       isAdd = false;
 199     }
 200     // These values don't encode the low two bits since they're always zero.
 201     Value >>= 2;
 202     assert ((Value < 256) && "Out of range pc-relative fixup value!");
 203     Value |= isAdd << 23;
 204
 205     // Same addressing mode as fixup_arm_pcrel_10,
 206     // but with 16-bit halfwords swapped.
 207     if (Kind == ARM::fixup_t2_pcrel_10) {
 208       uint64_t swapped = (Value & 0xFFFF0000) >> 16;
 209       swapped |= (Value & 0x0000FFFF) << 16;
 210       return swapped;
 211     }
 212
 213     return Value;
 214   }
 215   }
 216 }
 217
 218 namespace {
 219
 220 // FIXME: This should be in a separate file.
 221 // ELF is an ELF of course...
 222 class ELFARMAsmBackend : public ARMAsmBackend {
 223   MCELFObjectFormat Format;
 224
 225 public:
 226   Triple::OSType OSType;
 227   ELFARMAsmBackend(const Target &T, Triple::OSType _OSType)
 228     : ARMAsmBackend(T), OSType(_OSType) {
 229     HasScatteredSymbols = true;
 230   }
 231
 232   virtual const MCObjectFormat &getObjectFormat() const {
 233     return Format;
 234   }
 235
 236   void ApplyFixup(const MCFixup &Fixup, char *Data, unsigned DataSize,
 237                   uint64_t Value) const;
 238
 239   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
 240     return createELFObjectWriter(OS, /*Is64Bit=*/false,
 241                                  OSType, ELF::EM_ARM,
 242                                  /*IsLittleEndian=*/true,
 243                                  /*HasRelocationAddend=*/false);
 244   }
 245 };
 246
 247 // FIXME: Raise this to share code between Darwin and ELF.
 248 void ELFARMAsmBackend::ApplyFixup(const MCFixup &Fixup, char *Data,
 249                                   unsigned DataSize, uint64_t Value) const {
 250   unsigned NumBytes = 4;        // FIXME: 2 for Thumb
 251   Value = adjustFixupValue(Fixup.getKind(), Value);
 252   if (!Value) return;           // Doesn't change encoding.
 253
 254   unsigned Offset = Fixup.getOffset();
 255   assert(Offset % NumBytes == 0 && "Offset mod NumBytes is nonzero!");
 256
 257   // For each byte of the fragment that the fixup touches, mask in the bits from
 258   // the fixup value. The Value has been "split up" into the appropriate
 259   // bitfields above.
 260   for (unsigned i = 0; i != NumBytes; ++i)
 261     Data[Offset + i] |= uint8_t((Value >> (i * 8)) & 0xff);
 262 }
 263
 264 // FIXME: This should be in a separate file.
 265 class DarwinARMAsmBackend : public ARMAsmBackend {
 266   MCMachOObjectFormat Format;
 267 public:
 268   DarwinARMAsmBackend(const Target &T) : ARMAsmBackend(T) {
 269     HasScatteredSymbols = true;
 270   }
 271
 272   virtual const MCObjectFormat &getObjectFormat() const {
 273     return Format;
 274   }
 275
 276   void ApplyFixup(const MCFixup &Fixup, char *Data, unsigned DataSize,
 277                   uint64_t Value) const;
 278
 279   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
 280     // FIXME: Subtarget info should be derived. Force v7 for now.
 281     return createMachObjectWriter(OS, /*Is64Bit=*/false,
 282                                   object::mach::CTM_ARM,
 283                                   object::mach::CSARM_V7,
 284                                   /*IsLittleEndian=*/true);
 285   }
 286
 287   virtual bool doesSectionRequireSymbols(const MCSection &Section) const {
 288     return false;
 289   }
 290 };
 291
 292 /// getFixupKindNumBytes - The number of bytes the fixup may change.
 293 static unsigned getFixupKindNumBytes(unsigned Kind) {
 294   switch (Kind) {
 295   default:
 296     llvm_unreachable("Unknown fixup kind!");
 297
 298   case ARM::fixup_arm_thumb_cp:
 299     return 1;
 300
 301   case ARM::fixup_arm_thumb_br:
 302     return 2;
 303
 304   case ARM::fixup_arm_ldst_pcrel_12:
 305   case ARM::fixup_arm_pcrel_10:
 306   case ARM::fixup_arm_adr_pcrel_12:
 307   case ARM::fixup_arm_branch:
 308     return 3;
 309
 310   case FK_Data_4:
 311   case ARM::fixup_t2_branch:
 312   case ARM::fixup_t2_pcrel_10:
 313   case ARM::fixup_arm_thumb_bl:
 314   case ARM::fixup_arm_thumb_blx:
 315     return 4;
 316   }
 317 }
 318
 319 void DarwinARMAsmBackend::ApplyFixup(const MCFixup &Fixup, char *Data,
 320                                      unsigned DataSize, uint64_t Value) const {
 321   unsigned NumBytes = getFixupKindNumBytes(Fixup.getKind());
 322   Value = adjustFixupValue(Fixup.getKind(), Value);
 323   if (!Value) return;           // Doesn't change encoding.
 324
 325   unsigned Offset = Fixup.getOffset();
 326   assert(Offset + NumBytes <= DataSize && "Invalid fixup offset!");
 327
 328   // For each byte of the fragment that the fixup touches, mask in the
 329   // bits from the fixup value.
 330   for (unsigned i = 0; i != NumBytes; ++i)
 331     Data[Offset + i] |= uint8_t((Value >> (i * 8)) & 0xff);
 332 }
 333
 334 } // end anonymous namespace
 335
 336 TargetAsmBackend *llvm::createARMAsmBackend(const Target &T,
 337                                             const std::string &TT) {
 338   switch (Triple(TT).getOS()) {
 339   case Triple::Darwin:
 340     return new DarwinARMAsmBackend(T);
 341   case Triple::MinGW32:
 342   case Triple::Cygwin:
 343   case Triple::Win32:
 344     assert(0 && "Windows not supported on ARM");
 345   default:
 346     return new ELFARMAsmBackend(T, Triple(TT).getOS());
 347   }
 348 }