lib/Analysis/DataStructure/TopDownClosure.cpp

   1 //===- TopDownClosure.cpp - Compute the top-down interprocedure 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 TDDataStructures class, which represents the
  11 // Top-down Interprocedural closure of the data structure graph over the
  12 // program.  This is useful (but not strictly necessary?) for applications
  13 // like pointer analysis.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "llvm/Analysis/DataStructure.h"
  18 #include "llvm/Module.h"
  19 #include "llvm/DerivedTypes.h"
  20 #include "llvm/Analysis/DSGraph.h"
  21 #include "Support/Debug.h"
  22 #include "Support/Statistic.h"
  23 using namespace llvm;
  24
  25 namespace {
  26   RegisterAnalysis<TDDataStructures>   // Register the pass
  27   Y("tddatastructure", "Top-down Data Structure Analysis");
  28
  29   Statistic<> NumTDInlines("tddatastructures", "Number of graphs inlined");
  30 }
  31
  32 void TDDataStructures::markReachableFunctionsExternallyAccessible(DSNode *N,
  33                                                    hash_set<DSNode*> &Visited) {
  34   if (!N || Visited.count(N)) return;
  35   Visited.insert(N);
  36
  37   for (unsigned i = 0, e = N->getNumLinks(); i != e; ++i) {
  38     DSNodeHandle &NH = N->getLink(i*N->getPointerSize());
  39     if (DSNode *NN = NH.getNode()) {
  40       const std::vector<GlobalValue*> &Globals = NN->getGlobals();
  41       for (unsigned G = 0, e = Globals.size(); G != e; ++G)
  42         if (Function *F = dyn_cast<Function>(Globals[G]))
  43           ArgsRemainIncomplete.insert(F);
  44
  45       markReachableFunctionsExternallyAccessible(NN, Visited);
  46     }
  47   }
  48 }
  49
  50
  51 // run - Calculate the top down data structure graphs for each function in the
  52 // program.
  53 //
  54 bool TDDataStructures::run(Module &M) {
  55   BUDataStructures &BU = getAnalysis<BUDataStructures>();
  56   GlobalsGraph = new DSGraph(BU.getGlobalsGraph());
  57   GlobalsGraph->setPrintAuxCalls();
  58
  59   // Figure out which functions must not mark their arguments complete because
  60   // they are accessible outside this compilation unit.  Currently, these
  61   // arguments are functions which are reachable by global variables in the
  62   // globals graph.
  63   const DSGraph::ScalarMapTy &GGSM = GlobalsGraph->getScalarMap();
  64   hash_set<DSNode*> Visited;
  65   for (DSScalarMap::global_iterator I = GGSM.global_begin(), E = GGSM.global_end();
  66        I != E; ++I)
  67     markReachableFunctionsExternallyAccessible(GGSM.find(*I)->second.getNode(), Visited);
  68
  69   // Loop over unresolved call nodes.  Any functions passed into (but not
  70   // returned!) from unresolvable call nodes may be invoked outside of the
  71   // current module.
  72   const std::vector<DSCallSite> &Calls = GlobalsGraph->getAuxFunctionCalls();
  73   for (unsigned i = 0, e = Calls.size(); i != e; ++i) {
  74     const DSCallSite &CS = Calls[i];
  75     for (unsigned arg = 0, e = CS.getNumPtrArgs(); arg != e; ++arg)
  76       markReachableFunctionsExternallyAccessible(CS.getPtrArg(arg).getNode(),
  77                                                  Visited);
  78   }
  79   Visited.clear();
  80
  81   // Functions without internal linkage also have unknown incoming arguments!
  82   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
  83     if (!I->isExternal() && !I->hasInternalLinkage())
  84       ArgsRemainIncomplete.insert(I);
  85
  86   // We want to traverse the call graph in reverse post-order.  To do this, we
  87   // calculate a post-order traversal, then reverse it.
  88   hash_set<DSGraph*> VisitedGraph;
  89   std::vector<DSGraph*> PostOrder;
  90   const BUDataStructures::ActualCalleesTy &ActualCallees =
  91     getAnalysis<BUDataStructures>().getActualCallees();
  92
  93   // Calculate top-down from main...
  94   if (Function *F = M.getMainFunction())
  95     ComputePostOrder(*F, VisitedGraph, PostOrder, ActualCallees);
  96
  97   // Next calculate the graphs for each unreachable function...
  98   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
  99     ComputePostOrder(*I, VisitedGraph, PostOrder, ActualCallees);
 100
 101   VisitedGraph.clear();   // Release memory!
 102
 103   // Visit each of the graphs in reverse post-order now!
 104   while (!PostOrder.empty()) {
 105     inlineGraphIntoCallees(*PostOrder.back());
 106     PostOrder.pop_back();
 107   }
 108
 109   ArgsRemainIncomplete.clear();
 110   return false;
 111 }
 112
 113
 114 DSGraph &TDDataStructures::getOrCreateDSGraph(Function &F) {
 115   DSGraph *&G = DSInfo[&F];
 116   if (G == 0) { // Not created yet?  Clone BU graph...
 117     G = new DSGraph(getAnalysis<BUDataStructures>().getDSGraph(F));
 118     G->getAuxFunctionCalls().clear();
 119     G->setPrintAuxCalls();
 120     G->setGlobalsGraph(GlobalsGraph);
 121   }
 122   return *G;
 123 }
 124
 125
 126 void TDDataStructures::ComputePostOrder(Function &F,hash_set<DSGraph*> &Visited,
 127                                         std::vector<DSGraph*> &PostOrder,
 128                       const BUDataStructures::ActualCalleesTy &ActualCallees) {
 129   if (F.isExternal()) return;
 130   DSGraph &G = getOrCreateDSGraph(F);
 131   if (Visited.count(&G)) return;
 132   Visited.insert(&G);
 133
 134   // Recursively traverse all of the callee graphs.
 135   const std::vector<DSCallSite> &FunctionCalls = G.getFunctionCalls();
 136
 137   for (unsigned i = 0, e = FunctionCalls.size(); i != e; ++i) {
 138     Instruction *CallI = FunctionCalls[i].getCallSite().getInstruction();
 139     std::pair<BUDataStructures::ActualCalleesTy::const_iterator,
 140       BUDataStructures::ActualCalleesTy::const_iterator>
 141          IP = ActualCallees.equal_range(CallI);
 142
 143     for (BUDataStructures::ActualCalleesTy::const_iterator I = IP.first;
 144          I != IP.second; ++I)
 145       ComputePostOrder(*I->second, Visited, PostOrder, ActualCallees);
 146   }
 147
 148   PostOrder.push_back(&G);
 149 }
 150
 151
 152
 153
 154
 155 // releaseMemory - If the pass pipeline is done with this pass, we can release
 156 // our memory... here...
 157 //
 158 // FIXME: This should be releaseMemory and will work fine, except that LoadVN
 159 // has no way to extend the lifetime of the pass, which screws up ds-aa.
 160 //
 161 void TDDataStructures::releaseMyMemory() {
 162   for (hash_map<Function*, DSGraph*>::iterator I = DSInfo.begin(),
 163          E = DSInfo.end(); I != E; ++I) {
 164     I->second->getReturnNodes().erase(I->first);
 165     if (I->second->getReturnNodes().empty())
 166       delete I->second;
 167   }
 168
 169   // Empty map so next time memory is released, data structures are not
 170   // re-deleted.
 171   DSInfo.clear();
 172   delete GlobalsGraph;
 173   GlobalsGraph = 0;
 174 }
 175
 176 void TDDataStructures::inlineGraphIntoCallees(DSGraph &Graph) {
 177   // Recompute the Incomplete markers and eliminate unreachable nodes.
 178   Graph.removeTriviallyDeadNodes();
 179   Graph.maskIncompleteMarkers();
 180
 181   // If any of the functions has incomplete incoming arguments, don't mark any
 182   // of them as complete.
 183   bool HasIncompleteArgs = false;
 184   const DSGraph::ReturnNodesTy &GraphReturnNodes = Graph.getReturnNodes();
 185   for (DSGraph::ReturnNodesTy::const_iterator I = GraphReturnNodes.begin(),
 186          E = GraphReturnNodes.end(); I != E; ++I)
 187     if (ArgsRemainIncomplete.count(I->first)) {
 188       HasIncompleteArgs = true;
 189       break;
 190     }
 191
 192   // Now fold in the necessary globals from the GlobalsGraph.  A global G
 193   // must be folded in if it exists in the current graph (i.e., is not dead)
 194   // and it was not inlined from any of my callers.  If it was inlined from
 195   // a caller, it would have been fully consistent with the GlobalsGraph
 196   // in the caller so folding in is not necessary.  Otherwise, this node came
 197   // solely from this function's BU graph and so has to be made consistent.
 198   //
 199   Graph.updateFromGlobalGraph();
 200
 201   // Recompute the Incomplete markers.  Depends on whether args are complete
 202   unsigned Flags
 203     = HasIncompleteArgs ? DSGraph::MarkFormalArgs : DSGraph::IgnoreFormalArgs;
 204   Graph.markIncompleteNodes(Flags | DSGraph::IgnoreGlobals);
 205
 206   // Delete dead nodes.  Treat globals that are unreachable as dead also.
 207   Graph.removeDeadNodes(DSGraph::RemoveUnreachableGlobals);
 208
 209   // We are done with computing the current TD Graph! Now move on to
 210   // inlining the current graph into the graphs for its callees, if any.
 211   //
 212   const std::vector<DSCallSite> &FunctionCalls = Graph.getFunctionCalls();
 213   if (FunctionCalls.empty()) {
 214     DEBUG(std::cerr << "  [TD] No callees for: " << Graph.getFunctionNames()
 215                     << "\n");
 216     return;
 217   }
 218
 219   // Now that we have information about all of the callees, propagate the
 220   // current graph into the callees.  Clone only the reachable subgraph at
 221   // each call-site, not the entire graph (even though the entire graph
 222   // would be cloned only once, this should still be better on average).
 223   //
 224   DEBUG(std::cerr << "  [TD] Inlining '" << Graph.getFunctionNames() <<"' into "
 225                   << FunctionCalls.size() << " call nodes.\n");
 226
 227   const BUDataStructures::ActualCalleesTy &ActualCallees =
 228     getAnalysis<BUDataStructures>().getActualCallees();
 229
 230   // Loop over all the call sites and all the callees at each call site.  Build
 231   // a mapping from called DSGraph's to the call sites in this function that
 232   // invoke them.  This is useful because we can be more efficient if there are
 233   // multiple call sites to the callees in the graph from this caller.
 234   std::multimap<DSGraph*, std::pair<Function*, const DSCallSite*> > CallSites;
 235
 236   for (unsigned i = 0, e = FunctionCalls.size(); i != e; ++i) {
 237     Instruction *CallI = FunctionCalls[i].getCallSite().getInstruction();
 238     // For each function in the invoked function list at this call site...
 239     std::pair<BUDataStructures::ActualCalleesTy::const_iterator,
 240       BUDataStructures::ActualCalleesTy::const_iterator>
 241           IP = ActualCallees.equal_range(CallI);
 242     // Loop over each actual callee at this call site
 243     for (BUDataStructures::ActualCalleesTy::const_iterator I = IP.first;
 244          I != IP.second; ++I) {
 245       DSGraph& CalleeGraph = getDSGraph(*I->second);
 246       assert(&CalleeGraph != &Graph && "TD need not inline graph into self!");
 247
 248       CallSites.insert(std::make_pair(&CalleeGraph,
 249                            std::make_pair(I->second, &FunctionCalls[i])));
 250     }
 251   }
 252
 253   // Now that we built the mapping, actually perform the inlining a callee graph
 254   // at a time.
 255   std::multimap<DSGraph*,std::pair<Function*,const DSCallSite*> >::iterator CSI;
 256   for (CSI = CallSites.begin(); CSI != CallSites.end(); ) {
 257     DSGraph &CalleeGraph = *CSI->first;
 258     // Iterate through all of the call sites of this graph, cloning and merging
 259     // any nodes required by the call.
 260     ReachabilityCloner RC(CalleeGraph, Graph, DSGraph::StripModRefBits);
 261
 262     // Clone over any global nodes that appear in both graphs.
 263     for (DSGraph::ScalarMapTy::const_iterator
 264            SI = CalleeGraph.getScalarMap().begin(),
 265            SE = CalleeGraph.getScalarMap().end(); SI != SE; ++SI)
 266       if (GlobalValue *GV = dyn_cast<GlobalValue>(SI->first)) {
 267         DSGraph::ScalarMapTy::const_iterator GI = Graph.getScalarMap().find(GV);
 268         if (GI != Graph.getScalarMap().end())
 269           RC.merge(SI->second, GI->second);
 270       }
 271
 272     // Loop over all of the distinct call sites in the caller of the callee.
 273     for (; CSI != CallSites.end() && CSI->first == &CalleeGraph; ++CSI) {
 274       Function &CF = *CSI->second.first;
 275       const DSCallSite &CS = *CSI->second.second;
 276       DEBUG(std::cerr << "     [TD] Resolving arguments for callee graph '"
 277             << CalleeGraph.getFunctionNames()
 278             << "': " << CF.getFunctionType()->getNumParams()
 279             << " args\n          at call site (DSCallSite*) 0x" << &CS << "\n");
 280
 281       // Get the formal argument and return nodes for the called function and
 282       // merge them with the cloned subgraph.
 283       RC.mergeCallSite(CalleeGraph.getCallSiteForArguments(CF), CS);
 284       ++NumTDInlines;
 285     }
 286   }
 287
 288   DEBUG(std::cerr << "  [TD] Done inlining into callees for: "
 289         << Graph.getFunctionNames() << " [" << Graph.getGraphSize() << "+"
 290         << Graph.getFunctionCalls().size() << "]\n");
 291 }