lib/CodeGen/RegAllocPBQP.cpp

   1 //===------ RegAllocPBQP.cpp ---- PBQP Register Allocator -------*- 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 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.
  16 //
  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:
  20 //
  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.
  24 //
  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,
  28 //   NY, USA, 139-148.
  29 //
  30 //===----------------------------------------------------------------------===//
  31
  32 #define DEBUG_TYPE "regalloc"
  33
  34 #include "RenderMachineFunction.h"
  35 #include "Spiller.h"
  36 #include "VirtRegMap.h"
  37 #include "RegisterCoalescer.h"
  38 #include "llvm/Module.h"
  39 #include "llvm/Analysis/AliasAnalysis.h"
  40 #include "llvm/CodeGen/CalcSpillWeights.h"
  41 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
  42 #include "llvm/CodeGen/LiveRangeEdit.h"
  43 #include "llvm/CodeGen/LiveStackAnalysis.h"
  44 #include "llvm/CodeGen/RegAllocPBQP.h"
  45 #include "llvm/CodeGen/MachineDominators.h"
  46 #include "llvm/CodeGen/MachineFunctionPass.h"
  47 #include "llvm/CodeGen/MachineLoopInfo.h"
  48 #include "llvm/CodeGen/MachineRegisterInfo.h"
  49 #include "llvm/CodeGen/PBQP/HeuristicSolver.h"
  50 #include "llvm/CodeGen/PBQP/Graph.h"
  51 #include "llvm/CodeGen/PBQP/Heuristics/Briggs.h"
  52 #include "llvm/CodeGen/RegAllocRegistry.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"
  57 #include <limits>
  58 #include <memory>
  59 #include <set>
  60 #include <sstream>
  61 #include <vector>
  62
  63 using namespace llvm;
  64
  65 static RegisterRegAlloc
  66 registerPBQPRepAlloc("pbqp", "PBQP register allocator",
  67                        createDefaultPBQPRegisterAllocator);
  68
  69 static cl::opt<bool>
  70 pbqpCoalescing("pbqp-coalescing",
  71                 cl::desc("Attempt coalescing during PBQP register allocation."),
  72                 cl::init(false), cl::Hidden);
  73
  74 #ifndef NDEBUG
  75 static cl::opt<bool>
  76 pbqpDumpGraphs("pbqp-dump-graphs",
  77                cl::desc("Dump graphs for each function/round in the compilation unit."),
  78                cl::init(false), cl::Hidden);
  79 #endif
  80
  81 namespace {
  82
  83 ///
  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 {
  88 public:
  89
  90   static char ID;
  91
  92   /// Construct a PBQP register allocator.
  93   RegAllocPBQP(std::auto_ptr<PBQPBuilder> b, char *cPassID=0)
  94       : MachineFunctionPass(ID), builder(b), 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());
 101     initializeRenderMachineFunctionPass(*PassRegistry::getPassRegistry());
 102   }
 103
 104   /// Return the pass name.
 105   virtual const char* getPassName() const {
 106     return "PBQP Register Allocator";
 107   }
 108
 109   /// PBQP analysis usage.
 110   virtual void getAnalysisUsage(AnalysisUsage &au) const;
 111
 112   /// Perform register allocation
 113   virtual bool runOnMachineFunction(MachineFunction &MF);
 114
 115 private:
 116
 117   typedef std::map<const LiveInterval*, unsigned> LI2NodeMap;
 118   typedef std::vector<const LiveInterval*> Node2LIMap;
 119   typedef std::vector<unsigned> AllowedSet;
 120   typedef std::vector<AllowedSet> AllowedSetMap;
 121   typedef std::pair<unsigned, unsigned> RegPair;
 122   typedef std::map<RegPair, PBQP::PBQPNum> CoalesceMap;
 123   typedef std::vector<PBQP::Graph::NodeItr> NodeVector;
 124   typedef std::set<unsigned> RegSet;
 125
 126
 127   std::auto_ptr<PBQPBuilder> builder;
 128
 129   char *customPassID;
 130
 131   MachineFunction *mf;
 132   const TargetMachine *tm;
 133   const TargetRegisterInfo *tri;
 134   const TargetInstrInfo *tii;
 135   const MachineLoopInfo *loopInfo;
 136   MachineRegisterInfo *mri;
 137   RenderMachineFunction *rmf;
 138
 139   std::auto_ptr<Spiller> spiller;
 140   LiveIntervals *lis;
 141   LiveStacks *lss;
 142   VirtRegMap *vrm;
 143
 144   RegSet vregsToAlloc, emptyIntervalVRegs;
 145
 146   /// \brief Finds the initial set of vreg intervals to allocate.
 147   void findVRegIntervalsToAlloc();
 148
 149   /// \brief Given a solved PBQP problem maps this solution back to a register
 150   /// assignment.
 151   bool mapPBQPToRegAlloc(const PBQPRAProblem &problem,
 152                          const PBQP::Solution &solution);
 153
 154   /// \brief Postprocessing before final spilling. Sets basic block "live in"
 155   /// variables.
 156   void finalizeAlloc() const;
 157
 158 };
 159
 160 char RegAllocPBQP::ID = 0;
 161
 162 } // End anonymous namespace.
 163
 164 unsigned PBQPRAProblem::getVRegForNode(PBQP::Graph::ConstNodeItr node) const {
 165   Node2VReg::const_iterator vregItr = node2VReg.find(node);
 166   assert(vregItr != node2VReg.end() && "No vreg for node.");
 167   return vregItr->second;
 168 }
 169
 170 PBQP::Graph::NodeItr PBQPRAProblem::getNodeForVReg(unsigned vreg) const {
 171   VReg2Node::const_iterator nodeItr = vreg2Node.find(vreg);
 172   assert(nodeItr != vreg2Node.end() && "No node for vreg.");
 173   return nodeItr->second;
 174
 175 }
 176
 177 const PBQPRAProblem::AllowedSet&
 178   PBQPRAProblem::getAllowedSet(unsigned vreg) const {
 179   AllowedSetMap::const_iterator allowedSetItr = allowedSets.find(vreg);
 180   assert(allowedSetItr != allowedSets.end() && "No pregs for vreg.");
 181   const AllowedSet &allowedSet = allowedSetItr->second;
 182   return allowedSet;
 183 }
 184
 185 unsigned PBQPRAProblem::getPRegForOption(unsigned vreg, unsigned option) const {
 186   assert(isPRegOption(vreg, option) && "Not a preg option.");
 187
 188   const AllowedSet& allowedSet = getAllowedSet(vreg);
 189   assert(option <= allowedSet.size() && "Option outside allowed set.");
 190   return allowedSet[option - 1];
 191 }
 192
 193 std::auto_ptr<PBQPRAProblem> PBQPBuilder::build(MachineFunction *mf,
 194                                                 const LiveIntervals *lis,
 195                                                 const MachineLoopInfo *loopInfo,
 196                                                 const RegSet &vregs) {
 197
 198   typedef std::vector<const LiveInterval*> LIVector;
 199   ArrayRef<SlotIndex> regMaskSlots = lis->getRegMaskSlots();
 200   MachineRegisterInfo *mri = &mf->getRegInfo();
 201   const TargetRegisterInfo *tri = mf->getTarget().getRegisterInfo();
 202
 203   std::auto_ptr<PBQPRAProblem> p(new PBQPRAProblem());
 204   PBQP::Graph &g = p->getGraph();
 205   RegSet pregs;
 206
 207   // Collect the set of preg intervals, record that they're used in the MF.
 208   for (LiveIntervals::const_iterator itr = lis->begin(), end = lis->end();
 209        itr != end; ++itr) {
 210     if (TargetRegisterInfo::isPhysicalRegister(itr->first)) {
 211       pregs.insert(itr->first);
 212       mri->setPhysRegUsed(itr->first);
 213     }
 214   }
 215
 216   BitVector reservedRegs = tri->getReservedRegs(*mf);
 217
 218   // Iterate over vregs.
 219   for (RegSet::const_iterator vregItr = vregs.begin(), vregEnd = vregs.end();
 220        vregItr != vregEnd; ++vregItr) {
 221     unsigned vreg = *vregItr;
 222     const TargetRegisterClass *trc = mri->getRegClass(vreg);
 223     const LiveInterval *vregLI = &lis->getInterval(vreg);
 224
 225     // Compute an initial allowed set for the current vreg.
 226     typedef std::vector<unsigned> VRAllowed;
 227     VRAllowed vrAllowed;
 228     ArrayRef<uint16_t> rawOrder = trc->getRawAllocationOrder(*mf);
 229     for (unsigned i = 0; i != rawOrder.size(); ++i) {
 230       unsigned preg = rawOrder[i];
 231       if (!reservedRegs.test(preg)) {
 232         vrAllowed.push_back(preg);
 233       }
 234     }
 235
 236     RegSet overlappingPRegs;
 237
 238     // Record physical registers whose ranges overlap.
 239     for (RegSet::const_iterator pregItr = pregs.begin(),
 240                                 pregEnd = pregs.end();
 241          pregItr != pregEnd; ++pregItr) {
 242       unsigned preg = *pregItr;
 243       const LiveInterval *pregLI = &lis->getInterval(preg);
 244
 245       if (pregLI->empty()) {
 246         continue;
 247       }
 248
 249       if (vregLI->overlaps(*pregLI))
 250         overlappingPRegs.insert(preg);
 251     }
 252
 253     // Record any overlaps with regmask operands.
 254     BitVector regMaskOverlaps(tri->getNumRegs());
 255     for (ArrayRef<SlotIndex>::iterator rmItr = regMaskSlots.begin(),
 256                                        rmEnd = regMaskSlots.end();
 257          rmItr != rmEnd; ++rmItr) {
 258       SlotIndex rmIdx = *rmItr;
 259       if (vregLI->liveAt(rmIdx)) {
 260         MachineInstr *rmMI = lis->getInstructionFromIndex(rmIdx);
 261         const uint32_t* regMask = 0;
 262         for (MachineInstr::mop_iterator mopItr = rmMI->operands_begin(),
 263                                         mopEnd = rmMI->operands_end();
 264              mopItr != mopEnd; ++mopItr) {
 265           if (mopItr->isRegMask()) {
 266             regMask = mopItr->getRegMask();
 267             break;
 268           }
 269         }
 270         assert(regMask != 0 && "Couldn't find register mask.");
 271         regMaskOverlaps.setBitsNotInMask(regMask);
 272       }
 273     }
 274
 275     for (unsigned preg = 0; preg < tri->getNumRegs(); ++preg) {
 276       if (regMaskOverlaps.test(preg))
 277         overlappingPRegs.insert(preg);
 278     }
 279
 280     for (RegSet::const_iterator pregItr = overlappingPRegs.begin(),
 281                                 pregEnd = overlappingPRegs.end();
 282          pregItr != pregEnd; ++pregItr) {
 283       unsigned preg = *pregItr;
 284
 285       // Remove the register from the allowed set.
 286       VRAllowed::iterator eraseItr =
 287         std::find(vrAllowed.begin(), vrAllowed.end(), preg);
 288
 289       if (eraseItr != vrAllowed.end()) {
 290         vrAllowed.erase(eraseItr);
 291       }
 292
 293       // Also remove any aliases.
 294       for (MCRegAliasIterator AI(preg, tri, false); AI.isValid(); ++AI) {
 295         VRAllowed::iterator eraseItr =
 296           std::find(vrAllowed.begin(), vrAllowed.end(), *AI);
 297         if (eraseItr != vrAllowed.end()) {
 298           vrAllowed.erase(eraseItr);
 299         }
 300       }
 301     }
 302
 303     // Construct the node.
 304     PBQP::Graph::NodeItr node =
 305       g.addNode(PBQP::Vector(vrAllowed.size() + 1, 0));
 306
 307     // Record the mapping and allowed set in the problem.
 308     p->recordVReg(vreg, node, vrAllowed.begin(), vrAllowed.end());
 309
 310     PBQP::PBQPNum spillCost = (vregLI->weight != 0.0) ?
 311         vregLI->weight : std::numeric_limits<PBQP::PBQPNum>::min();
 312
 313     addSpillCosts(g.getNodeCosts(node), spillCost);
 314   }
 315
 316   for (RegSet::const_iterator vr1Itr = vregs.begin(), vrEnd = vregs.end();
 317          vr1Itr != vrEnd; ++vr1Itr) {
 318     unsigned vr1 = *vr1Itr;
 319     const LiveInterval &l1 = lis->getInterval(vr1);
 320     const PBQPRAProblem::AllowedSet &vr1Allowed = p->getAllowedSet(vr1);
 321
 322     for (RegSet::const_iterator vr2Itr = llvm::next(vr1Itr);
 323          vr2Itr != vrEnd; ++vr2Itr) {
 324       unsigned vr2 = *vr2Itr;
 325       const LiveInterval &l2 = lis->getInterval(vr2);
 326       const PBQPRAProblem::AllowedSet &vr2Allowed = p->getAllowedSet(vr2);
 327
 328       assert(!l2.empty() && "Empty interval in vreg set?");
 329       if (l1.overlaps(l2)) {
 330         PBQP::Graph::EdgeItr edge =
 331           g.addEdge(p->getNodeForVReg(vr1), p->getNodeForVReg(vr2),
 332                     PBQP::Matrix(vr1Allowed.size()+1, vr2Allowed.size()+1, 0));
 333
 334         addInterferenceCosts(g.getEdgeCosts(edge), vr1Allowed, vr2Allowed, tri);
 335       }
 336     }
 337   }
 338
 339   return p;
 340 }
 341
 342 void PBQPBuilder::addSpillCosts(PBQP::Vector &costVec,
 343                                 PBQP::PBQPNum spillCost) {
 344   costVec[0] = spillCost;
 345 }
 346
 347 void PBQPBuilder::addInterferenceCosts(
 348                                     PBQP::Matrix &costMat,
 349                                     const PBQPRAProblem::AllowedSet &vr1Allowed,
 350                                     const PBQPRAProblem::AllowedSet &vr2Allowed,
 351                                     const TargetRegisterInfo *tri) {
 352   assert(costMat.getRows() == vr1Allowed.size() + 1 && "Matrix height mismatch.");
 353   assert(costMat.getCols() == vr2Allowed.size() + 1 && "Matrix width mismatch.");
 354
 355   for (unsigned i = 0; i != vr1Allowed.size(); ++i) {
 356     unsigned preg1 = vr1Allowed[i];
 357
 358     for (unsigned j = 0; j != vr2Allowed.size(); ++j) {
 359       unsigned preg2 = vr2Allowed[j];
 360
 361       if (tri->regsOverlap(preg1, preg2)) {
 362         costMat[i + 1][j + 1] = std::numeric_limits<PBQP::PBQPNum>::infinity();
 363       }
 364     }
 365   }
 366 }
 367
 368 std::auto_ptr<PBQPRAProblem> PBQPBuilderWithCoalescing::build(
 369                                                 MachineFunction *mf,
 370                                                 const LiveIntervals *lis,
 371                                                 const MachineLoopInfo *loopInfo,
 372                                                 const RegSet &vregs) {
 373
 374   std::auto_ptr<PBQPRAProblem> p = PBQPBuilder::build(mf, lis, loopInfo, vregs);
 375   PBQP::Graph &g = p->getGraph();
 376
 377   const TargetMachine &tm = mf->getTarget();
 378   CoalescerPair cp(*tm.getRegisterInfo());
 379
 380   // Scan the machine function and add a coalescing cost whenever CoalescerPair
 381   // gives the Ok.
 382   for (MachineFunction::const_iterator mbbItr = mf->begin(),
 383                                        mbbEnd = mf->end();
 384        mbbItr != mbbEnd; ++mbbItr) {
 385     const MachineBasicBlock *mbb = &*mbbItr;
 386
 387     for (MachineBasicBlock::const_iterator miItr = mbb->begin(),
 388                                            miEnd = mbb->end();
 389          miItr != miEnd; ++miItr) {
 390       const MachineInstr *mi = &*miItr;
 391
 392       if (!cp.setRegisters(mi)) {
 393         continue; // Not coalescable.
 394       }
 395
 396       if (cp.getSrcReg() == cp.getDstReg()) {
 397         continue; // Already coalesced.
 398       }
 399
 400       unsigned dst = cp.getDstReg(),
 401                src = cp.getSrcReg();
 402
 403       const float copyFactor = 0.5; // Cost of copy relative to load. Current
 404       // value plucked randomly out of the air.
 405
 406       PBQP::PBQPNum cBenefit =
 407         copyFactor * LiveIntervals::getSpillWeight(false, true,
 408                                                    loopInfo->getLoopDepth(mbb));
 409
 410       if (cp.isPhys()) {
 411         if (!lis->isAllocatable(dst)) {
 412           continue;
 413         }
 414
 415         const PBQPRAProblem::AllowedSet &allowed = p->getAllowedSet(src);
 416         unsigned pregOpt = 0;
 417         while (pregOpt < allowed.size() && allowed[pregOpt] != dst) {
 418           ++pregOpt;
 419         }
 420         if (pregOpt < allowed.size()) {
 421           ++pregOpt; // +1 to account for spill option.
 422           PBQP::Graph::NodeItr node = p->getNodeForVReg(src);
 423           addPhysRegCoalesce(g.getNodeCosts(node), pregOpt, cBenefit);
 424         }
 425       } else {
 426         const PBQPRAProblem::AllowedSet *allowed1 = &p->getAllowedSet(dst);
 427         const PBQPRAProblem::AllowedSet *allowed2 = &p->getAllowedSet(src);
 428         PBQP::Graph::NodeItr node1 = p->getNodeForVReg(dst);
 429         PBQP::Graph::NodeItr node2 = p->getNodeForVReg(src);
 430         PBQP::Graph::EdgeItr edge = g.findEdge(node1, node2);
 431         if (edge == g.edgesEnd()) {
 432           edge = g.addEdge(node1, node2, PBQP::Matrix(allowed1->size() + 1,
 433                                                       allowed2->size() + 1,
 434                                                       0));
 435         } else {
 436           if (g.getEdgeNode1(edge) == node2) {
 437             std::swap(node1, node2);
 438             std::swap(allowed1, allowed2);
 439           }
 440         }
 441
 442         addVirtRegCoalesce(g.getEdgeCosts(edge), *allowed1, *allowed2,
 443                            cBenefit);
 444       }
 445     }
 446   }
 447
 448   return p;
 449 }
 450
 451 void PBQPBuilderWithCoalescing::addPhysRegCoalesce(PBQP::Vector &costVec,
 452                                                    unsigned pregOption,
 453                                                    PBQP::PBQPNum benefit) {
 454   costVec[pregOption] += -benefit;
 455 }
 456
 457 void PBQPBuilderWithCoalescing::addVirtRegCoalesce(
 458                                     PBQP::Matrix &costMat,
 459                                     const PBQPRAProblem::AllowedSet &vr1Allowed,
 460                                     const PBQPRAProblem::AllowedSet &vr2Allowed,
 461                                     PBQP::PBQPNum benefit) {
 462
 463   assert(costMat.getRows() == vr1Allowed.size() + 1 && "Size mismatch.");
 464   assert(costMat.getCols() == vr2Allowed.size() + 1 && "Size mismatch.");
 465
 466   for (unsigned i = 0; i != vr1Allowed.size(); ++i) {
 467     unsigned preg1 = vr1Allowed[i];
 468     for (unsigned j = 0; j != vr2Allowed.size(); ++j) {
 469       unsigned preg2 = vr2Allowed[j];
 470
 471       if (preg1 == preg2) {
 472         costMat[i + 1][j + 1] += -benefit;
 473       }
 474     }
 475   }
 476 }
 477
 478
 479 void RegAllocPBQP::getAnalysisUsage(AnalysisUsage &au) const {
 480   au.setPreservesCFG();
 481   au.addRequired<AliasAnalysis>();
 482   au.addPreserved<AliasAnalysis>();
 483   au.addRequired<SlotIndexes>();
 484   au.addPreserved<SlotIndexes>();
 485   au.addRequired<LiveIntervals>();
 486   //au.addRequiredID(SplitCriticalEdgesID);
 487   if (customPassID)
 488     au.addRequiredID(*customPassID);
 489   au.addRequired<CalculateSpillWeights>();
 490   au.addRequired<LiveStacks>();
 491   au.addPreserved<LiveStacks>();
 492   au.addRequired<MachineDominatorTree>();
 493   au.addPreserved<MachineDominatorTree>();
 494   au.addRequired<MachineLoopInfo>();
 495   au.addPreserved<MachineLoopInfo>();
 496   au.addRequired<VirtRegMap>();
 497   au.addRequired<RenderMachineFunction>();
 498   MachineFunctionPass::getAnalysisUsage(au);
 499 }
 500
 501 void RegAllocPBQP::findVRegIntervalsToAlloc() {
 502
 503   // Iterate over all live ranges.
 504   for (LiveIntervals::iterator itr = lis->begin(), end = lis->end();
 505        itr != end; ++itr) {
 506
 507     // Ignore physical ones.
 508     if (TargetRegisterInfo::isPhysicalRegister(itr->first))
 509       continue;
 510
 511     LiveInterval *li = itr->second;
 512
 513     // If this live interval is non-empty we will use pbqp to allocate it.
 514     // Empty intervals we allocate in a simple post-processing stage in
 515     // finalizeAlloc.
 516     if (!li->empty()) {
 517       vregsToAlloc.insert(li->reg);
 518     } else {
 519       emptyIntervalVRegs.insert(li->reg);
 520     }
 521   }
 522 }
 523
 524 bool RegAllocPBQP::mapPBQPToRegAlloc(const PBQPRAProblem &problem,
 525                                      const PBQP::Solution &solution) {
 526   // Set to true if we have any spills
 527   bool anotherRoundNeeded = false;
 528
 529   // Clear the existing allocation.
 530   vrm->clearAllVirt();
 531
 532   const PBQP::Graph &g = problem.getGraph();
 533   // Iterate over the nodes mapping the PBQP solution to a register
 534   // assignment.
 535   for (PBQP::Graph::ConstNodeItr node = g.nodesBegin(),
 536                                  nodeEnd = g.nodesEnd();
 537        node != nodeEnd; ++node) {
 538     unsigned vreg = problem.getVRegForNode(node);
 539     unsigned alloc = solution.getSelection(node);
 540
 541     if (problem.isPRegOption(vreg, alloc)) {
 542       unsigned preg = problem.getPRegForOption(vreg, alloc);
 543       DEBUG(dbgs() << "VREG " << PrintReg(vreg, tri) << " -> "
 544             << tri->getName(preg) << "\n");
 545       assert(preg != 0 && "Invalid preg selected.");
 546       vrm->assignVirt2Phys(vreg, preg);
 547     } else if (problem.isSpillOption(vreg, alloc)) {
 548       vregsToAlloc.erase(vreg);
 549       SmallVector<LiveInterval*, 8> newSpills;
 550       LiveRangeEdit LRE(&lis->getInterval(vreg), newSpills, *mf, *lis, vrm);
 551       spiller->spill(LRE);
 552
 553       DEBUG(dbgs() << "VREG " << PrintReg(vreg, tri) << " -> SPILLED (Cost: "
 554                    << LRE.getParent().weight << ", New vregs: ");
 555
 556       // Copy any newly inserted live intervals into the list of regs to
 557       // allocate.
 558       for (LiveRangeEdit::iterator itr = LRE.begin(), end = LRE.end();
 559            itr != end; ++itr) {
 560         assert(!(*itr)->empty() && "Empty spill range.");
 561         DEBUG(dbgs() << PrintReg((*itr)->reg, tri) << " ");
 562         vregsToAlloc.insert((*itr)->reg);
 563       }
 564
 565       DEBUG(dbgs() << ")\n");
 566
 567       // We need another round if spill intervals were added.
 568       anotherRoundNeeded |= !LRE.empty();
 569     } else {
 570       llvm_unreachable("Unknown allocation option.");
 571     }
 572   }
 573
 574   return !anotherRoundNeeded;
 575 }
 576
 577
 578 void RegAllocPBQP::finalizeAlloc() const {
 579   typedef LiveIntervals::iterator LIIterator;
 580   typedef LiveInterval::Ranges::const_iterator LRIterator;
 581
 582   // First allocate registers for the empty intervals.
 583   for (RegSet::const_iterator
 584          itr = emptyIntervalVRegs.begin(), end = emptyIntervalVRegs.end();
 585          itr != end; ++itr) {
 586     LiveInterval *li = &lis->getInterval(*itr);
 587
 588     unsigned physReg = vrm->getRegAllocPref(li->reg);
 589
 590     if (physReg == 0) {
 591       const TargetRegisterClass *liRC = mri->getRegClass(li->reg);
 592       physReg = liRC->getRawAllocationOrder(*mf).front();
 593     }
 594
 595     vrm->assignVirt2Phys(li->reg, physReg);
 596   }
 597 }
 598
 599 bool RegAllocPBQP::runOnMachineFunction(MachineFunction &MF) {
 600
 601   mf = &MF;
 602   tm = &mf->getTarget();
 603   tri = tm->getRegisterInfo();
 604   tii = tm->getInstrInfo();
 605   mri = &mf->getRegInfo();
 606
 607   lis = &getAnalysis<LiveIntervals>();
 608   lss = &getAnalysis<LiveStacks>();
 609   loopInfo = &getAnalysis<MachineLoopInfo>();
 610   rmf = &getAnalysis<RenderMachineFunction>();
 611
 612   vrm = &getAnalysis<VirtRegMap>();
 613   spiller.reset(createInlineSpiller(*this, MF, *vrm));
 614
 615   mri->freezeReservedRegs(MF);
 616
 617   DEBUG(dbgs() << "PBQP Register Allocating for " << mf->getFunction()->getName() << "\n");
 618
 619   // Allocator main loop:
 620   //
 621   // * Map current regalloc problem to a PBQP problem
 622   // * Solve the PBQP problem
 623   // * Map the solution back to a register allocation
 624   // * Spill if necessary
 625   //
 626   // This process is continued till no more spills are generated.
 627
 628   // Find the vreg intervals in need of allocation.
 629   findVRegIntervalsToAlloc();
 630
 631   const Function* func = mf->getFunction();
 632   std::string fqn =
 633     func->getParent()->getModuleIdentifier() + "." +
 634     func->getName().str();
 635   (void)fqn;
 636
 637   // If there are non-empty intervals allocate them using pbqp.
 638   if (!vregsToAlloc.empty()) {
 639
 640     bool pbqpAllocComplete = false;
 641     unsigned round = 0;
 642
 643     while (!pbqpAllocComplete) {
 644       DEBUG(dbgs() << "  PBQP Regalloc round " << round << ":\n");
 645
 646       std::auto_ptr<PBQPRAProblem> problem =
 647         builder->build(mf, lis, loopInfo, vregsToAlloc);
 648
 649 #ifndef NDEBUG
 650       if (pbqpDumpGraphs) {
 651         std::ostringstream rs;
 652         rs << round;
 653         std::string graphFileName(fqn + "." + rs.str() + ".pbqpgraph");
 654         std::string tmp;
 655         raw_fd_ostream os(graphFileName.c_str(), tmp);
 656         DEBUG(dbgs() << "Dumping graph for round " << round << " to \""
 657               << graphFileName << "\"\n");
 658         problem->getGraph().dump(os);
 659       }
 660 #endif
 661
 662       PBQP::Solution solution =
 663         PBQP::HeuristicSolver<PBQP::Heuristics::Briggs>::solve(
 664           problem->getGraph());
 665
 666       pbqpAllocComplete = mapPBQPToRegAlloc(*problem, solution);
 667
 668       ++round;
 669     }
 670   }
 671
 672   // Finalise allocation, allocate empty ranges.
 673   finalizeAlloc();
 674
 675   rmf->renderMachineFunction("After PBQP register allocation.", vrm);
 676
 677   vregsToAlloc.clear();
 678   emptyIntervalVRegs.clear();
 679
 680   DEBUG(dbgs() << "Post alloc VirtRegMap:\n" << *vrm << "\n");
 681
 682   return true;
 683 }
 684
 685 FunctionPass* llvm::createPBQPRegisterAllocator(
 686                                            std::auto_ptr<PBQPBuilder> builder,
 687                                            char *customPassID) {
 688   return new RegAllocPBQP(builder, customPassID);
 689 }
 690
 691 FunctionPass* llvm::createDefaultPBQPRegisterAllocator() {
 692   if (pbqpCoalescing) {
 693     return createPBQPRegisterAllocator(
 694              std::auto_ptr<PBQPBuilder>(new PBQPBuilderWithCoalescing()));
 695   } // else
 696   return createPBQPRegisterAllocator(
 697            std::auto_ptr<PBQPBuilder>(new PBQPBuilder()));
 698 }
 699
 700 #undef DEBUG_TYPE