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/DenseMap.h"
  35 #include "llvm/ADT/SmallVector.h"
  36
  37 namespace llvm {
  38
  39 class MachineRegisterInfo;
  40 class TargetRegisterInfo;
  41
  42 class LiveVariables : public MachineFunctionPass {
  43 public:
  44   static char ID; // Pass identification, replacement for typeid
  45   LiveVariables() : MachineFunctionPass(&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 set of blocks in which the instruction is live
  50   /// throughout, the set of blocks in which the instruction is actually used,
  51   /// and the set of 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   /// There is one killing instruction, and AliveBlocks is empty.
  55   ///
  56   /// Otherwise, the value is live out of the block.  If the value is live
  57   /// throughout any blocks, these blocks are listed in AliveBlocks.  Blocks
  58   /// where the liveness range ends are not included in AliveBlocks, instead
  59   /// being captured by the Kills set.  In these blocks, the value is live into
  60   /// the block (unless the value is defined and killed in the same block) and
  61   /// lives until the specified instruction.  Note that there cannot ever be a
  62   /// value whose Kills set contains two instructions from the same basic block.
  63   ///
  64   /// PHI nodes complicate things a bit.  If a PHI node is the last user of a
  65   /// value in one of its predecessor blocks, it is not listed in the kills set,
  66   /// but does include the predecessor block in the AliveBlocks set (unless that
  67   /// block also defines the value).  This leads to the (perfectly sensical)
  68   /// situation where a value is defined in a block, and the last use is a phi
  69   /// node in the successor.  In this case, AliveBlocks is empty (the value is
  70   /// not live across any  blocks) and Kills is empty (phi nodes are not
  71   /// included). This is sensical because the value must be live to the end of
  72   /// the block, but is not live in any successor blocks.
  73   struct VarInfo {
  74     /// AliveBlocks - Set of blocks in 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     BitVector AliveBlocks;
  79
  80     /// UsedBlocks - Set of blocks in which this value is actually used. This
  81     /// is a bit set which uses the basic block number as an index.
  82     BitVector UsedBlocks;
  83
  84     /// NumUses - Number of uses of this register across the entire function.
  85     ///
  86     unsigned NumUses;
  87
  88     /// Kills - List of MachineInstruction's which are the last use of this
  89     /// virtual register (kill it) in their basic block.
  90     ///
  91     std::vector<MachineInstr*> Kills;
  92
  93     VarInfo() : NumUses(0) {}
  94
  95     /// removeKill - Delete a kill corresponding to the specified
  96     /// machine instruction. Returns true if there was a kill
  97     /// corresponding to this instruction, false otherwise.
  98     bool removeKill(MachineInstr *MI) {
  99       std::vector<MachineInstr*>::iterator
 100         I = std::find(Kills.begin(), Kills.end(), MI);
 101       if (I == Kills.end())
 102         return false;
 103       Kills.erase(I);
 104       return true;
 105     }
 106
 107     void dump() const;
 108   };
 109
 110 private:
 111   /// VirtRegInfo - This list is a mapping from virtual register number to
 112   /// variable information.  FirstVirtualRegister is subtracted from the virtual
 113   /// register number before indexing into this list.
 114   ///
 115   std::vector<VarInfo> VirtRegInfo;
 116
 117   /// ReservedRegisters - This vector keeps track of which registers
 118   /// are reserved register which are not allocatable by the target machine.
 119   /// We can not track liveness for values that are in this set.
 120   ///
 121   BitVector ReservedRegisters;
 122
 123 private:   // Intermediate data structures
 124   MachineFunction *MF;
 125
 126   MachineRegisterInfo* MRI;
 127
 128   const TargetRegisterInfo *TRI;
 129
 130   // PhysRegInfo - Keep track of which instruction was the last def of a
 131   // physical register. This is a purely local property, because all physical
 132   // register references are presumed dead across basic blocks.
 133   MachineInstr **PhysRegDef;
 134
 135   // PhysRegInfo - Keep track of which instruction was the last use of a
 136   // physical register. This is a purely local property, because all physical
 137   // register references are presumed dead across basic blocks.
 138   MachineInstr **PhysRegUse;
 139
 140   SmallVector<unsigned, 4> *PHIVarInfo;
 141
 142   // DistanceMap - Keep track the distance of a MI from the start of the
 143   // current basic block.
 144   DenseMap<MachineInstr*, unsigned> DistanceMap;
 145
 146   /// HandlePhysRegKill - Add kills of Reg and its sub-registers to the
 147   /// uses. Pay special attention to the sub-register uses which may come below
 148   /// the last use of the whole register.
 149   bool HandlePhysRegKill(unsigned Reg, MachineInstr *MI);
 150
 151   void HandlePhysRegUse(unsigned Reg, MachineInstr *MI);
 152   void HandlePhysRegDef(unsigned Reg, MachineInstr *MI);
 153
 154   /// FindLastPartialDef - Return the last partial def of the specified register.
 155   /// Also returns the sub-register that's defined.
 156   MachineInstr *FindLastPartialDef(unsigned Reg, unsigned &PartDefReg);
 157
 158   /// hasRegisterUseBelow - Return true if the specified register is used after
 159   /// the current instruction and before it's next definition.
 160   bool hasRegisterUseBelow(unsigned Reg, MachineBasicBlock::iterator I,
 161                            MachineBasicBlock *MBB);
 162
 163   /// analyzePHINodes - Gather information about the PHI nodes in here. In
 164   /// particular, we want to map the variable information of a virtual
 165   /// register which is used in a PHI node. We map that to the BB the vreg
 166   /// is coming from.
 167   void analyzePHINodes(const MachineFunction& Fn);
 168 public:
 169
 170   virtual bool runOnMachineFunction(MachineFunction &MF);
 171
 172   /// RegisterDefIsDead - Return true if the specified instruction defines the
 173   /// specified register, but that definition is dead.
 174   bool RegisterDefIsDead(MachineInstr *MI, unsigned Reg) const;
 175
 176   //===--------------------------------------------------------------------===//
 177   //  API to update live variable information
 178
 179   /// replaceKillInstruction - Update register kill info by replacing a kill
 180   /// instruction with a new one.
 181   void replaceKillInstruction(unsigned Reg, MachineInstr *OldMI,
 182                               MachineInstr *NewMI);
 183
 184   /// addVirtualRegisterKilled - Add information about the fact that the
 185   /// specified register is killed after being used by the specified
 186   /// instruction. If AddIfNotFound is true, add a implicit operand if it's
 187   /// not found.
 188   void addVirtualRegisterKilled(unsigned IncomingReg, MachineInstr *MI,
 189                                 bool AddIfNotFound = false) {
 190     if (MI->addRegisterKilled(IncomingReg, TRI, AddIfNotFound))
 191       getVarInfo(IncomingReg).Kills.push_back(MI);
 192   }
 193
 194   /// removeVirtualRegisterKilled - Remove the specified kill of the virtual
 195   /// register from the live variable information. Returns true if the
 196   /// variable was marked as killed by the specified instruction,
 197   /// false otherwise.
 198   bool removeVirtualRegisterKilled(unsigned reg, MachineInstr *MI) {
 199     if (!getVarInfo(reg).removeKill(MI))
 200       return false;
 201
 202     bool Removed = false;
 203     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 204       MachineOperand &MO = MI->getOperand(i);
 205       if (MO.isReg() && MO.isKill() && MO.getReg() == reg) {
 206         MO.setIsKill(false);
 207         Removed = true;
 208         break;
 209       }
 210     }
 211
 212     assert(Removed && "Register is not used by this instruction!");
 213     return true;
 214   }
 215
 216   /// removeVirtualRegistersKilled - Remove all killed info for the specified
 217   /// instruction.
 218   void removeVirtualRegistersKilled(MachineInstr *MI);
 219
 220   /// addVirtualRegisterDead - Add information about the fact that the specified
 221   /// register is dead after being used by the specified instruction. If
 222   /// AddIfNotFound is true, add a implicit operand if it's not found.
 223   void addVirtualRegisterDead(unsigned IncomingReg, MachineInstr *MI,
 224                               bool AddIfNotFound = false) {
 225     if (MI->addRegisterDead(IncomingReg, TRI, AddIfNotFound))
 226       getVarInfo(IncomingReg).Kills.push_back(MI);
 227   }
 228
 229   /// removeVirtualRegisterDead - Remove the specified kill of the virtual
 230   /// register from the live variable information. Returns true if the
 231   /// variable was marked dead at the specified instruction, false
 232   /// otherwise.
 233   bool removeVirtualRegisterDead(unsigned reg, MachineInstr *MI) {
 234     if (!getVarInfo(reg).removeKill(MI))
 235       return false;
 236
 237     bool Removed = false;
 238     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 239       MachineOperand &MO = MI->getOperand(i);
 240       if (MO.isReg() && MO.isDef() && MO.getReg() == reg) {
 241         MO.setIsDead(false);
 242         Removed = true;
 243         break;
 244       }
 245     }
 246     assert(Removed && "Register is not defined by this instruction!");
 247     return true;
 248   }
 249
 250   void getAnalysisUsage(AnalysisUsage &AU) const;
 251
 252   virtual void releaseMemory() {
 253     VirtRegInfo.clear();
 254   }
 255
 256   /// getVarInfo - Return the VarInfo structure for the specified VIRTUAL
 257   /// register.
 258   VarInfo &getVarInfo(unsigned RegIdx);
 259
 260   void MarkVirtRegAliveInBlock(VarInfo& VRInfo, MachineBasicBlock* DefBlock,
 261                                MachineBasicBlock *BB);
 262   void MarkVirtRegAliveInBlock(VarInfo& VRInfo, MachineBasicBlock* DefBlock,
 263                                MachineBasicBlock *BB,
 264                                std::vector<MachineBasicBlock*> &WorkList);
 265   void HandleVirtRegDef(unsigned reg, MachineInstr *MI);
 266   void HandleVirtRegUse(unsigned reg, MachineBasicBlock *MBB,
 267                         MachineInstr *MI);
 268 };
 269
 270 } // End llvm namespace
 271
 272 #endif