tools/llvm-prof/llvm-prof.cpp

   1 //===- llvm-prof.cpp - Read in and process llvmprof.out data files --------===//
   2 //
   3 //                      The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This tools is meant for use with the various LLVM profiling instrumentation
  11 // passes.  It reads in the data file produced by executing an instrumented
  12 // program, and outputs a nice report.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "llvm/InstrTypes.h"
  17 #include "llvm/Module.h"
  18 #include "llvm/Assembly/AsmAnnotationWriter.h"
  19 #include "llvm/Analysis/ProfileInfoLoader.h"
  20 #include "llvm/Bytecode/Reader.h"
  21 #include "llvm/Support/CommandLine.h"
  22 #include "llvm/System/Signals.h"
  23 #include <iostream>
  24 #include <iomanip>
  25 #include <map>
  26 #include <set>
  27
  28 using namespace llvm;
  29
  30 namespace {
  31   cl::opt<std::string>
  32   BytecodeFile(cl::Positional, cl::desc("<program bytecode file>"),
  33                cl::Required);
  34
  35   cl::opt<std::string>
  36   ProfileDataFile(cl::Positional, cl::desc("<llvmprof.out file>"),
  37                   cl::Optional, cl::init("llvmprof.out"));
  38
  39   cl::opt<bool>
  40   PrintAnnotatedLLVM("annotated-llvm",
  41                      cl::desc("Print LLVM code with frequency annotations"));
  42   cl::alias PrintAnnotated2("A", cl::desc("Alias for --annotated-llvm"),
  43                             cl::aliasopt(PrintAnnotatedLLVM));
  44   cl::opt<bool>
  45   PrintAllCode("print-all-code",
  46                cl::desc("Print annotated code for the entire program"));
  47 }
  48
  49 // PairSecondSort - A sorting predicate to sort by the second element of a pair.
  50 template<class T>
  51 struct PairSecondSortReverse
  52   : public std::binary_function<std::pair<T, unsigned>,
  53                                 std::pair<T, unsigned>, bool> {
  54   bool operator()(const std::pair<T, unsigned> &LHS,
  55                   const std::pair<T, unsigned> &RHS) const {
  56     return LHS.second > RHS.second;
  57   }
  58 };
  59
  60 namespace {
  61   class ProfileAnnotator : public AssemblyAnnotationWriter {
  62     std::map<const Function  *, unsigned> &FuncFreqs;
  63     std::map<const BasicBlock*, unsigned> &BlockFreqs;
  64     std::map<ProfileInfoLoader::Edge, unsigned> &EdgeFreqs;
  65   public:
  66     ProfileAnnotator(std::map<const Function  *, unsigned> &FF,
  67                      std::map<const BasicBlock*, unsigned> &BF,
  68                      std::map<ProfileInfoLoader::Edge, unsigned> &EF)
  69       : FuncFreqs(FF), BlockFreqs(BF), EdgeFreqs(EF) {}
  70
  71     virtual void emitFunctionAnnot(const Function *F, std::ostream &OS) {
  72       OS << ";;; %" << F->getName() << " called " << FuncFreqs[F]
  73          << " times.\n;;;\n";
  74     }
  75     virtual void emitBasicBlockStartAnnot(const BasicBlock *BB,
  76                                           std::ostream &OS) {
  77       if (BlockFreqs.empty()) return;
  78       if (unsigned Count = BlockFreqs[BB])
  79         OS << "\t;;; Basic block executed " << Count << " times.\n";
  80       else
  81         OS << "\t;;; Never executed!\n";
  82     }
  83
  84     virtual void emitBasicBlockEndAnnot(const BasicBlock *BB, std::ostream &OS){
  85       if (EdgeFreqs.empty()) return;
  86
  87       // Figure out how many times each successor executed.
  88       std::vector<std::pair<const BasicBlock*, unsigned> > SuccCounts;
  89       const TerminatorInst *TI = BB->getTerminator();
  90
  91       std::map<ProfileInfoLoader::Edge, unsigned>::iterator I =
  92         EdgeFreqs.lower_bound(std::make_pair(const_cast<BasicBlock*>(BB), 0U));
  93       for (; I != EdgeFreqs.end() && I->first.first == BB; ++I)
  94         if (I->second)
  95           SuccCounts.push_back(std::make_pair(TI->getSuccessor(I->first.second),
  96                                               I->second));
  97       if (!SuccCounts.empty()) {
  98         OS << "\t;;; Out-edge counts:";
  99         for (unsigned i = 0, e = SuccCounts.size(); i != e; ++i)
 100           OS << " [" << SuccCounts[i].second << " -> "
 101              << SuccCounts[i].first->getName() << "]";
 102         OS << "\n";
 103       }
 104     }
 105   };
 106 }
 107
 108
 109 int main(int argc, char **argv) {
 110   try {
 111     cl::ParseCommandLineOptions(argc, argv, " llvm profile dump decoder\n");
 112     sys::PrintStackTraceOnErrorSignal();
 113
 114     // Read in the bytecode file...
 115     std::string ErrorMessage;
 116     Module *M = ParseBytecodeFile(BytecodeFile, &ErrorMessage);
 117     if (M == 0) {
 118       std::cerr << argv[0] << ": " << BytecodeFile << ": "
 119         << ErrorMessage << "\n";
 120       return 1;
 121     }
 122
 123     // Read the profiling information
 124     ProfileInfoLoader PI(argv[0], ProfileDataFile, *M);
 125
 126     std::map<const Function  *, unsigned> FuncFreqs;
 127     std::map<const BasicBlock*, unsigned> BlockFreqs;
 128     std::map<ProfileInfoLoader::Edge, unsigned> EdgeFreqs;
 129
 130     // Output a report. Eventually, there will be multiple reports selectable on
 131     // the command line, for now, just keep things simple.
 132
 133     // Emit the most frequent function table...
 134     std::vector<std::pair<Function*, unsigned> > FunctionCounts;
 135     PI.getFunctionCounts(FunctionCounts);
 136     FuncFreqs.insert(FunctionCounts.begin(), FunctionCounts.end());
 137
 138     // Sort by the frequency, backwards.
 139     sort(FunctionCounts.begin(), FunctionCounts.end(),
 140               PairSecondSortReverse<Function*>());
 141
 142     unsigned long long TotalExecutions = 0;
 143     for (unsigned i = 0, e = FunctionCounts.size(); i != e; ++i)
 144       TotalExecutions += FunctionCounts[i].second;
 145
 146     std::cout << "===" << std::string(73, '-') << "===\n"
 147               << "LLVM profiling output for execution";
 148     if (PI.getNumExecutions() != 1) std::cout << "s";
 149     std::cout << ":\n";
 150
 151     for (unsigned i = 0, e = PI.getNumExecutions(); i != e; ++i) {
 152       std::cout << "  ";
 153       if (e != 1) std::cout << i+1 << ". ";
 154       std::cout << PI.getExecution(i) << "\n";
 155     }
 156
 157     std::cout << "\n===" << std::string(73, '-') << "===\n";
 158     std::cout << "Function execution frequencies:\n\n";
 159
 160     // Print out the function frequencies...
 161     std::cout << " ##   Frequency\n";
 162     for (unsigned i = 0, e = FunctionCounts.size(); i != e; ++i) {
 163       if (FunctionCounts[i].second == 0) {
 164         std::cout << "\n  NOTE: " << e-i << " function" <<
 165                (e-i-1 ? "s were" : " was") << " never executed!\n";
 166         break;
 167       }
 168
 169       std::cout << std::setw(3) << i+1 << ". "
 170         << std::setw(5) << FunctionCounts[i].second << "/"
 171         << TotalExecutions << " "
 172         << FunctionCounts[i].first->getName().c_str() << "\n";
 173     }
 174
 175     std::set<Function*> FunctionsToPrint;
 176
 177     // If we have block count information, print out the LLVM module with
 178     // frequency annotations.
 179     if (PI.hasAccurateBlockCounts()) {
 180       std::vector<std::pair<BasicBlock*, unsigned> > Counts;
 181       PI.getBlockCounts(Counts);
 182
 183       TotalExecutions = 0;
 184       for (unsigned i = 0, e = Counts.size(); i != e; ++i)
 185         TotalExecutions += Counts[i].second;
 186
 187       // Sort by the frequency, backwards.
 188       sort(Counts.begin(), Counts.end(),
 189                 PairSecondSortReverse<BasicBlock*>());
 190
 191       std::cout << "\n===" << std::string(73, '-') << "===\n";
 192       std::cout << "Top 20 most frequently executed basic blocks:\n\n";
 193
 194       // Print out the function frequencies...
 195       std::cout <<" ##      %% \tFrequency\n";
 196       unsigned BlocksToPrint = Counts.size();
 197       if (BlocksToPrint > 20) BlocksToPrint = 20;
 198       for (unsigned i = 0; i != BlocksToPrint; ++i) {
 199         if (Counts[i].second == 0) break;
 200         Function *F = Counts[i].first->getParent();
 201         std::cout << std::setw(3) << i+1 << ". "
 202           << std::setw(5) << std::setprecision(2)
 203           << Counts[i].second/(double)TotalExecutions*100 << "% "
 204           << std::setw(5) << Counts[i].second << "/"
 205           << TotalExecutions << "\t"
 206           << F->getName().c_str() << "() - "
 207           << Counts[i].first->getName().c_str() << "\n";
 208         FunctionsToPrint.insert(F);
 209       }
 210
 211       BlockFreqs.insert(Counts.begin(), Counts.end());
 212     }
 213
 214     if (PI.hasAccurateEdgeCounts()) {
 215       std::vector<std::pair<ProfileInfoLoader::Edge, unsigned> > Counts;
 216       PI.getEdgeCounts(Counts);
 217       EdgeFreqs.insert(Counts.begin(), Counts.end());
 218     }
 219
 220     if (PrintAnnotatedLLVM || PrintAllCode) {
 221       std::cout << "\n===" << std::string(73, '-') << "===\n";
 222       std::cout << "Annotated LLVM code for the module:\n\n";
 223
 224       ProfileAnnotator PA(FuncFreqs, BlockFreqs, EdgeFreqs);
 225
 226       if (FunctionsToPrint.empty() || PrintAllCode)
 227         M->print(std::cout, &PA);
 228       else
 229         // Print just a subset of the functions...
 230         for (std::set<Function*>::iterator I = FunctionsToPrint.begin(),
 231                E = FunctionsToPrint.end(); I != E; ++I)
 232           (*I)->print(std::cout, &PA);
 233     }
 234
 235     return 0;
 236   } catch (const std::string& msg) {
 237     std::cerr << argv[0] << ": " << msg << "\n";
 238   } catch (...) {
 239     std::cerr << argv[0] << ": Unexpected unknown exception occurred.\n";
 240   }
 241   return 1;
 242 }