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