Make use of simpler DSNode methods.
[oota-llvm.git] / 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     inlineGraphIntoCallees(*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 void TDDataStructures::inlineGraphIntoCallees(DSGraph &Graph) {
175   // Recompute the Incomplete markers and eliminate unreachable nodes.
176   Graph.maskIncompleteMarkers();
177
178   // If any of the functions has incomplete incoming arguments, don't mark any
179   // of them as complete.
180   bool HasIncompleteArgs = false;
181   for (DSGraph::retnodes_iterator I = Graph.retnodes_begin(),
182          E = Graph.retnodes_end(); I != E; ++I)
183     if (ArgsRemainIncomplete.count(I->first)) {
184       HasIncompleteArgs = true;
185       break;
186     }
187
188   // Now fold in the necessary globals from the GlobalsGraph.  A global G
189   // must be folded in if it exists in the current graph (i.e., is not dead)
190   // and it was not inlined from any of my callers.  If it was inlined from
191   // a caller, it would have been fully consistent with the GlobalsGraph
192   // in the caller so folding in is not necessary.  Otherwise, this node came
193   // solely from this function's BU graph and so has to be made consistent.
194   // 
195   Graph.updateFromGlobalGraph();
196
197   // Recompute the Incomplete markers.  Depends on whether args are complete
198   unsigned Flags
199     = HasIncompleteArgs ? DSGraph::MarkFormalArgs : DSGraph::IgnoreFormalArgs;
200   Graph.markIncompleteNodes(Flags | DSGraph::IgnoreGlobals);
201
202   // Delete dead nodes.  Treat globals that are unreachable as dead also.
203   Graph.removeDeadNodes(DSGraph::RemoveUnreachableGlobals);
204
205   // We are done with computing the current TD Graph! Now move on to
206   // inlining the current graph into the graphs for its callees, if any.
207   // 
208   if (Graph.fc_begin() == Graph.fc_end()) {
209     DEBUG(std::cerr << "  [TD] No callees for: " << Graph.getFunctionNames()
210                     << "\n");
211     return;
212   }
213
214   // Now that we have information about all of the callees, propagate the
215   // current graph into the callees.  Clone only the reachable subgraph at
216   // each call-site, not the entire graph (even though the entire graph
217   // would be cloned only once, this should still be better on average).
218   //
219   DEBUG(std::cerr << "  [TD] Inlining '" << Graph.getFunctionNames() <<"' into "
220                   << Graph.getFunctionCalls().size() << " call nodes.\n");
221
222   const BUDataStructures::ActualCalleesTy &ActualCallees =
223     getAnalysis<BUDataStructures>().getActualCallees();
224
225   // Loop over all the call sites and all the callees at each call site.  Build
226   // a mapping from called DSGraph's to the call sites in this function that
227   // invoke them.  This is useful because we can be more efficient if there are
228   // multiple call sites to the callees in the graph from this caller.
229   std::multimap<DSGraph*, std::pair<Function*, const DSCallSite*> > CallSites;
230
231   for (DSGraph::fc_iterator CI = Graph.fc_begin(), E = Graph.fc_end();
232        CI != E; ++CI) {
233     Instruction *CallI = CI->getCallSite().getInstruction();
234     // For each function in the invoked function list at this call site...
235     std::pair<BUDataStructures::ActualCalleesTy::const_iterator,
236               BUDataStructures::ActualCalleesTy::const_iterator> 
237       IP = ActualCallees.equal_range(CallI);
238     // Loop over each actual callee at this call site
239     for (BUDataStructures::ActualCalleesTy::const_iterator I = IP.first;
240          I != IP.second; ++I) {
241       DSGraph& CalleeGraph = getDSGraph(*I->second);
242       if (&CalleeGraph != &Graph)
243         CallSites.insert(std::make_pair(&CalleeGraph,
244                                         std::make_pair(I->second, &*CI)));
245     }
246   }
247
248   // Now that we built the mapping, actually perform the inlining a callee graph
249   // at a time.
250   std::multimap<DSGraph*,std::pair<Function*,const DSCallSite*> >::iterator CSI;
251   for (CSI = CallSites.begin(); CSI != CallSites.end(); ) {
252     DSGraph &CalleeGraph = *CSI->first;
253     // Iterate through all of the call sites of this graph, cloning and merging
254     // any nodes required by the call.
255     ReachabilityCloner RC(CalleeGraph, Graph, DSGraph::StripModRefBits);
256
257     // Clone over any global nodes that appear in both graphs.
258     for (DSScalarMap::global_iterator
259            SI = CalleeGraph.getScalarMap().global_begin(),
260            SE = CalleeGraph.getScalarMap().global_end(); SI != SE; ++SI) {
261       DSScalarMap::const_iterator GI = Graph.getScalarMap().find(*SI);
262       if (GI != Graph.getScalarMap().end())
263         RC.merge(CalleeGraph.getNodeForValue(*SI), GI->second);
264     }
265
266     // Loop over all of the distinct call sites in the caller of the callee.
267     for (; CSI != CallSites.end() && CSI->first == &CalleeGraph; ++CSI) {
268       Function &CF = *CSI->second.first;
269       const DSCallSite &CS = *CSI->second.second;
270       DEBUG(std::cerr << "     [TD] Resolving arguments for callee graph '"
271             << CalleeGraph.getFunctionNames()
272             << "': " << CF.getFunctionType()->getNumParams()
273             << " args\n          at call site (DSCallSite*) 0x" << &CS << "\n");
274       
275       // Get the formal argument and return nodes for the called function and
276       // merge them with the cloned subgraph.
277       RC.mergeCallSite(CalleeGraph.getCallSiteForArguments(CF), CS);
278       ++NumTDInlines;
279     }
280   }
281
282   DEBUG(std::cerr << "  [TD] Done inlining into callees for: "
283         << Graph.getFunctionNames() << " [" << Graph.getGraphSize() << "+"
284         << Graph.getFunctionCalls().size() << "]\n");
285 }
286
287 static const Function *getFnForValue(const Value *V) {
288   if (const Instruction *I = dyn_cast<Instruction>(V))
289     return I->getParent()->getParent();
290   else if (const Argument *A = dyn_cast<Argument>(V))
291     return A->getParent();
292   else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
293     return BB->getParent();
294   return 0;
295 }
296
297 void TDDataStructures::deleteValue(Value *V) {
298   if (const Function *F = getFnForValue(V)) {  // Function local value?
299     // If this is a function local value, just delete it from the scalar map!
300     getDSGraph(*F).getScalarMap().eraseIfExists(V);
301     return;
302   }
303
304   if (Function *F = dyn_cast<Function>(V)) {
305     assert(getDSGraph(*F).getReturnNodes().size() == 1 &&
306            "cannot handle scc's");
307     delete DSInfo[F];
308     DSInfo.erase(F);
309     return;
310   }
311
312   assert(!isa<GlobalVariable>(V) && "Do not know how to delete GV's yet!");
313 }
314
315 void TDDataStructures::copyValue(Value *From, Value *To) {
316   if (From == To) return;
317   if (const Function *F = getFnForValue(From)) {  // Function local value?
318     // If this is a function local value, just delete it from the scalar map!
319     getDSGraph(*F).getScalarMap().copyScalarIfExists(From, To);
320     return;
321   }
322
323   if (Function *FromF = dyn_cast<Function>(From)) {
324     Function *ToF = cast<Function>(To);
325     assert(!DSInfo.count(ToF) && "New Function already exists!");
326     DSGraph *NG = new DSGraph(getDSGraph(*FromF), GlobalECs);
327     DSInfo[ToF] = NG;
328     assert(NG->getReturnNodes().size() == 1 && "Cannot copy SCC's yet!");
329
330     // Change the Function* is the returnnodes map to the ToF.
331     DSNodeHandle Ret = NG->retnodes_begin()->second;
332     NG->getReturnNodes().clear();
333     NG->getReturnNodes()[ToF] = Ret;
334     return;
335   }
336
337   assert(!isa<GlobalVariable>(From) && "Do not know how to copy GV's yet!");
338 }