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