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 (DSGraph::ScalarMapTy::const_iterator I = GGSM.begin(), E = GGSM.end();
  66        I != E; ++I)
  67     if (isa<GlobalValue>(I->first))
  68       markReachableFunctionsExternallyAccessible(I->second.getNode(), Visited);
  69
  70   // Loop over unresolved call nodes.  Any functions passed into (but not
  71   // returned!?) from unresolvable call nodes may be invoked outside of the
  72   // current module.
  73   const std::vector<DSCallSite> &Calls = GlobalsGraph->getAuxFunctionCalls();
  74   for (unsigned i = 0, e = Calls.size(); i != e; ++i) {
  75     const DSCallSite &CS = Calls[i];
  76     for (unsigned arg = 0, e = CS.getNumPtrArgs(); arg != e; ++arg)
  77       markReachableFunctionsExternallyAccessible(CS.getPtrArg(arg).getNode(),
  78                                                  Visited);
  79   }
  80   Visited.clear();
  81
  82   // Functions without internal linkage also have unknown incoming arguments!
  83   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
  84     if (!I->isExternal() && !I->hasInternalLinkage())
  85       ArgsRemainIncomplete.insert(I);
  86
  87   // We want to traverse the call graph in reverse post-order.  To do this, we
  88   // calculate a post-order traversal, then reverse it.
  89   hash_set<DSGraph*> VisitedGraph;
  90   std::vector<DSGraph*> PostOrder;
  91   const BUDataStructures::ActualCalleesTy &ActualCallees =
  92     getAnalysis<BUDataStructures>().getActualCallees();
  93
  94   // Calculate top-down from main...
  95   if (Function *F = M.getMainFunction())
  96     ComputePostOrder(*F, VisitedGraph, PostOrder, ActualCallees);
  97
  98   // Next calculate the graphs for each unreachable function...
  99   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 100     ComputePostOrder(*I, VisitedGraph, PostOrder, ActualCallees);
 101
 102   VisitedGraph.clear();   // Release memory!
 103
 104   // Visit each of the graphs in reverse post-order now!
 105   while (!PostOrder.empty()) {
 106     inlineGraphIntoCallees(*PostOrder.back());
 107     PostOrder.pop_back();
 108   }
 109
 110   ArgsRemainIncomplete.clear();
 111   return false;
 112 }
 113
 114
 115 DSGraph &TDDataStructures::getOrCreateDSGraph(Function &F) {
 116   DSGraph *&G = DSInfo[&F];
 117   if (G == 0) { // Not created yet?  Clone BU graph...
 118     G = new DSGraph(getAnalysis<BUDataStructures>().getDSGraph(F));
 119     G->getAuxFunctionCalls().clear();
 120     G->setPrintAuxCalls();
 121     G->setGlobalsGraph(GlobalsGraph);
 122   }
 123   return *G;
 124 }
 125
 126
 127 void TDDataStructures::ComputePostOrder(Function &F,hash_set<DSGraph*> &Visited,
 128                                         std::vector<DSGraph*> &PostOrder,
 129                       const BUDataStructures::ActualCalleesTy &ActualCallees) {
 130   if (F.isExternal()) return;
 131   DSGraph &G = getOrCreateDSGraph(F);
 132   if (Visited.count(&G)) return;
 133   Visited.insert(&G);
 134
 135   // Recursively traverse all of the callee graphs.
 136   const std::vector<DSCallSite> &FunctionCalls = G.getFunctionCalls();
 137
 138   for (unsigned i = 0, e = FunctionCalls.size(); i != e; ++i) {
 139     Instruction *CallI = FunctionCalls[i].getCallSite().getInstruction();
 140     std::pair<BUDataStructures::ActualCalleesTy::const_iterator,
 141       BUDataStructures::ActualCalleesTy::const_iterator>
 142          IP = ActualCallees.equal_range(CallI);
 143
 144     for (BUDataStructures::ActualCalleesTy::const_iterator I = IP.first;
 145          I != IP.second; ++I)
 146       ComputePostOrder(*I->second, Visited, PostOrder, ActualCallees);
 147   }
 148
 149   PostOrder.push_back(&G);
 150 }
 151
 152
 153
 154
 155
 156 // releaseMemory - If the pass pipeline is done with this pass, we can release
 157 // our memory... here...
 158 //
 159 // FIXME: This should be releaseMemory and will work fine, except that LoadVN
 160 // has no way to extend the lifetime of the pass, which screws up ds-aa.
 161 //
 162 void TDDataStructures::releaseMyMemory() {
 163   for (hash_map<Function*, DSGraph*>::iterator I = DSInfo.begin(),
 164          E = DSInfo.end(); I != E; ++I) {
 165     I->second->getReturnNodes().erase(I->first);
 166     if (I->second->getReturnNodes().empty())
 167       delete I->second;
 168   }
 169
 170   // Empty map so next time memory is released, data structures are not
 171   // re-deleted.
 172   DSInfo.clear();
 173   delete GlobalsGraph;
 174   GlobalsGraph = 0;
 175 }
 176
 177 void TDDataStructures::inlineGraphIntoCallees(DSGraph &Graph) {
 178   // Recompute the Incomplete markers and eliminate unreachable nodes.
 179   Graph.removeTriviallyDeadNodes();
 180   Graph.maskIncompleteMarkers();
 181
 182   // If any of the functions has incomplete incoming arguments, don't mark any
 183   // of them as complete.
 184   bool HasIncompleteArgs = false;
 185   const DSGraph::ReturnNodesTy &GraphReturnNodes = Graph.getReturnNodes();
 186   for (DSGraph::ReturnNodesTy::const_iterator I = GraphReturnNodes.begin(),
 187          E = GraphReturnNodes.end(); I != E; ++I)
 188     if (ArgsRemainIncomplete.count(I->first)) {
 189       HasIncompleteArgs = true;
 190       break;
 191     }
 192
 193   // Now fold in the necessary globals from the GlobalsGraph.  A global G
 194   // must be folded in if it exists in the current graph (i.e., is not dead)
 195   // and it was not inlined from any of my callers.  If it was inlined from
 196   // a caller, it would have been fully consistent with the GlobalsGraph
 197   // in the caller so folding in is not necessary.  Otherwise, this node came
 198   // solely from this function's BU graph and so has to be made consistent.
 199   //
 200   Graph.updateFromGlobalGraph();
 201
 202   // Recompute the Incomplete markers.  Depends on whether args are complete
 203   unsigned Flags
 204     = HasIncompleteArgs ? DSGraph::MarkFormalArgs : DSGraph::IgnoreFormalArgs;
 205   Graph.markIncompleteNodes(Flags | DSGraph::IgnoreGlobals);
 206
 207   // Delete dead nodes.  Treat globals that are unreachable as dead also.
 208   Graph.removeDeadNodes(DSGraph::RemoveUnreachableGlobals);
 209
 210   // We are done with computing the current TD Graph! Now move on to
 211   // inlining the current graph into the graphs for its callees, if any.
 212   //
 213   const std::vector<DSCallSite> &FunctionCalls = Graph.getFunctionCalls();
 214   if (FunctionCalls.empty()) {
 215     DEBUG(std::cerr << "  [TD] No callees for: " << Graph.getFunctionNames()
 216                     << "\n");
 217     return;
 218   }
 219
 220   // Now that we have information about all of the callees, propagate the
 221   // current graph into the callees.  Clone only the reachable subgraph at
 222   // each call-site, not the entire graph (even though the entire graph
 223   // would be cloned only once, this should still be better on average).
 224   //
 225   DEBUG(std::cerr << "  [TD] Inlining '" << Graph.getFunctionNames() <<"' into "
 226                   << FunctionCalls.size() << " call nodes.\n");
 227
 228   const BUDataStructures::ActualCalleesTy &ActualCallees =
 229     getAnalysis<BUDataStructures>().getActualCallees();
 230
 231   // Loop over all the call sites and all the callees at each call site.
 232   // Clone and merge the reachable subgraph from the call into callee's graph.
 233   //
 234   for (unsigned i = 0, e = FunctionCalls.size(); i != e; ++i) {
 235     Instruction *CallI = FunctionCalls[i].getCallSite().getInstruction();
 236     // For each function in the invoked function list at this call site...
 237     std::pair<BUDataStructures::ActualCalleesTy::const_iterator,
 238       BUDataStructures::ActualCalleesTy::const_iterator>
 239           IP = ActualCallees.equal_range(CallI);
 240
 241     // Multiple callees may have the same graph, so try to inline and merge
 242     // only once for each <callSite,calleeGraph> pair, not once for each
 243     // <callSite,calleeFunction> pair; the latter will be correct but slower.
 244     hash_set<DSGraph*> GraphsSeen;
 245
 246     // Loop over each actual callee at this call site
 247     for (BUDataStructures::ActualCalleesTy::const_iterator I = IP.first;
 248          I != IP.second; ++I) {
 249       DSGraph& CalleeGraph = getDSGraph(*I->second);
 250       assert(&CalleeGraph != &Graph && "TD need not inline graph into self!");
 251
 252       // if this callee graph is already done at this site, skip this callee
 253       if (GraphsSeen.find(&CalleeGraph) != GraphsSeen.end())
 254         continue;
 255       GraphsSeen.insert(&CalleeGraph);
 256
 257       // Get the root nodes for cloning the reachable subgraph into each callee:
 258       // -- all global nodes that appear in both the caller and the callee
 259       // -- return value at this call site, if any
 260       // -- actual arguments passed at this call site
 261       // -- callee node at this call site, if this is an indirect call (this may
 262       //    not be needed for merging, but allows us to create CS and therefore
 263       //    simplify the merging below).
 264       hash_set<const DSNode*> RootNodeSet;
 265       for (DSGraph::ScalarMapTy::const_iterator
 266              SI = CalleeGraph.getScalarMap().begin(),
 267              SE = CalleeGraph.getScalarMap().end(); SI != SE; ++SI)
 268         if (GlobalValue* GV = dyn_cast<GlobalValue>(SI->first)) {
 269           DSGraph::ScalarMapTy::const_iterator GI=Graph.getScalarMap().find(GV);
 270           if (GI != Graph.getScalarMap().end())
 271             RootNodeSet.insert(GI->second.getNode());
 272         }
 273
 274       if (const DSNode* RetNode = FunctionCalls[i].getRetVal().getNode())
 275         RootNodeSet.insert(RetNode);
 276
 277       for (unsigned j=0, N=FunctionCalls[i].getNumPtrArgs(); j < N; ++j)
 278         if (const DSNode* ArgTarget = FunctionCalls[i].getPtrArg(j).getNode())
 279           RootNodeSet.insert(ArgTarget);
 280
 281       if (FunctionCalls[i].isIndirectCall())
 282         RootNodeSet.insert(FunctionCalls[i].getCalleeNode());
 283
 284       DEBUG(std::cerr << "     [TD] Resolving arguments for callee graph '"
 285             << CalleeGraph.getFunctionNames()
 286             << "': " << I->second->getFunctionType()->getNumParams()
 287             << " args\n          at call site (DSCallSite*) 0x"
 288             << &FunctionCalls[i] << "\n");
 289
 290       DSGraph::NodeMapTy NodeMapInCallee; // map from nodes to clones in callee
 291       DSGraph::NodeMapTy CompletedMap;    // unused map for nodes not to do
 292       CalleeGraph.cloneReachableSubgraph(Graph, RootNodeSet,
 293                                          NodeMapInCallee, CompletedMap,
 294                                          DSGraph::StripModRefBits |
 295                                          DSGraph::KeepAllocaBit);
 296
 297       // Transform our call site info into the cloned version for CalleeGraph
 298       DSCallSite CS(FunctionCalls[i], NodeMapInCallee);
 299
 300       // Get the formal argument and return nodes for the called function
 301       // and merge them with the cloned subgraph.  Global nodes were merged
 302       // already by cloneReachableSubgraph() above.
 303       CalleeGraph.getCallSiteForArguments(*I->second).mergeWith(CS);
 304
 305       ++NumTDInlines;
 306     }
 307   }
 308
 309   DEBUG(std::cerr << "  [TD] Done inlining into callees for: "
 310         << Graph.getFunctionNames() << " [" << Graph.getGraphSize() << "+"
 311         << Graph.getFunctionCalls().size() << "]\n");
 312 }