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