Use std::bitset for SubtargetFeatures
[oota-llvm.git] / lib / Target / ARM / ARMBaseInstrInfo.cpp
1 //===-- ARMBaseInstrInfo.cpp - ARM 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 Base ARM implementation of the TargetInstrInfo class.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "ARM.h"
15 #include "ARMBaseInstrInfo.h"
16 #include "ARMBaseRegisterInfo.h"
17 #include "ARMConstantPoolValue.h"
18 #include "ARMFeatures.h"
19 #include "ARMHazardRecognizer.h"
20 #include "ARMMachineFunctionInfo.h"
21 #include "MCTargetDesc/ARMAddressingModes.h"
22 #include "llvm/ADT/STLExtras.h"
23 #include "llvm/CodeGen/LiveVariables.h"
24 #include "llvm/CodeGen/MachineConstantPool.h"
25 #include "llvm/CodeGen/MachineFrameInfo.h"
26 #include "llvm/CodeGen/MachineInstrBuilder.h"
27 #include "llvm/CodeGen/MachineJumpTableInfo.h"
28 #include "llvm/CodeGen/MachineMemOperand.h"
29 #include "llvm/CodeGen/MachineRegisterInfo.h"
30 #include "llvm/CodeGen/SelectionDAGNodes.h"
31 #include "llvm/IR/Constants.h"
32 #include "llvm/IR/Function.h"
33 #include "llvm/IR/GlobalValue.h"
34 #include "llvm/MC/MCAsmInfo.h"
35 #include "llvm/MC/MCExpr.h"
36 #include "llvm/Support/BranchProbability.h"
37 #include "llvm/Support/CommandLine.h"
38 #include "llvm/Support/Debug.h"
39 #include "llvm/Support/ErrorHandling.h"
40 #include "llvm/Support/raw_ostream.h"
41
42 using namespace llvm;
43
44 #define DEBUG_TYPE "arm-instrinfo"
45
46 #define GET_INSTRINFO_CTOR_DTOR
47 #include "ARMGenInstrInfo.inc"
48
49 static cl::opt<bool>
50 EnableARM3Addr("enable-arm-3-addr-conv", cl::Hidden,
51                cl::desc("Enable ARM 2-addr to 3-addr conv"));
52
53 static cl::opt<bool>
54 WidenVMOVS("widen-vmovs", cl::Hidden, cl::init(true),
55            cl::desc("Widen ARM vmovs to vmovd when possible"));
56
57 static cl::opt<unsigned>
58 SwiftPartialUpdateClearance("swift-partial-update-clearance",
59      cl::Hidden, cl::init(12),
60      cl::desc("Clearance before partial register updates"));
61
62 /// ARM_MLxEntry - Record information about MLA / MLS instructions.
63 struct ARM_MLxEntry {
64   uint16_t MLxOpc;     // MLA / MLS opcode
65   uint16_t MulOpc;     // Expanded multiplication opcode
66   uint16_t AddSubOpc;  // Expanded add / sub opcode
67   bool NegAcc;         // True if the acc is negated before the add / sub.
68   bool HasLane;        // True if instruction has an extra "lane" operand.
69 };
70
71 static const ARM_MLxEntry ARM_MLxTable[] = {
72   // MLxOpc,          MulOpc,           AddSubOpc,       NegAcc, HasLane
73   // fp scalar ops
74   { ARM::VMLAS,       ARM::VMULS,       ARM::VADDS,      false,  false },
75   { ARM::VMLSS,       ARM::VMULS,       ARM::VSUBS,      false,  false },
76   { ARM::VMLAD,       ARM::VMULD,       ARM::VADDD,      false,  false },
77   { ARM::VMLSD,       ARM::VMULD,       ARM::VSUBD,      false,  false },
78   { ARM::VNMLAS,      ARM::VNMULS,      ARM::VSUBS,      true,   false },
79   { ARM::VNMLSS,      ARM::VMULS,       ARM::VSUBS,      true,   false },
80   { ARM::VNMLAD,      ARM::VNMULD,      ARM::VSUBD,      true,   false },
81   { ARM::VNMLSD,      ARM::VMULD,       ARM::VSUBD,      true,   false },
82
83   // fp SIMD ops
84   { ARM::VMLAfd,      ARM::VMULfd,      ARM::VADDfd,     false,  false },
85   { ARM::VMLSfd,      ARM::VMULfd,      ARM::VSUBfd,     false,  false },
86   { ARM::VMLAfq,      ARM::VMULfq,      ARM::VADDfq,     false,  false },
87   { ARM::VMLSfq,      ARM::VMULfq,      ARM::VSUBfq,     false,  false },
88   { ARM::VMLAslfd,    ARM::VMULslfd,    ARM::VADDfd,     false,  true  },
89   { ARM::VMLSslfd,    ARM::VMULslfd,    ARM::VSUBfd,     false,  true  },
90   { ARM::VMLAslfq,    ARM::VMULslfq,    ARM::VADDfq,     false,  true  },
91   { ARM::VMLSslfq,    ARM::VMULslfq,    ARM::VSUBfq,     false,  true  },
92 };
93
94 ARMBaseInstrInfo::ARMBaseInstrInfo(const ARMSubtarget& STI)
95   : ARMGenInstrInfo(ARM::ADJCALLSTACKDOWN, ARM::ADJCALLSTACKUP),
96     Subtarget(STI) {
97   for (unsigned i = 0, e = array_lengthof(ARM_MLxTable); i != e; ++i) {
98     if (!MLxEntryMap.insert(std::make_pair(ARM_MLxTable[i].MLxOpc, i)).second)
99       assert(false && "Duplicated entries?");
100     MLxHazardOpcodes.insert(ARM_MLxTable[i].AddSubOpc);
101     MLxHazardOpcodes.insert(ARM_MLxTable[i].MulOpc);
102   }
103 }
104
105 // Use a ScoreboardHazardRecognizer for prepass ARM scheduling. TargetInstrImpl
106 // currently defaults to no prepass hazard recognizer.
107 ScheduleHazardRecognizer *
108 ARMBaseInstrInfo::CreateTargetHazardRecognizer(const TargetSubtargetInfo *STI,
109                                                const ScheduleDAG *DAG) const {
110   if (usePreRAHazardRecognizer()) {
111     const InstrItineraryData *II =
112         static_cast<const ARMSubtarget *>(STI)->getInstrItineraryData();
113     return new ScoreboardHazardRecognizer(II, DAG, "pre-RA-sched");
114   }
115   return TargetInstrInfo::CreateTargetHazardRecognizer(STI, DAG);
116 }
117
118 ScheduleHazardRecognizer *ARMBaseInstrInfo::
119 CreateTargetPostRAHazardRecognizer(const InstrItineraryData *II,
120                                    const ScheduleDAG *DAG) const {
121   if (Subtarget.isThumb2() || Subtarget.hasVFP2())
122     return (ScheduleHazardRecognizer *)new ARMHazardRecognizer(II, DAG);
123   return TargetInstrInfo::CreateTargetPostRAHazardRecognizer(II, DAG);
124 }
125
126 MachineInstr *
127 ARMBaseInstrInfo::convertToThreeAddress(MachineFunction::iterator &MFI,
128                                         MachineBasicBlock::iterator &MBBI,
129                                         LiveVariables *LV) const {
130   // FIXME: Thumb2 support.
131
132   if (!EnableARM3Addr)
133     return nullptr;
134
135   MachineInstr *MI = MBBI;
136   MachineFunction &MF = *MI->getParent()->getParent();
137   uint64_t TSFlags = MI->getDesc().TSFlags;
138   bool isPre = false;
139   switch ((TSFlags & ARMII::IndexModeMask) >> ARMII::IndexModeShift) {
140   default: return nullptr;
141   case ARMII::IndexModePre:
142     isPre = true;
143     break;
144   case ARMII::IndexModePost:
145     break;
146   }
147
148   // Try splitting an indexed load/store to an un-indexed one plus an add/sub
149   // operation.
150   unsigned MemOpc = getUnindexedOpcode(MI->getOpcode());
151   if (MemOpc == 0)
152     return nullptr;
153
154   MachineInstr *UpdateMI = nullptr;
155   MachineInstr *MemMI = nullptr;
156   unsigned AddrMode = (TSFlags & ARMII::AddrModeMask);
157   const MCInstrDesc &MCID = MI->getDesc();
158   unsigned NumOps = MCID.getNumOperands();
159   bool isLoad = !MI->mayStore();
160   const MachineOperand &WB = isLoad ? MI->getOperand(1) : MI->getOperand(0);
161   const MachineOperand &Base = MI->getOperand(2);
162   const MachineOperand &Offset = MI->getOperand(NumOps-3);
163   unsigned WBReg = WB.getReg();
164   unsigned BaseReg = Base.getReg();
165   unsigned OffReg = Offset.getReg();
166   unsigned OffImm = MI->getOperand(NumOps-2).getImm();
167   ARMCC::CondCodes Pred = (ARMCC::CondCodes)MI->getOperand(NumOps-1).getImm();
168   switch (AddrMode) {
169   default: llvm_unreachable("Unknown indexed op!");
170   case ARMII::AddrMode2: {
171     bool isSub = ARM_AM::getAM2Op(OffImm) == ARM_AM::sub;
172     unsigned Amt = ARM_AM::getAM2Offset(OffImm);
173     if (OffReg == 0) {
174       if (ARM_AM::getSOImmVal(Amt) == -1)
175         // Can't encode it in a so_imm operand. This transformation will
176         // add more than 1 instruction. Abandon!
177         return nullptr;
178       UpdateMI = BuildMI(MF, MI->getDebugLoc(),
179                          get(isSub ? ARM::SUBri : ARM::ADDri), WBReg)
180         .addReg(BaseReg).addImm(Amt)
181         .addImm(Pred).addReg(0).addReg(0);
182     } else if (Amt != 0) {
183       ARM_AM::ShiftOpc ShOpc = ARM_AM::getAM2ShiftOpc(OffImm);
184       unsigned SOOpc = ARM_AM::getSORegOpc(ShOpc, Amt);
185       UpdateMI = BuildMI(MF, MI->getDebugLoc(),
186                          get(isSub ? ARM::SUBrsi : ARM::ADDrsi), WBReg)
187         .addReg(BaseReg).addReg(OffReg).addReg(0).addImm(SOOpc)
188         .addImm(Pred).addReg(0).addReg(0);
189     } else
190       UpdateMI = BuildMI(MF, MI->getDebugLoc(),
191                          get(isSub ? ARM::SUBrr : ARM::ADDrr), WBReg)
192         .addReg(BaseReg).addReg(OffReg)
193         .addImm(Pred).addReg(0).addReg(0);
194     break;
195   }
196   case ARMII::AddrMode3 : {
197     bool isSub = ARM_AM::getAM3Op(OffImm) == ARM_AM::sub;
198     unsigned Amt = ARM_AM::getAM3Offset(OffImm);
199     if (OffReg == 0)
200       // Immediate is 8-bits. It's guaranteed to fit in a so_imm operand.
201       UpdateMI = BuildMI(MF, MI->getDebugLoc(),
202                          get(isSub ? ARM::SUBri : ARM::ADDri), WBReg)
203         .addReg(BaseReg).addImm(Amt)
204         .addImm(Pred).addReg(0).addReg(0);
205     else
206       UpdateMI = BuildMI(MF, MI->getDebugLoc(),
207                          get(isSub ? ARM::SUBrr : ARM::ADDrr), WBReg)
208         .addReg(BaseReg).addReg(OffReg)
209         .addImm(Pred).addReg(0).addReg(0);
210     break;
211   }
212   }
213
214   std::vector<MachineInstr*> NewMIs;
215   if (isPre) {
216     if (isLoad)
217       MemMI = BuildMI(MF, MI->getDebugLoc(),
218                       get(MemOpc), MI->getOperand(0).getReg())
219         .addReg(WBReg).addImm(0).addImm(Pred);
220     else
221       MemMI = BuildMI(MF, MI->getDebugLoc(),
222                       get(MemOpc)).addReg(MI->getOperand(1).getReg())
223         .addReg(WBReg).addReg(0).addImm(0).addImm(Pred);
224     NewMIs.push_back(MemMI);
225     NewMIs.push_back(UpdateMI);
226   } else {
227     if (isLoad)
228       MemMI = BuildMI(MF, MI->getDebugLoc(),
229                       get(MemOpc), MI->getOperand(0).getReg())
230         .addReg(BaseReg).addImm(0).addImm(Pred);
231     else
232       MemMI = BuildMI(MF, MI->getDebugLoc(),
233                       get(MemOpc)).addReg(MI->getOperand(1).getReg())
234         .addReg(BaseReg).addReg(0).addImm(0).addImm(Pred);
235     if (WB.isDead())
236       UpdateMI->getOperand(0).setIsDead();
237     NewMIs.push_back(UpdateMI);
238     NewMIs.push_back(MemMI);
239   }
240
241   // Transfer LiveVariables states, kill / dead info.
242   if (LV) {
243     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
244       MachineOperand &MO = MI->getOperand(i);
245       if (MO.isReg() && TargetRegisterInfo::isVirtualRegister(MO.getReg())) {
246         unsigned Reg = MO.getReg();
247
248         LiveVariables::VarInfo &VI = LV->getVarInfo(Reg);
249         if (MO.isDef()) {
250           MachineInstr *NewMI = (Reg == WBReg) ? UpdateMI : MemMI;
251           if (MO.isDead())
252             LV->addVirtualRegisterDead(Reg, NewMI);
253         }
254         if (MO.isUse() && MO.isKill()) {
255           for (unsigned j = 0; j < 2; ++j) {
256             // Look at the two new MI's in reverse order.
257             MachineInstr *NewMI = NewMIs[j];
258             if (!NewMI->readsRegister(Reg))
259               continue;
260             LV->addVirtualRegisterKilled(Reg, NewMI);
261             if (VI.removeKill(MI))
262               VI.Kills.push_back(NewMI);
263             break;
264           }
265         }
266       }
267     }
268   }
269
270   MFI->insert(MBBI, NewMIs[1]);
271   MFI->insert(MBBI, NewMIs[0]);
272   return NewMIs[0];
273 }
274
275 // Branch analysis.
276 bool
277 ARMBaseInstrInfo::AnalyzeBranch(MachineBasicBlock &MBB,MachineBasicBlock *&TBB,
278                                 MachineBasicBlock *&FBB,
279                                 SmallVectorImpl<MachineOperand> &Cond,
280                                 bool AllowModify) const {
281   TBB = nullptr;
282   FBB = nullptr;
283
284   MachineBasicBlock::iterator I = MBB.end();
285   if (I == MBB.begin())
286     return false; // Empty blocks are easy.
287   --I;
288
289   // Walk backwards from the end of the basic block until the branch is
290   // analyzed or we give up.
291   while (isPredicated(I) || I->isTerminator() || I->isDebugValue()) {
292
293     // Flag to be raised on unanalyzeable instructions. This is useful in cases
294     // where we want to clean up on the end of the basic block before we bail
295     // out.
296     bool CantAnalyze = false;
297
298     // Skip over DEBUG values and predicated nonterminators.
299     while (I->isDebugValue() || !I->isTerminator()) {
300       if (I == MBB.begin())
301         return false;
302       --I;
303     }
304
305     if (isIndirectBranchOpcode(I->getOpcode()) ||
306         isJumpTableBranchOpcode(I->getOpcode())) {
307       // Indirect branches and jump tables can't be analyzed, but we still want
308       // to clean up any instructions at the tail of the basic block.
309       CantAnalyze = true;
310     } else if (isUncondBranchOpcode(I->getOpcode())) {
311       TBB = I->getOperand(0).getMBB();
312     } else if (isCondBranchOpcode(I->getOpcode())) {
313       // Bail out if we encounter multiple conditional branches.
314       if (!Cond.empty())
315         return true;
316
317       assert(!FBB && "FBB should have been null.");
318       FBB = TBB;
319       TBB = I->getOperand(0).getMBB();
320       Cond.push_back(I->getOperand(1));
321       Cond.push_back(I->getOperand(2));
322     } else if (I->isReturn()) {
323       // Returns can't be analyzed, but we should run cleanup.
324       CantAnalyze = !isPredicated(I);
325     } else {
326       // We encountered other unrecognized terminator. Bail out immediately.
327       return true;
328     }
329
330     // Cleanup code - to be run for unpredicated unconditional branches and
331     //                returns.
332     if (!isPredicated(I) &&
333           (isUncondBranchOpcode(I->getOpcode()) ||
334            isIndirectBranchOpcode(I->getOpcode()) ||
335            isJumpTableBranchOpcode(I->getOpcode()) ||
336            I->isReturn())) {
337       // Forget any previous condition branch information - it no longer applies.
338       Cond.clear();
339       FBB = nullptr;
340
341       // If we can modify the function, delete everything below this
342       // unconditional branch.
343       if (AllowModify) {
344         MachineBasicBlock::iterator DI = std::next(I);
345         while (DI != MBB.end()) {
346           MachineInstr *InstToDelete = DI;
347           ++DI;
348           InstToDelete->eraseFromParent();
349         }
350       }
351     }
352
353     if (CantAnalyze)
354       return true;
355
356     if (I == MBB.begin())
357       return false;
358
359     --I;
360   }
361
362   // We made it past the terminators without bailing out - we must have
363   // analyzed this branch successfully.
364   return false;
365 }
366
367
368 unsigned ARMBaseInstrInfo::RemoveBranch(MachineBasicBlock &MBB) const {
369   MachineBasicBlock::iterator I = MBB.end();
370   if (I == MBB.begin()) return 0;
371   --I;
372   while (I->isDebugValue()) {
373     if (I == MBB.begin())
374       return 0;
375     --I;
376   }
377   if (!isUncondBranchOpcode(I->getOpcode()) &&
378       !isCondBranchOpcode(I->getOpcode()))
379     return 0;
380
381   // Remove the branch.
382   I->eraseFromParent();
383
384   I = MBB.end();
385
386   if (I == MBB.begin()) return 1;
387   --I;
388   if (!isCondBranchOpcode(I->getOpcode()))
389     return 1;
390
391   // Remove the branch.
392   I->eraseFromParent();
393   return 2;
394 }
395
396 unsigned
397 ARMBaseInstrInfo::InsertBranch(MachineBasicBlock &MBB, MachineBasicBlock *TBB,
398                                MachineBasicBlock *FBB,
399                                const SmallVectorImpl<MachineOperand> &Cond,
400                                DebugLoc DL) const {
401   ARMFunctionInfo *AFI = MBB.getParent()->getInfo<ARMFunctionInfo>();
402   int BOpc   = !AFI->isThumbFunction()
403     ? ARM::B : (AFI->isThumb2Function() ? ARM::t2B : ARM::tB);
404   int BccOpc = !AFI->isThumbFunction()
405     ? ARM::Bcc : (AFI->isThumb2Function() ? ARM::t2Bcc : ARM::tBcc);
406   bool isThumb = AFI->isThumbFunction() || AFI->isThumb2Function();
407
408   // Shouldn't be a fall through.
409   assert(TBB && "InsertBranch must not be told to insert a fallthrough");
410   assert((Cond.size() == 2 || Cond.size() == 0) &&
411          "ARM branch conditions have two components!");
412
413   // For conditional branches, we use addOperand to preserve CPSR flags.
414
415   if (!FBB) {
416     if (Cond.empty()) { // Unconditional branch?
417       if (isThumb)
418         BuildMI(&MBB, DL, get(BOpc)).addMBB(TBB).addImm(ARMCC::AL).addReg(0);
419       else
420         BuildMI(&MBB, DL, get(BOpc)).addMBB(TBB);
421     } else
422       BuildMI(&MBB, DL, get(BccOpc)).addMBB(TBB)
423         .addImm(Cond[0].getImm()).addOperand(Cond[1]);
424     return 1;
425   }
426
427   // Two-way conditional branch.
428   BuildMI(&MBB, DL, get(BccOpc)).addMBB(TBB)
429     .addImm(Cond[0].getImm()).addOperand(Cond[1]);
430   if (isThumb)
431     BuildMI(&MBB, DL, get(BOpc)).addMBB(FBB).addImm(ARMCC::AL).addReg(0);
432   else
433     BuildMI(&MBB, DL, get(BOpc)).addMBB(FBB);
434   return 2;
435 }
436
437 bool ARMBaseInstrInfo::
438 ReverseBranchCondition(SmallVectorImpl<MachineOperand> &Cond) const {
439   ARMCC::CondCodes CC = (ARMCC::CondCodes)(int)Cond[0].getImm();
440   Cond[0].setImm(ARMCC::getOppositeCondition(CC));
441   return false;
442 }
443
444 bool ARMBaseInstrInfo::isPredicated(const MachineInstr *MI) const {
445   if (MI->isBundle()) {
446     MachineBasicBlock::const_instr_iterator I = MI;
447     MachineBasicBlock::const_instr_iterator E = MI->getParent()->instr_end();
448     while (++I != E && I->isInsideBundle()) {
449       int PIdx = I->findFirstPredOperandIdx();
450       if (PIdx != -1 && I->getOperand(PIdx).getImm() != ARMCC::AL)
451         return true;
452     }
453     return false;
454   }
455
456   int PIdx = MI->findFirstPredOperandIdx();
457   return PIdx != -1 && MI->getOperand(PIdx).getImm() != ARMCC::AL;
458 }
459
460 bool ARMBaseInstrInfo::
461 PredicateInstruction(MachineInstr *MI,
462                      const SmallVectorImpl<MachineOperand> &Pred) const {
463   unsigned Opc = MI->getOpcode();
464   if (isUncondBranchOpcode(Opc)) {
465     MI->setDesc(get(getMatchingCondBranchOpcode(Opc)));
466     MachineInstrBuilder(*MI->getParent()->getParent(), MI)
467       .addImm(Pred[0].getImm())
468       .addReg(Pred[1].getReg());
469     return true;
470   }
471
472   int PIdx = MI->findFirstPredOperandIdx();
473   if (PIdx != -1) {
474     MachineOperand &PMO = MI->getOperand(PIdx);
475     PMO.setImm(Pred[0].getImm());
476     MI->getOperand(PIdx+1).setReg(Pred[1].getReg());
477     return true;
478   }
479   return false;
480 }
481
482 bool ARMBaseInstrInfo::
483 SubsumesPredicate(const SmallVectorImpl<MachineOperand> &Pred1,
484                   const SmallVectorImpl<MachineOperand> &Pred2) const {
485   if (Pred1.size() > 2 || Pred2.size() > 2)
486     return false;
487
488   ARMCC::CondCodes CC1 = (ARMCC::CondCodes)Pred1[0].getImm();
489   ARMCC::CondCodes CC2 = (ARMCC::CondCodes)Pred2[0].getImm();
490   if (CC1 == CC2)
491     return true;
492
493   switch (CC1) {
494   default:
495     return false;
496   case ARMCC::AL:
497     return true;
498   case ARMCC::HS:
499     return CC2 == ARMCC::HI;
500   case ARMCC::LS:
501     return CC2 == ARMCC::LO || CC2 == ARMCC::EQ;
502   case ARMCC::GE:
503     return CC2 == ARMCC::GT;
504   case ARMCC::LE:
505     return CC2 == ARMCC::LT;
506   }
507 }
508
509 bool ARMBaseInstrInfo::DefinesPredicate(MachineInstr *MI,
510                                     std::vector<MachineOperand> &Pred) const {
511   bool Found = false;
512   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
513     const MachineOperand &MO = MI->getOperand(i);
514     if ((MO.isRegMask() && MO.clobbersPhysReg(ARM::CPSR)) ||
515         (MO.isReg() && MO.isDef() && MO.getReg() == ARM::CPSR)) {
516       Pred.push_back(MO);
517       Found = true;
518     }
519   }
520
521   return Found;
522 }
523
524 static bool isCPSRDefined(const MachineInstr *MI) {
525   for (const auto &MO : MI->operands())
526     if (MO.isReg() && MO.getReg() == ARM::CPSR && MO.isDef())
527       return true;
528   return false;
529 }
530
531 static bool isEligibleForITBlock(const MachineInstr *MI) {
532   switch (MI->getOpcode()) {
533   default: return true;
534   case ARM::tADC:   // ADC (register) T1
535   case ARM::tADDi3: // ADD (immediate) T1
536   case ARM::tADDi8: // ADD (immediate) T2
537   case ARM::tADDrr: // ADD (register) T1
538   case ARM::tAND:   // AND (register) T1
539   case ARM::tASRri: // ASR (immediate) T1
540   case ARM::tASRrr: // ASR (register) T1
541   case ARM::tBIC:   // BIC (register) T1
542   case ARM::tEOR:   // EOR (register) T1
543   case ARM::tLSLri: // LSL (immediate) T1
544   case ARM::tLSLrr: // LSL (register) T1
545   case ARM::tLSRri: // LSR (immediate) T1
546   case ARM::tLSRrr: // LSR (register) T1
547   case ARM::tMUL:   // MUL T1
548   case ARM::tMVN:   // MVN (register) T1
549   case ARM::tORR:   // ORR (register) T1
550   case ARM::tROR:   // ROR (register) T1
551   case ARM::tRSB:   // RSB (immediate) T1
552   case ARM::tSBC:   // SBC (register) T1
553   case ARM::tSUBi3: // SUB (immediate) T1
554   case ARM::tSUBi8: // SUB (immediate) T2
555   case ARM::tSUBrr: // SUB (register) T1
556     return !isCPSRDefined(MI);
557   }
558 }
559
560 /// isPredicable - Return true if the specified instruction can be predicated.
561 /// By default, this returns true for every instruction with a
562 /// PredicateOperand.
563 bool ARMBaseInstrInfo::isPredicable(MachineInstr *MI) const {
564   if (!MI->isPredicable())
565     return false;
566
567   if (!isEligibleForITBlock(MI))
568     return false;
569
570   ARMFunctionInfo *AFI =
571     MI->getParent()->getParent()->getInfo<ARMFunctionInfo>();
572
573   if (AFI->isThumb2Function()) {
574     if (getSubtarget().restrictIT())
575       return isV8EligibleForIT(MI);
576   } else { // non-Thumb
577     if ((MI->getDesc().TSFlags & ARMII::DomainMask) == ARMII::DomainNEON)
578       return false;
579   }
580
581   return true;
582 }
583
584 namespace llvm {
585 template <> bool IsCPSRDead<MachineInstr>(MachineInstr *MI) {
586   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
587     const MachineOperand &MO = MI->getOperand(i);
588     if (!MO.isReg() || MO.isUndef() || MO.isUse())
589       continue;
590     if (MO.getReg() != ARM::CPSR)
591       continue;
592     if (!MO.isDead())
593       return false;
594   }
595   // all definitions of CPSR are dead
596   return true;
597 }
598 }
599
600 /// GetInstSize - Return the size of the specified MachineInstr.
601 ///
602 unsigned ARMBaseInstrInfo::GetInstSizeInBytes(const MachineInstr *MI) const {
603   const MachineBasicBlock &MBB = *MI->getParent();
604   const MachineFunction *MF = MBB.getParent();
605   const MCAsmInfo *MAI = MF->getTarget().getMCAsmInfo();
606
607   const MCInstrDesc &MCID = MI->getDesc();
608   if (MCID.getSize())
609     return MCID.getSize();
610
611   // If this machine instr is an inline asm, measure it.
612   if (MI->getOpcode() == ARM::INLINEASM)
613     return getInlineAsmLength(MI->getOperand(0).getSymbolName(), *MAI);
614   unsigned Opc = MI->getOpcode();
615   switch (Opc) {
616   default:
617     // pseudo-instruction sizes are zero.
618     return 0;
619   case TargetOpcode::BUNDLE:
620     return getInstBundleLength(MI);
621   case ARM::MOVi16_ga_pcrel:
622   case ARM::MOVTi16_ga_pcrel:
623   case ARM::t2MOVi16_ga_pcrel:
624   case ARM::t2MOVTi16_ga_pcrel:
625     return 4;
626   case ARM::MOVi32imm:
627   case ARM::t2MOVi32imm:
628     return 8;
629   case ARM::CONSTPOOL_ENTRY:
630     // If this machine instr is a constant pool entry, its size is recorded as
631     // operand #2.
632     return MI->getOperand(2).getImm();
633   case ARM::Int_eh_sjlj_longjmp:
634     return 16;
635   case ARM::tInt_eh_sjlj_longjmp:
636     return 10;
637   case ARM::Int_eh_sjlj_setjmp:
638   case ARM::Int_eh_sjlj_setjmp_nofp:
639     return 20;
640   case ARM::tInt_eh_sjlj_setjmp:
641   case ARM::t2Int_eh_sjlj_setjmp:
642   case ARM::t2Int_eh_sjlj_setjmp_nofp:
643     return 12;
644   case ARM::BR_JTr:
645   case ARM::BR_JTm:
646   case ARM::BR_JTadd:
647   case ARM::tBR_JTr:
648   case ARM::t2BR_JT:
649   case ARM::t2TBB_JT:
650   case ARM::t2TBH_JT: {
651     // These are jumptable branches, i.e. a branch followed by an inlined
652     // jumptable. The size is 4 + 4 * number of entries. For TBB, each
653     // entry is one byte; TBH two byte each.
654     unsigned EntrySize = (Opc == ARM::t2TBB_JT)
655       ? 1 : ((Opc == ARM::t2TBH_JT) ? 2 : 4);
656     unsigned NumOps = MCID.getNumOperands();
657     MachineOperand JTOP =
658       MI->getOperand(NumOps - (MI->isPredicable() ? 3 : 2));
659     unsigned JTI = JTOP.getIndex();
660     const MachineJumpTableInfo *MJTI = MF->getJumpTableInfo();
661     assert(MJTI != nullptr);
662     const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
663     assert(JTI < JT.size());
664     // Thumb instructions are 2 byte aligned, but JT entries are 4 byte
665     // 4 aligned. The assembler / linker may add 2 byte padding just before
666     // the JT entries.  The size does not include this padding; the
667     // constant islands pass does separate bookkeeping for it.
668     // FIXME: If we know the size of the function is less than (1 << 16) *2
669     // bytes, we can use 16-bit entries instead. Then there won't be an
670     // alignment issue.
671     unsigned InstSize = (Opc == ARM::tBR_JTr || Opc == ARM::t2BR_JT) ? 2 : 4;
672     unsigned NumEntries = JT[JTI].MBBs.size();
673     if (Opc == ARM::t2TBB_JT && (NumEntries & 1))
674       // Make sure the instruction that follows TBB is 2-byte aligned.
675       // FIXME: Constant island pass should insert an "ALIGN" instruction
676       // instead.
677       ++NumEntries;
678     return NumEntries * EntrySize + InstSize;
679   }
680   case ARM::SPACE:
681     return MI->getOperand(1).getImm();
682   }
683 }
684
685 unsigned ARMBaseInstrInfo::getInstBundleLength(const MachineInstr *MI) const {
686   unsigned Size = 0;
687   MachineBasicBlock::const_instr_iterator I = MI;
688   MachineBasicBlock::const_instr_iterator E = MI->getParent()->instr_end();
689   while (++I != E && I->isInsideBundle()) {
690     assert(!I->isBundle() && "No nested bundle!");
691     Size += GetInstSizeInBytes(&*I);
692   }
693   return Size;
694 }
695
696 void ARMBaseInstrInfo::copyFromCPSR(MachineBasicBlock &MBB,
697                                     MachineBasicBlock::iterator I,
698                                     unsigned DestReg, bool KillSrc,
699                                     const ARMSubtarget &Subtarget) const {
700   unsigned Opc = Subtarget.isThumb()
701                      ? (Subtarget.isMClass() ? ARM::t2MRS_M : ARM::t2MRS_AR)
702                      : ARM::MRS;
703
704   MachineInstrBuilder MIB =
705       BuildMI(MBB, I, I->getDebugLoc(), get(Opc), DestReg);
706
707   // There is only 1 A/R class MRS instruction, and it always refers to
708   // APSR. However, there are lots of other possibilities on M-class cores.
709   if (Subtarget.isMClass())
710     MIB.addImm(0x800);
711
712   AddDefaultPred(MIB);
713
714   MIB.addReg(ARM::CPSR, RegState::Implicit | getKillRegState(KillSrc));
715 }
716
717 void ARMBaseInstrInfo::copyToCPSR(MachineBasicBlock &MBB,
718                                   MachineBasicBlock::iterator I,
719                                   unsigned SrcReg, bool KillSrc,
720                                   const ARMSubtarget &Subtarget) const {
721   unsigned Opc = Subtarget.isThumb()
722                      ? (Subtarget.isMClass() ? ARM::t2MSR_M : ARM::t2MSR_AR)
723                      : ARM::MSR;
724
725   MachineInstrBuilder MIB = BuildMI(MBB, I, I->getDebugLoc(), get(Opc));
726
727   if (Subtarget.isMClass())
728     MIB.addImm(0x800);
729   else
730     MIB.addImm(8);
731
732   MIB.addReg(SrcReg, getKillRegState(KillSrc));
733
734   AddDefaultPred(MIB);
735
736   MIB.addReg(ARM::CPSR, RegState::Implicit | RegState::Define);
737 }
738
739 void ARMBaseInstrInfo::copyPhysReg(MachineBasicBlock &MBB,
740                                    MachineBasicBlock::iterator I, DebugLoc DL,
741                                    unsigned DestReg, unsigned SrcReg,
742                                    bool KillSrc) const {
743   bool GPRDest = ARM::GPRRegClass.contains(DestReg);
744   bool GPRSrc = ARM::GPRRegClass.contains(SrcReg);
745
746   if (GPRDest && GPRSrc) {
747     AddDefaultCC(AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::MOVr), DestReg)
748                                     .addReg(SrcReg, getKillRegState(KillSrc))));
749     return;
750   }
751
752   bool SPRDest = ARM::SPRRegClass.contains(DestReg);
753   bool SPRSrc = ARM::SPRRegClass.contains(SrcReg);
754
755   unsigned Opc = 0;
756   if (SPRDest && SPRSrc)
757     Opc = ARM::VMOVS;
758   else if (GPRDest && SPRSrc)
759     Opc = ARM::VMOVRS;
760   else if (SPRDest && GPRSrc)
761     Opc = ARM::VMOVSR;
762   else if (ARM::DPRRegClass.contains(DestReg, SrcReg) && !Subtarget.isFPOnlySP())
763     Opc = ARM::VMOVD;
764   else if (ARM::QPRRegClass.contains(DestReg, SrcReg))
765     Opc = ARM::VORRq;
766
767   if (Opc) {
768     MachineInstrBuilder MIB = BuildMI(MBB, I, DL, get(Opc), DestReg);
769     MIB.addReg(SrcReg, getKillRegState(KillSrc));
770     if (Opc == ARM::VORRq)
771       MIB.addReg(SrcReg, getKillRegState(KillSrc));
772     AddDefaultPred(MIB);
773     return;
774   }
775
776   // Handle register classes that require multiple instructions.
777   unsigned BeginIdx = 0;
778   unsigned SubRegs = 0;
779   int Spacing = 1;
780
781   // Use VORRq when possible.
782   if (ARM::QQPRRegClass.contains(DestReg, SrcReg)) {
783     Opc = ARM::VORRq;
784     BeginIdx = ARM::qsub_0;
785     SubRegs = 2;
786   } else if (ARM::QQQQPRRegClass.contains(DestReg, SrcReg)) {
787     Opc = ARM::VORRq;
788     BeginIdx = ARM::qsub_0;
789     SubRegs = 4;
790   // Fall back to VMOVD.
791   } else if (ARM::DPairRegClass.contains(DestReg, SrcReg)) {
792     Opc = ARM::VMOVD;
793     BeginIdx = ARM::dsub_0;
794     SubRegs = 2;
795   } else if (ARM::DTripleRegClass.contains(DestReg, SrcReg)) {
796     Opc = ARM::VMOVD;
797     BeginIdx = ARM::dsub_0;
798     SubRegs = 3;
799   } else if (ARM::DQuadRegClass.contains(DestReg, SrcReg)) {
800     Opc = ARM::VMOVD;
801     BeginIdx = ARM::dsub_0;
802     SubRegs = 4;
803   } else if (ARM::GPRPairRegClass.contains(DestReg, SrcReg)) {
804     Opc = Subtarget.isThumb2() ? ARM::tMOVr : ARM::MOVr;
805     BeginIdx = ARM::gsub_0;
806     SubRegs = 2;
807   } else if (ARM::DPairSpcRegClass.contains(DestReg, SrcReg)) {
808     Opc = ARM::VMOVD;
809     BeginIdx = ARM::dsub_0;
810     SubRegs = 2;
811     Spacing = 2;
812   } else if (ARM::DTripleSpcRegClass.contains(DestReg, SrcReg)) {
813     Opc = ARM::VMOVD;
814     BeginIdx = ARM::dsub_0;
815     SubRegs = 3;
816     Spacing = 2;
817   } else if (ARM::DQuadSpcRegClass.contains(DestReg, SrcReg)) {
818     Opc = ARM::VMOVD;
819     BeginIdx = ARM::dsub_0;
820     SubRegs = 4;
821     Spacing = 2;
822   } else if (ARM::DPRRegClass.contains(DestReg, SrcReg) && Subtarget.isFPOnlySP()) {
823     Opc = ARM::VMOVS;
824     BeginIdx = ARM::ssub_0;
825     SubRegs = 2;
826   } else if (SrcReg == ARM::CPSR) {
827     copyFromCPSR(MBB, I, DestReg, KillSrc, Subtarget);
828     return;
829   } else if (DestReg == ARM::CPSR) {
830     copyToCPSR(MBB, I, SrcReg, KillSrc, Subtarget);
831     return;
832   }
833
834   assert(Opc && "Impossible reg-to-reg copy");
835
836   const TargetRegisterInfo *TRI = &getRegisterInfo();
837   MachineInstrBuilder Mov;
838
839   // Copy register tuples backward when the first Dest reg overlaps with SrcReg.
840   if (TRI->regsOverlap(SrcReg, TRI->getSubReg(DestReg, BeginIdx))) {
841     BeginIdx = BeginIdx + ((SubRegs - 1) * Spacing);
842     Spacing = -Spacing;
843   }
844 #ifndef NDEBUG
845   SmallSet<unsigned, 4> DstRegs;
846 #endif
847   for (unsigned i = 0; i != SubRegs; ++i) {
848     unsigned Dst = TRI->getSubReg(DestReg, BeginIdx + i * Spacing);
849     unsigned Src = TRI->getSubReg(SrcReg, BeginIdx + i * Spacing);
850     assert(Dst && Src && "Bad sub-register");
851 #ifndef NDEBUG
852     assert(!DstRegs.count(Src) && "destructive vector copy");
853     DstRegs.insert(Dst);
854 #endif
855     Mov = BuildMI(MBB, I, I->getDebugLoc(), get(Opc), Dst).addReg(Src);
856     // VORR takes two source operands.
857     if (Opc == ARM::VORRq)
858       Mov.addReg(Src);
859     Mov = AddDefaultPred(Mov);
860     // MOVr can set CC.
861     if (Opc == ARM::MOVr)
862       Mov = AddDefaultCC(Mov);
863   }
864   // Add implicit super-register defs and kills to the last instruction.
865   Mov->addRegisterDefined(DestReg, TRI);
866   if (KillSrc)
867     Mov->addRegisterKilled(SrcReg, TRI);
868 }
869
870 const MachineInstrBuilder &
871 ARMBaseInstrInfo::AddDReg(MachineInstrBuilder &MIB, unsigned Reg,
872                           unsigned SubIdx, unsigned State,
873                           const TargetRegisterInfo *TRI) const {
874   if (!SubIdx)
875     return MIB.addReg(Reg, State);
876
877   if (TargetRegisterInfo::isPhysicalRegister(Reg))
878     return MIB.addReg(TRI->getSubReg(Reg, SubIdx), State);
879   return MIB.addReg(Reg, State, SubIdx);
880 }
881
882 void ARMBaseInstrInfo::
883 storeRegToStackSlot(MachineBasicBlock &MBB, MachineBasicBlock::iterator I,
884                     unsigned SrcReg, bool isKill, int FI,
885                     const TargetRegisterClass *RC,
886                     const TargetRegisterInfo *TRI) const {
887   DebugLoc DL;
888   if (I != MBB.end()) DL = I->getDebugLoc();
889   MachineFunction &MF = *MBB.getParent();
890   MachineFrameInfo &MFI = *MF.getFrameInfo();
891   unsigned Align = MFI.getObjectAlignment(FI);
892
893   MachineMemOperand *MMO =
894     MF.getMachineMemOperand(MachinePointerInfo::getFixedStack(FI),
895                             MachineMemOperand::MOStore,
896                             MFI.getObjectSize(FI),
897                             Align);
898
899   switch (RC->getSize()) {
900     case 4:
901       if (ARM::GPRRegClass.hasSubClassEq(RC)) {
902         AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::STRi12))
903                    .addReg(SrcReg, getKillRegState(isKill))
904                    .addFrameIndex(FI).addImm(0).addMemOperand(MMO));
905       } else if (ARM::SPRRegClass.hasSubClassEq(RC)) {
906         AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::VSTRS))
907                    .addReg(SrcReg, getKillRegState(isKill))
908                    .addFrameIndex(FI).addImm(0).addMemOperand(MMO));
909       } else
910         llvm_unreachable("Unknown reg class!");
911       break;
912     case 8:
913       if (ARM::DPRRegClass.hasSubClassEq(RC)) {
914         AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::VSTRD))
915                    .addReg(SrcReg, getKillRegState(isKill))
916                    .addFrameIndex(FI).addImm(0).addMemOperand(MMO));
917       } else if (ARM::GPRPairRegClass.hasSubClassEq(RC)) {
918         if (Subtarget.hasV5TEOps()) {
919           MachineInstrBuilder MIB = BuildMI(MBB, I, DL, get(ARM::STRD));
920           AddDReg(MIB, SrcReg, ARM::gsub_0, getKillRegState(isKill), TRI);
921           AddDReg(MIB, SrcReg, ARM::gsub_1, 0, TRI);
922           MIB.addFrameIndex(FI).addReg(0).addImm(0).addMemOperand(MMO);
923
924           AddDefaultPred(MIB);
925         } else {
926           // Fallback to STM instruction, which has existed since the dawn of
927           // time.
928           MachineInstrBuilder MIB =
929             AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::STMIA))
930                              .addFrameIndex(FI).addMemOperand(MMO));
931           AddDReg(MIB, SrcReg, ARM::gsub_0, getKillRegState(isKill), TRI);
932           AddDReg(MIB, SrcReg, ARM::gsub_1, 0, TRI);
933         }
934       } else
935         llvm_unreachable("Unknown reg class!");
936       break;
937     case 16:
938       if (ARM::DPairRegClass.hasSubClassEq(RC)) {
939         // Use aligned spills if the stack can be realigned.
940         if (Align >= 16 && getRegisterInfo().canRealignStack(MF)) {
941           AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::VST1q64))
942                      .addFrameIndex(FI).addImm(16)
943                      .addReg(SrcReg, getKillRegState(isKill))
944                      .addMemOperand(MMO));
945         } else {
946           AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::VSTMQIA))
947                      .addReg(SrcReg, getKillRegState(isKill))
948                      .addFrameIndex(FI)
949                      .addMemOperand(MMO));
950         }
951       } else
952         llvm_unreachable("Unknown reg class!");
953       break;
954     case 24:
955       if (ARM::DTripleRegClass.hasSubClassEq(RC)) {
956         // Use aligned spills if the stack can be realigned.
957         if (Align >= 16 && getRegisterInfo().canRealignStack(MF)) {
958           AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::VST1d64TPseudo))
959                      .addFrameIndex(FI).addImm(16)
960                      .addReg(SrcReg, getKillRegState(isKill))
961                      .addMemOperand(MMO));
962         } else {
963           MachineInstrBuilder MIB =
964           AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::VSTMDIA))
965                        .addFrameIndex(FI))
966                        .addMemOperand(MMO);
967           MIB = AddDReg(MIB, SrcReg, ARM::dsub_0, getKillRegState(isKill), TRI);
968           MIB = AddDReg(MIB, SrcReg, ARM::dsub_1, 0, TRI);
969           AddDReg(MIB, SrcReg, ARM::dsub_2, 0, TRI);
970         }
971       } else
972         llvm_unreachable("Unknown reg class!");
973       break;
974     case 32:
975       if (ARM::QQPRRegClass.hasSubClassEq(RC) || ARM::DQuadRegClass.hasSubClassEq(RC)) {
976         if (Align >= 16 && getRegisterInfo().canRealignStack(MF)) {
977           // FIXME: It's possible to only store part of the QQ register if the
978           // spilled def has a sub-register index.
979           AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::VST1d64QPseudo))
980                      .addFrameIndex(FI).addImm(16)
981                      .addReg(SrcReg, getKillRegState(isKill))
982                      .addMemOperand(MMO));
983         } else {
984           MachineInstrBuilder MIB =
985           AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::VSTMDIA))
986                        .addFrameIndex(FI))
987                        .addMemOperand(MMO);
988           MIB = AddDReg(MIB, SrcReg, ARM::dsub_0, getKillRegState(isKill), TRI);
989           MIB = AddDReg(MIB, SrcReg, ARM::dsub_1, 0, TRI);
990           MIB = AddDReg(MIB, SrcReg, ARM::dsub_2, 0, TRI);
991                 AddDReg(MIB, SrcReg, ARM::dsub_3, 0, TRI);
992         }
993       } else
994         llvm_unreachable("Unknown reg class!");
995       break;
996     case 64:
997       if (ARM::QQQQPRRegClass.hasSubClassEq(RC)) {
998         MachineInstrBuilder MIB =
999           AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::VSTMDIA))
1000                          .addFrameIndex(FI))
1001                          .addMemOperand(MMO);
1002         MIB = AddDReg(MIB, SrcReg, ARM::dsub_0, getKillRegState(isKill), TRI);
1003         MIB = AddDReg(MIB, SrcReg, ARM::dsub_1, 0, TRI);
1004         MIB = AddDReg(MIB, SrcReg, ARM::dsub_2, 0, TRI);
1005         MIB = AddDReg(MIB, SrcReg, ARM::dsub_3, 0, TRI);
1006         MIB = AddDReg(MIB, SrcReg, ARM::dsub_4, 0, TRI);
1007         MIB = AddDReg(MIB, SrcReg, ARM::dsub_5, 0, TRI);
1008         MIB = AddDReg(MIB, SrcReg, ARM::dsub_6, 0, TRI);
1009               AddDReg(MIB, SrcReg, ARM::dsub_7, 0, TRI);
1010       } else
1011         llvm_unreachable("Unknown reg class!");
1012       break;
1013     default:
1014       llvm_unreachable("Unknown reg class!");
1015   }
1016 }
1017
1018 unsigned
1019 ARMBaseInstrInfo::isStoreToStackSlot(const MachineInstr *MI,
1020                                      int &FrameIndex) const {
1021   switch (MI->getOpcode()) {
1022   default: break;
1023   case ARM::STRrs:
1024   case ARM::t2STRs: // FIXME: don't use t2STRs to access frame.
1025     if (MI->getOperand(1).isFI() &&
1026         MI->getOperand(2).isReg() &&
1027         MI->getOperand(3).isImm() &&
1028         MI->getOperand(2).getReg() == 0 &&
1029         MI->getOperand(3).getImm() == 0) {
1030       FrameIndex = MI->getOperand(1).getIndex();
1031       return MI->getOperand(0).getReg();
1032     }
1033     break;
1034   case ARM::STRi12:
1035   case ARM::t2STRi12:
1036   case ARM::tSTRspi:
1037   case ARM::VSTRD:
1038   case ARM::VSTRS:
1039     if (MI->getOperand(1).isFI() &&
1040         MI->getOperand(2).isImm() &&
1041         MI->getOperand(2).getImm() == 0) {
1042       FrameIndex = MI->getOperand(1).getIndex();
1043       return MI->getOperand(0).getReg();
1044     }
1045     break;
1046   case ARM::VST1q64:
1047   case ARM::VST1d64TPseudo:
1048   case ARM::VST1d64QPseudo:
1049     if (MI->getOperand(0).isFI() &&
1050         MI->getOperand(2).getSubReg() == 0) {
1051       FrameIndex = MI->getOperand(0).getIndex();
1052       return MI->getOperand(2).getReg();
1053     }
1054     break;
1055   case ARM::VSTMQIA:
1056     if (MI->getOperand(1).isFI() &&
1057         MI->getOperand(0).getSubReg() == 0) {
1058       FrameIndex = MI->getOperand(1).getIndex();
1059       return MI->getOperand(0).getReg();
1060     }
1061     break;
1062   }
1063
1064   return 0;
1065 }
1066
1067 unsigned ARMBaseInstrInfo::isStoreToStackSlotPostFE(const MachineInstr *MI,
1068                                                     int &FrameIndex) const {
1069   const MachineMemOperand *Dummy;
1070   return MI->mayStore() && hasStoreToStackSlot(MI, Dummy, FrameIndex);
1071 }
1072
1073 void ARMBaseInstrInfo::
1074 loadRegFromStackSlot(MachineBasicBlock &MBB, MachineBasicBlock::iterator I,
1075                      unsigned DestReg, int FI,
1076                      const TargetRegisterClass *RC,
1077                      const TargetRegisterInfo *TRI) const {
1078   DebugLoc DL;
1079   if (I != MBB.end()) DL = I->getDebugLoc();
1080   MachineFunction &MF = *MBB.getParent();
1081   MachineFrameInfo &MFI = *MF.getFrameInfo();
1082   unsigned Align = MFI.getObjectAlignment(FI);
1083   MachineMemOperand *MMO =
1084     MF.getMachineMemOperand(
1085                     MachinePointerInfo::getFixedStack(FI),
1086                             MachineMemOperand::MOLoad,
1087                             MFI.getObjectSize(FI),
1088                             Align);
1089
1090   switch (RC->getSize()) {
1091   case 4:
1092     if (ARM::GPRRegClass.hasSubClassEq(RC)) {
1093       AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::LDRi12), DestReg)
1094                    .addFrameIndex(FI).addImm(0).addMemOperand(MMO));
1095
1096     } else if (ARM::SPRRegClass.hasSubClassEq(RC)) {
1097       AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::VLDRS), DestReg)
1098                    .addFrameIndex(FI).addImm(0).addMemOperand(MMO));
1099     } else
1100       llvm_unreachable("Unknown reg class!");
1101     break;
1102   case 8:
1103     if (ARM::DPRRegClass.hasSubClassEq(RC)) {
1104       AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::VLDRD), DestReg)
1105                    .addFrameIndex(FI).addImm(0).addMemOperand(MMO));
1106     } else if (ARM::GPRPairRegClass.hasSubClassEq(RC)) {
1107       MachineInstrBuilder MIB;
1108
1109       if (Subtarget.hasV5TEOps()) {
1110         MIB = BuildMI(MBB, I, DL, get(ARM::LDRD));
1111         AddDReg(MIB, DestReg, ARM::gsub_0, RegState::DefineNoRead, TRI);
1112         AddDReg(MIB, DestReg, ARM::gsub_1, RegState::DefineNoRead, TRI);
1113         MIB.addFrameIndex(FI).addReg(0).addImm(0).addMemOperand(MMO);
1114
1115         AddDefaultPred(MIB);
1116       } else {
1117         // Fallback to LDM instruction, which has existed since the dawn of
1118         // time.
1119         MIB = AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::LDMIA))
1120                                  .addFrameIndex(FI).addMemOperand(MMO));
1121         MIB = AddDReg(MIB, DestReg, ARM::gsub_0, RegState::DefineNoRead, TRI);
1122         MIB = AddDReg(MIB, DestReg, ARM::gsub_1, RegState::DefineNoRead, TRI);
1123       }
1124
1125       if (TargetRegisterInfo::isPhysicalRegister(DestReg))
1126         MIB.addReg(DestReg, RegState::ImplicitDefine);
1127     } else
1128       llvm_unreachable("Unknown reg class!");
1129     break;
1130   case 16:
1131     if (ARM::DPairRegClass.hasSubClassEq(RC)) {
1132       if (Align >= 16 && getRegisterInfo().canRealignStack(MF)) {
1133         AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::VLD1q64), DestReg)
1134                      .addFrameIndex(FI).addImm(16)
1135                      .addMemOperand(MMO));
1136       } else {
1137         AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::VLDMQIA), DestReg)
1138                        .addFrameIndex(FI)
1139                        .addMemOperand(MMO));
1140       }
1141     } else
1142       llvm_unreachable("Unknown reg class!");
1143     break;
1144   case 24:
1145     if (ARM::DTripleRegClass.hasSubClassEq(RC)) {
1146       if (Align >= 16 && getRegisterInfo().canRealignStack(MF)) {
1147         AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::VLD1d64TPseudo), DestReg)
1148                      .addFrameIndex(FI).addImm(16)
1149                      .addMemOperand(MMO));
1150       } else {
1151         MachineInstrBuilder MIB =
1152           AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::VLDMDIA))
1153                          .addFrameIndex(FI)
1154                          .addMemOperand(MMO));
1155         MIB = AddDReg(MIB, DestReg, ARM::dsub_0, RegState::DefineNoRead, TRI);
1156         MIB = AddDReg(MIB, DestReg, ARM::dsub_1, RegState::DefineNoRead, TRI);
1157         MIB = AddDReg(MIB, DestReg, ARM::dsub_2, RegState::DefineNoRead, TRI);
1158         if (TargetRegisterInfo::isPhysicalRegister(DestReg))
1159           MIB.addReg(DestReg, RegState::ImplicitDefine);
1160       }
1161     } else
1162       llvm_unreachable("Unknown reg class!");
1163     break;
1164    case 32:
1165     if (ARM::QQPRRegClass.hasSubClassEq(RC) || ARM::DQuadRegClass.hasSubClassEq(RC)) {
1166       if (Align >= 16 && getRegisterInfo().canRealignStack(MF)) {
1167         AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::VLD1d64QPseudo), DestReg)
1168                      .addFrameIndex(FI).addImm(16)
1169                      .addMemOperand(MMO));
1170       } else {
1171         MachineInstrBuilder MIB =
1172         AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::VLDMDIA))
1173                        .addFrameIndex(FI))
1174                        .addMemOperand(MMO);
1175         MIB = AddDReg(MIB, DestReg, ARM::dsub_0, RegState::DefineNoRead, TRI);
1176         MIB = AddDReg(MIB, DestReg, ARM::dsub_1, RegState::DefineNoRead, TRI);
1177         MIB = AddDReg(MIB, DestReg, ARM::dsub_2, RegState::DefineNoRead, TRI);
1178         MIB = AddDReg(MIB, DestReg, ARM::dsub_3, RegState::DefineNoRead, TRI);
1179         if (TargetRegisterInfo::isPhysicalRegister(DestReg))
1180           MIB.addReg(DestReg, RegState::ImplicitDefine);
1181       }
1182     } else
1183       llvm_unreachable("Unknown reg class!");
1184     break;
1185   case 64:
1186     if (ARM::QQQQPRRegClass.hasSubClassEq(RC)) {
1187       MachineInstrBuilder MIB =
1188       AddDefaultPred(BuildMI(MBB, I, DL, get(ARM::VLDMDIA))
1189                      .addFrameIndex(FI))
1190                      .addMemOperand(MMO);
1191       MIB = AddDReg(MIB, DestReg, ARM::dsub_0, RegState::DefineNoRead, TRI);
1192       MIB = AddDReg(MIB, DestReg, ARM::dsub_1, RegState::DefineNoRead, TRI);
1193       MIB = AddDReg(MIB, DestReg, ARM::dsub_2, RegState::DefineNoRead, TRI);
1194       MIB = AddDReg(MIB, DestReg, ARM::dsub_3, RegState::DefineNoRead, TRI);
1195       MIB = AddDReg(MIB, DestReg, ARM::dsub_4, RegState::DefineNoRead, TRI);
1196       MIB = AddDReg(MIB, DestReg, ARM::dsub_5, RegState::DefineNoRead, TRI);
1197       MIB = AddDReg(MIB, DestReg, ARM::dsub_6, RegState::DefineNoRead, TRI);
1198       MIB = AddDReg(MIB, DestReg, ARM::dsub_7, RegState::DefineNoRead, TRI);
1199       if (TargetRegisterInfo::isPhysicalRegister(DestReg))
1200         MIB.addReg(DestReg, RegState::ImplicitDefine);
1201     } else
1202       llvm_unreachable("Unknown reg class!");
1203     break;
1204   default:
1205     llvm_unreachable("Unknown regclass!");
1206   }
1207 }
1208
1209 unsigned
1210 ARMBaseInstrInfo::isLoadFromStackSlot(const MachineInstr *MI,
1211                                       int &FrameIndex) const {
1212   switch (MI->getOpcode()) {
1213   default: break;
1214   case ARM::LDRrs:
1215   case ARM::t2LDRs:  // FIXME: don't use t2LDRs to access frame.
1216     if (MI->getOperand(1).isFI() &&
1217         MI->getOperand(2).isReg() &&
1218         MI->getOperand(3).isImm() &&
1219         MI->getOperand(2).getReg() == 0 &&
1220         MI->getOperand(3).getImm() == 0) {
1221       FrameIndex = MI->getOperand(1).getIndex();
1222       return MI->getOperand(0).getReg();
1223     }
1224     break;
1225   case ARM::LDRi12:
1226   case ARM::t2LDRi12:
1227   case ARM::tLDRspi:
1228   case ARM::VLDRD:
1229   case ARM::VLDRS:
1230     if (MI->getOperand(1).isFI() &&
1231         MI->getOperand(2).isImm() &&
1232         MI->getOperand(2).getImm() == 0) {
1233       FrameIndex = MI->getOperand(1).getIndex();
1234       return MI->getOperand(0).getReg();
1235     }
1236     break;
1237   case ARM::VLD1q64:
1238   case ARM::VLD1d64TPseudo:
1239   case ARM::VLD1d64QPseudo:
1240     if (MI->getOperand(1).isFI() &&
1241         MI->getOperand(0).getSubReg() == 0) {
1242       FrameIndex = MI->getOperand(1).getIndex();
1243       return MI->getOperand(0).getReg();
1244     }
1245     break;
1246   case ARM::VLDMQIA:
1247     if (MI->getOperand(1).isFI() &&
1248         MI->getOperand(0).getSubReg() == 0) {
1249       FrameIndex = MI->getOperand(1).getIndex();
1250       return MI->getOperand(0).getReg();
1251     }
1252     break;
1253   }
1254
1255   return 0;
1256 }
1257
1258 unsigned ARMBaseInstrInfo::isLoadFromStackSlotPostFE(const MachineInstr *MI,
1259                                              int &FrameIndex) const {
1260   const MachineMemOperand *Dummy;
1261   return MI->mayLoad() && hasLoadFromStackSlot(MI, Dummy, FrameIndex);
1262 }
1263
1264 bool
1265 ARMBaseInstrInfo::expandPostRAPseudo(MachineBasicBlock::iterator MI) const {
1266   MachineFunction &MF = *MI->getParent()->getParent();
1267   Reloc::Model RM = MF.getTarget().getRelocationModel();
1268
1269   if (MI->getOpcode() == TargetOpcode::LOAD_STACK_GUARD) {
1270     assert(getSubtarget().getTargetTriple().getObjectFormat() ==
1271            Triple::MachO &&
1272            "LOAD_STACK_GUARD currently supported only for MachO.");
1273     expandLoadStackGuard(MI, RM);
1274     MI->getParent()->erase(MI);
1275     return true;
1276   }
1277
1278   // This hook gets to expand COPY instructions before they become
1279   // copyPhysReg() calls.  Look for VMOVS instructions that can legally be
1280   // widened to VMOVD.  We prefer the VMOVD when possible because it may be
1281   // changed into a VORR that can go down the NEON pipeline.
1282   if (!WidenVMOVS || !MI->isCopy() || Subtarget.isCortexA15() ||
1283       Subtarget.isFPOnlySP())
1284     return false;
1285
1286   // Look for a copy between even S-registers.  That is where we keep floats
1287   // when using NEON v2f32 instructions for f32 arithmetic.
1288   unsigned DstRegS = MI->getOperand(0).getReg();
1289   unsigned SrcRegS = MI->getOperand(1).getReg();
1290   if (!ARM::SPRRegClass.contains(DstRegS, SrcRegS))
1291     return false;
1292
1293   const TargetRegisterInfo *TRI = &getRegisterInfo();
1294   unsigned DstRegD = TRI->getMatchingSuperReg(DstRegS, ARM::ssub_0,
1295                                               &ARM::DPRRegClass);
1296   unsigned SrcRegD = TRI->getMatchingSuperReg(SrcRegS, ARM::ssub_0,
1297                                               &ARM::DPRRegClass);
1298   if (!DstRegD || !SrcRegD)
1299     return false;
1300
1301   // We want to widen this into a DstRegD = VMOVD SrcRegD copy.  This is only
1302   // legal if the COPY already defines the full DstRegD, and it isn't a
1303   // sub-register insertion.
1304   if (!MI->definesRegister(DstRegD, TRI) || MI->readsRegister(DstRegD, TRI))
1305     return false;
1306
1307   // A dead copy shouldn't show up here, but reject it just in case.
1308   if (MI->getOperand(0).isDead())
1309     return false;
1310
1311   // All clear, widen the COPY.
1312   DEBUG(dbgs() << "widening:    " << *MI);
1313   MachineInstrBuilder MIB(*MI->getParent()->getParent(), MI);
1314
1315   // Get rid of the old <imp-def> of DstRegD.  Leave it if it defines a Q-reg
1316   // or some other super-register.
1317   int ImpDefIdx = MI->findRegisterDefOperandIdx(DstRegD);
1318   if (ImpDefIdx != -1)
1319     MI->RemoveOperand(ImpDefIdx);
1320
1321   // Change the opcode and operands.
1322   MI->setDesc(get(ARM::VMOVD));
1323   MI->getOperand(0).setReg(DstRegD);
1324   MI->getOperand(1).setReg(SrcRegD);
1325   AddDefaultPred(MIB);
1326
1327   // We are now reading SrcRegD instead of SrcRegS.  This may upset the
1328   // register scavenger and machine verifier, so we need to indicate that we
1329   // are reading an undefined value from SrcRegD, but a proper value from
1330   // SrcRegS.
1331   MI->getOperand(1).setIsUndef();
1332   MIB.addReg(SrcRegS, RegState::Implicit);
1333
1334   // SrcRegD may actually contain an unrelated value in the ssub_1
1335   // sub-register.  Don't kill it.  Only kill the ssub_0 sub-register.
1336   if (MI->getOperand(1).isKill()) {
1337     MI->getOperand(1).setIsKill(false);
1338     MI->addRegisterKilled(SrcRegS, TRI, true);
1339   }
1340
1341   DEBUG(dbgs() << "replaced by: " << *MI);
1342   return true;
1343 }
1344
1345 /// Create a copy of a const pool value. Update CPI to the new index and return
1346 /// the label UID.
1347 static unsigned duplicateCPV(MachineFunction &MF, unsigned &CPI) {
1348   MachineConstantPool *MCP = MF.getConstantPool();
1349   ARMFunctionInfo *AFI = MF.getInfo<ARMFunctionInfo>();
1350
1351   const MachineConstantPoolEntry &MCPE = MCP->getConstants()[CPI];
1352   assert(MCPE.isMachineConstantPoolEntry() &&
1353          "Expecting a machine constantpool entry!");
1354   ARMConstantPoolValue *ACPV =
1355     static_cast<ARMConstantPoolValue*>(MCPE.Val.MachineCPVal);
1356
1357   unsigned PCLabelId = AFI->createPICLabelUId();
1358   ARMConstantPoolValue *NewCPV = nullptr;
1359
1360   // FIXME: The below assumes PIC relocation model and that the function
1361   // is Thumb mode (t1 or t2). PCAdjustment would be 8 for ARM mode PIC, and
1362   // zero for non-PIC in ARM or Thumb. The callers are all of thumb LDR
1363   // instructions, so that's probably OK, but is PIC always correct when
1364   // we get here?
1365   if (ACPV->isGlobalValue())
1366     NewCPV = ARMConstantPoolConstant::
1367       Create(cast<ARMConstantPoolConstant>(ACPV)->getGV(), PCLabelId,
1368              ARMCP::CPValue, 4);
1369   else if (ACPV->isExtSymbol())
1370     NewCPV = ARMConstantPoolSymbol::
1371       Create(MF.getFunction()->getContext(),
1372              cast<ARMConstantPoolSymbol>(ACPV)->getSymbol(), PCLabelId, 4);
1373   else if (ACPV->isBlockAddress())
1374     NewCPV = ARMConstantPoolConstant::
1375       Create(cast<ARMConstantPoolConstant>(ACPV)->getBlockAddress(), PCLabelId,
1376              ARMCP::CPBlockAddress, 4);
1377   else if (ACPV->isLSDA())
1378     NewCPV = ARMConstantPoolConstant::Create(MF.getFunction(), PCLabelId,
1379                                              ARMCP::CPLSDA, 4);
1380   else if (ACPV->isMachineBasicBlock())
1381     NewCPV = ARMConstantPoolMBB::
1382       Create(MF.getFunction()->getContext(),
1383              cast<ARMConstantPoolMBB>(ACPV)->getMBB(), PCLabelId, 4);
1384   else
1385     llvm_unreachable("Unexpected ARM constantpool value type!!");
1386   CPI = MCP->getConstantPoolIndex(NewCPV, MCPE.getAlignment());
1387   return PCLabelId;
1388 }
1389
1390 void ARMBaseInstrInfo::
1391 reMaterialize(MachineBasicBlock &MBB,
1392               MachineBasicBlock::iterator I,
1393               unsigned DestReg, unsigned SubIdx,
1394               const MachineInstr *Orig,
1395               const TargetRegisterInfo &TRI) const {
1396   unsigned Opcode = Orig->getOpcode();
1397   switch (Opcode) {
1398   default: {
1399     MachineInstr *MI = MBB.getParent()->CloneMachineInstr(Orig);
1400     MI->substituteRegister(Orig->getOperand(0).getReg(), DestReg, SubIdx, TRI);
1401     MBB.insert(I, MI);
1402     break;
1403   }
1404   case ARM::tLDRpci_pic:
1405   case ARM::t2LDRpci_pic: {
1406     MachineFunction &MF = *MBB.getParent();
1407     unsigned CPI = Orig->getOperand(1).getIndex();
1408     unsigned PCLabelId = duplicateCPV(MF, CPI);
1409     MachineInstrBuilder MIB = BuildMI(MBB, I, Orig->getDebugLoc(), get(Opcode),
1410                                       DestReg)
1411       .addConstantPoolIndex(CPI).addImm(PCLabelId);
1412     MIB->setMemRefs(Orig->memoperands_begin(), Orig->memoperands_end());
1413     break;
1414   }
1415   }
1416 }
1417
1418 MachineInstr *
1419 ARMBaseInstrInfo::duplicate(MachineInstr *Orig, MachineFunction &MF) const {
1420   MachineInstr *MI = TargetInstrInfo::duplicate(Orig, MF);
1421   switch(Orig->getOpcode()) {
1422   case ARM::tLDRpci_pic:
1423   case ARM::t2LDRpci_pic: {
1424     unsigned CPI = Orig->getOperand(1).getIndex();
1425     unsigned PCLabelId = duplicateCPV(MF, CPI);
1426     Orig->getOperand(1).setIndex(CPI);
1427     Orig->getOperand(2).setImm(PCLabelId);
1428     break;
1429   }
1430   }
1431   return MI;
1432 }
1433
1434 bool ARMBaseInstrInfo::produceSameValue(const MachineInstr *MI0,
1435                                         const MachineInstr *MI1,
1436                                         const MachineRegisterInfo *MRI) const {
1437   int Opcode = MI0->getOpcode();
1438   if (Opcode == ARM::t2LDRpci ||
1439       Opcode == ARM::t2LDRpci_pic ||
1440       Opcode == ARM::tLDRpci ||
1441       Opcode == ARM::tLDRpci_pic ||
1442       Opcode == ARM::LDRLIT_ga_pcrel ||
1443       Opcode == ARM::LDRLIT_ga_pcrel_ldr ||
1444       Opcode == ARM::tLDRLIT_ga_pcrel ||
1445       Opcode == ARM::MOV_ga_pcrel ||
1446       Opcode == ARM::MOV_ga_pcrel_ldr ||
1447       Opcode == ARM::t2MOV_ga_pcrel) {
1448     if (MI1->getOpcode() != Opcode)
1449       return false;
1450     if (MI0->getNumOperands() != MI1->getNumOperands())
1451       return false;
1452
1453     const MachineOperand &MO0 = MI0->getOperand(1);
1454     const MachineOperand &MO1 = MI1->getOperand(1);
1455     if (MO0.getOffset() != MO1.getOffset())
1456       return false;
1457
1458     if (Opcode == ARM::LDRLIT_ga_pcrel ||
1459         Opcode == ARM::LDRLIT_ga_pcrel_ldr ||
1460         Opcode == ARM::tLDRLIT_ga_pcrel ||
1461         Opcode == ARM::MOV_ga_pcrel ||
1462         Opcode == ARM::MOV_ga_pcrel_ldr ||
1463         Opcode == ARM::t2MOV_ga_pcrel)
1464       // Ignore the PC labels.
1465       return MO0.getGlobal() == MO1.getGlobal();
1466
1467     const MachineFunction *MF = MI0->getParent()->getParent();
1468     const MachineConstantPool *MCP = MF->getConstantPool();
1469     int CPI0 = MO0.getIndex();
1470     int CPI1 = MO1.getIndex();
1471     const MachineConstantPoolEntry &MCPE0 = MCP->getConstants()[CPI0];
1472     const MachineConstantPoolEntry &MCPE1 = MCP->getConstants()[CPI1];
1473     bool isARMCP0 = MCPE0.isMachineConstantPoolEntry();
1474     bool isARMCP1 = MCPE1.isMachineConstantPoolEntry();
1475     if (isARMCP0 && isARMCP1) {
1476       ARMConstantPoolValue *ACPV0 =
1477         static_cast<ARMConstantPoolValue*>(MCPE0.Val.MachineCPVal);
1478       ARMConstantPoolValue *ACPV1 =
1479         static_cast<ARMConstantPoolValue*>(MCPE1.Val.MachineCPVal);
1480       return ACPV0->hasSameValue(ACPV1);
1481     } else if (!isARMCP0 && !isARMCP1) {
1482       return MCPE0.Val.ConstVal == MCPE1.Val.ConstVal;
1483     }
1484     return false;
1485   } else if (Opcode == ARM::PICLDR) {
1486     if (MI1->getOpcode() != Opcode)
1487       return false;
1488     if (MI0->getNumOperands() != MI1->getNumOperands())
1489       return false;
1490
1491     unsigned Addr0 = MI0->getOperand(1).getReg();
1492     unsigned Addr1 = MI1->getOperand(1).getReg();
1493     if (Addr0 != Addr1) {
1494       if (!MRI ||
1495           !TargetRegisterInfo::isVirtualRegister(Addr0) ||
1496           !TargetRegisterInfo::isVirtualRegister(Addr1))
1497         return false;
1498
1499       // This assumes SSA form.
1500       MachineInstr *Def0 = MRI->getVRegDef(Addr0);
1501       MachineInstr *Def1 = MRI->getVRegDef(Addr1);
1502       // Check if the loaded value, e.g. a constantpool of a global address, are
1503       // the same.
1504       if (!produceSameValue(Def0, Def1, MRI))
1505         return false;
1506     }
1507
1508     for (unsigned i = 3, e = MI0->getNumOperands(); i != e; ++i) {
1509       // %vreg12<def> = PICLDR %vreg11, 0, pred:14, pred:%noreg
1510       const MachineOperand &MO0 = MI0->getOperand(i);
1511       const MachineOperand &MO1 = MI1->getOperand(i);
1512       if (!MO0.isIdenticalTo(MO1))
1513         return false;
1514     }
1515     return true;
1516   }
1517
1518   return MI0->isIdenticalTo(MI1, MachineInstr::IgnoreVRegDefs);
1519 }
1520
1521 /// areLoadsFromSameBasePtr - This is used by the pre-regalloc scheduler to
1522 /// determine if two loads are loading from the same base address. It should
1523 /// only return true if the base pointers are the same and the only differences
1524 /// between the two addresses is the offset. It also returns the offsets by
1525 /// reference.
1526 ///
1527 /// FIXME: remove this in favor of the MachineInstr interface once pre-RA-sched
1528 /// is permanently disabled.
1529 bool ARMBaseInstrInfo::areLoadsFromSameBasePtr(SDNode *Load1, SDNode *Load2,
1530                                                int64_t &Offset1,
1531                                                int64_t &Offset2) const {
1532   // Don't worry about Thumb: just ARM and Thumb2.
1533   if (Subtarget.isThumb1Only()) return false;
1534
1535   if (!Load1->isMachineOpcode() || !Load2->isMachineOpcode())
1536     return false;
1537
1538   switch (Load1->getMachineOpcode()) {
1539   default:
1540     return false;
1541   case ARM::LDRi12:
1542   case ARM::LDRBi12:
1543   case ARM::LDRD:
1544   case ARM::LDRH:
1545   case ARM::LDRSB:
1546   case ARM::LDRSH:
1547   case ARM::VLDRD:
1548   case ARM::VLDRS:
1549   case ARM::t2LDRi8:
1550   case ARM::t2LDRBi8:
1551   case ARM::t2LDRDi8:
1552   case ARM::t2LDRSHi8:
1553   case ARM::t2LDRi12:
1554   case ARM::t2LDRBi12:
1555   case ARM::t2LDRSHi12:
1556     break;
1557   }
1558
1559   switch (Load2->getMachineOpcode()) {
1560   default:
1561     return false;
1562   case ARM::LDRi12:
1563   case ARM::LDRBi12:
1564   case ARM::LDRD:
1565   case ARM::LDRH:
1566   case ARM::LDRSB:
1567   case ARM::LDRSH:
1568   case ARM::VLDRD:
1569   case ARM::VLDRS:
1570   case ARM::t2LDRi8:
1571   case ARM::t2LDRBi8:
1572   case ARM::t2LDRSHi8:
1573   case ARM::t2LDRi12:
1574   case ARM::t2LDRBi12:
1575   case ARM::t2LDRSHi12:
1576     break;
1577   }
1578
1579   // Check if base addresses and chain operands match.
1580   if (Load1->getOperand(0) != Load2->getOperand(0) ||
1581       Load1->getOperand(4) != Load2->getOperand(4))
1582     return false;
1583
1584   // Index should be Reg0.
1585   if (Load1->getOperand(3) != Load2->getOperand(3))
1586     return false;
1587
1588   // Determine the offsets.
1589   if (isa<ConstantSDNode>(Load1->getOperand(1)) &&
1590       isa<ConstantSDNode>(Load2->getOperand(1))) {
1591     Offset1 = cast<ConstantSDNode>(Load1->getOperand(1))->getSExtValue();
1592     Offset2 = cast<ConstantSDNode>(Load2->getOperand(1))->getSExtValue();
1593     return true;
1594   }
1595
1596   return false;
1597 }
1598
1599 /// shouldScheduleLoadsNear - This is a used by the pre-regalloc scheduler to
1600 /// determine (in conjunction with areLoadsFromSameBasePtr) if two loads should
1601 /// be scheduled togther. On some targets if two loads are loading from
1602 /// addresses in the same cache line, it's better if they are scheduled
1603 /// together. This function takes two integers that represent the load offsets
1604 /// from the common base address. It returns true if it decides it's desirable
1605 /// to schedule the two loads together. "NumLoads" is the number of loads that
1606 /// have already been scheduled after Load1.
1607 ///
1608 /// FIXME: remove this in favor of the MachineInstr interface once pre-RA-sched
1609 /// is permanently disabled.
1610 bool ARMBaseInstrInfo::shouldScheduleLoadsNear(SDNode *Load1, SDNode *Load2,
1611                                                int64_t Offset1, int64_t Offset2,
1612                                                unsigned NumLoads) const {
1613   // Don't worry about Thumb: just ARM and Thumb2.
1614   if (Subtarget.isThumb1Only()) return false;
1615
1616   assert(Offset2 > Offset1);
1617
1618   if ((Offset2 - Offset1) / 8 > 64)
1619     return false;
1620
1621   // Check if the machine opcodes are different. If they are different
1622   // then we consider them to not be of the same base address,
1623   // EXCEPT in the case of Thumb2 byte loads where one is LDRBi8 and the other LDRBi12.
1624   // In this case, they are considered to be the same because they are different
1625   // encoding forms of the same basic instruction.
1626   if ((Load1->getMachineOpcode() != Load2->getMachineOpcode()) &&
1627       !((Load1->getMachineOpcode() == ARM::t2LDRBi8 &&
1628          Load2->getMachineOpcode() == ARM::t2LDRBi12) ||
1629         (Load1->getMachineOpcode() == ARM::t2LDRBi12 &&
1630          Load2->getMachineOpcode() == ARM::t2LDRBi8)))
1631     return false;  // FIXME: overly conservative?
1632
1633   // Four loads in a row should be sufficient.
1634   if (NumLoads >= 3)
1635     return false;
1636
1637   return true;
1638 }
1639
1640 bool ARMBaseInstrInfo::isSchedulingBoundary(const MachineInstr *MI,
1641                                             const MachineBasicBlock *MBB,
1642                                             const MachineFunction &MF) const {
1643   // Debug info is never a scheduling boundary. It's necessary to be explicit
1644   // due to the special treatment of IT instructions below, otherwise a
1645   // dbg_value followed by an IT will result in the IT instruction being
1646   // considered a scheduling hazard, which is wrong. It should be the actual
1647   // instruction preceding the dbg_value instruction(s), just like it is
1648   // when debug info is not present.
1649   if (MI->isDebugValue())
1650     return false;
1651
1652   // Terminators and labels can't be scheduled around.
1653   if (MI->isTerminator() || MI->isPosition())
1654     return true;
1655
1656   // Treat the start of the IT block as a scheduling boundary, but schedule
1657   // t2IT along with all instructions following it.
1658   // FIXME: This is a big hammer. But the alternative is to add all potential
1659   // true and anti dependencies to IT block instructions as implicit operands
1660   // to the t2IT instruction. The added compile time and complexity does not
1661   // seem worth it.
1662   MachineBasicBlock::const_iterator I = MI;
1663   // Make sure to skip any dbg_value instructions
1664   while (++I != MBB->end() && I->isDebugValue())
1665     ;
1666   if (I != MBB->end() && I->getOpcode() == ARM::t2IT)
1667     return true;
1668
1669   // Don't attempt to schedule around any instruction that defines
1670   // a stack-oriented pointer, as it's unlikely to be profitable. This
1671   // saves compile time, because it doesn't require every single
1672   // stack slot reference to depend on the instruction that does the
1673   // modification.
1674   // Calls don't actually change the stack pointer, even if they have imp-defs.
1675   // No ARM calling conventions change the stack pointer. (X86 calling
1676   // conventions sometimes do).
1677   if (!MI->isCall() && MI->definesRegister(ARM::SP))
1678     return true;
1679
1680   return false;
1681 }
1682
1683 bool ARMBaseInstrInfo::
1684 isProfitableToIfCvt(MachineBasicBlock &MBB,
1685                     unsigned NumCycles, unsigned ExtraPredCycles,
1686                     const BranchProbability &Probability) const {
1687   if (!NumCycles)
1688     return false;
1689
1690   // If we are optimizing for size, see if the branch in the predecessor can be
1691   // lowered to cbn?z by the constant island lowering pass, and return false if
1692   // so. This results in a shorter instruction sequence.
1693   const Function *F = MBB.getParent()->getFunction();
1694   if (F->hasFnAttribute(Attribute::OptimizeForSize) ||
1695       F->hasFnAttribute(Attribute::MinSize)) {
1696     MachineBasicBlock *Pred = *MBB.pred_begin();
1697     if (!Pred->empty()) {
1698       MachineInstr *LastMI = &*Pred->rbegin();
1699       if (LastMI->getOpcode() == ARM::t2Bcc) {
1700         MachineBasicBlock::iterator CmpMI = LastMI;
1701         if (CmpMI != Pred->begin()) {
1702           --CmpMI;
1703           if (CmpMI->getOpcode() == ARM::tCMPi8 ||
1704               CmpMI->getOpcode() == ARM::t2CMPri) {
1705             unsigned Reg = CmpMI->getOperand(0).getReg();
1706             unsigned PredReg = 0;
1707             ARMCC::CondCodes P = getInstrPredicate(CmpMI, PredReg);
1708             if (P == ARMCC::AL && CmpMI->getOperand(1).getImm() == 0 &&
1709                 isARMLowRegister(Reg))
1710               return false;
1711           }
1712         }
1713       }
1714     }
1715   }
1716
1717   // Attempt to estimate the relative costs of predication versus branching.
1718   unsigned UnpredCost = Probability.getNumerator() * NumCycles;
1719   UnpredCost /= Probability.getDenominator();
1720   UnpredCost += 1; // The branch itself
1721   UnpredCost += Subtarget.getMispredictionPenalty() / 10;
1722
1723   return (NumCycles + ExtraPredCycles) <= UnpredCost;
1724 }
1725
1726 bool ARMBaseInstrInfo::
1727 isProfitableToIfCvt(MachineBasicBlock &TMBB,
1728                     unsigned TCycles, unsigned TExtra,
1729                     MachineBasicBlock &FMBB,
1730                     unsigned FCycles, unsigned FExtra,
1731                     const BranchProbability &Probability) const {
1732   if (!TCycles || !FCycles)
1733     return false;
1734
1735   // Attempt to estimate the relative costs of predication versus branching.
1736   unsigned TUnpredCost = Probability.getNumerator() * TCycles;
1737   TUnpredCost /= Probability.getDenominator();
1738
1739   uint32_t Comp = Probability.getDenominator() - Probability.getNumerator();
1740   unsigned FUnpredCost = Comp * FCycles;
1741   FUnpredCost /= Probability.getDenominator();
1742
1743   unsigned UnpredCost = TUnpredCost + FUnpredCost;
1744   UnpredCost += 1; // The branch itself
1745   UnpredCost += Subtarget.getMispredictionPenalty() / 10;
1746
1747   return (TCycles + FCycles + TExtra + FExtra) <= UnpredCost;
1748 }
1749
1750 bool
1751 ARMBaseInstrInfo::isProfitableToUnpredicate(MachineBasicBlock &TMBB,
1752                                             MachineBasicBlock &FMBB) const {
1753   // Reduce false anti-dependencies to let Swift's out-of-order execution
1754   // engine do its thing.
1755   return Subtarget.isSwift();
1756 }
1757
1758 /// getInstrPredicate - If instruction is predicated, returns its predicate
1759 /// condition, otherwise returns AL. It also returns the condition code
1760 /// register by reference.
1761 ARMCC::CondCodes
1762 llvm::getInstrPredicate(const MachineInstr *MI, unsigned &PredReg) {
1763   int PIdx = MI->findFirstPredOperandIdx();
1764   if (PIdx == -1) {
1765     PredReg = 0;
1766     return ARMCC::AL;
1767   }
1768
1769   PredReg = MI->getOperand(PIdx+1).getReg();
1770   return (ARMCC::CondCodes)MI->getOperand(PIdx).getImm();
1771 }
1772
1773
1774 int llvm::getMatchingCondBranchOpcode(int Opc) {
1775   if (Opc == ARM::B)
1776     return ARM::Bcc;
1777   if (Opc == ARM::tB)
1778     return ARM::tBcc;
1779   if (Opc == ARM::t2B)
1780     return ARM::t2Bcc;
1781
1782   llvm_unreachable("Unknown unconditional branch opcode!");
1783 }
1784
1785 /// commuteInstruction - Handle commutable instructions.
1786 MachineInstr *
1787 ARMBaseInstrInfo::commuteInstruction(MachineInstr *MI, bool NewMI) const {
1788   switch (MI->getOpcode()) {
1789   case ARM::MOVCCr:
1790   case ARM::t2MOVCCr: {
1791     // MOVCC can be commuted by inverting the condition.
1792     unsigned PredReg = 0;
1793     ARMCC::CondCodes CC = getInstrPredicate(MI, PredReg);
1794     // MOVCC AL can't be inverted. Shouldn't happen.
1795     if (CC == ARMCC::AL || PredReg != ARM::CPSR)
1796       return nullptr;
1797     MI = TargetInstrInfo::commuteInstruction(MI, NewMI);
1798     if (!MI)
1799       return nullptr;
1800     // After swapping the MOVCC operands, also invert the condition.
1801     MI->getOperand(MI->findFirstPredOperandIdx())
1802       .setImm(ARMCC::getOppositeCondition(CC));
1803     return MI;
1804   }
1805   }
1806   return TargetInstrInfo::commuteInstruction(MI, NewMI);
1807 }
1808
1809 /// Identify instructions that can be folded into a MOVCC instruction, and
1810 /// return the defining instruction.
1811 static MachineInstr *canFoldIntoMOVCC(unsigned Reg,
1812                                       const MachineRegisterInfo &MRI,
1813                                       const TargetInstrInfo *TII) {
1814   if (!TargetRegisterInfo::isVirtualRegister(Reg))
1815     return nullptr;
1816   if (!MRI.hasOneNonDBGUse(Reg))
1817     return nullptr;
1818   MachineInstr *MI = MRI.getVRegDef(Reg);
1819   if (!MI)
1820     return nullptr;
1821   // MI is folded into the MOVCC by predicating it.
1822   if (!MI->isPredicable())
1823     return nullptr;
1824   // Check if MI has any non-dead defs or physreg uses. This also detects
1825   // predicated instructions which will be reading CPSR.
1826   for (unsigned i = 1, e = MI->getNumOperands(); i != e; ++i) {
1827     const MachineOperand &MO = MI->getOperand(i);
1828     // Reject frame index operands, PEI can't handle the predicated pseudos.
1829     if (MO.isFI() || MO.isCPI() || MO.isJTI())
1830       return nullptr;
1831     if (!MO.isReg())
1832       continue;
1833     // MI can't have any tied operands, that would conflict with predication.
1834     if (MO.isTied())
1835       return nullptr;
1836     if (TargetRegisterInfo::isPhysicalRegister(MO.getReg()))
1837       return nullptr;
1838     if (MO.isDef() && !MO.isDead())
1839       return nullptr;
1840   }
1841   bool DontMoveAcrossStores = true;
1842   if (!MI->isSafeToMove(TII, /* AliasAnalysis = */ nullptr,
1843                         DontMoveAcrossStores))
1844     return nullptr;
1845   return MI;
1846 }
1847
1848 bool ARMBaseInstrInfo::analyzeSelect(const MachineInstr *MI,
1849                                      SmallVectorImpl<MachineOperand> &Cond,
1850                                      unsigned &TrueOp, unsigned &FalseOp,
1851                                      bool &Optimizable) const {
1852   assert((MI->getOpcode() == ARM::MOVCCr || MI->getOpcode() == ARM::t2MOVCCr) &&
1853          "Unknown select instruction");
1854   // MOVCC operands:
1855   // 0: Def.
1856   // 1: True use.
1857   // 2: False use.
1858   // 3: Condition code.
1859   // 4: CPSR use.
1860   TrueOp = 1;
1861   FalseOp = 2;
1862   Cond.push_back(MI->getOperand(3));
1863   Cond.push_back(MI->getOperand(4));
1864   // We can always fold a def.
1865   Optimizable = true;
1866   return false;
1867 }
1868
1869 MachineInstr *
1870 ARMBaseInstrInfo::optimizeSelect(MachineInstr *MI,
1871                                  SmallPtrSetImpl<MachineInstr *> &SeenMIs,
1872                                  bool PreferFalse) const {
1873   assert((MI->getOpcode() == ARM::MOVCCr || MI->getOpcode() == ARM::t2MOVCCr) &&
1874          "Unknown select instruction");
1875   MachineRegisterInfo &MRI = MI->getParent()->getParent()->getRegInfo();
1876   MachineInstr *DefMI = canFoldIntoMOVCC(MI->getOperand(2).getReg(), MRI, this);
1877   bool Invert = !DefMI;
1878   if (!DefMI)
1879     DefMI = canFoldIntoMOVCC(MI->getOperand(1).getReg(), MRI, this);
1880   if (!DefMI)
1881     return nullptr;
1882
1883   // Find new register class to use.
1884   MachineOperand FalseReg = MI->getOperand(Invert ? 2 : 1);
1885   unsigned       DestReg  = MI->getOperand(0).getReg();
1886   const TargetRegisterClass *PreviousClass = MRI.getRegClass(FalseReg.getReg());
1887   if (!MRI.constrainRegClass(DestReg, PreviousClass))
1888     return nullptr;
1889
1890   // Create a new predicated version of DefMI.
1891   // Rfalse is the first use.
1892   MachineInstrBuilder NewMI = BuildMI(*MI->getParent(), MI, MI->getDebugLoc(),
1893                                       DefMI->getDesc(), DestReg);
1894
1895   // Copy all the DefMI operands, excluding its (null) predicate.
1896   const MCInstrDesc &DefDesc = DefMI->getDesc();
1897   for (unsigned i = 1, e = DefDesc.getNumOperands();
1898        i != e && !DefDesc.OpInfo[i].isPredicate(); ++i)
1899     NewMI.addOperand(DefMI->getOperand(i));
1900
1901   unsigned CondCode = MI->getOperand(3).getImm();
1902   if (Invert)
1903     NewMI.addImm(ARMCC::getOppositeCondition(ARMCC::CondCodes(CondCode)));
1904   else
1905     NewMI.addImm(CondCode);
1906   NewMI.addOperand(MI->getOperand(4));
1907
1908   // DefMI is not the -S version that sets CPSR, so add an optional %noreg.
1909   if (NewMI->hasOptionalDef())
1910     AddDefaultCC(NewMI);
1911
1912   // The output register value when the predicate is false is an implicit
1913   // register operand tied to the first def.
1914   // The tie makes the register allocator ensure the FalseReg is allocated the
1915   // same register as operand 0.
1916   FalseReg.setImplicit();
1917   NewMI.addOperand(FalseReg);
1918   NewMI->tieOperands(0, NewMI->getNumOperands() - 1);
1919
1920   // Update SeenMIs set: register newly created MI and erase removed DefMI.
1921   SeenMIs.insert(NewMI);
1922   SeenMIs.erase(DefMI);
1923
1924   // If MI is inside a loop, and DefMI is outside the loop, then kill flags on
1925   // DefMI would be invalid when tranferred inside the loop.  Checking for a
1926   // loop is expensive, but at least remove kill flags if they are in different
1927   // BBs.
1928   if (DefMI->getParent() != MI->getParent())
1929     NewMI->clearKillInfo();
1930
1931   // The caller will erase MI, but not DefMI.
1932   DefMI->eraseFromParent();
1933   return NewMI;
1934 }
1935
1936 /// Map pseudo instructions that imply an 'S' bit onto real opcodes. Whether the
1937 /// instruction is encoded with an 'S' bit is determined by the optional CPSR
1938 /// def operand.
1939 ///
1940 /// This will go away once we can teach tblgen how to set the optional CPSR def
1941 /// operand itself.
1942 struct AddSubFlagsOpcodePair {
1943   uint16_t PseudoOpc;
1944   uint16_t MachineOpc;
1945 };
1946
1947 static const AddSubFlagsOpcodePair AddSubFlagsOpcodeMap[] = {
1948   {ARM::ADDSri, ARM::ADDri},
1949   {ARM::ADDSrr, ARM::ADDrr},
1950   {ARM::ADDSrsi, ARM::ADDrsi},
1951   {ARM::ADDSrsr, ARM::ADDrsr},
1952
1953   {ARM::SUBSri, ARM::SUBri},
1954   {ARM::SUBSrr, ARM::SUBrr},
1955   {ARM::SUBSrsi, ARM::SUBrsi},
1956   {ARM::SUBSrsr, ARM::SUBrsr},
1957
1958   {ARM::RSBSri, ARM::RSBri},
1959   {ARM::RSBSrsi, ARM::RSBrsi},
1960   {ARM::RSBSrsr, ARM::RSBrsr},
1961
1962   {ARM::t2ADDSri, ARM::t2ADDri},
1963   {ARM::t2ADDSrr, ARM::t2ADDrr},
1964   {ARM::t2ADDSrs, ARM::t2ADDrs},
1965
1966   {ARM::t2SUBSri, ARM::t2SUBri},
1967   {ARM::t2SUBSrr, ARM::t2SUBrr},
1968   {ARM::t2SUBSrs, ARM::t2SUBrs},
1969
1970   {ARM::t2RSBSri, ARM::t2RSBri},
1971   {ARM::t2RSBSrs, ARM::t2RSBrs},
1972 };
1973
1974 unsigned llvm::convertAddSubFlagsOpcode(unsigned OldOpc) {
1975   for (unsigned i = 0, e = array_lengthof(AddSubFlagsOpcodeMap); i != e; ++i)
1976     if (OldOpc == AddSubFlagsOpcodeMap[i].PseudoOpc)
1977       return AddSubFlagsOpcodeMap[i].MachineOpc;
1978   return 0;
1979 }
1980
1981 void llvm::emitARMRegPlusImmediate(MachineBasicBlock &MBB,
1982                                MachineBasicBlock::iterator &MBBI, DebugLoc dl,
1983                                unsigned DestReg, unsigned BaseReg, int NumBytes,
1984                                ARMCC::CondCodes Pred, unsigned PredReg,
1985                                const ARMBaseInstrInfo &TII, unsigned MIFlags) {
1986   if (NumBytes == 0 && DestReg != BaseReg) {
1987     BuildMI(MBB, MBBI, dl, TII.get(ARM::MOVr), DestReg)
1988       .addReg(BaseReg, RegState::Kill)
1989       .addImm((unsigned)Pred).addReg(PredReg).addReg(0)
1990       .setMIFlags(MIFlags);
1991     return;
1992   }
1993
1994   bool isSub = NumBytes < 0;
1995   if (isSub) NumBytes = -NumBytes;
1996
1997   while (NumBytes) {
1998     unsigned RotAmt = ARM_AM::getSOImmValRotate(NumBytes);
1999     unsigned ThisVal = NumBytes & ARM_AM::rotr32(0xFF, RotAmt);
2000     assert(ThisVal && "Didn't extract field correctly");
2001
2002     // We will handle these bits from offset, clear them.
2003     NumBytes &= ~ThisVal;
2004
2005     assert(ARM_AM::getSOImmVal(ThisVal) != -1 && "Bit extraction didn't work?");
2006
2007     // Build the new ADD / SUB.
2008     unsigned Opc = isSub ? ARM::SUBri : ARM::ADDri;
2009     BuildMI(MBB, MBBI, dl, TII.get(Opc), DestReg)
2010       .addReg(BaseReg, RegState::Kill).addImm(ThisVal)
2011       .addImm((unsigned)Pred).addReg(PredReg).addReg(0)
2012       .setMIFlags(MIFlags);
2013     BaseReg = DestReg;
2014   }
2015 }
2016
2017 static bool isAnySubRegLive(unsigned Reg, const TargetRegisterInfo *TRI,
2018                       MachineInstr *MI) {
2019   for (MCSubRegIterator Subreg(Reg, TRI, /* IncludeSelf */ true);
2020        Subreg.isValid(); ++Subreg)
2021     if (MI->getParent()->computeRegisterLiveness(TRI, *Subreg, MI) !=
2022         MachineBasicBlock::LQR_Dead)
2023       return true;
2024   return false;
2025 }
2026 bool llvm::tryFoldSPUpdateIntoPushPop(const ARMSubtarget &Subtarget,
2027                                       MachineFunction &MF, MachineInstr *MI,
2028                                       unsigned NumBytes) {
2029   // This optimisation potentially adds lots of load and store
2030   // micro-operations, it's only really a great benefit to code-size.
2031   if (!MF.getFunction()->hasFnAttribute(Attribute::MinSize))
2032     return false;
2033
2034   // If only one register is pushed/popped, LLVM can use an LDR/STR
2035   // instead. We can't modify those so make sure we're dealing with an
2036   // instruction we understand.
2037   bool IsPop = isPopOpcode(MI->getOpcode());
2038   bool IsPush = isPushOpcode(MI->getOpcode());
2039   if (!IsPush && !IsPop)
2040     return false;
2041
2042   bool IsVFPPushPop = MI->getOpcode() == ARM::VSTMDDB_UPD ||
2043                       MI->getOpcode() == ARM::VLDMDIA_UPD;
2044   bool IsT1PushPop = MI->getOpcode() == ARM::tPUSH ||
2045                      MI->getOpcode() == ARM::tPOP ||
2046                      MI->getOpcode() == ARM::tPOP_RET;
2047
2048   assert((IsT1PushPop || (MI->getOperand(0).getReg() == ARM::SP &&
2049                           MI->getOperand(1).getReg() == ARM::SP)) &&
2050          "trying to fold sp update into non-sp-updating push/pop");
2051
2052   // The VFP push & pop act on D-registers, so we can only fold an adjustment
2053   // by a multiple of 8 bytes in correctly. Similarly rN is 4-bytes. Don't try
2054   // if this is violated.
2055   if (NumBytes % (IsVFPPushPop ? 8 : 4) != 0)
2056     return false;
2057
2058   // ARM and Thumb2 push/pop insts have explicit "sp, sp" operands (+
2059   // pred) so the list starts at 4. Thumb1 starts after the predicate.
2060   int RegListIdx = IsT1PushPop ? 2 : 4;
2061
2062   // Calculate the space we'll need in terms of registers.
2063   unsigned FirstReg = MI->getOperand(RegListIdx).getReg();
2064   unsigned RD0Reg, RegsNeeded;
2065   if (IsVFPPushPop) {
2066     RD0Reg = ARM::D0;
2067     RegsNeeded = NumBytes / 8;
2068   } else {
2069     RD0Reg = ARM::R0;
2070     RegsNeeded = NumBytes / 4;
2071   }
2072
2073   // We're going to have to strip all list operands off before
2074   // re-adding them since the order matters, so save the existing ones
2075   // for later.
2076   SmallVector<MachineOperand, 4> RegList;
2077   for (int i = MI->getNumOperands() - 1; i >= RegListIdx; --i)
2078     RegList.push_back(MI->getOperand(i));
2079
2080   const TargetRegisterInfo *TRI = MF.getRegInfo().getTargetRegisterInfo();
2081   const MCPhysReg *CSRegs = TRI->getCalleeSavedRegs(&MF);
2082
2083   // Now try to find enough space in the reglist to allocate NumBytes.
2084   for (unsigned CurReg = FirstReg - 1; CurReg >= RD0Reg && RegsNeeded;
2085        --CurReg) {
2086     if (!IsPop) {
2087       // Pushing any register is completely harmless, mark the
2088       // register involved as undef since we don't care about it in
2089       // the slightest.
2090       RegList.push_back(MachineOperand::CreateReg(CurReg, false, false,
2091                                                   false, false, true));
2092       --RegsNeeded;
2093       continue;
2094     }
2095
2096     // However, we can only pop an extra register if it's not live. For
2097     // registers live within the function we might clobber a return value
2098     // register; the other way a register can be live here is if it's
2099     // callee-saved.
2100     // TODO: Currently, computeRegisterLiveness() does not report "live" if a
2101     // sub reg is live. When computeRegisterLiveness() works for sub reg, it
2102     // can replace isAnySubRegLive().
2103     if (isCalleeSavedRegister(CurReg, CSRegs) ||
2104         isAnySubRegLive(CurReg, TRI, MI)) {
2105       // VFP pops don't allow holes in the register list, so any skip is fatal
2106       // for our transformation. GPR pops do, so we should just keep looking.
2107       if (IsVFPPushPop)
2108         return false;
2109       else
2110         continue;
2111     }
2112
2113     // Mark the unimportant registers as <def,dead> in the POP.
2114     RegList.push_back(MachineOperand::CreateReg(CurReg, true, false, false,
2115                                                 true));
2116     --RegsNeeded;
2117   }
2118
2119   if (RegsNeeded > 0)
2120     return false;
2121
2122   // Finally we know we can profitably perform the optimisation so go
2123   // ahead: strip all existing registers off and add them back again
2124   // in the right order.
2125   for (int i = MI->getNumOperands() - 1; i >= RegListIdx; --i)
2126     MI->RemoveOperand(i);
2127
2128   // Add the complete list back in.
2129   MachineInstrBuilder MIB(MF, &*MI);
2130   for (int i = RegList.size() - 1; i >= 0; --i)
2131     MIB.addOperand(RegList[i]);
2132
2133   return true;
2134 }
2135
2136 bool llvm::rewriteARMFrameIndex(MachineInstr &MI, unsigned FrameRegIdx,
2137                                 unsigned FrameReg, int &Offset,
2138                                 const ARMBaseInstrInfo &TII) {
2139   unsigned Opcode = MI.getOpcode();
2140   const MCInstrDesc &Desc = MI.getDesc();
2141   unsigned AddrMode = (Desc.TSFlags & ARMII::AddrModeMask);
2142   bool isSub = false;
2143
2144   // Memory operands in inline assembly always use AddrMode2.
2145   if (Opcode == ARM::INLINEASM)
2146     AddrMode = ARMII::AddrMode2;
2147
2148   if (Opcode == ARM::ADDri) {
2149     Offset += MI.getOperand(FrameRegIdx+1).getImm();
2150     if (Offset == 0) {
2151       // Turn it into a move.
2152       MI.setDesc(TII.get(ARM::MOVr));
2153       MI.getOperand(FrameRegIdx).ChangeToRegister(FrameReg, false);
2154       MI.RemoveOperand(FrameRegIdx+1);
2155       Offset = 0;
2156       return true;
2157     } else if (Offset < 0) {
2158       Offset = -Offset;
2159       isSub = true;
2160       MI.setDesc(TII.get(ARM::SUBri));
2161     }
2162
2163     // Common case: small offset, fits into instruction.
2164     if (ARM_AM::getSOImmVal(Offset) != -1) {
2165       // Replace the FrameIndex with sp / fp
2166       MI.getOperand(FrameRegIdx).ChangeToRegister(FrameReg, false);
2167       MI.getOperand(FrameRegIdx+1).ChangeToImmediate(Offset);
2168       Offset = 0;
2169       return true;
2170     }
2171
2172     // Otherwise, pull as much of the immedidate into this ADDri/SUBri
2173     // as possible.
2174     unsigned RotAmt = ARM_AM::getSOImmValRotate(Offset);
2175     unsigned ThisImmVal = Offset & ARM_AM::rotr32(0xFF, RotAmt);
2176
2177     // We will handle these bits from offset, clear them.
2178     Offset &= ~ThisImmVal;
2179
2180     // Get the properly encoded SOImmVal field.
2181     assert(ARM_AM::getSOImmVal(ThisImmVal) != -1 &&
2182            "Bit extraction didn't work?");
2183     MI.getOperand(FrameRegIdx+1).ChangeToImmediate(ThisImmVal);
2184  } else {
2185     unsigned ImmIdx = 0;
2186     int InstrOffs = 0;
2187     unsigned NumBits = 0;
2188     unsigned Scale = 1;
2189     switch (AddrMode) {
2190     case ARMII::AddrMode_i12: {
2191       ImmIdx = FrameRegIdx + 1;
2192       InstrOffs = MI.getOperand(ImmIdx).getImm();
2193       NumBits = 12;
2194       break;
2195     }
2196     case ARMII::AddrMode2: {
2197       ImmIdx = FrameRegIdx+2;
2198       InstrOffs = ARM_AM::getAM2Offset(MI.getOperand(ImmIdx).getImm());
2199       if (ARM_AM::getAM2Op(MI.getOperand(ImmIdx).getImm()) == ARM_AM::sub)
2200         InstrOffs *= -1;
2201       NumBits = 12;
2202       break;
2203     }
2204     case ARMII::AddrMode3: {
2205       ImmIdx = FrameRegIdx+2;
2206       InstrOffs = ARM_AM::getAM3Offset(MI.getOperand(ImmIdx).getImm());
2207       if (ARM_AM::getAM3Op(MI.getOperand(ImmIdx).getImm()) == ARM_AM::sub)
2208         InstrOffs *= -1;
2209       NumBits = 8;
2210       break;
2211     }
2212     case ARMII::AddrMode4:
2213     case ARMII::AddrMode6:
2214       // Can't fold any offset even if it's zero.
2215       return false;
2216     case ARMII::AddrMode5: {
2217       ImmIdx = FrameRegIdx+1;
2218       InstrOffs = ARM_AM::getAM5Offset(MI.getOperand(ImmIdx).getImm());
2219       if (ARM_AM::getAM5Op(MI.getOperand(ImmIdx).getImm()) == ARM_AM::sub)
2220         InstrOffs *= -1;
2221       NumBits = 8;
2222       Scale = 4;
2223       break;
2224     }
2225     default:
2226       llvm_unreachable("Unsupported addressing mode!");
2227     }
2228
2229     Offset += InstrOffs * Scale;
2230     assert((Offset & (Scale-1)) == 0 && "Can't encode this offset!");
2231     if (Offset < 0) {
2232       Offset = -Offset;
2233       isSub = true;
2234     }
2235
2236     // Attempt to fold address comp. if opcode has offset bits
2237     if (NumBits > 0) {
2238       // Common case: small offset, fits into instruction.
2239       MachineOperand &ImmOp = MI.getOperand(ImmIdx);
2240       int ImmedOffset = Offset / Scale;
2241       unsigned Mask = (1 << NumBits) - 1;
2242       if ((unsigned)Offset <= Mask * Scale) {
2243         // Replace the FrameIndex with sp
2244         MI.getOperand(FrameRegIdx).ChangeToRegister(FrameReg, false);
2245         // FIXME: When addrmode2 goes away, this will simplify (like the
2246         // T2 version), as the LDR.i12 versions don't need the encoding
2247         // tricks for the offset value.
2248         if (isSub) {
2249           if (AddrMode == ARMII::AddrMode_i12)
2250             ImmedOffset = -ImmedOffset;
2251           else
2252             ImmedOffset |= 1 << NumBits;
2253         }
2254         ImmOp.ChangeToImmediate(ImmedOffset);
2255         Offset = 0;
2256         return true;
2257       }
2258
2259       // Otherwise, it didn't fit. Pull in what we can to simplify the immed.
2260       ImmedOffset = ImmedOffset & Mask;
2261       if (isSub) {
2262         if (AddrMode == ARMII::AddrMode_i12)
2263           ImmedOffset = -ImmedOffset;
2264         else
2265           ImmedOffset |= 1 << NumBits;
2266       }
2267       ImmOp.ChangeToImmediate(ImmedOffset);
2268       Offset &= ~(Mask*Scale);
2269     }
2270   }
2271
2272   Offset = (isSub) ? -Offset : Offset;
2273   return Offset == 0;
2274 }
2275
2276 /// analyzeCompare - For a comparison instruction, return the source registers
2277 /// in SrcReg and SrcReg2 if having two register operands, and the value it
2278 /// compares against in CmpValue. Return true if the comparison instruction
2279 /// can be analyzed.
2280 bool ARMBaseInstrInfo::
2281 analyzeCompare(const MachineInstr *MI, unsigned &SrcReg, unsigned &SrcReg2,
2282                int &CmpMask, int &CmpValue) const {
2283   switch (MI->getOpcode()) {
2284   default: break;
2285   case ARM::CMPri:
2286   case ARM::t2CMPri:
2287     SrcReg = MI->getOperand(0).getReg();
2288     SrcReg2 = 0;
2289     CmpMask = ~0;
2290     CmpValue = MI->getOperand(1).getImm();
2291     return true;
2292   case ARM::CMPrr:
2293   case ARM::t2CMPrr:
2294     SrcReg = MI->getOperand(0).getReg();
2295     SrcReg2 = MI->getOperand(1).getReg();
2296     CmpMask = ~0;
2297     CmpValue = 0;
2298     return true;
2299   case ARM::TSTri:
2300   case ARM::t2TSTri:
2301     SrcReg = MI->getOperand(0).getReg();
2302     SrcReg2 = 0;
2303     CmpMask = MI->getOperand(1).getImm();
2304     CmpValue = 0;
2305     return true;
2306   }
2307
2308   return false;
2309 }
2310
2311 /// isSuitableForMask - Identify a suitable 'and' instruction that
2312 /// operates on the given source register and applies the same mask
2313 /// as a 'tst' instruction. Provide a limited look-through for copies.
2314 /// When successful, MI will hold the found instruction.
2315 static bool isSuitableForMask(MachineInstr *&MI, unsigned SrcReg,
2316                               int CmpMask, bool CommonUse) {
2317   switch (MI->getOpcode()) {
2318     case ARM::ANDri:
2319     case ARM::t2ANDri:
2320       if (CmpMask != MI->getOperand(2).getImm())
2321         return false;
2322       if (SrcReg == MI->getOperand(CommonUse ? 1 : 0).getReg())
2323         return true;
2324       break;
2325   }
2326
2327   return false;
2328 }
2329
2330 /// getSwappedCondition - assume the flags are set by MI(a,b), return
2331 /// the condition code if we modify the instructions such that flags are
2332 /// set by MI(b,a).
2333 inline static ARMCC::CondCodes getSwappedCondition(ARMCC::CondCodes CC) {
2334   switch (CC) {
2335   default: return ARMCC::AL;
2336   case ARMCC::EQ: return ARMCC::EQ;
2337   case ARMCC::NE: return ARMCC::NE;
2338   case ARMCC::HS: return ARMCC::LS;
2339   case ARMCC::LO: return ARMCC::HI;
2340   case ARMCC::HI: return ARMCC::LO;
2341   case ARMCC::LS: return ARMCC::HS;
2342   case ARMCC::GE: return ARMCC::LE;
2343   case ARMCC::LT: return ARMCC::GT;
2344   case ARMCC::GT: return ARMCC::LT;
2345   case ARMCC::LE: return ARMCC::GE;
2346   }
2347 }
2348
2349 /// isRedundantFlagInstr - check whether the first instruction, whose only
2350 /// purpose is to update flags, can be made redundant.
2351 /// CMPrr can be made redundant by SUBrr if the operands are the same.
2352 /// CMPri can be made redundant by SUBri if the operands are the same.
2353 /// This function can be extended later on.
2354 inline static bool isRedundantFlagInstr(MachineInstr *CmpI, unsigned SrcReg,
2355                                         unsigned SrcReg2, int ImmValue,
2356                                         MachineInstr *OI) {
2357   if ((CmpI->getOpcode() == ARM::CMPrr ||
2358        CmpI->getOpcode() == ARM::t2CMPrr) &&
2359       (OI->getOpcode() == ARM::SUBrr ||
2360        OI->getOpcode() == ARM::t2SUBrr) &&
2361       ((OI->getOperand(1).getReg() == SrcReg &&
2362         OI->getOperand(2).getReg() == SrcReg2) ||
2363        (OI->getOperand(1).getReg() == SrcReg2 &&
2364         OI->getOperand(2).getReg() == SrcReg)))
2365     return true;
2366
2367   if ((CmpI->getOpcode() == ARM::CMPri ||
2368        CmpI->getOpcode() == ARM::t2CMPri) &&
2369       (OI->getOpcode() == ARM::SUBri ||
2370        OI->getOpcode() == ARM::t2SUBri) &&
2371       OI->getOperand(1).getReg() == SrcReg &&
2372       OI->getOperand(2).getImm() == ImmValue)
2373     return true;
2374   return false;
2375 }
2376
2377 /// optimizeCompareInstr - Convert the instruction supplying the argument to the
2378 /// comparison into one that sets the zero bit in the flags register;
2379 /// Remove a redundant Compare instruction if an earlier instruction can set the
2380 /// flags in the same way as Compare.
2381 /// E.g. SUBrr(r1,r2) and CMPrr(r1,r2). We also handle the case where two
2382 /// operands are swapped: SUBrr(r1,r2) and CMPrr(r2,r1), by updating the
2383 /// condition code of instructions which use the flags.
2384 bool ARMBaseInstrInfo::
2385 optimizeCompareInstr(MachineInstr *CmpInstr, unsigned SrcReg, unsigned SrcReg2,
2386                      int CmpMask, int CmpValue,
2387                      const MachineRegisterInfo *MRI) const {
2388   // Get the unique definition of SrcReg.
2389   MachineInstr *MI = MRI->getUniqueVRegDef(SrcReg);
2390   if (!MI) return false;
2391
2392   // Masked compares sometimes use the same register as the corresponding 'and'.
2393   if (CmpMask != ~0) {
2394     if (!isSuitableForMask(MI, SrcReg, CmpMask, false) || isPredicated(MI)) {
2395       MI = nullptr;
2396       for (MachineRegisterInfo::use_instr_iterator
2397            UI = MRI->use_instr_begin(SrcReg), UE = MRI->use_instr_end();
2398            UI != UE; ++UI) {
2399         if (UI->getParent() != CmpInstr->getParent()) continue;
2400         MachineInstr *PotentialAND = &*UI;
2401         if (!isSuitableForMask(PotentialAND, SrcReg, CmpMask, true) ||
2402             isPredicated(PotentialAND))
2403           continue;
2404         MI = PotentialAND;
2405         break;
2406       }
2407       if (!MI) return false;
2408     }
2409   }
2410
2411   // Get ready to iterate backward from CmpInstr.
2412   MachineBasicBlock::iterator I = CmpInstr, E = MI,
2413                               B = CmpInstr->getParent()->begin();
2414
2415   // Early exit if CmpInstr is at the beginning of the BB.
2416   if (I == B) return false;
2417
2418   // There are two possible candidates which can be changed to set CPSR:
2419   // One is MI, the other is a SUB instruction.
2420   // For CMPrr(r1,r2), we are looking for SUB(r1,r2) or SUB(r2,r1).
2421   // For CMPri(r1, CmpValue), we are looking for SUBri(r1, CmpValue).
2422   MachineInstr *Sub = nullptr;
2423   if (SrcReg2 != 0)
2424     // MI is not a candidate for CMPrr.
2425     MI = nullptr;
2426   else if (MI->getParent() != CmpInstr->getParent() || CmpValue != 0) {
2427     // Conservatively refuse to convert an instruction which isn't in the same
2428     // BB as the comparison.
2429     // For CMPri w/ CmpValue != 0, a Sub may still be a candidate.
2430     // Thus we cannot return here.
2431     if (CmpInstr->getOpcode() == ARM::CMPri ||
2432        CmpInstr->getOpcode() == ARM::t2CMPri)
2433       MI = nullptr;
2434     else
2435       return false;
2436   }
2437
2438   // Check that CPSR isn't set between the comparison instruction and the one we
2439   // want to change. At the same time, search for Sub.
2440   const TargetRegisterInfo *TRI = &getRegisterInfo();
2441   --I;
2442   for (; I != E; --I) {
2443     const MachineInstr &Instr = *I;
2444
2445     if (Instr.modifiesRegister(ARM::CPSR, TRI) ||
2446         Instr.readsRegister(ARM::CPSR, TRI))
2447       // This instruction modifies or uses CPSR after the one we want to
2448       // change. We can't do this transformation.
2449       return false;
2450
2451     // Check whether CmpInstr can be made redundant by the current instruction.
2452     if (isRedundantFlagInstr(CmpInstr, SrcReg, SrcReg2, CmpValue, &*I)) {
2453       Sub = &*I;
2454       break;
2455     }
2456
2457     if (I == B)
2458       // The 'and' is below the comparison instruction.
2459       return false;
2460   }
2461
2462   // Return false if no candidates exist.
2463   if (!MI && !Sub)
2464     return false;
2465
2466   // The single candidate is called MI.
2467   if (!MI) MI = Sub;
2468
2469   // We can't use a predicated instruction - it doesn't always write the flags.
2470   if (isPredicated(MI))
2471     return false;
2472
2473   switch (MI->getOpcode()) {
2474   default: break;
2475   case ARM::RSBrr:
2476   case ARM::RSBri:
2477   case ARM::RSCrr:
2478   case ARM::RSCri:
2479   case ARM::ADDrr:
2480   case ARM::ADDri:
2481   case ARM::ADCrr:
2482   case ARM::ADCri:
2483   case ARM::SUBrr:
2484   case ARM::SUBri:
2485   case ARM::SBCrr:
2486   case ARM::SBCri:
2487   case ARM::t2RSBri:
2488   case ARM::t2ADDrr:
2489   case ARM::t2ADDri:
2490   case ARM::t2ADCrr:
2491   case ARM::t2ADCri:
2492   case ARM::t2SUBrr:
2493   case ARM::t2SUBri:
2494   case ARM::t2SBCrr:
2495   case ARM::t2SBCri:
2496   case ARM::ANDrr:
2497   case ARM::ANDri:
2498   case ARM::t2ANDrr:
2499   case ARM::t2ANDri:
2500   case ARM::ORRrr:
2501   case ARM::ORRri:
2502   case ARM::t2ORRrr:
2503   case ARM::t2ORRri:
2504   case ARM::EORrr:
2505   case ARM::EORri:
2506   case ARM::t2EORrr:
2507   case ARM::t2EORri: {
2508     // Scan forward for the use of CPSR
2509     // When checking against MI: if it's a conditional code that requires
2510     // checking of the V bit or C bit, then this is not safe to do.
2511     // It is safe to remove CmpInstr if CPSR is redefined or killed.
2512     // If we are done with the basic block, we need to check whether CPSR is
2513     // live-out.
2514     SmallVector<std::pair<MachineOperand*, ARMCC::CondCodes>, 4>
2515         OperandsToUpdate;
2516     bool isSafe = false;
2517     I = CmpInstr;
2518     E = CmpInstr->getParent()->end();
2519     while (!isSafe && ++I != E) {
2520       const MachineInstr &Instr = *I;
2521       for (unsigned IO = 0, EO = Instr.getNumOperands();
2522            !isSafe && IO != EO; ++IO) {
2523         const MachineOperand &MO = Instr.getOperand(IO);
2524         if (MO.isRegMask() && MO.clobbersPhysReg(ARM::CPSR)) {
2525           isSafe = true;
2526           break;
2527         }
2528         if (!MO.isReg() || MO.getReg() != ARM::CPSR)
2529           continue;
2530         if (MO.isDef()) {
2531           isSafe = true;
2532           break;
2533         }
2534         // Condition code is after the operand before CPSR except for VSELs.
2535         ARMCC::CondCodes CC;
2536         bool IsInstrVSel = true;
2537         switch (Instr.getOpcode()) {
2538         default:
2539           IsInstrVSel = false;
2540           CC = (ARMCC::CondCodes)Instr.getOperand(IO - 1).getImm();
2541           break;
2542         case ARM::VSELEQD:
2543         case ARM::VSELEQS:
2544           CC = ARMCC::EQ;
2545           break;
2546         case ARM::VSELGTD:
2547         case ARM::VSELGTS:
2548           CC = ARMCC::GT;
2549           break;
2550         case ARM::VSELGED:
2551         case ARM::VSELGES:
2552           CC = ARMCC::GE;
2553           break;
2554         case ARM::VSELVSS:
2555         case ARM::VSELVSD:
2556           CC = ARMCC::VS;
2557           break;
2558         }
2559
2560         if (Sub) {
2561           ARMCC::CondCodes NewCC = getSwappedCondition(CC);
2562           if (NewCC == ARMCC::AL)
2563             return false;
2564           // If we have SUB(r1, r2) and CMP(r2, r1), the condition code based
2565           // on CMP needs to be updated to be based on SUB.
2566           // Push the condition code operands to OperandsToUpdate.
2567           // If it is safe to remove CmpInstr, the condition code of these
2568           // operands will be modified.
2569           if (SrcReg2 != 0 && Sub->getOperand(1).getReg() == SrcReg2 &&
2570               Sub->getOperand(2).getReg() == SrcReg) {
2571             // VSel doesn't support condition code update.
2572             if (IsInstrVSel)
2573               return false;
2574             OperandsToUpdate.push_back(
2575                 std::make_pair(&((*I).getOperand(IO - 1)), NewCC));
2576           }
2577         } else {
2578           // No Sub, so this is x = <op> y, z; cmp x, 0.
2579           switch (CC) {
2580           case ARMCC::EQ: // Z
2581           case ARMCC::NE: // Z
2582           case ARMCC::MI: // N
2583           case ARMCC::PL: // N
2584           case ARMCC::AL: // none
2585             // CPSR can be used multiple times, we should continue.
2586             break;
2587           case ARMCC::HS: // C
2588           case ARMCC::LO: // C
2589           case ARMCC::VS: // V
2590           case ARMCC::VC: // V
2591           case ARMCC::HI: // C Z
2592           case ARMCC::LS: // C Z
2593           case ARMCC::GE: // N V
2594           case ARMCC::LT: // N V
2595           case ARMCC::GT: // Z N V
2596           case ARMCC::LE: // Z N V
2597             // The instruction uses the V bit or C bit which is not safe.
2598             return false;
2599           }
2600         }
2601       }
2602     }
2603
2604     // If CPSR is not killed nor re-defined, we should check whether it is
2605     // live-out. If it is live-out, do not optimize.
2606     if (!isSafe) {
2607       MachineBasicBlock *MBB = CmpInstr->getParent();
2608       for (MachineBasicBlock::succ_iterator SI = MBB->succ_begin(),
2609                SE = MBB->succ_end(); SI != SE; ++SI)
2610         if ((*SI)->isLiveIn(ARM::CPSR))
2611           return false;
2612     }
2613
2614     // Toggle the optional operand to CPSR.
2615     MI->getOperand(5).setReg(ARM::CPSR);
2616     MI->getOperand(5).setIsDef(true);
2617     assert(!isPredicated(MI) && "Can't use flags from predicated instruction");
2618     CmpInstr->eraseFromParent();
2619
2620     // Modify the condition code of operands in OperandsToUpdate.
2621     // Since we have SUB(r1, r2) and CMP(r2, r1), the condition code needs to
2622     // be changed from r2 > r1 to r1 < r2, from r2 < r1 to r1 > r2, etc.
2623     for (unsigned i = 0, e = OperandsToUpdate.size(); i < e; i++)
2624       OperandsToUpdate[i].first->setImm(OperandsToUpdate[i].second);
2625     return true;
2626   }
2627   }
2628
2629   return false;
2630 }
2631
2632 bool ARMBaseInstrInfo::FoldImmediate(MachineInstr *UseMI,
2633                                      MachineInstr *DefMI, unsigned Reg,
2634                                      MachineRegisterInfo *MRI) const {
2635   // Fold large immediates into add, sub, or, xor.
2636   unsigned DefOpc = DefMI->getOpcode();
2637   if (DefOpc != ARM::t2MOVi32imm && DefOpc != ARM::MOVi32imm)
2638     return false;
2639   if (!DefMI->getOperand(1).isImm())
2640     // Could be t2MOVi32imm <ga:xx>
2641     return false;
2642
2643   if (!MRI->hasOneNonDBGUse(Reg))
2644     return false;
2645
2646   const MCInstrDesc &DefMCID = DefMI->getDesc();
2647   if (DefMCID.hasOptionalDef()) {
2648     unsigned NumOps = DefMCID.getNumOperands();
2649     const MachineOperand &MO = DefMI->getOperand(NumOps-1);
2650     if (MO.getReg() == ARM::CPSR && !MO.isDead())
2651       // If DefMI defines CPSR and it is not dead, it's obviously not safe
2652       // to delete DefMI.
2653       return false;
2654   }
2655
2656   const MCInstrDesc &UseMCID = UseMI->getDesc();
2657   if (UseMCID.hasOptionalDef()) {
2658     unsigned NumOps = UseMCID.getNumOperands();
2659     if (UseMI->getOperand(NumOps-1).getReg() == ARM::CPSR)
2660       // If the instruction sets the flag, do not attempt this optimization
2661       // since it may change the semantics of the code.
2662       return false;
2663   }
2664
2665   unsigned UseOpc = UseMI->getOpcode();
2666   unsigned NewUseOpc = 0;
2667   uint32_t ImmVal = (uint32_t)DefMI->getOperand(1).getImm();
2668   uint32_t SOImmValV1 = 0, SOImmValV2 = 0;
2669   bool Commute = false;
2670   switch (UseOpc) {
2671   default: return false;
2672   case ARM::SUBrr:
2673   case ARM::ADDrr:
2674   case ARM::ORRrr:
2675   case ARM::EORrr:
2676   case ARM::t2SUBrr:
2677   case ARM::t2ADDrr:
2678   case ARM::t2ORRrr:
2679   case ARM::t2EORrr: {
2680     Commute = UseMI->getOperand(2).getReg() != Reg;
2681     switch (UseOpc) {
2682     default: break;
2683     case ARM::SUBrr: {
2684       if (Commute)
2685         return false;
2686       ImmVal = -ImmVal;
2687       NewUseOpc = ARM::SUBri;
2688       // Fallthrough
2689     }
2690     case ARM::ADDrr:
2691     case ARM::ORRrr:
2692     case ARM::EORrr: {
2693       if (!ARM_AM::isSOImmTwoPartVal(ImmVal))
2694         return false;
2695       SOImmValV1 = (uint32_t)ARM_AM::getSOImmTwoPartFirst(ImmVal);
2696       SOImmValV2 = (uint32_t)ARM_AM::getSOImmTwoPartSecond(ImmVal);
2697       switch (UseOpc) {
2698       default: break;
2699       case ARM::ADDrr: NewUseOpc = ARM::ADDri; break;
2700       case ARM::ORRrr: NewUseOpc = ARM::ORRri; break;
2701       case ARM::EORrr: NewUseOpc = ARM::EORri; break;
2702       }
2703       break;
2704     }
2705     case ARM::t2SUBrr: {
2706       if (Commute)
2707         return false;
2708       ImmVal = -ImmVal;
2709       NewUseOpc = ARM::t2SUBri;
2710       // Fallthrough
2711     }
2712     case ARM::t2ADDrr:
2713     case ARM::t2ORRrr:
2714     case ARM::t2EORrr: {
2715       if (!ARM_AM::isT2SOImmTwoPartVal(ImmVal))
2716         return false;
2717       SOImmValV1 = (uint32_t)ARM_AM::getT2SOImmTwoPartFirst(ImmVal);
2718       SOImmValV2 = (uint32_t)ARM_AM::getT2SOImmTwoPartSecond(ImmVal);
2719       switch (UseOpc) {
2720       default: break;
2721       case ARM::t2ADDrr: NewUseOpc = ARM::t2ADDri; break;
2722       case ARM::t2ORRrr: NewUseOpc = ARM::t2ORRri; break;
2723       case ARM::t2EORrr: NewUseOpc = ARM::t2EORri; break;
2724       }
2725       break;
2726     }
2727     }
2728   }
2729   }
2730
2731   unsigned OpIdx = Commute ? 2 : 1;
2732   unsigned Reg1 = UseMI->getOperand(OpIdx).getReg();
2733   bool isKill = UseMI->getOperand(OpIdx).isKill();
2734   unsigned NewReg = MRI->createVirtualRegister(MRI->getRegClass(Reg));
2735   AddDefaultCC(AddDefaultPred(BuildMI(*UseMI->getParent(),
2736                                       UseMI, UseMI->getDebugLoc(),
2737                                       get(NewUseOpc), NewReg)
2738                               .addReg(Reg1, getKillRegState(isKill))
2739                               .addImm(SOImmValV1)));
2740   UseMI->setDesc(get(NewUseOpc));
2741   UseMI->getOperand(1).setReg(NewReg);
2742   UseMI->getOperand(1).setIsKill();
2743   UseMI->getOperand(2).ChangeToImmediate(SOImmValV2);
2744   DefMI->eraseFromParent();
2745   return true;
2746 }
2747
2748 static unsigned getNumMicroOpsSwiftLdSt(const InstrItineraryData *ItinData,
2749                                         const MachineInstr *MI) {
2750   switch (MI->getOpcode()) {
2751   default: {
2752     const MCInstrDesc &Desc = MI->getDesc();
2753     int UOps = ItinData->getNumMicroOps(Desc.getSchedClass());
2754     assert(UOps >= 0 && "bad # UOps");
2755     return UOps;
2756   }
2757
2758   case ARM::LDRrs:
2759   case ARM::LDRBrs:
2760   case ARM::STRrs:
2761   case ARM::STRBrs: {
2762     unsigned ShOpVal = MI->getOperand(3).getImm();
2763     bool isSub = ARM_AM::getAM2Op(ShOpVal) == ARM_AM::sub;
2764     unsigned ShImm = ARM_AM::getAM2Offset(ShOpVal);
2765     if (!isSub &&
2766         (ShImm == 0 ||
2767          ((ShImm == 1 || ShImm == 2 || ShImm == 3) &&
2768           ARM_AM::getAM2ShiftOpc(ShOpVal) == ARM_AM::lsl)))
2769       return 1;
2770     return 2;
2771   }
2772
2773   case ARM::LDRH:
2774   case ARM::STRH: {
2775     if (!MI->getOperand(2).getReg())
2776       return 1;
2777
2778     unsigned ShOpVal = MI->getOperand(3).getImm();
2779     bool isSub = ARM_AM::getAM2Op(ShOpVal) == ARM_AM::sub;
2780     unsigned ShImm = ARM_AM::getAM2Offset(ShOpVal);
2781     if (!isSub &&
2782         (ShImm == 0 ||
2783          ((ShImm == 1 || ShImm == 2 || ShImm == 3) &&
2784           ARM_AM::getAM2ShiftOpc(ShOpVal) == ARM_AM::lsl)))
2785       return 1;
2786     return 2;
2787   }
2788
2789   case ARM::LDRSB:
2790   case ARM::LDRSH:
2791     return (ARM_AM::getAM3Op(MI->getOperand(3).getImm()) == ARM_AM::sub) ? 3:2;
2792
2793   case ARM::LDRSB_POST:
2794   case ARM::LDRSH_POST: {
2795     unsigned Rt = MI->getOperand(0).getReg();
2796     unsigned Rm = MI->getOperand(3).getReg();
2797     return (Rt == Rm) ? 4 : 3;
2798   }
2799
2800   case ARM::LDR_PRE_REG:
2801   case ARM::LDRB_PRE_REG: {
2802     unsigned Rt = MI->getOperand(0).getReg();
2803     unsigned Rm = MI->getOperand(3).getReg();
2804     if (Rt == Rm)
2805       return 3;
2806     unsigned ShOpVal = MI->getOperand(4).getImm();
2807     bool isSub = ARM_AM::getAM2Op(ShOpVal) == ARM_AM::sub;
2808     unsigned ShImm = ARM_AM::getAM2Offset(ShOpVal);
2809     if (!isSub &&
2810         (ShImm == 0 ||
2811          ((ShImm == 1 || ShImm == 2 || ShImm == 3) &&
2812           ARM_AM::getAM2ShiftOpc(ShOpVal) == ARM_AM::lsl)))
2813       return 2;
2814     return 3;
2815   }
2816
2817   case ARM::STR_PRE_REG:
2818   case ARM::STRB_PRE_REG: {
2819     unsigned ShOpVal = MI->getOperand(4).getImm();
2820     bool isSub = ARM_AM::getAM2Op(ShOpVal) == ARM_AM::sub;
2821     unsigned ShImm = ARM_AM::getAM2Offset(ShOpVal);
2822     if (!isSub &&
2823         (ShImm == 0 ||
2824          ((ShImm == 1 || ShImm == 2 || ShImm == 3) &&
2825           ARM_AM::getAM2ShiftOpc(ShOpVal) == ARM_AM::lsl)))
2826       return 2;
2827     return 3;
2828   }
2829
2830   case ARM::LDRH_PRE:
2831   case ARM::STRH_PRE: {
2832     unsigned Rt = MI->getOperand(0).getReg();
2833     unsigned Rm = MI->getOperand(3).getReg();
2834     if (!Rm)
2835       return 2;
2836     if (Rt == Rm)
2837       return 3;
2838     return (ARM_AM::getAM3Op(MI->getOperand(4).getImm()) == ARM_AM::sub)
2839       ? 3 : 2;
2840   }
2841
2842   case ARM::LDR_POST_REG:
2843   case ARM::LDRB_POST_REG:
2844   case ARM::LDRH_POST: {
2845     unsigned Rt = MI->getOperand(0).getReg();
2846     unsigned Rm = MI->getOperand(3).getReg();
2847     return (Rt == Rm) ? 3 : 2;
2848   }
2849
2850   case ARM::LDR_PRE_IMM:
2851   case ARM::LDRB_PRE_IMM:
2852   case ARM::LDR_POST_IMM:
2853   case ARM::LDRB_POST_IMM:
2854   case ARM::STRB_POST_IMM:
2855   case ARM::STRB_POST_REG:
2856   case ARM::STRB_PRE_IMM:
2857   case ARM::STRH_POST:
2858   case ARM::STR_POST_IMM:
2859   case ARM::STR_POST_REG:
2860   case ARM::STR_PRE_IMM:
2861     return 2;
2862
2863   case ARM::LDRSB_PRE:
2864   case ARM::LDRSH_PRE: {
2865     unsigned Rm = MI->getOperand(3).getReg();
2866     if (Rm == 0)
2867       return 3;
2868     unsigned Rt = MI->getOperand(0).getReg();
2869     if (Rt == Rm)
2870       return 4;
2871     unsigned ShOpVal = MI->getOperand(4).getImm();
2872     bool isSub = ARM_AM::getAM2Op(ShOpVal) == ARM_AM::sub;
2873     unsigned ShImm = ARM_AM::getAM2Offset(ShOpVal);
2874     if (!isSub &&
2875         (ShImm == 0 ||
2876          ((ShImm == 1 || ShImm == 2 || ShImm == 3) &&
2877           ARM_AM::getAM2ShiftOpc(ShOpVal) == ARM_AM::lsl)))
2878       return 3;
2879     return 4;
2880   }
2881
2882   case ARM::LDRD: {
2883     unsigned Rt = MI->getOperand(0).getReg();
2884     unsigned Rn = MI->getOperand(2).getReg();
2885     unsigned Rm = MI->getOperand(3).getReg();
2886     if (Rm)
2887       return (ARM_AM::getAM3Op(MI->getOperand(4).getImm()) == ARM_AM::sub) ?4:3;
2888     return (Rt == Rn) ? 3 : 2;
2889   }
2890
2891   case ARM::STRD: {
2892     unsigned Rm = MI->getOperand(3).getReg();
2893     if (Rm)
2894       return (ARM_AM::getAM3Op(MI->getOperand(4).getImm()) == ARM_AM::sub) ?4:3;
2895     return 2;
2896   }
2897
2898   case ARM::LDRD_POST:
2899   case ARM::t2LDRD_POST:
2900     return 3;
2901
2902   case ARM::STRD_POST:
2903   case ARM::t2STRD_POST:
2904     return 4;
2905
2906   case ARM::LDRD_PRE: {
2907     unsigned Rt = MI->getOperand(0).getReg();
2908     unsigned Rn = MI->getOperand(3).getReg();
2909     unsigned Rm = MI->getOperand(4).getReg();
2910     if (Rm)
2911       return (ARM_AM::getAM3Op(MI->getOperand(5).getImm()) == ARM_AM::sub) ?5:4;
2912     return (Rt == Rn) ? 4 : 3;
2913   }
2914
2915   case ARM::t2LDRD_PRE: {
2916     unsigned Rt = MI->getOperand(0).getReg();
2917     unsigned Rn = MI->getOperand(3).getReg();
2918     return (Rt == Rn) ? 4 : 3;
2919   }
2920
2921   case ARM::STRD_PRE: {
2922     unsigned Rm = MI->getOperand(4).getReg();
2923     if (Rm)
2924       return (ARM_AM::getAM3Op(MI->getOperand(5).getImm()) == ARM_AM::sub) ?5:4;
2925     return 3;
2926   }
2927
2928   case ARM::t2STRD_PRE:
2929     return 3;
2930
2931   case ARM::t2LDR_POST:
2932   case ARM::t2LDRB_POST:
2933   case ARM::t2LDRB_PRE:
2934   case ARM::t2LDRSBi12:
2935   case ARM::t2LDRSBi8:
2936   case ARM::t2LDRSBpci:
2937   case ARM::t2LDRSBs:
2938   case ARM::t2LDRH_POST:
2939   case ARM::t2LDRH_PRE:
2940   case ARM::t2LDRSBT:
2941   case ARM::t2LDRSB_POST:
2942   case ARM::t2LDRSB_PRE:
2943   case ARM::t2LDRSH_POST:
2944   case ARM::t2LDRSH_PRE:
2945   case ARM::t2LDRSHi12:
2946   case ARM::t2LDRSHi8:
2947   case ARM::t2LDRSHpci:
2948   case ARM::t2LDRSHs:
2949     return 2;
2950
2951   case ARM::t2LDRDi8: {
2952     unsigned Rt = MI->getOperand(0).getReg();
2953     unsigned Rn = MI->getOperand(2).getReg();
2954     return (Rt == Rn) ? 3 : 2;
2955   }
2956
2957   case ARM::t2STRB_POST:
2958   case ARM::t2STRB_PRE:
2959   case ARM::t2STRBs:
2960   case ARM::t2STRDi8:
2961   case ARM::t2STRH_POST:
2962   case ARM::t2STRH_PRE:
2963   case ARM::t2STRHs:
2964   case ARM::t2STR_POST:
2965   case ARM::t2STR_PRE:
2966   case ARM::t2STRs:
2967     return 2;
2968   }
2969 }
2970
2971 // Return the number of 32-bit words loaded by LDM or stored by STM. If this
2972 // can't be easily determined return 0 (missing MachineMemOperand).
2973 //
2974 // FIXME: The current MachineInstr design does not support relying on machine
2975 // mem operands to determine the width of a memory access. Instead, we expect
2976 // the target to provide this information based on the instruction opcode and
2977 // operands. However, using MachineMemOperand is the best solution now for
2978 // two reasons:
2979 //
2980 // 1) getNumMicroOps tries to infer LDM memory width from the total number of MI
2981 // operands. This is much more dangerous than using the MachineMemOperand
2982 // sizes because CodeGen passes can insert/remove optional machine operands. In
2983 // fact, it's totally incorrect for preRA passes and appears to be wrong for
2984 // postRA passes as well.
2985 //
2986 // 2) getNumLDMAddresses is only used by the scheduling machine model and any
2987 // machine model that calls this should handle the unknown (zero size) case.
2988 //
2989 // Long term, we should require a target hook that verifies MachineMemOperand
2990 // sizes during MC lowering. That target hook should be local to MC lowering
2991 // because we can't ensure that it is aware of other MI forms. Doing this will
2992 // ensure that MachineMemOperands are correctly propagated through all passes.
2993 unsigned ARMBaseInstrInfo::getNumLDMAddresses(const MachineInstr *MI) const {
2994   unsigned Size = 0;
2995   for (MachineInstr::mmo_iterator I = MI->memoperands_begin(),
2996          E = MI->memoperands_end(); I != E; ++I) {
2997     Size += (*I)->getSize();
2998   }
2999   return Size / 4;
3000 }
3001
3002 unsigned
3003 ARMBaseInstrInfo::getNumMicroOps(const InstrItineraryData *ItinData,
3004                                  const MachineInstr *MI) const {
3005   if (!ItinData || ItinData->isEmpty())
3006     return 1;
3007
3008   const MCInstrDesc &Desc = MI->getDesc();
3009   unsigned Class = Desc.getSchedClass();
3010   int ItinUOps = ItinData->getNumMicroOps(Class);
3011   if (ItinUOps >= 0) {
3012     if (Subtarget.isSwift() && (Desc.mayLoad() || Desc.mayStore()))
3013       return getNumMicroOpsSwiftLdSt(ItinData, MI);
3014
3015     return ItinUOps;
3016   }
3017
3018   unsigned Opc = MI->getOpcode();
3019   switch (Opc) {
3020   default:
3021     llvm_unreachable("Unexpected multi-uops instruction!");
3022   case ARM::VLDMQIA:
3023   case ARM::VSTMQIA:
3024     return 2;
3025
3026   // The number of uOps for load / store multiple are determined by the number
3027   // registers.
3028   //
3029   // On Cortex-A8, each pair of register loads / stores can be scheduled on the
3030   // same cycle. The scheduling for the first load / store must be done
3031   // separately by assuming the address is not 64-bit aligned.
3032   //
3033   // On Cortex-A9, the formula is simply (#reg / 2) + (#reg % 2). If the address
3034   // is not 64-bit aligned, then AGU would take an extra cycle.  For VFP / NEON
3035   // load / store multiple, the formula is (#reg / 2) + (#reg % 2) + 1.
3036   case ARM::VLDMDIA:
3037   case ARM::VLDMDIA_UPD:
3038   case ARM::VLDMDDB_UPD:
3039   case ARM::VLDMSIA:
3040   case ARM::VLDMSIA_UPD:
3041   case ARM::VLDMSDB_UPD:
3042   case ARM::VSTMDIA:
3043   case ARM::VSTMDIA_UPD:
3044   case ARM::VSTMDDB_UPD:
3045   case ARM::VSTMSIA:
3046   case ARM::VSTMSIA_UPD:
3047   case ARM::VSTMSDB_UPD: {
3048     unsigned NumRegs = MI->getNumOperands() - Desc.getNumOperands();
3049     return (NumRegs / 2) + (NumRegs % 2) + 1;
3050   }
3051
3052   case ARM::LDMIA_RET:
3053   case ARM::LDMIA:
3054   case ARM::LDMDA:
3055   case ARM::LDMDB:
3056   case ARM::LDMIB:
3057   case ARM::LDMIA_UPD:
3058   case ARM::LDMDA_UPD:
3059   case ARM::LDMDB_UPD:
3060   case ARM::LDMIB_UPD:
3061   case ARM::STMIA:
3062   case ARM::STMDA:
3063   case ARM::STMDB:
3064   case ARM::STMIB:
3065   case ARM::STMIA_UPD:
3066   case ARM::STMDA_UPD:
3067   case ARM::STMDB_UPD:
3068   case ARM::STMIB_UPD:
3069   case ARM::tLDMIA:
3070   case ARM::tLDMIA_UPD:
3071   case ARM::tSTMIA_UPD:
3072   case ARM::tPOP_RET:
3073   case ARM::tPOP:
3074   case ARM::tPUSH:
3075   case ARM::t2LDMIA_RET:
3076   case ARM::t2LDMIA:
3077   case ARM::t2LDMDB:
3078   case ARM::t2LDMIA_UPD:
3079   case ARM::t2LDMDB_UPD:
3080   case ARM::t2STMIA:
3081   case ARM::t2STMDB:
3082   case ARM::t2STMIA_UPD:
3083   case ARM::t2STMDB_UPD: {
3084     unsigned NumRegs = MI->getNumOperands() - Desc.getNumOperands() + 1;
3085     if (Subtarget.isSwift()) {
3086       int UOps = 1 + NumRegs;  // One for address computation, one for each ld / st.
3087       switch (Opc) {
3088       default: break;
3089       case ARM::VLDMDIA_UPD:
3090       case ARM::VLDMDDB_UPD:
3091       case ARM::VLDMSIA_UPD:
3092       case ARM::VLDMSDB_UPD:
3093       case ARM::VSTMDIA_UPD:
3094       case ARM::VSTMDDB_UPD:
3095       case ARM::VSTMSIA_UPD:
3096       case ARM::VSTMSDB_UPD:
3097       case ARM::LDMIA_UPD:
3098       case ARM::LDMDA_UPD:
3099       case ARM::LDMDB_UPD:
3100       case ARM::LDMIB_UPD:
3101       case ARM::STMIA_UPD:
3102       case ARM::STMDA_UPD:
3103       case ARM::STMDB_UPD:
3104       case ARM::STMIB_UPD:
3105       case ARM::tLDMIA_UPD:
3106       case ARM::tSTMIA_UPD:
3107       case ARM::t2LDMIA_UPD:
3108       case ARM::t2LDMDB_UPD:
3109       case ARM::t2STMIA_UPD:
3110       case ARM::t2STMDB_UPD:
3111         ++UOps; // One for base register writeback.
3112         break;
3113       case ARM::LDMIA_RET:
3114       case ARM::tPOP_RET:
3115       case ARM::t2LDMIA_RET:
3116         UOps += 2; // One for base reg wb, one for write to pc.
3117         break;
3118       }
3119       return UOps;
3120     } else if (Subtarget.isCortexA8() || Subtarget.isCortexA7()) {
3121       if (NumRegs < 4)
3122         return 2;
3123       // 4 registers would be issued: 2, 2.
3124       // 5 registers would be issued: 2, 2, 1.
3125       int A8UOps = (NumRegs / 2);
3126       if (NumRegs % 2)
3127         ++A8UOps;
3128       return A8UOps;
3129     } else if (Subtarget.isLikeA9() || Subtarget.isSwift()) {
3130       int A9UOps = (NumRegs / 2);
3131       // If there are odd number of registers or if it's not 64-bit aligned,
3132       // then it takes an extra AGU (Address Generation Unit) cycle.
3133       if ((NumRegs % 2) ||
3134           !MI->hasOneMemOperand() ||
3135           (*MI->memoperands_begin())->getAlignment() < 8)
3136         ++A9UOps;
3137       return A9UOps;
3138     } else {
3139       // Assume the worst.
3140       return NumRegs;
3141     }
3142   }
3143   }
3144 }
3145
3146 int
3147 ARMBaseInstrInfo::getVLDMDefCycle(const InstrItineraryData *ItinData,
3148                                   const MCInstrDesc &DefMCID,
3149                                   unsigned DefClass,
3150                                   unsigned DefIdx, unsigned DefAlign) const {
3151   int RegNo = (int)(DefIdx+1) - DefMCID.getNumOperands() + 1;
3152   if (RegNo <= 0)
3153     // Def is the address writeback.
3154     return ItinData->getOperandCycle(DefClass, DefIdx);
3155
3156   int DefCycle;
3157   if (Subtarget.isCortexA8() || Subtarget.isCortexA7()) {
3158     // (regno / 2) + (regno % 2) + 1
3159     DefCycle = RegNo / 2 + 1;
3160     if (RegNo % 2)
3161       ++DefCycle;
3162   } else if (Subtarget.isLikeA9() || Subtarget.isSwift()) {
3163     DefCycle = RegNo;
3164     bool isSLoad = false;
3165
3166     switch (DefMCID.getOpcode()) {
3167     default: break;
3168     case ARM::VLDMSIA:
3169     case ARM::VLDMSIA_UPD:
3170     case ARM::VLDMSDB_UPD:
3171       isSLoad = true;
3172       break;
3173     }
3174
3175     // If there are odd number of 'S' registers or if it's not 64-bit aligned,
3176     // then it takes an extra cycle.
3177     if ((isSLoad && (RegNo % 2)) || DefAlign < 8)
3178       ++DefCycle;
3179   } else {
3180     // Assume the worst.
3181     DefCycle = RegNo + 2;
3182   }
3183
3184   return DefCycle;
3185 }
3186
3187 int
3188 ARMBaseInstrInfo::getLDMDefCycle(const InstrItineraryData *ItinData,
3189                                  const MCInstrDesc &DefMCID,
3190                                  unsigned DefClass,
3191                                  unsigned DefIdx, unsigned DefAlign) const {
3192   int RegNo = (int)(DefIdx+1) - DefMCID.getNumOperands() + 1;
3193   if (RegNo <= 0)
3194     // Def is the address writeback.
3195     return ItinData->getOperandCycle(DefClass, DefIdx);
3196
3197   int DefCycle;
3198   if (Subtarget.isCortexA8() || Subtarget.isCortexA7()) {
3199     // 4 registers would be issued: 1, 2, 1.
3200     // 5 registers would be issued: 1, 2, 2.
3201     DefCycle = RegNo / 2;
3202     if (DefCycle < 1)
3203       DefCycle = 1;
3204     // Result latency is issue cycle + 2: E2.
3205     DefCycle += 2;
3206   } else if (Subtarget.isLikeA9() || Subtarget.isSwift()) {
3207     DefCycle = (RegNo / 2);
3208     // If there are odd number of registers or if it's not 64-bit aligned,
3209     // then it takes an extra AGU (Address Generation Unit) cycle.
3210     if ((RegNo % 2) || DefAlign < 8)
3211       ++DefCycle;
3212     // Result latency is AGU cycles + 2.
3213     DefCycle += 2;
3214   } else {
3215     // Assume the worst.
3216     DefCycle = RegNo + 2;
3217   }
3218
3219   return DefCycle;
3220 }
3221
3222 int
3223 ARMBaseInstrInfo::getVSTMUseCycle(const InstrItineraryData *ItinData,
3224                                   const MCInstrDesc &UseMCID,
3225                                   unsigned UseClass,
3226                                   unsigned UseIdx, unsigned UseAlign) const {
3227   int RegNo = (int)(UseIdx+1) - UseMCID.getNumOperands() + 1;
3228   if (RegNo <= 0)
3229     return ItinData->getOperandCycle(UseClass, UseIdx);
3230
3231   int UseCycle;
3232   if (Subtarget.isCortexA8() || Subtarget.isCortexA7()) {
3233     // (regno / 2) + (regno % 2) + 1
3234     UseCycle = RegNo / 2 + 1;
3235     if (RegNo % 2)
3236       ++UseCycle;
3237   } else if (Subtarget.isLikeA9() || Subtarget.isSwift()) {
3238     UseCycle = RegNo;
3239     bool isSStore = false;
3240
3241     switch (UseMCID.getOpcode()) {
3242     default: break;
3243     case ARM::VSTMSIA:
3244     case ARM::VSTMSIA_UPD:
3245     case ARM::VSTMSDB_UPD:
3246       isSStore = true;
3247       break;
3248     }
3249
3250     // If there are odd number of 'S' registers or if it's not 64-bit aligned,
3251     // then it takes an extra cycle.
3252     if ((isSStore && (RegNo % 2)) || UseAlign < 8)
3253       ++UseCycle;
3254   } else {
3255     // Assume the worst.
3256     UseCycle = RegNo + 2;
3257   }
3258
3259   return UseCycle;
3260 }
3261
3262 int
3263 ARMBaseInstrInfo::getSTMUseCycle(const InstrItineraryData *ItinData,
3264                                  const MCInstrDesc &UseMCID,
3265                                  unsigned UseClass,
3266                                  unsigned UseIdx, unsigned UseAlign) const {
3267   int RegNo = (int)(UseIdx+1) - UseMCID.getNumOperands() + 1;
3268   if (RegNo <= 0)
3269     return ItinData->getOperandCycle(UseClass, UseIdx);
3270
3271   int UseCycle;
3272   if (Subtarget.isCortexA8() || Subtarget.isCortexA7()) {
3273     UseCycle = RegNo / 2;
3274     if (UseCycle < 2)
3275       UseCycle = 2;
3276     // Read in E3.
3277     UseCycle += 2;
3278   } else if (Subtarget.isLikeA9() || Subtarget.isSwift()) {
3279     UseCycle = (RegNo / 2);
3280     // If there are odd number of registers or if it's not 64-bit aligned,
3281     // then it takes an extra AGU (Address Generation Unit) cycle.
3282     if ((RegNo % 2) || UseAlign < 8)
3283       ++UseCycle;
3284   } else {
3285     // Assume the worst.
3286     UseCycle = 1;
3287   }
3288   return UseCycle;
3289 }
3290
3291 int
3292 ARMBaseInstrInfo::getOperandLatency(const InstrItineraryData *ItinData,
3293                                     const MCInstrDesc &DefMCID,
3294                                     unsigned DefIdx, unsigned DefAlign,
3295                                     const MCInstrDesc &UseMCID,
3296                                     unsigned UseIdx, unsigned UseAlign) const {
3297   unsigned DefClass = DefMCID.getSchedClass();
3298   unsigned UseClass = UseMCID.getSchedClass();
3299
3300   if (DefIdx < DefMCID.getNumDefs() && UseIdx < UseMCID.getNumOperands())
3301     return ItinData->getOperandLatency(DefClass, DefIdx, UseClass, UseIdx);
3302
3303   // This may be a def / use of a variable_ops instruction, the operand
3304   // latency might be determinable dynamically. Let the target try to
3305   // figure it out.
3306   int DefCycle = -1;
3307   bool LdmBypass = false;
3308   switch (DefMCID.getOpcode()) {
3309   default:
3310     DefCycle = ItinData->getOperandCycle(DefClass, DefIdx);
3311     break;
3312
3313   case ARM::VLDMDIA:
3314   case ARM::VLDMDIA_UPD:
3315   case ARM::VLDMDDB_UPD:
3316   case ARM::VLDMSIA:
3317   case ARM::VLDMSIA_UPD:
3318   case ARM::VLDMSDB_UPD:
3319     DefCycle = getVLDMDefCycle(ItinData, DefMCID, DefClass, DefIdx, DefAlign);
3320     break;
3321
3322   case ARM::LDMIA_RET:
3323   case ARM::LDMIA:
3324   case ARM::LDMDA:
3325   case ARM::LDMDB:
3326   case ARM::LDMIB:
3327   case ARM::LDMIA_UPD:
3328   case ARM::LDMDA_UPD:
3329   case ARM::LDMDB_UPD:
3330   case ARM::LDMIB_UPD:
3331   case ARM::tLDMIA:
3332   case ARM::tLDMIA_UPD:
3333   case ARM::tPUSH:
3334   case ARM::t2LDMIA_RET:
3335   case ARM::t2LDMIA:
3336   case ARM::t2LDMDB:
3337   case ARM::t2LDMIA_UPD:
3338   case ARM::t2LDMDB_UPD:
3339     LdmBypass = 1;
3340     DefCycle = getLDMDefCycle(ItinData, DefMCID, DefClass, DefIdx, DefAlign);
3341     break;
3342   }
3343
3344   if (DefCycle == -1)
3345     // We can't seem to determine the result latency of the def, assume it's 2.
3346     DefCycle = 2;
3347
3348   int UseCycle = -1;
3349   switch (UseMCID.getOpcode()) {
3350   default:
3351     UseCycle = ItinData->getOperandCycle(UseClass, UseIdx);
3352     break;
3353
3354   case ARM::VSTMDIA:
3355   case ARM::VSTMDIA_UPD:
3356   case ARM::VSTMDDB_UPD:
3357   case ARM::VSTMSIA:
3358   case ARM::VSTMSIA_UPD:
3359   case ARM::VSTMSDB_UPD:
3360     UseCycle = getVSTMUseCycle(ItinData, UseMCID, UseClass, UseIdx, UseAlign);
3361     break;
3362
3363   case ARM::STMIA:
3364   case ARM::STMDA:
3365   case ARM::STMDB:
3366   case ARM::STMIB:
3367   case ARM::STMIA_UPD:
3368   case ARM::STMDA_UPD:
3369   case ARM::STMDB_UPD:
3370   case ARM::STMIB_UPD:
3371   case ARM::tSTMIA_UPD:
3372   case ARM::tPOP_RET:
3373   case ARM::tPOP:
3374   case ARM::t2STMIA:
3375   case ARM::t2STMDB:
3376   case ARM::t2STMIA_UPD:
3377   case ARM::t2STMDB_UPD:
3378     UseCycle = getSTMUseCycle(ItinData, UseMCID, UseClass, UseIdx, UseAlign);
3379     break;
3380   }
3381
3382   if (UseCycle == -1)
3383     // Assume it's read in the first stage.
3384     UseCycle = 1;
3385
3386   UseCycle = DefCycle - UseCycle + 1;
3387   if (UseCycle > 0) {
3388     if (LdmBypass) {
3389       // It's a variable_ops instruction so we can't use DefIdx here. Just use
3390       // first def operand.
3391       if (ItinData->hasPipelineForwarding(DefClass, DefMCID.getNumOperands()-1,
3392                                           UseClass, UseIdx))
3393         --UseCycle;
3394     } else if (ItinData->hasPipelineForwarding(DefClass, DefIdx,
3395                                                UseClass, UseIdx)) {
3396       --UseCycle;
3397     }
3398   }
3399
3400   return UseCycle;
3401 }
3402
3403 static const MachineInstr *getBundledDefMI(const TargetRegisterInfo *TRI,
3404                                            const MachineInstr *MI, unsigned Reg,
3405                                            unsigned &DefIdx, unsigned &Dist) {
3406   Dist = 0;
3407
3408   MachineBasicBlock::const_iterator I = MI; ++I;
3409   MachineBasicBlock::const_instr_iterator II = std::prev(I.getInstrIterator());
3410   assert(II->isInsideBundle() && "Empty bundle?");
3411
3412   int Idx = -1;
3413   while (II->isInsideBundle()) {
3414     Idx = II->findRegisterDefOperandIdx(Reg, false, true, TRI);
3415     if (Idx != -1)
3416       break;
3417     --II;
3418     ++Dist;
3419   }
3420
3421   assert(Idx != -1 && "Cannot find bundled definition!");
3422   DefIdx = Idx;
3423   return II;
3424 }
3425
3426 static const MachineInstr *getBundledUseMI(const TargetRegisterInfo *TRI,
3427                                            const MachineInstr *MI, unsigned Reg,
3428                                            unsigned &UseIdx, unsigned &Dist) {
3429   Dist = 0;
3430
3431   MachineBasicBlock::const_instr_iterator II = MI; ++II;
3432   assert(II->isInsideBundle() && "Empty bundle?");
3433   MachineBasicBlock::const_instr_iterator E = MI->getParent()->instr_end();
3434
3435   // FIXME: This doesn't properly handle multiple uses.
3436   int Idx = -1;
3437   while (II != E && II->isInsideBundle()) {
3438     Idx = II->findRegisterUseOperandIdx(Reg, false, TRI);
3439     if (Idx != -1)
3440       break;
3441     if (II->getOpcode() != ARM::t2IT)
3442       ++Dist;
3443     ++II;
3444   }
3445
3446   if (Idx == -1) {
3447     Dist = 0;
3448     return nullptr;
3449   }
3450
3451   UseIdx = Idx;
3452   return II;
3453 }
3454
3455 /// Return the number of cycles to add to (or subtract from) the static
3456 /// itinerary based on the def opcode and alignment. The caller will ensure that
3457 /// adjusted latency is at least one cycle.
3458 static int adjustDefLatency(const ARMSubtarget &Subtarget,
3459                             const MachineInstr *DefMI,
3460                             const MCInstrDesc *DefMCID, unsigned DefAlign) {
3461   int Adjust = 0;
3462   if (Subtarget.isCortexA8() || Subtarget.isLikeA9() || Subtarget.isCortexA7()) {
3463     // FIXME: Shifter op hack: no shift (i.e. [r +/- r]) or [r + r << 2]
3464     // variants are one cycle cheaper.
3465     switch (DefMCID->getOpcode()) {
3466     default: break;
3467     case ARM::LDRrs:
3468     case ARM::LDRBrs: {
3469       unsigned ShOpVal = DefMI->getOperand(3).getImm();
3470       unsigned ShImm = ARM_AM::getAM2Offset(ShOpVal);
3471       if (ShImm == 0 ||
3472           (ShImm == 2 && ARM_AM::getAM2ShiftOpc(ShOpVal) == ARM_AM::lsl))
3473         --Adjust;
3474       break;
3475     }
3476     case ARM::t2LDRs:
3477     case ARM::t2LDRBs:
3478     case ARM::t2LDRHs:
3479     case ARM::t2LDRSHs: {
3480       // Thumb2 mode: lsl only.
3481       unsigned ShAmt = DefMI->getOperand(3).getImm();
3482       if (ShAmt == 0 || ShAmt == 2)
3483         --Adjust;
3484       break;
3485     }
3486     }
3487   } else if (Subtarget.isSwift()) {
3488     // FIXME: Properly handle all of the latency adjustments for address
3489     // writeback.
3490     switch (DefMCID->getOpcode()) {
3491     default: break;
3492     case ARM::LDRrs:
3493     case ARM::LDRBrs: {
3494       unsigned ShOpVal = DefMI->getOperand(3).getImm();
3495       bool isSub = ARM_AM::getAM2Op(ShOpVal) == ARM_AM::sub;
3496       unsigned ShImm = ARM_AM::getAM2Offset(ShOpVal);
3497       if (!isSub &&
3498           (ShImm == 0 ||
3499            ((ShImm == 1 || ShImm == 2 || ShImm == 3) &&
3500             ARM_AM::getAM2ShiftOpc(ShOpVal) == ARM_AM::lsl)))
3501         Adjust -= 2;
3502       else if (!isSub &&
3503                ShImm == 1 && ARM_AM::getAM2ShiftOpc(ShOpVal) == ARM_AM::lsr)
3504         --Adjust;
3505       break;
3506     }
3507     case ARM::t2LDRs:
3508     case ARM::t2LDRBs:
3509     case ARM::t2LDRHs:
3510     case ARM::t2LDRSHs: {
3511       // Thumb2 mode: lsl only.
3512       unsigned ShAmt = DefMI->getOperand(3).getImm();
3513       if (ShAmt == 0 || ShAmt == 1 || ShAmt == 2 || ShAmt == 3)
3514         Adjust -= 2;
3515       break;
3516     }
3517     }
3518   }
3519
3520   if (DefAlign < 8 && Subtarget.isLikeA9()) {
3521     switch (DefMCID->getOpcode()) {
3522     default: break;
3523     case ARM::VLD1q8:
3524     case ARM::VLD1q16:
3525     case ARM::VLD1q32:
3526     case ARM::VLD1q64:
3527     case ARM::VLD1q8wb_fixed:
3528     case ARM::VLD1q16wb_fixed:
3529     case ARM::VLD1q32wb_fixed:
3530     case ARM::VLD1q64wb_fixed:
3531     case ARM::VLD1q8wb_register:
3532     case ARM::VLD1q16wb_register:
3533     case ARM::VLD1q32wb_register:
3534     case ARM::VLD1q64wb_register:
3535     case ARM::VLD2d8:
3536     case ARM::VLD2d16:
3537     case ARM::VLD2d32:
3538     case ARM::VLD2q8:
3539     case ARM::VLD2q16:
3540     case ARM::VLD2q32:
3541     case ARM::VLD2d8wb_fixed:
3542     case ARM::VLD2d16wb_fixed:
3543     case ARM::VLD2d32wb_fixed:
3544     case ARM::VLD2q8wb_fixed:
3545     case ARM::VLD2q16wb_fixed:
3546     case ARM::VLD2q32wb_fixed:
3547     case ARM::VLD2d8wb_register:
3548     case ARM::VLD2d16wb_register:
3549     case ARM::VLD2d32wb_register:
3550     case ARM::VLD2q8wb_register:
3551     case ARM::VLD2q16wb_register:
3552     case ARM::VLD2q32wb_register:
3553     case ARM::VLD3d8:
3554     case ARM::VLD3d16:
3555     case ARM::VLD3d32:
3556     case ARM::VLD1d64T:
3557     case ARM::VLD3d8_UPD:
3558     case ARM::VLD3d16_UPD:
3559     case ARM::VLD3d32_UPD:
3560     case ARM::VLD1d64Twb_fixed:
3561     case ARM::VLD1d64Twb_register:
3562     case ARM::VLD3q8_UPD:
3563     case ARM::VLD3q16_UPD:
3564     case ARM::VLD3q32_UPD:
3565     case ARM::VLD4d8:
3566     case ARM::VLD4d16:
3567     case ARM::VLD4d32:
3568     case ARM::VLD1d64Q:
3569     case ARM::VLD4d8_UPD:
3570     case ARM::VLD4d16_UPD:
3571     case ARM::VLD4d32_UPD:
3572     case ARM::VLD1d64Qwb_fixed:
3573     case ARM::VLD1d64Qwb_register:
3574     case ARM::VLD4q8_UPD:
3575     case ARM::VLD4q16_UPD:
3576     case ARM::VLD4q32_UPD:
3577     case ARM::VLD1DUPq8:
3578     case ARM::VLD1DUPq16:
3579     case ARM::VLD1DUPq32:
3580     case ARM::VLD1DUPq8wb_fixed:
3581     case ARM::VLD1DUPq16wb_fixed:
3582     case ARM::VLD1DUPq32wb_fixed:
3583     case ARM::VLD1DUPq8wb_register:
3584     case ARM::VLD1DUPq16wb_register:
3585     case ARM::VLD1DUPq32wb_register:
3586     case ARM::VLD2DUPd8:
3587     case ARM::VLD2DUPd16:
3588     case ARM::VLD2DUPd32:
3589     case ARM::VLD2DUPd8wb_fixed:
3590     case ARM::VLD2DUPd16wb_fixed:
3591     case ARM::VLD2DUPd32wb_fixed:
3592     case ARM::VLD2DUPd8wb_register:
3593     case ARM::VLD2DUPd16wb_register:
3594     case ARM::VLD2DUPd32wb_register:
3595     case ARM::VLD4DUPd8:
3596     case ARM::VLD4DUPd16:
3597     case ARM::VLD4DUPd32:
3598     case ARM::VLD4DUPd8_UPD:
3599     case ARM::VLD4DUPd16_UPD:
3600     case ARM::VLD4DUPd32_UPD:
3601     case ARM::VLD1LNd8:
3602     case ARM::VLD1LNd16:
3603     case ARM::VLD1LNd32:
3604     case ARM::VLD1LNd8_UPD:
3605     case ARM::VLD1LNd16_UPD:
3606     case ARM::VLD1LNd32_UPD:
3607     case ARM::VLD2LNd8:
3608     case ARM::VLD2LNd16:
3609     case ARM::VLD2LNd32:
3610     case ARM::VLD2LNq16:
3611     case ARM::VLD2LNq32:
3612     case ARM::VLD2LNd8_UPD:
3613     case ARM::VLD2LNd16_UPD:
3614     case ARM::VLD2LNd32_UPD:
3615     case ARM::VLD2LNq16_UPD:
3616     case ARM::VLD2LNq32_UPD:
3617     case ARM::VLD4LNd8:
3618     case ARM::VLD4LNd16:
3619     case ARM::VLD4LNd32:
3620     case ARM::VLD4LNq16:
3621     case ARM::VLD4LNq32:
3622     case ARM::VLD4LNd8_UPD:
3623     case ARM::VLD4LNd16_UPD:
3624     case ARM::VLD4LNd32_UPD:
3625     case ARM::VLD4LNq16_UPD:
3626     case ARM::VLD4LNq32_UPD:
3627       // If the address is not 64-bit aligned, the latencies of these
3628       // instructions increases by one.
3629       ++Adjust;
3630       break;
3631     }
3632   }
3633   return Adjust;
3634 }
3635
3636
3637
3638 int
3639 ARMBaseInstrInfo::getOperandLatency(const InstrItineraryData *ItinData,
3640                                     const MachineInstr *DefMI, unsigned DefIdx,
3641                                     const MachineInstr *UseMI,
3642                                     unsigned UseIdx) const {
3643   // No operand latency. The caller may fall back to getInstrLatency.
3644   if (!ItinData || ItinData->isEmpty())
3645     return -1;
3646
3647   const MachineOperand &DefMO = DefMI->getOperand(DefIdx);
3648   unsigned Reg = DefMO.getReg();
3649   const MCInstrDesc *DefMCID = &DefMI->getDesc();
3650   const MCInstrDesc *UseMCID = &UseMI->getDesc();
3651
3652   unsigned DefAdj = 0;
3653   if (DefMI->isBundle()) {
3654     DefMI = getBundledDefMI(&getRegisterInfo(), DefMI, Reg, DefIdx, DefAdj);
3655     DefMCID = &DefMI->getDesc();
3656   }
3657   if (DefMI->isCopyLike() || DefMI->isInsertSubreg() ||
3658       DefMI->isRegSequence() || DefMI->isImplicitDef()) {
3659     return 1;
3660   }
3661
3662   unsigned UseAdj = 0;
3663   if (UseMI->isBundle()) {
3664     unsigned NewUseIdx;
3665     const MachineInstr *NewUseMI = getBundledUseMI(&getRegisterInfo(), UseMI,
3666                                                    Reg, NewUseIdx, UseAdj);
3667     if (!NewUseMI)
3668       return -1;
3669
3670     UseMI = NewUseMI;
3671     UseIdx = NewUseIdx;
3672     UseMCID = &UseMI->getDesc();
3673   }
3674
3675   if (Reg == ARM::CPSR) {
3676     if (DefMI->getOpcode() == ARM::FMSTAT) {
3677       // fpscr -> cpsr stalls over 20 cycles on A8 (and earlier?)
3678       return Subtarget.isLikeA9() ? 1 : 20;
3679     }
3680
3681     // CPSR set and branch can be paired in the same cycle.
3682     if (UseMI->isBranch())
3683       return 0;
3684
3685     // Otherwise it takes the instruction latency (generally one).
3686     unsigned Latency = getInstrLatency(ItinData, DefMI);
3687
3688     // For Thumb2 and -Os, prefer scheduling CPSR setting instruction close to
3689     // its uses. Instructions which are otherwise scheduled between them may
3690     // incur a code size penalty (not able to use the CPSR setting 16-bit
3691     // instructions).
3692     if (Latency > 0 && Subtarget.isThumb2()) {
3693       const MachineFunction *MF = DefMI->getParent()->getParent();
3694       if (MF->getFunction()->hasFnAttribute(Attribute::OptimizeForSize))
3695         --Latency;
3696     }
3697     return Latency;
3698   }
3699
3700   if (DefMO.isImplicit() || UseMI->getOperand(UseIdx).isImplicit())
3701     return -1;
3702
3703   unsigned DefAlign = DefMI->hasOneMemOperand()
3704     ? (*DefMI->memoperands_begin())->getAlignment() : 0;
3705   unsigned UseAlign = UseMI->hasOneMemOperand()
3706     ? (*UseMI->memoperands_begin())->getAlignment() : 0;
3707
3708   // Get the itinerary's latency if possible, and handle variable_ops.
3709   int Latency = getOperandLatency(ItinData, *DefMCID, DefIdx, DefAlign,
3710                                   *UseMCID, UseIdx, UseAlign);
3711   // Unable to find operand latency. The caller may resort to getInstrLatency.
3712   if (Latency < 0)
3713     return Latency;
3714
3715   // Adjust for IT block position.
3716   int Adj = DefAdj + UseAdj;
3717
3718   // Adjust for dynamic def-side opcode variants not captured by the itinerary.
3719   Adj += adjustDefLatency(Subtarget, DefMI, DefMCID, DefAlign);
3720   if (Adj >= 0 || (int)Latency > -Adj) {
3721     return Latency + Adj;
3722   }
3723   // Return the itinerary latency, which may be zero but not less than zero.
3724   return Latency;
3725 }
3726
3727 int
3728 ARMBaseInstrInfo::getOperandLatency(const InstrItineraryData *ItinData,
3729                                     SDNode *DefNode, unsigned DefIdx,
3730                                     SDNode *UseNode, unsigned UseIdx) const {
3731   if (!DefNode->isMachineOpcode())
3732     return 1;
3733
3734   const MCInstrDesc &DefMCID = get(DefNode->getMachineOpcode());
3735
3736   if (isZeroCost(DefMCID.Opcode))
3737     return 0;
3738
3739   if (!ItinData || ItinData->isEmpty())
3740     return DefMCID.mayLoad() ? 3 : 1;
3741
3742   if (!UseNode->isMachineOpcode()) {
3743     int Latency = ItinData->getOperandCycle(DefMCID.getSchedClass(), DefIdx);
3744     if (Subtarget.isLikeA9() || Subtarget.isSwift())
3745       return Latency <= 2 ? 1 : Latency - 1;
3746     else
3747       return Latency <= 3 ? 1 : Latency - 2;
3748   }
3749
3750   const MCInstrDesc &UseMCID = get(UseNode->getMachineOpcode());
3751   const MachineSDNode *DefMN = dyn_cast<MachineSDNode>(DefNode);
3752   unsigned DefAlign = !DefMN->memoperands_empty()
3753     ? (*DefMN->memoperands_begin())->getAlignment() : 0;
3754   const MachineSDNode *UseMN = dyn_cast<MachineSDNode>(UseNode);
3755   unsigned UseAlign = !UseMN->memoperands_empty()
3756     ? (*UseMN->memoperands_begin())->getAlignment() : 0;
3757   int Latency = getOperandLatency(ItinData, DefMCID, DefIdx, DefAlign,
3758                                   UseMCID, UseIdx, UseAlign);
3759
3760   if (Latency > 1 &&
3761       (Subtarget.isCortexA8() || Subtarget.isLikeA9() ||
3762        Subtarget.isCortexA7())) {
3763     // FIXME: Shifter op hack: no shift (i.e. [r +/- r]) or [r + r << 2]
3764     // variants are one cycle cheaper.
3765     switch (DefMCID.getOpcode()) {
3766     default: break;
3767     case ARM::LDRrs:
3768     case ARM::LDRBrs: {
3769       unsigned ShOpVal =
3770         cast<ConstantSDNode>(DefNode->getOperand(2))->getZExtValue();
3771       unsigned ShImm = ARM_AM::getAM2Offset(ShOpVal);
3772       if (ShImm == 0 ||
3773           (ShImm == 2 && ARM_AM::getAM2ShiftOpc(ShOpVal) == ARM_AM::lsl))
3774         --Latency;
3775       break;
3776     }
3777     case ARM::t2LDRs:
3778     case ARM::t2LDRBs:
3779     case ARM::t2LDRHs:
3780     case ARM::t2LDRSHs: {
3781       // Thumb2 mode: lsl only.
3782       unsigned ShAmt =
3783         cast<ConstantSDNode>(DefNode->getOperand(2))->getZExtValue();
3784       if (ShAmt == 0 || ShAmt == 2)
3785         --Latency;
3786       break;
3787     }
3788     }
3789   } else if (DefIdx == 0 && Latency > 2 && Subtarget.isSwift()) {
3790     // FIXME: Properly handle all of the latency adjustments for address
3791     // writeback.
3792     switch (DefMCID.getOpcode()) {
3793     default: break;
3794     case ARM::LDRrs:
3795     case ARM::LDRBrs: {
3796       unsigned ShOpVal =
3797         cast<ConstantSDNode>(DefNode->getOperand(2))->getZExtValue();
3798       unsigned ShImm = ARM_AM::getAM2Offset(ShOpVal);
3799       if (ShImm == 0 ||
3800           ((ShImm == 1 || ShImm == 2 || ShImm == 3) &&
3801            ARM_AM::getAM2ShiftOpc(ShOpVal) == ARM_AM::lsl))
3802         Latency -= 2;
3803       else if (ShImm == 1 && ARM_AM::getAM2ShiftOpc(ShOpVal) == ARM_AM::lsr)
3804         --Latency;
3805       break;
3806     }
3807     case ARM::t2LDRs:
3808     case ARM::t2LDRBs:
3809     case ARM::t2LDRHs:
3810     case ARM::t2LDRSHs: {
3811       // Thumb2 mode: lsl 0-3 only.
3812       Latency -= 2;
3813       break;
3814     }
3815     }
3816   }
3817
3818   if (DefAlign < 8 && Subtarget.isLikeA9())
3819     switch (DefMCID.getOpcode()) {
3820     default: break;
3821     case ARM::VLD1q8:
3822     case ARM::VLD1q16:
3823     case ARM::VLD1q32:
3824     case ARM::VLD1q64:
3825     case ARM::VLD1q8wb_register:
3826     case ARM::VLD1q16wb_register:
3827     case ARM::VLD1q32wb_register:
3828     case ARM::VLD1q64wb_register:
3829     case ARM::VLD1q8wb_fixed:
3830     case ARM::VLD1q16wb_fixed:
3831     case ARM::VLD1q32wb_fixed:
3832     case ARM::VLD1q64wb_fixed:
3833     case ARM::VLD2d8:
3834     case ARM::VLD2d16:
3835     case ARM::VLD2d32:
3836     case ARM::VLD2q8Pseudo:
3837     case ARM::VLD2q16Pseudo:
3838     case ARM::VLD2q32Pseudo:
3839     case ARM::VLD2d8wb_fixed:
3840     case ARM::VLD2d16wb_fixed:
3841     case ARM::VLD2d32wb_fixed:
3842     case ARM::VLD2q8PseudoWB_fixed:
3843     case ARM::VLD2q16PseudoWB_fixed:
3844     case ARM::VLD2q32PseudoWB_fixed:
3845     case ARM::VLD2d8wb_register:
3846     case ARM::VLD2d16wb_register:
3847     case ARM::VLD2d32wb_register:
3848     case ARM::VLD2q8PseudoWB_register:
3849     case ARM::VLD2q16PseudoWB_register:
3850     case ARM::VLD2q32PseudoWB_register:
3851     case ARM::VLD3d8Pseudo:
3852     case ARM::VLD3d16Pseudo:
3853     case ARM::VLD3d32Pseudo:
3854     case ARM::VLD1d64TPseudo:
3855     case ARM::VLD1d64TPseudoWB_fixed:
3856     case ARM::VLD3d8Pseudo_UPD:
3857     case ARM::VLD3d16Pseudo_UPD:
3858     case ARM::VLD3d32Pseudo_UPD:
3859     case ARM::VLD3q8Pseudo_UPD:
3860     case ARM::VLD3q16Pseudo_UPD:
3861     case ARM::VLD3q32Pseudo_UPD:
3862     case ARM::VLD3q8oddPseudo:
3863     case ARM::VLD3q16oddPseudo:
3864     case ARM::VLD3q32oddPseudo:
3865     case ARM::VLD3q8oddPseudo_UPD:
3866     case ARM::VLD3q16oddPseudo_UPD:
3867     case ARM::VLD3q32oddPseudo_UPD:
3868     case ARM::VLD4d8Pseudo:
3869     case ARM::VLD4d16Pseudo:
3870     case ARM::VLD4d32Pseudo:
3871     case ARM::VLD1d64QPseudo:
3872     case ARM::VLD1d64QPseudoWB_fixed:
3873     case ARM::VLD4d8Pseudo_UPD:
3874     case ARM::VLD4d16Pseudo_UPD:
3875     case ARM::VLD4d32Pseudo_UPD:
3876     case ARM::VLD4q8Pseudo_UPD:
3877     case ARM::VLD4q16Pseudo_UPD:
3878     case ARM::VLD4q32Pseudo_UPD:
3879     case ARM::VLD4q8oddPseudo:
3880     case ARM::VLD4q16oddPseudo:
3881     case ARM::VLD4q32oddPseudo:
3882     case ARM::VLD4q8oddPseudo_UPD:
3883     case ARM::VLD4q16oddPseudo_UPD:
3884     case ARM::VLD4q32oddPseudo_UPD:
3885     case ARM::VLD1DUPq8:
3886     case ARM::VLD1DUPq16:
3887     case ARM::VLD1DUPq32:
3888     case ARM::VLD1DUPq8wb_fixed:
3889     case ARM::VLD1DUPq16wb_fixed:
3890     case ARM::VLD1DUPq32wb_fixed:
3891     case ARM::VLD1DUPq8wb_register:
3892     case ARM::VLD1DUPq16wb_register:
3893     case ARM::VLD1DUPq32wb_register:
3894     case ARM::VLD2DUPd8:
3895     case ARM::VLD2DUPd16:
3896     case ARM::VLD2DUPd32:
3897     case ARM::VLD2DUPd8wb_fixed:
3898     case ARM::VLD2DUPd16wb_fixed:
3899     case ARM::VLD2DUPd32wb_fixed:
3900     case ARM::VLD2DUPd8wb_register:
3901     case ARM::VLD2DUPd16wb_register:
3902     case ARM::VLD2DUPd32wb_register:
3903     case ARM::VLD4DUPd8Pseudo:
3904     case ARM::VLD4DUPd16Pseudo:
3905     case ARM::VLD4DUPd32Pseudo:
3906     case ARM::VLD4DUPd8Pseudo_UPD:
3907     case ARM::VLD4DUPd16Pseudo_UPD:
3908     case ARM::VLD4DUPd32Pseudo_UPD:
3909     case ARM::VLD1LNq8Pseudo:
3910     case ARM::VLD1LNq16Pseudo:
3911     case ARM::VLD1LNq32Pseudo:
3912     case ARM::VLD1LNq8Pseudo_UPD:
3913     case ARM::VLD1LNq16Pseudo_UPD:
3914     case ARM::VLD1LNq32Pseudo_UPD:
3915     case ARM::VLD2LNd8Pseudo:
3916     case ARM::VLD2LNd16Pseudo:
3917     case ARM::VLD2LNd32Pseudo:
3918     case ARM::VLD2LNq16Pseudo:
3919     case ARM::VLD2LNq32Pseudo:
3920     case ARM::VLD2LNd8Pseudo_UPD:
3921     case ARM::VLD2LNd16Pseudo_UPD:
3922     case ARM::VLD2LNd32Pseudo_UPD:
3923     case ARM::VLD2LNq16Pseudo_UPD:
3924     case ARM::VLD2LNq32Pseudo_UPD:
3925     case ARM::VLD4LNd8Pseudo:
3926     case ARM::VLD4LNd16Pseudo:
3927     case ARM::VLD4LNd32Pseudo:
3928     case ARM::VLD4LNq16Pseudo:
3929     case ARM::VLD4LNq32Pseudo:
3930     case ARM::VLD4LNd8Pseudo_UPD:
3931     case ARM::VLD4LNd16Pseudo_UPD:
3932     case ARM::VLD4LNd32Pseudo_UPD:
3933     case ARM::VLD4LNq16Pseudo_UPD:
3934     case ARM::VLD4LNq32Pseudo_UPD:
3935       // If the address is not 64-bit aligned, the latencies of these
3936       // instructions increases by one.
3937       ++Latency;
3938       break;
3939     }
3940
3941   return Latency;
3942 }
3943
3944 unsigned ARMBaseInstrInfo::getPredicationCost(const MachineInstr *MI) const {
3945    if (MI->isCopyLike() || MI->isInsertSubreg() ||
3946       MI->isRegSequence() || MI->isImplicitDef())
3947     return 0;
3948
3949   if (MI->isBundle())
3950     return 0;
3951
3952   const MCInstrDesc &MCID = MI->getDesc();
3953
3954   if (MCID.isCall() || MCID.hasImplicitDefOfPhysReg(ARM::CPSR)) {
3955     // When predicated, CPSR is an additional source operand for CPSR updating
3956     // instructions, this apparently increases their latencies.
3957     return 1;
3958   }
3959   return 0;
3960 }
3961
3962 unsigned ARMBaseInstrInfo::getInstrLatency(const InstrItineraryData *ItinData,
3963                                            const MachineInstr *MI,
3964                                            unsigned *PredCost) const {
3965   if (MI->isCopyLike() || MI->isInsertSubreg() ||
3966       MI->isRegSequence() || MI->isImplicitDef())
3967     return 1;
3968
3969   // An instruction scheduler typically runs on unbundled instructions, however
3970   // other passes may query the latency of a bundled instruction.
3971   if (MI->isBundle()) {
3972     unsigned Latency = 0;
3973     MachineBasicBlock::const_instr_iterator I = MI;
3974     MachineBasicBlock::const_instr_iterator E = MI->getParent()->instr_end();
3975     while (++I != E && I->isInsideBundle()) {
3976       if (I->getOpcode() != ARM::t2IT)
3977         Latency += getInstrLatency(ItinData, I, PredCost);
3978     }
3979     return Latency;
3980   }
3981
3982   const MCInstrDesc &MCID = MI->getDesc();
3983   if (PredCost && (MCID.isCall() || MCID.hasImplicitDefOfPhysReg(ARM::CPSR))) {
3984     // When predicated, CPSR is an additional source operand for CPSR updating
3985     // instructions, this apparently increases their latencies.
3986     *PredCost = 1;
3987   }
3988   // Be sure to call getStageLatency for an empty itinerary in case it has a
3989   // valid MinLatency property.
3990   if (!ItinData)
3991     return MI->mayLoad() ? 3 : 1;
3992
3993   unsigned Class = MCID.getSchedClass();
3994
3995   // For instructions with variable uops, use uops as latency.
3996   if (!ItinData->isEmpty() && ItinData->getNumMicroOps(Class) < 0)
3997     return getNumMicroOps(ItinData, MI);
3998
3999   // For the common case, fall back on the itinerary's latency.
4000   unsigned Latency = ItinData->getStageLatency(Class);
4001
4002   // Adjust for dynamic def-side opcode variants not captured by the itinerary.
4003   unsigned DefAlign = MI->hasOneMemOperand()
4004     ? (*MI->memoperands_begin())->getAlignment() : 0;
4005   int Adj = adjustDefLatency(Subtarget, MI, &MCID, DefAlign);
4006   if (Adj >= 0 || (int)Latency > -Adj) {
4007     return Latency + Adj;
4008   }
4009   return Latency;
4010 }
4011
4012 int ARMBaseInstrInfo::getInstrLatency(const InstrItineraryData *ItinData,
4013                                       SDNode *Node) const {
4014   if (!Node->isMachineOpcode())
4015     return 1;
4016
4017   if (!ItinData || ItinData->isEmpty())
4018     return 1;
4019
4020   unsigned Opcode = Node->getMachineOpcode();
4021   switch (Opcode) {
4022   default:
4023     return ItinData->getStageLatency(get(Opcode).getSchedClass());
4024   case ARM::VLDMQIA:
4025   case ARM::VSTMQIA:
4026     return 2;
4027   }
4028 }
4029
4030 bool ARMBaseInstrInfo::
4031 hasHighOperandLatency(const InstrItineraryData *ItinData,
4032                       const MachineRegisterInfo *MRI,
4033                       const MachineInstr *DefMI, unsigned DefIdx,
4034                       const MachineInstr *UseMI, unsigned UseIdx) const {
4035   unsigned DDomain = DefMI->getDesc().TSFlags & ARMII::DomainMask;
4036   unsigned UDomain = UseMI->getDesc().TSFlags & ARMII::DomainMask;
4037   if (Subtarget.isCortexA8() &&
4038       (DDomain == ARMII::DomainVFP || UDomain == ARMII::DomainVFP))
4039     // CortexA8 VFP instructions are not pipelined.
4040     return true;
4041
4042   // Hoist VFP / NEON instructions with 4 or higher latency.
4043   int Latency = computeOperandLatency(ItinData, DefMI, DefIdx, UseMI, UseIdx);
4044   if (Latency < 0)
4045     Latency = getInstrLatency(ItinData, DefMI);
4046   if (Latency <= 3)
4047     return false;
4048   return DDomain == ARMII::DomainVFP || DDomain == ARMII::DomainNEON ||
4049          UDomain == ARMII::DomainVFP || UDomain == ARMII::DomainNEON;
4050 }
4051
4052 bool ARMBaseInstrInfo::
4053 hasLowDefLatency(const InstrItineraryData *ItinData,
4054                  const MachineInstr *DefMI, unsigned DefIdx) const {
4055   if (!ItinData || ItinData->isEmpty())
4056     return false;
4057
4058   unsigned DDomain = DefMI->getDesc().TSFlags & ARMII::DomainMask;
4059   if (DDomain == ARMII::DomainGeneral) {
4060     unsigned DefClass = DefMI->getDesc().getSchedClass();
4061     int DefCycle = ItinData->getOperandCycle(DefClass, DefIdx);
4062     return (DefCycle != -1 && DefCycle <= 2);
4063   }
4064   return false;
4065 }
4066
4067 bool ARMBaseInstrInfo::verifyInstruction(const MachineInstr *MI,
4068                                          StringRef &ErrInfo) const {
4069   if (convertAddSubFlagsOpcode(MI->getOpcode())) {
4070     ErrInfo = "Pseudo flag setting opcodes only exist in Selection DAG";
4071     return false;
4072   }
4073   return true;
4074 }
4075
4076 // LoadStackGuard has so far only been implemented for MachO. Different code
4077 // sequence is needed for other targets.
4078 void ARMBaseInstrInfo::expandLoadStackGuardBase(MachineBasicBlock::iterator MI,
4079                                                 unsigned LoadImmOpc,
4080                                                 unsigned LoadOpc,
4081                                                 Reloc::Model RM) const {
4082   MachineBasicBlock &MBB = *MI->getParent();
4083   DebugLoc DL = MI->getDebugLoc();
4084   unsigned Reg = MI->getOperand(0).getReg();
4085   const GlobalValue *GV =
4086       cast<GlobalValue>((*MI->memoperands_begin())->getValue());
4087   MachineInstrBuilder MIB;
4088
4089   BuildMI(MBB, MI, DL, get(LoadImmOpc), Reg)
4090       .addGlobalAddress(GV, 0, ARMII::MO_NONLAZY);
4091
4092   if (Subtarget.GVIsIndirectSymbol(GV, RM)) {
4093     MIB = BuildMI(MBB, MI, DL, get(LoadOpc), Reg);
4094     MIB.addReg(Reg, RegState::Kill).addImm(0);
4095     unsigned Flag = MachineMemOperand::MOLoad | MachineMemOperand::MOInvariant;
4096     MachineMemOperand *MMO = MBB.getParent()->
4097         getMachineMemOperand(MachinePointerInfo::getGOT(), Flag, 4, 4);
4098     MIB.addMemOperand(MMO);
4099     AddDefaultPred(MIB);
4100   }
4101
4102   MIB = BuildMI(MBB, MI, DL, get(LoadOpc), Reg);
4103   MIB.addReg(Reg, RegState::Kill).addImm(0);
4104   MIB.setMemRefs(MI->memoperands_begin(), MI->memoperands_end());
4105   AddDefaultPred(MIB);
4106 }
4107
4108 bool
4109 ARMBaseInstrInfo::isFpMLxInstruction(unsigned Opcode, unsigned &MulOpc,
4110                                      unsigned &AddSubOpc,
4111                                      bool &NegAcc, bool &HasLane) const {
4112   DenseMap<unsigned, unsigned>::const_iterator I = MLxEntryMap.find(Opcode);
4113   if (I == MLxEntryMap.end())
4114     return false;
4115
4116   const ARM_MLxEntry &Entry = ARM_MLxTable[I->second];
4117   MulOpc = Entry.MulOpc;
4118   AddSubOpc = Entry.AddSubOpc;
4119   NegAcc = Entry.NegAcc;
4120   HasLane = Entry.HasLane;
4121   return true;
4122 }
4123
4124 //===----------------------------------------------------------------------===//
4125 // Execution domains.
4126 //===----------------------------------------------------------------------===//
4127 //
4128 // Some instructions go down the NEON pipeline, some go down the VFP pipeline,
4129 // and some can go down both.  The vmov instructions go down the VFP pipeline,
4130 // but they can be changed to vorr equivalents that are executed by the NEON
4131 // pipeline.
4132 //
4133 // We use the following execution domain numbering:
4134 //
4135 enum ARMExeDomain {
4136   ExeGeneric = 0,
4137   ExeVFP = 1,
4138   ExeNEON = 2
4139 };
4140 //
4141 // Also see ARMInstrFormats.td and Domain* enums in ARMBaseInfo.h
4142 //
4143 std::pair<uint16_t, uint16_t>
4144 ARMBaseInstrInfo::getExecutionDomain(const MachineInstr *MI) const {
4145   // If we don't have access to NEON instructions then we won't be able
4146   // to swizzle anything to the NEON domain. Check to make sure.
4147   if (Subtarget.hasNEON()) {
4148     // VMOVD, VMOVRS and VMOVSR are VFP instructions, but can be changed to NEON
4149     // if they are not predicated.
4150     if (MI->getOpcode() == ARM::VMOVD && !isPredicated(MI))
4151       return std::make_pair(ExeVFP, (1 << ExeVFP) | (1 << ExeNEON));
4152
4153     // CortexA9 is particularly picky about mixing the two and wants these
4154     // converted.
4155     if (Subtarget.isCortexA9() && !isPredicated(MI) &&
4156         (MI->getOpcode() == ARM::VMOVRS || MI->getOpcode() == ARM::VMOVSR ||
4157          MI->getOpcode() == ARM::VMOVS))
4158       return std::make_pair(ExeVFP, (1 << ExeVFP) | (1 << ExeNEON));
4159   }
4160   // No other instructions can be swizzled, so just determine their domain.
4161   unsigned Domain = MI->getDesc().TSFlags & ARMII::DomainMask;
4162
4163   if (Domain & ARMII::DomainNEON)
4164     return std::make_pair(ExeNEON, 0);
4165
4166   // Certain instructions can go either way on Cortex-A8.
4167   // Treat them as NEON instructions.
4168   if ((Domain & ARMII::DomainNEONA8) && Subtarget.isCortexA8())
4169     return std::make_pair(ExeNEON, 0);
4170
4171   if (Domain & ARMII::DomainVFP)
4172     return std::make_pair(ExeVFP, 0);
4173
4174   return std::make_pair(ExeGeneric, 0);
4175 }
4176
4177 static unsigned getCorrespondingDRegAndLane(const TargetRegisterInfo *TRI,
4178                                             unsigned SReg, unsigned &Lane) {
4179   unsigned DReg = TRI->getMatchingSuperReg(SReg, ARM::ssub_0, &ARM::DPRRegClass);
4180   Lane = 0;
4181
4182   if (DReg != ARM::NoRegister)
4183    return DReg;
4184
4185   Lane = 1;
4186   DReg = TRI->getMatchingSuperReg(SReg, ARM::ssub_1, &ARM::DPRRegClass);
4187
4188   assert(DReg && "S-register with no D super-register?");
4189   return DReg;
4190 }
4191
4192 /// getImplicitSPRUseForDPRUse - Given a use of a DPR register and lane,
4193 /// set ImplicitSReg to a register number that must be marked as implicit-use or
4194 /// zero if no register needs to be defined as implicit-use.
4195 ///
4196 /// If the function cannot determine if an SPR should be marked implicit use or
4197 /// not, it returns false.
4198 ///
4199 /// This function handles cases where an instruction is being modified from taking
4200 /// an SPR to a DPR[Lane]. A use of the DPR is being added, which may conflict
4201 /// with an earlier def of an SPR corresponding to DPR[Lane^1] (i.e. the other
4202 /// lane of the DPR).
4203 ///
4204 /// If the other SPR is defined, an implicit-use of it should be added. Else,
4205 /// (including the case where the DPR itself is defined), it should not.
4206 ///
4207 static bool getImplicitSPRUseForDPRUse(const TargetRegisterInfo *TRI,
4208                                        MachineInstr *MI,
4209                                        unsigned DReg, unsigned Lane,
4210                                        unsigned &ImplicitSReg) {
4211   // If the DPR is defined or used already, the other SPR lane will be chained
4212   // correctly, so there is nothing to be done.
4213   if (MI->definesRegister(DReg, TRI) || MI->readsRegister(DReg, TRI)) {
4214     ImplicitSReg = 0;
4215     return true;
4216   }
4217
4218   // Otherwise we need to go searching to see if the SPR is set explicitly.
4219   ImplicitSReg = TRI->getSubReg(DReg,
4220                                 (Lane & 1) ? ARM::ssub_0 : ARM::ssub_1);
4221   MachineBasicBlock::LivenessQueryResult LQR =
4222     MI->getParent()->computeRegisterLiveness(TRI, ImplicitSReg, MI);
4223
4224   if (LQR == MachineBasicBlock::LQR_Live)
4225     return true;
4226   else if (LQR == MachineBasicBlock::LQR_Unknown)
4227     return false;
4228
4229   // If the register is known not to be live, there is no need to add an
4230   // implicit-use.
4231   ImplicitSReg = 0;
4232   return true;
4233 }
4234
4235 void
4236 ARMBaseInstrInfo::setExecutionDomain(MachineInstr *MI, unsigned Domain) const {
4237   unsigned DstReg, SrcReg, DReg;
4238   unsigned Lane;
4239   MachineInstrBuilder MIB(*MI->getParent()->getParent(), MI);
4240   const TargetRegisterInfo *TRI = &getRegisterInfo();
4241   switch (MI->getOpcode()) {
4242     default:
4243       llvm_unreachable("cannot handle opcode!");
4244       break;
4245     case ARM::VMOVD:
4246       if (Domain != ExeNEON)
4247         break;
4248
4249       // Zap the predicate operands.
4250       assert(!isPredicated(MI) && "Cannot predicate a VORRd");
4251
4252       // Make sure we've got NEON instructions.
4253       assert(Subtarget.hasNEON() && "VORRd requires NEON");
4254
4255       // Source instruction is %DDst = VMOVD %DSrc, 14, %noreg (; implicits)
4256       DstReg = MI->getOperand(0).getReg();
4257       SrcReg = MI->getOperand(1).getReg();
4258
4259       for (unsigned i = MI->getDesc().getNumOperands(); i; --i)
4260         MI->RemoveOperand(i-1);
4261
4262       // Change to a %DDst = VORRd %DSrc, %DSrc, 14, %noreg (; implicits)
4263       MI->setDesc(get(ARM::VORRd));
4264       AddDefaultPred(MIB.addReg(DstReg, RegState::Define)
4265                         .addReg(SrcReg)
4266                         .addReg(SrcReg));
4267       break;
4268     case ARM::VMOVRS:
4269       if (Domain != ExeNEON)
4270         break;
4271       assert(!isPredicated(MI) && "Cannot predicate a VGETLN");
4272
4273       // Source instruction is %RDst = VMOVRS %SSrc, 14, %noreg (; implicits)
4274       DstReg = MI->getOperand(0).getReg();
4275       SrcReg = MI->getOperand(1).getReg();
4276
4277       for (unsigned i = MI->getDesc().getNumOperands(); i; --i)
4278         MI->RemoveOperand(i-1);
4279
4280       DReg = getCorrespondingDRegAndLane(TRI, SrcReg, Lane);
4281
4282       // Convert to %RDst = VGETLNi32 %DSrc, Lane, 14, %noreg (; imps)
4283       // Note that DSrc has been widened and the other lane may be undef, which
4284       // contaminates the entire register.
4285       MI->setDesc(get(ARM::VGETLNi32));
4286       AddDefaultPred(MIB.addReg(DstReg, RegState::Define)
4287                         .addReg(DReg, RegState::Undef)
4288                         .addImm(Lane));
4289
4290       // The old source should be an implicit use, otherwise we might think it
4291       // was dead before here.
4292       MIB.addReg(SrcReg, RegState::Implicit);
4293       break;
4294     case ARM::VMOVSR: {
4295       if (Domain != ExeNEON)
4296         break;
4297       assert(!isPredicated(MI) && "Cannot predicate a VSETLN");
4298
4299       // Source instruction is %SDst = VMOVSR %RSrc, 14, %noreg (; implicits)
4300       DstReg = MI->getOperand(0).getReg();
4301       SrcReg = MI->getOperand(1).getReg();
4302
4303       DReg = getCorrespondingDRegAndLane(TRI, DstReg, Lane);
4304
4305       unsigned ImplicitSReg;
4306       if (!getImplicitSPRUseForDPRUse(TRI, MI, DReg, Lane, ImplicitSReg))
4307         break;
4308
4309       for (unsigned i = MI->getDesc().getNumOperands(); i; --i)
4310         MI->RemoveOperand(i-1);
4311
4312       // Convert to %DDst = VSETLNi32 %DDst, %RSrc, Lane, 14, %noreg (; imps)
4313       // Again DDst may be undefined at the beginning of this instruction.
4314       MI->setDesc(get(ARM::VSETLNi32));
4315       MIB.addReg(DReg, RegState::Define)
4316          .addReg(DReg, getUndefRegState(!MI->readsRegister(DReg, TRI)))
4317          .addReg(SrcReg)
4318          .addImm(Lane);
4319       AddDefaultPred(MIB);
4320
4321       // The narrower destination must be marked as set to keep previous chains
4322       // in place.
4323       MIB.addReg(DstReg, RegState::Define | RegState::Implicit);
4324       if (ImplicitSReg != 0)
4325         MIB.addReg(ImplicitSReg, RegState::Implicit);
4326       break;
4327     }
4328     case ARM::VMOVS: {
4329       if (Domain != ExeNEON)
4330         break;
4331
4332       // Source instruction is %SDst = VMOVS %SSrc, 14, %noreg (; implicits)
4333       DstReg = MI->getOperand(0).getReg();
4334       SrcReg = MI->getOperand(1).getReg();
4335
4336       unsigned DstLane = 0, SrcLane = 0, DDst, DSrc;
4337       DDst = getCorrespondingDRegAndLane(TRI, DstReg, DstLane);
4338       DSrc = getCorrespondingDRegAndLane(TRI, SrcReg, SrcLane);
4339
4340       unsigned ImplicitSReg;
4341       if (!getImplicitSPRUseForDPRUse(TRI, MI, DSrc, SrcLane, ImplicitSReg))
4342         break;
4343
4344       for (unsigned i = MI->getDesc().getNumOperands(); i; --i)
4345         MI->RemoveOperand(i-1);
4346
4347       if (DSrc == DDst) {
4348         // Destination can be:
4349         //     %DDst = VDUPLN32d %DDst, Lane, 14, %noreg (; implicits)
4350         MI->setDesc(get(ARM::VDUPLN32d));
4351         MIB.addReg(DDst, RegState::Define)
4352            .addReg(DDst, getUndefRegState(!MI->readsRegister(DDst, TRI)))
4353            .addImm(SrcLane);
4354         AddDefaultPred(MIB);
4355
4356         // Neither the source or the destination are naturally represented any
4357         // more, so add them in manually.
4358         MIB.addReg(DstReg, RegState::Implicit | RegState::Define);
4359         MIB.addReg(SrcReg, RegState::Implicit);
4360         if (ImplicitSReg != 0)
4361           MIB.addReg(ImplicitSReg, RegState::Implicit);
4362         break;
4363       }
4364
4365       // In general there's no single instruction that can perform an S <-> S
4366       // move in NEON space, but a pair of VEXT instructions *can* do the
4367       // job. It turns out that the VEXTs needed will only use DSrc once, with
4368       // the position based purely on the combination of lane-0 and lane-1
4369       // involved. For example
4370       //     vmov s0, s2 -> vext.32 d0, d0, d1, #1  vext.32 d0, d0, d0, #1
4371       //     vmov s1, s3 -> vext.32 d0, d1, d0, #1  vext.32 d0, d0, d0, #1
4372       //     vmov s0, s3 -> vext.32 d0, d0, d0, #1  vext.32 d0, d1, d0, #1
4373       //     vmov s1, s2 -> vext.32 d0, d0, d0, #1  vext.32 d0, d0, d1, #1
4374       //
4375       // Pattern of the MachineInstrs is:
4376       //     %DDst = VEXTd32 %DSrc1, %DSrc2, Lane, 14, %noreg (;implicits)
4377       MachineInstrBuilder NewMIB;
4378       NewMIB = BuildMI(*MI->getParent(), MI, MI->getDebugLoc(),
4379                        get(ARM::VEXTd32), DDst);
4380
4381       // On the first instruction, both DSrc and DDst may be <undef> if present.
4382       // Specifically when the original instruction didn't have them as an
4383       // <imp-use>.
4384       unsigned CurReg = SrcLane == 1 && DstLane == 1 ? DSrc : DDst;
4385       bool CurUndef = !MI->readsRegister(CurReg, TRI);
4386       NewMIB.addReg(CurReg, getUndefRegState(CurUndef));
4387
4388       CurReg = SrcLane == 0 && DstLane == 0 ? DSrc : DDst;
4389       CurUndef = !MI->readsRegister(CurReg, TRI);
4390       NewMIB.addReg(CurReg, getUndefRegState(CurUndef));
4391
4392       NewMIB.addImm(1);
4393       AddDefaultPred(NewMIB);
4394
4395       if (SrcLane == DstLane)
4396         NewMIB.addReg(SrcReg, RegState::Implicit);
4397
4398       MI->setDesc(get(ARM::VEXTd32));
4399       MIB.addReg(DDst, RegState::Define);
4400
4401       // On the second instruction, DDst has definitely been defined above, so
4402       // it is not <undef>. DSrc, if present, can be <undef> as above.
4403       CurReg = SrcLane == 1 && DstLane == 0 ? DSrc : DDst;
4404       CurUndef = CurReg == DSrc && !MI->readsRegister(CurReg, TRI);
4405       MIB.addReg(CurReg, getUndefRegState(CurUndef));
4406
4407       CurReg = SrcLane == 0 && DstLane == 1 ? DSrc : DDst;
4408       CurUndef = CurReg == DSrc && !MI->readsRegister(CurReg, TRI);
4409       MIB.addReg(CurReg, getUndefRegState(CurUndef));
4410
4411       MIB.addImm(1);
4412       AddDefaultPred(MIB);
4413
4414       if (SrcLane != DstLane)
4415         MIB.addReg(SrcReg, RegState::Implicit);
4416
4417       // As before, the original destination is no longer represented, add it
4418       // implicitly.
4419       MIB.addReg(DstReg, RegState::Define | RegState::Implicit);
4420       if (ImplicitSReg != 0)
4421         MIB.addReg(ImplicitSReg, RegState::Implicit);
4422       break;
4423     }
4424   }
4425
4426 }
4427
4428 //===----------------------------------------------------------------------===//
4429 // Partial register updates
4430 //===----------------------------------------------------------------------===//
4431 //
4432 // Swift renames NEON registers with 64-bit granularity.  That means any
4433 // instruction writing an S-reg implicitly reads the containing D-reg.  The
4434 // problem is mostly avoided by translating f32 operations to v2f32 operations
4435 // on D-registers, but f32 loads are still a problem.
4436 //
4437 // These instructions can load an f32 into a NEON register:
4438 //
4439 // VLDRS - Only writes S, partial D update.
4440 // VLD1LNd32 - Writes all D-regs, explicit partial D update, 2 uops.
4441 // VLD1DUPd32 - Writes all D-regs, no partial reg update, 2 uops.
4442 //
4443 // FCONSTD can be used as a dependency-breaking instruction.
4444 unsigned ARMBaseInstrInfo::
4445 getPartialRegUpdateClearance(const MachineInstr *MI,
4446                              unsigned OpNum,
4447                              const TargetRegisterInfo *TRI) const {
4448   if (!SwiftPartialUpdateClearance ||
4449       !(Subtarget.isSwift() || Subtarget.isCortexA15()))
4450     return 0;
4451
4452   assert(TRI && "Need TRI instance");
4453
4454   const MachineOperand &MO = MI->getOperand(OpNum);
4455   if (MO.readsReg())
4456     return 0;
4457   unsigned Reg = MO.getReg();
4458   int UseOp = -1;
4459
4460   switch(MI->getOpcode()) {
4461     // Normal instructions writing only an S-register.
4462   case ARM::VLDRS:
4463   case ARM::FCONSTS:
4464   case ARM::VMOVSR:
4465   case ARM::VMOVv8i8:
4466   case ARM::VMOVv4i16:
4467   case ARM::VMOVv2i32:
4468   case ARM::VMOVv2f32:
4469   case ARM::VMOVv1i64:
4470     UseOp = MI->findRegisterUseOperandIdx(Reg, false, TRI);
4471     break;
4472
4473     // Explicitly reads the dependency.
4474   case ARM::VLD1LNd32:
4475     UseOp = 3;
4476     break;
4477   default:
4478     return 0;
4479   }
4480
4481   // If this instruction actually reads a value from Reg, there is no unwanted
4482   // dependency.
4483   if (UseOp != -1 && MI->getOperand(UseOp).readsReg())
4484     return 0;
4485
4486   // We must be able to clobber the whole D-reg.
4487   if (TargetRegisterInfo::isVirtualRegister(Reg)) {
4488     // Virtual register must be a foo:ssub_0<def,undef> operand.
4489     if (!MO.getSubReg() || MI->readsVirtualRegister(Reg))
4490       return 0;
4491   } else if (ARM::SPRRegClass.contains(Reg)) {
4492     // Physical register: MI must define the full D-reg.
4493     unsigned DReg = TRI->getMatchingSuperReg(Reg, ARM::ssub_0,
4494                                              &ARM::DPRRegClass);
4495     if (!DReg || !MI->definesRegister(DReg, TRI))
4496       return 0;
4497   }
4498
4499   // MI has an unwanted D-register dependency.
4500   // Avoid defs in the previous N instructrions.
4501   return SwiftPartialUpdateClearance;
4502 }
4503
4504 // Break a partial register dependency after getPartialRegUpdateClearance
4505 // returned non-zero.
4506 void ARMBaseInstrInfo::
4507 breakPartialRegDependency(MachineBasicBlock::iterator MI,
4508                           unsigned OpNum,
4509                           const TargetRegisterInfo *TRI) const {
4510   assert(MI && OpNum < MI->getDesc().getNumDefs() && "OpNum is not a def");
4511   assert(TRI && "Need TRI instance");
4512
4513   const MachineOperand &MO = MI->getOperand(OpNum);
4514   unsigned Reg = MO.getReg();
4515   assert(TargetRegisterInfo::isPhysicalRegister(Reg) &&
4516          "Can't break virtual register dependencies.");
4517   unsigned DReg = Reg;
4518
4519   // If MI defines an S-reg, find the corresponding D super-register.
4520   if (ARM::SPRRegClass.contains(Reg)) {
4521     DReg = ARM::D0 + (Reg - ARM::S0) / 2;
4522     assert(TRI->isSuperRegister(Reg, DReg) && "Register enums broken");
4523   }
4524
4525   assert(ARM::DPRRegClass.contains(DReg) && "Can only break D-reg deps");
4526   assert(MI->definesRegister(DReg, TRI) && "MI doesn't clobber full D-reg");
4527
4528   // FIXME: In some cases, VLDRS can be changed to a VLD1DUPd32 which defines
4529   // the full D-register by loading the same value to both lanes.  The
4530   // instruction is micro-coded with 2 uops, so don't do this until we can
4531   // properly schedule micro-coded instructions.  The dispatcher stalls cause
4532   // too big regressions.
4533
4534   // Insert the dependency-breaking FCONSTD before MI.
4535   // 96 is the encoding of 0.5, but the actual value doesn't matter here.
4536   AddDefaultPred(BuildMI(*MI->getParent(), MI, MI->getDebugLoc(),
4537                          get(ARM::FCONSTD), DReg).addImm(96));
4538   MI->addRegisterKilled(DReg, TRI, true);
4539 }
4540
4541 bool ARMBaseInstrInfo::hasNOP() const {
4542   return Subtarget.getFeatureBits()[ARM::HasV6KOps];
4543 }
4544
4545 bool ARMBaseInstrInfo::isSwiftFastImmShift(const MachineInstr *MI) const {
4546   if (MI->getNumOperands() < 4)
4547     return true;
4548   unsigned ShOpVal = MI->getOperand(3).getImm();
4549   unsigned ShImm = ARM_AM::getSORegOffset(ShOpVal);
4550   // Swift supports faster shifts for: lsl 2, lsl 1, and lsr 1.
4551   if ((ShImm == 1 && ARM_AM::getSORegShOp(ShOpVal) == ARM_AM::lsr) ||
4552       ((ShImm == 1 || ShImm == 2) &&
4553        ARM_AM::getSORegShOp(ShOpVal) == ARM_AM::lsl))
4554     return true;
4555
4556   return false;
4557 }
4558
4559 bool ARMBaseInstrInfo::getRegSequenceLikeInputs(
4560     const MachineInstr &MI, unsigned DefIdx,
4561     SmallVectorImpl<RegSubRegPairAndIdx> &InputRegs) const {
4562   assert(DefIdx < MI.getDesc().getNumDefs() && "Invalid definition index");
4563   assert(MI.isRegSequenceLike() && "Invalid kind of instruction");
4564
4565   switch (MI.getOpcode()) {
4566   case ARM::VMOVDRR:
4567     // dX = VMOVDRR rY, rZ
4568     // is the same as:
4569     // dX = REG_SEQUENCE rY, ssub_0, rZ, ssub_1
4570     // Populate the InputRegs accordingly.
4571     // rY
4572     const MachineOperand *MOReg = &MI.getOperand(1);
4573     InputRegs.push_back(
4574         RegSubRegPairAndIdx(MOReg->getReg(), MOReg->getSubReg(), ARM::ssub_0));
4575     // rZ
4576     MOReg = &MI.getOperand(2);
4577     InputRegs.push_back(
4578         RegSubRegPairAndIdx(MOReg->getReg(), MOReg->getSubReg(), ARM::ssub_1));
4579     return true;
4580   }
4581   llvm_unreachable("Target dependent opcode missing");
4582 }
4583
4584 bool ARMBaseInstrInfo::getExtractSubregLikeInputs(
4585     const MachineInstr &MI, unsigned DefIdx,
4586     RegSubRegPairAndIdx &InputReg) const {
4587   assert(DefIdx < MI.getDesc().getNumDefs() && "Invalid definition index");
4588   assert(MI.isExtractSubregLike() && "Invalid kind of instruction");
4589
4590   switch (MI.getOpcode()) {
4591   case ARM::VMOVRRD:
4592     // rX, rY = VMOVRRD dZ
4593     // is the same as:
4594     // rX = EXTRACT_SUBREG dZ, ssub_0
4595     // rY = EXTRACT_SUBREG dZ, ssub_1
4596     const MachineOperand &MOReg = MI.getOperand(2);
4597     InputReg.Reg = MOReg.getReg();
4598     InputReg.SubReg = MOReg.getSubReg();
4599     InputReg.SubIdx = DefIdx == 0 ? ARM::ssub_0 : ARM::ssub_1;
4600     return true;
4601   }
4602   llvm_unreachable("Target dependent opcode missing");
4603 }
4604
4605 bool ARMBaseInstrInfo::getInsertSubregLikeInputs(
4606     const MachineInstr &MI, unsigned DefIdx, RegSubRegPair &BaseReg,
4607     RegSubRegPairAndIdx &InsertedReg) const {
4608   assert(DefIdx < MI.getDesc().getNumDefs() && "Invalid definition index");
4609   assert(MI.isInsertSubregLike() && "Invalid kind of instruction");
4610
4611   switch (MI.getOpcode()) {
4612   case ARM::VSETLNi32:
4613     // dX = VSETLNi32 dY, rZ, imm
4614     const MachineOperand &MOBaseReg = MI.getOperand(1);
4615     const MachineOperand &MOInsertedReg = MI.getOperand(2);
4616     const MachineOperand &MOIndex = MI.getOperand(3);
4617     BaseReg.Reg = MOBaseReg.getReg();
4618     BaseReg.SubReg = MOBaseReg.getSubReg();
4619
4620     InsertedReg.Reg = MOInsertedReg.getReg();
4621     InsertedReg.SubReg = MOInsertedReg.getSubReg();
4622     InsertedReg.SubIdx = MOIndex.getImm() == 0 ? ARM::ssub_0 : ARM::ssub_1;
4623     return true;
4624   }
4625   llvm_unreachable("Target dependent opcode missing");
4626 }