lib/CodeGen/RegAllocLocal.cpp

   1 //===-- RegAllocLocal.cpp - A BasicBlock generic register allocator -------===//
   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 register allocator allocates registers to a basic block at a time,
  11 // attempting to keep values in registers and reusing registers as appropriate.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #define DEBUG_TYPE "regalloc"
  16 #include "llvm/BasicBlock.h"
  17 #include "llvm/CodeGen/Passes.h"
  18 #include "llvm/CodeGen/MachineFunctionPass.h"
  19 #include "llvm/CodeGen/MachineInstr.h"
  20 #include "llvm/CodeGen/SSARegMap.h"
  21 #include "llvm/CodeGen/MachineFrameInfo.h"
  22 #include "llvm/CodeGen/LiveVariables.h"
  23 #include "llvm/CodeGen/RegAllocRegistry.h"
  24 #include "llvm/Target/TargetInstrInfo.h"
  25 #include "llvm/Target/TargetMachine.h"
  26 #include "llvm/Support/CommandLine.h"
  27 #include "llvm/Support/Debug.h"
  28 #include "llvm/Support/Compiler.h"
  29 #include "llvm/ADT/IndexedMap.h"
  30 #include "llvm/ADT/SmallVector.h"
  31 #include "llvm/ADT/Statistic.h"
  32 #include <algorithm>
  33 using namespace llvm;
  34
  35 STATISTIC(NumStores, "Number of stores added");
  36 STATISTIC(NumLoads , "Number of loads added");
  37 STATISTIC(NumFolded, "Number of loads/stores folded into instructions");
  38
  39 namespace {
  40   static RegisterRegAlloc
  41     localRegAlloc("local", "  local register allocator",
  42                   createLocalRegisterAllocator);
  43
  44
  45   class VISIBILITY_HIDDEN RA : public MachineFunctionPass {
  46     const TargetMachine *TM;
  47     MachineFunction *MF;
  48     const MRegisterInfo *RegInfo;
  49     LiveVariables *LV;
  50
  51     // StackSlotForVirtReg - Maps virtual regs to the frame index where these
  52     // values are spilled.
  53     std::map<unsigned, int> StackSlotForVirtReg;
  54
  55     // Virt2PhysRegMap - This map contains entries for each virtual register
  56     // that is currently available in a physical register.
  57     IndexedMap<unsigned, VirtReg2IndexFunctor> Virt2PhysRegMap;
  58
  59     unsigned &getVirt2PhysRegMapSlot(unsigned VirtReg) {
  60       return Virt2PhysRegMap[VirtReg];
  61     }
  62
  63     // PhysRegsUsed - This array is effectively a map, containing entries for
  64     // each physical register that currently has a value (ie, it is in
  65     // Virt2PhysRegMap).  The value mapped to is the virtual register
  66     // corresponding to the physical register (the inverse of the
  67     // Virt2PhysRegMap), or 0.  The value is set to 0 if this register is pinned
  68     // because it is used by a future instruction, and to -2 if it is not
  69     // allocatable.  If the entry for a physical register is -1, then the
  70     // physical register is "not in the map".
  71     //
  72     std::vector<int> PhysRegsUsed;
  73
  74     // PhysRegsUseOrder - This contains a list of the physical registers that
  75     // currently have a virtual register value in them.  This list provides an
  76     // ordering of registers, imposing a reallocation order.  This list is only
  77     // used if all registers are allocated and we have to spill one, in which
  78     // case we spill the least recently used register.  Entries at the front of
  79     // the list are the least recently used registers, entries at the back are
  80     // the most recently used.
  81     //
  82     std::vector<unsigned> PhysRegsUseOrder;
  83
  84     // VirtRegModified - This bitset contains information about which virtual
  85     // registers need to be spilled back to memory when their registers are
  86     // scavenged.  If a virtual register has simply been rematerialized, there
  87     // is no reason to spill it to memory when we need the register back.
  88     //
  89     std::vector<bool> VirtRegModified;
  90
  91     void markVirtRegModified(unsigned Reg, bool Val = true) {
  92       assert(MRegisterInfo::isVirtualRegister(Reg) && "Illegal VirtReg!");
  93       Reg -= MRegisterInfo::FirstVirtualRegister;
  94       if (VirtRegModified.size() <= Reg) VirtRegModified.resize(Reg+1);
  95       VirtRegModified[Reg] = Val;
  96     }
  97
  98     bool isVirtRegModified(unsigned Reg) const {
  99       assert(MRegisterInfo::isVirtualRegister(Reg) && "Illegal VirtReg!");
 100       assert(Reg - MRegisterInfo::FirstVirtualRegister < VirtRegModified.size()
 101              && "Illegal virtual register!");
 102       return VirtRegModified[Reg - MRegisterInfo::FirstVirtualRegister];
 103     }
 104
 105     void MarkPhysRegRecentlyUsed(unsigned Reg) {
 106       if (PhysRegsUseOrder.empty() ||
 107           PhysRegsUseOrder.back() == Reg) return;  // Already most recently used
 108
 109       for (unsigned i = PhysRegsUseOrder.size(); i != 0; --i)
 110         if (areRegsEqual(Reg, PhysRegsUseOrder[i-1])) {
 111           unsigned RegMatch = PhysRegsUseOrder[i-1];       // remove from middle
 112           PhysRegsUseOrder.erase(PhysRegsUseOrder.begin()+i-1);
 113           // Add it to the end of the list
 114           PhysRegsUseOrder.push_back(RegMatch);
 115           if (RegMatch == Reg)
 116             return;    // Found an exact match, exit early
 117         }
 118     }
 119
 120   public:
 121     virtual const char *getPassName() const {
 122       return "Local Register Allocator";
 123     }
 124
 125     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 126       AU.addRequired<LiveVariables>();
 127       AU.addRequiredID(PHIEliminationID);
 128       AU.addRequiredID(TwoAddressInstructionPassID);
 129       MachineFunctionPass::getAnalysisUsage(AU);
 130     }
 131
 132   private:
 133     /// runOnMachineFunction - Register allocate the whole function
 134     bool runOnMachineFunction(MachineFunction &Fn);
 135
 136     /// AllocateBasicBlock - Register allocate the specified basic block.
 137     void AllocateBasicBlock(MachineBasicBlock &MBB);
 138
 139
 140     /// areRegsEqual - This method returns true if the specified registers are
 141     /// related to each other.  To do this, it checks to see if they are equal
 142     /// or if the first register is in the alias set of the second register.
 143     ///
 144     bool areRegsEqual(unsigned R1, unsigned R2) const {
 145       if (R1 == R2) return true;
 146       for (const unsigned *AliasSet = RegInfo->getAliasSet(R2);
 147            *AliasSet; ++AliasSet) {
 148         if (*AliasSet == R1) return true;
 149       }
 150       return false;
 151     }
 152
 153     /// getStackSpaceFor - This returns the frame index of the specified virtual
 154     /// register on the stack, allocating space if necessary.
 155     int getStackSpaceFor(unsigned VirtReg, const TargetRegisterClass *RC);
 156
 157     /// removePhysReg - This method marks the specified physical register as no
 158     /// longer being in use.
 159     ///
 160     void removePhysReg(unsigned PhysReg);
 161
 162     /// spillVirtReg - This method spills the value specified by PhysReg into
 163     /// the virtual register slot specified by VirtReg.  It then updates the RA
 164     /// data structures to indicate the fact that PhysReg is now available.
 165     ///
 166     void spillVirtReg(MachineBasicBlock &MBB, MachineBasicBlock::iterator MI,
 167                       unsigned VirtReg, unsigned PhysReg);
 168
 169     /// spillPhysReg - This method spills the specified physical register into
 170     /// the virtual register slot associated with it.  If OnlyVirtRegs is set to
 171     /// true, then the request is ignored if the physical register does not
 172     /// contain a virtual register.
 173     ///
 174     void spillPhysReg(MachineBasicBlock &MBB, MachineInstr *I,
 175                       unsigned PhysReg, bool OnlyVirtRegs = false);
 176
 177     /// assignVirtToPhysReg - This method updates local state so that we know
 178     /// that PhysReg is the proper container for VirtReg now.  The physical
 179     /// register must not be used for anything else when this is called.
 180     ///
 181     void assignVirtToPhysReg(unsigned VirtReg, unsigned PhysReg);
 182
 183     /// liberatePhysReg - Make sure the specified physical register is available
 184     /// for use.  If there is currently a value in it, it is either moved out of
 185     /// the way or spilled to memory.
 186     ///
 187     void liberatePhysReg(MachineBasicBlock &MBB, MachineBasicBlock::iterator &I,
 188                          unsigned PhysReg);
 189
 190     /// isPhysRegAvailable - Return true if the specified physical register is
 191     /// free and available for use.  This also includes checking to see if
 192     /// aliased registers are all free...
 193     ///
 194     bool isPhysRegAvailable(unsigned PhysReg) const;
 195
 196     /// getFreeReg - Look to see if there is a free register available in the
 197     /// specified register class.  If not, return 0.
 198     ///
 199     unsigned getFreeReg(const TargetRegisterClass *RC);
 200
 201     /// getReg - Find a physical register to hold the specified virtual
 202     /// register.  If all compatible physical registers are used, this method
 203     /// spills the last used virtual register to the stack, and uses that
 204     /// register.
 205     ///
 206     unsigned getReg(MachineBasicBlock &MBB, MachineInstr *MI,
 207                     unsigned VirtReg);
 208
 209     /// reloadVirtReg - This method transforms the specified specified virtual
 210     /// register use to refer to a physical register.  This method may do this
 211     /// in one of several ways: if the register is available in a physical
 212     /// register already, it uses that physical register.  If the value is not
 213     /// in a physical register, and if there are physical registers available,
 214     /// it loads it into a register.  If register pressure is high, and it is
 215     /// possible, it tries to fold the load of the virtual register into the
 216     /// instruction itself.  It avoids doing this if register pressure is low to
 217     /// improve the chance that subsequent instructions can use the reloaded
 218     /// value.  This method returns the modified instruction.
 219     ///
 220     MachineInstr *reloadVirtReg(MachineBasicBlock &MBB, MachineInstr *MI,
 221                                 unsigned OpNum);
 222
 223
 224     void reloadPhysReg(MachineBasicBlock &MBB, MachineBasicBlock::iterator &I,
 225                        unsigned PhysReg);
 226   };
 227 }
 228
 229 /// getStackSpaceFor - This allocates space for the specified virtual register
 230 /// to be held on the stack.
 231 int RA::getStackSpaceFor(unsigned VirtReg, const TargetRegisterClass *RC) {
 232   // Find the location Reg would belong...
 233   std::map<unsigned, int>::iterator I =StackSlotForVirtReg.lower_bound(VirtReg);
 234
 235   if (I != StackSlotForVirtReg.end() && I->first == VirtReg)
 236     return I->second;          // Already has space allocated?
 237
 238   // Allocate a new stack object for this spill location...
 239   int FrameIdx = MF->getFrameInfo()->CreateStackObject(RC->getSize(),
 240                                                        RC->getAlignment());
 241
 242   // Assign the slot...
 243   StackSlotForVirtReg.insert(I, std::make_pair(VirtReg, FrameIdx));
 244   return FrameIdx;
 245 }
 246
 247
 248 /// removePhysReg - This method marks the specified physical register as no
 249 /// longer being in use.
 250 ///
 251 void RA::removePhysReg(unsigned PhysReg) {
 252   PhysRegsUsed[PhysReg] = -1;      // PhyReg no longer used
 253
 254   std::vector<unsigned>::iterator It =
 255     std::find(PhysRegsUseOrder.begin(), PhysRegsUseOrder.end(), PhysReg);
 256   if (It != PhysRegsUseOrder.end())
 257     PhysRegsUseOrder.erase(It);
 258 }
 259
 260
 261 /// spillVirtReg - This method spills the value specified by PhysReg into the
 262 /// virtual register slot specified by VirtReg.  It then updates the RA data
 263 /// structures to indicate the fact that PhysReg is now available.
 264 ///
 265 void RA::spillVirtReg(MachineBasicBlock &MBB, MachineBasicBlock::iterator I,
 266                       unsigned VirtReg, unsigned PhysReg) {
 267   assert(VirtReg && "Spilling a physical register is illegal!"
 268          " Must not have appropriate kill for the register or use exists beyond"
 269          " the intended one.");
 270   DOUT << "  Spilling register " << RegInfo->getName(PhysReg)
 271        << " containing %reg" << VirtReg;
 272   if (!isVirtRegModified(VirtReg))
 273     DOUT << " which has not been modified, so no store necessary!";
 274
 275   // Otherwise, there is a virtual register corresponding to this physical
 276   // register.  We only need to spill it into its stack slot if it has been
 277   // modified.
 278   if (isVirtRegModified(VirtReg)) {
 279     const TargetRegisterClass *RC = MF->getSSARegMap()->getRegClass(VirtReg);
 280     int FrameIndex = getStackSpaceFor(VirtReg, RC);
 281     DOUT << " to stack slot #" << FrameIndex;
 282     RegInfo->storeRegToStackSlot(MBB, I, PhysReg, FrameIndex, RC);
 283     ++NumStores;   // Update statistics
 284   }
 285
 286   getVirt2PhysRegMapSlot(VirtReg) = 0;   // VirtReg no longer available
 287
 288   DOUT << "\n";
 289   removePhysReg(PhysReg);
 290 }
 291
 292
 293 /// spillPhysReg - This method spills the specified physical register into the
 294 /// virtual register slot associated with it.  If OnlyVirtRegs is set to true,
 295 /// then the request is ignored if the physical register does not contain a
 296 /// virtual register.
 297 ///
 298 void RA::spillPhysReg(MachineBasicBlock &MBB, MachineInstr *I,
 299                       unsigned PhysReg, bool OnlyVirtRegs) {
 300   if (PhysRegsUsed[PhysReg] != -1) {            // Only spill it if it's used!
 301     assert(PhysRegsUsed[PhysReg] != -2 && "Non allocable reg used!");
 302     if (PhysRegsUsed[PhysReg] || !OnlyVirtRegs)
 303       spillVirtReg(MBB, I, PhysRegsUsed[PhysReg], PhysReg);
 304   } else {
 305     // If the selected register aliases any other registers, we must make
 306     // sure that one of the aliases isn't alive.
 307     for (const unsigned *AliasSet = RegInfo->getAliasSet(PhysReg);
 308          *AliasSet; ++AliasSet)
 309       if (PhysRegsUsed[*AliasSet] != -1 &&     // Spill aliased register.
 310           PhysRegsUsed[*AliasSet] != -2)       // If allocatable.
 311         if (PhysRegsUsed[*AliasSet] == 0) {
 312           // This must have been a dead def due to something like this:
 313           // %EAX :=
 314           //      := op %AL
 315           // No more use of %EAX, %AH, etc.
 316           // %EAX isn't dead upon definition, but %AH is. However %AH isn't
 317           // an operand of definition MI so it's not marked as such.
 318           DOUT << "  Register " << RegInfo->getName(*AliasSet)
 319                << " [%reg" << *AliasSet
 320                << "] is never used, removing it frame live list\n";
 321           removePhysReg(*AliasSet);
 322         } else
 323           spillVirtReg(MBB, I, PhysRegsUsed[*AliasSet], *AliasSet);
 324   }
 325 }
 326
 327
 328 /// assignVirtToPhysReg - This method updates local state so that we know
 329 /// that PhysReg is the proper container for VirtReg now.  The physical
 330 /// register must not be used for anything else when this is called.
 331 ///
 332 void RA::assignVirtToPhysReg(unsigned VirtReg, unsigned PhysReg) {
 333   assert(PhysRegsUsed[PhysReg] == -1 && "Phys reg already assigned!");
 334   // Update information to note the fact that this register was just used, and
 335   // it holds VirtReg.
 336   PhysRegsUsed[PhysReg] = VirtReg;
 337   getVirt2PhysRegMapSlot(VirtReg) = PhysReg;
 338   PhysRegsUseOrder.push_back(PhysReg);   // New use of PhysReg
 339 }
 340
 341
 342 /// isPhysRegAvailable - Return true if the specified physical register is free
 343 /// and available for use.  This also includes checking to see if aliased
 344 /// registers are all free...
 345 ///
 346 bool RA::isPhysRegAvailable(unsigned PhysReg) const {
 347   if (PhysRegsUsed[PhysReg] != -1) return false;
 348
 349   // If the selected register aliases any other allocated registers, it is
 350   // not free!
 351   for (const unsigned *AliasSet = RegInfo->getAliasSet(PhysReg);
 352        *AliasSet; ++AliasSet)
 353     if (PhysRegsUsed[*AliasSet] != -1) // Aliased register in use?
 354       return false;                    // Can't use this reg then.
 355   return true;
 356 }
 357
 358
 359 /// getFreeReg - Look to see if there is a free register available in the
 360 /// specified register class.  If not, return 0.
 361 ///
 362 unsigned RA::getFreeReg(const TargetRegisterClass *RC) {
 363   // Get iterators defining the range of registers that are valid to allocate in
 364   // this class, which also specifies the preferred allocation order.
 365   TargetRegisterClass::iterator RI = RC->allocation_order_begin(*MF);
 366   TargetRegisterClass::iterator RE = RC->allocation_order_end(*MF);
 367
 368   for (; RI != RE; ++RI)
 369     if (isPhysRegAvailable(*RI)) {       // Is reg unused?
 370       assert(*RI != 0 && "Cannot use register!");
 371       return *RI; // Found an unused register!
 372     }
 373   return 0;
 374 }
 375
 376
 377 /// liberatePhysReg - Make sure the specified physical register is available for
 378 /// use.  If there is currently a value in it, it is either moved out of the way
 379 /// or spilled to memory.
 380 ///
 381 void RA::liberatePhysReg(MachineBasicBlock &MBB, MachineBasicBlock::iterator &I,
 382                          unsigned PhysReg) {
 383   spillPhysReg(MBB, I, PhysReg);
 384 }
 385
 386
 387 /// getReg - Find a physical register to hold the specified virtual
 388 /// register.  If all compatible physical registers are used, this method spills
 389 /// the last used virtual register to the stack, and uses that register.
 390 ///
 391 unsigned RA::getReg(MachineBasicBlock &MBB, MachineInstr *I,
 392                     unsigned VirtReg) {
 393   const TargetRegisterClass *RC = MF->getSSARegMap()->getRegClass(VirtReg);
 394
 395   // First check to see if we have a free register of the requested type...
 396   unsigned PhysReg = getFreeReg(RC);
 397
 398   // If we didn't find an unused register, scavenge one now!
 399   if (PhysReg == 0) {
 400     assert(!PhysRegsUseOrder.empty() && "No allocated registers??");
 401
 402     // Loop over all of the preallocated registers from the least recently used
 403     // to the most recently used.  When we find one that is capable of holding
 404     // our register, use it.
 405     for (unsigned i = 0; PhysReg == 0; ++i) {
 406       assert(i != PhysRegsUseOrder.size() &&
 407              "Couldn't find a register of the appropriate class!");
 408
 409       unsigned R = PhysRegsUseOrder[i];
 410
 411       // We can only use this register if it holds a virtual register (ie, it
 412       // can be spilled).  Do not use it if it is an explicitly allocated
 413       // physical register!
 414       assert(PhysRegsUsed[R] != -1 &&
 415              "PhysReg in PhysRegsUseOrder, but is not allocated?");
 416       if (PhysRegsUsed[R] && PhysRegsUsed[R] != -2) {
 417         // If the current register is compatible, use it.
 418         if (RC->contains(R)) {
 419           PhysReg = R;
 420           break;
 421         } else {
 422           // If one of the registers aliased to the current register is
 423           // compatible, use it.
 424           for (const unsigned *AliasIt = RegInfo->getAliasSet(R);
 425                *AliasIt; ++AliasIt) {
 426             if (RC->contains(*AliasIt) &&
 427                 // If this is pinned down for some reason, don't use it.  For
 428                 // example, if CL is pinned, and we run across CH, don't use
 429                 // CH as justification for using scavenging ECX (which will
 430                 // fail).
 431                 PhysRegsUsed[*AliasIt] != 0 &&
 432
 433                 // Make sure the register is allocatable.  Don't allocate SIL on
 434                 // x86-32.
 435                 PhysRegsUsed[*AliasIt] != -2) {
 436               PhysReg = *AliasIt;    // Take an aliased register
 437               break;
 438             }
 439           }
 440         }
 441       }
 442     }
 443
 444     assert(PhysReg && "Physical register not assigned!?!?");
 445
 446     // At this point PhysRegsUseOrder[i] is the least recently used register of
 447     // compatible register class.  Spill it to memory and reap its remains.
 448     spillPhysReg(MBB, I, PhysReg);
 449   }
 450
 451   // Now that we know which register we need to assign this to, do it now!
 452   assignVirtToPhysReg(VirtReg, PhysReg);
 453   return PhysReg;
 454 }
 455
 456
 457 /// reloadVirtReg - This method transforms the specified specified virtual
 458 /// register use to refer to a physical register.  This method may do this in
 459 /// one of several ways: if the register is available in a physical register
 460 /// already, it uses that physical register.  If the value is not in a physical
 461 /// register, and if there are physical registers available, it loads it into a
 462 /// register.  If register pressure is high, and it is possible, it tries to
 463 /// fold the load of the virtual register into the instruction itself.  It
 464 /// avoids doing this if register pressure is low to improve the chance that
 465 /// subsequent instructions can use the reloaded value.  This method returns the
 466 /// modified instruction.
 467 ///
 468 MachineInstr *RA::reloadVirtReg(MachineBasicBlock &MBB, MachineInstr *MI,
 469                                 unsigned OpNum) {
 470   unsigned VirtReg = MI->getOperand(OpNum).getReg();
 471
 472   // If the virtual register is already available, just update the instruction
 473   // and return.
 474   if (unsigned PR = getVirt2PhysRegMapSlot(VirtReg)) {
 475     MarkPhysRegRecentlyUsed(PR);          // Already have this value available!
 476     MI->getOperand(OpNum).setReg(PR);  // Assign the input register
 477     return MI;
 478   }
 479
 480   // Otherwise, we need to fold it into the current instruction, or reload it.
 481   // If we have registers available to hold the value, use them.
 482   const TargetRegisterClass *RC = MF->getSSARegMap()->getRegClass(VirtReg);
 483   unsigned PhysReg = getFreeReg(RC);
 484   int FrameIndex = getStackSpaceFor(VirtReg, RC);
 485
 486   if (PhysReg) {   // Register is available, allocate it!
 487     assignVirtToPhysReg(VirtReg, PhysReg);
 488   } else {         // No registers available.
 489     // If we can fold this spill into this instruction, do so now.
 490     if (MachineInstr* FMI = RegInfo->foldMemoryOperand(MI, OpNum, FrameIndex)){
 491       ++NumFolded;
 492       // Since we changed the address of MI, make sure to update live variables
 493       // to know that the new instruction has the properties of the old one.
 494       LV->instructionChanged(MI, FMI);
 495       return MBB.insert(MBB.erase(MI), FMI);
 496     }
 497
 498     // It looks like we can't fold this virtual register load into this
 499     // instruction.  Force some poor hapless value out of the register file to
 500     // make room for the new register, and reload it.
 501     PhysReg = getReg(MBB, MI, VirtReg);
 502   }
 503
 504   markVirtRegModified(VirtReg, false);   // Note that this reg was just reloaded
 505
 506   DOUT << "  Reloading %reg" << VirtReg << " into "
 507        << RegInfo->getName(PhysReg) << "\n";
 508
 509   // Add move instruction(s)
 510   RegInfo->loadRegFromStackSlot(MBB, MI, PhysReg, FrameIndex, RC);
 511   ++NumLoads;    // Update statistics
 512
 513   MF->setPhysRegUsed(PhysReg);
 514   MI->getOperand(OpNum).setReg(PhysReg);  // Assign the input register
 515   return MI;
 516 }
 517
 518
 519
 520 void RA::AllocateBasicBlock(MachineBasicBlock &MBB) {
 521   // loop over each instruction
 522   MachineBasicBlock::iterator MII = MBB.begin();
 523   const TargetInstrInfo &TII = *TM->getInstrInfo();
 524
 525   DEBUG(const BasicBlock *LBB = MBB.getBasicBlock();
 526         if (LBB) DOUT << "\nStarting RegAlloc of BB: " << LBB->getName());
 527
 528   // If this is the first basic block in the machine function, add live-in
 529   // registers as active.
 530   if (&MBB == &*MF->begin()) {
 531     for (MachineFunction::livein_iterator I = MF->livein_begin(),
 532          E = MF->livein_end(); I != E; ++I) {
 533       unsigned Reg = I->first;
 534       MF->setPhysRegUsed(Reg);
 535       PhysRegsUsed[Reg] = 0;            // It is free and reserved now
 536       PhysRegsUseOrder.push_back(Reg);
 537       for (const unsigned *AliasSet = RegInfo->getAliasSet(Reg);
 538            *AliasSet; ++AliasSet) {
 539         if (PhysRegsUsed[*AliasSet] != -2) {
 540           PhysRegsUseOrder.push_back(*AliasSet);
 541           PhysRegsUsed[*AliasSet] = 0;  // It is free and reserved now
 542           MF->setPhysRegUsed(*AliasSet);
 543         }
 544       }
 545     }
 546   }
 547
 548   // Otherwise, sequentially allocate each instruction in the MBB.
 549   while (MII != MBB.end()) {
 550     MachineInstr *MI = MII++;
 551     const TargetInstrDescriptor &TID = TII.get(MI->getOpcode());
 552     DEBUG(DOUT << "\nStarting RegAlloc of: " << *MI;
 553           DOUT << "  Regs have values: ";
 554           for (unsigned i = 0; i != RegInfo->getNumRegs(); ++i)
 555             if (PhysRegsUsed[i] != -1 && PhysRegsUsed[i] != -2)
 556                DOUT << "[" << RegInfo->getName(i)
 557                     << ",%reg" << PhysRegsUsed[i] << "] ";
 558           DOUT << "\n");
 559
 560     // Loop over the implicit uses, making sure that they are at the head of the
 561     // use order list, so they don't get reallocated.
 562     if (TID.ImplicitUses) {
 563       for (const unsigned *ImplicitUses = TID.ImplicitUses;
 564            *ImplicitUses; ++ImplicitUses)
 565         MarkPhysRegRecentlyUsed(*ImplicitUses);
 566     }
 567
 568     SmallVector<unsigned, 8> Kills;
 569     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 570       MachineOperand& MO = MI->getOperand(i);
 571       if (MO.isRegister() && MO.isKill())
 572         Kills.push_back(MO.getReg());
 573     }
 574
 575     // Get the used operands into registers.  This has the potential to spill
 576     // incoming values if we are out of registers.  Note that we completely
 577     // ignore physical register uses here.  We assume that if an explicit
 578     // physical register is referenced by the instruction, that it is guaranteed
 579     // to be live-in, or the input is badly hosed.
 580     //
 581     for (unsigned i = 0; i != MI->getNumOperands(); ++i) {
 582       MachineOperand& MO = MI->getOperand(i);
 583       // here we are looking for only used operands (never def&use)
 584       if (MO.isRegister() && !MO.isDef() && MO.getReg() && !MO.isImplicit() &&
 585           MRegisterInfo::isVirtualRegister(MO.getReg()))
 586         MI = reloadVirtReg(MBB, MI, i);
 587     }
 588
 589     // If this instruction is the last user of this register, kill the
 590     // value, freeing the register being used, so it doesn't need to be
 591     // spilled to memory.
 592     //
 593     for (unsigned i = 0, e = Kills.size(); i != e; ++i) {
 594       unsigned VirtReg = Kills[i];
 595       unsigned PhysReg = VirtReg;
 596       if (MRegisterInfo::isVirtualRegister(VirtReg)) {
 597         // If the virtual register was never materialized into a register, it
 598         // might not be in the map, but it won't hurt to zero it out anyway.
 599         unsigned &PhysRegSlot = getVirt2PhysRegMapSlot(VirtReg);
 600         PhysReg = PhysRegSlot;
 601         PhysRegSlot = 0;
 602       } else if (PhysRegsUsed[PhysReg] == -2) {
 603         // Unallocatable register dead, ignore.
 604         continue;
 605       }
 606
 607       if (PhysReg) {
 608         DOUT << "  Last use of " << RegInfo->getName(PhysReg)
 609              << "[%reg" << VirtReg <<"], removing it from live set\n";
 610         removePhysReg(PhysReg);
 611         for (const unsigned *AliasSet = RegInfo->getAliasSet(PhysReg);
 612              *AliasSet; ++AliasSet) {
 613           if (PhysRegsUsed[*AliasSet] != -2) {
 614             DOUT  << "  Last use of "
 615                   << RegInfo->getName(*AliasSet)
 616                   << "[%reg" << VirtReg <<"], removing it from live set\n";
 617             removePhysReg(*AliasSet);
 618           }
 619         }
 620       }
 621     }
 622
 623     // Loop over all of the operands of the instruction, spilling registers that
 624     // are defined, and marking explicit destinations in the PhysRegsUsed map.
 625     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 626       MachineOperand& MO = MI->getOperand(i);
 627       if (MO.isRegister() && MO.isDef() && !MO.isImplicit() && MO.getReg() &&
 628           MRegisterInfo::isPhysicalRegister(MO.getReg())) {
 629         unsigned Reg = MO.getReg();
 630         if (PhysRegsUsed[Reg] == -2) continue;  // Something like ESP.
 631
 632         MF->setPhysRegUsed(Reg);
 633         spillPhysReg(MBB, MI, Reg, true); // Spill any existing value in reg
 634         PhysRegsUsed[Reg] = 0;            // It is free and reserved now
 635         PhysRegsUseOrder.push_back(Reg);
 636         for (const unsigned *AliasSet = RegInfo->getAliasSet(Reg);
 637              *AliasSet; ++AliasSet) {
 638           if (PhysRegsUsed[*AliasSet] != -2) {
 639             PhysRegsUseOrder.push_back(*AliasSet);
 640             PhysRegsUsed[*AliasSet] = 0;  // It is free and reserved now
 641             MF->setPhysRegUsed(*AliasSet);
 642           }
 643         }
 644       }
 645     }
 646
 647     // Loop over the implicit defs, spilling them as well.
 648     if (TID.ImplicitDefs) {
 649       for (const unsigned *ImplicitDefs = TID.ImplicitDefs;
 650            *ImplicitDefs; ++ImplicitDefs) {
 651         unsigned Reg = *ImplicitDefs;
 652         bool IsNonAllocatable = PhysRegsUsed[Reg] == -2;
 653         if (!IsNonAllocatable) {
 654           spillPhysReg(MBB, MI, Reg, true);
 655           PhysRegsUseOrder.push_back(Reg);
 656           PhysRegsUsed[Reg] = 0;            // It is free and reserved now
 657         }
 658         MF->setPhysRegUsed(Reg);
 659
 660         for (const unsigned *AliasSet = RegInfo->getAliasSet(Reg);
 661              *AliasSet; ++AliasSet) {
 662           if (PhysRegsUsed[*AliasSet] != -2) {
 663             if (!IsNonAllocatable) {
 664               PhysRegsUseOrder.push_back(*AliasSet);
 665               PhysRegsUsed[*AliasSet] = 0;  // It is free and reserved now
 666             }
 667             MF->setPhysRegUsed(*AliasSet);
 668           }
 669         }
 670       }
 671     }
 672
 673     SmallVector<unsigned, 8> DeadDefs;
 674     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 675       MachineOperand& MO = MI->getOperand(i);
 676       if (MO.isRegister() && MO.isDead())
 677         DeadDefs.push_back(MO.getReg());
 678     }
 679
 680     // Okay, we have allocated all of the source operands and spilled any values
 681     // that would be destroyed by defs of this instruction.  Loop over the
 682     // explicit defs and assign them to a register, spilling incoming values if
 683     // we need to scavenge a register.
 684     //
 685     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 686       MachineOperand& MO = MI->getOperand(i);
 687       if (MO.isRegister() && MO.isDef() && MO.getReg() &&
 688           MRegisterInfo::isVirtualRegister(MO.getReg())) {
 689         unsigned DestVirtReg = MO.getReg();
 690         unsigned DestPhysReg;
 691
 692         // If DestVirtReg already has a value, use it.
 693         if (!(DestPhysReg = getVirt2PhysRegMapSlot(DestVirtReg)))
 694           DestPhysReg = getReg(MBB, MI, DestVirtReg);
 695         MF->setPhysRegUsed(DestPhysReg);
 696         markVirtRegModified(DestVirtReg);
 697         MI->getOperand(i).setReg(DestPhysReg);  // Assign the output register
 698       }
 699     }
 700
 701     // If this instruction defines any registers that are immediately dead,
 702     // kill them now.
 703     //
 704     for (unsigned i = 0, e = DeadDefs.size(); i != e; ++i) {
 705       unsigned VirtReg = DeadDefs[i];
 706       unsigned PhysReg = VirtReg;
 707       if (MRegisterInfo::isVirtualRegister(VirtReg)) {
 708         unsigned &PhysRegSlot = getVirt2PhysRegMapSlot(VirtReg);
 709         PhysReg = PhysRegSlot;
 710         assert(PhysReg != 0);
 711         PhysRegSlot = 0;
 712       } else if (PhysRegsUsed[PhysReg] == -2) {
 713         // Unallocatable register dead, ignore.
 714         continue;
 715       }
 716
 717       if (PhysReg) {
 718         DOUT  << "  Register " << RegInfo->getName(PhysReg)
 719               << " [%reg" << VirtReg
 720               << "] is never used, removing it frame live list\n";
 721         removePhysReg(PhysReg);
 722         for (const unsigned *AliasSet = RegInfo->getAliasSet(PhysReg);
 723              *AliasSet; ++AliasSet) {
 724           if (PhysRegsUsed[*AliasSet] != -2) {
 725             DOUT  << "  Register " << RegInfo->getName(*AliasSet)
 726                   << " [%reg" << *AliasSet
 727                   << "] is never used, removing it frame live list\n";
 728             removePhysReg(*AliasSet);
 729           }
 730         }
 731       }
 732     }
 733
 734     // Finally, if this is a noop copy instruction, zap it.
 735     unsigned SrcReg, DstReg;
 736     if (TII.isMoveInstr(*MI, SrcReg, DstReg) && SrcReg == DstReg) {
 737       LV->removeVirtualRegistersKilled(MI);
 738       LV->removeVirtualRegistersDead(MI);
 739       MBB.erase(MI);
 740     }
 741   }
 742
 743   MachineBasicBlock::iterator MI = MBB.getFirstTerminator();
 744
 745   // Spill all physical registers holding virtual registers now.
 746   for (unsigned i = 0, e = RegInfo->getNumRegs(); i != e; ++i)
 747     if (PhysRegsUsed[i] != -1 && PhysRegsUsed[i] != -2)
 748       if (unsigned VirtReg = PhysRegsUsed[i])
 749         spillVirtReg(MBB, MI, VirtReg, i);
 750       else
 751         removePhysReg(i);
 752
 753 #if 0
 754   // This checking code is very expensive.
 755   bool AllOk = true;
 756   for (unsigned i = MRegisterInfo::FirstVirtualRegister,
 757            e = MF->getSSARegMap()->getLastVirtReg(); i <= e; ++i)
 758     if (unsigned PR = Virt2PhysRegMap[i]) {
 759       cerr << "Register still mapped: " << i << " -> " << PR << "\n";
 760       AllOk = false;
 761     }
 762   assert(AllOk && "Virtual registers still in phys regs?");
 763 #endif
 764
 765   // Clear any physical register which appear live at the end of the basic
 766   // block, but which do not hold any virtual registers.  e.g., the stack
 767   // pointer.
 768   PhysRegsUseOrder.clear();
 769 }
 770
 771
 772 /// runOnMachineFunction - Register allocate the whole function
 773 ///
 774 bool RA::runOnMachineFunction(MachineFunction &Fn) {
 775   DOUT << "Machine Function " << "\n";
 776   MF = &Fn;
 777   TM = &Fn.getTarget();
 778   RegInfo = TM->getRegisterInfo();
 779   LV = &getAnalysis<LiveVariables>();
 780
 781   PhysRegsUsed.assign(RegInfo->getNumRegs(), -1);
 782
 783   // At various places we want to efficiently check to see whether a register
 784   // is allocatable.  To handle this, we mark all unallocatable registers as
 785   // being pinned down, permanently.
 786   {
 787     BitVector Allocable = RegInfo->getAllocatableSet(Fn);
 788     for (unsigned i = 0, e = Allocable.size(); i != e; ++i)
 789       if (!Allocable[i])
 790         PhysRegsUsed[i] = -2;  // Mark the reg unallocable.
 791   }
 792
 793   // initialize the virtual->physical register map to have a 'null'
 794   // mapping for all virtual registers
 795   Virt2PhysRegMap.grow(MF->getSSARegMap()->getLastVirtReg());
 796
 797   // Loop over all of the basic blocks, eliminating virtual register references
 798   for (MachineFunction::iterator MBB = Fn.begin(), MBBe = Fn.end();
 799        MBB != MBBe; ++MBB)
 800     AllocateBasicBlock(*MBB);
 801
 802   StackSlotForVirtReg.clear();
 803   PhysRegsUsed.clear();
 804   VirtRegModified.clear();
 805   Virt2PhysRegMap.clear();
 806   return true;
 807 }
 808
 809 FunctionPass *llvm::createLocalRegisterAllocator() {
 810   return new RA();
 811 }