1 //===-- RegAllocIterativeScan.cpp - Iterative Scan register allocator -----===//
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 an iterative scan register
11 // allocator. Iterative scan is a linear scan variant with the
12 // following difference:
14 // It performs linear scan and keeps a list of the registers it cannot
15 // allocate. It then spills all those registers and repeats the
16 // process until allocation succeeds.
18 //===----------------------------------------------------------------------===//
20 #define DEBUG_TYPE "regalloc"
21 #include "llvm/Function.h"
22 #include "llvm/CodeGen/LiveVariables.h"
23 #include "llvm/CodeGen/MachineFunctionPass.h"
24 #include "llvm/CodeGen/MachineInstr.h"
25 #include "llvm/CodeGen/Passes.h"
26 #include "llvm/CodeGen/SSARegMap.h"
27 #include "llvm/Target/MRegisterInfo.h"
28 #include "llvm/Target/TargetMachine.h"
29 #include "Support/Debug.h"
30 #include "Support/Statistic.h"
31 #include "Support/STLExtras.h"
32 #include "LiveIntervals.h"
33 #include "PhysRegTracker.h"
34 #include "VirtRegMap.h"
44 Statistic<double> efficiency
45 ("regalloc", "Ratio of intervals processed over total intervals");
47 static unsigned numIterations = 0;
48 static unsigned numIntervals = 0;
50 class RA : public MachineFunctionPass {
53 const TargetMachine* tm_;
54 const MRegisterInfo* mri_;
56 typedef std::vector<LiveInterval*> IntervalPtrs;
57 IntervalPtrs unhandled_, fixed_, active_, inactive_, handled_, spilled_;
59 std::auto_ptr<PhysRegTracker> prt_;
60 std::auto_ptr<VirtRegMap> vrm_;
61 std::auto_ptr<Spiller> spiller_;
63 typedef std::vector<float> SpillWeights;
64 SpillWeights spillWeights_;
67 virtual const char* getPassName() const {
68 return "Iterative Scan Register Allocator";
71 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
72 AU.addRequired<LiveVariables>();
73 AU.addRequired<LiveIntervals>();
74 MachineFunctionPass::getAnalysisUsage(AU);
77 /// runOnMachineFunction - register allocate the whole function
78 bool runOnMachineFunction(MachineFunction&);
83 /// linearScan - the linear scan algorithm. Returns a boolean
84 /// indicating if there were any spills
87 /// initIntervalSets - initializes the four interval sets:
88 /// unhandled, fixed, active and inactive
89 void initIntervalSets(LiveIntervals::Intervals& li);
91 /// processActiveIntervals - expire old intervals and move
92 /// non-overlapping ones to the incative list
93 void processActiveIntervals(IntervalPtrs::value_type cur);
95 /// processInactiveIntervals - expire old intervals and move
96 /// overlapping ones to the active list
97 void processInactiveIntervals(IntervalPtrs::value_type cur);
99 /// updateSpillWeights - updates the spill weights of the
100 /// specifed physical register and its weight
101 void updateSpillWeights(unsigned reg, SpillWeights::value_type weight);
103 /// assignRegOrStackSlotAtInterval - assign a register if one
104 /// is available, or spill.
105 void assignRegOrSpillAtInterval(IntervalPtrs::value_type cur);
108 /// register handling helpers
111 /// getFreePhysReg - return a free physical register for this
112 /// virtual register interval if we have one, otherwise return
114 unsigned getFreePhysReg(IntervalPtrs::value_type cur);
116 /// assignVirt2StackSlot - assigns this virtual register to a
117 /// stack slot. returns the stack slot
118 int assignVirt2StackSlot(unsigned virtReg);
120 void printIntervals(const char* const str,
121 RA::IntervalPtrs::const_iterator i,
122 RA::IntervalPtrs::const_iterator e) const {
123 if (str) std::cerr << str << " intervals:\n";
124 for (; i != e; ++i) {
125 std::cerr << "\t" << **i << " -> ";
126 unsigned reg = (*i)->reg;
127 if (MRegisterInfo::isVirtualRegister(reg)) {
128 reg = vrm_->getPhys(reg);
130 std::cerr << mri_->getName(reg) << '\n';
136 void RA::releaseMemory()
146 bool RA::runOnMachineFunction(MachineFunction &fn) {
148 tm_ = &fn.getTarget();
149 mri_ = tm_->getRegisterInfo();
150 li_ = &getAnalysis<LiveIntervals>();
151 if (!prt_.get()) prt_.reset(new PhysRegTracker(*mri_));
152 vrm_.reset(new VirtRegMap(*mf_));
153 if (!spiller_.get()) spiller_.reset(createSpiller());
155 initIntervalSets(li_->getIntervals());
157 numIntervals += li_->getIntervals().size();
159 while (linearScan()) {
160 // we spilled some registers, so we need to add intervals for
161 // the spill code and restart the algorithm
162 std::set<unsigned> spilledRegs;
163 for (IntervalPtrs::iterator
164 i = spilled_.begin(); i != spilled_.end(); ++i) {
165 int slot = vrm_->assignVirt2StackSlot((*i)->reg);
166 std::vector<LiveInterval*> added =
167 li_->addIntervalsForSpills(**i, *vrm_, slot);
168 std::copy(added.begin(), added.end(), std::back_inserter(handled_));
169 spilledRegs.insert((*i)->reg);
172 for (IntervalPtrs::iterator
173 i = handled_.begin(); i != handled_.end(); )
174 if (spilledRegs.count((*i)->reg))
175 i = handled_.erase(i);
178 handled_.swap(unhandled_);
179 vrm_->clearAllVirt();
182 efficiency = double(numIterations) / double(numIntervals);
184 DEBUG(std::cerr << *vrm_);
186 spiller_->runOnMachineFunction(*mf_, *vrm_);
191 bool RA::linearScan()
193 // linear scan algorithm
194 DEBUG(std::cerr << "********** LINEAR SCAN **********\n");
195 DEBUG(std::cerr << "********** Function: "
196 << mf_->getFunction()->getName() << '\n');
199 std::sort(unhandled_.begin(), unhandled_.end(),
200 greater_ptr<LiveInterval>());
201 DEBUG(printIntervals("unhandled", unhandled_.begin(), unhandled_.end()));
202 DEBUG(printIntervals("fixed", fixed_.begin(), fixed_.end()));
203 DEBUG(printIntervals("active", active_.begin(), active_.end()));
204 DEBUG(printIntervals("inactive", inactive_.begin(), inactive_.end()));
206 while (!unhandled_.empty()) {
207 // pick the interval with the earliest start point
208 IntervalPtrs::value_type cur = unhandled_.back();
209 unhandled_.pop_back();
211 DEBUG(std::cerr << "\n*** CURRENT ***: " << *cur << '\n');
213 processActiveIntervals(cur);
214 processInactiveIntervals(cur);
216 // if this register is fixed we are done
217 if (MRegisterInfo::isPhysicalRegister(cur->reg)) {
218 prt_->addRegUse(cur->reg);
219 active_.push_back(cur);
220 handled_.push_back(cur);
222 // otherwise we are allocating a virtual register. try to find
223 // a free physical register or spill an interval in order to
224 // assign it one (we could spill the current though).
226 assignRegOrSpillAtInterval(cur);
229 DEBUG(printIntervals("active", active_.begin(), active_.end()));
230 DEBUG(printIntervals("inactive", inactive_.begin(), inactive_.end()));
233 // expire any remaining active intervals
234 for (IntervalPtrs::iterator i = active_.begin(); i != active_.end(); ) {
235 unsigned reg = (*i)->reg;
236 DEBUG(std::cerr << "\tinterval " << **i << " expired\n");
237 if (MRegisterInfo::isVirtualRegister(reg))
238 reg = vrm_->getPhys(reg);
239 prt_->delRegUse(reg);
240 i = active_.erase(i);
243 // expire any remaining inactive intervals
244 for (IntervalPtrs::iterator
245 i = inactive_.begin(); i != inactive_.end(); ) {
246 DEBUG(std::cerr << "\tinterval " << **i << " expired\n");
247 i = inactive_.erase(i);
250 // return true if we spilled anything
251 return !spilled_.empty();
254 void RA::initIntervalSets(LiveIntervals::Intervals& li)
256 assert(unhandled_.empty() && fixed_.empty() &&
257 active_.empty() && inactive_.empty() &&
258 "interval sets should be empty on initialization");
260 for (LiveIntervals::Intervals::iterator i = li.begin(), e = li.end();
262 unhandled_.push_back(&*i);
263 if (MRegisterInfo::isPhysicalRegister(i->reg))
264 fixed_.push_back(&*i);
268 void RA::processActiveIntervals(IntervalPtrs::value_type cur)
270 DEBUG(std::cerr << "\tprocessing active intervals:\n");
271 for (IntervalPtrs::iterator i = active_.begin(); i != active_.end();) {
272 unsigned reg = (*i)->reg;
273 // remove expired intervals
274 if ((*i)->expiredAt(cur->start())) {
275 DEBUG(std::cerr << "\t\tinterval " << **i << " expired\n");
276 if (MRegisterInfo::isVirtualRegister(reg))
277 reg = vrm_->getPhys(reg);
278 prt_->delRegUse(reg);
279 // remove from active
280 i = active_.erase(i);
282 // move inactive intervals to inactive list
283 else if (!(*i)->liveAt(cur->start())) {
284 DEBUG(std::cerr << "\t\tinterval " << **i << " inactive\n");
285 if (MRegisterInfo::isVirtualRegister(reg))
286 reg = vrm_->getPhys(reg);
287 prt_->delRegUse(reg);
289 inactive_.push_back(*i);
290 // remove from active
291 i = active_.erase(i);
299 void RA::processInactiveIntervals(IntervalPtrs::value_type cur)
301 DEBUG(std::cerr << "\tprocessing inactive intervals:\n");
302 for (IntervalPtrs::iterator i = inactive_.begin(); i != inactive_.end();) {
303 unsigned reg = (*i)->reg;
305 // remove expired intervals
306 if ((*i)->expiredAt(cur->start())) {
307 DEBUG(std::cerr << "\t\tinterval " << **i << " expired\n");
308 // remove from inactive
309 i = inactive_.erase(i);
311 // move re-activated intervals in active list
312 else if ((*i)->liveAt(cur->start())) {
313 DEBUG(std::cerr << "\t\tinterval " << **i << " active\n");
314 if (MRegisterInfo::isVirtualRegister(reg))
315 reg = vrm_->getPhys(reg);
316 prt_->addRegUse(reg);
318 active_.push_back(*i);
319 // remove from inactive
320 i = inactive_.erase(i);
328 void RA::updateSpillWeights(unsigned reg, SpillWeights::value_type weight)
330 spillWeights_[reg] += weight;
331 for (const unsigned* as = mri_->getAliasSet(reg); *as; ++as)
332 spillWeights_[*as] += weight;
335 void RA::assignRegOrSpillAtInterval(IntervalPtrs::value_type cur)
337 DEBUG(std::cerr << "\tallocating current interval: ");
339 PhysRegTracker backupPrt = *prt_;
341 spillWeights_.assign(mri_->getNumRegs(), 0.0);
343 // for each interval in active update spill weights
344 for (IntervalPtrs::const_iterator i = active_.begin(), e = active_.end();
346 unsigned reg = (*i)->reg;
347 if (MRegisterInfo::isVirtualRegister(reg))
348 reg = vrm_->getPhys(reg);
349 updateSpillWeights(reg, (*i)->weight);
352 // for every interval in inactive we overlap with, mark the
353 // register as not free and update spill weights
354 for (IntervalPtrs::const_iterator i = inactive_.begin(),
355 e = inactive_.end(); i != e; ++i) {
356 if (cur->overlaps(**i)) {
357 unsigned reg = (*i)->reg;
358 if (MRegisterInfo::isVirtualRegister(reg))
359 reg = vrm_->getPhys(reg);
360 prt_->addRegUse(reg);
361 updateSpillWeights(reg, (*i)->weight);
365 // for every interval in fixed we overlap with,
366 // mark the register as not free and update spill weights
367 for (IntervalPtrs::const_iterator i = fixed_.begin(),
368 e = fixed_.end(); i != e; ++i) {
369 if (cur->overlaps(**i)) {
370 unsigned reg = (*i)->reg;
371 prt_->addRegUse(reg);
372 updateSpillWeights(reg, (*i)->weight);
376 unsigned physReg = getFreePhysReg(cur);
377 // restore the physical register tracker
379 // if we find a free register, we are done: assign this virtual to
380 // the free physical register and add this interval to the active
383 DEBUG(std::cerr << mri_->getName(physReg) << '\n');
384 vrm_->assignVirt2Phys(cur->reg, physReg);
385 prt_->addRegUse(physReg);
386 active_.push_back(cur);
387 handled_.push_back(cur);
390 DEBUG(std::cerr << "no free registers\n");
392 DEBUG(std::cerr << "\tassigning stack slot at interval "<< *cur << ":\n");
394 float minWeight = HUGE_VAL;
396 const TargetRegisterClass* rc = mf_->getSSARegMap()->getRegClass(cur->reg);
397 for (TargetRegisterClass::iterator i = rc->allocation_order_begin(*mf_);
398 i != rc->allocation_order_end(*mf_); ++i) {
400 if (minWeight > spillWeights_[reg]) {
401 minWeight = spillWeights_[reg];
405 DEBUG(std::cerr << "\t\tregister with min weight: "
406 << mri_->getName(minReg) << " (" << minWeight << ")\n");
408 // if the current has the minimum weight, we spill it and move on
409 if (cur->weight <= minWeight) {
410 DEBUG(std::cerr << "\t\t\tspilling(c): " << *cur << '\n');
411 spilled_.push_back(cur);
415 // otherwise we spill all intervals aliasing the register with
416 // minimum weight, assigned the newly cleared register to the
417 // current interval and continue
418 assert(MRegisterInfo::isPhysicalRegister(minReg) &&
419 "did not choose a register to spill?");
420 std::vector<bool> toSpill(mri_->getNumRegs(), false);
421 toSpill[minReg] = true;
422 for (const unsigned* as = mri_->getAliasSet(minReg); *as; ++as)
424 unsigned earliestStart = cur->start();
426 std::set<unsigned> spilled;
428 for (IntervalPtrs::iterator i = active_.begin(); i != active_.end(); ) {
429 unsigned reg = (*i)->reg;
430 if (MRegisterInfo::isVirtualRegister(reg) &&
431 toSpill[vrm_->getPhys(reg)] &&
432 cur->overlaps(**i)) {
433 DEBUG(std::cerr << "\t\t\tspilling(a): " << **i << '\n');
434 spilled_.push_back(*i);
435 prt_->delRegUse(vrm_->getPhys(reg));
436 vrm_->clearVirt(reg);
437 i = active_.erase(i);
442 for (IntervalPtrs::iterator i = inactive_.begin(); i != inactive_.end(); ) {
443 unsigned reg = (*i)->reg;
444 if (MRegisterInfo::isVirtualRegister(reg) &&
445 toSpill[vrm_->getPhys(reg)] &&
446 cur->overlaps(**i)) {
447 DEBUG(std::cerr << "\t\t\tspilling(i): " << **i << '\n');
448 spilled_.push_back(*i);
449 vrm_->clearVirt(reg);
450 i = inactive_.erase(i);
456 vrm_->assignVirt2Phys(cur->reg, minReg);
457 prt_->addRegUse(minReg);
458 active_.push_back(cur);
459 handled_.push_back(cur);
463 unsigned RA::getFreePhysReg(IntervalPtrs::value_type cur)
465 const TargetRegisterClass* rc = mf_->getSSARegMap()->getRegClass(cur->reg);
467 for (TargetRegisterClass::iterator i = rc->allocation_order_begin(*mf_);
468 i != rc->allocation_order_end(*mf_); ++i) {
470 if (prt_->isRegAvail(reg))
476 FunctionPass* llvm::createIterativeScanRegisterAllocator() {