Use MachineBasicBlock::transferSuccessors.
[oota-llvm.git] / include / llvm / CodeGen / LiveInterval.h
index f73cac18923ce3b8863cde70826749460865be68..b6f38dfc3575feab5665e0a73164eb32e0f739f7 100644 (file)
@@ -2,8 +2,8 @@
 //
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by the LLVM research group and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
 #define LLVM_CODEGEN_LIVEINTERVAL_H
 
 #include "llvm/ADT/SmallVector.h"
-#include "llvm/Support/Streams.h"
+#include "llvm/Support/Allocator.h"
 #include <iosfwd>
-#include <vector>
 #include <cassert>
 
 namespace llvm {
   class MachineInstr;
-  class MRegisterInfo;
+  class TargetRegisterInfo;
   struct LiveInterval;
 
   /// VNInfo - If the value number definition is undefined (e.g. phi
   /// merge point), it contains ~0u,x. If the value number is not in use, it
   /// contains ~1u,x to indicate that the value # is not used. 
-  ///   parent- LiveInterval parent.
   ///   def   - Instruction # of the definition.
-  ///   reg   - Source reg iff val# is defined by a copy; zero otherwise.
-  ///   kills - Instruction # of the kills. If a kill is an odd #, it means
-  ///           the kill is a phi join point.
+  ///         - or reg # of the definition if it's a stack slot liveinterval.
+  ///   copy  - Copy iff val# is defined by a copy; zero otherwise.
+  ///   hasPHIKill - One or more of the kills are PHI nodes.
+  ///   kills - Instruction # of the kills.
   struct VNInfo {
-    LiveInterval *parent;
     unsigned id;
     unsigned def;
-    unsigned reg;
+    MachineInstr *copy;
+    bool hasPHIKill;
     SmallVector<unsigned, 4> kills;
-    VNInfo() : parent(0), id(~1U), def(~1U), reg(0) {}
-    VNInfo(LiveInterval *p, unsigned i, unsigned d, unsigned r)
-      : parent(p), id(i), def(d), reg(r) {}
+    VNInfo() : id(~1U), def(~1U), copy(0), hasPHIKill(false) {}
+    VNInfo(unsigned i, unsigned d, MachineInstr *c)
+      : id(i), def(d), copy(c), hasPHIKill(false) {}
   };
 
   /// LiveRange structure - This represents a simple register range in the
@@ -102,16 +101,16 @@ namespace llvm {
     typedef SmallVector<LiveRange,4> Ranges;
     typedef SmallVector<VNInfo*,4> VNInfoList;
 
-    unsigned reg;        // the register of this interval
+    bool isSS;           // True if this represents a stack slot
+    unsigned reg;        // the register or stack slot of this interval
     unsigned preference; // preferred register to allocate for this interval
     float weight;        // weight of this interval
     Ranges ranges;       // the ranges in which this register is live
-    unsigned numvals;    // number of value#'s
     VNInfoList valnos;   // value#'s
 
   public:
-    LiveInterval(unsigned Reg, float Weight)
-      : reg(Reg), preference(0), weight(Weight), numvals(0) {
+    LiveInterval(unsigned Reg, float Weight, bool IsSS = false)
+      : isSS(IsSS), reg(Reg), preference(0), weight(Weight) {
     }
 
     typedef Ranges::iterator iterator;
@@ -130,15 +129,6 @@ namespace llvm {
     const_vni_iterator vni_begin() const { return valnos.begin(); }
     const_vni_iterator vni_end() const { return valnos.end(); }
 
-    ~LiveInterval() {
-      for (vni_iterator i = vni_begin(), e = vni_end(); i != e; ++i) {
-        VNInfo *VNI = *i;
-        if (VNI->parent == this)
-          delete VNI;
-      }
-      valnos.clear();
-    }
-
     /// advanceTo - Advance the specified iterator to point to the LiveRange
     /// containing the specified position, or end() if the position is past the
     /// end of the interval.  If no LiveRange contains this position, but the
@@ -151,39 +141,61 @@ namespace llvm {
       return I;
     }
 
-    bool containsOneValue() const { return numvals == 1; }
+    /// isStackSlot - Return true if this is a stack slot interval.
+    ///
+    bool isStackSlot() const { return isSS; }
 
-    unsigned getNumValNums() const { return numvals; }
+    /// getStackSlotIndex - Return stack slot index if this is a stack slot
+    /// interval.
+    int getStackSlotIndex() const {
+      assert(isStackSlot() && "Interval is not a stack slot interval!");
+      return reg;
+    }
+
+    bool containsOneValue() const { return valnos.size() == 1; }
+
+    unsigned getNumValNums() const { return (unsigned)valnos.size(); }
     
-    /// getFirstValNumInfo - Returns pointer to the first val#.
+    /// getValNumInfo - Returns pointer to the specified val#.
     ///
-    inline VNInfo *getFirstValNumInfo() {
-      return valnos.front();
+    inline VNInfo *getValNumInfo(unsigned ValNo) {
+      return valnos[ValNo];
     }
-    inline const VNInfo *getFirstValNumInfo() const {
-      return valnos.front();
+    inline const VNInfo *getValNumInfo(unsigned ValNo) const {
+      return valnos[ValNo];
     }
     
     /// copyValNumInfo - Copy the value number info for one value number to
     /// another.
-    void copyValNumInfo(VNInfo &DstValNo, VNInfo &SrcValNo) {
-      DstValNo.def = SrcValNo.def;
-      DstValNo.reg = SrcValNo.reg;
-      DstValNo.kills = SrcValNo.kills;
+    void copyValNumInfo(VNInfo *DstValNo, const VNInfo *SrcValNo) {
+      DstValNo->def = SrcValNo->def;
+      DstValNo->copy = SrcValNo->copy;
+      DstValNo->hasPHIKill = SrcValNo->hasPHIKill;
+      DstValNo->kills = SrcValNo->kills;
     }
 
     /// getNextValue - Create a new value number and return it.  MIIdx specifies
     /// the instruction that defines the value number.
-    VNInfo *getNextValue(unsigned MIIdx, unsigned SrcReg) {
-      VNInfo *VNI = new VNInfo(this, numvals++, MIIdx, SrcReg);
+    VNInfo *getNextValue(unsigned MIIdx, MachineInstr *CopyMI,
+                         BumpPtrAllocator &VNInfoAllocator) {
+#ifdef __GNUC__
+      unsigned Alignment = (unsigned)__alignof__(VNInfo);
+#else
+      // FIXME: ugly.
+      unsigned Alignment = 8;
+#endif
+      VNInfo *VNI =
+        static_cast<VNInfo*>(VNInfoAllocator.Allocate((unsigned)sizeof(VNInfo),
+                                                      Alignment));
+      new (VNI) VNInfo((unsigned)valnos.size(), MIIdx, CopyMI);
       valnos.push_back(VNI);
       return VNI;
     }
 
     /// addKillForValNum - Add a kill instruction index to the specified value
     /// number.
-    static void addKill(VNInfo &VNI, unsigned KillIdx) {
-      SmallVector<unsigned, 4> &kills = VNI.kills;
+    static void addKill(VNInfo *VNI, unsigned KillIdx) {
+      SmallVector<unsigned, 4> &kills = VNI->kills;
       if (kills.empty()) {
         kills.push_back(KillIdx);
       } else {
@@ -195,21 +207,22 @@ namespace llvm {
 
     /// addKills - Add a number of kills into the VNInfo kill vector. If this
     /// interval is live at a kill point, then the kill is not added.
-    void addKills(VNInfo &VNI, const SmallVector<unsigned, 4> &kills) {
-      for (unsigned i = 0, e = kills.size(); i != e; ++i) {
+    void addKills(VNInfo *VNI, const SmallVector<unsigned, 4> &kills) {
+      for (unsigned i = 0, e = static_cast<unsigned>(kills.size());
+           i != e; ++i) {
         unsigned KillIdx = kills[i];
-        if (!liveAt(KillIdx)) {
+        if (!liveBeforeAndAt(KillIdx)) {
           SmallVector<unsigned, 4>::iterator
-            I = std::lower_bound(VNI.kills.begin(), VNI.kills.end(), KillIdx);
-          VNI.kills.insert(I, KillIdx);
+            I = std::lower_bound(VNI->kills.begin(), VNI->kills.end(), KillIdx);
+          VNI->kills.insert(I, KillIdx);
         }
       }
     }
 
     /// removeKill - Remove the specified kill from the list of kills of
     /// the specified val#.
-    static bool removeKill(VNInfo &VNI, unsigned KillIdx) {
-      SmallVector<unsigned, 4> &kills = VNI.kills;
+    static bool removeKill(VNInfo *VNI, unsigned KillIdx) {
+      SmallVector<unsigned, 4> &kills = VNI->kills;
       SmallVector<unsigned, 4>::iterator
         I = std::lower_bound(kills.begin(), kills.end(), KillIdx);
       if (I != kills.end() && *I == KillIdx) {
@@ -221,14 +234,23 @@ namespace llvm {
 
     /// removeKills - Remove all the kills in specified range
     /// [Start, End] of the specified val#.
-    void removeKills(VNInfo &VNI, unsigned Start, unsigned End) {
-      SmallVector<unsigned, 4> &kills = VNI.kills;
+    void removeKills(VNInfo *VNI, unsigned Start, unsigned End) {
+      SmallVector<unsigned, 4> &kills = VNI->kills;
       SmallVector<unsigned, 4>::iterator
         I = std::lower_bound(kills.begin(), kills.end(), Start);
       SmallVector<unsigned, 4>::iterator
         E = std::upper_bound(kills.begin(), kills.end(), End);
       kills.erase(I, E);
     }
+
+    /// isKill - Return true if the specified index is a kill of the
+    /// specified val#.
+    bool isKill(const VNInfo *VNI, unsigned KillIdx) const {
+      const SmallVector<unsigned, 4> &kills = VNI->kills;
+      SmallVector<unsigned, 4>::const_iterator
+        I = std::lower_bound(kills.begin(), kills.end(), KillIdx);
+      return I != kills.end() && *I == KillIdx;
+    }
     
     /// MergeValueNumberInto - This method is called when two value nubmers
     /// are found to be equivalent.  This eliminates V1, replacing all
@@ -238,28 +260,44 @@ namespace llvm {
 
     /// MergeInClobberRanges - For any live ranges that are not defined in the
     /// current interval, but are defined in the Clobbers interval, mark them
-    /// used with an unknown definition value.
-    void MergeInClobberRanges(const LiveInterval &Clobbers);
-
-    
-    /// MergeRangesInAsValue - Merge all of the intervals in RHS into this live
-    /// interval as the specified value number.  The LiveRanges in RHS are
-    /// allowed to overlap with LiveRanges in the current interval, but only if
-    /// the overlapping LiveRanges have the specified value number.
+    /// used with an unknown definition value. Caller must pass in reference to
+    /// VNInfoAllocator since it will create a new val#.
+    void MergeInClobberRanges(const LiveInterval &Clobbers,
+                              BumpPtrAllocator &VNInfoAllocator);
+
+    /// MergeValueInAsValue - Merge all of the live ranges of a specific val#
+    /// in RHS into this live interval as the specified value number.
+    /// The LiveRanges in RHS are allowed to overlap with LiveRanges in the
+    /// current interval, it will replace the value numbers of the overlaped
+    /// live ranges with the specified value number.
     void MergeRangesInAsValue(const LiveInterval &RHS, VNInfo *LHSValNo);
+
+    /// MergeValueInAsValue - Merge all of the live ranges of a specific val#
+    /// in RHS into this live interval as the specified value number.
+    /// The LiveRanges in RHS are allowed to overlap with LiveRanges in the
+    /// current interval, but only if the overlapping LiveRanges have the
+    /// specified value number.
+    void MergeValueInAsValue(const LiveInterval &RHS,
+                             const VNInfo *RHSValNo, VNInfo *LHSValNo);
+
+    /// Copy - Copy the specified live interval. This copies all the fields
+    /// except for the register of the interval.
+    void Copy(const LiveInterval &RHS, BumpPtrAllocator &VNInfoAllocator);
     
     bool empty() const { return ranges.empty(); }
 
     /// beginNumber - Return the lowest numbered slot covered by interval.
     unsigned beginNumber() const {
-      assert(!empty() && "empty interval for register");
+      if (empty())
+        return 0;
       return ranges.front().start;
     }
 
     /// endNumber - return the maximum point of the interval of the whole,
     /// exclusive.
     unsigned endNumber() const {
-      assert(!empty() && "empty interval for register");
+      if (empty())
+        return 0;
       return ranges.back().end;
     }
 
@@ -269,6 +307,11 @@ namespace llvm {
 
     bool liveAt(unsigned index) const;
 
+    // liveBeforeAndAt - Check if the interval is live at the index and the
+    // index just before it. If index is liveAt, check if it starts a new live
+    // range.If it does, then check if the previous live range ends at index-1.
+    bool liveBeforeAndAt(unsigned index) const;
+
     /// getLiveRangeContaining - Return the live range that contains the
     /// specified index, or null if there is none.
     const LiveRange *getLiveRangeContaining(unsigned Idx) const {
@@ -283,13 +326,12 @@ namespace llvm {
     /// FindLiveRangeContaining - Return an iterator to the live range that
     /// contains the specified index, or end() if there is none.
     iterator FindLiveRangeContaining(unsigned Idx);
-    
-    /// getOverlapingRanges - Given another live interval which is defined as a
-    /// copy from this one, return a list of all of the live ranges where the
-    /// two overlap and have different value numbers.
-    void getOverlapingRanges(const LiveInterval &Other, unsigned CopyIdx,
-                             std::vector<LiveRange*> &Ranges);
 
+    /// findDefinedVNInfo - Find the VNInfo that's defined at the specified
+    /// index (register interval) or defined by the specified register (stack
+    /// inteval).
+    VNInfo *findDefinedVNInfo(unsigned DefIdxOrReg) const;
+    
     /// overlaps - Return true if the intersection of the two live intervals is
     /// not empty.
     bool overlaps(const LiveInterval& other) const {
@@ -311,17 +353,22 @@ namespace llvm {
     /// join - Join two live intervals (this, and other) together.  This applies
     /// mappings to the value numbers in the LHS/RHS intervals as specified.  If
     /// the intervals are not joinable, this aborts.
-    void join(LiveInterval &Other, int *ValNoAssignments,
-              int *RHSValNoAssignments, SmallVector<VNInfo*, 16> &NewVNInfo);
+    void join(LiveInterval &Other, const int *ValNoAssignments,
+              const int *RHSValNoAssignments,
+              SmallVector<VNInfo*, 16> &NewVNInfo);
 
     /// removeRange - Remove the specified range from this interval.  Note that
     /// the range must already be in this interval in its entirety.
-    void removeRange(unsigned Start, unsigned End);
+    void removeRange(unsigned Start, unsigned End, bool RemoveDeadValNo = false);
 
-    void removeRange(LiveRange LR) {
-      removeRange(LR.start, LR.end);
+    void removeRange(LiveRange LR, bool RemoveDeadValNo = false) {
+      removeRange(LR.start, LR.end, RemoveDeadValNo);
     }
 
+    /// removeValNo - Remove all the ranges defined by the specified value#.
+    /// Also remove the value# from value# list.
+    void removeValNo(VNInfo *ValNo);
+
     /// getSize - Returns the sum of sizes of all the LiveRange's.
     ///
     unsigned getSize() const;
@@ -330,9 +377,9 @@ namespace llvm {
       return beginNumber() < other.beginNumber();
     }
 
-    void print(std::ostream &OS, const MRegisterInfo *MRI = 0) const;
-    void print(std::ostream *OS, const MRegisterInfo *MRI = 0) const {
-      if (OS) print(*OS, MRI);
+    void print(std::ostream &OS, const TargetRegisterInfo *TRI = 0) const;
+    void print(std::ostream *OS, const TargetRegisterInfo *TRI = 0) const {
+      if (OS) print(*OS, TRI);
     }
     void dump() const;