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