1 //===-- LiveIntervals.cpp - Live Interval Analysis ------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the LiveInterval analysis pass which is used
11 // by the Linear Scan Register allocator. This pass linearizes the
12 // basic blocks of the function in DFS order and uses the
13 // LiveVariables pass to conservatively compute live intervals for
14 // each virtual and physical register.
16 //===----------------------------------------------------------------------===//
18 #define DEBUG_TYPE "liveintervals"
19 #include "LiveIntervals.h"
20 #include "llvm/Analysis/LoopInfo.h"
21 #include "llvm/CodeGen/LiveVariables.h"
22 #include "llvm/CodeGen/MachineFrameInfo.h"
23 #include "llvm/CodeGen/MachineInstr.h"
24 #include "llvm/CodeGen/Passes.h"
25 #include "llvm/CodeGen/SSARegMap.h"
26 #include "llvm/Target/MRegisterInfo.h"
27 #include "llvm/Target/TargetInstrInfo.h"
28 #include "llvm/Target/TargetMachine.h"
29 #include "llvm/Support/CFG.h"
30 #include "Support/CommandLine.h"
31 #include "Support/Debug.h"
32 #include "Support/Statistic.h"
33 #include "Support/STLExtras.h"
34 #include "VirtRegMap.h"
42 RegisterAnalysis<LiveIntervals> X("liveintervals",
43 "Live Interval Analysis");
45 Statistic<> numIntervals
46 ("liveintervals", "Number of original intervals");
48 Statistic<> numIntervalsAfter
49 ("liveintervals", "Number of intervals after coalescing");
52 ("liveintervals", "Number of interval joins performed");
55 ("liveintervals", "Number of identity moves eliminated after coalescing");
58 ("liveintervals", "Number of loads/stores folded into instructions");
61 join("join-liveintervals",
62 cl::desc("Join compatible live intervals"),
66 void LiveIntervals::getAnalysisUsage(AnalysisUsage &AU) const
68 AU.addPreserved<LiveVariables>();
69 AU.addRequired<LiveVariables>();
70 AU.addPreservedID(PHIEliminationID);
71 AU.addRequiredID(PHIEliminationID);
72 AU.addRequiredID(TwoAddressInstructionPassID);
73 AU.addRequired<LoopInfo>();
74 MachineFunctionPass::getAnalysisUsage(AU);
77 void LiveIntervals::releaseMemory()
88 /// runOnMachineFunction - Register allocate the whole function
90 bool LiveIntervals::runOnMachineFunction(MachineFunction &fn) {
92 tm_ = &fn.getTarget();
93 mri_ = tm_->getRegisterInfo();
94 lv_ = &getAnalysis<LiveVariables>();
96 // number MachineInstrs
98 for (MachineFunction::iterator mbb = mf_->begin(), mbbEnd = mf_->end();
99 mbb != mbbEnd; ++mbb) {
100 const std::pair<MachineBasicBlock*, unsigned>& entry =
101 lv_->getMachineBasicBlockInfo(mbb);
102 bool inserted = mbbi2mbbMap_.insert(std::make_pair(entry.second,
103 entry.first)).second;
104 assert(inserted && "multiple index -> MachineBasicBlock");
106 for (MachineBasicBlock::iterator mi = mbb->begin(), miEnd = mbb->end();
108 inserted = mi2iMap_.insert(std::make_pair(mi, miIndex)).second;
109 assert(inserted && "multiple MachineInstr -> index mappings");
110 i2miMap_.push_back(mi);
111 miIndex += InstrSlots::NUM;
117 numIntervals += intervals_.size();
119 // join intervals if requested
120 if (join) joinIntervals();
122 numIntervalsAfter += intervals_.size();
124 // perform a final pass over the instructions and compute spill
125 // weights, coalesce virtual registers and remove identity moves
126 const LoopInfo& loopInfo = getAnalysis<LoopInfo>();
127 const TargetInstrInfo& tii = tm_->getInstrInfo();
129 for (MachineFunction::iterator mbbi = mf_->begin(), mbbe = mf_->end();
130 mbbi != mbbe; ++mbbi) {
131 MachineBasicBlock* mbb = mbbi;
132 unsigned loopDepth = loopInfo.getLoopDepth(mbb->getBasicBlock());
134 for (MachineBasicBlock::iterator mii = mbb->begin(), mie = mbb->end();
136 for (unsigned i = 0; i < mii->getNumOperands(); ++i) {
137 const MachineOperand& mop = mii->getOperand(i);
138 if (mop.isRegister() && mop.getReg()) {
139 // replace register with representative register
140 unsigned reg = rep(mop.getReg());
141 mii->SetMachineOperandReg(i, reg);
143 if (MRegisterInfo::isVirtualRegister(reg)) {
144 Reg2IntervalMap::iterator r2iit = r2iMap_.find(reg);
145 assert(r2iit != r2iMap_.end());
146 r2iit->second->weight += pow(10.0F, loopDepth);
151 // if the move is now an identity move delete it
152 unsigned srcReg, dstReg;
153 if (tii.isMoveInstr(*mii, srcReg, dstReg) && srcReg == dstReg) {
154 // remove from def list
155 Interval& interval = getOrCreateInterval(dstReg);
156 unsigned defIndex = getInstructionIndex(mii);
157 Interval::Defs::iterator d = std::lower_bound(
158 interval.defs.begin(), interval.defs.end(), defIndex);
159 assert(*d == defIndex && "Def index not found in def list!");
160 interval.defs.erase(d);
161 // remove index -> MachineInstr and
162 // MachineInstr -> index mappings
163 Mi2IndexMap::iterator mi2i = mi2iMap_.find(mii);
164 if (mi2i != mi2iMap_.end()) {
165 i2miMap_[mi2i->second/InstrSlots::NUM] = 0;
166 mi2iMap_.erase(mi2i);
168 mii = mbbi->erase(mii);
176 intervals_.sort(StartPointComp());
177 DEBUG(std::cerr << "********** INTERVALS **********\n");
178 DEBUG(std::copy(intervals_.begin(), intervals_.end(),
179 std::ostream_iterator<Interval>(std::cerr, "\n")));
180 DEBUG(std::cerr << "********** MACHINEINSTRS **********\n");
182 for (MachineFunction::iterator mbbi = mf_->begin(), mbbe = mf_->end();
183 mbbi != mbbe; ++mbbi) {
184 std::cerr << mbbi->getBasicBlock()->getName() << ":\n";
185 for (MachineBasicBlock::iterator mii = mbbi->begin(),
186 mie = mbbi->end(); mii != mie; ++mii) {
187 std::cerr << getInstructionIndex(mii) << '\t';
188 mii->print(std::cerr, *tm_);
195 void LiveIntervals::updateSpilledInterval(Interval& li,
199 assert(li.weight != std::numeric_limits<float>::infinity() &&
200 "attempt to spill already spilled interval!");
201 Interval::Ranges oldRanges;
202 swap(oldRanges, li.ranges);
204 DEBUG(std::cerr << "\t\t\t\tupdating interval: " << li);
206 for (Interval::Ranges::iterator i = oldRanges.begin(), e = oldRanges.end();
208 unsigned index = getBaseIndex(i->first);
209 unsigned end = getBaseIndex(i->second-1) + InstrSlots::NUM;
210 for (; index < end; index += InstrSlots::NUM) {
211 // skip deleted instructions
212 while (!getInstructionFromIndex(index)) index += InstrSlots::NUM;
213 MachineBasicBlock::iterator mi = getInstructionFromIndex(index);
216 for (unsigned i = 0; i < mi->getNumOperands(); ++i) {
217 MachineOperand& mop = mi->getOperand(i);
218 if (mop.isRegister() && mop.getReg() == li.reg) {
219 if (MachineInstr* fmi =
220 mri_->foldMemoryOperand(mi, i, slot)) {
221 lv_->instructionChanged(mi, fmi);
222 vrm.virtFolded(li.reg, mi, fmi);
224 i2miMap_[index/InstrSlots::NUM] = fmi;
225 mi2iMap_[fmi] = index;
226 MachineBasicBlock& mbb = *mi->getParent();
227 mi = mbb.insert(mbb.erase(mi), fmi);
232 // This is tricky. We need to add information in
233 // the interval about the spill code so we have to
234 // use our extra load/store slots.
236 // If we have a use we are going to have a load so
237 // we start the interval from the load slot
238 // onwards. Otherwise we start from the def slot.
239 unsigned start = (mop.isUse() ?
240 getLoadIndex(index) :
242 // If we have a def we are going to have a store
243 // right after it so we end the interval after the
244 // use of the next instruction. Otherwise we end
245 // after the use of this instruction.
246 unsigned end = 1 + (mop.isDef() ?
247 getUseIndex(index+InstrSlots::NUM) :
249 li.addRange(start, end);
255 // the new spill weight is now infinity as it cannot be spilled again
256 li.weight = std::numeric_limits<float>::infinity();
257 DEBUG(std::cerr << '\n');
258 DEBUG(std::cerr << "\t\t\t\tupdated interval: " << li << '\n');
261 void LiveIntervals::printRegName(unsigned reg) const
263 if (MRegisterInfo::isPhysicalRegister(reg))
264 std::cerr << mri_->getName(reg);
266 std::cerr << "%reg" << reg;
269 void LiveIntervals::handleVirtualRegisterDef(MachineBasicBlock* mbb,
270 MachineBasicBlock::iterator mi,
273 DEBUG(std::cerr << "\t\tregister: "; printRegName(interval.reg));
274 LiveVariables::VarInfo& vi = lv_->getVarInfo(interval.reg);
276 // iterate over all of the blocks that the variable is completely
277 // live in, adding them to the live interval. obviously we only
278 // need to do this once.
279 if (interval.empty()) {
280 for (unsigned i = 0, e = vi.AliveBlocks.size(); i != e; ++i) {
281 if (vi.AliveBlocks[i]) {
282 MachineBasicBlock* mbb = lv_->getIndexMachineBasicBlock(i);
285 getInstructionIndex(&mbb->front()),
286 getInstructionIndex(&mbb->back()) + InstrSlots::NUM);
292 unsigned baseIndex = getInstructionIndex(mi);
293 interval.defs.push_back(baseIndex);
295 bool killedInDefiningBasicBlock = false;
296 for (int i = 0, e = vi.Kills.size(); i != e; ++i) {
297 MachineBasicBlock* killerBlock = vi.Kills[i].first;
298 MachineInstr* killerInstr = vi.Kills[i].second;
299 unsigned start = (mbb == killerBlock ?
300 getDefIndex(baseIndex) :
301 getInstructionIndex(&killerBlock->front()));
302 unsigned end = (killerInstr == mi ?
306 getUseIndex(getInstructionIndex(killerInstr))+1);
307 // we do not want to add invalid ranges. these can happen when
308 // a variable has its latest use and is redefined later on in
309 // the same basic block (common with variables introduced by
312 killedInDefiningBasicBlock |= mbb == killerBlock;
313 interval.addRange(start, end);
317 if (!killedInDefiningBasicBlock) {
318 unsigned end = getInstructionIndex(&mbb->back()) + InstrSlots::NUM;
319 interval.addRange(getDefIndex(baseIndex), end);
321 DEBUG(std::cerr << '\n');
324 void LiveIntervals::handlePhysicalRegisterDef(MachineBasicBlock* mbb,
325 MachineBasicBlock::iterator mi,
328 DEBUG(std::cerr << "\t\tregister: "; printRegName(interval.reg));
329 typedef LiveVariables::killed_iterator KillIter;
331 MachineBasicBlock::iterator e = mbb->end();
332 unsigned baseIndex = getInstructionIndex(mi);
333 interval.defs.push_back(baseIndex);
334 unsigned start = getDefIndex(baseIndex);
335 unsigned end = start;
337 // a variable can be dead by the instruction defining it
338 for (KillIter ki = lv_->dead_begin(mi), ke = lv_->dead_end(mi);
340 if (interval.reg == ki->second) {
341 DEBUG(std::cerr << " dead");
342 end = getDefIndex(start) + 1;
347 // a variable can only be killed by subsequent instructions
350 baseIndex += InstrSlots::NUM;
351 for (KillIter ki = lv_->killed_begin(mi), ke = lv_->killed_end(mi);
353 if (interval.reg == ki->second) {
354 DEBUG(std::cerr << " killed");
355 end = getUseIndex(baseIndex) + 1;
362 assert(start < end && "did not find end of interval?");
363 interval.addRange(start, end);
364 DEBUG(std::cerr << '\n');
367 void LiveIntervals::handleRegisterDef(MachineBasicBlock* mbb,
368 MachineBasicBlock::iterator mi,
371 if (MRegisterInfo::isPhysicalRegister(reg)) {
372 if (lv_->getAllocatablePhysicalRegisters()[reg]) {
373 handlePhysicalRegisterDef(mbb, mi, getOrCreateInterval(reg));
374 for (const unsigned* as = mri_->getAliasSet(reg); *as; ++as)
375 handlePhysicalRegisterDef(mbb, mi, getOrCreateInterval(*as));
379 handleVirtualRegisterDef(mbb, mi, getOrCreateInterval(reg));
382 unsigned LiveIntervals::getInstructionIndex(MachineInstr* instr) const
384 Mi2IndexMap::const_iterator it = mi2iMap_.find(instr);
385 return (it == mi2iMap_.end() ?
386 std::numeric_limits<unsigned>::max() :
390 MachineInstr* LiveIntervals::getInstructionFromIndex(unsigned index) const
392 index /= InstrSlots::NUM; // convert index to vector index
393 assert(index < i2miMap_.size() &&
394 "index does not correspond to an instruction");
395 return i2miMap_[index];
398 /// computeIntervals - computes the live intervals for virtual
399 /// registers. for some ordering of the machine instructions [1,N] a
400 /// live interval is an interval [i, j) where 1 <= i <= j < N for
401 /// which a variable is live
402 void LiveIntervals::computeIntervals()
404 DEBUG(std::cerr << "********** COMPUTING LIVE INTERVALS **********\n");
405 DEBUG(std::cerr << "********** Function: "
406 << mf_->getFunction()->getName() << '\n');
408 for (MbbIndex2MbbMap::iterator
409 it = mbbi2mbbMap_.begin(), itEnd = mbbi2mbbMap_.end();
411 MachineBasicBlock* mbb = it->second;
412 DEBUG(std::cerr << mbb->getBasicBlock()->getName() << ":\n");
414 for (MachineBasicBlock::iterator mi = mbb->begin(), miEnd = mbb->end();
416 const TargetInstrDescriptor& tid =
417 tm_->getInstrInfo().get(mi->getOpcode());
418 DEBUG(std::cerr << getInstructionIndex(mi) << "\t";
419 mi->print(std::cerr, *tm_));
421 // handle implicit defs
422 for (const unsigned* id = tid.ImplicitDefs; *id; ++id)
423 handleRegisterDef(mbb, mi, *id);
425 // handle explicit defs
426 for (int i = mi->getNumOperands() - 1; i >= 0; --i) {
427 MachineOperand& mop = mi->getOperand(i);
428 // handle register defs - build intervals
429 if (mop.isRegister() && mop.getReg() && mop.isDef())
430 handleRegisterDef(mbb, mi, mop.getReg());
436 unsigned LiveIntervals::rep(unsigned reg)
438 Reg2RegMap::iterator it = r2rMap_.find(reg);
439 if (it != r2rMap_.end())
440 return it->second = rep(it->second);
444 void LiveIntervals::joinIntervals()
446 DEBUG(std::cerr << "********** JOINING INTERVALS ***********\n");
448 const TargetInstrInfo& tii = tm_->getInstrInfo();
450 for (MachineFunction::iterator mbbi = mf_->begin(), mbbe = mf_->end();
451 mbbi != mbbe; ++mbbi) {
452 MachineBasicBlock* mbb = mbbi;
453 DEBUG(std::cerr << mbb->getBasicBlock()->getName() << ":\n");
455 for (MachineBasicBlock::iterator mi = mbb->begin(), mie = mbb->end();
457 const TargetInstrDescriptor& tid =
458 tm_->getInstrInfo().get(mi->getOpcode());
459 DEBUG(std::cerr << getInstructionIndex(mi) << '\t';
460 mi->print(std::cerr, *tm_););
462 // we only join virtual registers with allocatable
463 // physical registers since we do not have liveness information
464 // on not allocatable physical registers
466 if (tii.isMoveInstr(*mi, regA, regB) &&
467 (MRegisterInfo::isVirtualRegister(regA) ||
468 lv_->getAllocatablePhysicalRegisters()[regA]) &&
469 (MRegisterInfo::isVirtualRegister(regB) ||
470 lv_->getAllocatablePhysicalRegisters()[regB])) {
472 // get representative registers
476 // if they are already joined we continue
480 Reg2IntervalMap::iterator r2iA = r2iMap_.find(regA);
481 assert(r2iA != r2iMap_.end());
482 Reg2IntervalMap::iterator r2iB = r2iMap_.find(regB);
483 assert(r2iB != r2iMap_.end());
485 Intervals::iterator intA = r2iA->second;
486 Intervals::iterator intB = r2iB->second;
488 // both A and B are virtual registers
489 if (MRegisterInfo::isVirtualRegister(intA->reg) &&
490 MRegisterInfo::isVirtualRegister(intB->reg)) {
492 const TargetRegisterClass *rcA, *rcB;
493 rcA = mf_->getSSARegMap()->getRegClass(intA->reg);
494 rcB = mf_->getSSARegMap()->getRegClass(intB->reg);
495 assert(rcA == rcB && "registers must be of the same class");
497 // if their intervals do not overlap we join them
498 if (!intB->overlaps(*intA)) {
500 r2iB->second = r2iA->second;
501 r2rMap_.insert(std::make_pair(intB->reg, intA->reg));
502 intervals_.erase(intB);
505 else if (MRegisterInfo::isPhysicalRegister(intA->reg) ^
506 MRegisterInfo::isPhysicalRegister(intB->reg)) {
507 if (MRegisterInfo::isPhysicalRegister(intB->reg)) {
508 std::swap(regA, regB);
509 std::swap(intA, intB);
510 std::swap(r2iA, r2iB);
513 assert(MRegisterInfo::isPhysicalRegister(intA->reg) &&
514 MRegisterInfo::isVirtualRegister(intB->reg) &&
515 "A must be physical and B must be virtual");
517 if (!intA->overlaps(*intB) &&
518 !overlapsAliases(*intA, *intB)) {
520 r2iB->second = r2iA->second;
521 r2rMap_.insert(std::make_pair(intB->reg, intA->reg));
522 intervals_.erase(intB);
530 bool LiveIntervals::overlapsAliases(const Interval& lhs,
531 const Interval& rhs) const
533 assert(MRegisterInfo::isPhysicalRegister(lhs.reg) &&
534 "first interval must describe a physical register");
536 for (const unsigned* as = mri_->getAliasSet(lhs.reg); *as; ++as) {
537 Reg2IntervalMap::const_iterator r2i = r2iMap_.find(*as);
538 assert(r2i != r2iMap_.end() && "alias does not have interval?");
539 if (rhs.overlaps(*r2i->second))
546 LiveIntervals::Interval& LiveIntervals::getOrCreateInterval(unsigned reg)
548 Reg2IntervalMap::iterator r2iit = r2iMap_.lower_bound(reg);
549 if (r2iit == r2iMap_.end() || r2iit->first != reg) {
550 intervals_.push_back(Interval(reg));
551 r2iit = r2iMap_.insert(r2iit, std::make_pair(reg, --intervals_.end()));
554 return *r2iit->second;
557 LiveIntervals::Interval::Interval(unsigned r)
559 weight((MRegisterInfo::isPhysicalRegister(r) ?
560 std::numeric_limits<float>::infinity() : 0.0F))
565 bool LiveIntervals::Interval::spilled() const
567 return (weight == std::numeric_limits<float>::infinity() &&
568 MRegisterInfo::isVirtualRegister(reg));
571 // An example for liveAt():
573 // this = [1,4), liveAt(0) will return false. The instruction defining
574 // this spans slots [0,3]. The interval belongs to an spilled
575 // definition of the variable it represents. This is because slot 1 is
576 // used (def slot) and spans up to slot 3 (store slot).
578 bool LiveIntervals::Interval::liveAt(unsigned index) const
580 Range dummy(index, index+1);
581 Ranges::const_iterator r = std::upper_bound(ranges.begin(),
584 if (r == ranges.begin())
588 return index >= r->first && index < r->second;
591 // An example for overlaps():
595 // 8: C = A + B ;; last use of A
597 // The live intervals should look like:
603 // A->overlaps(C) should return false since we want to be able to join
605 bool LiveIntervals::Interval::overlaps(const Interval& other) const
607 Ranges::const_iterator i = ranges.begin();
608 Ranges::const_iterator ie = ranges.end();
609 Ranges::const_iterator j = other.ranges.begin();
610 Ranges::const_iterator je = other.ranges.end();
611 if (i->first < j->first) {
612 i = std::upper_bound(i, ie, *j);
613 if (i != ranges.begin()) --i;
615 else if (j->first < i->first) {
616 j = std::upper_bound(j, je, *i);
617 if (j != other.ranges.begin()) --j;
620 while (i != ie && j != je) {
621 if (i->first == j->first) {
625 if (i->first > j->first) {
629 assert(i->first < j->first);
631 if (i->second > j->first) {
643 void LiveIntervals::Interval::addRange(unsigned start, unsigned end)
645 assert(start < end && "Invalid range to add!");
646 DEBUG(std::cerr << " +[" << start << ',' << end << ")");
647 //assert(start < end && "invalid range?");
648 Range range = std::make_pair(start, end);
649 Ranges::iterator it =
650 ranges.insert(std::upper_bound(ranges.begin(), ranges.end(), range),
653 it = mergeRangesForward(it);
654 it = mergeRangesBackward(it);
657 void LiveIntervals::Interval::join(const LiveIntervals::Interval& other)
659 DEBUG(std::cerr << "\t\tjoining " << *this << " with " << other << '\n');
660 Ranges::iterator cur = ranges.begin();
662 for (Ranges::const_iterator i = other.ranges.begin(),
663 e = other.ranges.end(); i != e; ++i) {
664 cur = ranges.insert(std::upper_bound(cur, ranges.end(), *i), *i);
665 cur = mergeRangesForward(cur);
666 cur = mergeRangesBackward(cur);
668 weight += other.weight;
670 std::set_union(defs.begin(), defs.end(),
671 other.defs.begin(), other.defs.end(),
672 std::back_inserter(u));
677 LiveIntervals::Interval::Ranges::iterator
678 LiveIntervals::Interval::mergeRangesForward(Ranges::iterator it)
681 while ((n = next(it)) != ranges.end()) {
682 if (n->first > it->second)
684 it->second = std::max(it->second, n->second);
690 LiveIntervals::Interval::Ranges::iterator
691 LiveIntervals::Interval::mergeRangesBackward(Ranges::iterator it)
693 while (it != ranges.begin()) {
694 Ranges::iterator p = prior(it);
695 if (it->first > p->second)
698 it->first = std::min(it->first, p->first);
699 it->second = std::max(it->second, p->second);
700 it = ranges.erase(p);
706 std::ostream& llvm::operator<<(std::ostream& os,
707 const LiveIntervals::Interval& li)
709 os << "%reg" << li.reg << ',' << li.weight;
711 return os << "EMPTY";
713 os << " {" << li.defs.front();
714 for (LiveIntervals::Interval::Defs::const_iterator
715 i = next(li.defs.begin()), e = li.defs.end(); i != e; ++i)
720 for (LiveIntervals::Interval::Ranges::const_iterator
721 i = li.ranges.begin(), e = li.ranges.end(); i != e; ++i) {
722 os << "[" << i->first << "," << i->second << ")";