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/DataStructure.h"
  18 #include "llvm/Module.h"
  19 #include "llvm/DerivedTypes.h"
  20 #include "llvm/Analysis/DataStructure/DSGraph.h"
  21 #include "llvm/Support/Debug.h"
  22 #include "llvm/ADT/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       std::vector<Function*> Functions;
  41       NN->addFullFunctionList(Functions);
  42       ArgsRemainIncomplete.insert(Functions.begin(), Functions.end());
  43       markReachableFunctionsExternallyAccessible(NN, Visited);
  44     }
  45   }
  46 }
  47
  48
  49 // run - Calculate the top down data structure graphs for each function in the
  50 // program.
  51 //
  52 bool TDDataStructures::runOnModule(Module &M) {
  53   BUDataStructures &BU = getAnalysis<BUDataStructures>();
  54   GlobalECs = BU.getGlobalECs();
  55   GlobalsGraph = new DSGraph(BU.getGlobalsGraph(), GlobalECs);
  56   GlobalsGraph->setPrintAuxCalls();
  57
  58   // Figure out which functions must not mark their arguments complete because
  59   // they are accessible outside this compilation unit.  Currently, these
  60   // arguments are functions which are reachable by global variables in the
  61   // globals graph.
  62   const DSScalarMap &GGSM = GlobalsGraph->getScalarMap();
  63   hash_set<DSNode*> Visited;
  64   for (DSScalarMap::global_iterator I=GGSM.global_begin(), E=GGSM.global_end();
  65        I != E; ++I)
  66     markReachableFunctionsExternallyAccessible(GGSM.find(*I)->second.getNode(),
  67                                                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   for (DSGraph::afc_iterator I = GlobalsGraph->afc_begin(),
  73          E = GlobalsGraph->afc_end(); I != E; ++I)
  74     for (unsigned arg = 0, e = I->getNumPtrArgs(); arg != e; ++arg)
  75       markReachableFunctionsExternallyAccessible(I->getPtrArg(arg).getNode(),
  76                                                  Visited);
  77   Visited.clear();
  78
  79   // Functions without internal linkage also have unknown incoming arguments!
  80   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
  81     if (!I->isExternal() && !I->hasInternalLinkage())
  82       ArgsRemainIncomplete.insert(I);
  83
  84   // We want to traverse the call graph in reverse post-order.  To do this, we
  85   // calculate a post-order traversal, then reverse it.
  86   hash_set<DSGraph*> VisitedGraph;
  87   std::vector<DSGraph*> PostOrder;
  88   const BUDataStructures::ActualCalleesTy &ActualCallees =
  89     getAnalysis<BUDataStructures>().getActualCallees();
  90
  91   // Calculate top-down from main...
  92   if (Function *F = M.getMainFunction())
  93     ComputePostOrder(*F, VisitedGraph, PostOrder, ActualCallees);
  94
  95   // Next calculate the graphs for each unreachable function...
  96   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
  97     ComputePostOrder(*I, VisitedGraph, PostOrder, ActualCallees);
  98
  99   VisitedGraph.clear();   // Release memory!
 100
 101   // Visit each of the graphs in reverse post-order now!
 102   while (!PostOrder.empty()) {
 103     InlineCallersIntoGraph(*PostOrder.back());
 104     PostOrder.pop_back();
 105   }
 106
 107   ArgsRemainIncomplete.clear();
 108   GlobalsGraph->removeTriviallyDeadNodes();
 109
 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), GlobalECs);
 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   for (DSGraph::fc_iterator CI = G.fc_begin(), E = G.fc_end(); CI != E; ++CI) {
 136     Instruction *CallI = CI->getCallSite().getInstruction();
 137     std::pair<BUDataStructures::ActualCalleesTy::const_iterator,
 138       BUDataStructures::ActualCalleesTy::const_iterator>
 139          IP = ActualCallees.equal_range(CallI);
 140
 141     for (BUDataStructures::ActualCalleesTy::const_iterator I = IP.first;
 142          I != IP.second; ++I)
 143       ComputePostOrder(*I->second, Visited, PostOrder, ActualCallees);
 144   }
 145
 146   PostOrder.push_back(&G);
 147 }
 148
 149
 150
 151
 152
 153 // releaseMemory - If the pass pipeline is done with this pass, we can release
 154 // our memory... here...
 155 //
 156 // FIXME: This should be releaseMemory and will work fine, except that LoadVN
 157 // has no way to extend the lifetime of the pass, which screws up ds-aa.
 158 //
 159 void TDDataStructures::releaseMyMemory() {
 160   for (hash_map<Function*, DSGraph*>::iterator I = DSInfo.begin(),
 161          E = DSInfo.end(); I != E; ++I) {
 162     I->second->getReturnNodes().erase(I->first);
 163     if (I->second->getReturnNodes().empty())
 164       delete I->second;
 165   }
 166
 167   // Empty map so next time memory is released, data structures are not
 168   // re-deleted.
 169   DSInfo.clear();
 170   delete GlobalsGraph;
 171   GlobalsGraph = 0;
 172 }
 173
 174 /// InlineCallersIntoGraph - Inline all of the callers of the specified DS graph
 175 /// into it, then recompute completeness of nodes in the resultant graph.
 176 void TDDataStructures::InlineCallersIntoGraph(DSGraph &DSG) {
 177   // Inline caller graphs into this graph.  First step, get the list of call
 178   // sites that call into this graph.
 179   std::vector<CallerCallEdge> EdgesFromCaller;
 180   std::map<DSGraph*, std::vector<CallerCallEdge> >::iterator
 181     CEI = CallerEdges.find(&DSG);
 182   if (CEI != CallerEdges.end()) {
 183     std::swap(CEI->second, EdgesFromCaller);
 184     CallerEdges.erase(CEI);
 185   }
 186
 187   // Sort the caller sites to provide a by-caller-graph ordering.
 188   std::sort(EdgesFromCaller.begin(), EdgesFromCaller.end());
 189
 190
 191   // Merge information from the globals graph into this graph.  FIXME: This is
 192   // stupid.  Instead of us cloning information from the GG into this graph,
 193   // then having RemoveDeadNodes clone it back, we should do all of this as a
 194   // post-pass over all of the graphs.  We need to take cloning out of
 195   // removeDeadNodes and gut removeDeadNodes at the same time first though. :(
 196   {
 197     DSGraph &GG = *DSG.getGlobalsGraph();
 198     ReachabilityCloner RC(DSG, GG,
 199                           DSGraph::DontCloneCallNodes |
 200                           DSGraph::DontCloneAuxCallNodes);
 201     for (DSScalarMap::global_iterator
 202            GI = DSG.getScalarMap().global_begin(),
 203            E = DSG.getScalarMap().global_end(); GI != E; ++GI)
 204       RC.getClonedNH(GG.getNodeForValue(*GI));
 205
 206
 207   }
 208
 209   DEBUG(std::cerr << "[TD] Inlining callers into '" << DSG.getFunctionNames()
 210         << "'\n");
 211
 212   // Iteratively inline caller graphs into this graph.
 213   while (!EdgesFromCaller.empty()) {
 214     DSGraph &CallerGraph = *EdgesFromCaller.back().CallerGraph;
 215
 216     // Iterate through all of the call sites of this graph, cloning and merging
 217     // any nodes required by the call.
 218     ReachabilityCloner RC(DSG, CallerGraph,
 219                           DSGraph::DontCloneCallNodes |
 220                           DSGraph::DontCloneAuxCallNodes);
 221
 222     // Inline all call sites from this caller graph.
 223     do {
 224       const DSCallSite &CS = *EdgesFromCaller.back().CS;
 225       Function &CF = *EdgesFromCaller.back().CalledFunction;
 226       DEBUG(std::cerr << "   [TD] Inlining graph for call to Fn '"
 227             << CF.getName() << "' from Fn '"
 228             << CS.getCallSite().getInstruction()->
 229                             getParent()->getParent()->getName()
 230             << "': " << CF.getFunctionType()->getNumParams()
 231             << " args\n");
 232
 233       // Get the formal argument and return nodes for the called function and
 234       // merge them with the cloned subgraph.
 235       RC.mergeCallSite(DSG.getCallSiteForArguments(CF), CS);
 236       ++NumTDInlines;
 237
 238       EdgesFromCaller.pop_back();
 239     } while (!EdgesFromCaller.empty() &&
 240              EdgesFromCaller.back().CallerGraph == &CallerGraph);
 241   }
 242
 243
 244   // Next, now that this graph is finalized, we need to recompute the
 245   // incompleteness markers for this graph and remove unreachable nodes.
 246   DSG.maskIncompleteMarkers();
 247
 248   // If any of the functions has incomplete incoming arguments, don't mark any
 249   // of them as complete.
 250   bool HasIncompleteArgs = false;
 251   for (DSGraph::retnodes_iterator I = DSG.retnodes_begin(),
 252          E = DSG.retnodes_end(); I != E; ++I)
 253     if (ArgsRemainIncomplete.count(I->first)) {
 254       HasIncompleteArgs = true;
 255       break;
 256     }
 257
 258   // Recompute the Incomplete markers.  Depends on whether args are complete
 259   unsigned Flags
 260     = HasIncompleteArgs ? DSGraph::MarkFormalArgs : DSGraph::IgnoreFormalArgs;
 261   DSG.markIncompleteNodes(Flags | DSGraph::IgnoreGlobals);
 262
 263   // Delete dead nodes.  Treat globals that are unreachable as dead also.
 264   DSG.removeDeadNodes(DSGraph::RemoveUnreachableGlobals);
 265
 266   // We are done with computing the current TD Graph!  Finally, before we can
 267   // finish processing this function, we figure out which functions it calls and
 268   // records these call graph edges, so that we have them when we process the
 269   // callee graphs.
 270   if (DSG.fc_begin() == DSG.fc_end()) return;
 271
 272   const BUDataStructures::ActualCalleesTy &ActualCallees =
 273     getAnalysis<BUDataStructures>().getActualCallees();
 274
 275   // Loop over all the call sites and all the callees at each call site, and add
 276   // edges to the CallerEdges structure for each callee.
 277   for (DSGraph::fc_iterator CI = DSG.fc_begin(), E = DSG.fc_end();
 278        CI != E; ++CI) {
 279     Instruction *CallI = CI->getCallSite().getInstruction();
 280     // For each function in the invoked function list at this call site...
 281     std::pair<BUDataStructures::ActualCalleesTy::const_iterator,
 282               BUDataStructures::ActualCalleesTy::const_iterator>
 283       IP = ActualCallees.equal_range(CallI);
 284     // Loop over each actual callee at this call site
 285     for (BUDataStructures::ActualCalleesTy::const_iterator I = IP.first;
 286          I != IP.second; ++I) {
 287       DSGraph& CalleeGraph = getDSGraph(*I->second);
 288       if (&CalleeGraph != &DSG)
 289         CallerEdges[&CalleeGraph].push_back(CallerCallEdge(&DSG, &*CI,
 290                                                            I->second));
 291     }
 292   }
 293 }
 294
 295
 296 static const Function *getFnForValue(const Value *V) {
 297   if (const Instruction *I = dyn_cast<Instruction>(V))
 298     return I->getParent()->getParent();
 299   else if (const Argument *A = dyn_cast<Argument>(V))
 300     return A->getParent();
 301   else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
 302     return BB->getParent();
 303   return 0;
 304 }
 305
 306 void TDDataStructures::deleteValue(Value *V) {
 307   if (const Function *F = getFnForValue(V)) {  // Function local value?
 308     // If this is a function local value, just delete it from the scalar map!
 309     getDSGraph(*F).getScalarMap().eraseIfExists(V);
 310     return;
 311   }
 312
 313   if (Function *F = dyn_cast<Function>(V)) {
 314     assert(getDSGraph(*F).getReturnNodes().size() == 1 &&
 315            "cannot handle scc's");
 316     delete DSInfo[F];
 317     DSInfo.erase(F);
 318     return;
 319   }
 320
 321   assert(!isa<GlobalVariable>(V) && "Do not know how to delete GV's yet!");
 322 }
 323
 324 void TDDataStructures::copyValue(Value *From, Value *To) {
 325   if (From == To) return;
 326   if (const Function *F = getFnForValue(From)) {  // Function local value?
 327     // If this is a function local value, just delete it from the scalar map!
 328     getDSGraph(*F).getScalarMap().copyScalarIfExists(From, To);
 329     return;
 330   }
 331
 332   if (Function *FromF = dyn_cast<Function>(From)) {
 333     Function *ToF = cast<Function>(To);
 334     assert(!DSInfo.count(ToF) && "New Function already exists!");
 335     DSGraph *NG = new DSGraph(getDSGraph(*FromF), GlobalECs);
 336     DSInfo[ToF] = NG;
 337     assert(NG->getReturnNodes().size() == 1 && "Cannot copy SCC's yet!");
 338
 339     // Change the Function* is the returnnodes map to the ToF.
 340     DSNodeHandle Ret = NG->retnodes_begin()->second;
 341     NG->getReturnNodes().clear();
 342     NG->getReturnNodes()[ToF] = Ret;
 343     return;
 344   }
 345
 346   assert(!isa<GlobalVariable>(From) && "Do not know how to copy GV's yet!");
 347 }