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/SmallVector.h"
  25 #include "llvm/Support/Allocator.h"
  26 #include <iosfwd>
  27 #include <cassert>
  28
  29 namespace llvm {
  30   class MachineInstr;
  31   class TargetRegisterInfo;
  32   struct LiveInterval;
  33
  34   /// VNInfo - If the value number definition is undefined (e.g. phi
  35   /// merge point), it contains ~0u,x. If the value number is not in use, it
  36   /// contains ~1u,x to indicate that the value # is not used.
  37   ///   def   - Instruction # of the definition.
  38   ///         - or reg # of the definition if it's a stack slot liveinterval.
  39   ///   copy  - Copy iff val# is defined by a copy; zero otherwise.
  40   ///   hasPHIKill - One or more of the kills are PHI nodes.
  41   ///   redefByEC - Re-defined by early clobber somewhere during the live range.
  42   ///   kills - Instruction # of the kills.
  43   struct VNInfo {
  44     unsigned id;
  45     unsigned def;
  46     MachineInstr *copy;
  47     bool hasPHIKill : 1;
  48     bool redefByEC : 1;
  49     SmallVector<unsigned, 4> kills;
  50     VNInfo()
  51       : id(~1U), def(~1U), copy(0), hasPHIKill(false), redefByEC(false) {}
  52     VNInfo(unsigned i, unsigned d, MachineInstr *c)
  53       : id(i), def(d), copy(c), hasPHIKill(false), redefByEC(false) {}
  54   };
  55
  56   /// LiveRange structure - This represents a simple register range in the
  57   /// program, with an inclusive start point and an exclusive end point.
  58   /// These ranges are rendered as [start,end).
  59   struct LiveRange {
  60     unsigned start;  // Start point of the interval (inclusive)
  61     unsigned end;    // End point of the interval (exclusive)
  62     VNInfo *valno;   // identifier for the value contained in this interval.
  63
  64     LiveRange(unsigned S, unsigned E, VNInfo *V) : start(S), end(E), valno(V) {
  65       assert(S < E && "Cannot create empty or backwards range");
  66     }
  67
  68     /// contains - Return true if the index is covered by this range.
  69     ///
  70     bool contains(unsigned I) const {
  71       return start <= I && I < end;
  72     }
  73
  74     bool operator<(const LiveRange &LR) const {
  75       return start < LR.start || (start == LR.start && end < LR.end);
  76     }
  77     bool operator==(const LiveRange &LR) const {
  78       return start == LR.start && end == LR.end;
  79     }
  80
  81     void dump() const;
  82     void print(std::ostream &os) const;
  83     void print(std::ostream *os) const { if (os) print(*os); }
  84
  85   private:
  86     LiveRange(); // DO NOT IMPLEMENT
  87   };
  88
  89   std::ostream& operator<<(std::ostream& os, const LiveRange &LR);
  90
  91
  92   inline bool operator<(unsigned V, const LiveRange &LR) {
  93     return V < LR.start;
  94   }
  95
  96   inline bool operator<(const LiveRange &LR, unsigned V) {
  97     return LR.start < V;
  98   }
  99
 100   /// LiveInterval - This class represents some number of live ranges for a
 101   /// register or value.  This class also contains a bit of register allocator
 102   /// state.
 103   struct LiveInterval {
 104     typedef SmallVector<LiveRange,4> Ranges;
 105     typedef SmallVector<VNInfo*,4> VNInfoList;
 106
 107     unsigned reg;        // the register or stack slot of this interval
 108                          // if the top bits is set, it represents a stack slot.
 109     float weight;        // weight of this interval
 110     unsigned short preference; // preferred register for this interval
 111     Ranges ranges;       // the ranges in which this register is live
 112     VNInfoList valnos;   // value#'s
 113
 114   public:
 115     LiveInterval(unsigned Reg, float Weight, bool IsSS = false)
 116       : reg(Reg), weight(Weight), preference(0)  {
 117       if (IsSS)
 118         reg = reg | (1U << (sizeof(unsigned)*8-1));
 119     }
 120
 121     typedef Ranges::iterator iterator;
 122     iterator begin() { return ranges.begin(); }
 123     iterator end()   { return ranges.end(); }
 124
 125     typedef Ranges::const_iterator const_iterator;
 126     const_iterator begin() const { return ranges.begin(); }
 127     const_iterator end() const  { return ranges.end(); }
 128
 129     typedef VNInfoList::iterator vni_iterator;
 130     vni_iterator vni_begin() { return valnos.begin(); }
 131     vni_iterator vni_end() { return valnos.end(); }
 132
 133     typedef VNInfoList::const_iterator const_vni_iterator;
 134     const_vni_iterator vni_begin() const { return valnos.begin(); }
 135     const_vni_iterator vni_end() const { return valnos.end(); }
 136
 137     /// advanceTo - Advance the specified iterator to point to the LiveRange
 138     /// containing the specified position, or end() if the position is past the
 139     /// end of the interval.  If no LiveRange contains this position, but the
 140     /// position is in a hole, this method returns an iterator pointing the the
 141     /// LiveRange immediately after the hole.
 142     iterator advanceTo(iterator I, unsigned Pos) {
 143       if (Pos >= endNumber())
 144         return end();
 145       while (I->end <= Pos) ++I;
 146       return I;
 147     }
 148
 149     void clear() {
 150       while (!valnos.empty()) {
 151         VNInfo *VNI = valnos.back();
 152         valnos.pop_back();
 153         VNI->~VNInfo();
 154       }
 155
 156       ranges.clear();
 157     }
 158
 159     /// isStackSlot - Return true if this is a stack slot interval.
 160     ///
 161     bool isStackSlot() const {
 162       return reg & (1U << (sizeof(unsigned)*8-1));
 163     }
 164
 165     /// getStackSlotIndex - Return stack slot index if this is a stack slot
 166     /// interval.
 167     int getStackSlotIndex() const {
 168       assert(isStackSlot() && "Interval is not a stack slot interval!");
 169       return reg & ~(1U << (sizeof(unsigned)*8-1));
 170     }
 171
 172     bool hasAtLeastOneValue() const { return !valnos.empty(); }
 173
 174     bool containsOneValue() const { return valnos.size() == 1; }
 175
 176     unsigned getNumValNums() const { return (unsigned)valnos.size(); }
 177
 178     /// getValNumInfo - Returns pointer to the specified val#.
 179     ///
 180     inline VNInfo *getValNumInfo(unsigned ValNo) {
 181       return valnos[ValNo];
 182     }
 183     inline const VNInfo *getValNumInfo(unsigned ValNo) const {
 184       return valnos[ValNo];
 185     }
 186
 187     /// copyValNumInfo - Copy the value number info for one value number to
 188     /// another.
 189     void copyValNumInfo(VNInfo *DstValNo, const VNInfo *SrcValNo) {
 190       DstValNo->def = SrcValNo->def;
 191       DstValNo->copy = SrcValNo->copy;
 192       DstValNo->hasPHIKill = SrcValNo->hasPHIKill;
 193       DstValNo->redefByEC = SrcValNo->redefByEC;
 194       DstValNo->kills = SrcValNo->kills;
 195     }
 196
 197     /// getNextValue - Create a new value number and return it.  MIIdx specifies
 198     /// the instruction that defines the value number.
 199     VNInfo *getNextValue(unsigned MIIdx, MachineInstr *CopyMI,
 200                          BumpPtrAllocator &VNInfoAllocator) {
 201 #ifdef __GNUC__
 202       unsigned Alignment = (unsigned)__alignof__(VNInfo);
 203 #else
 204       // FIXME: ugly.
 205       unsigned Alignment = 8;
 206 #endif
 207       VNInfo *VNI =
 208         static_cast<VNInfo*>(VNInfoAllocator.Allocate((unsigned)sizeof(VNInfo),
 209                                                       Alignment));
 210       new (VNI) VNInfo((unsigned)valnos.size(), MIIdx, CopyMI);
 211       valnos.push_back(VNI);
 212       return VNI;
 213     }
 214
 215     /// addKill - Add a kill instruction index to the specified value
 216     /// number.
 217     static void addKill(VNInfo *VNI, unsigned KillIdx) {
 218       SmallVector<unsigned, 4> &kills = VNI->kills;
 219       if (kills.empty()) {
 220         kills.push_back(KillIdx);
 221       } else {
 222         SmallVector<unsigned, 4>::iterator
 223           I = std::lower_bound(kills.begin(), kills.end(), KillIdx);
 224         kills.insert(I, KillIdx);
 225       }
 226     }
 227
 228     /// addKills - Add a number of kills into the VNInfo kill vector. If this
 229     /// interval is live at a kill point, then the kill is not added.
 230     void addKills(VNInfo *VNI, const SmallVector<unsigned, 4> &kills) {
 231       for (unsigned i = 0, e = static_cast<unsigned>(kills.size());
 232            i != e; ++i) {
 233         unsigned KillIdx = kills[i];
 234         if (!liveBeforeAndAt(KillIdx)) {
 235           SmallVector<unsigned, 4>::iterator
 236             I = std::lower_bound(VNI->kills.begin(), VNI->kills.end(), KillIdx);
 237           VNI->kills.insert(I, KillIdx);
 238         }
 239       }
 240     }
 241
 242     /// removeKill - Remove the specified kill from the list of kills of
 243     /// the specified val#.
 244     static bool removeKill(VNInfo *VNI, unsigned KillIdx) {
 245       SmallVector<unsigned, 4> &kills = VNI->kills;
 246       SmallVector<unsigned, 4>::iterator
 247         I = std::lower_bound(kills.begin(), kills.end(), KillIdx);
 248       if (I != kills.end() && *I == KillIdx) {
 249         kills.erase(I);
 250         return true;
 251       }
 252       return false;
 253     }
 254
 255     /// removeKills - Remove all the kills in specified range
 256     /// [Start, End] of the specified val#.
 257     static void removeKills(VNInfo *VNI, unsigned Start, unsigned End) {
 258       SmallVector<unsigned, 4> &kills = VNI->kills;
 259       SmallVector<unsigned, 4>::iterator
 260         I = std::lower_bound(kills.begin(), kills.end(), Start);
 261       SmallVector<unsigned, 4>::iterator
 262         E = std::upper_bound(kills.begin(), kills.end(), End);
 263       kills.erase(I, E);
 264     }
 265
 266     /// isKill - Return true if the specified index is a kill of the
 267     /// specified val#.
 268     static bool isKill(const VNInfo *VNI, unsigned KillIdx) {
 269       const SmallVector<unsigned, 4> &kills = VNI->kills;
 270       SmallVector<unsigned, 4>::const_iterator
 271         I = std::lower_bound(kills.begin(), kills.end(), KillIdx);
 272       return I != kills.end() && *I == KillIdx;
 273     }
 274
 275     /// MergeValueNumberInto - This method is called when two value nubmers
 276     /// are found to be equivalent.  This eliminates V1, replacing all
 277     /// LiveRanges with the V1 value number with the V2 value number.  This can
 278     /// cause merging of V1/V2 values numbers and compaction of the value space.
 279     void MergeValueNumberInto(VNInfo *V1, VNInfo *V2);
 280
 281     /// MergeInClobberRanges - For any live ranges that are not defined in the
 282     /// current interval, but are defined in the Clobbers interval, mark them
 283     /// used with an unknown definition value. Caller must pass in reference to
 284     /// VNInfoAllocator since it will create a new val#.
 285     void MergeInClobberRanges(const LiveInterval &Clobbers,
 286                               BumpPtrAllocator &VNInfoAllocator);
 287
 288     /// MergeValueInAsValue - Merge all of the live ranges of a specific val#
 289     /// in RHS into this live interval as the specified value number.
 290     /// The LiveRanges in RHS are allowed to overlap with LiveRanges in the
 291     /// current interval, it will replace the value numbers of the overlaped
 292     /// live ranges with the specified value number.
 293     void MergeRangesInAsValue(const LiveInterval &RHS, VNInfo *LHSValNo);
 294
 295     /// MergeValueInAsValue - Merge all of the live ranges of a specific val#
 296     /// in RHS into this live interval as the specified value number.
 297     /// The LiveRanges in RHS are allowed to overlap with LiveRanges in the
 298     /// current interval, but only if the overlapping LiveRanges have the
 299     /// specified value number.
 300     void MergeValueInAsValue(const LiveInterval &RHS,
 301                              const VNInfo *RHSValNo, VNInfo *LHSValNo);
 302
 303     /// Copy - Copy the specified live interval. This copies all the fields
 304     /// except for the register of the interval.
 305     void Copy(const LiveInterval &RHS, BumpPtrAllocator &VNInfoAllocator);
 306
 307     bool empty() const { return ranges.empty(); }
 308
 309     /// beginNumber - Return the lowest numbered slot covered by interval.
 310     unsigned beginNumber() const {
 311       if (empty())
 312         return 0;
 313       return ranges.front().start;
 314     }
 315
 316     /// endNumber - return the maximum point of the interval of the whole,
 317     /// exclusive.
 318     unsigned endNumber() const {
 319       if (empty())
 320         return 0;
 321       return ranges.back().end;
 322     }
 323
 324     bool expiredAt(unsigned index) const {
 325       return index >= endNumber();
 326     }
 327
 328     bool liveAt(unsigned index) const;
 329
 330     // liveBeforeAndAt - Check if the interval is live at the index and the
 331     // index just before it. If index is liveAt, check if it starts a new live
 332     // range.If it does, then check if the previous live range ends at index-1.
 333     bool liveBeforeAndAt(unsigned index) const;
 334
 335     /// getLiveRangeContaining - Return the live range that contains the
 336     /// specified index, or null if there is none.
 337     const LiveRange *getLiveRangeContaining(unsigned Idx) const {
 338       const_iterator I = FindLiveRangeContaining(Idx);
 339       return I == end() ? 0 : &*I;
 340     }
 341
 342     /// FindLiveRangeContaining - Return an iterator to the live range that
 343     /// contains the specified index, or end() if there is none.
 344     const_iterator FindLiveRangeContaining(unsigned Idx) const;
 345
 346     /// FindLiveRangeContaining - Return an iterator to the live range that
 347     /// contains the specified index, or end() if there is none.
 348     iterator FindLiveRangeContaining(unsigned Idx);
 349
 350     /// findDefinedVNInfo - Find the VNInfo that's defined at the specified
 351     /// index (register interval) or defined by the specified register (stack
 352     /// inteval).
 353     VNInfo *findDefinedVNInfo(unsigned DefIdxOrReg) const;
 354
 355     /// overlaps - Return true if the intersection of the two live intervals is
 356     /// not empty.
 357     bool overlaps(const LiveInterval& other) const {
 358       return overlapsFrom(other, other.begin());
 359     }
 360
 361     /// overlapsFrom - Return true if the intersection of the two live intervals
 362     /// is not empty.  The specified iterator is a hint that we can begin
 363     /// scanning the Other interval starting at I.
 364     bool overlapsFrom(const LiveInterval& other, const_iterator I) const;
 365
 366     /// addRange - Add the specified LiveRange to this interval, merging
 367     /// intervals as appropriate.  This returns an iterator to the inserted live
 368     /// range (which may have grown since it was inserted.
 369     void addRange(LiveRange LR) {
 370       addRangeFrom(LR, ranges.begin());
 371     }
 372
 373     /// join - Join two live intervals (this, and other) together.  This applies
 374     /// mappings to the value numbers in the LHS/RHS intervals as specified.  If
 375     /// the intervals are not joinable, this aborts.
 376     void join(LiveInterval &Other, const int *ValNoAssignments,
 377               const int *RHSValNoAssignments,
 378               SmallVector<VNInfo*, 16> &NewVNInfo);
 379
 380     /// removeRange - Remove the specified range from this interval.  Note that
 381     /// the range must already be in this interval in its entirety.
 382     void removeRange(unsigned Start, unsigned End, bool RemoveDeadValNo = false);
 383
 384     void removeRange(LiveRange LR, bool RemoveDeadValNo = false) {
 385       removeRange(LR.start, LR.end, RemoveDeadValNo);
 386     }
 387
 388     /// removeValNo - Remove all the ranges defined by the specified value#.
 389     /// Also remove the value# from value# list.
 390     void removeValNo(VNInfo *ValNo);
 391
 392     /// getSize - Returns the sum of sizes of all the LiveRange's.
 393     ///
 394     unsigned getSize() const;
 395
 396     bool operator<(const LiveInterval& other) const {
 397       return beginNumber() < other.beginNumber();
 398     }
 399
 400     void print(std::ostream &OS, const TargetRegisterInfo *TRI = 0) const;
 401     void print(std::ostream *OS, const TargetRegisterInfo *TRI = 0) const {
 402       if (OS) print(*OS, TRI);
 403     }
 404     void dump() const;
 405
 406   private:
 407     Ranges::iterator addRangeFrom(LiveRange LR, Ranges::iterator From);
 408     void extendIntervalEndTo(Ranges::iterator I, unsigned NewEnd);
 409     Ranges::iterator extendIntervalStartTo(Ranges::iterator I, unsigned NewStr);
 410     LiveInterval& operator=(const LiveInterval& rhs); // DO NOT IMPLEMENT
 411   };
 412
 413   inline std::ostream &operator<<(std::ostream &OS, const LiveInterval &LI) {
 414     LI.print(OS);
 415     return OS;
 416   }
 417 }
 418
 419 #endif