1 //===- llvm-prof.cpp - Read in and process llvmprof.out data files --------===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
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.
14 //===----------------------------------------------------------------------===//
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/Bitcode/ReaderWriter.h"
21 #include "llvm/Support/CommandLine.h"
22 #include "llvm/Support/ManagedStatic.h"
23 #include "llvm/Support/MemoryBuffer.h"
24 #include "llvm/System/Signals.h"
35 BytecodeFile(cl::Positional, cl::desc("<program bytecode file>"),
39 ProfileDataFile(cl::Positional, cl::desc("<llvmprof.out file>"),
40 cl::Optional, cl::init("llvmprof.out"));
43 PrintAnnotatedLLVM("annotated-llvm",
44 cl::desc("Print LLVM code with frequency annotations"));
45 cl::alias PrintAnnotated2("A", cl::desc("Alias for --annotated-llvm"),
46 cl::aliasopt(PrintAnnotatedLLVM));
48 PrintAllCode("print-all-code",
49 cl::desc("Print annotated code for the entire program"));
52 // PairSecondSort - A sorting predicate to sort by the second element of a pair.
54 struct PairSecondSortReverse
55 : public std::binary_function<std::pair<T, unsigned>,
56 std::pair<T, unsigned>, bool> {
57 bool operator()(const std::pair<T, unsigned> &LHS,
58 const std::pair<T, unsigned> &RHS) const {
59 return LHS.second > RHS.second;
64 class ProfileAnnotator : public AssemblyAnnotationWriter {
65 std::map<const Function *, unsigned> &FuncFreqs;
66 std::map<const BasicBlock*, unsigned> &BlockFreqs;
67 std::map<ProfileInfoLoader::Edge, unsigned> &EdgeFreqs;
69 ProfileAnnotator(std::map<const Function *, unsigned> &FF,
70 std::map<const BasicBlock*, unsigned> &BF,
71 std::map<ProfileInfoLoader::Edge, unsigned> &EF)
72 : FuncFreqs(FF), BlockFreqs(BF), EdgeFreqs(EF) {}
74 virtual void emitFunctionAnnot(const Function *F, std::ostream &OS) {
75 OS << ";;; %" << F->getName() << " called " << FuncFreqs[F]
78 virtual void emitBasicBlockStartAnnot(const BasicBlock *BB,
80 if (BlockFreqs.empty()) return;
81 if (unsigned Count = BlockFreqs[BB])
82 OS << "\t;;; Basic block executed " << Count << " times.\n";
84 OS << "\t;;; Never executed!\n";
87 virtual void emitBasicBlockEndAnnot(const BasicBlock *BB, std::ostream &OS){
88 if (EdgeFreqs.empty()) return;
90 // Figure out how many times each successor executed.
91 std::vector<std::pair<const BasicBlock*, unsigned> > SuccCounts;
92 const TerminatorInst *TI = BB->getTerminator();
94 std::map<ProfileInfoLoader::Edge, unsigned>::iterator I =
95 EdgeFreqs.lower_bound(std::make_pair(const_cast<BasicBlock*>(BB), 0U));
96 for (; I != EdgeFreqs.end() && I->first.first == BB; ++I)
98 SuccCounts.push_back(std::make_pair(TI->getSuccessor(I->first.second),
100 if (!SuccCounts.empty()) {
101 OS << "\t;;; Out-edge counts:";
102 for (unsigned i = 0, e = SuccCounts.size(); i != e; ++i)
103 OS << " [" << SuccCounts[i].second << " -> "
104 << SuccCounts[i].first->getName() << "]";
112 int main(int argc, char **argv) {
113 llvm_shutdown_obj X; // Call llvm_shutdown() on exit.
115 cl::ParseCommandLineOptions(argc, argv, " llvm profile dump decoder\n");
116 sys::PrintStackTraceOnErrorSignal();
118 // Read in the bytecode file...
119 std::string ErrorMessage;
121 MemoryBuffer *Buffer = MemoryBuffer::getFileOrSTDIN(&BytecodeFile[0],
122 BytecodeFile.size());
124 ErrorMessage = "Error reading file '" + BytecodeFile + "'";
126 M = ParseBitcodeFile(Buffer, &ErrorMessage);
129 std::cerr << argv[0] << ": " << BytecodeFile << ": "
130 << ErrorMessage << "\n";
134 // Read the profiling information
135 ProfileInfoLoader PI(argv[0], ProfileDataFile, *M);
137 std::map<const Function *, unsigned> FuncFreqs;
138 std::map<const BasicBlock*, unsigned> BlockFreqs;
139 std::map<ProfileInfoLoader::Edge, unsigned> EdgeFreqs;
141 // Output a report. Eventually, there will be multiple reports selectable on
142 // the command line, for now, just keep things simple.
144 // Emit the most frequent function table...
145 std::vector<std::pair<Function*, unsigned> > FunctionCounts;
146 PI.getFunctionCounts(FunctionCounts);
147 FuncFreqs.insert(FunctionCounts.begin(), FunctionCounts.end());
149 // Sort by the frequency, backwards.
150 sort(FunctionCounts.begin(), FunctionCounts.end(),
151 PairSecondSortReverse<Function*>());
153 uint64_t TotalExecutions = 0;
154 for (unsigned i = 0, e = FunctionCounts.size(); i != e; ++i)
155 TotalExecutions += FunctionCounts[i].second;
157 std::cout << "===" << std::string(73, '-') << "===\n"
158 << "LLVM profiling output for execution";
159 if (PI.getNumExecutions() != 1) std::cout << "s";
162 for (unsigned i = 0, e = PI.getNumExecutions(); i != e; ++i) {
164 if (e != 1) std::cout << i+1 << ". ";
165 std::cout << PI.getExecution(i) << "\n";
168 std::cout << "\n===" << std::string(73, '-') << "===\n";
169 std::cout << "Function execution frequencies:\n\n";
171 // Print out the function frequencies...
172 std::cout << " ## Frequency\n";
173 for (unsigned i = 0, e = FunctionCounts.size(); i != e; ++i) {
174 if (FunctionCounts[i].second == 0) {
175 std::cout << "\n NOTE: " << e-i << " function" <<
176 (e-i-1 ? "s were" : " was") << " never executed!\n";
180 std::cout << std::setw(3) << i+1 << ". "
181 << std::setw(5) << FunctionCounts[i].second << "/"
182 << TotalExecutions << " "
183 << FunctionCounts[i].first->getName().c_str() << "\n";
186 std::set<Function*> FunctionsToPrint;
188 // If we have block count information, print out the LLVM module with
189 // frequency annotations.
190 if (PI.hasAccurateBlockCounts()) {
191 std::vector<std::pair<BasicBlock*, unsigned> > Counts;
192 PI.getBlockCounts(Counts);
195 for (unsigned i = 0, e = Counts.size(); i != e; ++i)
196 TotalExecutions += Counts[i].second;
198 // Sort by the frequency, backwards.
199 sort(Counts.begin(), Counts.end(),
200 PairSecondSortReverse<BasicBlock*>());
202 std::cout << "\n===" << std::string(73, '-') << "===\n";
203 std::cout << "Top 20 most frequently executed basic blocks:\n\n";
205 // Print out the function frequencies...
206 std::cout <<" ## %% \tFrequency\n";
207 unsigned BlocksToPrint = Counts.size();
208 if (BlocksToPrint > 20) BlocksToPrint = 20;
209 for (unsigned i = 0; i != BlocksToPrint; ++i) {
210 if (Counts[i].second == 0) break;
211 Function *F = Counts[i].first->getParent();
212 std::cout << std::setw(3) << i+1 << ". "
213 << std::setw(5) << std::setprecision(2)
214 << Counts[i].second/(double)TotalExecutions*100 << "% "
215 << std::setw(5) << Counts[i].second << "/"
216 << TotalExecutions << "\t"
217 << F->getName().c_str() << "() - "
218 << Counts[i].first->getName().c_str() << "\n";
219 FunctionsToPrint.insert(F);
222 BlockFreqs.insert(Counts.begin(), Counts.end());
225 if (PI.hasAccurateEdgeCounts()) {
226 std::vector<std::pair<ProfileInfoLoader::Edge, unsigned> > Counts;
227 PI.getEdgeCounts(Counts);
228 EdgeFreqs.insert(Counts.begin(), Counts.end());
231 if (PrintAnnotatedLLVM || PrintAllCode) {
232 std::cout << "\n===" << std::string(73, '-') << "===\n";
233 std::cout << "Annotated LLVM code for the module:\n\n";
235 ProfileAnnotator PA(FuncFreqs, BlockFreqs, EdgeFreqs);
237 if (FunctionsToPrint.empty() || PrintAllCode)
238 M->print(std::cout, &PA);
240 // Print just a subset of the functions...
241 for (std::set<Function*>::iterator I = FunctionsToPrint.begin(),
242 E = FunctionsToPrint.end(); I != E; ++I)
243 (*I)->print(std::cout, &PA);
247 } catch (const std::string& msg) {
248 std::cerr << argv[0] << ": " << msg << "\n";
250 std::cerr << argv[0] << ": Unexpected unknown exception occurred.\n";