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 "llvm/ADT/SmallVector.h"
  35 #include <map>
  36
  37 namespace llvm {
  38
  39 class MRegisterInfo;
  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     /// NumUses - Number of uses of this register across the entire function.
  83     ///
  84     unsigned NumUses;
  85
  86     /// Kills - List of MachineInstruction's which are the last use of this
  87     /// virtual register (kill it) in their basic block.
  88     ///
  89     std::vector<MachineInstr*> Kills;
  90
  91     VarInfo() : DefInst(0), NumUses(0) {}
  92
  93     /// removeKill - Delete a kill corresponding to the specified
  94     /// machine instruction. Returns true if there was a kill
  95     /// corresponding to this instruction, false otherwise.
  96     bool removeKill(MachineInstr *MI) {
  97       for (std::vector<MachineInstr*>::iterator i = Kills.begin(),
  98              e = Kills.end(); i != e; ++i)
  99         if (*i == MI) {
 100           Kills.erase(i);
 101           return true;
 102         }
 103       return false;
 104     }
 105
 106     void dump() const;
 107   };
 108
 109 private:
 110   /// VirtRegInfo - This list is a mapping from virtual register number to
 111   /// variable information.  FirstVirtualRegister is subtracted from the virtual
 112   /// register number before indexing into this list.
 113   ///
 114   std::vector<VarInfo> VirtRegInfo;
 115
 116   /// ReservedRegisters - This vector keeps track of which registers
 117   /// are reserved register which are not allocatable by the target machine.
 118   /// We can not track liveness for values that are in this set.
 119   ///
 120   BitVector ReservedRegisters;
 121
 122 private:   // Intermediate data structures
 123   MachineFunction *MF;
 124
 125   const MRegisterInfo *RegInfo;
 126
 127   // PhysRegInfo - Keep track of which instruction was the last def/use of a
 128   // physical register. This is a purely local property, because all physical
 129   // register references as presumed dead across basic blocks.
 130   MachineInstr **PhysRegInfo;
 131
 132   // PhysRegUsed - Keep track whether the physical register has been used after
 133   // its last definition. This is local property.
 134   bool          *PhysRegUsed;
 135
 136   // PhysRegPartUse - Keep track of which instruction was the last partial use
 137   // of a physical register (e.g. on X86 a def of EAX followed by a use of AX).
 138   // This is a purely local property.
 139   MachineInstr **PhysRegPartUse;
 140
 141   // PhysRegPartDef - Keep track of a list of instructions which "partially"
 142   // defined the physical register (e.g. on X86 AX partially defines EAX).
 143   // These are turned into use/mod/write if there is a use of the register
 144   // later in the same block. This is local property.
 145   SmallVector<MachineInstr*, 4> *PhysRegPartDef;
 146
 147   SmallVector<unsigned, 4> *PHIVarInfo;
 148
 149   /// addRegisterKilled - We have determined MI kills a register. Look for the
 150   /// operand that uses it and mark it as IsKill.
 151   void addRegisterKilled(unsigned IncomingReg, MachineInstr *MI);
 152
 153   /// addRegisterDead - We have determined MI defined a register without a use.
 154   /// Look for the operand that defines it and mark it as IsDead.
 155   void addRegisterDead(unsigned IncomingReg, MachineInstr *MI);
 156
 157   void HandlePhysRegUse(unsigned Reg, MachineInstr *MI);
 158   void HandlePhysRegDef(unsigned Reg, MachineInstr *MI);
 159
 160   /// analyzePHINodes - Gather information about the PHI nodes in here. In
 161   /// particular, we want to map the variable information of a virtual
 162   /// register which is used in a PHI node. We map that to the BB the vreg
 163   /// is coming from.
 164   void analyzePHINodes(const MachineFunction& Fn);
 165 public:
 166
 167   virtual bool runOnMachineFunction(MachineFunction &MF);
 168
 169   /// KillsRegister - Return true if the specified instruction kills the
 170   /// specified register.
 171   bool KillsRegister(MachineInstr *MI, unsigned Reg) const;
 172
 173   /// RegisterDefIsDead - Return true if the specified instruction defines the
 174   /// specified register, but that definition is dead.
 175   bool RegisterDefIsDead(MachineInstr *MI, unsigned Reg) const;
 176
 177   /// ModifiesRegister - Return true if the specified instruction modifies the
 178   /// specified register.
 179   bool ModifiesRegister(MachineInstr *MI, unsigned Reg) const;
 180
 181   //===--------------------------------------------------------------------===//
 182   //  API to update live variable information
 183
 184   /// instructionChanged - When the address of an instruction changes, this
 185   /// method should be called so that live variables can update its internal
 186   /// data structures.  This removes the records for OldMI, transfering them to
 187   /// the records for NewMI.
 188   void instructionChanged(MachineInstr *OldMI, MachineInstr *NewMI);
 189
 190   /// addVirtualRegisterKilled - Add information about the fact that the
 191   /// specified register is killed after being used by the specified
 192   /// instruction.
 193   ///
 194   void addVirtualRegisterKilled(unsigned IncomingReg, MachineInstr *MI) {
 195     addRegisterKilled(IncomingReg, MI);
 196     getVarInfo(IncomingReg).Kills.push_back(MI);
 197  }
 198
 199   /// removeVirtualRegisterKilled - Remove the specified virtual
 200   /// register from the live variable information. Returns true if the
 201   /// variable was marked as killed by the specified instruction,
 202   /// false otherwise.
 203   bool removeVirtualRegisterKilled(unsigned reg,
 204                                    MachineBasicBlock *MBB,
 205                                    MachineInstr *MI) {
 206     if (!getVarInfo(reg).removeKill(MI))
 207       return false;
 208
 209     bool Removed = false;
 210     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 211       MachineOperand &MO = MI->getOperand(i);
 212       if (MO.isReg() && MO.isUse() && MO.getReg() == reg) {
 213         MO.unsetIsKill();
 214         Removed = true;
 215         break;
 216       }
 217     }
 218
 219     assert(Removed && "Register is not used by this instruction!");
 220     return true;
 221   }
 222
 223   /// removeVirtualRegistersKilled - Remove all killed info for the specified
 224   /// instruction.
 225   void removeVirtualRegistersKilled(MachineInstr *MI);
 226
 227   /// addVirtualRegisterDead - Add information about the fact that the specified
 228   /// register is dead after being used by the specified instruction.
 229   ///
 230   void addVirtualRegisterDead(unsigned IncomingReg, MachineInstr *MI) {
 231     addRegisterDead(IncomingReg, MI);
 232     getVarInfo(IncomingReg).Kills.push_back(MI);
 233   }
 234
 235   /// removeVirtualRegisterDead - Remove the specified virtual
 236   /// register from the live variable information. Returns true if the
 237   /// variable was marked dead at the specified instruction, false
 238   /// otherwise.
 239   bool removeVirtualRegisterDead(unsigned reg,
 240                                  MachineBasicBlock *MBB,
 241                                  MachineInstr *MI) {
 242     if (!getVarInfo(reg).removeKill(MI))
 243       return false;
 244
 245     bool Removed = false;
 246     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 247       MachineOperand &MO = MI->getOperand(i);
 248       if (MO.isReg() && MO.isDef() && MO.getReg() == reg) {
 249         MO.unsetIsDead();
 250         Removed = true;
 251         break;
 252       }
 253     }
 254     assert(Removed && "Register is not defined by this instruction!");
 255     return true;
 256   }
 257
 258   /// removeVirtualRegistersDead - Remove all of the dead registers for the
 259   /// specified instruction from the live variable information.
 260   void removeVirtualRegistersDead(MachineInstr *MI);
 261
 262   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 263     AU.setPreservesAll();
 264   }
 265
 266   virtual void releaseMemory() {
 267     VirtRegInfo.clear();
 268   }
 269
 270   /// getVarInfo - Return the VarInfo structure for the specified VIRTUAL
 271   /// register.
 272   VarInfo &getVarInfo(unsigned RegIdx);
 273
 274   void MarkVirtRegAliveInBlock(VarInfo &VRInfo, MachineBasicBlock *BB);
 275   void HandleVirtRegUse(VarInfo &VRInfo, MachineBasicBlock *MBB,
 276                         MachineInstr *MI);
 277 };
 278
 279 } // End llvm namespace
 280
 281 #endif