1 //===- ProfileVerifierPass.cpp - LLVM Pass to estimate profile info -------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements a pass that checks profiling information for
13 //===----------------------------------------------------------------------===//
14 #define DEBUG_TYPE "profile-verifier"
15 #include "llvm/Pass.h"
16 #include "llvm/Analysis/ProfileInfo.h"
17 #include "llvm/Support/CommandLine.h"
18 #include "llvm/Support/CFG.h"
19 #include "llvm/Support/raw_ostream.h"
20 #include "llvm/Support/Debug.h"
24 static cl::opt<bool,true>
25 ProfileVerifierDisableAssertions("profile-verifier-noassert",
26 cl::desc("Disable assertions"));
29 class VISIBILITY_HIDDEN ProfileVerifierPass : public FunctionPass {
31 struct DetailedBlockInfo {
41 std::set<const BasicBlock*> BBisVisited;
42 bool DisableAssertions;
44 // When debugging is enabled, the verifier prints a whole slew of debug
45 // information, otherwise its just the assert. These are all the helper
47 bool PrintedDebugTree;
48 std::set<const BasicBlock*> BBisPrinted;
49 void debugEntry(DetailedBlockInfo*);
50 void printDebugInfo(const BasicBlock *BB);
53 static char ID; // Class identification, replacement for typeinfo
55 explicit ProfileVerifierPass (bool da = false) : FunctionPass(&ID),
56 DisableAssertions(da) {
59 void getAnalysisUsage(AnalysisUsage &AU) const {
61 AU.addRequired<ProfileInfo>();
64 const char *getPassName() const {
65 return "Profiling information verifier";
68 /// run - Verify the profile information.
69 bool runOnFunction(Function &F);
70 void recurseBasicBlock(const BasicBlock *BB);
72 double ReadOrAssert(ProfileInfo::Edge);
73 void CheckValue(bool, const char*, DetailedBlockInfo*);
75 } // End of anonymous namespace
77 char ProfileVerifierPass::ID = 0;
78 static RegisterPass<ProfileVerifierPass>
79 X("profile-verifier", "Verify profiling information", false, true);
82 FunctionPass *createProfileVerifierPass() {
83 return new ProfileVerifierPass(ProfileVerifierDisableAssertions);
87 void ProfileVerifierPass::printDebugInfo(const BasicBlock *BB) {
89 if (BBisPrinted.find(BB) != BBisPrinted.end()) return;
91 double BBWeight = PI->getExecutionCount(BB);
92 if (BBWeight == ProfileInfo::MissingValue) { BBWeight = 0; }
95 std::set<const BasicBlock*> ProcessedPreds;
96 for ( pred_const_iterator bbi = pred_begin(BB), bbe = pred_end(BB);
98 if (ProcessedPreds.insert(*bbi).second) {
99 double EdgeWeight = PI->getEdgeWeight(PI->getEdge(*bbi,BB));
100 if (EdgeWeight == ProfileInfo::MissingValue) { EdgeWeight = 0; }
101 errs()<<"calculated in-edge ("<<(*bbi)->getNameStr()<<","<<BB->getNameStr()
102 <<"): "<<EdgeWeight<<"\n";
103 inWeight += EdgeWeight;
107 double outWeight = 0;
109 std::set<const BasicBlock*> ProcessedSuccs;
110 for ( succ_const_iterator bbi = succ_begin(BB), bbe = succ_end(BB);
111 bbi != bbe; ++bbi ) {
112 if (ProcessedSuccs.insert(*bbi).second) {
113 double EdgeWeight = PI->getEdgeWeight(PI->getEdge(BB,*bbi));
114 if (EdgeWeight == ProfileInfo::MissingValue) { EdgeWeight = 0; }
115 errs()<<"calculated out-edge ("<<BB->getNameStr()<<","<<(*bbi)->getNameStr()
116 <<"): "<<EdgeWeight<<"\n";
117 outWeight += EdgeWeight;
121 errs()<<"Block "<<BB->getNameStr()<<" in "<<BB->getParent()->getNameStr()
122 <<",BBWeight="<<BBWeight<<",inWeight="<<inWeight<<",inCount="<<inCount
123 <<",outWeight="<<outWeight<<",outCount"<<outCount<<"\n";
125 // mark as visited and recurse into subnodes
126 BBisPrinted.insert(BB);
127 for ( succ_const_iterator bbi = succ_begin(BB), bbe = succ_end(BB);
128 bbi != bbe; ++bbi ) {
129 printDebugInfo(*bbi);
133 void ProfileVerifierPass::debugEntry (DetailedBlockInfo *DI) {
134 errs() << "TROUBLE: Block " << DI->BB->getNameStr() << " in "
135 << DI->BB->getParent()->getNameStr() << ":";
136 errs() << "BBWeight=" << DI->BBWeight << ",";
137 errs() << "inWeight=" << DI->inWeight << ",";
138 errs() << "inCount=" << DI->inCount << ",";
139 errs() << "outWeight=" << DI->outWeight << ",";
140 errs() << "outCount=" << DI->outCount << ",";
141 if (!PrintedDebugTree) {
142 PrintedDebugTree = true;
143 printDebugInfo(&(DI->BB->getParent()->getEntryBlock()));
147 // compare with relative error
148 static bool Equals(double A, double B) {
149 double maxRelativeError = 0.0000001;
152 double relativeError;
153 if (fabs(B) > fabs(A))
154 relativeError = fabs((A - B) / B);
156 relativeError = fabs((A - B) / A);
157 if (relativeError <= maxRelativeError) return true;
161 double ProfileVerifierPass::ReadOrAssert(ProfileInfo::Edge E) {
162 const char *Message = "ASSERT:Edge has missing value";
163 double EdgeWeight = PI->getEdgeWeight(E);
164 if (EdgeWeight == ProfileInfo::MissingValue) {
165 if (DisableAssertions) {
166 errs() << Message << "\n";
169 assert(0 && Message);
176 void ProfileVerifierPass::CheckValue(bool Error, const char *Message, DetailedBlockInfo *DI) {
178 DEBUG(debugEntry(DI));
179 if (DisableAssertions) {
180 errs() << Message << "\n";
182 assert(0 && Message);
188 void ProfileVerifierPass::recurseBasicBlock(const BasicBlock *BB) {
190 if (BBisVisited.find(BB) != BBisVisited.end()) return;
192 DetailedBlockInfo DI;
194 DI.outCount = DI.inCount = DI.inWeight = DI.outWeight = 0;
195 std::set<const BasicBlock*> ProcessedPreds;
196 for ( pred_const_iterator bbi = pred_begin(BB), bbe = pred_end(BB);
197 bbi != bbe; ++bbi ) {
198 if (ProcessedPreds.insert(*bbi).second) {
199 DI.inWeight += ReadOrAssert(PI->getEdge(*bbi,BB));
204 std::set<const BasicBlock*> ProcessedSuccs;
205 for ( succ_const_iterator bbi = succ_begin(BB), bbe = succ_end(BB);
206 bbi != bbe; ++bbi ) {
207 if (ProcessedSuccs.insert(*bbi).second) {
208 DI.outWeight += ReadOrAssert(PI->getEdge(BB,*bbi));
213 DI.BBWeight = PI->getExecutionCount(BB);
214 CheckValue(DI.BBWeight == ProfileInfo::MissingValue, "ASSERT:BasicBlock has missing value", &DI);
216 if (DI.inCount > 0) {
217 CheckValue(!Equals(DI.inWeight,DI.BBWeight), "ASSERT:inWeight and BBWeight do not match", &DI);
219 if (DI.outCount > 0) {
220 CheckValue(!Equals(DI.outWeight,DI.BBWeight), "ASSERT:outWeight and BBWeight do not match", &DI);
223 // mark as visited and recurse into subnodes
224 BBisVisited.insert(BB);
225 for ( succ_const_iterator bbi = succ_begin(BB), bbe = succ_end(BB);
226 bbi != bbe; ++bbi ) {
227 recurseBasicBlock(*bbi);
231 bool ProfileVerifierPass::runOnFunction(Function &F) {
232 PI = &getAnalysis<ProfileInfo>();
234 if (PI->getExecutionCount(&F) == ProfileInfo::MissingValue) {
235 DEBUG(errs()<<"Function "<<F.getNameStr()<<" has no profile\n");
239 PrintedDebugTree = false;
242 const BasicBlock *entry = &F.getEntryBlock();
243 recurseBasicBlock(entry);
245 if (!DisableAssertions)
246 assert((PI->getExecutionCount(&F)==PI->getExecutionCount(entry)) &&
247 "Function count and entry block count do not match");