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 #define DEBUG_TYPE "bu_dsa"
  17 #include "llvm/Analysis/DataStructure/DataStructure.h"
  18 #include "llvm/Analysis/DataStructure/DSGraph.h"
  19 #include "llvm/Module.h"
  20 #include "llvm/DerivedTypes.h"
  21 #include "llvm/ADT/Statistic.h"
  22 #include "llvm/Support/CommandLine.h"
  23 #include "llvm/Support/Debug.h"
  24 #include "llvm/Support/Timer.h"
  25 #include <iostream>
  26 using namespace llvm;
  27
  28 namespace {
  29   Statistic<> MaxSCC("budatastructure", "Maximum SCC Size in Call Graph");
  30   Statistic<> NumBUInlines("budatastructures", "Number of graphs inlined");
  31   Statistic<> NumCallEdges("budatastructures", "Number of 'actual' call edges");
  32
  33   cl::opt<bool>
  34   AddGlobals("budatastructures-annotate-calls",
  35              cl::desc("Annotate call sites with functions as they are resolved"));
  36   cl::opt<bool>
  37   UpdateGlobals("budatastructures-update-from-globals",
  38                 cl::desc("Update local graph from global graph when processing function"));
  39
  40   RegisterPass<BUDataStructures>
  41   X("budatastructure", "Bottom-up Data Structure Analysis");
  42 }
  43
  44 static bool GetAllCallees(const DSCallSite &CS,
  45                           std::vector<Function*> &Callees);
  46
  47 /// BuildGlobalECs - Look at all of the nodes in the globals graph.  If any node
  48 /// contains multiple globals, DSA will never, ever, be able to tell the globals
  49 /// apart.  Instead of maintaining this information in all of the graphs
  50 /// throughout the entire program, store only a single global (the "leader") in
  51 /// the graphs, and build equivalence classes for the rest of the globals.
  52 static void BuildGlobalECs(DSGraph &GG, std::set<GlobalValue*> &ECGlobals) {
  53   DSScalarMap &SM = GG.getScalarMap();
  54   EquivalenceClasses<GlobalValue*> &GlobalECs = SM.getGlobalECs();
  55   for (DSGraph::node_iterator I = GG.node_begin(), E = GG.node_end();
  56        I != E; ++I) {
  57     if (I->getGlobalsList().size() <= 1) continue;
  58
  59     // First, build up the equivalence set for this block of globals.
  60     const std::vector<GlobalValue*> &GVs = I->getGlobalsList();
  61     GlobalValue *First = GVs[0];
  62     for (unsigned i = 1, e = GVs.size(); i != e; ++i)
  63       GlobalECs.unionSets(First, GVs[i]);
  64
  65     // Next, get the leader element.
  66     assert(First == GlobalECs.getLeaderValue(First) &&
  67            "First did not end up being the leader?");
  68
  69     // Next, remove all globals from the scalar map that are not the leader.
  70     assert(GVs[0] == First && "First had to be at the front!");
  71     for (unsigned i = 1, e = GVs.size(); i != e; ++i) {
  72       ECGlobals.insert(GVs[i]);
  73       SM.erase(SM.find(GVs[i]));
  74     }
  75
  76     // Finally, change the global node to only contain the leader.
  77     I->clearGlobals();
  78     I->addGlobal(First);
  79   }
  80
  81   DEBUG(GG.AssertGraphOK());
  82 }
  83
  84 /// EliminateUsesOfECGlobals - Once we have determined that some globals are in
  85 /// really just equivalent to some other globals, remove the globals from the
  86 /// specified DSGraph (if present), and merge any nodes with their leader nodes.
  87 static void EliminateUsesOfECGlobals(DSGraph &G,
  88                                      const std::set<GlobalValue*> &ECGlobals) {
  89   DSScalarMap &SM = G.getScalarMap();
  90   EquivalenceClasses<GlobalValue*> &GlobalECs = SM.getGlobalECs();
  91
  92   bool MadeChange = false;
  93   for (DSScalarMap::global_iterator GI = SM.global_begin(), E = SM.global_end();
  94        GI != E; ) {
  95     GlobalValue *GV = *GI++;
  96     if (!ECGlobals.count(GV)) continue;
  97
  98     const DSNodeHandle &GVNH = SM[GV];
  99     assert(!GVNH.isNull() && "Global has null NH!?");
 100
 101     // Okay, this global is in some equivalence class.  Start by finding the
 102     // leader of the class.
 103     GlobalValue *Leader = GlobalECs.getLeaderValue(GV);
 104
 105     // If the leader isn't already in the graph, insert it into the node
 106     // corresponding to GV.
 107     if (!SM.global_count(Leader)) {
 108       GVNH.getNode()->addGlobal(Leader);
 109       SM[Leader] = GVNH;
 110     } else {
 111       // Otherwise, the leader is in the graph, make sure the nodes are the
 112       // merged in the specified graph.
 113       const DSNodeHandle &LNH = SM[Leader];
 114       if (LNH.getNode() != GVNH.getNode())
 115         LNH.mergeWith(GVNH);
 116     }
 117
 118     // Next step, remove the global from the DSNode.
 119     GVNH.getNode()->removeGlobal(GV);
 120
 121     // Finally, remove the global from the ScalarMap.
 122     SM.erase(GV);
 123     MadeChange = true;
 124   }
 125
 126   DEBUG(if(MadeChange) G.AssertGraphOK());
 127 }
 128
 129 static void AddGlobalToNode(BUDataStructures* B, DSCallSite D, Function* F) {
 130   if(!AddGlobals)
 131     return;
 132   if(D.isIndirectCall()) {
 133     DSGraph* GI = &B->getDSGraph(D.getCaller());
 134     DSNodeHandle& NHF = GI->getNodeForValue(F);
 135     DSCallSite DL = GI->getDSCallSiteForCallSite(D.getCallSite());
 136     if (DL.getCalleeNode() != NHF.getNode() || NHF.isNull()) {
 137       if (NHF.isNull()) {
 138         DSNode *N = new DSNode(F->getType()->getElementType(), GI);   // Create the node
 139         N->addGlobal(F);
 140         NHF.setTo(N,0);
 141         DEBUG(std::cerr << "Adding " << F->getName() << " to a call node in "
 142              << D.getCaller().getName() << "\n");
 143       }
 144       DL.getCalleeNode()->mergeWith(NHF, 0);
 145     }
 146   }
 147 }
 148
 149 // run - Calculate the bottom up data structure graphs for each function in the
 150 // program.
 151 //
 152 bool BUDataStructures::runOnModule(Module &M) {
 153   LocalDataStructures &LocalDSA = getAnalysis<LocalDataStructures>();
 154   GlobalECs = LocalDSA.getGlobalECs();
 155
 156   GlobalsGraph = new DSGraph(LocalDSA.getGlobalsGraph(), GlobalECs);
 157   GlobalsGraph->setPrintAuxCalls();
 158
 159   IndCallGraphMap = new std::map<std::vector<Function*>,
 160                            std::pair<DSGraph*, std::vector<DSNodeHandle> > >();
 161
 162   std::vector<Function*> Stack;
 163   hash_map<Function*, unsigned> ValMap;
 164   unsigned NextID = 1;
 165
 166   Function *MainFunc = M.getMainFunction();
 167
 168   if (MainFunc)
 169     calculateGraphs(MainFunc, Stack, NextID, ValMap);
 170
 171   // Calculate the graphs for any functions that are unreachable from main...
 172   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 173     if (!I->isExternal() && !DSInfo.count(I)) {
 174       if (MainFunc)
 175         DEBUG(std::cerr << "*** BU: Function unreachable from main: "
 176               << I->getName() << "\n");
 177       calculateGraphs(I, Stack, NextID, ValMap);     // Calculate all graphs.
 178     }
 179
 180   // If we computed any temporary indcallgraphs, free them now.
 181   for (std::map<std::vector<Function*>,
 182          std::pair<DSGraph*, std::vector<DSNodeHandle> > >::iterator I =
 183          IndCallGraphMap->begin(), E = IndCallGraphMap->end(); I != E; ++I) {
 184     I->second.second.clear();  // Drop arg refs into the graph.
 185     delete I->second.first;
 186   }
 187   delete IndCallGraphMap;
 188
 189   // At the end of the bottom-up pass, the globals graph becomes complete.
 190   // FIXME: This is not the right way to do this, but it is sorta better than
 191   // nothing!  In particular, externally visible globals and unresolvable call
 192   // nodes at the end of the BU phase should make things that they point to
 193   // incomplete in the globals graph.
 194   //
 195   GlobalsGraph->removeTriviallyDeadNodes();
 196   GlobalsGraph->maskIncompleteMarkers();
 197
 198   // Mark external globals incomplete.
 199   GlobalsGraph->markIncompleteNodes(DSGraph::IgnoreGlobals);
 200
 201   // Grow the equivalence classes for the globals to include anything that we
 202   // now know to be aliased.
 203   std::set<GlobalValue*> ECGlobals;
 204   BuildGlobalECs(*GlobalsGraph, ECGlobals);
 205   if (!ECGlobals.empty()) {
 206     NamedRegionTimer X("Bottom-UP EC Cleanup");
 207     DEBUG(std::cerr << "Eliminating " << ECGlobals.size() << " EC Globals!\n");
 208     for (hash_map<Function*, DSGraph*>::iterator I = DSInfo.begin(),
 209            E = DSInfo.end(); I != E; ++I)
 210       EliminateUsesOfECGlobals(*I->second, ECGlobals);
 211   }
 212
 213   // Merge the globals variables (not the calls) from the globals graph back
 214   // into the main function's graph so that the main function contains all of
 215   // the information about global pools and GV usage in the program.
 216   if (MainFunc && !MainFunc->isExternal()) {
 217     DSGraph &MainGraph = getOrCreateGraph(MainFunc);
 218     const DSGraph &GG = *MainGraph.getGlobalsGraph();
 219     ReachabilityCloner RC(MainGraph, GG, DSGraph::DontCloneCallNodes |
 220                           DSGraph::DontCloneAuxCallNodes);
 221
 222     // Clone the global nodes into this graph.
 223     for (DSScalarMap::global_iterator I = GG.getScalarMap().global_begin(),
 224            E = GG.getScalarMap().global_end(); I != E; ++I)
 225       if (isa<GlobalVariable>(*I))
 226         RC.getClonedNH(GG.getNodeForValue(*I));
 227
 228     MainGraph.maskIncompleteMarkers();
 229     MainGraph.markIncompleteNodes(DSGraph::MarkFormalArgs |
 230                                   DSGraph::IgnoreGlobals);
 231
 232     //Debug messages if along the way we didn't resolve a call site
 233     //also update the call graph and callsites we did find.
 234     for(DSGraph::afc_iterator ii = MainGraph.afc_begin(),
 235           ee = MainGraph.afc_end(); ii != ee; ++ii) {
 236       std::vector<Function*> Funcs;
 237       GetAllCallees(*ii, Funcs);
 238       DEBUG(std::cerr << "Lost site\n");
 239       DEBUG(ii->getCallSite().getInstruction()->dump());
 240       for (std::vector<Function*>::iterator iif = Funcs.begin(), eef = Funcs.end();
 241            iif != eef; ++iif) {
 242         AddGlobalToNode(this, *ii, *iif);
 243         DEBUG(std::cerr << "Adding\n");
 244         ActualCallees.insert(std::make_pair(ii->getCallSite().getInstruction(), *iif));
 245       }
 246     }
 247
 248   }
 249
 250   NumCallEdges += ActualCallees.size();
 251
 252   return false;
 253 }
 254
 255 DSGraph &BUDataStructures::getOrCreateGraph(Function *F) {
 256   // Has the graph already been created?
 257   DSGraph *&Graph = DSInfo[F];
 258   if (Graph) return *Graph;
 259
 260   DSGraph &LocGraph = getAnalysis<LocalDataStructures>().getDSGraph(*F);
 261
 262   // Steal the local graph.
 263   Graph = new DSGraph(GlobalECs, LocGraph.getTargetData());
 264   Graph->spliceFrom(LocGraph);
 265
 266   Graph->setGlobalsGraph(GlobalsGraph);
 267   Graph->setPrintAuxCalls();
 268
 269   // Start with a copy of the original call sites...
 270   Graph->getAuxFunctionCalls() = Graph->getFunctionCalls();
 271   return *Graph;
 272 }
 273
 274 static bool isVAHackFn(const Function *F) {
 275   return F->getName() == "printf"  || F->getName() == "sscanf" ||
 276     F->getName() == "fprintf" || F->getName() == "open" ||
 277     F->getName() == "sprintf" || F->getName() == "fputs" ||
 278     F->getName() == "fscanf" || F->getName() == "malloc" ||
 279     F->getName() == "free";
 280 }
 281
 282 static bool isResolvableFunc(const Function* callee) {
 283   return !callee->isExternal() || isVAHackFn(callee);
 284 }
 285
 286 //returns true if all callees were resolved
 287 static bool GetAllCallees(const DSCallSite &CS,
 288                           std::vector<Function*> &Callees) {
 289   if (CS.isDirectCall()) {
 290     if (isResolvableFunc(CS.getCalleeFunc())) {
 291       Callees.push_back(CS.getCalleeFunc());
 292       return true;
 293     } else
 294       return false;
 295   } else {
 296     // Get all callees.
 297     bool retval = CS.getCalleeNode()->isComplete();
 298     unsigned OldSize = Callees.size();
 299     CS.getCalleeNode()->addFullFunctionList(Callees);
 300
 301     // If any of the callees are unresolvable, remove that one
 302     for (unsigned i = OldSize; i != Callees.size(); ++i)
 303       if (!isResolvableFunc(Callees[i])) {
 304         Callees.erase(Callees.begin()+i);
 305         --i;
 306        retval = false;
 307       }
 308     return retval;
 309     //return false;
 310   }
 311 }
 312
 313 /// GetAllAuxCallees - Return a list containing all of the resolvable callees in
 314 /// the aux list for the specified graph in the Callees vector.
 315 static void GetAllAuxCallees(DSGraph &G, std::vector<Function*> &Callees) {
 316   Callees.clear();
 317   for (DSGraph::afc_iterator I = G.afc_begin(), E = G.afc_end(); I != E; ++I)
 318     GetAllCallees(*I, Callees);
 319 }
 320
 321 unsigned BUDataStructures::calculateGraphs(Function *F,
 322                                            std::vector<Function*> &Stack,
 323                                            unsigned &NextID,
 324                                            hash_map<Function*, unsigned> &ValMap) {
 325   assert(!ValMap.count(F) && "Shouldn't revisit functions!");
 326   unsigned Min = NextID++, MyID = Min;
 327   ValMap[F] = Min;
 328   Stack.push_back(F);
 329
 330   // FIXME!  This test should be generalized to be any function that we have
 331   // already processed, in the case when there isn't a main or there are
 332   // unreachable functions!
 333   if (F->isExternal()) {   // sprintf, fprintf, sscanf, etc...
 334     // No callees!
 335     Stack.pop_back();
 336     ValMap[F] = ~0;
 337     return Min;
 338   }
 339
 340   DSGraph &Graph = getOrCreateGraph(F);
 341   if (UpdateGlobals)
 342     Graph.updateFromGlobalGraph();
 343
 344   // Find all callee functions.
 345   std::vector<Function*> CalleeFunctions;
 346   GetAllAuxCallees(Graph, CalleeFunctions);
 347
 348   // The edges out of the current node are the call site targets...
 349   for (unsigned i = 0, e = CalleeFunctions.size(); i != e; ++i) {
 350     Function *Callee = CalleeFunctions[i];
 351     unsigned M;
 352     // Have we visited the destination function yet?
 353     hash_map<Function*, unsigned>::iterator It = ValMap.find(Callee);
 354     if (It == ValMap.end())  // No, visit it now.
 355       M = calculateGraphs(Callee, Stack, NextID, ValMap);
 356     else                    // Yes, get it's number.
 357       M = It->second;
 358     if (M < Min) Min = M;
 359   }
 360
 361   assert(ValMap[F] == MyID && "SCC construction assumption wrong!");
 362   if (Min != MyID)
 363     return Min;         // This is part of a larger SCC!
 364
 365   // If this is a new SCC, process it now.
 366   if (Stack.back() == F) {           // Special case the single "SCC" case here.
 367     DEBUG(std::cerr << "Visiting single node SCC #: " << MyID << " fn: "
 368                     << F->getName() << "\n");
 369     Stack.pop_back();
 370     DSGraph &G = getDSGraph(*F);
 371     DEBUG(std::cerr << "  [BU] Calculating graph for: " << F->getName()<< "\n");
 372     bool redo = calculateGraph(G);
 373     DEBUG(std::cerr << "  [BU] Done inlining: " << F->getName() << " ["
 374                     << G.getGraphSize() << "+" << G.getAuxFunctionCalls().size()
 375                     << "]\n");
 376
 377     if (MaxSCC < 1) MaxSCC = 1;
 378
 379     // Should we revisit the graph?  Only do it if there are now new resolvable
 380     // callees.
 381     if (redo) {
 382       DEBUG(std::cerr << "Recalculating " << F->getName() << " due to new knowledge\n");
 383       ValMap.erase(F);
 384       return calculateGraphs(F, Stack, NextID, ValMap);
 385     } else {
 386       ValMap[F] = ~0U;
 387     }
 388     return MyID;
 389
 390   } else {
 391     // SCCFunctions - Keep track of the functions in the current SCC
 392     //
 393     std::vector<DSGraph*> SCCGraphs;
 394
 395     unsigned SCCSize = 1;
 396     Function *NF = Stack.back();
 397     ValMap[NF] = ~0U;
 398     DSGraph &SCCGraph = getDSGraph(*NF);
 399
 400     // First thing first, collapse all of the DSGraphs into a single graph for
 401     // the entire SCC.  Splice all of the graphs into one and discard all of the
 402     // old graphs.
 403     //
 404     while (NF != F) {
 405       Stack.pop_back();
 406       NF = Stack.back();
 407       ValMap[NF] = ~0U;
 408
 409       DSGraph &NFG = getDSGraph(*NF);
 410
 411       // Update the Function -> DSG map.
 412       for (DSGraph::retnodes_iterator I = NFG.retnodes_begin(),
 413              E = NFG.retnodes_end(); I != E; ++I)
 414         DSInfo[I->first] = &SCCGraph;
 415
 416       SCCGraph.spliceFrom(NFG);
 417       delete &NFG;
 418
 419       ++SCCSize;
 420     }
 421     Stack.pop_back();
 422
 423     DEBUG(std::cerr << "Calculating graph for SCC #: " << MyID << " of size: "
 424           << SCCSize << "\n");
 425
 426     // Compute the Max SCC Size.
 427     if (MaxSCC < SCCSize)
 428       MaxSCC = SCCSize;
 429
 430     // Clean up the graph before we start inlining a bunch again...
 431     SCCGraph.removeDeadNodes(DSGraph::KeepUnreachableGlobals);
 432
 433     // Now that we have one big happy family, resolve all of the call sites in
 434     // the graph...
 435     bool redo = calculateGraph(SCCGraph);
 436     DEBUG(std::cerr << "  [BU] Done inlining SCC  [" << SCCGraph.getGraphSize()
 437                     << "+" << SCCGraph.getAuxFunctionCalls().size() << "]\n");
 438
 439     if (redo) {
 440       DEBUG(std::cerr << "MISSING REDO\n");
 441     }
 442
 443     DEBUG(std::cerr << "DONE with SCC #: " << MyID << "\n");
 444
 445     // We never have to revisit "SCC" processed functions...
 446     return MyID;
 447   }
 448
 449   return MyID;  // == Min
 450 }
 451
 452
 453 // releaseMemory - If the pass pipeline is done with this pass, we can release
 454 // our memory... here...
 455 //
 456 void BUDataStructures::releaseMyMemory() {
 457   for (hash_map<Function*, DSGraph*>::iterator I = DSInfo.begin(),
 458          E = DSInfo.end(); I != E; ++I) {
 459     I->second->getReturnNodes().erase(I->first);
 460     if (I->second->getReturnNodes().empty())
 461       delete I->second;
 462   }
 463
 464   // Empty map so next time memory is released, data structures are not
 465   // re-deleted.
 466   DSInfo.clear();
 467   delete GlobalsGraph;
 468   GlobalsGraph = 0;
 469 }
 470
 471 DSGraph &BUDataStructures::CreateGraphForExternalFunction(const Function &Fn) {
 472   Function *F = const_cast<Function*>(&Fn);
 473   DSGraph *DSG = new DSGraph(GlobalECs, GlobalsGraph->getTargetData());
 474   DSInfo[F] = DSG;
 475   DSG->setGlobalsGraph(GlobalsGraph);
 476   DSG->setPrintAuxCalls();
 477
 478   // Add function to the graph.
 479   DSG->getReturnNodes().insert(std::make_pair(F, DSNodeHandle()));
 480
 481   if (F->getName() == "free") { // Taking the address of free.
 482
 483     // Free should take a single pointer argument, mark it as heap memory.
 484     DSNode *N = new DSNode(0, DSG);
 485     N->setHeapNodeMarker();
 486     DSG->getNodeForValue(F->arg_begin()).mergeWith(N);
 487
 488   } else {
 489     std::cerr << "Unrecognized external function: " << F->getName() << "\n";
 490     abort();
 491   }
 492
 493   return *DSG;
 494 }
 495
 496
 497 bool BUDataStructures::calculateGraph(DSGraph &Graph) {
 498   // If this graph contains the main function, clone the globals graph into this
 499   // graph before we inline callees and other fun stuff.
 500   bool ContainsMain = false;
 501   DSGraph::ReturnNodesTy &ReturnNodes = Graph.getReturnNodes();
 502
 503   for (DSGraph::ReturnNodesTy::iterator I = ReturnNodes.begin(),
 504          E = ReturnNodes.end(); I != E; ++I)
 505     if (I->first->hasExternalLinkage() && I->first->getName() == "main") {
 506       ContainsMain = true;
 507       break;
 508     }
 509
 510   // If this graph contains main, copy the contents of the globals graph over.
 511   // Note that this is *required* for correctness.  If a callee contains a use
 512   // of a global, we have to make sure to link up nodes due to global-argument
 513   // bindings.
 514   if (ContainsMain) {
 515     const DSGraph &GG = *Graph.getGlobalsGraph();
 516     ReachabilityCloner RC(Graph, GG,
 517                           DSGraph::DontCloneCallNodes |
 518                           DSGraph::DontCloneAuxCallNodes);
 519
 520     // Clone the global nodes into this graph.
 521     for (DSScalarMap::global_iterator I = GG.getScalarMap().global_begin(),
 522            E = GG.getScalarMap().global_end(); I != E; ++I)
 523       if (isa<GlobalVariable>(*I))
 524         RC.getClonedNH(GG.getNodeForValue(*I));
 525   }
 526
 527
 528   // Move our call site list into TempFCs so that inline call sites go into the
 529   // new call site list and doesn't invalidate our iterators!
 530   std::list<DSCallSite> TempFCs;
 531   std::list<DSCallSite> &AuxCallsList = Graph.getAuxFunctionCalls();
 532   TempFCs.swap(AuxCallsList);
 533   //remember what we've seen (or will see)
 534   unsigned oldSize = TempFCs.size();
 535
 536   bool Printed = false;
 537   bool missingNode = false;
 538
 539   while (!TempFCs.empty()) {
 540     DSCallSite &CS = *TempFCs.begin();
 541     Instruction *TheCall = CS.getCallSite().getInstruction();
 542     DSGraph *GI;
 543
 544     // Fast path for noop calls.  Note that we don't care about merging globals
 545     // in the callee with nodes in the caller here.
 546     if (CS.isDirectCall()) {
 547       if (!isVAHackFn(CS.getCalleeFunc()) && isResolvableFunc(CS.getCalleeFunc())) {
 548         Function* Callee = CS.getCalleeFunc();
 549         ActualCallees.insert(std::make_pair(TheCall, Callee));
 550
 551         assert(doneDSGraph(Callee) && "Direct calls should always be precomputed");
 552         GI = &getDSGraph(*Callee);  // Graph to inline
 553         DEBUG(std::cerr << "    Inlining graph for " << Callee->getName());
 554         DEBUG(std::cerr << "[" << GI->getGraphSize() << "+"
 555               << GI->getAuxFunctionCalls().size() << "] into '"
 556               << Graph.getFunctionNames() << "' [" << Graph.getGraphSize() <<"+"
 557               << Graph.getAuxFunctionCalls().size() << "]\n");
 558         Graph.mergeInGraph(CS, *Callee, *GI,
 559                            DSGraph::StripAllocaBit|DSGraph::DontCloneCallNodes);
 560         ++NumBUInlines;
 561       } else {
 562         DEBUG(std::cerr << "Graph " << Graph.getFunctionNames() << " Call Site " <<
 563               CS.getCallSite().getInstruction() << " never resolvable\n");
 564       }
 565       --oldSize;
 566       TempFCs.pop_front();
 567       continue;
 568     } else {
 569       std::vector<Function*> CalledFuncs;
 570       bool resolved = GetAllCallees(CS, CalledFuncs);
 571
 572       if (CalledFuncs.empty()) {
 573         DEBUG(std::cerr << "Graph " << Graph.getFunctionNames() << " Call Site " <<
 574               CS.getCallSite().getInstruction() << " delayed\n");
 575       } else {
 576         DEBUG(
 577         if (!Printed)
 578           std::cerr << "In Fns: " << Graph.getFunctionNames() << "\n";
 579         std::cerr << "  calls " << CalledFuncs.size()
 580                   << " fns from site: " << CS.getCallSite().getInstruction()
 581                   << "  " << *CS.getCallSite().getInstruction();
 582         std::cerr << "   Fns =";
 583         );
 584         unsigned NumPrinted = 0;
 585
 586         for (std::vector<Function*>::iterator I = CalledFuncs.begin(),
 587                E = CalledFuncs.end(); I != E; ++I) {
 588           DEBUG(if (NumPrinted++ < 8) std::cerr << " " << (*I)->getName(););
 589
 590           // Add the call edges to the call graph.
 591           ActualCallees.insert(std::make_pair(TheCall, *I));
 592         }
 593         DEBUG(std::cerr << "\n");
 594
 595         // See if we already computed a graph for this set of callees.
 596         std::sort(CalledFuncs.begin(), CalledFuncs.end());
 597         std::pair<DSGraph*, std::vector<DSNodeHandle> > &IndCallGraph =
 598           (*IndCallGraphMap)[CalledFuncs];
 599
 600         if (IndCallGraph.first == 0) {
 601           std::vector<Function*>::iterator I = CalledFuncs.begin(),
 602             E = CalledFuncs.end();
 603
 604           // Start with a copy of the first graph.
 605           if (!doneDSGraph(*I)) {
 606             AuxCallsList.splice(AuxCallsList.end(), TempFCs, TempFCs.begin());
 607             missingNode = true;
 608             continue;
 609           }
 610
 611           AddGlobalToNode(this, CS, *I);
 612
 613           GI = IndCallGraph.first = new DSGraph(getDSGraph(**I), GlobalECs);
 614           GI->setGlobalsGraph(Graph.getGlobalsGraph());
 615           std::vector<DSNodeHandle> &Args = IndCallGraph.second;
 616
 617           // Get the argument nodes for the first callee.  The return value is
 618           // the 0th index in the vector.
 619           GI->getFunctionArgumentsForCall(*I, Args);
 620
 621           // Merge all of the other callees into this graph.
 622           bool locMissing = false;
 623           for (++I; I != E && !locMissing; ++I) {
 624             AddGlobalToNode(this, CS, *I);
 625             // If the graph already contains the nodes for the function, don't
 626             // bother merging it in again.
 627             if (!GI->containsFunction(*I)) {
 628               if (!doneDSGraph(*I)) {
 629                 locMissing = true;
 630                 break;
 631               }
 632
 633               GI->cloneInto(getDSGraph(**I));
 634               ++NumBUInlines;
 635             }
 636
 637             std::vector<DSNodeHandle> NextArgs;
 638             GI->getFunctionArgumentsForCall(*I, NextArgs);
 639             unsigned i = 0, e = Args.size();
 640             for (; i != e; ++i) {
 641               if (i == NextArgs.size()) break;
 642               Args[i].mergeWith(NextArgs[i]);
 643             }
 644             for (e = NextArgs.size(); i != e; ++i)
 645               Args.push_back(NextArgs[i]);
 646           }
 647           if (locMissing) {
 648             AuxCallsList.splice(AuxCallsList.end(), TempFCs, TempFCs.begin());
 649             missingNode = true;
 650             continue;
 651           }
 652
 653           // Clean up the final graph!
 654           GI->removeDeadNodes(DSGraph::KeepUnreachableGlobals);
 655         } else {
 656           DEBUG(std::cerr << "***\n*** RECYCLED GRAPH ***\n***\n");
 657           for (std::vector<Function*>::iterator I = CalledFuncs.begin(), E = CalledFuncs.end(); I != E; ++I) {
 658             AddGlobalToNode(this, CS, *I);
 659           }
 660         }
 661
 662         GI = IndCallGraph.first;
 663
 664         if (AlreadyInlined[CS.getCallSite()] != CalledFuncs) {
 665          AlreadyInlined[CS.getCallSite()].swap(CalledFuncs);
 666
 667           // Merge the unified graph into this graph now.
 668           DEBUG(std::cerr << "    Inlining multi callee graph "
 669                 << "[" << GI->getGraphSize() << "+"
 670                 << GI->getAuxFunctionCalls().size() << "] into '"
 671                 << Graph.getFunctionNames() << "' [" << Graph.getGraphSize() <<"+"
 672                 << Graph.getAuxFunctionCalls().size() << "]\n");
 673
 674           Graph.mergeInGraph(CS, IndCallGraph.second, *GI,
 675                              DSGraph::StripAllocaBit |
 676                              DSGraph::DontCloneCallNodes);
 677
 678           ++NumBUInlines;
 679         } else {
 680           DEBUG(std::cerr << "   Skipping already inlined graph\n");
 681         }
 682       }
 683       AuxCallsList.splice(AuxCallsList.end(), TempFCs, TempFCs.begin());
 684     }
 685   }
 686
 687   // Recompute the Incomplete markers
 688   Graph.maskIncompleteMarkers();
 689   Graph.markIncompleteNodes(DSGraph::MarkFormalArgs);
 690
 691   // Delete dead nodes.  Treat globals that are unreachable but that can
 692   // reach live nodes as live.
 693   Graph.removeDeadNodes(DSGraph::KeepUnreachableGlobals);
 694
 695   // When this graph is finalized, clone the globals in the graph into the
 696   // globals graph to make sure it has everything, from all graphs.
 697   DSScalarMap &MainSM = Graph.getScalarMap();
 698   ReachabilityCloner RC(*GlobalsGraph, Graph, DSGraph::StripAllocaBit);
 699
 700   // Clone everything reachable from globals in the function graph into the
 701   // globals graph.
 702   for (DSScalarMap::global_iterator I = MainSM.global_begin(),
 703          E = MainSM.global_end(); I != E; ++I)
 704     RC.getClonedNH(MainSM[*I]);
 705
 706   //Graph.writeGraphToFile(std::cerr, "bu_" + F.getName());
 707   AuxCallsList.sort();
 708   AuxCallsList.unique();
 709   //conditionally prune the call list keeping only one copy of each actual
 710   //CallSite
 711   if (AuxCallsList.size() > 100) {
 712     DEBUG(std::cerr << "Reducing Aux from " << AuxCallsList.size());
 713     std::map<CallSite, std::list<DSCallSite>::iterator> keepers;
 714     TempFCs.swap(AuxCallsList);
 715     for( std::list<DSCallSite>::iterator ii = TempFCs.begin(), ee = TempFCs.end();
 716          ii != ee; ++ii)
 717       keepers[ii->getCallSite()] = ii;
 718     for (std::map<CallSite, std::list<DSCallSite>::iterator>::iterator
 719            ii = keepers.begin(), ee = keepers.end();
 720          ii != ee; ++ii)
 721       AuxCallsList.splice(AuxCallsList.end(), TempFCs, ii->second);
 722     DEBUG(std::cerr << " to " << AuxCallsList.size() << "\n");
 723   }
 724   return missingNode || oldSize != AuxCallsList.size();
 725 }
 726
 727 static const Function *getFnForValue(const Value *V) {
 728   if (const Instruction *I = dyn_cast<Instruction>(V))
 729     return I->getParent()->getParent();
 730   else if (const Argument *A = dyn_cast<Argument>(V))
 731     return A->getParent();
 732   else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
 733     return BB->getParent();
 734   return 0;
 735 }
 736
 737 /// deleteValue/copyValue - Interfaces to update the DSGraphs in the program.
 738 /// These correspond to the interfaces defined in the AliasAnalysis class.
 739 void BUDataStructures::deleteValue(Value *V) {
 740   if (const Function *F = getFnForValue(V)) {  // Function local value?
 741     // If this is a function local value, just delete it from the scalar map!
 742     getDSGraph(*F).getScalarMap().eraseIfExists(V);
 743     return;
 744   }
 745
 746   if (Function *F = dyn_cast<Function>(V)) {
 747     assert(getDSGraph(*F).getReturnNodes().size() == 1 &&
 748            "cannot handle scc's");
 749     delete DSInfo[F];
 750     DSInfo.erase(F);
 751     return;
 752   }
 753
 754   assert(!isa<GlobalVariable>(V) && "Do not know how to delete GV's yet!");
 755 }
 756
 757 void BUDataStructures::copyValue(Value *From, Value *To) {
 758   if (From == To) return;
 759   if (const Function *F = getFnForValue(From)) {  // Function local value?
 760     // If this is a function local value, just delete it from the scalar map!
 761     getDSGraph(*F).getScalarMap().copyScalarIfExists(From, To);
 762     return;
 763   }
 764
 765   if (Function *FromF = dyn_cast<Function>(From)) {
 766     Function *ToF = cast<Function>(To);
 767     assert(!DSInfo.count(ToF) && "New Function already exists!");
 768     DSGraph *NG = new DSGraph(getDSGraph(*FromF), GlobalECs);
 769     DSInfo[ToF] = NG;
 770     assert(NG->getReturnNodes().size() == 1 && "Cannot copy SCC's yet!");
 771
 772     // Change the Function* is the returnnodes map to the ToF.
 773     DSNodeHandle Ret = NG->retnodes_begin()->second;
 774     NG->getReturnNodes().clear();
 775     NG->getReturnNodes()[ToF] = Ret;
 776     return;
 777   }
 778
 779   if (const Function *F = getFnForValue(To)) {
 780     DSGraph &G = getDSGraph(*F);
 781     G.getScalarMap().copyScalarIfExists(From, To);
 782     return;
 783   }
 784
 785   std::cerr << *From;
 786   std::cerr << *To;
 787   assert(0 && "Do not know how to copy this yet!");
 788   abort();
 789 }