in builds without asserts we do not need to allocate the Next pointer in "ghostly...
[oota-llvm.git] / include / llvm / CodeGen / LiveInterval.h
index 5d9db57da01727019bd14c6152428bbe3d8ea6c8..1e8202e5f4bfaed5c9c5f8ea08de64e27554b2c5 100644 (file)
@@ -2,14 +2,14 @@
 //
 //                     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.
 //
 //===----------------------------------------------------------------------===//
 //
 // This file implements the LiveRange and LiveInterval classes.  Given some
 // numbering of each the machine instructions an interval [i, j) is said to be a
-// live interval for register v if there is no instruction with number j' > j
+// live interval for register v if there is no instruction with number j' >= j
 // such that v is live at j' and there is no instruction with number i' < i such
 // that v is live at i'. In this implementation intervals can have holes,
 // i.e. an interval might look like [1,20), [50,65), [1000,1001).  Each
 #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. 
+  ///   def   - Instruction # of the definition.
+  ///         - 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.
+  ///   redefByEC - Re-defined by early clobber somewhere during the live range.
+  ///   kills - Instruction # of the kills.
+  struct VNInfo {
+    unsigned id;
+    unsigned def;
+    MachineInstr *copy;
+    bool hasPHIKill : 1;
+    bool redefByEC : 1;
+    SmallVector<unsigned, 4> kills;
+    VNInfo()
+      : id(~1U), def(~1U), copy(0), hasPHIKill(false), redefByEC(false) {}
+    VNInfo(unsigned i, unsigned d, MachineInstr *c)
+      : id(i), def(d), copy(c), hasPHIKill(false), redefByEC(false) {}
+  };
 
   /// LiveRange structure - This represents a simple register range in the
   /// program, with an inclusive start point and an exclusive end point.
