1 //===- AArch64InstrInfo.cpp - AArch64 Instruction Information -------------===//
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 // This file contains the AArch64 implementation of the TargetInstrInfo class.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "AArch64InstrInfo.h"
15 #include "AArch64Subtarget.h"
16 #include "MCTargetDesc/AArch64AddressingModes.h"
17 #include "llvm/CodeGen/MachineFrameInfo.h"
18 #include "llvm/CodeGen/MachineInstrBuilder.h"
19 #include "llvm/CodeGen/MachineMemOperand.h"
20 #include "llvm/CodeGen/MachineRegisterInfo.h"
21 #include "llvm/CodeGen/PseudoSourceValue.h"
22 #include "llvm/MC/MCInst.h"
23 #include "llvm/Support/ErrorHandling.h"
24 #include "llvm/Support/TargetRegistry.h"
25 
26 using namespace llvm;
27 
28 #define GET_INSTRINFO_CTOR_DTOR
29 #include "AArch64GenInstrInfo.inc"
30 
31 AArch64InstrInfo::AArch64InstrInfo(const AArch64Subtarget &STI)
32     : AArch64GenInstrInfo(AArch64::ADJCALLSTACKDOWN, AArch64::ADJCALLSTACKUP),
33       RI(STI.getTargetTriple()), Subtarget(STI) {}
34 
35 /// GetInstSize - Return the number of bytes of code the specified
36 /// instruction may be.  This returns the maximum number of bytes.
37 unsigned AArch64InstrInfo::GetInstSizeInBytes(const MachineInstr *MI) const {
38   const MachineBasicBlock &MBB = *MI->getParent();
39   const MachineFunction *MF = MBB.getParent();
40   const MCAsmInfo *MAI = MF->getTarget().getMCAsmInfo();
41 
42   if (MI->getOpcode() == AArch64::INLINEASM)
43     return getInlineAsmLength(MI->getOperand(0).getSymbolName(), *MAI);
44 
45   const MCInstrDesc &Desc = MI->getDesc();
46   switch (Desc.getOpcode()) {
47   default:
48     // Anything not explicitly designated otherwise is a nomal 4-byte insn.
49     return 4;
50   case TargetOpcode::DBG_VALUE:
51   case TargetOpcode::EH_LABEL:
52   case TargetOpcode::IMPLICIT_DEF:
53   case TargetOpcode::KILL:
54     return 0;
55   }
56 
57   llvm_unreachable("GetInstSizeInBytes()- Unable to determin insn size");
58 }
59 
60 static void parseCondBranch(MachineInstr *LastInst, MachineBasicBlock *&Target,
61                             SmallVectorImpl<MachineOperand> &Cond) {
62   // Block ends with fall-through condbranch.
63   switch (LastInst->getOpcode()) {
64   default:
65     llvm_unreachable("Unknown branch instruction?");
66   case AArch64::Bcc:
67     Target = LastInst->getOperand(1).getMBB();
68     Cond.push_back(LastInst->getOperand(0));
69     break;
70   case AArch64::CBZW:
71   case AArch64::CBZX:
72   case AArch64::CBNZW:
73   case AArch64::CBNZX:
74     Target = LastInst->getOperand(1).getMBB();
75     Cond.push_back(MachineOperand::CreateImm(-1));
76     Cond.push_back(MachineOperand::CreateImm(LastInst->getOpcode()));
77     Cond.push_back(LastInst->getOperand(0));
78     break;
79   case AArch64::TBZW:
80   case AArch64::TBZX:
81   case AArch64::TBNZW:
82   case AArch64::TBNZX:
83     Target = LastInst->getOperand(2).getMBB();
84     Cond.push_back(MachineOperand::CreateImm(-1));
85     Cond.push_back(MachineOperand::CreateImm(LastInst->getOpcode()));
86     Cond.push_back(LastInst->getOperand(0));
87     Cond.push_back(LastInst->getOperand(1));
88   }
89 }
90 
91 // Branch analysis.
92 bool AArch64InstrInfo::AnalyzeBranch(MachineBasicBlock &MBB,
93                                    MachineBasicBlock *&TBB,
94                                    MachineBasicBlock *&FBB,
95                                    SmallVectorImpl<MachineOperand> &Cond,
96                                    bool AllowModify) const {
97   // If the block has no terminators, it just falls into the block after it.
98   MachineBasicBlock::iterator I = MBB.getLastNonDebugInstr();
99   if (I == MBB.end())
100     return false;
101 
102   if (!isUnpredicatedTerminator(*I))
103     return false;
104 
105   // Get the last instruction in the block.
106   MachineInstr *LastInst = I;
107 
108   // If there is only one terminator instruction, process it.
109   unsigned LastOpc = LastInst->getOpcode();
110   if (I == MBB.begin() || !isUnpredicatedTerminator(*--I)) {
111     if (isUncondBranchOpcode(LastOpc)) {
112       TBB = LastInst->getOperand(0).getMBB();
113       return false;
114     }
115     if (isCondBranchOpcode(LastOpc)) {
116       // Block ends with fall-through condbranch.
117       parseCondBranch(LastInst, TBB, Cond);
118       return false;
119     }
120     return true; // Can't handle indirect branch.
121   }
122 
123   // Get the instruction before it if it is a terminator.
124   MachineInstr *SecondLastInst = I;
125   unsigned SecondLastOpc = SecondLastInst->getOpcode();
126 
127   // If AllowModify is true and the block ends with two or more unconditional
128   // branches, delete all but the first unconditional branch.
129   if (AllowModify && isUncondBranchOpcode(LastOpc)) {
130     while (isUncondBranchOpcode(SecondLastOpc)) {
131       LastInst->eraseFromParent();
132       LastInst = SecondLastInst;
133       LastOpc = LastInst->getOpcode();
134       if (I == MBB.begin() || !isUnpredicatedTerminator(*--I)) {
135         // Return now the only terminator is an unconditional branch.
136         TBB = LastInst->getOperand(0).getMBB();
137         return false;
138       } else {
139         SecondLastInst = I;
140         SecondLastOpc = SecondLastInst->getOpcode();
141       }
142     }
143   }
144 
145   // If there are three terminators, we don't know what sort of block this is.
146   if (SecondLastInst && I != MBB.begin() && isUnpredicatedTerminator(*--I))
147     return true;
148 
149   // If the block ends with a B and a Bcc, handle it.
150   if (isCondBranchOpcode(SecondLastOpc) && isUncondBranchOpcode(LastOpc)) {
151     parseCondBranch(SecondLastInst, TBB, Cond);
152     FBB = LastInst->getOperand(0).getMBB();
153     return false;
154   }
155 
156   // If the block ends with two unconditional branches, handle it.  The second
157   // one is not executed, so remove it.
158   if (isUncondBranchOpcode(SecondLastOpc) && isUncondBranchOpcode(LastOpc)) {
159     TBB = SecondLastInst->getOperand(0).getMBB();
160     I = LastInst;
161     if (AllowModify)
162       I->eraseFromParent();
163     return false;
164   }
165 
166   // ...likewise if it ends with an indirect branch followed by an unconditional
167   // branch.
168   if (isIndirectBranchOpcode(SecondLastOpc) && isUncondBranchOpcode(LastOpc)) {
169     I = LastInst;
170     if (AllowModify)
171       I->eraseFromParent();
172     return true;
173   }
174 
175   // Otherwise, can't handle this.
176   return true;
177 }
178 
179 bool AArch64InstrInfo::ReverseBranchCondition(
180     SmallVectorImpl<MachineOperand> &Cond) const {
181   if (Cond[0].getImm() != -1) {
182     // Regular Bcc
183     AArch64CC::CondCode CC = (AArch64CC::CondCode)(int)Cond[0].getImm();
184     Cond[0].setImm(AArch64CC::getInvertedCondCode(CC));
185   } else {
186     // Folded compare-and-branch
187     switch (Cond[1].getImm()) {
188     default:
189       llvm_unreachable("Unknown conditional branch!");
190     case AArch64::CBZW:
191       Cond[1].setImm(AArch64::CBNZW);
192       break;
193     case AArch64::CBNZW:
194       Cond[1].setImm(AArch64::CBZW);
195       break;
196     case AArch64::CBZX:
197       Cond[1].setImm(AArch64::CBNZX);
198       break;
199     case AArch64::CBNZX:
200       Cond[1].setImm(AArch64::CBZX);
201       break;
202     case AArch64::TBZW:
203       Cond[1].setImm(AArch64::TBNZW);
204       break;
205     case AArch64::TBNZW:
206       Cond[1].setImm(AArch64::TBZW);
207       break;
208     case AArch64::TBZX:
209       Cond[1].setImm(AArch64::TBNZX);
210       break;
211     case AArch64::TBNZX:
212       Cond[1].setImm(AArch64::TBZX);
213       break;
214     }
215   }
216 
217   return false;
218 }
219 
220 unsigned AArch64InstrInfo::RemoveBranch(MachineBasicBlock &MBB) const {
221   MachineBasicBlock::iterator I = MBB.getLastNonDebugInstr();
222   if (I == MBB.end())
223     return 0;
224 
225   if (!isUncondBranchOpcode(I->getOpcode()) &&
226       !isCondBranchOpcode(I->getOpcode()))
227     return 0;
228 
229   // Remove the branch.
230   I->eraseFromParent();
231 
232   I = MBB.end();
233 
234   if (I == MBB.begin())
235     return 1;
236   --I;
237   if (!isCondBranchOpcode(I->getOpcode()))
238     return 1;
239 
240   // Remove the branch.
241   I->eraseFromParent();
242   return 2;
243 }
244 
245 void AArch64InstrInfo::instantiateCondBranch(
246     MachineBasicBlock &MBB, DebugLoc DL, MachineBasicBlock *TBB,
247     ArrayRef<MachineOperand> Cond) const {
248   if (Cond[0].getImm() != -1) {
249     // Regular Bcc
250     BuildMI(&MBB, DL, get(AArch64::Bcc)).addImm(Cond[0].getImm()).addMBB(TBB);
251   } else {
252     // Folded compare-and-branch
253     // Note that we use addOperand instead of addReg to keep the flags.
254     const MachineInstrBuilder MIB =
255         BuildMI(&MBB, DL, get(Cond[1].getImm())).addOperand(Cond[2]);
256     if (Cond.size() > 3)
257       MIB.addImm(Cond[3].getImm());
258     MIB.addMBB(TBB);
259   }
260 }
261 
262 unsigned AArch64InstrInfo::InsertBranch(
263     MachineBasicBlock &MBB, MachineBasicBlock *TBB, MachineBasicBlock *FBB,
264     ArrayRef<MachineOperand> Cond, DebugLoc DL) const {
265   // Shouldn't be a fall through.
266   assert(TBB && "InsertBranch must not be told to insert a fallthrough");
267 
268   if (!FBB) {
269     if (Cond.empty()) // Unconditional branch?
270       BuildMI(&MBB, DL, get(AArch64::B)).addMBB(TBB);
271     else
272       instantiateCondBranch(MBB, DL, TBB, Cond);
273     return 1;
274   }
275 
276   // Two-way conditional branch.
277   instantiateCondBranch(MBB, DL, TBB, Cond);
278   BuildMI(&MBB, DL, get(AArch64::B)).addMBB(FBB);
279   return 2;
280 }
281 
282 // Find the original register that VReg is copied from.
283 static unsigned removeCopies(const MachineRegisterInfo &MRI, unsigned VReg) {
284   while (TargetRegisterInfo::isVirtualRegister(VReg)) {
285     const MachineInstr *DefMI = MRI.getVRegDef(VReg);
286     if (!DefMI->isFullCopy())
287       return VReg;
288     VReg = DefMI->getOperand(1).getReg();
289   }
290   return VReg;
291 }
292 
293 // Determine if VReg is defined by an instruction that can be folded into a
294 // csel instruction. If so, return the folded opcode, and the replacement
295 // register.
296 static unsigned canFoldIntoCSel(const MachineRegisterInfo &MRI, unsigned VReg,
297                                 unsigned *NewVReg = nullptr) {
298   VReg = removeCopies(MRI, VReg);
299   if (!TargetRegisterInfo::isVirtualRegister(VReg))
300     return 0;
301 
302   bool Is64Bit = AArch64::GPR64allRegClass.hasSubClassEq(MRI.getRegClass(VReg));
303   const MachineInstr *DefMI = MRI.getVRegDef(VReg);
304   unsigned Opc = 0;
305   unsigned SrcOpNum = 0;
306   switch (DefMI->getOpcode()) {
307   case AArch64::ADDSXri:
308   case AArch64::ADDSWri:
309     // if NZCV is used, do not fold.
310     if (DefMI->findRegisterDefOperandIdx(AArch64::NZCV, true) == -1)
311       return 0;
312   // fall-through to ADDXri and ADDWri.
313   case AArch64::ADDXri:
314   case AArch64::ADDWri:
315     // add x, 1 -> csinc.
316     if (!DefMI->getOperand(2).isImm() || DefMI->getOperand(2).getImm() != 1 ||
317         DefMI->getOperand(3).getImm() != 0)
318       return 0;
319     SrcOpNum = 1;
320     Opc = Is64Bit ? AArch64::CSINCXr : AArch64::CSINCWr;
321     break;
322 
323   case AArch64::ORNXrr:
324   case AArch64::ORNWrr: {
325     // not x -> csinv, represented as orn dst, xzr, src.
326     unsigned ZReg = removeCopies(MRI, DefMI->getOperand(1).getReg());
327     if (ZReg != AArch64::XZR && ZReg != AArch64::WZR)
328       return 0;
329     SrcOpNum = 2;
330     Opc = Is64Bit ? AArch64::CSINVXr : AArch64::CSINVWr;
331     break;
332   }
333 
334   case AArch64::SUBSXrr:
335   case AArch64::SUBSWrr:
336     // if NZCV is used, do not fold.
337     if (DefMI->findRegisterDefOperandIdx(AArch64::NZCV, true) == -1)
338       return 0;
339   // fall-through to SUBXrr and SUBWrr.
340   case AArch64::SUBXrr:
341   case AArch64::SUBWrr: {
342     // neg x -> csneg, represented as sub dst, xzr, src.
343     unsigned ZReg = removeCopies(MRI, DefMI->getOperand(1).getReg());
344     if (ZReg != AArch64::XZR && ZReg != AArch64::WZR)
345       return 0;
346     SrcOpNum = 2;
347     Opc = Is64Bit ? AArch64::CSNEGXr : AArch64::CSNEGWr;
348     break;
349   }
350   default:
351     return 0;
352   }
353   assert(Opc && SrcOpNum && "Missing parameters");
354 
355   if (NewVReg)
356     *NewVReg = DefMI->getOperand(SrcOpNum).getReg();
357   return Opc;
358 }
359 
360 bool AArch64InstrInfo::canInsertSelect(
361     const MachineBasicBlock &MBB, ArrayRef<MachineOperand> Cond,
362     unsigned TrueReg, unsigned FalseReg, int &CondCycles, int &TrueCycles,
363     int &FalseCycles) const {
364   // Check register classes.
365   const MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
366   const TargetRegisterClass *RC =
367       RI.getCommonSubClass(MRI.getRegClass(TrueReg), MRI.getRegClass(FalseReg));
368   if (!RC)
369     return false;
370 
371   // Expanding cbz/tbz requires an extra cycle of latency on the condition.
372   unsigned ExtraCondLat = Cond.size() != 1;
373 
374   // GPRs are handled by csel.
375   // FIXME: Fold in x+1, -x, and ~x when applicable.
376   if (AArch64::GPR64allRegClass.hasSubClassEq(RC) ||
377       AArch64::GPR32allRegClass.hasSubClassEq(RC)) {
378     // Single-cycle csel, csinc, csinv, and csneg.
379     CondCycles = 1 + ExtraCondLat;
380     TrueCycles = FalseCycles = 1;
381     if (canFoldIntoCSel(MRI, TrueReg))
382       TrueCycles = 0;
383     else if (canFoldIntoCSel(MRI, FalseReg))
384       FalseCycles = 0;
385     return true;
386   }
387 
388   // Scalar floating point is handled by fcsel.
389   // FIXME: Form fabs, fmin, and fmax when applicable.
390   if (AArch64::FPR64RegClass.hasSubClassEq(RC) ||
391       AArch64::FPR32RegClass.hasSubClassEq(RC)) {
392     CondCycles = 5 + ExtraCondLat;
393     TrueCycles = FalseCycles = 2;
394     return true;
395   }
396 
397   // Can't do vectors.
398   return false;
399 }
400 
401 void AArch64InstrInfo::insertSelect(MachineBasicBlock &MBB,
402                                     MachineBasicBlock::iterator I, DebugLoc DL,
403                                     unsigned DstReg,
404                                     ArrayRef<MachineOperand> Cond,
405                                     unsigned TrueReg, unsigned FalseReg) const {
406   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
407 
408   // Parse the condition code, see parseCondBranch() above.
409   AArch64CC::CondCode CC;
410   switch (Cond.size()) {
411   default:
412     llvm_unreachable("Unknown condition opcode in Cond");
413   case 1: // b.cc
414     CC = AArch64CC::CondCode(Cond[0].getImm());
415     break;
416   case 3: { // cbz/cbnz
417     // We must insert a compare against 0.
418     bool Is64Bit;
419     switch (Cond[1].getImm()) {
420     default:
421       llvm_unreachable("Unknown branch opcode in Cond");
422     case AArch64::CBZW:
423       Is64Bit = 0;
424       CC = AArch64CC::EQ;
425       break;
426     case AArch64::CBZX:
427       Is64Bit = 1;
428       CC = AArch64CC::EQ;
429       break;
430     case AArch64::CBNZW:
431       Is64Bit = 0;
432       CC = AArch64CC::NE;
433       break;
434     case AArch64::CBNZX:
435       Is64Bit = 1;
436       CC = AArch64CC::NE;
437       break;
438     }
439     unsigned SrcReg = Cond[2].getReg();
440     if (Is64Bit) {
441       // cmp reg, #0 is actually subs xzr, reg, #0.
442       MRI.constrainRegClass(SrcReg, &AArch64::GPR64spRegClass);
443       BuildMI(MBB, I, DL, get(AArch64::SUBSXri), AArch64::XZR)
444           .addReg(SrcReg)
445           .addImm(0)
446           .addImm(0);
447     } else {
448       MRI.constrainRegClass(SrcReg, &AArch64::GPR32spRegClass);
449       BuildMI(MBB, I, DL, get(AArch64::SUBSWri), AArch64::WZR)
450           .addReg(SrcReg)
451           .addImm(0)
452           .addImm(0);
453     }
454     break;
455   }
456   case 4: { // tbz/tbnz
457     // We must insert a tst instruction.
458     switch (Cond[1].getImm()) {
459     default:
460       llvm_unreachable("Unknown branch opcode in Cond");
461     case AArch64::TBZW:
462     case AArch64::TBZX:
463       CC = AArch64CC::EQ;
464       break;
465     case AArch64::TBNZW:
466     case AArch64::TBNZX:
467       CC = AArch64CC::NE;
468       break;
469     }
470     // cmp reg, #foo is actually ands xzr, reg, #1<<foo.
471     if (Cond[1].getImm() == AArch64::TBZW || Cond[1].getImm() == AArch64::TBNZW)
472       BuildMI(MBB, I, DL, get(AArch64::ANDSWri), AArch64::WZR)
473           .addReg(Cond[2].getReg())
474           .addImm(
475               AArch64_AM::encodeLogicalImmediate(1ull << Cond[3].getImm(), 32));
476     else
477       BuildMI(MBB, I, DL, get(AArch64::ANDSXri), AArch64::XZR)
478           .addReg(Cond[2].getReg())
479           .addImm(
480               AArch64_AM::encodeLogicalImmediate(1ull << Cond[3].getImm(), 64));
481     break;
482   }
483   }
484 
485   unsigned Opc = 0;
486   const TargetRegisterClass *RC = nullptr;
487   bool TryFold = false;
488   if (MRI.constrainRegClass(DstReg, &AArch64::GPR64RegClass)) {
489     RC = &AArch64::GPR64RegClass;
490     Opc = AArch64::CSELXr;
491     TryFold = true;
492   } else if (MRI.constrainRegClass(DstReg, &AArch64::GPR32RegClass)) {
493     RC = &AArch64::GPR32RegClass;
494     Opc = AArch64::CSELWr;
495     TryFold = true;
496   } else if (MRI.constrainRegClass(DstReg, &AArch64::FPR64RegClass)) {
497     RC = &AArch64::FPR64RegClass;
498     Opc = AArch64::FCSELDrrr;
499   } else if (MRI.constrainRegClass(DstReg, &AArch64::FPR32RegClass)) {
500     RC = &AArch64::FPR32RegClass;
501     Opc = AArch64::FCSELSrrr;
502   }
503   assert(RC && "Unsupported regclass");
504 
505   // Try folding simple instructions into the csel.
506   if (TryFold) {
507     unsigned NewVReg = 0;
508     unsigned FoldedOpc = canFoldIntoCSel(MRI, TrueReg, &NewVReg);
509     if (FoldedOpc) {
510       // The folded opcodes csinc, csinc and csneg apply the operation to
511       // FalseReg, so we need to invert the condition.
512       CC = AArch64CC::getInvertedCondCode(CC);
513       TrueReg = FalseReg;
514     } else
515       FoldedOpc = canFoldIntoCSel(MRI, FalseReg, &NewVReg);
516 
517     // Fold the operation. Leave any dead instructions for DCE to clean up.
518     if (FoldedOpc) {
519       FalseReg = NewVReg;
520       Opc = FoldedOpc;
521       // The extends the live range of NewVReg.
522       MRI.clearKillFlags(NewVReg);
523     }
524   }
525 
526   // Pull all virtual register into the appropriate class.
527   MRI.constrainRegClass(TrueReg, RC);
528   MRI.constrainRegClass(FalseReg, RC);
529 
530   // Insert the csel.
531   BuildMI(MBB, I, DL, get(Opc), DstReg).addReg(TrueReg).addReg(FalseReg).addImm(
532       CC);
533 }
534 
535 /// Returns true if a MOVi32imm or MOVi64imm can be expanded to an  ORRxx.
536 static bool canBeExpandedToORR(const MachineInstr *MI, unsigned BitSize) {
537   uint64_t Imm = MI->getOperand(1).getImm();
538   uint64_t UImm = Imm << (64 - BitSize) >> (64 - BitSize);
539   uint64_t Encoding;
540   return AArch64_AM::processLogicalImmediate(UImm, BitSize, Encoding);
541 }
542 
543 // FIXME: this implementation should be micro-architecture dependent, so a
544 // micro-architecture target hook should be introduced here in future.
545 bool AArch64InstrInfo::isAsCheapAsAMove(const MachineInstr *MI) const {
546   if (!Subtarget.isCortexA57() && !Subtarget.isCortexA53() &&
547       !Subtarget.isKryo())
548     return MI->isAsCheapAsAMove();
549 
550   switch (MI->getOpcode()) {
551   default:
552     return false;
553 
554   // add/sub on register without shift
555   case AArch64::ADDWri:
556   case AArch64::ADDXri:
557   case AArch64::SUBWri:
558   case AArch64::SUBXri:
559     return (MI->getOperand(3).getImm() == 0);
560 
561   // logical ops on immediate
562   case AArch64::ANDWri:
563   case AArch64::ANDXri:
564   case AArch64::EORWri:
565   case AArch64::EORXri:
566   case AArch64::ORRWri:
567   case AArch64::ORRXri:
568     return true;
569 
570   // logical ops on register without shift
571   case AArch64::ANDWrr:
572   case AArch64::ANDXrr:
573   case AArch64::BICWrr:
574   case AArch64::BICXrr:
575   case AArch64::EONWrr:
576   case AArch64::EONXrr:
577   case AArch64::EORWrr:
578   case AArch64::EORXrr:
579   case AArch64::ORNWrr:
580   case AArch64::ORNXrr:
581   case AArch64::ORRWrr:
582   case AArch64::ORRXrr:
583     return true;
584   // If MOVi32imm or MOVi64imm can be expanded into ORRWri or
585   // ORRXri, it is as cheap as MOV
586   case AArch64::MOVi32imm:
587     return canBeExpandedToORR(MI, 32);
588   case AArch64::MOVi64imm:
589     return canBeExpandedToORR(MI, 64);
590   }
591 
592   llvm_unreachable("Unknown opcode to check as cheap as a move!");
593 }
594 
595 bool AArch64InstrInfo::isCoalescableExtInstr(const MachineInstr &MI,
596                                              unsigned &SrcReg, unsigned &DstReg,
597                                              unsigned &SubIdx) const {
598   switch (MI.getOpcode()) {
599   default:
600     return false;
601   case AArch64::SBFMXri: // aka sxtw
602   case AArch64::UBFMXri: // aka uxtw
603     // Check for the 32 -> 64 bit extension case, these instructions can do
604     // much more.
605     if (MI.getOperand(2).getImm() != 0 || MI.getOperand(3).getImm() != 31)
606       return false;
607     // This is a signed or unsigned 32 -> 64 bit extension.
608     SrcReg = MI.getOperand(1).getReg();
609     DstReg = MI.getOperand(0).getReg();
610     SubIdx = AArch64::sub_32;
611     return true;
612   }
613 }
614 
615 bool
616 AArch64InstrInfo::areMemAccessesTriviallyDisjoint(MachineInstr *MIa,
617                                                   MachineInstr *MIb,
618                                                   AliasAnalysis *AA) const {
619   const TargetRegisterInfo *TRI = &getRegisterInfo();
620   unsigned BaseRegA = 0, BaseRegB = 0;
621   int OffsetA = 0, OffsetB = 0;
622   int WidthA = 0, WidthB = 0;
623 
624   assert(MIa && MIa->mayLoadOrStore() && "MIa must be a load or store.");
625   assert(MIb && MIb->mayLoadOrStore() && "MIb must be a load or store.");
626 
627   if (MIa->hasUnmodeledSideEffects() || MIb->hasUnmodeledSideEffects() ||
628       MIa->hasOrderedMemoryRef() || MIb->hasOrderedMemoryRef())
629     return false;
630 
631   // Retrieve the base register, offset from the base register and width. Width
632   // is the size of memory that is being loaded/stored (e.g. 1, 2, 4, 8).  If
633   // base registers are identical, and the offset of a lower memory access +
634   // the width doesn't overlap the offset of a higher memory access,
635   // then the memory accesses are different.
636   if (getMemOpBaseRegImmOfsWidth(MIa, BaseRegA, OffsetA, WidthA, TRI) &&
637       getMemOpBaseRegImmOfsWidth(MIb, BaseRegB, OffsetB, WidthB, TRI)) {
638     if (BaseRegA == BaseRegB) {
639       int LowOffset = OffsetA < OffsetB ? OffsetA : OffsetB;
640       int HighOffset = OffsetA < OffsetB ? OffsetB : OffsetA;
641       int LowWidth = (LowOffset == OffsetA) ? WidthA : WidthB;
642       if (LowOffset + LowWidth <= HighOffset)
643         return true;
644     }
645   }
646   return false;
647 }
648 
649 /// analyzeCompare - For a comparison instruction, return the source registers
650 /// in SrcReg and SrcReg2, and the value it compares against in CmpValue.
651 /// Return true if the comparison instruction can be analyzed.
652 bool AArch64InstrInfo::analyzeCompare(const MachineInstr *MI, unsigned &SrcReg,
653                                       unsigned &SrcReg2, int &CmpMask,
654                                       int &CmpValue) const {
655   switch (MI->getOpcode()) {
656   default:
657     break;
658   case AArch64::SUBSWrr:
659   case AArch64::SUBSWrs:
660   case AArch64::SUBSWrx:
661   case AArch64::SUBSXrr:
662   case AArch64::SUBSXrs:
663   case AArch64::SUBSXrx:
664   case AArch64::ADDSWrr:
665   case AArch64::ADDSWrs:
666   case AArch64::ADDSWrx:
667   case AArch64::ADDSXrr:
668   case AArch64::ADDSXrs:
669   case AArch64::ADDSXrx:
670     // Replace SUBSWrr with SUBWrr if NZCV is not used.
671     SrcReg = MI->getOperand(1).getReg();
672     SrcReg2 = MI->getOperand(2).getReg();
673     CmpMask = ~0;
674     CmpValue = 0;
675     return true;
676   case AArch64::SUBSWri:
677   case AArch64::ADDSWri:
678   case AArch64::SUBSXri:
679   case AArch64::ADDSXri:
680     SrcReg = MI->getOperand(1).getReg();
681     SrcReg2 = 0;
682     CmpMask = ~0;
683     // FIXME: In order to convert CmpValue to 0 or 1
684     CmpValue = (MI->getOperand(2).getImm() != 0);
685     return true;
686   case AArch64::ANDSWri:
687   case AArch64::ANDSXri:
688     // ANDS does not use the same encoding scheme as the others xxxS
689     // instructions.
690     SrcReg = MI->getOperand(1).getReg();
691     SrcReg2 = 0;
692     CmpMask = ~0;
693     // FIXME:The return val type of decodeLogicalImmediate is uint64_t,
694     // while the type of CmpValue is int. When converting uint64_t to int,
695     // the high 32 bits of uint64_t will be lost.
696     // In fact it causes a bug in spec2006-483.xalancbmk
697     // CmpValue is only used to compare with zero in OptimizeCompareInstr
698     CmpValue = (AArch64_AM::decodeLogicalImmediate(
699                     MI->getOperand(2).getImm(),
700                     MI->getOpcode() == AArch64::ANDSWri ? 32 : 64) != 0);
701     return true;
702   }
703 
704   return false;
705 }
706 
707 static bool UpdateOperandRegClass(MachineInstr *Instr) {
708   MachineBasicBlock *MBB = Instr->getParent();
709   assert(MBB && "Can't get MachineBasicBlock here");
710   MachineFunction *MF = MBB->getParent();
711   assert(MF && "Can't get MachineFunction here");
712   const TargetInstrInfo *TII = MF->getSubtarget().getInstrInfo();
713   const TargetRegisterInfo *TRI = MF->getSubtarget().getRegisterInfo();
714   MachineRegisterInfo *MRI = &MF->getRegInfo();
715 
716   for (unsigned OpIdx = 0, EndIdx = Instr->getNumOperands(); OpIdx < EndIdx;
717        ++OpIdx) {
718     MachineOperand &MO = Instr->getOperand(OpIdx);
719     const TargetRegisterClass *OpRegCstraints =
720         Instr->getRegClassConstraint(OpIdx, TII, TRI);
721 
722     // If there's no constraint, there's nothing to do.
723     if (!OpRegCstraints)
724       continue;
725     // If the operand is a frame index, there's nothing to do here.
726     // A frame index operand will resolve correctly during PEI.
727     if (MO.isFI())
728       continue;
729 
730     assert(MO.isReg() &&
731            "Operand has register constraints without being a register!");
732 
733     unsigned Reg = MO.getReg();
734     if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
735       if (!OpRegCstraints->contains(Reg))
736         return false;
737     } else if (!OpRegCstraints->hasSubClassEq(MRI->getRegClass(Reg)) &&
738                !MRI->constrainRegClass(Reg, OpRegCstraints))
739       return false;
740   }
741 
742   return true;
743 }
744 
745 /// \brief Return the opcode that does not set flags when possible - otherwise
746 /// return the original opcode. The caller is responsible to do the actual
747 /// substitution and legality checking.
748 static unsigned convertFlagSettingOpcode(const MachineInstr *MI) {
749   // Don't convert all compare instructions, because for some the zero register
750   // encoding becomes the sp register.
751   bool MIDefinesZeroReg = false;
752   if (MI->definesRegister(AArch64::WZR) || MI->definesRegister(AArch64::XZR))
753     MIDefinesZeroReg = true;
754 
755   switch (MI->getOpcode()) {
756   default:
757     return MI->getOpcode();
758   case AArch64::ADDSWrr:
759     return AArch64::ADDWrr;
760   case AArch64::ADDSWri:
761     return MIDefinesZeroReg ? AArch64::ADDSWri : AArch64::ADDWri;
762   case AArch64::ADDSWrs:
763     return MIDefinesZeroReg ? AArch64::ADDSWrs : AArch64::ADDWrs;
764   case AArch64::ADDSWrx:
765     return AArch64::ADDWrx;
766   case AArch64::ADDSXrr:
767     return AArch64::ADDXrr;
768   case AArch64::ADDSXri:
769     return MIDefinesZeroReg ? AArch64::ADDSXri : AArch64::ADDXri;
770   case AArch64::ADDSXrs:
771     return MIDefinesZeroReg ? AArch64::ADDSXrs : AArch64::ADDXrs;
772   case AArch64::ADDSXrx:
773     return AArch64::ADDXrx;
774   case AArch64::SUBSWrr:
775     return AArch64::SUBWrr;
776   case AArch64::SUBSWri:
777     return MIDefinesZeroReg ? AArch64::SUBSWri : AArch64::SUBWri;
778   case AArch64::SUBSWrs:
779     return MIDefinesZeroReg ? AArch64::SUBSWrs : AArch64::SUBWrs;
780   case AArch64::SUBSWrx:
781     return AArch64::SUBWrx;
782   case AArch64::SUBSXrr:
783     return AArch64::SUBXrr;
784   case AArch64::SUBSXri:
785     return MIDefinesZeroReg ? AArch64::SUBSXri : AArch64::SUBXri;
786   case AArch64::SUBSXrs:
787     return MIDefinesZeroReg ? AArch64::SUBSXrs : AArch64::SUBXrs;
788   case AArch64::SUBSXrx:
789     return AArch64::SUBXrx;
790   }
791 }
792 
793 /// True when condition code could be modified on the instruction
794 /// trace starting at from and ending at to.
795 static bool modifiesConditionCode(MachineInstr *From, MachineInstr *To,
796                                   const bool CheckOnlyCCWrites,
797                                   const TargetRegisterInfo *TRI) {
798   // We iterate backward starting \p To until we hit \p From
799   MachineBasicBlock::iterator I = To, E = From, B = To->getParent()->begin();
800 
801   // Early exit if To is at the beginning of the BB.
802   if (I == B)
803     return true;
804 
805   // Check whether the definition of SrcReg is in the same basic block as
806   // Compare. If not, assume the condition code gets modified on some path.
807   if (To->getParent() != From->getParent())
808     return true;
809 
810   // Check that NZCV isn't set on the trace.
811   for (--I; I != E; --I) {
812     const MachineInstr &Instr = *I;
813 
814     if (Instr.modifiesRegister(AArch64::NZCV, TRI) ||
815         (!CheckOnlyCCWrites && Instr.readsRegister(AArch64::NZCV, TRI)))
816       // This instruction modifies or uses NZCV after the one we want to
817       // change.
818       return true;
819     if (I == B)
820       // We currently don't allow the instruction trace to cross basic
821       // block boundaries
822       return true;
823   }
824   return false;
825 }
826 /// optimizeCompareInstr - Convert the instruction supplying the argument to the
827 /// comparison into one that sets the zero bit in the flags register.
828 bool AArch64InstrInfo::optimizeCompareInstr(
829     MachineInstr *CmpInstr, unsigned SrcReg, unsigned SrcReg2, int CmpMask,
830     int CmpValue, const MachineRegisterInfo *MRI) const {
831 
832   // Replace SUBSWrr with SUBWrr if NZCV is not used.
833   int Cmp_NZCV = CmpInstr->findRegisterDefOperandIdx(AArch64::NZCV, true);
834   if (Cmp_NZCV != -1) {
835     if (CmpInstr->definesRegister(AArch64::WZR) ||
836         CmpInstr->definesRegister(AArch64::XZR)) {
837       CmpInstr->eraseFromParent();
838       return true;
839     }
840     unsigned Opc = CmpInstr->getOpcode();
841     unsigned NewOpc = convertFlagSettingOpcode(CmpInstr);
842     if (NewOpc == Opc)
843       return false;
844     const MCInstrDesc &MCID = get(NewOpc);
845     CmpInstr->setDesc(MCID);
846     CmpInstr->RemoveOperand(Cmp_NZCV);
847     bool succeeded = UpdateOperandRegClass(CmpInstr);
848     (void)succeeded;
849     assert(succeeded && "Some operands reg class are incompatible!");
850     return true;
851   }
852 
853   // Continue only if we have a "ri" where immediate is zero.
854   // FIXME:CmpValue has already been converted to 0 or 1 in analyzeCompare
855   // function.
856   assert((CmpValue == 0 || CmpValue == 1) && "CmpValue must be 0 or 1!");
857   if (CmpValue != 0 || SrcReg2 != 0)
858     return false;
859 
860   // CmpInstr is a Compare instruction if destination register is not used.
861   if (!MRI->use_nodbg_empty(CmpInstr->getOperand(0).getReg()))
862     return false;
863 
864   // Get the unique definition of SrcReg.
865   MachineInstr *MI = MRI->getUniqueVRegDef(SrcReg);
866   if (!MI)
867     return false;
868 
869   bool CheckOnlyCCWrites = false;
870   const TargetRegisterInfo *TRI = &getRegisterInfo();
871   if (modifiesConditionCode(MI, CmpInstr, CheckOnlyCCWrites, TRI))
872     return false;
873 
874   unsigned NewOpc = MI->getOpcode();
875   switch (MI->getOpcode()) {
876   default:
877     return false;
878   case AArch64::ADDSWrr:
879   case AArch64::ADDSWri:
880   case AArch64::ADDSXrr:
881   case AArch64::ADDSXri:
882   case AArch64::SUBSWrr:
883   case AArch64::SUBSWri:
884   case AArch64::SUBSXrr:
885   case AArch64::SUBSXri:
886     break;
887   case AArch64::ADDWrr:    NewOpc = AArch64::ADDSWrr; break;
888   case AArch64::ADDWri:    NewOpc = AArch64::ADDSWri; break;
889   case AArch64::ADDXrr:    NewOpc = AArch64::ADDSXrr; break;
890   case AArch64::ADDXri:    NewOpc = AArch64::ADDSXri; break;
891   case AArch64::ADCWr:     NewOpc = AArch64::ADCSWr; break;
892   case AArch64::ADCXr:     NewOpc = AArch64::ADCSXr; break;
893   case AArch64::SUBWrr:    NewOpc = AArch64::SUBSWrr; break;
894   case AArch64::SUBWri:    NewOpc = AArch64::SUBSWri; break;
895   case AArch64::SUBXrr:    NewOpc = AArch64::SUBSXrr; break;
896   case AArch64::SUBXri:    NewOpc = AArch64::SUBSXri; break;
897   case AArch64::SBCWr:     NewOpc = AArch64::SBCSWr; break;
898   case AArch64::SBCXr:     NewOpc = AArch64::SBCSXr; break;
899   case AArch64::ANDWri:    NewOpc = AArch64::ANDSWri; break;
900   case AArch64::ANDXri:    NewOpc = AArch64::ANDSXri; break;
901   }
902 
903   // Scan forward for the use of NZCV.
904   // When checking against MI: if it's a conditional code requires
905   // checking of V bit, then this is not safe to do.
906   // It is safe to remove CmpInstr if NZCV is redefined or killed.
907   // If we are done with the basic block, we need to check whether NZCV is
908   // live-out.
909   bool IsSafe = false;
910   for (MachineBasicBlock::iterator I = CmpInstr,
911                                    E = CmpInstr->getParent()->end();
912        !IsSafe && ++I != E;) {
913     const MachineInstr &Instr = *I;
914     for (unsigned IO = 0, EO = Instr.getNumOperands(); !IsSafe && IO != EO;
915          ++IO) {
916       const MachineOperand &MO = Instr.getOperand(IO);
917       if (MO.isRegMask() && MO.clobbersPhysReg(AArch64::NZCV)) {
918         IsSafe = true;
919         break;
920       }
921       if (!MO.isReg() || MO.getReg() != AArch64::NZCV)
922         continue;
923       if (MO.isDef()) {
924         IsSafe = true;
925         break;
926       }
927 
928       // Decode the condition code.
929       unsigned Opc = Instr.getOpcode();
930       AArch64CC::CondCode CC;
931       switch (Opc) {
932       default:
933         return false;
934       case AArch64::Bcc:
935         CC = (AArch64CC::CondCode)Instr.getOperand(IO - 2).getImm();
936         break;
937       case AArch64::CSINVWr:
938       case AArch64::CSINVXr:
939       case AArch64::CSINCWr:
940       case AArch64::CSINCXr:
941       case AArch64::CSELWr:
942       case AArch64::CSELXr:
943       case AArch64::CSNEGWr:
944       case AArch64::CSNEGXr:
945       case AArch64::FCSELSrrr:
946       case AArch64::FCSELDrrr:
947         CC = (AArch64CC::CondCode)Instr.getOperand(IO - 1).getImm();
948         break;
949       }
950 
951       // It is not safe to remove Compare instruction if Overflow(V) is used.
952       switch (CC) {
953       default:
954         // NZCV can be used multiple times, we should continue.
955         break;
956       case AArch64CC::VS:
957       case AArch64CC::VC:
958       case AArch64CC::GE:
959       case AArch64CC::LT:
960       case AArch64CC::GT:
961       case AArch64CC::LE:
962         return false;
963       }
964     }
965   }
966 
967   // If NZCV is not killed nor re-defined, we should check whether it is
968   // live-out. If it is live-out, do not optimize.
969   if (!IsSafe) {
970     MachineBasicBlock *ParentBlock = CmpInstr->getParent();
971     for (auto *MBB : ParentBlock->successors())
972       if (MBB->isLiveIn(AArch64::NZCV))
973         return false;
974   }
975 
976   // Update the instruction to set NZCV.
977   MI->setDesc(get(NewOpc));
978   CmpInstr->eraseFromParent();
979   bool succeeded = UpdateOperandRegClass(MI);
980   (void)succeeded;
981   assert(succeeded && "Some operands reg class are incompatible!");
982   MI->addRegisterDefined(AArch64::NZCV, TRI);
983   return true;
984 }
985 
986 bool
987 AArch64InstrInfo::expandPostRAPseudo(MachineBasicBlock::iterator MI) const {
988   if (MI->getOpcode() != TargetOpcode::LOAD_STACK_GUARD)
989     return false;
990 
991   MachineBasicBlock &MBB = *MI->getParent();
992   DebugLoc DL = MI->getDebugLoc();
993   unsigned Reg = MI->getOperand(0).getReg();
994   const GlobalValue *GV =
995       cast<GlobalValue>((*MI->memoperands_begin())->getValue());
996   const TargetMachine &TM = MBB.getParent()->getTarget();
997   unsigned char OpFlags = Subtarget.ClassifyGlobalReference(GV, TM);
998   const unsigned char MO_NC = AArch64II::MO_NC;
999 
1000   if ((OpFlags & AArch64II::MO_GOT) != 0) {
1001     BuildMI(MBB, MI, DL, get(AArch64::LOADgot), Reg)
1002         .addGlobalAddress(GV, 0, AArch64II::MO_GOT);
1003     BuildMI(MBB, MI, DL, get(AArch64::LDRXui), Reg)
1004         .addReg(Reg, RegState::Kill).addImm(0)
1005         .addMemOperand(*MI->memoperands_begin());
1006   } else if (TM.getCodeModel() == CodeModel::Large) {
1007     BuildMI(MBB, MI, DL, get(AArch64::MOVZXi), Reg)
1008         .addGlobalAddress(GV, 0, AArch64II::MO_G3).addImm(48);
1009     BuildMI(MBB, MI, DL, get(AArch64::MOVKXi), Reg)
1010         .addReg(Reg, RegState::Kill)
1011         .addGlobalAddress(GV, 0, AArch64II::MO_G2 | MO_NC).addImm(32);
1012     BuildMI(MBB, MI, DL, get(AArch64::MOVKXi), Reg)
1013         .addReg(Reg, RegState::Kill)
1014         .addGlobalAddress(GV, 0, AArch64II::MO_G1 | MO_NC).addImm(16);
1015     BuildMI(MBB, MI, DL, get(AArch64::MOVKXi), Reg)
1016         .addReg(Reg, RegState::Kill)
1017         .addGlobalAddress(GV, 0, AArch64II::MO_G0 | MO_NC).addImm(0);
1018     BuildMI(MBB, MI, DL, get(AArch64::LDRXui), Reg)
1019         .addReg(Reg, RegState::Kill).addImm(0)
1020         .addMemOperand(*MI->memoperands_begin());
1021   } else {
1022     BuildMI(MBB, MI, DL, get(AArch64::ADRP), Reg)
1023         .addGlobalAddress(GV, 0, OpFlags | AArch64II::MO_PAGE);
1024     unsigned char LoFlags = OpFlags | AArch64II::MO_PAGEOFF | MO_NC;
1025     BuildMI(MBB, MI, DL, get(AArch64::LDRXui), Reg)
1026         .addReg(Reg, RegState::Kill)
1027         .addGlobalAddress(GV, 0, LoFlags)
1028         .addMemOperand(*MI->memoperands_begin());
1029   }
1030 
1031   MBB.erase(MI);
1032 
1033   return true;
1034 }
1035 
1036 /// Return true if this is this instruction has a non-zero immediate
1037 bool AArch64InstrInfo::hasShiftedReg(const MachineInstr *MI) const {
1038   switch (MI->getOpcode()) {
1039   default:
1040     break;
1041   case AArch64::ADDSWrs:
1042   case AArch64::ADDSXrs:
1043   case AArch64::ADDWrs:
1044   case AArch64::ADDXrs:
1045   case AArch64::ANDSWrs:
1046   case AArch64::ANDSXrs:
1047   case AArch64::ANDWrs:
1048   case AArch64::ANDXrs:
1049   case AArch64::BICSWrs:
1050   case AArch64::BICSXrs:
1051   case AArch64::BICWrs:
1052   case AArch64::BICXrs:
1053   case AArch64::CRC32Brr:
1054   case AArch64::CRC32CBrr:
1055   case AArch64::CRC32CHrr:
1056   case AArch64::CRC32CWrr:
1057   case AArch64::CRC32CXrr:
1058   case AArch64::CRC32Hrr:
1059   case AArch64::CRC32Wrr:
1060   case AArch64::CRC32Xrr:
1061   case AArch64::EONWrs:
1062   case AArch64::EONXrs:
1063   case AArch64::EORWrs:
1064   case AArch64::EORXrs:
1065   case AArch64::ORNWrs:
1066   case AArch64::ORNXrs:
1067   case AArch64::ORRWrs:
1068   case AArch64::ORRXrs:
1069   case AArch64::SUBSWrs:
1070   case AArch64::SUBSXrs:
1071   case AArch64::SUBWrs:
1072   case AArch64::SUBXrs:
1073     if (MI->getOperand(3).isImm()) {
1074       unsigned val = MI->getOperand(3).getImm();
1075       return (val != 0);
1076     }
1077     break;
1078   }
1079   return false;
1080 }
1081 
1082 /// Return true if this is this instruction has a non-zero immediate
1083 bool AArch64InstrInfo::hasExtendedReg(const MachineInstr *MI) const {
1084   switch (MI->getOpcode()) {
1085   default:
1086     break;
1087   case AArch64::ADDSWrx:
1088   case AArch64::ADDSXrx:
1089   case AArch64::ADDSXrx64:
1090   case AArch64::ADDWrx:
1091   case AArch64::ADDXrx:
1092   case AArch64::ADDXrx64:
1093   case AArch64::SUBSWrx:
1094   case AArch64::SUBSXrx:
1095   case AArch64::SUBSXrx64:
1096   case AArch64::SUBWrx:
1097   case AArch64::SUBXrx:
1098   case AArch64::SUBXrx64:
1099     if (MI->getOperand(3).isImm()) {
1100       unsigned val = MI->getOperand(3).getImm();
1101       return (val != 0);
1102     }
1103     break;
1104   }
1105 
1106   return false;
1107 }
1108 
1109 // Return true if this instruction simply sets its single destination register
1110 // to zero. This is equivalent to a register rename of the zero-register.
1111 bool AArch64InstrInfo::isGPRZero(const MachineInstr *MI) const {
1112   switch (MI->getOpcode()) {
1113   default:
1114     break;
1115   case AArch64::MOVZWi:
1116   case AArch64::MOVZXi: // movz Rd, #0 (LSL #0)
1117     if (MI->getOperand(1).isImm() && MI->getOperand(1).getImm() == 0) {
1118       assert(MI->getDesc().getNumOperands() == 3 &&
1119              MI->getOperand(2).getImm() == 0 && "invalid MOVZi operands");
1120       return true;
1121     }
1122     break;
1123   case AArch64::ANDWri: // and Rd, Rzr, #imm
1124     return MI->getOperand(1).getReg() == AArch64::WZR;
1125   case AArch64::ANDXri:
1126     return MI->getOperand(1).getReg() == AArch64::XZR;
1127   case TargetOpcode::COPY:
1128     return MI->getOperand(1).getReg() == AArch64::WZR;
1129   }
1130   return false;
1131 }
1132 
1133 // Return true if this instruction simply renames a general register without
1134 // modifying bits.
1135 bool AArch64InstrInfo::isGPRCopy(const MachineInstr *MI) const {
1136   switch (MI->getOpcode()) {
1137   default:
1138     break;
1139   case TargetOpcode::COPY: {
1140     // GPR32 copies will by lowered to ORRXrs
1141     unsigned DstReg = MI->getOperand(0).getReg();
1142     return (AArch64::GPR32RegClass.contains(DstReg) ||
1143             AArch64::GPR64RegClass.contains(DstReg));
1144   }
1145   case AArch64::ORRXrs: // orr Xd, Xzr, Xm (LSL #0)
1146     if (MI->getOperand(1).getReg() == AArch64::XZR) {
1147       assert(MI->getDesc().getNumOperands() == 4 &&
1148              MI->getOperand(3).getImm() == 0 && "invalid ORRrs operands");
1149       return true;
1150     }
1151     break;
1152   case AArch64::ADDXri: // add Xd, Xn, #0 (LSL #0)
1153     if (MI->getOperand(2).getImm() == 0) {
1154       assert(MI->getDesc().getNumOperands() == 4 &&
1155              MI->getOperand(3).getImm() == 0 && "invalid ADDXri operands");
1156       return true;
1157     }
1158     break;
1159   }
1160   return false;
1161 }
1162 
1163 // Return true if this instruction simply renames a general register without
1164 // modifying bits.
1165 bool AArch64InstrInfo::isFPRCopy(const MachineInstr *MI) const {
1166   switch (MI->getOpcode()) {
1167   default:
1168     break;
1169   case TargetOpcode::COPY: {
1170     // FPR64 copies will by lowered to ORR.16b
1171     unsigned DstReg = MI->getOperand(0).getReg();
1172     return (AArch64::FPR64RegClass.contains(DstReg) ||
1173             AArch64::FPR128RegClass.contains(DstReg));
1174   }
1175   case AArch64::ORRv16i8:
1176     if (MI->getOperand(1).getReg() == MI->getOperand(2).getReg()) {
1177       assert(MI->getDesc().getNumOperands() == 3 && MI->getOperand(0).isReg() &&
1178              "invalid ORRv16i8 operands");
1179       return true;
1180     }
1181     break;
1182   }
1183   return false;
1184 }
1185 
1186 unsigned AArch64InstrInfo::isLoadFromStackSlot(const MachineInstr *MI,
1187                                                int &FrameIndex) const {
1188   switch (MI->getOpcode()) {
1189   default:
1190     break;
1191   case AArch64::LDRWui:
1192   case AArch64::LDRXui:
1193   case AArch64::LDRBui:
1194   case AArch64::LDRHui:
1195   case AArch64::LDRSui:
1196   case AArch64::LDRDui:
1197   case AArch64::LDRQui:
1198     if (MI->getOperand(0).getSubReg() == 0 && MI->getOperand(1).isFI() &&
1199         MI->getOperand(2).isImm() && MI->getOperand(2).getImm() == 0) {
1200       FrameIndex = MI->getOperand(1).getIndex();
1201       return MI->getOperand(0).getReg();
1202     }
1203     break;
1204   }
1205 
1206   return 0;
1207 }
1208 
1209 unsigned AArch64InstrInfo::isStoreToStackSlot(const MachineInstr *MI,
1210                                               int &FrameIndex) const {
1211   switch (MI->getOpcode()) {
1212   default:
1213     break;
1214   case AArch64::STRWui:
1215   case AArch64::STRXui:
1216   case AArch64::STRBui:
1217   case AArch64::STRHui:
1218   case AArch64::STRSui:
1219   case AArch64::STRDui:
1220   case AArch64::STRQui:
1221     if (MI->getOperand(0).getSubReg() == 0 && MI->getOperand(1).isFI() &&
1222         MI->getOperand(2).isImm() && MI->getOperand(2).getImm() == 0) {
1223       FrameIndex = MI->getOperand(1).getIndex();
1224       return MI->getOperand(0).getReg();
1225     }
1226     break;
1227   }
1228   return 0;
1229 }
1230 
1231 /// Return true if this is load/store scales or extends its register offset.
1232 /// This refers to scaling a dynamic index as opposed to scaled immediates.
1233 /// MI should be a memory op that allows scaled addressing.
1234 bool AArch64InstrInfo::isScaledAddr(const MachineInstr *MI) const {
1235   switch (MI->getOpcode()) {
1236   default:
1237     break;
1238   case AArch64::LDRBBroW:
1239   case AArch64::LDRBroW:
1240   case AArch64::LDRDroW:
1241   case AArch64::LDRHHroW:
1242   case AArch64::LDRHroW:
1243   case AArch64::LDRQroW:
1244   case AArch64::LDRSBWroW:
1245   case AArch64::LDRSBXroW:
1246   case AArch64::LDRSHWroW:
1247   case AArch64::LDRSHXroW:
1248   case AArch64::LDRSWroW:
1249   case AArch64::LDRSroW:
1250   case AArch64::LDRWroW:
1251   case AArch64::LDRXroW:
1252   case AArch64::STRBBroW:
1253   case AArch64::STRBroW:
1254   case AArch64::STRDroW:
1255   case AArch64::STRHHroW:
1256   case AArch64::STRHroW:
1257   case AArch64::STRQroW:
1258   case AArch64::STRSroW:
1259   case AArch64::STRWroW:
1260   case AArch64::STRXroW:
1261   case AArch64::LDRBBroX:
1262   case AArch64::LDRBroX:
1263   case AArch64::LDRDroX:
1264   case AArch64::LDRHHroX:
1265   case AArch64::LDRHroX:
1266   case AArch64::LDRQroX:
1267   case AArch64::LDRSBWroX:
1268   case AArch64::LDRSBXroX:
1269   case AArch64::LDRSHWroX:
1270   case AArch64::LDRSHXroX:
1271   case AArch64::LDRSWroX:
1272   case AArch64::LDRSroX:
1273   case AArch64::LDRWroX:
1274   case AArch64::LDRXroX:
1275   case AArch64::STRBBroX:
1276   case AArch64::STRBroX:
1277   case AArch64::STRDroX:
1278   case AArch64::STRHHroX:
1279   case AArch64::STRHroX:
1280   case AArch64::STRQroX:
1281   case AArch64::STRSroX:
1282   case AArch64::STRWroX:
1283   case AArch64::STRXroX:
1284 
1285     unsigned Val = MI->getOperand(3).getImm();
1286     AArch64_AM::ShiftExtendType ExtType = AArch64_AM::getMemExtendType(Val);
1287     return (ExtType != AArch64_AM::UXTX) || AArch64_AM::getMemDoShift(Val);
1288   }
1289   return false;
1290 }
1291 
1292 /// Check all MachineMemOperands for a hint to suppress pairing.
1293 bool AArch64InstrInfo::isLdStPairSuppressed(const MachineInstr *MI) const {
1294   assert(MOSuppressPair < (1 << MachineMemOperand::MOTargetNumBits) &&
1295          "Too many target MO flags");
1296   for (auto *MM : MI->memoperands()) {
1297     if (MM->getFlags() &
1298         (MOSuppressPair << MachineMemOperand::MOTargetStartBit)) {
1299       return true;
1300     }
1301   }
1302   return false;
1303 }
1304 
1305 /// Set a flag on the first MachineMemOperand to suppress pairing.
1306 void AArch64InstrInfo::suppressLdStPair(MachineInstr *MI) const {
1307   if (MI->memoperands_empty())
1308     return;
1309 
1310   assert(MOSuppressPair < (1 << MachineMemOperand::MOTargetNumBits) &&
1311          "Too many target MO flags");
1312   (*MI->memoperands_begin())
1313       ->setFlags(MOSuppressPair << MachineMemOperand::MOTargetStartBit);
1314 }
1315 
1316 bool
1317 AArch64InstrInfo::getMemOpBaseRegImmOfs(MachineInstr *LdSt, unsigned &BaseReg,
1318                                         unsigned &Offset,
1319                                         const TargetRegisterInfo *TRI) const {
1320   switch (LdSt->getOpcode()) {
1321   default:
1322     return false;
1323   case AArch64::STRSui:
1324   case AArch64::STRDui:
1325   case AArch64::STRQui:
1326   case AArch64::STRXui:
1327   case AArch64::STRWui:
1328   case AArch64::LDRSui:
1329   case AArch64::LDRDui:
1330   case AArch64::LDRQui:
1331   case AArch64::LDRXui:
1332   case AArch64::LDRWui:
1333     if (!LdSt->getOperand(1).isReg() || !LdSt->getOperand(2).isImm())
1334       return false;
1335     BaseReg = LdSt->getOperand(1).getReg();
1336     MachineFunction &MF = *LdSt->getParent()->getParent();
1337     unsigned Width = getRegClass(LdSt->getDesc(), 0, TRI, MF)->getSize();
1338     Offset = LdSt->getOperand(2).getImm() * Width;
1339     return true;
1340   };
1341 }
1342 
1343 bool AArch64InstrInfo::getMemOpBaseRegImmOfsWidth(
1344     MachineInstr *LdSt, unsigned &BaseReg, int &Offset, int &Width,
1345     const TargetRegisterInfo *TRI) const {
1346   // Handle only loads/stores with base register followed by immediate offset.
1347   if (LdSt->getNumOperands() != 3)
1348     return false;
1349   if (!LdSt->getOperand(1).isReg() || !LdSt->getOperand(2).isImm())
1350     return false;
1351 
1352   // Offset is calculated as the immediate operand multiplied by the scaling factor.
1353   // Unscaled instructions have scaling factor set to 1.
1354   int Scale = 0;
1355   switch (LdSt->getOpcode()) {
1356   default:
1357     return false;
1358   case AArch64::LDURQi:
1359   case AArch64::STURQi:
1360     Width = 16;
1361     Scale = 1;
1362     break;
1363   case AArch64::LDURXi:
1364   case AArch64::LDURDi:
1365   case AArch64::STURXi:
1366   case AArch64::STURDi:
1367     Width = 8;
1368     Scale = 1;
1369     break;
1370   case AArch64::LDURWi:
1371   case AArch64::LDURSi:
1372   case AArch64::LDURSWi:
1373   case AArch64::STURWi:
1374   case AArch64::STURSi:
1375     Width = 4;
1376     Scale = 1;
1377     break;
1378   case AArch64::LDURHi:
1379   case AArch64::LDURHHi:
1380   case AArch64::LDURSHXi:
1381   case AArch64::LDURSHWi:
1382   case AArch64::STURHi:
1383   case AArch64::STURHHi:
1384     Width = 2;
1385     Scale = 1;
1386     break;
1387   case AArch64::LDURBi:
1388   case AArch64::LDURBBi:
1389   case AArch64::LDURSBXi:
1390   case AArch64::LDURSBWi:
1391   case AArch64::STURBi:
1392   case AArch64::STURBBi:
1393     Width = 1;
1394     Scale = 1;
1395     break;
1396   case AArch64::LDRQui:
1397   case AArch64::STRQui:
1398     Scale = Width = 16;
1399     break;
1400   case AArch64::LDRXui:
1401   case AArch64::LDRDui:
1402   case AArch64::STRXui:
1403   case AArch64::STRDui:
1404     Scale = Width = 8;
1405     break;
1406   case AArch64::LDRWui:
1407   case AArch64::LDRSui:
1408   case AArch64::STRWui:
1409   case AArch64::STRSui:
1410     Scale = Width = 4;
1411     break;
1412   case AArch64::LDRHui:
1413   case AArch64::LDRHHui:
1414   case AArch64::STRHui:
1415   case AArch64::STRHHui:
1416     Scale = Width = 2;
1417     break;
1418   case AArch64::LDRBui:
1419   case AArch64::LDRBBui:
1420   case AArch64::STRBui:
1421   case AArch64::STRBBui:
1422     Scale = Width = 1;
1423     break;
1424   }
1425 
1426   BaseReg = LdSt->getOperand(1).getReg();
1427   Offset = LdSt->getOperand(2).getImm() * Scale;
1428   return true;
1429 }
1430 
1431 /// Detect opportunities for ldp/stp formation.
1432 ///
1433 /// Only called for LdSt for which getMemOpBaseRegImmOfs returns true.
1434 bool AArch64InstrInfo::shouldClusterLoads(MachineInstr *FirstLdSt,
1435                                           MachineInstr *SecondLdSt,
1436                                           unsigned NumLoads) const {
1437   // Only cluster up to a single pair.
1438   if (NumLoads > 1)
1439     return false;
1440   if (FirstLdSt->getOpcode() != SecondLdSt->getOpcode())
1441     return false;
1442   // getMemOpBaseRegImmOfs guarantees that oper 2 isImm.
1443   unsigned Ofs1 = FirstLdSt->getOperand(2).getImm();
1444   // Allow 6 bits of positive range.
1445   if (Ofs1 > 64)
1446     return false;
1447   // The caller should already have ordered First/SecondLdSt by offset.
1448   unsigned Ofs2 = SecondLdSt->getOperand(2).getImm();
1449   return Ofs1 + 1 == Ofs2;
1450 }
1451 
1452 bool AArch64InstrInfo::shouldScheduleAdjacent(MachineInstr *First,
1453                                               MachineInstr *Second) const {
1454   if (Subtarget.isCyclone()) {
1455     // Cyclone can fuse CMN, CMP, TST followed by Bcc.
1456     unsigned SecondOpcode = Second->getOpcode();
1457     if (SecondOpcode == AArch64::Bcc) {
1458       switch (First->getOpcode()) {
1459       default:
1460         return false;
1461       case AArch64::SUBSWri:
1462       case AArch64::ADDSWri:
1463       case AArch64::ANDSWri:
1464       case AArch64::SUBSXri:
1465       case AArch64::ADDSXri:
1466       case AArch64::ANDSXri:
1467         return true;
1468       }
1469     }
1470     // Cyclone B0 also supports ALU operations followed by CBZ/CBNZ.
1471     if (SecondOpcode == AArch64::CBNZW || SecondOpcode == AArch64::CBNZX ||
1472         SecondOpcode == AArch64::CBZW || SecondOpcode == AArch64::CBZX) {
1473       switch (First->getOpcode()) {
1474       default:
1475         return false;
1476       case AArch64::ADDWri:
1477       case AArch64::ADDXri:
1478       case AArch64::ANDWri:
1479       case AArch64::ANDXri:
1480       case AArch64::EORWri:
1481       case AArch64::EORXri:
1482       case AArch64::ORRWri:
1483       case AArch64::ORRXri:
1484       case AArch64::SUBWri:
1485       case AArch64::SUBXri:
1486         return true;
1487       }
1488     }
1489   }
1490   return false;
1491 }
1492 
1493 MachineInstr *AArch64InstrInfo::emitFrameIndexDebugValue(
1494     MachineFunction &MF, int FrameIx, uint64_t Offset, const MDNode *Var,
1495     const MDNode *Expr, DebugLoc DL) const {
1496   MachineInstrBuilder MIB = BuildMI(MF, DL, get(AArch64::DBG_VALUE))
1497                                 .addFrameIndex(FrameIx)
1498                                 .addImm(0)
1499                                 .addImm(Offset)
1500                                 .addMetadata(Var)
1501                                 .addMetadata(Expr);
1502   return &*MIB;
1503 }
1504 
1505 static const MachineInstrBuilder &AddSubReg(const MachineInstrBuilder &MIB,
1506                                             unsigned Reg, unsigned SubIdx,
1507                                             unsigned State,
1508                                             const TargetRegisterInfo *TRI) {
1509   if (!SubIdx)
1510     return MIB.addReg(Reg, State);
1511 
1512   if (TargetRegisterInfo::isPhysicalRegister(Reg))
1513     return MIB.addReg(TRI->getSubReg(Reg, SubIdx), State);
1514   return MIB.addReg(Reg, State, SubIdx);
1515 }
1516 
1517 static bool forwardCopyWillClobberTuple(unsigned DestReg, unsigned SrcReg,
1518                                         unsigned NumRegs) {
1519   // We really want the positive remainder mod 32 here, that happens to be
1520   // easily obtainable with a mask.
1521   return ((DestReg - SrcReg) & 0x1f) < NumRegs;
1522 }
1523 
1524 void AArch64InstrInfo::copyPhysRegTuple(
1525     MachineBasicBlock &MBB, MachineBasicBlock::iterator I, DebugLoc DL,
1526     unsigned DestReg, unsigned SrcReg, bool KillSrc, unsigned Opcode,
1527     llvm::ArrayRef<unsigned> Indices) const {
1528   assert(Subtarget.hasNEON() &&
1529          "Unexpected register copy without NEON");
1530   const TargetRegisterInfo *TRI = &getRegisterInfo();
1531   uint16_t DestEncoding = TRI->getEncodingValue(DestReg);
1532   uint16_t SrcEncoding = TRI->getEncodingValue(SrcReg);
1533   unsigned NumRegs = Indices.size();
1534 
1535   int SubReg = 0, End = NumRegs, Incr = 1;
1536   if (forwardCopyWillClobberTuple(DestEncoding, SrcEncoding, NumRegs)) {
1537     SubReg = NumRegs - 1;
1538     End = -1;
1539     Incr = -1;
1540   }
1541 
1542   for (; SubReg != End; SubReg += Incr) {
1543     const MachineInstrBuilder MIB = BuildMI(MBB, I, DL, get(Opcode));
1544     AddSubReg(MIB, DestReg, Indices[SubReg], RegState::Define, TRI);
1545     AddSubReg(MIB, SrcReg, Indices[SubReg], 0, TRI);
1546     AddSubReg(MIB, SrcReg, Indices[SubReg], getKillRegState(KillSrc), TRI);
1547   }
1548 }
1549 
1550 void AArch64InstrInfo::copyPhysReg(MachineBasicBlock &MBB,
1551                                    MachineBasicBlock::iterator I, DebugLoc DL,
1552                                    unsigned DestReg, unsigned SrcReg,
1553                                    bool KillSrc) const {
1554   if (AArch64::GPR32spRegClass.contains(DestReg) &&
1555       (AArch64::GPR32spRegClass.contains(SrcReg) || SrcReg == AArch64::WZR)) {
1556     const TargetRegisterInfo *TRI = &getRegisterInfo();
1557 
1558     if (DestReg == AArch64::WSP || SrcReg == AArch64::WSP) {
1559       // If either operand is WSP, expand to ADD #0.
1560       if (Subtarget.hasZeroCycleRegMove()) {
1561         // Cyclone recognizes "ADD Xd, Xn, #0" as a zero-cycle register move.
1562         unsigned DestRegX = TRI->getMatchingSuperReg(DestReg, AArch64::sub_32,
1563                                                      &AArch64::GPR64spRegClass);
1564         unsigned SrcRegX = TRI->getMatchingSuperReg(SrcReg, AArch64::sub_32,
1565                                                     &AArch64::GPR64spRegClass);
1566         // This instruction is reading and writing X registers.  This may upset
1567         // the register scavenger and machine verifier, so we need to indicate
1568         // that we are reading an undefined value from SrcRegX, but a proper
1569         // value from SrcReg.
1570         BuildMI(MBB, I, DL, get(AArch64::ADDXri), DestRegX)
1571             .addReg(SrcRegX, RegState::Undef)
1572             .addImm(0)
1573             .addImm(AArch64_AM::getShifterImm(AArch64_AM::LSL, 0))
1574             .addReg(SrcReg, RegState::Implicit | getKillRegState(KillSrc));
1575       } else {
1576         BuildMI(MBB, I, DL, get(AArch64::ADDWri), DestReg)
1577             .addReg(SrcReg, getKillRegState(KillSrc))
1578             .addImm(0)
1579             .addImm(AArch64_AM::getShifterImm(AArch64_AM::LSL, 0));
1580       }
1581     } else if (SrcReg == AArch64::WZR && Subtarget.hasZeroCycleZeroing()) {
1582       BuildMI(MBB, I, DL, get(AArch64::MOVZWi), DestReg).addImm(0).addImm(
1583           AArch64_AM::getShifterImm(AArch64_AM::LSL, 0));
1584     } else {
1585       if (Subtarget.hasZeroCycleRegMove()) {
1586         // Cyclone recognizes "ORR Xd, XZR, Xm" as a zero-cycle register move.
1587         unsigned DestRegX = TRI->getMatchingSuperReg(DestReg, AArch64::sub_32,
1588                                                      &AArch64::GPR64spRegClass);
1589         unsigned SrcRegX = TRI->getMatchingSuperReg(SrcReg, AArch64::sub_32,
1590                                                     &AArch64::GPR64spRegClass);
1591         // This instruction is reading and writing X registers.  This may upset
1592         // the register scavenger and machine verifier, so we need to indicate
1593         // that we are reading an undefined value from SrcRegX, but a proper
1594         // value from SrcReg.
1595         BuildMI(MBB, I, DL, get(AArch64::ORRXrr), DestRegX)
1596             .addReg(AArch64::XZR)
1597             .addReg(SrcRegX, RegState::Undef)
1598             .addReg(SrcReg, RegState::Implicit | getKillRegState(KillSrc));
1599       } else {
1600         // Otherwise, expand to ORR WZR.
1601         BuildMI(MBB, I, DL, get(AArch64::ORRWrr), DestReg)
1602             .addReg(AArch64::WZR)
1603             .addReg(SrcReg, getKillRegState(KillSrc));
1604       }
1605     }
1606     return;
1607   }
1608 
1609   if (AArch64::GPR64spRegClass.contains(DestReg) &&
1610       (AArch64::GPR64spRegClass.contains(SrcReg) || SrcReg == AArch64::XZR)) {
1611     if (DestReg == AArch64::SP || SrcReg == AArch64::SP) {
1612       // If either operand is SP, expand to ADD #0.
1613       BuildMI(MBB, I, DL, get(AArch64::ADDXri), DestReg)
1614           .addReg(SrcReg, getKillRegState(KillSrc))
1615           .addImm(0)
1616           .addImm(AArch64_AM::getShifterImm(AArch64_AM::LSL, 0));
1617     } else if (SrcReg == AArch64::XZR && Subtarget.hasZeroCycleZeroing()) {
1618       BuildMI(MBB, I, DL, get(AArch64::MOVZXi), DestReg).addImm(0).addImm(
1619           AArch64_AM::getShifterImm(AArch64_AM::LSL, 0));
1620     } else {
1621       // Otherwise, expand to ORR XZR.
1622       BuildMI(MBB, I, DL, get(AArch64::ORRXrr), DestReg)
1623           .addReg(AArch64::XZR)
1624           .addReg(SrcReg, getKillRegState(KillSrc));
1625     }
1626     return;
1627   }
1628 
1629   // Copy a DDDD register quad by copying the individual sub-registers.
1630   if (AArch64::DDDDRegClass.contains(DestReg) &&
1631       AArch64::DDDDRegClass.contains(SrcReg)) {
1632     static const unsigned Indices[] = { AArch64::dsub0, AArch64::dsub1,
1633                                         AArch64::dsub2, AArch64::dsub3 };
1634     copyPhysRegTuple(MBB, I, DL, DestReg, SrcReg, KillSrc, AArch64::ORRv8i8,
1635                      Indices);
1636     return;
1637   }
1638 
1639   // Copy a DDD register triple by copying the individual sub-registers.
1640   if (AArch64::DDDRegClass.contains(DestReg) &&
1641       AArch64::DDDRegClass.contains(SrcReg)) {
1642     static const unsigned Indices[] = { AArch64::dsub0, AArch64::dsub1,
1643                                         AArch64::dsub2 };
1644     copyPhysRegTuple(MBB, I, DL, DestReg, SrcReg, KillSrc, AArch64::ORRv8i8,
1645                      Indices);
1646     return;
1647   }
1648 
1649   // Copy a DD register pair by copying the individual sub-registers.
1650   if (AArch64::DDRegClass.contains(DestReg) &&
1651       AArch64::DDRegClass.contains(SrcReg)) {
1652     static const unsigned Indices[] = { AArch64::dsub0, AArch64::dsub1 };
1653     copyPhysRegTuple(MBB, I, DL, DestReg, SrcReg, KillSrc, AArch64::ORRv8i8,
1654                      Indices);
1655     return;
1656   }
1657 
1658   // Copy a QQQQ register quad by copying the individual sub-registers.
1659   if (AArch64::QQQQRegClass.contains(DestReg) &&
1660       AArch64::QQQQRegClass.contains(SrcReg)) {
1661     static const unsigned Indices[] = { AArch64::qsub0, AArch64::qsub1,
1662                                         AArch64::qsub2, AArch64::qsub3 };
1663     copyPhysRegTuple(MBB, I, DL, DestReg, SrcReg, KillSrc, AArch64::ORRv16i8,
1664                      Indices);
1665     return;
1666   }
1667 
1668   // Copy a QQQ register triple by copying the individual sub-registers.
1669   if (AArch64::QQQRegClass.contains(DestReg) &&
1670       AArch64::QQQRegClass.contains(SrcReg)) {
1671     static const unsigned Indices[] = { AArch64::qsub0, AArch64::qsub1,
1672                                         AArch64::qsub2 };
1673     copyPhysRegTuple(MBB, I, DL, DestReg, SrcReg, KillSrc, AArch64::ORRv16i8,
1674                      Indices);
1675     return;
1676   }
1677 
1678   // Copy a QQ register pair by copying the individual sub-registers.
1679   if (AArch64::QQRegClass.contains(DestReg) &&
1680       AArch64::QQRegClass.contains(SrcReg)) {
1681     static const unsigned Indices[] = { AArch64::qsub0, AArch64::qsub1 };
1682     copyPhysRegTuple(MBB, I, DL, DestReg, SrcReg, KillSrc, AArch64::ORRv16i8,
1683                      Indices);
1684     return;
1685   }
1686 
1687   if (AArch64::FPR128RegClass.contains(DestReg) &&
1688       AArch64::FPR128RegClass.contains(SrcReg)) {
1689     if(Subtarget.hasNEON()) {
1690       BuildMI(MBB, I, DL, get(AArch64::ORRv16i8), DestReg)
1691           .addReg(SrcReg)
1692           .addReg(SrcReg, getKillRegState(KillSrc));
1693     } else {
1694       BuildMI(MBB, I, DL, get(AArch64::STRQpre))
1695         .addReg(AArch64::SP, RegState::Define)
1696         .addReg(SrcReg, getKillRegState(KillSrc))
1697         .addReg(AArch64::SP)
1698         .addImm(-16);
1699       BuildMI(MBB, I, DL, get(AArch64::LDRQpre))
1700         .addReg(AArch64::SP, RegState::Define)
1701         .addReg(DestReg, RegState::Define)
1702         .addReg(AArch64::SP)
1703         .addImm(16);
1704     }
1705     return;
1706   }
1707 
1708   if (AArch64::FPR64RegClass.contains(DestReg) &&
1709       AArch64::FPR64RegClass.contains(SrcReg)) {
1710     if(Subtarget.hasNEON()) {
1711       DestReg = RI.getMatchingSuperReg(DestReg, AArch64::dsub,
1712                                        &AArch64::FPR128RegClass);
1713       SrcReg = RI.getMatchingSuperReg(SrcReg, AArch64::dsub,
1714                                       &AArch64::FPR128RegClass);
1715       BuildMI(MBB, I, DL, get(AArch64::ORRv16i8), DestReg)
1716           .addReg(SrcReg)
1717           .addReg(SrcReg, getKillRegState(KillSrc));
1718     } else {
1719       BuildMI(MBB, I, DL, get(AArch64::FMOVDr), DestReg)
1720           .addReg(SrcReg, getKillRegState(KillSrc));
1721     }
1722     return;
1723   }
1724 
1725   if (AArch64::FPR32RegClass.contains(DestReg) &&
1726       AArch64::FPR32RegClass.contains(SrcReg)) {
1727     if(Subtarget.hasNEON()) {
1728       DestReg = RI.getMatchingSuperReg(DestReg, AArch64::ssub,
1729                                        &AArch64::FPR128RegClass);
1730       SrcReg = RI.getMatchingSuperReg(SrcReg, AArch64::ssub,
1731                                       &AArch64::FPR128RegClass);
1732       BuildMI(MBB, I, DL, get(AArch64::ORRv16i8), DestReg)
1733           .addReg(SrcReg)
1734           .addReg(SrcReg, getKillRegState(KillSrc));
1735     } else {
1736       BuildMI(MBB, I, DL, get(AArch64::FMOVSr), DestReg)
1737           .addReg(SrcReg, getKillRegState(KillSrc));
1738     }
1739     return;
1740   }
1741 
1742   if (AArch64::FPR16RegClass.contains(DestReg) &&
1743       AArch64::FPR16RegClass.contains(SrcReg)) {
1744     if(Subtarget.hasNEON()) {
1745       DestReg = RI.getMatchingSuperReg(DestReg, AArch64::hsub,
1746                                        &AArch64::FPR128RegClass);
1747       SrcReg = RI.getMatchingSuperReg(SrcReg, AArch64::hsub,
1748                                       &AArch64::FPR128RegClass);
1749       BuildMI(MBB, I, DL, get(AArch64::ORRv16i8), DestReg)
1750           .addReg(SrcReg)
1751           .addReg(SrcReg, getKillRegState(KillSrc));
1752     } else {
1753       DestReg = RI.getMatchingSuperReg(DestReg, AArch64::hsub,
1754                                        &AArch64::FPR32RegClass);
1755       SrcReg = RI.getMatchingSuperReg(SrcReg, AArch64::hsub,
1756                                       &AArch64::FPR32RegClass);
1757       BuildMI(MBB, I, DL, get(AArch64::FMOVSr), DestReg)
1758           .addReg(SrcReg, getKillRegState(KillSrc));
1759     }
1760     return;
1761   }
1762 
1763   if (AArch64::FPR8RegClass.contains(DestReg) &&
1764       AArch64::FPR8RegClass.contains(SrcReg)) {
1765     if(Subtarget.hasNEON()) {
1766       DestReg = RI.getMatchingSuperReg(DestReg, AArch64::bsub,
1767                                        &AArch64::FPR128RegClass);
1768       SrcReg = RI.getMatchingSuperReg(SrcReg, AArch64::bsub,
1769                                       &AArch64::FPR128RegClass);
1770       BuildMI(MBB, I, DL, get(AArch64::ORRv16i8), DestReg)
1771           .addReg(SrcReg)
1772           .addReg(SrcReg, getKillRegState(KillSrc));
1773     } else {
1774       DestReg = RI.getMatchingSuperReg(DestReg, AArch64::bsub,
1775                                        &AArch64::FPR32RegClass);
1776       SrcReg = RI.getMatchingSuperReg(SrcReg, AArch64::bsub,
1777                                       &AArch64::FPR32RegClass);
1778       BuildMI(MBB, I, DL, get(AArch64::FMOVSr), DestReg)
1779           .addReg(SrcReg, getKillRegState(KillSrc));
1780     }
1781     return;
1782   }
1783 
1784   // Copies between GPR64 and FPR64.
1785   if (AArch64::FPR64RegClass.contains(DestReg) &&
1786       AArch64::GPR64RegClass.contains(SrcReg)) {
1787     BuildMI(MBB, I, DL, get(AArch64::FMOVXDr), DestReg)
1788         .addReg(SrcReg, getKillRegState(KillSrc));
1789     return;
1790   }
1791   if (AArch64::GPR64RegClass.contains(DestReg) &&
1792       AArch64::FPR64RegClass.contains(SrcReg)) {
1793     BuildMI(MBB, I, DL, get(AArch64::FMOVDXr), DestReg)
1794         .addReg(SrcReg, getKillRegState(KillSrc));
1795     return;
1796   }
1797   // Copies between GPR32 and FPR32.
1798   if (AArch64::FPR32RegClass.contains(DestReg) &&
1799       AArch64::GPR32RegClass.contains(SrcReg)) {
1800     BuildMI(MBB, I, DL, get(AArch64::FMOVWSr), DestReg)
1801         .addReg(SrcReg, getKillRegState(KillSrc));
1802     return;
1803   }
1804   if (AArch64::GPR32RegClass.contains(DestReg) &&
1805       AArch64::FPR32RegClass.contains(SrcReg)) {
1806     BuildMI(MBB, I, DL, get(AArch64::FMOVSWr), DestReg)
1807         .addReg(SrcReg, getKillRegState(KillSrc));
1808     return;
1809   }
1810 
1811   if (DestReg == AArch64::NZCV) {
1812     assert(AArch64::GPR64RegClass.contains(SrcReg) && "Invalid NZCV copy");
1813     BuildMI(MBB, I, DL, get(AArch64::MSR))
1814       .addImm(AArch64SysReg::NZCV)
1815       .addReg(SrcReg, getKillRegState(KillSrc))
1816       .addReg(AArch64::NZCV, RegState::Implicit | RegState::Define);
1817     return;
1818   }
1819 
1820   if (SrcReg == AArch64::NZCV) {
1821     assert(AArch64::GPR64RegClass.contains(DestReg) && "Invalid NZCV copy");
1822     BuildMI(MBB, I, DL, get(AArch64::MRS))
1823       .addReg(DestReg)
1824       .addImm(AArch64SysReg::NZCV)
1825       .addReg(AArch64::NZCV, RegState::Implicit | getKillRegState(KillSrc));
1826     return;
1827   }
1828 
1829   llvm_unreachable("unimplemented reg-to-reg copy");
1830 }
1831 
1832 void AArch64InstrInfo::storeRegToStackSlot(
1833     MachineBasicBlock &MBB, MachineBasicBlock::iterator MBBI, unsigned SrcReg,
1834     bool isKill, int FI, const TargetRegisterClass *RC,
1835     const TargetRegisterInfo *TRI) const {
1836   DebugLoc DL;
1837   if (MBBI != MBB.end())
1838     DL = MBBI->getDebugLoc();
1839   MachineFunction &MF = *MBB.getParent();
1840   MachineFrameInfo &MFI = *MF.getFrameInfo();
1841   unsigned Align = MFI.getObjectAlignment(FI);
1842 
1843   MachinePointerInfo PtrInfo = MachinePointerInfo::getFixedStack(MF, FI);
1844   MachineMemOperand *MMO = MF.getMachineMemOperand(
1845       PtrInfo, MachineMemOperand::MOStore, MFI.getObjectSize(FI), Align);
1846   unsigned Opc = 0;
1847   bool Offset = true;
1848   switch (RC->getSize()) {
1849   case 1:
1850     if (AArch64::FPR8RegClass.hasSubClassEq(RC))
1851       Opc = AArch64::STRBui;
1852     break;
1853   case 2:
1854     if (AArch64::FPR16RegClass.hasSubClassEq(RC))
1855       Opc = AArch64::STRHui;
1856     break;
1857   case 4:
1858     if (AArch64::GPR32allRegClass.hasSubClassEq(RC)) {
1859       Opc = AArch64::STRWui;
1860       if (TargetRegisterInfo::isVirtualRegister(SrcReg))
1861         MF.getRegInfo().constrainRegClass(SrcReg, &AArch64::GPR32RegClass);
1862       else
1863         assert(SrcReg != AArch64::WSP);
1864     } else if (AArch64::FPR32RegClass.hasSubClassEq(RC))
1865       Opc = AArch64::STRSui;
1866     break;
1867   case 8:
1868     if (AArch64::GPR64allRegClass.hasSubClassEq(RC)) {
1869       Opc = AArch64::STRXui;
1870       if (TargetRegisterInfo::isVirtualRegister(SrcReg))
1871         MF.getRegInfo().constrainRegClass(SrcReg, &AArch64::GPR64RegClass);
1872       else
1873         assert(SrcReg != AArch64::SP);
1874     } else if (AArch64::FPR64RegClass.hasSubClassEq(RC))
1875       Opc = AArch64::STRDui;
1876     break;
1877   case 16:
1878     if (AArch64::FPR128RegClass.hasSubClassEq(RC))
1879       Opc = AArch64::STRQui;
1880     else if (AArch64::DDRegClass.hasSubClassEq(RC)) {
1881       assert(Subtarget.hasNEON() &&
1882              "Unexpected register store without NEON");
1883       Opc = AArch64::ST1Twov1d;
1884       Offset = false;
1885     }
1886     break;
1887   case 24:
1888     if (AArch64::DDDRegClass.hasSubClassEq(RC)) {
1889       assert(Subtarget.hasNEON() &&
1890              "Unexpected register store without NEON");
1891       Opc = AArch64::ST1Threev1d;
1892       Offset = false;
1893     }
1894     break;
1895   case 32:
1896     if (AArch64::DDDDRegClass.hasSubClassEq(RC)) {
1897       assert(Subtarget.hasNEON() &&
1898              "Unexpected register store without NEON");
1899       Opc = AArch64::ST1Fourv1d;
1900       Offset = false;
1901     } else if (AArch64::QQRegClass.hasSubClassEq(RC)) {
1902       assert(Subtarget.hasNEON() &&
1903              "Unexpected register store without NEON");
1904       Opc = AArch64::ST1Twov2d;
1905       Offset = false;
1906     }
1907     break;
1908   case 48:
1909     if (AArch64::QQQRegClass.hasSubClassEq(RC)) {
1910       assert(Subtarget.hasNEON() &&
1911              "Unexpected register store without NEON");
1912       Opc = AArch64::ST1Threev2d;
1913       Offset = false;
1914     }
1915     break;
1916   case 64:
1917     if (AArch64::QQQQRegClass.hasSubClassEq(RC)) {
1918       assert(Subtarget.hasNEON() &&
1919              "Unexpected register store without NEON");
1920       Opc = AArch64::ST1Fourv2d;
1921       Offset = false;
1922     }
1923     break;
1924   }
1925   assert(Opc && "Unknown register class");
1926 
1927   const MachineInstrBuilder MI = BuildMI(MBB, MBBI, DL, get(Opc))
1928                                       .addReg(SrcReg, getKillRegState(isKill))
1929                                       .addFrameIndex(FI);
1930 
1931   if (Offset)
1932     MI.addImm(0);
1933   MI.addMemOperand(MMO);
1934 }
1935 
1936 void AArch64InstrInfo::loadRegFromStackSlot(
1937     MachineBasicBlock &MBB, MachineBasicBlock::iterator MBBI, unsigned DestReg,
1938     int FI, const TargetRegisterClass *RC,
1939     const TargetRegisterInfo *TRI) const {
1940   DebugLoc DL;
1941   if (MBBI != MBB.end())
1942     DL = MBBI->getDebugLoc();
1943   MachineFunction &MF = *MBB.getParent();
1944   MachineFrameInfo &MFI = *MF.getFrameInfo();
1945   unsigned Align = MFI.getObjectAlignment(FI);
1946   MachinePointerInfo PtrInfo = MachinePointerInfo::getFixedStack(MF, FI);
1947   MachineMemOperand *MMO = MF.getMachineMemOperand(
1948       PtrInfo, MachineMemOperand::MOLoad, MFI.getObjectSize(FI), Align);
1949 
1950   unsigned Opc = 0;
1951   bool Offset = true;
1952   switch (RC->getSize()) {
1953   case 1:
1954     if (AArch64::FPR8RegClass.hasSubClassEq(RC))
1955       Opc = AArch64::LDRBui;
1956     break;
1957   case 2:
1958     if (AArch64::FPR16RegClass.hasSubClassEq(RC))
1959       Opc = AArch64::LDRHui;
1960     break;
1961   case 4:
1962     if (AArch64::GPR32allRegClass.hasSubClassEq(RC)) {
1963       Opc = AArch64::LDRWui;
1964       if (TargetRegisterInfo::isVirtualRegister(DestReg))
1965         MF.getRegInfo().constrainRegClass(DestReg, &AArch64::GPR32RegClass);
1966       else
1967         assert(DestReg != AArch64::WSP);
1968     } else if (AArch64::FPR32RegClass.hasSubClassEq(RC))
1969       Opc = AArch64::LDRSui;
1970     break;
1971   case 8:
1972     if (AArch64::GPR64allRegClass.hasSubClassEq(RC)) {
1973       Opc = AArch64::LDRXui;
1974       if (TargetRegisterInfo::isVirtualRegister(DestReg))
1975         MF.getRegInfo().constrainRegClass(DestReg, &AArch64::GPR64RegClass);
1976       else
1977         assert(DestReg != AArch64::SP);
1978     } else if (AArch64::FPR64RegClass.hasSubClassEq(RC))
1979       Opc = AArch64::LDRDui;
1980     break;
1981   case 16:
1982     if (AArch64::FPR128RegClass.hasSubClassEq(RC))
1983       Opc = AArch64::LDRQui;
1984     else if (AArch64::DDRegClass.hasSubClassEq(RC)) {
1985       assert(Subtarget.hasNEON() &&
1986              "Unexpected register load without NEON");
1987       Opc = AArch64::LD1Twov1d;
1988       Offset = false;
1989     }
1990     break;
1991   case 24:
1992     if (AArch64::DDDRegClass.hasSubClassEq(RC)) {
1993       assert(Subtarget.hasNEON() &&
1994              "Unexpected register load without NEON");
1995       Opc = AArch64::LD1Threev1d;
1996       Offset = false;
1997     }
1998     break;
1999   case 32:
2000     if (AArch64::DDDDRegClass.hasSubClassEq(RC)) {
2001       assert(Subtarget.hasNEON() &&
2002              "Unexpected register load without NEON");
2003       Opc = AArch64::LD1Fourv1d;
2004       Offset = false;
2005     } else if (AArch64::QQRegClass.hasSubClassEq(RC)) {
2006       assert(Subtarget.hasNEON() &&
2007              "Unexpected register load without NEON");
2008       Opc = AArch64::LD1Twov2d;
2009       Offset = false;
2010     }
2011     break;
2012   case 48:
2013     if (AArch64::QQQRegClass.hasSubClassEq(RC)) {
2014       assert(Subtarget.hasNEON() &&
2015              "Unexpected register load without NEON");
2016       Opc = AArch64::LD1Threev2d;
2017       Offset = false;
2018     }
2019     break;
2020   case 64:
2021     if (AArch64::QQQQRegClass.hasSubClassEq(RC)) {
2022       assert(Subtarget.hasNEON() &&
2023              "Unexpected register load without NEON");
2024       Opc = AArch64::LD1Fourv2d;
2025       Offset = false;
2026     }
2027     break;
2028   }
2029   assert(Opc && "Unknown register class");
2030 
2031   const MachineInstrBuilder MI = BuildMI(MBB, MBBI, DL, get(Opc))
2032                                       .addReg(DestReg, getDefRegState(true))
2033                                       .addFrameIndex(FI);
2034   if (Offset)
2035     MI.addImm(0);
2036   MI.addMemOperand(MMO);
2037 }
2038 
2039 void llvm::emitFrameOffset(MachineBasicBlock &MBB,
2040                            MachineBasicBlock::iterator MBBI, DebugLoc DL,
2041                            unsigned DestReg, unsigned SrcReg, int Offset,
2042                            const TargetInstrInfo *TII,
2043                            MachineInstr::MIFlag Flag, bool SetNZCV) {
2044   if (DestReg == SrcReg && Offset == 0)
2045     return;
2046 
2047   bool isSub = Offset < 0;
2048   if (isSub)
2049     Offset = -Offset;
2050 
2051   // FIXME: If the offset won't fit in 24-bits, compute the offset into a
2052   // scratch register.  If DestReg is a virtual register, use it as the
2053   // scratch register; otherwise, create a new virtual register (to be
2054   // replaced by the scavenger at the end of PEI).  That case can be optimized
2055   // slightly if DestReg is SP which is always 16-byte aligned, so the scratch
2056   // register can be loaded with offset%8 and the add/sub can use an extending
2057   // instruction with LSL#3.
2058   // Currently the function handles any offsets but generates a poor sequence
2059   // of code.
2060   //  assert(Offset < (1 << 24) && "unimplemented reg plus immediate");
2061 
2062   unsigned Opc;
2063   if (SetNZCV)
2064     Opc = isSub ? AArch64::SUBSXri : AArch64::ADDSXri;
2065   else
2066     Opc = isSub ? AArch64::SUBXri : AArch64::ADDXri;
2067   const unsigned MaxEncoding = 0xfff;
2068   const unsigned ShiftSize = 12;
2069   const unsigned MaxEncodableValue = MaxEncoding << ShiftSize;
2070   while (((unsigned)Offset) >= (1 << ShiftSize)) {
2071     unsigned ThisVal;
2072     if (((unsigned)Offset) > MaxEncodableValue) {
2073       ThisVal = MaxEncodableValue;
2074     } else {
2075       ThisVal = Offset & MaxEncodableValue;
2076     }
2077     assert((ThisVal >> ShiftSize) <= MaxEncoding &&
2078            "Encoding cannot handle value that big");
2079     BuildMI(MBB, MBBI, DL, TII->get(Opc), DestReg)
2080         .addReg(SrcReg)
2081         .addImm(ThisVal >> ShiftSize)
2082         .addImm(AArch64_AM::getShifterImm(AArch64_AM::LSL, ShiftSize))
2083         .setMIFlag(Flag);
2084 
2085     SrcReg = DestReg;
2086     Offset -= ThisVal;
2087     if (Offset == 0)
2088       return;
2089   }
2090   BuildMI(MBB, MBBI, DL, TII->get(Opc), DestReg)
2091       .addReg(SrcReg)
2092       .addImm(Offset)
2093       .addImm(AArch64_AM::getShifterImm(AArch64_AM::LSL, 0))
2094       .setMIFlag(Flag);
2095 }
2096 
2097 MachineInstr *AArch64InstrInfo::foldMemoryOperandImpl(
2098     MachineFunction &MF, MachineInstr *MI, ArrayRef<unsigned> Ops,
2099     MachineBasicBlock::iterator InsertPt, int FrameIndex) const {
2100   // This is a bit of a hack. Consider this instruction:
2101   //
2102   //   %vreg0<def> = COPY %SP; GPR64all:%vreg0
2103   //
2104   // We explicitly chose GPR64all for the virtual register so such a copy might
2105   // be eliminated by RegisterCoalescer. However, that may not be possible, and
2106   // %vreg0 may even spill. We can't spill %SP, and since it is in the GPR64all
2107   // register class, TargetInstrInfo::foldMemoryOperand() is going to try.
2108   //
2109   // To prevent that, we are going to constrain the %vreg0 register class here.
2110   //
2111   // <rdar://problem/11522048>
2112   //
2113   if (MI->isCopy()) {
2114     unsigned DstReg = MI->getOperand(0).getReg();
2115     unsigned SrcReg = MI->getOperand(1).getReg();
2116     if (SrcReg == AArch64::SP &&
2117         TargetRegisterInfo::isVirtualRegister(DstReg)) {
2118       MF.getRegInfo().constrainRegClass(DstReg, &AArch64::GPR64RegClass);
2119       return nullptr;
2120     }
2121     if (DstReg == AArch64::SP &&
2122         TargetRegisterInfo::isVirtualRegister(SrcReg)) {
2123       MF.getRegInfo().constrainRegClass(SrcReg, &AArch64::GPR64RegClass);
2124       return nullptr;
2125     }
2126   }
2127 
2128   // Cannot fold.
2129   return nullptr;
2130 }
2131 
2132 int llvm::isAArch64FrameOffsetLegal(const MachineInstr &MI, int &Offset,
2133                                     bool *OutUseUnscaledOp,
2134                                     unsigned *OutUnscaledOp,
2135                                     int *EmittableOffset) {
2136   int Scale = 1;
2137   bool IsSigned = false;
2138   // The ImmIdx should be changed case by case if it is not 2.
2139   unsigned ImmIdx = 2;
2140   unsigned UnscaledOp = 0;
2141   // Set output values in case of early exit.
2142   if (EmittableOffset)
2143     *EmittableOffset = 0;
2144   if (OutUseUnscaledOp)
2145     *OutUseUnscaledOp = false;
2146   if (OutUnscaledOp)
2147     *OutUnscaledOp = 0;
2148   switch (MI.getOpcode()) {
2149   default:
2150     llvm_unreachable("unhandled opcode in rewriteAArch64FrameIndex");
2151   // Vector spills/fills can't take an immediate offset.
2152   case AArch64::LD1Twov2d:
2153   case AArch64::LD1Threev2d:
2154   case AArch64::LD1Fourv2d:
2155   case AArch64::LD1Twov1d:
2156   case AArch64::LD1Threev1d:
2157   case AArch64::LD1Fourv1d:
2158   case AArch64::ST1Twov2d:
2159   case AArch64::ST1Threev2d:
2160   case AArch64::ST1Fourv2d:
2161   case AArch64::ST1Twov1d:
2162   case AArch64::ST1Threev1d:
2163   case AArch64::ST1Fourv1d:
2164     return AArch64FrameOffsetCannotUpdate;
2165   case AArch64::PRFMui:
2166     Scale = 8;
2167     UnscaledOp = AArch64::PRFUMi;
2168     break;
2169   case AArch64::LDRXui:
2170     Scale = 8;
2171     UnscaledOp = AArch64::LDURXi;
2172     break;
2173   case AArch64::LDRWui:
2174     Scale = 4;
2175     UnscaledOp = AArch64::LDURWi;
2176     break;
2177   case AArch64::LDRBui:
2178     Scale = 1;
2179     UnscaledOp = AArch64::LDURBi;
2180     break;
2181   case AArch64::LDRHui:
2182     Scale = 2;
2183     UnscaledOp = AArch64::LDURHi;
2184     break;
2185   case AArch64::LDRSui:
2186     Scale = 4;
2187     UnscaledOp = AArch64::LDURSi;
2188     break;
2189   case AArch64::LDRDui:
2190     Scale = 8;
2191     UnscaledOp = AArch64::LDURDi;
2192     break;
2193   case AArch64::LDRQui:
2194     Scale = 16;
2195     UnscaledOp = AArch64::LDURQi;
2196     break;
2197   case AArch64::LDRBBui:
2198     Scale = 1;
2199     UnscaledOp = AArch64::LDURBBi;
2200     break;
2201   case AArch64::LDRHHui:
2202     Scale = 2;
2203     UnscaledOp = AArch64::LDURHHi;
2204     break;
2205   case AArch64::LDRSBXui:
2206     Scale = 1;
2207     UnscaledOp = AArch64::LDURSBXi;
2208     break;
2209   case AArch64::LDRSBWui:
2210     Scale = 1;
2211     UnscaledOp = AArch64::LDURSBWi;
2212     break;
2213   case AArch64::LDRSHXui:
2214     Scale = 2;
2215     UnscaledOp = AArch64::LDURSHXi;
2216     break;
2217   case AArch64::LDRSHWui:
2218     Scale = 2;
2219     UnscaledOp = AArch64::LDURSHWi;
2220     break;
2221   case AArch64::LDRSWui:
2222     Scale = 4;
2223     UnscaledOp = AArch64::LDURSWi;
2224     break;
2225 
2226   case AArch64::STRXui:
2227     Scale = 8;
2228     UnscaledOp = AArch64::STURXi;
2229     break;
2230   case AArch64::STRWui:
2231     Scale = 4;
2232     UnscaledOp = AArch64::STURWi;
2233     break;
2234   case AArch64::STRBui:
2235     Scale = 1;
2236     UnscaledOp = AArch64::STURBi;
2237     break;
2238   case AArch64::STRHui:
2239     Scale = 2;
2240     UnscaledOp = AArch64::STURHi;
2241     break;
2242   case AArch64::STRSui:
2243     Scale = 4;
2244     UnscaledOp = AArch64::STURSi;
2245     break;
2246   case AArch64::STRDui:
2247     Scale = 8;
2248     UnscaledOp = AArch64::STURDi;
2249     break;
2250   case AArch64::STRQui:
2251     Scale = 16;
2252     UnscaledOp = AArch64::STURQi;
2253     break;
2254   case AArch64::STRBBui:
2255     Scale = 1;
2256     UnscaledOp = AArch64::STURBBi;
2257     break;
2258   case AArch64::STRHHui:
2259     Scale = 2;
2260     UnscaledOp = AArch64::STURHHi;
2261     break;
2262 
2263   case AArch64::LDPXi:
2264   case AArch64::LDPDi:
2265   case AArch64::STPXi:
2266   case AArch64::STPDi:
2267   case AArch64::LDNPXi:
2268   case AArch64::LDNPDi:
2269   case AArch64::STNPXi:
2270   case AArch64::STNPDi:
2271     ImmIdx = 3;
2272     IsSigned = true;
2273     Scale = 8;
2274     break;
2275   case AArch64::LDPQi:
2276   case AArch64::STPQi:
2277   case AArch64::LDNPQi:
2278   case AArch64::STNPQi:
2279     ImmIdx = 3;
2280     IsSigned = true;
2281     Scale = 16;
2282     break;
2283   case AArch64::LDPWi:
2284   case AArch64::LDPSi:
2285   case AArch64::STPWi:
2286   case AArch64::STPSi:
2287   case AArch64::LDNPWi:
2288   case AArch64::LDNPSi:
2289   case AArch64::STNPWi:
2290   case AArch64::STNPSi:
2291     ImmIdx = 3;
2292     IsSigned = true;
2293     Scale = 4;
2294     break;
2295 
2296   case AArch64::LDURXi:
2297   case AArch64::LDURWi:
2298   case AArch64::LDURBi:
2299   case AArch64::LDURHi:
2300   case AArch64::LDURSi:
2301   case AArch64::LDURDi:
2302   case AArch64::LDURQi:
2303   case AArch64::LDURHHi:
2304   case AArch64::LDURBBi:
2305   case AArch64::LDURSBXi:
2306   case AArch64::LDURSBWi:
2307   case AArch64::LDURSHXi:
2308   case AArch64::LDURSHWi:
2309   case AArch64::LDURSWi:
2310   case AArch64::STURXi:
2311   case AArch64::STURWi:
2312   case AArch64::STURBi:
2313   case AArch64::STURHi:
2314   case AArch64::STURSi:
2315   case AArch64::STURDi:
2316   case AArch64::STURQi:
2317   case AArch64::STURBBi:
2318   case AArch64::STURHHi:
2319     Scale = 1;
2320     break;
2321   }
2322 
2323   Offset += MI.getOperand(ImmIdx).getImm() * Scale;
2324 
2325   bool useUnscaledOp = false;
2326   // If the offset doesn't match the scale, we rewrite the instruction to
2327   // use the unscaled instruction instead. Likewise, if we have a negative
2328   // offset (and have an unscaled op to use).
2329   if ((Offset & (Scale - 1)) != 0 || (Offset < 0 && UnscaledOp != 0))
2330     useUnscaledOp = true;
2331 
2332   // Use an unscaled addressing mode if the instruction has a negative offset
2333   // (or if the instruction is already using an unscaled addressing mode).
2334   unsigned MaskBits;
2335   if (IsSigned) {
2336     // ldp/stp instructions.
2337     MaskBits = 7;
2338     Offset /= Scale;
2339   } else if (UnscaledOp == 0 || useUnscaledOp) {
2340     MaskBits = 9;
2341     IsSigned = true;
2342     Scale = 1;
2343   } else {
2344     MaskBits = 12;
2345     IsSigned = false;
2346     Offset /= Scale;
2347   }
2348 
2349   // Attempt to fold address computation.
2350   int MaxOff = (1 << (MaskBits - IsSigned)) - 1;
2351   int MinOff = (IsSigned ? (-MaxOff - 1) : 0);
2352   if (Offset >= MinOff && Offset <= MaxOff) {
2353     if (EmittableOffset)
2354       *EmittableOffset = Offset;
2355     Offset = 0;
2356   } else {
2357     int NewOff = Offset < 0 ? MinOff : MaxOff;
2358     if (EmittableOffset)
2359       *EmittableOffset = NewOff;
2360     Offset = (Offset - NewOff) * Scale;
2361   }
2362   if (OutUseUnscaledOp)
2363     *OutUseUnscaledOp = useUnscaledOp;
2364   if (OutUnscaledOp)
2365     *OutUnscaledOp = UnscaledOp;
2366   return AArch64FrameOffsetCanUpdate |
2367          (Offset == 0 ? AArch64FrameOffsetIsLegal : 0);
2368 }
2369 
2370 bool llvm::rewriteAArch64FrameIndex(MachineInstr &MI, unsigned FrameRegIdx,
2371                                     unsigned FrameReg, int &Offset,
2372                                     const AArch64InstrInfo *TII) {
2373   unsigned Opcode = MI.getOpcode();
2374   unsigned ImmIdx = FrameRegIdx + 1;
2375 
2376   if (Opcode == AArch64::ADDSXri || Opcode == AArch64::ADDXri) {
2377     Offset += MI.getOperand(ImmIdx).getImm();
2378     emitFrameOffset(*MI.getParent(), MI, MI.getDebugLoc(),
2379                     MI.getOperand(0).getReg(), FrameReg, Offset, TII,
2380                     MachineInstr::NoFlags, (Opcode == AArch64::ADDSXri));
2381     MI.eraseFromParent();
2382     Offset = 0;
2383     return true;
2384   }
2385 
2386   int NewOffset;
2387   unsigned UnscaledOp;
2388   bool UseUnscaledOp;
2389   int Status = isAArch64FrameOffsetLegal(MI, Offset, &UseUnscaledOp,
2390                                          &UnscaledOp, &NewOffset);
2391   if (Status & AArch64FrameOffsetCanUpdate) {
2392     if (Status & AArch64FrameOffsetIsLegal)
2393       // Replace the FrameIndex with FrameReg.
2394       MI.getOperand(FrameRegIdx).ChangeToRegister(FrameReg, false);
2395     if (UseUnscaledOp)
2396       MI.setDesc(TII->get(UnscaledOp));
2397 
2398     MI.getOperand(ImmIdx).ChangeToImmediate(NewOffset);
2399     return Offset == 0;
2400   }
2401 
2402   return false;
2403 }
2404 
2405 void AArch64InstrInfo::getNoopForMachoTarget(MCInst &NopInst) const {
2406   NopInst.setOpcode(AArch64::HINT);
2407   NopInst.addOperand(MCOperand::createImm(0));
2408 }
2409 /// useMachineCombiner - return true when a target supports MachineCombiner
2410 bool AArch64InstrInfo::useMachineCombiner() const {
2411   // AArch64 supports the combiner
2412   return true;
2413 }
2414 //
2415 // True when Opc sets flag
2416 static bool isCombineInstrSettingFlag(unsigned Opc) {
2417   switch (Opc) {
2418   case AArch64::ADDSWrr:
2419   case AArch64::ADDSWri:
2420   case AArch64::ADDSXrr:
2421   case AArch64::ADDSXri:
2422   case AArch64::SUBSWrr:
2423   case AArch64::SUBSXrr:
2424   // Note: MSUB Wd,Wn,Wm,Wi -> Wd = Wi - WnxWm, not Wd=WnxWm - Wi.
2425   case AArch64::SUBSWri:
2426   case AArch64::SUBSXri:
2427     return true;
2428   default:
2429     break;
2430   }
2431   return false;
2432 }
2433 //
2434 // 32b Opcodes that can be combined with a MUL
2435 static bool isCombineInstrCandidate32(unsigned Opc) {
2436   switch (Opc) {
2437   case AArch64::ADDWrr:
2438   case AArch64::ADDWri:
2439   case AArch64::SUBWrr:
2440   case AArch64::ADDSWrr:
2441   case AArch64::ADDSWri:
2442   case AArch64::SUBSWrr:
2443   // Note: MSUB Wd,Wn,Wm,Wi -> Wd = Wi - WnxWm, not Wd=WnxWm - Wi.
2444   case AArch64::SUBWri:
2445   case AArch64::SUBSWri:
2446     return true;
2447   default:
2448     break;
2449   }
2450   return false;
2451 }
2452 //
2453 // 64b Opcodes that can be combined with a MUL
2454 static bool isCombineInstrCandidate64(unsigned Opc) {
2455   switch (Opc) {
2456   case AArch64::ADDXrr:
2457   case AArch64::ADDXri:
2458   case AArch64::SUBXrr:
2459   case AArch64::ADDSXrr:
2460   case AArch64::ADDSXri:
2461   case AArch64::SUBSXrr:
2462   // Note: MSUB Wd,Wn,Wm,Wi -> Wd = Wi - WnxWm, not Wd=WnxWm - Wi.
2463   case AArch64::SUBXri:
2464   case AArch64::SUBSXri:
2465     return true;
2466   default:
2467     break;
2468   }
2469   return false;
2470 }
2471 //
2472 // Opcodes that can be combined with a MUL
2473 static bool isCombineInstrCandidate(unsigned Opc) {
2474   return (isCombineInstrCandidate32(Opc) || isCombineInstrCandidate64(Opc));
2475 }
2476 
2477 static bool canCombineWithMUL(MachineBasicBlock &MBB, MachineOperand &MO,
2478                               unsigned MulOpc, unsigned ZeroReg) {
2479   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
2480   MachineInstr *MI = nullptr;
2481   // We need a virtual register definition.
2482   if (MO.isReg() && TargetRegisterInfo::isVirtualRegister(MO.getReg()))
2483     MI = MRI.getUniqueVRegDef(MO.getReg());
2484   // And it needs to be in the trace (otherwise, it won't have a depth).
2485   if (!MI || MI->getParent() != &MBB || (unsigned)MI->getOpcode() != MulOpc)
2486     return false;
2487 
2488   assert(MI->getNumOperands() >= 4 && MI->getOperand(0).isReg() &&
2489          MI->getOperand(1).isReg() && MI->getOperand(2).isReg() &&
2490          MI->getOperand(3).isReg() && "MAdd/MSub must have a least 4 regs");
2491 
2492   // The third input reg must be zero.
2493   if (MI->getOperand(3).getReg() != ZeroReg)
2494     return false;
2495 
2496   // Must only used by the user we combine with.
2497   if (!MRI.hasOneNonDBGUse(MI->getOperand(0).getReg()))
2498     return false;
2499 
2500   return true;
2501 }
2502 
2503 // TODO: There are many more machine instruction opcodes to match:
2504 //       1. Other data types (integer, vectors)
2505 //       2. Other math / logic operations (xor, or)
2506 //       3. Other forms of the same operation (intrinsics and other variants)
2507 bool AArch64InstrInfo::isAssociativeAndCommutative(const MachineInstr &Inst) const {
2508   switch (Inst.getOpcode()) {
2509   case AArch64::FADDDrr:
2510   case AArch64::FADDSrr:
2511   case AArch64::FADDv2f32:
2512   case AArch64::FADDv2f64:
2513   case AArch64::FADDv4f32:
2514   case AArch64::FMULDrr:
2515   case AArch64::FMULSrr:
2516   case AArch64::FMULX32:
2517   case AArch64::FMULX64:
2518   case AArch64::FMULXv2f32:
2519   case AArch64::FMULXv2f64:
2520   case AArch64::FMULXv4f32:
2521   case AArch64::FMULv2f32:
2522   case AArch64::FMULv2f64:
2523   case AArch64::FMULv4f32:
2524     return Inst.getParent()->getParent()->getTarget().Options.UnsafeFPMath;
2525   default:
2526     return false;
2527   }
2528 }
2529 
2530 /// Find instructions that can be turned into madd.
2531 static bool getMaddPatterns(MachineInstr &Root,
2532                             SmallVectorImpl<MachineCombinerPattern> &Patterns) {
2533   unsigned Opc = Root.getOpcode();
2534   MachineBasicBlock &MBB = *Root.getParent();
2535   bool Found = false;
2536 
2537   if (!isCombineInstrCandidate(Opc))
2538     return 0;
2539   if (isCombineInstrSettingFlag(Opc)) {
2540     int Cmp_NZCV = Root.findRegisterDefOperandIdx(AArch64::NZCV, true);
2541     // When NZCV is live bail out.
2542     if (Cmp_NZCV == -1)
2543       return 0;
2544     unsigned NewOpc = convertFlagSettingOpcode(&Root);
2545     // When opcode can't change bail out.
2546     // CHECKME: do we miss any cases for opcode conversion?
2547     if (NewOpc == Opc)
2548       return 0;
2549     Opc = NewOpc;
2550   }
2551 
2552   switch (Opc) {
2553   default:
2554     break;
2555   case AArch64::ADDWrr:
2556     assert(Root.getOperand(1).isReg() && Root.getOperand(2).isReg() &&
2557            "ADDWrr does not have register operands");
2558     if (canCombineWithMUL(MBB, Root.getOperand(1), AArch64::MADDWrrr,
2559                           AArch64::WZR)) {
2560       Patterns.push_back(MachineCombinerPattern::MULADDW_OP1);
2561       Found = true;
2562     }
2563     if (canCombineWithMUL(MBB, Root.getOperand(2), AArch64::MADDWrrr,
2564                           AArch64::WZR)) {
2565       Patterns.push_back(MachineCombinerPattern::MULADDW_OP2);
2566       Found = true;
2567     }
2568     break;
2569   case AArch64::ADDXrr:
2570     if (canCombineWithMUL(MBB, Root.getOperand(1), AArch64::MADDXrrr,
2571                           AArch64::XZR)) {
2572       Patterns.push_back(MachineCombinerPattern::MULADDX_OP1);
2573       Found = true;
2574     }
2575     if (canCombineWithMUL(MBB, Root.getOperand(2), AArch64::MADDXrrr,
2576                           AArch64::XZR)) {
2577       Patterns.push_back(MachineCombinerPattern::MULADDX_OP2);
2578       Found = true;
2579     }
2580     break;
2581   case AArch64::SUBWrr:
2582     if (canCombineWithMUL(MBB, Root.getOperand(1), AArch64::MADDWrrr,
2583                           AArch64::WZR)) {
2584       Patterns.push_back(MachineCombinerPattern::MULSUBW_OP1);
2585       Found = true;
2586     }
2587     if (canCombineWithMUL(MBB, Root.getOperand(2), AArch64::MADDWrrr,
2588                           AArch64::WZR)) {
2589       Patterns.push_back(MachineCombinerPattern::MULSUBW_OP2);
2590       Found = true;
2591     }
2592     break;
2593   case AArch64::SUBXrr:
2594     if (canCombineWithMUL(MBB, Root.getOperand(1), AArch64::MADDXrrr,
2595                           AArch64::XZR)) {
2596       Patterns.push_back(MachineCombinerPattern::MULSUBX_OP1);
2597       Found = true;
2598     }
2599     if (canCombineWithMUL(MBB, Root.getOperand(2), AArch64::MADDXrrr,
2600                           AArch64::XZR)) {
2601       Patterns.push_back(MachineCombinerPattern::MULSUBX_OP2);
2602       Found = true;
2603     }
2604     break;
2605   case AArch64::ADDWri:
2606     if (canCombineWithMUL(MBB, Root.getOperand(1), AArch64::MADDWrrr,
2607                           AArch64::WZR)) {
2608       Patterns.push_back(MachineCombinerPattern::MULADDWI_OP1);
2609       Found = true;
2610     }
2611     break;
2612   case AArch64::ADDXri:
2613     if (canCombineWithMUL(MBB, Root.getOperand(1), AArch64::MADDXrrr,
2614                           AArch64::XZR)) {
2615       Patterns.push_back(MachineCombinerPattern::MULADDXI_OP1);
2616       Found = true;
2617     }
2618     break;
2619   case AArch64::SUBWri:
2620     if (canCombineWithMUL(MBB, Root.getOperand(1), AArch64::MADDWrrr,
2621                           AArch64::WZR)) {
2622       Patterns.push_back(MachineCombinerPattern::MULSUBWI_OP1);
2623       Found = true;
2624     }
2625     break;
2626   case AArch64::SUBXri:
2627     if (canCombineWithMUL(MBB, Root.getOperand(1), AArch64::MADDXrrr,
2628                           AArch64::XZR)) {
2629       Patterns.push_back(MachineCombinerPattern::MULSUBXI_OP1);
2630       Found = true;
2631     }
2632     break;
2633   }
2634   return Found;
2635 }
2636 
2637 /// Return true when there is potentially a faster code sequence for an
2638 /// instruction chain ending in \p Root. All potential patterns are listed in
2639 /// the \p Pattern vector. Pattern should be sorted in priority order since the
2640 /// pattern evaluator stops checking as soon as it finds a faster sequence.
2641 
2642 bool AArch64InstrInfo::getMachineCombinerPatterns(
2643     MachineInstr &Root,
2644     SmallVectorImpl<MachineCombinerPattern> &Patterns) const {
2645   if (getMaddPatterns(Root, Patterns))
2646     return true;
2647 
2648   return TargetInstrInfo::getMachineCombinerPatterns(Root, Patterns);
2649 }
2650 
2651 /// genMadd - Generate madd instruction and combine mul and add.
2652 /// Example:
2653 ///  MUL I=A,B,0
2654 ///  ADD R,I,C
2655 ///  ==> MADD R,A,B,C
2656 /// \param Root is the ADD instruction
2657 /// \param [out] InsInstrs is a vector of machine instructions and will
2658 /// contain the generated madd instruction
2659 /// \param IdxMulOpd is index of operand in Root that is the result of
2660 /// the MUL. In the example above IdxMulOpd is 1.
2661 /// \param MaddOpc the opcode fo the madd instruction
2662 static MachineInstr *genMadd(MachineFunction &MF, MachineRegisterInfo &MRI,
2663                              const TargetInstrInfo *TII, MachineInstr &Root,
2664                              SmallVectorImpl<MachineInstr *> &InsInstrs,
2665                              unsigned IdxMulOpd, unsigned MaddOpc,
2666                              const TargetRegisterClass *RC) {
2667   assert(IdxMulOpd == 1 || IdxMulOpd == 2);
2668 
2669   unsigned IdxOtherOpd = IdxMulOpd == 1 ? 2 : 1;
2670   MachineInstr *MUL = MRI.getUniqueVRegDef(Root.getOperand(IdxMulOpd).getReg());
2671   unsigned ResultReg = Root.getOperand(0).getReg();
2672   unsigned SrcReg0 = MUL->getOperand(1).getReg();
2673   bool Src0IsKill = MUL->getOperand(1).isKill();
2674   unsigned SrcReg1 = MUL->getOperand(2).getReg();
2675   bool Src1IsKill = MUL->getOperand(2).isKill();
2676   unsigned SrcReg2 = Root.getOperand(IdxOtherOpd).getReg();
2677   bool Src2IsKill = Root.getOperand(IdxOtherOpd).isKill();
2678 
2679   if (TargetRegisterInfo::isVirtualRegister(ResultReg))
2680     MRI.constrainRegClass(ResultReg, RC);
2681   if (TargetRegisterInfo::isVirtualRegister(SrcReg0))
2682     MRI.constrainRegClass(SrcReg0, RC);
2683   if (TargetRegisterInfo::isVirtualRegister(SrcReg1))
2684     MRI.constrainRegClass(SrcReg1, RC);
2685   if (TargetRegisterInfo::isVirtualRegister(SrcReg2))
2686     MRI.constrainRegClass(SrcReg2, RC);
2687 
2688   MachineInstrBuilder MIB = BuildMI(MF, Root.getDebugLoc(), TII->get(MaddOpc),
2689                                     ResultReg)
2690                                 .addReg(SrcReg0, getKillRegState(Src0IsKill))
2691                                 .addReg(SrcReg1, getKillRegState(Src1IsKill))
2692                                 .addReg(SrcReg2, getKillRegState(Src2IsKill));
2693   // Insert the MADD
2694   InsInstrs.push_back(MIB);
2695   return MUL;
2696 }
2697 
2698 /// genMaddR - Generate madd instruction and combine mul and add using
2699 /// an extra virtual register
2700 /// Example - an ADD intermediate needs to be stored in a register:
2701 ///   MUL I=A,B,0
2702 ///   ADD R,I,Imm
2703 ///   ==> ORR  V, ZR, Imm
2704 ///   ==> MADD R,A,B,V
2705 /// \param Root is the ADD instruction
2706 /// \param [out] InsInstrs is a vector of machine instructions and will
2707 /// contain the generated madd instruction
2708 /// \param IdxMulOpd is index of operand in Root that is the result of
2709 /// the MUL. In the example above IdxMulOpd is 1.
2710 /// \param MaddOpc the opcode fo the madd instruction
2711 /// \param VR is a virtual register that holds the value of an ADD operand
2712 /// (V in the example above).
2713 static MachineInstr *genMaddR(MachineFunction &MF, MachineRegisterInfo &MRI,
2714                               const TargetInstrInfo *TII, MachineInstr &Root,
2715                               SmallVectorImpl<MachineInstr *> &InsInstrs,
2716                               unsigned IdxMulOpd, unsigned MaddOpc,
2717                               unsigned VR, const TargetRegisterClass *RC) {
2718   assert(IdxMulOpd == 1 || IdxMulOpd == 2);
2719 
2720   MachineInstr *MUL = MRI.getUniqueVRegDef(Root.getOperand(IdxMulOpd).getReg());
2721   unsigned ResultReg = Root.getOperand(0).getReg();
2722   unsigned SrcReg0 = MUL->getOperand(1).getReg();
2723   bool Src0IsKill = MUL->getOperand(1).isKill();
2724   unsigned SrcReg1 = MUL->getOperand(2).getReg();
2725   bool Src1IsKill = MUL->getOperand(2).isKill();
2726 
2727   if (TargetRegisterInfo::isVirtualRegister(ResultReg))
2728     MRI.constrainRegClass(ResultReg, RC);
2729   if (TargetRegisterInfo::isVirtualRegister(SrcReg0))
2730     MRI.constrainRegClass(SrcReg0, RC);
2731   if (TargetRegisterInfo::isVirtualRegister(SrcReg1))
2732     MRI.constrainRegClass(SrcReg1, RC);
2733   if (TargetRegisterInfo::isVirtualRegister(VR))
2734     MRI.constrainRegClass(VR, RC);
2735 
2736   MachineInstrBuilder MIB = BuildMI(MF, Root.getDebugLoc(), TII->get(MaddOpc),
2737                                     ResultReg)
2738                                 .addReg(SrcReg0, getKillRegState(Src0IsKill))
2739                                 .addReg(SrcReg1, getKillRegState(Src1IsKill))
2740                                 .addReg(VR);
2741   // Insert the MADD
2742   InsInstrs.push_back(MIB);
2743   return MUL;
2744 }
2745 
2746 /// When getMachineCombinerPatterns() finds potential patterns,
2747 /// this function generates the instructions that could replace the
2748 /// original code sequence
2749 void AArch64InstrInfo::genAlternativeCodeSequence(
2750     MachineInstr &Root, MachineCombinerPattern Pattern,
2751     SmallVectorImpl<MachineInstr *> &InsInstrs,
2752     SmallVectorImpl<MachineInstr *> &DelInstrs,
2753     DenseMap<unsigned, unsigned> &InstrIdxForVirtReg) const {
2754   MachineBasicBlock &MBB = *Root.getParent();
2755   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
2756   MachineFunction &MF = *MBB.getParent();
2757   const TargetInstrInfo *TII = MF.getSubtarget().getInstrInfo();
2758 
2759   MachineInstr *MUL;
2760   const TargetRegisterClass *RC;
2761   unsigned Opc;
2762   switch (Pattern) {
2763   default:
2764     // Reassociate instructions.
2765     TargetInstrInfo::genAlternativeCodeSequence(Root, Pattern, InsInstrs,
2766                                                 DelInstrs, InstrIdxForVirtReg);
2767     return;
2768   case MachineCombinerPattern::MULADDW_OP1:
2769   case MachineCombinerPattern::MULADDX_OP1:
2770     // MUL I=A,B,0
2771     // ADD R,I,C
2772     // ==> MADD R,A,B,C
2773     // --- Create(MADD);
2774     if (Pattern == MachineCombinerPattern::MULADDW_OP1) {
2775       Opc = AArch64::MADDWrrr;
2776       RC = &AArch64::GPR32RegClass;
2777     } else {
2778       Opc = AArch64::MADDXrrr;
2779       RC = &AArch64::GPR64RegClass;
2780     }
2781     MUL = genMadd(MF, MRI, TII, Root, InsInstrs, 1, Opc, RC);
2782     break;
2783   case MachineCombinerPattern::MULADDW_OP2:
2784   case MachineCombinerPattern::MULADDX_OP2:
2785     // MUL I=A,B,0
2786     // ADD R,C,I
2787     // ==> MADD R,A,B,C
2788     // --- Create(MADD);
2789     if (Pattern == MachineCombinerPattern::MULADDW_OP2) {
2790       Opc = AArch64::MADDWrrr;
2791       RC = &AArch64::GPR32RegClass;
2792     } else {
2793       Opc = AArch64::MADDXrrr;
2794       RC = &AArch64::GPR64RegClass;
2795     }
2796     MUL = genMadd(MF, MRI, TII, Root, InsInstrs, 2, Opc, RC);
2797     break;
2798   case MachineCombinerPattern::MULADDWI_OP1:
2799   case MachineCombinerPattern::MULADDXI_OP1: {
2800     // MUL I=A,B,0
2801     // ADD R,I,Imm
2802     // ==> ORR  V, ZR, Imm
2803     // ==> MADD R,A,B,V
2804     // --- Create(MADD);
2805     const TargetRegisterClass *OrrRC;
2806     unsigned BitSize, OrrOpc, ZeroReg;
2807     if (Pattern == MachineCombinerPattern::MULADDWI_OP1) {
2808       OrrOpc = AArch64::ORRWri;
2809       OrrRC = &AArch64::GPR32spRegClass;
2810       BitSize = 32;
2811       ZeroReg = AArch64::WZR;
2812       Opc = AArch64::MADDWrrr;
2813       RC = &AArch64::GPR32RegClass;
2814     } else {
2815       OrrOpc = AArch64::ORRXri;
2816       OrrRC = &AArch64::GPR64spRegClass;
2817       BitSize = 64;
2818       ZeroReg = AArch64::XZR;
2819       Opc = AArch64::MADDXrrr;
2820       RC = &AArch64::GPR64RegClass;
2821     }
2822     unsigned NewVR = MRI.createVirtualRegister(OrrRC);
2823     uint64_t Imm = Root.getOperand(2).getImm();
2824 
2825     if (Root.getOperand(3).isImm()) {
2826       unsigned Val = Root.getOperand(3).getImm();
2827       Imm = Imm << Val;
2828     }
2829     uint64_t UImm = Imm << (64 - BitSize) >> (64 - BitSize);
2830     uint64_t Encoding;
2831     if (AArch64_AM::processLogicalImmediate(UImm, BitSize, Encoding)) {
2832       MachineInstrBuilder MIB1 =
2833           BuildMI(MF, Root.getDebugLoc(), TII->get(OrrOpc), NewVR)
2834               .addReg(ZeroReg)
2835               .addImm(Encoding);
2836       InsInstrs.push_back(MIB1);
2837       InstrIdxForVirtReg.insert(std::make_pair(NewVR, 0));
2838       MUL = genMaddR(MF, MRI, TII, Root, InsInstrs, 1, Opc, NewVR, RC);
2839     }
2840     break;
2841   }
2842   case MachineCombinerPattern::MULSUBW_OP1:
2843   case MachineCombinerPattern::MULSUBX_OP1: {
2844     // MUL I=A,B,0
2845     // SUB R,I, C
2846     // ==> SUB  V, 0, C
2847     // ==> MADD R,A,B,V // = -C + A*B
2848     // --- Create(MADD);
2849     const TargetRegisterClass *SubRC;
2850     unsigned SubOpc, ZeroReg;
2851     if (Pattern == MachineCombinerPattern::MULSUBW_OP1) {
2852       SubOpc = AArch64::SUBWrr;
2853       SubRC = &AArch64::GPR32spRegClass;
2854       ZeroReg = AArch64::WZR;
2855       Opc = AArch64::MADDWrrr;
2856       RC = &AArch64::GPR32RegClass;
2857     } else {
2858       SubOpc = AArch64::SUBXrr;
2859       SubRC = &AArch64::GPR64spRegClass;
2860       ZeroReg = AArch64::XZR;
2861       Opc = AArch64::MADDXrrr;
2862       RC = &AArch64::GPR64RegClass;
2863     }
2864     unsigned NewVR = MRI.createVirtualRegister(SubRC);
2865     // SUB NewVR, 0, C
2866     MachineInstrBuilder MIB1 =
2867         BuildMI(MF, Root.getDebugLoc(), TII->get(SubOpc), NewVR)
2868             .addReg(ZeroReg)
2869             .addOperand(Root.getOperand(2));
2870     InsInstrs.push_back(MIB1);
2871     InstrIdxForVirtReg.insert(std::make_pair(NewVR, 0));
2872     MUL = genMaddR(MF, MRI, TII, Root, InsInstrs, 1, Opc, NewVR, RC);
2873     break;
2874   }
2875   case MachineCombinerPattern::MULSUBW_OP2:
2876   case MachineCombinerPattern::MULSUBX_OP2:
2877     // MUL I=A,B,0
2878     // SUB R,C,I
2879     // ==> MSUB R,A,B,C (computes C - A*B)
2880     // --- Create(MSUB);
2881     if (Pattern == MachineCombinerPattern::MULSUBW_OP2) {
2882       Opc = AArch64::MSUBWrrr;
2883       RC = &AArch64::GPR32RegClass;
2884     } else {
2885       Opc = AArch64::MSUBXrrr;
2886       RC = &AArch64::GPR64RegClass;
2887     }
2888     MUL = genMadd(MF, MRI, TII, Root, InsInstrs, 2, Opc, RC);
2889     break;
2890   case MachineCombinerPattern::MULSUBWI_OP1:
2891   case MachineCombinerPattern::MULSUBXI_OP1: {
2892     // MUL I=A,B,0
2893     // SUB R,I, Imm
2894     // ==> ORR  V, ZR, -Imm
2895     // ==> MADD R,A,B,V // = -Imm + A*B
2896     // --- Create(MADD);
2897     const TargetRegisterClass *OrrRC;
2898     unsigned BitSize, OrrOpc, ZeroReg;
2899     if (Pattern == MachineCombinerPattern::MULSUBWI_OP1) {
2900       OrrOpc = AArch64::ORRWri;
2901       OrrRC = &AArch64::GPR32spRegClass;
2902       BitSize = 32;
2903       ZeroReg = AArch64::WZR;
2904       Opc = AArch64::MADDWrrr;
2905       RC = &AArch64::GPR32RegClass;
2906     } else {
2907       OrrOpc = AArch64::ORRXri;
2908       OrrRC = &AArch64::GPR64spRegClass;
2909       BitSize = 64;
2910       ZeroReg = AArch64::XZR;
2911       Opc = AArch64::MADDXrrr;
2912       RC = &AArch64::GPR64RegClass;
2913     }
2914     unsigned NewVR = MRI.createVirtualRegister(OrrRC);
2915     int Imm = Root.getOperand(2).getImm();
2916     if (Root.getOperand(3).isImm()) {
2917       unsigned Val = Root.getOperand(3).getImm();
2918       Imm = Imm << Val;
2919     }
2920     uint64_t UImm = -Imm << (64 - BitSize) >> (64 - BitSize);
2921     uint64_t Encoding;
2922     if (AArch64_AM::processLogicalImmediate(UImm, BitSize, Encoding)) {
2923       MachineInstrBuilder MIB1 =
2924           BuildMI(MF, Root.getDebugLoc(), TII->get(OrrOpc), NewVR)
2925               .addReg(ZeroReg)
2926               .addImm(Encoding);
2927       InsInstrs.push_back(MIB1);
2928       InstrIdxForVirtReg.insert(std::make_pair(NewVR, 0));
2929       MUL = genMaddR(MF, MRI, TII, Root, InsInstrs, 1, Opc, NewVR, RC);
2930     }
2931     break;
2932   }
2933   } // end switch (Pattern)
2934   // Record MUL and ADD/SUB for deletion
2935   DelInstrs.push_back(MUL);
2936   DelInstrs.push_back(&Root);
2937 
2938   return;
2939 }
2940 
2941 /// \brief Replace csincr-branch sequence by simple conditional branch
2942 ///
2943 /// Examples:
2944 /// 1.
2945 ///   csinc  w9, wzr, wzr, <condition code>
2946 ///   tbnz   w9, #0, 0x44
2947 /// to
2948 ///   b.<inverted condition code>
2949 ///
2950 /// 2.
2951 ///   csinc w9, wzr, wzr, <condition code>
2952 ///   tbz   w9, #0, 0x44
2953 /// to
2954 ///   b.<condition code>
2955 ///
2956 /// \param  MI Conditional Branch
2957 /// \return True when the simple conditional branch is generated
2958 ///
2959 bool AArch64InstrInfo::optimizeCondBranch(MachineInstr *MI) const {
2960   bool IsNegativeBranch = false;
2961   bool IsTestAndBranch = false;
2962   unsigned TargetBBInMI = 0;
2963   switch (MI->getOpcode()) {
2964   default:
2965     llvm_unreachable("Unknown branch instruction?");
2966   case AArch64::Bcc:
2967     return false;
2968   case AArch64::CBZW:
2969   case AArch64::CBZX:
2970     TargetBBInMI = 1;
2971     break;
2972   case AArch64::CBNZW:
2973   case AArch64::CBNZX:
2974     TargetBBInMI = 1;
2975     IsNegativeBranch = true;
2976     break;
2977   case AArch64::TBZW:
2978   case AArch64::TBZX:
2979     TargetBBInMI = 2;
2980     IsTestAndBranch = true;
2981     break;
2982   case AArch64::TBNZW:
2983   case AArch64::TBNZX:
2984     TargetBBInMI = 2;
2985     IsNegativeBranch = true;
2986     IsTestAndBranch = true;
2987     break;
2988   }
2989   // So we increment a zero register and test for bits other
2990   // than bit 0? Conservatively bail out in case the verifier
2991   // missed this case.
2992   if (IsTestAndBranch && MI->getOperand(1).getImm())
2993     return false;
2994 
2995   // Find Definition.
2996   assert(MI->getParent() && "Incomplete machine instruciton\n");
2997   MachineBasicBlock *MBB = MI->getParent();
2998   MachineFunction *MF = MBB->getParent();
2999   MachineRegisterInfo *MRI = &MF->getRegInfo();
3000   unsigned VReg = MI->getOperand(0).getReg();
3001   if (!TargetRegisterInfo::isVirtualRegister(VReg))
3002     return false;
3003 
3004   MachineInstr *DefMI = MRI->getVRegDef(VReg);
3005 
3006   // Look for CSINC
3007   if (!(DefMI->getOpcode() == AArch64::CSINCWr &&
3008         DefMI->getOperand(1).getReg() == AArch64::WZR &&
3009         DefMI->getOperand(2).getReg() == AArch64::WZR) &&
3010       !(DefMI->getOpcode() == AArch64::CSINCXr &&
3011         DefMI->getOperand(1).getReg() == AArch64::XZR &&
3012         DefMI->getOperand(2).getReg() == AArch64::XZR))
3013     return false;
3014 
3015   if (DefMI->findRegisterDefOperandIdx(AArch64::NZCV, true) != -1)
3016     return false;
3017 
3018   AArch64CC::CondCode CC =
3019       (AArch64CC::CondCode)DefMI->getOperand(3).getImm();
3020   bool CheckOnlyCCWrites = true;
3021   // Convert only when the condition code is not modified between
3022   // the CSINC and the branch. The CC may be used by other
3023   // instructions in between.
3024   if (modifiesConditionCode(DefMI, MI, CheckOnlyCCWrites, &getRegisterInfo()))
3025     return false;
3026   MachineBasicBlock &RefToMBB = *MBB;
3027   MachineBasicBlock *TBB = MI->getOperand(TargetBBInMI).getMBB();
3028   DebugLoc DL = MI->getDebugLoc();
3029   if (IsNegativeBranch)
3030     CC = AArch64CC::getInvertedCondCode(CC);
3031   BuildMI(RefToMBB, MI, DL, get(AArch64::Bcc)).addImm(CC).addMBB(TBB);
3032   MI->eraseFromParent();
3033   return true;
3034 }
3035 
3036 std::pair<unsigned, unsigned>
3037 AArch64InstrInfo::decomposeMachineOperandsTargetFlags(unsigned TF) const {
3038   const unsigned Mask = AArch64II::MO_FRAGMENT;
3039   return std::make_pair(TF & Mask, TF & ~Mask);
3040 }
3041 
3042 ArrayRef<std::pair<unsigned, const char *>>
3043 AArch64InstrInfo::getSerializableDirectMachineOperandTargetFlags() const {
3044   using namespace AArch64II;
3045   static const std::pair<unsigned, const char *> TargetFlags[] = {
3046       {MO_PAGE, "aarch64-page"},
3047       {MO_PAGEOFF, "aarch64-pageoff"},
3048       {MO_G3, "aarch64-g3"},
3049       {MO_G2, "aarch64-g2"},
3050       {MO_G1, "aarch64-g1"},
3051       {MO_G0, "aarch64-g0"},
3052       {MO_HI12, "aarch64-hi12"}};
3053   return makeArrayRef(TargetFlags);
3054 }
3055 
3056 ArrayRef<std::pair<unsigned, const char *>>
3057 AArch64InstrInfo::getSerializableBitmaskMachineOperandTargetFlags() const {
3058   using namespace AArch64II;
3059   static const std::pair<unsigned, const char *> TargetFlags[] = {
3060       {MO_GOT, "aarch64-got"},
3061       {MO_NC, "aarch64-nc"},
3062       {MO_TLS, "aarch64-tls"},
3063       {MO_CONSTPOOL, "aarch64-constant-pool"}};
3064   return makeArrayRef(TargetFlags);
3065 }
3066