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