include/llvm/CodeGen/LiveVariables.h

   1 //===-- llvm/CodeGen/LiveVariables.h - Live Variable Analysis ---*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the LiveVariable analysis pass.  For each machine
  11 // instruction in the function, this pass calculates the set of registers that
  12 // are immediately dead after the instruction (i.e., the instruction calculates
  13 // the value, but it is never used) and the set of registers that are used by
  14 // the instruction, but are never used after the instruction (i.e., they are
  15 // killed).
  16 //
  17 // This class computes live variables using are sparse implementation based on
  18 // the machine code SSA form.  This class computes live variable information for
  19 // each virtual and _register allocatable_ physical register in a function.  It
  20 // uses the dominance properties of SSA form to efficiently compute live
  21 // variables for virtual registers, and assumes that physical registers are only
  22 // live within a single basic block (allowing it to do a single local analysis
  23 // to resolve physical register lifetimes in each basic block).  If a physical
  24 // register is not register allocatable, it is not tracked.  This is useful for
  25 // things like the stack pointer and condition codes.
  26 //
  27 //===----------------------------------------------------------------------===//
  28
  29 #ifndef LLVM_CODEGEN_LIVEVARIABLES_H
  30 #define LLVM_CODEGEN_LIVEVARIABLES_H
  31
  32 #include "llvm/CodeGen/MachineFunctionPass.h"
  33 #include <map>
  34
  35 namespace llvm {
  36
  37 class MRegisterInfo;
  38
  39 class LiveVariables : public MachineFunctionPass {
  40 public:
  41   struct VarInfo {
  42     /// DefBlock - The basic block which defines this value...
  43     MachineBasicBlock *DefBlock;
  44     MachineInstr      *DefInst;
  45
  46     /// AliveBlocks - Set of blocks of which this value is alive completely
  47     /// through.  This is a bit set which uses the basic block number as an
  48     /// index.
  49     ///
  50     std::vector<bool> AliveBlocks;
  51
  52     /// Kills - List of MachineBasicblock's which contain the last use of this
  53     /// virtual register (kill it).  This also includes the specific instruction
  54     /// which kills the value.
  55     ///
  56     std::vector<std::pair<MachineBasicBlock*, MachineInstr*> > Kills;
  57
  58     VarInfo() : DefBlock(0), DefInst(0) {}
  59
  60     /// removeKill - Delete a kill corresponding to the specified
  61     /// machine instruction. Returns true if there was a kill
  62     /// corresponding to this instruction, false otherwise.
  63     bool removeKill(MachineInstr *MI) {
  64       for (std::vector<std::pair<MachineBasicBlock*, MachineInstr*> >::iterator
  65              i = Kills.begin(); i != Kills.end(); ++i) {
  66         if (i->second == MI) {
  67           Kills.erase(i);
  68           return true;
  69         }
  70       }
  71       return false;
  72     }
  73   };
  74
  75 private:
  76   /// VirtRegInfo - This list is a mapping from virtual register number to
  77   /// variable information.  FirstVirtualRegister is subtracted from the virtual
  78   /// register number before indexing into this list.
  79   ///
  80   std::vector<VarInfo> VirtRegInfo;
  81
  82   /// RegistersKilled - This multimap keeps track of all of the registers that
  83   /// are dead immediately after an instruction reads its operands.  If an
  84   /// instruction does not have an entry in this map, it kills no registers.
  85   ///
  86   std::multimap<MachineInstr*, unsigned> RegistersKilled;
  87
  88   /// RegistersDead - This multimap keeps track of all of the registers that are
  89   /// dead immediately after an instruction executes, which are not dead after
  90   /// the operands are evaluated.  In practice, this only contains registers
  91   /// which are defined by an instruction, but never used.
  92   ///
  93   std::multimap<MachineInstr*, unsigned> RegistersDead;
  94
  95   /// AllocatablePhysicalRegisters - This vector keeps track of which registers
  96   /// are actually register allocatable by the target machine.  We can not track
  97   /// liveness for values that are not in this set.
  98   ///
  99   std::vector<bool> AllocatablePhysicalRegisters;
 100
 101 private:   // Intermediate data structures
 102
 103   /// BBMap - This provides a numbering of the basic blocks in the function.
 104   ///
 105   std::map<MachineBasicBlock*, unsigned> BBMap;
 106
 107   /// BBIdxMap - This contains the inverse mapping of BBMap, going from block ID
 108   /// numbers to the corresponding MachineBasicBlock.  This is lazily computed
 109   /// when the getIndexMachineBasicBlock() method is called.
 110   std::vector<MachineBasicBlock*> BBIdxMap;
 111
 112   const MRegisterInfo *RegInfo;
 113
 114   MachineInstr **PhysRegInfo;
 115   bool          *PhysRegUsed;
 116
 117   void HandlePhysRegUse(unsigned Reg, MachineInstr *MI);
 118   void HandlePhysRegDef(unsigned Reg, MachineInstr *MI);
 119
 120 public:
 121
 122   virtual bool runOnMachineFunction(MachineFunction &MF);
 123
 124   /// getMachineBasicBlockIndex - Turn a MachineBasicBlock into an index number
 125   /// suitable for use with VarInfo's.
 126   ///
 127   unsigned getMachineBasicBlockIndex(MachineBasicBlock *MBB) const {
 128     return BBMap.find(MBB)->second;
 129   }
 130
 131   /// getIndexMachineBasicBlock() - Given a block index, return the
 132   /// MachineBasicBlock corresponding to it.
 133   MachineBasicBlock *getIndexMachineBasicBlock(unsigned Idx);
 134
 135   /// killed_iterator - Iterate over registers killed by a machine instruction
 136   ///
 137   typedef std::multimap<MachineInstr*, unsigned>::iterator killed_iterator;
 138
 139   /// killed_begin/end - Get access to the range of registers killed by a
 140   /// machine instruction.
 141   killed_iterator killed_begin(MachineInstr *MI) {
 142     return RegistersKilled.lower_bound(MI);
 143   }
 144   killed_iterator killed_end(MachineInstr *MI) {
 145     return RegistersKilled.upper_bound(MI);
 146   }
 147   std::pair<killed_iterator, killed_iterator>
 148   killed_range(MachineInstr *MI) {
 149     return RegistersKilled.equal_range(MI);
 150   }
 151
 152   killed_iterator dead_begin(MachineInstr *MI) {
 153     return RegistersDead.lower_bound(MI);
 154   }
 155   killed_iterator dead_end(MachineInstr *MI) {
 156     return RegistersDead.upper_bound(MI);
 157   }
 158   std::pair<killed_iterator, killed_iterator>
 159   dead_range(MachineInstr *MI) {
 160     return RegistersDead.equal_range(MI);
 161   }
 162
 163   //===--------------------------------------------------------------------===//
 164   //  API to update live variable information
 165
 166   /// instructionChanged - When the address of an instruction changes, this
 167   /// method should be called so that live variables can update its internal
 168   /// data structures.  This removes the records for OldMI, transfering them to
 169   /// the records for NewMI.
 170   void instructionChanged(MachineInstr *OldMI, MachineInstr *NewMI);
 171
 172   /// addVirtualRegisterKilled - Add information about the fact that the
 173   /// specified register is killed after being used by the specified
 174   /// instruction.
 175   ///
 176   void addVirtualRegisterKilled(unsigned IncomingReg,
 177                                 MachineBasicBlock *MBB,
 178                                 MachineInstr *MI) {
 179     RegistersKilled.insert(std::make_pair(MI, IncomingReg));
 180     getVarInfo(IncomingReg).Kills.push_back(std::make_pair(MBB, MI));
 181   }
 182
 183   /// removeVirtualRegisterKilled - Remove the specified virtual
 184   /// register from the live variable information. Returns true if the
 185   /// variable was marked as killed by the specified instruction,
 186   /// false otherwise.
 187   bool removeVirtualRegisterKilled(unsigned reg,
 188                                    MachineBasicBlock *MBB,
 189                                    MachineInstr *MI) {
 190     if (!getVarInfo(reg).removeKill(MI))
 191       return false;
 192     for (killed_iterator i = killed_begin(MI), e = killed_end(MI); i != e; ) {
 193       if (i->second == reg)
 194         RegistersKilled.erase(i++);
 195       else
 196         ++i;
 197     }
 198     return true;
 199   }
 200
 201   /// removeVirtualRegistersKilled - Remove all of the specified killed
 202   /// registers from the live variable information.
 203   void removeVirtualRegistersKilled(killed_iterator B, killed_iterator E) {
 204     for (killed_iterator I = B; I != E; ++I) { // Remove VarInfo entries...
 205       bool removed = getVarInfo(I->second).removeKill(I->first);
 206       assert(removed && "kill not in register's VarInfo?");
 207     }
 208     RegistersKilled.erase(B, E);
 209   }
 210
 211   /// addVirtualRegisterDead - Add information about the fact that the specified
 212   /// register is dead after being used by the specified instruction.
 213   ///
 214   void addVirtualRegisterDead(unsigned IncomingReg,
 215                               MachineBasicBlock *MBB,
 216                               MachineInstr *MI) {
 217     RegistersDead.insert(std::make_pair(MI, IncomingReg));
 218     getVarInfo(IncomingReg).Kills.push_back(std::make_pair(MBB, MI));
 219   }
 220
 221   /// removeVirtualRegisterDead - Remove the specified virtual
 222   /// register from the live variable information. Returns true if the
 223   /// variable was marked dead at the specified instruction, false
 224   /// otherwise.
 225   bool removeVirtualRegisterDead(unsigned reg,
 226                                  MachineBasicBlock *MBB,
 227                                  MachineInstr *MI) {
 228     if (!getVarInfo(reg).removeKill(MI))
 229       return false;
 230
 231     for (killed_iterator i = killed_begin(MI), e = killed_end(MI); i != e; ) {
 232       if (i->second == reg)
 233         RegistersKilled.erase(i++);
 234       else
 235         ++i;
 236     }
 237     return true;
 238   }
 239
 240   /// removeVirtualRegistersDead - Remove all of the specified dead
 241   /// registers from the live variable information.
 242   void removeVirtualRegistersDead(killed_iterator B, killed_iterator E) {
 243     for (killed_iterator I = B; I != E; ++I)  // Remove VarInfo entries...
 244       getVarInfo(I->second).removeKill(I->first);
 245     RegistersDead.erase(B, E);
 246   }
 247
 248   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 249     AU.setPreservesAll();
 250   }
 251
 252   virtual void releaseMemory() {
 253     VirtRegInfo.clear();
 254     RegistersKilled.clear();
 255     RegistersDead.clear();
 256     BBMap.clear();
 257     BBIdxMap.clear();
 258   }
 259
 260   /// getVarInfo - Return the VarInfo structure for the specified VIRTUAL
 261   /// register.
 262   VarInfo &getVarInfo(unsigned RegIdx);
 263
 264   const std::vector<bool>& getAllocatablePhysicalRegisters() const {
 265     return AllocatablePhysicalRegisters;
 266   }
 267
 268   void MarkVirtRegAliveInBlock(VarInfo &VRInfo, MachineBasicBlock *BB);
 269   void HandleVirtRegUse(VarInfo &VRInfo, MachineBasicBlock *MBB,
 270                         MachineInstr *MI);
 271 };
 272
 273 } // End llvm namespace
 274
 275 #endif