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/Module.h"
  17 #include "llvm/Assembly/AsmAnnotationWriter.h"
  18 #include "llvm/Analysis/ProfileInfoLoader.h"
  19 #include "llvm/Bytecode/Reader.h"
  20 #include "Support/CommandLine.h"
  21 #include "Support/Signals.h"
  22 #include <cstdio>
  23 #include <map>
  24 #include <set>
  25
  26 using namespace llvm;
  27
  28 namespace {
  29   cl::opt<std::string>
  30   BytecodeFile(cl::Positional, cl::desc("<program bytecode file>"),
  31                cl::Required);
  32
  33   cl::opt<std::string>
  34   ProfileDataFile(cl::Positional, cl::desc("<llvmprof.out file>"),
  35                   cl::Optional, cl::init("llvmprof.out"));
  36
  37   cl::opt<bool>
  38   PrintAnnotatedLLVM("annotated-llvm",
  39                      cl::desc("Print LLVM code with frequency annotations"));
  40   cl::alias PrintAnnotated2("A", cl::desc("Alias for --annotated-llvm"),
  41                             cl::aliasopt(PrintAnnotatedLLVM));
  42   cl::opt<bool>
  43   PrintAllCode("print-all-code",
  44                cl::desc("Print annotated code for the entire program"));
  45 }
  46
  47 // PairSecondSort - A sorting predicate to sort by the second element of a pair.
  48 template<class T>
  49 struct PairSecondSortReverse
  50   : public std::binary_function<std::pair<T, unsigned>,
  51                                 std::pair<T, unsigned>, bool> {
  52   bool operator()(const std::pair<T, unsigned> &LHS,
  53                   const std::pair<T, unsigned> &RHS) const {
  54     return LHS.second > RHS.second;
  55   }
  56 };
  57
  58 namespace {
  59   class ProfileAnnotator : public AssemblyAnnotationWriter {
  60     std::map<const Function  *, unsigned> &FuncFreqs;
  61     std::map<const BasicBlock*, unsigned> &BlockFreqs;
  62   public:
  63     ProfileAnnotator(std::map<const Function  *, unsigned> &FF,
  64                      std::map<const BasicBlock*, unsigned> &BF)
  65       : FuncFreqs(FF), BlockFreqs(BF) {}
  66
  67     virtual void emitFunctionAnnot(const Function *F, std::ostream &OS) {
  68       OS << ";;; %" << F->getName() << " called " << FuncFreqs[F]
  69          << " times.\n;;;\n";
  70     }
  71     virtual void emitBasicBlockAnnot(const BasicBlock *BB, std::ostream &OS) {
  72       if (BlockFreqs.empty()) return;
  73       if (unsigned Count = BlockFreqs[BB])
  74         OS << ";;; Executed " << Count << " times.\n";
  75       else
  76         OS << ";;; Never executed!\n";
  77     }
  78   };
  79 }
  80
  81
  82 int main(int argc, char **argv) {
  83   cl::ParseCommandLineOptions(argc, argv, " llvm profile dump decoder\n");
  84   PrintStackTraceOnErrorSignal();
  85
  86   // Read in the bytecode file...
  87   std::string ErrorMessage;
  88   Module *M = ParseBytecodeFile(BytecodeFile, &ErrorMessage);
  89   if (M == 0) {
  90     std::cerr << argv[0] << ": " << BytecodeFile << ": " << ErrorMessage
  91               << "\n";
  92     return 1;
  93   }
  94
  95   // Read the profiling information
  96   ProfileInfoLoader PI(argv[0], ProfileDataFile, *M);
  97
  98   std::map<const Function  *, unsigned> FuncFreqs;
  99   std::map<const BasicBlock*, unsigned> BlockFreqs;
 100
 101   // Output a report.  Eventually, there will be multiple reports selectable on
 102   // the command line, for now, just keep things simple.
 103
 104   // Emit the most frequent function table...
 105   std::vector<std::pair<Function*, unsigned> > FunctionCounts;
 106   PI.getFunctionCounts(FunctionCounts);
 107   FuncFreqs.insert(FunctionCounts.begin(), FunctionCounts.end());
 108
 109   // Sort by the frequency, backwards.
 110   std::sort(FunctionCounts.begin(), FunctionCounts.end(),
 111             PairSecondSortReverse<Function*>());
 112
 113   unsigned long long TotalExecutions = 0;
 114   for (unsigned i = 0, e = FunctionCounts.size(); i != e; ++i)
 115     TotalExecutions += FunctionCounts[i].second;
 116
 117   std::cout << "===" << std::string(73, '-') << "===\n"
 118             << "LLVM profiling output for execution";
 119   if (PI.getNumExecutions() != 1) std::cout << "s";
 120   std::cout << ":\n";
 121
 122   for (unsigned i = 0, e = PI.getNumExecutions(); i != e; ++i) {
 123     std::cout << "  ";
 124     if (e != 1) std::cout << i+1 << ". ";
 125     std::cout << PI.getExecution(i) << "\n";
 126   }
 127
 128   std::cout << "\n===" << std::string(73, '-') << "===\n";
 129   std::cout << "Function execution frequencies:\n\n";
 130
 131   // Print out the function frequencies...
 132   printf(" ##   Frequency\n");
 133   for (unsigned i = 0, e = FunctionCounts.size(); i != e; ++i) {
 134     if (FunctionCounts[i].second == 0) {
 135       printf("\n  NOTE: %d function%s never executed!\n",
 136              e-i, e-i-1 ? "s were" : " was");
 137       break;
 138     }
 139
 140     printf("%3d. %5u/%llu %s\n", i+1, FunctionCounts[i].second, TotalExecutions,
 141            FunctionCounts[i].first->getName().c_str());
 142   }
 143
 144   std::set<Function*> FunctionsToPrint;
 145
 146   // If we have block count information, print out the LLVM module with
 147   // frequency annotations.
 148   if (PI.hasAccurateBlockCounts()) {
 149     std::vector<std::pair<BasicBlock*, unsigned> > Counts;
 150     PI.getBlockCounts(Counts);
 151
 152     TotalExecutions = 0;
 153     for (unsigned i = 0, e = Counts.size(); i != e; ++i)
 154       TotalExecutions += Counts[i].second;
 155
 156     // Sort by the frequency, backwards.
 157     std::sort(Counts.begin(), Counts.end(),
 158               PairSecondSortReverse<BasicBlock*>());
 159
 160     std::cout << "\n===" << std::string(73, '-') << "===\n";
 161     std::cout << "Top 20 most frequently executed basic blocks:\n\n";
 162
 163     // Print out the function frequencies...
 164     printf(" ##      %%%% \tFrequency\n");
 165     unsigned BlocksToPrint = Counts.size();
 166     if (BlocksToPrint > 20) BlocksToPrint = 20;
 167     for (unsigned i = 0; i != BlocksToPrint; ++i) {
 168       if (Counts[i].second == 0) break;
 169       Function *F = Counts[i].first->getParent();
 170       printf("%3d. %5.2f%% %5u/%llu\t%s() - %s\n", i+1,
 171              Counts[i].second/(double)TotalExecutions*100,
 172              Counts[i].second, TotalExecutions,
 173              F->getName().c_str(), Counts[i].first->getName().c_str());
 174       FunctionsToPrint.insert(F);
 175     }
 176
 177     BlockFreqs.insert(Counts.begin(), Counts.end());
 178   }
 179
 180   if (PrintAnnotatedLLVM || PrintAllCode) {
 181     std::cout << "\n===" << std::string(73, '-') << "===\n";
 182     std::cout << "Annotated LLVM code for the module:\n\n";
 183
 184     ProfileAnnotator PA(FuncFreqs, BlockFreqs);
 185
 186     if (FunctionsToPrint.empty() || PrintAllCode)
 187       M->print(std::cout, &PA);
 188     else
 189       // Print just a subset of the functions...
 190       for (std::set<Function*>::iterator I = FunctionsToPrint.begin(),
 191              E = FunctionsToPrint.end(); I != E; ++I)
 192         (*I)->print(std::cout, &PA);
 193   }
 194
 195   return 0;
 196 }