Implement optimizeCompareInstr for PPC
[oota-llvm.git] / lib / Target / PowerPC / PPCInstrInfo.cpp
1 //===-- PPCInstrInfo.cpp - PowerPC 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 PowerPC implementation of the TargetInstrInfo class.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "PPCInstrInfo.h"
15 #include "MCTargetDesc/PPCPredicates.h"
16 #include "PPC.h"
17 #include "PPCHazardRecognizers.h"
18 #include "PPCInstrBuilder.h"
19 #include "PPCMachineFunctionInfo.h"
20 #include "PPCTargetMachine.h"
21 #include "llvm/ADT/Statistic.h"
22 #include "llvm/ADT/STLExtras.h"
23 #include "llvm/CodeGen/MachineFrameInfo.h"
24 #include "llvm/CodeGen/MachineFunctionPass.h"
25 #include "llvm/CodeGen/MachineInstrBuilder.h"
26 #include "llvm/CodeGen/MachineMemOperand.h"
27 #include "llvm/CodeGen/MachineRegisterInfo.h"
28 #include "llvm/CodeGen/PseudoSourceValue.h"
29 #include "llvm/MC/MCAsmInfo.h"
30 #include "llvm/Support/CommandLine.h"
31 #include "llvm/Support/ErrorHandling.h"
32 #include "llvm/Support/TargetRegistry.h"
33 #include "llvm/Support/raw_ostream.h"
34
35 #define GET_INSTRMAP_INFO
36 #define GET_INSTRINFO_CTOR
37 #include "PPCGenInstrInfo.inc"
38
39 using namespace llvm;
40
41 static cl::
42 opt<bool> DisableCTRLoopAnal("disable-ppc-ctrloop-analysis", cl::Hidden,
43             cl::desc("Disable analysis for CTR loops"));
44
45 PPCInstrInfo::PPCInstrInfo(PPCTargetMachine &tm)
46   : PPCGenInstrInfo(PPC::ADJCALLSTACKDOWN, PPC::ADJCALLSTACKUP),
47     TM(tm), RI(*TM.getSubtargetImpl(), *this) {}
48
49 /// CreateTargetHazardRecognizer - Return the hazard recognizer to use for
50 /// this target when scheduling the DAG.
51 ScheduleHazardRecognizer *PPCInstrInfo::CreateTargetHazardRecognizer(
52   const TargetMachine *TM,
53   const ScheduleDAG *DAG) const {
54   unsigned Directive = TM->getSubtarget<PPCSubtarget>().getDarwinDirective();
55   if (Directive == PPC::DIR_440 || Directive == PPC::DIR_A2 ||
56       Directive == PPC::DIR_E500mc || Directive == PPC::DIR_E5500) {
57     const InstrItineraryData *II = TM->getInstrItineraryData();
58     return new PPCScoreboardHazardRecognizer(II, DAG);
59   }
60
61   return TargetInstrInfo::CreateTargetHazardRecognizer(TM, DAG);
62 }
63
64 /// CreateTargetPostRAHazardRecognizer - Return the postRA hazard recognizer
65 /// to use for this target when scheduling the DAG.
66 ScheduleHazardRecognizer *PPCInstrInfo::CreateTargetPostRAHazardRecognizer(
67   const InstrItineraryData *II,
68   const ScheduleDAG *DAG) const {
69   unsigned Directive = TM.getSubtarget<PPCSubtarget>().getDarwinDirective();
70
71   // Most subtargets use a PPC970 recognizer.
72   if (Directive != PPC::DIR_440 && Directive != PPC::DIR_A2 &&
73       Directive != PPC::DIR_E500mc && Directive != PPC::DIR_E5500) {
74     const TargetInstrInfo *TII = TM.getInstrInfo();
75     assert(TII && "No InstrInfo?");
76
77     return new PPCHazardRecognizer970(*TII);
78   }
79
80   return new PPCScoreboardHazardRecognizer(II, DAG);
81 }
82
83 // Detect 32 -> 64-bit extensions where we may reuse the low sub-register.
84 bool PPCInstrInfo::isCoalescableExtInstr(const MachineInstr &MI,
85                                          unsigned &SrcReg, unsigned &DstReg,
86                                          unsigned &SubIdx) const {
87   switch (MI.getOpcode()) {
88   default: return false;
89   case PPC::EXTSW:
90   case PPC::EXTSW_32_64:
91     SrcReg = MI.getOperand(1).getReg();
92     DstReg = MI.getOperand(0).getReg();
93     SubIdx = PPC::sub_32;
94     return true;
95   }
96 }
97
98 unsigned PPCInstrInfo::isLoadFromStackSlot(const MachineInstr *MI,
99                                            int &FrameIndex) const {
100   // Note: This list must be kept consistent with LoadRegFromStackSlot.
101   switch (MI->getOpcode()) {
102   default: break;
103   case PPC::LD:
104   case PPC::LWZ:
105   case PPC::LFS:
106   case PPC::LFD:
107   case PPC::RESTORE_CR:
108   case PPC::LVX:
109   case PPC::RESTORE_VRSAVE:
110     // Check for the operands added by addFrameReference (the immediate is the
111     // offset which defaults to 0).
112     if (MI->getOperand(1).isImm() && !MI->getOperand(1).getImm() &&
113         MI->getOperand(2).isFI()) {
114       FrameIndex = MI->getOperand(2).getIndex();
115       return MI->getOperand(0).getReg();
116     }
117     break;
118   }
119   return 0;
120 }
121
122 unsigned PPCInstrInfo::isStoreToStackSlot(const MachineInstr *MI,
123                                           int &FrameIndex) const {
124   // Note: This list must be kept consistent with StoreRegToStackSlot.
125   switch (MI->getOpcode()) {
126   default: break;
127   case PPC::STD:
128   case PPC::STW:
129   case PPC::STFS:
130   case PPC::STFD:
131   case PPC::SPILL_CR:
132   case PPC::STVX:
133   case PPC::SPILL_VRSAVE:
134     // Check for the operands added by addFrameReference (the immediate is the
135     // offset which defaults to 0).
136     if (MI->getOperand(1).isImm() && !MI->getOperand(1).getImm() &&
137         MI->getOperand(2).isFI()) {
138       FrameIndex = MI->getOperand(2).getIndex();
139       return MI->getOperand(0).getReg();
140     }
141     break;
142   }
143   return 0;
144 }
145
146 // commuteInstruction - We can commute rlwimi instructions, but only if the
147 // rotate amt is zero.  We also have to munge the immediates a bit.
148 MachineInstr *
149 PPCInstrInfo::commuteInstruction(MachineInstr *MI, bool NewMI) const {
150   MachineFunction &MF = *MI->getParent()->getParent();
151
152   // Normal instructions can be commuted the obvious way.
153   if (MI->getOpcode() != PPC::RLWIMI &&
154       MI->getOpcode() != PPC::RLWIMIo)
155     return TargetInstrInfo::commuteInstruction(MI, NewMI);
156
157   // Cannot commute if it has a non-zero rotate count.
158   if (MI->getOperand(3).getImm() != 0)
159     return 0;
160
161   // If we have a zero rotate count, we have:
162   //   M = mask(MB,ME)
163   //   Op0 = (Op1 & ~M) | (Op2 & M)
164   // Change this to:
165   //   M = mask((ME+1)&31, (MB-1)&31)
166   //   Op0 = (Op2 & ~M) | (Op1 & M)
167
168   // Swap op1/op2
169   unsigned Reg0 = MI->getOperand(0).getReg();
170   unsigned Reg1 = MI->getOperand(1).getReg();
171   unsigned Reg2 = MI->getOperand(2).getReg();
172   bool Reg1IsKill = MI->getOperand(1).isKill();
173   bool Reg2IsKill = MI->getOperand(2).isKill();
174   bool ChangeReg0 = false;
175   // If machine instrs are no longer in two-address forms, update
176   // destination register as well.
177   if (Reg0 == Reg1) {
178     // Must be two address instruction!
179     assert(MI->getDesc().getOperandConstraint(0, MCOI::TIED_TO) &&
180            "Expecting a two-address instruction!");
181     Reg2IsKill = false;
182     ChangeReg0 = true;
183   }
184
185   // Masks.
186   unsigned MB = MI->getOperand(4).getImm();
187   unsigned ME = MI->getOperand(5).getImm();
188
189   if (NewMI) {
190     // Create a new instruction.
191     unsigned Reg0 = ChangeReg0 ? Reg2 : MI->getOperand(0).getReg();
192     bool Reg0IsDead = MI->getOperand(0).isDead();
193     return BuildMI(MF, MI->getDebugLoc(), MI->getDesc())
194       .addReg(Reg0, RegState::Define | getDeadRegState(Reg0IsDead))
195       .addReg(Reg2, getKillRegState(Reg2IsKill))
196       .addReg(Reg1, getKillRegState(Reg1IsKill))
197       .addImm((ME+1) & 31)
198       .addImm((MB-1) & 31);
199   }
200
201   if (ChangeReg0)
202     MI->getOperand(0).setReg(Reg2);
203   MI->getOperand(2).setReg(Reg1);
204   MI->getOperand(1).setReg(Reg2);
205   MI->getOperand(2).setIsKill(Reg1IsKill);
206   MI->getOperand(1).setIsKill(Reg2IsKill);
207
208   // Swap the mask around.
209   MI->getOperand(4).setImm((ME+1) & 31);
210   MI->getOperand(5).setImm((MB-1) & 31);
211   return MI;
212 }
213
214 void PPCInstrInfo::insertNoop(MachineBasicBlock &MBB,
215                               MachineBasicBlock::iterator MI) const {
216   DebugLoc DL;
217   BuildMI(MBB, MI, DL, get(PPC::NOP));
218 }
219
220
221 // Branch analysis.
222 // Note: If the condition register is set to CTR or CTR8 then this is a
223 // BDNZ (imm == 1) or BDZ (imm == 0) branch.
224 bool PPCInstrInfo::AnalyzeBranch(MachineBasicBlock &MBB,MachineBasicBlock *&TBB,
225                                  MachineBasicBlock *&FBB,
226                                  SmallVectorImpl<MachineOperand> &Cond,
227                                  bool AllowModify) const {
228   bool isPPC64 = TM.getSubtargetImpl()->isPPC64();
229
230   // If the block has no terminators, it just falls into the block after it.
231   MachineBasicBlock::iterator I = MBB.end();
232   if (I == MBB.begin())
233     return false;
234   --I;
235   while (I->isDebugValue()) {
236     if (I == MBB.begin())
237       return false;
238     --I;
239   }
240   if (!isUnpredicatedTerminator(I))
241     return false;
242
243   // Get the last instruction in the block.
244   MachineInstr *LastInst = I;
245
246   // If there is only one terminator instruction, process it.
247   if (I == MBB.begin() || !isUnpredicatedTerminator(--I)) {
248     if (LastInst->getOpcode() == PPC::B) {
249       if (!LastInst->getOperand(0).isMBB())
250         return true;
251       TBB = LastInst->getOperand(0).getMBB();
252       return false;
253     } else if (LastInst->getOpcode() == PPC::BCC) {
254       if (!LastInst->getOperand(2).isMBB())
255         return true;
256       // Block ends with fall-through condbranch.
257       TBB = LastInst->getOperand(2).getMBB();
258       Cond.push_back(LastInst->getOperand(0));
259       Cond.push_back(LastInst->getOperand(1));
260       return false;
261     } else if (LastInst->getOpcode() == PPC::BDNZ8 ||
262                LastInst->getOpcode() == PPC::BDNZ) {
263       if (!LastInst->getOperand(0).isMBB())
264         return true;
265       if (DisableCTRLoopAnal)
266         return true;
267       TBB = LastInst->getOperand(0).getMBB();
268       Cond.push_back(MachineOperand::CreateImm(1));
269       Cond.push_back(MachineOperand::CreateReg(isPPC64 ? PPC::CTR8 : PPC::CTR,
270                                                true));
271       return false;
272     } else if (LastInst->getOpcode() == PPC::BDZ8 ||
273                LastInst->getOpcode() == PPC::BDZ) {
274       if (!LastInst->getOperand(0).isMBB())
275         return true;
276       if (DisableCTRLoopAnal)
277         return true;
278       TBB = LastInst->getOperand(0).getMBB();
279       Cond.push_back(MachineOperand::CreateImm(0));
280       Cond.push_back(MachineOperand::CreateReg(isPPC64 ? PPC::CTR8 : PPC::CTR,
281                                                true));
282       return false;
283     }
284
285     // Otherwise, don't know what this is.
286     return true;
287   }
288
289   // Get the instruction before it if it's a terminator.
290   MachineInstr *SecondLastInst = I;
291
292   // If there are three terminators, we don't know what sort of block this is.
293   if (SecondLastInst && I != MBB.begin() &&
294       isUnpredicatedTerminator(--I))
295     return true;
296
297   // If the block ends with PPC::B and PPC:BCC, handle it.
298   if (SecondLastInst->getOpcode() == PPC::BCC &&
299       LastInst->getOpcode() == PPC::B) {
300     if (!SecondLastInst->getOperand(2).isMBB() ||
301         !LastInst->getOperand(0).isMBB())
302       return true;
303     TBB =  SecondLastInst->getOperand(2).getMBB();
304     Cond.push_back(SecondLastInst->getOperand(0));
305     Cond.push_back(SecondLastInst->getOperand(1));
306     FBB = LastInst->getOperand(0).getMBB();
307     return false;
308   } else if ((SecondLastInst->getOpcode() == PPC::BDNZ8 ||
309               SecondLastInst->getOpcode() == PPC::BDNZ) &&
310       LastInst->getOpcode() == PPC::B) {
311     if (!SecondLastInst->getOperand(0).isMBB() ||
312         !LastInst->getOperand(0).isMBB())
313       return true;
314     if (DisableCTRLoopAnal)
315       return true;
316     TBB = SecondLastInst->getOperand(0).getMBB();
317     Cond.push_back(MachineOperand::CreateImm(1));
318     Cond.push_back(MachineOperand::CreateReg(isPPC64 ? PPC::CTR8 : PPC::CTR,
319                                              true));
320     FBB = LastInst->getOperand(0).getMBB();
321     return false;
322   } else if ((SecondLastInst->getOpcode() == PPC::BDZ8 ||
323               SecondLastInst->getOpcode() == PPC::BDZ) &&
324       LastInst->getOpcode() == PPC::B) {
325     if (!SecondLastInst->getOperand(0).isMBB() ||
326         !LastInst->getOperand(0).isMBB())
327       return true;
328     if (DisableCTRLoopAnal)
329       return true;
330     TBB = SecondLastInst->getOperand(0).getMBB();
331     Cond.push_back(MachineOperand::CreateImm(0));
332     Cond.push_back(MachineOperand::CreateReg(isPPC64 ? PPC::CTR8 : PPC::CTR,
333                                              true));
334     FBB = LastInst->getOperand(0).getMBB();
335     return false;
336   }
337
338   // If the block ends with two PPC:Bs, handle it.  The second one is not
339   // executed, so remove it.
340   if (SecondLastInst->getOpcode() == PPC::B &&
341       LastInst->getOpcode() == PPC::B) {
342     if (!SecondLastInst->getOperand(0).isMBB())
343       return true;
344     TBB = SecondLastInst->getOperand(0).getMBB();
345     I = LastInst;
346     if (AllowModify)
347       I->eraseFromParent();
348     return false;
349   }
350
351   // Otherwise, can't handle this.
352   return true;
353 }
354
355 unsigned PPCInstrInfo::RemoveBranch(MachineBasicBlock &MBB) const {
356   MachineBasicBlock::iterator I = MBB.end();
357   if (I == MBB.begin()) return 0;
358   --I;
359   while (I->isDebugValue()) {
360     if (I == MBB.begin())
361       return 0;
362     --I;
363   }
364   if (I->getOpcode() != PPC::B && I->getOpcode() != PPC::BCC &&
365       I->getOpcode() != PPC::BDNZ8 && I->getOpcode() != PPC::BDNZ &&
366       I->getOpcode() != PPC::BDZ8  && I->getOpcode() != PPC::BDZ)
367     return 0;
368
369   // Remove the branch.
370   I->eraseFromParent();
371
372   I = MBB.end();
373
374   if (I == MBB.begin()) return 1;
375   --I;
376   if (I->getOpcode() != PPC::BCC &&
377       I->getOpcode() != PPC::BDNZ8 && I->getOpcode() != PPC::BDNZ &&
378       I->getOpcode() != PPC::BDZ8  && I->getOpcode() != PPC::BDZ)
379     return 1;
380
381   // Remove the branch.
382   I->eraseFromParent();
383   return 2;
384 }
385
386 unsigned
387 PPCInstrInfo::InsertBranch(MachineBasicBlock &MBB, MachineBasicBlock *TBB,
388                            MachineBasicBlock *FBB,
389                            const SmallVectorImpl<MachineOperand> &Cond,
390                            DebugLoc DL) const {
391   // Shouldn't be a fall through.
392   assert(TBB && "InsertBranch must not be told to insert a fallthrough");
393   assert((Cond.size() == 2 || Cond.size() == 0) &&
394          "PPC branch conditions have two components!");
395
396   bool isPPC64 = TM.getSubtargetImpl()->isPPC64();
397
398   // One-way branch.
399   if (FBB == 0) {
400     if (Cond.empty())   // Unconditional branch
401       BuildMI(&MBB, DL, get(PPC::B)).addMBB(TBB);
402     else if (Cond[1].getReg() == PPC::CTR || Cond[1].getReg() == PPC::CTR8)
403       BuildMI(&MBB, DL, get(Cond[0].getImm() ?
404                               (isPPC64 ? PPC::BDNZ8 : PPC::BDNZ) :
405                               (isPPC64 ? PPC::BDZ8  : PPC::BDZ))).addMBB(TBB);
406     else                // Conditional branch
407       BuildMI(&MBB, DL, get(PPC::BCC))
408         .addImm(Cond[0].getImm()).addReg(Cond[1].getReg()).addMBB(TBB);
409     return 1;
410   }
411
412   // Two-way Conditional Branch.
413   if (Cond[1].getReg() == PPC::CTR || Cond[1].getReg() == PPC::CTR8)
414     BuildMI(&MBB, DL, get(Cond[0].getImm() ?
415                             (isPPC64 ? PPC::BDNZ8 : PPC::BDNZ) :
416                             (isPPC64 ? PPC::BDZ8  : PPC::BDZ))).addMBB(TBB);
417   else
418     BuildMI(&MBB, DL, get(PPC::BCC))
419       .addImm(Cond[0].getImm()).addReg(Cond[1].getReg()).addMBB(TBB);
420   BuildMI(&MBB, DL, get(PPC::B)).addMBB(FBB);
421   return 2;
422 }
423
424 // Select analysis.
425 bool PPCInstrInfo::canInsertSelect(const MachineBasicBlock &MBB,
426                 const SmallVectorImpl<MachineOperand> &Cond,
427                 unsigned TrueReg, unsigned FalseReg,
428                 int &CondCycles, int &TrueCycles, int &FalseCycles) const {
429   if (!TM.getSubtargetImpl()->hasISEL())
430     return false;
431
432   if (Cond.size() != 2)
433     return false;
434
435   // If this is really a bdnz-like condition, then it cannot be turned into a
436   // select.
437   if (Cond[1].getReg() == PPC::CTR || Cond[1].getReg() == PPC::CTR8)
438     return false;
439
440   // Check register classes.
441   const MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
442   const TargetRegisterClass *RC =
443     RI.getCommonSubClass(MRI.getRegClass(TrueReg), MRI.getRegClass(FalseReg));
444   if (!RC)
445     return false;
446
447   // isel is for regular integer GPRs only.
448   if (!PPC::GPRCRegClass.hasSubClassEq(RC) &&
449       !PPC::G8RCRegClass.hasSubClassEq(RC))
450     return false;
451
452   // FIXME: These numbers are for the A2, how well they work for other cores is
453   // an open question. On the A2, the isel instruction has a 2-cycle latency
454   // but single-cycle throughput. These numbers are used in combination with
455   // the MispredictPenalty setting from the active SchedMachineModel.
456   CondCycles = 1;
457   TrueCycles = 1;
458   FalseCycles = 1;
459
460   return true;
461 }
462
463 void PPCInstrInfo::insertSelect(MachineBasicBlock &MBB,
464                                 MachineBasicBlock::iterator MI, DebugLoc dl,
465                                 unsigned DestReg,
466                                 const SmallVectorImpl<MachineOperand> &Cond,
467                                 unsigned TrueReg, unsigned FalseReg) const {
468   assert(Cond.size() == 2 &&
469          "PPC branch conditions have two components!");
470
471   assert(TM.getSubtargetImpl()->hasISEL() &&
472          "Cannot insert select on target without ISEL support");
473
474   // Get the register classes.
475   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
476   const TargetRegisterClass *RC =
477     RI.getCommonSubClass(MRI.getRegClass(TrueReg), MRI.getRegClass(FalseReg));
478   assert(RC && "TrueReg and FalseReg must have overlapping register classes");
479   assert((PPC::GPRCRegClass.hasSubClassEq(RC) ||
480           PPC::G8RCRegClass.hasSubClassEq(RC)) &&
481          "isel is for regular integer GPRs only");
482
483   unsigned OpCode =
484     PPC::GPRCRegClass.hasSubClassEq(RC) ? PPC::ISEL : PPC::ISEL8;
485   unsigned SelectPred = Cond[0].getImm();
486
487   unsigned SubIdx;
488   bool SwapOps;
489   switch (SelectPred) {
490   default: llvm_unreachable("invalid predicate for isel");
491   case PPC::PRED_EQ: SubIdx = PPC::sub_eq; SwapOps = false; break;
492   case PPC::PRED_NE: SubIdx = PPC::sub_eq; SwapOps = true; break;
493   case PPC::PRED_LT: SubIdx = PPC::sub_lt; SwapOps = false; break;
494   case PPC::PRED_GE: SubIdx = PPC::sub_lt; SwapOps = true; break;
495   case PPC::PRED_GT: SubIdx = PPC::sub_gt; SwapOps = false; break;
496   case PPC::PRED_LE: SubIdx = PPC::sub_gt; SwapOps = true; break;
497   case PPC::PRED_UN: SubIdx = PPC::sub_un; SwapOps = false; break;
498   case PPC::PRED_NU: SubIdx = PPC::sub_un; SwapOps = true; break;
499   }
500
501   unsigned FirstReg =  SwapOps ? FalseReg : TrueReg,
502            SecondReg = SwapOps ? TrueReg  : FalseReg;
503
504   // The first input register of isel cannot be r0. If it is a member
505   // of a register class that can be r0, then copy it first (the
506   // register allocator should eliminate the copy).
507   if (MRI.getRegClass(FirstReg)->contains(PPC::R0) ||
508       MRI.getRegClass(FirstReg)->contains(PPC::X0)) {
509     const TargetRegisterClass *FirstRC =
510       MRI.getRegClass(FirstReg)->contains(PPC::X0) ?
511         &PPC::G8RC_NOX0RegClass : &PPC::GPRC_NOR0RegClass;
512     unsigned OldFirstReg = FirstReg;
513     FirstReg = MRI.createVirtualRegister(FirstRC);
514     BuildMI(MBB, MI, dl, get(TargetOpcode::COPY), FirstReg)
515       .addReg(OldFirstReg);
516   }
517
518   BuildMI(MBB, MI, dl, get(OpCode), DestReg)
519     .addReg(FirstReg).addReg(SecondReg)
520     .addReg(Cond[1].getReg(), 0, SubIdx);
521 }
522
523 void PPCInstrInfo::copyPhysReg(MachineBasicBlock &MBB,
524                                MachineBasicBlock::iterator I, DebugLoc DL,
525                                unsigned DestReg, unsigned SrcReg,
526                                bool KillSrc) const {
527   unsigned Opc;
528   if (PPC::GPRCRegClass.contains(DestReg, SrcReg))
529     Opc = PPC::OR;
530   else if (PPC::G8RCRegClass.contains(DestReg, SrcReg))
531     Opc = PPC::OR8;
532   else if (PPC::F4RCRegClass.contains(DestReg, SrcReg))
533     Opc = PPC::FMR;
534   else if (PPC::CRRCRegClass.contains(DestReg, SrcReg))
535     Opc = PPC::MCRF;
536   else if (PPC::VRRCRegClass.contains(DestReg, SrcReg))
537     Opc = PPC::VOR;
538   else if (PPC::CRBITRCRegClass.contains(DestReg, SrcReg))
539     Opc = PPC::CROR;
540   else
541     llvm_unreachable("Impossible reg-to-reg copy");
542
543   const MCInstrDesc &MCID = get(Opc);
544   if (MCID.getNumOperands() == 3)
545     BuildMI(MBB, I, DL, MCID, DestReg)
546       .addReg(SrcReg).addReg(SrcReg, getKillRegState(KillSrc));
547   else
548     BuildMI(MBB, I, DL, MCID, DestReg).addReg(SrcReg, getKillRegState(KillSrc));
549 }
550
551 // This function returns true if a CR spill is necessary and false otherwise.
552 bool
553 PPCInstrInfo::StoreRegToStackSlot(MachineFunction &MF,
554                                   unsigned SrcReg, bool isKill,
555                                   int FrameIdx,
556                                   const TargetRegisterClass *RC,
557                                   SmallVectorImpl<MachineInstr*> &NewMIs,
558                                   bool &NonRI, bool &SpillsVRS) const{
559   // Note: If additional store instructions are added here,
560   // update isStoreToStackSlot.
561
562   DebugLoc DL;
563   if (PPC::GPRCRegClass.hasSubClassEq(RC)) {
564     NewMIs.push_back(addFrameReference(BuildMI(MF, DL, get(PPC::STW))
565                                        .addReg(SrcReg,
566                                                getKillRegState(isKill)),
567                                        FrameIdx));
568   } else if (PPC::G8RCRegClass.hasSubClassEq(RC)) {
569     NewMIs.push_back(addFrameReference(BuildMI(MF, DL, get(PPC::STD))
570                                        .addReg(SrcReg,
571                                                getKillRegState(isKill)),
572                                        FrameIdx));
573   } else if (PPC::F8RCRegClass.hasSubClassEq(RC)) {
574     NewMIs.push_back(addFrameReference(BuildMI(MF, DL, get(PPC::STFD))
575                                        .addReg(SrcReg,
576                                                getKillRegState(isKill)),
577                                        FrameIdx));
578   } else if (PPC::F4RCRegClass.hasSubClassEq(RC)) {
579     NewMIs.push_back(addFrameReference(BuildMI(MF, DL, get(PPC::STFS))
580                                        .addReg(SrcReg,
581                                                getKillRegState(isKill)),
582                                        FrameIdx));
583   } else if (PPC::CRRCRegClass.hasSubClassEq(RC)) {
584     NewMIs.push_back(addFrameReference(BuildMI(MF, DL, get(PPC::SPILL_CR))
585                                        .addReg(SrcReg,
586                                                getKillRegState(isKill)),
587                                        FrameIdx));
588     return true;
589   } else if (PPC::CRBITRCRegClass.hasSubClassEq(RC)) {
590     // FIXME: We use CRi here because there is no mtcrf on a bit. Since the
591     // backend currently only uses CR1EQ as an individual bit, this should
592     // not cause any bug. If we need other uses of CR bits, the following
593     // code may be invalid.
594     unsigned Reg = 0;
595     if (SrcReg == PPC::CR0LT || SrcReg == PPC::CR0GT ||
596         SrcReg == PPC::CR0EQ || SrcReg == PPC::CR0UN)
597       Reg = PPC::CR0;
598     else if (SrcReg == PPC::CR1LT || SrcReg == PPC::CR1GT ||
599              SrcReg == PPC::CR1EQ || SrcReg == PPC::CR1UN)
600       Reg = PPC::CR1;
601     else if (SrcReg == PPC::CR2LT || SrcReg == PPC::CR2GT ||
602              SrcReg == PPC::CR2EQ || SrcReg == PPC::CR2UN)
603       Reg = PPC::CR2;
604     else if (SrcReg == PPC::CR3LT || SrcReg == PPC::CR3GT ||
605              SrcReg == PPC::CR3EQ || SrcReg == PPC::CR3UN)
606       Reg = PPC::CR3;
607     else if (SrcReg == PPC::CR4LT || SrcReg == PPC::CR4GT ||
608              SrcReg == PPC::CR4EQ || SrcReg == PPC::CR4UN)
609       Reg = PPC::CR4;
610     else if (SrcReg == PPC::CR5LT || SrcReg == PPC::CR5GT ||
611              SrcReg == PPC::CR5EQ || SrcReg == PPC::CR5UN)
612       Reg = PPC::CR5;
613     else if (SrcReg == PPC::CR6LT || SrcReg == PPC::CR6GT ||
614              SrcReg == PPC::CR6EQ || SrcReg == PPC::CR6UN)
615       Reg = PPC::CR6;
616     else if (SrcReg == PPC::CR7LT || SrcReg == PPC::CR7GT ||
617              SrcReg == PPC::CR7EQ || SrcReg == PPC::CR7UN)
618       Reg = PPC::CR7;
619
620     return StoreRegToStackSlot(MF, Reg, isKill, FrameIdx,
621                                &PPC::CRRCRegClass, NewMIs, NonRI, SpillsVRS);
622
623   } else if (PPC::VRRCRegClass.hasSubClassEq(RC)) {
624     NewMIs.push_back(addFrameReference(BuildMI(MF, DL, get(PPC::STVX))
625                                        .addReg(SrcReg,
626                                                getKillRegState(isKill)),
627                                        FrameIdx));
628     NonRI = true;
629   } else if (PPC::VRSAVERCRegClass.hasSubClassEq(RC)) {
630     assert(TM.getSubtargetImpl()->isDarwin() &&
631            "VRSAVE only needs spill/restore on Darwin");
632     NewMIs.push_back(addFrameReference(BuildMI(MF, DL, get(PPC::SPILL_VRSAVE))
633                                        .addReg(SrcReg,
634                                                getKillRegState(isKill)),
635                                        FrameIdx));
636     SpillsVRS = true;
637   } else {
638     llvm_unreachable("Unknown regclass!");
639   }
640
641   return false;
642 }
643
644 void
645 PPCInstrInfo::storeRegToStackSlot(MachineBasicBlock &MBB,
646                                   MachineBasicBlock::iterator MI,
647                                   unsigned SrcReg, bool isKill, int FrameIdx,
648                                   const TargetRegisterClass *RC,
649                                   const TargetRegisterInfo *TRI) const {
650   MachineFunction &MF = *MBB.getParent();
651   SmallVector<MachineInstr*, 4> NewMIs;
652
653   PPCFunctionInfo *FuncInfo = MF.getInfo<PPCFunctionInfo>();
654   FuncInfo->setHasSpills();
655
656   bool NonRI = false, SpillsVRS = false;
657   if (StoreRegToStackSlot(MF, SrcReg, isKill, FrameIdx, RC, NewMIs,
658                           NonRI, SpillsVRS))
659     FuncInfo->setSpillsCR();
660
661   if (SpillsVRS)
662     FuncInfo->setSpillsVRSAVE();
663
664   if (NonRI)
665     FuncInfo->setHasNonRISpills();
666
667   for (unsigned i = 0, e = NewMIs.size(); i != e; ++i)
668     MBB.insert(MI, NewMIs[i]);
669
670   const MachineFrameInfo &MFI = *MF.getFrameInfo();
671   MachineMemOperand *MMO =
672     MF.getMachineMemOperand(MachinePointerInfo::getFixedStack(FrameIdx),
673                             MachineMemOperand::MOStore,
674                             MFI.getObjectSize(FrameIdx),
675                             MFI.getObjectAlignment(FrameIdx));
676   NewMIs.back()->addMemOperand(MF, MMO);
677 }
678
679 bool
680 PPCInstrInfo::LoadRegFromStackSlot(MachineFunction &MF, DebugLoc DL,
681                                    unsigned DestReg, int FrameIdx,
682                                    const TargetRegisterClass *RC,
683                                    SmallVectorImpl<MachineInstr*> &NewMIs,
684                                    bool &NonRI, bool &SpillsVRS) const{
685   // Note: If additional load instructions are added here,
686   // update isLoadFromStackSlot.
687
688   if (PPC::GPRCRegClass.hasSubClassEq(RC)) {
689     NewMIs.push_back(addFrameReference(BuildMI(MF, DL, get(PPC::LWZ),
690                                                DestReg), FrameIdx));
691   } else if (PPC::G8RCRegClass.hasSubClassEq(RC)) {
692     NewMIs.push_back(addFrameReference(BuildMI(MF, DL, get(PPC::LD), DestReg),
693                                        FrameIdx));
694   } else if (PPC::F8RCRegClass.hasSubClassEq(RC)) {
695     NewMIs.push_back(addFrameReference(BuildMI(MF, DL, get(PPC::LFD), DestReg),
696                                        FrameIdx));
697   } else if (PPC::F4RCRegClass.hasSubClassEq(RC)) {
698     NewMIs.push_back(addFrameReference(BuildMI(MF, DL, get(PPC::LFS), DestReg),
699                                        FrameIdx));
700   } else if (PPC::CRRCRegClass.hasSubClassEq(RC)) {
701     NewMIs.push_back(addFrameReference(BuildMI(MF, DL,
702                                                get(PPC::RESTORE_CR), DestReg),
703                                        FrameIdx));
704     return true;
705   } else if (PPC::CRBITRCRegClass.hasSubClassEq(RC)) {
706
707     unsigned Reg = 0;
708     if (DestReg == PPC::CR0LT || DestReg == PPC::CR0GT ||
709         DestReg == PPC::CR0EQ || DestReg == PPC::CR0UN)
710       Reg = PPC::CR0;
711     else if (DestReg == PPC::CR1LT || DestReg == PPC::CR1GT ||
712              DestReg == PPC::CR1EQ || DestReg == PPC::CR1UN)
713       Reg = PPC::CR1;
714     else if (DestReg == PPC::CR2LT || DestReg == PPC::CR2GT ||
715              DestReg == PPC::CR2EQ || DestReg == PPC::CR2UN)
716       Reg = PPC::CR2;
717     else if (DestReg == PPC::CR3LT || DestReg == PPC::CR3GT ||
718              DestReg == PPC::CR3EQ || DestReg == PPC::CR3UN)
719       Reg = PPC::CR3;
720     else if (DestReg == PPC::CR4LT || DestReg == PPC::CR4GT ||
721              DestReg == PPC::CR4EQ || DestReg == PPC::CR4UN)
722       Reg = PPC::CR4;
723     else if (DestReg == PPC::CR5LT || DestReg == PPC::CR5GT ||
724              DestReg == PPC::CR5EQ || DestReg == PPC::CR5UN)
725       Reg = PPC::CR5;
726     else if (DestReg == PPC::CR6LT || DestReg == PPC::CR6GT ||
727              DestReg == PPC::CR6EQ || DestReg == PPC::CR6UN)
728       Reg = PPC::CR6;
729     else if (DestReg == PPC::CR7LT || DestReg == PPC::CR7GT ||
730              DestReg == PPC::CR7EQ || DestReg == PPC::CR7UN)
731       Reg = PPC::CR7;
732
733     return LoadRegFromStackSlot(MF, DL, Reg, FrameIdx,
734                                 &PPC::CRRCRegClass, NewMIs, NonRI, SpillsVRS);
735
736   } else if (PPC::VRRCRegClass.hasSubClassEq(RC)) {
737     NewMIs.push_back(addFrameReference(BuildMI(MF, DL, get(PPC::LVX), DestReg),
738                                        FrameIdx));
739     NonRI = true;
740   } else if (PPC::VRSAVERCRegClass.hasSubClassEq(RC)) {
741     assert(TM.getSubtargetImpl()->isDarwin() &&
742            "VRSAVE only needs spill/restore on Darwin");
743     NewMIs.push_back(addFrameReference(BuildMI(MF, DL,
744                                                get(PPC::RESTORE_VRSAVE),
745                                                DestReg),
746                                        FrameIdx));
747     SpillsVRS = true;
748   } else {
749     llvm_unreachable("Unknown regclass!");
750   }
751
752   return false;
753 }
754
755 void
756 PPCInstrInfo::loadRegFromStackSlot(MachineBasicBlock &MBB,
757                                    MachineBasicBlock::iterator MI,
758                                    unsigned DestReg, int FrameIdx,
759                                    const TargetRegisterClass *RC,
760                                    const TargetRegisterInfo *TRI) const {
761   MachineFunction &MF = *MBB.getParent();
762   SmallVector<MachineInstr*, 4> NewMIs;
763   DebugLoc DL;
764   if (MI != MBB.end()) DL = MI->getDebugLoc();
765
766   PPCFunctionInfo *FuncInfo = MF.getInfo<PPCFunctionInfo>();
767   FuncInfo->setHasSpills();
768
769   bool NonRI = false, SpillsVRS = false;
770   if (LoadRegFromStackSlot(MF, DL, DestReg, FrameIdx, RC, NewMIs,
771                            NonRI, SpillsVRS))
772     FuncInfo->setSpillsCR();
773
774   if (SpillsVRS)
775     FuncInfo->setSpillsVRSAVE();
776
777   if (NonRI)
778     FuncInfo->setHasNonRISpills();
779
780   for (unsigned i = 0, e = NewMIs.size(); i != e; ++i)
781     MBB.insert(MI, NewMIs[i]);
782
783   const MachineFrameInfo &MFI = *MF.getFrameInfo();
784   MachineMemOperand *MMO =
785     MF.getMachineMemOperand(MachinePointerInfo::getFixedStack(FrameIdx),
786                             MachineMemOperand::MOLoad,
787                             MFI.getObjectSize(FrameIdx),
788                             MFI.getObjectAlignment(FrameIdx));
789   NewMIs.back()->addMemOperand(MF, MMO);
790 }
791
792 MachineInstr*
793 PPCInstrInfo::emitFrameIndexDebugValue(MachineFunction &MF,
794                                        int FrameIx, uint64_t Offset,
795                                        const MDNode *MDPtr,
796                                        DebugLoc DL) const {
797   MachineInstrBuilder MIB = BuildMI(MF, DL, get(PPC::DBG_VALUE));
798   addFrameReference(MIB, FrameIx, 0, false).addImm(Offset).addMetadata(MDPtr);
799   return &*MIB;
800 }
801
802 bool PPCInstrInfo::
803 ReverseBranchCondition(SmallVectorImpl<MachineOperand> &Cond) const {
804   assert(Cond.size() == 2 && "Invalid PPC branch opcode!");
805   if (Cond[1].getReg() == PPC::CTR8 || Cond[1].getReg() == PPC::CTR)
806     Cond[0].setImm(Cond[0].getImm() == 0 ? 1 : 0);
807   else
808     // Leave the CR# the same, but invert the condition.
809     Cond[0].setImm(PPC::InvertPredicate((PPC::Predicate)Cond[0].getImm()));
810   return false;
811 }
812
813 bool PPCInstrInfo::FoldImmediate(MachineInstr *UseMI, MachineInstr *DefMI,
814                              unsigned Reg, MachineRegisterInfo *MRI) const {
815   // For some instructions, it is legal to fold ZERO into the RA register field.
816   // A zero immediate should always be loaded with a single li.
817   unsigned DefOpc = DefMI->getOpcode();
818   if (DefOpc != PPC::LI && DefOpc != PPC::LI8)
819     return false;
820   if (!DefMI->getOperand(1).isImm())
821     return false;
822   if (DefMI->getOperand(1).getImm() != 0)
823     return false;
824
825   // Note that we cannot here invert the arguments of an isel in order to fold
826   // a ZERO into what is presented as the second argument. All we have here
827   // is the condition bit, and that might come from a CR-logical bit operation.
828
829   const MCInstrDesc &UseMCID = UseMI->getDesc();
830
831   // Only fold into real machine instructions.
832   if (UseMCID.isPseudo())
833     return false;
834
835   unsigned UseIdx;
836   for (UseIdx = 0; UseIdx < UseMI->getNumOperands(); ++UseIdx)
837     if (UseMI->getOperand(UseIdx).isReg() &&
838         UseMI->getOperand(UseIdx).getReg() == Reg)
839       break;
840
841   assert(UseIdx < UseMI->getNumOperands() && "Cannot find Reg in UseMI");
842   assert(UseIdx < UseMCID.getNumOperands() && "No operand description for Reg");
843
844   const MCOperandInfo *UseInfo = &UseMCID.OpInfo[UseIdx];
845
846   // We can fold the zero if this register requires a GPRC_NOR0/G8RC_NOX0
847   // register (which might also be specified as a pointer class kind).
848   if (UseInfo->isLookupPtrRegClass()) {
849     if (UseInfo->RegClass /* Kind */ != 1)
850       return false;
851   } else {
852     if (UseInfo->RegClass != PPC::GPRC_NOR0RegClassID &&
853         UseInfo->RegClass != PPC::G8RC_NOX0RegClassID)
854       return false;
855   }
856
857   // Make sure this is not tied to an output register (or otherwise
858   // constrained). This is true for ST?UX registers, for example, which
859   // are tied to their output registers.
860   if (UseInfo->Constraints != 0)
861     return false;
862
863   unsigned ZeroReg;
864   if (UseInfo->isLookupPtrRegClass()) {
865     bool isPPC64 = TM.getSubtargetImpl()->isPPC64();
866     ZeroReg = isPPC64 ? PPC::ZERO8 : PPC::ZERO;
867   } else {
868     ZeroReg = UseInfo->RegClass == PPC::G8RC_NOX0RegClassID ?
869               PPC::ZERO8 : PPC::ZERO;
870   }
871
872   bool DeleteDef = MRI->hasOneNonDBGUse(Reg);
873   UseMI->getOperand(UseIdx).setReg(ZeroReg);
874
875   if (DeleteDef)
876     DefMI->eraseFromParent();
877
878   return true;
879 }
880
881 static bool MBBDefinesCTR(MachineBasicBlock &MBB) {
882   for (MachineBasicBlock::iterator I = MBB.begin(), IE = MBB.end();
883        I != IE; ++I)
884     if (I->definesRegister(PPC::CTR) || I->definesRegister(PPC::CTR8))
885       return true;
886   return false;
887 }
888
889 // We should make sure that, if we're going to predicate both sides of a
890 // condition (a diamond), that both sides don't define the counter register. We
891 // can predicate counter-decrement-based branches, but while that predicates
892 // the branching, it does not predicate the counter decrement. If we tried to
893 // merge the triangle into one predicated block, we'd decrement the counter
894 // twice.
895 bool PPCInstrInfo::isProfitableToIfCvt(MachineBasicBlock &TMBB,
896                      unsigned NumT, unsigned ExtraT,
897                      MachineBasicBlock &FMBB,
898                      unsigned NumF, unsigned ExtraF,
899                      const BranchProbability &Probability) const {
900   return !(MBBDefinesCTR(TMBB) && MBBDefinesCTR(FMBB));
901 }
902
903
904 bool PPCInstrInfo::isPredicated(const MachineInstr *MI) const {
905   // The predicated branches are identified by their type, not really by the
906   // explicit presence of a predicate. Furthermore, some of them can be
907   // predicated more than once. Because if conversion won't try to predicate
908   // any instruction which already claims to be predicated (by returning true
909   // here), always return false. In doing so, we let isPredicable() be the
910   // final word on whether not the instruction can be (further) predicated.
911
912   return false;
913 }
914
915 bool PPCInstrInfo::isUnpredicatedTerminator(const MachineInstr *MI) const {
916   if (!MI->isTerminator())
917     return false;
918
919   // Conditional branch is a special case.
920   if (MI->isBranch() && !MI->isBarrier())
921     return true;
922
923   return !isPredicated(MI);
924 }
925
926 bool PPCInstrInfo::PredicateInstruction(
927                      MachineInstr *MI,
928                      const SmallVectorImpl<MachineOperand> &Pred) const {
929   unsigned OpC = MI->getOpcode();
930   if (OpC == PPC::BLR) {
931     if (Pred[1].getReg() == PPC::CTR8 || Pred[1].getReg() == PPC::CTR) {
932       bool isPPC64 = TM.getSubtargetImpl()->isPPC64();
933       MI->setDesc(get(Pred[0].getImm() ?
934                       (isPPC64 ? PPC::BDNZLR8 : PPC::BDNZLR) :
935                       (isPPC64 ? PPC::BDZLR8  : PPC::BDZLR)));
936     } else {
937       MI->setDesc(get(PPC::BCLR));
938       MachineInstrBuilder(*MI->getParent()->getParent(), MI)
939         .addImm(Pred[0].getImm())
940         .addReg(Pred[1].getReg());
941     }
942
943     return true;
944   } else if (OpC == PPC::B) {
945     if (Pred[1].getReg() == PPC::CTR8 || Pred[1].getReg() == PPC::CTR) {
946       bool isPPC64 = TM.getSubtargetImpl()->isPPC64();
947       MI->setDesc(get(Pred[0].getImm() ?
948                       (isPPC64 ? PPC::BDNZ8 : PPC::BDNZ) :
949                       (isPPC64 ? PPC::BDZ8  : PPC::BDZ)));
950     } else {
951       MachineBasicBlock *MBB = MI->getOperand(0).getMBB();
952       MI->RemoveOperand(0);
953
954       MI->setDesc(get(PPC::BCC));
955       MachineInstrBuilder(*MI->getParent()->getParent(), MI)
956         .addImm(Pred[0].getImm())
957         .addReg(Pred[1].getReg())
958         .addMBB(MBB);
959     }
960
961     return true;
962   } else if (OpC == PPC::BCTR  || OpC == PPC::BCTR8 ||
963              OpC == PPC::BCTRL || OpC == PPC::BCTRL8) {
964     if (Pred[1].getReg() == PPC::CTR8 || Pred[1].getReg() == PPC::CTR)
965       llvm_unreachable("Cannot predicate bctr[l] on the ctr register");
966
967     bool setLR = OpC == PPC::BCTRL || OpC == PPC::BCTRL8;
968     bool isPPC64 = TM.getSubtargetImpl()->isPPC64();
969     MI->setDesc(get(isPPC64 ? (setLR ? PPC::BCCTRL8 : PPC::BCCTR8) :
970                               (setLR ? PPC::BCCTRL  : PPC::BCCTR)));
971     MachineInstrBuilder(*MI->getParent()->getParent(), MI)
972       .addImm(Pred[0].getImm())
973       .addReg(Pred[1].getReg());
974     return true;
975   }
976
977   return false;
978 }
979
980 bool PPCInstrInfo::SubsumesPredicate(
981                      const SmallVectorImpl<MachineOperand> &Pred1,
982                      const SmallVectorImpl<MachineOperand> &Pred2) const {
983   assert(Pred1.size() == 2 && "Invalid PPC first predicate");
984   assert(Pred2.size() == 2 && "Invalid PPC second predicate");
985
986   if (Pred1[1].getReg() == PPC::CTR8 || Pred1[1].getReg() == PPC::CTR)
987     return false;
988   if (Pred2[1].getReg() == PPC::CTR8 || Pred2[1].getReg() == PPC::CTR)
989     return false;
990
991   PPC::Predicate P1 = (PPC::Predicate) Pred1[0].getImm();
992   PPC::Predicate P2 = (PPC::Predicate) Pred2[0].getImm();
993
994   if (P1 == P2)
995     return true;
996
997   // Does P1 subsume P2, e.g. GE subsumes GT.
998   if (P1 == PPC::PRED_LE &&
999       (P2 == PPC::PRED_LT || P2 == PPC::PRED_EQ))
1000     return true;
1001   if (P1 == PPC::PRED_GE &&
1002       (P2 == PPC::PRED_GT || P2 == PPC::PRED_EQ))
1003     return true;
1004
1005   return false;
1006 }
1007
1008 bool PPCInstrInfo::DefinesPredicate(MachineInstr *MI,
1009                                     std::vector<MachineOperand> &Pred) const {
1010   // Note: At the present time, the contents of Pred from this function is
1011   // unused by IfConversion. This implementation follows ARM by pushing the
1012   // CR-defining operand. Because the 'DZ' and 'DNZ' count as types of
1013   // predicate, instructions defining CTR or CTR8 are also included as
1014   // predicate-defining instructions.
1015
1016   const TargetRegisterClass *RCs[] =
1017     { &PPC::CRRCRegClass, &PPC::CRBITRCRegClass,
1018       &PPC::CTRRCRegClass, &PPC::CTRRC8RegClass };
1019
1020   bool Found = false;
1021   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
1022     const MachineOperand &MO = MI->getOperand(i);
1023     for (unsigned c = 0; c < array_lengthof(RCs) && !Found; ++c) {
1024       const TargetRegisterClass *RC = RCs[c];
1025       if (MO.isReg()) {
1026         if (MO.isDef() && RC->contains(MO.getReg())) {
1027           Pred.push_back(MO);
1028           Found = true;
1029         }
1030       } else if (MO.isRegMask()) {
1031         for (TargetRegisterClass::iterator I = RC->begin(),
1032              IE = RC->end(); I != IE; ++I)
1033           if (MO.clobbersPhysReg(*I)) {
1034             Pred.push_back(MO);
1035             Found = true;
1036           }
1037       }
1038     }
1039   }
1040
1041   return Found;
1042 }
1043
1044 bool PPCInstrInfo::isPredicable(MachineInstr *MI) const {
1045   unsigned OpC = MI->getOpcode();
1046   switch (OpC) {
1047   default:
1048     return false;
1049   case PPC::B:
1050   case PPC::BLR:
1051   case PPC::BCTR:
1052   case PPC::BCTR8:
1053   case PPC::BCTRL:
1054   case PPC::BCTRL8:
1055     return true;
1056   }
1057 }
1058
1059 bool PPCInstrInfo::analyzeCompare(const MachineInstr *MI,
1060                                   unsigned &SrcReg, unsigned &SrcReg2,
1061                                   int &Mask, int &Value) const {
1062   unsigned Opc = MI->getOpcode();
1063
1064   switch (Opc) {
1065   default: return false;
1066   case PPC::CMPWI:
1067   case PPC::CMPLWI:
1068   case PPC::CMPDI:
1069   case PPC::CMPLDI:
1070     SrcReg = MI->getOperand(1).getReg();
1071     SrcReg2 = 0;
1072     Value = MI->getOperand(2).getImm();
1073     Mask = 0xFFFF;
1074     return true;
1075   case PPC::CMPW:
1076   case PPC::CMPLW:
1077   case PPC::CMPD:
1078   case PPC::CMPLD:
1079   case PPC::FCMPUS:
1080   case PPC::FCMPUD:
1081     SrcReg = MI->getOperand(1).getReg();
1082     SrcReg2 = MI->getOperand(2).getReg();
1083     return true;
1084   }
1085 }
1086   
1087 bool PPCInstrInfo::optimizeCompareInstr(MachineInstr *CmpInstr,
1088                                         unsigned SrcReg, unsigned SrcReg2,
1089                                         int Mask, int Value,
1090                                         const MachineRegisterInfo *MRI) const {
1091   int OpC = CmpInstr->getOpcode();
1092   unsigned CRReg = CmpInstr->getOperand(0).getReg();
1093   bool isFP = OpC == PPC::FCMPUS || OpC == PPC::FCMPUD;
1094   unsigned CRRecReg = isFP ? PPC::CR1 : PPC::CR0;
1095
1096   // The record forms set the condition register based on a signed comparison
1097   // with zero (so says the ISA manual). This is not as straightforward as it
1098   // seems, however, because this is always a 64-bit comparison on PPC64, even
1099   // for instructions that are 32-bit in nature (like slw for example).
1100   // So, on PPC32, for unsigned comparisons, we can use the record forms only
1101   // for equality checks (as those don't depend on the sign). On PPC64,
1102   // we are restricted to equality for unsigned 64-bit comparisons and for
1103   // signed 32-bit comparisons the applicability is more restricted.
1104   bool isPPC64 = TM.getSubtargetImpl()->isPPC64();
1105   bool is32BitSignedCompare   = OpC ==  PPC::CMPWI || OpC == PPC::CMPW;
1106   bool is32BitUnsignedCompare = OpC == PPC::CMPLWI || OpC == PPC::CMPLW;
1107   bool is64BitUnsignedCompare = OpC == PPC::CMPLDI || OpC == PPC::CMPLD;
1108
1109   // Get the unique definition of SrcReg.
1110   MachineInstr *MI = MRI->getUniqueVRegDef(SrcReg);
1111   if (!MI) return false;
1112   int MIOpC = MI->getOpcode();
1113
1114   bool equalityOnly = false;
1115   bool noSub = false;
1116   if (isPPC64) {
1117     if (is32BitSignedCompare) {
1118       // We can perform this optimization only if MI is sign-extending.
1119       if (MIOpC == PPC::SRAW  || MIOpC == PPC::SRAWo ||
1120           MIOpC == PPC::SRAWI || MIOpC == PPC::SRAWIo ||
1121           MIOpC == PPC::EXTSB || MIOpC == PPC::EXTSBo ||
1122           MIOpC == PPC::EXTSH || MIOpC == PPC::EXTSHo ||
1123           MIOpC == PPC::EXTSW || MIOpC == PPC::EXTSWo) {
1124         noSub = true;
1125       } else
1126         return false;
1127     } else if (is32BitUnsignedCompare) {
1128       // We can perform this optimization, equality only, if MI is
1129       // zero-extending.
1130       if (MIOpC == PPC::CNTLZW || MIOpC == PPC::CNTLZWo ||
1131           MIOpC == PPC::SLW    || MIOpC == PPC::SLWo ||
1132           MIOpC == PPC::SRW    || MIOpC == PPC::SRWo) {
1133         noSub = true;
1134         equalityOnly = true;
1135       } else
1136         return false;
1137     } else if (!isFP)
1138       equalityOnly = is64BitUnsignedCompare;
1139   } else if (!isFP)
1140     equalityOnly = is32BitUnsignedCompare;
1141
1142   if (equalityOnly) {
1143     // We need to check the uses of the condition register in order to reject
1144     // non-equality comparisons.
1145     for (MachineRegisterInfo::use_iterator I = MRI->use_begin(CRReg),
1146          IE = MRI->use_end(); I != IE; ++I) {
1147       MachineInstr *UseMI = &*I;
1148       if (UseMI->getOpcode() == PPC::BCC) {
1149         unsigned Pred = UseMI->getOperand(0).getImm();
1150         if (Pred == PPC::PRED_EQ || Pred == PPC::PRED_NE)
1151           continue;
1152
1153         return false;
1154       } else if (UseMI->getOpcode() == PPC::ISEL ||
1155                  UseMI->getOpcode() == PPC::ISEL8) {
1156         unsigned SubIdx = UseMI->getOperand(3).getSubReg();
1157         if (SubIdx == PPC::sub_eq)
1158           continue;
1159
1160         return false;
1161       } else
1162         return false;
1163     }
1164   }
1165
1166   // Get ready to iterate backward from CmpInstr.
1167   MachineBasicBlock::iterator I = CmpInstr, E = MI,
1168                               B = CmpInstr->getParent()->begin();
1169
1170   // Scan forward to find the first use of the compare.
1171   for (MachineBasicBlock::iterator EL = CmpInstr->getParent()->end();
1172        I != EL; ++I) {
1173     bool FoundUse = false;
1174     for (MachineRegisterInfo::use_iterator J = MRI->use_begin(CRReg),
1175          JE = MRI->use_end(); J != JE; ++J)
1176       if (&*J == &*I) {
1177         FoundUse = true;
1178         break;
1179       }
1180
1181     if (FoundUse)
1182       break;
1183   }
1184
1185   // Early exit if we're at the beginning of the BB.
1186   if (I == B) return false;
1187
1188   // There are two possible candidates which can be changed to set CR[01].
1189   // One is MI, the other is a SUB instruction.
1190   // For CMPrr(r1,r2), we are looking for SUB(r1,r2) or SUB(r2,r1).
1191   MachineInstr *Sub = NULL;
1192   if (SrcReg2 != 0)
1193     // MI is not a candidate for CMPrr.
1194     MI = NULL;
1195   // FIXME: Conservatively refuse to convert an instruction which isn't in the
1196   // same BB as the comparison. This is to allow the check below to avoid calls
1197   // (and other explicit clobbers); instead we should really check for these
1198   // more explicitly (in at least a few predecessors).
1199   else if (MI->getParent() != CmpInstr->getParent() || Value != 0) {
1200     // PPC does not have a record-form SUBri.
1201     return false;
1202   }
1203
1204   // Search for Sub.
1205   const TargetRegisterInfo *TRI = &getRegisterInfo();
1206   --I;
1207   for (; I != E && !noSub; --I) {
1208     const MachineInstr &Instr = *I;
1209     unsigned IOpC = Instr.getOpcode();
1210
1211     if (&*I != CmpInstr && (
1212         Instr.modifiesRegister(CRRecReg, TRI) ||
1213         Instr.readsRegister(CRRecReg, TRI)))
1214       // This instruction modifies or uses the record condition register after
1215       // the one we want to change. While we could do this transformation, it
1216       // would likely not be profitable. This transformation removes one
1217       // instruction, and so even forcing RA to generate one move probably
1218       // makes it unprofitable.
1219       return false;
1220
1221     // Check whether CmpInstr can be made redundant by the current instruction.
1222     if ((OpC == PPC::CMPW || OpC == PPC::CMPLW ||
1223          OpC == PPC::CMPD || OpC == PPC::CMPLD) &&
1224         (IOpC == PPC::SUBF || IOpC == PPC::SUBF8) &&
1225         ((Instr.getOperand(1).getReg() == SrcReg &&
1226           Instr.getOperand(2).getReg() == SrcReg2) ||
1227         (Instr.getOperand(1).getReg() == SrcReg2 &&
1228          Instr.getOperand(2).getReg() == SrcReg))) {
1229       Sub = &*I;
1230       break;
1231     }
1232
1233     if (isFP && (IOpC == PPC::FSUB || IOpC == PPC::FSUBS) &&
1234         ((Instr.getOperand(1).getReg() == SrcReg &&
1235           Instr.getOperand(2).getReg() == SrcReg2) ||
1236         (Instr.getOperand(1).getReg() == SrcReg2 &&
1237          Instr.getOperand(2).getReg() == SrcReg))) {
1238       Sub = &*I;
1239       break;
1240     }
1241
1242     if (I == B)
1243       // The 'and' is below the comparison instruction.
1244       return false;
1245   }
1246
1247   // Return false if no candidates exist.
1248   if (!MI && !Sub)
1249     return false;
1250
1251   // The single candidate is called MI.
1252   if (!MI) MI = Sub;
1253
1254   int NewOpC = -1;
1255   MIOpC = MI->getOpcode();
1256   if (MIOpC == PPC::ANDIo || MIOpC == PPC::ANDIo8)
1257     NewOpC = MIOpC;
1258   else {
1259     NewOpC = PPC::getRecordFormOpcode(MIOpC);
1260     if (NewOpC == -1 && PPC::getNonRecordFormOpcode(MIOpC) != -1)
1261       NewOpC = MIOpC;
1262   }
1263
1264   // FIXME: On the non-embedded POWER architectures, only some of the record
1265   // forms are fast, and we should use only the fast ones.
1266
1267   // The defining instruction has a record form (or is already a record
1268   // form). It is possible, however, that we'll need to reverse the condition
1269   // code of the users.
1270   if (NewOpC == -1)
1271     return false;
1272
1273   SmallVector<std::pair<MachineOperand*, PPC::Predicate>, 4>
1274       OperandsToUpdate;
1275   SmallVector<std::pair<MachineOperand*, MachineOperand*>, 4>
1276       OperandsToSwap;
1277
1278   // If we have SUB(r1, r2) and CMP(r2, r1), the condition code based on CMP
1279   // needs to be updated to be based on SUB.  Push the condition code
1280   // operands to OperandsToUpdate.  If it is safe to remove CmpInstr, the
1281   // condition code of these operands will be modified.
1282   bool ShouldSwap = false;
1283   if (Sub) {
1284     ShouldSwap = SrcReg2 != 0 && Sub->getOperand(1).getReg() == SrcReg2 &&
1285       Sub->getOperand(2).getReg() == SrcReg;
1286
1287     // The operands to subf are the opposite of sub, so only in the fixed-point
1288     // case, invert the order.
1289     if (!isFP)
1290       ShouldSwap = !ShouldSwap;
1291   }
1292
1293   if (ShouldSwap)
1294     for (MachineRegisterInfo::use_iterator I = MRI->use_begin(CRReg),
1295          IE = MRI->use_end(); I != IE; ++I) {
1296       MachineInstr *UseMI = &*I;
1297       if (UseMI->getOpcode() == PPC::BCC) {
1298         PPC::Predicate Pred = (PPC::Predicate) UseMI->getOperand(0).getImm();
1299         if (ShouldSwap)
1300           OperandsToUpdate.push_back(std::make_pair(&((*I).getOperand(0)),
1301                                      PPC::InvertPredicate(Pred)));
1302       } else if (UseMI->getOpcode() == PPC::ISEL ||
1303                  UseMI->getOpcode() == PPC::ISEL8) {
1304         if (ShouldSwap)
1305           OperandsToSwap.push_back(std::make_pair(&((*I).getOperand(1)),
1306                                                   &((*I).getOperand(2))));
1307       } else // We need to abort on a user we don't understand.
1308         return false;
1309     }
1310
1311   // Create a new virtual register to hold the value of the CR set by the
1312   // record-form instruction. If the instruction was not previously in
1313   // record form, then set the kill flag on the CR.
1314   CmpInstr->eraseFromParent();
1315
1316   MachineBasicBlock::iterator MII = MI;
1317   BuildMI(*MI->getParent(), llvm::next(MII), MI->getDebugLoc(),
1318           get(TargetOpcode::COPY), CRReg)
1319     .addReg(CRRecReg, MIOpC != NewOpC ? RegState::Kill : 0);
1320
1321   if (MIOpC != NewOpC) {
1322     // We need to be careful here: we're replacing one instruction with
1323     // another, and we need to make sure that we get all of the right
1324     // implicit uses and defs. On the other hand, the caller may be holding
1325     // an iterator to this instruction, and so we can't delete it (this is
1326     // specifically the case if this is the instruction directly after the
1327     // compare).
1328
1329     const MCInstrDesc &NewDesc = get(NewOpC);
1330     MI->setDesc(NewDesc);
1331
1332     if (NewDesc.ImplicitDefs)
1333       for (const uint16_t *ImpDefs = NewDesc.getImplicitDefs();
1334            *ImpDefs; ++ImpDefs)
1335         if (!MI->definesRegister(*ImpDefs))
1336           MI->addOperand(*MI->getParent()->getParent(),
1337                          MachineOperand::CreateReg(*ImpDefs, true, true));
1338     if (NewDesc.ImplicitUses)
1339       for (const uint16_t *ImpUses = NewDesc.getImplicitUses();
1340            *ImpUses; ++ImpUses)
1341         if (!MI->readsRegister(*ImpUses))
1342           MI->addOperand(*MI->getParent()->getParent(),
1343                          MachineOperand::CreateReg(*ImpUses, false, true));
1344   }
1345
1346   // Modify the condition code of operands in OperandsToUpdate.
1347   // Since we have SUB(r1, r2) and CMP(r2, r1), the condition code needs to
1348   // be changed from r2 > r1 to r1 < r2, from r2 < r1 to r1 > r2, etc.
1349   for (unsigned i = 0, e = OperandsToUpdate.size(); i < e; i++)
1350     OperandsToUpdate[i].first->setImm(OperandsToUpdate[i].second);
1351
1352   for (unsigned i = 0, e = OperandsToSwap.size(); i < e; i++)
1353     std::swap(*OperandsToSwap[i].first, *OperandsToSwap[i].second);
1354
1355   return true;
1356 }
1357
1358 /// GetInstSize - Return the number of bytes of code the specified
1359 /// instruction may be.  This returns the maximum number of bytes.
1360 ///
1361 unsigned PPCInstrInfo::GetInstSizeInBytes(const MachineInstr *MI) const {
1362   switch (MI->getOpcode()) {
1363   case PPC::INLINEASM: {       // Inline Asm: Variable size.
1364     const MachineFunction *MF = MI->getParent()->getParent();
1365     const char *AsmStr = MI->getOperand(0).getSymbolName();
1366     return getInlineAsmLength(AsmStr, *MF->getTarget().getMCAsmInfo());
1367   }
1368   case PPC::PROLOG_LABEL:
1369   case PPC::EH_LABEL:
1370   case PPC::GC_LABEL:
1371   case PPC::DBG_VALUE:
1372     return 0;
1373   case PPC::BL8_NOP:
1374   case PPC::BLA8_NOP:
1375     return 8;
1376   default:
1377     return 4; // PowerPC instructions are all 4 bytes
1378   }
1379 }
1380
1381 #undef DEBUG_TYPE
1382 #define DEBUG_TYPE "ppc-early-ret"
1383 STATISTIC(NumBCLR, "Number of early conditional returns");
1384 STATISTIC(NumBLR,  "Number of early returns");
1385
1386 namespace llvm {
1387   void initializePPCEarlyReturnPass(PassRegistry&);
1388 }
1389
1390 namespace {
1391   // PPCEarlyReturn pass - For simple functions without epilogue code, move
1392   // returns up, and create conditional returns, to avoid unnecessary
1393   // branch-to-blr sequences.
1394   struct PPCEarlyReturn : public MachineFunctionPass {
1395     static char ID;
1396     PPCEarlyReturn() : MachineFunctionPass(ID) {
1397       initializePPCEarlyReturnPass(*PassRegistry::getPassRegistry());
1398     }
1399
1400     const PPCTargetMachine *TM;
1401     const PPCInstrInfo *TII;
1402
1403 protected:
1404     bool processBlock(MachineBasicBlock &ReturnMBB) {
1405       bool Changed = false;
1406
1407       MachineBasicBlock::iterator I = ReturnMBB.begin();
1408       I = ReturnMBB.SkipPHIsAndLabels(I);
1409
1410       // The block must be essentially empty except for the blr.
1411       if (I == ReturnMBB.end() || I->getOpcode() != PPC::BLR ||
1412           I != ReturnMBB.getLastNonDebugInstr())
1413         return Changed;
1414
1415       SmallVector<MachineBasicBlock*, 8> PredToRemove;
1416       for (MachineBasicBlock::pred_iterator PI = ReturnMBB.pred_begin(),
1417            PIE = ReturnMBB.pred_end(); PI != PIE; ++PI) {
1418         bool OtherReference = false, BlockChanged = false;
1419         for (MachineBasicBlock::iterator J = (*PI)->getLastNonDebugInstr();;) {
1420           if (J->getOpcode() == PPC::B) {
1421             if (J->getOperand(0).getMBB() == &ReturnMBB) {
1422               // This is an unconditional branch to the return. Replace the
1423               // branch with a blr.
1424               BuildMI(**PI, J, J->getDebugLoc(), TII->get(PPC::BLR));
1425               MachineBasicBlock::iterator K = J--;
1426               K->eraseFromParent();
1427               BlockChanged = true;
1428               ++NumBLR;
1429               continue;
1430             }
1431           } else if (J->getOpcode() == PPC::BCC) {
1432             if (J->getOperand(2).getMBB() == &ReturnMBB) {
1433               // This is a conditional branch to the return. Replace the branch
1434               // with a bclr.
1435               BuildMI(**PI, J, J->getDebugLoc(), TII->get(PPC::BCLR))
1436                 .addImm(J->getOperand(0).getImm())
1437                 .addReg(J->getOperand(1).getReg());
1438               MachineBasicBlock::iterator K = J--;
1439               K->eraseFromParent();
1440               BlockChanged = true;
1441               ++NumBCLR;
1442               continue;
1443             }
1444           } else if (J->isBranch()) {
1445             if (J->isIndirectBranch()) {
1446               if (ReturnMBB.hasAddressTaken())
1447                 OtherReference = true;
1448             } else
1449               for (unsigned i = 0; i < J->getNumOperands(); ++i)
1450                 if (J->getOperand(i).isMBB() &&
1451                     J->getOperand(i).getMBB() == &ReturnMBB)
1452                   OtherReference = true;
1453           } else if (!J->isTerminator() && !J->isDebugValue())
1454             break;
1455
1456           if (J == (*PI)->begin())
1457             break;
1458
1459           --J;
1460         }
1461
1462         if ((*PI)->canFallThrough() && (*PI)->isLayoutSuccessor(&ReturnMBB))
1463           OtherReference = true;
1464
1465         // Predecessors are stored in a vector and can't be removed here.
1466         if (!OtherReference && BlockChanged) {
1467           PredToRemove.push_back(*PI);
1468         }
1469
1470         if (BlockChanged)
1471           Changed = true;
1472       }
1473
1474       for (unsigned i = 0, ie = PredToRemove.size(); i != ie; ++i)
1475         PredToRemove[i]->removeSuccessor(&ReturnMBB);
1476
1477       if (Changed && !ReturnMBB.hasAddressTaken()) {
1478         // We now might be able to merge this blr-only block into its
1479         // by-layout predecessor.
1480         if (ReturnMBB.pred_size() == 1 &&
1481             (*ReturnMBB.pred_begin())->isLayoutSuccessor(&ReturnMBB)) {
1482           // Move the blr into the preceding block.
1483           MachineBasicBlock &PrevMBB = **ReturnMBB.pred_begin();
1484           PrevMBB.splice(PrevMBB.end(), &ReturnMBB, I);
1485           PrevMBB.removeSuccessor(&ReturnMBB);
1486         }
1487
1488         if (ReturnMBB.pred_empty())
1489           ReturnMBB.eraseFromParent();
1490       }
1491
1492       return Changed;
1493     }
1494
1495 public:
1496     virtual bool runOnMachineFunction(MachineFunction &MF) {
1497       TM = static_cast<const PPCTargetMachine *>(&MF.getTarget());
1498       TII = TM->getInstrInfo();
1499
1500       bool Changed = false;
1501
1502       // If the function does not have at least two blocks, then there is
1503       // nothing to do.
1504       if (MF.size() < 2)
1505         return Changed;
1506
1507       for (MachineFunction::iterator I = MF.begin(); I != MF.end();) {
1508         MachineBasicBlock &B = *I++; 
1509         if (processBlock(B))
1510           Changed = true;
1511       }
1512
1513       return Changed;
1514     }
1515
1516     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
1517       MachineFunctionPass::getAnalysisUsage(AU);
1518     }
1519   };
1520 }
1521
1522 INITIALIZE_PASS(PPCEarlyReturn, DEBUG_TYPE,
1523                 "PowerPC Early-Return Creation", false, false)
1524
1525 char PPCEarlyReturn::ID = 0;
1526 FunctionPass*
1527 llvm::createPPCEarlyReturnPass() { return new PPCEarlyReturn(); }
1528