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