contrib/llvm/lib/CodeGen/LivePhysRegs.cpp

   1 //===--- LivePhysRegs.cpp - Live Physical Register Set --------------------===//
   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 LivePhysRegs utility for tracking liveness of
  11 // physical registers across machine instructions in forward or backward order.
  12 // A more detailed description can be found in the corresponding header file.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "llvm/CodeGen/LivePhysRegs.h"
  17 #include "llvm/CodeGen/MachineFrameInfo.h"
  18 #include "llvm/CodeGen/MachineFunction.h"
  19 #include "llvm/CodeGen/MachineInstrBundle.h"
  20 #include "llvm/CodeGen/MachineRegisterInfo.h"
  21 #include "llvm/Support/Debug.h"
  22 #include "llvm/Support/raw_ostream.h"
  23 using namespace llvm;
  24
  25
  26 /// \brief Remove all registers from the set that get clobbered by the register
  27 /// mask.
  28 /// The clobbers set will be the list of live registers clobbered
  29 /// by the regmask.
  30 void LivePhysRegs::removeRegsInMask(const MachineOperand &MO,
  31         SmallVectorImpl<std::pair<unsigned, const MachineOperand*>> *Clobbers) {
  32   SparseSet<unsigned>::iterator LRI = LiveRegs.begin();
  33   while (LRI != LiveRegs.end()) {
  34     if (MO.clobbersPhysReg(*LRI)) {
  35       if (Clobbers)
  36         Clobbers->push_back(std::make_pair(*LRI, &MO));
  37       LRI = LiveRegs.erase(LRI);
  38     } else
  39       ++LRI;
  40   }
  41 }
  42
  43 /// Remove defined registers and regmask kills from the set.
  44 void LivePhysRegs::removeDefs(const MachineInstr &MI) {
  45   for (ConstMIBundleOperands O(MI); O.isValid(); ++O) {
  46     if (O->isReg()) {
  47       if (!O->isDef())
  48         continue;
  49       unsigned Reg = O->getReg();
  50       if (!TargetRegisterInfo::isPhysicalRegister(Reg))
  51         continue;
  52       removeReg(Reg);
  53     } else if (O->isRegMask())
  54       removeRegsInMask(*O);
  55   }
  56 }
  57
  58 /// Add uses to the set.
  59 void LivePhysRegs::addUses(const MachineInstr &MI) {
  60   for (ConstMIBundleOperands O(MI); O.isValid(); ++O) {
  61     if (!O->isReg() || !O->readsReg())
  62       continue;
  63     unsigned Reg = O->getReg();
  64     if (!TargetRegisterInfo::isPhysicalRegister(Reg))
  65       continue;
  66     addReg(Reg);
  67   }
  68 }
  69
  70 /// Simulates liveness when stepping backwards over an instruction(bundle):
  71 /// Remove Defs, add uses. This is the recommended way of calculating liveness.
  72 void LivePhysRegs::stepBackward(const MachineInstr &MI) {
  73   // Remove defined registers and regmask kills from the set.
  74   removeDefs(MI);
  75
  76   // Add uses to the set.
  77   addUses(MI);
  78 }
  79
  80 /// Simulates liveness when stepping forward over an instruction(bundle): Remove
  81 /// killed-uses, add defs. This is the not recommended way, because it depends
  82 /// on accurate kill flags. If possible use stepBackward() instead of this
  83 /// function.
  84 void LivePhysRegs::stepForward(const MachineInstr &MI,
  85         SmallVectorImpl<std::pair<unsigned, const MachineOperand*>> &Clobbers) {
  86   // Remove killed registers from the set.
  87   for (ConstMIBundleOperands O(MI); O.isValid(); ++O) {
  88     if (O->isReg()) {
  89       unsigned Reg = O->getReg();
  90       if (!TargetRegisterInfo::isPhysicalRegister(Reg))
  91         continue;
  92       if (O->isDef()) {
  93         // Note, dead defs are still recorded.  The caller should decide how to
  94         // handle them.
  95         Clobbers.push_back(std::make_pair(Reg, &*O));
  96       } else {
  97         if (!O->isKill())
  98           continue;
  99         assert(O->isUse());
 100         removeReg(Reg);
 101       }
 102     } else if (O->isRegMask())
 103       removeRegsInMask(*O, &Clobbers);
 104   }
 105
 106   // Add defs to the set.
 107   for (auto Reg : Clobbers) {
 108     // Skip dead defs.  They shouldn't be added to the set.
 109     if (Reg.second->isReg() && Reg.second->isDead())
 110       continue;
 111     addReg(Reg.first);
 112   }
 113 }
 114
 115 /// Prin the currently live registers to OS.
 116 void LivePhysRegs::print(raw_ostream &OS) const {
 117   OS << "Live Registers:";
 118   if (!TRI) {
 119     OS << " (uninitialized)\n";
 120     return;
 121   }
 122
 123   if (empty()) {
 124     OS << " (empty)\n";
 125     return;
 126   }
 127
 128   for (const_iterator I = begin(), E = end(); I != E; ++I)
 129     OS << " " << printReg(*I, TRI);
 130   OS << "\n";
 131 }
 132
 133 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
 134 LLVM_DUMP_METHOD void LivePhysRegs::dump() const {
 135   dbgs() << "  " << *this;
 136 }
 137 #endif
 138
 139 bool LivePhysRegs::available(const MachineRegisterInfo &MRI,
 140                              unsigned Reg) const {
 141   if (LiveRegs.count(Reg))
 142     return false;
 143   if (MRI.isReserved(Reg))
 144     return false;
 145   for (MCRegAliasIterator R(Reg, TRI, false); R.isValid(); ++R) {
 146     if (LiveRegs.count(*R))
 147       return false;
 148   }
 149   return true;
 150 }
 151
 152 /// Add live-in registers of basic block \p MBB to \p LiveRegs.
 153 void LivePhysRegs::addBlockLiveIns(const MachineBasicBlock &MBB) {
 154   for (const auto &LI : MBB.liveins()) {
 155     unsigned Reg = LI.PhysReg;
 156     LaneBitmask Mask = LI.LaneMask;
 157     MCSubRegIndexIterator S(Reg, TRI);
 158     assert(Mask.any() && "Invalid livein mask");
 159     if (Mask.all() || !S.isValid()) {
 160       addReg(Reg);
 161       continue;
 162     }
 163     for (; S.isValid(); ++S) {
 164       unsigned SI = S.getSubRegIndex();
 165       if ((Mask & TRI->getSubRegIndexLaneMask(SI)).any())
 166         addReg(S.getSubReg());
 167     }
 168   }
 169 }
 170
 171 /// Adds all callee saved registers to \p LiveRegs.
 172 static void addCalleeSavedRegs(LivePhysRegs &LiveRegs,
 173                                const MachineFunction &MF) {
 174   const MachineRegisterInfo &MRI = MF.getRegInfo();
 175   for (const MCPhysReg *CSR = MRI.getCalleeSavedRegs(); CSR && *CSR; ++CSR)
 176     LiveRegs.addReg(*CSR);
 177 }
 178
 179 void LivePhysRegs::addPristines(const MachineFunction &MF) {
 180   const MachineFrameInfo &MFI = MF.getFrameInfo();
 181   if (!MFI.isCalleeSavedInfoValid())
 182     return;
 183   /// This function will usually be called on an empty object, handle this
 184   /// as a special case.
 185   if (empty()) {
 186     /// Add all callee saved regs, then remove the ones that are saved and
 187     /// restored.
 188     addCalleeSavedRegs(*this, MF);
 189     /// Remove the ones that are not saved/restored; they are pristine.
 190     for (const CalleeSavedInfo &Info : MFI.getCalleeSavedInfo())
 191       removeReg(Info.getReg());
 192     return;
 193   }
 194   /// If a callee-saved register that is not pristine is already present
 195   /// in the set, we should make sure that it stays in it. Precompute the
 196   /// set of pristine registers in a separate object.
 197   /// Add all callee saved regs, then remove the ones that are saved+restored.
 198   LivePhysRegs Pristine(*TRI);
 199   addCalleeSavedRegs(Pristine, MF);
 200   /// Remove the ones that are not saved/restored; they are pristine.
 201   for (const CalleeSavedInfo &Info : MFI.getCalleeSavedInfo())
 202     Pristine.removeReg(Info.getReg());
 203   for (MCPhysReg R : Pristine)
 204     addReg(R);
 205 }
 206
 207 void LivePhysRegs::addLiveOutsNoPristines(const MachineBasicBlock &MBB) {
 208   // To get the live-outs we simply merge the live-ins of all successors.
 209   for (const MachineBasicBlock *Succ : MBB.successors())
 210     addBlockLiveIns(*Succ);
 211   if (MBB.isReturnBlock()) {
 212     // Return blocks are a special case because we currently don't mark up
 213     // return instructions completely: specifically, there is no explicit
 214     // use for callee-saved registers. So we add all callee saved registers
 215     // that are saved and restored (somewhere). This does not include
 216     // callee saved registers that are unused and hence not saved and
 217     // restored; they are called pristine.
 218     // FIXME: PEI should add explicit markings to return instructions
 219     // instead of implicitly handling them here.
 220     const MachineFunction &MF = *MBB.getParent();
 221     const MachineFrameInfo &MFI = MF.getFrameInfo();
 222     if (MFI.isCalleeSavedInfoValid()) {
 223       for (const CalleeSavedInfo &Info : MFI.getCalleeSavedInfo())
 224         if (Info.isRestored())
 225           addReg(Info.getReg());
 226     }
 227   }
 228 }
 229
 230 void LivePhysRegs::addLiveOuts(const MachineBasicBlock &MBB) {
 231   const MachineFunction &MF = *MBB.getParent();
 232   addPristines(MF);
 233   addLiveOutsNoPristines(MBB);
 234 }
 235
 236 void LivePhysRegs::addLiveIns(const MachineBasicBlock &MBB) {
 237   const MachineFunction &MF = *MBB.getParent();
 238   addPristines(MF);
 239   addBlockLiveIns(MBB);
 240 }
 241
 242 void llvm::computeLiveIns(LivePhysRegs &LiveRegs,
 243                           const MachineBasicBlock &MBB) {
 244   const MachineFunction &MF = *MBB.getParent();
 245   const MachineRegisterInfo &MRI = MF.getRegInfo();
 246   const TargetRegisterInfo &TRI = *MRI.getTargetRegisterInfo();
 247   LiveRegs.init(TRI);
 248   LiveRegs.addLiveOutsNoPristines(MBB);
 249   for (const MachineInstr &MI : make_range(MBB.rbegin(), MBB.rend()))
 250     LiveRegs.stepBackward(MI);
 251 }
 252
 253 void llvm::addLiveIns(MachineBasicBlock &MBB, const LivePhysRegs &LiveRegs) {
 254   assert(MBB.livein_empty() && "Expected empty live-in list");
 255   const MachineFunction &MF = *MBB.getParent();
 256   const MachineRegisterInfo &MRI = MF.getRegInfo();
 257   const TargetRegisterInfo &TRI = *MRI.getTargetRegisterInfo();
 258   for (MCPhysReg Reg : LiveRegs) {
 259     if (MRI.isReserved(Reg))
 260       continue;
 261     // Skip the register if we are about to add one of its super registers.
 262     bool ContainsSuperReg = false;
 263     for (MCSuperRegIterator SReg(Reg, &TRI); SReg.isValid(); ++SReg) {
 264       if (LiveRegs.contains(*SReg) && !MRI.isReserved(*SReg)) {
 265         ContainsSuperReg = true;
 266         break;
 267       }
 268     }
 269     if (ContainsSuperReg)
 270       continue;
 271     MBB.addLiveIn(Reg);
 272   }
 273 }
 274
 275 void llvm::recomputeLivenessFlags(MachineBasicBlock &MBB) {
 276   const MachineFunction &MF = *MBB.getParent();
 277   const MachineRegisterInfo &MRI = MF.getRegInfo();
 278   const TargetRegisterInfo &TRI = *MRI.getTargetRegisterInfo();
 279
 280   // We walk through the block backwards and start with the live outs.
 281   LivePhysRegs LiveRegs;
 282   LiveRegs.init(TRI);
 283   LiveRegs.addLiveOutsNoPristines(MBB);
 284
 285   for (MachineInstr &MI : make_range(MBB.rbegin(), MBB.rend())) {
 286     // Recompute dead flags.
 287     for (MIBundleOperands MO(MI); MO.isValid(); ++MO) {
 288       if (!MO->isReg() || !MO->isDef() || MO->isDebug())
 289         continue;
 290
 291       unsigned Reg = MO->getReg();
 292       if (Reg == 0)
 293         continue;
 294       assert(TargetRegisterInfo::isPhysicalRegister(Reg));
 295
 296       bool IsNotLive = LiveRegs.available(MRI, Reg);
 297       MO->setIsDead(IsNotLive);
 298     }
 299
 300     // Step backward over defs.
 301     LiveRegs.removeDefs(MI);
 302
 303     // Recompute kill flags.
 304     for (MIBundleOperands MO(MI); MO.isValid(); ++MO) {
 305       if (!MO->isReg() || !MO->readsReg() || MO->isDebug())
 306         continue;
 307
 308       unsigned Reg = MO->getReg();
 309       if (Reg == 0)
 310         continue;
 311       assert(TargetRegisterInfo::isPhysicalRegister(Reg));
 312
 313       bool IsNotLive = LiveRegs.available(MRI, Reg);
 314       MO->setIsKill(IsNotLive);
 315     }
 316
 317     // Complete the stepbackward.
 318     LiveRegs.addUses(MI);
 319   }
 320 }
 321
 322 void llvm::computeAndAddLiveIns(LivePhysRegs &LiveRegs,
 323                                 MachineBasicBlock &MBB) {
 324   computeLiveIns(LiveRegs, MBB);
 325   addLiveIns(MBB, LiveRegs);
 326 }