lib/Analysis/DataStructure/BottomUpClosure.cpp

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