include/llvm/CodeGen/RegisterScavenging.h

   1 //===-- RegisterScavenging.h - Machine register scavenging ------*- C++ -*-===//
   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 declares the machine register scavenger class. It can provide
  11 // information such as unused register at any point in a machine basic block.
  12 // It also provides a mechanism to make registers availbale by evicting them
  13 // to spill slots.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef LLVM_CODEGEN_REGISTER_SCAVENGING_H
  18 #define LLVM_CODEGEN_REGISTER_SCAVENGING_H
  19
  20 #include "llvm/CodeGen/MachineBasicBlock.h"
  21 #include "llvm/ADT/BitVector.h"
  22 #include "llvm/ADT/DenseMap.h"
  23
  24 namespace llvm {
  25
  26 class MachineRegisterInfo;
  27 class TargetRegisterInfo;
  28 class TargetInstrInfo;
  29 class TargetRegisterClass;
  30
  31 class RegScavenger {
  32   const TargetRegisterInfo *TRI;
  33   const TargetInstrInfo *TII;
  34   MachineRegisterInfo* MRI;
  35   MachineBasicBlock *MBB;
  36   MachineBasicBlock::iterator MBBI;
  37   unsigned NumPhysRegs;
  38
  39   /// Tracking - True if RegScavenger is currently tracking the liveness of
  40   /// registers.
  41   bool Tracking;
  42
  43   /// ScavengingFrameIndex - Special spill slot used for scavenging a register
  44   /// post register allocation.
  45   int ScavengingFrameIndex;
  46
  47   /// ScavengedReg - If none zero, the specific register is currently being
  48   /// scavenged. That is, it is spilled to the special scavenging stack slot.
  49   unsigned ScavengedReg;
  50
  51   /// ScavengedRC - Register class of the scavenged register.
  52   ///
  53   const TargetRegisterClass *ScavengedRC;
  54
  55   /// ScavengeRestore - Instruction that restores the scavenged register from
  56   /// stack.
  57   const MachineInstr *ScavengeRestore;
  58
  59   /// CalleeSavedrRegs - A bitvector of callee saved registers for the target.
  60   ///
  61   BitVector CalleeSavedRegs;
  62
  63   /// ReservedRegs - A bitvector of reserved registers.
  64   ///
  65   BitVector ReservedRegs;
  66
  67   /// RegsAvailable - The current state of all the physical registers immediately
  68   /// before MBBI. One bit per physical register. If bit is set that means it's
  69   /// available, unset means the register is currently being used.
  70   BitVector RegsAvailable;
  71
  72   /// CurrDist - Distance from MBB entry to the current instruction MBBI.
  73   ///
  74   unsigned CurrDist;
  75
  76   /// DistanceMap - Keep track the distance of a MI from the start of the
  77   /// current basic block.
  78   DenseMap<MachineInstr*, unsigned> DistanceMap;
  79
  80 public:
  81   RegScavenger()
  82     : MBB(NULL), NumPhysRegs(0), Tracking(false),
  83       ScavengingFrameIndex(-1), ScavengedReg(0), ScavengedRC(NULL) {}
  84
  85   /// enterBasicBlock - Start tracking liveness from the begin of the specific
  86   /// basic block.
  87   void enterBasicBlock(MachineBasicBlock *mbb);
  88
  89   /// initRegState - allow resetting register state info for multiple
  90   /// passes over/within the same function.
  91   void initRegState();
  92
  93   /// forward - Move the internal MBB iterator and update register states.
  94   void forward();
  95
  96   /// forward - Move the internal MBB iterator and update register states until
  97   /// it has processed the specific iterator.
  98   void forward(MachineBasicBlock::iterator I) {
  99     if (!Tracking && MBB->begin() != I) forward();
 100     while (MBBI != I) forward();
 101   }
 102
 103   /// skipTo - Move the internal MBB iterator but do not update register states.
 104   ///
 105   void skipTo(MachineBasicBlock::iterator I) { MBBI = I; }
 106
 107   /// isReserved - Returns true if a register is reserved. It is never "unused".
 108   bool isReserved(unsigned Reg) const { return ReservedRegs[Reg]; }
 109
 110   /// isUsed / isUsed - Test if a register is currently being used.
 111   ///
 112   bool isUsed(unsigned Reg) const   { return !RegsAvailable[Reg]; }
 113   bool isUnused(unsigned Reg) const { return RegsAvailable[Reg]; }
 114
 115   /// getRegsUsed - return all registers currently in use in used.
 116   void getRegsUsed(BitVector &used, bool includeReserved);
 117
 118   /// setUsed / setUnused - Mark the state of one or a number of registers.
 119   ///
 120   void setUsed(unsigned Reg);
 121   void setUsed(BitVector &Regs) {
 122     RegsAvailable &= ~Regs;
 123   }
 124   void setUnused(unsigned Reg, const MachineInstr *MI);
 125   void setUnused(BitVector &Regs) {
 126     RegsAvailable |= Regs;
 127   }
 128
 129   /// FindUnusedReg - Find a unused register of the specified register class
 130   /// from the specified set of registers. It return 0 is none is found.
 131   unsigned FindUnusedReg(const TargetRegisterClass *RegClass,
 132                          const BitVector &Candidates) const;
 133
 134   /// FindUnusedReg - Find a unused register of the specified register class.
 135   /// Exclude callee saved registers if directed. It return 0 is none is found.
 136   unsigned FindUnusedReg(const TargetRegisterClass *RegClass,
 137                          bool ExCalleeSaved = false) const;
 138
 139   /// setScavengingFrameIndex / getScavengingFrameIndex - accessor and setter of
 140   /// ScavengingFrameIndex.
 141   void setScavengingFrameIndex(int FI) { ScavengingFrameIndex = FI; }
 142   int getScavengingFrameIndex() const { return ScavengingFrameIndex; }
 143
 144   /// scavengeRegister - Make a register of the specific register class
 145   /// available and do the appropriate bookkeeping. SPAdj is the stack
 146   /// adjustment due to call frame, it's passed along to eliminateFrameIndex().
 147   /// Returns the scavenged register.
 148   unsigned scavengeRegister(const TargetRegisterClass *RegClass,
 149                             MachineBasicBlock::iterator I, int SPAdj);
 150   unsigned scavengeRegister(const TargetRegisterClass *RegClass, int SPAdj) {
 151     return scavengeRegister(RegClass, MBBI, SPAdj);
 152   }
 153
 154 private:
 155   /// restoreScavengedReg - Restore scavenged by loading it back from the
 156   /// emergency spill slot. Mark it used.
 157   void restoreScavengedReg();
 158
 159   MachineInstr *findFirstUse(MachineBasicBlock *MBB,
 160                              MachineBasicBlock::iterator I, unsigned Reg,
 161                              unsigned &Dist);
 162
 163   /// Add Reg and all its sub-registers to BV.
 164   void addRegWithSubRegs(BitVector &BV, unsigned Reg);
 165
 166   /// Add Reg and its aliases to BV.
 167   void addRegWithAliases(BitVector &BV, unsigned Reg);
 168 };
 169
 170 } // End llvm namespace
 171
 172 #endif