Make helper static.
[oota-llvm.git] / 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/MCELFObjectWriter.h"
17 #include "llvm/MC/MCExpr.h"
18 #include "llvm/MC/MCMachObjectWriter.h"
19 #include "llvm/MC/MCObjectWriter.h"
20 #include "llvm/MC/MCSectionELF.h"
21 #include "llvm/MC/MCSectionMachO.h"
22 #include "llvm/Object/MachOFormat.h"
23 #include "llvm/Support/ELF.h"
24 #include "llvm/Support/ErrorHandling.h"
25 #include "llvm/Support/raw_ostream.h"
26 #include "llvm/Target/TargetAsmBackend.h"
27 #include "llvm/Target/TargetRegistry.h"
28 using namespace llvm;
29
30 namespace {
31 class ARMMachObjectWriter : public MCMachObjectTargetWriter {
32 public:
33   ARMMachObjectWriter(bool Is64Bit, uint32_t CPUType,
34                       uint32_t CPUSubtype)
35     : MCMachObjectTargetWriter(Is64Bit, CPUType, CPUSubtype,
36                                /*UseAggressiveSymbolFolding=*/true) {}
37 };
38
39 class ARMELFObjectWriter : public MCELFObjectTargetWriter {
40 public:
41   ARMELFObjectWriter(Triple::OSType OSType)
42     : MCELFObjectTargetWriter(/*Is64Bit*/ false, OSType, ELF::EM_ARM,
43                               /*HasRelocationAddend*/ false) {}
44 };
45
46 class ARMAsmBackend : public TargetAsmBackend {
47   bool isThumbMode;  // Currently emitting Thumb code.
48 public:
49   ARMAsmBackend(const Target &T) : TargetAsmBackend(), isThumbMode(false) {}
50
51   unsigned getNumFixupKinds() const { return ARM::NumTargetFixupKinds; }
52
53   const MCFixupKindInfo &getFixupKindInfo(MCFixupKind Kind) const {
54     const static MCFixupKindInfo Infos[ARM::NumTargetFixupKinds] = {
55 // This table *must* be in the order that the fixup_* kinds are defined in
56 // ARMFixupKinds.h.
57 //
58 // Name                      Offset (bits) Size (bits)     Flags
59 { "fixup_arm_ldst_pcrel_12", 1,            24,  MCFixupKindInfo::FKF_IsPCRel },
60 { "fixup_t2_ldst_pcrel_12",  0,            32,  MCFixupKindInfo::FKF_IsPCRel |
61                                    MCFixupKindInfo::FKF_IsAlignedDownTo32Bits},
62 { "fixup_arm_pcrel_10",      1,            24,  MCFixupKindInfo::FKF_IsPCRel },
63 { "fixup_t2_pcrel_10",       0,            32,  MCFixupKindInfo::FKF_IsPCRel |
64                                    MCFixupKindInfo::FKF_IsAlignedDownTo32Bits},
65 { "fixup_thumb_adr_pcrel_10",0,            8,   MCFixupKindInfo::FKF_IsPCRel |
66                                    MCFixupKindInfo::FKF_IsAlignedDownTo32Bits},
67 { "fixup_arm_adr_pcrel_12",  1,            24,  MCFixupKindInfo::FKF_IsPCRel },
68 { "fixup_t2_adr_pcrel_12",   0,            32,  MCFixupKindInfo::FKF_IsPCRel |
69                                    MCFixupKindInfo::FKF_IsAlignedDownTo32Bits},
70 { "fixup_arm_condbranch",    0,            24,  MCFixupKindInfo::FKF_IsPCRel },
71 { "fixup_arm_uncondbranch",  0,            24,  MCFixupKindInfo::FKF_IsPCRel },
72 { "fixup_t2_condbranch",     0,            32,  MCFixupKindInfo::FKF_IsPCRel },
73 { "fixup_t2_uncondbranch",   0,            32,  MCFixupKindInfo::FKF_IsPCRel },
74 { "fixup_arm_thumb_br",      0,            16,  MCFixupKindInfo::FKF_IsPCRel },
75 { "fixup_arm_thumb_bl",      0,            32,  MCFixupKindInfo::FKF_IsPCRel },
76 { "fixup_arm_thumb_blx",     7,            21,  MCFixupKindInfo::FKF_IsPCRel },
77 { "fixup_arm_thumb_cb",      0,            16,  MCFixupKindInfo::FKF_IsPCRel },
78 { "fixup_arm_thumb_cp",      1,             8,  MCFixupKindInfo::FKF_IsPCRel },
79 { "fixup_arm_thumb_bcc",     1,             8,  MCFixupKindInfo::FKF_IsPCRel },
80 // movw / movt: 16-bits immediate but scattered into two chunks 0 - 12, 16 - 19.
81 { "fixup_arm_movt_hi16",     0,            20,  0 },
82 { "fixup_arm_movw_lo16",     0,            20,  0 },
83 { "fixup_t2_movt_hi16",      0,            20,  0 },
84 { "fixup_t2_movw_lo16",      0,            20,  0 },
85 { "fixup_arm_movt_hi16_pcrel", 0,          20,  MCFixupKindInfo::FKF_IsPCRel },
86 { "fixup_arm_movw_lo16_pcrel", 0,          20,  MCFixupKindInfo::FKF_IsPCRel },
87 { "fixup_t2_movt_hi16_pcrel", 0,           20,  MCFixupKindInfo::FKF_IsPCRel },
88 { "fixup_t2_movw_lo16_pcrel", 0,           20,  MCFixupKindInfo::FKF_IsPCRel },
89     };
90
91     if (Kind < FirstTargetFixupKind)
92       return TargetAsmBackend::getFixupKindInfo(Kind);
93
94     assert(unsigned(Kind - FirstTargetFixupKind) < getNumFixupKinds() &&
95            "Invalid kind!");
96     return Infos[Kind - FirstTargetFixupKind];
97   }
98
99   bool MayNeedRelaxation(const MCInst &Inst) const;
100
101   void RelaxInstruction(const MCInst &Inst, MCInst &Res) const;
102
103   bool WriteNopData(uint64_t Count, MCObjectWriter *OW) const;
104
105   void HandleAssemblerFlag(MCAssemblerFlag Flag) {
106     switch (Flag) {
107     default: break;
108     case MCAF_Code16:
109       setIsThumb(true);
110       break;
111     case MCAF_Code32:
112       setIsThumb(false);
113       break;
114     }
115   }
116
117   unsigned getPointerSize() const { return 4; }
118   bool isThumb() const { return isThumbMode; }
119   void setIsThumb(bool it) { isThumbMode = it; }
120 };
121 } // end anonymous namespace
122
123 bool ARMAsmBackend::MayNeedRelaxation(const MCInst &Inst) const {
124   // FIXME: Thumb targets, different move constant targets..
125   return false;
126 }
127
128 void ARMAsmBackend::RelaxInstruction(const MCInst &Inst, MCInst &Res) const {
129   assert(0 && "ARMAsmBackend::RelaxInstruction() unimplemented");
130   return;
131 }
132
133 bool ARMAsmBackend::WriteNopData(uint64_t Count, MCObjectWriter *OW) const {
134   if (isThumb()) {
135     // FIXME: 0xbf00 is the ARMv7 value. For v6 and before, we'll need to
136     // use 0x46c0 (which is a 'mov r8, r8' insn).
137     uint64_t NumNops = Count / 2;
138     for (uint64_t i = 0; i != NumNops; ++i)
139       OW->Write16(0xbf00);
140     if (Count & 1)
141       OW->Write8(0);
142     return true;
143   }
144   // ARM mode
145   uint64_t NumNops = Count / 4;
146   for (uint64_t i = 0; i != NumNops; ++i)
147     OW->Write32(0xe1a00000);
148   switch (Count % 4) {
149   default: break; // No leftover bytes to write
150   case 1: OW->Write8(0); break;
151   case 2: OW->Write16(0); break;
152   case 3: OW->Write16(0); OW->Write8(0xa0); break;
153   }
154
155   return true;
156 }
157
158 static unsigned adjustFixupValue(unsigned Kind, uint64_t Value) {
159   switch (Kind) {
160   default:
161     llvm_unreachable("Unknown fixup kind!");
162   case FK_Data_1:
163   case FK_Data_2:
164   case FK_Data_4:
165     return Value;
166   case ARM::fixup_arm_movt_hi16:
167   case ARM::fixup_arm_movt_hi16_pcrel:
168     Value >>= 16;
169     // Fallthrough
170   case ARM::fixup_arm_movw_lo16:
171   case ARM::fixup_arm_movw_lo16_pcrel: {
172     unsigned Hi4 = (Value & 0xF000) >> 12;
173     unsigned Lo12 = Value & 0x0FFF;
174     // inst{19-16} = Hi4;
175     // inst{11-0} = Lo12;
176     Value = (Hi4 << 16) | (Lo12);
177     return Value;
178   }
179   case ARM::fixup_t2_movt_hi16:
180   case ARM::fixup_t2_movt_hi16_pcrel:
181     Value >>= 16;
182     // Fallthrough
183   case ARM::fixup_t2_movw_lo16:
184   case ARM::fixup_t2_movw_lo16_pcrel: {
185     unsigned Hi4 = (Value & 0xF000) >> 12;
186     unsigned i = (Value & 0x800) >> 11;
187     unsigned Mid3 = (Value & 0x700) >> 8;
188     unsigned Lo8 = Value & 0x0FF;
189     // inst{19-16} = Hi4;
190     // inst{26} = i;
191     // inst{14-12} = Mid3;
192     // inst{7-0} = Lo8;
193     Value = (Hi4 << 16) | (i << 26) | (Mid3 << 12) | (Lo8);
194
195     uint64_t swapped = (Value & 0xFFFF0000) >> 16;
196     swapped |= (Value & 0x0000FFFF) << 16;
197     return swapped;
198   }
199   case ARM::fixup_arm_ldst_pcrel_12:
200     // ARM PC-relative values are offset by 8.
201     Value -= 4;
202     // FALLTHROUGH
203   case ARM::fixup_t2_ldst_pcrel_12: {
204     // Offset by 4, adjusted by two due to the half-word ordering of thumb.
205     Value -= 4;
206     bool isAdd = true;
207     if ((int64_t)Value < 0) {
208       Value = -Value;
209       isAdd = false;
210     }
211     assert ((Value < 4096) && "Out of range pc-relative fixup value!");
212     Value |= isAdd << 23;
213
214     // Same addressing mode as fixup_arm_pcrel_10,
215     // but with 16-bit halfwords swapped.
216     if (Kind == ARM::fixup_t2_ldst_pcrel_12) {
217       uint64_t swapped = (Value & 0xFFFF0000) >> 16;
218       swapped |= (Value & 0x0000FFFF) << 16;
219       return swapped;
220     }
221
222     return Value;
223   }
224   case ARM::fixup_thumb_adr_pcrel_10:
225     return ((Value - 4) >> 2) & 0xff;
226   case ARM::fixup_arm_adr_pcrel_12: {
227     // ARM PC-relative values are offset by 8.
228     Value -= 8;
229     unsigned opc = 4; // bits {24-21}. Default to add: 0b0100
230     if ((int64_t)Value < 0) {
231       Value = -Value;
232       opc = 2; // 0b0010
233     }
234     assert(ARM_AM::getSOImmVal(Value) != -1 &&
235            "Out of range pc-relative fixup value!");
236     // Encode the immediate and shift the opcode into place.
237     return ARM_AM::getSOImmVal(Value) | (opc << 21);
238   }
239
240   case ARM::fixup_t2_adr_pcrel_12: {
241     Value -= 4;
242     unsigned opc = 0;
243     if ((int64_t)Value < 0) {
244       Value = -Value;
245       opc = 5;
246     }
247
248     uint32_t out = (opc << 21);
249     out |= (Value & 0x800) << 15;
250     out |= (Value & 0x700) << 4;
251     out |= (Value & 0x0FF);
252
253     uint64_t swapped = (out & 0xFFFF0000) >> 16;
254     swapped |= (out & 0x0000FFFF) << 16;
255     return swapped;
256   }
257
258   case ARM::fixup_arm_condbranch:
259   case ARM::fixup_arm_uncondbranch:
260     // These values don't encode the low two bits since they're always zero.
261     // Offset by 8 just as above.
262     return 0xffffff & ((Value - 8) >> 2);
263   case ARM::fixup_t2_uncondbranch: {
264     Value = Value - 4;
265     Value >>= 1; // Low bit is not encoded.
266
267     uint32_t out = 0;
268     bool I =  Value & 0x800000;
269     bool J1 = Value & 0x400000;
270     bool J2 = Value & 0x200000;
271     J1 ^= I;
272     J2 ^= I;
273
274     out |= I  << 26; // S bit
275     out |= !J1 << 13; // J1 bit
276     out |= !J2 << 11; // J2 bit
277     out |= (Value & 0x1FF800)  << 5; // imm6 field
278     out |= (Value & 0x0007FF);        // imm11 field
279
280     uint64_t swapped = (out & 0xFFFF0000) >> 16;
281     swapped |= (out & 0x0000FFFF) << 16;
282     return swapped;
283   }
284   case ARM::fixup_t2_condbranch: {
285     Value = Value - 4;
286     Value >>= 1; // Low bit is not encoded.
287
288     uint64_t out = 0;
289     out |= (Value & 0x80000) << 7; // S bit
290     out |= (Value & 0x40000) >> 7; // J2 bit
291     out |= (Value & 0x20000) >> 4; // J1 bit
292     out |= (Value & 0x1F800) << 5; // imm6 field
293     out |= (Value & 0x007FF);      // imm11 field
294
295     uint32_t swapped = (out & 0xFFFF0000) >> 16;
296     swapped |= (out & 0x0000FFFF) << 16;
297     return swapped;
298   }
299   case ARM::fixup_arm_thumb_bl: {
300     // The value doesn't encode the low bit (always zero) and is offset by
301     // four. The value is encoded into disjoint bit positions in the destination
302     // opcode. x = unchanged, I = immediate value bit, S = sign extension bit
303     //
304     //   BL:  xxxxxSIIIIIIIIII xxxxxIIIIIIIIIII
305     //
306     // Note that the halfwords are stored high first, low second; so we need
307     // to transpose the fixup value here to map properly.
308     unsigned isNeg = (int64_t(Value) < 0) ? 1 : 0;
309     uint32_t Binary = 0;
310     Value = 0x3fffff & ((Value - 4) >> 1);
311     Binary  = (Value & 0x7ff) << 16;    // Low imm11 value.
312     Binary |= (Value & 0x1ffc00) >> 11; // High imm10 value.
313     Binary |= isNeg << 10;              // Sign bit.
314     return Binary;
315   }
316   case ARM::fixup_arm_thumb_blx: {
317     // The value doesn't encode the low two bits (always zero) and is offset by
318     // four (see fixup_arm_thumb_cp). The value is encoded into disjoint bit
319     // positions in the destination opcode. x = unchanged, I = immediate value
320     // bit, S = sign extension bit, 0 = zero.
321     //
322     //   BLX: xxxxxSIIIIIIIIII xxxxxIIIIIIIIII0
323     //
324     // Note that the halfwords are stored high first, low second; so we need
325     // to transpose the fixup value here to map properly.
326     unsigned isNeg = (int64_t(Value) < 0) ? 1 : 0;
327     uint32_t Binary = 0;
328     Value = 0xfffff & ((Value - 2) >> 2);
329     Binary  = (Value & 0x3ff) << 17;    // Low imm10L value.
330     Binary |= (Value & 0xffc00) >> 10;  // High imm10H value.
331     Binary |= isNeg << 10;              // Sign bit.
332     return Binary;
333   }
334   case ARM::fixup_arm_thumb_cp:
335     // Offset by 4, and don't encode the low two bits. Two bytes of that
336     // 'off by 4' is implicitly handled by the half-word ordering of the
337     // Thumb encoding, so we only need to adjust by 2 here.
338     return ((Value - 2) >> 2) & 0xff;
339   case ARM::fixup_arm_thumb_cb: {
340     // Offset by 4 and don't encode the lower bit, which is always 0.
341     uint32_t Binary = (Value - 4) >> 1;
342     return ((Binary & 0x20) << 4) | ((Binary & 0x1f) << 3);
343   }
344   case ARM::fixup_arm_thumb_br:
345     // Offset by 4 and don't encode the lower bit, which is always 0.
346     return ((Value - 4) >> 1) & 0x7ff;
347   case ARM::fixup_arm_thumb_bcc:
348     // Offset by 4 and don't encode the lower bit, which is always 0.
349     return ((Value - 4) >> 1) & 0xff;
350   case ARM::fixup_arm_pcrel_10:
351     Value = Value - 4; // ARM fixups offset by an additional word and don't
352                        // need to adjust for the half-word ordering.
353     // Fall through.
354   case ARM::fixup_t2_pcrel_10: {
355     // Offset by 4, adjusted by two due to the half-word ordering of thumb.
356     Value = Value - 4;
357     bool isAdd = true;
358     if ((int64_t)Value < 0) {
359       Value = -Value;
360       isAdd = false;
361     }
362     // These values don't encode the low two bits since they're always zero.
363     Value >>= 2;
364     assert ((Value < 256) && "Out of range pc-relative fixup value!");
365     Value |= isAdd << 23;
366
367     // Same addressing mode as fixup_arm_pcrel_10,
368     // but with 16-bit halfwords swapped.
369     if (Kind == ARM::fixup_t2_pcrel_10) {
370       uint32_t swapped = (Value & 0xFFFF0000) >> 16;
371       swapped |= (Value & 0x0000FFFF) << 16;
372       return swapped;
373     }
374
375     return Value;
376   }
377   }
378 }
379
380 namespace {
381
382 // FIXME: This should be in a separate file.
383 // ELF is an ELF of course...
384 class ELFARMAsmBackend : public ARMAsmBackend {
385 public:
386   Triple::OSType OSType;
387   ELFARMAsmBackend(const Target &T, Triple::OSType _OSType)
388     : ARMAsmBackend(T), OSType(_OSType) { }
389
390   void ApplyFixup(const MCFixup &Fixup, char *Data, unsigned DataSize,
391                   uint64_t Value) const;
392
393   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
394     return createELFObjectWriter(new ARMELFObjectWriter(OSType), OS,
395                               /*IsLittleEndian*/ true);
396   }
397 };
398
399 // FIXME: Raise this to share code between Darwin and ELF.
400 void ELFARMAsmBackend::ApplyFixup(const MCFixup &Fixup, char *Data,
401                                   unsigned DataSize, uint64_t Value) const {
402   unsigned NumBytes = 4;        // FIXME: 2 for Thumb
403   Value = adjustFixupValue(Fixup.getKind(), Value);
404   if (!Value) return;           // Doesn't change encoding.
405
406   unsigned Offset = Fixup.getOffset();
407   assert(Offset % NumBytes == 0 && "Offset mod NumBytes is nonzero!");
408
409   // For each byte of the fragment that the fixup touches, mask in the bits from
410   // the fixup value. The Value has been "split up" into the appropriate
411   // bitfields above.
412   for (unsigned i = 0; i != NumBytes; ++i)
413     Data[Offset + i] |= uint8_t((Value >> (i * 8)) & 0xff);
414 }
415
416 // FIXME: This should be in a separate file.
417 class DarwinARMAsmBackend : public ARMAsmBackend {
418 public:
419   DarwinARMAsmBackend(const Target &T) : ARMAsmBackend(T) { }
420
421   void ApplyFixup(const MCFixup &Fixup, char *Data, unsigned DataSize,
422                   uint64_t Value) const;
423
424   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
425     // FIXME: Subtarget info should be derived. Force v7 for now.
426     return createMachObjectWriter(new ARMMachObjectWriter(
427                                     /*Is64Bit=*/false,
428                                     object::mach::CTM_ARM,
429                                     object::mach::CSARM_V7),
430                                   OS,
431                                   /*IsLittleEndian=*/true);
432   }
433
434   virtual bool doesSectionRequireSymbols(const MCSection &Section) const {
435     return false;
436   }
437 };
438
439 /// getFixupKindNumBytes - The number of bytes the fixup may change.
440 static unsigned getFixupKindNumBytes(unsigned Kind) {
441   switch (Kind) {
442   default:
443     llvm_unreachable("Unknown fixup kind!");
444
445   case FK_Data_1:
446   case ARM::fixup_arm_thumb_bcc:
447   case ARM::fixup_arm_thumb_cp:
448   case ARM::fixup_thumb_adr_pcrel_10:
449     return 1;
450
451   case FK_Data_2:
452   case ARM::fixup_arm_thumb_br:
453   case ARM::fixup_arm_thumb_cb:
454     return 2;
455
456   case ARM::fixup_arm_ldst_pcrel_12:
457   case ARM::fixup_arm_pcrel_10:
458   case ARM::fixup_arm_adr_pcrel_12:
459   case ARM::fixup_arm_condbranch:
460   case ARM::fixup_arm_uncondbranch:
461     return 3;
462
463   case FK_Data_4:
464   case ARM::fixup_t2_ldst_pcrel_12:
465   case ARM::fixup_t2_condbranch:
466   case ARM::fixup_t2_uncondbranch:
467   case ARM::fixup_t2_pcrel_10:
468   case ARM::fixup_t2_adr_pcrel_12:
469   case ARM::fixup_arm_thumb_bl:
470   case ARM::fixup_arm_thumb_blx:
471   case ARM::fixup_arm_movt_hi16:
472   case ARM::fixup_arm_movw_lo16:
473   case ARM::fixup_arm_movt_hi16_pcrel:
474   case ARM::fixup_arm_movw_lo16_pcrel:
475   case ARM::fixup_t2_movt_hi16:
476   case ARM::fixup_t2_movw_lo16:
477   case ARM::fixup_t2_movt_hi16_pcrel:
478   case ARM::fixup_t2_movw_lo16_pcrel:
479     return 4;
480   }
481 }
482
483 void DarwinARMAsmBackend::ApplyFixup(const MCFixup &Fixup, char *Data,
484                                      unsigned DataSize, uint64_t Value) const {
485   unsigned NumBytes = getFixupKindNumBytes(Fixup.getKind());
486   Value = adjustFixupValue(Fixup.getKind(), Value);
487   if (!Value) return;           // Doesn't change encoding.
488
489   unsigned Offset = Fixup.getOffset();
490   assert(Offset + NumBytes <= DataSize && "Invalid fixup offset!");
491
492   // For each byte of the fragment that the fixup touches, mask in the
493   // bits from the fixup value.
494   for (unsigned i = 0; i != NumBytes; ++i)
495     Data[Offset + i] |= uint8_t((Value >> (i * 8)) & 0xff);
496 }
497
498 } // end anonymous namespace
499
500 TargetAsmBackend *llvm::createARMAsmBackend(const Target &T,
501                                             const std::string &TT) {
502   switch (Triple(TT).getOS()) {
503   case Triple::Darwin:
504     return new DarwinARMAsmBackend(T);
505   case Triple::MinGW32:
506   case Triple::Cygwin:
507   case Triple::Win32:
508     assert(0 && "Windows not supported on ARM");
509   default:
510     return new ELFARMAsmBackend(T, Triple(TT).getOS());
511   }
512 }