lib/CodeGen/LiveVariables.cpp

   1 //===-- LiveVariables.cpp - Live Variable Analysis for Machine Code -------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the LiveVariable analysis pass.  For each machine
  11 // instruction in the function, this pass calculates the set of registers that
  12 // are immediately dead after the instruction (i.e., the instruction calculates
  13 // the value, but it is never used) and the set of registers that are used by
  14 // the instruction, but are never used after the instruction (i.e., they are
  15 // killed).
  16 //
  17 // This class computes live variables using are sparse implementation based on
  18 // the machine code SSA form.  This class computes live variable information for
  19 // each virtual and _register allocatable_ physical register in a function.  It
  20 // uses the dominance properties of SSA form to efficiently compute live
  21 // variables for virtual registers, and assumes that physical registers are only
  22 // live within a single basic block (allowing it to do a single local analysis
  23 // to resolve physical register lifetimes in each basic block).  If a physical
  24 // register is not register allocatable, it is not tracked.  This is useful for
  25 // things like the stack pointer and condition codes.
  26 //
  27 //===----------------------------------------------------------------------===//
  28
  29 #include "llvm/CodeGen/LiveVariables.h"
  30 #include "llvm/CodeGen/MachineInstr.h"
  31 #include "llvm/CodeGen/MachineRegisterInfo.h"
  32 #include "llvm/CodeGen/Passes.h"
  33 #include "llvm/Target/TargetRegisterInfo.h"
  34 #include "llvm/Target/TargetInstrInfo.h"
  35 #include "llvm/Target/TargetMachine.h"
  36 #include "llvm/ADT/DepthFirstIterator.h"
  37 #include "llvm/ADT/SmallPtrSet.h"
  38 #include "llvm/ADT/SmallSet.h"
  39 #include "llvm/ADT/STLExtras.h"
  40 #include "llvm/Config/alloca.h"
  41 #include <algorithm>
  42 using namespace llvm;
  43
  44 char LiveVariables::ID = 0;
  45 static RegisterPass<LiveVariables> X("livevars", "Live Variable Analysis");
  46
  47
  48 void LiveVariables::getAnalysisUsage(AnalysisUsage &AU) const {
  49   AU.addRequiredID(UnreachableMachineBlockElimID);
  50   AU.setPreservesAll();
  51 }
  52
  53 void LiveVariables::VarInfo::dump() const {
  54   cerr << "  Alive in blocks: ";
  55   for (SparseBitVector<>::iterator I = AliveBlocks.begin(),
  56            E = AliveBlocks.end(); I != E; ++I)
  57     cerr << *I << ", ";
  58   cerr << "\n  Killed by:";
  59   if (Kills.empty())
  60     cerr << " No instructions.\n";
  61   else {
  62     for (unsigned i = 0, e = Kills.size(); i != e; ++i)
  63       cerr << "\n    #" << i << ": " << *Kills[i];
  64     cerr << "\n";
  65   }
  66 }
  67
  68 /// getVarInfo - Get (possibly creating) a VarInfo object for the given vreg.
  69 LiveVariables::VarInfo &LiveVariables::getVarInfo(unsigned RegIdx) {
  70   assert(TargetRegisterInfo::isVirtualRegister(RegIdx) &&
  71          "getVarInfo: not a virtual register!");
  72   RegIdx -= TargetRegisterInfo::FirstVirtualRegister;
  73   if (RegIdx >= VirtRegInfo.size()) {
  74     if (RegIdx >= 2*VirtRegInfo.size())
  75       VirtRegInfo.resize(RegIdx*2);
  76     else
  77       VirtRegInfo.resize(2*VirtRegInfo.size());
  78   }
  79   return VirtRegInfo[RegIdx];
  80 }
  81
  82 void LiveVariables::MarkVirtRegAliveInBlock(VarInfo& VRInfo,
  83                                             MachineBasicBlock *DefBlock,
  84                                             MachineBasicBlock *MBB,
  85                                     std::vector<MachineBasicBlock*> &WorkList) {
  86   unsigned BBNum = MBB->getNumber();
  87
  88   // Check to see if this basic block is one of the killing blocks.  If so,
  89   // remove it.
  90   for (unsigned i = 0, e = VRInfo.Kills.size(); i != e; ++i)
  91     if (VRInfo.Kills[i]->getParent() == MBB) {
  92       VRInfo.Kills.erase(VRInfo.Kills.begin()+i);  // Erase entry
  93       break;
  94     }
  95
  96   if (MBB == DefBlock) return;  // Terminate recursion
  97
  98   if (VRInfo.AliveBlocks.test(BBNum))
  99     return;  // We already know the block is live
 100
 101   // Mark the variable known alive in this bb
 102   VRInfo.AliveBlocks.set(BBNum);
 103
 104   for (MachineBasicBlock::const_pred_reverse_iterator PI = MBB->pred_rbegin(),
 105          E = MBB->pred_rend(); PI != E; ++PI)
 106     WorkList.push_back(*PI);
 107 }
 108
 109 void LiveVariables::MarkVirtRegAliveInBlock(VarInfo &VRInfo,
 110                                             MachineBasicBlock *DefBlock,
 111                                             MachineBasicBlock *MBB) {
 112   std::vector<MachineBasicBlock*> WorkList;
 113   MarkVirtRegAliveInBlock(VRInfo, DefBlock, MBB, WorkList);
 114
 115   while (!WorkList.empty()) {
 116     MachineBasicBlock *Pred = WorkList.back();
 117     WorkList.pop_back();
 118     MarkVirtRegAliveInBlock(VRInfo, DefBlock, Pred, WorkList);
 119   }
 120 }
 121
 122 void LiveVariables::HandleVirtRegUse(unsigned reg, MachineBasicBlock *MBB,
 123                                      MachineInstr *MI) {
 124   assert(MRI->getVRegDef(reg) && "Register use before def!");
 125
 126   unsigned BBNum = MBB->getNumber();
 127
 128   VarInfo& VRInfo = getVarInfo(reg);
 129   VRInfo.NumUses++;
 130
 131   // Check to see if this basic block is already a kill block.
 132   if (!VRInfo.Kills.empty() && VRInfo.Kills.back()->getParent() == MBB) {
 133     // Yes, this register is killed in this basic block already. Increase the
 134     // live range by updating the kill instruction.
 135     VRInfo.Kills.back() = MI;
 136     return;
 137   }
 138
 139 #ifndef NDEBUG
 140   for (unsigned i = 0, e = VRInfo.Kills.size(); i != e; ++i)
 141     assert(VRInfo.Kills[i]->getParent() != MBB && "entry should be at end!");
 142 #endif
 143
 144   // This situation can occur:
 145   //
 146   //     ,------.
 147   //     |      |
 148   //     |      v
 149   //     |   t2 = phi ... t1 ...
 150   //     |      |
 151   //     |      v
 152   //     |   t1 = ...
 153   //     |  ... = ... t1 ...
 154   //     |      |
 155   //     `------'
 156   //
 157   // where there is a use in a PHI node that's a predecessor to the defining
 158   // block. We don't want to mark all predecessors as having the value "alive"
 159   // in this case.
 160   if (MBB == MRI->getVRegDef(reg)->getParent()) return;
 161
 162   // Add a new kill entry for this basic block. If this virtual register is
 163   // already marked as alive in this basic block, that means it is alive in at
 164   // least one of the successor blocks, it's not a kill.
 165   if (!VRInfo.AliveBlocks.test(BBNum))
 166     VRInfo.Kills.push_back(MI);
 167
 168   // Update all dominating blocks to mark them as "known live".
 169   for (MachineBasicBlock::const_pred_iterator PI = MBB->pred_begin(),
 170          E = MBB->pred_end(); PI != E; ++PI)
 171     MarkVirtRegAliveInBlock(VRInfo, MRI->getVRegDef(reg)->getParent(), *PI);
 172 }
 173
 174 void LiveVariables::HandleVirtRegDef(unsigned Reg, MachineInstr *MI) {
 175   VarInfo &VRInfo = getVarInfo(Reg);
 176
 177   if (VRInfo.AliveBlocks.empty())
 178     // If vr is not alive in any block, then defaults to dead.
 179     VRInfo.Kills.push_back(MI);
 180 }
 181
 182 /// FindLastPartialDef - Return the last partial def of the specified register.
 183 /// Also returns the sub-register that's defined.
 184 MachineInstr *LiveVariables::FindLastPartialDef(unsigned Reg,
 185                                                 unsigned &PartDefReg) {
 186   unsigned LastDefReg = 0;
 187   unsigned LastDefDist = 0;
 188   MachineInstr *LastDef = NULL;
 189   for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
 190        unsigned SubReg = *SubRegs; ++SubRegs) {
 191     MachineInstr *Def = PhysRegDef[SubReg];
 192     if (!Def)
 193       continue;
 194     unsigned Dist = DistanceMap[Def];
 195     if (Dist > LastDefDist) {
 196       LastDefReg  = SubReg;
 197       LastDef     = Def;
 198       LastDefDist = Dist;
 199     }
 200   }
 201   PartDefReg = LastDefReg;
 202   return LastDef;
 203 }
 204
 205 /// HandlePhysRegUse - Turn previous partial def's into read/mod/writes. Add
 206 /// implicit defs to a machine instruction if there was an earlier def of its
 207 /// super-register.
 208 void LiveVariables::HandlePhysRegUse(unsigned Reg, MachineInstr *MI) {
 209   // If there was a previous use or a "full" def all is well.
 210   if (!PhysRegDef[Reg] && !PhysRegUse[Reg]) {
 211     // Otherwise, the last sub-register def implicitly defines this register.
 212     // e.g.
 213     // AH =
 214     // AL = ... <imp-def EAX>, <imp-kill AH>
 215     //    = AH
 216     // ...
 217     //    = EAX
 218     // All of the sub-registers must have been defined before the use of Reg!
 219     unsigned PartDefReg = 0;
 220     MachineInstr *LastPartialDef = FindLastPartialDef(Reg, PartDefReg);
 221     // If LastPartialDef is NULL, it must be using a livein register.
 222     if (LastPartialDef) {
 223       LastPartialDef->addOperand(MachineOperand::CreateReg(Reg, true/*IsDef*/,
 224                                                            true/*IsImp*/));
 225       PhysRegDef[Reg] = LastPartialDef;
 226       SmallSet<unsigned, 8> Processed;
 227       for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
 228            unsigned SubReg = *SubRegs; ++SubRegs) {
 229         if (Processed.count(SubReg))
 230           continue;
 231         if (SubReg == PartDefReg || TRI->isSubRegister(PartDefReg, SubReg))
 232           continue;
 233         // This part of Reg was defined before the last partial def. It's killed
 234         // here.
 235         LastPartialDef->addOperand(MachineOperand::CreateReg(SubReg,
 236                                                              false/*IsDef*/,
 237                                                              true/*IsImp*/));
 238         PhysRegDef[SubReg] = LastPartialDef;
 239         for (const unsigned *SS = TRI->getSubRegisters(SubReg); *SS; ++SS)
 240           Processed.insert(*SS);
 241       }
 242     }
 243   }
 244
 245   // Remember this use.
 246   PhysRegUse[Reg]  = MI;
 247   for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
 248        unsigned SubReg = *SubRegs; ++SubRegs)
 249     PhysRegUse[SubReg] =  MI;
 250 }
 251
 252 /// hasRegisterUseBelow - Return true if the specified register is used after
 253 /// the current instruction and before it's next definition.
 254 bool LiveVariables::hasRegisterUseBelow(unsigned Reg,
 255                                         MachineBasicBlock::iterator I,
 256                                         MachineBasicBlock *MBB) {
 257   if (I == MBB->end())
 258     return false;
 259
 260   // First find out if there are any uses / defs below.
 261   bool hasDistInfo = true;
 262   unsigned CurDist = DistanceMap[I];
 263   SmallVector<MachineInstr*, 4> Uses;
 264   SmallVector<MachineInstr*, 4> Defs;
 265   for (MachineRegisterInfo::reg_iterator RI = MRI->reg_begin(Reg),
 266          RE = MRI->reg_end(); RI != RE; ++RI) {
 267     MachineOperand &UDO = RI.getOperand();
 268     MachineInstr *UDMI = &*RI;
 269     if (UDMI->getParent() != MBB)
 270       continue;
 271     DenseMap<MachineInstr*, unsigned>::iterator DI = DistanceMap.find(UDMI);
 272     bool isBelow = false;
 273     if (DI == DistanceMap.end()) {
 274       // Must be below if it hasn't been assigned a distance yet.
 275       isBelow = true;
 276       hasDistInfo = false;
 277     } else if (DI->second > CurDist)
 278       isBelow = true;
 279     if (isBelow) {
 280       if (UDO.isUse())
 281         Uses.push_back(UDMI);
 282       if (UDO.isDef())
 283         Defs.push_back(UDMI);
 284     }
 285   }
 286
 287   if (Uses.empty())
 288     // No uses below.
 289     return false;
 290   else if (!Uses.empty() && Defs.empty())
 291     // There are uses below but no defs below.
 292     return true;
 293   // There are both uses and defs below. We need to know which comes first.
 294   if (!hasDistInfo) {
 295     // Complete DistanceMap for this MBB. This information is computed only
 296     // once per MBB.
 297     ++I;
 298     ++CurDist;
 299     for (MachineBasicBlock::iterator E = MBB->end(); I != E; ++I, ++CurDist)
 300       DistanceMap.insert(std::make_pair(I, CurDist));
 301   }
 302
 303   unsigned EarliestUse = DistanceMap[Uses[0]];
 304   for (unsigned i = 1, e = Uses.size(); i != e; ++i) {
 305     unsigned Dist = DistanceMap[Uses[i]];
 306     if (Dist < EarliestUse)
 307       EarliestUse = Dist;
 308   }
 309   for (unsigned i = 0, e = Defs.size(); i != e; ++i) {
 310     unsigned Dist = DistanceMap[Defs[i]];
 311     if (Dist < EarliestUse)
 312       // The register is defined before its first use below.
 313       return false;
 314   }
 315   return true;
 316 }
 317
 318 bool LiveVariables::HandlePhysRegKill(unsigned Reg, MachineInstr *MI) {
 319   if (!PhysRegUse[Reg] && !PhysRegDef[Reg])
 320     return false;
 321
 322   MachineInstr *LastRefOrPartRef = PhysRegUse[Reg]
 323     ? PhysRegUse[Reg] : PhysRegDef[Reg];
 324   unsigned LastRefOrPartRefDist = DistanceMap[LastRefOrPartRef];
 325   // The whole register is used.
 326   // AL =
 327   // AH =
 328   //
 329   //    = AX
 330   //    = AL, AX<imp-use, kill>
 331   // AX =
 332   //
 333   // Or whole register is defined, but not used at all.
 334   // AX<dead> =
 335   // ...
 336   // AX =
 337   //
 338   // Or whole register is defined, but only partly used.
 339   // AX<dead> = AL<imp-def>
 340   //    = AL<kill>
 341   // AX =
 342   SmallSet<unsigned, 8> PartUses;
 343   for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
 344        unsigned SubReg = *SubRegs; ++SubRegs) {
 345     if (MachineInstr *Use = PhysRegUse[SubReg]) {
 346       PartUses.insert(SubReg);
 347       for (const unsigned *SS = TRI->getSubRegisters(SubReg); *SS; ++SS)
 348         PartUses.insert(*SS);
 349       unsigned Dist = DistanceMap[Use];
 350       if (Dist > LastRefOrPartRefDist) {
 351         LastRefOrPartRefDist = Dist;
 352         LastRefOrPartRef = Use;
 353       }
 354     }
 355   }
 356
 357   if (LastRefOrPartRef == PhysRegDef[Reg] && LastRefOrPartRef != MI)
 358     // If the last reference is the last def, then it's not used at all.
 359     // That is, unless we are currently processing the last reference itself.
 360     LastRefOrPartRef->addRegisterDead(Reg, TRI, true);
 361
 362   // Partial uses. Mark register def dead and add implicit def of
 363   // sub-registers which are used.
 364   // EAX<dead>  = op  AL<imp-def>
 365   // That is, EAX def is dead but AL def extends pass it.
 366   // Enable this after live interval analysis is fixed to improve codegen!
 367   else if (!PhysRegUse[Reg]) {
 368     PhysRegDef[Reg]->addRegisterDead(Reg, TRI, true);
 369     for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
 370          unsigned SubReg = *SubRegs; ++SubRegs) {
 371       if (PartUses.count(SubReg)) {
 372         bool NeedDef = true;
 373         if (PhysRegDef[Reg] == PhysRegDef[SubReg]) {
 374           MachineOperand *MO = PhysRegDef[Reg]->findRegisterDefOperand(SubReg);
 375           if (MO) {
 376             NeedDef = false;
 377             assert(!MO->isDead());
 378           }
 379         }
 380         if (NeedDef)
 381           PhysRegDef[Reg]->addOperand(MachineOperand::CreateReg(SubReg,
 382                                                                 true, true));
 383         LastRefOrPartRef->addRegisterKilled(SubReg, TRI, true);
 384         for (const unsigned *SS = TRI->getSubRegisters(SubReg); *SS; ++SS)
 385           PartUses.erase(*SS);
 386       }
 387     }
 388   }
 389   else
 390     LastRefOrPartRef->addRegisterKilled(Reg, TRI, true);
 391   return true;
 392 }
 393
 394 void LiveVariables::HandlePhysRegDef(unsigned Reg, MachineInstr *MI) {
 395   // What parts of the register are previously defined?
 396   SmallSet<unsigned, 32> Live;
 397   if (PhysRegDef[Reg] || PhysRegUse[Reg]) {
 398     Live.insert(Reg);
 399     for (const unsigned *SS = TRI->getSubRegisters(Reg); *SS; ++SS)
 400       Live.insert(*SS);
 401   } else {
 402     for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
 403          unsigned SubReg = *SubRegs; ++SubRegs) {
 404       // If a register isn't itself defined, but all parts that make up of it
 405       // are defined, then consider it also defined.
 406       // e.g.
 407       // AL =
 408       // AH =
 409       //    = AX
 410       if (PhysRegDef[SubReg] || PhysRegUse[SubReg]) {
 411         Live.insert(SubReg);
 412         for (const unsigned *SS = TRI->getSubRegisters(SubReg); *SS; ++SS)
 413           Live.insert(*SS);
 414       }
 415     }
 416   }
 417
 418   // Start from the largest piece, find the last time any part of the register
 419   // is referenced.
 420   if (!HandlePhysRegKill(Reg, MI)) {
 421     // Only some of the sub-registers are used.
 422     for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
 423          unsigned SubReg = *SubRegs; ++SubRegs) {
 424       if (!Live.count(SubReg))
 425         // Skip if this sub-register isn't defined.
 426         continue;
 427       if (HandlePhysRegKill(SubReg, MI)) {
 428         Live.erase(SubReg);
 429         for (const unsigned *SS = TRI->getSubRegisters(SubReg); *SS; ++SS)
 430           Live.erase(*SS);
 431       }
 432     }
 433     assert(Live.empty() && "Not all defined registers are killed / dead?");
 434   }
 435
 436   if (MI) {
 437     // Does this extend the live range of a super-register?
 438     SmallSet<unsigned, 8> Processed;
 439     for (const unsigned *SuperRegs = TRI->getSuperRegisters(Reg);
 440          unsigned SuperReg = *SuperRegs; ++SuperRegs) {
 441       if (Processed.count(SuperReg))
 442         continue;
 443       MachineInstr *LastRef = PhysRegUse[SuperReg]
 444         ? PhysRegUse[SuperReg] : PhysRegDef[SuperReg];
 445       if (LastRef && LastRef != MI) {
 446         // The larger register is previously defined. Now a smaller part is
 447         // being re-defined. Treat it as read/mod/write if there are uses
 448         // below.
 449         // EAX =
 450         // AX  =        EAX<imp-use,kill>, EAX<imp-def>
 451         // ...
 452         ///    =  EAX
 453         if (hasRegisterUseBelow(SuperReg, MI, MI->getParent())) {
 454           MI->addOperand(MachineOperand::CreateReg(SuperReg, false/*IsDef*/,
 455                                                    true/*IsImp*/,true/*IsKill*/));
 456           MI->addOperand(MachineOperand::CreateReg(SuperReg, true/*IsDef*/,
 457                                                    true/*IsImp*/));
 458           PhysRegDef[SuperReg]  = MI;
 459           PhysRegUse[SuperReg]  = NULL;
 460           Processed.insert(SuperReg);
 461           for (const unsigned *SS = TRI->getSubRegisters(SuperReg); *SS; ++SS) {
 462             PhysRegDef[*SS]  = MI;
 463             PhysRegUse[*SS]  = NULL;
 464             Processed.insert(*SS);
 465           }
 466         } else {
 467           // Otherwise, the super register is killed.
 468           if (HandlePhysRegKill(SuperReg, MI)) {
 469             PhysRegDef[SuperReg]  = NULL;
 470             PhysRegUse[SuperReg]  = NULL;
 471             for (const unsigned *SS = TRI->getSubRegisters(SuperReg); *SS; ++SS) {
 472               PhysRegDef[*SS]  = NULL;
 473               PhysRegUse[*SS]  = NULL;
 474               Processed.insert(*SS);
 475             }
 476           }
 477         }
 478       }
 479     }
 480
 481     // Remember this def.
 482     PhysRegDef[Reg]  = MI;
 483     PhysRegUse[Reg]  = NULL;
 484     for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
 485          unsigned SubReg = *SubRegs; ++SubRegs) {
 486       PhysRegDef[SubReg]  = MI;
 487       PhysRegUse[SubReg]  = NULL;
 488     }
 489   }
 490 }
 491
 492 bool LiveVariables::runOnMachineFunction(MachineFunction &mf) {
 493   MF = &mf;
 494   MRI = &mf.getRegInfo();
 495   TRI = MF->getTarget().getRegisterInfo();
 496
 497   ReservedRegisters = TRI->getReservedRegs(mf);
 498
 499   unsigned NumRegs = TRI->getNumRegs();
 500   PhysRegDef  = new MachineInstr*[NumRegs];
 501   PhysRegUse  = new MachineInstr*[NumRegs];
 502   PHIVarInfo = new SmallVector<unsigned, 4>[MF->getNumBlockIDs()];
 503   std::fill(PhysRegDef,  PhysRegDef  + NumRegs, (MachineInstr*)0);
 504   std::fill(PhysRegUse,  PhysRegUse  + NumRegs, (MachineInstr*)0);
 505
 506   /// Get some space for a respectable number of registers.
 507   VirtRegInfo.resize(64);
 508
 509   analyzePHINodes(mf);
 510
 511   // Calculate live variable information in depth first order on the CFG of the
 512   // function.  This guarantees that we will see the definition of a virtual
 513   // register before its uses due to dominance properties of SSA (except for PHI
 514   // nodes, which are treated as a special case).
 515   MachineBasicBlock *Entry = MF->begin();
 516   SmallPtrSet<MachineBasicBlock*,16> Visited;
 517
 518   for (df_ext_iterator<MachineBasicBlock*, SmallPtrSet<MachineBasicBlock*,16> >
 519          DFI = df_ext_begin(Entry, Visited), E = df_ext_end(Entry, Visited);
 520        DFI != E; ++DFI) {
 521     MachineBasicBlock *MBB = *DFI;
 522
 523     // Mark live-in registers as live-in.
 524     for (MachineBasicBlock::const_livein_iterator II = MBB->livein_begin(),
 525            EE = MBB->livein_end(); II != EE; ++II) {
 526       assert(TargetRegisterInfo::isPhysicalRegister(*II) &&
 527              "Cannot have a live-in virtual register!");
 528       HandlePhysRegDef(*II, 0);
 529     }
 530
 531     // Loop over all of the instructions, processing them.
 532     DistanceMap.clear();
 533     unsigned Dist = 0;
 534     for (MachineBasicBlock::iterator I = MBB->begin(), E = MBB->end();
 535          I != E; ++I) {
 536       MachineInstr *MI = I;
 537       DistanceMap.insert(std::make_pair(MI, Dist++));
 538
 539       // Process all of the operands of the instruction...
 540       unsigned NumOperandsToProcess = MI->getNumOperands();
 541
 542       // Unless it is a PHI node.  In this case, ONLY process the DEF, not any
 543       // of the uses.  They will be handled in other basic blocks.
 544       if (MI->getOpcode() == TargetInstrInfo::PHI)
 545         NumOperandsToProcess = 1;
 546
 547       SmallVector<unsigned, 4> UseRegs;
 548       SmallVector<unsigned, 4> DefRegs;
 549       for (unsigned i = 0; i != NumOperandsToProcess; ++i) {
 550         const MachineOperand &MO = MI->getOperand(i);
 551         if (!MO.isReg() || MO.getReg() == 0)
 552           continue;
 553         unsigned MOReg = MO.getReg();
 554         if (MO.isUse())
 555           UseRegs.push_back(MOReg);
 556         if (MO.isDef())
 557           DefRegs.push_back(MOReg);
 558       }
 559
 560       // Process all uses.
 561       for (unsigned i = 0, e = UseRegs.size(); i != e; ++i) {
 562         unsigned MOReg = UseRegs[i];
 563         if (TargetRegisterInfo::isVirtualRegister(MOReg))
 564           HandleVirtRegUse(MOReg, MBB, MI);
 565         else if (!ReservedRegisters[MOReg])
 566           HandlePhysRegUse(MOReg, MI);
 567       }
 568
 569       // Process all defs.
 570       for (unsigned i = 0, e = DefRegs.size(); i != e; ++i) {
 571         unsigned MOReg = DefRegs[i];
 572         if (TargetRegisterInfo::isVirtualRegister(MOReg))
 573           HandleVirtRegDef(MOReg, MI);
 574         else if (!ReservedRegisters[MOReg])
 575           HandlePhysRegDef(MOReg, MI);
 576       }
 577     }
 578
 579     // Handle any virtual assignments from PHI nodes which might be at the
 580     // bottom of this basic block.  We check all of our successor blocks to see
 581     // if they have PHI nodes, and if so, we simulate an assignment at the end
 582     // of the current block.
 583     if (!PHIVarInfo[MBB->getNumber()].empty()) {
 584       SmallVector<unsigned, 4>& VarInfoVec = PHIVarInfo[MBB->getNumber()];
 585
 586       for (SmallVector<unsigned, 4>::iterator I = VarInfoVec.begin(),
 587              E = VarInfoVec.end(); I != E; ++I)
 588         // Mark it alive only in the block we are representing.
 589         MarkVirtRegAliveInBlock(getVarInfo(*I),MRI->getVRegDef(*I)->getParent(),
 590                                 MBB);
 591     }
 592
 593     // Finally, if the last instruction in the block is a return, make sure to
 594     // mark it as using all of the live-out values in the function.
 595     if (!MBB->empty() && MBB->back().getDesc().isReturn()) {
 596       MachineInstr *Ret = &MBB->back();
 597
 598       for (MachineRegisterInfo::liveout_iterator
 599            I = MF->getRegInfo().liveout_begin(),
 600            E = MF->getRegInfo().liveout_end(); I != E; ++I) {
 601         assert(TargetRegisterInfo::isPhysicalRegister(*I) &&
 602                "Cannot have a live-out virtual register!");
 603         HandlePhysRegUse(*I, Ret);
 604
 605         // Add live-out registers as implicit uses.
 606         if (!Ret->readsRegister(*I))
 607           Ret->addOperand(MachineOperand::CreateReg(*I, false, true));
 608       }
 609     }
 610
 611     // Loop over PhysRegDef / PhysRegUse, killing any registers that are
 612     // available at the end of the basic block.
 613     for (unsigned i = 0; i != NumRegs; ++i)
 614       if (PhysRegDef[i] || PhysRegUse[i])
 615         HandlePhysRegDef(i, 0);
 616
 617     std::fill(PhysRegDef,  PhysRegDef  + NumRegs, (MachineInstr*)0);
 618     std::fill(PhysRegUse,  PhysRegUse  + NumRegs, (MachineInstr*)0);
 619   }
 620
 621   // Convert and transfer the dead / killed information we have gathered into
 622   // VirtRegInfo onto MI's.
 623   for (unsigned i = 0, e1 = VirtRegInfo.size(); i != e1; ++i)
 624     for (unsigned j = 0, e2 = VirtRegInfo[i].Kills.size(); j != e2; ++j)
 625       if (VirtRegInfo[i].Kills[j] ==
 626           MRI->getVRegDef(i + TargetRegisterInfo::FirstVirtualRegister))
 627         VirtRegInfo[i]
 628           .Kills[j]->addRegisterDead(i +
 629                                      TargetRegisterInfo::FirstVirtualRegister,
 630                                      TRI);
 631       else
 632         VirtRegInfo[i]
 633           .Kills[j]->addRegisterKilled(i +
 634                                        TargetRegisterInfo::FirstVirtualRegister,
 635                                        TRI);
 636
 637   // Check to make sure there are no unreachable blocks in the MC CFG for the
 638   // function.  If so, it is due to a bug in the instruction selector or some
 639   // other part of the code generator if this happens.
 640 #ifndef NDEBUG
 641   for(MachineFunction::iterator i = MF->begin(), e = MF->end(); i != e; ++i)
 642     assert(Visited.count(&*i) != 0 && "unreachable basic block found");
 643 #endif
 644
 645   delete[] PhysRegDef;
 646   delete[] PhysRegUse;
 647   delete[] PHIVarInfo;
 648
 649   return false;
 650 }
 651
 652 /// replaceKillInstruction - Update register kill info by replacing a kill
 653 /// instruction with a new one.
 654 void LiveVariables::replaceKillInstruction(unsigned Reg, MachineInstr *OldMI,
 655                                            MachineInstr *NewMI) {
 656   VarInfo &VI = getVarInfo(Reg);
 657   std::replace(VI.Kills.begin(), VI.Kills.end(), OldMI, NewMI);
 658 }
 659
 660 /// removeVirtualRegistersKilled - Remove all killed info for the specified
 661 /// instruction.
 662 void LiveVariables::removeVirtualRegistersKilled(MachineInstr *MI) {
 663   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 664     MachineOperand &MO = MI->getOperand(i);
 665     if (MO.isReg() && MO.isKill()) {
 666       MO.setIsKill(false);
 667       unsigned Reg = MO.getReg();
 668       if (TargetRegisterInfo::isVirtualRegister(Reg)) {
 669         bool removed = getVarInfo(Reg).removeKill(MI);
 670         assert(removed && "kill not in register's VarInfo?");
 671         removed = true;
 672       }
 673     }
 674   }
 675 }
 676
 677 /// analyzePHINodes - Gather information about the PHI nodes in here. In
 678 /// particular, we want to map the variable information of a virtual register
 679 /// which is used in a PHI node. We map that to the BB the vreg is coming from.
 680 ///
 681 void LiveVariables::analyzePHINodes(const MachineFunction& Fn) {
 682   for (MachineFunction::const_iterator I = Fn.begin(), E = Fn.end();
 683        I != E; ++I)
 684     for (MachineBasicBlock::const_iterator BBI = I->begin(), BBE = I->end();
 685          BBI != BBE && BBI->getOpcode() == TargetInstrInfo::PHI; ++BBI)
 686       for (unsigned i = 1, e = BBI->getNumOperands(); i != e; i += 2)
 687         PHIVarInfo[BBI->getOperand(i + 1).getMBB()->getNumber()]
 688           .push_back(BBI->getOperand(i).getReg());
 689 }