lib/CodeGen/RegAllocLocal.cpp

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