Duncan P. N. Exon Smith | 689a507 | 2014-04-11 23:20:58 +0000 | [diff] [blame] | 1 | //===- BlockFrequencyInfo.cpp - Block Frequency Analysis ------------------===// |
Jakub Staszak | 668c6fa | 2011-06-23 21:56:59 +0000 | [diff] [blame] | 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 | // Loops should be simplified before this analysis. |
| 11 | // |
| 12 | //===----------------------------------------------------------------------===// |
| 13 | |
Jakub Staszak | 875ebd5 | 2011-07-25 19:25:40 +0000 | [diff] [blame] | 14 | #include "llvm/Analysis/BlockFrequencyInfo.h" |
Duncan P. N. Exon Smith | 689a507 | 2014-04-11 23:20:58 +0000 | [diff] [blame] | 15 | #include "llvm/Analysis/BlockFrequencyInfoImpl.h" |
Chandler Carruth | ed0881b | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 16 | #include "llvm/Analysis/BranchProbabilityInfo.h" |
Jakub Staszak | 668c6fa | 2011-06-23 21:56:59 +0000 | [diff] [blame] | 17 | #include "llvm/Analysis/LoopInfo.h" |
| 18 | #include "llvm/Analysis/Passes.h" |
Chandler Carruth | 1305dc3 | 2014-03-04 11:45:46 +0000 | [diff] [blame] | 19 | #include "llvm/IR/CFG.h" |
Chandler Carruth | ed0881b | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 20 | #include "llvm/InitializePasses.h" |
Michael Gottesman | fd8aee7 | 2013-11-14 02:27:46 +0000 | [diff] [blame] | 21 | #include "llvm/Support/CommandLine.h" |
| 22 | #include "llvm/Support/Debug.h" |
| 23 | #include "llvm/Support/GraphWriter.h" |
Jakub Staszak | 668c6fa | 2011-06-23 21:56:59 +0000 | [diff] [blame] | 24 | |
| 25 | using namespace llvm; |
| 26 | |
Chandler Carruth | f1221bd | 2014-04-22 02:48:03 +0000 | [diff] [blame] | 27 | #define DEBUG_TYPE "block-freq" |
| 28 | |
Michael Gottesman | fd8aee7 | 2013-11-14 02:27:46 +0000 | [diff] [blame] | 29 | #ifndef NDEBUG |
| 30 | enum GVDAGType { |
| 31 | GVDT_None, |
| 32 | GVDT_Fraction, |
| 33 | GVDT_Integer |
| 34 | }; |
| 35 | |
| 36 | static cl::opt<GVDAGType> |
| 37 | ViewBlockFreqPropagationDAG("view-block-freq-propagation-dags", cl::Hidden, |
| 38 | cl::desc("Pop up a window to show a dag displaying how block " |
| 39 | "frequencies propagation through the CFG."), |
| 40 | cl::values( |
| 41 | clEnumValN(GVDT_None, "none", |
| 42 | "do not display graphs."), |
| 43 | clEnumValN(GVDT_Fraction, "fraction", "display a graph using the " |
| 44 | "fractional block frequency representation."), |
| 45 | clEnumValN(GVDT_Integer, "integer", "display a graph using the raw " |
| 46 | "integer fractional block frequency representation."), |
| 47 | clEnumValEnd)); |
| 48 | |
| 49 | namespace llvm { |
| 50 | |
| 51 | template <> |
| 52 | struct GraphTraits<BlockFrequencyInfo *> { |
| 53 | typedef const BasicBlock NodeType; |
| 54 | typedef succ_const_iterator ChildIteratorType; |
| 55 | typedef Function::const_iterator nodes_iterator; |
| 56 | |
| 57 | static inline const NodeType *getEntryNode(const BlockFrequencyInfo *G) { |
Duncan P. N. Exon Smith | 5a82c91 | 2015-10-10 00:53:03 +0000 | [diff] [blame] | 58 | return &G->getFunction()->front(); |
Michael Gottesman | fd8aee7 | 2013-11-14 02:27:46 +0000 | [diff] [blame] | 59 | } |
| 60 | static ChildIteratorType child_begin(const NodeType *N) { |
| 61 | return succ_begin(N); |
| 62 | } |
| 63 | static ChildIteratorType child_end(const NodeType *N) { |
| 64 | return succ_end(N); |
| 65 | } |
| 66 | static nodes_iterator nodes_begin(const BlockFrequencyInfo *G) { |
| 67 | return G->getFunction()->begin(); |
| 68 | } |
| 69 | static nodes_iterator nodes_end(const BlockFrequencyInfo *G) { |
| 70 | return G->getFunction()->end(); |
| 71 | } |
| 72 | }; |
| 73 | |
| 74 | template<> |
| 75 | struct DOTGraphTraits<BlockFrequencyInfo*> : public DefaultDOTGraphTraits { |
| 76 | explicit DOTGraphTraits(bool isSimple=false) : |
| 77 | DefaultDOTGraphTraits(isSimple) {} |
| 78 | |
| 79 | static std::string getGraphName(const BlockFrequencyInfo *G) { |
| 80 | return G->getFunction()->getName(); |
| 81 | } |
| 82 | |
| 83 | std::string getNodeLabel(const BasicBlock *Node, |
| 84 | const BlockFrequencyInfo *Graph) { |
Alp Toker | e69170a | 2014-06-26 22:52:05 +0000 | [diff] [blame] | 85 | std::string Result; |
| 86 | raw_string_ostream OS(Result); |
Michael Gottesman | fd8aee7 | 2013-11-14 02:27:46 +0000 | [diff] [blame] | 87 | |
Yaron Keren | 75e0c4b | 2015-03-27 17:51:30 +0000 | [diff] [blame] | 88 | OS << Node->getName() << ":"; |
Michael Gottesman | fd8aee7 | 2013-11-14 02:27:46 +0000 | [diff] [blame] | 89 | switch (ViewBlockFreqPropagationDAG) { |
| 90 | case GVDT_Fraction: |
Michael Gottesman | b0c1ed8 | 2013-12-14 00:25:42 +0000 | [diff] [blame] | 91 | Graph->printBlockFreq(OS, Node); |
Michael Gottesman | fd8aee7 | 2013-11-14 02:27:46 +0000 | [diff] [blame] | 92 | break; |
| 93 | case GVDT_Integer: |
| 94 | OS << Graph->getBlockFreq(Node).getFrequency(); |
| 95 | break; |
| 96 | case GVDT_None: |
| 97 | llvm_unreachable("If we are not supposed to render a graph we should " |
| 98 | "never reach this point."); |
| 99 | } |
| 100 | |
Alp Toker | e69170a | 2014-06-26 22:52:05 +0000 | [diff] [blame] | 101 | return Result; |
Michael Gottesman | fd8aee7 | 2013-11-14 02:27:46 +0000 | [diff] [blame] | 102 | } |
| 103 | }; |
| 104 | |
| 105 | } // end namespace llvm |
| 106 | #endif |
| 107 | |
Cong Hou | 9b4f6b2 | 2015-07-16 23:23:35 +0000 | [diff] [blame] | 108 | BlockFrequencyInfo::BlockFrequencyInfo() {} |
| 109 | |
| 110 | BlockFrequencyInfo::BlockFrequencyInfo(const Function &F, |
| 111 | const BranchProbabilityInfo &BPI, |
| 112 | const LoopInfo &LI) { |
| 113 | calculate(F, BPI, LI); |
| 114 | } |
| 115 | |
Xinliang David Li | 28a9327 | 2016-05-05 21:13:27 +0000 | [diff] [blame] | 116 | BlockFrequencyInfo::BlockFrequencyInfo(BlockFrequencyInfo &&Arg) |
| 117 | : BFI(std::move(Arg.BFI)) {} |
| 118 | |
| 119 | BlockFrequencyInfo &BlockFrequencyInfo::operator=(BlockFrequencyInfo &&RHS) { |
| 120 | releaseMemory(); |
| 121 | BFI = std::move(RHS.BFI); |
| 122 | return *this; |
| 123 | } |
| 124 | |
Wei Mi | deee61e | 2015-07-14 23:40:50 +0000 | [diff] [blame] | 125 | void BlockFrequencyInfo::calculate(const Function &F, |
| 126 | const BranchProbabilityInfo &BPI, |
| 127 | const LoopInfo &LI) { |
Duncan P. N. Exon Smith | 3dbe105 | 2014-03-25 18:01:38 +0000 | [diff] [blame] | 128 | if (!BFI) |
| 129 | BFI.reset(new ImplType); |
Cong Hou | 5e67b66 | 2015-07-15 19:58:26 +0000 | [diff] [blame] | 130 | BFI->calculate(F, BPI, LI); |
Michael Gottesman | fd8aee7 | 2013-11-14 02:27:46 +0000 | [diff] [blame] | 131 | #ifndef NDEBUG |
| 132 | if (ViewBlockFreqPropagationDAG != GVDT_None) |
| 133 | view(); |
| 134 | #endif |
Chandler Carruth | 343fad4 | 2011-10-19 10:12:41 +0000 | [diff] [blame] | 135 | } |
| 136 | |
Jakub Staszak | 96f8c55 | 2011-12-20 20:03:10 +0000 | [diff] [blame] | 137 | BlockFrequency BlockFrequencyInfo::getBlockFreq(const BasicBlock *BB) const { |
Duncan P. N. Exon Smith | 3dbe105 | 2014-03-25 18:01:38 +0000 | [diff] [blame] | 138 | return BFI ? BFI->getBlockFreq(BB) : 0; |
Jakub Staszak | 668c6fa | 2011-06-23 21:56:59 +0000 | [diff] [blame] | 139 | } |
Michael Gottesman | fd8aee7 | 2013-11-14 02:27:46 +0000 | [diff] [blame] | 140 | |
Easwaran Raman | 12b79aa | 2016-03-23 18:18:26 +0000 | [diff] [blame] | 141 | Optional<uint64_t> |
| 142 | BlockFrequencyInfo::getBlockProfileCount(const BasicBlock *BB) const { |
Xinliang David Li | b12b353 | 2016-06-22 17:12:12 +0000 | [diff] [blame^] | 143 | if (!BFI) |
Easwaran Raman | 12b79aa | 2016-03-23 18:18:26 +0000 | [diff] [blame] | 144 | return None; |
Xinliang David Li | b12b353 | 2016-06-22 17:12:12 +0000 | [diff] [blame^] | 145 | |
| 146 | return BFI->getBlockProfileCount(*getFunction(), BB); |
Easwaran Raman | 12b79aa | 2016-03-23 18:18:26 +0000 | [diff] [blame] | 147 | } |
| 148 | |
Xinliang David Li | b12b353 | 2016-06-22 17:12:12 +0000 | [diff] [blame^] | 149 | void BlockFrequencyInfo::setBlockFreq(const BasicBlock *BB, uint64_t Freq) { |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 150 | assert(BFI && "Expected analysis to be available"); |
| 151 | BFI->setBlockFreq(BB, Freq); |
| 152 | } |
| 153 | |
Michael Gottesman | fd8aee7 | 2013-11-14 02:27:46 +0000 | [diff] [blame] | 154 | /// Pop up a ghostview window with the current block frequency propagation |
| 155 | /// rendered using dot. |
| 156 | void BlockFrequencyInfo::view() const { |
| 157 | // This code is only for debugging. |
| 158 | #ifndef NDEBUG |
| 159 | ViewGraph(const_cast<BlockFrequencyInfo *>(this), "BlockFrequencyDAGs"); |
| 160 | #else |
| 161 | errs() << "BlockFrequencyInfo::view is only available in debug builds on " |
| 162 | "systems with Graphviz or gv!\n"; |
| 163 | #endif // NDEBUG |
| 164 | } |
| 165 | |
| 166 | const Function *BlockFrequencyInfo::getFunction() const { |
Duncan P. N. Exon Smith | 10be9a8 | 2014-04-21 17:57:07 +0000 | [diff] [blame] | 167 | return BFI ? BFI->getFunction() : nullptr; |
Michael Gottesman | fd8aee7 | 2013-11-14 02:27:46 +0000 | [diff] [blame] | 168 | } |
Michael Gottesman | fd5c4b2 | 2013-12-14 00:06:03 +0000 | [diff] [blame] | 169 | |
| 170 | raw_ostream &BlockFrequencyInfo:: |
| 171 | printBlockFreq(raw_ostream &OS, const BlockFrequency Freq) const { |
Duncan P. N. Exon Smith | 3dbe105 | 2014-03-25 18:01:38 +0000 | [diff] [blame] | 172 | return BFI ? BFI->printBlockFreq(OS, Freq) : OS; |
Michael Gottesman | fd5c4b2 | 2013-12-14 00:06:03 +0000 | [diff] [blame] | 173 | } |
| 174 | |
| 175 | raw_ostream & |
| 176 | BlockFrequencyInfo::printBlockFreq(raw_ostream &OS, |
| 177 | const BasicBlock *BB) const { |
Duncan P. N. Exon Smith | 3dbe105 | 2014-03-25 18:01:38 +0000 | [diff] [blame] | 178 | return BFI ? BFI->printBlockFreq(OS, BB) : OS; |
Michael Gottesman | fd5c4b2 | 2013-12-14 00:06:03 +0000 | [diff] [blame] | 179 | } |
Yuchen Wu | 5947c8f | 2013-12-20 22:11:11 +0000 | [diff] [blame] | 180 | |
| 181 | uint64_t BlockFrequencyInfo::getEntryFreq() const { |
Duncan P. N. Exon Smith | 3dbe105 | 2014-03-25 18:01:38 +0000 | [diff] [blame] | 182 | return BFI ? BFI->getEntryFreq() : 0; |
Yuchen Wu | 5947c8f | 2013-12-20 22:11:11 +0000 | [diff] [blame] | 183 | } |
Wei Mi | deee61e | 2015-07-14 23:40:50 +0000 | [diff] [blame] | 184 | |
| 185 | void BlockFrequencyInfo::releaseMemory() { BFI.reset(); } |
| 186 | |
| 187 | void BlockFrequencyInfo::print(raw_ostream &OS) const { |
| 188 | if (BFI) |
| 189 | BFI->print(OS); |
| 190 | } |
| 191 | |
| 192 | |
| 193 | INITIALIZE_PASS_BEGIN(BlockFrequencyInfoWrapperPass, "block-freq", |
| 194 | "Block Frequency Analysis", true, true) |
Cong Hou | ab23bfb | 2015-07-15 22:48:29 +0000 | [diff] [blame] | 195 | INITIALIZE_PASS_DEPENDENCY(BranchProbabilityInfoWrapperPass) |
Wei Mi | deee61e | 2015-07-14 23:40:50 +0000 | [diff] [blame] | 196 | INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass) |
| 197 | INITIALIZE_PASS_END(BlockFrequencyInfoWrapperPass, "block-freq", |
| 198 | "Block Frequency Analysis", true, true) |
| 199 | |
| 200 | char BlockFrequencyInfoWrapperPass::ID = 0; |
| 201 | |
| 202 | |
| 203 | BlockFrequencyInfoWrapperPass::BlockFrequencyInfoWrapperPass() |
| 204 | : FunctionPass(ID) { |
| 205 | initializeBlockFrequencyInfoWrapperPassPass(*PassRegistry::getPassRegistry()); |
| 206 | } |
| 207 | |
| 208 | BlockFrequencyInfoWrapperPass::~BlockFrequencyInfoWrapperPass() {} |
| 209 | |
| 210 | void BlockFrequencyInfoWrapperPass::print(raw_ostream &OS, |
| 211 | const Module *) const { |
| 212 | BFI.print(OS); |
| 213 | } |
| 214 | |
| 215 | void BlockFrequencyInfoWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const { |
Cong Hou | ab23bfb | 2015-07-15 22:48:29 +0000 | [diff] [blame] | 216 | AU.addRequired<BranchProbabilityInfoWrapperPass>(); |
Wei Mi | deee61e | 2015-07-14 23:40:50 +0000 | [diff] [blame] | 217 | AU.addRequired<LoopInfoWrapperPass>(); |
| 218 | AU.setPreservesAll(); |
| 219 | } |
| 220 | |
| 221 | void BlockFrequencyInfoWrapperPass::releaseMemory() { BFI.releaseMemory(); } |
| 222 | |
| 223 | bool BlockFrequencyInfoWrapperPass::runOnFunction(Function &F) { |
Cong Hou | ab23bfb | 2015-07-15 22:48:29 +0000 | [diff] [blame] | 224 | BranchProbabilityInfo &BPI = |
| 225 | getAnalysis<BranchProbabilityInfoWrapperPass>().getBPI(); |
Wei Mi | deee61e | 2015-07-14 23:40:50 +0000 | [diff] [blame] | 226 | LoopInfo &LI = getAnalysis<LoopInfoWrapperPass>().getLoopInfo(); |
| 227 | BFI.calculate(F, BPI, LI); |
| 228 | return false; |
| 229 | } |
Xinliang David Li | 28a9327 | 2016-05-05 21:13:27 +0000 | [diff] [blame] | 230 | |
| 231 | char BlockFrequencyAnalysis::PassID; |
| 232 | BlockFrequencyInfo BlockFrequencyAnalysis::run(Function &F, |
| 233 | AnalysisManager<Function> &AM) { |
| 234 | BlockFrequencyInfo BFI; |
| 235 | BFI.calculate(F, AM.getResult<BranchProbabilityAnalysis>(F), |
| 236 | AM.getResult<LoopAnalysis>(F)); |
| 237 | return BFI; |
| 238 | } |
| 239 | |
| 240 | PreservedAnalyses |
| 241 | BlockFrequencyPrinterPass::run(Function &F, AnalysisManager<Function> &AM) { |
| 242 | OS << "Printing analysis results of BFI for function " |
| 243 | << "'" << F.getName() << "':" |
| 244 | << "\n"; |
| 245 | AM.getResult<BlockFrequencyAnalysis>(F).print(OS); |
| 246 | return PreservedAnalyses::all(); |
| 247 | } |