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/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->removeTriviallyDeadNodes();
  67   GlobalsGraph->maskIncompleteMarkers();
  68   return false;
  69 }
  70
  71 void BUDataStructures::calculateReachableGraphs(Function *F) {
  72   std::vector<Function*> Stack;
  73   hash_map<Function*, unsigned> ValMap;
  74   unsigned NextID = 1;
  75   calculateGraphs(F, Stack, NextID, ValMap);
  76 }
  77
  78 DSGraph &BUDataStructures::getOrCreateGraph(Function *F) {
  79   // Has the graph already been created?
  80   DSGraph *&Graph = DSInfo[F];
  81   if (Graph) return *Graph;
  82
  83   // Copy the local version into DSInfo...
  84   Graph = new DSGraph(getAnalysis<LocalDataStructures>().getDSGraph(*F));
  85
  86   Graph->setGlobalsGraph(GlobalsGraph);
  87   Graph->setPrintAuxCalls();
  88
  89   // Start with a copy of the original call sites...
  90   Graph->getAuxFunctionCalls() = Graph->getFunctionCalls();
  91   return *Graph;
  92 }
  93
  94 unsigned BUDataStructures::calculateGraphs(Function *F,
  95                                            std::vector<Function*> &Stack,
  96                                            unsigned &NextID,
  97                                      hash_map<Function*, unsigned> &ValMap) {
  98   assert(!ValMap.count(F) && "Shouldn't revisit functions!");
  99   unsigned Min = NextID++, MyID = Min;
 100   ValMap[F] = Min;
 101   Stack.push_back(F);
 102
 103   // FIXME!  This test should be generalized to be any function that we have
 104   // already processed, in the case when there isn't a main or there are
 105   // unreachable functions!
 106   if (F->isExternal()) {   // sprintf, fprintf, sscanf, etc...
 107     // No callees!
 108     Stack.pop_back();
 109     ValMap[F] = ~0;
 110     return Min;
 111   }
 112
 113   DSGraph &Graph = getOrCreateGraph(F);
 114
 115   // The edges out of the current node are the call site targets...
 116   for (DSCallSiteIterator I = DSCallSiteIterator::begin_aux(Graph),
 117          E = DSCallSiteIterator::end_aux(Graph); I != E; ++I) {
 118     Function *Callee = *I;
 119     unsigned M;
 120     // Have we visited the destination function yet?
 121     hash_map<Function*, unsigned>::iterator It = ValMap.find(Callee);
 122     if (It == ValMap.end())  // No, visit it now.
 123       M = calculateGraphs(Callee, Stack, NextID, ValMap);
 124     else                    // Yes, get it's number.
 125       M = It->second;
 126     if (M < Min) Min = M;
 127   }
 128
 129   assert(ValMap[F] == MyID && "SCC construction assumption wrong!");
 130   if (Min != MyID)
 131     return Min;         // This is part of a larger SCC!
 132
 133   // If this is a new SCC, process it now.
 134   if (Stack.back() == F) {           // Special case the single "SCC" case here.
 135     DEBUG(std::cerr << "Visiting single node SCC #: " << MyID << " fn: "
 136                     << F->getName() << "\n");
 137     Stack.pop_back();
 138     DSGraph &G = getDSGraph(*F);
 139     DEBUG(std::cerr << "  [BU] Calculating graph for: " << F->getName()<< "\n");
 140     calculateGraph(G);
 141     DEBUG(std::cerr << "  [BU] Done inlining: " << F->getName() << " ["
 142                     << G.getGraphSize() << "+" << G.getAuxFunctionCalls().size()
 143                     << "]\n");
 144
 145     if (MaxSCC < 1) MaxSCC = 1;
 146
 147     // Should we revisit the graph?
 148     if (DSCallSiteIterator::begin_aux(G) != DSCallSiteIterator::end_aux(G)) {
 149       ValMap.erase(F);
 150       return calculateGraphs(F, Stack, NextID, ValMap);
 151     } else {
 152       ValMap[F] = ~0U;
 153     }
 154     return MyID;
 155
 156   } else {
 157     // SCCFunctions - Keep track of the functions in the current SCC
 158     //
 159     hash_set<DSGraph*> SCCGraphs;
 160
 161     Function *NF;
 162     std::vector<Function*>::iterator FirstInSCC = Stack.end();
 163     DSGraph *SCCGraph = 0;
 164     do {
 165       NF = *--FirstInSCC;
 166       ValMap[NF] = ~0U;
 167
 168       // Figure out which graph is the largest one, in order to speed things up
 169       // a bit in situations where functions in the SCC have widely different
 170       // graph sizes.
 171       DSGraph &NFGraph = getDSGraph(*NF);
 172       SCCGraphs.insert(&NFGraph);
 173       // FIXME: If we used a better way of cloning graphs (ie, just splice all
 174       // of the nodes into the new graph), this would be completely unneeded!
 175       if (!SCCGraph || SCCGraph->getGraphSize() < NFGraph.getGraphSize())
 176         SCCGraph = &NFGraph;
 177     } while (NF != F);
 178
 179     std::cerr << "Calculating graph for SCC #: " << MyID << " of size: "
 180               << SCCGraphs.size() << "\n";
 181
 182     // Compute the Max SCC Size...
 183     if (MaxSCC < SCCGraphs.size())
 184       MaxSCC = SCCGraphs.size();
 185
 186     // First thing first, collapse all of the DSGraphs into a single graph for
 187     // the entire SCC.  We computed the largest graph, so clone all of the other
 188     // (smaller) graphs into it.  Discard all of the old graphs.
 189     //
 190     for (hash_set<DSGraph*>::iterator I = SCCGraphs.begin(),
 191            E = SCCGraphs.end(); I != E; ++I) {
 192       DSGraph &G = **I;
 193       if (&G != SCCGraph) {
 194         {
 195           DSGraph::NodeMapTy NodeMap;
 196           SCCGraph->cloneInto(G, SCCGraph->getScalarMap(),
 197                               SCCGraph->getReturnNodes(), NodeMap);
 198         }
 199         // Update the DSInfo map and delete the old graph...
 200         for (DSGraph::ReturnNodesTy::iterator I = G.getReturnNodes().begin(),
 201                E = G.getReturnNodes().end(); I != E; ++I)
 202           DSInfo[I->first] = SCCGraph;
 203         delete &G;
 204       }
 205     }
 206
 207     // Clean up the graph before we start inlining a bunch again...
 208     SCCGraph->removeDeadNodes(DSGraph::RemoveUnreachableGlobals);
 209
 210     // Now that we have one big happy family, resolve all of the call sites in
 211     // the graph...
 212     calculateGraph(*SCCGraph);
 213     DEBUG(std::cerr << "  [BU] Done inlining SCC  [" << SCCGraph->getGraphSize()
 214                     << "+" << SCCGraph->getAuxFunctionCalls().size() << "]\n");
 215
 216     std::cerr << "DONE with SCC #: " << MyID << "\n";
 217
 218     // We never have to revisit "SCC" processed functions...
 219
 220     // Drop the stuff we don't need from the end of the stack
 221     Stack.erase(FirstInSCC, Stack.end());
 222     return MyID;
 223   }
 224
 225   return MyID;  // == Min
 226 }
 227
 228
 229 // releaseMemory - If the pass pipeline is done with this pass, we can release
 230 // our memory... here...
 231 //
 232 void BUDataStructures::releaseMemory() {
 233   for (hash_map<Function*, DSGraph*>::iterator I = DSInfo.begin(),
 234          E = DSInfo.end(); I != E; ++I) {
 235     I->second->getReturnNodes().erase(I->first);
 236     if (I->second->getReturnNodes().empty())
 237       delete I->second;
 238   }
 239
 240   // Empty map so next time memory is released, data structures are not
 241   // re-deleted.
 242   DSInfo.clear();
 243   delete GlobalsGraph;
 244   GlobalsGraph = 0;
 245 }
 246
 247 void BUDataStructures::calculateGraph(DSGraph &Graph) {
 248   // Move our call site list into TempFCs so that inline call sites go into the
 249   // new call site list and doesn't invalidate our iterators!
 250   std::vector<DSCallSite> TempFCs;
 251   std::vector<DSCallSite> &AuxCallsList = Graph.getAuxFunctionCalls();
 252   TempFCs.swap(AuxCallsList);
 253
 254   DSGraph::ReturnNodesTy &ReturnNodes = Graph.getReturnNodes();
 255
 256   // Loop over all of the resolvable call sites
 257   unsigned LastCallSiteIdx = ~0U;
 258   for (DSCallSiteIterator I = DSCallSiteIterator::begin(TempFCs),
 259          E = DSCallSiteIterator::end(TempFCs); I != E; ++I) {
 260     // If we skipped over any call sites, they must be unresolvable, copy them
 261     // to the real call site list.
 262     LastCallSiteIdx++;
 263     for (; LastCallSiteIdx < I.getCallSiteIdx(); ++LastCallSiteIdx)
 264       AuxCallsList.push_back(TempFCs[LastCallSiteIdx]);
 265     LastCallSiteIdx = I.getCallSiteIdx();
 266
 267     // Resolve the current call...
 268     Function *Callee = *I;
 269     DSCallSite CS = I.getCallSite();
 270
 271     if (Callee->isExternal()) {
 272       // Ignore this case, simple varargs functions we cannot stub out!
 273     } else if (ReturnNodes.count(Callee)) {
 274       // Self recursion... simply link up the formal arguments with the
 275       // actual arguments...
 276       DEBUG(std::cerr << "    Self Inlining: " << Callee->getName() << "\n");
 277
 278       // Handle self recursion by resolving the arguments and return value
 279       Graph.mergeInGraph(CS, *Callee, Graph, 0);
 280
 281     } else {
 282       ActualCallees.insert(std::make_pair(CS.getCallSite().getInstruction(),
 283                                           Callee));
 284
 285       // Get the data structure graph for the called function.
 286       //
 287       DSGraph &GI = getDSGraph(*Callee);  // Graph to inline
 288
 289       DEBUG(std::cerr << "    Inlining graph for " << Callee->getName()
 290             << "[" << GI.getGraphSize() << "+"
 291             << GI.getAuxFunctionCalls().size() << "] into '"
 292             << Graph.getFunctionNames() << "' [" << Graph.getGraphSize() << "+"
 293             << Graph.getAuxFunctionCalls().size() << "]\n");
 294       Graph.mergeInGraph(CS, *Callee, GI,
 295                          DSGraph::KeepModRefBits |
 296                          DSGraph::StripAllocaBit | DSGraph::DontCloneCallNodes);
 297       ++NumBUInlines;
 298
 299 #if 0
 300       Graph.writeGraphToFile(std::cerr, "bu_" + F.getName() + "_after_" +
 301                              Callee->getName());
 302 #endif
 303     }
 304   }
 305
 306   // Make sure to catch any leftover unresolvable calls...
 307   for (++LastCallSiteIdx; LastCallSiteIdx < TempFCs.size(); ++LastCallSiteIdx)
 308     AuxCallsList.push_back(TempFCs[LastCallSiteIdx]);
 309
 310   TempFCs.clear();
 311
 312   // Recompute the Incomplete markers
 313   assert(Graph.getInlinedGlobals().empty());
 314   Graph.maskIncompleteMarkers();
 315   Graph.markIncompleteNodes(DSGraph::MarkFormalArgs);
 316
 317   // Delete dead nodes.  Treat globals that are unreachable but that can
 318   // reach live nodes as live.
 319   Graph.removeDeadNodes(DSGraph::KeepUnreachableGlobals);
 320
 321   // When this graph is finalized, clone the globals in the graph into the
 322   // globals graph to make sure it has everything, from all graphs.
 323   DSScalarMap &MainSM = Graph.getScalarMap();
 324   ReachabilityCloner RC(*GlobalsGraph, Graph, DSGraph::StripAllocaBit);
 325
 326   // Clone everything reachable from globals in the "main" graph into the
 327   // globals graph.
 328   for (DSScalarMap::global_iterator I = MainSM.global_begin(),
 329          E = MainSM.global_end(); I != E; ++I)
 330     RC.getClonedNH(MainSM[*I]);
 331
 332   //Graph.writeGraphToFile(std::cerr, "bu_" + F.getName());
 333 }