include/llvm/Analysis/BranchProbabilityInfo.h

   1 //===--- BranchProbabilityInfo.h - Branch Probability Analysis --*- 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 pass is used to evaluate branch probabilties.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_ANALYSIS_BRANCHPROBABILITYINFO_H
  15 #define LLVM_ANALYSIS_BRANCHPROBABILITYINFO_H
  16
  17 #include "llvm/InitializePasses.h"
  18 #include "llvm/Pass.h"
  19 #include "llvm/ADT/DenseMap.h"
  20 #include "llvm/Support/BranchProbability.h"
  21
  22 namespace llvm {
  23 class LoopInfo;
  24 class raw_ostream;
  25
  26 /// \brief Analysis pass providing branch probability information.
  27 ///
  28 /// This is a function analysis pass which provides information on the relative
  29 /// probabilities of each "edge" in the function's CFG where such an edge is
  30 /// defined by a pair of basic blocks. The probability for a given block and
  31 /// a successor block are always relative to the probabilities of the other
  32 /// successor blocks. Another way of looking at it is that the probabilities
  33 /// for a given block B and each of its successors should sum to exactly
  34 /// one (100%).
  35 class BranchProbabilityInfo : public FunctionPass {
  36 public:
  37   static char ID;
  38
  39   BranchProbabilityInfo() : FunctionPass(ID) {
  40     initializeBranchProbabilityInfoPass(*PassRegistry::getPassRegistry());
  41   }
  42
  43   void getAnalysisUsage(AnalysisUsage &AU) const;
  44   bool runOnFunction(Function &F);
  45   void print(raw_ostream &OS, const Module *M = 0) const;
  46
  47   /// \brief Get an edge's probability, relative to other out-edges of the Src.
  48   ///
  49   /// This routine provides access to the fractional probability between zero
  50   /// (0%) and one (100%) of this edge executing, relative to other edges
  51   /// leaving the 'Src' block. The returned probability is never zero, and can
  52   /// only be one if the source block has only one successor.
  53   BranchProbability getEdgeProbability(const BasicBlock *Src,
  54                                        const BasicBlock *Dst) const;
  55
  56   /// \brief Test if an edge is hot relative to other out-edges of the Src.
  57   ///
  58   /// Check whether this edge out of the source block is 'hot'. We define hot
  59   /// as having a relative probability >= 80%.
  60   bool isEdgeHot(const BasicBlock *Src, const BasicBlock *Dst) const;
  61
  62   /// \brief Retrieve the hot successor of a block if one exists.
  63   ///
  64   /// Given a basic block, look through its successors and if one exists for
  65   /// which \see isEdgeHot would return true, return that successor block.
  66   BasicBlock *getHotSucc(BasicBlock *BB) const;
  67
  68   /// \brief Print an edge's probability.
  69   ///
  70   /// Retrieves an edge's probability similarly to \see getEdgeProbability, but
  71   /// then prints that probability to the provided stream. That stream is then
  72   /// returned.
  73   raw_ostream &printEdgeProbability(raw_ostream &OS, const BasicBlock *Src,
  74                                     const BasicBlock *Dst) const;
  75
  76   /// \brief Get the raw edge weight calculated for the block pair.
  77   ///
  78   /// This returns the raw edge weight. It is guaranteed to fall between 1 and
  79   /// UINT32_MAX. Note that the raw edge weight is not meaningful in isolation.
  80   /// This interface should be very carefully, and primarily by routines that
  81   /// are updating the analysis by later calling setEdgeWeight.
  82   uint32_t getEdgeWeight(const BasicBlock *Src, const BasicBlock *Dst) const;
  83
  84   /// \brief Set the raw edge weight for the block pair.
  85   ///
  86   /// This allows a pass to explicitly set the edge weight for a block. It can
  87   /// be used when updating the CFG to update and preserve the branch
  88   /// probability information. Read the implementation of how these edge
  89   /// weights are calculated carefully before using!
  90   void setEdgeWeight(const BasicBlock *Src, const BasicBlock *Dst,
  91                      uint32_t Weight);
  92
  93 private:
  94   typedef std::pair<const BasicBlock *, const BasicBlock *> Edge;
  95
  96   // Default weight value. Used when we don't have information about the edge.
  97   // TODO: DEFAULT_WEIGHT makes sense during static predication, when none of
  98   // the successors have a weight yet. But it doesn't make sense when providing
  99   // weight to an edge that may have siblings with non-zero weights. This can
 100   // be handled various ways, but it's probably fine for an edge with unknown
 101   // weight to just "inherit" the non-zero weight of an adjacent successor.
 102   static const uint32_t DEFAULT_WEIGHT = 16;
 103
 104   DenseMap<Edge, uint32_t> Weights;
 105
 106   /// \brief Handle to the LoopInfo analysis.
 107   LoopInfo *LI;
 108
 109   /// \brief Track the last function we run over for printing.
 110   Function *LastF;
 111
 112   /// \brief Get sum of the block successors' weights.
 113   uint32_t getSumForBlock(const BasicBlock *BB) const;
 114
 115   bool calcMetadataWeights(BasicBlock *BB);
 116   bool calcReturnHeuristics(BasicBlock *BB);
 117   bool calcPointerHeuristics(BasicBlock *BB);
 118   bool calcLoopBranchHeuristics(BasicBlock *BB);
 119   bool calcZeroHeuristics(BasicBlock *BB);
 120   bool calcFloatingPointHeuristics(BasicBlock *BB);
 121 };
 122
 123 }
 124
 125 #endif