123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267 |
- //===- BlockFrequencyInfo.cpp - Block Frequency Analysis ------------------===//
- //
- // The LLVM Compiler Infrastructure
- //
- // This file is distributed under the University of Illinois Open Source
- // License. See LICENSE.TXT for details.
- //
- //===----------------------------------------------------------------------===//
- //
- // Loops should be simplified before this analysis.
- //
- //===----------------------------------------------------------------------===//
- #include "llvm/Analysis/BlockFrequencyInfo.h"
- #include "llvm/Analysis/BlockFrequencyInfoImpl.h"
- #include "llvm/Analysis/BranchProbabilityInfo.h"
- #include "llvm/Analysis/LoopInfo.h"
- #include "llvm/Analysis/Passes.h"
- #include "llvm/IR/CFG.h"
- #include "llvm/InitializePasses.h"
- #include "llvm/Support/CommandLine.h"
- #include "llvm/Support/Debug.h"
- #include "llvm/Support/GraphWriter.h"
- using namespace llvm;
- #define DEBUG_TYPE "block-freq"
- #ifndef NDEBUG
- static cl::opt<GVDAGType> ViewBlockFreqPropagationDAG(
- "view-block-freq-propagation-dags", cl::Hidden,
- cl::desc("Pop up a window to show a dag displaying how block "
- "frequencies propagation through the CFG."),
- cl::values(clEnumValN(GVDT_None, "none", "do not display graphs."),
- clEnumValN(GVDT_Fraction, "fraction",
- "display a graph using the "
- "fractional block frequency representation."),
- clEnumValN(GVDT_Integer, "integer",
- "display a graph using the raw "
- "integer fractional block frequency representation."),
- clEnumValN(GVDT_Count, "count", "display a graph using the real "
- "profile count if available."),
- clEnumValEnd));
- cl::opt<std::string>
- ViewBlockFreqFuncName("view-bfi-func-name", cl::Hidden,
- cl::desc("The option to specify "
- "the name of the function "
- "whose CFG will be displayed."));
- cl::opt<unsigned>
- ViewHotFreqPercent("view-hot-freq-percent", cl::init(10), cl::Hidden,
- cl::desc("An integer in percent used to specify "
- "the hot blocks/edges to be displayed "
- "in red: a block or edge whose frequency "
- "is no less than the max frequency of the "
- "function multiplied by this percent."));
- namespace llvm {
- template <>
- struct GraphTraits<BlockFrequencyInfo *> {
- typedef const BasicBlock NodeType;
- typedef succ_const_iterator ChildIteratorType;
- typedef Function::const_iterator nodes_iterator;
- static inline const NodeType *getEntryNode(const BlockFrequencyInfo *G) {
- return &G->getFunction()->front();
- }
- static ChildIteratorType child_begin(const NodeType *N) {
- return succ_begin(N);
- }
- static ChildIteratorType child_end(const NodeType *N) {
- return succ_end(N);
- }
- static nodes_iterator nodes_begin(const BlockFrequencyInfo *G) {
- return G->getFunction()->begin();
- }
- static nodes_iterator nodes_end(const BlockFrequencyInfo *G) {
- return G->getFunction()->end();
- }
- };
- typedef BFIDOTGraphTraitsBase<BlockFrequencyInfo, BranchProbabilityInfo>
- BFIDOTGTraitsBase;
- template <>
- struct DOTGraphTraits<BlockFrequencyInfo *> : public BFIDOTGTraitsBase {
- explicit DOTGraphTraits(bool isSimple = false)
- : BFIDOTGTraitsBase(isSimple) {}
- std::string getNodeLabel(const BasicBlock *Node,
- const BlockFrequencyInfo *Graph) {
- return BFIDOTGTraitsBase::getNodeLabel(Node, Graph,
- ViewBlockFreqPropagationDAG);
- }
- std::string getNodeAttributes(const BasicBlock *Node,
- const BlockFrequencyInfo *Graph) {
- return BFIDOTGTraitsBase::getNodeAttributes(Node, Graph,
- ViewHotFreqPercent);
- }
- std::string getEdgeAttributes(const BasicBlock *Node, EdgeIter EI,
- const BlockFrequencyInfo *BFI) {
- return BFIDOTGTraitsBase::getEdgeAttributes(Node, EI, BFI, BFI->getBPI(),
- ViewHotFreqPercent);
- }
- };
- } // end namespace llvm
- #endif
- BlockFrequencyInfo::BlockFrequencyInfo() {}
- BlockFrequencyInfo::BlockFrequencyInfo(const Function &F,
- const BranchProbabilityInfo &BPI,
- const LoopInfo &LI) {
- calculate(F, BPI, LI);
- }
- BlockFrequencyInfo::BlockFrequencyInfo(BlockFrequencyInfo &&Arg)
- : BFI(std::move(Arg.BFI)) {}
- BlockFrequencyInfo &BlockFrequencyInfo::operator=(BlockFrequencyInfo &&RHS) {
- releaseMemory();
- BFI = std::move(RHS.BFI);
- return *this;
- }
- // Explicitly define the default constructor otherwise it would be implicitly
- // defined at the first ODR-use which is the BFI member in the
- // LazyBlockFrequencyInfo header. The dtor needs the BlockFrequencyInfoImpl
- // template instantiated which is not available in the header.
- BlockFrequencyInfo::~BlockFrequencyInfo() {}
- void BlockFrequencyInfo::calculate(const Function &F,
- const BranchProbabilityInfo &BPI,
- const LoopInfo &LI) {
- if (!BFI)
- BFI.reset(new ImplType);
- BFI->calculate(F, BPI, LI);
- #ifndef NDEBUG
- if (ViewBlockFreqPropagationDAG != GVDT_None &&
- (ViewBlockFreqFuncName.empty() ||
- F.getName().equals(ViewBlockFreqFuncName))) {
- view();
- }
- #endif
- }
- BlockFrequency BlockFrequencyInfo::getBlockFreq(const BasicBlock *BB) const {
- return BFI ? BFI->getBlockFreq(BB) : 0;
- }
- Optional<uint64_t>
- BlockFrequencyInfo::getBlockProfileCount(const BasicBlock *BB) const {
- if (!BFI)
- return None;
- return BFI->getBlockProfileCount(*getFunction(), BB);
- }
- void BlockFrequencyInfo::setBlockFreq(const BasicBlock *BB, uint64_t Freq) {
- assert(BFI && "Expected analysis to be available");
- BFI->setBlockFreq(BB, Freq);
- }
- /// Pop up a ghostview window with the current block frequency propagation
- /// rendered using dot.
- void BlockFrequencyInfo::view() const {
- // This code is only for debugging.
- #ifndef NDEBUG
- ViewGraph(const_cast<BlockFrequencyInfo *>(this), "BlockFrequencyDAGs");
- #else
- errs() << "BlockFrequencyInfo::view is only available in debug builds on "
- "systems with Graphviz or gv!\n";
- #endif // NDEBUG
- }
- const Function *BlockFrequencyInfo::getFunction() const {
- return BFI ? BFI->getFunction() : nullptr;
- }
- const BranchProbabilityInfo *BlockFrequencyInfo::getBPI() const {
- return BFI ? &BFI->getBPI() : nullptr;
- }
- raw_ostream &BlockFrequencyInfo::
- printBlockFreq(raw_ostream &OS, const BlockFrequency Freq) const {
- return BFI ? BFI->printBlockFreq(OS, Freq) : OS;
- }
- raw_ostream &
- BlockFrequencyInfo::printBlockFreq(raw_ostream &OS,
- const BasicBlock *BB) const {
- return BFI ? BFI->printBlockFreq(OS, BB) : OS;
- }
- uint64_t BlockFrequencyInfo::getEntryFreq() const {
- return BFI ? BFI->getEntryFreq() : 0;
- }
- void BlockFrequencyInfo::releaseMemory() { BFI.reset(); }
- void BlockFrequencyInfo::print(raw_ostream &OS) const {
- if (BFI)
- BFI->print(OS);
- }
- INITIALIZE_PASS_BEGIN(BlockFrequencyInfoWrapperPass, "block-freq",
- "Block Frequency Analysis", true, true)
- INITIALIZE_PASS_DEPENDENCY(BranchProbabilityInfoWrapperPass)
- INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass)
- INITIALIZE_PASS_END(BlockFrequencyInfoWrapperPass, "block-freq",
- "Block Frequency Analysis", true, true)
- char BlockFrequencyInfoWrapperPass::ID = 0;
- BlockFrequencyInfoWrapperPass::BlockFrequencyInfoWrapperPass()
- : FunctionPass(ID) {
- initializeBlockFrequencyInfoWrapperPassPass(*PassRegistry::getPassRegistry());
- }
- BlockFrequencyInfoWrapperPass::~BlockFrequencyInfoWrapperPass() {}
- void BlockFrequencyInfoWrapperPass::print(raw_ostream &OS,
- const Module *) const {
- BFI.print(OS);
- }
- void BlockFrequencyInfoWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
- AU.addRequired<BranchProbabilityInfoWrapperPass>();
- AU.addRequired<LoopInfoWrapperPass>();
- AU.setPreservesAll();
- }
- void BlockFrequencyInfoWrapperPass::releaseMemory() { BFI.releaseMemory(); }
- bool BlockFrequencyInfoWrapperPass::runOnFunction(Function &F) {
- BranchProbabilityInfo &BPI =
- getAnalysis<BranchProbabilityInfoWrapperPass>().getBPI();
- LoopInfo &LI = getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
- BFI.calculate(F, BPI, LI);
- return false;
- }
- char BlockFrequencyAnalysis::PassID;
- BlockFrequencyInfo BlockFrequencyAnalysis::run(Function &F,
- AnalysisManager<Function> &AM) {
- BlockFrequencyInfo BFI;
- BFI.calculate(F, AM.getResult<BranchProbabilityAnalysis>(F),
- AM.getResult<LoopAnalysis>(F));
- return BFI;
- }
- PreservedAnalyses
- BlockFrequencyPrinterPass::run(Function &F, AnalysisManager<Function> &AM) {
- OS << "Printing analysis results of BFI for function "
- << "'" << F.getName() << "':"
- << "\n";
- AM.getResult<BlockFrequencyAnalysis>(F).print(OS);
- return PreservedAnalyses::all();
- }
|