lib/Analysis/DataStructure/BottomUpClosure.cpp

   1 //===- BottomUpClosure.cpp - Compute bottom-up interprocedural closure ----===//
   2 //
   3 // This file implements the BUDataStructures class, which represents the
   4 // Bottom-Up Interprocedural closure of the data structure graph over the
   5 // program.  This is useful for applications like pool allocation, but **not**
   6 // applications like alias analysis.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #include "llvm/Analysis/DataStructure.h"
  11 #include "llvm/Module.h"
  12 #include "Support/Statistic.h"
  13 #include "DSCallSiteIterator.h"
  14
  15 namespace {
  16   Statistic<> MaxSCC("budatastructure", "Maximum SCC Size in Call Graph");
  17   Statistic<> NumBUInlines("budatastructures", "Number of graphs inlined");
  18
  19   RegisterAnalysis<BUDataStructures>
  20   X("budatastructure", "Bottom-up Data Structure Analysis");
  21 }
  22
  23 using namespace DS;
  24
  25 // run - Calculate the bottom up data structure graphs for each function in the
  26 // program.
  27 //
  28 bool BUDataStructures::run(Module &M) {
  29   LocalDataStructures &LocalDSA = getAnalysis<LocalDataStructures>();
  30   GlobalsGraph = new DSGraph(LocalDSA.getGlobalsGraph());
  31   GlobalsGraph->setPrintAuxCalls();
  32
  33   Function *MainFunc = M.getMainFunction();
  34   if (MainFunc)
  35     calculateReachableGraphs(MainFunc);
  36
  37   // Calculate the graphs for any functions that are unreachable from main...
  38   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
  39     if (!I->isExternal() && !DSInfo.count(I)) {
  40 #ifndef NDEBUG
  41       if (MainFunc)
  42         std::cerr << "*** Function unreachable from main: "
  43                   << I->getName() << "\n";
  44 #endif
  45       calculateReachableGraphs(I);    // Calculate all graphs...
  46     }
  47   return false;
  48 }
  49
  50 void BUDataStructures::calculateReachableGraphs(Function *F) {
  51   std::vector<Function*> Stack;
  52   hash_map<Function*, unsigned> ValMap;
  53   unsigned NextID = 1;
  54   calculateGraphs(F, Stack, NextID, ValMap);
  55 }
  56
  57 DSGraph &BUDataStructures::getOrCreateGraph(Function *F) {
  58   // Has the graph already been created?
  59   DSGraph *&Graph = DSInfo[F];
  60   if (Graph) return *Graph;
  61
  62   // Copy the local version into DSInfo...
  63   Graph = new DSGraph(getAnalysis<LocalDataStructures>().getDSGraph(*F));
  64
  65   Graph->setGlobalsGraph(GlobalsGraph);
  66   Graph->setPrintAuxCalls();
  67
  68   // Start with a copy of the original call sites...
  69   Graph->getAuxFunctionCalls() = Graph->getFunctionCalls();
  70   return *Graph;
  71 }
  72
  73 unsigned BUDataStructures::calculateGraphs(Function *F,
  74                                            std::vector<Function*> &Stack,
  75                                            unsigned &NextID,
  76                                      hash_map<Function*, unsigned> &ValMap) {
  77   assert(ValMap.find(F) == ValMap.end() && "Shouldn't revisit functions!");
  78   unsigned Min = NextID++, MyID = Min;
  79   ValMap[F] = Min;
  80   Stack.push_back(F);
  81
  82   if (F->isExternal()) {   // sprintf, fprintf, sscanf, etc...
  83     // No callees!
  84     Stack.pop_back();
  85     ValMap[F] = ~0;
  86     return Min;
  87   }
  88
  89   DSGraph &Graph = getOrCreateGraph(F);
  90
  91   // The edges out of the current node are the call site targets...
  92   for (DSCallSiteIterator I = DSCallSiteIterator::begin_aux(Graph),
  93          E = DSCallSiteIterator::end_aux(Graph); I != E; ++I) {
  94     Function *Callee = *I;
  95     unsigned M;
  96     // Have we visited the destination function yet?
  97     hash_map<Function*, unsigned>::iterator It = ValMap.find(Callee);
  98     if (It == ValMap.end())  // No, visit it now.
  99       M = calculateGraphs(Callee, Stack, NextID, ValMap);
 100     else                    // Yes, get it's number.
 101       M = It->second;
 102     if (M < Min) Min = M;
 103   }
 104
 105   assert(ValMap[F] == MyID && "SCC construction assumption wrong!");
 106   if (Min != MyID)
 107     return Min;         // This is part of a larger SCC!
 108
 109   // If this is a new SCC, process it now.
 110   if (Stack.back() == F) {           // Special case the single "SCC" case here.
 111     DEBUG(std::cerr << "Visiting single node SCC #: " << MyID << " fn: "
 112                     << F->getName() << "\n");
 113     Stack.pop_back();
 114     DSGraph &G = getDSGraph(*F);
 115     DEBUG(std::cerr << "  [BU] Calculating graph for: " << F->getName()<< "\n");
 116     calculateGraph(G);
 117     DEBUG(std::cerr << "  [BU] Done inlining: " << F->getName() << " ["
 118                     << G.getGraphSize() << "+" << G.getAuxFunctionCalls().size()
 119                     << "]\n");
 120
 121     if (MaxSCC < 1) MaxSCC = 1;
 122
 123     // Should we revisit the graph?
 124     if (DSCallSiteIterator::begin_aux(G) != DSCallSiteIterator::end_aux(G)) {
 125       ValMap.erase(F);
 126       return calculateGraphs(F, Stack, NextID, ValMap);
 127     } else {
 128       ValMap[F] = ~0U;
 129     }
 130     return MyID;
 131
 132   } else {
 133     // SCCFunctions - Keep track of the functions in the current SCC
 134     //
 135     hash_set<Function*> SCCFunctions;
 136
 137     Function *NF;
 138     std::vector<Function*>::iterator FirstInSCC = Stack.end();
 139     DSGraph *SCCGraph = 0;
 140     do {
 141       NF = *--FirstInSCC;
 142       ValMap[NF] = ~0U;
 143       SCCFunctions.insert(NF);
 144
 145       // Figure out which graph is the largest one, in order to speed things up
 146       // a bit in situations where functions in the SCC have widely different
 147       // graph sizes.
 148       DSGraph &NFGraph = getDSGraph(*NF);
 149       if (!SCCGraph || SCCGraph->getGraphSize() < NFGraph.getGraphSize())
 150         SCCGraph = &NFGraph;
 151     } while (NF != F);
 152
 153     std::cerr << "Calculating graph for SCC #: " << MyID << " of size: "
 154               << SCCFunctions.size() << "\n";
 155
 156     // Compute the Max SCC Size...
 157     if (MaxSCC < SCCFunctions.size())
 158       MaxSCC = SCCFunctions.size();
 159
 160     // First thing first, collapse all of the DSGraphs into a single graph for
 161     // the entire SCC.  We computed the largest graph, so clone all of the other
 162     // (smaller) graphs into it.  Discard all of the old graphs.
 163     //
 164     for (hash_set<Function*>::iterator I = SCCFunctions.begin(),
 165            E = SCCFunctions.end(); I != E; ++I) {
 166       DSGraph &G = getDSGraph(**I);
 167       if (&G != SCCGraph) {
 168         DSGraph::NodeMapTy NodeMap;
 169         SCCGraph->cloneInto(G, SCCGraph->getScalarMap(),
 170                             SCCGraph->getReturnNodes(), NodeMap, 0);
 171         // Update the DSInfo map and delete the old graph...
 172         DSInfo[*I] = SCCGraph;
 173         delete &G;
 174       }
 175     }
 176
 177     // Clean up the graph before we start inlining a bunch again...
 178     SCCGraph->removeTriviallyDeadNodes();
 179
 180     // Now that we have one big happy family, resolve all of the call sites in
 181     // the graph...
 182     calculateGraph(*SCCGraph);
 183     DEBUG(std::cerr << "  [BU] Done inlining SCC  [" << SCCGraph->getGraphSize()
 184                     << "+" << SCCGraph->getAuxFunctionCalls().size() << "]\n");
 185
 186     std::cerr << "DONE with SCC #: " << MyID << "\n";
 187
 188     // We never have to revisit "SCC" processed functions...
 189
 190     // Drop the stuff we don't need from the end of the stack
 191     Stack.erase(FirstInSCC, Stack.end());
 192     return MyID;
 193   }
 194
 195   return MyID;  // == Min
 196 }
 197
 198
 199 // releaseMemory - If the pass pipeline is done with this pass, we can release
 200 // our memory... here...
 201 //
 202 void BUDataStructures::releaseMemory() {
 203   for (hash_map<Function*, DSGraph*>::iterator I = DSInfo.begin(),
 204          E = DSInfo.end(); I != E; ++I) {
 205     I->second->getReturnNodes().erase(I->first);
 206     if (I->second->getReturnNodes().empty())
 207       delete I->second;
 208   }
 209
 210   // Empty map so next time memory is released, data structures are not
 211   // re-deleted.
 212   DSInfo.clear();
 213   delete GlobalsGraph;
 214   GlobalsGraph = 0;
 215 }
 216
 217 void BUDataStructures::calculateGraph(DSGraph &Graph) {
 218   // Move our call site list into TempFCs so that inline call sites go into the
 219   // new call site list and doesn't invalidate our iterators!
 220   std::vector<DSCallSite> TempFCs;
 221   std::vector<DSCallSite> &AuxCallsList = Graph.getAuxFunctionCalls();
 222   TempFCs.swap(AuxCallsList);
 223
 224   DSGraph::ReturnNodesTy &ReturnNodes = Graph.getReturnNodes();
 225
 226   // Loop over all of the resolvable call sites
 227   unsigned LastCallSiteIdx = ~0U;
 228   for (DSCallSiteIterator I = DSCallSiteIterator::begin(TempFCs),
 229          E = DSCallSiteIterator::end(TempFCs); I != E; ++I) {
 230     // If we skipped over any call sites, they must be unresolvable, copy them
 231     // to the real call site list.
 232     LastCallSiteIdx++;
 233     for (; LastCallSiteIdx < I.getCallSiteIdx(); ++LastCallSiteIdx)
 234       AuxCallsList.push_back(TempFCs[LastCallSiteIdx]);
 235     LastCallSiteIdx = I.getCallSiteIdx();
 236
 237     // Resolve the current call...
 238     Function *Callee = *I;
 239     DSCallSite CS = I.getCallSite();
 240
 241     if (Callee->isExternal()) {
 242       // Ignore this case, simple varargs functions we cannot stub out!
 243     } else if (ReturnNodes.find(Callee) != ReturnNodes.end()) {
 244       // Self recursion... simply link up the formal arguments with the
 245       // actual arguments...
 246       DEBUG(std::cerr << "    Self Inlining: " << Callee->getName() << "\n");
 247
 248       // Handle self recursion by resolving the arguments and return value
 249       Graph.mergeInGraph(CS, *Callee, Graph, 0);
 250
 251     } else {
 252       ActualCallees.insert(std::make_pair(&CS.getCallInst(), Callee));
 253
 254       // Get the data structure graph for the called function.
 255       //
 256       DSGraph &GI = getDSGraph(*Callee);  // Graph to inline
 257
 258       DEBUG(std::cerr << "    Inlining graph for " << Callee->getName()
 259             << "[" << GI.getGraphSize() << "+"
 260             << GI.getAuxFunctionCalls().size() << "] into '"
 261             << Graph.getFunctionNames() << "' [" << Graph.getGraphSize() << "+"
 262             << Graph.getAuxFunctionCalls().size() << "]\n");
 263
 264       // Handle self recursion by resolving the arguments and return value
 265       Graph.mergeInGraph(CS, *Callee, GI,
 266                          DSGraph::KeepModRefBits |
 267                          DSGraph::StripAllocaBit | DSGraph::DontCloneCallNodes);
 268       ++NumBUInlines;
 269
 270 #if 0
 271       Graph.writeGraphToFile(std::cerr, "bu_" + F.getName() + "_after_" +
 272                              Callee->getName());
 273 #endif
 274     }
 275   }
 276
 277   // Make sure to catch any leftover unresolvable calls...
 278   for (++LastCallSiteIdx; LastCallSiteIdx < TempFCs.size(); ++LastCallSiteIdx)
 279     AuxCallsList.push_back(TempFCs[LastCallSiteIdx]);
 280
 281   TempFCs.clear();
 282
 283   // Recompute the Incomplete markers.  If there are any function calls left
 284   // now that are complete, we must loop!
 285   Graph.maskIncompleteMarkers();
 286   Graph.markIncompleteNodes(DSGraph::MarkFormalArgs);
 287   // FIXME: materialize nodes from the globals graph as neccesary...
 288   Graph.removeDeadNodes(DSGraph::KeepUnreachableGlobals);
 289
 290   //Graph.writeGraphToFile(std::cerr, "bu_" + F.getName());
 291 }
 292