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/Analysis/DataStructure/DSGraph.h"
  19 #include "llvm/Module.h"
  20 #include "llvm/ADT/Statistic.h"
  21 #include "llvm/Support/Debug.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 // run - Calculate the bottom up data structure graphs for each function in the
  34 // program.
  35 //
  36 bool BUDataStructures::runOnModule(Module &M) {
  37   LocalDataStructures &LocalDSA = getAnalysis<LocalDataStructures>();
  38   GlobalECs = LocalDSA.getGlobalECs();
  39
  40   GlobalsGraph = new DSGraph(LocalDSA.getGlobalsGraph(), GlobalECs);
  41   GlobalsGraph->setPrintAuxCalls();
  42
  43   IndCallGraphMap = new std::map<std::vector<Function*>,
  44                            std::pair<DSGraph*, std::vector<DSNodeHandle> > >();
  45
  46   std::vector<Function*> Stack;
  47   hash_map<Function*, unsigned> ValMap;
  48   unsigned NextID = 1;
  49
  50   Function *MainFunc = M.getMainFunction();
  51   if (MainFunc)
  52     calculateGraphs(MainFunc, Stack, NextID, ValMap);
  53
  54   // Calculate the graphs for any functions that are unreachable from main...
  55   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
  56     if (!I->isExternal() && !DSInfo.count(I)) {
  57 #ifndef NDEBUG
  58       if (MainFunc)
  59         std::cerr << "*** Function unreachable from main: "
  60                   << I->getName() << "\n";
  61 #endif
  62       calculateGraphs(I, Stack, NextID, ValMap);     // Calculate all graphs.
  63     }
  64
  65   NumCallEdges += ActualCallees.size();
  66
  67   // If we computed any temporary indcallgraphs, free them now.
  68   for (std::map<std::vector<Function*>,
  69          std::pair<DSGraph*, std::vector<DSNodeHandle> > >::iterator I =
  70          IndCallGraphMap->begin(), E = IndCallGraphMap->end(); I != E; ++I) {
  71     I->second.second.clear();  // Drop arg refs into the graph.
  72     delete I->second.first;
  73   }
  74   delete IndCallGraphMap;
  75
  76   // At the end of the bottom-up pass, the globals graph becomes complete.
  77   // FIXME: This is not the right way to do this, but it is sorta better than
  78   // nothing!  In particular, externally visible globals and unresolvable call
  79   // nodes at the end of the BU phase should make things that they point to
  80   // incomplete in the globals graph.
  81   //
  82   GlobalsGraph->removeTriviallyDeadNodes();
  83   GlobalsGraph->maskIncompleteMarkers();
  84
  85   // Mark external globals incomplete.
  86   GlobalsGraph->markIncompleteNodes(DSGraph::IgnoreGlobals);
  87
  88   // Merge the globals variables (not the calls) from the globals graph back
  89   // into the main function's graph so that the main function contains all of
  90   // the information about global pools and GV usage in the program.
  91   if (MainFunc && !MainFunc->isExternal()) {
  92     DSGraph &MainGraph = getOrCreateGraph(MainFunc);
  93     const DSGraph &GG = *MainGraph.getGlobalsGraph();
  94     ReachabilityCloner RC(MainGraph, GG,
  95                           DSGraph::DontCloneCallNodes |
  96                           DSGraph::DontCloneAuxCallNodes);
  97
  98     // Clone the global nodes into this graph.
  99     for (DSScalarMap::global_iterator I = GG.getScalarMap().global_begin(),
 100            E = GG.getScalarMap().global_end(); I != E; ++I)
 101       if (isa<GlobalVariable>(*I))
 102         RC.getClonedNH(GG.getNodeForValue(*I));
 103
 104     MainGraph.maskIncompleteMarkers();
 105     MainGraph.markIncompleteNodes(DSGraph::MarkFormalArgs |
 106                                   DSGraph::IgnoreGlobals);
 107   }
 108
 109   return false;
 110 }
 111
 112 DSGraph &BUDataStructures::getOrCreateGraph(Function *F) {
 113   // Has the graph already been created?
 114   DSGraph *&Graph = DSInfo[F];
 115   if (Graph) return *Graph;
 116
 117   DSGraph &LocGraph = getAnalysis<LocalDataStructures>().getDSGraph(*F);
 118
 119   // Steal the local graph.
 120   Graph = new DSGraph(GlobalECs, LocGraph.getTargetData());
 121   Graph->spliceFrom(LocGraph);
 122
 123   Graph->setGlobalsGraph(GlobalsGraph);
 124   Graph->setPrintAuxCalls();
 125
 126   // Start with a copy of the original call sites...
 127   Graph->getAuxFunctionCalls() = Graph->getFunctionCalls();
 128   return *Graph;
 129 }
 130
 131 static bool isVAHackFn(const Function *F) {
 132   return F->getName() == "printf"  || F->getName() == "sscanf" ||
 133     F->getName() == "fprintf" || F->getName() == "open" ||
 134     F->getName() == "sprintf" || F->getName() == "fputs" ||
 135     F->getName() == "fscanf";
 136 }
 137
 138 static bool isResolvableFunc(const Function* callee) {
 139   return !callee->isExternal() || isVAHackFn(callee);
 140 }
 141
 142 static void GetAllCallees(const DSCallSite &CS,
 143                           std::vector<Function*> &Callees) {
 144   if (CS.isDirectCall()) {
 145     if (isResolvableFunc(CS.getCalleeFunc()))
 146       Callees.push_back(CS.getCalleeFunc());
 147   } else if (!CS.getCalleeNode()->isIncomplete()) {
 148     // Get all callees.
 149     unsigned OldSize = Callees.size();
 150     CS.getCalleeNode()->addFullFunctionList(Callees);
 151
 152     // If any of the callees are unresolvable, remove the whole batch!
 153     for (unsigned i = OldSize, e = Callees.size(); i != e; ++i)
 154       if (!isResolvableFunc(Callees[i])) {
 155         Callees.erase(Callees.begin()+OldSize, Callees.end());
 156         return;
 157       }
 158   }
 159 }
 160
 161
 162 /// GetAllAuxCallees - Return a list containing all of the resolvable callees in
 163 /// the aux list for the specified graph in the Callees vector.
 164 static void GetAllAuxCallees(DSGraph &G, std::vector<Function*> &Callees) {
 165   Callees.clear();
 166   for (DSGraph::afc_iterator I = G.afc_begin(), E = G.afc_end(); I != E; ++I)
 167     GetAllCallees(*I, Callees);
 168 }
 169
 170 unsigned BUDataStructures::calculateGraphs(Function *F,
 171                                            std::vector<Function*> &Stack,
 172                                            unsigned &NextID,
 173                                      hash_map<Function*, unsigned> &ValMap) {
 174   assert(!ValMap.count(F) && "Shouldn't revisit functions!");
 175   unsigned Min = NextID++, MyID = Min;
 176   ValMap[F] = Min;
 177   Stack.push_back(F);
 178
 179   // FIXME!  This test should be generalized to be any function that we have
 180   // already processed, in the case when there isn't a main or there are
 181   // unreachable functions!
 182   if (F->isExternal()) {   // sprintf, fprintf, sscanf, etc...
 183     // No callees!
 184     Stack.pop_back();
 185     ValMap[F] = ~0;
 186     return Min;
 187   }
 188
 189   DSGraph &Graph = getOrCreateGraph(F);
 190
 191   // Find all callee functions.
 192   std::vector<Function*> CalleeFunctions;
 193   GetAllAuxCallees(Graph, CalleeFunctions);
 194
 195   // The edges out of the current node are the call site targets...
 196   for (unsigned i = 0, e = CalleeFunctions.size(); i != e; ++i) {
 197     Function *Callee = CalleeFunctions[i];
 198     unsigned M;
 199     // Have we visited the destination function yet?
 200     hash_map<Function*, unsigned>::iterator It = ValMap.find(Callee);
 201     if (It == ValMap.end())  // No, visit it now.
 202       M = calculateGraphs(Callee, Stack, NextID, ValMap);
 203     else                    // Yes, get it's number.
 204       M = It->second;
 205     if (M < Min) Min = M;
 206   }
 207
 208   assert(ValMap[F] == MyID && "SCC construction assumption wrong!");
 209   if (Min != MyID)
 210     return Min;         // This is part of a larger SCC!
 211
 212   // If this is a new SCC, process it now.
 213   if (Stack.back() == F) {           // Special case the single "SCC" case here.
 214     DEBUG(std::cerr << "Visiting single node SCC #: " << MyID << " fn: "
 215                     << F->getName() << "\n");
 216     Stack.pop_back();
 217     DSGraph &G = getDSGraph(*F);
 218     DEBUG(std::cerr << "  [BU] Calculating graph for: " << F->getName()<< "\n");
 219     calculateGraph(G);
 220     DEBUG(std::cerr << "  [BU] Done inlining: " << F->getName() << " ["
 221                     << G.getGraphSize() << "+" << G.getAuxFunctionCalls().size()
 222                     << "]\n");
 223
 224     if (MaxSCC < 1) MaxSCC = 1;
 225
 226     // Should we revisit the graph?  Only do it if there are now new resolvable
 227     // callees.
 228     GetAllAuxCallees(Graph, CalleeFunctions);
 229     if (!CalleeFunctions.empty()) {
 230       ValMap.erase(F);
 231       return calculateGraphs(F, Stack, NextID, ValMap);
 232     } else {
 233       ValMap[F] = ~0U;
 234     }
 235     return MyID;
 236
 237   } else {
 238     // SCCFunctions - Keep track of the functions in the current SCC
 239     //
 240     std::vector<DSGraph*> SCCGraphs;
 241
 242     unsigned SCCSize = 1;
 243     Function *NF = Stack.back();
 244     ValMap[NF] = ~0U;
 245     DSGraph &SCCGraph = getDSGraph(*NF);
 246
 247     // First thing first, collapse all of the DSGraphs into a single graph for
 248     // the entire SCC.  Splice all of the graphs into one and discard all of the
 249     // old graphs.
 250     //
 251     while (NF != F) {
 252       Stack.pop_back();
 253       NF = Stack.back();
 254       ValMap[NF] = ~0U;
 255
 256       DSGraph &NFG = getDSGraph(*NF);
 257
 258       // Update the Function -> DSG map.
 259       for (DSGraph::retnodes_iterator I = NFG.retnodes_begin(),
 260              E = NFG.retnodes_end(); I != E; ++I)
 261         DSInfo[I->first] = &SCCGraph;
 262
 263       SCCGraph.spliceFrom(NFG);
 264       delete &NFG;
 265
 266       ++SCCSize;
 267     }
 268     Stack.pop_back();
 269
 270     std::cerr << "Calculating graph for SCC #: " << MyID << " of size: "
 271               << SCCSize << "\n";
 272
 273     // Compute the Max SCC Size.
 274     if (MaxSCC < SCCSize)
 275       MaxSCC = SCCSize;
 276
 277     // Clean up the graph before we start inlining a bunch again...
 278     SCCGraph.removeDeadNodes(DSGraph::KeepUnreachableGlobals);
 279
 280     // Now that we have one big happy family, resolve all of the call sites in
 281     // the graph...
 282     calculateGraph(SCCGraph);
 283     DEBUG(std::cerr << "  [BU] Done inlining SCC  [" << SCCGraph.getGraphSize()
 284                     << "+" << SCCGraph.getAuxFunctionCalls().size() << "]\n");
 285
 286     std::cerr << "DONE with SCC #: " << MyID << "\n";
 287
 288     // We never have to revisit "SCC" processed functions...
 289     return MyID;
 290   }
 291
 292   return MyID;  // == Min
 293 }
 294
 295
 296 // releaseMemory - If the pass pipeline is done with this pass, we can release
 297 // our memory... here...
 298 //
 299 void BUDataStructures::releaseMyMemory() {
 300   for (hash_map<Function*, DSGraph*>::iterator I = DSInfo.begin(),
 301          E = DSInfo.end(); I != E; ++I) {
 302     I->second->getReturnNodes().erase(I->first);
 303     if (I->second->getReturnNodes().empty())
 304       delete I->second;
 305   }
 306
 307   // Empty map so next time memory is released, data structures are not
 308   // re-deleted.
 309   DSInfo.clear();
 310   delete GlobalsGraph;
 311   GlobalsGraph = 0;
 312 }
 313
 314 void BUDataStructures::calculateGraph(DSGraph &Graph) {
 315   // Move our call site list into TempFCs so that inline call sites go into the
 316   // new call site list and doesn't invalidate our iterators!
 317   std::list<DSCallSite> TempFCs;
 318   std::list<DSCallSite> &AuxCallsList = Graph.getAuxFunctionCalls();
 319   TempFCs.swap(AuxCallsList);
 320
 321   DSGraph::ReturnNodesTy &ReturnNodes = Graph.getReturnNodes();
 322
 323   bool Printed = false;
 324   std::vector<Function*> CalledFuncs;
 325   while (!TempFCs.empty()) {
 326     DSCallSite &CS = *TempFCs.begin();
 327
 328     CalledFuncs.clear();
 329
 330     // Fast path for noop calls.  Note that we don't care about merging globals
 331     // in the callee with nodes in the caller here.
 332     if (CS.getRetVal().isNull() && CS.getNumPtrArgs() == 0) {
 333       TempFCs.erase(TempFCs.begin());
 334       continue;
 335     } else if (CS.isDirectCall() && isVAHackFn(CS.getCalleeFunc())) {
 336       TempFCs.erase(TempFCs.begin());
 337       continue;
 338     }
 339
 340     GetAllCallees(CS, CalledFuncs);
 341
 342     if (CalledFuncs.empty()) {
 343       // Remember that we could not resolve this yet!
 344       AuxCallsList.splice(AuxCallsList.end(), TempFCs, TempFCs.begin());
 345       continue;
 346     } else {
 347       DSGraph *GI;
 348       Instruction *TheCall = CS.getCallSite().getInstruction();
 349
 350       if (CalledFuncs.size() == 1) {
 351         Function *Callee = CalledFuncs[0];
 352         ActualCallees.insert(std::make_pair(TheCall, Callee));
 353
 354         // Get the data structure graph for the called function.
 355         GI = &getDSGraph(*Callee);  // Graph to inline
 356         DEBUG(std::cerr << "    Inlining graph for " << Callee->getName());
 357
 358         DEBUG(std::cerr << "[" << GI->getGraphSize() << "+"
 359               << GI->getAuxFunctionCalls().size() << "] into '"
 360               << Graph.getFunctionNames() << "' [" << Graph.getGraphSize() <<"+"
 361               << Graph.getAuxFunctionCalls().size() << "]\n");
 362         Graph.mergeInGraph(CS, *Callee, *GI,
 363                            DSGraph::StripAllocaBit|DSGraph::DontCloneCallNodes);
 364         ++NumBUInlines;
 365       } else {
 366         if (!Printed)
 367           std::cerr << "In Fns: " << Graph.getFunctionNames() << "\n";
 368         std::cerr << "  calls " << CalledFuncs.size()
 369                   << " fns from site: " << CS.getCallSite().getInstruction()
 370                   << "  " << *CS.getCallSite().getInstruction();
 371         std::cerr << "   Fns =";
 372         unsigned NumPrinted = 0;
 373
 374         for (std::vector<Function*>::iterator I = CalledFuncs.begin(),
 375                E = CalledFuncs.end(); I != E; ++I) {
 376           if (NumPrinted++ < 8) std::cerr << " " << (*I)->getName();
 377
 378           // Add the call edges to the call graph.
 379           ActualCallees.insert(std::make_pair(TheCall, *I));
 380         }
 381         std::cerr << "\n";
 382
 383         // See if we already computed a graph for this set of callees.
 384         std::sort(CalledFuncs.begin(), CalledFuncs.end());
 385         std::pair<DSGraph*, std::vector<DSNodeHandle> > &IndCallGraph =
 386           (*IndCallGraphMap)[CalledFuncs];
 387
 388         if (IndCallGraph.first == 0) {
 389           std::vector<Function*>::iterator I = CalledFuncs.begin(),
 390             E = CalledFuncs.end();
 391
 392           // Start with a copy of the first graph.
 393           GI = IndCallGraph.first = new DSGraph(getDSGraph(**I), GlobalECs);
 394           GI->setGlobalsGraph(Graph.getGlobalsGraph());
 395           std::vector<DSNodeHandle> &Args = IndCallGraph.second;
 396
 397           // Get the argument nodes for the first callee.  The return value is
 398           // the 0th index in the vector.
 399           GI->getFunctionArgumentsForCall(*I, Args);
 400
 401           // Merge all of the other callees into this graph.
 402           for (++I; I != E; ++I) {
 403             // If the graph already contains the nodes for the function, don't
 404             // bother merging it in again.
 405             if (!GI->containsFunction(*I)) {
 406               GI->cloneInto(getDSGraph(**I));
 407               ++NumBUInlines;
 408             }
 409
 410             std::vector<DSNodeHandle> NextArgs;
 411             GI->getFunctionArgumentsForCall(*I, NextArgs);
 412             unsigned i = 0, e = Args.size();
 413             for (; i != e; ++i) {
 414               if (i == NextArgs.size()) break;
 415               Args[i].mergeWith(NextArgs[i]);
 416             }
 417             for (e = NextArgs.size(); i != e; ++i)
 418               Args.push_back(NextArgs[i]);
 419           }
 420
 421           // Clean up the final graph!
 422           GI->removeDeadNodes(DSGraph::KeepUnreachableGlobals);
 423         } else {
 424           std::cerr << "***\n*** RECYCLED GRAPH ***\n***\n";
 425         }
 426
 427         GI = IndCallGraph.first;
 428
 429         // Merge the unified graph into this graph now.
 430         DEBUG(std::cerr << "    Inlining multi callee graph "
 431               << "[" << GI->getGraphSize() << "+"
 432               << GI->getAuxFunctionCalls().size() << "] into '"
 433               << Graph.getFunctionNames() << "' [" << Graph.getGraphSize() <<"+"
 434               << Graph.getAuxFunctionCalls().size() << "]\n");
 435
 436         Graph.mergeInGraph(CS, IndCallGraph.second, *GI,
 437                            DSGraph::StripAllocaBit |
 438                            DSGraph::DontCloneCallNodes);
 439         ++NumBUInlines;
 440       }
 441     }
 442     TempFCs.erase(TempFCs.begin());
 443   }
 444
 445   // Recompute the Incomplete markers
 446   Graph.maskIncompleteMarkers();
 447   Graph.markIncompleteNodes(DSGraph::MarkFormalArgs);
 448
 449   // Delete dead nodes.  Treat globals that are unreachable but that can
 450   // reach live nodes as live.
 451   Graph.removeDeadNodes(DSGraph::KeepUnreachableGlobals);
 452
 453   // When this graph is finalized, clone the globals in the graph into the
 454   // globals graph to make sure it has everything, from all graphs.
 455   DSScalarMap &MainSM = Graph.getScalarMap();
 456   ReachabilityCloner RC(*GlobalsGraph, Graph, DSGraph::StripAllocaBit);
 457
 458   // Clone everything reachable from globals in the function graph into the
 459   // globals graph.
 460   for (DSScalarMap::global_iterator I = MainSM.global_begin(),
 461          E = MainSM.global_end(); I != E; ++I)
 462     RC.getClonedNH(MainSM[*I]);
 463
 464   //Graph.writeGraphToFile(std::cerr, "bu_" + F.getName());
 465 }
 466
 467 static const Function *getFnForValue(const Value *V) {
 468   if (const Instruction *I = dyn_cast<Instruction>(V))
 469     return I->getParent()->getParent();
 470   else if (const Argument *A = dyn_cast<Argument>(V))
 471     return A->getParent();
 472   else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
 473     return BB->getParent();
 474   return 0;
 475 }
 476
 477 /// deleteValue/copyValue - Interfaces to update the DSGraphs in the program.
 478 /// These correspond to the interfaces defined in the AliasAnalysis class.
 479 void BUDataStructures::deleteValue(Value *V) {
 480   if (const Function *F = getFnForValue(V)) {  // Function local value?
 481     // If this is a function local value, just delete it from the scalar map!
 482     getDSGraph(*F).getScalarMap().eraseIfExists(V);
 483     return;
 484   }
 485
 486   if (Function *F = dyn_cast<Function>(V)) {
 487     assert(getDSGraph(*F).getReturnNodes().size() == 1 &&
 488            "cannot handle scc's");
 489     delete DSInfo[F];
 490     DSInfo.erase(F);
 491     return;
 492   }
 493
 494   assert(!isa<GlobalVariable>(V) && "Do not know how to delete GV's yet!");
 495 }
 496
 497 void BUDataStructures::copyValue(Value *From, Value *To) {
 498   if (From == To) return;
 499   if (const Function *F = getFnForValue(From)) {  // Function local value?
 500     // If this is a function local value, just delete it from the scalar map!
 501     getDSGraph(*F).getScalarMap().copyScalarIfExists(From, To);
 502     return;
 503   }
 504
 505   if (Function *FromF = dyn_cast<Function>(From)) {
 506     Function *ToF = cast<Function>(To);
 507     assert(!DSInfo.count(ToF) && "New Function already exists!");
 508     DSGraph *NG = new DSGraph(getDSGraph(*FromF), GlobalECs);
 509     DSInfo[ToF] = NG;
 510     assert(NG->getReturnNodes().size() == 1 && "Cannot copy SCC's yet!");
 511
 512     // Change the Function* is the returnnodes map to the ToF.
 513     DSNodeHandle Ret = NG->retnodes_begin()->second;
 514     NG->getReturnNodes().clear();
 515     NG->getReturnNodes()[ToF] = Ret;
 516     return;
 517   }
 518
 519   if (const Function *F = getFnForValue(To)) {
 520     DSGraph &G = getDSGraph(*F);
 521     G.getScalarMap().copyScalarIfExists(From, To);
 522     return;
 523   }
 524
 525   std::cerr << *From;
 526   std::cerr << *To;
 527   assert(0 && "Do not know how to copy this yet!");
 528   abort();
 529 }