include/llvm/CodeGen/MachineRegisterInfo.h

   1 //===-- llvm/CodeGen/MachineRegisterInfo.h ----------------------*- 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 defines the MachineRegisterInfo class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_CODEGEN_MACHINEREGISTERINFO_H
  15 #define LLVM_CODEGEN_MACHINEREGISTERINFO_H
  16
  17 #include "llvm/Target/TargetRegisterInfo.h"
  18 #include "llvm/ADT/BitVector.h"
  19 #include <vector>
  20
  21 namespace llvm {
  22
  23 /// MachineRegisterInfo - Keep track of information for virtual and physical
  24 /// registers, including vreg register classes, use/def chains for registers,
  25 /// etc.
  26 class MachineRegisterInfo {
  27   /// VRegInfo - Information we keep for each virtual register.  The entries in
  28   /// this vector are actually converted to vreg numbers by adding the
  29   /// TargetRegisterInfo::FirstVirtualRegister delta to their index.
  30   ///
  31   /// Each element in this list contains the register class of the vreg and the
  32   /// start of the use/def list for the register.
  33   std::vector<std::pair<const TargetRegisterClass*, MachineOperand*> > VRegInfo;
  34
  35   /// RegClassVRegMap - This vector acts as a map from TargetRegisterClass to
  36   /// virtual registers. For each target register class, it keeps a list of
  37   /// virtual registers belonging to the class.
  38   std::vector<std::vector<unsigned> > RegClass2VRegMap;
  39
  40   /// RegAllocHints - This vector records register allocation hints for virtual
  41   /// registers. For each virtual register, it keeps a register and hint type
  42   /// pair making up the allocation hint. Hint type is target specific except
  43   /// for the value 0 which means the second value of the pair is the preferred
  44   /// register for allocation. For example, if the hint is <0, 1024>, it means
  45   /// the allocator should prefer the physical register allocated to the virtual
  46   /// register of the hint.
  47   std::vector<std::pair<unsigned, unsigned> > RegAllocHints;
  48
  49   /// PhysRegUseDefLists - This is an array of the head of the use/def list for
  50   /// physical registers.
  51   MachineOperand **PhysRegUseDefLists;
  52
  53   /// UsedPhysRegs - This is a bit vector that is computed and set by the
  54   /// register allocator, and must be kept up to date by passes that run after
  55   /// register allocation (though most don't modify this).  This is used
  56   /// so that the code generator knows which callee save registers to save and
  57   /// for other target specific uses.
  58   BitVector UsedPhysRegs;
  59
  60   /// LiveIns/LiveOuts - Keep track of the physical registers that are
  61   /// livein/liveout of the function.  Live in values are typically arguments in
  62   /// registers, live out values are typically return values in registers.
  63   /// LiveIn values are allowed to have virtual registers associated with them,
  64   /// stored in the second element.
  65   std::vector<std::pair<unsigned, unsigned> > LiveIns;
  66   std::vector<unsigned> LiveOuts;
  67
  68   MachineRegisterInfo(const MachineRegisterInfo&); // DO NOT IMPLEMENT
  69   void operator=(const MachineRegisterInfo&);      // DO NOT IMPLEMENT
  70 public:
  71   explicit MachineRegisterInfo(const TargetRegisterInfo &TRI);
  72   ~MachineRegisterInfo();
  73
  74   //===--------------------------------------------------------------------===//
  75   // Register Info
  76   //===--------------------------------------------------------------------===//
  77
  78   /// reg_begin/reg_end - Provide iteration support to walk over all definitions
  79   /// and uses of a register within the MachineFunction that corresponds to this
  80   /// MachineRegisterInfo object.
  81   template<bool Uses, bool Defs, bool SkipDebug>
  82   class defusechain_iterator;
  83
  84   /// reg_iterator/reg_begin/reg_end - Walk all defs and uses of the specified
  85   /// register.
  86   typedef defusechain_iterator<true,true,false> reg_iterator;
  87   reg_iterator reg_begin(unsigned RegNo) const {
  88     return reg_iterator(getRegUseDefListHead(RegNo));
  89   }
  90   static reg_iterator reg_end() { return reg_iterator(0); }
  91
  92   /// reg_empty - Return true if there are no instructions using or defining the
  93   /// specified register (it may be live-in).
  94   bool reg_empty(unsigned RegNo) const { return reg_begin(RegNo) == reg_end(); }
  95
  96   /// def_iterator/def_begin/def_end - Walk all defs of the specified register.
  97   typedef defusechain_iterator<false,true,false> def_iterator;
  98   def_iterator def_begin(unsigned RegNo) const {
  99     return def_iterator(getRegUseDefListHead(RegNo));
 100   }
 101   static def_iterator def_end() { return def_iterator(0); }
 102
 103   /// def_empty - Return true if there are no instructions defining the
 104   /// specified register (it may be live-in).
 105   bool def_empty(unsigned RegNo) const { return def_begin(RegNo) == def_end(); }
 106
 107   /// use_iterator/use_begin/use_end - Walk all uses of the specified register.
 108   typedef defusechain_iterator<true,false,false> use_iterator;
 109   use_iterator use_begin(unsigned RegNo) const {
 110     return use_iterator(getRegUseDefListHead(RegNo));
 111   }
 112   static use_iterator use_end() { return use_iterator(0); }
 113
 114   /// use_empty - Return true if there are no instructions using the specified
 115   /// register.
 116   bool use_empty(unsigned RegNo) const { return use_begin(RegNo) == use_end(); }
 117
 118   /// hasOneUse - Return true if there is exactly one instruction using the
 119   /// specified register.
 120   bool hasOneUse(unsigned RegNo) const;
 121
 122   /// use_nodbg_iterator/use_nodbg_begin/use_nodbg_end - Walk all uses of the
 123   /// specified register, skipping those marked as Debug.
 124   typedef defusechain_iterator<true,false,true> use_nodbg_iterator;
 125   use_nodbg_iterator use_nodbg_begin(unsigned RegNo) const {
 126     return use_nodbg_iterator(getRegUseDefListHead(RegNo));
 127   }
 128   static use_nodbg_iterator use_nodbg_end() { return use_nodbg_iterator(0); }
 129
 130   /// use_nodbg_empty - Return true if there are no non-Debug instructions
 131   /// using the specified register.
 132   bool use_nodbg_empty(unsigned RegNo) const {
 133     return use_nodbg_begin(RegNo) == use_nodbg_end();
 134   }
 135
 136   /// hasOneNonDBGUse - Return true if there is exactly one non-Debug
 137   /// instruction using the specified register.
 138   bool hasOneNonDBGUse(unsigned RegNo) const;
 139
 140   /// replaceRegWith - Replace all instances of FromReg with ToReg in the
 141   /// machine function.  This is like llvm-level X->replaceAllUsesWith(Y),
 142   /// except that it also changes any definitions of the register as well.
 143   void replaceRegWith(unsigned FromReg, unsigned ToReg);
 144
 145   /// getRegUseDefListHead - Return the head pointer for the register use/def
 146   /// list for the specified virtual or physical register.
 147   MachineOperand *&getRegUseDefListHead(unsigned RegNo) {
 148     if (RegNo < TargetRegisterInfo::FirstVirtualRegister)
 149       return PhysRegUseDefLists[RegNo];
 150     RegNo -= TargetRegisterInfo::FirstVirtualRegister;
 151     return VRegInfo[RegNo].second;
 152   }
 153
 154   MachineOperand *getRegUseDefListHead(unsigned RegNo) const {
 155     if (RegNo < TargetRegisterInfo::FirstVirtualRegister)
 156       return PhysRegUseDefLists[RegNo];
 157     RegNo -= TargetRegisterInfo::FirstVirtualRegister;
 158     return VRegInfo[RegNo].second;
 159   }
 160
 161   /// getVRegDef - Return the machine instr that defines the specified virtual
 162   /// register or null if none is found.  This assumes that the code is in SSA
 163   /// form, so there should only be one definition.
 164   MachineInstr *getVRegDef(unsigned Reg) const;
 165
 166   /// clearKillFlags - Iterate over all the uses of the given register and
 167   /// clear the kill flag from the MachineOperand. This function is used by
 168   /// optimization passes which extend register lifetimes and need only
 169   /// preserve conservative kill flag information.
 170   void clearKillFlags(unsigned Reg) const;
 171
 172 #ifndef NDEBUG
 173   void dumpUses(unsigned RegNo) const;
 174 #endif
 175
 176   //===--------------------------------------------------------------------===//
 177   // Virtual Register Info
 178   //===--------------------------------------------------------------------===//
 179
 180   /// getRegClass - Return the register class of the specified virtual register.
 181   ///
 182   const TargetRegisterClass *getRegClass(unsigned Reg) const {
 183     Reg -= TargetRegisterInfo::FirstVirtualRegister;
 184     assert(Reg < VRegInfo.size() && "Invalid vreg!");
 185     return VRegInfo[Reg].first;
 186   }
 187
 188   /// setRegClass - Set the register class of the specified virtual register.
 189   ///
 190   void setRegClass(unsigned Reg, const TargetRegisterClass *RC);
 191
 192   /// createVirtualRegister - Create and return a new virtual register in the
 193   /// function with the specified register class.
 194   ///
 195   unsigned createVirtualRegister(const TargetRegisterClass *RegClass);
 196
 197   /// getLastVirtReg - Return the highest currently assigned virtual register.
 198   ///
 199   unsigned getLastVirtReg() const {
 200     return (unsigned)VRegInfo.size()+TargetRegisterInfo::FirstVirtualRegister-1;
 201   }
 202
 203   /// getRegClassVirtRegs - Return the list of virtual registers of the given
 204   /// target register class.
 205   std::vector<unsigned> &getRegClassVirtRegs(const TargetRegisterClass *RC) {
 206     return RegClass2VRegMap[RC->getID()];
 207   }
 208
 209   /// setRegAllocationHint - Specify a register allocation hint for the
 210   /// specified virtual register.
 211   void setRegAllocationHint(unsigned Reg, unsigned Type, unsigned PrefReg) {
 212     Reg -= TargetRegisterInfo::FirstVirtualRegister;
 213     assert(Reg < VRegInfo.size() && "Invalid vreg!");
 214     RegAllocHints[Reg].first  = Type;
 215     RegAllocHints[Reg].second = PrefReg;
 216   }
 217
 218   /// getRegAllocationHint - Return the register allocation hint for the
 219   /// specified virtual register.
 220   std::pair<unsigned, unsigned>
 221   getRegAllocationHint(unsigned Reg) const {
 222     Reg -= TargetRegisterInfo::FirstVirtualRegister;
 223     assert(Reg < VRegInfo.size() && "Invalid vreg!");
 224     return RegAllocHints[Reg];
 225   }
 226
 227   //===--------------------------------------------------------------------===//
 228   // Physical Register Use Info
 229   //===--------------------------------------------------------------------===//
 230
 231   /// isPhysRegUsed - Return true if the specified register is used in this
 232   /// function.  This only works after register allocation.
 233   bool isPhysRegUsed(unsigned Reg) const { return UsedPhysRegs[Reg]; }
 234
 235   /// setPhysRegUsed - Mark the specified register used in this function.
 236   /// This should only be called during and after register allocation.
 237   void setPhysRegUsed(unsigned Reg) { UsedPhysRegs[Reg] = true; }
 238
 239   /// addPhysRegsUsed - Mark the specified registers used in this function.
 240   /// This should only be called during and after register allocation.
 241   void addPhysRegsUsed(const BitVector &Regs) { UsedPhysRegs |= Regs; }
 242
 243   /// setPhysRegUnused - Mark the specified register unused in this function.
 244   /// This should only be called during and after register allocation.
 245   void setPhysRegUnused(unsigned Reg) { UsedPhysRegs[Reg] = false; }
 246
 247   /// closePhysRegsUsed - Expand UsedPhysRegs to its transitive closure over
 248   /// subregisters. That means that if R is used, so are all subregisters.
 249   void closePhysRegsUsed(const TargetRegisterInfo&);
 250
 251   //===--------------------------------------------------------------------===//
 252   // LiveIn/LiveOut Management
 253   //===--------------------------------------------------------------------===//
 254
 255   /// addLiveIn/Out - Add the specified register as a live in/out.  Note that it
 256   /// is an error to add the same register to the same set more than once.
 257   void addLiveIn(unsigned Reg, unsigned vreg = 0) {
 258     LiveIns.push_back(std::make_pair(Reg, vreg));
 259   }
 260   void addLiveOut(unsigned Reg) { LiveOuts.push_back(Reg); }
 261
 262   // Iteration support for live in/out sets.  These sets are kept in sorted
 263   // order by their register number.
 264   typedef std::vector<std::pair<unsigned,unsigned> >::const_iterator
 265   livein_iterator;
 266   typedef std::vector<unsigned>::const_iterator liveout_iterator;
 267   livein_iterator livein_begin() const { return LiveIns.begin(); }
 268   livein_iterator livein_end()   const { return LiveIns.end(); }
 269   bool            livein_empty() const { return LiveIns.empty(); }
 270   liveout_iterator liveout_begin() const { return LiveOuts.begin(); }
 271   liveout_iterator liveout_end()   const { return LiveOuts.end(); }
 272   bool             liveout_empty() const { return LiveOuts.empty(); }
 273
 274   bool isLiveIn(unsigned Reg) const;
 275   bool isLiveOut(unsigned Reg) const;
 276
 277   /// getLiveInPhysReg - If VReg is a live-in virtual register, return the
 278   /// corresponding live-in physical register.
 279   unsigned getLiveInPhysReg(unsigned VReg) const;
 280
 281   /// EmitLiveInCopies - Emit copies to initialize livein virtual registers
 282   /// into the given entry block.
 283   void EmitLiveInCopies(MachineBasicBlock *EntryMBB,
 284                         const TargetRegisterInfo &TRI,
 285                         const TargetInstrInfo &TII);
 286
 287 private:
 288   void HandleVRegListReallocation();
 289
 290 public:
 291   /// defusechain_iterator - This class provides iterator support for machine
 292   /// operands in the function that use or define a specific register.  If
 293   /// ReturnUses is true it returns uses of registers, if ReturnDefs is true it
 294   /// returns defs.  If neither are true then you are silly and it always
 295   /// returns end().  If SkipDebug is true it skips uses marked Debug
 296   /// when incrementing.
 297   template<bool ReturnUses, bool ReturnDefs, bool SkipDebug>
 298   class defusechain_iterator
 299     : public std::iterator<std::forward_iterator_tag, MachineInstr, ptrdiff_t> {
 300     MachineOperand *Op;
 301     explicit defusechain_iterator(MachineOperand *op) : Op(op) {
 302       // If the first node isn't one we're interested in, advance to one that
 303       // we are interested in.
 304       if (op) {
 305         if ((!ReturnUses && op->isUse()) ||
 306             (!ReturnDefs && op->isDef()) ||
 307             (SkipDebug && op->isDebug()))
 308           ++*this;
 309       }
 310     }
 311     friend class MachineRegisterInfo;
 312   public:
 313     typedef std::iterator<std::forward_iterator_tag,
 314                           MachineInstr, ptrdiff_t>::reference reference;
 315     typedef std::iterator<std::forward_iterator_tag,
 316                           MachineInstr, ptrdiff_t>::pointer pointer;
 317
 318     defusechain_iterator(const defusechain_iterator &I) : Op(I.Op) {}
 319     defusechain_iterator() : Op(0) {}
 320
 321     bool operator==(const defusechain_iterator &x) const {
 322       return Op == x.Op;
 323     }
 324     bool operator!=(const defusechain_iterator &x) const {
 325       return !operator==(x);
 326     }
 327
 328     /// atEnd - return true if this iterator is equal to reg_end() on the value.
 329     bool atEnd() const { return Op == 0; }
 330
 331     // Iterator traversal: forward iteration only
 332     defusechain_iterator &operator++() {          // Preincrement
 333       assert(Op && "Cannot increment end iterator!");
 334       Op = Op->getNextOperandForReg();
 335
 336       // If this is an operand we don't care about, skip it.
 337       while (Op && ((!ReturnUses && Op->isUse()) ||
 338                     (!ReturnDefs && Op->isDef()) ||
 339                     (SkipDebug && Op->isDebug())))
 340         Op = Op->getNextOperandForReg();
 341
 342       return *this;
 343     }
 344     defusechain_iterator operator++(int) {        // Postincrement
 345       defusechain_iterator tmp = *this; ++*this; return tmp;
 346     }
 347
 348     MachineOperand &getOperand() const {
 349       assert(Op && "Cannot dereference end iterator!");
 350       return *Op;
 351     }
 352
 353     /// getOperandNo - Return the operand # of this MachineOperand in its
 354     /// MachineInstr.
 355     unsigned getOperandNo() const {
 356       assert(Op && "Cannot dereference end iterator!");
 357       return Op - &Op->getParent()->getOperand(0);
 358     }
 359
 360     // Retrieve a reference to the current operand.
 361     MachineInstr &operator*() const {
 362       assert(Op && "Cannot dereference end iterator!");
 363       return *Op->getParent();
 364     }
 365
 366     MachineInstr *operator->() const {
 367       assert(Op && "Cannot dereference end iterator!");
 368       return Op->getParent();
 369     }
 370   };
 371
 372 };
 373
 374 } // End llvm namespace
 375
 376 #endif