lib/CodeGen/MachineBlockPlacement.cpp

   1 //===-- MachineBlockPlacement.cpp - Basic Block Code Layout optimization --===//
   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 implements basic block placement transformations using the CFG
  11 // structure and branch probability estimates.
  12 //
  13 // The pass strives to preserve the structure of the CFG (that is, retain
  14 // a topological ordering of basic blocks) in the absense of a *strong* signal
  15 // to the contrary from probabilities. However, within the CFG structure, it
  16 // attempts to choose an ordering which favors placing more likely sequences of
  17 // blocks adjacent to each other.
  18 //
  19 // The algorithm works from the inner-most loop within a function outward, and
  20 // at each stage walks through the basic blocks, trying to coalesce them into
  21 // sequential chains where allowed by the CFG (or demanded by heavy
  22 // probabilities). Finally, it walks the blocks in topological order, and the
  23 // first time it reaches a chain of basic blocks, it schedules them in the
  24 // function in-order.
  25 //
  26 //===----------------------------------------------------------------------===//
  27
  28 #define DEBUG_TYPE "block-placement2"
  29 #include "llvm/CodeGen/MachineBasicBlock.h"
  30 #include "llvm/CodeGen/MachineBlockFrequencyInfo.h"
  31 #include "llvm/CodeGen/MachineBranchProbabilityInfo.h"
  32 #include "llvm/CodeGen/MachineFunction.h"
  33 #include "llvm/CodeGen/MachineFunctionPass.h"
  34 #include "llvm/CodeGen/MachineLoopInfo.h"
  35 #include "llvm/CodeGen/MachineModuleInfo.h"
  36 #include "llvm/CodeGen/Passes.h"
  37 #include "llvm/Support/Allocator.h"
  38 #include "llvm/Support/Debug.h"
  39 #include "llvm/Support/ErrorHandling.h"
  40 #include "llvm/ADT/DenseMap.h"
  41 #include "llvm/ADT/PostOrderIterator.h"
  42 #include "llvm/ADT/SCCIterator.h"
  43 #include "llvm/ADT/SmallPtrSet.h"
  44 #include "llvm/ADT/SmallVector.h"
  45 #include "llvm/ADT/Statistic.h"
  46 #include "llvm/Target/TargetInstrInfo.h"
  47 #include "llvm/Target/TargetLowering.h"
  48 #include <algorithm>
  49 using namespace llvm;
  50
  51 STATISTIC(NumCondBranches, "Number of conditional branches");
  52 STATISTIC(NumUncondBranches, "Number of uncondittional branches");
  53 STATISTIC(CondBranchTakenFreq,
  54           "Potential frequency of taking conditional branches");
  55 STATISTIC(UncondBranchTakenFreq,
  56           "Potential frequency of taking unconditional branches");
  57
  58 namespace {
  59 /// \brief A structure for storing a weighted edge.
  60 ///
  61 /// This stores an edge and its weight, computed as the product of the
  62 /// frequency that the starting block is entered with the probability of
  63 /// a particular exit block.
  64 struct WeightedEdge {
  65   BlockFrequency EdgeFrequency;
  66   MachineBasicBlock *From, *To;
  67
  68   bool operator<(const WeightedEdge &RHS) const {
  69     return EdgeFrequency < RHS.EdgeFrequency;
  70   }
  71 };
  72 }
  73
  74 namespace {
  75 class BlockChain;
  76 /// \brief Type for our function-wide basic block -> block chain mapping.
  77 typedef DenseMap<MachineBasicBlock *, BlockChain *> BlockToChainMapType;
  78 }
  79
  80 namespace {
  81 /// \brief A chain of blocks which will be laid out contiguously.
  82 ///
  83 /// This is the datastructure representing a chain of consecutive blocks that
  84 /// are profitable to layout together in order to maximize fallthrough
  85 /// probabilities. We also can use a block chain to represent a sequence of
  86 /// basic blocks which have some external (correctness) requirement for
  87 /// sequential layout.
  88 ///
  89 /// Eventually, the block chains will form a directed graph over the function.
  90 /// We provide an SCC-supporting-iterator in order to quicky build and walk the
  91 /// SCCs of block chains within a function.
  92 ///
  93 /// The block chains also have support for calculating and caching probability
  94 /// information related to the chain itself versus other chains. This is used
  95 /// for ranking during the final layout of block chains.
  96 class BlockChain {
  97   /// \brief The sequence of blocks belonging to this chain.
  98   ///
  99   /// This is the sequence of blocks for a particular chain. These will be laid
 100   /// out in-order within the function.
 101   SmallVector<MachineBasicBlock *, 4> Blocks;
 102
 103   /// \brief A handle to the function-wide basic block to block chain mapping.
 104   ///
 105   /// This is retained in each block chain to simplify the computation of child
 106   /// block chains for SCC-formation and iteration. We store the edges to child
 107   /// basic blocks, and map them back to their associated chains using this
 108   /// structure.
 109   BlockToChainMapType &BlockToChain;
 110
 111 public:
 112   /// \brief Construct a new BlockChain.
 113   ///
 114   /// This builds a new block chain representing a single basic block in the
 115   /// function. It also registers itself as the chain that block participates
 116   /// in with the BlockToChain mapping.
 117   BlockChain(BlockToChainMapType &BlockToChain, MachineBasicBlock *BB)
 118     : Blocks(1, BB), BlockToChain(BlockToChain), LoopPredecessors(0) {
 119     assert(BB && "Cannot create a chain with a null basic block");
 120     BlockToChain[BB] = this;
 121   }
 122
 123   /// \brief Iterator over blocks within the chain.
 124   typedef SmallVectorImpl<MachineBasicBlock *>::const_iterator iterator;
 125
 126   /// \brief Beginning of blocks within the chain.
 127   iterator begin() const { return Blocks.begin(); }
 128
 129   /// \brief End of blocks within the chain.
 130   iterator end() const { return Blocks.end(); }
 131
 132   /// \brief Merge a block chain into this one.
 133   ///
 134   /// This routine merges a block chain into this one. It takes care of forming
 135   /// a contiguous sequence of basic blocks, updating the edge list, and
 136   /// updating the block -> chain mapping. It does not free or tear down the
 137   /// old chain, but the old chain's block list is no longer valid.
 138   void merge(MachineBasicBlock *BB, BlockChain *Chain) {
 139     assert(BB);
 140     assert(!Blocks.empty());
 141
 142     // Fast path in case we don't have a chain already.
 143     if (!Chain) {
 144       assert(!BlockToChain[BB]);
 145       Blocks.push_back(BB);
 146       BlockToChain[BB] = this;
 147       return;
 148     }
 149
 150     assert(BB == *Chain->begin());
 151     assert(Chain->begin() != Chain->end());
 152
 153     // Update the incoming blocks to point to this chain, and add them to the
 154     // chain structure.
 155     for (BlockChain::iterator BI = Chain->begin(), BE = Chain->end();
 156          BI != BE; ++BI) {
 157       Blocks.push_back(*BI);
 158       assert(BlockToChain[*BI] == Chain && "Incoming blocks not in chain");
 159       BlockToChain[*BI] = this;
 160     }
 161   }
 162
 163   /// \brief Count of predecessors within the loop currently being processed.
 164   ///
 165   /// This count is updated at each loop we process to represent the number of
 166   /// in-loop predecessors of this chain.
 167   unsigned LoopPredecessors;
 168 };
 169 }
 170
 171 namespace {
 172 class MachineBlockPlacement : public MachineFunctionPass {
 173   /// \brief A typedef for a block filter set.
 174   typedef SmallPtrSet<MachineBasicBlock *, 16> BlockFilterSet;
 175
 176   /// \brief A handle to the branch probability pass.
 177   const MachineBranchProbabilityInfo *MBPI;
 178
 179   /// \brief A handle to the function-wide block frequency pass.
 180   const MachineBlockFrequencyInfo *MBFI;
 181
 182   /// \brief A handle to the loop info.
 183   const MachineLoopInfo *MLI;
 184
 185   /// \brief A handle to the target's instruction info.
 186   const TargetInstrInfo *TII;
 187
 188   /// \brief A handle to the target's lowering info.
 189   const TargetLowering *TLI;
 190
 191   /// \brief Allocator and owner of BlockChain structures.
 192   ///
 193   /// We build BlockChains lazily by merging together high probability BB
 194   /// sequences acording to the "Algo2" in the paper mentioned at the top of
 195   /// the file. To reduce malloc traffic, we allocate them using this slab-like
 196   /// allocator, and destroy them after the pass completes.
 197   SpecificBumpPtrAllocator<BlockChain> ChainAllocator;
 198
 199   /// \brief Function wide BasicBlock to BlockChain mapping.
 200   ///
 201   /// This mapping allows efficiently moving from any given basic block to the
 202   /// BlockChain it participates in, if any. We use it to, among other things,
 203   /// allow implicitly defining edges between chains as the existing edges
 204   /// between basic blocks.
 205   DenseMap<MachineBasicBlock *, BlockChain *> BlockToChain;
 206
 207   void markChainSuccessors(BlockChain &Chain,
 208                            MachineBasicBlock *LoopHeaderBB,
 209                            SmallVectorImpl<MachineBasicBlock *> &BlockWorkList,
 210                            const BlockFilterSet *BlockFilter = 0);
 211   MachineBasicBlock *selectBestSuccessor(MachineBasicBlock *BB,
 212                                          BlockChain &Chain,
 213                                          const BlockFilterSet *BlockFilter);
 214   MachineBasicBlock *selectBestCandidateBlock(
 215       BlockChain &Chain, SmallVectorImpl<MachineBasicBlock *> &WorkList,
 216       const BlockFilterSet *BlockFilter);
 217   MachineBasicBlock *getFirstUnplacedBlock(
 218       MachineFunction &F,
 219       const BlockChain &PlacedChain,
 220       MachineFunction::iterator &PrevUnplacedBlockIt,
 221       const BlockFilterSet *BlockFilter);
 222   void buildChain(MachineBasicBlock *BB, BlockChain &Chain,
 223                   SmallVectorImpl<MachineBasicBlock *> &BlockWorkList,
 224                   const BlockFilterSet *BlockFilter = 0);
 225   void buildLoopChains(MachineFunction &F, MachineLoop &L);
 226   void buildCFGChains(MachineFunction &F);
 227   void AlignLoops(MachineFunction &F);
 228
 229 public:
 230   static char ID; // Pass identification, replacement for typeid
 231   MachineBlockPlacement() : MachineFunctionPass(ID) {
 232     initializeMachineBlockPlacementPass(*PassRegistry::getPassRegistry());
 233   }
 234
 235   bool runOnMachineFunction(MachineFunction &F);
 236
 237   void getAnalysisUsage(AnalysisUsage &AU) const {
 238     AU.addRequired<MachineBranchProbabilityInfo>();
 239     AU.addRequired<MachineBlockFrequencyInfo>();
 240     AU.addRequired<MachineLoopInfo>();
 241     MachineFunctionPass::getAnalysisUsage(AU);
 242   }
 243
 244   const char *getPassName() const { return "Block Placement"; }
 245 };
 246 }
 247
 248 char MachineBlockPlacement::ID = 0;
 249 INITIALIZE_PASS_BEGIN(MachineBlockPlacement, "block-placement2",
 250                       "Branch Probability Basic Block Placement", false, false)
 251 INITIALIZE_PASS_DEPENDENCY(MachineBranchProbabilityInfo)
 252 INITIALIZE_PASS_DEPENDENCY(MachineBlockFrequencyInfo)
 253 INITIALIZE_PASS_DEPENDENCY(MachineLoopInfo)
 254 INITIALIZE_PASS_END(MachineBlockPlacement, "block-placement2",
 255                     "Branch Probability Basic Block Placement", false, false)
 256
 257 FunctionPass *llvm::createMachineBlockPlacementPass() {
 258   return new MachineBlockPlacement();
 259 }
 260
 261 #ifndef NDEBUG
 262 /// \brief Helper to print the name of a MBB.
 263 ///
 264 /// Only used by debug logging.
 265 static std::string getBlockName(MachineBasicBlock *BB) {
 266   std::string Result;
 267   raw_string_ostream OS(Result);
 268   OS << "BB#" << BB->getNumber()
 269      << " (derived from LLVM BB '" << BB->getName() << "')";
 270   OS.flush();
 271   return Result;
 272 }
 273
 274 /// \brief Helper to print the number of a MBB.
 275 ///
 276 /// Only used by debug logging.
 277 static std::string getBlockNum(MachineBasicBlock *BB) {
 278   std::string Result;
 279   raw_string_ostream OS(Result);
 280   OS << "BB#" << BB->getNumber();
 281   OS.flush();
 282   return Result;
 283 }
 284 #endif
 285
 286 /// \brief Mark a chain's successors as having one fewer preds.
 287 ///
 288 /// When a chain is being merged into the "placed" chain, this routine will
 289 /// quickly walk the successors of each block in the chain and mark them as
 290 /// having one fewer active predecessor. It also adds any successors of this
 291 /// chain which reach the zero-predecessor state to the worklist passed in.
 292 void MachineBlockPlacement::markChainSuccessors(
 293     BlockChain &Chain,
 294     MachineBasicBlock *LoopHeaderBB,
 295     SmallVectorImpl<MachineBasicBlock *> &BlockWorkList,
 296     const BlockFilterSet *BlockFilter) {
 297   // Walk all the blocks in this chain, marking their successors as having
 298   // a predecessor placed.
 299   for (BlockChain::iterator CBI = Chain.begin(), CBE = Chain.end();
 300        CBI != CBE; ++CBI) {
 301     // Add any successors for which this is the only un-placed in-loop
 302     // predecessor to the worklist as a viable candidate for CFG-neutral
 303     // placement. No subsequent placement of this block will violate the CFG
 304     // shape, so we get to use heuristics to choose a favorable placement.
 305     for (MachineBasicBlock::succ_iterator SI = (*CBI)->succ_begin(),
 306                                           SE = (*CBI)->succ_end();
 307          SI != SE; ++SI) {
 308       if (BlockFilter && !BlockFilter->count(*SI))
 309         continue;
 310       BlockChain &SuccChain = *BlockToChain[*SI];
 311       // Disregard edges within a fixed chain, or edges to the loop header.
 312       if (&Chain == &SuccChain || *SI == LoopHeaderBB)
 313         continue;
 314
 315       // This is a cross-chain edge that is within the loop, so decrement the
 316       // loop predecessor count of the destination chain.
 317       if (SuccChain.LoopPredecessors > 0 && --SuccChain.LoopPredecessors == 0)
 318         BlockWorkList.push_back(*SI);
 319     }
 320   }
 321 }
 322
 323 /// \brief Select the best successor for a block.
 324 ///
 325 /// This looks across all successors of a particular block and attempts to
 326 /// select the "best" one to be the layout successor. It only considers direct
 327 /// successors which also pass the block filter. It will attempt to avoid
 328 /// breaking CFG structure, but cave and break such structures in the case of
 329 /// very hot successor edges.
 330 ///
 331 /// \returns The best successor block found, or null if none are viable.
 332 MachineBasicBlock *MachineBlockPlacement::selectBestSuccessor(
 333     MachineBasicBlock *BB, BlockChain &Chain,
 334     const BlockFilterSet *BlockFilter) {
 335   const BranchProbability HotProb(4, 5); // 80%
 336
 337   MachineBasicBlock *BestSucc = 0;
 338   // FIXME: Due to the performance of the probability and weight routines in
 339   // the MBPI analysis, we manually compute probabilities using the edge
 340   // weights. This is suboptimal as it means that the somewhat subtle
 341   // definition of edge weight semantics is encoded here as well. We should
 342   // improve the MBPI interface to effeciently support query patterns such as
 343   // this.
 344   uint32_t BestWeight = 0;
 345   uint32_t WeightScale = 0;
 346   uint32_t SumWeight = MBPI->getSumForBlock(BB, WeightScale);
 347   DEBUG(dbgs() << "Attempting merge from: " << getBlockName(BB) << "\n");
 348   for (MachineBasicBlock::succ_iterator SI = BB->succ_begin(),
 349                                         SE = BB->succ_end();
 350        SI != SE; ++SI) {
 351     if (BlockFilter && !BlockFilter->count(*SI))
 352       continue;
 353     BlockChain &SuccChain = *BlockToChain[*SI];
 354     if (&SuccChain == &Chain) {
 355       DEBUG(dbgs() << "    " << getBlockName(*SI) << " -> Already merged!\n");
 356       continue;
 357     }
 358
 359     uint32_t SuccWeight = MBPI->getEdgeWeight(BB, *SI);
 360     BranchProbability SuccProb(SuccWeight / WeightScale, SumWeight);
 361
 362     // Only consider successors which are either "hot", or wouldn't violate
 363     // any CFG constraints.
 364     if (SuccChain.LoopPredecessors != 0 && SuccProb < HotProb) {
 365       DEBUG(dbgs() << "    " << getBlockName(*SI) << " -> CFG conflict\n");
 366       continue;
 367     }
 368
 369     DEBUG(dbgs() << "    " << getBlockName(*SI) << " -> " << SuccProb
 370                  << " (prob)"
 371                  << (SuccChain.LoopPredecessors != 0 ? " (CFG break)" : "")
 372                  << "\n");
 373     if (BestSucc && BestWeight >= SuccWeight)
 374       continue;
 375     BestSucc = *SI;
 376     BestWeight = SuccWeight;
 377   }
 378   return BestSucc;
 379 }
 380
 381 namespace {
 382 /// \brief Predicate struct to detect blocks already placed.
 383 class IsBlockPlaced {
 384   const BlockChain &PlacedChain;
 385   const BlockToChainMapType &BlockToChain;
 386
 387 public:
 388   IsBlockPlaced(const BlockChain &PlacedChain,
 389                 const BlockToChainMapType &BlockToChain)
 390       : PlacedChain(PlacedChain), BlockToChain(BlockToChain) {}
 391
 392   bool operator()(MachineBasicBlock *BB) const {
 393     return BlockToChain.lookup(BB) == &PlacedChain;
 394   }
 395 };
 396 }
 397
 398 /// \brief Select the best block from a worklist.
 399 ///
 400 /// This looks through the provided worklist as a list of candidate basic
 401 /// blocks and select the most profitable one to place. The definition of
 402 /// profitable only really makes sense in the context of a loop. This returns
 403 /// the most frequently visited block in the worklist, which in the case of
 404 /// a loop, is the one most desirable to be physically close to the rest of the
 405 /// loop body in order to improve icache behavior.
 406 ///
 407 /// \returns The best block found, or null if none are viable.
 408 MachineBasicBlock *MachineBlockPlacement::selectBestCandidateBlock(
 409     BlockChain &Chain, SmallVectorImpl<MachineBasicBlock *> &WorkList,
 410     const BlockFilterSet *BlockFilter) {
 411   // Once we need to walk the worklist looking for a candidate, cleanup the
 412   // worklist of already placed entries.
 413   // FIXME: If this shows up on profiles, it could be folded (at the cost of
 414   // some code complexity) into the loop below.
 415   WorkList.erase(std::remove_if(WorkList.begin(), WorkList.end(),
 416                                 IsBlockPlaced(Chain, BlockToChain)),
 417                  WorkList.end());
 418
 419   MachineBasicBlock *BestBlock = 0;
 420   BlockFrequency BestFreq;
 421   for (SmallVectorImpl<MachineBasicBlock *>::iterator WBI = WorkList.begin(),
 422                                                       WBE = WorkList.end();
 423        WBI != WBE; ++WBI) {
 424     assert(!BlockFilter || BlockFilter->count(*WBI));
 425     BlockChain &SuccChain = *BlockToChain[*WBI];
 426     if (&SuccChain == &Chain) {
 427       DEBUG(dbgs() << "    " << getBlockName(*WBI)
 428                    << " -> Already merged!\n");
 429       continue;
 430     }
 431     assert(SuccChain.LoopPredecessors == 0 && "Found CFG-violating block");
 432
 433     BlockFrequency CandidateFreq = MBFI->getBlockFreq(*WBI);
 434     DEBUG(dbgs() << "    " << getBlockName(*WBI) << " -> " << CandidateFreq
 435                  << " (freq)\n");
 436     if (BestBlock && BestFreq >= CandidateFreq)
 437       continue;
 438     BestBlock = *WBI;
 439     BestFreq = CandidateFreq;
 440   }
 441   return BestBlock;
 442 }
 443
 444 /// \brief Retrieve the first unplaced basic block.
 445 ///
 446 /// This routine is called when we are unable to use the CFG to walk through
 447 /// all of the basic blocks and form a chain due to unnatural loops in the CFG.
 448 /// We walk through the function's blocks in order, starting from the
 449 /// LastUnplacedBlockIt. We update this iterator on each call to avoid
 450 /// re-scanning the entire sequence on repeated calls to this routine.
 451 MachineBasicBlock *MachineBlockPlacement::getFirstUnplacedBlock(
 452     MachineFunction &F, const BlockChain &PlacedChain,
 453     MachineFunction::iterator &PrevUnplacedBlockIt,
 454     const BlockFilterSet *BlockFilter) {
 455   for (MachineFunction::iterator I = PrevUnplacedBlockIt, E = F.end(); I != E;
 456        ++I) {
 457     if (BlockFilter && !BlockFilter->count(I))
 458       continue;
 459     if (BlockToChain[I] != &PlacedChain) {
 460       PrevUnplacedBlockIt = I;
 461       return I;
 462     }
 463   }
 464   return 0;
 465 }
 466
 467 void MachineBlockPlacement::buildChain(
 468     MachineBasicBlock *BB,
 469     BlockChain &Chain,
 470     SmallVectorImpl<MachineBasicBlock *> &BlockWorkList,
 471     const BlockFilterSet *BlockFilter) {
 472   assert(BB);
 473   assert(BlockToChain[BB] == &Chain);
 474   assert(*Chain.begin() == BB);
 475   SmallVector<MachineOperand, 4> Cond; // For AnalyzeBranch.
 476   MachineFunction &F = *BB->getParent();
 477   MachineFunction::iterator PrevUnplacedBlockIt = F.begin();
 478
 479   MachineBasicBlock *LoopHeaderBB = BB;
 480   markChainSuccessors(Chain, LoopHeaderBB, BlockWorkList, BlockFilter);
 481   BB = *llvm::prior(Chain.end());
 482   for (;;) {
 483     assert(BB);
 484     assert(BlockToChain[BB] == &Chain);
 485     assert(*llvm::prior(Chain.end()) == BB);
 486     MachineBasicBlock *BestSucc = 0;
 487
 488     // Check for unreasonable branches, and forcibly merge the existing layout
 489     // successor for them. We can handle cases that AnalyzeBranch can't: jump
 490     // tables etc are fine. The case we want to handle specially is when there
 491     // is potential fallthrough, but the branch cannot be analyzed. This
 492     // includes blocks without terminators as well as other cases.
 493     Cond.clear();
 494     MachineBasicBlock *TBB = 0, *FBB = 0; // For AnalyzeBranch.
 495     if (TII->AnalyzeBranch(*BB, TBB, FBB, Cond) && BB->canFallThrough()) {
 496       MachineFunction::iterator I(BB), NextI(llvm::next(I));
 497       // Ensure that the layout successor is a viable block, as we know that
 498       // fallthrough is a possibility. Note that this may not be a valid block
 499       // in the loop, but we allow that to cope with degenerate situations.
 500       assert(NextI != BB->getParent()->end());
 501       BestSucc = NextI;
 502     }
 503
 504     // Otherwise, look for the best viable successor if there is one to place
 505     // immediately after this block.
 506     if (!BestSucc)
 507       BestSucc = selectBestSuccessor(BB, Chain, BlockFilter);
 508
 509     // If an immediate successor isn't available, look for the best viable
 510     // block among those we've identified as not violating the loop's CFG at
 511     // this point. This won't be a fallthrough, but it will increase locality.
 512     if (!BestSucc)
 513       BestSucc = selectBestCandidateBlock(Chain, BlockWorkList, BlockFilter);
 514
 515     if (!BestSucc) {
 516       BestSucc = getFirstUnplacedBlock(F, Chain, PrevUnplacedBlockIt,
 517                                        BlockFilter);
 518       if (!BestSucc)
 519         break;
 520
 521       DEBUG(dbgs() << "Unnatural loop CFG detected, forcibly merging the "
 522                       "layout successor until the CFG reduces\n");
 523     }
 524
 525     // Place this block, updating the datastructures to reflect its placement.
 526     BlockChain &SuccChain = *BlockToChain[BestSucc];
 527     // Zero out LoopPredecessors for the successor we're about to merge in case
 528     // we selected a successor that didn't fit naturally into the CFG.
 529     SuccChain.LoopPredecessors = 0;
 530     DEBUG(dbgs() << "Merging from " << getBlockNum(BB)
 531                  << " to " << getBlockNum(BestSucc) << "\n");
 532     markChainSuccessors(SuccChain, LoopHeaderBB, BlockWorkList, BlockFilter);
 533     Chain.merge(BestSucc, &SuccChain);
 534     BB = *llvm::prior(Chain.end());
 535   };
 536
 537   DEBUG(dbgs() << "Finished forming chain for header block "
 538                << getBlockNum(*Chain.begin()) << "\n");
 539 }
 540
 541 /// \brief Forms basic block chains from the natural loop structures.
 542 ///
 543 /// These chains are designed to preserve the existing *structure* of the code
 544 /// as much as possible. We can then stitch the chains together in a way which
 545 /// both preserves the topological structure and minimizes taken conditional
 546 /// branches.
 547 void MachineBlockPlacement::buildLoopChains(MachineFunction &F,
 548                                             MachineLoop &L) {
 549   // First recurse through any nested loops, building chains for those inner
 550   // loops.
 551   for (MachineLoop::iterator LI = L.begin(), LE = L.end(); LI != LE; ++LI)
 552     buildLoopChains(F, **LI);
 553
 554   SmallVector<MachineBasicBlock *, 16> BlockWorkList;
 555   BlockFilterSet LoopBlockSet(L.block_begin(), L.block_end());
 556   BlockChain &LoopChain = *BlockToChain[L.getHeader()];
 557
 558   // FIXME: This is a really lame way of walking the chains in the loop: we
 559   // walk the blocks, and use a set to prevent visiting a particular chain
 560   // twice.
 561   SmallPtrSet<BlockChain *, 4> UpdatedPreds;
 562   for (MachineLoop::block_iterator BI = L.block_begin(),
 563                                    BE = L.block_end();
 564        BI != BE; ++BI) {
 565     BlockChain &Chain = *BlockToChain[*BI];
 566     if (!UpdatedPreds.insert(&Chain) || BI == L.block_begin())
 567       continue;
 568
 569     assert(Chain.LoopPredecessors == 0);
 570     for (BlockChain::iterator BCI = Chain.begin(), BCE = Chain.end();
 571          BCI != BCE; ++BCI) {
 572       assert(BlockToChain[*BCI] == &Chain);
 573       for (MachineBasicBlock::pred_iterator PI = (*BCI)->pred_begin(),
 574                                             PE = (*BCI)->pred_end();
 575            PI != PE; ++PI) {
 576         if (BlockToChain[*PI] == &Chain || !LoopBlockSet.count(*PI))
 577           continue;
 578         ++Chain.LoopPredecessors;
 579       }
 580     }
 581
 582     if (Chain.LoopPredecessors == 0)
 583       BlockWorkList.push_back(*BI);
 584   }
 585
 586   buildChain(*L.block_begin(), LoopChain, BlockWorkList, &LoopBlockSet);
 587
 588   DEBUG({
 589     // Crash at the end so we get all of the debugging output first.
 590     bool BadLoop = false;
 591     if (LoopChain.LoopPredecessors) {
 592       BadLoop = true;
 593       dbgs() << "Loop chain contains a block without its preds placed!\n"
 594              << "  Loop header:  " << getBlockName(*L.block_begin()) << "\n"
 595              << "  Chain header: " << getBlockName(*LoopChain.begin()) << "\n";
 596     }
 597     for (BlockChain::iterator BCI = LoopChain.begin(), BCE = LoopChain.end();
 598          BCI != BCE; ++BCI)
 599       if (!LoopBlockSet.erase(*BCI)) {
 600         // We don't mark the loop as bad here because there are real situations
 601         // where this can occur. For example, with an unanalyzable fallthrough
 602         // from a loop block to a non-loop block.
 603         // FIXME: Such constructs shouldn't exist. Track them down and fix them.
 604         dbgs() << "Loop chain contains a block not contained by the loop!\n"
 605                << "  Loop header:  " << getBlockName(*L.block_begin()) << "\n"
 606                << "  Chain header: " << getBlockName(*LoopChain.begin()) << "\n"
 607                << "  Bad block:    " << getBlockName(*BCI) << "\n";
 608       }
 609
 610     if (!LoopBlockSet.empty()) {
 611       BadLoop = true;
 612       for (BlockFilterSet::iterator LBI = LoopBlockSet.begin(),
 613                                     LBE = LoopBlockSet.end();
 614            LBI != LBE; ++LBI)
 615         dbgs() << "Loop contains blocks never placed into a chain!\n"
 616                << "  Loop header:  " << getBlockName(*L.block_begin()) << "\n"
 617                << "  Chain header: " << getBlockName(*LoopChain.begin()) << "\n"
 618                << "  Bad block:    " << getBlockName(*LBI) << "\n";
 619     }
 620     assert(!BadLoop && "Detected problems with the placement of this loop.");
 621   });
 622 }
 623
 624 void MachineBlockPlacement::buildCFGChains(MachineFunction &F) {
 625   // Ensure that every BB in the function has an associated chain to simplify
 626   // the assumptions of the remaining algorithm.
 627   for (MachineFunction::iterator FI = F.begin(), FE = F.end(); FI != FE; ++FI)
 628     BlockToChain[&*FI] =
 629       new (ChainAllocator.Allocate()) BlockChain(BlockToChain, &*FI);
 630
 631   // Build any loop-based chains.
 632   for (MachineLoopInfo::iterator LI = MLI->begin(), LE = MLI->end(); LI != LE;
 633        ++LI)
 634     buildLoopChains(F, **LI);
 635
 636   SmallVector<MachineBasicBlock *, 16> BlockWorkList;
 637
 638   SmallPtrSet<BlockChain *, 4> UpdatedPreds;
 639   for (MachineFunction::iterator FI = F.begin(), FE = F.end(); FI != FE; ++FI) {
 640     MachineBasicBlock *BB = &*FI;
 641     BlockChain &Chain = *BlockToChain[BB];
 642     if (!UpdatedPreds.insert(&Chain))
 643       continue;
 644
 645     assert(Chain.LoopPredecessors == 0);
 646     for (BlockChain::iterator BCI = Chain.begin(), BCE = Chain.end();
 647          BCI != BCE; ++BCI) {
 648       assert(BlockToChain[*BCI] == &Chain);
 649       for (MachineBasicBlock::pred_iterator PI = (*BCI)->pred_begin(),
 650                                             PE = (*BCI)->pred_end();
 651            PI != PE; ++PI) {
 652         if (BlockToChain[*PI] == &Chain)
 653           continue;
 654         ++Chain.LoopPredecessors;
 655       }
 656     }
 657
 658     if (Chain.LoopPredecessors == 0)
 659       BlockWorkList.push_back(BB);
 660   }
 661
 662   BlockChain &FunctionChain = *BlockToChain[&F.front()];
 663   buildChain(&F.front(), FunctionChain, BlockWorkList);
 664
 665   typedef SmallPtrSet<MachineBasicBlock *, 16> FunctionBlockSetType;
 666   DEBUG({
 667     // Crash at the end so we get all of the debugging output first.
 668     bool BadFunc = false;
 669     FunctionBlockSetType FunctionBlockSet;
 670     for (MachineFunction::iterator FI = F.begin(), FE = F.end(); FI != FE; ++FI)
 671       FunctionBlockSet.insert(FI);
 672
 673     for (BlockChain::iterator BCI = FunctionChain.begin(),
 674                               BCE = FunctionChain.end();
 675          BCI != BCE; ++BCI)
 676       if (!FunctionBlockSet.erase(*BCI)) {
 677         BadFunc = true;
 678         dbgs() << "Function chain contains a block not in the function!\n"
 679                << "  Bad block:    " << getBlockName(*BCI) << "\n";
 680       }
 681
 682     if (!FunctionBlockSet.empty()) {
 683       BadFunc = true;
 684       for (FunctionBlockSetType::iterator FBI = FunctionBlockSet.begin(),
 685                                           FBE = FunctionBlockSet.end();
 686            FBI != FBE; ++FBI)
 687         dbgs() << "Function contains blocks never placed into a chain!\n"
 688                << "  Bad block:    " << getBlockName(*FBI) << "\n";
 689     }
 690     assert(!BadFunc && "Detected problems with the block placement.");
 691   });
 692
 693   // Splice the blocks into place.
 694   MachineFunction::iterator InsertPos = F.begin();
 695   SmallVector<MachineOperand, 4> Cond; // For AnalyzeBranch.
 696   for (BlockChain::iterator BI = FunctionChain.begin(),
 697                             BE = FunctionChain.end();
 698        BI != BE; ++BI) {
 699     DEBUG(dbgs() << (BI == FunctionChain.begin() ? "Placing chain "
 700                                                   : "          ... ")
 701           << getBlockName(*BI) << "\n");
 702     if (InsertPos != MachineFunction::iterator(*BI))
 703       F.splice(InsertPos, *BI);
 704     else
 705       ++InsertPos;
 706
 707     // Update the terminator of the previous block.
 708     if (BI == FunctionChain.begin())
 709       continue;
 710     MachineBasicBlock *PrevBB = llvm::prior(MachineFunction::iterator(*BI));
 711
 712     // FIXME: It would be awesome of updateTerminator would just return rather
 713     // than assert when the branch cannot be analyzed in order to remove this
 714     // boiler plate.
 715     Cond.clear();
 716     MachineBasicBlock *TBB = 0, *FBB = 0; // For AnalyzeBranch.
 717     if (!TII->AnalyzeBranch(*PrevBB, TBB, FBB, Cond))
 718       PrevBB->updateTerminator();
 719   }
 720
 721   // Fixup the last block.
 722   Cond.clear();
 723   MachineBasicBlock *TBB = 0, *FBB = 0; // For AnalyzeBranch.
 724   if (!TII->AnalyzeBranch(F.back(), TBB, FBB, Cond))
 725     F.back().updateTerminator();
 726 }
 727
 728 /// \brief Recursive helper to align a loop and any nested loops.
 729 static void AlignLoop(MachineFunction &F, MachineLoop *L, unsigned Align) {
 730   // Recurse through nested loops.
 731   for (MachineLoop::iterator I = L->begin(), E = L->end(); I != E; ++I)
 732     AlignLoop(F, *I, Align);
 733
 734   L->getTopBlock()->setAlignment(Align);
 735 }
 736
 737 /// \brief Align loop headers to target preferred alignments.
 738 void MachineBlockPlacement::AlignLoops(MachineFunction &F) {
 739   if (F.getFunction()->hasFnAttr(Attribute::OptimizeForSize))
 740     return;
 741
 742   unsigned Align = TLI->getPrefLoopAlignment();
 743   if (!Align)
 744     return;  // Don't care about loop alignment.
 745
 746   for (MachineLoopInfo::iterator I = MLI->begin(), E = MLI->end(); I != E; ++I)
 747     AlignLoop(F, *I, Align);
 748 }
 749
 750 bool MachineBlockPlacement::runOnMachineFunction(MachineFunction &F) {
 751   // Check for single-block functions and skip them.
 752   if (llvm::next(F.begin()) == F.end())
 753     return false;
 754
 755   MBPI = &getAnalysis<MachineBranchProbabilityInfo>();
 756   MBFI = &getAnalysis<MachineBlockFrequencyInfo>();
 757   MLI = &getAnalysis<MachineLoopInfo>();
 758   TII = F.getTarget().getInstrInfo();
 759   TLI = F.getTarget().getTargetLowering();
 760   assert(BlockToChain.empty());
 761
 762   buildCFGChains(F);
 763   AlignLoops(F);
 764
 765   BlockToChain.clear();
 766   ChainAllocator.DestroyAll();
 767
 768   // We always return true as we have no way to track whether the final order
 769   // differs from the original order.
 770   return true;
 771 }
 772
 773 namespace {
 774 /// \brief A pass to compute block placement statistics.
 775 ///
 776 /// A separate pass to compute interesting statistics for evaluating block
 777 /// placement. This is separate from the actual placement pass so that they can
 778 /// be computed in the absense of any placement transformations or when using
 779 /// alternative placement strategies.
 780 class MachineBlockPlacementStats : public MachineFunctionPass {
 781   /// \brief A handle to the branch probability pass.
 782   const MachineBranchProbabilityInfo *MBPI;
 783
 784   /// \brief A handle to the function-wide block frequency pass.
 785   const MachineBlockFrequencyInfo *MBFI;
 786
 787 public:
 788   static char ID; // Pass identification, replacement for typeid
 789   MachineBlockPlacementStats() : MachineFunctionPass(ID) {
 790     initializeMachineBlockPlacementStatsPass(*PassRegistry::getPassRegistry());
 791   }
 792
 793   bool runOnMachineFunction(MachineFunction &F);
 794
 795   void getAnalysisUsage(AnalysisUsage &AU) const {
 796     AU.addRequired<MachineBranchProbabilityInfo>();
 797     AU.addRequired<MachineBlockFrequencyInfo>();
 798     AU.setPreservesAll();
 799     MachineFunctionPass::getAnalysisUsage(AU);
 800   }
 801
 802   const char *getPassName() const { return "Block Placement Stats"; }
 803 };
 804 }
 805
 806 char MachineBlockPlacementStats::ID = 0;
 807 INITIALIZE_PASS_BEGIN(MachineBlockPlacementStats, "block-placement-stats",
 808                       "Basic Block Placement Stats", false, false)
 809 INITIALIZE_PASS_DEPENDENCY(MachineBranchProbabilityInfo)
 810 INITIALIZE_PASS_DEPENDENCY(MachineBlockFrequencyInfo)
 811 INITIALIZE_PASS_END(MachineBlockPlacementStats, "block-placement-stats",
 812                     "Basic Block Placement Stats", false, false)
 813
 814 FunctionPass *llvm::createMachineBlockPlacementStatsPass() {
 815   return new MachineBlockPlacementStats();
 816 }
 817
 818 bool MachineBlockPlacementStats::runOnMachineFunction(MachineFunction &F) {
 819   // Check for single-block functions and skip them.
 820   if (llvm::next(F.begin()) == F.end())
 821     return false;
 822
 823   MBPI = &getAnalysis<MachineBranchProbabilityInfo>();
 824   MBFI = &getAnalysis<MachineBlockFrequencyInfo>();
 825
 826   for (MachineFunction::iterator I = F.begin(), E = F.end(); I != E; ++I) {
 827     BlockFrequency BlockFreq = MBFI->getBlockFreq(I);
 828     Statistic &NumBranches = (I->succ_size() > 1) ? NumCondBranches
 829                                                   : NumUncondBranches;
 830     Statistic &BranchTakenFreq = (I->succ_size() > 1) ? CondBranchTakenFreq
 831                                                       : UncondBranchTakenFreq;
 832     for (MachineBasicBlock::succ_iterator SI = I->succ_begin(),
 833                                           SE = I->succ_end();
 834          SI != SE; ++SI) {
 835       // Skip if this successor is a fallthrough.
 836       if (I->isLayoutSuccessor(*SI))
 837         continue;
 838
 839       BlockFrequency EdgeFreq = BlockFreq * MBPI->getEdgeProbability(I, *SI);
 840       ++NumBranches;
 841       BranchTakenFreq += EdgeFreq.getFrequency();
 842     }
 843   }
 844
 845   return false;
 846 }
 847