[X86] Avoid over-relaxation of 8-bit immediates in integer arithmetic instructions.
[oota-llvm.git] / lib / Target / X86 / MCTargetDesc / 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 "MCTargetDesc/X86BaseInfo.h"
11 #include "MCTargetDesc/X86FixupKinds.h"
12 #include "llvm/ADT/StringSwitch.h"
13 #include "llvm/MC/MCAsmBackend.h"
14 #include "llvm/MC/MCELFObjectWriter.h"
15 #include "llvm/MC/MCExpr.h"
16 #include "llvm/MC/MCFixupKindInfo.h"
17 #include "llvm/MC/MCInst.h"
18 #include "llvm/MC/MCMachObjectWriter.h"
19 #include "llvm/MC/MCObjectWriter.h"
20 #include "llvm/MC/MCRegisterInfo.h"
21 #include "llvm/MC/MCSectionCOFF.h"
22 #include "llvm/MC/MCSectionELF.h"
23 #include "llvm/MC/MCSectionMachO.h"
24 #include "llvm/Support/CommandLine.h"
25 #include "llvm/Support/ELF.h"
26 #include "llvm/Support/ErrorHandling.h"
27 #include "llvm/Support/MachO.h"
28 #include "llvm/Support/TargetRegistry.h"
29 #include "llvm/Support/raw_ostream.h"
30 using namespace llvm;
31
32 static unsigned getFixupKindLog2Size(unsigned Kind) {
33   switch (Kind) {
34   default:
35     llvm_unreachable("invalid fixup kind!");
36   case FK_PCRel_1:
37   case FK_SecRel_1:
38   case FK_Data_1:
39     return 0;
40   case FK_PCRel_2:
41   case FK_SecRel_2:
42   case FK_Data_2:
43     return 1;
44   case FK_PCRel_4:
45   case X86::reloc_riprel_4byte:
46   case X86::reloc_riprel_4byte_movq_load:
47   case X86::reloc_signed_4byte:
48   case X86::reloc_global_offset_table:
49   case FK_SecRel_4:
50   case FK_Data_4:
51     return 2;
52   case FK_PCRel_8:
53   case FK_SecRel_8:
54   case FK_Data_8:
55   case X86::reloc_global_offset_table8:
56     return 3;
57   }
58 }
59
60 namespace {
61
62 class X86ELFObjectWriter : public MCELFObjectTargetWriter {
63 public:
64   X86ELFObjectWriter(bool is64Bit, uint8_t OSABI, uint16_t EMachine,
65                      bool HasRelocationAddend, bool foobar)
66     : MCELFObjectTargetWriter(is64Bit, OSABI, EMachine, HasRelocationAddend) {}
67 };
68
69 class X86AsmBackend : public MCAsmBackend {
70   const StringRef CPU;
71   bool HasNopl;
72   const uint64_t MaxNopLength;
73 public:
74   X86AsmBackend(const Target &T, StringRef CPU)
75       : MCAsmBackend(), CPU(CPU), MaxNopLength(CPU == "slm" ? 7 : 15) {
76     HasNopl = CPU != "generic" && CPU != "i386" && CPU != "i486" &&
77               CPU != "i586" && CPU != "pentium" && CPU != "pentium-mmx" &&
78               CPU != "i686" && CPU != "k6" && CPU != "k6-2" && CPU != "k6-3" &&
79               CPU != "geode" && CPU != "winchip-c6" && CPU != "winchip2" &&
80               CPU != "c3" && CPU != "c3-2";
81   }
82
83   unsigned getNumFixupKinds() const override {
84     return X86::NumTargetFixupKinds;
85   }
86
87   const MCFixupKindInfo &getFixupKindInfo(MCFixupKind Kind) const override {
88     const static MCFixupKindInfo Infos[X86::NumTargetFixupKinds] = {
89       { "reloc_riprel_4byte", 0, 4 * 8, MCFixupKindInfo::FKF_IsPCRel },
90       { "reloc_riprel_4byte_movq_load", 0, 4 * 8, MCFixupKindInfo::FKF_IsPCRel},
91       { "reloc_signed_4byte", 0, 4 * 8, 0},
92       { "reloc_global_offset_table", 0, 4 * 8, 0}
93     };
94
95     if (Kind < FirstTargetFixupKind)
96       return MCAsmBackend::getFixupKindInfo(Kind);
97
98     assert(unsigned(Kind - FirstTargetFixupKind) < getNumFixupKinds() &&
99            "Invalid kind!");
100     return Infos[Kind - FirstTargetFixupKind];
101   }
102
103   void applyFixup(const MCFixup &Fixup, char *Data, unsigned DataSize,
104                   uint64_t Value, bool IsPCRel) const override {
105     unsigned Size = 1 << getFixupKindLog2Size(Fixup.getKind());
106
107     assert(Fixup.getOffset() + Size <= DataSize &&
108            "Invalid fixup offset!");
109
110     // Check that uppper bits are either all zeros or all ones.
111     // Specifically ignore overflow/underflow as long as the leakage is
112     // limited to the lower bits. This is to remain compatible with
113     // other assemblers.
114     assert(isIntN(Size * 8 + 1, Value) &&
115            "Value does not fit in the Fixup field");
116
117     for (unsigned i = 0; i != Size; ++i)
118       Data[Fixup.getOffset() + i] = uint8_t(Value >> (i * 8));
119   }
120
121   bool mayNeedRelaxation(const MCInst &Inst) const override;
122
123   bool fixupNeedsRelaxation(const MCFixup &Fixup, uint64_t Value,
124                             const MCRelaxableFragment *DF,
125                             const MCAsmLayout &Layout) const override;
126
127   void relaxInstruction(const MCInst &Inst, MCInst &Res) const override;
128
129   bool writeNopData(uint64_t Count, MCObjectWriter *OW) const override;
130 };
131 } // end anonymous namespace
132
133 static unsigned getRelaxedOpcodeBranch(unsigned Op) {
134   switch (Op) {
135   default:
136     return Op;
137
138   case X86::JAE_1: return X86::JAE_4;
139   case X86::JA_1:  return X86::JA_4;
140   case X86::JBE_1: return X86::JBE_4;
141   case X86::JB_1:  return X86::JB_4;
142   case X86::JE_1:  return X86::JE_4;
143   case X86::JGE_1: return X86::JGE_4;
144   case X86::JG_1:  return X86::JG_4;
145   case X86::JLE_1: return X86::JLE_4;
146   case X86::JL_1:  return X86::JL_4;
147   case X86::JMP_1: return X86::JMP_4;
148   case X86::JNE_1: return X86::JNE_4;
149   case X86::JNO_1: return X86::JNO_4;
150   case X86::JNP_1: return X86::JNP_4;
151   case X86::JNS_1: return X86::JNS_4;
152   case X86::JO_1:  return X86::JO_4;
153   case X86::JP_1:  return X86::JP_4;
154   case X86::JS_1:  return X86::JS_4;
155   }
156 }
157
158 static unsigned getRelaxedOpcodeArith(unsigned Op) {
159   switch (Op) {
160   default:
161     return Op;
162
163     // IMUL
164   case X86::IMUL16rri8: return X86::IMUL16rri;
165   case X86::IMUL16rmi8: return X86::IMUL16rmi;
166   case X86::IMUL32rri8: return X86::IMUL32rri;
167   case X86::IMUL32rmi8: return X86::IMUL32rmi;
168   case X86::IMUL64rri8: return X86::IMUL64rri32;
169   case X86::IMUL64rmi8: return X86::IMUL64rmi32;
170
171     // AND
172   case X86::AND16ri8: return X86::AND16ri;
173   case X86::AND16mi8: return X86::AND16mi;
174   case X86::AND32ri8: return X86::AND32ri;
175   case X86::AND32mi8: return X86::AND32mi;
176   case X86::AND64ri8: return X86::AND64ri32;
177   case X86::AND64mi8: return X86::AND64mi32;
178
179     // OR
180   case X86::OR16ri8: return X86::OR16ri;
181   case X86::OR16mi8: return X86::OR16mi;
182   case X86::OR32ri8: return X86::OR32ri;
183   case X86::OR32mi8: return X86::OR32mi;
184   case X86::OR64ri8: return X86::OR64ri32;
185   case X86::OR64mi8: return X86::OR64mi32;
186
187     // XOR
188   case X86::XOR16ri8: return X86::XOR16ri;
189   case X86::XOR16mi8: return X86::XOR16mi;
190   case X86::XOR32ri8: return X86::XOR32ri;
191   case X86::XOR32mi8: return X86::XOR32mi;
192   case X86::XOR64ri8: return X86::XOR64ri32;
193   case X86::XOR64mi8: return X86::XOR64mi32;
194
195     // ADD
196   case X86::ADD16ri8: return X86::ADD16ri;
197   case X86::ADD16mi8: return X86::ADD16mi;
198   case X86::ADD32ri8: return X86::ADD32ri;
199   case X86::ADD32mi8: return X86::ADD32mi;
200   case X86::ADD64ri8: return X86::ADD64ri32;
201   case X86::ADD64mi8: return X86::ADD64mi32;
202
203     // SUB
204   case X86::SUB16ri8: return X86::SUB16ri;
205   case X86::SUB16mi8: return X86::SUB16mi;
206   case X86::SUB32ri8: return X86::SUB32ri;
207   case X86::SUB32mi8: return X86::SUB32mi;
208   case X86::SUB64ri8: return X86::SUB64ri32;
209   case X86::SUB64mi8: return X86::SUB64mi32;
210
211     // CMP
212   case X86::CMP16ri8: return X86::CMP16ri;
213   case X86::CMP16mi8: return X86::CMP16mi;
214   case X86::CMP32ri8: return X86::CMP32ri;
215   case X86::CMP32mi8: return X86::CMP32mi;
216   case X86::CMP64ri8: return X86::CMP64ri32;
217   case X86::CMP64mi8: return X86::CMP64mi32;
218
219     // PUSH
220   case X86::PUSH32i8:  return X86::PUSHi32;
221   case X86::PUSH16i8:  return X86::PUSHi16;
222   case X86::PUSH64i8:  return X86::PUSH64i32;
223   case X86::PUSH64i16: return X86::PUSH64i32;
224   }
225 }
226
227 static unsigned getRelaxedOpcode(unsigned Op) {
228   unsigned R = getRelaxedOpcodeArith(Op);
229   if (R != Op)
230     return R;
231   return getRelaxedOpcodeBranch(Op);
232 }
233
234 bool X86AsmBackend::mayNeedRelaxation(const MCInst &Inst) const {
235   // Branches can always be relaxed.
236   if (getRelaxedOpcodeBranch(Inst.getOpcode()) != Inst.getOpcode())
237     return true;
238
239   // Check if this instruction is ever relaxable.
240   if (getRelaxedOpcodeArith(Inst.getOpcode()) == Inst.getOpcode())
241     return false;
242
243
244   // Check if the relaxable operand has an expression. For the current set of
245   // relaxable instructions, the relaxable operand is always the last operand.
246   unsigned RelaxableOp = Inst.getNumOperands() - 1;
247   if (Inst.getOperand(RelaxableOp).isExpr())
248     return true;
249
250   return false;
251 }
252
253 bool X86AsmBackend::fixupNeedsRelaxation(const MCFixup &Fixup,
254                                          uint64_t Value,
255                                          const MCRelaxableFragment *DF,
256                                          const MCAsmLayout &Layout) const {
257   // Relax if the value is too big for a (signed) i8.
258   return int64_t(Value) != int64_t(int8_t(Value));
259 }
260
261 // FIXME: Can tblgen help at all here to verify there aren't other instructions
262 // we can relax?
263 void X86AsmBackend::relaxInstruction(const MCInst &Inst, MCInst &Res) const {
264   // The only relaxations X86 does is from a 1byte pcrel to a 4byte pcrel.
265   unsigned RelaxedOp = getRelaxedOpcode(Inst.getOpcode());
266
267   if (RelaxedOp == Inst.getOpcode()) {
268     SmallString<256> Tmp;
269     raw_svector_ostream OS(Tmp);
270     Inst.dump_pretty(OS);
271     OS << "\n";
272     report_fatal_error("unexpected instruction to relax: " + OS.str());
273   }
274
275   Res = Inst;
276   Res.setOpcode(RelaxedOp);
277 }
278
279 /// \brief Write a sequence of optimal nops to the output, covering \p Count
280 /// bytes.
281 /// \return - true on success, false on failure
282 bool X86AsmBackend::writeNopData(uint64_t Count, MCObjectWriter *OW) const {
283   static const uint8_t Nops[10][10] = {
284     // nop
285     {0x90},
286     // xchg %ax,%ax
287     {0x66, 0x90},
288     // nopl (%[re]ax)
289     {0x0f, 0x1f, 0x00},
290     // nopl 0(%[re]ax)
291     {0x0f, 0x1f, 0x40, 0x00},
292     // nopl 0(%[re]ax,%[re]ax,1)
293     {0x0f, 0x1f, 0x44, 0x00, 0x00},
294     // nopw 0(%[re]ax,%[re]ax,1)
295     {0x66, 0x0f, 0x1f, 0x44, 0x00, 0x00},
296     // nopl 0L(%[re]ax)
297     {0x0f, 0x1f, 0x80, 0x00, 0x00, 0x00, 0x00},
298     // nopl 0L(%[re]ax,%[re]ax,1)
299     {0x0f, 0x1f, 0x84, 0x00, 0x00, 0x00, 0x00, 0x00},
300     // nopw 0L(%[re]ax,%[re]ax,1)
301     {0x66, 0x0f, 0x1f, 0x84, 0x00, 0x00, 0x00, 0x00, 0x00},
302     // nopw %cs:0L(%[re]ax,%[re]ax,1)
303     {0x66, 0x2e, 0x0f, 0x1f, 0x84, 0x00, 0x00, 0x00, 0x00, 0x00},
304   };
305
306   // This CPU doesn't support long nops. If needed add more.
307   // FIXME: Can we get this from the subtarget somehow?
308   // FIXME: We could generated something better than plain 0x90.
309   if (!HasNopl) {
310     for (uint64_t i = 0; i < Count; ++i)
311       OW->write8(0x90);
312     return true;
313   }
314
315   // 15 is the longest single nop instruction.  Emit as many 15-byte nops as
316   // needed, then emit a nop of the remaining length.
317   do {
318     const uint8_t ThisNopLength = (uint8_t) std::min(Count, MaxNopLength);
319     const uint8_t Prefixes = ThisNopLength <= 10 ? 0 : ThisNopLength - 10;
320     for (uint8_t i = 0; i < Prefixes; i++)
321       OW->write8(0x66);
322     const uint8_t Rest = ThisNopLength - Prefixes;
323     for (uint8_t i = 0; i < Rest; i++)
324       OW->write8(Nops[Rest - 1][i]);
325     Count -= ThisNopLength;
326   } while (Count != 0);
327
328   return true;
329 }
330
331 /* *** */
332
333 namespace {
334
335 class ELFX86AsmBackend : public X86AsmBackend {
336 public:
337   uint8_t OSABI;
338   ELFX86AsmBackend(const Target &T, uint8_t OSABI, StringRef CPU)
339       : X86AsmBackend(T, CPU), OSABI(OSABI) {}
340 };
341
342 class ELFX86_32AsmBackend : public ELFX86AsmBackend {
343 public:
344   ELFX86_32AsmBackend(const Target &T, uint8_t OSABI, StringRef CPU)
345     : ELFX86AsmBackend(T, OSABI, CPU) {}
346
347   MCObjectWriter *createObjectWriter(raw_pwrite_stream &OS) const override {
348     return createX86ELFObjectWriter(OS, /*IsELF64*/ false, OSABI, ELF::EM_386);
349   }
350 };
351
352 class ELFX86_X32AsmBackend : public ELFX86AsmBackend {
353 public:
354   ELFX86_X32AsmBackend(const Target &T, uint8_t OSABI, StringRef CPU)
355       : ELFX86AsmBackend(T, OSABI, CPU) {}
356
357   MCObjectWriter *createObjectWriter(raw_pwrite_stream &OS) const override {
358     return createX86ELFObjectWriter(OS, /*IsELF64*/ false, OSABI,
359                                     ELF::EM_X86_64);
360   }
361 };
362
363 class ELFX86_64AsmBackend : public ELFX86AsmBackend {
364 public:
365   ELFX86_64AsmBackend(const Target &T, uint8_t OSABI, StringRef CPU)
366     : ELFX86AsmBackend(T, OSABI, CPU) {}
367
368   MCObjectWriter *createObjectWriter(raw_pwrite_stream &OS) const override {
369     return createX86ELFObjectWriter(OS, /*IsELF64*/ true, OSABI, ELF::EM_X86_64);
370   }
371 };
372
373 class WindowsX86AsmBackend : public X86AsmBackend {
374   bool Is64Bit;
375
376 public:
377   WindowsX86AsmBackend(const Target &T, bool is64Bit, StringRef CPU)
378     : X86AsmBackend(T, CPU)
379     , Is64Bit(is64Bit) {
380   }
381
382   MCObjectWriter *createObjectWriter(raw_pwrite_stream &OS) const override {
383     return createX86WinCOFFObjectWriter(OS, Is64Bit);
384   }
385 };
386
387 namespace CU {
388
389   /// Compact unwind encoding values.
390   enum CompactUnwindEncodings {
391     /// [RE]BP based frame where [RE]BP is pused on the stack immediately after
392     /// the return address, then [RE]SP is moved to [RE]BP.
393     UNWIND_MODE_BP_FRAME                   = 0x01000000,
394
395     /// A frameless function with a small constant stack size.
396     UNWIND_MODE_STACK_IMMD                 = 0x02000000,
397
398     /// A frameless function with a large constant stack size.
399     UNWIND_MODE_STACK_IND                  = 0x03000000,
400
401     /// No compact unwind encoding is available.
402     UNWIND_MODE_DWARF                      = 0x04000000,
403
404     /// Mask for encoding the frame registers.
405     UNWIND_BP_FRAME_REGISTERS              = 0x00007FFF,
406
407     /// Mask for encoding the frameless registers.
408     UNWIND_FRAMELESS_STACK_REG_PERMUTATION = 0x000003FF
409   };
410
411 } // end CU namespace
412
413 class DarwinX86AsmBackend : public X86AsmBackend {
414   const MCRegisterInfo &MRI;
415
416   /// \brief Number of registers that can be saved in a compact unwind encoding.
417   enum { CU_NUM_SAVED_REGS = 6 };
418
419   mutable unsigned SavedRegs[CU_NUM_SAVED_REGS];
420   bool Is64Bit;
421
422   unsigned OffsetSize;                   ///< Offset of a "push" instruction.
423   unsigned MoveInstrSize;                ///< Size of a "move" instruction.
424   unsigned StackDivide;                  ///< Amount to adjust stack size by.
425 protected:
426   /// \brief Size of a "push" instruction for the given register.
427   unsigned PushInstrSize(unsigned Reg) const {
428     switch (Reg) {
429       case X86::EBX:
430       case X86::ECX:
431       case X86::EDX:
432       case X86::EDI:
433       case X86::ESI:
434       case X86::EBP:
435       case X86::RBX:
436       case X86::RBP:
437         return 1;
438       case X86::R12:
439       case X86::R13:
440       case X86::R14:
441       case X86::R15:
442         return 2;
443     }
444     return 1;
445   }
446
447   /// \brief Implementation of algorithm to generate the compact unwind encoding
448   /// for the CFI instructions.
449   uint32_t
450   generateCompactUnwindEncodingImpl(ArrayRef<MCCFIInstruction> Instrs) const {
451     if (Instrs.empty()) return 0;
452
453     // Reset the saved registers.
454     unsigned SavedRegIdx = 0;
455     memset(SavedRegs, 0, sizeof(SavedRegs));
456
457     bool HasFP = false;
458
459     // Encode that we are using EBP/RBP as the frame pointer.
460     uint32_t CompactUnwindEncoding = 0;
461
462     unsigned SubtractInstrIdx = Is64Bit ? 3 : 2;
463     unsigned InstrOffset = 0;
464     unsigned StackAdjust = 0;
465     unsigned StackSize = 0;
466     unsigned PrevStackSize = 0;
467     unsigned NumDefCFAOffsets = 0;
468
469     for (unsigned i = 0, e = Instrs.size(); i != e; ++i) {
470       const MCCFIInstruction &Inst = Instrs[i];
471
472       switch (Inst.getOperation()) {
473       default:
474         // Any other CFI directives indicate a frame that we aren't prepared
475         // to represent via compact unwind, so just bail out.
476         return 0;
477       case MCCFIInstruction::OpDefCfaRegister: {
478         // Defines a frame pointer. E.g.
479         //
480         //     movq %rsp, %rbp
481         //  L0:
482         //     .cfi_def_cfa_register %rbp
483         //
484         HasFP = true;
485         assert(MRI.getLLVMRegNum(Inst.getRegister(), true) ==
486                (Is64Bit ? X86::RBP : X86::EBP) && "Invalid frame pointer!");
487
488         // Reset the counts.
489         memset(SavedRegs, 0, sizeof(SavedRegs));
490         StackAdjust = 0;
491         SavedRegIdx = 0;
492         InstrOffset += MoveInstrSize;
493         break;
494       }
495       case MCCFIInstruction::OpDefCfaOffset: {
496         // Defines a new offset for the CFA. E.g.
497         //
498         //  With frame:
499         //
500         //     pushq %rbp
501         //  L0:
502         //     .cfi_def_cfa_offset 16
503         //
504         //  Without frame:
505         //
506         //     subq $72, %rsp
507         //  L0:
508         //     .cfi_def_cfa_offset 80
509         //
510         PrevStackSize = StackSize;
511         StackSize = std::abs(Inst.getOffset()) / StackDivide;
512         ++NumDefCFAOffsets;
513         break;
514       }
515       case MCCFIInstruction::OpOffset: {
516         // Defines a "push" of a callee-saved register. E.g.
517         //
518         //     pushq %r15
519         //     pushq %r14
520         //     pushq %rbx
521         //  L0:
522         //     subq $120, %rsp
523         //  L1:
524         //     .cfi_offset %rbx, -40
525         //     .cfi_offset %r14, -32
526         //     .cfi_offset %r15, -24
527         //
528         if (SavedRegIdx == CU_NUM_SAVED_REGS)
529           // If there are too many saved registers, we cannot use a compact
530           // unwind encoding.
531           return CU::UNWIND_MODE_DWARF;
532
533         unsigned Reg = MRI.getLLVMRegNum(Inst.getRegister(), true);
534         SavedRegs[SavedRegIdx++] = Reg;
535         StackAdjust += OffsetSize;
536         InstrOffset += PushInstrSize(Reg);
537         break;
538       }
539       }
540     }
541
542     StackAdjust /= StackDivide;
543
544     if (HasFP) {
545       if ((StackAdjust & 0xFF) != StackAdjust)
546         // Offset was too big for a compact unwind encoding.
547         return CU::UNWIND_MODE_DWARF;
548
549       // Get the encoding of the saved registers when we have a frame pointer.
550       uint32_t RegEnc = encodeCompactUnwindRegistersWithFrame();
551       if (RegEnc == ~0U) return CU::UNWIND_MODE_DWARF;
552
553       CompactUnwindEncoding |= CU::UNWIND_MODE_BP_FRAME;
554       CompactUnwindEncoding |= (StackAdjust & 0xFF) << 16;
555       CompactUnwindEncoding |= RegEnc & CU::UNWIND_BP_FRAME_REGISTERS;
556     } else {
557       // If the amount of the stack allocation is the size of a register, then
558       // we "push" the RAX/EAX register onto the stack instead of adjusting the
559       // stack pointer with a SUB instruction. We don't support the push of the
560       // RAX/EAX register with compact unwind. So we check for that situation
561       // here.
562       if ((NumDefCFAOffsets == SavedRegIdx + 1 &&
563            StackSize - PrevStackSize == 1) ||
564           (Instrs.size() == 1 && NumDefCFAOffsets == 1 && StackSize == 2))
565         return CU::UNWIND_MODE_DWARF;
566
567       SubtractInstrIdx += InstrOffset;
568       ++StackAdjust;
569
570       if ((StackSize & 0xFF) == StackSize) {
571         // Frameless stack with a small stack size.
572         CompactUnwindEncoding |= CU::UNWIND_MODE_STACK_IMMD;
573
574         // Encode the stack size.
575         CompactUnwindEncoding |= (StackSize & 0xFF) << 16;
576       } else {
577         if ((StackAdjust & 0x7) != StackAdjust)
578           // The extra stack adjustments are too big for us to handle.
579           return CU::UNWIND_MODE_DWARF;
580
581         // Frameless stack with an offset too large for us to encode compactly.
582         CompactUnwindEncoding |= CU::UNWIND_MODE_STACK_IND;
583
584         // Encode the offset to the nnnnnn value in the 'subl $nnnnnn, ESP'
585         // instruction.
586         CompactUnwindEncoding |= (SubtractInstrIdx & 0xFF) << 16;
587
588         // Encode any extra stack stack adjustments (done via push
589         // instructions).
590         CompactUnwindEncoding |= (StackAdjust & 0x7) << 13;
591       }
592
593       // Encode the number of registers saved. (Reverse the list first.)
594       std::reverse(&SavedRegs[0], &SavedRegs[SavedRegIdx]);
595       CompactUnwindEncoding |= (SavedRegIdx & 0x7) << 10;
596
597       // Get the encoding of the saved registers when we don't have a frame
598       // pointer.
599       uint32_t RegEnc = encodeCompactUnwindRegistersWithoutFrame(SavedRegIdx);
600       if (RegEnc == ~0U) return CU::UNWIND_MODE_DWARF;
601
602       // Encode the register encoding.
603       CompactUnwindEncoding |=
604         RegEnc & CU::UNWIND_FRAMELESS_STACK_REG_PERMUTATION;
605     }
606
607     return CompactUnwindEncoding;
608   }
609
610 private:
611   /// \brief Get the compact unwind number for a given register. The number
612   /// corresponds to the enum lists in compact_unwind_encoding.h.
613   int getCompactUnwindRegNum(unsigned Reg) const {
614     static const uint16_t CU32BitRegs[7] = {
615       X86::EBX, X86::ECX, X86::EDX, X86::EDI, X86::ESI, X86::EBP, 0
616     };
617     static const uint16_t CU64BitRegs[] = {
618       X86::RBX, X86::R12, X86::R13, X86::R14, X86::R15, X86::RBP, 0
619     };
620     const uint16_t *CURegs = Is64Bit ? CU64BitRegs : CU32BitRegs;
621     for (int Idx = 1; *CURegs; ++CURegs, ++Idx)
622       if (*CURegs == Reg)
623         return Idx;
624
625     return -1;
626   }
627
628   /// \brief Return the registers encoded for a compact encoding with a frame
629   /// pointer.
630   uint32_t encodeCompactUnwindRegistersWithFrame() const {
631     // Encode the registers in the order they were saved --- 3-bits per
632     // register. The list of saved registers is assumed to be in reverse
633     // order. The registers are numbered from 1 to CU_NUM_SAVED_REGS.
634     uint32_t RegEnc = 0;
635     for (int i = 0, Idx = 0; i != CU_NUM_SAVED_REGS; ++i) {
636       unsigned Reg = SavedRegs[i];
637       if (Reg == 0) break;
638
639       int CURegNum = getCompactUnwindRegNum(Reg);
640       if (CURegNum == -1) return ~0U;
641
642       // Encode the 3-bit register number in order, skipping over 3-bits for
643       // each register.
644       RegEnc |= (CURegNum & 0x7) << (Idx++ * 3);
645     }
646
647     assert((RegEnc & 0x3FFFF) == RegEnc &&
648            "Invalid compact register encoding!");
649     return RegEnc;
650   }
651
652   /// \brief Create the permutation encoding used with frameless stacks. It is
653   /// passed the number of registers to be saved and an array of the registers
654   /// saved.
655   uint32_t encodeCompactUnwindRegistersWithoutFrame(unsigned RegCount) const {
656     // The saved registers are numbered from 1 to 6. In order to encode the
657     // order in which they were saved, we re-number them according to their
658     // place in the register order. The re-numbering is relative to the last
659     // re-numbered register. E.g., if we have registers {6, 2, 4, 5} saved in
660     // that order:
661     //
662     //    Orig  Re-Num
663     //    ----  ------
664     //     6       6
665     //     2       2
666     //     4       3
667     //     5       3
668     //
669     for (unsigned i = 0; i < RegCount; ++i) {
670       int CUReg = getCompactUnwindRegNum(SavedRegs[i]);
671       if (CUReg == -1) return ~0U;
672       SavedRegs[i] = CUReg;
673     }
674
675     // Reverse the list.
676     std::reverse(&SavedRegs[0], &SavedRegs[CU_NUM_SAVED_REGS]);
677
678     uint32_t RenumRegs[CU_NUM_SAVED_REGS];
679     for (unsigned i = CU_NUM_SAVED_REGS - RegCount; i < CU_NUM_SAVED_REGS; ++i){
680       unsigned Countless = 0;
681       for (unsigned j = CU_NUM_SAVED_REGS - RegCount; j < i; ++j)
682         if (SavedRegs[j] < SavedRegs[i])
683           ++Countless;
684
685       RenumRegs[i] = SavedRegs[i] - Countless - 1;
686     }
687
688     // Take the renumbered values and encode them into a 10-bit number.
689     uint32_t permutationEncoding = 0;
690     switch (RegCount) {
691     case 6:
692       permutationEncoding |= 120 * RenumRegs[0] + 24 * RenumRegs[1]
693                              + 6 * RenumRegs[2] +  2 * RenumRegs[3]
694                              +     RenumRegs[4];
695       break;
696     case 5:
697       permutationEncoding |= 120 * RenumRegs[1] + 24 * RenumRegs[2]
698                              + 6 * RenumRegs[3] +  2 * RenumRegs[4]
699                              +     RenumRegs[5];
700       break;
701     case 4:
702       permutationEncoding |=  60 * RenumRegs[2] + 12 * RenumRegs[3]
703                              + 3 * RenumRegs[4] +      RenumRegs[5];
704       break;
705     case 3:
706       permutationEncoding |=  20 * RenumRegs[3] +  4 * RenumRegs[4]
707                              +     RenumRegs[5];
708       break;
709     case 2:
710       permutationEncoding |=   5 * RenumRegs[4] +      RenumRegs[5];
711       break;
712     case 1:
713       permutationEncoding |=       RenumRegs[5];
714       break;
715     }
716
717     assert((permutationEncoding & 0x3FF) == permutationEncoding &&
718            "Invalid compact register encoding!");
719     return permutationEncoding;
720   }
721
722 public:
723   DarwinX86AsmBackend(const Target &T, const MCRegisterInfo &MRI, StringRef CPU,
724                       bool Is64Bit)
725     : X86AsmBackend(T, CPU), MRI(MRI), Is64Bit(Is64Bit) {
726     memset(SavedRegs, 0, sizeof(SavedRegs));
727     OffsetSize = Is64Bit ? 8 : 4;
728     MoveInstrSize = Is64Bit ? 3 : 2;
729     StackDivide = Is64Bit ? 8 : 4;
730   }
731 };
732
733 class DarwinX86_32AsmBackend : public DarwinX86AsmBackend {
734 public:
735   DarwinX86_32AsmBackend(const Target &T, const MCRegisterInfo &MRI,
736                          StringRef CPU)
737       : DarwinX86AsmBackend(T, MRI, CPU, false) {}
738
739   MCObjectWriter *createObjectWriter(raw_pwrite_stream &OS) const override {
740     return createX86MachObjectWriter(OS, /*Is64Bit=*/false,
741                                      MachO::CPU_TYPE_I386,
742                                      MachO::CPU_SUBTYPE_I386_ALL);
743   }
744
745   /// \brief Generate the compact unwind encoding for the CFI instructions.
746   uint32_t generateCompactUnwindEncoding(
747                              ArrayRef<MCCFIInstruction> Instrs) const override {
748     return generateCompactUnwindEncodingImpl(Instrs);
749   }
750 };
751
752 class DarwinX86_64AsmBackend : public DarwinX86AsmBackend {
753   const MachO::CPUSubTypeX86 Subtype;
754 public:
755   DarwinX86_64AsmBackend(const Target &T, const MCRegisterInfo &MRI,
756                          StringRef CPU, MachO::CPUSubTypeX86 st)
757       : DarwinX86AsmBackend(T, MRI, CPU, true), Subtype(st) {}
758
759   MCObjectWriter *createObjectWriter(raw_pwrite_stream &OS) const override {
760     return createX86MachObjectWriter(OS, /*Is64Bit=*/true,
761                                      MachO::CPU_TYPE_X86_64, Subtype);
762   }
763
764   /// \brief Generate the compact unwind encoding for the CFI instructions.
765   uint32_t generateCompactUnwindEncoding(
766                              ArrayRef<MCCFIInstruction> Instrs) const override {
767     return generateCompactUnwindEncodingImpl(Instrs);
768   }
769 };
770
771 } // end anonymous namespace
772
773 MCAsmBackend *llvm::createX86_32AsmBackend(const Target &T,
774                                            const MCRegisterInfo &MRI,
775                                            const Triple &TheTriple,
776                                            StringRef CPU) {
777   if (TheTriple.isOSBinFormatMachO())
778     return new DarwinX86_32AsmBackend(T, MRI, CPU);
779
780   if (TheTriple.isOSWindows() && !TheTriple.isOSBinFormatELF())
781     return new WindowsX86AsmBackend(T, false, CPU);
782
783   uint8_t OSABI = MCELFObjectTargetWriter::getOSABI(TheTriple.getOS());
784   return new ELFX86_32AsmBackend(T, OSABI, CPU);
785 }
786
787 MCAsmBackend *llvm::createX86_64AsmBackend(const Target &T,
788                                            const MCRegisterInfo &MRI,
789                                            const Triple &TheTriple,
790                                            StringRef CPU) {
791   if (TheTriple.isOSBinFormatMachO()) {
792     MachO::CPUSubTypeX86 CS =
793         StringSwitch<MachO::CPUSubTypeX86>(TheTriple.getArchName())
794             .Case("x86_64h", MachO::CPU_SUBTYPE_X86_64_H)
795             .Default(MachO::CPU_SUBTYPE_X86_64_ALL);
796     return new DarwinX86_64AsmBackend(T, MRI, CPU, CS);
797   }
798
799   if (TheTriple.isOSWindows() && !TheTriple.isOSBinFormatELF())
800     return new WindowsX86AsmBackend(T, true, CPU);
801
802   uint8_t OSABI = MCELFObjectTargetWriter::getOSABI(TheTriple.getOS());
803
804   if (TheTriple.getEnvironment() == Triple::GNUX32)
805     return new ELFX86_X32AsmBackend(T, OSABI, CPU);
806   return new ELFX86_64AsmBackend(T, OSABI, CPU);
807 }