//===- BottomUpClosure.cpp - Compute bottom-up interprocedural closure ----===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
//
// This file implements the BUDataStructures class, which represents the
// Bottom-Up Interprocedural closure of the data structure graph over the
//===----------------------------------------------------------------------===//
#include "llvm/Analysis/DataStructure.h"
-#include "llvm/Analysis/DSGraph.h"
#include "llvm/Module.h"
#include "Support/Statistic.h"
-using std::map;
+#include "Support/Debug.h"
+#include "DSCallSiteIterator.h"
namespace {
Statistic<> MaxSCC("budatastructure", "Maximum SCC Size in Call Graph");
+ Statistic<> NumBUInlines("budatastructures", "Number of graphs inlined");
+ Statistic<> NumCallEdges("budatastructures", "Number of 'actual' call edges");
RegisterAnalysis<BUDataStructures>
- X("budatastructure", "Bottom-up Data Structure Analysis Closure");
+ X("budatastructure", "Bottom-up Data Structure Analysis");
}
using namespace DS;
-// isCompleteNode - Return true if we know all of the targets of this node, and
-// if the call sites are not external.
-//
-static inline bool isCompleteNode(DSNode *N) {
- if (N->NodeType & DSNode::Incomplete) return false;
- const std::vector<GlobalValue*> &Callees = N->getGlobals();
- for (unsigned i = 0, e = Callees.size(); i != e; ++i)
- if (Callees[i]->isExternal()) {
- GlobalValue &FI = cast<Function>(*Callees[i]);
- if (FI.getName() != "printf" && FI.getName() != "sscanf" &&
- FI.getName() != "fprintf" && FI.getName() != "open" &&
- FI.getName() != "sprintf" && FI.getName() != "fputs")
- return false; // External function found...
- }
- return true; // otherwise ok
-}
-
-struct CallSiteIterator {
- // FCs are the edges out of the current node are the call site targets...
- std::vector<DSCallSite> *FCs;
- unsigned CallSite;
- unsigned CallSiteEntry;
-
- CallSiteIterator(std::vector<DSCallSite> &CS) : FCs(&CS) {
- CallSite = 0; CallSiteEntry = 0;
- advanceToNextValid();
- }
-
- // End iterator ctor...
- CallSiteIterator(std::vector<DSCallSite> &CS, bool) : FCs(&CS) {
- CallSite = FCs->size(); CallSiteEntry = 0;
- }
-
- void advanceToNextValid() {
- while (CallSite < FCs->size()) {
- if (DSNode *CalleeNode = (*FCs)[CallSite].getCallee().getNode()) {
- if (CallSiteEntry || isCompleteNode(CalleeNode)) {
- const std::vector<GlobalValue*> &Callees = CalleeNode->getGlobals();
-
- if (CallSiteEntry < Callees.size())
- return;
- }
- CallSiteEntry = 0;
- ++CallSite;
- }
- }
- }
-public:
- static CallSiteIterator begin(DSGraph &G) { return G.getAuxFunctionCalls(); }
- static CallSiteIterator end(DSGraph &G) {
- return CallSiteIterator(G.getAuxFunctionCalls(), true);
- }
- static CallSiteIterator begin(std::vector<DSCallSite> &CSs) { return CSs; }
- static CallSiteIterator end(std::vector<DSCallSite> &CSs) {
- return CallSiteIterator(CSs, true);
- }
- bool operator==(const CallSiteIterator &CSI) const {
- return CallSite == CSI.CallSite && CallSiteEntry == CSI.CallSiteEntry;
- }
- bool operator!=(const CallSiteIterator &CSI) const { return !operator==(CSI);}
-
- unsigned getCallSiteIdx() const { return CallSite; }
- DSCallSite &getCallSite() const { return (*FCs)[CallSite]; }
-
- Function* operator*() const {
- DSNode *Node = (*FCs)[CallSite].getCallee().getNode();
- return cast<Function>(Node->getGlobals()[CallSiteEntry]);
- }
-
- CallSiteIterator& operator++() { // Preincrement
- ++CallSiteEntry;
- advanceToNextValid();
- return *this;
- }
- CallSiteIterator operator++(int) { // Postincrement
- CallSiteIterator tmp = *this; ++*this; return tmp;
- }
-};
-
-
-
// run - Calculate the bottom up data structure graphs for each function in the
// program.
//
bool BUDataStructures::run(Module &M) {
- GlobalsGraph = new DSGraph();
+ LocalDataStructures &LocalDSA = getAnalysis<LocalDataStructures>();
+ GlobalsGraph = new DSGraph(LocalDSA.getGlobalsGraph());
+ GlobalsGraph->setPrintAuxCalls();
Function *MainFunc = M.getMainFunction();
if (MainFunc)
// Calculate the graphs for any functions that are unreachable from main...
for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
- if (!I->isExternal() && DSInfo.find(I) == DSInfo.end()) {
+ if (!I->isExternal() && !DSInfo.count(I)) {
#ifndef NDEBUG
if (MainFunc)
std::cerr << "*** Function unreachable from main: "
#endif
calculateReachableGraphs(I); // Calculate all graphs...
}
+
+ NumCallEdges += ActualCallees.size();
+
+ // At the end of the bottom-up pass, the globals graph becomes complete.
+ // FIXME: This is not the right way to do this, but it is sorta better than
+ // nothing! In particular, externally visible globals and unresolvable call
+ // nodes at the end of the BU phase should make things that they point to
+ // incomplete in the globals graph.
+ //
+ GlobalsGraph->maskIncompleteMarkers();
return false;
}
void BUDataStructures::calculateReachableGraphs(Function *F) {
std::vector<Function*> Stack;
- std::map<Function*, unsigned> ValMap;
+ hash_map<Function*, unsigned> ValMap;
unsigned NextID = 1;
calculateGraphs(F, Stack, NextID, ValMap);
}
unsigned BUDataStructures::calculateGraphs(Function *F,
std::vector<Function*> &Stack,
unsigned &NextID,
- std::map<Function*, unsigned> &ValMap) {
+ hash_map<Function*, unsigned> &ValMap) {
assert(ValMap.find(F) == ValMap.end() && "Shouldn't revisit functions!");
unsigned Min = NextID++, MyID = Min;
ValMap[F] = Min;
DSGraph &Graph = getOrCreateGraph(F);
// The edges out of the current node are the call site targets...
- for (CallSiteIterator I = CallSiteIterator::begin(Graph),
- E = CallSiteIterator::end(Graph); I != E; ++I) {
+ for (DSCallSiteIterator I = DSCallSiteIterator::begin_aux(Graph),
+ E = DSCallSiteIterator::end_aux(Graph); I != E; ++I) {
Function *Callee = *I;
unsigned M;
// Have we visited the destination function yet?
- std::map<Function*, unsigned>::iterator It = ValMap.find(Callee);
+ hash_map<Function*, unsigned>::iterator It = ValMap.find(Callee);
if (It == ValMap.end()) // No, visit it now.
M = calculateGraphs(Callee, Stack, NextID, ValMap);
else // Yes, get it's number.
DEBUG(std::cerr << "Visiting single node SCC #: " << MyID << " fn: "
<< F->getName() << "\n");
Stack.pop_back();
- DSGraph &G = calculateGraph(*F);
+ DSGraph &G = getDSGraph(*F);
+ DEBUG(std::cerr << " [BU] Calculating graph for: " << F->getName()<< "\n");
+ calculateGraph(G);
+ DEBUG(std::cerr << " [BU] Done inlining: " << F->getName() << " ["
+ << G.getGraphSize() << "+" << G.getAuxFunctionCalls().size()
+ << "]\n");
if (MaxSCC < 1) MaxSCC = 1;
// Should we revisit the graph?
- if (CallSiteIterator::begin(G) != CallSiteIterator::end(G)) {
+ if (DSCallSiteIterator::begin_aux(G) != DSCallSiteIterator::end_aux(G)) {
ValMap.erase(F);
return calculateGraphs(F, Stack, NextID, ValMap);
} else {
} else {
// SCCFunctions - Keep track of the functions in the current SCC
//
- std::set<Function*> SCCFunctions;
+ hash_set<Function*> SCCFunctions;
Function *NF;
std::vector<Function*>::iterator FirstInSCC = Stack.end();
+ DSGraph *SCCGraph = 0;
do {
NF = *--FirstInSCC;
ValMap[NF] = ~0U;
SCCFunctions.insert(NF);
+
+ // Figure out which graph is the largest one, in order to speed things up
+ // a bit in situations where functions in the SCC have widely different
+ // graph sizes.
+ DSGraph &NFGraph = getDSGraph(*NF);
+ if (!SCCGraph || SCCGraph->getGraphSize() < NFGraph.getGraphSize())
+ SCCGraph = &NFGraph;
} while (NF != F);
- std::cerr << "Identified SCC #: " << MyID << " of size: "
- << (Stack.end()-FirstInSCC) << "\n";
+ std::cerr << "Calculating graph for SCC #: " << MyID << " of size: "
+ << SCCFunctions.size() << "\n";
// Compute the Max SCC Size...
- if (MaxSCC < unsigned(Stack.end()-FirstInSCC))
- MaxSCC = Stack.end()-FirstInSCC;
-
- std::vector<Function*>::iterator I = Stack.end();
- do {
- --I;
-#ifndef NDEBUG
- /*DEBUG*/(std::cerr << " Fn #" << (Stack.end()-I) << "/"
- << (Stack.end()-FirstInSCC) << " in SCC: "
- << (*I)->getName());
- DSGraph &G = getDSGraph(**I);
- std::cerr << " [" << G.getGraphSize() << "+"
- << G.getAuxFunctionCalls().size() << "] ";
-#endif
-
- // Eliminate all call sites in the SCC that are not to functions that are
- // in the SCC.
- inlineNonSCCGraphs(**I, SCCFunctions);
-
-#ifndef NDEBUG
- std::cerr << "after Non-SCC's [" << G.getGraphSize() << "+"
- << G.getAuxFunctionCalls().size() << "]\n";
-#endif
- } while (I != FirstInSCC);
+ if (MaxSCC < SCCFunctions.size())
+ MaxSCC = SCCFunctions.size();
- I = Stack.end();
- do {
- --I;
-#ifndef NDEBUG
- /*DEBUG*/(std::cerr << " Fn #" << (Stack.end()-I) << "/"
- << (Stack.end()-FirstInSCC) << " in SCC: "
- << (*I)->getName());
+ // First thing first, collapse all of the DSGraphs into a single graph for
+ // the entire SCC. We computed the largest graph, so clone all of the other
+ // (smaller) graphs into it. Discard all of the old graphs.
+ //
+ for (hash_set<Function*>::iterator I = SCCFunctions.begin(),
+ E = SCCFunctions.end(); I != E; ++I) {
DSGraph &G = getDSGraph(**I);
- std::cerr << " [" << G.getGraphSize() << "+"
- << G.getAuxFunctionCalls().size() << "] ";
-#endif
- // Inline all graphs into the SCC nodes...
- calculateSCCGraph(**I, SCCFunctions);
+ if (&G != SCCGraph) {
+ DSGraph::NodeMapTy NodeMap;
+ SCCGraph->cloneInto(G, SCCGraph->getScalarMap(),
+ SCCGraph->getReturnNodes(), NodeMap, 0);
+ // Update the DSInfo map and delete the old graph...
+ DSInfo[*I] = SCCGraph;
+ delete &G;
+ }
+ }
-#ifndef NDEBUG
- std::cerr << "after [" << G.getGraphSize() << "+"
- << G.getAuxFunctionCalls().size() << "]\n";
-#endif
- } while (I != FirstInSCC);
+ // Clean up the graph before we start inlining a bunch again...
+ SCCGraph->removeTriviallyDeadNodes();
+ // Now that we have one big happy family, resolve all of the call sites in
+ // the graph...
+ calculateGraph(*SCCGraph);
+ DEBUG(std::cerr << " [BU] Done inlining SCC [" << SCCGraph->getGraphSize()
+ << "+" << SCCGraph->getAuxFunctionCalls().size() << "]\n");
std::cerr << "DONE with SCC #: " << MyID << "\n";
// our memory... here...
//
void BUDataStructures::releaseMemory() {
- for (map<const Function*, DSGraph*>::iterator I = DSInfo.begin(),
- E = DSInfo.end(); I != E; ++I)
- delete I->second;
+ for (hash_map<Function*, DSGraph*>::iterator I = DSInfo.begin(),
+ E = DSInfo.end(); I != E; ++I) {
+ I->second->getReturnNodes().erase(I->first);
+ if (I->second->getReturnNodes().empty())
+ delete I->second;
+ }
// Empty map so next time memory is released, data structures are not
// re-deleted.
GlobalsGraph = 0;
}
-DSGraph &BUDataStructures::calculateGraph(Function &F) {
- DSGraph &Graph = getDSGraph(F);
- DEBUG(std::cerr << " [BU] Calculating graph for: " << F.getName() << "\n");
-
+void BUDataStructures::calculateGraph(DSGraph &Graph) {
// Move our call site list into TempFCs so that inline call sites go into the
// new call site list and doesn't invalidate our iterators!
std::vector<DSCallSite> TempFCs;
std::vector<DSCallSite> &AuxCallsList = Graph.getAuxFunctionCalls();
TempFCs.swap(AuxCallsList);
+ DSGraph::ReturnNodesTy &ReturnNodes = Graph.getReturnNodes();
+
// Loop over all of the resolvable call sites
unsigned LastCallSiteIdx = ~0U;
- for (CallSiteIterator I = CallSiteIterator::begin(TempFCs),
- E = CallSiteIterator::end(TempFCs); I != E; ++I) {
+ for (DSCallSiteIterator I = DSCallSiteIterator::begin(TempFCs),
+ E = DSCallSiteIterator::end(TempFCs); I != E; ++I) {
// If we skipped over any call sites, they must be unresolvable, copy them
// to the real call site list.
LastCallSiteIdx++;
// Resolve the current call...
Function *Callee = *I;
- DSCallSite &CS = I.getCallSite();
+ DSCallSite CS = I.getCallSite();
if (Callee->isExternal()) {
// Ignore this case, simple varargs functions we cannot stub out!
- } else if (Callee == &F) {
+ } else if (ReturnNodes.find(Callee) != ReturnNodes.end()) {
// Self recursion... simply link up the formal arguments with the
// actual arguments...
- DEBUG(std::cerr << " Self Inlining: " << F.getName() << "\n");
+ DEBUG(std::cerr << " Self Inlining: " << Callee->getName() << "\n");
// Handle self recursion by resolving the arguments and return value
- Graph.mergeInGraph(CS, Graph, 0);
+ Graph.mergeInGraph(CS, *Callee, Graph, 0);
} else {
+ ActualCallees.insert(std::make_pair(CS.getCallSite().getInstruction(),
+ Callee));
+
// Get the data structure graph for the called function.
//
DSGraph &GI = getDSGraph(*Callee); // Graph to inline
DEBUG(std::cerr << " Inlining graph for " << Callee->getName()
- << " in: " << F.getName() << "[" << GI.getGraphSize() << "+"
- << GI.getAuxFunctionCalls().size() << "]\n");
-
-#if 0
- Graph.writeGraphToFile(std::cerr, "bu_" + F.getName() + "_before_" +
- Callee->getName());
-#endif
+ << "[" << GI.getGraphSize() << "+"
+ << GI.getAuxFunctionCalls().size() << "] into '"
+ << Graph.getFunctionNames() << "' [" << Graph.getGraphSize() << "+"
+ << Graph.getAuxFunctionCalls().size() << "]\n");
// Handle self recursion by resolving the arguments and return value
- Graph.mergeInGraph(CS, GI,
+ Graph.mergeInGraph(CS, *Callee, GI,
DSGraph::KeepModRefBits |
DSGraph::StripAllocaBit | DSGraph::DontCloneCallNodes);
+ ++NumBUInlines;
#if 0
Graph.writeGraphToFile(std::cerr, "bu_" + F.getName() + "_after_" +
TempFCs.clear();
- // Recompute the Incomplete markers. If there are any function calls left
- // now that are complete, we must loop!
- Graph.maskIncompleteMarkers();
- Graph.markIncompleteNodes(DSGraph::MarkFormalArgs);
- Graph.removeDeadNodes(DSGraph::KeepUnreachableGlobals);
-
- DEBUG(std::cerr << " [BU] Done inlining: " << F.getName() << " ["
- << Graph.getGraphSize() << "+" << Graph.getAuxFunctionCalls().size()
- << "]\n");
-
- //Graph.writeGraphToFile(std::cerr, "bu_" + F.getName());
-
- return Graph;
-}
-
+ // Re-materialize nodes from the globals graph.
+ // Do not ignore globals inlined from callees -- they are not up-to-date!
+ Graph.getInlinedGlobals().clear();
+ Graph.updateFromGlobalGraph();
-// inlineNonSCCGraphs - This method is almost like the other two calculate graph
-// methods. This one is used to inline function graphs (from functions outside
-// of the SCC) into functions in the SCC. It is not supposed to touch functions
-// IN the SCC at all.
-//
-DSGraph &BUDataStructures::inlineNonSCCGraphs(Function &F,
- std::set<Function*> &SCCFunctions){
- DSGraph &Graph = getDSGraph(F);
- DEBUG(std::cerr << " [BU] Inlining Non-SCC graphs for: "
- << F.getName() << "\n");
-
- // Move our call site list into TempFCs so that inline call sites go into the
- // new call site list and doesn't invalidate our iterators!
- std::vector<DSCallSite> TempFCs;
- std::vector<DSCallSite> &AuxCallsList = Graph.getAuxFunctionCalls();
- TempFCs.swap(AuxCallsList);
-
- // Loop over all of the resolvable call sites
- unsigned LastCallSiteIdx = ~0U;
- for (CallSiteIterator I = CallSiteIterator::begin(TempFCs),
- E = CallSiteIterator::end(TempFCs); I != E; ++I) {
- // If we skipped over any call sites, they must be unresolvable, copy them
- // to the real call site list.
- LastCallSiteIdx++;
- for (; LastCallSiteIdx < I.getCallSiteIdx(); ++LastCallSiteIdx)
- AuxCallsList.push_back(TempFCs[LastCallSiteIdx]);
- LastCallSiteIdx = I.getCallSiteIdx();
-
- // Resolve the current call...
- Function *Callee = *I;
- DSCallSite &CS = I.getCallSite();
-
- if (Callee->isExternal()) {
- // Ignore this case, simple varargs functions we cannot stub out!
- } else if (SCCFunctions.count(Callee)) {
- // Calling a function in the SCC, ignore it for now!
- DEBUG(std::cerr << " SCC CallSite for: " << Callee->getName() << "\n");
- AuxCallsList.push_back(CS);
- } else {
- // Get the data structure graph for the called function.
- //
- DSGraph &GI = getDSGraph(*Callee); // Graph to inline
-
- DEBUG(std::cerr << " Inlining graph for " << Callee->getName()
- << " in: " << F.getName() << "[" << GI.getGraphSize() << "+"
- << GI.getAuxFunctionCalls().size() << "]\n");
-
- // Handle self recursion by resolving the arguments and return value
- Graph.mergeInGraph(CS, GI,
- DSGraph::KeepModRefBits | DSGraph::StripAllocaBit |
- DSGraph::DontCloneCallNodes);
- }
- }
-
- // Make sure to catch any leftover unresolvable calls...
- for (++LastCallSiteIdx; LastCallSiteIdx < TempFCs.size(); ++LastCallSiteIdx)
- AuxCallsList.push_back(TempFCs[LastCallSiteIdx]);
-
- TempFCs.clear();
-
- // Recompute the Incomplete markers. If there are any function calls left
- // now that are complete, we must loop!
+ // Recompute the Incomplete markers
Graph.maskIncompleteMarkers();
Graph.markIncompleteNodes(DSGraph::MarkFormalArgs);
- Graph.removeDeadNodes(DSGraph::KeepUnreachableGlobals);
-
- DEBUG(std::cerr << " [BU] Done Non-SCC inlining: " << F.getName() << " ["
- << Graph.getGraphSize() << "+" << Graph.getAuxFunctionCalls().size()
- << "]\n");
- return Graph;
-}
-
-
-DSGraph &BUDataStructures::calculateSCCGraph(Function &F,
- std::set<Function*> &SCCFunctions){
- DSGraph &Graph = getDSGraph(F);
- DEBUG(std::cerr << " [BU] Calculating SCC graph for: " << F.getName()<<"\n");
-
- std::vector<DSCallSite> UnresolvableCalls;
- std::map<Function*, DSCallSite> SCCCallSiteMap;
- std::vector<DSCallSite> &AuxCallsList = Graph.getAuxFunctionCalls();
-
- while (1) { // Loop until we run out of resolvable call sites!
- // Move our call site list into TempFCs so that inline call sites go into
- // the new call site list and doesn't invalidate our iterators!
- std::vector<DSCallSite> TempFCs;
- TempFCs.swap(AuxCallsList);
-
- // Loop over all of the resolvable call sites
- unsigned LastCallSiteIdx = ~0U;
- CallSiteIterator I = CallSiteIterator::begin(TempFCs),
- E = CallSiteIterator::end(TempFCs);
- if (I == E) {
- TempFCs.swap(AuxCallsList);
- break; // Done when no resolvable call sites exist
- }
-
- for (; I != E; ++I) {
- // If we skipped over any call sites, they must be unresolvable, copy them
- // to the unresolvable site list.
- LastCallSiteIdx++;
- for (; LastCallSiteIdx < I.getCallSiteIdx(); ++LastCallSiteIdx)
- UnresolvableCalls.push_back(TempFCs[LastCallSiteIdx]);
- LastCallSiteIdx = I.getCallSiteIdx();
-
- // Resolve the current call...
- Function *Callee = *I;
- DSCallSite &CS = I.getCallSite();
-
- if (Callee->isExternal()) {
- // Ignore this case, simple varargs functions we cannot stub out!
- } else if (Callee == &F) {
- // Self recursion... simply link up the formal arguments with the
- // actual arguments...
- DEBUG(std::cerr << " Self Inlining: " << F.getName() << "\n");
-
- // Handle self recursion by resolving the arguments and return value
- Graph.mergeInGraph(CS, Graph, 0);
- } else if (SCCCallSiteMap.count(Callee)) {
- // We have already seen a call site in the SCC for this function, just
- // merge the two call sites together and we are done.
- SCCCallSiteMap.find(Callee)->second.mergeWith(CS);
- } else {
- // Get the data structure graph for the called function.
- //
- DSGraph &GI = getDSGraph(*Callee); // Graph to inline
-
- DEBUG(std::cerr << " Inlining graph for " << Callee->getName()
- << " in: " << F.getName() << "[" << GI.getGraphSize() << "+"
- << GI.getAuxFunctionCalls().size() << "]\n");
-
- // Handle self recursion by resolving the arguments and return value
- Graph.mergeInGraph(CS, GI,
- DSGraph::KeepModRefBits | DSGraph::StripAllocaBit |
- DSGraph::DontCloneCallNodes);
-
- if (SCCFunctions.count(Callee))
- SCCCallSiteMap.insert(std::make_pair(Callee, CS));
- }
- }
-
- // Make sure to catch any leftover unresolvable calls...
- for (++LastCallSiteIdx; LastCallSiteIdx < TempFCs.size(); ++LastCallSiteIdx)
- UnresolvableCalls.push_back(TempFCs[LastCallSiteIdx]);
- }
-
- // Reset the SCCCallSiteMap...
- SCCCallSiteMap.clear();
-
- AuxCallsList.insert(AuxCallsList.end(), UnresolvableCalls.begin(),
- UnresolvableCalls.end());
- UnresolvableCalls.clear();
-
-
- // Recompute the Incomplete markers. If there are any function calls left
- // now that are complete, we must loop!
- Graph.maskIncompleteMarkers();
- Graph.markIncompleteNodes(DSGraph::MarkFormalArgs);
+ // Delete dead nodes. Treat globals that are unreachable but that can
+ // reach live nodes as live.
Graph.removeDeadNodes(DSGraph::KeepUnreachableGlobals);
- DEBUG(std::cerr << " [BU] Done inlining: " << F.getName() << " ["
- << Graph.getGraphSize() << "+" << Graph.getAuxFunctionCalls().size()
- << "]\n");
//Graph.writeGraphToFile(std::cerr, "bu_" + F.getName());
-
- return Graph;
}
+