include/llvm/CodeGen/LiveVariables.h

   1 //===-- llvm/CodeGen/LiveVariables.h - Live Variable Analysis ---*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the LiveVariables 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 a 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/SmallSet.h"
  35 #include "llvm/ADT/SmallVector.h"
  36 #include <map>
  37
  38 namespace llvm {
  39
  40 class TargetRegisterInfo;
  41
  42 class LiveVariables : public MachineFunctionPass {
  43 public:
  44   static char ID; // Pass identification, replacement for typeid
  45   LiveVariables() : MachineFunctionPass((intptr_t)&ID) {}
  46
  47   /// VarInfo - This represents the regions where a virtual register is live in
  48   /// the program.  We represent this with three different pieces of
  49   /// information: the instruction that uniquely defines the value, the set of
  50   /// blocks the instruction is live into and live out of, and the set of
  51   /// non-phi instructions that are the last users of the value.
  52   ///
  53   /// In the common case where a value is defined and killed in the same block,
  54   /// DefInst is the defining inst, there is one killing instruction, and
  55   /// AliveBlocks is empty.
  56   ///
  57   /// Otherwise, the value is live out of the block.  If the value is live
  58   /// across any blocks, these blocks are listed in AliveBlocks.  Blocks where
  59   /// the liveness range ends are not included in AliveBlocks, instead being
  60   /// captured by the Kills set.  In these blocks, the value is live into the
  61   /// block (unless the value is defined and killed in the same block) and lives
  62   /// until the specified instruction.  Note that there cannot ever be a value
  63   /// whose Kills set contains two instructions from the same basic block.
  64   ///
  65   /// PHI nodes complicate things a bit.  If a PHI node is the last user of a
  66   /// value in one of its predecessor blocks, it is not listed in the kills set,
  67   /// but does include the predecessor block in the AliveBlocks set (unless that
  68   /// block also defines the value).  This leads to the (perfectly sensical)
  69   /// situation where a value is defined in a block, and the last use is a phi
  70   /// node in the successor.  In this case, DefInst will be the defining
  71   /// instruction, AliveBlocks is empty (the value is not live across any
  72   /// blocks) and Kills is empty (phi nodes are not included).  This is sensical
  73   /// because the value must be live to the end of the block, but is not live in
  74   /// any successor blocks.
  75   struct VarInfo {
  76     /// DefInst - The machine instruction that defines this register.
  77     ///
  78     MachineInstr *DefInst;
  79
  80     /// AliveBlocks - Set of blocks of which this value is alive completely
  81     /// through.  This is a bit set which uses the basic block number as an
  82     /// index.
  83     ///
  84     BitVector AliveBlocks;
  85
  86     /// UsedBlocks - Set of blocks of which this value is actually used. This
  87     /// is a bit set which uses the basic block number as an index.
  88     BitVector UsedBlocks;
  89
  90     /// NumUses - Number of uses of this register across the entire function.
  91     ///
  92     unsigned NumUses;
  93
  94     /// Kills - List of MachineInstruction's which are the last use of this
  95     /// virtual register (kill it) in their basic block.
  96     ///
  97     std::vector<MachineInstr*> Kills;
  98
  99     VarInfo() : DefInst(0), NumUses(0) {}
 100
 101     /// removeKill - Delete a kill corresponding to the specified
 102     /// machine instruction. Returns true if there was a kill
 103     /// corresponding to this instruction, false otherwise.
 104     bool removeKill(MachineInstr *MI) {
 105       std::vector<MachineInstr*>::iterator
 106         I = std::find(Kills.begin(), Kills.end(), MI);
 107       if (I == Kills.end())
 108         return false;
 109       Kills.erase(I);
 110       return true;
 111     }
 112
 113     void dump() const;
 114   };
 115
 116 private:
 117   /// VirtRegInfo - This list is a mapping from virtual register number to
 118   /// variable information.  FirstVirtualRegister is subtracted from the virtual
 119   /// register number before indexing into this list.
 120   ///
 121   std::vector<VarInfo> VirtRegInfo;
 122
 123   /// ReservedRegisters - This vector keeps track of which registers
 124   /// are reserved register which are not allocatable by the target machine.
 125   /// We can not track liveness for values that are in this set.
 126   ///
 127   BitVector ReservedRegisters;
 128
 129 private:   // Intermediate data structures
 130   MachineFunction *MF;
 131
 132   const TargetRegisterInfo *TRI;
 133
 134   // PhysRegInfo - Keep track of which instruction was the last def/use of a
 135   // physical register. This is a purely local property, because all physical
 136   // register references are presumed dead across basic blocks.
 137   MachineInstr **PhysRegInfo;
 138
 139   // PhysRegUsed - Keep track of whether the physical register has been used
 140   // after its last definition. This is local property.
 141   bool          *PhysRegUsed;
 142
 143   // PhysRegPartUse - Keep track of which instruction was the last partial use
 144   // of a physical register (e.g. on X86 a def of EAX followed by a use of AX).
 145   // This is a purely local property.
 146   MachineInstr **PhysRegPartUse;
 147
 148   // PhysRegPartDef - Keep track of a list of instructions which "partially"
 149   // defined the physical register (e.g. on X86 AX partially defines EAX).
 150   // These are turned into use/mod/write if there is a use of the register
 151   // later in the same block. This is local property.
 152   SmallVector<MachineInstr*, 4> *PhysRegPartDef;
 153
 154   SmallVector<unsigned, 4> *PHIVarInfo;
 155
 156   void addRegisterKills(unsigned Reg, MachineInstr *MI,
 157                         SmallSet<unsigned, 4> &SubKills);
 158
 159   /// HandlePhysRegKill - Add kills of Reg and its sub-registers to the
 160   /// uses. Pay special attention to the sub-register uses which may come below
 161   /// the last use of the whole register.
 162   bool HandlePhysRegKill(unsigned Reg, const MachineInstr *MI,
 163                          SmallSet<unsigned, 4> &SubKills);
 164   bool HandlePhysRegKill(unsigned Reg, MachineInstr *MI);
 165   void HandlePhysRegUse(unsigned Reg, MachineInstr *MI);
 166   void HandlePhysRegDef(unsigned Reg, MachineInstr *MI);
 167
 168   /// hasRegisterUseBelow - Return true if the specified register is used after
 169   /// the current instruction and before it's next definition.
 170   bool hasRegisterUseBelow(unsigned Reg,
 171                            MachineBasicBlock::iterator I,
 172                            MachineBasicBlock *MBB);
 173
 174   /// analyzePHINodes - Gather information about the PHI nodes in here. In
 175   /// particular, we want to map the variable information of a virtual
 176   /// register which is used in a PHI node. We map that to the BB the vreg
 177   /// is coming from.
 178   void analyzePHINodes(const MachineFunction& Fn);
 179 public:
 180
 181   virtual bool runOnMachineFunction(MachineFunction &MF);
 182
 183   /// RegisterDefIsDead - Return true if the specified instruction defines the
 184   /// specified register, but that definition is dead.
 185   bool RegisterDefIsDead(MachineInstr *MI, unsigned Reg) const;
 186
 187   //===--------------------------------------------------------------------===//
 188   //  API to update live variable information
 189
 190   /// instructionChanged - When the address of an instruction changes, this
 191   /// method should be called so that live variables can update its internal
 192   /// data structures.  This removes the records for OldMI, transfering them to
 193   /// the records for NewMI.
 194   void instructionChanged(MachineInstr *OldMI, MachineInstr *NewMI);
 195
 196   /// addVirtualRegisterKilled - Add information about the fact that the
 197   /// specified register is killed after being used by the specified
 198   /// instruction. If AddIfNotFound is true, add a implicit operand if it's
 199   /// not found.
 200   void addVirtualRegisterKilled(unsigned IncomingReg, MachineInstr *MI,
 201                                 bool AddIfNotFound = false) {
 202     if (MI->addRegisterKilled(IncomingReg, TRI, AddIfNotFound))
 203       getVarInfo(IncomingReg).Kills.push_back(MI);
 204   }
 205
 206   /// removeVirtualRegisterKilled - Remove the specified virtual
 207   /// register from the live variable information. Returns true if the
 208   /// variable was marked as killed by the specified instruction,
 209   /// false otherwise.
 210   bool removeVirtualRegisterKilled(unsigned reg,
 211                                    MachineBasicBlock *MBB,
 212                                    MachineInstr *MI) {
 213     if (!getVarInfo(reg).removeKill(MI))
 214       return false;
 215
 216     bool Removed = false;
 217     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 218       MachineOperand &MO = MI->getOperand(i);
 219       if (MO.isRegister() && MO.isKill() && MO.getReg() == reg) {
 220         MO.setIsKill(false);
 221         Removed = true;
 222         break;
 223       }
 224     }
 225
 226     assert(Removed && "Register is not used by this instruction!");
 227     return true;
 228   }
 229
 230   /// removeVirtualRegistersKilled - Remove all killed info for the specified
 231   /// instruction.
 232   void removeVirtualRegistersKilled(MachineInstr *MI);
 233
 234   /// addVirtualRegisterDead - Add information about the fact that the specified
 235   /// register is dead after being used by the specified instruction. If
 236   /// AddIfNotFound is true, add a implicit operand if it's not found.
 237   void addVirtualRegisterDead(unsigned IncomingReg, MachineInstr *MI,
 238                               bool AddIfNotFound = false) {
 239     if (MI->addRegisterDead(IncomingReg, TRI, AddIfNotFound))
 240         getVarInfo(IncomingReg).Kills.push_back(MI);
 241   }
 242
 243   /// removeVirtualRegisterDead - Remove the specified virtual
 244   /// register from the live variable information. Returns true if the
 245   /// variable was marked dead at the specified instruction, false
 246   /// otherwise.
 247   bool removeVirtualRegisterDead(unsigned reg,
 248                                  MachineBasicBlock *MBB,
 249                                  MachineInstr *MI) {
 250     if (!getVarInfo(reg).removeKill(MI))
 251       return false;
 252
 253     bool Removed = false;
 254     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 255       MachineOperand &MO = MI->getOperand(i);
 256       if (MO.isRegister() && MO.isDef() && MO.getReg() == reg) {
 257         MO.setIsDead(false);
 258         Removed = true;
 259         break;
 260       }
 261     }
 262     assert(Removed && "Register is not defined by this instruction!");
 263     return true;
 264   }
 265
 266   /// removeVirtualRegistersDead - Remove all of the dead registers for the
 267   /// specified instruction from the live variable information.
 268   void removeVirtualRegistersDead(MachineInstr *MI);
 269
 270   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 271     AU.setPreservesAll();
 272   }
 273
 274   virtual void releaseMemory() {
 275     VirtRegInfo.clear();
 276   }
 277
 278   /// getVarInfo - Return the VarInfo structure for the specified VIRTUAL
 279   /// register.
 280   VarInfo &getVarInfo(unsigned RegIdx);
 281
 282   void MarkVirtRegAliveInBlock(VarInfo& VRInfo, MachineBasicBlock* DefBlock,
 283                                MachineBasicBlock *BB);
 284   void MarkVirtRegAliveInBlock(VarInfo& VRInfo, MachineBasicBlock* DefBlock,
 285                                MachineBasicBlock *BB,
 286                                std::vector<MachineBasicBlock*> &WorkList);
 287   void HandleVirtRegUse(unsigned reg, MachineBasicBlock *MBB,
 288                         MachineInstr *MI);
 289 };
 290
 291 } // End llvm namespace
 292
 293 #endif