Oops, forgot to commit this file.
[oota-llvm.git] / include / llvm / CodeGen / LiveVariables.h
index e19a6c69dd7a994246db9bb103d919588a55d68d..8938330fad673f1e612c682a7abeb325e06f7585 100644 (file)
@@ -30,6 +30,9 @@
 #define LLVM_CODEGEN_LIVEVARIABLES_H
 
 #include "llvm/CodeGen/MachineFunctionPass.h"
+#include "llvm/ADT/BitVector.h"
+#include "llvm/ADT/SmallSet.h"
+#include "llvm/ADT/SmallVector.h"
 #include <map>
 
 namespace llvm {
@@ -38,6 +41,37 @@ class MRegisterInfo;
 
 class LiveVariables : public MachineFunctionPass {
 public:
+  static char ID; // Pass identification, replacement for typeid
+  LiveVariables() : MachineFunctionPass((intptr_t)&ID) {}
+
+  /// VarInfo - This represents the regions where a virtual register is live in
+  /// the program.  We represent this with three different pieces of
+  /// information: the instruction that uniquely defines the value, the set of
+  /// blocks the instruction is live into and live out of, and the set of 
+  /// non-phi instructions that are the last users of the value.
+  ///
+  /// In the common case where a value is defined and killed in the same block,
+  /// DefInst is the defining inst, there is one killing instruction, and 
+  /// AliveBlocks is empty.
+  ///
+  /// Otherwise, the value is live out of the block.  If the value is live
+  /// across any blocks, these blocks are listed in AliveBlocks.  Blocks where
+  /// the liveness range ends are not included in AliveBlocks, instead being
+  /// captured by the Kills set.  In these blocks, the value is live into the
+  /// block (unless the value is defined and killed in the same block) and lives
+  /// until the specified instruction.  Note that there cannot ever be a value
+  /// whose Kills set contains two instructions from the same basic block.
+  ///
+  /// PHI nodes complicate things a bit.  If a PHI node is the last user of a
+  /// value in one of its predecessor blocks, it is not listed in the kills set,
+  /// but does include the predecessor block in the AliveBlocks set (unless that
+  /// block also defines the value).  This leads to the (perfectly sensical)
+  /// situation where a value is defined in a block, and the last use is a phi
+  /// node in the successor.  In this case, DefInst will be the defining
+  /// instruction, AliveBlocks is empty (the value is not live across any 
+  /// blocks) and Kills is empty (phi nodes are not included).  This is sensical
+  /// because the value must be live to the end of the block, but is not live in
+  /// any successor blocks.
   struct VarInfo {
     /// DefInst - The machine instruction that defines this register.
     ///
@@ -47,14 +81,22 @@ public:
     /// through.  This is a bit set which uses the basic block number as an
     /// index.
     ///
-    std::vector<bool> AliveBlocks;
+    BitVector AliveBlocks;
+
+    /// UsedBlocks - Set of blocks of which this value is actually used. This
+    /// is a bit set which uses the basic block number as an index.
+    BitVector UsedBlocks;
+
+    /// NumUses - Number of uses of this register across the entire function.
+    ///
+    unsigned NumUses;
 
     /// Kills - List of MachineInstruction's which are the last use of this
     /// virtual register (kill it) in their basic block.
     ///
     std::vector<MachineInstr*> Kills;
 
-    VarInfo() : DefInst(0) {}
+    VarInfo() : DefInst(0), NumUses(0) {}
 
     /// removeKill - Delete a kill corresponding to the specified
     /// machine instruction. Returns true if there was a kill
@@ -79,91 +121,85 @@ private:
   ///
   std::vector<VarInfo> VirtRegInfo;
 
-  /// RegistersKilled - This map keeps track of all of the registers that
-  /// are dead immediately after an instruction reads its operands.  If an
-  /// instruction does not have an entry in this map, it kills no registers.
+  /// ReservedRegisters - This vector keeps track of which registers
+  /// are reserved register which are not allocatable by the target machine.
+  /// We can not track liveness for values that are in this set.
   ///
-  std::map<MachineInstr*, std::vector<unsigned> > RegistersKilled;
-
-  /// RegistersDead - This map keeps track of all of the registers that are
-  /// dead immediately after an instruction executes, which are not dead after
-  /// the operands are evaluated.  In practice, this only contains registers
-  /// which are defined by an instruction, but never used.
-  ///
-  std::map<MachineInstr*, std::vector<unsigned> > RegistersDead;
-  
-  /// Dummy - An always empty vector used for instructions without dead or
-  /// killed operands.
-  std::vector<unsigned> Dummy;
-
-  /// AllocatablePhysicalRegisters - This vector keeps track of which registers
-  /// are actually register allocatable by the target machine.  We can not track
-  /// liveness for values that are not in this set.
-  ///
-  std::vector<bool> AllocatablePhysicalRegisters;
+  BitVector ReservedRegisters;
 
 private:   // Intermediate data structures
+  MachineFunction *MF;
+
   const MRegisterInfo *RegInfo;
 
+  // PhysRegInfo - Keep track of which instruction was the last def/use of a
+  // physical register. This is a purely local property, because all physical
+  // register references as presumed dead across basic blocks.
   MachineInstr **PhysRegInfo;
+
+  // PhysRegUsed - Keep track whether the physical register has been used after
+  // its last definition. This is local property.
   bool          *PhysRegUsed;
 
+  // PhysRegPartUse - Keep track of which instruction was the last partial use
+  // of a physical register (e.g. on X86 a def of EAX followed by a use of AX).
+  // This is a purely local property.
+  MachineInstr **PhysRegPartUse;
+
+  // PhysRegPartDef - Keep track of a list of instructions which "partially"
+  // defined the physical register (e.g. on X86 AX partially defines EAX).
+  // These are turned into use/mod/write if there is a use of the register
+  // later in the same block. This is local property.
+  SmallVector<MachineInstr*, 4> *PhysRegPartDef;
+
+  SmallVector<unsigned, 4> *PHIVarInfo;
+
+  /// addRegisterKilled - We have determined MI kills a register. Look for the
+  /// operand that uses it and mark it as IsKill. If AddIfNotFound is true,
+  /// add a implicit operand if it's not found. Returns true if the operand
+  /// exists / is added.
+  bool addRegisterKilled(unsigned IncomingReg, MachineInstr *MI,
+                         bool AddIfNotFound = false);
+
+  /// addRegisterDead - We have determined MI defined a register without a use.
+  /// Look for the operand that defines it and mark it as IsDead. If
+  /// AddIfNotFound is true, add a implicit operand if it's not found. Returns
+  /// true if the operand exists / is added.
+  bool addRegisterDead(unsigned IncomingReg, MachineInstr *MI,
+                       bool AddIfNotFound = false);
+
+  void addRegisterKills(unsigned Reg, MachineInstr *MI,
+                        SmallSet<unsigned, 4> &SubKills);
+
+  /// HandlePhysRegKill - Add kills of Reg and its sub-registers to the
+  /// uses. Pay special attention to the sub-register uses which may come below
+  /// the last use of the whole register.
+  bool HandlePhysRegKill(unsigned Reg, MachineInstr *MI,
+                         SmallSet<unsigned, 4> &SubKills);
+  bool HandlePhysRegKill(unsigned Reg, MachineInstr *MI);
   void HandlePhysRegUse(unsigned Reg, MachineInstr *MI);
   void HandlePhysRegDef(unsigned Reg, MachineInstr *MI);
 
+  /// analyzePHINodes - Gather information about the PHI nodes in here. In
+  /// particular, we want to map the variable information of a virtual
+  /// register which is used in a PHI node. We map that to the BB the vreg
+  /// is coming from.
+  void analyzePHINodes(const MachineFunction& Fn);
 public:
 
   virtual bool runOnMachineFunction(MachineFunction &MF);
 
-  /// killed_iterator - Iterate over registers killed by a machine instruction
-  ///
-  typedef std::vector<unsigned>::iterator killed_iterator;
-
-  std::vector<unsigned> &getKillsVector(MachineInstr *MI) {
-    std::map<MachineInstr*, std::vector<unsigned> >::iterator I = 
-      RegistersKilled.find(MI);
-    return I != RegistersKilled.end() ? I->second : Dummy;
-  }
-  std::vector<unsigned> &getDeadDefsVector(MachineInstr *MI) {
-    std::map<MachineInstr*, std::vector<unsigned> >::iterator I = 
-      RegistersDead.find(MI);
-    return I != RegistersDead.end() ? I->second : Dummy;
-  }
-  
-    
-  /// killed_begin/end - Get access to the range of registers killed by a
-  /// machine instruction.
-  killed_iterator killed_begin(MachineInstr *MI) {
-    return getKillsVector(MI).begin();
-  }
-  killed_iterator killed_end(MachineInstr *MI) {
-    return getKillsVector(MI).end();
-  }
-  std::pair<killed_iterator, killed_iterator>
-  killed_range(MachineInstr *MI) {
-    std::vector<unsigned> &V = getKillsVector(MI);
-    return std::make_pair(V.begin(), V.end());
-  }
-
   /// KillsRegister - Return true if the specified instruction kills the
   /// specified register.
   bool KillsRegister(MachineInstr *MI, unsigned Reg) const;
   
-  killed_iterator dead_begin(MachineInstr *MI) {
-    return getDeadDefsVector(MI).begin();
-  }
-  killed_iterator dead_end(MachineInstr *MI) {
-    return getDeadDefsVector(MI).end();
-  }
-  std::pair<killed_iterator, killed_iterator>
-  dead_range(MachineInstr *MI) {
-    std::vector<unsigned> &V = getDeadDefsVector(MI);
-    return std::make_pair(V.begin(), V.end());
-  }
-  
   /// RegisterDefIsDead - Return true if the specified instruction defines the
   /// specified register, but that definition is dead.
   bool RegisterDefIsDead(MachineInstr *MI, unsigned Reg) const;
+
+  /// ModifiesRegister - Return true if the specified instruction modifies the
+  /// specified register.
+  bool ModifiesRegister(MachineInstr *MI, unsigned Reg) const;
   
   //===--------------------------------------------------------------------===//
   //  API to update live variable information
@@ -176,22 +212,13 @@ public:
 
   /// addVirtualRegisterKilled - Add information about the fact that the
   /// specified register is killed after being used by the specified
-  /// instruction.
-  ///
-  void addVirtualRegisterKilled(unsigned IncomingReg, MachineInstr *MI) {
-    std::vector<unsigned> &V = RegistersKilled[MI];
-    // Insert in a sorted order.
-    if (V.empty() || IncomingReg > V.back()) {
-      V.push_back(IncomingReg);
-    } else {
-      std::vector<unsigned>::iterator I = V.begin();
-      for (; *I < IncomingReg; ++I)
-        /*empty*/;
-      if (*I != IncomingReg)   // Don't insert duplicates.
-        V.insert(I, IncomingReg);
-    }
-    getVarInfo(IncomingReg).Kills.push_back(MI);
-  }
+  /// instruction. If AddIfNotFound is true, add a implicit operand if it's
+  /// not found.
+  void addVirtualRegisterKilled(unsigned IncomingReg, MachineInstr *MI,
+                                bool AddIfNotFound = false) {
+    if (addRegisterKilled(IncomingReg, MI, AddIfNotFound))
+      getVarInfo(IncomingReg).Kills.push_back(MI); 
+ }
 
   /// removeVirtualRegisterKilled - Remove the specified virtual
   /// register from the live variable information. Returns true if the
@@ -203,46 +230,31 @@ public:
     if (!getVarInfo(reg).removeKill(MI))
       return false;
 
-    std::vector<unsigned> &V = getKillsVector(MI);
-    for (unsigned i = 0, e = V.size(); i != e; ++i)
-      if (V[i] == reg) {
-        V.erase(V.begin()+i);
-        return true;
+    bool Removed = false;
+    for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
+      MachineOperand &MO = MI->getOperand(i);
+      if (MO.isRegister() && MO.isKill() && MO.getReg() == reg) {
+        MO.unsetIsKill();
+        Removed = true;
+        break;
       }
+    }
+
+    assert(Removed && "Register is not used by this instruction!");
     return true;
   }
 
   /// removeVirtualRegistersKilled - Remove all killed info for the specified
   /// instruction.
-  void removeVirtualRegistersKilled(MachineInstr *MI) {
-    std::map<MachineInstr*, std::vector<unsigned> >::iterator I = 
-      RegistersKilled.find(MI);
-    if (I != RegistersKilled.end()) {
-      std::vector<unsigned> &Regs = I->second;
-      for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
-        bool removed = getVarInfo(Regs[i]).removeKill(MI);
-        assert(removed && "kill not in register's VarInfo?");
-      }
-      RegistersKilled.erase(I);
-    }
-  }
-
+  void removeVirtualRegistersKilled(MachineInstr *MI);
+  
   /// addVirtualRegisterDead - Add information about the fact that the specified
-  /// register is dead after being used by the specified instruction.
-  ///
-  void addVirtualRegisterDead(unsigned IncomingReg, MachineInstr *MI) {
-    std::vector<unsigned> &V = RegistersDead[MI];
-    // Insert in a sorted order.
-    if (V.empty() || IncomingReg > V.back()) {
-      V.push_back(IncomingReg);
-    } else {
-      std::vector<unsigned>::iterator I = V.begin();
-      for (; *I < IncomingReg; ++I)
-        /*empty*/;
-      if (*I != IncomingReg)   // Don't insert duplicates.
-        V.insert(I, IncomingReg);
-    }
-    getVarInfo(IncomingReg).Kills.push_back(MI);
+  /// register is dead after being used by the specified instruction. If
+  /// AddIfNotFound is true, add a implicit operand if it's not found.
+  void addVirtualRegisterDead(unsigned IncomingReg, MachineInstr *MI,
+                              bool AddIfNotFound = false) {
+    if (addRegisterDead(IncomingReg, MI, AddIfNotFound))
+        getVarInfo(IncomingReg).Kills.push_back(MI);
   }
 
   /// removeVirtualRegisterDead - Remove the specified virtual
@@ -255,38 +267,29 @@ public:
     if (!getVarInfo(reg).removeKill(MI))
       return false;
 
-    std::vector<unsigned> &V = getDeadDefsVector(MI);
-    for (unsigned i = 0, e = V.size(); i != e; ++i)
-      if (V[i] == reg) {
-        V.erase(V.begin()+i);
-        return true;
+    bool Removed = false;
+    for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
+      MachineOperand &MO = MI->getOperand(i);
+      if (MO.isRegister() && MO.isDef() && MO.getReg() == reg) {
+        MO.unsetIsDead();
+        Removed = true;
+        break;
       }
-    return true;
-  }
-
-  /// removeVirtualRegistersDead - Remove all of the specified dead
-  /// registers from the live variable information.
-  void removeVirtualRegistersDead(MachineInstr *MI) {
-    std::map<MachineInstr*, std::vector<unsigned> >::iterator I = 
-      RegistersDead.find(MI);
-    if (I != RegistersDead.end()) {
-      std::vector<unsigned> &Regs = I->second;
-      for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
-        bool removed = getVarInfo(Regs[i]).removeKill(MI);
-        assert(removed && "kill not in register's VarInfo?");
-      }
-      RegistersDead.erase(I);
     }
+    assert(Removed && "Register is not defined by this instruction!");
+    return true;
   }
 
+  /// removeVirtualRegistersDead - Remove all of the dead registers for the
+  /// specified instruction from the live variable information.
+  void removeVirtualRegistersDead(MachineInstr *MI);
+  
   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
     AU.setPreservesAll();
   }
 
   virtual void releaseMemory() {
     VirtRegInfo.clear();
-    RegistersKilled.clear();
-    RegistersDead.clear();
   }
 
   /// getVarInfo - Return the VarInfo structure for the specified VIRTUAL
@@ -294,6 +297,8 @@ public:
   VarInfo &getVarInfo(unsigned RegIdx);
 
   void MarkVirtRegAliveInBlock(VarInfo &VRInfo, MachineBasicBlock *BB);
+  void MarkVirtRegAliveInBlock(VarInfo &VRInfo, MachineBasicBlock *BB,
+                               std::vector<MachineBasicBlock*> &WorkList);
   void HandleVirtRegUse(VarInfo &VRInfo, MachineBasicBlock *MBB,
                         MachineInstr *MI);
 };