Remember to update live-in lists when coalescing physregs.
[oota-llvm.git] / lib / CodeGen / SimpleRegisterCoalescing.cpp
1 //===-- SimpleRegisterCoalescing.cpp - Register Coalescing ----------------===//
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 a simple register coalescing pass that attempts to
11 // aggressively coalesce every register copy that it can.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #define DEBUG_TYPE "regcoalescing"
16 #include "SimpleRegisterCoalescing.h"
17 #include "VirtRegMap.h"
18 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
19 #include "llvm/Value.h"
20 #include "llvm/Analysis/AliasAnalysis.h"
21 #include "llvm/CodeGen/MachineFrameInfo.h"
22 #include "llvm/CodeGen/MachineInstr.h"
23 #include "llvm/CodeGen/MachineLoopInfo.h"
24 #include "llvm/CodeGen/MachineRegisterInfo.h"
25 #include "llvm/CodeGen/Passes.h"
26 #include "llvm/CodeGen/RegisterCoalescer.h"
27 #include "llvm/Target/TargetInstrInfo.h"
28 #include "llvm/Target/TargetMachine.h"
29 #include "llvm/Target/TargetOptions.h"
30 #include "llvm/Support/CommandLine.h"
31 #include "llvm/Support/Debug.h"
32 #include "llvm/Support/ErrorHandling.h"
33 #include "llvm/Support/raw_ostream.h"
34 #include "llvm/ADT/SmallSet.h"
35 #include "llvm/ADT/Statistic.h"
36 #include "llvm/ADT/STLExtras.h"
37 #include <algorithm>
38 #include <cmath>
39 using namespace llvm;
40
41 STATISTIC(numJoins    , "Number of interval joins performed");
42 STATISTIC(numCrossRCs , "Number of cross class joins performed");
43 STATISTIC(numCommutes , "Number of instruction commuting performed");
44 STATISTIC(numExtends  , "Number of copies extended");
45 STATISTIC(NumReMats   , "Number of instructions re-materialized");
46 STATISTIC(numPeep     , "Number of identity moves eliminated after coalescing");
47 STATISTIC(numAborts   , "Number of times interval joining aborted");
48 STATISTIC(numDeadValNo, "Number of valno def marked dead");
49
50 char SimpleRegisterCoalescing::ID = 0;
51 static cl::opt<bool>
52 EnableJoining("join-liveintervals",
53               cl::desc("Coalesce copies (default=true)"),
54               cl::init(true));
55
56 static cl::opt<bool>
57 DisableCrossClassJoin("disable-cross-class-join",
58                cl::desc("Avoid coalescing cross register class copies"),
59                cl::init(false), cl::Hidden);
60
61 static cl::opt<bool>
62 PhysJoinTweak("tweak-phys-join-heuristics",
63                cl::desc("Tweak heuristics for joining phys reg with vr"),
64                cl::init(false), cl::Hidden);
65
66 static RegisterPass<SimpleRegisterCoalescing>
67 X("simple-register-coalescing", "Simple Register Coalescing");
68
69 // Declare that we implement the RegisterCoalescer interface
70 static RegisterAnalysisGroup<RegisterCoalescer, true/*The Default*/> V(X);
71
72 const PassInfo *const llvm::SimpleRegisterCoalescingID = &X;
73
74 void SimpleRegisterCoalescing::getAnalysisUsage(AnalysisUsage &AU) const {
75   AU.setPreservesCFG();
76   AU.addRequired<AliasAnalysis>();
77   AU.addRequired<LiveIntervals>();
78   AU.addPreserved<LiveIntervals>();
79   AU.addPreserved<SlotIndexes>();
80   AU.addRequired<MachineLoopInfo>();
81   AU.addPreserved<MachineLoopInfo>();
82   AU.addPreservedID(MachineDominatorsID);
83   if (StrongPHIElim)
84     AU.addPreservedID(StrongPHIEliminationID);
85   else
86     AU.addPreservedID(PHIEliminationID);
87   AU.addPreservedID(TwoAddressInstructionPassID);
88   MachineFunctionPass::getAnalysisUsage(AU);
89 }
90
91 /// AdjustCopiesBackFrom - We found a non-trivially-coalescable copy with IntA
92 /// being the source and IntB being the dest, thus this defines a value number
93 /// in IntB.  If the source value number (in IntA) is defined by a copy from B,
94 /// see if we can merge these two pieces of B into a single value number,
95 /// eliminating a copy.  For example:
96 ///
97 ///  A3 = B0
98 ///    ...
99 ///  B1 = A3      <- this copy
100 ///
101 /// In this case, B0 can be extended to where the B1 copy lives, allowing the B1
102 /// value number to be replaced with B0 (which simplifies the B liveinterval).
103 ///
104 /// This returns true if an interval was modified.
105 ///
106 bool SimpleRegisterCoalescing::AdjustCopiesBackFrom(LiveInterval &IntA,
107                                                     LiveInterval &IntB,
108                                                     MachineInstr *CopyMI) {
109   SlotIndex CopyIdx = li_->getInstructionIndex(CopyMI).getDefIndex();
110
111   // BValNo is a value number in B that is defined by a copy from A.  'B3' in
112   // the example above.
113   LiveInterval::iterator BLR = IntB.FindLiveRangeContaining(CopyIdx);
114   assert(BLR != IntB.end() && "Live range not found!");
115   VNInfo *BValNo = BLR->valno;
116
117   // Get the location that B is defined at.  Two options: either this value has
118   // an unknown definition point or it is defined at CopyIdx.  If unknown, we
119   // can't process it.
120   if (!BValNo->getCopy()) return false;
121   assert(BValNo->def == CopyIdx && "Copy doesn't define the value?");
122
123   // AValNo is the value number in A that defines the copy, A3 in the example.
124   SlotIndex CopyUseIdx = CopyIdx.getUseIndex();
125   LiveInterval::iterator ALR = IntA.FindLiveRangeContaining(CopyUseIdx);
126   assert(ALR != IntA.end() && "Live range not found!");
127   VNInfo *AValNo = ALR->valno;
128   // If it's re-defined by an early clobber somewhere in the live range, then
129   // it's not safe to eliminate the copy. FIXME: This is a temporary workaround.
130   // See PR3149:
131   // 172     %ECX<def> = MOV32rr %reg1039<kill>
132   // 180     INLINEASM <es:subl $5,$1
133   //         sbbl $3,$0>, 10, %EAX<def>, 14, %ECX<earlyclobber,def>, 9,
134   //         %EAX<kill>,
135   // 36, <fi#0>, 1, %reg0, 0, 9, %ECX<kill>, 36, <fi#1>, 1, %reg0, 0
136   // 188     %EAX<def> = MOV32rr %EAX<kill>
137   // 196     %ECX<def> = MOV32rr %ECX<kill>
138   // 204     %ECX<def> = MOV32rr %ECX<kill>
139   // 212     %EAX<def> = MOV32rr %EAX<kill>
140   // 220     %EAX<def> = MOV32rr %EAX
141   // 228     %reg1039<def> = MOV32rr %ECX<kill>
142   // The early clobber operand ties ECX input to the ECX def.
143   //
144   // The live interval of ECX is represented as this:
145   // %reg20,inf = [46,47:1)[174,230:0)  0@174-(230) 1@46-(47)
146   // The coalescer has no idea there was a def in the middle of [174,230].
147   if (AValNo->hasRedefByEC())
148     return false;
149
150   // If AValNo is defined as a copy from IntB, we can potentially process this.
151   // Get the instruction that defines this value number.
152   unsigned SrcReg = li_->getVNInfoSourceReg(AValNo);
153   if (!SrcReg) return false;  // Not defined by a copy.
154
155   // If the value number is not defined by a copy instruction, ignore it.
156
157   // If the source register comes from an interval other than IntB, we can't
158   // handle this.
159   if (SrcReg != IntB.reg) return false;
160
161   // Get the LiveRange in IntB that this value number starts with.
162   LiveInterval::iterator ValLR =
163     IntB.FindLiveRangeContaining(AValNo->def.getPrevSlot());
164   assert(ValLR != IntB.end() && "Live range not found!");
165
166   // Make sure that the end of the live range is inside the same block as
167   // CopyMI.
168   MachineInstr *ValLREndInst =
169     li_->getInstructionFromIndex(ValLR->end.getPrevSlot());
170   if (!ValLREndInst ||
171       ValLREndInst->getParent() != CopyMI->getParent()) return false;
172
173   // Okay, we now know that ValLR ends in the same block that the CopyMI
174   // live-range starts.  If there are no intervening live ranges between them in
175   // IntB, we can merge them.
176   if (ValLR+1 != BLR) return false;
177
178   // If a live interval is a physical register, conservatively check if any
179   // of its sub-registers is overlapping the live interval of the virtual
180   // register. If so, do not coalesce.
181   if (TargetRegisterInfo::isPhysicalRegister(IntB.reg) &&
182       *tri_->getSubRegisters(IntB.reg)) {
183     for (const unsigned* SR = tri_->getSubRegisters(IntB.reg); *SR; ++SR)
184       if (li_->hasInterval(*SR) && IntA.overlaps(li_->getInterval(*SR))) {
185         DEBUG({
186             dbgs() << "Interfere with sub-register ";
187             li_->getInterval(*SR).print(dbgs(), tri_);
188           });
189         return false;
190       }
191   }
192
193   DEBUG({
194       dbgs() << "\nExtending: ";
195       IntB.print(dbgs(), tri_);
196     });
197
198   SlotIndex FillerStart = ValLR->end, FillerEnd = BLR->start;
199   // We are about to delete CopyMI, so need to remove it as the 'instruction
200   // that defines this value #'. Update the the valnum with the new defining
201   // instruction #.
202   BValNo->def  = FillerStart;
203   BValNo->setCopy(0);
204
205   // Okay, we can merge them.  We need to insert a new liverange:
206   // [ValLR.end, BLR.begin) of either value number, then we merge the
207   // two value numbers.
208   IntB.addRange(LiveRange(FillerStart, FillerEnd, BValNo));
209
210   // If the IntB live range is assigned to a physical register, and if that
211   // physreg has sub-registers, update their live intervals as well.
212   if (TargetRegisterInfo::isPhysicalRegister(IntB.reg)) {
213     for (const unsigned *SR = tri_->getSubRegisters(IntB.reg); *SR; ++SR) {
214       LiveInterval &SRLI = li_->getInterval(*SR);
215       SRLI.addRange(LiveRange(FillerStart, FillerEnd,
216                               SRLI.getNextValue(FillerStart, 0, true,
217                                                 li_->getVNInfoAllocator())));
218     }
219   }
220
221   // Okay, merge "B1" into the same value number as "B0".
222   if (BValNo != ValLR->valno) {
223     IntB.addKills(ValLR->valno, BValNo->kills);
224     IntB.MergeValueNumberInto(BValNo, ValLR->valno);
225   }
226   DEBUG({
227       dbgs() << "   result = ";
228       IntB.print(dbgs(), tri_);
229       dbgs() << "\n";
230     });
231
232   // If the source instruction was killing the source register before the
233   // merge, unset the isKill marker given the live range has been extended.
234   int UIdx = ValLREndInst->findRegisterUseOperandIdx(IntB.reg, true);
235   if (UIdx != -1) {
236     ValLREndInst->getOperand(UIdx).setIsKill(false);
237     ValLR->valno->removeKill(FillerStart);
238   }
239
240   // If the copy instruction was killing the destination register before the
241   // merge, find the last use and trim the live range. That will also add the
242   // isKill marker.
243   if (CopyMI->killsRegister(IntA.reg))
244     TrimLiveIntervalToLastUse(CopyUseIdx, CopyMI->getParent(), IntA, ALR);
245
246   ++numExtends;
247   return true;
248 }
249
250 /// HasOtherReachingDefs - Return true if there are definitions of IntB
251 /// other than BValNo val# that can reach uses of AValno val# of IntA.
252 bool SimpleRegisterCoalescing::HasOtherReachingDefs(LiveInterval &IntA,
253                                                     LiveInterval &IntB,
254                                                     VNInfo *AValNo,
255                                                     VNInfo *BValNo) {
256   for (LiveInterval::iterator AI = IntA.begin(), AE = IntA.end();
257        AI != AE; ++AI) {
258     if (AI->valno != AValNo) continue;
259     LiveInterval::Ranges::iterator BI =
260       std::upper_bound(IntB.ranges.begin(), IntB.ranges.end(), AI->start);
261     if (BI != IntB.ranges.begin())
262       --BI;
263     for (; BI != IntB.ranges.end() && AI->end >= BI->start; ++BI) {
264       if (BI->valno == BValNo)
265         continue;
266       if (BI->start <= AI->start && BI->end > AI->start)
267         return true;
268       if (BI->start > AI->start && BI->start < AI->end)
269         return true;
270     }
271   }
272   return false;
273 }
274
275 static void
276 TransferImplicitOps(MachineInstr *MI, MachineInstr *NewMI) {
277   for (unsigned i = MI->getDesc().getNumOperands(), e = MI->getNumOperands();
278        i != e; ++i) {
279     MachineOperand &MO = MI->getOperand(i);
280     if (MO.isReg() && MO.isImplicit())
281       NewMI->addOperand(MO);
282   }
283 }
284
285 /// RemoveCopyByCommutingDef - We found a non-trivially-coalescable copy with
286 /// IntA being the source and IntB being the dest, thus this defines a value
287 /// number in IntB.  If the source value number (in IntA) is defined by a
288 /// commutable instruction and its other operand is coalesced to the copy dest
289 /// register, see if we can transform the copy into a noop by commuting the
290 /// definition. For example,
291 ///
292 ///  A3 = op A2 B0<kill>
293 ///    ...
294 ///  B1 = A3      <- this copy
295 ///    ...
296 ///     = op A3   <- more uses
297 ///
298 /// ==>
299 ///
300 ///  B2 = op B0 A2<kill>
301 ///    ...
302 ///  B1 = B2      <- now an identify copy
303 ///    ...
304 ///     = op B2   <- more uses
305 ///
306 /// This returns true if an interval was modified.
307 ///
308 bool SimpleRegisterCoalescing::RemoveCopyByCommutingDef(LiveInterval &IntA,
309                                                         LiveInterval &IntB,
310                                                         MachineInstr *CopyMI) {
311   SlotIndex CopyIdx =
312     li_->getInstructionIndex(CopyMI).getDefIndex();
313
314   // FIXME: For now, only eliminate the copy by commuting its def when the
315   // source register is a virtual register. We want to guard against cases
316   // where the copy is a back edge copy and commuting the def lengthen the
317   // live interval of the source register to the entire loop.
318   if (TargetRegisterInfo::isPhysicalRegister(IntA.reg))
319     return false;
320
321   // BValNo is a value number in B that is defined by a copy from A. 'B3' in
322   // the example above.
323   LiveInterval::iterator BLR = IntB.FindLiveRangeContaining(CopyIdx);
324   assert(BLR != IntB.end() && "Live range not found!");
325   VNInfo *BValNo = BLR->valno;
326
327   // Get the location that B is defined at.  Two options: either this value has
328   // an unknown definition point or it is defined at CopyIdx.  If unknown, we
329   // can't process it.
330   if (!BValNo->getCopy()) return false;
331   assert(BValNo->def == CopyIdx && "Copy doesn't define the value?");
332
333   // AValNo is the value number in A that defines the copy, A3 in the example.
334   LiveInterval::iterator ALR =
335     IntA.FindLiveRangeContaining(CopyIdx.getUseIndex()); // 
336
337   assert(ALR != IntA.end() && "Live range not found!");
338   VNInfo *AValNo = ALR->valno;
339   // If other defs can reach uses of this def, then it's not safe to perform
340   // the optimization. FIXME: Do isPHIDef and isDefAccurate both need to be
341   // tested?
342   if (AValNo->isPHIDef() || !AValNo->isDefAccurate() ||
343       AValNo->isUnused() || AValNo->hasPHIKill())
344     return false;
345   MachineInstr *DefMI = li_->getInstructionFromIndex(AValNo->def);
346   const TargetInstrDesc &TID = DefMI->getDesc();
347   if (!TID.isCommutable())
348     return false;
349   // If DefMI is a two-address instruction then commuting it will change the
350   // destination register.
351   int DefIdx = DefMI->findRegisterDefOperandIdx(IntA.reg);
352   assert(DefIdx != -1);
353   unsigned UseOpIdx;
354   if (!DefMI->isRegTiedToUseOperand(DefIdx, &UseOpIdx))
355     return false;
356   unsigned Op1, Op2, NewDstIdx;
357   if (!tii_->findCommutedOpIndices(DefMI, Op1, Op2))
358     return false;
359   if (Op1 == UseOpIdx)
360     NewDstIdx = Op2;
361   else if (Op2 == UseOpIdx)
362     NewDstIdx = Op1;
363   else
364     return false;
365
366   MachineOperand &NewDstMO = DefMI->getOperand(NewDstIdx);
367   unsigned NewReg = NewDstMO.getReg();
368   if (NewReg != IntB.reg || !NewDstMO.isKill())
369     return false;
370
371   // Make sure there are no other definitions of IntB that would reach the
372   // uses which the new definition can reach.
373   if (HasOtherReachingDefs(IntA, IntB, AValNo, BValNo))
374     return false;
375
376   // If some of the uses of IntA.reg is already coalesced away, return false.
377   // It's not possible to determine whether it's safe to perform the coalescing.
378   for (MachineRegisterInfo::use_iterator UI = mri_->use_begin(IntA.reg),
379          UE = mri_->use_end(); UI != UE; ++UI) {
380     MachineInstr *UseMI = &*UI;
381     SlotIndex UseIdx = li_->getInstructionIndex(UseMI);
382     LiveInterval::iterator ULR = IntA.FindLiveRangeContaining(UseIdx);
383     if (ULR == IntA.end())
384       continue;
385     if (ULR->valno == AValNo && JoinedCopies.count(UseMI))
386       return false;
387   }
388
389   // At this point we have decided that it is legal to do this
390   // transformation.  Start by commuting the instruction.
391   MachineBasicBlock *MBB = DefMI->getParent();
392   MachineInstr *NewMI = tii_->commuteInstruction(DefMI);
393   if (!NewMI)
394     return false;
395   if (NewMI != DefMI) {
396     li_->ReplaceMachineInstrInMaps(DefMI, NewMI);
397     MBB->insert(DefMI, NewMI);
398     MBB->erase(DefMI);
399   }
400   unsigned OpIdx = NewMI->findRegisterUseOperandIdx(IntA.reg, false);
401   NewMI->getOperand(OpIdx).setIsKill();
402
403   bool BHasPHIKill = BValNo->hasPHIKill();
404   SmallVector<VNInfo*, 4> BDeadValNos;
405   VNInfo::KillSet BKills;
406   std::map<SlotIndex, SlotIndex> BExtend;
407
408   // If ALR and BLR overlaps and end of BLR extends beyond end of ALR, e.g.
409   // A = or A, B
410   // ...
411   // B = A
412   // ...
413   // C = A<kill>
414   // ...
415   //   = B
416   //
417   // then do not add kills of A to the newly created B interval.
418   bool Extended = BLR->end > ALR->end && ALR->end != ALR->start;
419   if (Extended)
420     BExtend[ALR->end] = BLR->end;
421
422   // Update uses of IntA of the specific Val# with IntB.
423   bool BHasSubRegs = false;
424   if (TargetRegisterInfo::isPhysicalRegister(IntB.reg))
425     BHasSubRegs = *tri_->getSubRegisters(IntB.reg);
426   for (MachineRegisterInfo::use_iterator UI = mri_->use_begin(IntA.reg),
427          UE = mri_->use_end(); UI != UE;) {
428     MachineOperand &UseMO = UI.getOperand();
429     MachineInstr *UseMI = &*UI;
430     ++UI;
431     if (JoinedCopies.count(UseMI))
432       continue;
433     SlotIndex UseIdx = li_->getInstructionIndex(UseMI).getUseIndex();
434     LiveInterval::iterator ULR = IntA.FindLiveRangeContaining(UseIdx);
435     if (ULR == IntA.end() || ULR->valno != AValNo)
436       continue;
437     UseMO.setReg(NewReg);
438     if (UseMI == CopyMI)
439       continue;
440     if (UseMO.isKill()) {
441       if (Extended)
442         UseMO.setIsKill(false);
443       else
444         BKills.push_back(UseIdx.getDefIndex());
445     }
446     unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
447     if (!tii_->isMoveInstr(*UseMI, SrcReg, DstReg, SrcSubIdx, DstSubIdx))
448       continue;
449     if (DstReg == IntB.reg) {
450       // This copy will become a noop. If it's defining a new val#,
451       // remove that val# as well. However this live range is being
452       // extended to the end of the existing live range defined by the copy.
453       SlotIndex DefIdx = UseIdx.getDefIndex();
454       const LiveRange *DLR = IntB.getLiveRangeContaining(DefIdx);
455       BHasPHIKill |= DLR->valno->hasPHIKill();
456       assert(DLR->valno->def == DefIdx);
457       BDeadValNos.push_back(DLR->valno);
458       BExtend[DLR->start] = DLR->end;
459       JoinedCopies.insert(UseMI);
460       // If this is a kill but it's going to be removed, the last use
461       // of the same val# is the new kill.
462       if (UseMO.isKill())
463         BKills.pop_back();
464     }
465   }
466
467   // We need to insert a new liverange: [ALR.start, LastUse). It may be we can
468   // simply extend BLR if CopyMI doesn't end the range.
469   DEBUG({
470       dbgs() << "\nExtending: ";
471       IntB.print(dbgs(), tri_);
472     });
473
474   // Remove val#'s defined by copies that will be coalesced away.
475   for (unsigned i = 0, e = BDeadValNos.size(); i != e; ++i) {
476     VNInfo *DeadVNI = BDeadValNos[i];
477     if (BHasSubRegs) {
478       for (const unsigned *SR = tri_->getSubRegisters(IntB.reg); *SR; ++SR) {
479         LiveInterval &SRLI = li_->getInterval(*SR);
480         const LiveRange *SRLR = SRLI.getLiveRangeContaining(DeadVNI->def);
481         SRLI.removeValNo(SRLR->valno);
482       }
483     }
484     IntB.removeValNo(BDeadValNos[i]);
485   }
486
487   // Extend BValNo by merging in IntA live ranges of AValNo. Val# definition
488   // is updated. Kills are also updated.
489   VNInfo *ValNo = BValNo;
490   ValNo->def = AValNo->def;
491   ValNo->setCopy(0);
492   for (unsigned j = 0, ee = ValNo->kills.size(); j != ee; ++j) {
493     if (ValNo->kills[j] != BLR->end)
494       BKills.push_back(ValNo->kills[j]);
495   }
496   ValNo->kills.clear();
497   for (LiveInterval::iterator AI = IntA.begin(), AE = IntA.end();
498        AI != AE; ++AI) {
499     if (AI->valno != AValNo) continue;
500     SlotIndex End = AI->end;
501     std::map<SlotIndex, SlotIndex>::iterator
502       EI = BExtend.find(End);
503     if (EI != BExtend.end())
504       End = EI->second;
505     IntB.addRange(LiveRange(AI->start, End, ValNo));
506
507     // If the IntB live range is assigned to a physical register, and if that
508     // physreg has sub-registers, update their live intervals as well.
509     if (BHasSubRegs) {
510       for (const unsigned *SR = tri_->getSubRegisters(IntB.reg); *SR; ++SR) {
511         LiveInterval &SRLI = li_->getInterval(*SR);
512         SRLI.MergeInClobberRange(*li_, AI->start, End,
513                                  li_->getVNInfoAllocator());
514       }
515     }
516   }
517   IntB.addKills(ValNo, BKills);
518   ValNo->setHasPHIKill(BHasPHIKill);
519
520   DEBUG({
521       dbgs() << "   result = ";
522       IntB.print(dbgs(), tri_);
523       dbgs() << '\n';
524       dbgs() << "\nShortening: ";
525       IntA.print(dbgs(), tri_);
526     });
527
528   IntA.removeValNo(AValNo);
529
530   DEBUG({
531       dbgs() << "   result = ";
532       IntA.print(dbgs(), tri_);
533       dbgs() << '\n';
534     });
535
536   ++numCommutes;
537   return true;
538 }
539
540 /// isSameOrFallThroughBB - Return true if MBB == SuccMBB or MBB simply
541 /// fallthoughs to SuccMBB.
542 static bool isSameOrFallThroughBB(MachineBasicBlock *MBB,
543                                   MachineBasicBlock *SuccMBB,
544                                   const TargetInstrInfo *tii_) {
545   if (MBB == SuccMBB)
546     return true;
547   MachineBasicBlock *TBB = 0, *FBB = 0;
548   SmallVector<MachineOperand, 4> Cond;
549   return !tii_->AnalyzeBranch(*MBB, TBB, FBB, Cond) && !TBB && !FBB &&
550     MBB->isSuccessor(SuccMBB);
551 }
552
553 /// removeRange - Wrapper for LiveInterval::removeRange. This removes a range
554 /// from a physical register live interval as well as from the live intervals
555 /// of its sub-registers.
556 static void removeRange(LiveInterval &li,
557                         SlotIndex Start, SlotIndex End,
558                         LiveIntervals *li_, const TargetRegisterInfo *tri_) {
559   li.removeRange(Start, End, true);
560   if (TargetRegisterInfo::isPhysicalRegister(li.reg)) {
561     for (const unsigned* SR = tri_->getSubRegisters(li.reg); *SR; ++SR) {
562       if (!li_->hasInterval(*SR))
563         continue;
564       LiveInterval &sli = li_->getInterval(*SR);
565       SlotIndex RemoveStart = Start;
566       SlotIndex RemoveEnd = Start;
567
568       while (RemoveEnd != End) {
569         LiveInterval::iterator LR = sli.FindLiveRangeContaining(RemoveStart);
570         if (LR == sli.end())
571           break;
572         RemoveEnd = (LR->end < End) ? LR->end : End;
573         sli.removeRange(RemoveStart, RemoveEnd, true);
574         RemoveStart = RemoveEnd;
575       }
576     }
577   }
578 }
579
580 /// TrimLiveIntervalToLastUse - If there is a last use in the same basic block
581 /// as the copy instruction, trim the live interval to the last use and return
582 /// true.
583 bool
584 SimpleRegisterCoalescing::TrimLiveIntervalToLastUse(SlotIndex CopyIdx,
585                                                     MachineBasicBlock *CopyMBB,
586                                                     LiveInterval &li,
587                                                     const LiveRange *LR) {
588   SlotIndex MBBStart = li_->getMBBStartIdx(CopyMBB);
589   SlotIndex LastUseIdx;
590   MachineOperand *LastUse =
591     lastRegisterUse(LR->start, CopyIdx.getPrevSlot(), li.reg, LastUseIdx);
592   if (LastUse) {
593     MachineInstr *LastUseMI = LastUse->getParent();
594     if (!isSameOrFallThroughBB(LastUseMI->getParent(), CopyMBB, tii_)) {
595       // r1024 = op
596       // ...
597       // BB1:
598       //       = r1024
599       //
600       // BB2:
601       // r1025<dead> = r1024<kill>
602       if (MBBStart < LR->end)
603         removeRange(li, MBBStart, LR->end, li_, tri_);
604       return true;
605     }
606
607     // There are uses before the copy, just shorten the live range to the end
608     // of last use.
609     LastUse->setIsKill();
610     removeRange(li, LastUseIdx.getDefIndex(), LR->end, li_, tri_);
611     LR->valno->addKill(LastUseIdx.getDefIndex());
612     unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
613     if (tii_->isMoveInstr(*LastUseMI, SrcReg, DstReg, SrcSubIdx, DstSubIdx) &&
614         DstReg == li.reg) {
615       // Last use is itself an identity code.
616       int DeadIdx = LastUseMI->findRegisterDefOperandIdx(li.reg, false, tri_);
617       LastUseMI->getOperand(DeadIdx).setIsDead();
618     }
619     return true;
620   }
621
622   // Is it livein?
623   if (LR->start <= MBBStart && LR->end > MBBStart) {
624     if (LR->start == li_->getZeroIndex()) {
625       assert(TargetRegisterInfo::isPhysicalRegister(li.reg));
626       // Live-in to the function but dead. Remove it from entry live-in set.
627       mf_->begin()->removeLiveIn(li.reg);
628     }
629     // FIXME: Shorten intervals in BBs that reaches this BB.
630   }
631
632   return false;
633 }
634
635 /// ReMaterializeTrivialDef - If the source of a copy is defined by a trivial
636 /// computation, replace the copy by rematerialize the definition.
637 bool SimpleRegisterCoalescing::ReMaterializeTrivialDef(LiveInterval &SrcInt,
638                                                        unsigned DstReg,
639                                                        unsigned DstSubIdx,
640                                                        MachineInstr *CopyMI) {
641   SlotIndex CopyIdx = li_->getInstructionIndex(CopyMI).getUseIndex();
642   LiveInterval::iterator SrcLR = SrcInt.FindLiveRangeContaining(CopyIdx);
643   assert(SrcLR != SrcInt.end() && "Live range not found!");
644   VNInfo *ValNo = SrcLR->valno;
645   // If other defs can reach uses of this def, then it's not safe to perform
646   // the optimization. FIXME: Do isPHIDef and isDefAccurate both need to be
647   // tested?
648   if (ValNo->isPHIDef() || !ValNo->isDefAccurate() ||
649       ValNo->isUnused() || ValNo->hasPHIKill())
650     return false;
651   MachineInstr *DefMI = li_->getInstructionFromIndex(ValNo->def);
652   const TargetInstrDesc &TID = DefMI->getDesc();
653   if (!TID.isAsCheapAsAMove())
654     return false;
655   if (!tii_->isTriviallyReMaterializable(DefMI, AA))
656     return false;
657   bool SawStore = false;
658   if (!DefMI->isSafeToMove(tii_, SawStore, AA))
659     return false;
660   if (TID.getNumDefs() != 1)
661     return false;
662   if (DefMI->getOpcode() != TargetInstrInfo::IMPLICIT_DEF) {
663     // Make sure the copy destination register class fits the instruction
664     // definition register class. The mismatch can happen as a result of earlier
665     // extract_subreg, insert_subreg, subreg_to_reg coalescing.
666     const TargetRegisterClass *RC = TID.OpInfo[0].getRegClass(tri_);
667     if (TargetRegisterInfo::isVirtualRegister(DstReg)) {
668       if (mri_->getRegClass(DstReg) != RC)
669         return false;
670     } else if (!RC->contains(DstReg))
671       return false;
672   }
673
674   // If destination register has a sub-register index on it, make sure it mtches
675   // the instruction register class.
676   if (DstSubIdx) {
677     const TargetInstrDesc &TID = DefMI->getDesc();
678     if (TID.getNumDefs() != 1)
679       return false;
680     const TargetRegisterClass *DstRC = mri_->getRegClass(DstReg);
681     const TargetRegisterClass *DstSubRC =
682       DstRC->getSubRegisterRegClass(DstSubIdx);
683     const TargetRegisterClass *DefRC = TID.OpInfo[0].getRegClass(tri_);
684     if (DefRC == DstRC)
685       DstSubIdx = 0;
686     else if (DefRC != DstSubRC)
687       return false;
688   }
689
690   SlotIndex DefIdx = CopyIdx.getDefIndex();
691   const LiveRange *DLR= li_->getInterval(DstReg).getLiveRangeContaining(DefIdx);
692   DLR->valno->setCopy(0);
693   // Don't forget to update sub-register intervals.
694   if (TargetRegisterInfo::isPhysicalRegister(DstReg)) {
695     for (const unsigned* SR = tri_->getSubRegisters(DstReg); *SR; ++SR) {
696       if (!li_->hasInterval(*SR))
697         continue;
698       DLR = li_->getInterval(*SR).getLiveRangeContaining(DefIdx);
699       if (DLR && DLR->valno->getCopy() == CopyMI)
700         DLR->valno->setCopy(0);
701     }
702   }
703
704   // If copy kills the source register, find the last use and propagate
705   // kill.
706   bool checkForDeadDef = false;
707   MachineBasicBlock *MBB = CopyMI->getParent();
708   if (CopyMI->killsRegister(SrcInt.reg))
709     if (!TrimLiveIntervalToLastUse(CopyIdx, MBB, SrcInt, SrcLR)) {
710       checkForDeadDef = true;
711     }
712
713   MachineBasicBlock::iterator MII =
714     llvm::next(MachineBasicBlock::iterator(CopyMI));
715   tii_->reMaterialize(*MBB, MII, DstReg, DstSubIdx, DefMI, tri_);
716   MachineInstr *NewMI = prior(MII);
717
718   if (checkForDeadDef) {
719     // PR4090 fix: Trim interval failed because there was no use of the
720     // source interval in this MBB. If the def is in this MBB too then we
721     // should mark it dead:
722     if (DefMI->getParent() == MBB) {
723       DefMI->addRegisterDead(SrcInt.reg, tri_);
724       SrcLR->end = SrcLR->start.getNextSlot();
725     }
726   }
727
728   // CopyMI may have implicit operands, transfer them over to the newly
729   // rematerialized instruction. And update implicit def interval valnos.
730   for (unsigned i = CopyMI->getDesc().getNumOperands(),
731          e = CopyMI->getNumOperands(); i != e; ++i) {
732     MachineOperand &MO = CopyMI->getOperand(i);
733     if (MO.isReg() && MO.isImplicit())
734       NewMI->addOperand(MO);
735     if (MO.isDef() && li_->hasInterval(MO.getReg())) {
736       unsigned Reg = MO.getReg();
737       DLR = li_->getInterval(Reg).getLiveRangeContaining(DefIdx);
738       if (DLR && DLR->valno->getCopy() == CopyMI)
739         DLR->valno->setCopy(0);
740     }
741   }
742
743   TransferImplicitOps(CopyMI, NewMI);
744   li_->ReplaceMachineInstrInMaps(CopyMI, NewMI);
745   CopyMI->eraseFromParent();
746   ReMatCopies.insert(CopyMI);
747   ReMatDefs.insert(DefMI);
748   ++NumReMats;
749   return true;
750 }
751
752 /// UpdateRegDefsUses - Replace all defs and uses of SrcReg to DstReg and
753 /// update the subregister number if it is not zero. If DstReg is a
754 /// physical register and the existing subregister number of the def / use
755 /// being updated is not zero, make sure to set it to the correct physical
756 /// subregister.
757 void
758 SimpleRegisterCoalescing::UpdateRegDefsUses(unsigned SrcReg, unsigned DstReg,
759                                             unsigned SubIdx) {
760   bool DstIsPhys = TargetRegisterInfo::isPhysicalRegister(DstReg);
761   if (DstIsPhys && SubIdx) {
762     // Figure out the real physical register we are updating with.
763     DstReg = tri_->getSubReg(DstReg, SubIdx);
764     SubIdx = 0;
765   }
766
767   for (MachineRegisterInfo::reg_iterator I = mri_->reg_begin(SrcReg),
768          E = mri_->reg_end(); I != E; ) {
769     MachineOperand &O = I.getOperand();
770     MachineInstr *UseMI = &*I;
771     ++I;
772     unsigned OldSubIdx = O.getSubReg();
773     if (DstIsPhys) {
774       unsigned UseDstReg = DstReg;
775       if (OldSubIdx)
776           UseDstReg = tri_->getSubReg(DstReg, OldSubIdx);
777
778       unsigned CopySrcReg, CopyDstReg, CopySrcSubIdx, CopyDstSubIdx;
779       if (tii_->isMoveInstr(*UseMI, CopySrcReg, CopyDstReg,
780                             CopySrcSubIdx, CopyDstSubIdx) &&
781           CopySrcReg != CopyDstReg &&
782           CopySrcReg == SrcReg && CopyDstReg != UseDstReg) {
783         // If the use is a copy and it won't be coalesced away, and its source
784         // is defined by a trivial computation, try to rematerialize it instead.
785         if (ReMaterializeTrivialDef(li_->getInterval(SrcReg), CopyDstReg,
786                                     CopyDstSubIdx, UseMI))
787           continue;
788       }
789
790       O.setReg(UseDstReg);
791       O.setSubReg(0);
792       continue;
793     }
794
795     // Sub-register indexes goes from small to large. e.g.
796     // RAX: 1 -> AL, 2 -> AX, 3 -> EAX
797     // EAX: 1 -> AL, 2 -> AX
798     // So RAX's sub-register 2 is AX, RAX's sub-regsiter 3 is EAX, whose
799     // sub-register 2 is also AX.
800     if (SubIdx && OldSubIdx && SubIdx != OldSubIdx)
801       assert(OldSubIdx < SubIdx && "Conflicting sub-register index!");
802     else if (SubIdx)
803       O.setSubReg(SubIdx);
804     // Remove would-be duplicated kill marker.
805     if (O.isKill() && UseMI->killsRegister(DstReg))
806       O.setIsKill(false);
807     O.setReg(DstReg);
808
809     // After updating the operand, check if the machine instruction has
810     // become a copy. If so, update its val# information.
811     if (JoinedCopies.count(UseMI))
812       continue;
813
814     const TargetInstrDesc &TID = UseMI->getDesc();
815     unsigned CopySrcReg, CopyDstReg, CopySrcSubIdx, CopyDstSubIdx;
816     if (TID.getNumDefs() == 1 && TID.getNumOperands() > 2 &&
817         tii_->isMoveInstr(*UseMI, CopySrcReg, CopyDstReg,
818                           CopySrcSubIdx, CopyDstSubIdx) &&
819         CopySrcReg != CopyDstReg &&
820         (TargetRegisterInfo::isVirtualRegister(CopyDstReg) ||
821          allocatableRegs_[CopyDstReg])) {
822       LiveInterval &LI = li_->getInterval(CopyDstReg);
823       SlotIndex DefIdx =
824         li_->getInstructionIndex(UseMI).getDefIndex();
825       if (const LiveRange *DLR = LI.getLiveRangeContaining(DefIdx)) {
826         if (DLR->valno->def == DefIdx)
827           DLR->valno->setCopy(UseMI);
828       }
829     }
830   }
831 }
832
833 /// RemoveUnnecessaryKills - Remove kill markers that are no longer accurate
834 /// due to live range lengthening as the result of coalescing.
835 void SimpleRegisterCoalescing::RemoveUnnecessaryKills(unsigned Reg,
836                                                       LiveInterval &LI) {
837   for (MachineRegisterInfo::use_iterator UI = mri_->use_begin(Reg),
838          UE = mri_->use_end(); UI != UE; ++UI) {
839     MachineOperand &UseMO = UI.getOperand();
840     if (!UseMO.isKill())
841       continue;
842     MachineInstr *UseMI = UseMO.getParent();
843     SlotIndex UseIdx =
844       li_->getInstructionIndex(UseMI).getUseIndex();
845     const LiveRange *LR = LI.getLiveRangeContaining(UseIdx);
846     if (!LR ||
847         (!LR->valno->isKill(UseIdx.getDefIndex()) &&
848          LR->valno->def != UseIdx.getDefIndex())) {
849       // Interesting problem. After coalescing reg1027's def and kill are both
850       // at the same point:  %reg1027,0.000000e+00 = [56,814:0)  0@70-(814)
851       //
852       // bb5:
853       // 60   %reg1027<def> = t2MOVr %reg1027, 14, %reg0, %reg0
854       // 68   %reg1027<def> = t2LDRi12 %reg1027<kill>, 8, 14, %reg0
855       // 76   t2CMPzri %reg1038<kill,undef>, 0, 14, %reg0, %CPSR<imp-def>
856       // 84   %reg1027<def> = t2MOVr %reg1027, 14, %reg0, %reg0
857       // 96   t2Bcc mbb<bb5,0x2030910>, 1, %CPSR<kill>
858       //
859       // Do not remove the kill marker on t2LDRi12.
860       UseMO.setIsKill(false);
861     }
862   }
863 }
864
865 /// removeIntervalIfEmpty - Check if the live interval of a physical register
866 /// is empty, if so remove it and also remove the empty intervals of its
867 /// sub-registers. Return true if live interval is removed.
868 static bool removeIntervalIfEmpty(LiveInterval &li, LiveIntervals *li_,
869                                   const TargetRegisterInfo *tri_) {
870   if (li.empty()) {
871     if (TargetRegisterInfo::isPhysicalRegister(li.reg))
872       for (const unsigned* SR = tri_->getSubRegisters(li.reg); *SR; ++SR) {
873         if (!li_->hasInterval(*SR))
874           continue;
875         LiveInterval &sli = li_->getInterval(*SR);
876         if (sli.empty())
877           li_->removeInterval(*SR);
878       }
879     li_->removeInterval(li.reg);
880     return true;
881   }
882   return false;
883 }
884
885 /// ShortenDeadCopyLiveRange - Shorten a live range defined by a dead copy.
886 /// Return true if live interval is removed.
887 bool SimpleRegisterCoalescing::ShortenDeadCopyLiveRange(LiveInterval &li,
888                                                         MachineInstr *CopyMI) {
889   SlotIndex CopyIdx = li_->getInstructionIndex(CopyMI);
890   LiveInterval::iterator MLR =
891     li.FindLiveRangeContaining(CopyIdx.getDefIndex());
892   if (MLR == li.end())
893     return false;  // Already removed by ShortenDeadCopySrcLiveRange.
894   SlotIndex RemoveStart = MLR->start;
895   SlotIndex RemoveEnd = MLR->end;
896   SlotIndex DefIdx = CopyIdx.getDefIndex();
897   // Remove the liverange that's defined by this.
898   if (RemoveStart == DefIdx && RemoveEnd == DefIdx.getStoreIndex()) {
899     removeRange(li, RemoveStart, RemoveEnd, li_, tri_);
900     return removeIntervalIfEmpty(li, li_, tri_);
901   }
902   return false;
903 }
904
905 /// RemoveDeadDef - If a def of a live interval is now determined dead, remove
906 /// the val# it defines. If the live interval becomes empty, remove it as well.
907 bool SimpleRegisterCoalescing::RemoveDeadDef(LiveInterval &li,
908                                              MachineInstr *DefMI) {
909   SlotIndex DefIdx = li_->getInstructionIndex(DefMI).getDefIndex();
910   LiveInterval::iterator MLR = li.FindLiveRangeContaining(DefIdx);
911   if (DefIdx != MLR->valno->def)
912     return false;
913   li.removeValNo(MLR->valno);
914   return removeIntervalIfEmpty(li, li_, tri_);
915 }
916
917 /// PropagateDeadness - Propagate the dead marker to the instruction which
918 /// defines the val#.
919 static void PropagateDeadness(LiveInterval &li, MachineInstr *CopyMI,
920                               SlotIndex &LRStart, LiveIntervals *li_,
921                               const TargetRegisterInfo* tri_) {
922   MachineInstr *DefMI =
923     li_->getInstructionFromIndex(LRStart.getDefIndex());
924   if (DefMI && DefMI != CopyMI) {
925     int DeadIdx = DefMI->findRegisterDefOperandIdx(li.reg, false);
926     if (DeadIdx != -1)
927       DefMI->getOperand(DeadIdx).setIsDead();
928     else
929       DefMI->addOperand(MachineOperand::CreateReg(li.reg,
930                    /*def*/true, /*implicit*/true, /*kill*/false, /*dead*/true));
931     LRStart = LRStart.getNextSlot();
932   }
933 }
934
935 /// ShortenDeadCopySrcLiveRange - Shorten a live range as it's artificially
936 /// extended by a dead copy. Mark the last use (if any) of the val# as kill as
937 /// ends the live range there. If there isn't another use, then this live range
938 /// is dead. Return true if live interval is removed.
939 bool
940 SimpleRegisterCoalescing::ShortenDeadCopySrcLiveRange(LiveInterval &li,
941                                                       MachineInstr *CopyMI) {
942   SlotIndex CopyIdx = li_->getInstructionIndex(CopyMI);
943   if (CopyIdx == SlotIndex()) {
944     // FIXME: special case: function live in. It can be a general case if the
945     // first instruction index starts at > 0 value.
946     assert(TargetRegisterInfo::isPhysicalRegister(li.reg));
947     // Live-in to the function but dead. Remove it from entry live-in set.
948     if (mf_->begin()->isLiveIn(li.reg))
949       mf_->begin()->removeLiveIn(li.reg);
950     const LiveRange *LR = li.getLiveRangeContaining(CopyIdx);
951     removeRange(li, LR->start, LR->end, li_, tri_);
952     return removeIntervalIfEmpty(li, li_, tri_);
953   }
954
955   LiveInterval::iterator LR =
956     li.FindLiveRangeContaining(CopyIdx.getPrevIndex().getStoreIndex());
957   if (LR == li.end())
958     // Livein but defined by a phi.
959     return false;
960
961   SlotIndex RemoveStart = LR->start;
962   SlotIndex RemoveEnd = CopyIdx.getStoreIndex();
963   if (LR->end > RemoveEnd)
964     // More uses past this copy? Nothing to do.
965     return false;
966
967   // If there is a last use in the same bb, we can't remove the live range.
968   // Shorten the live interval and return.
969   MachineBasicBlock *CopyMBB = CopyMI->getParent();
970   if (TrimLiveIntervalToLastUse(CopyIdx, CopyMBB, li, LR))
971     return false;
972
973   // There are other kills of the val#. Nothing to do.
974   if (!li.isOnlyLROfValNo(LR))
975     return false;
976
977   MachineBasicBlock *StartMBB = li_->getMBBFromIndex(RemoveStart);
978   if (!isSameOrFallThroughBB(StartMBB, CopyMBB, tii_))
979     // If the live range starts in another mbb and the copy mbb is not a fall
980     // through mbb, then we can only cut the range from the beginning of the
981     // copy mbb.
982     RemoveStart = li_->getMBBStartIdx(CopyMBB).getNextIndex().getBaseIndex();
983
984   if (LR->valno->def == RemoveStart) {
985     // If the def MI defines the val# and this copy is the only kill of the
986     // val#, then propagate the dead marker.
987     PropagateDeadness(li, CopyMI, RemoveStart, li_, tri_);
988     ++numDeadValNo;
989
990     if (LR->valno->isKill(RemoveEnd))
991       LR->valno->removeKill(RemoveEnd);
992   }
993
994   removeRange(li, RemoveStart, RemoveEnd, li_, tri_);
995   return removeIntervalIfEmpty(li, li_, tri_);
996 }
997
998 /// CanCoalesceWithImpDef - Returns true if the specified copy instruction
999 /// from an implicit def to another register can be coalesced away.
1000 bool SimpleRegisterCoalescing::CanCoalesceWithImpDef(MachineInstr *CopyMI,
1001                                                      LiveInterval &li,
1002                                                      LiveInterval &ImpLi) const{
1003   if (!CopyMI->killsRegister(ImpLi.reg))
1004     return false;
1005   // Make sure this is the only use.
1006   for (MachineRegisterInfo::use_iterator UI = mri_->use_begin(ImpLi.reg),
1007          UE = mri_->use_end(); UI != UE;) {
1008     MachineInstr *UseMI = &*UI;
1009     ++UI;
1010     if (CopyMI == UseMI || JoinedCopies.count(UseMI))
1011       continue;
1012     return false;
1013   }
1014   return true;
1015 }
1016
1017
1018 /// isWinToJoinVRWithSrcPhysReg - Return true if it's worth while to join a
1019 /// a virtual destination register with physical source register.
1020 bool
1021 SimpleRegisterCoalescing::isWinToJoinVRWithSrcPhysReg(MachineInstr *CopyMI,
1022                                                      MachineBasicBlock *CopyMBB,
1023                                                      LiveInterval &DstInt,
1024                                                      LiveInterval &SrcInt) {
1025   // If the virtual register live interval is long but it has low use desity,
1026   // do not join them, instead mark the physical register as its allocation
1027   // preference.
1028   const TargetRegisterClass *RC = mri_->getRegClass(DstInt.reg);
1029   unsigned Threshold = allocatableRCRegs_[RC].count() * 2;
1030   unsigned Length = li_->getApproximateInstructionCount(DstInt);
1031   if (Length > Threshold &&
1032       (((float)std::distance(mri_->use_begin(DstInt.reg),
1033                              mri_->use_end()) / Length) < (1.0 / Threshold)))
1034     return false;
1035
1036   // If the virtual register live interval extends into a loop, turn down
1037   // aggressiveness.
1038   SlotIndex CopyIdx =
1039     li_->getInstructionIndex(CopyMI).getDefIndex();
1040   const MachineLoop *L = loopInfo->getLoopFor(CopyMBB);
1041   if (!L) {
1042     // Let's see if the virtual register live interval extends into the loop.
1043     LiveInterval::iterator DLR = DstInt.FindLiveRangeContaining(CopyIdx);
1044     assert(DLR != DstInt.end() && "Live range not found!");
1045     DLR = DstInt.FindLiveRangeContaining(DLR->end.getNextSlot());
1046     if (DLR != DstInt.end()) {
1047       CopyMBB = li_->getMBBFromIndex(DLR->start);
1048       L = loopInfo->getLoopFor(CopyMBB);
1049     }
1050   }
1051
1052   if (!L || Length <= Threshold)
1053     return true;
1054
1055   SlotIndex UseIdx = CopyIdx.getUseIndex();
1056   LiveInterval::iterator SLR = SrcInt.FindLiveRangeContaining(UseIdx);
1057   MachineBasicBlock *SMBB = li_->getMBBFromIndex(SLR->start);
1058   if (loopInfo->getLoopFor(SMBB) != L) {
1059     if (!loopInfo->isLoopHeader(CopyMBB))
1060       return false;
1061     // If vr's live interval extends pass the loop header, do not join.
1062     for (MachineBasicBlock::succ_iterator SI = CopyMBB->succ_begin(),
1063            SE = CopyMBB->succ_end(); SI != SE; ++SI) {
1064       MachineBasicBlock *SuccMBB = *SI;
1065       if (SuccMBB == CopyMBB)
1066         continue;
1067       if (DstInt.overlaps(li_->getMBBStartIdx(SuccMBB),
1068                           li_->getMBBEndIdx(SuccMBB)))
1069         return false;
1070     }
1071   }
1072   return true;
1073 }
1074
1075 /// isWinToJoinVRWithDstPhysReg - Return true if it's worth while to join a
1076 /// copy from a virtual source register to a physical destination register.
1077 bool
1078 SimpleRegisterCoalescing::isWinToJoinVRWithDstPhysReg(MachineInstr *CopyMI,
1079                                                      MachineBasicBlock *CopyMBB,
1080                                                      LiveInterval &DstInt,
1081                                                      LiveInterval &SrcInt) {
1082   // If the virtual register live interval is long but it has low use desity,
1083   // do not join them, instead mark the physical register as its allocation
1084   // preference.
1085   const TargetRegisterClass *RC = mri_->getRegClass(SrcInt.reg);
1086   unsigned Threshold = allocatableRCRegs_[RC].count() * 2;
1087   unsigned Length = li_->getApproximateInstructionCount(SrcInt);
1088   if (Length > Threshold &&
1089       (((float)std::distance(mri_->use_begin(SrcInt.reg),
1090                              mri_->use_end()) / Length) < (1.0 / Threshold)))
1091     return false;
1092
1093   if (SrcInt.empty())
1094     // Must be implicit_def.
1095     return false;
1096
1097   // If the virtual register live interval is defined or cross a loop, turn
1098   // down aggressiveness.
1099   SlotIndex CopyIdx =
1100     li_->getInstructionIndex(CopyMI).getDefIndex();
1101   SlotIndex UseIdx = CopyIdx.getUseIndex();
1102   LiveInterval::iterator SLR = SrcInt.FindLiveRangeContaining(UseIdx);
1103   assert(SLR != SrcInt.end() && "Live range not found!");
1104   SLR = SrcInt.FindLiveRangeContaining(SLR->start.getPrevSlot());
1105   if (SLR == SrcInt.end())
1106     return true;
1107   MachineBasicBlock *SMBB = li_->getMBBFromIndex(SLR->start);
1108   const MachineLoop *L = loopInfo->getLoopFor(SMBB);
1109
1110   if (!L || Length <= Threshold)
1111     return true;
1112
1113   if (loopInfo->getLoopFor(CopyMBB) != L) {
1114     if (SMBB != L->getLoopLatch())
1115       return false;
1116     // If vr's live interval is extended from before the loop latch, do not
1117     // join.
1118     for (MachineBasicBlock::pred_iterator PI = SMBB->pred_begin(),
1119            PE = SMBB->pred_end(); PI != PE; ++PI) {
1120       MachineBasicBlock *PredMBB = *PI;
1121       if (PredMBB == SMBB)
1122         continue;
1123       if (SrcInt.overlaps(li_->getMBBStartIdx(PredMBB),
1124                           li_->getMBBEndIdx(PredMBB)))
1125         return false;
1126     }
1127   }
1128   return true;
1129 }
1130
1131 /// isWinToJoinCrossClass - Return true if it's profitable to coalesce
1132 /// two virtual registers from different register classes.
1133 bool
1134 SimpleRegisterCoalescing::isWinToJoinCrossClass(unsigned LargeReg,
1135                                                 unsigned SmallReg,
1136                                                 unsigned Threshold) {
1137   // Then make sure the intervals are *short*.
1138   LiveInterval &LargeInt = li_->getInterval(LargeReg);
1139   LiveInterval &SmallInt = li_->getInterval(SmallReg);
1140   unsigned LargeSize = li_->getApproximateInstructionCount(LargeInt);
1141   unsigned SmallSize = li_->getApproximateInstructionCount(SmallInt);
1142   if (SmallSize > Threshold || LargeSize > Threshold)
1143     if ((float)std::distance(mri_->use_begin(SmallReg),
1144                              mri_->use_end()) / SmallSize <
1145         (float)std::distance(mri_->use_begin(LargeReg),
1146                              mri_->use_end()) / LargeSize)
1147       return false;
1148   return true;
1149 }
1150
1151 /// HasIncompatibleSubRegDefUse - If we are trying to coalesce a virtual
1152 /// register with a physical register, check if any of the virtual register
1153 /// operand is a sub-register use or def. If so, make sure it won't result
1154 /// in an illegal extract_subreg or insert_subreg instruction. e.g.
1155 /// vr1024 = extract_subreg vr1025, 1
1156 /// ...
1157 /// vr1024 = mov8rr AH
1158 /// If vr1024 is coalesced with AH, the extract_subreg is now illegal since
1159 /// AH does not have a super-reg whose sub-register 1 is AH.
1160 bool
1161 SimpleRegisterCoalescing::HasIncompatibleSubRegDefUse(MachineInstr *CopyMI,
1162                                                       unsigned VirtReg,
1163                                                       unsigned PhysReg) {
1164   for (MachineRegisterInfo::reg_iterator I = mri_->reg_begin(VirtReg),
1165          E = mri_->reg_end(); I != E; ++I) {
1166     MachineOperand &O = I.getOperand();
1167     MachineInstr *MI = &*I;
1168     if (MI == CopyMI || JoinedCopies.count(MI))
1169       continue;
1170     unsigned SubIdx = O.getSubReg();
1171     if (SubIdx && !tri_->getSubReg(PhysReg, SubIdx))
1172       return true;
1173     if (MI->getOpcode() == TargetInstrInfo::EXTRACT_SUBREG) {
1174       SubIdx = MI->getOperand(2).getImm();
1175       if (O.isUse() && !tri_->getSubReg(PhysReg, SubIdx))
1176         return true;
1177       if (O.isDef()) {
1178         unsigned SrcReg = MI->getOperand(1).getReg();
1179         const TargetRegisterClass *RC =
1180           TargetRegisterInfo::isPhysicalRegister(SrcReg)
1181           ? tri_->getPhysicalRegisterRegClass(SrcReg)
1182           : mri_->getRegClass(SrcReg);
1183         if (!tri_->getMatchingSuperReg(PhysReg, SubIdx, RC))
1184           return true;
1185       }
1186     }
1187     if (MI->getOpcode() == TargetInstrInfo::INSERT_SUBREG ||
1188         MI->getOpcode() == TargetInstrInfo::SUBREG_TO_REG) {
1189       SubIdx = MI->getOperand(3).getImm();
1190       if (VirtReg == MI->getOperand(0).getReg()) {
1191         if (!tri_->getSubReg(PhysReg, SubIdx))
1192           return true;
1193       } else {
1194         unsigned DstReg = MI->getOperand(0).getReg();
1195         const TargetRegisterClass *RC =
1196           TargetRegisterInfo::isPhysicalRegister(DstReg)
1197           ? tri_->getPhysicalRegisterRegClass(DstReg)
1198           : mri_->getRegClass(DstReg);
1199         if (!tri_->getMatchingSuperReg(PhysReg, SubIdx, RC))
1200           return true;
1201       }
1202     }
1203   }
1204   return false;
1205 }
1206
1207
1208 /// CanJoinExtractSubRegToPhysReg - Return true if it's possible to coalesce
1209 /// an extract_subreg where dst is a physical register, e.g.
1210 /// cl = EXTRACT_SUBREG reg1024, 1
1211 bool
1212 SimpleRegisterCoalescing::CanJoinExtractSubRegToPhysReg(unsigned DstReg,
1213                                                unsigned SrcReg, unsigned SubIdx,
1214                                                unsigned &RealDstReg) {
1215   const TargetRegisterClass *RC = mri_->getRegClass(SrcReg);
1216   RealDstReg = tri_->getMatchingSuperReg(DstReg, SubIdx, RC);
1217   assert(RealDstReg && "Invalid extract_subreg instruction!");
1218
1219   // For this type of EXTRACT_SUBREG, conservatively
1220   // check if the live interval of the source register interfere with the
1221   // actual super physical register we are trying to coalesce with.
1222   LiveInterval &RHS = li_->getInterval(SrcReg);
1223   if (li_->hasInterval(RealDstReg) &&
1224       RHS.overlaps(li_->getInterval(RealDstReg))) {
1225     DEBUG({
1226         dbgs() << "Interfere with register ";
1227         li_->getInterval(RealDstReg).print(dbgs(), tri_);
1228       });
1229     return false; // Not coalescable
1230   }
1231   for (const unsigned* SR = tri_->getSubRegisters(RealDstReg); *SR; ++SR)
1232     if (li_->hasInterval(*SR) && RHS.overlaps(li_->getInterval(*SR))) {
1233       DEBUG({
1234           dbgs() << "Interfere with sub-register ";
1235           li_->getInterval(*SR).print(dbgs(), tri_);
1236         });
1237       return false; // Not coalescable
1238     }
1239   return true;
1240 }
1241
1242 /// CanJoinInsertSubRegToPhysReg - Return true if it's possible to coalesce
1243 /// an insert_subreg where src is a physical register, e.g.
1244 /// reg1024 = INSERT_SUBREG reg1024, c1, 0
1245 bool
1246 SimpleRegisterCoalescing::CanJoinInsertSubRegToPhysReg(unsigned DstReg,
1247                                                unsigned SrcReg, unsigned SubIdx,
1248                                                unsigned &RealSrcReg) {
1249   const TargetRegisterClass *RC = mri_->getRegClass(DstReg);
1250   RealSrcReg = tri_->getMatchingSuperReg(SrcReg, SubIdx, RC);
1251   assert(RealSrcReg && "Invalid extract_subreg instruction!");
1252
1253   LiveInterval &RHS = li_->getInterval(DstReg);
1254   if (li_->hasInterval(RealSrcReg) &&
1255       RHS.overlaps(li_->getInterval(RealSrcReg))) {
1256     DEBUG({
1257         dbgs() << "Interfere with register ";
1258         li_->getInterval(RealSrcReg).print(dbgs(), tri_);
1259       });
1260     return false; // Not coalescable
1261   }
1262   for (const unsigned* SR = tri_->getSubRegisters(RealSrcReg); *SR; ++SR)
1263     if (li_->hasInterval(*SR) && RHS.overlaps(li_->getInterval(*SR))) {
1264       DEBUG({
1265           dbgs() << "Interfere with sub-register ";
1266           li_->getInterval(*SR).print(dbgs(), tri_);
1267         });
1268       return false; // Not coalescable
1269     }
1270   return true;
1271 }
1272
1273 /// getRegAllocPreference - Return register allocation preference register.
1274 ///
1275 static unsigned getRegAllocPreference(unsigned Reg, MachineFunction &MF,
1276                                       MachineRegisterInfo *MRI,
1277                                       const TargetRegisterInfo *TRI) {
1278   if (TargetRegisterInfo::isPhysicalRegister(Reg))
1279     return 0;
1280   std::pair<unsigned, unsigned> Hint = MRI->getRegAllocationHint(Reg);
1281   return TRI->ResolveRegAllocHint(Hint.first, Hint.second, MF);
1282 }
1283
1284 /// JoinCopy - Attempt to join intervals corresponding to SrcReg/DstReg,
1285 /// which are the src/dst of the copy instruction CopyMI.  This returns true
1286 /// if the copy was successfully coalesced away. If it is not currently
1287 /// possible to coalesce this interval, but it may be possible if other
1288 /// things get coalesced, then it returns true by reference in 'Again'.
1289 bool SimpleRegisterCoalescing::JoinCopy(CopyRec &TheCopy, bool &Again) {
1290   MachineInstr *CopyMI = TheCopy.MI;
1291
1292   Again = false;
1293   if (JoinedCopies.count(CopyMI) || ReMatCopies.count(CopyMI))
1294     return false; // Already done.
1295
1296   DEBUG(dbgs() << li_->getInstructionIndex(CopyMI) << '\t' << *CopyMI);
1297
1298   unsigned SrcReg, DstReg, SrcSubIdx = 0, DstSubIdx = 0;
1299   bool isExtSubReg = CopyMI->getOpcode() == TargetInstrInfo::EXTRACT_SUBREG;
1300   bool isInsSubReg = CopyMI->getOpcode() == TargetInstrInfo::INSERT_SUBREG;
1301   bool isSubRegToReg = CopyMI->getOpcode() == TargetInstrInfo::SUBREG_TO_REG;
1302   unsigned SubIdx = 0;
1303   if (isExtSubReg) {
1304     DstReg    = CopyMI->getOperand(0).getReg();
1305     DstSubIdx = CopyMI->getOperand(0).getSubReg();
1306     SrcReg    = CopyMI->getOperand(1).getReg();
1307     SrcSubIdx = CopyMI->getOperand(2).getImm();
1308   } else if (isInsSubReg || isSubRegToReg) {
1309     DstReg    = CopyMI->getOperand(0).getReg();
1310     DstSubIdx = CopyMI->getOperand(3).getImm();
1311     SrcReg    = CopyMI->getOperand(2).getReg();
1312     SrcSubIdx = CopyMI->getOperand(2).getSubReg();
1313     if (SrcSubIdx && SrcSubIdx != DstSubIdx) {
1314       // r1025 = INSERT_SUBREG r1025, r1024<2>, 2 Then r1024 has already been
1315       // coalesced to a larger register so the subreg indices cancel out.
1316       DEBUG(dbgs() << "\tSource of insert_subreg or subreg_to_reg is already "
1317                       "coalesced to another register.\n");
1318       return false;  // Not coalescable.
1319     }
1320   } else if (tii_->isMoveInstr(*CopyMI, SrcReg, DstReg, SrcSubIdx, DstSubIdx)) {
1321     if (SrcSubIdx && DstSubIdx && SrcSubIdx != DstSubIdx) {
1322       // e.g. %reg16404:1<def> = MOV8rr %reg16412:2<kill>
1323       Again = true;
1324       return false;  // Not coalescable.
1325     }
1326   } else {
1327     llvm_unreachable("Unrecognized copy instruction!");
1328   }
1329
1330   // If they are already joined we continue.
1331   if (SrcReg == DstReg) {
1332     DEBUG(dbgs() << "\tCopy already coalesced.\n");
1333     return false;  // Not coalescable.
1334   }
1335
1336   bool SrcIsPhys = TargetRegisterInfo::isPhysicalRegister(SrcReg);
1337   bool DstIsPhys = TargetRegisterInfo::isPhysicalRegister(DstReg);
1338
1339   // If they are both physical registers, we cannot join them.
1340   if (SrcIsPhys && DstIsPhys) {
1341     DEBUG(dbgs() << "\tCan not coalesce physregs.\n");
1342     return false;  // Not coalescable.
1343   }
1344
1345   // We only join virtual registers with allocatable physical registers.
1346   if (SrcIsPhys && !allocatableRegs_[SrcReg]) {
1347     DEBUG(dbgs() << "\tSrc reg is unallocatable physreg.\n");
1348     return false;  // Not coalescable.
1349   }
1350   if (DstIsPhys && !allocatableRegs_[DstReg]) {
1351     DEBUG(dbgs() << "\tDst reg is unallocatable physreg.\n");
1352     return false;  // Not coalescable.
1353   }
1354
1355   // Check that a physical source register is compatible with dst regclass
1356   if (SrcIsPhys) {
1357     unsigned SrcSubReg = SrcSubIdx ?
1358       tri_->getSubReg(SrcReg, SrcSubIdx) : SrcReg;
1359     const TargetRegisterClass *DstRC = mri_->getRegClass(DstReg);
1360     const TargetRegisterClass *DstSubRC = DstRC;
1361     if (DstSubIdx)
1362       DstSubRC = DstRC->getSubRegisterRegClass(DstSubIdx);
1363     assert(DstSubRC && "Illegal subregister index");
1364     if (!DstSubRC->contains(SrcSubReg)) {
1365       DEBUG(dbgs() << "\tIncompatible destination regclass: "
1366                    << tri_->getName(SrcSubReg) << " not in "
1367                    << DstSubRC->getName() << ".\n");
1368       return false;             // Not coalescable.
1369     }
1370   }
1371
1372   // Check that a physical dst register is compatible with source regclass
1373   if (DstIsPhys) {
1374     unsigned DstSubReg = DstSubIdx ?
1375       tri_->getSubReg(DstReg, DstSubIdx) : DstReg;
1376     const TargetRegisterClass *SrcRC = mri_->getRegClass(SrcReg);
1377     const TargetRegisterClass *SrcSubRC = SrcRC;
1378     if (SrcSubIdx)
1379       SrcSubRC = SrcRC->getSubRegisterRegClass(SrcSubIdx);
1380     assert(SrcSubRC && "Illegal subregister index");
1381     if (!SrcSubRC->contains(DstSubReg)) {
1382       DEBUG(dbgs() << "\tIncompatible source regclass: "
1383                    << tri_->getName(DstSubReg) << " not in "
1384                    << SrcSubRC->getName() << ".\n");
1385       (void)DstSubReg;
1386       return false;             // Not coalescable.
1387     }
1388   }
1389
1390   // Should be non-null only when coalescing to a sub-register class.
1391   bool CrossRC = false;
1392   const TargetRegisterClass *SrcRC= SrcIsPhys ? 0 : mri_->getRegClass(SrcReg);
1393   const TargetRegisterClass *DstRC= DstIsPhys ? 0 : mri_->getRegClass(DstReg);
1394   const TargetRegisterClass *NewRC = NULL;
1395   MachineBasicBlock *CopyMBB = CopyMI->getParent();
1396   unsigned RealDstReg = 0;
1397   unsigned RealSrcReg = 0;
1398   if (isExtSubReg || isInsSubReg || isSubRegToReg) {
1399     SubIdx = CopyMI->getOperand(isExtSubReg ? 2 : 3).getImm();
1400     if (SrcIsPhys && isExtSubReg) {
1401       // r1024 = EXTRACT_SUBREG EAX, 0 then r1024 is really going to be
1402       // coalesced with AX.
1403       unsigned DstSubIdx = CopyMI->getOperand(0).getSubReg();
1404       if (DstSubIdx) {
1405         // r1024<2> = EXTRACT_SUBREG EAX, 2. Then r1024 has already been
1406         // coalesced to a larger register so the subreg indices cancel out.
1407         if (DstSubIdx != SubIdx) {
1408           DEBUG(dbgs() << "\t Sub-register indices mismatch.\n");
1409           return false; // Not coalescable.
1410         }
1411       } else
1412         SrcReg = tri_->getSubReg(SrcReg, SubIdx);
1413       SubIdx = 0;
1414     } else if (DstIsPhys && (isInsSubReg || isSubRegToReg)) {
1415       // EAX = INSERT_SUBREG EAX, r1024, 0
1416       unsigned SrcSubIdx = CopyMI->getOperand(2).getSubReg();
1417       if (SrcSubIdx) {
1418         // EAX = INSERT_SUBREG EAX, r1024<2>, 2 Then r1024 has already been
1419         // coalesced to a larger register so the subreg indices cancel out.
1420         if (SrcSubIdx != SubIdx) {
1421           DEBUG(dbgs() << "\t Sub-register indices mismatch.\n");
1422           return false; // Not coalescable.
1423         }
1424       } else
1425         DstReg = tri_->getSubReg(DstReg, SubIdx);
1426       SubIdx = 0;
1427     } else if ((DstIsPhys && isExtSubReg) ||
1428                (SrcIsPhys && (isInsSubReg || isSubRegToReg))) {
1429       if (!isSubRegToReg && CopyMI->getOperand(1).getSubReg()) {
1430         DEBUG(dbgs() << "\tSrc of extract_subreg already coalesced with reg"
1431                      << " of a super-class.\n");
1432         return false; // Not coalescable.
1433       }
1434
1435       if (isExtSubReg) {
1436         if (!CanJoinExtractSubRegToPhysReg(DstReg, SrcReg, SubIdx, RealDstReg))
1437           return false; // Not coalescable
1438       } else {
1439         if (!CanJoinInsertSubRegToPhysReg(DstReg, SrcReg, SubIdx, RealSrcReg))
1440           return false; // Not coalescable
1441       }
1442       SubIdx = 0;
1443     } else {
1444       unsigned OldSubIdx = isExtSubReg ? CopyMI->getOperand(0).getSubReg()
1445         : CopyMI->getOperand(2).getSubReg();
1446       if (OldSubIdx) {
1447         if (OldSubIdx == SubIdx && !differingRegisterClasses(SrcReg, DstReg))
1448           // r1024<2> = EXTRACT_SUBREG r1025, 2. Then r1024 has already been
1449           // coalesced to a larger register so the subreg indices cancel out.
1450           // Also check if the other larger register is of the same register
1451           // class as the would be resulting register.
1452           SubIdx = 0;
1453         else {
1454           DEBUG(dbgs() << "\t Sub-register indices mismatch.\n");
1455           return false; // Not coalescable.
1456         }
1457       }
1458       if (SubIdx) {
1459         if (!DstIsPhys && !SrcIsPhys) {
1460           if (isInsSubReg || isSubRegToReg) {
1461             NewRC = tri_->getMatchingSuperRegClass(DstRC, SrcRC, SubIdx);
1462           } else // extract_subreg {
1463             NewRC = tri_->getMatchingSuperRegClass(SrcRC, DstRC, SubIdx);
1464           }
1465         if (!NewRC) {
1466           DEBUG(dbgs() << "\t Conflicting sub-register indices.\n");
1467           return false;  // Not coalescable
1468         }
1469
1470         unsigned LargeReg = isExtSubReg ? SrcReg : DstReg;
1471         unsigned SmallReg = isExtSubReg ? DstReg : SrcReg;
1472         unsigned Limit= allocatableRCRegs_[mri_->getRegClass(SmallReg)].count();
1473         if (!isWinToJoinCrossClass(LargeReg, SmallReg, Limit)) {
1474           Again = true;  // May be possible to coalesce later.
1475           return false;
1476         }
1477       }
1478     }
1479   } else if (differingRegisterClasses(SrcReg, DstReg)) {
1480     if (DisableCrossClassJoin)
1481       return false;
1482     CrossRC = true;
1483
1484     // FIXME: What if the result of a EXTRACT_SUBREG is then coalesced
1485     // with another? If it's the resulting destination register, then
1486     // the subidx must be propagated to uses (but only those defined
1487     // by the EXTRACT_SUBREG). If it's being coalesced into another
1488     // register, it should be safe because register is assumed to have
1489     // the register class of the super-register.
1490
1491     // Process moves where one of the registers have a sub-register index.
1492     MachineOperand *DstMO = CopyMI->findRegisterDefOperand(DstReg);
1493     MachineOperand *SrcMO = CopyMI->findRegisterUseOperand(SrcReg);
1494     SubIdx = DstMO->getSubReg();
1495     if (SubIdx) {
1496       if (SrcMO->getSubReg())
1497         // FIXME: can we handle this?
1498         return false;
1499       // This is not an insert_subreg but it looks like one.
1500       // e.g. %reg1024:4 = MOV32rr %EAX
1501       isInsSubReg = true;
1502       if (SrcIsPhys) {
1503         if (!CanJoinInsertSubRegToPhysReg(DstReg, SrcReg, SubIdx, RealSrcReg))
1504           return false; // Not coalescable
1505         SubIdx = 0;
1506       }
1507     } else {
1508       SubIdx = SrcMO->getSubReg();
1509       if (SubIdx) {
1510         // This is not a extract_subreg but it looks like one.
1511         // e.g. %cl = MOV16rr %reg1024:1
1512         isExtSubReg = true;
1513         if (DstIsPhys) {
1514           if (!CanJoinExtractSubRegToPhysReg(DstReg, SrcReg, SubIdx,RealDstReg))
1515             return false; // Not coalescable
1516           SubIdx = 0;
1517         }
1518       }
1519     }
1520
1521     unsigned LargeReg = SrcReg;
1522     unsigned SmallReg = DstReg;
1523
1524     // Now determine the register class of the joined register.
1525     if (isExtSubReg) {
1526       if (SubIdx && DstRC && DstRC->isASubClass()) {
1527         // This is a move to a sub-register class. However, the source is a
1528         // sub-register of a larger register class. We don't know what should
1529         // the register class be. FIXME.
1530         Again = true;
1531         return false;
1532       }
1533       if (!DstIsPhys && !SrcIsPhys)
1534         NewRC = SrcRC;
1535     } else if (!SrcIsPhys && !DstIsPhys) {
1536       NewRC = getCommonSubClass(SrcRC, DstRC);
1537       if (!NewRC) {
1538         DEBUG(dbgs() << "\tDisjoint regclasses: "
1539                      << SrcRC->getName() << ", "
1540                      << DstRC->getName() << ".\n");
1541         return false;           // Not coalescable.
1542       }
1543       if (DstRC->getSize() > SrcRC->getSize())
1544         std::swap(LargeReg, SmallReg);
1545     }
1546
1547     // If we are joining two virtual registers and the resulting register
1548     // class is more restrictive (fewer register, smaller size). Check if it's
1549     // worth doing the merge.
1550     if (!SrcIsPhys && !DstIsPhys &&
1551         (isExtSubReg || DstRC->isASubClass()) &&
1552         !isWinToJoinCrossClass(LargeReg, SmallReg,
1553                                allocatableRCRegs_[NewRC].count())) {
1554       DEBUG(dbgs() << "\tSrc/Dest are different register classes.\n");
1555       // Allow the coalescer to try again in case either side gets coalesced to
1556       // a physical register that's compatible with the other side. e.g.
1557       // r1024 = MOV32to32_ r1025
1558       // But later r1024 is assigned EAX then r1025 may be coalesced with EAX.
1559       Again = true;  // May be possible to coalesce later.
1560       return false;
1561     }
1562   }
1563
1564   // Will it create illegal extract_subreg / insert_subreg?
1565   if (SrcIsPhys && HasIncompatibleSubRegDefUse(CopyMI, DstReg, SrcReg))
1566     return false;
1567   if (DstIsPhys && HasIncompatibleSubRegDefUse(CopyMI, SrcReg, DstReg))
1568     return false;
1569
1570   LiveInterval &SrcInt = li_->getInterval(SrcReg);
1571   LiveInterval &DstInt = li_->getInterval(DstReg);
1572   assert(SrcInt.reg == SrcReg && DstInt.reg == DstReg &&
1573          "Register mapping is horribly broken!");
1574
1575   DEBUG({
1576       dbgs() << "\t\tInspecting "; SrcInt.print(dbgs(), tri_);
1577       dbgs() << " and "; DstInt.print(dbgs(), tri_);
1578       dbgs() << ": ";
1579     });
1580
1581   // Save a copy of the virtual register live interval. We'll manually
1582   // merge this into the "real" physical register live interval this is
1583   // coalesced with.
1584   LiveInterval *SavedLI = 0;
1585   if (RealDstReg)
1586     SavedLI = li_->dupInterval(&SrcInt);
1587   else if (RealSrcReg)
1588     SavedLI = li_->dupInterval(&DstInt);
1589
1590   // Check if it is necessary to propagate "isDead" property.
1591   if (!isExtSubReg && !isInsSubReg && !isSubRegToReg) {
1592     MachineOperand *mopd = CopyMI->findRegisterDefOperand(DstReg, false);
1593     bool isDead = mopd->isDead();
1594
1595     // We need to be careful about coalescing a source physical register with a
1596     // virtual register. Once the coalescing is done, it cannot be broken and
1597     // these are not spillable! If the destination interval uses are far away,
1598     // think twice about coalescing them!
1599     if (!isDead && (SrcIsPhys || DstIsPhys)) {
1600       // If the copy is in a loop, take care not to coalesce aggressively if the
1601       // src is coming in from outside the loop (or the dst is out of the loop).
1602       // If it's not in a loop, then determine whether to join them base purely
1603       // by the length of the interval.
1604       if (PhysJoinTweak) {
1605         if (SrcIsPhys) {
1606           if (!isWinToJoinVRWithSrcPhysReg(CopyMI, CopyMBB, DstInt, SrcInt)) {
1607             mri_->setRegAllocationHint(DstInt.reg, 0, SrcReg);
1608             ++numAborts;
1609             DEBUG(dbgs() << "\tMay tie down a physical register, abort!\n");
1610             Again = true;  // May be possible to coalesce later.
1611             return false;
1612           }
1613         } else {
1614           if (!isWinToJoinVRWithDstPhysReg(CopyMI, CopyMBB, DstInt, SrcInt)) {
1615             mri_->setRegAllocationHint(SrcInt.reg, 0, DstReg);
1616             ++numAborts;
1617             DEBUG(dbgs() << "\tMay tie down a physical register, abort!\n");
1618             Again = true;  // May be possible to coalesce later.
1619             return false;
1620           }
1621         }
1622       } else {
1623         // If the virtual register live interval is long but it has low use
1624         // density, do not join them, instead mark the physical register as its
1625         // allocation preference.
1626         LiveInterval &JoinVInt = SrcIsPhys ? DstInt : SrcInt;
1627         unsigned JoinVReg = SrcIsPhys ? DstReg : SrcReg;
1628         unsigned JoinPReg = SrcIsPhys ? SrcReg : DstReg;
1629         const TargetRegisterClass *RC = mri_->getRegClass(JoinVReg);
1630         unsigned Threshold = allocatableRCRegs_[RC].count() * 2;
1631         unsigned Length = li_->getApproximateInstructionCount(JoinVInt);
1632         float Ratio = 1.0 / Threshold;
1633         if (Length > Threshold &&
1634             (((float)std::distance(mri_->use_begin(JoinVReg),
1635                                    mri_->use_end()) / Length) < Ratio)) {
1636           mri_->setRegAllocationHint(JoinVInt.reg, 0, JoinPReg);
1637           ++numAborts;
1638           DEBUG(dbgs() << "\tMay tie down a physical register, abort!\n");
1639           Again = true;  // May be possible to coalesce later.
1640           return false;
1641         }
1642       }
1643     }
1644   }
1645
1646   // Okay, attempt to join these two intervals.  On failure, this returns false.
1647   // Otherwise, if one of the intervals being joined is a physreg, this method
1648   // always canonicalizes DstInt to be it.  The output "SrcInt" will not have
1649   // been modified, so we can use this information below to update aliases.
1650   bool Swapped = false;
1651   // If SrcInt is implicitly defined, it's safe to coalesce.
1652   bool isEmpty = SrcInt.empty();
1653   if (isEmpty && !CanCoalesceWithImpDef(CopyMI, DstInt, SrcInt)) {
1654     // Only coalesce an empty interval (defined by implicit_def) with
1655     // another interval which has a valno defined by the CopyMI and the CopyMI
1656     // is a kill of the implicit def.
1657     DEBUG(dbgs() << "Not profitable!\n");
1658     return false;
1659   }
1660
1661   if (!isEmpty && !JoinIntervals(DstInt, SrcInt, Swapped)) {
1662     // Coalescing failed.
1663
1664     // If definition of source is defined by trivial computation, try
1665     // rematerializing it.
1666     if (!isExtSubReg && !isInsSubReg && !isSubRegToReg &&
1667         ReMaterializeTrivialDef(SrcInt, DstReg, DstSubIdx, CopyMI))
1668       return true;
1669
1670     // If we can eliminate the copy without merging the live ranges, do so now.
1671     if (!isExtSubReg && !isInsSubReg && !isSubRegToReg &&
1672         (AdjustCopiesBackFrom(SrcInt, DstInt, CopyMI) ||
1673          RemoveCopyByCommutingDef(SrcInt, DstInt, CopyMI))) {
1674       JoinedCopies.insert(CopyMI);
1675       return true;
1676     }
1677
1678     // Otherwise, we are unable to join the intervals.
1679     DEBUG(dbgs() << "Interference!\n");
1680     Again = true;  // May be possible to coalesce later.
1681     return false;
1682   }
1683
1684   LiveInterval *ResSrcInt = &SrcInt;
1685   LiveInterval *ResDstInt = &DstInt;
1686   if (Swapped) {
1687     std::swap(SrcReg, DstReg);
1688     std::swap(ResSrcInt, ResDstInt);
1689   }
1690   assert(TargetRegisterInfo::isVirtualRegister(SrcReg) &&
1691          "LiveInterval::join didn't work right!");
1692
1693   // If we're about to merge live ranges into a physical register live interval,
1694   // we have to update any aliased register's live ranges to indicate that they
1695   // have clobbered values for this range.
1696   if (TargetRegisterInfo::isPhysicalRegister(DstReg)) {
1697     // If this is a extract_subreg where dst is a physical register, e.g.
1698     // cl = EXTRACT_SUBREG reg1024, 1
1699     // then create and update the actual physical register allocated to RHS.
1700     if (RealDstReg || RealSrcReg) {
1701       LiveInterval &RealInt =
1702         li_->getOrCreateInterval(RealDstReg ? RealDstReg : RealSrcReg);
1703       for (LiveInterval::const_vni_iterator I = SavedLI->vni_begin(),
1704              E = SavedLI->vni_end(); I != E; ++I) {
1705         const VNInfo *ValNo = *I;
1706         VNInfo *NewValNo = RealInt.getNextValue(ValNo->def, ValNo->getCopy(),
1707                                                 false, // updated at *
1708                                                 li_->getVNInfoAllocator());
1709         NewValNo->setFlags(ValNo->getFlags()); // * updated here.
1710         RealInt.addKills(NewValNo, ValNo->kills);
1711         RealInt.MergeValueInAsValue(*SavedLI, ValNo, NewValNo);
1712       }
1713       RealInt.weight += SavedLI->weight;
1714       DstReg = RealDstReg ? RealDstReg : RealSrcReg;
1715     }
1716
1717     // Update the liveintervals of sub-registers.
1718     for (const unsigned *AS = tri_->getSubRegisters(DstReg); *AS; ++AS)
1719       li_->getOrCreateInterval(*AS).MergeInClobberRanges(*li_, *ResSrcInt,
1720                                                  li_->getVNInfoAllocator());
1721   }
1722
1723   // If this is a EXTRACT_SUBREG, make sure the result of coalescing is the
1724   // larger super-register.
1725   if ((isExtSubReg || isInsSubReg || isSubRegToReg) &&
1726       !SrcIsPhys && !DstIsPhys) {
1727     if ((isExtSubReg && !Swapped) ||
1728         ((isInsSubReg || isSubRegToReg) && Swapped)) {
1729       ResSrcInt->Copy(*ResDstInt, mri_, li_->getVNInfoAllocator());
1730       std::swap(SrcReg, DstReg);
1731       std::swap(ResSrcInt, ResDstInt);
1732     }
1733   }
1734
1735   // Coalescing to a virtual register that is of a sub-register class of the
1736   // other. Make sure the resulting register is set to the right register class.
1737   if (CrossRC)
1738     ++numCrossRCs;
1739
1740   // This may happen even if it's cross-rc coalescing. e.g.
1741   // %reg1026<def> = SUBREG_TO_REG 0, %reg1037<kill>, 4
1742   // reg1026 -> GR64, reg1037 -> GR32_ABCD. The resulting register will have to
1743   // be allocate a register from GR64_ABCD.
1744   if (NewRC)
1745     mri_->setRegClass(DstReg, NewRC);
1746
1747   // Remember to delete the copy instruction.
1748   JoinedCopies.insert(CopyMI);
1749
1750   // Some live range has been lengthened due to colaescing, eliminate the
1751   // unnecessary kills.
1752   RemoveUnnecessaryKills(SrcReg, *ResDstInt);
1753   if (TargetRegisterInfo::isVirtualRegister(DstReg))
1754     RemoveUnnecessaryKills(DstReg, *ResDstInt);
1755
1756   UpdateRegDefsUses(SrcReg, DstReg, SubIdx);
1757
1758   // If we have extended the live range of a physical register, make sure we
1759   // update live-in lists as well.
1760   if (TargetRegisterInfo::isPhysicalRegister(DstReg)) {
1761     const LiveInterval &VRegInterval = li_->getInterval(SrcReg);
1762     SmallVector<MachineBasicBlock*, 16> BlockSeq;
1763     for (LiveInterval::const_iterator I = VRegInterval.begin(),
1764            E = VRegInterval.end(); I != E; ++I ) {
1765       li_->findLiveInMBBs(I->start, I->end, BlockSeq);
1766       for (unsigned idx = 0, size = BlockSeq.size(); idx != size; ++idx) {
1767         MachineBasicBlock &block = *BlockSeq[idx];
1768         if (!block.isLiveIn(DstReg))
1769           block.addLiveIn(DstReg);
1770       }
1771       BlockSeq.clear();
1772     }
1773   }
1774
1775   // SrcReg is guarateed to be the register whose live interval that is
1776   // being merged.
1777   li_->removeInterval(SrcReg);
1778
1779   // Update regalloc hint.
1780   tri_->UpdateRegAllocHint(SrcReg, DstReg, *mf_);
1781
1782   // Manually deleted the live interval copy.
1783   if (SavedLI) {
1784     SavedLI->clear();
1785     delete SavedLI;
1786   }
1787
1788   // If resulting interval has a preference that no longer fits because of subreg
1789   // coalescing, just clear the preference.
1790   unsigned Preference = getRegAllocPreference(ResDstInt->reg, *mf_, mri_, tri_);
1791   if (Preference && (isExtSubReg || isInsSubReg || isSubRegToReg) &&
1792       TargetRegisterInfo::isVirtualRegister(ResDstInt->reg)) {
1793     const TargetRegisterClass *RC = mri_->getRegClass(ResDstInt->reg);
1794     if (!RC->contains(Preference))
1795       mri_->setRegAllocationHint(ResDstInt->reg, 0, 0);
1796   }
1797
1798   DEBUG({
1799       dbgs() << "\n\t\tJoined.  Result = ";
1800       ResDstInt->print(dbgs(), tri_);
1801       dbgs() << "\n";
1802     });
1803
1804   ++numJoins;
1805   return true;
1806 }
1807
1808 /// ComputeUltimateVN - Assuming we are going to join two live intervals,
1809 /// compute what the resultant value numbers for each value in the input two
1810 /// ranges will be.  This is complicated by copies between the two which can
1811 /// and will commonly cause multiple value numbers to be merged into one.
1812 ///
1813 /// VN is the value number that we're trying to resolve.  InstDefiningValue
1814 /// keeps track of the new InstDefiningValue assignment for the result
1815 /// LiveInterval.  ThisFromOther/OtherFromThis are sets that keep track of
1816 /// whether a value in this or other is a copy from the opposite set.
1817 /// ThisValNoAssignments/OtherValNoAssignments keep track of value #'s that have
1818 /// already been assigned.
1819 ///
1820 /// ThisFromOther[x] - If x is defined as a copy from the other interval, this
1821 /// contains the value number the copy is from.
1822 ///
1823 static unsigned ComputeUltimateVN(VNInfo *VNI,
1824                                   SmallVector<VNInfo*, 16> &NewVNInfo,
1825                                   DenseMap<VNInfo*, VNInfo*> &ThisFromOther,
1826                                   DenseMap<VNInfo*, VNInfo*> &OtherFromThis,
1827                                   SmallVector<int, 16> &ThisValNoAssignments,
1828                                   SmallVector<int, 16> &OtherValNoAssignments) {
1829   unsigned VN = VNI->id;
1830
1831   // If the VN has already been computed, just return it.
1832   if (ThisValNoAssignments[VN] >= 0)
1833     return ThisValNoAssignments[VN];
1834 //  assert(ThisValNoAssignments[VN] != -2 && "Cyclic case?");
1835
1836   // If this val is not a copy from the other val, then it must be a new value
1837   // number in the destination.
1838   DenseMap<VNInfo*, VNInfo*>::iterator I = ThisFromOther.find(VNI);
1839   if (I == ThisFromOther.end()) {
1840     NewVNInfo.push_back(VNI);
1841     return ThisValNoAssignments[VN] = NewVNInfo.size()-1;
1842   }
1843   VNInfo *OtherValNo = I->second;
1844
1845   // Otherwise, this *is* a copy from the RHS.  If the other side has already
1846   // been computed, return it.
1847   if (OtherValNoAssignments[OtherValNo->id] >= 0)
1848     return ThisValNoAssignments[VN] = OtherValNoAssignments[OtherValNo->id];
1849
1850   // Mark this value number as currently being computed, then ask what the
1851   // ultimate value # of the other value is.
1852   ThisValNoAssignments[VN] = -2;
1853   unsigned UltimateVN =
1854     ComputeUltimateVN(OtherValNo, NewVNInfo, OtherFromThis, ThisFromOther,
1855                       OtherValNoAssignments, ThisValNoAssignments);
1856   return ThisValNoAssignments[VN] = UltimateVN;
1857 }
1858
1859 static bool InVector(VNInfo *Val, const SmallVector<VNInfo*, 8> &V) {
1860   return std::find(V.begin(), V.end(), Val) != V.end();
1861 }
1862
1863 static bool isValNoDefMove(const MachineInstr *MI, unsigned DR, unsigned SR,
1864                            const TargetInstrInfo *TII,
1865                            const TargetRegisterInfo *TRI) {
1866   unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
1867   if (TII->isMoveInstr(*MI, SrcReg, DstReg, SrcSubIdx, DstSubIdx))
1868     ;
1869   else if (MI->getOpcode() == TargetInstrInfo::EXTRACT_SUBREG) {
1870     DstReg = MI->getOperand(0).getReg();
1871     SrcReg = MI->getOperand(1).getReg();
1872   } else if (MI->getOpcode() == TargetInstrInfo::SUBREG_TO_REG ||
1873              MI->getOpcode() == TargetInstrInfo::INSERT_SUBREG) {
1874     DstReg = MI->getOperand(0).getReg();
1875     SrcReg = MI->getOperand(2).getReg();
1876   } else
1877     return false;
1878   return (SrcReg == SR || TRI->isSuperRegister(SR, SrcReg)) &&
1879          (DstReg == DR || TRI->isSuperRegister(DR, DstReg));
1880 }
1881
1882 /// RangeIsDefinedByCopyFromReg - Return true if the specified live range of
1883 /// the specified live interval is defined by a copy from the specified
1884 /// register.
1885 bool SimpleRegisterCoalescing::RangeIsDefinedByCopyFromReg(LiveInterval &li,
1886                                                            LiveRange *LR,
1887                                                            unsigned Reg) {
1888   unsigned SrcReg = li_->getVNInfoSourceReg(LR->valno);
1889   if (SrcReg == Reg)
1890     return true;
1891   // FIXME: Do isPHIDef and isDefAccurate both need to be tested?
1892   if ((LR->valno->isPHIDef() || !LR->valno->isDefAccurate()) &&
1893       TargetRegisterInfo::isPhysicalRegister(li.reg) &&
1894       *tri_->getSuperRegisters(li.reg)) {
1895     // It's a sub-register live interval, we may not have precise information.
1896     // Re-compute it.
1897     MachineInstr *DefMI = li_->getInstructionFromIndex(LR->start);
1898     if (DefMI && isValNoDefMove(DefMI, li.reg, Reg, tii_, tri_)) {
1899       // Cache computed info.
1900       LR->valno->def = LR->start;
1901       LR->valno->setCopy(DefMI);
1902       return true;
1903     }
1904   }
1905   return false;
1906 }
1907
1908
1909 /// ValueLiveAt - Return true if the LiveRange pointed to by the given
1910 /// iterator, or any subsequent range with the same value number,
1911 /// is live at the given point.
1912 bool SimpleRegisterCoalescing::ValueLiveAt(LiveInterval::iterator LRItr,
1913                                            LiveInterval::iterator LREnd,
1914                                            SlotIndex defPoint) const {
1915   for (const VNInfo *valno = LRItr->valno;
1916        (LRItr != LREnd) && (LRItr->valno == valno); ++LRItr) {
1917     if (LRItr->contains(defPoint))
1918       return true;
1919   }
1920
1921   return false;
1922 }
1923
1924
1925 /// SimpleJoin - Attempt to joint the specified interval into this one. The
1926 /// caller of this method must guarantee that the RHS only contains a single
1927 /// value number and that the RHS is not defined by a copy from this
1928 /// interval.  This returns false if the intervals are not joinable, or it
1929 /// joins them and returns true.
1930 bool SimpleRegisterCoalescing::SimpleJoin(LiveInterval &LHS, LiveInterval &RHS){
1931   assert(RHS.containsOneValue());
1932
1933   // Some number (potentially more than one) value numbers in the current
1934   // interval may be defined as copies from the RHS.  Scan the overlapping
1935   // portions of the LHS and RHS, keeping track of this and looking for
1936   // overlapping live ranges that are NOT defined as copies.  If these exist, we
1937   // cannot coalesce.
1938
1939   LiveInterval::iterator LHSIt = LHS.begin(), LHSEnd = LHS.end();
1940   LiveInterval::iterator RHSIt = RHS.begin(), RHSEnd = RHS.end();
1941
1942   if (LHSIt->start < RHSIt->start) {
1943     LHSIt = std::upper_bound(LHSIt, LHSEnd, RHSIt->start);
1944     if (LHSIt != LHS.begin()) --LHSIt;
1945   } else if (RHSIt->start < LHSIt->start) {
1946     RHSIt = std::upper_bound(RHSIt, RHSEnd, LHSIt->start);
1947     if (RHSIt != RHS.begin()) --RHSIt;
1948   }
1949
1950   SmallVector<VNInfo*, 8> EliminatedLHSVals;
1951
1952   while (1) {
1953     // Determine if these live intervals overlap.
1954     bool Overlaps = false;
1955     if (LHSIt->start <= RHSIt->start)
1956       Overlaps = LHSIt->end > RHSIt->start;
1957     else
1958       Overlaps = RHSIt->end > LHSIt->start;
1959
1960     // If the live intervals overlap, there are two interesting cases: if the
1961     // LHS interval is defined by a copy from the RHS, it's ok and we record
1962     // that the LHS value # is the same as the RHS.  If it's not, then we cannot
1963     // coalesce these live ranges and we bail out.
1964     if (Overlaps) {
1965       // If we haven't already recorded that this value # is safe, check it.
1966       if (!InVector(LHSIt->valno, EliminatedLHSVals)) {
1967         // If it's re-defined by an early clobber somewhere in the live range,
1968         // then conservatively abort coalescing.
1969         if (LHSIt->valno->hasRedefByEC())
1970           return false;
1971         // Copy from the RHS?
1972         if (!RangeIsDefinedByCopyFromReg(LHS, LHSIt, RHS.reg))
1973           return false;    // Nope, bail out.
1974
1975         if (ValueLiveAt(LHSIt, LHS.end(), RHSIt->valno->def))
1976           // Here is an interesting situation:
1977           // BB1:
1978           //   vr1025 = copy vr1024
1979           //   ..
1980           // BB2:
1981           //   vr1024 = op
1982           //          = vr1025
1983           // Even though vr1025 is copied from vr1024, it's not safe to
1984           // coalesce them since the live range of vr1025 intersects the
1985           // def of vr1024. This happens because vr1025 is assigned the
1986           // value of the previous iteration of vr1024.
1987           return false;
1988         EliminatedLHSVals.push_back(LHSIt->valno);
1989       }
1990
1991       // We know this entire LHS live range is okay, so skip it now.
1992       if (++LHSIt == LHSEnd) break;
1993       continue;
1994     }
1995
1996     if (LHSIt->end < RHSIt->end) {
1997       if (++LHSIt == LHSEnd) break;
1998     } else {
1999       // One interesting case to check here.  It's possible that we have
2000       // something like "X3 = Y" which defines a new value number in the LHS,
2001       // and is the last use of this liverange of the RHS.  In this case, we
2002       // want to notice this copy (so that it gets coalesced away) even though
2003       // the live ranges don't actually overlap.
2004       if (LHSIt->start == RHSIt->end) {
2005         if (InVector(LHSIt->valno, EliminatedLHSVals)) {
2006           // We already know that this value number is going to be merged in
2007           // if coalescing succeeds.  Just skip the liverange.
2008           if (++LHSIt == LHSEnd) break;
2009         } else {
2010           // If it's re-defined by an early clobber somewhere in the live range,
2011           // then conservatively abort coalescing.
2012           if (LHSIt->valno->hasRedefByEC())
2013             return false;
2014           // Otherwise, if this is a copy from the RHS, mark it as being merged
2015           // in.
2016           if (RangeIsDefinedByCopyFromReg(LHS, LHSIt, RHS.reg)) {
2017             if (ValueLiveAt(LHSIt, LHS.end(), RHSIt->valno->def))
2018               // Here is an interesting situation:
2019               // BB1:
2020               //   vr1025 = copy vr1024
2021               //   ..
2022               // BB2:
2023               //   vr1024 = op
2024               //          = vr1025
2025               // Even though vr1025 is copied from vr1024, it's not safe to
2026               // coalesced them since live range of vr1025 intersects the
2027               // def of vr1024. This happens because vr1025 is assigned the
2028               // value of the previous iteration of vr1024.
2029               return false;
2030             EliminatedLHSVals.push_back(LHSIt->valno);
2031
2032             // We know this entire LHS live range is okay, so skip it now.
2033             if (++LHSIt == LHSEnd) break;
2034           }
2035         }
2036       }
2037
2038       if (++RHSIt == RHSEnd) break;
2039     }
2040   }
2041
2042   // If we got here, we know that the coalescing will be successful and that
2043   // the value numbers in EliminatedLHSVals will all be merged together.  Since
2044   // the most common case is that EliminatedLHSVals has a single number, we
2045   // optimize for it: if there is more than one value, we merge them all into
2046   // the lowest numbered one, then handle the interval as if we were merging
2047   // with one value number.
2048   VNInfo *LHSValNo = NULL;
2049   if (EliminatedLHSVals.size() > 1) {
2050     // Loop through all the equal value numbers merging them into the smallest
2051     // one.
2052     VNInfo *Smallest = EliminatedLHSVals[0];
2053     for (unsigned i = 1, e = EliminatedLHSVals.size(); i != e; ++i) {
2054       if (EliminatedLHSVals[i]->id < Smallest->id) {
2055         // Merge the current notion of the smallest into the smaller one.
2056         LHS.MergeValueNumberInto(Smallest, EliminatedLHSVals[i]);
2057         Smallest = EliminatedLHSVals[i];
2058       } else {
2059         // Merge into the smallest.
2060         LHS.MergeValueNumberInto(EliminatedLHSVals[i], Smallest);
2061       }
2062     }
2063     LHSValNo = Smallest;
2064   } else if (EliminatedLHSVals.empty()) {
2065     if (TargetRegisterInfo::isPhysicalRegister(LHS.reg) &&
2066         *tri_->getSuperRegisters(LHS.reg))
2067       // Imprecise sub-register information. Can't handle it.
2068       return false;
2069     llvm_unreachable("No copies from the RHS?");
2070   } else {
2071     LHSValNo = EliminatedLHSVals[0];
2072   }
2073
2074   // Okay, now that there is a single LHS value number that we're merging the
2075   // RHS into, update the value number info for the LHS to indicate that the
2076   // value number is defined where the RHS value number was.
2077   const VNInfo *VNI = RHS.getValNumInfo(0);
2078   LHSValNo->def  = VNI->def;
2079   LHSValNo->setCopy(VNI->getCopy());
2080
2081   // Okay, the final step is to loop over the RHS live intervals, adding them to
2082   // the LHS.
2083   if (VNI->hasPHIKill())
2084     LHSValNo->setHasPHIKill(true);
2085   LHS.addKills(LHSValNo, VNI->kills);
2086   LHS.MergeRangesInAsValue(RHS, LHSValNo);
2087
2088   LHS.ComputeJoinedWeight(RHS);
2089
2090   // Update regalloc hint if both are virtual registers.
2091   if (TargetRegisterInfo::isVirtualRegister(LHS.reg) &&
2092       TargetRegisterInfo::isVirtualRegister(RHS.reg)) {
2093     std::pair<unsigned, unsigned> RHSPref = mri_->getRegAllocationHint(RHS.reg);
2094     std::pair<unsigned, unsigned> LHSPref = mri_->getRegAllocationHint(LHS.reg);
2095     if (RHSPref != LHSPref)
2096       mri_->setRegAllocationHint(LHS.reg, RHSPref.first, RHSPref.second);
2097   }
2098
2099   // Update the liveintervals of sub-registers.
2100   if (TargetRegisterInfo::isPhysicalRegister(LHS.reg))
2101     for (const unsigned *AS = tri_->getSubRegisters(LHS.reg); *AS; ++AS)
2102       li_->getOrCreateInterval(*AS).MergeInClobberRanges(*li_, LHS,
2103                                                     li_->getVNInfoAllocator());
2104
2105   return true;
2106 }
2107
2108 /// JoinIntervals - Attempt to join these two intervals.  On failure, this
2109 /// returns false.  Otherwise, if one of the intervals being joined is a
2110 /// physreg, this method always canonicalizes LHS to be it.  The output
2111 /// "RHS" will not have been modified, so we can use this information
2112 /// below to update aliases.
2113 bool
2114 SimpleRegisterCoalescing::JoinIntervals(LiveInterval &LHS, LiveInterval &RHS,
2115                                         bool &Swapped) {
2116   // Compute the final value assignment, assuming that the live ranges can be
2117   // coalesced.
2118   SmallVector<int, 16> LHSValNoAssignments;
2119   SmallVector<int, 16> RHSValNoAssignments;
2120   DenseMap<VNInfo*, VNInfo*> LHSValsDefinedFromRHS;
2121   DenseMap<VNInfo*, VNInfo*> RHSValsDefinedFromLHS;
2122   SmallVector<VNInfo*, 16> NewVNInfo;
2123
2124   // If a live interval is a physical register, conservatively check if any
2125   // of its sub-registers is overlapping the live interval of the virtual
2126   // register. If so, do not coalesce.
2127   if (TargetRegisterInfo::isPhysicalRegister(LHS.reg) &&
2128       *tri_->getSubRegisters(LHS.reg)) {
2129     // If it's coalescing a virtual register to a physical register, estimate
2130     // its live interval length. This is the *cost* of scanning an entire live
2131     // interval. If the cost is low, we'll do an exhaustive check instead.
2132
2133     // If this is something like this:
2134     // BB1:
2135     // v1024 = op
2136     // ...
2137     // BB2:
2138     // ...
2139     // RAX   = v1024
2140     //
2141     // That is, the live interval of v1024 crosses a bb. Then we can't rely on
2142     // less conservative check. It's possible a sub-register is defined before
2143     // v1024 (or live in) and live out of BB1.
2144     if (RHS.containsOneValue() &&
2145         li_->intervalIsInOneMBB(RHS) &&
2146         li_->getApproximateInstructionCount(RHS) <= 10) {
2147       // Perform a more exhaustive check for some common cases.
2148       if (li_->conflictsWithPhysRegRef(RHS, LHS.reg, true, JoinedCopies))
2149         return false;
2150     } else {
2151       for (const unsigned* SR = tri_->getSubRegisters(LHS.reg); *SR; ++SR)
2152         if (li_->hasInterval(*SR) && RHS.overlaps(li_->getInterval(*SR))) {
2153           DEBUG({
2154               dbgs() << "Interfere with sub-register ";
2155               li_->getInterval(*SR).print(dbgs(), tri_);
2156             });
2157           return false;
2158         }
2159     }
2160   } else if (TargetRegisterInfo::isPhysicalRegister(RHS.reg) &&
2161              *tri_->getSubRegisters(RHS.reg)) {
2162     if (LHS.containsOneValue() &&
2163         li_->getApproximateInstructionCount(LHS) <= 10) {
2164       // Perform a more exhaustive check for some common cases.
2165       if (li_->conflictsWithPhysRegRef(LHS, RHS.reg, false, JoinedCopies))
2166         return false;
2167     } else {
2168       for (const unsigned* SR = tri_->getSubRegisters(RHS.reg); *SR; ++SR)
2169         if (li_->hasInterval(*SR) && LHS.overlaps(li_->getInterval(*SR))) {
2170           DEBUG({
2171               dbgs() << "Interfere with sub-register ";
2172               li_->getInterval(*SR).print(dbgs(), tri_);
2173             });
2174           return false;
2175         }
2176     }
2177   }
2178
2179   // Compute ultimate value numbers for the LHS and RHS values.
2180   if (RHS.containsOneValue()) {
2181     // Copies from a liveinterval with a single value are simple to handle and
2182     // very common, handle the special case here.  This is important, because
2183     // often RHS is small and LHS is large (e.g. a physreg).
2184
2185     // Find out if the RHS is defined as a copy from some value in the LHS.
2186     int RHSVal0DefinedFromLHS = -1;
2187     int RHSValID = -1;
2188     VNInfo *RHSValNoInfo = NULL;
2189     VNInfo *RHSValNoInfo0 = RHS.getValNumInfo(0);
2190     unsigned RHSSrcReg = li_->getVNInfoSourceReg(RHSValNoInfo0);
2191     if (RHSSrcReg == 0 || RHSSrcReg != LHS.reg) {
2192       // If RHS is not defined as a copy from the LHS, we can use simpler and
2193       // faster checks to see if the live ranges are coalescable.  This joiner
2194       // can't swap the LHS/RHS intervals though.
2195       if (!TargetRegisterInfo::isPhysicalRegister(RHS.reg)) {
2196         return SimpleJoin(LHS, RHS);
2197       } else {
2198         RHSValNoInfo = RHSValNoInfo0;
2199       }
2200     } else {
2201       // It was defined as a copy from the LHS, find out what value # it is.
2202       RHSValNoInfo =
2203         LHS.getLiveRangeContaining(RHSValNoInfo0->def.getPrevSlot())->valno;
2204       RHSValID = RHSValNoInfo->id;
2205       RHSVal0DefinedFromLHS = RHSValID;
2206     }
2207
2208     LHSValNoAssignments.resize(LHS.getNumValNums(), -1);
2209     RHSValNoAssignments.resize(RHS.getNumValNums(), -1);
2210     NewVNInfo.resize(LHS.getNumValNums(), NULL);
2211
2212     // Okay, *all* of the values in LHS that are defined as a copy from RHS
2213     // should now get updated.
2214     for (LiveInterval::vni_iterator i = LHS.vni_begin(), e = LHS.vni_end();
2215          i != e; ++i) {
2216       VNInfo *VNI = *i;
2217       unsigned VN = VNI->id;
2218       if (unsigned LHSSrcReg = li_->getVNInfoSourceReg(VNI)) {
2219         if (LHSSrcReg != RHS.reg) {
2220           // If this is not a copy from the RHS, its value number will be
2221           // unmodified by the coalescing.
2222           NewVNInfo[VN] = VNI;
2223           LHSValNoAssignments[VN] = VN;
2224         } else if (RHSValID == -1) {
2225           // Otherwise, it is a copy from the RHS, and we don't already have a
2226           // value# for it.  Keep the current value number, but remember it.
2227           LHSValNoAssignments[VN] = RHSValID = VN;
2228           NewVNInfo[VN] = RHSValNoInfo;
2229           LHSValsDefinedFromRHS[VNI] = RHSValNoInfo0;
2230         } else {
2231           // Otherwise, use the specified value #.
2232           LHSValNoAssignments[VN] = RHSValID;
2233           if (VN == (unsigned)RHSValID) {  // Else this val# is dead.
2234             NewVNInfo[VN] = RHSValNoInfo;
2235             LHSValsDefinedFromRHS[VNI] = RHSValNoInfo0;
2236           }
2237         }
2238       } else {
2239         NewVNInfo[VN] = VNI;
2240         LHSValNoAssignments[VN] = VN;
2241       }
2242     }
2243
2244     assert(RHSValID != -1 && "Didn't find value #?");
2245     RHSValNoAssignments[0] = RHSValID;
2246     if (RHSVal0DefinedFromLHS != -1) {
2247       // This path doesn't go through ComputeUltimateVN so just set
2248       // it to anything.
2249       RHSValsDefinedFromLHS[RHSValNoInfo0] = (VNInfo*)1;
2250     }
2251   } else {
2252     // Loop over the value numbers of the LHS, seeing if any are defined from
2253     // the RHS.
2254     for (LiveInterval::vni_iterator i = LHS.vni_begin(), e = LHS.vni_end();
2255          i != e; ++i) {
2256       VNInfo *VNI = *i;
2257       if (VNI->isUnused() || VNI->getCopy() == 0)  // Src not defined by a copy?
2258         continue;
2259
2260       // DstReg is known to be a register in the LHS interval.  If the src is
2261       // from the RHS interval, we can use its value #.
2262       if (li_->getVNInfoSourceReg(VNI) != RHS.reg)
2263         continue;
2264
2265       // Figure out the value # from the RHS.
2266       LiveRange *lr = RHS.getLiveRangeContaining(VNI->def.getPrevSlot());
2267       assert(lr && "Cannot find live range");
2268       LHSValsDefinedFromRHS[VNI] = lr->valno;
2269     }
2270
2271     // Loop over the value numbers of the RHS, seeing if any are defined from
2272     // the LHS.
2273     for (LiveInterval::vni_iterator i = RHS.vni_begin(), e = RHS.vni_end();
2274          i != e; ++i) {
2275       VNInfo *VNI = *i;
2276       if (VNI->isUnused() || VNI->getCopy() == 0)  // Src not defined by a copy?
2277         continue;
2278
2279       // DstReg is known to be a register in the RHS interval.  If the src is
2280       // from the LHS interval, we can use its value #.
2281       if (li_->getVNInfoSourceReg(VNI) != LHS.reg)
2282         continue;
2283
2284       // Figure out the value # from the LHS.
2285       LiveRange *lr = LHS.getLiveRangeContaining(VNI->def.getPrevSlot());
2286       assert(lr && "Cannot find live range");
2287       RHSValsDefinedFromLHS[VNI] = lr->valno;
2288     }
2289
2290     LHSValNoAssignments.resize(LHS.getNumValNums(), -1);
2291     RHSValNoAssignments.resize(RHS.getNumValNums(), -1);
2292     NewVNInfo.reserve(LHS.getNumValNums() + RHS.getNumValNums());
2293
2294     for (LiveInterval::vni_iterator i = LHS.vni_begin(), e = LHS.vni_end();
2295          i != e; ++i) {
2296       VNInfo *VNI = *i;
2297       unsigned VN = VNI->id;
2298       if (LHSValNoAssignments[VN] >= 0 || VNI->isUnused())
2299         continue;
2300       ComputeUltimateVN(VNI, NewVNInfo,
2301                         LHSValsDefinedFromRHS, RHSValsDefinedFromLHS,
2302                         LHSValNoAssignments, RHSValNoAssignments);
2303     }
2304     for (LiveInterval::vni_iterator i = RHS.vni_begin(), e = RHS.vni_end();
2305          i != e; ++i) {
2306       VNInfo *VNI = *i;
2307       unsigned VN = VNI->id;
2308       if (RHSValNoAssignments[VN] >= 0 || VNI->isUnused())
2309         continue;
2310       // If this value number isn't a copy from the LHS, it's a new number.
2311       if (RHSValsDefinedFromLHS.find(VNI) == RHSValsDefinedFromLHS.end()) {
2312         NewVNInfo.push_back(VNI);
2313         RHSValNoAssignments[VN] = NewVNInfo.size()-1;
2314         continue;
2315       }
2316
2317       ComputeUltimateVN(VNI, NewVNInfo,
2318                         RHSValsDefinedFromLHS, LHSValsDefinedFromRHS,
2319                         RHSValNoAssignments, LHSValNoAssignments);
2320     }
2321   }
2322
2323   // Armed with the mappings of LHS/RHS values to ultimate values, walk the
2324   // interval lists to see if these intervals are coalescable.
2325   LiveInterval::const_iterator I = LHS.begin();
2326   LiveInterval::const_iterator IE = LHS.end();
2327   LiveInterval::const_iterator J = RHS.begin();
2328   LiveInterval::const_iterator JE = RHS.end();
2329
2330   // Skip ahead until the first place of potential sharing.
2331   if (I->start < J->start) {
2332     I = std::upper_bound(I, IE, J->start);
2333     if (I != LHS.begin()) --I;
2334   } else if (J->start < I->start) {
2335     J = std::upper_bound(J, JE, I->start);
2336     if (J != RHS.begin()) --J;
2337   }
2338
2339   while (1) {
2340     // Determine if these two live ranges overlap.
2341     bool Overlaps;
2342     if (I->start < J->start) {
2343       Overlaps = I->end > J->start;
2344     } else {
2345       Overlaps = J->end > I->start;
2346     }
2347
2348     // If so, check value # info to determine if they are really different.
2349     if (Overlaps) {
2350       // If the live range overlap will map to the same value number in the
2351       // result liverange, we can still coalesce them.  If not, we can't.
2352       if (LHSValNoAssignments[I->valno->id] !=
2353           RHSValNoAssignments[J->valno->id])
2354         return false;
2355       // If it's re-defined by an early clobber somewhere in the live range,
2356       // then conservatively abort coalescing.
2357       if (NewVNInfo[LHSValNoAssignments[I->valno->id]]->hasRedefByEC())
2358         return false;
2359     }
2360
2361     if (I->end < J->end) {
2362       ++I;
2363       if (I == IE) break;
2364     } else {
2365       ++J;
2366       if (J == JE) break;
2367     }
2368   }
2369
2370   // Update kill info. Some live ranges are extended due to copy coalescing.
2371   for (DenseMap<VNInfo*, VNInfo*>::iterator I = LHSValsDefinedFromRHS.begin(),
2372          E = LHSValsDefinedFromRHS.end(); I != E; ++I) {
2373     VNInfo *VNI = I->first;
2374     unsigned LHSValID = LHSValNoAssignments[VNI->id];
2375     NewVNInfo[LHSValID]->removeKill(VNI->def);
2376     if (VNI->hasPHIKill())
2377       NewVNInfo[LHSValID]->setHasPHIKill(true);
2378     RHS.addKills(NewVNInfo[LHSValID], VNI->kills);
2379   }
2380
2381   // Update kill info. Some live ranges are extended due to copy coalescing.
2382   for (DenseMap<VNInfo*, VNInfo*>::iterator I = RHSValsDefinedFromLHS.begin(),
2383          E = RHSValsDefinedFromLHS.end(); I != E; ++I) {
2384     VNInfo *VNI = I->first;
2385     unsigned RHSValID = RHSValNoAssignments[VNI->id];
2386     NewVNInfo[RHSValID]->removeKill(VNI->def);
2387     if (VNI->hasPHIKill())
2388       NewVNInfo[RHSValID]->setHasPHIKill(true);
2389     LHS.addKills(NewVNInfo[RHSValID], VNI->kills);
2390   }
2391
2392   // If we get here, we know that we can coalesce the live ranges.  Ask the
2393   // intervals to coalesce themselves now.
2394   if ((RHS.ranges.size() > LHS.ranges.size() &&
2395       TargetRegisterInfo::isVirtualRegister(LHS.reg)) ||
2396       TargetRegisterInfo::isPhysicalRegister(RHS.reg)) {
2397     RHS.join(LHS, &RHSValNoAssignments[0], &LHSValNoAssignments[0], NewVNInfo,
2398              mri_);
2399     Swapped = true;
2400   } else {
2401     LHS.join(RHS, &LHSValNoAssignments[0], &RHSValNoAssignments[0], NewVNInfo,
2402              mri_);
2403     Swapped = false;
2404   }
2405   return true;
2406 }
2407
2408 namespace {
2409   // DepthMBBCompare - Comparison predicate that sort first based on the loop
2410   // depth of the basic block (the unsigned), and then on the MBB number.
2411   struct DepthMBBCompare {
2412     typedef std::pair<unsigned, MachineBasicBlock*> DepthMBBPair;
2413     bool operator()(const DepthMBBPair &LHS, const DepthMBBPair &RHS) const {
2414       // Deeper loops first
2415       if (LHS.first != RHS.first)
2416         return LHS.first > RHS.first;
2417
2418       // Prefer blocks that are more connected in the CFG. This takes care of
2419       // the most difficult copies first while intervals are short.
2420       unsigned cl = LHS.second->pred_size() + LHS.second->succ_size();
2421       unsigned cr = RHS.second->pred_size() + RHS.second->succ_size();
2422       if (cl != cr)
2423         return cl > cr;
2424
2425       // As a last resort, sort by block number.
2426       return LHS.second->getNumber() < RHS.second->getNumber();
2427     }
2428   };
2429 }
2430
2431 void SimpleRegisterCoalescing::CopyCoalesceInMBB(MachineBasicBlock *MBB,
2432                                                std::vector<CopyRec> &TryAgain) {
2433   DEBUG(dbgs() << MBB->getName() << ":\n");
2434
2435   std::vector<CopyRec> VirtCopies;
2436   std::vector<CopyRec> PhysCopies;
2437   std::vector<CopyRec> ImpDefCopies;
2438   for (MachineBasicBlock::iterator MII = MBB->begin(), E = MBB->end();
2439        MII != E;) {
2440     MachineInstr *Inst = MII++;
2441
2442     // If this isn't a copy nor a extract_subreg, we can't join intervals.
2443     unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
2444     bool isInsUndef = false;
2445     if (Inst->getOpcode() == TargetInstrInfo::EXTRACT_SUBREG) {
2446       DstReg = Inst->getOperand(0).getReg();
2447       SrcReg = Inst->getOperand(1).getReg();
2448     } else if (Inst->getOpcode() == TargetInstrInfo::INSERT_SUBREG) {
2449       DstReg = Inst->getOperand(0).getReg();
2450       SrcReg = Inst->getOperand(2).getReg();
2451       if (Inst->getOperand(1).isUndef())
2452         isInsUndef = true;
2453     } else if (Inst->getOpcode() == TargetInstrInfo::INSERT_SUBREG ||
2454                Inst->getOpcode() == TargetInstrInfo::SUBREG_TO_REG) {
2455       DstReg = Inst->getOperand(0).getReg();
2456       SrcReg = Inst->getOperand(2).getReg();
2457     } else if (!tii_->isMoveInstr(*Inst, SrcReg, DstReg, SrcSubIdx, DstSubIdx))
2458       continue;
2459
2460     bool SrcIsPhys = TargetRegisterInfo::isPhysicalRegister(SrcReg);
2461     bool DstIsPhys = TargetRegisterInfo::isPhysicalRegister(DstReg);
2462     if (isInsUndef ||
2463         (li_->hasInterval(SrcReg) && li_->getInterval(SrcReg).empty()))
2464       ImpDefCopies.push_back(CopyRec(Inst, 0));
2465     else if (SrcIsPhys || DstIsPhys)
2466       PhysCopies.push_back(CopyRec(Inst, 0));
2467     else
2468       VirtCopies.push_back(CopyRec(Inst, 0));
2469   }
2470
2471   // Try coalescing implicit copies and insert_subreg <undef> first,
2472   // followed by copies to / from physical registers, then finally copies
2473   // from virtual registers to virtual registers.
2474   for (unsigned i = 0, e = ImpDefCopies.size(); i != e; ++i) {
2475     CopyRec &TheCopy = ImpDefCopies[i];
2476     bool Again = false;
2477     if (!JoinCopy(TheCopy, Again))
2478       if (Again)
2479         TryAgain.push_back(TheCopy);
2480   }
2481   for (unsigned i = 0, e = PhysCopies.size(); i != e; ++i) {
2482     CopyRec &TheCopy = PhysCopies[i];
2483     bool Again = false;
2484     if (!JoinCopy(TheCopy, Again))
2485       if (Again)
2486         TryAgain.push_back(TheCopy);
2487   }
2488   for (unsigned i = 0, e = VirtCopies.size(); i != e; ++i) {
2489     CopyRec &TheCopy = VirtCopies[i];
2490     bool Again = false;
2491     if (!JoinCopy(TheCopy, Again))
2492       if (Again)
2493         TryAgain.push_back(TheCopy);
2494   }
2495 }
2496
2497 void SimpleRegisterCoalescing::joinIntervals() {
2498   DEBUG(dbgs() << "********** JOINING INTERVALS ***********\n");
2499
2500   std::vector<CopyRec> TryAgainList;
2501   if (loopInfo->empty()) {
2502     // If there are no loops in the function, join intervals in function order.
2503     for (MachineFunction::iterator I = mf_->begin(), E = mf_->end();
2504          I != E; ++I)
2505       CopyCoalesceInMBB(I, TryAgainList);
2506   } else {
2507     // Otherwise, join intervals in inner loops before other intervals.
2508     // Unfortunately we can't just iterate over loop hierarchy here because
2509     // there may be more MBB's than BB's.  Collect MBB's for sorting.
2510
2511     // Join intervals in the function prolog first. We want to join physical
2512     // registers with virtual registers before the intervals got too long.
2513     std::vector<std::pair<unsigned, MachineBasicBlock*> > MBBs;
2514     for (MachineFunction::iterator I = mf_->begin(), E = mf_->end();I != E;++I){
2515       MachineBasicBlock *MBB = I;
2516       MBBs.push_back(std::make_pair(loopInfo->getLoopDepth(MBB), I));
2517     }
2518
2519     // Sort by loop depth.
2520     std::sort(MBBs.begin(), MBBs.end(), DepthMBBCompare());
2521
2522     // Finally, join intervals in loop nest order.
2523     for (unsigned i = 0, e = MBBs.size(); i != e; ++i)
2524       CopyCoalesceInMBB(MBBs[i].second, TryAgainList);
2525   }
2526
2527   // Joining intervals can allow other intervals to be joined.  Iteratively join
2528   // until we make no progress.
2529   bool ProgressMade = true;
2530   while (ProgressMade) {
2531     ProgressMade = false;
2532
2533     for (unsigned i = 0, e = TryAgainList.size(); i != e; ++i) {
2534       CopyRec &TheCopy = TryAgainList[i];
2535       if (!TheCopy.MI)
2536         continue;
2537
2538       bool Again = false;
2539       bool Success = JoinCopy(TheCopy, Again);
2540       if (Success || !Again) {
2541         TheCopy.MI = 0;   // Mark this one as done.
2542         ProgressMade = true;
2543       }
2544     }
2545   }
2546 }
2547
2548 /// Return true if the two specified registers belong to different register
2549 /// classes.  The registers may be either phys or virt regs.
2550 bool
2551 SimpleRegisterCoalescing::differingRegisterClasses(unsigned RegA,
2552                                                    unsigned RegB) const {
2553   // Get the register classes for the first reg.
2554   if (TargetRegisterInfo::isPhysicalRegister(RegA)) {
2555     assert(TargetRegisterInfo::isVirtualRegister(RegB) &&
2556            "Shouldn't consider two physregs!");
2557     return !mri_->getRegClass(RegB)->contains(RegA);
2558   }
2559
2560   // Compare against the regclass for the second reg.
2561   const TargetRegisterClass *RegClassA = mri_->getRegClass(RegA);
2562   if (TargetRegisterInfo::isVirtualRegister(RegB)) {
2563     const TargetRegisterClass *RegClassB = mri_->getRegClass(RegB);
2564     return RegClassA != RegClassB;
2565   }
2566   return !RegClassA->contains(RegB);
2567 }
2568
2569 /// lastRegisterUse - Returns the last use of the specific register between
2570 /// cycles Start and End or NULL if there are no uses.
2571 MachineOperand *
2572 SimpleRegisterCoalescing::lastRegisterUse(SlotIndex Start,
2573                                           SlotIndex End,
2574                                           unsigned Reg,
2575                                           SlotIndex &UseIdx) const{
2576   UseIdx = SlotIndex();
2577   if (TargetRegisterInfo::isVirtualRegister(Reg)) {
2578     MachineOperand *LastUse = NULL;
2579     for (MachineRegisterInfo::use_iterator I = mri_->use_begin(Reg),
2580            E = mri_->use_end(); I != E; ++I) {
2581       MachineOperand &Use = I.getOperand();
2582       MachineInstr *UseMI = Use.getParent();
2583       unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
2584       if (tii_->isMoveInstr(*UseMI, SrcReg, DstReg, SrcSubIdx, DstSubIdx) &&
2585           SrcReg == DstReg)
2586         // Ignore identity copies.
2587         continue;
2588       SlotIndex Idx = li_->getInstructionIndex(UseMI);
2589       // FIXME: Should this be Idx != UseIdx? SlotIndex() will return something
2590       // that compares higher than any other interval.
2591       if (Idx >= Start && Idx < End && Idx >= UseIdx) {
2592         LastUse = &Use;
2593         UseIdx = Idx.getUseIndex();
2594       }
2595     }
2596     return LastUse;
2597   }
2598
2599   SlotIndex s = Start;
2600   SlotIndex e = End.getPrevSlot().getBaseIndex();
2601   while (e >= s) {
2602     // Skip deleted instructions
2603     MachineInstr *MI = li_->getInstructionFromIndex(e);
2604     while (e != SlotIndex() && e.getPrevIndex() >= s && !MI) {
2605       e = e.getPrevIndex();
2606       MI = li_->getInstructionFromIndex(e);
2607     }
2608     if (e < s || MI == NULL)
2609       return NULL;
2610
2611     // Ignore identity copies.
2612     unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
2613     if (!(tii_->isMoveInstr(*MI, SrcReg, DstReg, SrcSubIdx, DstSubIdx) &&
2614           SrcReg == DstReg))
2615       for (unsigned i = 0, NumOps = MI->getNumOperands(); i != NumOps; ++i) {
2616         MachineOperand &Use = MI->getOperand(i);
2617         if (Use.isReg() && Use.isUse() && Use.getReg() &&
2618             tri_->regsOverlap(Use.getReg(), Reg)) {
2619           UseIdx = e.getUseIndex();
2620           return &Use;
2621         }
2622       }
2623
2624     e = e.getPrevIndex();
2625   }
2626
2627   return NULL;
2628 }
2629
2630 void SimpleRegisterCoalescing::printRegName(unsigned reg) const {
2631   if (TargetRegisterInfo::isPhysicalRegister(reg))
2632     dbgs() << tri_->getName(reg);
2633   else
2634     dbgs() << "%reg" << reg;
2635 }
2636
2637 void SimpleRegisterCoalescing::releaseMemory() {
2638   JoinedCopies.clear();
2639   ReMatCopies.clear();
2640   ReMatDefs.clear();
2641 }
2642
2643 bool SimpleRegisterCoalescing::runOnMachineFunction(MachineFunction &fn) {
2644   mf_ = &fn;
2645   mri_ = &fn.getRegInfo();
2646   tm_ = &fn.getTarget();
2647   tri_ = tm_->getRegisterInfo();
2648   tii_ = tm_->getInstrInfo();
2649   li_ = &getAnalysis<LiveIntervals>();
2650   AA = &getAnalysis<AliasAnalysis>();
2651   loopInfo = &getAnalysis<MachineLoopInfo>();
2652
2653   DEBUG(dbgs() << "********** SIMPLE REGISTER COALESCING **********\n"
2654                << "********** Function: "
2655                << ((Value*)mf_->getFunction())->getName() << '\n');
2656
2657   allocatableRegs_ = tri_->getAllocatableSet(fn);
2658   for (TargetRegisterInfo::regclass_iterator I = tri_->regclass_begin(),
2659          E = tri_->regclass_end(); I != E; ++I)
2660     allocatableRCRegs_.insert(std::make_pair(*I,
2661                                              tri_->getAllocatableSet(fn, *I)));
2662
2663   // Join (coalesce) intervals if requested.
2664   if (EnableJoining) {
2665     joinIntervals();
2666     DEBUG({
2667         dbgs() << "********** INTERVALS POST JOINING **********\n";
2668         for (LiveIntervals::iterator I = li_->begin(), E = li_->end();
2669              I != E; ++I){
2670           I->second->print(dbgs(), tri_);
2671           dbgs() << "\n";
2672         }
2673       });
2674   }
2675
2676   // Perform a final pass over the instructions and compute spill weights
2677   // and remove identity moves.
2678   SmallVector<unsigned, 4> DeadDefs;
2679   for (MachineFunction::iterator mbbi = mf_->begin(), mbbe = mf_->end();
2680        mbbi != mbbe; ++mbbi) {
2681     MachineBasicBlock* mbb = mbbi;
2682     for (MachineBasicBlock::iterator mii = mbb->begin(), mie = mbb->end();
2683          mii != mie; ) {
2684       MachineInstr *MI = mii;
2685       unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
2686       if (JoinedCopies.count(MI)) {
2687         // Delete all coalesced copies.
2688         bool DoDelete = true;
2689         if (!tii_->isMoveInstr(*MI, SrcReg, DstReg, SrcSubIdx, DstSubIdx)) {
2690           assert((MI->getOpcode() == TargetInstrInfo::EXTRACT_SUBREG ||
2691                   MI->getOpcode() == TargetInstrInfo::INSERT_SUBREG ||
2692                   MI->getOpcode() == TargetInstrInfo::SUBREG_TO_REG) &&
2693                  "Unrecognized copy instruction");
2694           DstReg = MI->getOperand(0).getReg();
2695           if (TargetRegisterInfo::isPhysicalRegister(DstReg))
2696             // Do not delete extract_subreg, insert_subreg of physical
2697             // registers unless the definition is dead. e.g.
2698             // %DO<def> = INSERT_SUBREG %D0<undef>, %S0<kill>, 1
2699             // or else the scavenger may complain. LowerSubregs will
2700             // delete them later.
2701             DoDelete = false;
2702         }
2703         if (MI->registerDefIsDead(DstReg)) {
2704           LiveInterval &li = li_->getInterval(DstReg);
2705           if (!ShortenDeadCopySrcLiveRange(li, MI))
2706             ShortenDeadCopyLiveRange(li, MI);
2707           DoDelete = true;
2708         }
2709         if (!DoDelete)
2710           mii = llvm::next(mii);
2711         else {
2712           li_->RemoveMachineInstrFromMaps(MI);
2713           mii = mbbi->erase(mii);
2714           ++numPeep;
2715         }
2716         continue;
2717       }
2718
2719       // Now check if this is a remat'ed def instruction which is now dead.
2720       if (ReMatDefs.count(MI)) {
2721         bool isDead = true;
2722         for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
2723           const MachineOperand &MO = MI->getOperand(i);
2724           if (!MO.isReg())
2725             continue;
2726           unsigned Reg = MO.getReg();
2727           if (!Reg)
2728             continue;
2729           if (TargetRegisterInfo::isVirtualRegister(Reg))
2730             DeadDefs.push_back(Reg);
2731           if (MO.isDead())
2732             continue;
2733           if (TargetRegisterInfo::isPhysicalRegister(Reg) ||
2734               !mri_->use_empty(Reg)) {
2735             isDead = false;
2736             break;
2737           }
2738         }
2739         if (isDead) {
2740           while (!DeadDefs.empty()) {
2741             unsigned DeadDef = DeadDefs.back();
2742             DeadDefs.pop_back();
2743             RemoveDeadDef(li_->getInterval(DeadDef), MI);
2744           }
2745           li_->RemoveMachineInstrFromMaps(mii);
2746           mii = mbbi->erase(mii);
2747           continue;
2748         } else
2749           DeadDefs.clear();
2750       }
2751
2752       // If the move will be an identity move delete it
2753       bool isMove= tii_->isMoveInstr(*MI, SrcReg, DstReg, SrcSubIdx, DstSubIdx);
2754       if (isMove && SrcReg == DstReg) {
2755         if (li_->hasInterval(SrcReg)) {
2756           LiveInterval &RegInt = li_->getInterval(SrcReg);
2757           // If def of this move instruction is dead, remove its live range
2758           // from the dstination register's live interval.
2759           if (MI->registerDefIsDead(DstReg)) {
2760             if (!ShortenDeadCopySrcLiveRange(RegInt, MI))
2761               ShortenDeadCopyLiveRange(RegInt, MI);
2762           }
2763         }
2764         li_->RemoveMachineInstrFromMaps(MI);
2765         mii = mbbi->erase(mii);
2766         ++numPeep;
2767       } else {
2768         ++mii;
2769       }
2770     }
2771   }
2772
2773   DEBUG(dump());
2774   return true;
2775 }
2776
2777 /// print - Implement the dump method.
2778 void SimpleRegisterCoalescing::print(raw_ostream &O, const Module* m) const {
2779    li_->print(O, m);
2780 }
2781
2782 RegisterCoalescer* llvm::createSimpleRegisterCoalescer() {
2783   return new SimpleRegisterCoalescing();
2784 }
2785
2786 // Make sure that anything that uses RegisterCoalescer pulls in this file...
2787 DEFINING_FILE_FOR(SimpleRegisterCoalescing)