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     // ARM PC-relative values are offset by 8.
 103     Value -= 4;
 104     // FALLTHROUGH
 105   case ARM::fixup_t2_ldst_pcrel_12: {
 106     // Offset by 4, adjusted by two due to the half-word ordering of thumb.
 107     Value -= 4;
 108     bool isAdd = true;
 109     if ((int64_t)Value < 0) {
 110       Value = -Value;
 111       isAdd = false;
 112     }
 113     assert ((Value < 4096) && "Out of range pc-relative fixup value!");
 114     Value |= isAdd << 23;
 115
 116     // Same addressing mode as fixup_arm_pcrel_10,
 117     // but with 16-bit halfwords swapped.
 118     if (Kind == ARM::fixup_t2_ldst_pcrel_12) {
 119       uint64_t swapped = (Value & 0xFFFF0000) >> 16;
 120       swapped |= (Value & 0x0000FFFF) << 16;
 121       return swapped;
 122     }
 123
 124     return Value;
 125   }
 126   case ARM::fixup_arm_adr_pcrel_12: {
 127     // ARM PC-relative values are offset by 8.
 128     Value -= 8;
 129     unsigned opc = 4; // bits {24-21}. Default to add: 0b0100
 130     if ((int64_t)Value < 0) {
 131       Value = -Value;
 132       opc = 2; // 0b0010
 133     }
 134     assert(ARM_AM::getSOImmVal(Value) != -1 &&
 135            "Out of range pc-relative fixup value!");
 136     // Encode the immediate and shift the opcode into place.
 137     return ARM_AM::getSOImmVal(Value) | (opc << 21);
 138   }
 139
 140   case ARM::fixup_t2_adr_pcrel_12: {
 141     Value -= 4;
 142     unsigned opc = 0;
 143     if ((int64_t)Value < 0) {
 144       Value = -Value;
 145       opc = 5;
 146     }
 147
 148     uint32_t out = (opc << 21);
 149     out |= (Value & 0x800) << 14;
 150     out |= (Value & 0x700) << 4;
 151     out |= (Value & 0x0FF);
 152
 153     uint64_t swapped = (out & 0xFFFF0000) >> 16;
 154     swapped |= (out & 0x0000FFFF) << 16;
 155     return swapped;
 156   }
 157
 158   case ARM::fixup_arm_branch:
 159     // These values don't encode the low two bits since they're always zero.
 160     // Offset by 8 just as above.
 161     return 0xffffff & ((Value - 8) >> 2);
 162   case ARM::fixup_t2_uncondbranch: {
 163     Value = Value - 4;
 164     Value >>= 1; // Low bit is not encoded.
 165
 166     uint32_t out = 0;
 167     bool I =  Value & 0x800000;
 168     bool J1 = Value & 0x400000;
 169     bool J2 = Value & 0x200000;
 170     J1 ^= I;
 171     J2 ^= I;
 172
 173     out |= I  << 26; // S bit
 174     out |= !J1 << 13; // J1 bit
 175     out |= !J2 << 11; // J2 bit
 176     out |= (Value & 0x1FF800)  << 5; // imm6 field
 177     out |= (Value & 0x0007FF);        // imm11 field
 178
 179     uint64_t swapped = (out & 0xFFFF0000) >> 16;
 180     swapped |= (out & 0x0000FFFF) << 16;
 181     return swapped;
 182   }
 183   case ARM::fixup_t2_condbranch: {
 184     Value = Value - 4;
 185     Value >>= 1; // Low bit is not encoded.
 186
 187     uint64_t out = 0;
 188     out |= (Value & 0x80000) << 7; // S bit
 189     out |= (Value & 0x40000) >> 7; // J2 bit
 190     out |= (Value & 0x20000) >> 4; // J1 bit
 191     out |= (Value & 0x1F800) << 5; // imm6 field
 192     out |= (Value & 0x007FF);      // imm11 field
 193
 194     uint32_t swapped = (out & 0xFFFF0000) >> 16;
 195     swapped |= (out & 0x0000FFFF) << 16;
 196     return swapped;
 197   }
 198   case ARM::fixup_arm_thumb_bl: {
 199     // The value doesn't encode the low bit (always zero) and is offset by
 200     // four. The value is encoded into disjoint bit positions in the destination
 201     // opcode. x = unchanged, I = immediate value bit, S = sign extension bit
 202     //
 203     //   BL:  xxxxxSIIIIIIIIII xxxxxIIIIIIIIIII
 204     //
 205     // Note that the halfwords are stored high first, low second; so we need
 206     // to transpose the fixup value here to map properly.
 207     unsigned isNeg = (int64_t(Value) < 0) ? 1 : 0;
 208     uint32_t Binary = 0;
 209     Value = 0x3fffff & ((Value - 4) >> 1);
 210     Binary  = (Value & 0x7ff) << 16;    // Low imm11 value.
 211     Binary |= (Value & 0x1ffc00) >> 11; // High imm10 value.
 212     Binary |= isNeg << 10;              // Sign bit.
 213     return Binary;
 214   }
 215   case ARM::fixup_arm_thumb_blx: {
 216     // The value doesn't encode the low two bits (always zero) and is offset by
 217     // four (see fixup_arm_thumb_cp). The value is encoded into disjoint bit
 218     // positions in the destination opcode. x = unchanged, I = immediate value
 219     // bit, S = sign extension bit, 0 = zero.
 220     //
 221     //   BLX: xxxxxSIIIIIIIIII xxxxxIIIIIIIIII0
 222     //
 223     // Note that the halfwords are stored high first, low second; so we need
 224     // to transpose the fixup value here to map properly.
 225     unsigned isNeg = (int64_t(Value) < 0) ? 1 : 0;
 226     uint32_t Binary = 0;
 227     Value = 0xfffff & ((Value - 2) >> 2);
 228     Binary  = (Value & 0x3ff) << 17;    // Low imm10L value.
 229     Binary |= (Value & 0xffc00) >> 10;  // High imm10H value.
 230     Binary |= isNeg << 10;              // Sign bit.
 231     return Binary;
 232   }
 233   case ARM::fixup_arm_thumb_cp:
 234     // Offset by 4, and don't encode the low two bits. Two bytes of that
 235     // 'off by 4' is implicitly handled by the half-word ordering of the
 236     // Thumb encoding, so we only need to adjust by 2 here.
 237     return ((Value - 2) >> 2) & 0xff;
 238   case ARM::fixup_arm_thumb_cb: {
 239     // Offset by 4 and don't encode the lower bit, which is always 0.
 240     uint32_t Binary = (Value - 4) >> 1;
 241     return ((Binary & 0x20) << 4) | ((Binary & 0x1f) << 3);
 242   }
 243   case ARM::fixup_arm_thumb_br:
 244     // Offset by 4 and don't encode the lower bit, which is always 0.
 245     return ((Value - 4) >> 1) & 0x7ff;
 246   case ARM::fixup_arm_thumb_bcc:
 247     // Offset by 4 and don't encode the lower bit, which is always 0.
 248     return ((Value - 4) >> 1) & 0xff;
 249   case ARM::fixup_arm_pcrel_10:
 250     Value = Value - 4; // ARM fixups offset by an additional word and don't
 251                        // need to adjust for the half-word ordering.
 252     // Fall through.
 253   case ARM::fixup_t2_pcrel_10: {
 254     // Offset by 4, adjusted by two due to the half-word ordering of thumb.
 255     Value = Value - 4;
 256     bool isAdd = true;
 257     if ((int64_t)Value < 0) {
 258       Value = -Value;
 259       isAdd = false;
 260     }
 261     // These values don't encode the low two bits since they're always zero.
 262     Value >>= 2;
 263     assert ((Value < 256) && "Out of range pc-relative fixup value!");
 264     Value |= isAdd << 23;
 265
 266     // Same addressing mode as fixup_arm_pcrel_10,
 267     // but with 16-bit halfwords swapped.
 268     if (Kind == ARM::fixup_t2_pcrel_10) {
 269       uint32_t swapped = (Value & 0xFFFF0000) >> 16;
 270       swapped |= (Value & 0x0000FFFF) << 16;
 271       return swapped;
 272     }
 273
 274     return Value;
 275   }
 276   }
 277 }
 278
 279 namespace {
 280
 281 // FIXME: This should be in a separate file.
 282 // ELF is an ELF of course...
 283 class ELFARMAsmBackend : public ARMAsmBackend {
 284   MCELFObjectFormat Format;
 285
 286 public:
 287   Triple::OSType OSType;
 288   ELFARMAsmBackend(const Target &T, Triple::OSType _OSType)
 289     : ARMAsmBackend(T), OSType(_OSType) {
 290     HasScatteredSymbols = true;
 291   }
 292
 293   virtual const MCObjectFormat &getObjectFormat() const {
 294     return Format;
 295   }
 296
 297   void ApplyFixup(const MCFixup &Fixup, char *Data, unsigned DataSize,
 298                   uint64_t Value) const;
 299
 300   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
 301     return createELFObjectWriter(OS, /*Is64Bit=*/false,
 302                                  OSType, ELF::EM_ARM,
 303                                  /*IsLittleEndian=*/true,
 304                                  /*HasRelocationAddend=*/false);
 305   }
 306 };
 307
 308 // FIXME: Raise this to share code between Darwin and ELF.
 309 void ELFARMAsmBackend::ApplyFixup(const MCFixup &Fixup, char *Data,
 310                                   unsigned DataSize, uint64_t Value) const {
 311   unsigned NumBytes = 4;        // FIXME: 2 for Thumb
 312   Value = adjustFixupValue(Fixup.getKind(), Value);
 313   if (!Value) return;           // Doesn't change encoding.
 314
 315   unsigned Offset = Fixup.getOffset();
 316   assert(Offset % NumBytes == 0 && "Offset mod NumBytes is nonzero!");
 317
 318   // For each byte of the fragment that the fixup touches, mask in the bits from
 319   // the fixup value. The Value has been "split up" into the appropriate
 320   // bitfields above.
 321   for (unsigned i = 0; i != NumBytes; ++i)
 322     Data[Offset + i] |= uint8_t((Value >> (i * 8)) & 0xff);
 323 }
 324
 325 // FIXME: This should be in a separate file.
 326 class DarwinARMAsmBackend : public ARMAsmBackend {
 327   MCMachOObjectFormat Format;
 328 public:
 329   DarwinARMAsmBackend(const Target &T) : ARMAsmBackend(T) {
 330     HasScatteredSymbols = true;
 331   }
 332
 333   virtual const MCObjectFormat &getObjectFormat() const {
 334     return Format;
 335   }
 336
 337   void ApplyFixup(const MCFixup &Fixup, char *Data, unsigned DataSize,
 338                   uint64_t Value) const;
 339
 340   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
 341     // FIXME: Subtarget info should be derived. Force v7 for now.
 342     return createMachObjectWriter(OS, /*Is64Bit=*/false,
 343                                   object::mach::CTM_ARM,
 344                                   object::mach::CSARM_V7,
 345                                   /*IsLittleEndian=*/true);
 346   }
 347
 348   virtual bool doesSectionRequireSymbols(const MCSection &Section) const {
 349     return false;
 350   }
 351 };
 352
 353 /// getFixupKindNumBytes - The number of bytes the fixup may change.
 354 static unsigned getFixupKindNumBytes(unsigned Kind) {
 355   switch (Kind) {
 356   default:
 357     llvm_unreachable("Unknown fixup kind!");
 358
 359   case ARM::fixup_arm_thumb_bcc:
 360   case ARM::fixup_arm_thumb_cp:
 361     return 1;
 362
 363   case ARM::fixup_arm_thumb_br:
 364   case ARM::fixup_arm_thumb_cb:
 365     return 2;
 366
 367   case ARM::fixup_arm_ldst_pcrel_12:
 368   case ARM::fixup_arm_pcrel_10:
 369   case ARM::fixup_arm_adr_pcrel_12:
 370   case ARM::fixup_arm_branch:
 371     return 3;
 372
 373   case FK_Data_4:
 374   case ARM::fixup_t2_ldst_pcrel_12:
 375   case ARM::fixup_t2_condbranch:
 376   case ARM::fixup_t2_uncondbranch:
 377   case ARM::fixup_t2_pcrel_10:
 378   case ARM::fixup_t2_adr_pcrel_12:
 379   case ARM::fixup_arm_thumb_bl:
 380   case ARM::fixup_arm_thumb_blx:
 381     return 4;
 382   }
 383 }
 384
 385 void DarwinARMAsmBackend::ApplyFixup(const MCFixup &Fixup, char *Data,
 386                                      unsigned DataSize, uint64_t Value) const {
 387   unsigned NumBytes = getFixupKindNumBytes(Fixup.getKind());
 388   Value = adjustFixupValue(Fixup.getKind(), Value);
 389   if (!Value) return;           // Doesn't change encoding.
 390
 391   unsigned Offset = Fixup.getOffset();
 392   assert(Offset + NumBytes <= DataSize && "Invalid fixup offset!");
 393
 394   // For each byte of the fragment that the fixup touches, mask in the
 395   // bits from the fixup value.
 396   for (unsigned i = 0; i != NumBytes; ++i)
 397     Data[Offset + i] |= uint8_t((Value >> (i * 8)) & 0xff);
 398 }
 399
 400 } // end anonymous namespace
 401
 402 TargetAsmBackend *llvm::createARMAsmBackend(const Target &T,
 403                                             const std::string &TT) {
 404   switch (Triple(TT).getOS()) {
 405   case Triple::Darwin:
 406     return new DarwinARMAsmBackend(T);
 407   case Triple::MinGW32:
 408   case Triple::Cygwin:
 409   case Triple::Win32:
 410     assert(0 && "Windows not supported on ARM");
 411   default:
 412     return new ELFARMAsmBackend(T, Triple(TT).getOS());
 413   }
 414 }