1 //===------ RegAllocPBQP.cpp ---- PBQP Register Allocator -------*- 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 contains a Partitioned Boolean Quadratic Programming (PBQP) based
11 // register allocator for LLVM. This allocator works by constructing a PBQP
12 // problem representing the register allocation problem under consideration,
13 // solving this using a PBQP solver, and mapping the solution back to a
14 // register assignment. If any variables are selected for spilling then spill
15 // code is inserted and the process repeated.
17 // The PBQP solver (pbqp.c) provided for this allocator uses a heuristic tuned
18 // for register allocation. For more information on PBQP for register
19 // allocation, see the following papers:
21 // (1) Hames, L. and Scholz, B. 2006. Nearly optimal register allocation with
22 // PBQP. In Proceedings of the 7th Joint Modular Languages Conference
23 // (JMLC'06). LNCS, vol. 4228. Springer, New York, NY, USA. 346-361.
25 // (2) Scholz, B., Eckstein, E. 2002. Register allocation for irregular
26 // architectures. In Proceedings of the Joint Conference on Languages,
27 // Compilers and Tools for Embedded Systems (LCTES'02), ACM Press, New York,
30 //===----------------------------------------------------------------------===//
32 #define DEBUG_TYPE "regalloc"
34 #include "llvm/CodeGen/RegAllocPBQP.h"
35 #include "RegisterCoalescer.h"
37 #include "llvm/ADT/OwningPtr.h"
38 #include "llvm/Analysis/AliasAnalysis.h"
39 #include "llvm/CodeGen/CalcSpillWeights.h"
40 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
41 #include "llvm/CodeGen/LiveRangeEdit.h"
42 #include "llvm/CodeGen/LiveStackAnalysis.h"
43 #include "llvm/CodeGen/MachineDominators.h"
44 #include "llvm/CodeGen/MachineFunctionPass.h"
45 #include "llvm/CodeGen/MachineLoopInfo.h"
46 #include "llvm/CodeGen/MachineRegisterInfo.h"
47 #include "llvm/CodeGen/PBQP/Graph.h"
48 #include "llvm/CodeGen/PBQP/HeuristicSolver.h"
49 #include "llvm/CodeGen/PBQP/Heuristics/Briggs.h"
50 #include "llvm/CodeGen/RegAllocRegistry.h"
51 #include "llvm/CodeGen/VirtRegMap.h"
52 #include "llvm/IR/Module.h"
53 #include "llvm/Support/Debug.h"
54 #include "llvm/Support/raw_ostream.h"
55 #include "llvm/Target/TargetInstrInfo.h"
56 #include "llvm/Target/TargetMachine.h"
65 static RegisterRegAlloc
66 registerPBQPRepAlloc("pbqp", "PBQP register allocator",
67 createDefaultPBQPRegisterAllocator);
70 pbqpCoalescing("pbqp-coalescing",
71 cl::desc("Attempt coalescing during PBQP register allocation."),
72 cl::init(false), cl::Hidden);
76 pbqpDumpGraphs("pbqp-dump-graphs",
77 cl::desc("Dump graphs for each function/round in the compilation unit."),
78 cl::init(false), cl::Hidden);
84 /// PBQP based allocators solve the register allocation problem by mapping
85 /// register allocation problems to Partitioned Boolean Quadratic
86 /// Programming problems.
87 class RegAllocPBQP : public MachineFunctionPass {
92 /// Construct a PBQP register allocator.
93 RegAllocPBQP(OwningPtr<PBQPBuilder> &b, char *cPassID=0)
94 : MachineFunctionPass(ID), builder(b.take()), customPassID(cPassID) {
95 initializeSlotIndexesPass(*PassRegistry::getPassRegistry());
96 initializeLiveIntervalsPass(*PassRegistry::getPassRegistry());
97 initializeCalculateSpillWeightsPass(*PassRegistry::getPassRegistry());
98 initializeLiveStacksPass(*PassRegistry::getPassRegistry());
99 initializeMachineLoopInfoPass(*PassRegistry::getPassRegistry());
100 initializeVirtRegMapPass(*PassRegistry::getPassRegistry());
103 /// Return the pass name.
104 virtual const char* getPassName() const {
105 return "PBQP Register Allocator";
108 /// PBQP analysis usage.
109 virtual void getAnalysisUsage(AnalysisUsage &au) const;
111 /// Perform register allocation
112 virtual bool runOnMachineFunction(MachineFunction &MF);
116 typedef std::map<const LiveInterval*, unsigned> LI2NodeMap;
117 typedef std::vector<const LiveInterval*> Node2LIMap;
118 typedef std::vector<unsigned> AllowedSet;
119 typedef std::vector<AllowedSet> AllowedSetMap;
120 typedef std::pair<unsigned, unsigned> RegPair;
121 typedef std::map<RegPair, PBQP::PBQPNum> CoalesceMap;
122 typedef std::set<unsigned> RegSet;
125 OwningPtr<PBQPBuilder> builder;
130 const TargetMachine *tm;
131 const TargetRegisterInfo *tri;
132 const TargetInstrInfo *tii;
133 const MachineLoopInfo *loopInfo;
134 MachineRegisterInfo *mri;
136 OwningPtr<Spiller> spiller;
141 RegSet vregsToAlloc, emptyIntervalVRegs;
143 /// \brief Finds the initial set of vreg intervals to allocate.
144 void findVRegIntervalsToAlloc();
146 /// \brief Given a solved PBQP problem maps this solution back to a register
148 bool mapPBQPToRegAlloc(const PBQPRAProblem &problem,
149 const PBQP::Solution &solution);
151 /// \brief Postprocessing before final spilling. Sets basic block "live in"
153 void finalizeAlloc() const;
157 char RegAllocPBQP::ID = 0;
159 } // End anonymous namespace.
161 unsigned PBQPRAProblem::getVRegForNode(PBQP::Graph::ConstNodeItr node) const {
162 Node2VReg::const_iterator vregItr = node2VReg.find(node);
163 assert(vregItr != node2VReg.end() && "No vreg for node.");
164 return vregItr->second;
167 PBQP::Graph::NodeItr PBQPRAProblem::getNodeForVReg(unsigned vreg) const {
168 VReg2Node::const_iterator nodeItr = vreg2Node.find(vreg);
169 assert(nodeItr != vreg2Node.end() && "No node for vreg.");
170 return nodeItr->second;
174 const PBQPRAProblem::AllowedSet&
175 PBQPRAProblem::getAllowedSet(unsigned vreg) const {
176 AllowedSetMap::const_iterator allowedSetItr = allowedSets.find(vreg);
177 assert(allowedSetItr != allowedSets.end() && "No pregs for vreg.");
178 const AllowedSet &allowedSet = allowedSetItr->second;
182 unsigned PBQPRAProblem::getPRegForOption(unsigned vreg, unsigned option) const {
183 assert(isPRegOption(vreg, option) && "Not a preg option.");
185 const AllowedSet& allowedSet = getAllowedSet(vreg);
186 assert(option <= allowedSet.size() && "Option outside allowed set.");
187 return allowedSet[option - 1];
190 PBQPRAProblem *PBQPBuilder::build(MachineFunction *mf, const LiveIntervals *lis,
191 const MachineLoopInfo *loopInfo,
192 const RegSet &vregs) {
194 LiveIntervals *LIS = const_cast<LiveIntervals*>(lis);
195 MachineRegisterInfo *mri = &mf->getRegInfo();
196 const TargetRegisterInfo *tri = mf->getTarget().getRegisterInfo();
198 OwningPtr<PBQPRAProblem> p(new PBQPRAProblem());
199 PBQP::Graph &g = p->getGraph();
202 // Collect the set of preg intervals, record that they're used in the MF.
203 for (unsigned Reg = 1, e = tri->getNumRegs(); Reg != e; ++Reg) {
204 if (mri->def_empty(Reg))
207 mri->setPhysRegUsed(Reg);
210 // Iterate over vregs.
211 for (RegSet::const_iterator vregItr = vregs.begin(), vregEnd = vregs.end();
212 vregItr != vregEnd; ++vregItr) {
213 unsigned vreg = *vregItr;
214 const TargetRegisterClass *trc = mri->getRegClass(vreg);
215 LiveInterval *vregLI = &LIS->getInterval(vreg);
217 // Record any overlaps with regmask operands.
218 BitVector regMaskOverlaps;
219 LIS->checkRegMaskInterference(*vregLI, regMaskOverlaps);
221 // Compute an initial allowed set for the current vreg.
222 typedef std::vector<unsigned> VRAllowed;
224 ArrayRef<uint16_t> rawOrder = trc->getRawAllocationOrder(*mf);
225 for (unsigned i = 0; i != rawOrder.size(); ++i) {
226 unsigned preg = rawOrder[i];
227 if (mri->isReserved(preg))
230 // vregLI crosses a regmask operand that clobbers preg.
231 if (!regMaskOverlaps.empty() && !regMaskOverlaps.test(preg))
234 // vregLI overlaps fixed regunit interference.
235 bool Interference = false;
236 for (MCRegUnitIterator Units(preg, tri); Units.isValid(); ++Units) {
237 if (vregLI->overlaps(LIS->getRegUnit(*Units))) {
245 // preg is usable for this virtual register.
246 vrAllowed.push_back(preg);
249 // Construct the node.
250 PBQP::Graph::NodeItr node =
251 g.addNode(PBQP::Vector(vrAllowed.size() + 1, 0));
253 // Record the mapping and allowed set in the problem.
254 p->recordVReg(vreg, node, vrAllowed.begin(), vrAllowed.end());
256 PBQP::PBQPNum spillCost = (vregLI->weight != 0.0) ?
257 vregLI->weight : std::numeric_limits<PBQP::PBQPNum>::min();
259 addSpillCosts(g.getNodeCosts(node), spillCost);
262 for (RegSet::const_iterator vr1Itr = vregs.begin(), vrEnd = vregs.end();
263 vr1Itr != vrEnd; ++vr1Itr) {
264 unsigned vr1 = *vr1Itr;
265 const LiveInterval &l1 = lis->getInterval(vr1);
266 const PBQPRAProblem::AllowedSet &vr1Allowed = p->getAllowedSet(vr1);
268 for (RegSet::const_iterator vr2Itr = llvm::next(vr1Itr);
269 vr2Itr != vrEnd; ++vr2Itr) {
270 unsigned vr2 = *vr2Itr;
271 const LiveInterval &l2 = lis->getInterval(vr2);
272 const PBQPRAProblem::AllowedSet &vr2Allowed = p->getAllowedSet(vr2);
274 assert(!l2.empty() && "Empty interval in vreg set?");
275 if (l1.overlaps(l2)) {
276 PBQP::Graph::EdgeItr edge =
277 g.addEdge(p->getNodeForVReg(vr1), p->getNodeForVReg(vr2),
278 PBQP::Matrix(vr1Allowed.size()+1, vr2Allowed.size()+1, 0));
280 addInterferenceCosts(g.getEdgeCosts(edge), vr1Allowed, vr2Allowed, tri);
288 void PBQPBuilder::addSpillCosts(PBQP::Vector &costVec,
289 PBQP::PBQPNum spillCost) {
290 costVec[0] = spillCost;
293 void PBQPBuilder::addInterferenceCosts(
294 PBQP::Matrix &costMat,
295 const PBQPRAProblem::AllowedSet &vr1Allowed,
296 const PBQPRAProblem::AllowedSet &vr2Allowed,
297 const TargetRegisterInfo *tri) {
298 assert(costMat.getRows() == vr1Allowed.size() + 1 && "Matrix height mismatch.");
299 assert(costMat.getCols() == vr2Allowed.size() + 1 && "Matrix width mismatch.");
301 for (unsigned i = 0; i != vr1Allowed.size(); ++i) {
302 unsigned preg1 = vr1Allowed[i];
304 for (unsigned j = 0; j != vr2Allowed.size(); ++j) {
305 unsigned preg2 = vr2Allowed[j];
307 if (tri->regsOverlap(preg1, preg2)) {
308 costMat[i + 1][j + 1] = std::numeric_limits<PBQP::PBQPNum>::infinity();
314 PBQPRAProblem *PBQPBuilderWithCoalescing::build(MachineFunction *mf,
315 const LiveIntervals *lis,
316 const MachineLoopInfo *loopInfo,
317 const RegSet &vregs) {
319 OwningPtr<PBQPRAProblem> p(PBQPBuilder::build(mf, lis, loopInfo, vregs));
320 PBQP::Graph &g = p->getGraph();
322 const TargetMachine &tm = mf->getTarget();
323 CoalescerPair cp(*tm.getRegisterInfo());
325 // Scan the machine function and add a coalescing cost whenever CoalescerPair
327 for (MachineFunction::const_iterator mbbItr = mf->begin(),
329 mbbItr != mbbEnd; ++mbbItr) {
330 const MachineBasicBlock *mbb = &*mbbItr;
332 for (MachineBasicBlock::const_iterator miItr = mbb->begin(),
334 miItr != miEnd; ++miItr) {
335 const MachineInstr *mi = &*miItr;
337 if (!cp.setRegisters(mi)) {
338 continue; // Not coalescable.
341 if (cp.getSrcReg() == cp.getDstReg()) {
342 continue; // Already coalesced.
345 unsigned dst = cp.getDstReg(),
346 src = cp.getSrcReg();
348 const float copyFactor = 0.5; // Cost of copy relative to load. Current
349 // value plucked randomly out of the air.
351 PBQP::PBQPNum cBenefit =
352 copyFactor * LiveIntervals::getSpillWeight(false, true,
353 loopInfo->getLoopDepth(mbb));
356 if (!mf->getRegInfo().isAllocatable(dst)) {
360 const PBQPRAProblem::AllowedSet &allowed = p->getAllowedSet(src);
361 unsigned pregOpt = 0;
362 while (pregOpt < allowed.size() && allowed[pregOpt] != dst) {
365 if (pregOpt < allowed.size()) {
366 ++pregOpt; // +1 to account for spill option.
367 PBQP::Graph::NodeItr node = p->getNodeForVReg(src);
368 addPhysRegCoalesce(g.getNodeCosts(node), pregOpt, cBenefit);
371 const PBQPRAProblem::AllowedSet *allowed1 = &p->getAllowedSet(dst);
372 const PBQPRAProblem::AllowedSet *allowed2 = &p->getAllowedSet(src);
373 PBQP::Graph::NodeItr node1 = p->getNodeForVReg(dst);
374 PBQP::Graph::NodeItr node2 = p->getNodeForVReg(src);
375 PBQP::Graph::EdgeItr edge = g.findEdge(node1, node2);
376 if (edge == g.edgesEnd()) {
377 edge = g.addEdge(node1, node2, PBQP::Matrix(allowed1->size() + 1,
378 allowed2->size() + 1,
381 if (g.getEdgeNode1(edge) == node2) {
382 std::swap(node1, node2);
383 std::swap(allowed1, allowed2);
387 addVirtRegCoalesce(g.getEdgeCosts(edge), *allowed1, *allowed2,
396 void PBQPBuilderWithCoalescing::addPhysRegCoalesce(PBQP::Vector &costVec,
398 PBQP::PBQPNum benefit) {
399 costVec[pregOption] += -benefit;
402 void PBQPBuilderWithCoalescing::addVirtRegCoalesce(
403 PBQP::Matrix &costMat,
404 const PBQPRAProblem::AllowedSet &vr1Allowed,
405 const PBQPRAProblem::AllowedSet &vr2Allowed,
406 PBQP::PBQPNum benefit) {
408 assert(costMat.getRows() == vr1Allowed.size() + 1 && "Size mismatch.");
409 assert(costMat.getCols() == vr2Allowed.size() + 1 && "Size mismatch.");
411 for (unsigned i = 0; i != vr1Allowed.size(); ++i) {
412 unsigned preg1 = vr1Allowed[i];
413 for (unsigned j = 0; j != vr2Allowed.size(); ++j) {
414 unsigned preg2 = vr2Allowed[j];
416 if (preg1 == preg2) {
417 costMat[i + 1][j + 1] += -benefit;
424 void RegAllocPBQP::getAnalysisUsage(AnalysisUsage &au) const {
425 au.setPreservesCFG();
426 au.addRequired<AliasAnalysis>();
427 au.addPreserved<AliasAnalysis>();
428 au.addRequired<SlotIndexes>();
429 au.addPreserved<SlotIndexes>();
430 au.addRequired<LiveIntervals>();
431 au.addPreserved<LiveIntervals>();
432 //au.addRequiredID(SplitCriticalEdgesID);
434 au.addRequiredID(*customPassID);
435 au.addRequired<CalculateSpillWeights>();
436 au.addRequired<LiveStacks>();
437 au.addPreserved<LiveStacks>();
438 au.addRequired<MachineDominatorTree>();
439 au.addPreserved<MachineDominatorTree>();
440 au.addRequired<MachineLoopInfo>();
441 au.addPreserved<MachineLoopInfo>();
442 au.addRequired<VirtRegMap>();
443 au.addPreserved<VirtRegMap>();
444 MachineFunctionPass::getAnalysisUsage(au);
447 void RegAllocPBQP::findVRegIntervalsToAlloc() {
449 // Iterate over all live ranges.
450 for (unsigned i = 0, e = mri->getNumVirtRegs(); i != e; ++i) {
451 unsigned Reg = TargetRegisterInfo::index2VirtReg(i);
452 if (mri->reg_nodbg_empty(Reg))
454 LiveInterval *li = &lis->getInterval(Reg);
456 // If this live interval is non-empty we will use pbqp to allocate it.
457 // Empty intervals we allocate in a simple post-processing stage in
460 vregsToAlloc.insert(li->reg);
462 emptyIntervalVRegs.insert(li->reg);
467 bool RegAllocPBQP::mapPBQPToRegAlloc(const PBQPRAProblem &problem,
468 const PBQP::Solution &solution) {
469 // Set to true if we have any spills
470 bool anotherRoundNeeded = false;
472 // Clear the existing allocation.
475 const PBQP::Graph &g = problem.getGraph();
476 // Iterate over the nodes mapping the PBQP solution to a register
478 for (PBQP::Graph::ConstNodeItr node = g.nodesBegin(),
479 nodeEnd = g.nodesEnd();
480 node != nodeEnd; ++node) {
481 unsigned vreg = problem.getVRegForNode(node);
482 unsigned alloc = solution.getSelection(node);
484 if (problem.isPRegOption(vreg, alloc)) {
485 unsigned preg = problem.getPRegForOption(vreg, alloc);
486 DEBUG(dbgs() << "VREG " << PrintReg(vreg, tri) << " -> "
487 << tri->getName(preg) << "\n");
488 assert(preg != 0 && "Invalid preg selected.");
489 vrm->assignVirt2Phys(vreg, preg);
490 } else if (problem.isSpillOption(vreg, alloc)) {
491 vregsToAlloc.erase(vreg);
492 SmallVector<LiveInterval*, 8> newSpills;
493 LiveRangeEdit LRE(&lis->getInterval(vreg), newSpills, *mf, *lis, vrm);
496 DEBUG(dbgs() << "VREG " << PrintReg(vreg, tri) << " -> SPILLED (Cost: "
497 << LRE.getParent().weight << ", New vregs: ");
499 // Copy any newly inserted live intervals into the list of regs to
501 for (LiveRangeEdit::iterator itr = LRE.begin(), end = LRE.end();
503 assert(!(*itr)->empty() && "Empty spill range.");
504 DEBUG(dbgs() << PrintReg((*itr)->reg, tri) << " ");
505 vregsToAlloc.insert((*itr)->reg);
508 DEBUG(dbgs() << ")\n");
510 // We need another round if spill intervals were added.
511 anotherRoundNeeded |= !LRE.empty();
513 llvm_unreachable("Unknown allocation option.");
517 return !anotherRoundNeeded;
521 void RegAllocPBQP::finalizeAlloc() const {
522 // First allocate registers for the empty intervals.
523 for (RegSet::const_iterator
524 itr = emptyIntervalVRegs.begin(), end = emptyIntervalVRegs.end();
526 LiveInterval *li = &lis->getInterval(*itr);
528 unsigned physReg = mri->getSimpleHint(li->reg);
531 const TargetRegisterClass *liRC = mri->getRegClass(li->reg);
532 physReg = liRC->getRawAllocationOrder(*mf).front();
535 vrm->assignVirt2Phys(li->reg, physReg);
539 bool RegAllocPBQP::runOnMachineFunction(MachineFunction &MF) {
542 tm = &mf->getTarget();
543 tri = tm->getRegisterInfo();
544 tii = tm->getInstrInfo();
545 mri = &mf->getRegInfo();
547 lis = &getAnalysis<LiveIntervals>();
548 lss = &getAnalysis<LiveStacks>();
549 loopInfo = &getAnalysis<MachineLoopInfo>();
551 vrm = &getAnalysis<VirtRegMap>();
552 spiller.reset(createInlineSpiller(*this, MF, *vrm));
554 mri->freezeReservedRegs(MF);
556 DEBUG(dbgs() << "PBQP Register Allocating for " << mf->getName() << "\n");
558 // Allocator main loop:
560 // * Map current regalloc problem to a PBQP problem
561 // * Solve the PBQP problem
562 // * Map the solution back to a register allocation
563 // * Spill if necessary
565 // This process is continued till no more spills are generated.
567 // Find the vreg intervals in need of allocation.
568 findVRegIntervalsToAlloc();
571 const Function* func = mf->getFunction();
573 func->getParent()->getModuleIdentifier() + "." +
574 func->getName().str();
577 // If there are non-empty intervals allocate them using pbqp.
578 if (!vregsToAlloc.empty()) {
580 bool pbqpAllocComplete = false;
583 while (!pbqpAllocComplete) {
584 DEBUG(dbgs() << " PBQP Regalloc round " << round << ":\n");
586 OwningPtr<PBQPRAProblem> problem(
587 builder->build(mf, lis, loopInfo, vregsToAlloc));
590 if (pbqpDumpGraphs) {
591 std::ostringstream rs;
593 std::string graphFileName(fqn + "." + rs.str() + ".pbqpgraph");
595 raw_fd_ostream os(graphFileName.c_str(), tmp);
596 DEBUG(dbgs() << "Dumping graph for round " << round << " to \""
597 << graphFileName << "\"\n");
598 problem->getGraph().dump(os);
602 PBQP::Solution solution =
603 PBQP::HeuristicSolver<PBQP::Heuristics::Briggs>::solve(
604 problem->getGraph());
606 pbqpAllocComplete = mapPBQPToRegAlloc(*problem, solution);
612 // Finalise allocation, allocate empty ranges.
614 vregsToAlloc.clear();
615 emptyIntervalVRegs.clear();
617 DEBUG(dbgs() << "Post alloc VirtRegMap:\n" << *vrm << "\n");
622 FunctionPass* llvm::createPBQPRegisterAllocator(
623 OwningPtr<PBQPBuilder> &builder,
624 char *customPassID) {
625 return new RegAllocPBQP(builder, customPassID);
628 FunctionPass* llvm::createDefaultPBQPRegisterAllocator() {
629 OwningPtr<PBQPBuilder> Builder;
631 Builder.reset(new PBQPBuilderWithCoalescing());
633 Builder.reset(new PBQPBuilder());
634 return createPBQPRegisterAllocator(Builder);