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