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 - Maps LLVM basic blocks to their corresponding machine basic block.
 104   /// This also provides a numbering of the basic blocks in the function.
 105   std::map<const BasicBlock*, std::pair<MachineBasicBlock*, unsigned> > BBMap;
 106
 107
 108   /// BBIdxMap - This contains the inverse mapping of BBMap, going from block ID
 109   /// numbers to the corresponding MachineBasicBlock.  This is lazily computed
 110   /// when the getIndexMachineBasicBlock() method is called.
 111   std::vector<MachineBasicBlock*> BBIdxMap;
 112
 113   const MRegisterInfo *RegInfo;
 114
 115   MachineInstr **PhysRegInfo;
 116   bool          *PhysRegUsed;
 117
 118   void HandlePhysRegUse(unsigned Reg, MachineInstr *MI);
 119   void HandlePhysRegDef(unsigned Reg, MachineInstr *MI);
 120
 121 public:
 122
 123   virtual bool runOnMachineFunction(MachineFunction &MF);
 124
 125   /// getMachineBasicBlockIndex - Turn a MachineBasicBlock into an index number
 126   /// suitable for use with VarInfo's.
 127   ///
 128   const std::pair<MachineBasicBlock*, unsigned>
 129       &getMachineBasicBlockInfo(MachineBasicBlock *MBB) const;
 130   const std::pair<MachineBasicBlock*, unsigned>
 131       &getBasicBlockInfo(const BasicBlock *BB) const {
 132     return BBMap.find(BB)->second;
 133   }
 134
 135   /// getIndexMachineBasicBlock() - Given a block index, return the
 136   /// MachineBasicBlock corresponding to it.
 137   MachineBasicBlock *getIndexMachineBasicBlock(unsigned Idx);
 138
 139   /// killed_iterator - Iterate over registers killed by a machine instruction
 140   ///
 141   typedef std::multimap<MachineInstr*, unsigned>::iterator killed_iterator;
 142
 143   /// killed_begin/end - Get access to the range of registers killed by a
 144   /// machine instruction.
 145   killed_iterator killed_begin(MachineInstr *MI) {
 146     return RegistersKilled.lower_bound(MI);
 147   }
 148   killed_iterator killed_end(MachineInstr *MI) {
 149     return RegistersKilled.upper_bound(MI);
 150   }
 151   std::pair<killed_iterator, killed_iterator>
 152   killed_range(MachineInstr *MI) {
 153     return RegistersKilled.equal_range(MI);
 154   }
 155
 156   killed_iterator dead_begin(MachineInstr *MI) {
 157     return RegistersDead.lower_bound(MI);
 158   }
 159   killed_iterator dead_end(MachineInstr *MI) {
 160     return RegistersDead.upper_bound(MI);
 161   }
 162   std::pair<killed_iterator, killed_iterator>
 163   dead_range(MachineInstr *MI) {
 164     return RegistersDead.equal_range(MI);
 165   }
 166
 167   //===--------------------------------------------------------------------===//
 168   //  API to update live variable information
 169
 170   /// instructionChanged - When the address of an instruction changes, this
 171   /// method should be called so that live variables can update its internal
 172   /// data structures.  This removes the records for OldMI, transfering them to
 173   /// the records for NewMI.
 174   void instructionChanged(MachineInstr *OldMI, MachineInstr *NewMI);
 175
 176   /// addVirtualRegisterKilled - Add information about the fact that the
 177   /// specified register is killed after being used by the specified
 178   /// instruction.
 179   ///
 180   void addVirtualRegisterKilled(unsigned IncomingReg,
 181                                 MachineBasicBlock *MBB,
 182                                 MachineInstr *MI) {
 183     RegistersKilled.insert(std::make_pair(MI, IncomingReg));
 184     getVarInfo(IncomingReg).Kills.push_back(std::make_pair(MBB, MI));
 185   }
 186
 187   /// removeVirtualRegisterKilled - Remove the specified virtual
 188   /// register from the live variable information. Returns true if the
 189   /// variable was marked as killed by the specified instruction,
 190   /// false otherwise.
 191   bool removeVirtualRegisterKilled(unsigned reg,
 192                                    MachineBasicBlock *MBB,
 193                                    MachineInstr *MI) {
 194     if (!getVarInfo(reg).removeKill(MI))
 195       return false;
 196     for (killed_iterator i = killed_begin(MI), e = killed_end(MI); i != e; ) {
 197       if (i->second == reg)
 198         RegistersKilled.erase(i++);
 199       else
 200         ++i;
 201     }
 202     return true;
 203   }
 204
 205   /// removeVirtualRegistersKilled - Remove all of the specified killed
 206   /// registers from the live variable information.
 207   void removeVirtualRegistersKilled(killed_iterator B, killed_iterator E) {
 208     for (killed_iterator I = B; I != E; ++I) { // Remove VarInfo entries...
 209       bool removed = getVarInfo(I->second).removeKill(I->first);
 210       assert(removed && "kill not in register's VarInfo?");
 211     }
 212     RegistersKilled.erase(B, E);
 213   }
 214
 215   /// addVirtualRegisterDead - Add information about the fact that the specified
 216   /// register is dead after being used by the specified instruction.
 217   ///
 218   void addVirtualRegisterDead(unsigned IncomingReg,
 219                               MachineBasicBlock *MBB,
 220                               MachineInstr *MI) {
 221     RegistersDead.insert(std::make_pair(MI, IncomingReg));
 222     getVarInfo(IncomingReg).Kills.push_back(std::make_pair(MBB, MI));
 223   }
 224
 225   /// removeVirtualRegisterDead - Remove the specified virtual
 226   /// register from the live variable information. Returns true if the
 227   /// variable was marked dead at the specified instruction, false
 228   /// otherwise.
 229   bool removeVirtualRegisterDead(unsigned reg,
 230                                  MachineBasicBlock *MBB,
 231                                  MachineInstr *MI) {
 232     if (!getVarInfo(reg).removeKill(MI))
 233       return false;
 234
 235     for (killed_iterator i = killed_begin(MI), e = killed_end(MI); i != e; ) {
 236       if (i->second == reg)
 237         RegistersKilled.erase(i++);
 238       else
 239         ++i;
 240     }
 241     return true;
 242   }
 243
 244   /// removeVirtualRegistersDead - Remove all of the specified dead
 245   /// registers from the live variable information.
 246   void removeVirtualRegistersDead(killed_iterator B, killed_iterator E) {
 247     for (killed_iterator I = B; I != E; ++I)  // Remove VarInfo entries...
 248       getVarInfo(I->second).removeKill(I->first);
 249     RegistersDead.erase(B, E);
 250   }
 251
 252   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 253     AU.setPreservesAll();
 254   }
 255
 256   virtual void releaseMemory() {
 257     VirtRegInfo.clear();
 258     RegistersKilled.clear();
 259     RegistersDead.clear();
 260     BBMap.clear();
 261     BBIdxMap.clear();
 262   }
 263
 264   /// getVarInfo - Return the VarInfo structure for the specified VIRTUAL
 265   /// register.
 266   VarInfo &getVarInfo(unsigned RegIdx);
 267
 268   const std::vector<bool>& getAllocatablePhysicalRegisters() const {
 269     return AllocatablePhysicalRegisters;
 270   }
 271
 272   void MarkVirtRegAliveInBlock(VarInfo &VRInfo, const BasicBlock *BB);
 273   void HandleVirtRegUse(VarInfo &VRInfo, MachineBasicBlock *MBB,
 274                         MachineInstr *MI);
 275 };
 276
 277 } // End llvm namespace
 278
 279 #endif