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/SmallPtrSet.h"
  29 #include "llvm/ADT/SmallVector.h"
  30 #include "llvm/ADT/STLExtras.h"
  31 using namespace llvm;
  32
  33 /// RedefinesSuperRegPart - Return true if the specified register is redefining
  34 /// part of a super-register.
  35 static bool RedefinesSuperRegPart(const MachineInstr *MI, unsigned SubReg,
  36                                   const TargetRegisterInfo *TRI) {
  37   bool SeenSuperUse = false;
  38   bool SeenSuperDef = false;
  39   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
  40     const MachineOperand &MO = MI->getOperand(i);
  41     if (!MO.isReg() || MO.isUndef())
  42       continue;
  43     if (TRI->isSuperRegister(SubReg, MO.getReg())) {
  44       if (MO.isUse())
  45         SeenSuperUse = true;
  46       else if (MO.isImplicit())
  47         SeenSuperDef = true;
  48     }
  49   }
  50
  51   return SeenSuperDef && SeenSuperUse;
  52 }
  53
  54 static bool RedefinesSuperRegPart(const MachineInstr *MI,
  55                                   const MachineOperand &MO,
  56                                   const TargetRegisterInfo *TRI) {
  57   assert(MO.isReg() && MO.isDef() && "Not a register def!");
  58   return RedefinesSuperRegPart(MI, MO.getReg(), TRI);
  59 }
  60
  61 bool RegScavenger::isSuperRegUsed(unsigned Reg) const {
  62   for (const unsigned *SuperRegs = TRI->getSuperRegisters(Reg);
  63        unsigned SuperReg = *SuperRegs; ++SuperRegs)
  64     if (isUsed(SuperReg))
  65       return true;
  66   return false;
  67 }
  68
  69 /// setUsed - Set the register and its sub-registers as being used.
  70 void RegScavenger::setUsed(unsigned Reg) {
  71   RegsAvailable.reset(Reg);
  72
  73   for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
  74        unsigned SubReg = *SubRegs; ++SubRegs)
  75     RegsAvailable.reset(SubReg);
  76 }
  77
  78 /// setUnused - Set the register and its sub-registers as being unused.
  79 void RegScavenger::setUnused(unsigned Reg, const MachineInstr *MI) {
  80   RegsAvailable.set(Reg);
  81
  82   for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
  83        unsigned SubReg = *SubRegs; ++SubRegs)
  84     if (!RedefinesSuperRegPart(MI, Reg, TRI))
  85       RegsAvailable.set(SubReg);
  86 }
  87
  88 void RegScavenger::initRegState() {
  89   ScavengedReg = 0;
  90   ScavengedRC = NULL;
  91   ScavengeRestore = NULL;
  92   CurrDist = 0;
  93   DistanceMap.clear();
  94
  95   // All registers started out unused.
  96   RegsAvailable.set();
  97
  98   // Reserved registers are always used.
  99   RegsAvailable ^= ReservedRegs;
 100
 101   // Live-in registers are in use.
 102   if (!MBB || MBB->livein_empty())
 103     return;
 104   for (MachineBasicBlock::const_livein_iterator I = MBB->livein_begin(),
 105          E = MBB->livein_end(); I != E; ++I)
 106     setUsed(*I);
 107 }
 108
 109 void RegScavenger::enterBasicBlock(MachineBasicBlock *mbb) {
 110   MachineFunction &MF = *mbb->getParent();
 111   const TargetMachine &TM = MF.getTarget();
 112   TII = TM.getInstrInfo();
 113   TRI = TM.getRegisterInfo();
 114   MRI = &MF.getRegInfo();
 115
 116   assert((NumPhysRegs == 0 || NumPhysRegs == TRI->getNumRegs()) &&
 117          "Target changed?");
 118
 119   // Self-initialize.
 120   if (!MBB) {
 121     NumPhysRegs = TRI->getNumRegs();
 122     RegsAvailable.resize(NumPhysRegs);
 123
 124     // Create reserved registers bitvector.
 125     ReservedRegs = TRI->getReservedRegs(MF);
 126
 127     // Create callee-saved registers bitvector.
 128     CalleeSavedRegs.resize(NumPhysRegs);
 129     const unsigned *CSRegs = TRI->getCalleeSavedRegs();
 130     if (CSRegs != NULL)
 131       for (unsigned i = 0; CSRegs[i]; ++i)
 132         CalleeSavedRegs.set(CSRegs[i]);
 133   }
 134
 135   // RS used within emit{Pro,Epi}logue()
 136   if (mbb != MBB) {
 137     MBB = mbb;
 138     initRegState();
 139   }
 140
 141   Tracking = false;
 142 }
 143
 144 void RegScavenger::restoreScavengedReg() {
 145   TII->loadRegFromStackSlot(*MBB, MBBI, ScavengedReg,
 146                             ScavengingFrameIndex, ScavengedRC);
 147   MachineBasicBlock::iterator II = prior(MBBI);
 148   TRI->eliminateFrameIndex(II, 0, this);
 149   setUsed(ScavengedReg);
 150   ScavengedReg = 0;
 151   ScavengedRC = NULL;
 152 }
 153
 154 #ifndef NDEBUG
 155 /// isLiveInButUnusedBefore - Return true if register is livein the MBB not
 156 /// not used before it reaches the MI that defines register.
 157 static bool isLiveInButUnusedBefore(unsigned Reg, MachineInstr *MI,
 158                                     MachineBasicBlock *MBB,
 159                                     const TargetRegisterInfo *TRI,
 160                                     MachineRegisterInfo* MRI) {
 161   // First check if register is livein.
 162   bool isLiveIn = false;
 163   for (MachineBasicBlock::const_livein_iterator I = MBB->livein_begin(),
 164          E = MBB->livein_end(); I != E; ++I)
 165     if (Reg == *I || TRI->isSuperRegister(Reg, *I)) {
 166       isLiveIn = true;
 167       break;
 168     }
 169   if (!isLiveIn)
 170     return false;
 171
 172   // Is there any use of it before the specified MI?
 173   SmallPtrSet<MachineInstr*, 4> UsesInMBB;
 174   for (MachineRegisterInfo::use_iterator UI = MRI->use_begin(Reg),
 175          UE = MRI->use_end(); UI != UE; ++UI) {
 176     MachineOperand &UseMO = UI.getOperand();
 177     if (UseMO.isReg() && UseMO.isUndef())
 178       continue;
 179     MachineInstr *UseMI = &*UI;
 180     if (UseMI->getParent() == MBB)
 181       UsesInMBB.insert(UseMI);
 182   }
 183   if (UsesInMBB.empty())
 184     return true;
 185
 186   for (MachineBasicBlock::iterator I = MBB->begin(), E = MI; I != E; ++I)
 187     if (UsesInMBB.count(&*I))
 188       return false;
 189   return true;
 190 }
 191 #endif
 192
 193 void RegScavenger::forward() {
 194   // Move ptr forward.
 195   if (!Tracking) {
 196     MBBI = MBB->begin();
 197     Tracking = true;
 198   } else {
 199     assert(MBBI != MBB->end() && "Already at the end of the basic block!");
 200     MBBI = next(MBBI);
 201   }
 202
 203   MachineInstr *MI = MBBI;
 204   DistanceMap.insert(std::make_pair(MI, CurrDist++));
 205
 206   if (MI == ScavengeRestore) {
 207     ScavengedReg = 0;
 208     ScavengedRC = NULL;
 209     ScavengeRestore = NULL;
 210   }
 211
 212   // Separate register operands into 3 classes: uses, defs, earlyclobbers.
 213   SmallVector<std::pair<const MachineOperand*,unsigned>, 4> UseMOs;
 214   SmallVector<std::pair<const MachineOperand*,unsigned>, 4> DefMOs;
 215   SmallVector<std::pair<const MachineOperand*,unsigned>, 4> EarlyClobberMOs;
 216   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 217     const MachineOperand &MO = MI->getOperand(i);
 218     if (!MO.isReg() || MO.getReg() == 0 || MO.isUndef())
 219       continue;
 220     if (MO.isUse())
 221       UseMOs.push_back(std::make_pair(&MO,i));
 222     else if (MO.isEarlyClobber())
 223       EarlyClobberMOs.push_back(std::make_pair(&MO,i));
 224     else {
 225       assert(MO.isDef());
 226       DefMOs.push_back(std::make_pair(&MO,i));
 227     }
 228   }
 229
 230   // Process uses first.
 231   BitVector KillRegs(NumPhysRegs);
 232   for (unsigned i = 0, e = UseMOs.size(); i != e; ++i) {
 233     const MachineOperand MO = *UseMOs[i].first;
 234     unsigned Idx = UseMOs[i].second;
 235     unsigned Reg = MO.getReg();
 236
 237     assert(isUsed(Reg) && "Using an undefined register!");
 238
 239     // Two-address operands implicitly kill.
 240     if ((MO.isKill() || MI->isRegTiedToDefOperand(Idx)) && !isReserved(Reg)) {
 241       KillRegs.set(Reg);
 242
 243       // Mark sub-registers as used.
 244       for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
 245            unsigned SubReg = *SubRegs; ++SubRegs)
 246         KillRegs.set(SubReg);
 247     }
 248   }
 249
 250   // Change states of all registers after all the uses are processed to guard
 251   // against multiple uses.
 252   setUnused(KillRegs);
 253
 254   // Process early clobber defs then process defs. We can have a early clobber
 255   // that is dead, it should not conflict with a def that happens one "slot"
 256   // (see InstrSlots in LiveIntervalAnalysis.h) later.
 257   unsigned NumECs = EarlyClobberMOs.size();
 258   unsigned NumDefs = DefMOs.size();
 259
 260   for (unsigned i = 0, e = NumECs + NumDefs; i != e; ++i) {
 261     const MachineOperand &MO = (i < NumECs)
 262       ? *EarlyClobberMOs[i].first : *DefMOs[i-NumECs].first;
 263     unsigned Reg = MO.getReg();
 264     if (MO.isUndef())
 265       continue;
 266
 267     // If it's dead upon def, then it is now free.
 268     if (MO.isDead()) {
 269       setUnused(Reg, MI);
 270       continue;
 271     }
 272
 273     // Skip if this is merely redefining part of a super-register.
 274     if (RedefinesSuperRegPart(MI, MO, TRI))
 275       continue;
 276
 277     assert((isReserved(Reg) || isUnused(Reg) || isSuperRegUsed(Reg) ||
 278             isLiveInButUnusedBefore(Reg, MI, MBB, TRI, MRI)) &&
 279            "Re-defining a live register!");
 280     setUsed(Reg);
 281   }
 282 }
 283
 284 void RegScavenger::getRegsUsed(BitVector &used, bool includeReserved) {
 285   if (includeReserved)
 286     used = ~RegsAvailable;
 287   else
 288     used = ~RegsAvailable & ~ReservedRegs;
 289 }
 290
 291 /// CreateRegClassMask - Set the bits that represent the registers in the
 292 /// TargetRegisterClass.
 293 static void CreateRegClassMask(const TargetRegisterClass *RC, BitVector &Mask) {
 294   for (TargetRegisterClass::iterator I = RC->begin(), E = RC->end(); I != E;
 295        ++I)
 296     Mask.set(*I);
 297 }
 298
 299 unsigned RegScavenger::FindUnusedReg(const TargetRegisterClass *RegClass,
 300                                      const BitVector &Candidates) const {
 301   // Mask off the registers which are not in the TargetRegisterClass.
 302   BitVector RegsAvailableCopy(NumPhysRegs, false);
 303   CreateRegClassMask(RegClass, RegsAvailableCopy);
 304   RegsAvailableCopy &= RegsAvailable;
 305
 306   // Restrict the search to candidates.
 307   RegsAvailableCopy &= Candidates;
 308
 309   // Returns the first unused (bit is set) register, or 0 is none is found.
 310   int Reg = RegsAvailableCopy.find_first();
 311   return (Reg == -1) ? 0 : Reg;
 312 }
 313
 314 unsigned RegScavenger::FindUnusedReg(const TargetRegisterClass *RegClass,
 315                                      bool ExCalleeSaved) const {
 316   // Mask off the registers which are not in the TargetRegisterClass.
 317   BitVector RegsAvailableCopy(NumPhysRegs, false);
 318   CreateRegClassMask(RegClass, RegsAvailableCopy);
 319   RegsAvailableCopy &= RegsAvailable;
 320
 321   // If looking for a non-callee-saved register, mask off all the callee-saved
 322   // registers.
 323   if (ExCalleeSaved)
 324     RegsAvailableCopy &= ~CalleeSavedRegs;
 325
 326   // Returns the first unused (bit is set) register, or 0 is none is found.
 327   int Reg = RegsAvailableCopy.find_first();
 328   return (Reg == -1) ? 0 : Reg;
 329 }
 330
 331 /// findFirstUse - Calculate the distance to the first use of the
 332 /// specified register.
 333 MachineInstr*
 334 RegScavenger::findFirstUse(MachineBasicBlock *MBB,
 335                            MachineBasicBlock::iterator I, unsigned Reg,
 336                            unsigned &Dist) {
 337   MachineInstr *UseMI = 0;
 338   Dist = ~0U;
 339   for (MachineRegisterInfo::reg_iterator RI = MRI->reg_begin(Reg),
 340          RE = MRI->reg_end(); RI != RE; ++RI) {
 341     MachineInstr *UDMI = &*RI;
 342     if (UDMI->getParent() != MBB)
 343       continue;
 344     DenseMap<MachineInstr*, unsigned>::iterator DI = DistanceMap.find(UDMI);
 345     if (DI == DistanceMap.end()) {
 346       // If it's not in map, it's below current MI, let's initialize the
 347       // map.
 348       I = next(I);
 349       unsigned Dist = CurrDist + 1;
 350       while (I != MBB->end()) {
 351         DistanceMap.insert(std::make_pair(I, Dist++));
 352         I = next(I);
 353       }
 354     }
 355     DI = DistanceMap.find(UDMI);
 356     if (DI->second > CurrDist && DI->second < Dist) {
 357       Dist = DI->second;
 358       UseMI = UDMI;
 359     }
 360   }
 361   return UseMI;
 362 }
 363
 364 unsigned RegScavenger::scavengeRegister(const TargetRegisterClass *RC,
 365                                         MachineBasicBlock::iterator I,
 366                                         int SPAdj) {
 367   assert(ScavengingFrameIndex >= 0 &&
 368          "Cannot scavenge a register without an emergency spill slot!");
 369
 370   // Mask off the registers which are not in the TargetRegisterClass.
 371   BitVector Candidates(NumPhysRegs, false);
 372   CreateRegClassMask(RC, Candidates);
 373   // Do not include reserved registers.
 374   Candidates ^= ReservedRegs & Candidates;
 375
 376   // Exclude all the registers being used by the instruction.
 377   for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
 378     MachineOperand &MO = I->getOperand(i);
 379     if (MO.isReg())
 380       Candidates.reset(MO.getReg());
 381   }
 382
 383   // Find the register whose use is furthest away.
 384   unsigned SReg = 0;
 385   unsigned MaxDist = 0;
 386   MachineInstr *MaxUseMI = 0;
 387   int Reg = Candidates.find_first();
 388   while (Reg != -1) {
 389     unsigned Dist;
 390     MachineInstr *UseMI = findFirstUse(MBB, I, Reg, Dist);
 391     for (const unsigned *AS = TRI->getAliasSet(Reg); *AS; ++AS) {
 392       unsigned AsDist;
 393       MachineInstr *AsUseMI = findFirstUse(MBB, I, *AS, AsDist);
 394       if (AsDist < Dist) {
 395         Dist = AsDist;
 396         UseMI = AsUseMI;
 397       }
 398     }
 399     if (Dist >= MaxDist) {
 400       MaxDist = Dist;
 401       MaxUseMI = UseMI;
 402       SReg = Reg;
 403     }
 404     Reg = Candidates.find_next(Reg);
 405   }
 406
 407   assert(ScavengedReg == 0 &&
 408          "Scavenger slot is live, unable to scavenge another register!");
 409
 410   // Avoid infinite regress
 411   ScavengedReg = SReg;
 412
 413   // Make sure SReg is marked as used. It could be considered available
 414   // if it is one of the callee saved registers, but hasn't been spilled.
 415   if (!isUsed(SReg)) {
 416     MBB->addLiveIn(SReg);
 417     setUsed(SReg);
 418   }
 419
 420   // Spill the scavenged register before I.
 421   TII->storeRegToStackSlot(*MBB, I, SReg, true, ScavengingFrameIndex, RC);
 422   MachineBasicBlock::iterator II = prior(I);
 423   TRI->eliminateFrameIndex(II, SPAdj, this);
 424
 425   // Restore the scavenged register before its use (or first terminator).
 426   II = MaxUseMI
 427     ? MachineBasicBlock::iterator(MaxUseMI) : MBB->getFirstTerminator();
 428   TII->loadRegFromStackSlot(*MBB, II, SReg, ScavengingFrameIndex, RC);
 429   ScavengeRestore = prior(II);
 430   // Doing this here leads to infinite regress.
 431   // ScavengedReg = SReg;
 432   ScavengedRC = RC;
 433
 434   return SReg;
 435 }