include/llvm/CodeGen/LiveInterval.h

   1 //===-- llvm/CodeGen/LiveInterval.h - Interval representation ---*- 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 LiveRange and LiveInterval classes.  Given some
  11 // numbering of each the machine instructions an interval [i, j) is said to be a
  12 // live interval for register v if there is no instruction with number j' >= j
  13 // such that v is live at j' and there is no instruction with number i' < i such
  14 // that v is live at i'. In this implementation intervals can have holes,
  15 // i.e. an interval might look like [1,20), [50,65), [1000,1001).  Each
  16 // individual range is represented as an instance of LiveRange, and the whole
  17 // interval is represented as an instance of LiveInterval.
  18 //
  19 //===----------------------------------------------------------------------===//
  20
  21 #ifndef LLVM_CODEGEN_LIVEINTERVAL_H
  22 #define LLVM_CODEGEN_LIVEINTERVAL_H
  23
  24 #include "llvm/ADT/IntEqClasses.h"
  25 #include "llvm/Support/Allocator.h"
  26 #include "llvm/Support/AlignOf.h"
  27 #include "llvm/CodeGen/SlotIndexes.h"
  28 #include <cassert>
  29 #include <climits>
  30
  31 namespace llvm {
  32   class LiveIntervals;
  33   class MachineInstr;
  34   class MachineRegisterInfo;
  35   class TargetRegisterInfo;
  36   class raw_ostream;
  37
  38   /// VNInfo - Value Number Information.
  39   /// This class holds information about a machine level values, including
  40   /// definition and use points.
  41   ///
  42   class VNInfo {
  43   private:
  44     enum {
  45       HAS_PHI_KILL    = 1,
  46       IS_PHI_DEF      = 1 << 1,
  47       IS_UNUSED       = 1 << 2
  48     };
  49
  50     unsigned char flags;
  51
  52   public:
  53     typedef BumpPtrAllocator Allocator;
  54
  55     /// The ID number of this value.
  56     unsigned id;
  57
  58     /// The index of the defining instruction.
  59     SlotIndex def;
  60
  61     /// VNInfo constructor.
  62     VNInfo(unsigned i, SlotIndex d)
  63       : flags(0), id(i), def(d)
  64     { }
  65
  66     /// VNInfo construtor, copies values from orig, except for the value number.
  67     VNInfo(unsigned i, const VNInfo &orig)
  68       : flags(orig.flags), id(i), def(orig.def)
  69     { }
  70
  71     /// Copy from the parameter into this VNInfo.
  72     void copyFrom(VNInfo &src) {
  73       flags = src.flags;
  74       def = src.def;
  75     }
  76
  77     /// Used for copying value number info.
  78     unsigned getFlags() const { return flags; }
  79     void setFlags(unsigned flags) { this->flags = flags; }
  80
  81     /// Merge flags from another VNInfo
  82     void mergeFlags(const VNInfo *VNI) {
  83       flags = (flags | VNI->flags) & ~IS_UNUSED;
  84     }
  85
  86     /// Returns true if one or more kills are PHI nodes.
  87     /// Obsolete, do not use!
  88     bool hasPHIKill() const { return flags & HAS_PHI_KILL; }
  89     /// Set the PHI kill flag on this value.
  90     void setHasPHIKill(bool hasKill) {
  91       if (hasKill)
  92         flags |= HAS_PHI_KILL;
  93       else
  94         flags &= ~HAS_PHI_KILL;
  95     }
  96
  97     /// Returns true if this value is defined by a PHI instruction (or was,
  98     /// PHI instrucions may have been eliminated).
  99     bool isPHIDef() const { return flags & IS_PHI_DEF; }
 100     /// Set the "phi def" flag on this value.
 101     void setIsPHIDef(bool phiDef) {
 102       if (phiDef)
 103         flags |= IS_PHI_DEF;
 104       else
 105         flags &= ~IS_PHI_DEF;
 106     }
 107
 108     /// Returns true if this value is unused.
 109     bool isUnused() const { return flags & IS_UNUSED; }
 110     /// Set the "is unused" flag on this value.
 111     void setIsUnused(bool unused) {
 112       if (unused)
 113         flags |= IS_UNUSED;
 114       else
 115         flags &= ~IS_UNUSED;
 116     }
 117   };
 118
 119   /// LiveRange structure - This represents a simple register range in the
 120   /// program, with an inclusive start point and an exclusive end point.
 121   /// These ranges are rendered as [start,end).
 122   struct LiveRange {
 123     SlotIndex start;  // Start point of the interval (inclusive)
 124     SlotIndex end;    // End point of the interval (exclusive)
 125     VNInfo *valno;   // identifier for the value contained in this interval.
 126
 127     LiveRange(SlotIndex S, SlotIndex E, VNInfo *V)
 128       : start(S), end(E), valno(V) {
 129
 130       assert(S < E && "Cannot create empty or backwards range");
 131     }
 132
 133     /// contains - Return true if the index is covered by this range.
 134     ///
 135     bool contains(SlotIndex I) const {
 136       return start <= I && I < end;
 137     }
 138
 139     /// containsRange - Return true if the given range, [S, E), is covered by
 140     /// this range.
 141     bool containsRange(SlotIndex S, SlotIndex E) const {
 142       assert((S < E) && "Backwards interval?");
 143       return (start <= S && S < end) && (start < E && E <= end);
 144     }
 145
 146     bool operator<(const LiveRange &LR) const {
 147       return start < LR.start || (start == LR.start && end < LR.end);
 148     }
 149     bool operator==(const LiveRange &LR) const {
 150       return start == LR.start && end == LR.end;
 151     }
 152
 153     void dump() const;
 154     void print(raw_ostream &os) const;
 155
 156   private:
 157     LiveRange(); // DO NOT IMPLEMENT
 158   };
 159
 160   template <> struct isPodLike<LiveRange> { static const bool value = true; };
 161
 162   raw_ostream& operator<<(raw_ostream& os, const LiveRange &LR);
 163
 164
 165   inline bool operator<(SlotIndex V, const LiveRange &LR) {
 166     return V < LR.start;
 167   }
 168
 169   inline bool operator<(const LiveRange &LR, SlotIndex V) {
 170     return LR.start < V;
 171   }
 172
 173   /// LiveInterval - This class represents some number of live ranges for a
 174   /// register or value.  This class also contains a bit of register allocator
 175   /// state.
 176   class LiveInterval {
 177   public:
 178
 179     typedef SmallVector<LiveRange,4> Ranges;
 180     typedef SmallVector<VNInfo*,4> VNInfoList;
 181
 182     const unsigned reg;  // the register or stack slot of this interval.
 183     float weight;        // weight of this interval
 184     Ranges ranges;       // the ranges in which this register is live
 185     VNInfoList valnos;   // value#'s
 186
 187     struct InstrSlots {
 188       enum {
 189         LOAD  = 0,
 190         USE   = 1,
 191         DEF   = 2,
 192         STORE = 3,
 193         NUM   = 4
 194       };
 195
 196     };
 197
 198     LiveInterval(unsigned Reg, float Weight)
 199       : reg(Reg), weight(Weight) {}
 200
 201     typedef Ranges::iterator iterator;
 202     iterator begin() { return ranges.begin(); }
 203     iterator end()   { return ranges.end(); }
 204
 205     typedef Ranges::const_iterator const_iterator;
 206     const_iterator begin() const { return ranges.begin(); }
 207     const_iterator end() const  { return ranges.end(); }
 208
 209     typedef VNInfoList::iterator vni_iterator;
 210     vni_iterator vni_begin() { return valnos.begin(); }
 211     vni_iterator vni_end() { return valnos.end(); }
 212
 213     typedef VNInfoList::const_iterator const_vni_iterator;
 214     const_vni_iterator vni_begin() const { return valnos.begin(); }
 215     const_vni_iterator vni_end() const { return valnos.end(); }
 216
 217     /// advanceTo - Advance the specified iterator to point to the LiveRange
 218     /// containing the specified position, or end() if the position is past the
 219     /// end of the interval.  If no LiveRange contains this position, but the
 220     /// position is in a hole, this method returns an iterator pointing to the
 221     /// LiveRange immediately after the hole.
 222     iterator advanceTo(iterator I, SlotIndex Pos) {
 223       assert(I != end());
 224       if (Pos >= endIndex())
 225         return end();
 226       while (I->end <= Pos) ++I;
 227       return I;
 228     }
 229
 230     /// find - Return an iterator pointing to the first range that ends after
 231     /// Pos, or end(). This is the same as advanceTo(begin(), Pos), but faster
 232     /// when searching large intervals.
 233     ///
 234     /// If Pos is contained in a LiveRange, that range is returned.
 235     /// If Pos is in a hole, the following LiveRange is returned.
 236     /// If Pos is beyond endIndex, end() is returned.
 237     iterator find(SlotIndex Pos);
 238
 239     const_iterator find(SlotIndex Pos) const {
 240       return const_cast<LiveInterval*>(this)->find(Pos);
 241     }
 242
 243     void clear() {
 244       valnos.clear();
 245       ranges.clear();
 246     }
 247
 248     bool hasAtLeastOneValue() const { return !valnos.empty(); }
 249
 250     bool containsOneValue() const { return valnos.size() == 1; }
 251
 252     unsigned getNumValNums() const { return (unsigned)valnos.size(); }
 253
 254     /// getValNumInfo - Returns pointer to the specified val#.
 255     ///
 256     inline VNInfo *getValNumInfo(unsigned ValNo) {
 257       return valnos[ValNo];
 258     }
 259     inline const VNInfo *getValNumInfo(unsigned ValNo) const {
 260       return valnos[ValNo];
 261     }
 262
 263     /// containsValue - Returns true if VNI belongs to this interval.
 264     bool containsValue(const VNInfo *VNI) const {
 265       return VNI && VNI->id < getNumValNums() && VNI == getValNumInfo(VNI->id);
 266     }
 267
 268     /// getNextValue - Create a new value number and return it.  MIIdx specifies
 269     /// the instruction that defines the value number.
 270     VNInfo *getNextValue(SlotIndex def, VNInfo::Allocator &VNInfoAllocator) {
 271       VNInfo *VNI =
 272         new (VNInfoAllocator) VNInfo((unsigned)valnos.size(), def);
 273       valnos.push_back(VNI);
 274       return VNI;
 275     }
 276
 277     /// Create a copy of the given value. The new value will be identical except
 278     /// for the Value number.
 279     VNInfo *createValueCopy(const VNInfo *orig,
 280                             VNInfo::Allocator &VNInfoAllocator) {
 281       VNInfo *VNI =
 282         new (VNInfoAllocator) VNInfo((unsigned)valnos.size(), *orig);
 283       valnos.push_back(VNI);
 284       return VNI;
 285     }
 286
 287     /// RenumberValues - Renumber all values in order of appearance and remove
 288     /// unused values.
 289     void RenumberValues(LiveIntervals &lis);
 290
 291     /// MergeValueNumberInto - This method is called when two value nubmers
 292     /// are found to be equivalent.  This eliminates V1, replacing all
 293     /// LiveRanges with the V1 value number with the V2 value number.  This can
 294     /// cause merging of V1/V2 values numbers and compaction of the value space.
 295     VNInfo* MergeValueNumberInto(VNInfo *V1, VNInfo *V2);
 296
 297     /// MergeValueInAsValue - Merge all of the live ranges of a specific val#
 298     /// in RHS into this live interval as the specified value number.
 299     /// The LiveRanges in RHS are allowed to overlap with LiveRanges in the
 300     /// current interval, it will replace the value numbers of the overlaped
 301     /// live ranges with the specified value number.
 302     void MergeRangesInAsValue(const LiveInterval &RHS, VNInfo *LHSValNo);
 303
 304     /// MergeValueInAsValue - Merge all of the live ranges of a specific val#
 305     /// in RHS into this live interval as the specified value number.
 306     /// The LiveRanges in RHS are allowed to overlap with LiveRanges in the
 307     /// current interval, but only if the overlapping LiveRanges have the
 308     /// specified value number.
 309     void MergeValueInAsValue(const LiveInterval &RHS,
 310                              const VNInfo *RHSValNo, VNInfo *LHSValNo);
 311
 312     /// Copy - Copy the specified live interval. This copies all the fields
 313     /// except for the register of the interval.
 314     void Copy(const LiveInterval &RHS, MachineRegisterInfo *MRI,
 315               VNInfo::Allocator &VNInfoAllocator);
 316
 317     bool empty() const { return ranges.empty(); }
 318
 319     /// beginIndex - Return the lowest numbered slot covered by interval.
 320     SlotIndex beginIndex() const {
 321       assert(!empty() && "Call to beginIndex() on empty interval.");
 322       return ranges.front().start;
 323     }
 324
 325     /// endNumber - return the maximum point of the interval of the whole,
 326     /// exclusive.
 327     SlotIndex endIndex() const {
 328       assert(!empty() && "Call to endIndex() on empty interval.");
 329       return ranges.back().end;
 330     }
 331
 332     bool expiredAt(SlotIndex index) const {
 333       return index >= endIndex();
 334     }
 335
 336     bool liveAt(SlotIndex index) const {
 337       const_iterator r = find(index);
 338       return r != end() && r->start <= index;
 339     }
 340
 341     /// killedAt - Return true if a live range ends at index. Note that the kill
 342     /// point is not contained in the half-open live range. It is usually the
 343     /// getDefIndex() slot following its last use.
 344     bool killedAt(SlotIndex index) const {
 345       const_iterator r = find(index.getRegSlot(true));
 346       return r != end() && r->end == index;
 347     }
 348
 349     /// killedInRange - Return true if the interval has kills in [Start,End).
 350     /// Note that the kill point is considered the end of a live range, so it is
 351     /// not contained in the live range. If a live range ends at End, it won't
 352     /// be counted as a kill by this method.
 353     bool killedInRange(SlotIndex Start, SlotIndex End) const;
 354
 355     /// getLiveRangeContaining - Return the live range that contains the
 356     /// specified index, or null if there is none.
 357     const LiveRange *getLiveRangeContaining(SlotIndex Idx) const {
 358       const_iterator I = FindLiveRangeContaining(Idx);
 359       return I == end() ? 0 : &*I;
 360     }
 361
 362     /// getLiveRangeContaining - Return the live range that contains the
 363     /// specified index, or null if there is none.
 364     LiveRange *getLiveRangeContaining(SlotIndex Idx) {
 365       iterator I = FindLiveRangeContaining(Idx);
 366       return I == end() ? 0 : &*I;
 367     }
 368
 369     /// getVNInfoAt - Return the VNInfo that is live at Idx, or NULL.
 370     VNInfo *getVNInfoAt(SlotIndex Idx) const {
 371       const_iterator I = FindLiveRangeContaining(Idx);
 372       return I == end() ? 0 : I->valno;
 373     }
 374
 375     /// getVNInfoBefore - Return the VNInfo that is live up to but not
 376     /// necessarilly including Idx, or NULL. Use this to find the reaching def
 377     /// used by an instruction at this SlotIndex position.
 378     VNInfo *getVNInfoBefore(SlotIndex Idx) const {
 379       const_iterator I = FindLiveRangeContaining(Idx.getPrevSlot());
 380       return I == end() ? 0 : I->valno;
 381     }
 382
 383     /// FindLiveRangeContaining - Return an iterator to the live range that
 384     /// contains the specified index, or end() if there is none.
 385     iterator FindLiveRangeContaining(SlotIndex Idx) {
 386       iterator I = find(Idx);
 387       return I != end() && I->start <= Idx ? I : end();
 388     }
 389
 390     const_iterator FindLiveRangeContaining(SlotIndex Idx) const {
 391       const_iterator I = find(Idx);
 392       return I != end() && I->start <= Idx ? I : end();
 393     }
 394
 395     /// overlaps - Return true if the intersection of the two live intervals is
 396     /// not empty.
 397     bool overlaps(const LiveInterval& other) const {
 398       if (other.empty())
 399         return false;
 400       return overlapsFrom(other, other.begin());
 401     }
 402
 403     /// overlaps - Return true if the live interval overlaps a range specified
 404     /// by [Start, End).
 405     bool overlaps(SlotIndex Start, SlotIndex End) const;
 406
 407     /// overlapsFrom - Return true if the intersection of the two live intervals
 408     /// is not empty.  The specified iterator is a hint that we can begin
 409     /// scanning the Other interval starting at I.
 410     bool overlapsFrom(const LiveInterval& other, const_iterator I) const;
 411
 412     /// addRange - Add the specified LiveRange to this interval, merging
 413     /// intervals as appropriate.  This returns an iterator to the inserted live
 414     /// range (which may have grown since it was inserted.
 415     void addRange(LiveRange LR) {
 416       addRangeFrom(LR, ranges.begin());
 417     }
 418
 419     /// extendInBlock - If this interval is live before Kill in the basic block
 420     /// that starts at StartIdx, extend it to be live up to Kill, and return
 421     /// the value. If there is no live range before Kill, return NULL.
 422     VNInfo *extendInBlock(SlotIndex StartIdx, SlotIndex Kill);
 423
 424     /// join - Join two live intervals (this, and other) together.  This applies
 425     /// mappings to the value numbers in the LHS/RHS intervals as specified.  If
 426     /// the intervals are not joinable, this aborts.
 427     void join(LiveInterval &Other,
 428               const int *ValNoAssignments,
 429               const int *RHSValNoAssignments,
 430               SmallVector<VNInfo*, 16> &NewVNInfo,
 431               MachineRegisterInfo *MRI);
 432
 433     /// isInOneLiveRange - Return true if the range specified is entirely in the
 434     /// a single LiveRange of the live interval.
 435     bool isInOneLiveRange(SlotIndex Start, SlotIndex End) const {
 436       const_iterator r = find(Start);
 437       return r != end() && r->containsRange(Start, End);
 438     }
 439
 440     /// removeRange - Remove the specified range from this interval.  Note that
 441     /// the range must be a single LiveRange in its entirety.
 442     void removeRange(SlotIndex Start, SlotIndex End,
 443                      bool RemoveDeadValNo = false);
 444
 445     void removeRange(LiveRange LR, bool RemoveDeadValNo = false) {
 446       removeRange(LR.start, LR.end, RemoveDeadValNo);
 447     }
 448
 449     /// removeValNo - Remove all the ranges defined by the specified value#.
 450     /// Also remove the value# from value# list.
 451     void removeValNo(VNInfo *ValNo);
 452
 453     /// getSize - Returns the sum of sizes of all the LiveRange's.
 454     ///
 455     unsigned getSize() const;
 456
 457     /// Returns true if the live interval is zero length, i.e. no live ranges
 458     /// span instructions. It doesn't pay to spill such an interval.
 459     bool isZeroLength(SlotIndexes *Indexes) const {
 460       for (const_iterator i = begin(), e = end(); i != e; ++i)
 461         if (Indexes->getNextNonNullIndex(i->start).getBaseIndex() <
 462             i->end.getBaseIndex())
 463           return false;
 464       return true;
 465     }
 466
 467     /// isSpillable - Can this interval be spilled?
 468     bool isSpillable() const {
 469       return weight != HUGE_VALF;
 470     }
 471
 472     /// markNotSpillable - Mark interval as not spillable
 473     void markNotSpillable() {
 474       weight = HUGE_VALF;
 475     }
 476
 477     bool operator<(const LiveInterval& other) const {
 478       const SlotIndex &thisIndex = beginIndex();
 479       const SlotIndex &otherIndex = other.beginIndex();
 480       return (thisIndex < otherIndex ||
 481               (thisIndex == otherIndex && reg < other.reg));
 482     }
 483
 484     void print(raw_ostream &OS, const TargetRegisterInfo *TRI = 0) const;
 485     void dump() const;
 486
 487   private:
 488
 489     Ranges::iterator addRangeFrom(LiveRange LR, Ranges::iterator From);
 490     void extendIntervalEndTo(Ranges::iterator I, SlotIndex NewEnd);
 491     Ranges::iterator extendIntervalStartTo(Ranges::iterator I, SlotIndex NewStr);
 492     void markValNoForDeletion(VNInfo *V);
 493
 494     LiveInterval& operator=(const LiveInterval& rhs); // DO NOT IMPLEMENT
 495
 496   };
 497
 498   inline raw_ostream &operator<<(raw_ostream &OS, const LiveInterval &LI) {
 499     LI.print(OS);
 500     return OS;
 501   }
 502
 503   /// ConnectedVNInfoEqClasses - Helper class that can divide VNInfos in a
 504   /// LiveInterval into equivalence clases of connected components. A
 505   /// LiveInterval that has multiple connected components can be broken into
 506   /// multiple LiveIntervals.
 507   ///
 508   /// Given a LiveInterval that may have multiple connected components, run:
 509   ///
 510   ///   unsigned numComps = ConEQ.Classify(LI);
 511   ///   if (numComps > 1) {
 512   ///     // allocate numComps-1 new LiveIntervals into LIS[1..]
 513   ///     ConEQ.Distribute(LIS);
 514   /// }
 515
 516   class ConnectedVNInfoEqClasses {
 517     LiveIntervals &LIS;
 518     IntEqClasses EqClass;
 519
 520     // Note that values a and b are connected.
 521     void Connect(unsigned a, unsigned b);
 522
 523     unsigned Renumber();
 524
 525   public:
 526     explicit ConnectedVNInfoEqClasses(LiveIntervals &lis) : LIS(lis) {}
 527
 528     /// Classify - Classify the values in LI into connected components.
 529     /// Return the number of connected components.
 530     unsigned Classify(const LiveInterval *LI);
 531
 532     /// getEqClass - Classify creates equivalence classes numbered 0..N. Return
 533     /// the equivalence class assigned the VNI.
 534     unsigned getEqClass(const VNInfo *VNI) const { return EqClass[VNI->id]; }
 535
 536     /// Distribute - Distribute values in LIV[0] into a separate LiveInterval
 537     /// for each connected component. LIV must have a LiveInterval for each
 538     /// connected component. The LiveIntervals in Liv[1..] must be empty.
 539     /// Instructions using LIV[0] are rewritten.
 540     void Distribute(LiveInterval *LIV[], MachineRegisterInfo &MRI);
 541
 542   };
 543
 544 }
 545 #endif