include/llvm/CodeGen/MachineBranchProbabilityInfo.h

   1
   2 //==- MachineBranchProbabilityInfo.h - Machine Branch Probability Analysis -==//
   3 //
   4 //                     The LLVM Compiler Infrastructure
   5 //
   6 // This file is distributed under the University of Illinois Open Source
   7 // License. See LICENSE.TXT for details.
   8 //
   9 //===----------------------------------------------------------------------===//
  10 //
  11 // This pass is used to evaluate branch probabilties on machine basic blocks.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_CODEGEN_MACHINEBRANCHPROBABILITYINFO_H
  16 #define LLVM_CODEGEN_MACHINEBRANCHPROBABILITYINFO_H
  17
  18 #include "llvm/Pass.h"
  19 #include "llvm/Support/BranchProbability.h"
  20 #include <climits>
  21
  22 namespace llvm {
  23
  24 class raw_ostream;
  25 class MachineBasicBlock;
  26
  27 class MachineBranchProbabilityInfo : public ImmutablePass {
  28   virtual void anchor();
  29
  30   // Default weight value. Used when we don't have information about the edge.
  31   // TODO: DEFAULT_WEIGHT makes sense during static predication, when none of
  32   // the successors have a weight yet. But it doesn't make sense when providing
  33   // weight to an edge that may have siblings with non-zero weights. This can
  34   // be handled various ways, but it's probably fine for an edge with unknown
  35   // weight to just "inherit" the non-zero weight of an adjacent successor.
  36   static const uint32_t DEFAULT_WEIGHT = 16;
  37
  38 public:
  39   static char ID;
  40
  41   MachineBranchProbabilityInfo() : ImmutablePass(ID) {
  42     PassRegistry &Registry = *PassRegistry::getPassRegistry();
  43     initializeMachineBranchProbabilityInfoPass(Registry);
  44   }
  45
  46   void getAnalysisUsage(AnalysisUsage &AU) const {
  47     AU.setPreservesAll();
  48   }
  49
  50   // Return edge weight. If we don't have any informations about it - return
  51   // DEFAULT_WEIGHT.
  52   uint32_t getEdgeWeight(const MachineBasicBlock *Src,
  53                          const MachineBasicBlock *Dst) const;
  54
  55   // Get sum of the block successors' weights, potentially scaling them to fit
  56   // within 32-bits. If scaling is required, sets Scale based on the necessary
  57   // adjustment. Any edge weights used with the sum should be divided by Scale.
  58   uint32_t getSumForBlock(const MachineBasicBlock *MBB, uint32_t &Scale) const;
  59
  60   // A 'Hot' edge is an edge which probability is >= 80%.
  61   bool isEdgeHot(MachineBasicBlock *Src, MachineBasicBlock *Dst) const;
  62
  63   // Return a hot successor for the block BB or null if there isn't one.
  64   // NB: This routine's complexity is linear on the number of successors.
  65   MachineBasicBlock *getHotSucc(MachineBasicBlock *MBB) const;
  66
  67   // Return a probability as a fraction between 0 (0% probability) and
  68   // 1 (100% probability), however the value is never equal to 0, and can be 1
  69   // only iff SRC block has only one successor.
  70   // NB: This routine's complexity is linear on the number of successors of
  71   // Src. Querying sequentially for each successor's probability is a quadratic
  72   // query pattern.
  73   BranchProbability getEdgeProbability(MachineBasicBlock *Src,
  74                                        MachineBasicBlock *Dst) const;
  75
  76   // Print value between 0 (0% probability) and 1 (100% probability),
  77   // however the value is never equal to 0, and can be 1 only iff SRC block
  78   // has only one successor.
  79   raw_ostream &printEdgeProbability(raw_ostream &OS, MachineBasicBlock *Src,
  80                                     MachineBasicBlock *Dst) const;
  81 };
  82
  83 }
  84
  85
  86 #endif