lib/CodeGen/RegisterScavenging.cpp

   1 //===-- RegisterScavenging.cpp - Machine register scavenging --------------===//
   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 machine register scavenger. It can provide
  11 // information, such as unused registers, at any point in a machine basic block.
  12 // It also provides a mechanism to make registers available by evicting them to
  13 // spill slots.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #define DEBUG_TYPE "reg-scavenging"
  18 #include "llvm/CodeGen/RegisterScavenging.h"
  19 #include "llvm/CodeGen/MachineFrameInfo.h"
  20 #include "llvm/CodeGen/MachineFunction.h"
  21 #include "llvm/CodeGen/MachineBasicBlock.h"
  22 #include "llvm/CodeGen/MachineInstr.h"
  23 #include "llvm/CodeGen/MachineRegisterInfo.h"
  24 #include "llvm/Support/ErrorHandling.h"
  25 #include "llvm/Target/TargetRegisterInfo.h"
  26 #include "llvm/Target/TargetInstrInfo.h"
  27 #include "llvm/Target/TargetMachine.h"
  28 #include "llvm/ADT/DenseMap.h"
  29 #include "llvm/ADT/SmallPtrSet.h"
  30 #include "llvm/ADT/SmallVector.h"
  31 #include "llvm/ADT/STLExtras.h"
  32 using namespace llvm;
  33
  34 /// setUsed - Set the register and its sub-registers as being used.
  35 void RegScavenger::setUsed(unsigned Reg) {
  36   RegsAvailable.reset(Reg);
  37
  38   for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
  39        unsigned SubReg = *SubRegs; ++SubRegs)
  40     RegsAvailable.reset(SubReg);
  41 }
  42
  43 bool RegScavenger::isAliasUsed(unsigned Reg) const {
  44   if (isUsed(Reg))
  45     return true;
  46   for (const unsigned *R = TRI->getAliasSet(Reg); *R; ++R)
  47     if (isUsed(*R))
  48       return true;
  49   return false;
  50 }
  51
  52 void RegScavenger::initRegState() {
  53   ScavengedReg = 0;
  54   ScavengedRC = NULL;
  55   ScavengeRestore = NULL;
  56
  57   // All registers started out unused.
  58   RegsAvailable.set();
  59
  60   // Reserved registers are always used.
  61   RegsAvailable ^= ReservedRegs;
  62
  63   if (!MBB)
  64     return;
  65
  66   // Live-in registers are in use.
  67   for (MachineBasicBlock::const_livein_iterator I = MBB->livein_begin(),
  68          E = MBB->livein_end(); I != E; ++I)
  69     setUsed(*I);
  70
  71   // Pristine CSRs are also unavailable.
  72   BitVector PR = MBB->getParent()->getFrameInfo()->getPristineRegs(MBB);
  73   for (int I = PR.find_first(); I>0; I = PR.find_next(I))
  74     setUsed(I);
  75 }
  76
  77 void RegScavenger::enterBasicBlock(MachineBasicBlock *mbb) {
  78   MachineFunction &MF = *mbb->getParent();
  79   const TargetMachine &TM = MF.getTarget();
  80   TII = TM.getInstrInfo();
  81   TRI = TM.getRegisterInfo();
  82   MRI = &MF.getRegInfo();
  83
  84   assert((NumPhysRegs == 0 || NumPhysRegs == TRI->getNumRegs()) &&
  85          "Target changed?");
  86
  87   // Self-initialize.
  88   if (!MBB) {
  89     NumPhysRegs = TRI->getNumRegs();
  90     RegsAvailable.resize(NumPhysRegs);
  91
  92     // Create reserved registers bitvector.
  93     ReservedRegs = TRI->getReservedRegs(MF);
  94
  95     // Create callee-saved registers bitvector.
  96     CalleeSavedRegs.resize(NumPhysRegs);
  97     const unsigned *CSRegs = TRI->getCalleeSavedRegs();
  98     if (CSRegs != NULL)
  99       for (unsigned i = 0; CSRegs[i]; ++i)
 100         CalleeSavedRegs.set(CSRegs[i]);
 101   }
 102
 103   // RS used within emit{Pro,Epi}logue()
 104   if (mbb != MBB) {
 105     MBB = mbb;
 106     initRegState();
 107   }
 108
 109   Tracking = false;
 110 }
 111
 112 #ifndef NDEBUG
 113 /// isLiveInButUnusedBefore - Return true if register is livein the MBB not
 114 /// not used before it reaches the MI that defines register.
 115 static bool isLiveInButUnusedBefore(unsigned Reg, MachineInstr *MI,
 116                                     MachineBasicBlock *MBB,
 117                                     const TargetRegisterInfo *TRI,
 118                                     MachineRegisterInfo* MRI) {
 119   // First check if register is livein.
 120   bool isLiveIn = false;
 121   for (MachineBasicBlock::const_livein_iterator I = MBB->livein_begin(),
 122          E = MBB->livein_end(); I != E; ++I)
 123     if (Reg == *I || TRI->isSuperRegister(Reg, *I)) {
 124       isLiveIn = true;
 125       break;
 126     }
 127   if (!isLiveIn)
 128     return false;
 129
 130   // Is there any use of it before the specified MI?
 131   SmallPtrSet<MachineInstr*, 4> UsesInMBB;
 132   for (MachineRegisterInfo::use_iterator UI = MRI->use_begin(Reg),
 133          UE = MRI->use_end(); UI != UE; ++UI) {
 134     MachineOperand &UseMO = UI.getOperand();
 135     if (UseMO.isReg() && UseMO.isUndef())
 136       continue;
 137     MachineInstr *UseMI = &*UI;
 138     if (UseMI->getParent() == MBB)
 139       UsesInMBB.insert(UseMI);
 140   }
 141   if (UsesInMBB.empty())
 142     return true;
 143
 144   for (MachineBasicBlock::iterator I = MBB->begin(), E = MI; I != E; ++I)
 145     if (UsesInMBB.count(&*I))
 146       return false;
 147   return true;
 148 }
 149 #endif
 150
 151 void RegScavenger::addRegWithSubRegs(BitVector &BV, unsigned Reg) {
 152   BV.set(Reg);
 153   for (const unsigned *R = TRI->getSubRegisters(Reg); *R; R++)
 154     BV.set(*R);
 155 }
 156
 157 void RegScavenger::addRegWithAliases(BitVector &BV, unsigned Reg) {
 158   BV.set(Reg);
 159   for (const unsigned *R = TRI->getAliasSet(Reg); *R; R++)
 160     BV.set(*R);
 161 }
 162
 163 void RegScavenger::forward() {
 164   // Move ptr forward.
 165   if (!Tracking) {
 166     MBBI = MBB->begin();
 167     Tracking = true;
 168   } else {
 169     assert(MBBI != MBB->end() && "Already at the end of the basic block!");
 170     MBBI = next(MBBI);
 171   }
 172
 173   MachineInstr *MI = MBBI;
 174
 175   if (MI == ScavengeRestore) {
 176     ScavengedReg = 0;
 177     ScavengedRC = NULL;
 178     ScavengeRestore = NULL;
 179   }
 180
 181   // Find out which registers are early clobbered, killed, defined, and marked
 182   // def-dead in this instruction.
 183   BitVector EarlyClobberRegs(NumPhysRegs);
 184   BitVector KillRegs(NumPhysRegs);
 185   BitVector DefRegs(NumPhysRegs);
 186   BitVector DeadRegs(NumPhysRegs);
 187   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 188     const MachineOperand &MO = MI->getOperand(i);
 189     if (!MO.isReg() || MO.isUndef())
 190       continue;
 191     unsigned Reg = MO.getReg();
 192     if (!Reg || isReserved(Reg))
 193       continue;
 194
 195     if (MO.isUse()) {
 196       // Two-address operands implicitly kill.
 197       if (MO.isKill() || MI->isRegTiedToDefOperand(i))
 198         addRegWithSubRegs(KillRegs, Reg);
 199     } else {
 200       assert(MO.isDef());
 201       if (MO.isDead())
 202         addRegWithSubRegs(DeadRegs, Reg);
 203       else
 204         addRegWithSubRegs(DefRegs, Reg);
 205       if (MO.isEarlyClobber())
 206         addRegWithAliases(EarlyClobberRegs, Reg);
 207     }
 208   }
 209
 210   // Verify uses and defs.
 211   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 212     const MachineOperand &MO = MI->getOperand(i);
 213     if (!MO.isReg() || MO.isUndef())
 214       continue;
 215     unsigned Reg = MO.getReg();
 216     if (!Reg || isReserved(Reg))
 217       continue;
 218     if (MO.isUse()) {
 219       assert(isUsed(Reg) && "Using an undefined register!");
 220       assert((!EarlyClobberRegs.test(Reg) || MI->isRegTiedToDefOperand(i)) &&
 221              "Using an early clobbered register!");
 222     } else {
 223       assert(MO.isDef());
 224       assert((KillRegs.test(Reg) || isUnused(Reg) ||
 225               isLiveInButUnusedBefore(Reg, MI, MBB, TRI, MRI)) &&
 226              "Re-defining a live register!");
 227     }
 228   }
 229
 230   // Commit the changes.
 231   setUnused(KillRegs);
 232   setUnused(DeadRegs);
 233   setUsed(DefRegs);
 234 }
 235
 236 void RegScavenger::getRegsUsed(BitVector &used, bool includeReserved) {
 237   if (includeReserved)
 238     used = ~RegsAvailable;
 239   else
 240     used = ~RegsAvailable & ~ReservedRegs;
 241 }
 242
 243 /// CreateRegClassMask - Set the bits that represent the registers in the
 244 /// TargetRegisterClass.
 245 static void CreateRegClassMask(const TargetRegisterClass *RC, BitVector &Mask) {
 246   for (TargetRegisterClass::iterator I = RC->begin(), E = RC->end(); I != E;
 247        ++I)
 248     Mask.set(*I);
 249 }
 250
 251 unsigned RegScavenger::FindUnusedReg(const TargetRegisterClass *RegClass,
 252                                      const BitVector &Candidates) const {
 253   // Mask off the registers which are not in the TargetRegisterClass.
 254   BitVector RegsAvailableCopy(NumPhysRegs, false);
 255   CreateRegClassMask(RegClass, RegsAvailableCopy);
 256   RegsAvailableCopy &= RegsAvailable;
 257
 258   // Restrict the search to candidates.
 259   RegsAvailableCopy &= Candidates;
 260
 261   // Returns the first unused (bit is set) register, or 0 is none is found.
 262   int Reg = RegsAvailableCopy.find_first();
 263   return (Reg == -1) ? 0 : Reg;
 264 }
 265
 266 unsigned RegScavenger::FindUnusedReg(const TargetRegisterClass *RegClass,
 267                                      bool ExCalleeSaved) const {
 268   // Mask off the registers which are not in the TargetRegisterClass.
 269   BitVector RegsAvailableCopy(NumPhysRegs, false);
 270   CreateRegClassMask(RegClass, RegsAvailableCopy);
 271   RegsAvailableCopy &= RegsAvailable;
 272
 273   // If looking for a non-callee-saved register, mask off all the callee-saved
 274   // registers.
 275   if (ExCalleeSaved)
 276     RegsAvailableCopy &= ~CalleeSavedRegs;
 277
 278   // Returns the first unused (bit is set) register, or 0 is none is found.
 279   int Reg = RegsAvailableCopy.find_first();
 280   return (Reg == -1) ? 0 : Reg;
 281 }
 282
 283 /// DistanceMap - Keep track the distance of an MI from the current position.
 284 typedef DenseMap<MachineInstr*, unsigned> DistanceMap;
 285
 286 /// Build a distance map for instructions from I to E.
 287 static void buildDistanceMap(DistanceMap &DM,
 288                              MachineBasicBlock::iterator I,
 289                              MachineBasicBlock::iterator E) {
 290   DM.clear();
 291   for (unsigned d = 0; I != E; ++I, ++d)
 292     DM.insert(DistanceMap::value_type(I, d));
 293 }
 294
 295 /// findFirstUse - Calculate the distance to the first use of the
 296 /// specified register in the range covered by DM.
 297 static MachineInstr *findFirstUse(const MachineBasicBlock *MBB,
 298                                   const DistanceMap &DM,
 299                                   unsigned Reg,
 300                                   unsigned &Dist) {
 301   const MachineRegisterInfo *MRI = &MBB->getParent()->getRegInfo();
 302   MachineInstr *UseMI = 0;
 303   Dist = ~0U;
 304   for (MachineRegisterInfo::reg_iterator RI = MRI->reg_begin(Reg),
 305          RE = MRI->reg_end(); RI != RE; ++RI) {
 306     MachineInstr *UDMI = &*RI;
 307     if (UDMI->getParent() != MBB)
 308       continue;
 309     DistanceMap::const_iterator DI = DM.find(UDMI);
 310     if (DI == DM.end())
 311       continue;
 312     if (DI->second < Dist) {
 313       Dist = DI->second;
 314       UseMI = UDMI;
 315     }
 316   }
 317   return UseMI;
 318 }
 319
 320 unsigned RegScavenger::scavengeRegister(const TargetRegisterClass *RC,
 321                                         MachineBasicBlock::iterator I,
 322                                         int SPAdj) {
 323   assert(ScavengingFrameIndex >= 0 &&
 324          "Cannot scavenge a register without an emergency spill slot!");
 325
 326   // Mask off the registers which are not in the TargetRegisterClass.
 327   BitVector Candidates(NumPhysRegs, false);
 328   CreateRegClassMask(RC, Candidates);
 329   // Do not include reserved registers.
 330   Candidates ^= ReservedRegs & Candidates;
 331
 332   // Exclude all the registers being used by the instruction.
 333   for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
 334     MachineOperand &MO = I->getOperand(i);
 335     if (MO.isReg())
 336       Candidates.reset(MO.getReg());
 337   }
 338
 339   // Prepare to call findFirstUse() a number of times.
 340   DistanceMap DM;
 341   buildDistanceMap(DM, I, MBB->end());
 342
 343   // Find the register whose use is furthest away.
 344   unsigned SReg = 0;
 345   unsigned MaxDist = 0;
 346   MachineInstr *MaxUseMI = 0;
 347   int Reg = Candidates.find_first();
 348   while (Reg != -1) {
 349     unsigned Dist;
 350     MachineInstr *UseMI = findFirstUse(MBB, DM, Reg, Dist);
 351     for (const unsigned *AS = TRI->getAliasSet(Reg); *AS; ++AS) {
 352       unsigned AsDist;
 353       MachineInstr *AsUseMI = findFirstUse(MBB, DM, *AS, AsDist);
 354       if (AsDist < Dist) {
 355         Dist = AsDist;
 356         UseMI = AsUseMI;
 357       }
 358     }
 359
 360     // If we found an unused register there is no reason to spill it. We have
 361     // probably found a callee-saved register that has been saved in the
 362     // prologue, but happens to be unused at this point.
 363     if (!isAliasUsed(Reg))
 364       return Reg;
 365
 366     if (Dist >= MaxDist) {
 367       MaxDist = Dist;
 368       MaxUseMI = UseMI;
 369       SReg = Reg;
 370     }
 371     Reg = Candidates.find_next(Reg);
 372   }
 373
 374   assert(ScavengedReg == 0 &&
 375          "Scavenger slot is live, unable to scavenge another register!");
 376
 377   // Avoid infinite regress
 378   ScavengedReg = SReg;
 379
 380   // Spill the scavenged register before I.
 381   TII->storeRegToStackSlot(*MBB, I, SReg, true, ScavengingFrameIndex, RC);
 382   MachineBasicBlock::iterator II = prior(I);
 383   TRI->eliminateFrameIndex(II, SPAdj, this);
 384
 385   // Restore the scavenged register before its use (or first terminator).
 386   II = MaxUseMI
 387     ? MachineBasicBlock::iterator(MaxUseMI) : MBB->getFirstTerminator();
 388   TII->loadRegFromStackSlot(*MBB, II, SReg, ScavengingFrameIndex, RC);
 389   ScavengeRestore = prior(II);
 390   // Doing this here leads to infinite regress.
 391   // ScavengedReg = SReg;
 392   ScavengedRC = RC;
 393
 394   return SReg;
 395 }