Add an efficient merge operation to LiveInterval and use it to avoid
[oota-llvm.git] / 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     /// createDeadDef - Make sure the interval has a value defined at Def.
278     /// If one already exists, return it. Otherwise allocate a new value and
279     /// add liveness for a dead def.
280     VNInfo *createDeadDef(SlotIndex Def, VNInfo::Allocator &VNInfoAllocator);
281
282     /// Create a copy of the given value. The new value will be identical except
283     /// for the Value number.
284     VNInfo *createValueCopy(const VNInfo *orig,
285                             VNInfo::Allocator &VNInfoAllocator) {
286       VNInfo *VNI =
287         new (VNInfoAllocator) VNInfo((unsigned)valnos.size(), *orig);
288       valnos.push_back(VNI);
289       return VNI;
290     }
291
292     /// RenumberValues - Renumber all values in order of appearance and remove
293     /// unused values.
294     void RenumberValues(LiveIntervals &lis);
295
296     /// MergeValueNumberInto - This method is called when two value nubmers
297     /// are found to be equivalent.  This eliminates V1, replacing all
298     /// LiveRanges with the V1 value number with the V2 value number.  This can
299     /// cause merging of V1/V2 values numbers and compaction of the value space.
300     VNInfo* MergeValueNumberInto(VNInfo *V1, VNInfo *V2);
301
302     /// MergeValueInAsValue - Merge all of the live ranges of a specific val#
303     /// in RHS into this live interval as the specified value number.
304     /// The LiveRanges in RHS are allowed to overlap with LiveRanges in the
305     /// current interval, it will replace the value numbers of the overlaped
306     /// live ranges with the specified value number.
307     void MergeRangesInAsValue(const LiveInterval &RHS, VNInfo *LHSValNo);
308
309     /// MergeValueInAsValue - Merge all of the live ranges of a specific val#
310     /// in RHS into this live interval as the specified value number.
311     /// The LiveRanges in RHS are allowed to overlap with LiveRanges in the
312     /// current interval, but only if the overlapping LiveRanges have the
313     /// specified value number.
314     void MergeValueInAsValue(const LiveInterval &RHS,
315                              const VNInfo *RHSValNo, VNInfo *LHSValNo);
316
317     /// Copy - Copy the specified live interval. This copies all the fields
318     /// except for the register of the interval.
319     void Copy(const LiveInterval &RHS, MachineRegisterInfo *MRI,
320               VNInfo::Allocator &VNInfoAllocator);
321
322     bool empty() const { return ranges.empty(); }
323
324     /// beginIndex - Return the lowest numbered slot covered by interval.
325     SlotIndex beginIndex() const {
326       assert(!empty() && "Call to beginIndex() on empty interval.");
327       return ranges.front().start;
328     }
329
330     /// endNumber - return the maximum point of the interval of the whole,
331     /// exclusive.
332     SlotIndex endIndex() const {
333       assert(!empty() && "Call to endIndex() on empty interval.");
334       return ranges.back().end;
335     }
336
337     bool expiredAt(SlotIndex index) const {
338       return index >= endIndex();
339     }
340
341     bool liveAt(SlotIndex index) const {
342       const_iterator r = find(index);
343       return r != end() && r->start <= index;
344     }
345
346     /// killedAt - Return true if a live range ends at index. Note that the kill
347     /// point is not contained in the half-open live range. It is usually the
348     /// getDefIndex() slot following its last use.
349     bool killedAt(SlotIndex index) const {
350       const_iterator r = find(index.getRegSlot(true));
351       return r != end() && r->end == index;
352     }
353
354     /// killedInRange - Return true if the interval has kills in [Start,End).
355     /// Note that the kill point is considered the end of a live range, so it is
356     /// not contained in the live range. If a live range ends at End, it won't
357     /// be counted as a kill by this method.
358     bool killedInRange(SlotIndex Start, SlotIndex End) const;
359
360     /// getLiveRangeContaining - Return the live range that contains the
361     /// specified index, or null if there is none.
362     const LiveRange *getLiveRangeContaining(SlotIndex Idx) const {
363       const_iterator I = FindLiveRangeContaining(Idx);
364       return I == end() ? 0 : &*I;
365     }
366
367     /// getLiveRangeContaining - Return the live range that contains the
368     /// specified index, or null if there is none.
369     LiveRange *getLiveRangeContaining(SlotIndex Idx) {
370       iterator I = FindLiveRangeContaining(Idx);
371       return I == end() ? 0 : &*I;
372     }
373
374     /// getVNInfoAt - Return the VNInfo that is live at Idx, or NULL.
375     VNInfo *getVNInfoAt(SlotIndex Idx) const {
376       const_iterator I = FindLiveRangeContaining(Idx);
377       return I == end() ? 0 : I->valno;
378     }
379
380     /// getVNInfoBefore - Return the VNInfo that is live up to but not
381     /// necessarilly including Idx, or NULL. Use this to find the reaching def
382     /// used by an instruction at this SlotIndex position.
383     VNInfo *getVNInfoBefore(SlotIndex Idx) const {
384       const_iterator I = FindLiveRangeContaining(Idx.getPrevSlot());
385       return I == end() ? 0 : I->valno;
386     }
387
388     /// FindLiveRangeContaining - Return an iterator to the live range that
389     /// contains the specified index, or end() if there is none.
390     iterator FindLiveRangeContaining(SlotIndex Idx) {
391       iterator I = find(Idx);
392       return I != end() && I->start <= Idx ? I : end();
393     }
394
395     const_iterator FindLiveRangeContaining(SlotIndex Idx) const {
396       const_iterator I = find(Idx);
397       return I != end() && I->start <= Idx ? I : end();
398     }
399
400     /// overlaps - Return true if the intersection of the two live intervals is
401     /// not empty.
402     bool overlaps(const LiveInterval& other) const {
403       if (other.empty())
404         return false;
405       return overlapsFrom(other, other.begin());
406     }
407
408     /// overlaps - Return true if the live interval overlaps a range specified
409     /// by [Start, End).
410     bool overlaps(SlotIndex Start, SlotIndex End) const;
411
412     /// overlapsFrom - Return true if the intersection of the two live intervals
413     /// is not empty.  The specified iterator is a hint that we can begin
414     /// scanning the Other interval starting at I.
415     bool overlapsFrom(const LiveInterval& other, const_iterator I) const;
416
417     /// addRange - Add the specified LiveRange to this interval, merging
418     /// intervals as appropriate.  This returns an iterator to the inserted live
419     /// range (which may have grown since it was inserted.
420     void addRange(LiveRange LR) {
421       addRangeFrom(LR, ranges.begin());
422     }
423
424     /// extendInBlock - If this interval is live before Kill in the basic block
425     /// that starts at StartIdx, extend it to be live up to Kill, and return
426     /// the value. If there is no live range before Kill, return NULL.
427     VNInfo *extendInBlock(SlotIndex StartIdx, SlotIndex Kill);
428
429     /// join - Join two live intervals (this, and other) together.  This applies
430     /// mappings to the value numbers in the LHS/RHS intervals as specified.  If
431     /// the intervals are not joinable, this aborts.
432     void join(LiveInterval &Other,
433               const int *ValNoAssignments,
434               const int *RHSValNoAssignments,
435               SmallVector<VNInfo*, 16> &NewVNInfo,
436               MachineRegisterInfo *MRI);
437
438     /// isInOneLiveRange - Return true if the range specified is entirely in the
439     /// a single LiveRange of the live interval.
440     bool isInOneLiveRange(SlotIndex Start, SlotIndex End) const {
441       const_iterator r = find(Start);
442       return r != end() && r->containsRange(Start, End);
443     }
444
445     /// removeRange - Remove the specified range from this interval.  Note that
446     /// the range must be a single LiveRange in its entirety.
447     void removeRange(SlotIndex Start, SlotIndex End,
448                      bool RemoveDeadValNo = false);
449
450     void removeRange(LiveRange LR, bool RemoveDeadValNo = false) {
451       removeRange(LR.start, LR.end, RemoveDeadValNo);
452     }
453
454     /// removeValNo - Remove all the ranges defined by the specified value#.
455     /// Also remove the value# from value# list.
456     void removeValNo(VNInfo *ValNo);
457
458     /// getSize - Returns the sum of sizes of all the LiveRange's.
459     ///
460     unsigned getSize() const;
461
462     /// Returns true if the live interval is zero length, i.e. no live ranges
463     /// span instructions. It doesn't pay to spill such an interval.
464     bool isZeroLength(SlotIndexes *Indexes) const {
465       for (const_iterator i = begin(), e = end(); i != e; ++i)
466         if (Indexes->getNextNonNullIndex(i->start).getBaseIndex() <
467             i->end.getBaseIndex())
468           return false;
469       return true;
470     }
471
472     /// isSpillable - Can this interval be spilled?
473     bool isSpillable() const {
474       return weight != HUGE_VALF;
475     }
476
477     /// markNotSpillable - Mark interval as not spillable
478     void markNotSpillable() {
479       weight = HUGE_VALF;
480     }
481
482     bool operator<(const LiveInterval& other) const {
483       const SlotIndex &thisIndex = beginIndex();
484       const SlotIndex &otherIndex = other.beginIndex();
485       return (thisIndex < otherIndex ||
486               (thisIndex == otherIndex && reg < other.reg));
487     }
488
489     void print(raw_ostream &OS) const;
490     void dump() const;
491
492     /// \brief Walk the interval and assert if any invariants fail to hold.
493     ///
494     /// Note that this is a no-op when asserts are disabled.
495 #ifdef NDEBUG
496     void verify() const {}
497 #else
498     void verify() const;
499 #endif
500
501   private:
502
503     Ranges::iterator addRangeFrom(LiveRange LR, Ranges::iterator From);
504     void extendIntervalEndTo(Ranges::iterator I, SlotIndex NewEnd);
505     Ranges::iterator extendIntervalStartTo(Ranges::iterator I, SlotIndex NewStr);
506     void markValNoForDeletion(VNInfo *V);
507     void mergeIntervalRanges(const LiveInterval &RHS,
508                              VNInfo *LHSValNo,
509                              const VNInfo *RHSValNo = 0);
510
511     LiveInterval& operator=(const LiveInterval& rhs); // DO NOT IMPLEMENT
512
513   };
514
515   inline raw_ostream &operator<<(raw_ostream &OS, const LiveInterval &LI) {
516     LI.print(OS);
517     return OS;
518   }
519
520   /// LiveRangeQuery - Query information about a live range around a given
521   /// instruction. This class hides the implementation details of live ranges,
522   /// and it should be used as the primary interface for examining live ranges
523   /// around instructions.
524   ///
525   class LiveRangeQuery {
526     VNInfo *EarlyVal;
527     VNInfo *LateVal;
528     SlotIndex EndPoint;
529     bool Kill;
530
531   public:
532     /// Create a LiveRangeQuery for the given live range and instruction index.
533     /// The sub-instruction slot of Idx doesn't matter, only the instruction it
534     /// refers to is considered.
535     LiveRangeQuery(const LiveInterval &LI, SlotIndex Idx)
536       : EarlyVal(0), LateVal(0), Kill(false) {
537       // Find the segment that enters the instruction.
538       LiveInterval::const_iterator I = LI.find(Idx.getBaseIndex());
539       LiveInterval::const_iterator E = LI.end();
540       if (I == E)
541         return;
542       // Is this an instruction live-in segment?
543       if (SlotIndex::isEarlierInstr(I->start, Idx)) {
544         EarlyVal = I->valno;
545         EndPoint = I->end;
546         // Move to the potentially live-out segment.
547         if (SlotIndex::isSameInstr(Idx, I->end)) {
548           Kill = true;
549           if (++I == E)
550             return;
551         }
552       }
553       // I now points to the segment that may be live-through, or defined by
554       // this instr. Ignore segments starting after the current instr.
555       if (SlotIndex::isEarlierInstr(Idx, I->start))
556         return;
557       LateVal = I->valno;
558       EndPoint = I->end;
559     }
560
561     /// Return the value that is live-in to the instruction. This is the value
562     /// that will be read by the instruction's use operands. Return NULL if no
563     /// value is live-in.
564     VNInfo *valueIn() const {
565       return EarlyVal;
566     }
567
568     /// Return true if the live-in value is killed by this instruction. This
569     /// means that either the live range ends at the instruction, or it changes
570     /// value.
571     bool isKill() const {
572       return Kill;
573     }
574
575     /// Return true if this instruction has a dead def.
576     bool isDeadDef() const {
577       return EndPoint.isDead();
578     }
579
580     /// Return the value leaving the instruction, if any. This can be a
581     /// live-through value, or a live def. A dead def returns NULL.
582     VNInfo *valueOut() const {
583       return isDeadDef() ? 0 : LateVal;
584     }
585
586     /// Return the value defined by this instruction, if any. This includes
587     /// dead defs, it is the value created by the instruction's def operands.
588     VNInfo *valueDefined() const {
589       return EarlyVal == LateVal ? 0 : LateVal;
590     }
591
592     /// Return the end point of the last live range segment to interact with
593     /// the instruction, if any.
594     ///
595     /// The end point is an invalid SlotIndex only if the live range doesn't
596     /// intersect the instruction at all.
597     ///
598     /// The end point may be at or past the end of the instruction's basic
599     /// block. That means the value was live out of the block.
600     SlotIndex endPoint() const {
601       return EndPoint;
602     }
603   };
604
605   /// ConnectedVNInfoEqClasses - Helper class that can divide VNInfos in a
606   /// LiveInterval into equivalence clases of connected components. A
607   /// LiveInterval that has multiple connected components can be broken into
608   /// multiple LiveIntervals.
609   ///
610   /// Given a LiveInterval that may have multiple connected components, run:
611   ///
612   ///   unsigned numComps = ConEQ.Classify(LI);
613   ///   if (numComps > 1) {
614   ///     // allocate numComps-1 new LiveIntervals into LIS[1..]
615   ///     ConEQ.Distribute(LIS);
616   /// }
617
618   class ConnectedVNInfoEqClasses {
619     LiveIntervals &LIS;
620     IntEqClasses EqClass;
621
622     // Note that values a and b are connected.
623     void Connect(unsigned a, unsigned b);
624
625     unsigned Renumber();
626
627   public:
628     explicit ConnectedVNInfoEqClasses(LiveIntervals &lis) : LIS(lis) {}
629
630     /// Classify - Classify the values in LI into connected components.
631     /// Return the number of connected components.
632     unsigned Classify(const LiveInterval *LI);
633
634     /// getEqClass - Classify creates equivalence classes numbered 0..N. Return
635     /// the equivalence class assigned the VNI.
636     unsigned getEqClass(const VNInfo *VNI) const { return EqClass[VNI->id]; }
637
638     /// Distribute - Distribute values in LIV[0] into a separate LiveInterval
639     /// for each connected component. LIV must have a LiveInterval for each
640     /// connected component. The LiveIntervals in Liv[1..] must be empty.
641     /// Instructions using LIV[0] are rewritten.
642     void Distribute(LiveInterval *LIV[], MachineRegisterInfo &MRI);
643
644   };
645
646 }
647 #endif