lib/Transforms/Instrumentation/ProfilePaths/ProfilePaths.cpp

   1 //===-- ProfilePaths.cpp - interface to insert instrumentation ---*- C++ -*--=//
   2 //
   3 // This inserts intrumentation for counting
   4 // execution of paths though a given function
   5 // Its implemented as a "Function" Pass, and called using opt
   6 //
   7 // This pass is implemented by using algorithms similar to
   8 // 1."Efficient Path Profiling": Ball, T. and Larus, J. R.,
   9 // Proceedings of Micro-29, Dec 1996, Paris, France.
  10 // 2."Efficiently Counting Program events with support for on-line
  11 //   "queries": Ball T., ACM Transactions on Programming Languages
  12 //   and systems, Sep 1994.
  13 //
  14 // The algorithms work on a Graph constructed over the nodes
  15 // made from Basic Blocks: The transformations then take place on
  16 // the constucted graph (implementation in Graph.cpp and GraphAuxillary.cpp)
  17 // and finally, appropriate instrumentation is placed over suitable edges.
  18 // (code inserted through EdgeCode.cpp).
  19 //
  20 // The algorithm inserts code such that every acyclic path in the CFG
  21 // of a function is identified through a unique number. the code insertion
  22 // is optimal in the sense that its inserted over a minimal set of edges. Also,
  23 // the algorithm makes sure than initialization, path increment and counter
  24 // update can be collapsed into minimum number of edges.
  25 //===----------------------------------------------------------------------===//
  26
  27 #include "llvm/Transforms/Instrumentation/ProfilePaths.h"
  28 #include "llvm/Transforms/Utils/UnifyFunctionExitNodes.h"
  29 #include "llvm/Support/CFG.h"
  30 #include "llvm/Constants.h"
  31 #include "llvm/DerivedTypes.h"
  32 #include "llvm/iMemory.h"
  33 #include "llvm/Transforms/Instrumentation/Graph.h"
  34 #include <iostream>
  35 #include <fstream>
  36
  37 using std::vector;
  38
  39 struct ProfilePaths : public FunctionPass {
  40   bool runOnFunction(Function &F);
  41
  42   // Before this pass, make sure that there is only one
  43   // entry and only one exit node for the function in the CFG of the function
  44   //
  45   void ProfilePaths::getAnalysisUsage(AnalysisUsage &AU) const {
  46     AU.addRequired(UnifyFunctionExitNodes::ID);
  47   }
  48 };
  49
  50 static RegisterPass<ProfilePaths> X("paths", "Profile Paths");
  51
  52 // createProfilePathsPass - Create a new pass to add path profiling
  53 //
  54 Pass *createProfilePathsPass() {
  55   return new ProfilePaths();
  56 }
  57
  58
  59 static Node *findBB(std::vector<Node *> &st, BasicBlock *BB){
  60   for(std::vector<Node *>::iterator si=st.begin(); si!=st.end(); ++si){
  61     if(((*si)->getElement())==BB){
  62       return *si;
  63     }
  64   }
  65   return NULL;
  66 }
  67
  68 //Per function pass for inserting counters and trigger code
  69 bool ProfilePaths::runOnFunction(Function &F){
  70
  71   static int mn = -1;
  72
  73   if(F.isExternal()) {
  74     return false;
  75   }
  76
  77   //std::cerr<<"Instrumenting\n-----------------\n";
  78   //std::cerr<<F;
  79   //increment counter for instrumented functions. mn is now function#
  80   mn++;
  81
  82   //std::cerr<<"MN = "<<mn<<"\n";;
  83   //std::cerr<<F;
  84
  85   // Transform the cfg s.t. we have just one exit node
  86   BasicBlock *ExitNode = getAnalysis<UnifyFunctionExitNodes>().getExitNode();
  87
  88   //iterating over BBs and making graph
  89   std::vector<Node *> nodes;
  90   std::vector<Edge> edges;
  91
  92   Node *tmp;
  93   Node *exitNode, *startNode;
  94
  95   // The nodes must be uniquesly identified:
  96   // That is, no two nodes must hav same BB*
  97
  98   for (Function::iterator BB = F.begin(), BE = F.end(); BB != BE; ++BB) {
  99     Node *nd=new Node(BB);
 100     nodes.push_back(nd);
 101     if(&*BB == ExitNode)
 102       exitNode=nd;
 103     if(&*BB==F.begin())
 104       startNode=nd;
 105   }
 106
 107   // now do it againto insert edges
 108   for (Function::iterator BB = F.begin(), BE = F.end(); BB != BE; ++BB){
 109     Node *nd=findBB(nodes, BB);
 110     assert(nd && "No node for this edge!");
 111
 112     for(BasicBlock::succ_iterator s=succ_begin(BB), se=succ_end(BB);
 113         s!=se; ++s){
 114       Node *nd2=findBB(nodes,*s);
 115       assert(nd2 && "No node for this edge!");
 116       Edge ed(nd,nd2,0);
 117       edges.push_back(ed);
 118     }
 119   }
 120
 121   Graph g(nodes,edges, startNode, exitNode);
 122
 123   //#ifdef DEBUG_PATH_PROFILES
 124   //std::cerr<<"Original graph\n";
 125   //printGraph(g);
 126   //#endif
 127
 128   BasicBlock *fr = &F.front();
 129
 130   // The graph is made acyclic: this is done
 131   // by removing back edges for now, and adding them later on
 132   vector<Edge> be;
 133   std::map<Node *, int> nodePriority; //it ranks nodes in depth first order traversal
 134   g.getBackEdges(be, nodePriority);
 135   /*
 136   std::cerr<<"Node priority--------------\n";
 137   for(std::map<Node *, int>::iterator MI = nodePriority.begin(),
 138         ME = nodePriority.end(); MI!=ME; ++MI)
 139     std::cerr<<MI->first->getElement()->getName()<<"->"<<MI->second<<"\n";
 140   std::cerr<<"End Node priority--------------\n";
 141   */
 142   //std::cerr<<"BackEdges-------------\n";
 143   //   for(vector<Edge>::iterator VI=be.begin(); VI!=be.end(); ++VI){
 144   //printEdge(*VI);
 145   //cerr<<"\n";
 146   //}
 147   //std::cerr<<"------\n";
 148
 149 #ifdef DEBUG_PATH_PROFILES
 150   cerr<<"Backedges:"<<be.size()<<endl;
 151 #endif
 152   //Now we need to reflect the effect of back edges
 153   //This is done by adding dummy edges
 154   //If a->b is a back edge
 155   //Then we add 2 back edges for it:
 156   //1. from root->b (in vector stDummy)
 157   //and 2. from a->exit (in vector exDummy)
 158   vector<Edge> stDummy;
 159   vector<Edge> exDummy;
 160   addDummyEdges(stDummy, exDummy, g, be);
 161
 162   //std::cerr<<"After adding dummy edges\n";
 163   //printGraph(g);
 164
 165   // Now, every edge in the graph is assigned a weight
 166   // This weight later adds on to assign path
 167   // numbers to different paths in the graph
 168   //  All paths for now are acyclic,
 169   // since no back edges in the graph now
 170   // numPaths is the number of acyclic paths in the graph
 171   int numPaths=valueAssignmentToEdges(g, nodePriority);
 172
 173   if(numPaths<=1 || numPaths >5000) return false;
 174   //std::cerr<<"Numpaths="<<numPaths<<std::endl;
 175   //printGraph(g);
 176   //create instruction allocation r and count
 177   //r is the variable that'll act like an accumulator
 178   //all along the path, we just add edge values to r
 179   //and at the end, r reflects the path number
 180   //count is an array: count[x] would store
 181   //the number of executions of path numbered x
 182
 183   Instruction *rVar=new
 184     AllocaInst(PointerType::get(Type::IntTy),
 185                ConstantUInt::get(Type::UIntTy,1),"R");
 186
 187   Instruction *countVar=new
 188     AllocaInst(PointerType::get(Type::IntTy),
 189                ConstantUInt::get(Type::UIntTy, numPaths), "Count");
 190
 191   // insert initialization code in first (entry) BB
 192   // this includes initializing r and count
 193   insertInTopBB(&F.getEntryNode(),numPaths, rVar, countVar);
 194
 195   //now process the graph: get path numbers,
 196   //get increments along different paths,
 197   //and assign "increments" and "updates" (to r and count)
 198   //"optimally". Finally, insert llvm code along various edges
 199   processGraph(g, rVar, countVar, be, stDummy, exDummy, numPaths, mn);
 200
 201   return true;  // Always modifies function
 202 }