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