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 "llvm/ADT/BitVector.h"
  34 #include <map>
  35
  36 namespace llvm {
  37
  38 class MRegisterInfo;
  39 class BitVector;
  40
  41 class LiveVariables : public MachineFunctionPass {
  42 public:
  43   /// VarInfo - This represents the regions where a virtual register is live in
  44   /// the program.  We represent this with three different pieces of
  45   /// information: the instruction that uniquely defines the value, the set of
  46   /// blocks the instruction is live into and live out of, and the set of
  47   /// non-phi instructions that are the last users of the value.
  48   ///
  49   /// In the common case where a value is defined and killed in the same block,
  50   /// DefInst is the defining inst, there is one killing instruction, and
  51   /// AliveBlocks is empty.
  52   ///
  53   /// Otherwise, the value is live out of the block.  If the value is live
  54   /// across any blocks, these blocks are listed in AliveBlocks.  Blocks where
  55   /// the liveness range ends are not included in AliveBlocks, instead being
  56   /// captured by the Kills set.  In these blocks, the value is live into the
  57   /// block (unless the value is defined and killed in the same block) and lives
  58   /// until the specified instruction.  Note that there cannot ever be a value
  59   /// whose Kills set contains two instructions from the same basic block.
  60   ///
  61   /// PHI nodes complicate things a bit.  If a PHI node is the last user of a
  62   /// value in one of its predecessor blocks, it is not listed in the kills set,
  63   /// but does include the predecessor block in the AliveBlocks set (unless that
  64   /// block also defines the value).  This leads to the (perfectly sensical)
  65   /// situation where a value is defined in a block, and the last use is a phi
  66   /// node in the successor.  In this case, DefInst will be the defining
  67   /// instruction, AliveBlocks is empty (the value is not live across any
  68   /// blocks) and Kills is empty (phi nodes are not included).  This is sensical
  69   /// because the value must be live to the end of the block, but is not live in
  70   /// any successor blocks.
  71   struct VarInfo {
  72     /// DefInst - The machine instruction that defines this register.
  73     ///
  74     MachineInstr *DefInst;
  75
  76     /// AliveBlocks - Set of blocks of which this value is alive completely
  77     /// through.  This is a bit set which uses the basic block number as an
  78     /// index.
  79     ///
  80     BitVector AliveBlocks;
  81
  82     /// Kills - List of MachineInstruction's which are the last use of this
  83     /// virtual register (kill it) in their basic block.
  84     ///
  85     std::vector<MachineInstr*> Kills;
  86
  87     VarInfo() : DefInst(0) {}
  88
  89     /// removeKill - Delete a kill corresponding to the specified
  90     /// machine instruction. Returns true if there was a kill
  91     /// corresponding to this instruction, false otherwise.
  92     bool removeKill(MachineInstr *MI) {
  93       for (std::vector<MachineInstr*>::iterator i = Kills.begin(),
  94              e = Kills.end(); i != e; ++i)
  95         if (*i == MI) {
  96           Kills.erase(i);
  97           return true;
  98         }
  99       return false;
 100     }
 101
 102     void dump() const;
 103   };
 104
 105 private:
 106   /// VirtRegInfo - This list is a mapping from virtual register number to
 107   /// variable information.  FirstVirtualRegister is subtracted from the virtual
 108   /// register number before indexing into this list.
 109   ///
 110   std::vector<VarInfo> VirtRegInfo;
 111
 112   /// ReservedRegisters - This vector keeps track of which registers
 113   /// are reserved register which are not allocatable by the target machine.
 114   /// We can not track liveness for values that are in this set.
 115   ///
 116   BitVector ReservedRegisters;
 117
 118 private:   // Intermediate data structures
 119   const MRegisterInfo *RegInfo;
 120
 121   MachineInstr **PhysRegInfo;
 122   bool          *PhysRegUsed;
 123
 124   typedef std::map<const MachineBasicBlock*,
 125                    std::vector<unsigned> > PHIVarInfoMap;
 126
 127   PHIVarInfoMap PHIVarInfo;
 128
 129
 130   /// addRegisterKilled - We have determined MI kills a register. Look for the
 131   /// operand that uses it and mark it as IsKill.
 132   void addRegisterKilled(unsigned IncomingReg, MachineInstr *MI);
 133
 134   /// addRegisterDead - We have determined MI defined a register without a use.
 135   /// Look for the operand that defines it and mark it as IsDead.
 136   void addRegisterDead(unsigned IncomingReg, MachineInstr *MI);
 137
 138   void HandlePhysRegUse(unsigned Reg, MachineInstr *MI);
 139   void HandlePhysRegDef(unsigned Reg, MachineInstr *MI);
 140
 141   /// analyzePHINodes - Gather information about the PHI nodes in here. In
 142   /// particular, we want to map the variable information of a virtual
 143   /// register which is used in a PHI node. We map that to the BB the vreg
 144   /// is coming from.
 145   void analyzePHINodes(const MachineFunction& Fn);
 146 public:
 147
 148   virtual bool runOnMachineFunction(MachineFunction &MF);
 149
 150   /// KillsRegister - Return true if the specified instruction kills the
 151   /// specified register.
 152   bool KillsRegister(MachineInstr *MI, unsigned Reg) const;
 153
 154   /// RegisterDefIsDead - Return true if the specified instruction defines the
 155   /// specified register, but that definition is dead.
 156   bool RegisterDefIsDead(MachineInstr *MI, unsigned Reg) const;
 157
 158   /// ModifiesRegister - Return true if the specified instruction modifies the
 159   /// specified register.
 160   bool ModifiesRegister(MachineInstr *MI, unsigned Reg) const;
 161
 162   //===--------------------------------------------------------------------===//
 163   //  API to update live variable information
 164
 165   /// instructionChanged - When the address of an instruction changes, this
 166   /// method should be called so that live variables can update its internal
 167   /// data structures.  This removes the records for OldMI, transfering them to
 168   /// the records for NewMI.
 169   void instructionChanged(MachineInstr *OldMI, MachineInstr *NewMI);
 170
 171   /// addVirtualRegisterKilled - Add information about the fact that the
 172   /// specified register is killed after being used by the specified
 173   /// instruction.
 174   ///
 175   void addVirtualRegisterKilled(unsigned IncomingReg, MachineInstr *MI) {
 176     addRegisterKilled(IncomingReg, MI);
 177     getVarInfo(IncomingReg).Kills.push_back(MI);
 178  }
 179
 180   /// removeVirtualRegisterKilled - Remove the specified virtual
 181   /// register from the live variable information. Returns true if the
 182   /// variable was marked as killed by the specified instruction,
 183   /// false otherwise.
 184   bool removeVirtualRegisterKilled(unsigned reg,
 185                                    MachineBasicBlock *MBB,
 186                                    MachineInstr *MI) {
 187     if (!getVarInfo(reg).removeKill(MI))
 188       return false;
 189
 190     bool Removed = false;
 191     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 192       MachineOperand &MO = MI->getOperand(i);
 193       if (MO.isReg() && MO.isUse() && MO.getReg() == reg) {
 194         MO.unsetIsKill();
 195         Removed = true;
 196         break;
 197       }
 198     }
 199
 200     assert(Removed && "Register is not used by this instruction!");
 201     return true;
 202   }
 203
 204   /// removeVirtualRegistersKilled - Remove all killed info for the specified
 205   /// instruction.
 206   void removeVirtualRegistersKilled(MachineInstr *MI);
 207
 208   /// addVirtualRegisterDead - Add information about the fact that the specified
 209   /// register is dead after being used by the specified instruction.
 210   ///
 211   void addVirtualRegisterDead(unsigned IncomingReg, MachineInstr *MI) {
 212     addRegisterDead(IncomingReg, MI);
 213     getVarInfo(IncomingReg).Kills.push_back(MI);
 214   }
 215
 216   /// removeVirtualRegisterDead - Remove the specified virtual
 217   /// register from the live variable information. Returns true if the
 218   /// variable was marked dead at the specified instruction, false
 219   /// otherwise.
 220   bool removeVirtualRegisterDead(unsigned reg,
 221                                  MachineBasicBlock *MBB,
 222                                  MachineInstr *MI) {
 223     if (!getVarInfo(reg).removeKill(MI))
 224       return false;
 225
 226     bool Removed = false;
 227     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 228       MachineOperand &MO = MI->getOperand(i);
 229       if (MO.isReg() && MO.isDef() && MO.getReg() == reg) {
 230         MO.unsetIsDead();
 231         Removed = true;
 232         break;
 233       }
 234     }
 235     assert(Removed && "Register is not defined by this instruction!");
 236     return true;
 237   }
 238
 239   /// removeVirtualRegistersDead - Remove all of the dead registers for the
 240   /// specified instruction from the live variable information.
 241   void removeVirtualRegistersDead(MachineInstr *MI);
 242
 243   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 244     AU.setPreservesAll();
 245   }
 246
 247   virtual void releaseMemory() {
 248     VirtRegInfo.clear();
 249   }
 250
 251   /// getVarInfo - Return the VarInfo structure for the specified VIRTUAL
 252   /// register.
 253   VarInfo &getVarInfo(unsigned RegIdx);
 254
 255   void MarkVirtRegAliveInBlock(VarInfo &VRInfo, MachineBasicBlock *BB);
 256   void HandleVirtRegUse(VarInfo &VRInfo, MachineBasicBlock *MBB,
 257                         MachineInstr *MI);
 258 };
 259
 260 } // End llvm namespace
 261
 262 #endif