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