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     if (*SI != *SuccChain.begin()) {
 359       DEBUG(dbgs() << "    " << getBlockName(*SI) << " -> Mid chain!\n");
 360       continue;
 361     }
 362
 363     uint32_t SuccWeight = MBPI->getEdgeWeight(BB, *SI);
 364     BranchProbability SuccProb(SuccWeight / WeightScale, SumWeight);
 365
 366     // Only consider successors which are either "hot", or wouldn't violate
 367     // any CFG constraints.
 368     if (SuccChain.LoopPredecessors != 0 && SuccProb < HotProb) {
 369       DEBUG(dbgs() << "    " << getBlockName(*SI) << " -> CFG conflict\n");
 370       continue;
 371     }
 372
 373     DEBUG(dbgs() << "    " << getBlockName(*SI) << " -> " << SuccProb
 374                  << " (prob)"
 375                  << (SuccChain.LoopPredecessors != 0 ? " (CFG break)" : "")
 376                  << "\n");
 377     if (BestSucc && BestWeight >= SuccWeight)
 378       continue;
 379     BestSucc = *SI;
 380     BestWeight = SuccWeight;
 381   }
 382   return BestSucc;
 383 }
 384
 385 namespace {
 386 /// \brief Predicate struct to detect blocks already placed.
 387 class IsBlockPlaced {
 388   const BlockChain &PlacedChain;
 389   const BlockToChainMapType &BlockToChain;
 390
 391 public:
 392   IsBlockPlaced(const BlockChain &PlacedChain,
 393                 const BlockToChainMapType &BlockToChain)
 394       : PlacedChain(PlacedChain), BlockToChain(BlockToChain) {}
 395
 396   bool operator()(MachineBasicBlock *BB) const {
 397     return BlockToChain.lookup(BB) == &PlacedChain;
 398   }
 399 };
 400 }
 401
 402 /// \brief Select the best block from a worklist.
 403 ///
 404 /// This looks through the provided worklist as a list of candidate basic
 405 /// blocks and select the most profitable one to place. The definition of
 406 /// profitable only really makes sense in the context of a loop. This returns
 407 /// the most frequently visited block in the worklist, which in the case of
 408 /// a loop, is the one most desirable to be physically close to the rest of the
 409 /// loop body in order to improve icache behavior.
 410 ///
 411 /// \returns The best block found, or null if none are viable.
 412 MachineBasicBlock *MachineBlockPlacement::selectBestCandidateBlock(
 413     BlockChain &Chain, SmallVectorImpl<MachineBasicBlock *> &WorkList,
 414     const BlockFilterSet *BlockFilter) {
 415   // Once we need to walk the worklist looking for a candidate, cleanup the
 416   // worklist of already placed entries.
 417   // FIXME: If this shows up on profiles, it could be folded (at the cost of
 418   // some code complexity) into the loop below.
 419   WorkList.erase(std::remove_if(WorkList.begin(), WorkList.end(),
 420                                 IsBlockPlaced(Chain, BlockToChain)),
 421                  WorkList.end());
 422
 423   MachineBasicBlock *BestBlock = 0;
 424   BlockFrequency BestFreq;
 425   for (SmallVectorImpl<MachineBasicBlock *>::iterator WBI = WorkList.begin(),
 426                                                       WBE = WorkList.end();
 427        WBI != WBE; ++WBI) {
 428     assert(!BlockFilter || BlockFilter->count(*WBI));
 429     BlockChain &SuccChain = *BlockToChain[*WBI];
 430     if (&SuccChain == &Chain) {
 431       DEBUG(dbgs() << "    " << getBlockName(*WBI)
 432                    << " -> Already merged!\n");
 433       continue;
 434     }
 435     assert(SuccChain.LoopPredecessors == 0 && "Found CFG-violating block");
 436
 437     BlockFrequency CandidateFreq = MBFI->getBlockFreq(*WBI);
 438     DEBUG(dbgs() << "    " << getBlockName(*WBI) << " -> " << CandidateFreq
 439                  << " (freq)\n");
 440     if (BestBlock && BestFreq >= CandidateFreq)
 441       continue;
 442     BestBlock = *WBI;
 443     BestFreq = CandidateFreq;
 444   }
 445   return BestBlock;
 446 }
 447
 448 /// \brief Retrieve the first unplaced basic block.
 449 ///
 450 /// This routine is called when we are unable to use the CFG to walk through
 451 /// all of the basic blocks and form a chain due to unnatural loops in the CFG.
 452 /// We walk through the function's blocks in order, starting from the
 453 /// LastUnplacedBlockIt. We update this iterator on each call to avoid
 454 /// re-scanning the entire sequence on repeated calls to this routine.
 455 MachineBasicBlock *MachineBlockPlacement::getFirstUnplacedBlock(
 456     MachineFunction &F, const BlockChain &PlacedChain,
 457     MachineFunction::iterator &PrevUnplacedBlockIt,
 458     const BlockFilterSet *BlockFilter) {
 459   for (MachineFunction::iterator I = PrevUnplacedBlockIt, E = F.end(); I != E;
 460        ++I) {
 461     if (BlockFilter && !BlockFilter->count(I))
 462       continue;
 463     if (BlockToChain[I] != &PlacedChain) {
 464       PrevUnplacedBlockIt = I;
 465       return I;
 466     }
 467   }
 468   return 0;
 469 }
 470
 471 void MachineBlockPlacement::buildChain(
 472     MachineBasicBlock *BB,
 473     BlockChain &Chain,
 474     SmallVectorImpl<MachineBasicBlock *> &BlockWorkList,
 475     const BlockFilterSet *BlockFilter) {
 476   assert(BB);
 477   assert(BlockToChain[BB] == &Chain);
 478   assert(*Chain.begin() == BB);
 479   MachineFunction &F = *BB->getParent();
 480   MachineFunction::iterator PrevUnplacedBlockIt = F.begin();
 481
 482   MachineBasicBlock *LoopHeaderBB = BB;
 483   markChainSuccessors(Chain, LoopHeaderBB, BlockWorkList, BlockFilter);
 484   BB = *llvm::prior(Chain.end());
 485   for (;;) {
 486     assert(BB);
 487     assert(BlockToChain[BB] == &Chain);
 488     assert(*llvm::prior(Chain.end()) == BB);
 489     MachineBasicBlock *BestSucc = 0;
 490
 491     // Look for the best viable successor if there is one to place immediately
 492     // after this block.
 493     BestSucc = selectBestSuccessor(BB, Chain, BlockFilter);
 494
 495     // If an immediate successor isn't available, look for the best viable
 496     // block among those we've identified as not violating the loop's CFG at
 497     // this point. This won't be a fallthrough, but it will increase locality.
 498     if (!BestSucc)
 499       BestSucc = selectBestCandidateBlock(Chain, BlockWorkList, BlockFilter);
 500
 501     if (!BestSucc) {
 502       BestSucc = getFirstUnplacedBlock(F, Chain, PrevUnplacedBlockIt,
 503                                        BlockFilter);
 504       if (!BestSucc)
 505         break;
 506
 507       DEBUG(dbgs() << "Unnatural loop CFG detected, forcibly merging the "
 508                       "layout successor until the CFG reduces\n");
 509     }
 510
 511     // Place this block, updating the datastructures to reflect its placement.
 512     BlockChain &SuccChain = *BlockToChain[BestSucc];
 513     // Zero out LoopPredecessors for the successor we're about to merge in case
 514     // we selected a successor that didn't fit naturally into the CFG.
 515     SuccChain.LoopPredecessors = 0;
 516     DEBUG(dbgs() << "Merging from " << getBlockNum(BB)
 517                  << " to " << getBlockNum(BestSucc) << "\n");
 518     markChainSuccessors(SuccChain, LoopHeaderBB, BlockWorkList, BlockFilter);
 519     Chain.merge(BestSucc, &SuccChain);
 520     BB = *llvm::prior(Chain.end());
 521   };
 522
 523   DEBUG(dbgs() << "Finished forming chain for header block "
 524                << getBlockNum(*Chain.begin()) << "\n");
 525 }
 526
 527 /// \brief Forms basic block chains from the natural loop structures.
 528 ///
 529 /// These chains are designed to preserve the existing *structure* of the code
 530 /// as much as possible. We can then stitch the chains together in a way which
 531 /// both preserves the topological structure and minimizes taken conditional
 532 /// branches.
 533 void MachineBlockPlacement::buildLoopChains(MachineFunction &F,
 534                                             MachineLoop &L) {
 535   // First recurse through any nested loops, building chains for those inner
 536   // loops.
 537   for (MachineLoop::iterator LI = L.begin(), LE = L.end(); LI != LE; ++LI)
 538     buildLoopChains(F, **LI);
 539
 540   SmallVector<MachineBasicBlock *, 16> BlockWorkList;
 541   BlockFilterSet LoopBlockSet(L.block_begin(), L.block_end());
 542   BlockChain &LoopChain = *BlockToChain[L.getHeader()];
 543
 544   // FIXME: This is a really lame way of walking the chains in the loop: we
 545   // walk the blocks, and use a set to prevent visiting a particular chain
 546   // twice.
 547   SmallPtrSet<BlockChain *, 4> UpdatedPreds;
 548   for (MachineLoop::block_iterator BI = L.block_begin(),
 549                                    BE = L.block_end();
 550        BI != BE; ++BI) {
 551     BlockChain &Chain = *BlockToChain[*BI];
 552     if (!UpdatedPreds.insert(&Chain) || BI == L.block_begin())
 553       continue;
 554
 555     assert(Chain.LoopPredecessors == 0);
 556     for (BlockChain::iterator BCI = Chain.begin(), BCE = Chain.end();
 557          BCI != BCE; ++BCI) {
 558       assert(BlockToChain[*BCI] == &Chain);
 559       for (MachineBasicBlock::pred_iterator PI = (*BCI)->pred_begin(),
 560                                             PE = (*BCI)->pred_end();
 561            PI != PE; ++PI) {
 562         if (BlockToChain[*PI] == &Chain || !LoopBlockSet.count(*PI))
 563           continue;
 564         ++Chain.LoopPredecessors;
 565       }
 566     }
 567
 568     if (Chain.LoopPredecessors == 0)
 569       BlockWorkList.push_back(*BI);
 570   }
 571
 572   buildChain(*L.block_begin(), LoopChain, BlockWorkList, &LoopBlockSet);
 573
 574   DEBUG({
 575     // Crash at the end so we get all of the debugging output first.
 576     bool BadLoop = false;
 577     if (LoopChain.LoopPredecessors) {
 578       BadLoop = true;
 579       dbgs() << "Loop chain contains a block without its preds placed!\n"
 580              << "  Loop header:  " << getBlockName(*L.block_begin()) << "\n"
 581              << "  Chain header: " << getBlockName(*LoopChain.begin()) << "\n";
 582     }
 583     for (BlockChain::iterator BCI = LoopChain.begin(), BCE = LoopChain.end();
 584          BCI != BCE; ++BCI)
 585       if (!LoopBlockSet.erase(*BCI)) {
 586         // We don't mark the loop as bad here because there are real situations
 587         // where this can occur. For example, with an unanalyzable fallthrough
 588         // from a loop block to a non-loop block.
 589         // FIXME: Such constructs shouldn't exist. Track them down and fix them.
 590         dbgs() << "Loop chain contains a block not contained by the loop!\n"
 591                << "  Loop header:  " << getBlockName(*L.block_begin()) << "\n"
 592                << "  Chain header: " << getBlockName(*LoopChain.begin()) << "\n"
 593                << "  Bad block:    " << getBlockName(*BCI) << "\n";
 594       }
 595
 596     if (!LoopBlockSet.empty()) {
 597       BadLoop = true;
 598       for (BlockFilterSet::iterator LBI = LoopBlockSet.begin(),
 599                                     LBE = LoopBlockSet.end();
 600            LBI != LBE; ++LBI)
 601         dbgs() << "Loop contains blocks never placed into a chain!\n"
 602                << "  Loop header:  " << getBlockName(*L.block_begin()) << "\n"
 603                << "  Chain header: " << getBlockName(*LoopChain.begin()) << "\n"
 604                << "  Bad block:    " << getBlockName(*LBI) << "\n";
 605     }
 606     assert(!BadLoop && "Detected problems with the placement of this loop.");
 607   });
 608 }
 609
 610 void MachineBlockPlacement::buildCFGChains(MachineFunction &F) {
 611   // Ensure that every BB in the function has an associated chain to simplify
 612   // the assumptions of the remaining algorithm.
 613   SmallVector<MachineOperand, 4> Cond; // For AnalyzeBranch.
 614   for (MachineFunction::iterator FI = F.begin(), FE = F.end(); FI != FE; ++FI) {
 615     MachineBasicBlock *BB = FI;
 616     BlockChain *&Chain = BlockToChain[BB];
 617     Chain = new (ChainAllocator.Allocate()) BlockChain(BlockToChain, BB);
 618     // Also, merge any blocks which we cannot reason about and must preserve
 619     // the exact fallthrough behavior for.
 620     for (;;) {
 621       Cond.clear();
 622       MachineBasicBlock *TBB = 0, *FBB = 0; // For AnalyzeBranch.
 623       if (!TII->AnalyzeBranch(*BB, TBB, FBB, Cond) || !FI->canFallThrough())
 624         break;
 625
 626       MachineFunction::iterator NextFI(llvm::next(FI));
 627       MachineBasicBlock *NextBB = NextFI;
 628       // Ensure that the layout successor is a viable block, as we know that
 629       // fallthrough is a possibility.
 630       assert(NextFI != FE && "Can't fallthrough past the last block.");
 631       DEBUG(dbgs() << "Pre-merging due to unanalyzable fallthrough: "
 632                    << getBlockName(BB) << " -> " << getBlockName(NextBB)
 633                    << "\n");
 634       Chain->merge(NextBB, 0);
 635       FI = NextFI;
 636       BB = NextBB;
 637     }
 638   }
 639
 640   // Build any loop-based chains.
 641   for (MachineLoopInfo::iterator LI = MLI->begin(), LE = MLI->end(); LI != LE;
 642        ++LI)
 643     buildLoopChains(F, **LI);
 644
 645   SmallVector<MachineBasicBlock *, 16> BlockWorkList;
 646
 647   SmallPtrSet<BlockChain *, 4> UpdatedPreds;
 648   for (MachineFunction::iterator FI = F.begin(), FE = F.end(); FI != FE; ++FI) {
 649     MachineBasicBlock *BB = &*FI;
 650     BlockChain &Chain = *BlockToChain[BB];
 651     if (!UpdatedPreds.insert(&Chain))
 652       continue;
 653
 654     assert(Chain.LoopPredecessors == 0);
 655     for (BlockChain::iterator BCI = Chain.begin(), BCE = Chain.end();
 656          BCI != BCE; ++BCI) {
 657       assert(BlockToChain[*BCI] == &Chain);
 658       for (MachineBasicBlock::pred_iterator PI = (*BCI)->pred_begin(),
 659                                             PE = (*BCI)->pred_end();
 660            PI != PE; ++PI) {
 661         if (BlockToChain[*PI] == &Chain)
 662           continue;
 663         ++Chain.LoopPredecessors;
 664       }
 665     }
 666
 667     if (Chain.LoopPredecessors == 0)
 668       BlockWorkList.push_back(BB);
 669   }
 670
 671   BlockChain &FunctionChain = *BlockToChain[&F.front()];
 672   buildChain(&F.front(), FunctionChain, BlockWorkList);
 673
 674   typedef SmallPtrSet<MachineBasicBlock *, 16> FunctionBlockSetType;
 675   DEBUG({
 676     // Crash at the end so we get all of the debugging output first.
 677     bool BadFunc = false;
 678     FunctionBlockSetType FunctionBlockSet;
 679     for (MachineFunction::iterator FI = F.begin(), FE = F.end(); FI != FE; ++FI)
 680       FunctionBlockSet.insert(FI);
 681
 682     for (BlockChain::iterator BCI = FunctionChain.begin(),
 683                               BCE = FunctionChain.end();
 684          BCI != BCE; ++BCI)
 685       if (!FunctionBlockSet.erase(*BCI)) {
 686         BadFunc = true;
 687         dbgs() << "Function chain contains a block not in the function!\n"
 688                << "  Bad block:    " << getBlockName(*BCI) << "\n";
 689       }
 690
 691     if (!FunctionBlockSet.empty()) {
 692       BadFunc = true;
 693       for (FunctionBlockSetType::iterator FBI = FunctionBlockSet.begin(),
 694                                           FBE = FunctionBlockSet.end();
 695            FBI != FBE; ++FBI)
 696         dbgs() << "Function contains blocks never placed into a chain!\n"
 697                << "  Bad block:    " << getBlockName(*FBI) << "\n";
 698     }
 699     assert(!BadFunc && "Detected problems with the block placement.");
 700   });
 701
 702   // Splice the blocks into place.
 703   MachineFunction::iterator InsertPos = F.begin();
 704   for (BlockChain::iterator BI = FunctionChain.begin(),
 705                             BE = FunctionChain.end();
 706        BI != BE; ++BI) {
 707     DEBUG(dbgs() << (BI == FunctionChain.begin() ? "Placing chain "
 708                                                   : "          ... ")
 709           << getBlockName(*BI) << "\n");
 710     if (InsertPos != MachineFunction::iterator(*BI))
 711       F.splice(InsertPos, *BI);
 712     else
 713       ++InsertPos;
 714
 715     // Update the terminator of the previous block.
 716     if (BI == FunctionChain.begin())
 717       continue;
 718     MachineBasicBlock *PrevBB = llvm::prior(MachineFunction::iterator(*BI));
 719
 720     // FIXME: It would be awesome of updateTerminator would just return rather
 721     // than assert when the branch cannot be analyzed in order to remove this
 722     // boiler plate.
 723     Cond.clear();
 724     MachineBasicBlock *TBB = 0, *FBB = 0; // For AnalyzeBranch.
 725     if (!TII->AnalyzeBranch(*PrevBB, TBB, FBB, Cond))
 726       PrevBB->updateTerminator();
 727   }
 728
 729   // Fixup the last block.
 730   Cond.clear();
 731   MachineBasicBlock *TBB = 0, *FBB = 0; // For AnalyzeBranch.
 732   if (!TII->AnalyzeBranch(F.back(), TBB, FBB, Cond))
 733     F.back().updateTerminator();
 734 }
 735
 736 /// \brief Recursive helper to align a loop and any nested loops.
 737 static void AlignLoop(MachineFunction &F, MachineLoop *L, unsigned Align) {
 738   // Recurse through nested loops.
 739   for (MachineLoop::iterator I = L->begin(), E = L->end(); I != E; ++I)
 740     AlignLoop(F, *I, Align);
 741
 742   L->getTopBlock()->setAlignment(Align);
 743 }
 744
 745 /// \brief Align loop headers to target preferred alignments.
 746 void MachineBlockPlacement::AlignLoops(MachineFunction &F) {
 747   if (F.getFunction()->hasFnAttr(Attribute::OptimizeForSize))
 748     return;
 749
 750   unsigned Align = TLI->getPrefLoopAlignment();
 751   if (!Align)
 752     return;  // Don't care about loop alignment.
 753
 754   for (MachineLoopInfo::iterator I = MLI->begin(), E = MLI->end(); I != E; ++I)
 755     AlignLoop(F, *I, Align);
 756 }
 757
 758 bool MachineBlockPlacement::runOnMachineFunction(MachineFunction &F) {
 759   // Check for single-block functions and skip them.
 760   if (llvm::next(F.begin()) == F.end())
 761     return false;
 762
 763   MBPI = &getAnalysis<MachineBranchProbabilityInfo>();
 764   MBFI = &getAnalysis<MachineBlockFrequencyInfo>();
 765   MLI = &getAnalysis<MachineLoopInfo>();
 766   TII = F.getTarget().getInstrInfo();
 767   TLI = F.getTarget().getTargetLowering();
 768   assert(BlockToChain.empty());
 769
 770   buildCFGChains(F);
 771   AlignLoops(F);
 772
 773   BlockToChain.clear();
 774   ChainAllocator.DestroyAll();
 775
 776   // We always return true as we have no way to track whether the final order
 777   // differs from the original order.
 778   return true;
 779 }
 780
 781 namespace {
 782 /// \brief A pass to compute block placement statistics.
 783 ///
 784 /// A separate pass to compute interesting statistics for evaluating block
 785 /// placement. This is separate from the actual placement pass so that they can
 786 /// be computed in the absense of any placement transformations or when using
 787 /// alternative placement strategies.
 788 class MachineBlockPlacementStats : public MachineFunctionPass {
 789   /// \brief A handle to the branch probability pass.
 790   const MachineBranchProbabilityInfo *MBPI;
 791
 792   /// \brief A handle to the function-wide block frequency pass.
 793   const MachineBlockFrequencyInfo *MBFI;
 794
 795 public:
 796   static char ID; // Pass identification, replacement for typeid
 797   MachineBlockPlacementStats() : MachineFunctionPass(ID) {
 798     initializeMachineBlockPlacementStatsPass(*PassRegistry::getPassRegistry());
 799   }
 800
 801   bool runOnMachineFunction(MachineFunction &F);
 802
 803   void getAnalysisUsage(AnalysisUsage &AU) const {
 804     AU.addRequired<MachineBranchProbabilityInfo>();
 805     AU.addRequired<MachineBlockFrequencyInfo>();
 806     AU.setPreservesAll();
 807     MachineFunctionPass::getAnalysisUsage(AU);
 808   }
 809
 810   const char *getPassName() const { return "Block Placement Stats"; }
 811 };
 812 }
 813
 814 char MachineBlockPlacementStats::ID = 0;
 815 INITIALIZE_PASS_BEGIN(MachineBlockPlacementStats, "block-placement-stats",
 816                       "Basic Block Placement Stats", false, false)
 817 INITIALIZE_PASS_DEPENDENCY(MachineBranchProbabilityInfo)
 818 INITIALIZE_PASS_DEPENDENCY(MachineBlockFrequencyInfo)
 819 INITIALIZE_PASS_END(MachineBlockPlacementStats, "block-placement-stats",
 820                     "Basic Block Placement Stats", false, false)
 821
 822 FunctionPass *llvm::createMachineBlockPlacementStatsPass() {
 823   return new MachineBlockPlacementStats();
 824 }
 825
 826 bool MachineBlockPlacementStats::runOnMachineFunction(MachineFunction &F) {
 827   // Check for single-block functions and skip them.
 828   if (llvm::next(F.begin()) == F.end())
 829     return false;
 830
 831   MBPI = &getAnalysis<MachineBranchProbabilityInfo>();
 832   MBFI = &getAnalysis<MachineBlockFrequencyInfo>();
 833
 834   for (MachineFunction::iterator I = F.begin(), E = F.end(); I != E; ++I) {
 835     BlockFrequency BlockFreq = MBFI->getBlockFreq(I);
 836     Statistic &NumBranches = (I->succ_size() > 1) ? NumCondBranches
 837                                                   : NumUncondBranches;
 838     Statistic &BranchTakenFreq = (I->succ_size() > 1) ? CondBranchTakenFreq
 839                                                       : UncondBranchTakenFreq;
 840     for (MachineBasicBlock::succ_iterator SI = I->succ_begin(),
 841                                           SE = I->succ_end();
 842          SI != SE; ++SI) {
 843       // Skip if this successor is a fallthrough.
 844       if (I->isLayoutSuccessor(*SI))
 845         continue;
 846
 847       BlockFrequency EdgeFreq = BlockFreq * MBPI->getEdgeProbability(I, *SI);
 848       ++NumBranches;
 849       BranchTakenFreq += EdgeFreq.getFrequency();
 850     }
 851   }
 852
 853   return false;
 854 }
 855