TargetInstrInfo::commuteInstruction() doesn't actually return a new instruction
[oota-llvm.git] / lib / CodeGen / TwoAddressInstructionPass.cpp
1 //===-- TwoAddressInstructionPass.cpp - Two-Address instruction pass ------===//
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 implements the TwoAddress instruction pass which is used
11 // by most register allocators. Two-Address instructions are rewritten
12 // from:
13 //
14 //     A = B op C
15 //
16 // to:
17 //
18 //     A = B
19 //     A op= C
20 //
21 // Note that if a register allocator chooses to use this pass, that it
22 // has to be capable of handling the non-SSA nature of these rewritten
23 // virtual registers.
24 //
25 // It is also worth noting that the duplicate operand of the two
26 // address instruction is removed.
27 //
28 //===----------------------------------------------------------------------===//
29
30 #define DEBUG_TYPE "twoaddrinstr"
31 #include "llvm/CodeGen/Passes.h"
32 #include "llvm/ADT/BitVector.h"
33 #include "llvm/ADT/DenseMap.h"
34 #include "llvm/ADT/STLExtras.h"
35 #include "llvm/ADT/SmallSet.h"
36 #include "llvm/ADT/Statistic.h"
37 #include "llvm/Analysis/AliasAnalysis.h"
38 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
39 #include "llvm/CodeGen/LiveVariables.h"
40 #include "llvm/CodeGen/MachineFunctionPass.h"
41 #include "llvm/CodeGen/MachineInstr.h"
42 #include "llvm/CodeGen/MachineInstrBuilder.h"
43 #include "llvm/CodeGen/MachineRegisterInfo.h"
44 #include "llvm/IR/Function.h"
45 #include "llvm/MC/MCInstrItineraries.h"
46 #include "llvm/Support/Debug.h"
47 #include "llvm/Support/ErrorHandling.h"
48 #include "llvm/Target/TargetInstrInfo.h"
49 #include "llvm/Target/TargetMachine.h"
50 #include "llvm/Target/TargetOptions.h"
51 #include "llvm/Target/TargetRegisterInfo.h"
52 using namespace llvm;
53
54 STATISTIC(NumTwoAddressInstrs, "Number of two-address instructions");
55 STATISTIC(NumCommuted        , "Number of instructions commuted to coalesce");
56 STATISTIC(NumAggrCommuted    , "Number of instructions aggressively commuted");
57 STATISTIC(NumConvertedTo3Addr, "Number of instructions promoted to 3-address");
58 STATISTIC(Num3AddrSunk,        "Number of 3-address instructions sunk");
59 STATISTIC(NumReSchedUps,       "Number of instructions re-scheduled up");
60 STATISTIC(NumReSchedDowns,     "Number of instructions re-scheduled down");
61
62 namespace {
63 class TwoAddressInstructionPass : public MachineFunctionPass {
64   MachineFunction *MF;
65   const TargetInstrInfo *TII;
66   const TargetRegisterInfo *TRI;
67   const InstrItineraryData *InstrItins;
68   MachineRegisterInfo *MRI;
69   LiveVariables *LV;
70   LiveIntervals *LIS;
71   AliasAnalysis *AA;
72   CodeGenOpt::Level OptLevel;
73
74   // The current basic block being processed.
75   MachineBasicBlock *MBB;
76
77   // DistanceMap - Keep track the distance of a MI from the start of the
78   // current basic block.
79   DenseMap<MachineInstr*, unsigned> DistanceMap;
80
81   // Set of already processed instructions in the current block.
82   SmallPtrSet<MachineInstr*, 8> Processed;
83
84   // SrcRegMap - A map from virtual registers to physical registers which are
85   // likely targets to be coalesced to due to copies from physical registers to
86   // virtual registers. e.g. v1024 = move r0.
87   DenseMap<unsigned, unsigned> SrcRegMap;
88
89   // DstRegMap - A map from virtual registers to physical registers which are
90   // likely targets to be coalesced to due to copies to physical registers from
91   // virtual registers. e.g. r1 = move v1024.
92   DenseMap<unsigned, unsigned> DstRegMap;
93
94   bool sink3AddrInstruction(MachineInstr *MI, unsigned Reg,
95                             MachineBasicBlock::iterator OldPos);
96
97   bool noUseAfterLastDef(unsigned Reg, unsigned Dist, unsigned &LastDef);
98
99   bool isProfitableToCommute(unsigned regA, unsigned regB, unsigned regC,
100                              MachineInstr *MI, unsigned Dist);
101
102   bool commuteInstruction(MachineBasicBlock::iterator &mi,
103                           unsigned RegB, unsigned RegC, unsigned Dist);
104
105   bool isProfitableToConv3Addr(unsigned RegA, unsigned RegB);
106
107   bool convertInstTo3Addr(MachineBasicBlock::iterator &mi,
108                           MachineBasicBlock::iterator &nmi,
109                           unsigned RegA, unsigned RegB, unsigned Dist);
110
111   bool isDefTooClose(unsigned Reg, unsigned Dist, MachineInstr *MI);
112
113   bool rescheduleMIBelowKill(MachineBasicBlock::iterator &mi,
114                              MachineBasicBlock::iterator &nmi,
115                              unsigned Reg);
116   bool rescheduleKillAboveMI(MachineBasicBlock::iterator &mi,
117                              MachineBasicBlock::iterator &nmi,
118                              unsigned Reg);
119
120   bool tryInstructionTransform(MachineBasicBlock::iterator &mi,
121                                MachineBasicBlock::iterator &nmi,
122                                unsigned SrcIdx, unsigned DstIdx,
123                                unsigned Dist);
124
125   void scanUses(unsigned DstReg);
126
127   void processCopy(MachineInstr *MI);
128
129   typedef SmallVector<std::pair<unsigned, unsigned>, 4> TiedPairList;
130   typedef SmallDenseMap<unsigned, TiedPairList> TiedOperandMap;
131   bool collectTiedOperands(MachineInstr *MI, TiedOperandMap&);
132   void processTiedPairs(MachineInstr *MI, TiedPairList&, unsigned &Dist);
133   void eliminateRegSequence(MachineBasicBlock::iterator&);
134
135 public:
136   static char ID; // Pass identification, replacement for typeid
137   TwoAddressInstructionPass() : MachineFunctionPass(ID) {
138     initializeTwoAddressInstructionPassPass(*PassRegistry::getPassRegistry());
139   }
140
141   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
142     AU.setPreservesCFG();
143     AU.addRequired<AliasAnalysis>();
144     AU.addPreserved<LiveVariables>();
145     AU.addPreserved<SlotIndexes>();
146     AU.addPreserved<LiveIntervals>();
147     AU.addPreservedID(MachineLoopInfoID);
148     AU.addPreservedID(MachineDominatorsID);
149     MachineFunctionPass::getAnalysisUsage(AU);
150   }
151
152   /// runOnMachineFunction - Pass entry point.
153   bool runOnMachineFunction(MachineFunction&);
154 };
155 } // end anonymous namespace
156
157 char TwoAddressInstructionPass::ID = 0;
158 INITIALIZE_PASS_BEGIN(TwoAddressInstructionPass, "twoaddressinstruction",
159                 "Two-Address instruction pass", false, false)
160 INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
161 INITIALIZE_PASS_END(TwoAddressInstructionPass, "twoaddressinstruction",
162                 "Two-Address instruction pass", false, false)
163
164 char &llvm::TwoAddressInstructionPassID = TwoAddressInstructionPass::ID;
165
166 static bool isPlainlyKilled(MachineInstr *MI, unsigned Reg, LiveIntervals *LIS);
167
168 /// sink3AddrInstruction - A two-address instruction has been converted to a
169 /// three-address instruction to avoid clobbering a register. Try to sink it
170 /// past the instruction that would kill the above mentioned register to reduce
171 /// register pressure.
172 bool TwoAddressInstructionPass::
173 sink3AddrInstruction(MachineInstr *MI, unsigned SavedReg,
174                      MachineBasicBlock::iterator OldPos) {
175   // FIXME: Shouldn't we be trying to do this before we three-addressify the
176   // instruction?  After this transformation is done, we no longer need
177   // the instruction to be in three-address form.
178
179   // Check if it's safe to move this instruction.
180   bool SeenStore = true; // Be conservative.
181   if (!MI->isSafeToMove(TII, AA, SeenStore))
182     return false;
183
184   unsigned DefReg = 0;
185   SmallSet<unsigned, 4> UseRegs;
186
187   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
188     const MachineOperand &MO = MI->getOperand(i);
189     if (!MO.isReg())
190       continue;
191     unsigned MOReg = MO.getReg();
192     if (!MOReg)
193       continue;
194     if (MO.isUse() && MOReg != SavedReg)
195       UseRegs.insert(MO.getReg());
196     if (!MO.isDef())
197       continue;
198     if (MO.isImplicit())
199       // Don't try to move it if it implicitly defines a register.
200       return false;
201     if (DefReg)
202       // For now, don't move any instructions that define multiple registers.
203       return false;
204     DefReg = MO.getReg();
205   }
206
207   // Find the instruction that kills SavedReg.
208   MachineInstr *KillMI = NULL;
209   if (LIS) {
210     LiveInterval &LI = LIS->getInterval(SavedReg);
211     assert(LI.end() != LI.begin() &&
212            "Reg should not have empty live interval.");
213
214     SlotIndex MBBEndIdx = LIS->getMBBEndIdx(MBB).getPrevSlot();
215     LiveInterval::const_iterator I = LI.find(MBBEndIdx);
216     if (I != LI.end() && I->start < MBBEndIdx)
217       return false;
218
219     --I;
220     KillMI = LIS->getInstructionFromIndex(I->end);
221   }
222   if (!KillMI) {
223     for (MachineRegisterInfo::use_nodbg_iterator
224            UI = MRI->use_nodbg_begin(SavedReg),
225            UE = MRI->use_nodbg_end(); UI != UE; ++UI) {
226       MachineOperand &UseMO = UI.getOperand();
227       if (!UseMO.isKill())
228         continue;
229       KillMI = UseMO.getParent();
230       break;
231     }
232   }
233
234   // If we find the instruction that kills SavedReg, and it is in an
235   // appropriate location, we can try to sink the current instruction
236   // past it.
237   if (!KillMI || KillMI->getParent() != MBB || KillMI == MI ||
238       KillMI == OldPos || KillMI->isTerminator())
239     return false;
240
241   // If any of the definitions are used by another instruction between the
242   // position and the kill use, then it's not safe to sink it.
243   //
244   // FIXME: This can be sped up if there is an easy way to query whether an
245   // instruction is before or after another instruction. Then we can use
246   // MachineRegisterInfo def / use instead.
247   MachineOperand *KillMO = NULL;
248   MachineBasicBlock::iterator KillPos = KillMI;
249   ++KillPos;
250
251   unsigned NumVisited = 0;
252   for (MachineBasicBlock::iterator I = llvm::next(OldPos); I != KillPos; ++I) {
253     MachineInstr *OtherMI = I;
254     // DBG_VALUE cannot be counted against the limit.
255     if (OtherMI->isDebugValue())
256       continue;
257     if (NumVisited > 30)  // FIXME: Arbitrary limit to reduce compile time cost.
258       return false;
259     ++NumVisited;
260     for (unsigned i = 0, e = OtherMI->getNumOperands(); i != e; ++i) {
261       MachineOperand &MO = OtherMI->getOperand(i);
262       if (!MO.isReg())
263         continue;
264       unsigned MOReg = MO.getReg();
265       if (!MOReg)
266         continue;
267       if (DefReg == MOReg)
268         return false;
269
270       if (MO.isKill() || (LIS && isPlainlyKilled(OtherMI, MOReg, LIS))) {
271         if (OtherMI == KillMI && MOReg == SavedReg)
272           // Save the operand that kills the register. We want to unset the kill
273           // marker if we can sink MI past it.
274           KillMO = &MO;
275         else if (UseRegs.count(MOReg))
276           // One of the uses is killed before the destination.
277           return false;
278       }
279     }
280   }
281   assert(KillMO && "Didn't find kill");
282
283   if (!LIS) {
284     // Update kill and LV information.
285     KillMO->setIsKill(false);
286     KillMO = MI->findRegisterUseOperand(SavedReg, false, TRI);
287     KillMO->setIsKill(true);
288
289     if (LV)
290       LV->replaceKillInstruction(SavedReg, KillMI, MI);
291   }
292
293   // Move instruction to its destination.
294   MBB->remove(MI);
295   MBB->insert(KillPos, MI);
296
297   if (LIS)
298     LIS->handleMove(MI);
299
300   ++Num3AddrSunk;
301   return true;
302 }
303
304 /// noUseAfterLastDef - Return true if there are no intervening uses between the
305 /// last instruction in the MBB that defines the specified register and the
306 /// two-address instruction which is being processed. It also returns the last
307 /// def location by reference
308 bool TwoAddressInstructionPass::noUseAfterLastDef(unsigned Reg, unsigned Dist,
309                                                   unsigned &LastDef) {
310   LastDef = 0;
311   unsigned LastUse = Dist;
312   for (MachineRegisterInfo::reg_iterator I = MRI->reg_begin(Reg),
313          E = MRI->reg_end(); I != E; ++I) {
314     MachineOperand &MO = I.getOperand();
315     MachineInstr *MI = MO.getParent();
316     if (MI->getParent() != MBB || MI->isDebugValue())
317       continue;
318     DenseMap<MachineInstr*, unsigned>::iterator DI = DistanceMap.find(MI);
319     if (DI == DistanceMap.end())
320       continue;
321     if (MO.isUse() && DI->second < LastUse)
322       LastUse = DI->second;
323     if (MO.isDef() && DI->second > LastDef)
324       LastDef = DI->second;
325   }
326
327   return !(LastUse > LastDef && LastUse < Dist);
328 }
329
330 /// isCopyToReg - Return true if the specified MI is a copy instruction or
331 /// a extract_subreg instruction. It also returns the source and destination
332 /// registers and whether they are physical registers by reference.
333 static bool isCopyToReg(MachineInstr &MI, const TargetInstrInfo *TII,
334                         unsigned &SrcReg, unsigned &DstReg,
335                         bool &IsSrcPhys, bool &IsDstPhys) {
336   SrcReg = 0;
337   DstReg = 0;
338   if (MI.isCopy()) {
339     DstReg = MI.getOperand(0).getReg();
340     SrcReg = MI.getOperand(1).getReg();
341   } else if (MI.isInsertSubreg() || MI.isSubregToReg()) {
342     DstReg = MI.getOperand(0).getReg();
343     SrcReg = MI.getOperand(2).getReg();
344   } else
345     return false;
346
347   IsSrcPhys = TargetRegisterInfo::isPhysicalRegister(SrcReg);
348   IsDstPhys = TargetRegisterInfo::isPhysicalRegister(DstReg);
349   return true;
350 }
351
352 /// isPLainlyKilled - Test if the given register value, which is used by the
353 // given instruction, is killed by the given instruction.
354 static bool isPlainlyKilled(MachineInstr *MI, unsigned Reg,
355                             LiveIntervals *LIS) {
356   if (LIS && TargetRegisterInfo::isVirtualRegister(Reg) &&
357       !LIS->isNotInMIMap(MI)) {
358     // FIXME: Sometimes tryInstructionTransform() will add instructions and
359     // test whether they can be folded before keeping them. In this case it
360     // sets a kill before recursively calling tryInstructionTransform() again.
361     // If there is no interval available, we assume that this instruction is
362     // one of those. A kill flag is manually inserted on the operand so the
363     // check below will handle it.
364     LiveInterval &LI = LIS->getInterval(Reg);
365     // This is to match the kill flag version where undefs don't have kill
366     // flags.
367     if (!LI.hasAtLeastOneValue())
368       return false;
369
370     SlotIndex useIdx = LIS->getInstructionIndex(MI);
371     LiveInterval::const_iterator I = LI.find(useIdx);
372     assert(I != LI.end() && "Reg must be live-in to use.");
373     return !I->end.isBlock() && SlotIndex::isSameInstr(I->end, useIdx);
374   }
375
376   return MI->killsRegister(Reg);
377 }
378
379 /// isKilled - Test if the given register value, which is used by the given
380 /// instruction, is killed by the given instruction. This looks through
381 /// coalescable copies to see if the original value is potentially not killed.
382 ///
383 /// For example, in this code:
384 ///
385 ///   %reg1034 = copy %reg1024
386 ///   %reg1035 = copy %reg1025<kill>
387 ///   %reg1036 = add %reg1034<kill>, %reg1035<kill>
388 ///
389 /// %reg1034 is not considered to be killed, since it is copied from a
390 /// register which is not killed. Treating it as not killed lets the
391 /// normal heuristics commute the (two-address) add, which lets
392 /// coalescing eliminate the extra copy.
393 ///
394 /// If allowFalsePositives is true then likely kills are treated as kills even
395 /// if it can't be proven that they are kills.
396 static bool isKilled(MachineInstr &MI, unsigned Reg,
397                      const MachineRegisterInfo *MRI,
398                      const TargetInstrInfo *TII,
399                      LiveIntervals *LIS,
400                      bool allowFalsePositives) {
401   MachineInstr *DefMI = &MI;
402   for (;;) {
403     // All uses of physical registers are likely to be kills.
404     if (TargetRegisterInfo::isPhysicalRegister(Reg) &&
405         (allowFalsePositives || MRI->hasOneUse(Reg)))
406       return true;
407     if (!isPlainlyKilled(DefMI, Reg, LIS))
408       return false;
409     if (TargetRegisterInfo::isPhysicalRegister(Reg))
410       return true;
411     MachineRegisterInfo::def_iterator Begin = MRI->def_begin(Reg);
412     // If there are multiple defs, we can't do a simple analysis, so just
413     // go with what the kill flag says.
414     if (llvm::next(Begin) != MRI->def_end())
415       return true;
416     DefMI = &*Begin;
417     bool IsSrcPhys, IsDstPhys;
418     unsigned SrcReg,  DstReg;
419     // If the def is something other than a copy, then it isn't going to
420     // be coalesced, so follow the kill flag.
421     if (!isCopyToReg(*DefMI, TII, SrcReg, DstReg, IsSrcPhys, IsDstPhys))
422       return true;
423     Reg = SrcReg;
424   }
425 }
426
427 /// isTwoAddrUse - Return true if the specified MI uses the specified register
428 /// as a two-address use. If so, return the destination register by reference.
429 static bool isTwoAddrUse(MachineInstr &MI, unsigned Reg, unsigned &DstReg) {
430   const MCInstrDesc &MCID = MI.getDesc();
431   unsigned NumOps = MI.isInlineAsm()
432     ? MI.getNumOperands() : MCID.getNumOperands();
433   for (unsigned i = 0; i != NumOps; ++i) {
434     const MachineOperand &MO = MI.getOperand(i);
435     if (!MO.isReg() || !MO.isUse() || MO.getReg() != Reg)
436       continue;
437     unsigned ti;
438     if (MI.isRegTiedToDefOperand(i, &ti)) {
439       DstReg = MI.getOperand(ti).getReg();
440       return true;
441     }
442   }
443   return false;
444 }
445
446 /// findOnlyInterestingUse - Given a register, if has a single in-basic block
447 /// use, return the use instruction if it's a copy or a two-address use.
448 static
449 MachineInstr *findOnlyInterestingUse(unsigned Reg, MachineBasicBlock *MBB,
450                                      MachineRegisterInfo *MRI,
451                                      const TargetInstrInfo *TII,
452                                      bool &IsCopy,
453                                      unsigned &DstReg, bool &IsDstPhys) {
454   if (!MRI->hasOneNonDBGUse(Reg))
455     // None or more than one use.
456     return 0;
457   MachineInstr &UseMI = *MRI->use_nodbg_begin(Reg);
458   if (UseMI.getParent() != MBB)
459     return 0;
460   unsigned SrcReg;
461   bool IsSrcPhys;
462   if (isCopyToReg(UseMI, TII, SrcReg, DstReg, IsSrcPhys, IsDstPhys)) {
463     IsCopy = true;
464     return &UseMI;
465   }
466   IsDstPhys = false;
467   if (isTwoAddrUse(UseMI, Reg, DstReg)) {
468     IsDstPhys = TargetRegisterInfo::isPhysicalRegister(DstReg);
469     return &UseMI;
470   }
471   return 0;
472 }
473
474 /// getMappedReg - Return the physical register the specified virtual register
475 /// might be mapped to.
476 static unsigned
477 getMappedReg(unsigned Reg, DenseMap<unsigned, unsigned> &RegMap) {
478   while (TargetRegisterInfo::isVirtualRegister(Reg))  {
479     DenseMap<unsigned, unsigned>::iterator SI = RegMap.find(Reg);
480     if (SI == RegMap.end())
481       return 0;
482     Reg = SI->second;
483   }
484   if (TargetRegisterInfo::isPhysicalRegister(Reg))
485     return Reg;
486   return 0;
487 }
488
489 /// regsAreCompatible - Return true if the two registers are equal or aliased.
490 ///
491 static bool
492 regsAreCompatible(unsigned RegA, unsigned RegB, const TargetRegisterInfo *TRI) {
493   if (RegA == RegB)
494     return true;
495   if (!RegA || !RegB)
496     return false;
497   return TRI->regsOverlap(RegA, RegB);
498 }
499
500
501 /// isProfitableToCommute - Return true if it's potentially profitable to commute
502 /// the two-address instruction that's being processed.
503 bool
504 TwoAddressInstructionPass::
505 isProfitableToCommute(unsigned regA, unsigned regB, unsigned regC,
506                       MachineInstr *MI, unsigned Dist) {
507   if (OptLevel == CodeGenOpt::None)
508     return false;
509
510   // Determine if it's profitable to commute this two address instruction. In
511   // general, we want no uses between this instruction and the definition of
512   // the two-address register.
513   // e.g.
514   // %reg1028<def> = EXTRACT_SUBREG %reg1027<kill>, 1
515   // %reg1029<def> = MOV8rr %reg1028
516   // %reg1029<def> = SHR8ri %reg1029, 7, %EFLAGS<imp-def,dead>
517   // insert => %reg1030<def> = MOV8rr %reg1028
518   // %reg1030<def> = ADD8rr %reg1028<kill>, %reg1029<kill>, %EFLAGS<imp-def,dead>
519   // In this case, it might not be possible to coalesce the second MOV8rr
520   // instruction if the first one is coalesced. So it would be profitable to
521   // commute it:
522   // %reg1028<def> = EXTRACT_SUBREG %reg1027<kill>, 1
523   // %reg1029<def> = MOV8rr %reg1028
524   // %reg1029<def> = SHR8ri %reg1029, 7, %EFLAGS<imp-def,dead>
525   // insert => %reg1030<def> = MOV8rr %reg1029
526   // %reg1030<def> = ADD8rr %reg1029<kill>, %reg1028<kill>, %EFLAGS<imp-def,dead>
527
528   if (!isPlainlyKilled(MI, regC, LIS))
529     return false;
530
531   // Ok, we have something like:
532   // %reg1030<def> = ADD8rr %reg1028<kill>, %reg1029<kill>, %EFLAGS<imp-def,dead>
533   // let's see if it's worth commuting it.
534
535   // Look for situations like this:
536   // %reg1024<def> = MOV r1
537   // %reg1025<def> = MOV r0
538   // %reg1026<def> = ADD %reg1024, %reg1025
539   // r0            = MOV %reg1026
540   // Commute the ADD to hopefully eliminate an otherwise unavoidable copy.
541   unsigned ToRegA = getMappedReg(regA, DstRegMap);
542   if (ToRegA) {
543     unsigned FromRegB = getMappedReg(regB, SrcRegMap);
544     unsigned FromRegC = getMappedReg(regC, SrcRegMap);
545     bool BComp = !FromRegB || regsAreCompatible(FromRegB, ToRegA, TRI);
546     bool CComp = !FromRegC || regsAreCompatible(FromRegC, ToRegA, TRI);
547     if (BComp != CComp)
548       return !BComp && CComp;
549   }
550
551   // If there is a use of regC between its last def (could be livein) and this
552   // instruction, then bail.
553   unsigned LastDefC = 0;
554   if (!noUseAfterLastDef(regC, Dist, LastDefC))
555     return false;
556
557   // If there is a use of regB between its last def (could be livein) and this
558   // instruction, then go ahead and make this transformation.
559   unsigned LastDefB = 0;
560   if (!noUseAfterLastDef(regB, Dist, LastDefB))
561     return true;
562
563   // Since there are no intervening uses for both registers, then commute
564   // if the def of regC is closer. Its live interval is shorter.
565   return LastDefB && LastDefC && LastDefC > LastDefB;
566 }
567
568 /// commuteInstruction - Commute a two-address instruction and update the basic
569 /// block, distance map, and live variables if needed. Return true if it is
570 /// successful.
571 bool TwoAddressInstructionPass::
572 commuteInstruction(MachineBasicBlock::iterator &mi,
573                    unsigned RegB, unsigned RegC, unsigned Dist) {
574   MachineInstr *MI = mi;
575   DEBUG(dbgs() << "2addr: COMMUTING  : " << *MI);
576   MachineInstr *NewMI = TII->commuteInstruction(MI);
577
578   if (NewMI == 0) {
579     DEBUG(dbgs() << "2addr: COMMUTING FAILED!\n");
580     return false;
581   }
582
583   DEBUG(dbgs() << "2addr: COMMUTED TO: " << *NewMI);
584   assert(NewMI == MI &&
585          "TargetInstrInfo::commuteInstruction() should not return a new "
586          "instruction unless it was requested.");
587
588   // Update source register map.
589   unsigned FromRegC = getMappedReg(RegC, SrcRegMap);
590   if (FromRegC) {
591     unsigned RegA = MI->getOperand(0).getReg();
592     SrcRegMap[RegA] = FromRegC;
593   }
594
595   return true;
596 }
597
598 /// isProfitableToConv3Addr - Return true if it is profitable to convert the
599 /// given 2-address instruction to a 3-address one.
600 bool
601 TwoAddressInstructionPass::isProfitableToConv3Addr(unsigned RegA,unsigned RegB){
602   // Look for situations like this:
603   // %reg1024<def> = MOV r1
604   // %reg1025<def> = MOV r0
605   // %reg1026<def> = ADD %reg1024, %reg1025
606   // r2            = MOV %reg1026
607   // Turn ADD into a 3-address instruction to avoid a copy.
608   unsigned FromRegB = getMappedReg(RegB, SrcRegMap);
609   if (!FromRegB)
610     return false;
611   unsigned ToRegA = getMappedReg(RegA, DstRegMap);
612   return (ToRegA && !regsAreCompatible(FromRegB, ToRegA, TRI));
613 }
614
615 /// convertInstTo3Addr - Convert the specified two-address instruction into a
616 /// three address one. Return true if this transformation was successful.
617 bool
618 TwoAddressInstructionPass::convertInstTo3Addr(MachineBasicBlock::iterator &mi,
619                                               MachineBasicBlock::iterator &nmi,
620                                               unsigned RegA, unsigned RegB,
621                                               unsigned Dist) {
622   // FIXME: Why does convertToThreeAddress() need an iterator reference?
623   MachineFunction::iterator MFI = MBB;
624   MachineInstr *NewMI = TII->convertToThreeAddress(MFI, mi, LV);
625   assert(MBB == MFI && "convertToThreeAddress changed iterator reference");
626   if (!NewMI)
627     return false;
628
629   DEBUG(dbgs() << "2addr: CONVERTING 2-ADDR: " << *mi);
630   DEBUG(dbgs() << "2addr:         TO 3-ADDR: " << *NewMI);
631   bool Sunk = false;
632
633   if (LIS)
634     LIS->ReplaceMachineInstrInMaps(mi, NewMI);
635
636   if (NewMI->findRegisterUseOperand(RegB, false, TRI))
637     // FIXME: Temporary workaround. If the new instruction doesn't
638     // uses RegB, convertToThreeAddress must have created more
639     // then one instruction.
640     Sunk = sink3AddrInstruction(NewMI, RegB, mi);
641
642   MBB->erase(mi); // Nuke the old inst.
643
644   if (!Sunk) {
645     DistanceMap.insert(std::make_pair(NewMI, Dist));
646     mi = NewMI;
647     nmi = llvm::next(mi);
648   }
649
650   // Update source and destination register maps.
651   SrcRegMap.erase(RegA);
652   DstRegMap.erase(RegB);
653   return true;
654 }
655
656 /// scanUses - Scan forward recursively for only uses, update maps if the use
657 /// is a copy or a two-address instruction.
658 void
659 TwoAddressInstructionPass::scanUses(unsigned DstReg) {
660   SmallVector<unsigned, 4> VirtRegPairs;
661   bool IsDstPhys;
662   bool IsCopy = false;
663   unsigned NewReg = 0;
664   unsigned Reg = DstReg;
665   while (MachineInstr *UseMI = findOnlyInterestingUse(Reg, MBB, MRI, TII,IsCopy,
666                                                       NewReg, IsDstPhys)) {
667     if (IsCopy && !Processed.insert(UseMI))
668       break;
669
670     DenseMap<MachineInstr*, unsigned>::iterator DI = DistanceMap.find(UseMI);
671     if (DI != DistanceMap.end())
672       // Earlier in the same MBB.Reached via a back edge.
673       break;
674
675     if (IsDstPhys) {
676       VirtRegPairs.push_back(NewReg);
677       break;
678     }
679     bool isNew = SrcRegMap.insert(std::make_pair(NewReg, Reg)).second;
680     if (!isNew)
681       assert(SrcRegMap[NewReg] == Reg && "Can't map to two src registers!");
682     VirtRegPairs.push_back(NewReg);
683     Reg = NewReg;
684   }
685
686   if (!VirtRegPairs.empty()) {
687     unsigned ToReg = VirtRegPairs.back();
688     VirtRegPairs.pop_back();
689     while (!VirtRegPairs.empty()) {
690       unsigned FromReg = VirtRegPairs.back();
691       VirtRegPairs.pop_back();
692       bool isNew = DstRegMap.insert(std::make_pair(FromReg, ToReg)).second;
693       if (!isNew)
694         assert(DstRegMap[FromReg] == ToReg &&"Can't map to two dst registers!");
695       ToReg = FromReg;
696     }
697     bool isNew = DstRegMap.insert(std::make_pair(DstReg, ToReg)).second;
698     if (!isNew)
699       assert(DstRegMap[DstReg] == ToReg && "Can't map to two dst registers!");
700   }
701 }
702
703 /// processCopy - If the specified instruction is not yet processed, process it
704 /// if it's a copy. For a copy instruction, we find the physical registers the
705 /// source and destination registers might be mapped to. These are kept in
706 /// point-to maps used to determine future optimizations. e.g.
707 /// v1024 = mov r0
708 /// v1025 = mov r1
709 /// v1026 = add v1024, v1025
710 /// r1    = mov r1026
711 /// If 'add' is a two-address instruction, v1024, v1026 are both potentially
712 /// coalesced to r0 (from the input side). v1025 is mapped to r1. v1026 is
713 /// potentially joined with r1 on the output side. It's worthwhile to commute
714 /// 'add' to eliminate a copy.
715 void TwoAddressInstructionPass::processCopy(MachineInstr *MI) {
716   if (Processed.count(MI))
717     return;
718
719   bool IsSrcPhys, IsDstPhys;
720   unsigned SrcReg, DstReg;
721   if (!isCopyToReg(*MI, TII, SrcReg, DstReg, IsSrcPhys, IsDstPhys))
722     return;
723
724   if (IsDstPhys && !IsSrcPhys)
725     DstRegMap.insert(std::make_pair(SrcReg, DstReg));
726   else if (!IsDstPhys && IsSrcPhys) {
727     bool isNew = SrcRegMap.insert(std::make_pair(DstReg, SrcReg)).second;
728     if (!isNew)
729       assert(SrcRegMap[DstReg] == SrcReg &&
730              "Can't map to two src physical registers!");
731
732     scanUses(DstReg);
733   }
734
735   Processed.insert(MI);
736   return;
737 }
738
739 /// rescheduleMIBelowKill - If there is one more local instruction that reads
740 /// 'Reg' and it kills 'Reg, consider moving the instruction below the kill
741 /// instruction in order to eliminate the need for the copy.
742 bool TwoAddressInstructionPass::
743 rescheduleMIBelowKill(MachineBasicBlock::iterator &mi,
744                       MachineBasicBlock::iterator &nmi,
745                       unsigned Reg) {
746   // Bail immediately if we don't have LV or LIS available. We use them to find
747   // kills efficiently.
748   if (!LV && !LIS)
749     return false;
750
751   MachineInstr *MI = &*mi;
752   DenseMap<MachineInstr*, unsigned>::iterator DI = DistanceMap.find(MI);
753   if (DI == DistanceMap.end())
754     // Must be created from unfolded load. Don't waste time trying this.
755     return false;
756
757   MachineInstr *KillMI = 0;
758   if (LIS) {
759     LiveInterval &LI = LIS->getInterval(Reg);
760     assert(LI.end() != LI.begin() &&
761            "Reg should not have empty live interval.");
762
763     SlotIndex MBBEndIdx = LIS->getMBBEndIdx(MBB).getPrevSlot();
764     LiveInterval::const_iterator I = LI.find(MBBEndIdx);
765     if (I != LI.end() && I->start < MBBEndIdx)
766       return false;
767
768     --I;
769     KillMI = LIS->getInstructionFromIndex(I->end);
770   } else {
771     KillMI = LV->getVarInfo(Reg).findKill(MBB);
772   }
773   if (!KillMI || MI == KillMI || KillMI->isCopy() || KillMI->isCopyLike())
774     // Don't mess with copies, they may be coalesced later.
775     return false;
776
777   if (KillMI->hasUnmodeledSideEffects() || KillMI->isCall() ||
778       KillMI->isBranch() || KillMI->isTerminator())
779     // Don't move pass calls, etc.
780     return false;
781
782   unsigned DstReg;
783   if (isTwoAddrUse(*KillMI, Reg, DstReg))
784     return false;
785
786   bool SeenStore = true;
787   if (!MI->isSafeToMove(TII, AA, SeenStore))
788     return false;
789
790   if (TII->getInstrLatency(InstrItins, MI) > 1)
791     // FIXME: Needs more sophisticated heuristics.
792     return false;
793
794   SmallSet<unsigned, 2> Uses;
795   SmallSet<unsigned, 2> Kills;
796   SmallSet<unsigned, 2> Defs;
797   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
798     const MachineOperand &MO = MI->getOperand(i);
799     if (!MO.isReg())
800       continue;
801     unsigned MOReg = MO.getReg();
802     if (!MOReg)
803       continue;
804     if (MO.isDef())
805       Defs.insert(MOReg);
806     else {
807       Uses.insert(MOReg);
808       if (MOReg != Reg && (MO.isKill() ||
809                            (LIS && isPlainlyKilled(MI, MOReg, LIS))))
810         Kills.insert(MOReg);
811     }
812   }
813
814   // Move the copies connected to MI down as well.
815   MachineBasicBlock::iterator Begin = MI;
816   MachineBasicBlock::iterator AfterMI = llvm::next(Begin);
817
818   MachineBasicBlock::iterator End = AfterMI;
819   while (End->isCopy() && Defs.count(End->getOperand(1).getReg())) {
820     Defs.insert(End->getOperand(0).getReg());
821     ++End;
822   }
823
824   // Check if the reschedule will not break depedencies.
825   unsigned NumVisited = 0;
826   MachineBasicBlock::iterator KillPos = KillMI;
827   ++KillPos;
828   for (MachineBasicBlock::iterator I = End; I != KillPos; ++I) {
829     MachineInstr *OtherMI = I;
830     // DBG_VALUE cannot be counted against the limit.
831     if (OtherMI->isDebugValue())
832       continue;
833     if (NumVisited > 10)  // FIXME: Arbitrary limit to reduce compile time cost.
834       return false;
835     ++NumVisited;
836     if (OtherMI->hasUnmodeledSideEffects() || OtherMI->isCall() ||
837         OtherMI->isBranch() || OtherMI->isTerminator())
838       // Don't move pass calls, etc.
839       return false;
840     for (unsigned i = 0, e = OtherMI->getNumOperands(); i != e; ++i) {
841       const MachineOperand &MO = OtherMI->getOperand(i);
842       if (!MO.isReg())
843         continue;
844       unsigned MOReg = MO.getReg();
845       if (!MOReg)
846         continue;
847       if (MO.isDef()) {
848         if (Uses.count(MOReg))
849           // Physical register use would be clobbered.
850           return false;
851         if (!MO.isDead() && Defs.count(MOReg))
852           // May clobber a physical register def.
853           // FIXME: This may be too conservative. It's ok if the instruction
854           // is sunken completely below the use.
855           return false;
856       } else {
857         if (Defs.count(MOReg))
858           return false;
859         bool isKill = MO.isKill() ||
860                       (LIS && isPlainlyKilled(OtherMI, MOReg, LIS));
861         if (MOReg != Reg &&
862             ((isKill && Uses.count(MOReg)) || Kills.count(MOReg)))
863           // Don't want to extend other live ranges and update kills.
864           return false;
865         if (MOReg == Reg && !isKill)
866           // We can't schedule across a use of the register in question.
867           return false;
868         // Ensure that if this is register in question, its the kill we expect.
869         assert((MOReg != Reg || OtherMI == KillMI) &&
870                "Found multiple kills of a register in a basic block");
871       }
872     }
873   }
874
875   // Move debug info as well.
876   while (Begin != MBB->begin() && llvm::prior(Begin)->isDebugValue())
877     --Begin;
878
879   nmi = End;
880   MachineBasicBlock::iterator InsertPos = KillPos;
881   if (LIS) {
882     // We have to move the copies first so that the MBB is still well-formed
883     // when calling handleMove().
884     for (MachineBasicBlock::iterator MBBI = AfterMI; MBBI != End;) {
885       MachineInstr *CopyMI = MBBI;
886       ++MBBI;
887       MBB->splice(InsertPos, MBB, CopyMI);
888       LIS->handleMove(CopyMI);
889       InsertPos = CopyMI;
890     }
891     End = llvm::next(MachineBasicBlock::iterator(MI));
892   }
893
894   // Copies following MI may have been moved as well.
895   MBB->splice(InsertPos, MBB, Begin, End);
896   DistanceMap.erase(DI);
897
898   // Update live variables
899   if (LIS) {
900     LIS->handleMove(MI);
901   } else {
902     LV->removeVirtualRegisterKilled(Reg, KillMI);
903     LV->addVirtualRegisterKilled(Reg, MI);
904   }
905
906   DEBUG(dbgs() << "\trescheduled below kill: " << *KillMI);
907   return true;
908 }
909
910 /// isDefTooClose - Return true if the re-scheduling will put the given
911 /// instruction too close to the defs of its register dependencies.
912 bool TwoAddressInstructionPass::isDefTooClose(unsigned Reg, unsigned Dist,
913                                               MachineInstr *MI) {
914   for (MachineRegisterInfo::def_iterator DI = MRI->def_begin(Reg),
915          DE = MRI->def_end(); DI != DE; ++DI) {
916     MachineInstr *DefMI = &*DI;
917     if (DefMI->getParent() != MBB || DefMI->isCopy() || DefMI->isCopyLike())
918       continue;
919     if (DefMI == MI)
920       return true; // MI is defining something KillMI uses
921     DenseMap<MachineInstr*, unsigned>::iterator DDI = DistanceMap.find(DefMI);
922     if (DDI == DistanceMap.end())
923       return true;  // Below MI
924     unsigned DefDist = DDI->second;
925     assert(Dist > DefDist && "Visited def already?");
926     if (TII->getInstrLatency(InstrItins, DefMI) > (Dist - DefDist))
927       return true;
928   }
929   return false;
930 }
931
932 /// rescheduleKillAboveMI - If there is one more local instruction that reads
933 /// 'Reg' and it kills 'Reg, consider moving the kill instruction above the
934 /// current two-address instruction in order to eliminate the need for the
935 /// copy.
936 bool TwoAddressInstructionPass::
937 rescheduleKillAboveMI(MachineBasicBlock::iterator &mi,
938                       MachineBasicBlock::iterator &nmi,
939                       unsigned Reg) {
940   // Bail immediately if we don't have LV or LIS available. We use them to find
941   // kills efficiently.
942   if (!LV && !LIS)
943     return false;
944
945   MachineInstr *MI = &*mi;
946   DenseMap<MachineInstr*, unsigned>::iterator DI = DistanceMap.find(MI);
947   if (DI == DistanceMap.end())
948     // Must be created from unfolded load. Don't waste time trying this.
949     return false;
950
951   MachineInstr *KillMI = 0;
952   if (LIS) {
953     LiveInterval &LI = LIS->getInterval(Reg);
954     assert(LI.end() != LI.begin() &&
955            "Reg should not have empty live interval.");
956
957     SlotIndex MBBEndIdx = LIS->getMBBEndIdx(MBB).getPrevSlot();
958     LiveInterval::const_iterator I = LI.find(MBBEndIdx);
959     if (I != LI.end() && I->start < MBBEndIdx)
960       return false;
961
962     --I;
963     KillMI = LIS->getInstructionFromIndex(I->end);
964   } else {
965     KillMI = LV->getVarInfo(Reg).findKill(MBB);
966   }
967   if (!KillMI || MI == KillMI || KillMI->isCopy() || KillMI->isCopyLike())
968     // Don't mess with copies, they may be coalesced later.
969     return false;
970
971   unsigned DstReg;
972   if (isTwoAddrUse(*KillMI, Reg, DstReg))
973     return false;
974
975   bool SeenStore = true;
976   if (!KillMI->isSafeToMove(TII, AA, SeenStore))
977     return false;
978
979   SmallSet<unsigned, 2> Uses;
980   SmallSet<unsigned, 2> Kills;
981   SmallSet<unsigned, 2> Defs;
982   SmallSet<unsigned, 2> LiveDefs;
983   for (unsigned i = 0, e = KillMI->getNumOperands(); i != e; ++i) {
984     const MachineOperand &MO = KillMI->getOperand(i);
985     if (!MO.isReg())
986       continue;
987     unsigned MOReg = MO.getReg();
988     if (MO.isUse()) {
989       if (!MOReg)
990         continue;
991       if (isDefTooClose(MOReg, DI->second, MI))
992         return false;
993       bool isKill = MO.isKill() || (LIS && isPlainlyKilled(KillMI, MOReg, LIS));
994       if (MOReg == Reg && !isKill)
995         return false;
996       Uses.insert(MOReg);
997       if (isKill && MOReg != Reg)
998         Kills.insert(MOReg);
999     } else if (TargetRegisterInfo::isPhysicalRegister(MOReg)) {
1000       Defs.insert(MOReg);
1001       if (!MO.isDead())
1002         LiveDefs.insert(MOReg);
1003     }
1004   }
1005
1006   // Check if the reschedule will not break depedencies.
1007   unsigned NumVisited = 0;
1008   MachineBasicBlock::iterator KillPos = KillMI;
1009   for (MachineBasicBlock::iterator I = mi; I != KillPos; ++I) {
1010     MachineInstr *OtherMI = I;
1011     // DBG_VALUE cannot be counted against the limit.
1012     if (OtherMI->isDebugValue())
1013       continue;
1014     if (NumVisited > 10)  // FIXME: Arbitrary limit to reduce compile time cost.
1015       return false;
1016     ++NumVisited;
1017     if (OtherMI->hasUnmodeledSideEffects() || OtherMI->isCall() ||
1018         OtherMI->isBranch() || OtherMI->isTerminator())
1019       // Don't move pass calls, etc.
1020       return false;
1021     SmallVector<unsigned, 2> OtherDefs;
1022     for (unsigned i = 0, e = OtherMI->getNumOperands(); i != e; ++i) {
1023       const MachineOperand &MO = OtherMI->getOperand(i);
1024       if (!MO.isReg())
1025         continue;
1026       unsigned MOReg = MO.getReg();
1027       if (!MOReg)
1028         continue;
1029       if (MO.isUse()) {
1030         if (Defs.count(MOReg))
1031           // Moving KillMI can clobber the physical register if the def has
1032           // not been seen.
1033           return false;
1034         if (Kills.count(MOReg))
1035           // Don't want to extend other live ranges and update kills.
1036           return false;
1037         if (OtherMI != MI && MOReg == Reg &&
1038             !(MO.isKill() || (LIS && isPlainlyKilled(OtherMI, MOReg, LIS))))
1039           // We can't schedule across a use of the register in question.
1040           return false;
1041       } else {
1042         OtherDefs.push_back(MOReg);
1043       }
1044     }
1045
1046     for (unsigned i = 0, e = OtherDefs.size(); i != e; ++i) {
1047       unsigned MOReg = OtherDefs[i];
1048       if (Uses.count(MOReg))
1049         return false;
1050       if (TargetRegisterInfo::isPhysicalRegister(MOReg) &&
1051           LiveDefs.count(MOReg))
1052         return false;
1053       // Physical register def is seen.
1054       Defs.erase(MOReg);
1055     }
1056   }
1057
1058   // Move the old kill above MI, don't forget to move debug info as well.
1059   MachineBasicBlock::iterator InsertPos = mi;
1060   while (InsertPos != MBB->begin() && llvm::prior(InsertPos)->isDebugValue())
1061     --InsertPos;
1062   MachineBasicBlock::iterator From = KillMI;
1063   MachineBasicBlock::iterator To = llvm::next(From);
1064   while (llvm::prior(From)->isDebugValue())
1065     --From;
1066   MBB->splice(InsertPos, MBB, From, To);
1067
1068   nmi = llvm::prior(InsertPos); // Backtrack so we process the moved instr.
1069   DistanceMap.erase(DI);
1070
1071   // Update live variables
1072   if (LIS) {
1073     LIS->handleMove(KillMI);
1074   } else {
1075     LV->removeVirtualRegisterKilled(Reg, KillMI);
1076     LV->addVirtualRegisterKilled(Reg, MI);
1077   }
1078
1079   DEBUG(dbgs() << "\trescheduled kill: " << *KillMI);
1080   return true;
1081 }
1082
1083 /// tryInstructionTransform - For the case where an instruction has a single
1084 /// pair of tied register operands, attempt some transformations that may
1085 /// either eliminate the tied operands or improve the opportunities for
1086 /// coalescing away the register copy.  Returns true if no copy needs to be
1087 /// inserted to untie mi's operands (either because they were untied, or
1088 /// because mi was rescheduled, and will be visited again later).
1089 bool TwoAddressInstructionPass::
1090 tryInstructionTransform(MachineBasicBlock::iterator &mi,
1091                         MachineBasicBlock::iterator &nmi,
1092                         unsigned SrcIdx, unsigned DstIdx, unsigned Dist) {
1093   if (OptLevel == CodeGenOpt::None)
1094     return false;
1095
1096   MachineInstr &MI = *mi;
1097   unsigned regA = MI.getOperand(DstIdx).getReg();
1098   unsigned regB = MI.getOperand(SrcIdx).getReg();
1099
1100   assert(TargetRegisterInfo::isVirtualRegister(regB) &&
1101          "cannot make instruction into two-address form");
1102   bool regBKilled = isKilled(MI, regB, MRI, TII, LIS, true);
1103
1104   if (TargetRegisterInfo::isVirtualRegister(regA))
1105     scanUses(regA);
1106
1107   // Check if it is profitable to commute the operands.
1108   unsigned SrcOp1, SrcOp2;
1109   unsigned regC = 0;
1110   unsigned regCIdx = ~0U;
1111   bool TryCommute = false;
1112   bool AggressiveCommute = false;
1113   if (MI.isCommutable() && MI.getNumOperands() >= 3 &&
1114       TII->findCommutedOpIndices(&MI, SrcOp1, SrcOp2)) {
1115     if (SrcIdx == SrcOp1)
1116       regCIdx = SrcOp2;
1117     else if (SrcIdx == SrcOp2)
1118       regCIdx = SrcOp1;
1119
1120     if (regCIdx != ~0U) {
1121       regC = MI.getOperand(regCIdx).getReg();
1122       if (!regBKilled && isKilled(MI, regC, MRI, TII, LIS, false))
1123         // If C dies but B does not, swap the B and C operands.
1124         // This makes the live ranges of A and C joinable.
1125         TryCommute = true;
1126       else if (isProfitableToCommute(regA, regB, regC, &MI, Dist)) {
1127         TryCommute = true;
1128         AggressiveCommute = true;
1129       }
1130     }
1131   }
1132
1133   // If it's profitable to commute, try to do so.
1134   if (TryCommute && commuteInstruction(mi, regB, regC, Dist)) {
1135     ++NumCommuted;
1136     if (AggressiveCommute)
1137       ++NumAggrCommuted;
1138     return false;
1139   }
1140
1141   // If there is one more use of regB later in the same MBB, consider
1142   // re-schedule this MI below it.
1143   if (rescheduleMIBelowKill(mi, nmi, regB)) {
1144     ++NumReSchedDowns;
1145     return true;
1146   }
1147
1148   if (MI.isConvertibleTo3Addr()) {
1149     // This instruction is potentially convertible to a true
1150     // three-address instruction.  Check if it is profitable.
1151     if (!regBKilled || isProfitableToConv3Addr(regA, regB)) {
1152       // Try to convert it.
1153       if (convertInstTo3Addr(mi, nmi, regA, regB, Dist)) {
1154         ++NumConvertedTo3Addr;
1155         return true; // Done with this instruction.
1156       }
1157     }
1158   }
1159
1160   // If there is one more use of regB later in the same MBB, consider
1161   // re-schedule it before this MI if it's legal.
1162   if (rescheduleKillAboveMI(mi, nmi, regB)) {
1163     ++NumReSchedUps;
1164     return true;
1165   }
1166
1167   // If this is an instruction with a load folded into it, try unfolding
1168   // the load, e.g. avoid this:
1169   //   movq %rdx, %rcx
1170   //   addq (%rax), %rcx
1171   // in favor of this:
1172   //   movq (%rax), %rcx
1173   //   addq %rdx, %rcx
1174   // because it's preferable to schedule a load than a register copy.
1175   if (MI.mayLoad() && !regBKilled) {
1176     // Determine if a load can be unfolded.
1177     unsigned LoadRegIndex;
1178     unsigned NewOpc =
1179       TII->getOpcodeAfterMemoryUnfold(MI.getOpcode(),
1180                                       /*UnfoldLoad=*/true,
1181                                       /*UnfoldStore=*/false,
1182                                       &LoadRegIndex);
1183     if (NewOpc != 0) {
1184       const MCInstrDesc &UnfoldMCID = TII->get(NewOpc);
1185       if (UnfoldMCID.getNumDefs() == 1) {
1186         // Unfold the load.
1187         DEBUG(dbgs() << "2addr:   UNFOLDING: " << MI);
1188         const TargetRegisterClass *RC =
1189           TRI->getAllocatableClass(
1190             TII->getRegClass(UnfoldMCID, LoadRegIndex, TRI, *MF));
1191         unsigned Reg = MRI->createVirtualRegister(RC);
1192         SmallVector<MachineInstr *, 2> NewMIs;
1193         if (!TII->unfoldMemoryOperand(*MF, &MI, Reg,
1194                                       /*UnfoldLoad=*/true,/*UnfoldStore=*/false,
1195                                       NewMIs)) {
1196           DEBUG(dbgs() << "2addr: ABANDONING UNFOLD\n");
1197           return false;
1198         }
1199         assert(NewMIs.size() == 2 &&
1200                "Unfolded a load into multiple instructions!");
1201         // The load was previously folded, so this is the only use.
1202         NewMIs[1]->addRegisterKilled(Reg, TRI);
1203
1204         // Tentatively insert the instructions into the block so that they
1205         // look "normal" to the transformation logic.
1206         MBB->insert(mi, NewMIs[0]);
1207         MBB->insert(mi, NewMIs[1]);
1208
1209         DEBUG(dbgs() << "2addr:    NEW LOAD: " << *NewMIs[0]
1210                      << "2addr:    NEW INST: " << *NewMIs[1]);
1211
1212         // Transform the instruction, now that it no longer has a load.
1213         unsigned NewDstIdx = NewMIs[1]->findRegisterDefOperandIdx(regA);
1214         unsigned NewSrcIdx = NewMIs[1]->findRegisterUseOperandIdx(regB);
1215         MachineBasicBlock::iterator NewMI = NewMIs[1];
1216         bool TransformSuccess =
1217           tryInstructionTransform(NewMI, mi, NewSrcIdx, NewDstIdx, Dist);
1218         if (TransformSuccess ||
1219             NewMIs[1]->getOperand(NewSrcIdx).isKill()) {
1220           // Success, or at least we made an improvement. Keep the unfolded
1221           // instructions and discard the original.
1222           if (LV) {
1223             for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
1224               MachineOperand &MO = MI.getOperand(i);
1225               if (MO.isReg() &&
1226                   TargetRegisterInfo::isVirtualRegister(MO.getReg())) {
1227                 if (MO.isUse()) {
1228                   if (MO.isKill()) {
1229                     if (NewMIs[0]->killsRegister(MO.getReg()))
1230                       LV->replaceKillInstruction(MO.getReg(), &MI, NewMIs[0]);
1231                     else {
1232                       assert(NewMIs[1]->killsRegister(MO.getReg()) &&
1233                              "Kill missing after load unfold!");
1234                       LV->replaceKillInstruction(MO.getReg(), &MI, NewMIs[1]);
1235                     }
1236                   }
1237                 } else if (LV->removeVirtualRegisterDead(MO.getReg(), &MI)) {
1238                   if (NewMIs[1]->registerDefIsDead(MO.getReg()))
1239                     LV->addVirtualRegisterDead(MO.getReg(), NewMIs[1]);
1240                   else {
1241                     assert(NewMIs[0]->registerDefIsDead(MO.getReg()) &&
1242                            "Dead flag missing after load unfold!");
1243                     LV->addVirtualRegisterDead(MO.getReg(), NewMIs[0]);
1244                   }
1245                 }
1246               }
1247             }
1248             LV->addVirtualRegisterKilled(Reg, NewMIs[1]);
1249           }
1250
1251           SmallVector<unsigned, 4> OrigRegs;
1252           if (LIS) {
1253             for (MachineInstr::const_mop_iterator MOI = MI.operands_begin(),
1254                  MOE = MI.operands_end(); MOI != MOE; ++MOI) {
1255               if (MOI->isReg())
1256                 OrigRegs.push_back(MOI->getReg());
1257             }
1258           }
1259
1260           MI.eraseFromParent();
1261
1262           // Update LiveIntervals.
1263           if (LIS) {
1264             MachineBasicBlock::iterator Begin(NewMIs[0]);
1265             MachineBasicBlock::iterator End(NewMIs[1]);
1266             LIS->repairIntervalsInRange(MBB, Begin, End, OrigRegs);
1267           }
1268
1269           mi = NewMIs[1];
1270           if (TransformSuccess)
1271             return true;
1272         } else {
1273           // Transforming didn't eliminate the tie and didn't lead to an
1274           // improvement. Clean up the unfolded instructions and keep the
1275           // original.
1276           DEBUG(dbgs() << "2addr: ABANDONING UNFOLD\n");
1277           NewMIs[0]->eraseFromParent();
1278           NewMIs[1]->eraseFromParent();
1279         }
1280       }
1281     }
1282   }
1283
1284   return false;
1285 }
1286
1287 // Collect tied operands of MI that need to be handled.
1288 // Rewrite trivial cases immediately.
1289 // Return true if any tied operands where found, including the trivial ones.
1290 bool TwoAddressInstructionPass::
1291 collectTiedOperands(MachineInstr *MI, TiedOperandMap &TiedOperands) {
1292   const MCInstrDesc &MCID = MI->getDesc();
1293   bool AnyOps = false;
1294   unsigned NumOps = MI->getNumOperands();
1295
1296   for (unsigned SrcIdx = 0; SrcIdx < NumOps; ++SrcIdx) {
1297     unsigned DstIdx = 0;
1298     if (!MI->isRegTiedToDefOperand(SrcIdx, &DstIdx))
1299       continue;
1300     AnyOps = true;
1301     MachineOperand &SrcMO = MI->getOperand(SrcIdx);
1302     MachineOperand &DstMO = MI->getOperand(DstIdx);
1303     unsigned SrcReg = SrcMO.getReg();
1304     unsigned DstReg = DstMO.getReg();
1305     // Tied constraint already satisfied?
1306     if (SrcReg == DstReg)
1307       continue;
1308
1309     assert(SrcReg && SrcMO.isUse() && "two address instruction invalid");
1310
1311     // Deal with <undef> uses immediately - simply rewrite the src operand.
1312     if (SrcMO.isUndef()) {
1313       // Constrain the DstReg register class if required.
1314       if (TargetRegisterInfo::isVirtualRegister(DstReg))
1315         if (const TargetRegisterClass *RC = TII->getRegClass(MCID, SrcIdx,
1316                                                              TRI, *MF))
1317           MRI->constrainRegClass(DstReg, RC);
1318       SrcMO.setReg(DstReg);
1319       DEBUG(dbgs() << "\t\trewrite undef:\t" << *MI);
1320       continue;
1321     }
1322     TiedOperands[SrcReg].push_back(std::make_pair(SrcIdx, DstIdx));
1323   }
1324   return AnyOps;
1325 }
1326
1327 // Process a list of tied MI operands that all use the same source register.
1328 // The tied pairs are of the form (SrcIdx, DstIdx).
1329 void
1330 TwoAddressInstructionPass::processTiedPairs(MachineInstr *MI,
1331                                             TiedPairList &TiedPairs,
1332                                             unsigned &Dist) {
1333   bool IsEarlyClobber = false;
1334   for (unsigned tpi = 0, tpe = TiedPairs.size(); tpi != tpe; ++tpi) {
1335     const MachineOperand &DstMO = MI->getOperand(TiedPairs[tpi].second);
1336     IsEarlyClobber |= DstMO.isEarlyClobber();
1337   }
1338
1339   bool RemovedKillFlag = false;
1340   bool AllUsesCopied = true;
1341   unsigned LastCopiedReg = 0;
1342   SlotIndex LastCopyIdx;
1343   unsigned RegB = 0;
1344   for (unsigned tpi = 0, tpe = TiedPairs.size(); tpi != tpe; ++tpi) {
1345     unsigned SrcIdx = TiedPairs[tpi].first;
1346     unsigned DstIdx = TiedPairs[tpi].second;
1347
1348     const MachineOperand &DstMO = MI->getOperand(DstIdx);
1349     unsigned RegA = DstMO.getReg();
1350
1351     // Grab RegB from the instruction because it may have changed if the
1352     // instruction was commuted.
1353     RegB = MI->getOperand(SrcIdx).getReg();
1354
1355     if (RegA == RegB) {
1356       // The register is tied to multiple destinations (or else we would
1357       // not have continued this far), but this use of the register
1358       // already matches the tied destination.  Leave it.
1359       AllUsesCopied = false;
1360       continue;
1361     }
1362     LastCopiedReg = RegA;
1363
1364     assert(TargetRegisterInfo::isVirtualRegister(RegB) &&
1365            "cannot make instruction into two-address form");
1366
1367 #ifndef NDEBUG
1368     // First, verify that we don't have a use of "a" in the instruction
1369     // (a = b + a for example) because our transformation will not
1370     // work. This should never occur because we are in SSA form.
1371     for (unsigned i = 0; i != MI->getNumOperands(); ++i)
1372       assert(i == DstIdx ||
1373              !MI->getOperand(i).isReg() ||
1374              MI->getOperand(i).getReg() != RegA);
1375 #endif
1376
1377     // Emit a copy.
1378     BuildMI(*MI->getParent(), MI, MI->getDebugLoc(),
1379             TII->get(TargetOpcode::COPY), RegA).addReg(RegB);
1380
1381     // Update DistanceMap.
1382     MachineBasicBlock::iterator PrevMI = MI;
1383     --PrevMI;
1384     DistanceMap.insert(std::make_pair(PrevMI, Dist));
1385     DistanceMap[MI] = ++Dist;
1386
1387     if (LIS) {
1388       LastCopyIdx = LIS->InsertMachineInstrInMaps(PrevMI).getRegSlot();
1389
1390       if (TargetRegisterInfo::isVirtualRegister(RegA)) {
1391         LiveInterval &LI = LIS->getInterval(RegA);
1392         VNInfo *VNI = LI.getNextValue(LastCopyIdx, LIS->getVNInfoAllocator());
1393         SlotIndex endIdx =
1394           LIS->getInstructionIndex(MI).getRegSlot(IsEarlyClobber);
1395         LI.addRange(LiveRange(LastCopyIdx, endIdx, VNI));
1396       }
1397     }
1398
1399     DEBUG(dbgs() << "\t\tprepend:\t" << *PrevMI);
1400
1401     MachineOperand &MO = MI->getOperand(SrcIdx);
1402     assert(MO.isReg() && MO.getReg() == RegB && MO.isUse() &&
1403            "inconsistent operand info for 2-reg pass");
1404     if (MO.isKill()) {
1405       MO.setIsKill(false);
1406       RemovedKillFlag = true;
1407     }
1408
1409     // Make sure regA is a legal regclass for the SrcIdx operand.
1410     if (TargetRegisterInfo::isVirtualRegister(RegA) &&
1411         TargetRegisterInfo::isVirtualRegister(RegB))
1412       MRI->constrainRegClass(RegA, MRI->getRegClass(RegB));
1413
1414     MO.setReg(RegA);
1415
1416     // Propagate SrcRegMap.
1417     SrcRegMap[RegA] = RegB;
1418   }
1419
1420
1421   if (AllUsesCopied) {
1422     if (!IsEarlyClobber) {
1423       // Replace other (un-tied) uses of regB with LastCopiedReg.
1424       for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
1425         MachineOperand &MO = MI->getOperand(i);
1426         if (MO.isReg() && MO.getReg() == RegB && MO.isUse()) {
1427           if (MO.isKill()) {
1428             MO.setIsKill(false);
1429             RemovedKillFlag = true;
1430           }
1431           MO.setReg(LastCopiedReg);
1432         }
1433       }
1434     }
1435
1436     // Update live variables for regB.
1437     if (RemovedKillFlag && LV && LV->getVarInfo(RegB).removeKill(MI)) {
1438       MachineBasicBlock::iterator PrevMI = MI;
1439       --PrevMI;
1440       LV->addVirtualRegisterKilled(RegB, PrevMI);
1441     }
1442
1443     // Update LiveIntervals.
1444     if (LIS) {
1445       LiveInterval &LI = LIS->getInterval(RegB);
1446       SlotIndex MIIdx = LIS->getInstructionIndex(MI);
1447       LiveInterval::const_iterator I = LI.find(MIIdx);
1448       assert(I != LI.end() && "RegB must be live-in to use.");
1449
1450       SlotIndex UseIdx = MIIdx.getRegSlot(IsEarlyClobber);
1451       if (I->end == UseIdx)
1452         LI.removeRange(LastCopyIdx, UseIdx);
1453     }
1454
1455   } else if (RemovedKillFlag) {
1456     // Some tied uses of regB matched their destination registers, so
1457     // regB is still used in this instruction, but a kill flag was
1458     // removed from a different tied use of regB, so now we need to add
1459     // a kill flag to one of the remaining uses of regB.
1460     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
1461       MachineOperand &MO = MI->getOperand(i);
1462       if (MO.isReg() && MO.getReg() == RegB && MO.isUse()) {
1463         MO.setIsKill(true);
1464         break;
1465       }
1466     }
1467   }
1468 }
1469
1470 /// runOnMachineFunction - Reduce two-address instructions to two operands.
1471 ///
1472 bool TwoAddressInstructionPass::runOnMachineFunction(MachineFunction &Func) {
1473   MF = &Func;
1474   const TargetMachine &TM = MF->getTarget();
1475   MRI = &MF->getRegInfo();
1476   TII = TM.getInstrInfo();
1477   TRI = TM.getRegisterInfo();
1478   InstrItins = TM.getInstrItineraryData();
1479   LV = getAnalysisIfAvailable<LiveVariables>();
1480   LIS = getAnalysisIfAvailable<LiveIntervals>();
1481   AA = &getAnalysis<AliasAnalysis>();
1482   OptLevel = TM.getOptLevel();
1483
1484   bool MadeChange = false;
1485
1486   DEBUG(dbgs() << "********** REWRITING TWO-ADDR INSTRS **********\n");
1487   DEBUG(dbgs() << "********** Function: "
1488         << MF->getName() << '\n');
1489
1490   // This pass takes the function out of SSA form.
1491   MRI->leaveSSA();
1492
1493   TiedOperandMap TiedOperands;
1494   for (MachineFunction::iterator MBBI = MF->begin(), MBBE = MF->end();
1495        MBBI != MBBE; ++MBBI) {
1496     MBB = MBBI;
1497     unsigned Dist = 0;
1498     DistanceMap.clear();
1499     SrcRegMap.clear();
1500     DstRegMap.clear();
1501     Processed.clear();
1502     for (MachineBasicBlock::iterator mi = MBB->begin(), me = MBB->end();
1503          mi != me; ) {
1504       MachineBasicBlock::iterator nmi = llvm::next(mi);
1505       if (mi->isDebugValue()) {
1506         mi = nmi;
1507         continue;
1508       }
1509
1510       // Expand REG_SEQUENCE instructions. This will position mi at the first
1511       // expanded instruction.
1512       if (mi->isRegSequence())
1513         eliminateRegSequence(mi);
1514
1515       DistanceMap.insert(std::make_pair(mi, ++Dist));
1516
1517       processCopy(&*mi);
1518
1519       // First scan through all the tied register uses in this instruction
1520       // and record a list of pairs of tied operands for each register.
1521       if (!collectTiedOperands(mi, TiedOperands)) {
1522         mi = nmi;
1523         continue;
1524       }
1525
1526       ++NumTwoAddressInstrs;
1527       MadeChange = true;
1528       DEBUG(dbgs() << '\t' << *mi);
1529
1530       // If the instruction has a single pair of tied operands, try some
1531       // transformations that may either eliminate the tied operands or
1532       // improve the opportunities for coalescing away the register copy.
1533       if (TiedOperands.size() == 1) {
1534         SmallVector<std::pair<unsigned, unsigned>, 4> &TiedPairs
1535           = TiedOperands.begin()->second;
1536         if (TiedPairs.size() == 1) {
1537           unsigned SrcIdx = TiedPairs[0].first;
1538           unsigned DstIdx = TiedPairs[0].second;
1539           unsigned SrcReg = mi->getOperand(SrcIdx).getReg();
1540           unsigned DstReg = mi->getOperand(DstIdx).getReg();
1541           if (SrcReg != DstReg &&
1542               tryInstructionTransform(mi, nmi, SrcIdx, DstIdx, Dist)) {
1543             // The tied operands have been eliminated or shifted further down the
1544             // block to ease elimination. Continue processing with 'nmi'.
1545             TiedOperands.clear();
1546             mi = nmi;
1547             continue;
1548           }
1549         }
1550       }
1551
1552       // Now iterate over the information collected above.
1553       for (TiedOperandMap::iterator OI = TiedOperands.begin(),
1554              OE = TiedOperands.end(); OI != OE; ++OI) {
1555         processTiedPairs(mi, OI->second, Dist);
1556         DEBUG(dbgs() << "\t\trewrite to:\t" << *mi);
1557       }
1558
1559       // Rewrite INSERT_SUBREG as COPY now that we no longer need SSA form.
1560       if (mi->isInsertSubreg()) {
1561         // From %reg = INSERT_SUBREG %reg, %subreg, subidx
1562         // To   %reg:subidx = COPY %subreg
1563         unsigned SubIdx = mi->getOperand(3).getImm();
1564         mi->RemoveOperand(3);
1565         assert(mi->getOperand(0).getSubReg() == 0 && "Unexpected subreg idx");
1566         mi->getOperand(0).setSubReg(SubIdx);
1567         mi->getOperand(0).setIsUndef(mi->getOperand(1).isUndef());
1568         mi->RemoveOperand(1);
1569         mi->setDesc(TII->get(TargetOpcode::COPY));
1570         DEBUG(dbgs() << "\t\tconvert to:\t" << *mi);
1571       }
1572
1573       // Clear TiedOperands here instead of at the top of the loop
1574       // since most instructions do not have tied operands.
1575       TiedOperands.clear();
1576       mi = nmi;
1577     }
1578   }
1579
1580   if (LIS)
1581     MF->verify(this, "After two-address instruction pass");
1582
1583   return MadeChange;
1584 }
1585
1586 /// Eliminate a REG_SEQUENCE instruction as part of the de-ssa process.
1587 ///
1588 /// The instruction is turned into a sequence of sub-register copies:
1589 ///
1590 ///   %dst = REG_SEQUENCE %v1, ssub0, %v2, ssub1
1591 ///
1592 /// Becomes:
1593 ///
1594 ///   %dst:ssub0<def,undef> = COPY %v1
1595 ///   %dst:ssub1<def> = COPY %v2
1596 ///
1597 void TwoAddressInstructionPass::
1598 eliminateRegSequence(MachineBasicBlock::iterator &MBBI) {
1599   MachineInstr *MI = MBBI;
1600   unsigned DstReg = MI->getOperand(0).getReg();
1601   if (MI->getOperand(0).getSubReg() ||
1602       TargetRegisterInfo::isPhysicalRegister(DstReg) ||
1603       !(MI->getNumOperands() & 1)) {
1604     DEBUG(dbgs() << "Illegal REG_SEQUENCE instruction:" << *MI);
1605     llvm_unreachable(0);
1606   }
1607
1608   SmallVector<unsigned, 4> OrigRegs;
1609   if (LIS) {
1610     OrigRegs.push_back(MI->getOperand(0).getReg());
1611     for (unsigned i = 1, e = MI->getNumOperands(); i < e; i += 2)
1612       OrigRegs.push_back(MI->getOperand(i).getReg());
1613   }
1614
1615   bool DefEmitted = false;
1616   for (unsigned i = 1, e = MI->getNumOperands(); i < e; i += 2) {
1617     MachineOperand &UseMO = MI->getOperand(i);
1618     unsigned SrcReg = UseMO.getReg();
1619     unsigned SubIdx = MI->getOperand(i+1).getImm();
1620     // Nothing needs to be inserted for <undef> operands.
1621     if (UseMO.isUndef())
1622       continue;
1623
1624     // Defer any kill flag to the last operand using SrcReg. Otherwise, we
1625     // might insert a COPY that uses SrcReg after is was killed.
1626     bool isKill = UseMO.isKill();
1627     if (isKill)
1628       for (unsigned j = i + 2; j < e; j += 2)
1629         if (MI->getOperand(j).getReg() == SrcReg) {
1630           MI->getOperand(j).setIsKill();
1631           UseMO.setIsKill(false);
1632           isKill = false;
1633           break;
1634         }
1635
1636     // Insert the sub-register copy.
1637     MachineInstr *CopyMI = BuildMI(*MI->getParent(), MI, MI->getDebugLoc(),
1638                                    TII->get(TargetOpcode::COPY))
1639       .addReg(DstReg, RegState::Define, SubIdx)
1640       .addOperand(UseMO);
1641
1642     // The first def needs an <undef> flag because there is no live register
1643     // before it.
1644     if (!DefEmitted) {
1645       CopyMI->getOperand(0).setIsUndef(true);
1646       // Return an iterator pointing to the first inserted instr.
1647       MBBI = CopyMI;
1648     }
1649     DefEmitted = true;
1650
1651     // Update LiveVariables' kill info.
1652     if (LV && isKill && !TargetRegisterInfo::isPhysicalRegister(SrcReg))
1653       LV->replaceKillInstruction(SrcReg, MI, CopyMI);
1654
1655     DEBUG(dbgs() << "Inserted: " << *CopyMI);
1656   }
1657
1658   MachineBasicBlock::iterator EndMBBI =
1659       llvm::next(MachineBasicBlock::iterator(MI));
1660
1661   if (!DefEmitted) {
1662     DEBUG(dbgs() << "Turned: " << *MI << " into an IMPLICIT_DEF");
1663     MI->setDesc(TII->get(TargetOpcode::IMPLICIT_DEF));
1664     for (int j = MI->getNumOperands() - 1, ee = 0; j > ee; --j)
1665       MI->RemoveOperand(j);
1666   } else {
1667     DEBUG(dbgs() << "Eliminated: " << *MI);
1668     MI->eraseFromParent();
1669   }
1670
1671   // Udpate LiveIntervals.
1672   if (LIS)
1673     LIS->repairIntervalsInRange(MBB, MBBI, EndMBBI, OrigRegs);
1674 }