@@ -37,9 +59,9 @@ namespace llvm {
   struct LiveRange {
     unsigned start;  // Start point of the interval (inclusive)
     unsigned end;    // End point of the interval (exclusive)
-    unsigned ValId;  // identifier for the value contained in this interval.
+    VNInfo *valno;   // identifier for the value contained in this interval.
 
-    LiveRange(unsigned S, unsigned E, unsigned V) : start(S), end(E), ValId(V) {
+    LiveRange(unsigned S, unsigned E, VNInfo *V) : start(S), end(E), valno(V) {
       assert(S < E && "Cannot create empty or backwards range");
     }
 
@@ -80,28 +102,20 @@ namespace llvm {
   /// state.
   struct LiveInterval {
     typedef SmallVector<LiveRange,4> Ranges;
-    unsigned reg;        // the register of this interval
-    unsigned preference; // preferred register to allocate for this interval
+    typedef SmallVector<VNInfo*,4> VNInfoList;
+
+    unsigned reg;        // the register or stack slot of this interval
+                         // if the top bits is set, it represents a stack slot.
     float weight;        // weight of this interval
-    MachineInstr* remat; // definition if the definition rematerializable
+    unsigned short preference; // preferred register for this interval
     Ranges ranges;       // the ranges in which this register is live
+    VNInfoList valnos;   // value#'s
 
-    /// ValueNumberInfo - 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. 
-    struct VNInfo {
-      unsigned def;  // instruction # of the definition
-      unsigned reg;  // src reg: non-zero iff val# is defined by a copy
-      SmallVector<unsigned, 4> kills;  // instruction #s of the kills
-      VNInfo() : def(~1U), reg(0) {};
-      VNInfo(unsigned d, unsigned r) : def(d), reg(r) {};
-    };
-  private:
-    SmallVector<VNInfo, 4> ValueNumberInfo;
   public:
-
-    LiveInterval(unsigned Reg, float Weight)
-      : reg(Reg), preference(0), weight(Weight), remat(NULL) {
+    LiveInterval(unsigned Reg, float Weight, bool IsSS = false)
+      : reg(Reg), weight(Weight), preference(0)  {
+      if (IsSS)
+        reg = reg | (1U << (sizeof(unsigned)*8-1));
     }
 
     typedef Ranges::iterator iterator;
@@ -112,6 +126,13 @@ namespace llvm {
     const_iterator begin() const { return ranges.begin(); }
     const_iterator end() const  { return ranges.end(); }
 
+    typedef VNInfoList::iterator vni_iterator;
+    vni_iterator vni_begin() { return valnos.begin(); }
+    vni_iterator vni_end() { return valnos.end(); }
+
+    typedef VNInfoList::const_iterator const_vni_iterator;
+    const_vni_iterator vni_begin() const { return valnos.begin(); }
+    const_vni_iterator vni_end() const { return valnos.end(); }
 
     /// advanceTo - Advance the specified iterator to point to the LiveRange
     /// containing the specified position, or end() if the position is past the
@@ -124,67 +145,77 @@ namespace llvm {
       while (I->end <= Pos) ++I;
       return I;
     }
-
-    void swap(LiveInterval& other) {
-      std::swap(reg, other.reg);
-      std::swap(weight, other.weight);
-      std::swap(remat, other.remat);
-      std::swap(ranges, other.ranges);
-      std::swap(ValueNumberInfo, other.ValueNumberInfo);
+    
+    void clear() {
+      while (!valnos.empty()) {
+        VNInfo *VNI = valnos.back();
+        valnos.pop_back();
+        VNI->~VNInfo();
+      }
+      
+      ranges.clear();
     }
 
-    bool containsOneValue() const { return ValueNumberInfo.size() == 1; }
-
-    unsigned getNumValNums() const { return ValueNumberInfo.size(); }
-    
-    /// getNextValue - Create a new value number and return it.  MIIdx specifies
-    /// the instruction that defines the value number.
-    unsigned getNextValue(unsigned MIIdx, unsigned SrcReg) {
-      ValueNumberInfo.push_back(VNInfo(MIIdx, SrcReg));
-      return ValueNumberInfo.size()-1;
+    /// isStackSlot - Return true if this is a stack slot interval.
+    ///
+    bool isStackSlot() const {
+      return reg & (1U << (sizeof(unsigned)*8-1));
     }
-    
-    /// getDefForValNum - Return the machine instruction index that defines the
-    /// specified value number.
-    unsigned getDefForValNum(unsigned ValNo) const {
-      assert(ValNo < ValueNumberInfo.size());
-      return ValueNumberInfo[ValNo].def;
+
+    /// 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 & ~(1U << (sizeof(unsigned)*8-1));
     }
+
+    bool hasAtLeastOneValue() const { return !valnos.empty(); }
+
+    bool containsOneValue() const { return valnos.size() == 1; }
+
+    unsigned getNumValNums() const { return (unsigned)valnos.size(); }
     
-    /// getSrcRegForValNum - If the machine instruction that defines the
-    /// specified value number is a copy, returns the source register. Otherwise,
-    /// returns zero.
-    unsigned getSrcRegForValNum(unsigned ValNo) const {
-      assert(ValNo < ValueNumberInfo.size());
-      return ValueNumberInfo[ValNo].reg;
+    /// getValNumInfo - Returns pointer to the specified val#.
+    ///
+    inline VNInfo *getValNumInfo(unsigned ValNo) {
+      return valnos[ValNo];
     }
-
-    /// setDefForValNum - Set the machine instruction index that defines the
-    /// specified value number. 
-    void setDefForValNum(unsigned ValNo, unsigned NewDef) {
-      assert(ValNo < ValueNumberInfo.size());
-      ValueNumberInfo[ValNo].def = NewDef;
+    inline const VNInfo *getValNumInfo(unsigned ValNo) const {
+      return valnos[ValNo];
     }
     
-    /// setSrcRegForValNum - Set the source register of the specified value
-    /// number. 
-    void setSrcRegForValNum(unsigned ValNo, unsigned NewReg) {
-      assert(ValNo < ValueNumberInfo.size());
-      ValueNumberInfo[ValNo].reg = NewReg;
+    /// copyValNumInfo - Copy the value number info for one value number to
+    /// another.
+    void copyValNumInfo(VNInfo *DstValNo, const VNInfo *SrcValNo) {
+      DstValNo->def = SrcValNo->def;
+      DstValNo->copy = SrcValNo->copy;
+      DstValNo->hasPHIKill = SrcValNo->hasPHIKill;
+      DstValNo->redefByEC = SrcValNo->redefByEC;
+      DstValNo->kills = SrcValNo->kills;
     }
 
-    /// getKillsForValNum - Return the kill instruction indexes of the specified
-    /// value number.
-    const SmallVector<unsigned, 4> &getKillsForValNum(unsigned ValNo) const {
-      assert(ValNo < ValueNumberInfo.size());
-      return ValueNumberInfo[ValNo].kills;
+    /// getNextValue - Create a new value number and return it.  MIIdx specifies
+    /// the instruction that defines the value number.
+    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
+    /// addKill - Add a kill instruction index to the specified value
     /// number.
-    void addKillForValNum(unsigned ValNo, unsigned KillIdx) {
-      assert(ValNo < ValueNumberInfo.size());
-      SmallVector<unsigned, 4> &kills = ValueNumberInfo[ValNo].kills;
+    static void addKill(VNInfo *VNI, unsigned KillIdx) {
+      SmallVector<unsigned, 4> &kills = VNI->kills;
       if (kills.empty()) {
         kills.push_back(KillIdx);
       } else {
@@ -196,40 +227,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);
         }
       }
     }
 
-    /// addKillsForValNum - Add a number of kills into the kills vector of
-    /// the specified value number.
-    void addKillsForValNum(unsigned ValNo,
-                           const SmallVector<unsigned, 4> &kills) {
-      addKills(ValueNumberInfo[ValNo], kills);
-    }
-
-    /// isKillForValNum - Returns true if KillIdx is a kill of the specified
-    /// val#.
-    bool isKillForValNum(unsigned ValNo, unsigned KillIdx) const {
-      assert(ValNo < ValueNumberInfo.size());
-      const SmallVector<unsigned, 4> &kills = ValueNumberInfo[ValNo].kills;
-      SmallVector<unsigned, 4>::const_iterator
-        I = std::lower_bound(kills.begin(), kills.end(), KillIdx);
-      if (I == kills.end())
-        return false;
-      return *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) {
@@ -239,18 +252,10 @@ namespace llvm {
       return false;
     }
 
-    /// removeKillForValNum - Remove the specified kill from the list of kills
-    /// of the specified val#.
-    bool removeKillForValNum(unsigned ValNo, unsigned KillIdx) {
-      assert(ValNo < ValueNumberInfo.size());
-      return removeKill(ValueNumberInfo[ValNo], KillIdx);
-    }
-
-    /// removeKillForValNum - Remove all the kills in specified range
+    /// removeKills - Remove all the kills in specified range
     /// [Start, End] of the specified val#.
-    void removeKillForValNum(unsigned ValNo, unsigned Start, unsigned End) {
-      assert(ValNo < ValueNumberInfo.size());
-      SmallVector<unsigned, 4> &kills = ValueNumberInfo[ValNo].kills;
+    static 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
@@ -258,80 +263,72 @@ namespace llvm {
       kills.erase(I, E);
     }
 
-    /// replaceKill - Replace a kill index of the specified value# with a new
-    /// kill. Returns true if OldKill was indeed a kill point.
-    static bool replaceKill(VNInfo &VNI, unsigned OldKill, unsigned NewKill) {
-      SmallVector<unsigned, 4> &kills = VNI.kills;
-      SmallVector<unsigned, 4>::iterator
-        I = std::lower_bound(kills.begin(), kills.end(), OldKill);
-      if (I != kills.end() && *I == OldKill) {
-        *I = NewKill;
-        return true;
-      }
-      return false;
+    /// isKill - Return true if the specified index is a kill of the
+    /// specified val#.
+    static bool isKill(const VNInfo *VNI, unsigned KillIdx) {
+      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;
     }
 
-    /// replaceKillForValNum - Replace a kill index of the specified value# with
-    /// a new kill. Returns true if OldKill was indeed a kill point.
-    bool replaceKillForValNum(unsigned ValNo, unsigned OldKill,
-                              unsigned NewKill) {
-      assert(ValNo < ValueNumberInfo.size());
-      return replaceKill(ValueNumberInfo[ValNo], OldKill, NewKill);
-    }
-    
-    /// getValNumInfo - Returns a copy of the specified val#.
-    ///
-    VNInfo getValNumInfo(unsigned ValNo) const {
-      assert(ValNo < ValueNumberInfo.size());
-      return ValueNumberInfo[ValNo];
+    /// isOnlyLROfValNo - Return true if the specified live range is the only
+    /// one defined by the its val#.
+    bool isOnlyLROfValNo( const LiveRange *LR) {
+      for (const_iterator I = begin(), E = end(); I != E; ++I) {
+        const LiveRange *Tmp = I;
+        if (Tmp != LR && Tmp->valno == LR->valno)
+          return false;
+      }
+      return true;
     }
     
-    /// setValNumInfo - Change the value number info for the specified
-    /// value number.
-    void setValNumInfo(unsigned ValNo, const VNInfo &I) {
-      ValueNumberInfo[ValNo] = I;
-    }
-
-    /// copyValNumInfo - Copy the value number info for one value number to
-    /// another.
-    void copyValNumInfo(unsigned DstValNo, unsigned SrcValNo) {
-      ValueNumberInfo[DstValNo] = ValueNumberInfo[SrcValNo];
-    }
-    void copyValNumInfo(unsigned DstValNo, const LiveInterval &SrcLI,
-                        unsigned SrcValNo) {
-      ValueNumberInfo[DstValNo] = SrcLI.ValueNumberInfo[SrcValNo];
-    }
-
     /// MergeValueNumberInto - This method is called when two value nubmers
     /// are found to be equivalent.  This eliminates V1, replacing all
     /// LiveRanges with the V1 value number with the V2 value number.  This can
     /// cause merging of V1/V2 values numbers and compaction of the value space.
-    void MergeValueNumberInto(unsigned V1, unsigned V2);
+    VNInfo* MergeValueNumberInto(VNInfo *V1, VNInfo *V2);
 
     /// 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);
+    /// 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);
 
-    
-    /// 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.
-    void MergeRangesInAsValue(const LiveInterval &RHS, unsigned 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;
     }
 
@@ -341,6 +338,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 {
@@ -355,13 +357,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 {
@@ -383,18 +384,26 @@ 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> &NewValueNumberInfo);
+    void join(LiveInterval &Other, const int *ValNoAssignments,
+              const int *RHSValNoAssignments,
+              SmallVector<VNInfo*, 16> &NewVNInfo);
+
+    /// isInOneLiveRange - Return true if the range specified is entirely in the
+    /// a single LiveRange of the live interval.
+    bool isInOneLiveRange(unsigned Start, unsigned End);
 
     /// 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);
+    /// the range must be a single LiveRange in its entirety.
+    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;
@@ -403,9 +412,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;