lib/CodeGen/SimpleRegisterCoalescing.cpp

   1 //===-- SimpleRegisterCoalescing.cpp - Register Coalescing ----------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source 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 "llvm/CodeGen/SimpleRegisterCoalescing.h"
  17 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
  18 #include "VirtRegMap.h"
  19 #include "llvm/Value.h"
  20 #include "llvm/Analysis/LoopInfo.h"
  21 #include "llvm/CodeGen/LiveVariables.h"
  22 #include "llvm/CodeGen/MachineFrameInfo.h"
  23 #include "llvm/CodeGen/MachineInstr.h"
  24 #include "llvm/CodeGen/Passes.h"
  25 #include "llvm/CodeGen/SSARegMap.h"
  26 #include "llvm/CodeGen/RegisterCoalescer.h"
  27 #include "llvm/Target/MRegisterInfo.h"
  28 #include "llvm/Target/TargetInstrInfo.h"
  29 #include "llvm/Target/TargetMachine.h"
  30 #include "llvm/Support/CommandLine.h"
  31 #include "llvm/Support/Debug.h"
  32 #include "llvm/ADT/SmallSet.h"
  33 #include "llvm/ADT/Statistic.h"
  34 #include "llvm/ADT/STLExtras.h"
  35 #include <algorithm>
  36 #include <cmath>
  37 using namespace llvm;
  38
  39 STATISTIC(numJoins    , "Number of interval joins performed");
  40 STATISTIC(numPeep     , "Number of identity moves eliminated after coalescing");
  41 STATISTIC(numAborts   , "Number of times interval joining aborted");
  42
  43 char SimpleRegisterCoalescing::ID = 0;
  44 namespace {
  45   static cl::opt<bool>
  46   EnableJoining("join-liveintervals",
  47                 cl::desc("Coalesce copies (default=true)"),
  48                 cl::init(true));
  49
  50   RegisterPass<SimpleRegisterCoalescing>
  51   X("simple-register-coalescing", "Simple Register Coalescing");
  52
  53   // Declare that we implement the RegisterCoalescer interface
  54   RegisterAnalysisGroup<RegisterCoalescer, true/*The Default*/> V(X);
  55 }
  56
  57 const PassInfo *llvm::SimpleRegisterCoalescingID = X.getPassInfo();
  58
  59 void SimpleRegisterCoalescing::getAnalysisUsage(AnalysisUsage &AU) const {
  60    //AU.addPreserved<LiveVariables>();
  61   AU.addPreserved<LiveIntervals>();
  62   AU.addPreservedID(PHIEliminationID);
  63   AU.addPreservedID(TwoAddressInstructionPassID);
  64   AU.addRequired<LiveVariables>();
  65   AU.addRequired<LiveIntervals>();
  66   AU.addRequired<LoopInfo>();
  67   MachineFunctionPass::getAnalysisUsage(AU);
  68 }
  69
  70 /// AdjustCopiesBackFrom - We found a non-trivially-coalescable copy with IntA
  71 /// being the source and IntB being the dest, thus this defines a value number
  72 /// in IntB.  If the source value number (in IntA) is defined by a copy from B,
  73 /// see if we can merge these two pieces of B into a single value number,
  74 /// eliminating a copy.  For example:
  75 ///
  76 ///  A3 = B0
  77 ///    ...
  78 ///  B1 = A3      <- this copy
  79 ///
  80 /// In this case, B0 can be extended to where the B1 copy lives, allowing the B1
  81 /// value number to be replaced with B0 (which simplifies the B liveinterval).
  82 ///
  83 /// This returns true if an interval was modified.
  84 ///
  85 bool SimpleRegisterCoalescing::AdjustCopiesBackFrom(LiveInterval &IntA, LiveInterval &IntB,
  86                                          MachineInstr *CopyMI) {
  87   unsigned CopyIdx = li_->getDefIndex(li_->getInstructionIndex(CopyMI));
  88
  89   // BValNo is a value number in B that is defined by a copy from A.  'B3' in
  90   // the example above.
  91   LiveInterval::iterator BLR = IntB.FindLiveRangeContaining(CopyIdx);
  92   VNInfo *BValNo = BLR->valno;
  93
  94   // Get the location that B is defined at.  Two options: either this value has
  95   // an unknown definition point or it is defined at CopyIdx.  If unknown, we
  96   // can't process it.
  97   if (!BValNo->reg) return false;
  98   assert(BValNo->def == CopyIdx &&
  99          "Copy doesn't define the value?");
 100
 101   // AValNo is the value number in A that defines the copy, A0 in the example.
 102   LiveInterval::iterator AValLR = IntA.FindLiveRangeContaining(CopyIdx-1);
 103   VNInfo *AValNo = AValLR->valno;
 104
 105   // If AValNo is defined as a copy from IntB, we can potentially process this.
 106
 107   // Get the instruction that defines this value number.
 108   unsigned SrcReg = AValNo->reg;
 109   if (!SrcReg) return false;  // Not defined by a copy.
 110
 111   // If the value number is not defined by a copy instruction, ignore it.
 112
 113   // If the source register comes from an interval other than IntB, we can't
 114   // handle this.
 115   if (rep(SrcReg) != IntB.reg) return false;
 116
 117   // Get the LiveRange in IntB that this value number starts with.
 118   LiveInterval::iterator ValLR = IntB.FindLiveRangeContaining(AValNo->def-1);
 119
 120   // Make sure that the end of the live range is inside the same block as
 121   // CopyMI.
 122   MachineInstr *ValLREndInst = li_->getInstructionFromIndex(ValLR->end-1);
 123   if (!ValLREndInst ||
 124       ValLREndInst->getParent() != CopyMI->getParent()) return false;
 125
 126   // Okay, we now know that ValLR ends in the same block that the CopyMI
 127   // live-range starts.  If there are no intervening live ranges between them in
 128   // IntB, we can merge them.
 129   if (ValLR+1 != BLR) return false;
 130
 131   // If a live interval is a physical register, conservatively check if any
 132   // of its sub-registers is overlapping the live interval of the virtual
 133   // register. If so, do not coalesce.
 134   if (MRegisterInfo::isPhysicalRegister(IntB.reg) &&
 135       *mri_->getSubRegisters(IntB.reg)) {
 136     for (const unsigned* SR = mri_->getSubRegisters(IntB.reg); *SR; ++SR)
 137       if (li_->hasInterval(*SR) && IntA.overlaps(li_->getInterval(*SR))) {
 138         DOUT << "Interfere with sub-register ";
 139         DEBUG(li_->getInterval(*SR).print(DOUT, mri_));
 140         return false;
 141       }
 142   }
 143
 144   DOUT << "\nExtending: "; IntB.print(DOUT, mri_);
 145
 146   unsigned FillerStart = ValLR->end, FillerEnd = BLR->start;
 147   // We are about to delete CopyMI, so need to remove it as the 'instruction
 148   // that defines this value #'. Update the the valnum with the new defining
 149   // instruction #.
 150   BValNo->def = FillerStart;
 151   BValNo->reg = 0;
 152
 153   // Okay, we can merge them.  We need to insert a new liverange:
 154   // [ValLR.end, BLR.begin) of either value number, then we merge the
 155   // two value numbers.
 156   IntB.addRange(LiveRange(FillerStart, FillerEnd, BValNo));
 157
 158   // If the IntB live range is assigned to a physical register, and if that
 159   // physreg has aliases,
 160   if (MRegisterInfo::isPhysicalRegister(IntB.reg)) {
 161     // Update the liveintervals of sub-registers.
 162     for (const unsigned *AS = mri_->getSubRegisters(IntB.reg); *AS; ++AS) {
 163       LiveInterval &AliasLI = li_->getInterval(*AS);
 164       AliasLI.addRange(LiveRange(FillerStart, FillerEnd,
 165               AliasLI.getNextValue(FillerStart, 0, li_->getVNInfoAllocator())));
 166     }
 167   }
 168
 169   // Okay, merge "B1" into the same value number as "B0".
 170   if (BValNo != ValLR->valno)
 171     IntB.MergeValueNumberInto(BValNo, ValLR->valno);
 172   DOUT << "   result = "; IntB.print(DOUT, mri_);
 173   DOUT << "\n";
 174
 175   // If the source instruction was killing the source register before the
 176   // merge, unset the isKill marker given the live range has been extended.
 177   int UIdx = ValLREndInst->findRegisterUseOperandIdx(IntB.reg, true);
 178   if (UIdx != -1)
 179     ValLREndInst->getOperand(UIdx).unsetIsKill();
 180
 181   // Finally, delete the copy instruction.
 182   li_->RemoveMachineInstrFromMaps(CopyMI);
 183   CopyMI->eraseFromParent();
 184   ++numPeep;
 185   return true;
 186 }
 187
 188 /// JoinCopy - Attempt to join intervals corresponding to SrcReg/DstReg,
 189 /// which are the src/dst of the copy instruction CopyMI.  This returns true
 190 /// if the copy was successfully coalesced away, or if it is never possible
 191 /// to coalesce this copy, due to register constraints.  It returns
 192 /// false if it is not currently possible to coalesce this interval, but
 193 /// it may be possible if other things get coalesced.
 194 bool SimpleRegisterCoalescing::JoinCopy(MachineInstr *CopyMI,
 195                              unsigned SrcReg, unsigned DstReg, bool PhysOnly) {
 196   DOUT << li_->getInstructionIndex(CopyMI) << '\t' << *CopyMI;
 197
 198   // Get representative registers.
 199   unsigned repSrcReg = rep(SrcReg);
 200   unsigned repDstReg = rep(DstReg);
 201
 202   // If they are already joined we continue.
 203   if (repSrcReg == repDstReg) {
 204     DOUT << "\tCopy already coalesced.\n";
 205     return true;  // Not coalescable.
 206   }
 207
 208   bool SrcIsPhys = MRegisterInfo::isPhysicalRegister(repSrcReg);
 209   bool DstIsPhys = MRegisterInfo::isPhysicalRegister(repDstReg);
 210   if (PhysOnly && !SrcIsPhys && !DstIsPhys)
 211     // Only joining physical registers with virtual registers in this round.
 212     return true;
 213
 214   // If they are both physical registers, we cannot join them.
 215   if (SrcIsPhys && DstIsPhys) {
 216     DOUT << "\tCan not coalesce physregs.\n";
 217     return true;  // Not coalescable.
 218   }
 219
 220   // We only join virtual registers with allocatable physical registers.
 221   if (SrcIsPhys && !allocatableRegs_[repSrcReg]) {
 222     DOUT << "\tSrc reg is unallocatable physreg.\n";
 223     return true;  // Not coalescable.
 224   }
 225   if (DstIsPhys && !allocatableRegs_[repDstReg]) {
 226     DOUT << "\tDst reg is unallocatable physreg.\n";
 227     return true;  // Not coalescable.
 228   }
 229
 230   bool isExtSubReg = CopyMI->getOpcode() == TargetInstrInfo::EXTRACT_SUBREG;
 231   unsigned RealDstReg = 0;
 232   if (isExtSubReg) {
 233     unsigned SubIdx = CopyMI->getOperand(2).getImm();
 234     if (SrcIsPhys)
 235       // r1024 = EXTRACT_SUBREG EAX, 0 then r1024 is really going to be
 236       // coalesced with AX.
 237       repSrcReg = mri_->getSubReg(repSrcReg, SubIdx);
 238     else if (DstIsPhys) {
 239       // If this is a extract_subreg where dst is a physical register, e.g.
 240       // cl = EXTRACT_SUBREG reg1024, 1
 241       // then create and update the actual physical register allocated to RHS.
 242       const TargetRegisterClass *RC = mf_->getSSARegMap()->getRegClass(SrcReg);
 243       for (const unsigned *SRs = mri_->getSuperRegisters(repDstReg);
 244            unsigned SR = *SRs; ++SRs) {
 245         if (repDstReg == mri_->getSubReg(SR, SubIdx) &&
 246             RC->contains(SR)) {
 247           RealDstReg = SR;
 248           break;
 249         }
 250       }
 251       assert(RealDstReg && "Invalid extra_subreg instruction!");
 252
 253       // For this type of EXTRACT_SUBREG, conservatively
 254       // check if the live interval of the source register interfere with the
 255       // actual super physical register we are trying to coalesce with.
 256       LiveInterval &RHS = li_->getInterval(repSrcReg);
 257       if (li_->hasInterval(RealDstReg) &&
 258           RHS.overlaps(li_->getInterval(RealDstReg))) {
 259         DOUT << "Interfere with register ";
 260         DEBUG(li_->getInterval(RealDstReg).print(DOUT, mri_));
 261         return true; // Not coalescable
 262       }
 263       for (const unsigned* SR = mri_->getSubRegisters(RealDstReg); *SR; ++SR)
 264         if (li_->hasInterval(*SR) && RHS.overlaps(li_->getInterval(*SR))) {
 265           DOUT << "Interfere with sub-register ";
 266           DEBUG(li_->getInterval(*SR).print(DOUT, mri_));
 267           return true; // Not coalescable
 268         }
 269     } else if (li_->getInterval(repDstReg).getSize() >
 270                li_->getInterval(repSrcReg).getSize()) {
 271       // Be conservative. If both sides are virtual registers, do not coalesce
 272       // if the sub-register live interval is longer.
 273       return false;
 274     }
 275   } else if (differingRegisterClasses(repSrcReg, repDstReg)) {
 276     // If they are not of the same register class, we cannot join them.
 277     DOUT << "\tSrc/Dest are different register classes.\n";
 278     // Allow the coalescer to try again in case either side gets coalesced to
 279     // a physical register that's compatible with the other side. e.g.
 280     // r1024 = MOV32to32_ r1025
 281     // but later r1024 is assigned EAX then r1025 may be coalesced with EAX.
 282     return false;
 283   }
 284
 285   LiveInterval &SrcInt = li_->getInterval(repSrcReg);
 286   LiveInterval &DstInt = li_->getInterval(repDstReg);
 287   assert(SrcInt.reg == repSrcReg && DstInt.reg == repDstReg &&
 288          "Register mapping is horribly broken!");
 289
 290   DOUT << "\t\tInspecting "; SrcInt.print(DOUT, mri_);
 291   DOUT << " and "; DstInt.print(DOUT, mri_);
 292   DOUT << ": ";
 293
 294   // Check if it is necessary to propagate "isDead" property before intervals
 295   // are joined.
 296   MachineOperand *mopd = CopyMI->findRegisterDefOperand(DstReg);
 297   bool isDead = mopd->isDead();
 298   bool isShorten = false;
 299   unsigned SrcStart = 0, RemoveStart = 0;
 300   unsigned SrcEnd = 0, RemoveEnd = 0;
 301   if (isDead) {
 302     unsigned CopyIdx = li_->getInstructionIndex(CopyMI);
 303     LiveInterval::iterator SrcLR =
 304       SrcInt.FindLiveRangeContaining(li_->getUseIndex(CopyIdx));
 305     RemoveStart = SrcStart = SrcLR->start;
 306     RemoveEnd   = SrcEnd   = SrcLR->end;
 307     // The instruction which defines the src is only truly dead if there are
 308     // no intermediate uses and there isn't a use beyond the copy.
 309     // FIXME: find the last use, mark is kill and shorten the live range.
 310     if (SrcEnd > li_->getDefIndex(CopyIdx)) {
 311       isDead = false;
 312     } else {
 313       MachineOperand *MOU;
 314       MachineInstr *LastUse= lastRegisterUse(SrcStart, CopyIdx, repSrcReg, MOU);
 315       if (LastUse) {
 316         // Shorten the liveinterval to the end of last use.
 317         MOU->setIsKill();
 318         isDead = false;
 319         isShorten = true;
 320         RemoveStart = li_->getDefIndex(li_->getInstructionIndex(LastUse));
 321         RemoveEnd   = SrcEnd;
 322       } else {
 323         MachineInstr *SrcMI = li_->getInstructionFromIndex(SrcStart);
 324         if (SrcMI) {
 325           MachineOperand *mops = findDefOperand(SrcMI, repSrcReg);
 326           if (mops)
 327             // A dead def should have a single cycle interval.
 328             ++RemoveStart;
 329         }
 330       }
 331     }
 332   }
 333
 334   // We need to be careful about coalescing a source physical register with a
 335   // virtual register. Once the coalescing is done, it cannot be broken and
 336   // these are not spillable! If the destination interval uses are far away,
 337   // think twice about coalescing them!
 338   if (!mopd->isDead() && (SrcIsPhys || DstIsPhys) && !isExtSubReg) {
 339     LiveInterval &JoinVInt = SrcIsPhys ? DstInt : SrcInt;
 340     unsigned JoinVReg = SrcIsPhys ? repDstReg : repSrcReg;
 341     unsigned JoinPReg = SrcIsPhys ? repSrcReg : repDstReg;
 342     const TargetRegisterClass *RC = mf_->getSSARegMap()->getRegClass(JoinVReg);
 343     unsigned Threshold = allocatableRCRegs_[RC].count();
 344
 345     // If the virtual register live interval is long but it has low use desity,
 346     // do not join them, instead mark the physical register as its allocation
 347     // preference.
 348     unsigned Length = JoinVInt.getSize() / InstrSlots::NUM;
 349     LiveVariables::VarInfo &vi = lv_->getVarInfo(JoinVReg);
 350     if (Length > Threshold &&
 351         (((float)vi.NumUses / Length) < (1.0 / Threshold))) {
 352       JoinVInt.preference = JoinPReg;
 353       ++numAborts;
 354       DOUT << "\tMay tie down a physical register, abort!\n";
 355       return false;
 356     }
 357   }
 358
 359   // Okay, attempt to join these two intervals.  On failure, this returns false.
 360   // Otherwise, if one of the intervals being joined is a physreg, this method
 361   // always canonicalizes DstInt to be it.  The output "SrcInt" will not have
 362   // been modified, so we can use this information below to update aliases.
 363   bool Swapped = false;
 364   if (JoinIntervals(DstInt, SrcInt, Swapped)) {
 365     if (isDead) {
 366       // Result of the copy is dead. Propagate this property.
 367       if (SrcStart == 0) {
 368         assert(MRegisterInfo::isPhysicalRegister(repSrcReg) &&
 369                "Live-in must be a physical register!");
 370         // Live-in to the function but dead. Remove it from entry live-in set.
 371         // JoinIntervals may end up swapping the two intervals.
 372         mf_->begin()->removeLiveIn(repSrcReg);
 373       } else {
 374         MachineInstr *SrcMI = li_->getInstructionFromIndex(SrcStart);
 375         if (SrcMI) {
 376           MachineOperand *mops = findDefOperand(SrcMI, repSrcReg);
 377           if (mops)
 378             mops->setIsDead();
 379         }
 380       }
 381     }
 382
 383     if (isShorten || isDead) {
 384       // Shorten the destination live interval.
 385       if (Swapped)
 386         SrcInt.removeRange(RemoveStart, RemoveEnd);
 387     }
 388   } else {
 389     // Coalescing failed.
 390
 391     // If we can eliminate the copy without merging the live ranges, do so now.
 392     if (!isExtSubReg && AdjustCopiesBackFrom(SrcInt, DstInt, CopyMI))
 393       return true;
 394
 395     // Otherwise, we are unable to join the intervals.
 396     DOUT << "Interference!\n";
 397     return false;
 398   }
 399
 400   LiveInterval *ResSrcInt = &SrcInt;
 401   LiveInterval *ResDstInt = &DstInt;
 402   if (Swapped) {
 403     std::swap(repSrcReg, repDstReg);
 404     std::swap(ResSrcInt, ResDstInt);
 405   }
 406   assert(MRegisterInfo::isVirtualRegister(repSrcReg) &&
 407          "LiveInterval::join didn't work right!");
 408
 409   // If we're about to merge live ranges into a physical register live range,
 410   // we have to update any aliased register's live ranges to indicate that they
 411   // have clobbered values for this range.
 412   if (MRegisterInfo::isPhysicalRegister(repDstReg)) {
 413     // Unset unnecessary kills.
 414     if (!ResDstInt->containsOneValue()) {
 415       for (LiveInterval::Ranges::const_iterator I = ResSrcInt->begin(),
 416              E = ResSrcInt->end(); I != E; ++I)
 417         unsetRegisterKills(I->start, I->end, repDstReg);
 418     }
 419
 420     // If this is a extract_subreg where dst is a physical register, e.g.
 421     // cl = EXTRACT_SUBREG reg1024, 1
 422     // then create and update the actual physical register allocated to RHS.
 423     if (RealDstReg) {
 424       LiveInterval &RealDstInt = li_->getOrCreateInterval(RealDstReg);
 425       for (unsigned i = 0, e = ResSrcInt->getNumValNums(); i != e; ++i) {
 426         const VNInfo *SrcValNo = ResSrcInt->getValNumInfo(i);
 427         const VNInfo *DstValNo =
 428           ResDstInt->FindLiveRangeContaining(SrcValNo->def)->valno;
 429         VNInfo *ValNo = RealDstInt.getNextValue(DstValNo->def, DstValNo->reg,
 430                                                 li_->getVNInfoAllocator());
 431         RealDstInt.addKills(ValNo, DstValNo->kills);
 432         RealDstInt.MergeValueInAsValue(*ResDstInt, DstValNo, ValNo);
 433       }
 434       repDstReg = RealDstReg;
 435     }
 436
 437     // Update the liveintervals of sub-registers.
 438     for (const unsigned *AS = mri_->getSubRegisters(repDstReg); *AS; ++AS)
 439       li_->getOrCreateInterval(*AS).MergeInClobberRanges(*ResSrcInt,
 440                                                  li_->getVNInfoAllocator());
 441   } else {
 442     // Merge use info if the destination is a virtual register.
 443     LiveVariables::VarInfo& dVI = lv_->getVarInfo(repDstReg);
 444     LiveVariables::VarInfo& sVI = lv_->getVarInfo(repSrcReg);
 445     dVI.NumUses += sVI.NumUses;
 446   }
 447
 448   // Remember these liveintervals have been joined.
 449   JoinedLIs.set(repSrcReg - MRegisterInfo::FirstVirtualRegister);
 450   if (MRegisterInfo::isVirtualRegister(repDstReg))
 451     JoinedLIs.set(repDstReg - MRegisterInfo::FirstVirtualRegister);
 452
 453   if (isExtSubReg && !SrcIsPhys && !DstIsPhys) {
 454     if (!Swapped) {
 455       // Make sure we allocate the larger super-register.
 456       ResSrcInt->Copy(*ResDstInt, li_->getVNInfoAllocator());
 457       std::swap(repSrcReg, repDstReg);
 458       std::swap(ResSrcInt, ResDstInt);
 459     }
 460     SubRegIdxes.push_back(std::make_pair(repSrcReg,
 461                                          CopyMI->getOperand(2).getImm()));
 462   }
 463
 464   DOUT << "\n\t\tJoined.  Result = "; ResDstInt->print(DOUT, mri_);
 465   DOUT << "\n";
 466
 467   // repSrcReg is guarateed to be the register whose live interval that is
 468   // being merged.
 469   li_->removeInterval(repSrcReg);
 470   r2rMap_[repSrcReg] = repDstReg;
 471
 472   // Finally, delete the copy instruction.
 473   li_->RemoveMachineInstrFromMaps(CopyMI);
 474   CopyMI->eraseFromParent();
 475   ++numPeep;
 476   ++numJoins;
 477   return true;
 478 }
 479
 480 /// ComputeUltimateVN - Assuming we are going to join two live intervals,
 481 /// compute what the resultant value numbers for each value in the input two
 482 /// ranges will be.  This is complicated by copies between the two which can
 483 /// and will commonly cause multiple value numbers to be merged into one.
 484 ///
 485 /// VN is the value number that we're trying to resolve.  InstDefiningValue
 486 /// keeps track of the new InstDefiningValue assignment for the result
 487 /// LiveInterval.  ThisFromOther/OtherFromThis are sets that keep track of
 488 /// whether a value in this or other is a copy from the opposite set.
 489 /// ThisValNoAssignments/OtherValNoAssignments keep track of value #'s that have
 490 /// already been assigned.
 491 ///
 492 /// ThisFromOther[x] - If x is defined as a copy from the other interval, this
 493 /// contains the value number the copy is from.
 494 ///
 495 static unsigned ComputeUltimateVN(VNInfo *VNI,
 496                                   SmallVector<VNInfo*, 16> &NewVNInfo,
 497                                   DenseMap<VNInfo*, VNInfo*> &ThisFromOther,
 498                                   DenseMap<VNInfo*, VNInfo*> &OtherFromThis,
 499                                   SmallVector<int, 16> &ThisValNoAssignments,
 500                                   SmallVector<int, 16> &OtherValNoAssignments) {
 501   unsigned VN = VNI->id;
 502
 503   // If the VN has already been computed, just return it.
 504   if (ThisValNoAssignments[VN] >= 0)
 505     return ThisValNoAssignments[VN];
 506 //  assert(ThisValNoAssignments[VN] != -2 && "Cyclic case?");
 507
 508   // If this val is not a copy from the other val, then it must be a new value
 509   // number in the destination.
 510   DenseMap<VNInfo*, VNInfo*>::iterator I = ThisFromOther.find(VNI);
 511   if (I == ThisFromOther.end()) {
 512     NewVNInfo.push_back(VNI);
 513     return ThisValNoAssignments[VN] = NewVNInfo.size()-1;
 514   }
 515   VNInfo *OtherValNo = I->second;
 516
 517   // Otherwise, this *is* a copy from the RHS.  If the other side has already
 518   // been computed, return it.
 519   if (OtherValNoAssignments[OtherValNo->id] >= 0)
 520     return ThisValNoAssignments[VN] = OtherValNoAssignments[OtherValNo->id];
 521
 522   // Mark this value number as currently being computed, then ask what the
 523   // ultimate value # of the other value is.
 524   ThisValNoAssignments[VN] = -2;
 525   unsigned UltimateVN =
 526     ComputeUltimateVN(OtherValNo, NewVNInfo, OtherFromThis, ThisFromOther,
 527                       OtherValNoAssignments, ThisValNoAssignments);
 528   return ThisValNoAssignments[VN] = UltimateVN;
 529 }
 530
 531 static bool InVector(VNInfo *Val, const SmallVector<VNInfo*, 8> &V) {
 532   return std::find(V.begin(), V.end(), Val) != V.end();
 533 }
 534
 535 /// SimpleJoin - Attempt to joint the specified interval into this one. The
 536 /// caller of this method must guarantee that the RHS only contains a single
 537 /// value number and that the RHS is not defined by a copy from this
 538 /// interval.  This returns false if the intervals are not joinable, or it
 539 /// joins them and returns true.
 540 bool SimpleRegisterCoalescing::SimpleJoin(LiveInterval &LHS, LiveInterval &RHS) {
 541   assert(RHS.containsOneValue());
 542
 543   // Some number (potentially more than one) value numbers in the current
 544   // interval may be defined as copies from the RHS.  Scan the overlapping
 545   // portions of the LHS and RHS, keeping track of this and looking for
 546   // overlapping live ranges that are NOT defined as copies.  If these exist, we
 547   // cannot coalesce.
 548
 549   LiveInterval::iterator LHSIt = LHS.begin(), LHSEnd = LHS.end();
 550   LiveInterval::iterator RHSIt = RHS.begin(), RHSEnd = RHS.end();
 551
 552   if (LHSIt->start < RHSIt->start) {
 553     LHSIt = std::upper_bound(LHSIt, LHSEnd, RHSIt->start);
 554     if (LHSIt != LHS.begin()) --LHSIt;
 555   } else if (RHSIt->start < LHSIt->start) {
 556     RHSIt = std::upper_bound(RHSIt, RHSEnd, LHSIt->start);
 557     if (RHSIt != RHS.begin()) --RHSIt;
 558   }
 559
 560   SmallVector<VNInfo*, 8> EliminatedLHSVals;
 561
 562   while (1) {
 563     // Determine if these live intervals overlap.
 564     bool Overlaps = false;
 565     if (LHSIt->start <= RHSIt->start)
 566       Overlaps = LHSIt->end > RHSIt->start;
 567     else
 568       Overlaps = RHSIt->end > LHSIt->start;
 569
 570     // If the live intervals overlap, there are two interesting cases: if the
 571     // LHS interval is defined by a copy from the RHS, it's ok and we record
 572     // that the LHS value # is the same as the RHS.  If it's not, then we cannot
 573     // coalesce these live ranges and we bail out.
 574     if (Overlaps) {
 575       // If we haven't already recorded that this value # is safe, check it.
 576       if (!InVector(LHSIt->valno, EliminatedLHSVals)) {
 577         // Copy from the RHS?
 578         unsigned SrcReg = LHSIt->valno->reg;
 579         if (rep(SrcReg) != RHS.reg)
 580           return false;    // Nope, bail out.
 581
 582         EliminatedLHSVals.push_back(LHSIt->valno);
 583       }
 584
 585       // We know this entire LHS live range is okay, so skip it now.
 586       if (++LHSIt == LHSEnd) break;
 587       continue;
 588     }
 589
 590     if (LHSIt->end < RHSIt->end) {
 591       if (++LHSIt == LHSEnd) break;
 592     } else {
 593       // One interesting case to check here.  It's possible that we have
 594       // something like "X3 = Y" which defines a new value number in the LHS,
 595       // and is the last use of this liverange of the RHS.  In this case, we
 596       // want to notice this copy (so that it gets coalesced away) even though
 597       // the live ranges don't actually overlap.
 598       if (LHSIt->start == RHSIt->end) {
 599         if (InVector(LHSIt->valno, EliminatedLHSVals)) {
 600           // We already know that this value number is going to be merged in
 601           // if coalescing succeeds.  Just skip the liverange.
 602           if (++LHSIt == LHSEnd) break;
 603         } else {
 604           // Otherwise, if this is a copy from the RHS, mark it as being merged
 605           // in.
 606           if (rep(LHSIt->valno->reg) == RHS.reg) {
 607             EliminatedLHSVals.push_back(LHSIt->valno);
 608
 609             // We know this entire LHS live range is okay, so skip it now.
 610             if (++LHSIt == LHSEnd) break;
 611           }
 612         }
 613       }
 614
 615       if (++RHSIt == RHSEnd) break;
 616     }
 617   }
 618
 619   // If we got here, we know that the coalescing will be successful and that
 620   // the value numbers in EliminatedLHSVals will all be merged together.  Since
 621   // the most common case is that EliminatedLHSVals has a single number, we
 622   // optimize for it: if there is more than one value, we merge them all into
 623   // the lowest numbered one, then handle the interval as if we were merging
 624   // with one value number.
 625   VNInfo *LHSValNo;
 626   if (EliminatedLHSVals.size() > 1) {
 627     // Loop through all the equal value numbers merging them into the smallest
 628     // one.
 629     VNInfo *Smallest = EliminatedLHSVals[0];
 630     for (unsigned i = 1, e = EliminatedLHSVals.size(); i != e; ++i) {
 631       if (EliminatedLHSVals[i]->id < Smallest->id) {
 632         // Merge the current notion of the smallest into the smaller one.
 633         LHS.MergeValueNumberInto(Smallest, EliminatedLHSVals[i]);
 634         Smallest = EliminatedLHSVals[i];
 635       } else {
 636         // Merge into the smallest.
 637         LHS.MergeValueNumberInto(EliminatedLHSVals[i], Smallest);
 638       }
 639     }
 640     LHSValNo = Smallest;
 641   } else {
 642     assert(!EliminatedLHSVals.empty() && "No copies from the RHS?");
 643     LHSValNo = EliminatedLHSVals[0];
 644   }
 645
 646   // Okay, now that there is a single LHS value number that we're merging the
 647   // RHS into, update the value number info for the LHS to indicate that the
 648   // value number is defined where the RHS value number was.
 649   const VNInfo *VNI = RHS.getValNumInfo(0);
 650   LHSValNo->def = VNI->def;
 651   LHSValNo->reg = VNI->reg;
 652
 653   // Okay, the final step is to loop over the RHS live intervals, adding them to
 654   // the LHS.
 655   LHS.addKills(LHSValNo, VNI->kills);
 656   LHS.MergeRangesInAsValue(RHS, LHSValNo);
 657   LHS.weight += RHS.weight;
 658   if (RHS.preference && !LHS.preference)
 659     LHS.preference = RHS.preference;
 660
 661   return true;
 662 }
 663
 664 /// JoinIntervals - Attempt to join these two intervals.  On failure, this
 665 /// returns false.  Otherwise, if one of the intervals being joined is a
 666 /// physreg, this method always canonicalizes LHS to be it.  The output
 667 /// "RHS" will not have been modified, so we can use this information
 668 /// below to update aliases.
 669 bool SimpleRegisterCoalescing::JoinIntervals(LiveInterval &LHS,
 670                                              LiveInterval &RHS, bool &Swapped) {
 671   // Compute the final value assignment, assuming that the live ranges can be
 672   // coalesced.
 673   SmallVector<int, 16> LHSValNoAssignments;
 674   SmallVector<int, 16> RHSValNoAssignments;
 675   DenseMap<VNInfo*, VNInfo*> LHSValsDefinedFromRHS;
 676   DenseMap<VNInfo*, VNInfo*> RHSValsDefinedFromLHS;
 677   SmallVector<VNInfo*, 16> NewVNInfo;
 678
 679   // If a live interval is a physical register, conservatively check if any
 680   // of its sub-registers is overlapping the live interval of the virtual
 681   // register. If so, do not coalesce.
 682   if (MRegisterInfo::isPhysicalRegister(LHS.reg) &&
 683       *mri_->getSubRegisters(LHS.reg)) {
 684     for (const unsigned* SR = mri_->getSubRegisters(LHS.reg); *SR; ++SR)
 685       if (li_->hasInterval(*SR) && RHS.overlaps(li_->getInterval(*SR))) {
 686         DOUT << "Interfere with sub-register ";
 687         DEBUG(li_->getInterval(*SR).print(DOUT, mri_));
 688         return false;
 689       }
 690   } else if (MRegisterInfo::isPhysicalRegister(RHS.reg) &&
 691              *mri_->getSubRegisters(RHS.reg)) {
 692     for (const unsigned* SR = mri_->getSubRegisters(RHS.reg); *SR; ++SR)
 693       if (li_->hasInterval(*SR) && LHS.overlaps(li_->getInterval(*SR))) {
 694         DOUT << "Interfere with sub-register ";
 695         DEBUG(li_->getInterval(*SR).print(DOUT, mri_));
 696         return false;
 697       }
 698   }
 699
 700   // Compute ultimate value numbers for the LHS and RHS values.
 701   if (RHS.containsOneValue()) {
 702     // Copies from a liveinterval with a single value are simple to handle and
 703     // very common, handle the special case here.  This is important, because
 704     // often RHS is small and LHS is large (e.g. a physreg).
 705
 706     // Find out if the RHS is defined as a copy from some value in the LHS.
 707     int RHSVal0DefinedFromLHS = -1;
 708     int RHSValID = -1;
 709     VNInfo *RHSValNoInfo = NULL;
 710     VNInfo *RHSValNoInfo0 = RHS.getValNumInfo(0);
 711     unsigned RHSSrcReg = RHSValNoInfo0->reg;
 712     if ((RHSSrcReg == 0 || rep(RHSSrcReg) != LHS.reg)) {
 713       // If RHS is not defined as a copy from the LHS, we can use simpler and
 714       // faster checks to see if the live ranges are coalescable.  This joiner
 715       // can't swap the LHS/RHS intervals though.
 716       if (!MRegisterInfo::isPhysicalRegister(RHS.reg)) {
 717         return SimpleJoin(LHS, RHS);
 718       } else {
 719         RHSValNoInfo = RHSValNoInfo0;
 720       }
 721     } else {
 722       // It was defined as a copy from the LHS, find out what value # it is.
 723       RHSValNoInfo = LHS.getLiveRangeContaining(RHSValNoInfo0->def-1)->valno;
 724       RHSValID = RHSValNoInfo->id;
 725       RHSVal0DefinedFromLHS = RHSValID;
 726     }
 727
 728     LHSValNoAssignments.resize(LHS.getNumValNums(), -1);
 729     RHSValNoAssignments.resize(RHS.getNumValNums(), -1);
 730     NewVNInfo.resize(LHS.getNumValNums(), NULL);
 731
 732     // Okay, *all* of the values in LHS that are defined as a copy from RHS
 733     // should now get updated.
 734     for (LiveInterval::vni_iterator i = LHS.vni_begin(), e = LHS.vni_end();
 735          i != e; ++i) {
 736       VNInfo *VNI = *i;
 737       unsigned VN = VNI->id;
 738       if (unsigned LHSSrcReg = VNI->reg) {
 739         if (rep(LHSSrcReg) != RHS.reg) {
 740           // If this is not a copy from the RHS, its value number will be
 741           // unmodified by the coalescing.
 742           NewVNInfo[VN] = VNI;
 743           LHSValNoAssignments[VN] = VN;
 744         } else if (RHSValID == -1) {
 745           // Otherwise, it is a copy from the RHS, and we don't already have a
 746           // value# for it.  Keep the current value number, but remember it.
 747           LHSValNoAssignments[VN] = RHSValID = VN;
 748           NewVNInfo[VN] = RHSValNoInfo;
 749           LHSValsDefinedFromRHS[VNI] = RHSValNoInfo0;
 750         } else {
 751           // Otherwise, use the specified value #.
 752           LHSValNoAssignments[VN] = RHSValID;
 753           if (VN == (unsigned)RHSValID) {  // Else this val# is dead.
 754             NewVNInfo[VN] = RHSValNoInfo;
 755             LHSValsDefinedFromRHS[VNI] = RHSValNoInfo0;
 756           }
 757         }
 758       } else {
 759         NewVNInfo[VN] = VNI;
 760         LHSValNoAssignments[VN] = VN;
 761       }
 762     }
 763
 764     assert(RHSValID != -1 && "Didn't find value #?");
 765     RHSValNoAssignments[0] = RHSValID;
 766     if (RHSVal0DefinedFromLHS != -1) {
 767       // This path doesn't go through ComputeUltimateVN so just set
 768       // it to anything.
 769       RHSValsDefinedFromLHS[RHSValNoInfo0] = (VNInfo*)1;
 770     }
 771   } else {
 772     // Loop over the value numbers of the LHS, seeing if any are defined from
 773     // the RHS.
 774     for (LiveInterval::vni_iterator i = LHS.vni_begin(), e = LHS.vni_end();
 775          i != e; ++i) {
 776       VNInfo *VNI = *i;
 777       unsigned ValSrcReg = VNI->reg;
 778       if (ValSrcReg == 0)  // Src not defined by a copy?
 779         continue;
 780
 781       // DstReg is known to be a register in the LHS interval.  If the src is
 782       // from the RHS interval, we can use its value #.
 783       if (rep(ValSrcReg) != RHS.reg)
 784         continue;
 785
 786       // Figure out the value # from the RHS.
 787       LHSValsDefinedFromRHS[VNI] = RHS.getLiveRangeContaining(VNI->def-1)->valno;
 788     }
 789
 790     // Loop over the value numbers of the RHS, seeing if any are defined from
 791     // the LHS.
 792     for (LiveInterval::vni_iterator i = RHS.vni_begin(), e = RHS.vni_end();
 793          i != e; ++i) {
 794       VNInfo *VNI = *i;
 795       unsigned ValSrcReg = VNI->reg;
 796       if (ValSrcReg == 0)  // Src not defined by a copy?
 797         continue;
 798
 799       // DstReg is known to be a register in the RHS interval.  If the src is
 800       // from the LHS interval, we can use its value #.
 801       if (rep(ValSrcReg) != LHS.reg)
 802         continue;
 803
 804       // Figure out the value # from the LHS.
 805       RHSValsDefinedFromLHS[VNI]= LHS.getLiveRangeContaining(VNI->def-1)->valno;
 806     }
 807
 808     LHSValNoAssignments.resize(LHS.getNumValNums(), -1);
 809     RHSValNoAssignments.resize(RHS.getNumValNums(), -1);
 810     NewVNInfo.reserve(LHS.getNumValNums() + RHS.getNumValNums());
 811
 812     for (LiveInterval::vni_iterator i = LHS.vni_begin(), e = LHS.vni_end();
 813          i != e; ++i) {
 814       VNInfo *VNI = *i;
 815       unsigned VN = VNI->id;
 816       if (LHSValNoAssignments[VN] >= 0 || VNI->def == ~1U)
 817         continue;
 818       ComputeUltimateVN(VNI, NewVNInfo,
 819                         LHSValsDefinedFromRHS, RHSValsDefinedFromLHS,
 820                         LHSValNoAssignments, RHSValNoAssignments);
 821     }
 822     for (LiveInterval::vni_iterator i = RHS.vni_begin(), e = RHS.vni_end();
 823          i != e; ++i) {
 824       VNInfo *VNI = *i;
 825       unsigned VN = VNI->id;
 826       if (RHSValNoAssignments[VN] >= 0 || VNI->def == ~1U)
 827         continue;
 828       // If this value number isn't a copy from the LHS, it's a new number.
 829       if (RHSValsDefinedFromLHS.find(VNI) == RHSValsDefinedFromLHS.end()) {
 830         NewVNInfo.push_back(VNI);
 831         RHSValNoAssignments[VN] = NewVNInfo.size()-1;
 832         continue;
 833       }
 834
 835       ComputeUltimateVN(VNI, NewVNInfo,
 836                         RHSValsDefinedFromLHS, LHSValsDefinedFromRHS,
 837                         RHSValNoAssignments, LHSValNoAssignments);
 838     }
 839   }
 840
 841   // Armed with the mappings of LHS/RHS values to ultimate values, walk the
 842   // interval lists to see if these intervals are coalescable.
 843   LiveInterval::const_iterator I = LHS.begin();
 844   LiveInterval::const_iterator IE = LHS.end();
 845   LiveInterval::const_iterator J = RHS.begin();
 846   LiveInterval::const_iterator JE = RHS.end();
 847
 848   // Skip ahead until the first place of potential sharing.
 849   if (I->start < J->start) {
 850     I = std::upper_bound(I, IE, J->start);
 851     if (I != LHS.begin()) --I;
 852   } else if (J->start < I->start) {
 853     J = std::upper_bound(J, JE, I->start);
 854     if (J != RHS.begin()) --J;
 855   }
 856
 857   while (1) {
 858     // Determine if these two live ranges overlap.
 859     bool Overlaps;
 860     if (I->start < J->start) {
 861       Overlaps = I->end > J->start;
 862     } else {
 863       Overlaps = J->end > I->start;
 864     }
 865
 866     // If so, check value # info to determine if they are really different.
 867     if (Overlaps) {
 868       // If the live range overlap will map to the same value number in the
 869       // result liverange, we can still coalesce them.  If not, we can't.
 870       if (LHSValNoAssignments[I->valno->id] !=
 871           RHSValNoAssignments[J->valno->id])
 872         return false;
 873     }
 874
 875     if (I->end < J->end) {
 876       ++I;
 877       if (I == IE) break;
 878     } else {
 879       ++J;
 880       if (J == JE) break;
 881     }
 882   }
 883
 884   // Update kill info. Some live ranges are extended due to copy coalescing.
 885   for (DenseMap<VNInfo*, VNInfo*>::iterator I = LHSValsDefinedFromRHS.begin(),
 886          E = LHSValsDefinedFromRHS.end(); I != E; ++I) {
 887     VNInfo *VNI = I->first;
 888     unsigned LHSValID = LHSValNoAssignments[VNI->id];
 889     LiveInterval::removeKill(NewVNInfo[LHSValID], VNI->def);
 890     RHS.addKills(NewVNInfo[LHSValID], VNI->kills);
 891   }
 892
 893   // Update kill info. Some live ranges are extended due to copy coalescing.
 894   for (DenseMap<VNInfo*, VNInfo*>::iterator I = RHSValsDefinedFromLHS.begin(),
 895          E = RHSValsDefinedFromLHS.end(); I != E; ++I) {
 896     VNInfo *VNI = I->first;
 897     unsigned RHSValID = RHSValNoAssignments[VNI->id];
 898     LiveInterval::removeKill(NewVNInfo[RHSValID], VNI->def);
 899     LHS.addKills(NewVNInfo[RHSValID], VNI->kills);
 900   }
 901
 902   // If we get here, we know that we can coalesce the live ranges.  Ask the
 903   // intervals to coalesce themselves now.
 904   if ((RHS.ranges.size() > LHS.ranges.size() &&
 905       MRegisterInfo::isVirtualRegister(LHS.reg)) ||
 906       MRegisterInfo::isPhysicalRegister(RHS.reg)) {
 907     RHS.join(LHS, &RHSValNoAssignments[0], &LHSValNoAssignments[0], NewVNInfo);
 908     Swapped = true;
 909   } else {
 910     LHS.join(RHS, &LHSValNoAssignments[0], &RHSValNoAssignments[0], NewVNInfo);
 911     Swapped = false;
 912   }
 913   return true;
 914 }
 915
 916 namespace {
 917   // DepthMBBCompare - Comparison predicate that sort first based on the loop
 918   // depth of the basic block (the unsigned), and then on the MBB number.
 919   struct DepthMBBCompare {
 920     typedef std::pair<unsigned, MachineBasicBlock*> DepthMBBPair;
 921     bool operator()(const DepthMBBPair &LHS, const DepthMBBPair &RHS) const {
 922       if (LHS.first > RHS.first) return true;   // Deeper loops first
 923       return LHS.first == RHS.first &&
 924         LHS.second->getNumber() < RHS.second->getNumber();
 925     }
 926   };
 927 }
 928
 929 void SimpleRegisterCoalescing::CopyCoalesceInMBB(MachineBasicBlock *MBB,
 930                                 std::vector<CopyRec> *TryAgain, bool PhysOnly) {
 931   DOUT << ((Value*)MBB->getBasicBlock())->getName() << ":\n";
 932
 933   for (MachineBasicBlock::iterator MII = MBB->begin(), E = MBB->end();
 934        MII != E;) {
 935     MachineInstr *Inst = MII++;
 936
 937     // If this isn't a copy nor a extract_subreg, we can't join intervals.
 938     unsigned SrcReg, DstReg;
 939     if (Inst->getOpcode() == TargetInstrInfo::EXTRACT_SUBREG) {
 940       DstReg = Inst->getOperand(0).getReg();
 941       SrcReg = Inst->getOperand(1).getReg();
 942     } else if (!tii_->isMoveInstr(*Inst, SrcReg, DstReg))
 943       continue;
 944
 945     bool Done = JoinCopy(Inst, SrcReg, DstReg, PhysOnly);
 946     if (TryAgain && !Done)
 947       TryAgain->push_back(getCopyRec(Inst, SrcReg, DstReg));
 948   }
 949 }
 950
 951 void SimpleRegisterCoalescing::joinIntervals() {
 952   DOUT << "********** JOINING INTERVALS ***********\n";
 953
 954   JoinedLIs.resize(li_->getNumIntervals());
 955   JoinedLIs.reset();
 956
 957   std::vector<CopyRec> TryAgainList;
 958   const LoopInfo &LI = getAnalysis<LoopInfo>();
 959   if (LI.begin() == LI.end()) {
 960     // If there are no loops in the function, join intervals in function order.
 961     for (MachineFunction::iterator I = mf_->begin(), E = mf_->end();
 962          I != E; ++I)
 963       CopyCoalesceInMBB(I, &TryAgainList);
 964   } else {
 965     // Otherwise, join intervals in inner loops before other intervals.
 966     // Unfortunately we can't just iterate over loop hierarchy here because
 967     // there may be more MBB's than BB's.  Collect MBB's for sorting.
 968
 969     // Join intervals in the function prolog first. We want to join physical
 970     // registers with virtual registers before the intervals got too long.
 971     std::vector<std::pair<unsigned, MachineBasicBlock*> > MBBs;
 972     for (MachineFunction::iterator I = mf_->begin(), E = mf_->end(); I != E;++I)
 973       MBBs.push_back(std::make_pair(LI.getLoopDepth(I->getBasicBlock()), I));
 974
 975     // Sort by loop depth.
 976     std::sort(MBBs.begin(), MBBs.end(), DepthMBBCompare());
 977
 978     // Finally, join intervals in loop nest order.
 979     for (unsigned i = 0, e = MBBs.size(); i != e; ++i)
 980       CopyCoalesceInMBB(MBBs[i].second, NULL, true);
 981     for (unsigned i = 0, e = MBBs.size(); i != e; ++i)
 982       CopyCoalesceInMBB(MBBs[i].second, &TryAgainList, false);
 983   }
 984
 985   // Joining intervals can allow other intervals to be joined.  Iteratively join
 986   // until we make no progress.
 987   bool ProgressMade = true;
 988   while (ProgressMade) {
 989     ProgressMade = false;
 990
 991     for (unsigned i = 0, e = TryAgainList.size(); i != e; ++i) {
 992       CopyRec &TheCopy = TryAgainList[i];
 993       if (TheCopy.MI &&
 994           JoinCopy(TheCopy.MI, TheCopy.SrcReg, TheCopy.DstReg)) {
 995         TheCopy.MI = 0;   // Mark this one as done.
 996         ProgressMade = true;
 997       }
 998     }
 999   }
1000
1001   // Some live range has been lengthened due to colaescing, eliminate the
1002   // unnecessary kills.
1003   int RegNum = JoinedLIs.find_first();
1004   while (RegNum != -1) {
1005     unsigned Reg = RegNum + MRegisterInfo::FirstVirtualRegister;
1006     unsigned repReg = rep(Reg);
1007     LiveInterval &LI = li_->getInterval(repReg);
1008     LiveVariables::VarInfo& svi = lv_->getVarInfo(Reg);
1009     for (unsigned i = 0, e = svi.Kills.size(); i != e; ++i) {
1010       MachineInstr *Kill = svi.Kills[i];
1011       // Suppose vr1 = op vr2, x
1012       // and vr1 and vr2 are coalesced. vr2 should still be marked kill
1013       // unless it is a two-address operand.
1014       if (li_->isRemoved(Kill) || hasRegisterDef(Kill, repReg))
1015         continue;
1016       if (LI.liveAt(li_->getInstructionIndex(Kill) + InstrSlots::NUM))
1017         unsetRegisterKill(Kill, repReg);
1018     }
1019     RegNum = JoinedLIs.find_next(RegNum);
1020   }
1021
1022   DOUT << "*** Register mapping ***\n";
1023   for (int i = 0, e = r2rMap_.size(); i != e; ++i)
1024     if (r2rMap_[i]) {
1025       DOUT << "  reg " << i << " -> ";
1026       DEBUG(printRegName(r2rMap_[i]));
1027       DOUT << "\n";
1028     }
1029 }
1030
1031 /// Return true if the two specified registers belong to different register
1032 /// classes.  The registers may be either phys or virt regs.
1033 bool SimpleRegisterCoalescing::differingRegisterClasses(unsigned RegA,
1034                                                         unsigned RegB) const {
1035
1036   // Get the register classes for the first reg.
1037   if (MRegisterInfo::isPhysicalRegister(RegA)) {
1038     assert(MRegisterInfo::isVirtualRegister(RegB) &&
1039            "Shouldn't consider two physregs!");
1040     return !mf_->getSSARegMap()->getRegClass(RegB)->contains(RegA);
1041   }
1042
1043   // Compare against the regclass for the second reg.
1044   const TargetRegisterClass *RegClass = mf_->getSSARegMap()->getRegClass(RegA);
1045   if (MRegisterInfo::isVirtualRegister(RegB))
1046     return RegClass != mf_->getSSARegMap()->getRegClass(RegB);
1047   else
1048     return !RegClass->contains(RegB);
1049 }
1050
1051 /// lastRegisterUse - Returns the last use of the specific register between
1052 /// cycles Start and End. It also returns the use operand by reference. It
1053 /// returns NULL if there are no uses.
1054 MachineInstr *
1055 SimpleRegisterCoalescing::lastRegisterUse(unsigned Start, unsigned End, unsigned Reg,
1056                                MachineOperand *&MOU) {
1057   int e = (End-1) / InstrSlots::NUM * InstrSlots::NUM;
1058   int s = Start;
1059   while (e >= s) {
1060     // Skip deleted instructions
1061     MachineInstr *MI = li_->getInstructionFromIndex(e);
1062     while ((e - InstrSlots::NUM) >= s && !MI) {
1063       e -= InstrSlots::NUM;
1064       MI = li_->getInstructionFromIndex(e);
1065     }
1066     if (e < s || MI == NULL)
1067       return NULL;
1068
1069     for (unsigned i = 0, NumOps = MI->getNumOperands(); i != NumOps; ++i) {
1070       MachineOperand &MO = MI->getOperand(i);
1071       if (MO.isRegister() && MO.isUse() && MO.getReg() &&
1072           mri_->regsOverlap(rep(MO.getReg()), Reg)) {
1073         MOU = &MO;
1074         return MI;
1075       }
1076     }
1077
1078     e -= InstrSlots::NUM;
1079   }
1080
1081   return NULL;
1082 }
1083
1084
1085 /// findDefOperand - Returns the MachineOperand that is a def of the specific
1086 /// register. It returns NULL if the def is not found.
1087 MachineOperand *SimpleRegisterCoalescing::findDefOperand(MachineInstr *MI, unsigned Reg) {
1088   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
1089     MachineOperand &MO = MI->getOperand(i);
1090     if (MO.isRegister() && MO.isDef() &&
1091         mri_->regsOverlap(rep(MO.getReg()), Reg))
1092       return &MO;
1093   }
1094   return NULL;
1095 }
1096
1097 /// unsetRegisterKill - Unset IsKill property of all uses of specific register
1098 /// of the specific instruction.
1099 void SimpleRegisterCoalescing::unsetRegisterKill(MachineInstr *MI, unsigned Reg) {
1100   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
1101     MachineOperand &MO = MI->getOperand(i);
1102     if (MO.isRegister() && MO.isKill() && MO.getReg() &&
1103         mri_->regsOverlap(rep(MO.getReg()), Reg))
1104       MO.unsetIsKill();
1105   }
1106 }
1107
1108 /// unsetRegisterKills - Unset IsKill property of all uses of specific register
1109 /// between cycles Start and End.
1110 void SimpleRegisterCoalescing::unsetRegisterKills(unsigned Start, unsigned End,
1111                                        unsigned Reg) {
1112   int e = (End-1) / InstrSlots::NUM * InstrSlots::NUM;
1113   int s = Start;
1114   while (e >= s) {
1115     // Skip deleted instructions
1116     MachineInstr *MI = li_->getInstructionFromIndex(e);
1117     while ((e - InstrSlots::NUM) >= s && !MI) {
1118       e -= InstrSlots::NUM;
1119       MI = li_->getInstructionFromIndex(e);
1120     }
1121     if (e < s || MI == NULL)
1122       return;
1123
1124     for (unsigned i = 0, NumOps = MI->getNumOperands(); i != NumOps; ++i) {
1125       MachineOperand &MO = MI->getOperand(i);
1126       if (MO.isRegister() && MO.isKill() && MO.getReg() &&
1127           mri_->regsOverlap(rep(MO.getReg()), Reg)) {
1128         MO.unsetIsKill();
1129       }
1130     }
1131
1132     e -= InstrSlots::NUM;
1133   }
1134 }
1135
1136 /// hasRegisterDef - True if the instruction defines the specific register.
1137 ///
1138 bool SimpleRegisterCoalescing::hasRegisterDef(MachineInstr *MI, unsigned Reg) {
1139   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
1140     MachineOperand &MO = MI->getOperand(i);
1141     if (MO.isRegister() && MO.isDef() &&
1142         mri_->regsOverlap(rep(MO.getReg()), Reg))
1143       return true;
1144   }
1145   return false;
1146 }
1147
1148 void SimpleRegisterCoalescing::printRegName(unsigned reg) const {
1149   if (MRegisterInfo::isPhysicalRegister(reg))
1150     cerr << mri_->getName(reg);
1151   else
1152     cerr << "%reg" << reg;
1153 }
1154
1155 void SimpleRegisterCoalescing::releaseMemory() {
1156    r2rMap_.clear();
1157    JoinedLIs.clear();
1158    SubRegIdxes.clear();
1159 }
1160
1161 static bool isZeroLengthInterval(LiveInterval *li) {
1162   for (LiveInterval::Ranges::const_iterator
1163          i = li->ranges.begin(), e = li->ranges.end(); i != e; ++i)
1164     if (i->end - i->start > LiveIntervals::InstrSlots::NUM)
1165       return false;
1166   return true;
1167 }
1168
1169 bool SimpleRegisterCoalescing::runOnMachineFunction(MachineFunction &fn) {
1170   mf_ = &fn;
1171   tm_ = &fn.getTarget();
1172   mri_ = tm_->getRegisterInfo();
1173   tii_ = tm_->getInstrInfo();
1174   li_ = &getAnalysis<LiveIntervals>();
1175   lv_ = &getAnalysis<LiveVariables>();
1176
1177   DOUT << "********** SIMPLE REGISTER COALESCING **********\n"
1178        << "********** Function: "
1179        << ((Value*)mf_->getFunction())->getName() << '\n';
1180
1181   allocatableRegs_ = mri_->getAllocatableSet(fn);
1182   for (MRegisterInfo::regclass_iterator I = mri_->regclass_begin(),
1183          E = mri_->regclass_end(); I != E; ++I)
1184     allocatableRCRegs_.insert(std::make_pair(*I,mri_->getAllocatableSet(fn, *I)));
1185
1186   SSARegMap *RegMap = mf_->getSSARegMap();
1187   r2rMap_.grow(RegMap->getLastVirtReg());
1188
1189   // Join (coalesce) intervals if requested.
1190   if (EnableJoining) {
1191     joinIntervals();
1192     DOUT << "********** INTERVALS POST JOINING **********\n";
1193     for (LiveIntervals::iterator I = li_->begin(), E = li_->end(); I != E; ++I) {
1194       I->second.print(DOUT, mri_);
1195       DOUT << "\n";
1196     }
1197
1198     // Track coalesced sub-registers.
1199     while (!SubRegIdxes.empty()) {
1200       std::pair<unsigned, unsigned> RI = SubRegIdxes.back();
1201       SubRegIdxes.pop_back();
1202       mf_->getSSARegMap()->setIsSubRegister(RI.first, rep(RI.first), RI.second);
1203     }
1204   }
1205
1206   // perform a final pass over the instructions and compute spill
1207   // weights, coalesce virtual registers and remove identity moves.
1208   const LoopInfo &loopInfo = getAnalysis<LoopInfo>();
1209
1210   for (MachineFunction::iterator mbbi = mf_->begin(), mbbe = mf_->end();
1211        mbbi != mbbe; ++mbbi) {
1212     MachineBasicBlock* mbb = mbbi;
1213     unsigned loopDepth = loopInfo.getLoopDepth(mbb->getBasicBlock());
1214
1215     for (MachineBasicBlock::iterator mii = mbb->begin(), mie = mbb->end();
1216          mii != mie; ) {
1217       // if the move will be an identity move delete it
1218       unsigned srcReg, dstReg, RegRep;
1219       if (tii_->isMoveInstr(*mii, srcReg, dstReg) &&
1220           (RegRep = rep(srcReg)) == rep(dstReg)) {
1221         // remove from def list
1222         LiveInterval &RegInt = li_->getOrCreateInterval(RegRep);
1223         MachineOperand *MO = mii->findRegisterDefOperand(dstReg);
1224         // If def of this move instruction is dead, remove its live range from
1225         // the dstination register's live interval.
1226         if (MO->isDead()) {
1227           unsigned MoveIdx = li_->getDefIndex(li_->getInstructionIndex(mii));
1228           LiveInterval::iterator MLR = RegInt.FindLiveRangeContaining(MoveIdx);
1229           RegInt.removeRange(MLR->start, MoveIdx+1);
1230           if (RegInt.empty())
1231             li_->removeInterval(RegRep);
1232         }
1233         li_->RemoveMachineInstrFromMaps(mii);
1234         mii = mbbi->erase(mii);
1235         ++numPeep;
1236       } else {
1237         SmallSet<unsigned, 4> UniqueUses;
1238         for (unsigned i = 0, e = mii->getNumOperands(); i != e; ++i) {
1239           const MachineOperand &mop = mii->getOperand(i);
1240           if (mop.isRegister() && mop.getReg() &&
1241               MRegisterInfo::isVirtualRegister(mop.getReg())) {
1242             // replace register with representative register
1243             unsigned OrigReg = mop.getReg();
1244             unsigned reg = rep(OrigReg);
1245             // Don't rewrite if it is a sub-register of a virtual register.
1246             if (!RegMap->isSubRegister(OrigReg))
1247               mii->getOperand(i).setReg(reg);
1248             else if (MRegisterInfo::isPhysicalRegister(reg))
1249               mii->getOperand(i).setReg(mri_->getSubReg(reg,
1250                                          RegMap->getSubRegisterIndex(OrigReg)));
1251
1252             // Multiple uses of reg by the same instruction. It should not
1253             // contribute to spill weight again.
1254             if (UniqueUses.count(reg) != 0)
1255               continue;
1256             LiveInterval &RegInt = li_->getInterval(reg);
1257             float w = (mop.isUse()+mop.isDef()) * powf(10.0F, (float)loopDepth);
1258             RegInt.weight += w;
1259             UniqueUses.insert(reg);
1260           }
1261         }
1262         ++mii;
1263       }
1264     }
1265   }
1266
1267   for (LiveIntervals::iterator I = li_->begin(), E = li_->end(); I != E; ++I) {
1268     LiveInterval &LI = I->second;
1269     if (MRegisterInfo::isVirtualRegister(LI.reg)) {
1270       // If the live interval length is essentially zero, i.e. in every live
1271       // range the use follows def immediately, it doesn't make sense to spill
1272       // it and hope it will be easier to allocate for this li.
1273       if (isZeroLengthInterval(&LI))
1274         LI.weight = HUGE_VALF;
1275
1276       // Slightly prefer live interval that has been assigned a preferred reg.
1277       if (LI.preference)
1278         LI.weight *= 1.01F;
1279
1280       // Divide the weight of the interval by its size.  This encourages
1281       // spilling of intervals that are large and have few uses, and
1282       // discourages spilling of small intervals with many uses.
1283       LI.weight /= LI.getSize();
1284     }
1285   }
1286
1287   DEBUG(dump());
1288   return true;
1289 }
1290
1291 /// print - Implement the dump method.
1292 void SimpleRegisterCoalescing::print(std::ostream &O, const Module* m) const {
1293    li_->print(O, m);
1294 }
1295
1296 RegisterCoalescer* llvm::createSimpleRegisterCoalescer() {
1297   return new SimpleRegisterCoalescing();
1298 }
1299
1300 // Make sure that anything that uses RegisterCoalescer pulls in this file...
1301 DEFINING_FILE_FOR(SimpleRegisterCoalescing)