1 //===- BlockFrequencyInfo.h - Block Frequency Analysis ----------*- C++ -*-===//
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 // Loops should be simplified before this analysis.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_ANALYSIS_BLOCKFREQUENCYINFO_H
15 #define LLVM_ANALYSIS_BLOCKFREQUENCYINFO_H
17 #include "llvm/Pass.h"
18 #include "llvm/Support/BlockFrequency.h"
23 class BranchProbabilityInfo;
24 template <class BlockT, class FunctionT, class BranchProbInfoT>
25 class BlockFrequencyInfoImpl;
27 /// BlockFrequencyInfo pass uses BlockFrequencyInfoImpl implementation to
28 /// estimate IR basic block frequencies.
29 class BlockFrequencyInfo : public FunctionPass {
30 typedef BlockFrequencyInfoImpl<BasicBlock, Function, BranchProbabilityInfo>
32 std::unique_ptr<ImplType> BFI;
39 ~BlockFrequencyInfo();
41 void getAnalysisUsage(AnalysisUsage &AU) const override;
43 bool runOnFunction(Function &F) override;
44 void releaseMemory() override;
45 void print(raw_ostream &O, const Module *M) const override;
46 const Function *getFunction() const;
49 /// getblockFreq - Return block frequency. Return 0 if we don't have the
50 /// information. Please note that initial frequency is equal to ENTRY_FREQ. It
51 /// means that we should not rely on the value itself, but only on the
52 /// comparison to the other block frequencies. We do this to avoid using of
54 BlockFrequency getBlockFreq(const BasicBlock *BB) const;
56 // Print the block frequency Freq to OS using the current functions entry
57 // frequency to convert freq into a relative decimal form.
58 raw_ostream &printBlockFreq(raw_ostream &OS, const BlockFrequency Freq) const;
60 // Convenience method that attempts to look up the frequency associated with
61 // BB and print it to OS.
62 raw_ostream &printBlockFreq(raw_ostream &OS, const BasicBlock *BB) const;
64 uint64_t getEntryFreq() const;