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