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