1 //===-- llvm/CodeGen/LiveInterval.h - Interval representation ---*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
19 //===----------------------------------------------------------------------===//
21 #ifndef LLVM_CODEGEN_LIVEINTERVAL_H
22 #define LLVM_CODEGEN_LIVEINTERVAL_H
24 #include "llvm/ADT/SmallVector.h"
25 #include "llvm/Support/Allocator.h"
26 #include "llvm/Support/AlignOf.h"
27 #include "llvm/CodeGen/SlotIndexes.h"
34 class MachineRegisterInfo;
35 class TargetRegisterInfo;
38 /// VNInfo - Value Number Information.
39 /// This class holds information about a machine level values, including
40 /// definition and use points.
42 /// Care must be taken in interpreting the def index of the value. The
43 /// following rules apply:
45 /// If the isDefAccurate() method returns false then def does not contain the
46 /// index of the defining MachineInstr, or even (necessarily) to a
47 /// MachineInstr at all. In general such a def index is not meaningful
48 /// and should not be used. The exception is that, for values originally
49 /// defined by PHI instructions, after PHI elimination def will contain the
50 /// index of the MBB in which the PHI originally existed. This can be used
51 /// to insert code (spills or copies) which deals with the value, which will
52 /// be live in to the block.
60 IS_DEF_ACCURATE = 1 << 4
70 typedef BumpPtrAllocator Allocator;
72 /// The ID number of this value.
75 /// The index of the defining instruction (if isDefAccurate() returns true).
78 /// VNInfo constructor.
79 /// d is presumed to point to the actual defining instr. If it doesn't
80 /// setIsDefAccurate(false) should be called after construction.
81 VNInfo(unsigned i, SlotIndex d, MachineInstr *c)
82 : flags(IS_DEF_ACCURATE), id(i), def(d) { cr.copy = c; }
84 /// VNInfo construtor, copies values from orig, except for the value number.
85 VNInfo(unsigned i, const VNInfo &orig)
86 : flags(orig.flags), cr(orig.cr), id(i), def(orig.def)
89 /// Copy from the parameter into this VNInfo.
90 void copyFrom(VNInfo &src) {
96 /// Used for copying value number info.
97 unsigned getFlags() const { return flags; }
98 void setFlags(unsigned flags) { this->flags = flags; }
100 /// For a register interval, if this VN was definied by a copy instr
101 /// getCopy() returns a pointer to it, otherwise returns 0.
102 /// For a stack interval the behaviour of this method is undefined.
103 MachineInstr* getCopy() const { return cr.copy; }
104 /// For a register interval, set the copy member.
105 /// This method should not be called on stack intervals as it may lead to
106 /// undefined behavior.
107 void setCopy(MachineInstr *c) { cr.copy = c; }
109 /// For a stack interval, returns the reg which this stack interval was
111 /// For a register interval the behaviour of this method is undefined.
112 unsigned getReg() const { return cr.reg; }
113 /// For a stack interval, set the defining register.
114 /// This method should not be called on register intervals as it may lead
115 /// to undefined behaviour.
116 void setReg(unsigned reg) { cr.reg = reg; }
118 /// Returns true if one or more kills are PHI nodes.
119 bool hasPHIKill() const { return flags & HAS_PHI_KILL; }
120 /// Set the PHI kill flag on this value.
121 void setHasPHIKill(bool hasKill) {
123 flags |= HAS_PHI_KILL;
125 flags &= ~HAS_PHI_KILL;
128 /// Returns true if this value is re-defined by an early clobber somewhere
129 /// during the live range.
130 bool hasRedefByEC() const { return flags & REDEF_BY_EC; }
131 /// Set the "redef by early clobber" flag on this value.
132 void setHasRedefByEC(bool hasRedef) {
134 flags |= REDEF_BY_EC;
136 flags &= ~REDEF_BY_EC;
139 /// Returns true if this value is defined by a PHI instruction (or was,
140 /// PHI instrucions may have been eliminated).
141 bool isPHIDef() const { return flags & IS_PHI_DEF; }
142 /// Set the "phi def" flag on this value.
143 void setIsPHIDef(bool phiDef) {
147 flags &= ~IS_PHI_DEF;
150 /// Returns true if this value is unused.
151 bool isUnused() const { return flags & IS_UNUSED; }
152 /// Set the "is unused" flag on this value.
153 void setIsUnused(bool unused) {
160 /// Returns true if the def is accurate.
161 bool isDefAccurate() const { return flags & IS_DEF_ACCURATE; }
162 /// Set the "is def accurate" flag on this value.
163 void setIsDefAccurate(bool defAccurate) {
165 flags |= IS_DEF_ACCURATE;
167 flags &= ~IS_DEF_ACCURATE;
171 /// LiveRange structure - This represents a simple register range in the
172 /// program, with an inclusive start point and an exclusive end point.
173 /// These ranges are rendered as [start,end).
175 SlotIndex start; // Start point of the interval (inclusive)
176 SlotIndex end; // End point of the interval (exclusive)
177 VNInfo *valno; // identifier for the value contained in this interval.
179 LiveRange(SlotIndex S, SlotIndex E, VNInfo *V)
180 : start(S), end(E), valno(V) {
182 assert(S < E && "Cannot create empty or backwards range");
185 /// contains - Return true if the index is covered by this range.
187 bool contains(SlotIndex I) const {
188 return start <= I && I < end;
191 /// containsRange - Return true if the given range, [S, E), is covered by
193 bool containsRange(SlotIndex S, SlotIndex E) const {
194 assert((S < E) && "Backwards interval?");
195 return (start <= S && S < end) && (start < E && E <= end);
198 bool operator<(const LiveRange &LR) const {
199 return start < LR.start || (start == LR.start && end < LR.end);
201 bool operator==(const LiveRange &LR) const {
202 return start == LR.start && end == LR.end;
206 void print(raw_ostream &os) const;
209 LiveRange(); // DO NOT IMPLEMENT
212 template <> struct isPodLike<LiveRange> { static const bool value = true; };
214 raw_ostream& operator<<(raw_ostream& os, const LiveRange &LR);
217 inline bool operator<(SlotIndex V, const LiveRange &LR) {
221 inline bool operator<(const LiveRange &LR, SlotIndex V) {
225 /// LiveInterval - This class represents some number of live ranges for a
226 /// register or value. This class also contains a bit of register allocator
231 typedef SmallVector<LiveRange,4> Ranges;
232 typedef SmallVector<VNInfo*,4> VNInfoList;
234 unsigned reg; // the register or stack slot of this interval
235 // if the top bits is set, it represents a stack slot.
236 float weight; // weight of this interval
237 Ranges ranges; // the ranges in which this register is live
238 VNInfoList valnos; // value#'s
251 LiveInterval(unsigned Reg, float Weight, bool IsSS = false)
252 : reg(Reg), weight(Weight) {
254 reg = reg | (1U << (sizeof(unsigned)*CHAR_BIT-1));
257 typedef Ranges::iterator iterator;
258 iterator begin() { return ranges.begin(); }
259 iterator end() { return ranges.end(); }
261 typedef Ranges::const_iterator const_iterator;
262 const_iterator begin() const { return ranges.begin(); }
263 const_iterator end() const { return ranges.end(); }
265 typedef VNInfoList::iterator vni_iterator;
266 vni_iterator vni_begin() { return valnos.begin(); }
267 vni_iterator vni_end() { return valnos.end(); }
269 typedef VNInfoList::const_iterator const_vni_iterator;
270 const_vni_iterator vni_begin() const { return valnos.begin(); }
271 const_vni_iterator vni_end() const { return valnos.end(); }
273 /// advanceTo - Advance the specified iterator to point to the LiveRange
274 /// containing the specified position, or end() if the position is past the
275 /// end of the interval. If no LiveRange contains this position, but the
276 /// position is in a hole, this method returns an iterator pointing to the
277 /// LiveRange immediately after the hole.
278 iterator advanceTo(iterator I, SlotIndex Pos) {
279 if (Pos >= endIndex())
281 while (I->end <= Pos) ++I;
290 /// isStackSlot - Return true if this is a stack slot interval.
292 bool isStackSlot() const {
293 return reg & (1U << (sizeof(unsigned)*CHAR_BIT-1));
296 /// getStackSlotIndex - Return stack slot index if this is a stack slot
298 int getStackSlotIndex() const {
299 assert(isStackSlot() && "Interval is not a stack slot interval!");
300 return reg & ~(1U << (sizeof(unsigned)*CHAR_BIT-1));
303 bool hasAtLeastOneValue() const { return !valnos.empty(); }
305 bool containsOneValue() const { return valnos.size() == 1; }
307 unsigned getNumValNums() const { return (unsigned)valnos.size(); }
309 /// getValNumInfo - Returns pointer to the specified val#.
311 inline VNInfo *getValNumInfo(unsigned ValNo) {
312 return valnos[ValNo];
314 inline const VNInfo *getValNumInfo(unsigned ValNo) const {
315 return valnos[ValNo];
318 /// getNextValue - Create a new value number and return it. MIIdx specifies
319 /// the instruction that defines the value number.
320 VNInfo *getNextValue(SlotIndex def, MachineInstr *CopyMI,
321 bool isDefAccurate, VNInfo::Allocator &VNInfoAllocator) {
323 new (VNInfoAllocator) VNInfo((unsigned)valnos.size(), def, CopyMI);
324 VNI->setIsDefAccurate(isDefAccurate);
325 valnos.push_back(VNI);
329 /// Create a copy of the given value. The new value will be identical except
330 /// for the Value number.
331 VNInfo *createValueCopy(const VNInfo *orig,
332 VNInfo::Allocator &VNInfoAllocator) {
334 new (VNInfoAllocator) VNInfo((unsigned)valnos.size(), *orig);
335 valnos.push_back(VNI);
339 /// RenumberValues - Renumber all values in order of appearance and remove
341 /// Recalculate phi-kill flags in case any phi-def values were removed.
342 void RenumberValues(LiveIntervals &lis);
344 /// isOnlyLROfValNo - Return true if the specified live range is the only
345 /// one defined by the its val#.
346 bool isOnlyLROfValNo(const LiveRange *LR) {
347 for (const_iterator I = begin(), E = end(); I != E; ++I) {
348 const LiveRange *Tmp = I;
349 if (Tmp != LR && Tmp->valno == LR->valno)
355 /// MergeValueNumberInto - This method is called when two value nubmers
356 /// are found to be equivalent. This eliminates V1, replacing all
357 /// LiveRanges with the V1 value number with the V2 value number. This can
358 /// cause merging of V1/V2 values numbers and compaction of the value space.
359 VNInfo* MergeValueNumberInto(VNInfo *V1, VNInfo *V2);
361 /// MergeInClobberRanges - For any live ranges that are not defined in the
362 /// current interval, but are defined in the Clobbers interval, mark them
363 /// used with an unknown definition value. Caller must pass in reference to
364 /// VNInfoAllocator since it will create a new val#.
365 void MergeInClobberRanges(LiveIntervals &li_,
366 const LiveInterval &Clobbers,
367 VNInfo::Allocator &VNInfoAllocator);
369 /// MergeInClobberRange - Same as MergeInClobberRanges except it merge in a
370 /// single LiveRange only.
371 void MergeInClobberRange(LiveIntervals &li_,
374 VNInfo::Allocator &VNInfoAllocator);
376 /// MergeValueInAsValue - Merge all of the live ranges of a specific val#
377 /// in RHS into this live interval as the specified value number.
378 /// The LiveRanges in RHS are allowed to overlap with LiveRanges in the
379 /// current interval, it will replace the value numbers of the overlaped
380 /// live ranges with the specified value number.
381 void MergeRangesInAsValue(const LiveInterval &RHS, VNInfo *LHSValNo);
383 /// MergeValueInAsValue - Merge all of the live ranges of a specific val#
384 /// in RHS into this live interval as the specified value number.
385 /// The LiveRanges in RHS are allowed to overlap with LiveRanges in the
386 /// current interval, but only if the overlapping LiveRanges have the
387 /// specified value number.
388 void MergeValueInAsValue(const LiveInterval &RHS,
389 const VNInfo *RHSValNo, VNInfo *LHSValNo);
391 /// Copy - Copy the specified live interval. This copies all the fields
392 /// except for the register of the interval.
393 void Copy(const LiveInterval &RHS, MachineRegisterInfo *MRI,
394 VNInfo::Allocator &VNInfoAllocator);
396 bool empty() const { return ranges.empty(); }
398 /// beginIndex - Return the lowest numbered slot covered by interval.
399 SlotIndex beginIndex() const {
400 assert(!empty() && "Call to beginIndex() on empty interval.");
401 return ranges.front().start;
404 /// endNumber - return the maximum point of the interval of the whole,
406 SlotIndex endIndex() const {
407 assert(!empty() && "Call to endIndex() on empty interval.");
408 return ranges.back().end;
411 bool expiredAt(SlotIndex index) const {
412 return index >= endIndex();
415 bool liveAt(SlotIndex index) const;
417 // liveBeforeAndAt - Check if the interval is live at the index and the
418 // index just before it. If index is liveAt, check if it starts a new live
419 // range.If it does, then check if the previous live range ends at index-1.
420 bool liveBeforeAndAt(SlotIndex index) const;
422 /// killedAt - Return true if a live range ends at index. Note that the kill
423 /// point is not contained in the half-open live range. It is usually the
424 /// getDefIndex() slot following its last use.
425 bool killedAt(SlotIndex index) const;
427 /// killedInRange - Return true if the interval has kills in [Start,End).
428 /// Note that the kill point is considered the end of a live range, so it is
429 /// not contained in the live range. If a live range ends at End, it won't
430 /// be counted as a kill by this method.
431 bool killedInRange(SlotIndex Start, SlotIndex End) const;
433 /// getLiveRangeContaining - Return the live range that contains the
434 /// specified index, or null if there is none.
435 const LiveRange *getLiveRangeContaining(SlotIndex Idx) const {
436 const_iterator I = FindLiveRangeContaining(Idx);
437 return I == end() ? 0 : &*I;
440 /// getLiveRangeContaining - Return the live range that contains the
441 /// specified index, or null if there is none.
442 LiveRange *getLiveRangeContaining(SlotIndex Idx) {
443 iterator I = FindLiveRangeContaining(Idx);
444 return I == end() ? 0 : &*I;
447 /// getVNInfoAt - Return the VNInfo that is live at Idx, or NULL.
448 VNInfo *getVNInfoAt(SlotIndex Idx) const {
449 const_iterator I = FindLiveRangeContaining(Idx);
450 return I == end() ? 0 : I->valno;
453 /// FindLiveRangeContaining - Return an iterator to the live range that
454 /// contains the specified index, or end() if there is none.
455 const_iterator FindLiveRangeContaining(SlotIndex Idx) const;
457 /// FindLiveRangeContaining - Return an iterator to the live range that
458 /// contains the specified index, or end() if there is none.
459 iterator FindLiveRangeContaining(SlotIndex Idx);
461 /// findDefinedVNInfo - Find the by the specified
462 /// index (register interval) or defined
463 VNInfo *findDefinedVNInfoForRegInt(SlotIndex Idx) const;
465 /// findDefinedVNInfo - Find the VNInfo that's defined by the specified
466 /// register (stack inteval only).
467 VNInfo *findDefinedVNInfoForStackInt(unsigned Reg) const;
470 /// overlaps - Return true if the intersection of the two live intervals is
472 bool overlaps(const LiveInterval& other) const {
475 return overlapsFrom(other, other.begin());
478 /// overlaps - Return true if the live interval overlaps a range specified
480 bool overlaps(SlotIndex Start, SlotIndex End) const;
482 /// overlapsFrom - Return true if the intersection of the two live intervals
483 /// is not empty. The specified iterator is a hint that we can begin
484 /// scanning the Other interval starting at I.
485 bool overlapsFrom(const LiveInterval& other, const_iterator I) const;
487 /// addRange - Add the specified LiveRange to this interval, merging
488 /// intervals as appropriate. This returns an iterator to the inserted live
489 /// range (which may have grown since it was inserted.
490 void addRange(LiveRange LR) {
491 addRangeFrom(LR, ranges.begin());
494 /// join - Join two live intervals (this, and other) together. This applies
495 /// mappings to the value numbers in the LHS/RHS intervals as specified. If
496 /// the intervals are not joinable, this aborts.
497 void join(LiveInterval &Other,
498 const int *ValNoAssignments,
499 const int *RHSValNoAssignments,
500 SmallVector<VNInfo*, 16> &NewVNInfo,
501 MachineRegisterInfo *MRI);
503 /// isInOneLiveRange - Return true if the range specified is entirely in the
504 /// a single LiveRange of the live interval.
505 bool isInOneLiveRange(SlotIndex Start, SlotIndex End);
507 /// removeRange - Remove the specified range from this interval. Note that
508 /// the range must be a single LiveRange in its entirety.
509 void removeRange(SlotIndex Start, SlotIndex End,
510 bool RemoveDeadValNo = false);
512 void removeRange(LiveRange LR, bool RemoveDeadValNo = false) {
513 removeRange(LR.start, LR.end, RemoveDeadValNo);
516 /// removeValNo - Remove all the ranges defined by the specified value#.
517 /// Also remove the value# from value# list.
518 void removeValNo(VNInfo *ValNo);
520 /// getSize - Returns the sum of sizes of all the LiveRange's.
522 unsigned getSize() const;
524 /// Returns true if the live interval is zero length, i.e. no live ranges
525 /// span instructions. It doesn't pay to spill such an interval.
526 bool isZeroLength() const {
527 for (const_iterator i = begin(), e = end(); i != e; ++i)
528 if (i->end.getPrevIndex() > i->start)
533 /// isSpillable - Can this interval be spilled?
534 bool isSpillable() const {
535 return weight != HUGE_VALF;
538 /// markNotSpillable - Mark interval as not spillable
539 void markNotSpillable() {
543 /// ComputeJoinedWeight - Set the weight of a live interval after
544 /// Other has been merged into it.
545 void ComputeJoinedWeight(const LiveInterval &Other);
547 bool operator<(const LiveInterval& other) const {
548 const SlotIndex &thisIndex = beginIndex();
549 const SlotIndex &otherIndex = other.beginIndex();
550 return (thisIndex < otherIndex ||
551 (thisIndex == otherIndex && reg < other.reg));
554 void print(raw_ostream &OS, const TargetRegisterInfo *TRI = 0) const;
559 Ranges::iterator addRangeFrom(LiveRange LR, Ranges::iterator From);
560 void extendIntervalEndTo(Ranges::iterator I, SlotIndex NewEnd);
561 Ranges::iterator extendIntervalStartTo(Ranges::iterator I, SlotIndex NewStr);
562 void markValNoForDeletion(VNInfo *V);
564 LiveInterval& operator=(const LiveInterval& rhs); // DO NOT IMPLEMENT
568 inline raw_ostream &operator<<(raw_ostream &OS, const LiveInterval &LI) {