#define LLVM_ANALYSIS_DSGRAPH_H
#include "llvm/Analysis/DSNode.h"
+class GlobalValue;
//===----------------------------------------------------------------------===//
/// DSGraph - The graph that represents a function.
///
-class DSGraph {
- Function *Func;
+struct DSGraph {
+ // Public data-type declarations...
+ typedef hash_map<Value*, DSNodeHandle> ScalarMapTy;
+ typedef hash_map<Function*, DSNodeHandle> ReturnNodesTy;
+ typedef hash_set<const GlobalValue*> GlobalSetTy;
+
+ /// NodeMapTy - This data type is used when cloning one graph into another to
+ /// keep track of the correspondence between the nodes in the old and new
+ /// graphs.
+ typedef hash_map<const DSNode*, DSNodeHandle> NodeMapTy;
+private:
+ DSGraph *GlobalsGraph; // Pointer to the common graph of global objects
+ bool PrintAuxCalls; // Should this graph print the Aux calls vector?
+
std::vector<DSNode*> Nodes;
- DSNodeHandle RetNode; // Node that gets returned...
- std::map<Value*, DSNodeHandle> ScalarMap;
+ ScalarMapTy ScalarMap;
-#if 0
- // GlobalsGraph -- Reference to the common graph of globally visible objects.
- // This includes GlobalValues, New nodes, Cast nodes, and Calls.
- //
- GlobalDSGraph* GlobalsGraph;
-#endif
+ // ReturnNodes - A return value for every function merged into this graph.
+ // Each DSGraph may have multiple functions merged into it at any time, which
+ // is used for representing SCCs.
+ //
+ ReturnNodesTy ReturnNodes;
// FunctionCalls - This vector maintains a single entry for each call
- // instruction in the current graph. Each call entry contains DSNodeHandles
- // that refer to the arguments that are passed into the function call. The
- // first entry in the vector is the scalar that holds the return value for the
- // call, the second is the function scalar being invoked, and the rest are
- // pointer arguments to the function.
+ // instruction in the current graph. The first entry in the vector is the
+ // scalar that holds the return value for the call, the second is the function
+ // scalar being invoked, and the rest are pointer arguments to the function.
+ // This vector is built by the Local graph and is never modified after that.
//
std::vector<DSCallSite> FunctionCalls;
+ // AuxFunctionCalls - This vector contains call sites that have been processed
+ // by some mechanism. In pratice, the BU Analysis uses this vector to hold
+ // the _unresolved_ call sites, because it cannot modify FunctionCalls.
+ //
+ std::vector<DSCallSite> AuxFunctionCalls;
+
+ // InlinedGlobals - This set records which globals have been inlined from
+ // other graphs (callers or callees, depending on the pass) into this one.
+ //
+ GlobalSetTy InlinedGlobals;
+
void operator=(const DSGraph &); // DO NOT IMPLEMENT
+
public:
- DSGraph() : Func(0) {} // Create a new, empty, DSGraph.
- DSGraph(Function &F); // Compute the local DSGraph
+ // Create a new, empty, DSGraph.
+ DSGraph() : GlobalsGraph(0), PrintAuxCalls(false) {}
+ DSGraph(Function &F, DSGraph *GlobalsGraph); // Compute the local DSGraph
// Copy ctor - If you want to capture the node mapping between the source and
// destination graph, you may optionally do this by specifying a map to record
// this into.
+ //
+ // Note that a copied graph does not retain the GlobalsGraph pointer of the
+ // source. You need to set a new GlobalsGraph with the setGlobalsGraph
+ // method.
+ //
DSGraph(const DSGraph &DSG);
- DSGraph(const DSGraph &DSG, std::map<const DSNode*, DSNode*> &BUNodeMap);
+ DSGraph(const DSGraph &DSG, NodeMapTy &NodeMap);
~DSGraph();
- bool hasFunction() const { return Func != 0; }
- Function &getFunction() const { return *Func; }
+ DSGraph *getGlobalsGraph() const { return GlobalsGraph; }
+ void setGlobalsGraph(DSGraph *G) { GlobalsGraph = G; }
+
+ // setPrintAuxCalls - If you call this method, the auxillary call vector will
+ // be printed instead of the standard call vector to the dot file.
+ //
+ void setPrintAuxCalls() { PrintAuxCalls = true; }
+ bool shouldPrintAuxCalls() const { return PrintAuxCalls; }
/// getNodes - Get a vector of all the nodes in the graph
///
const std::vector<DSNode*> &getNodes() const { return Nodes; }
std::vector<DSNode*> &getNodes() { return Nodes; }
+ /// getFunctionNames - Return a space separated list of the name of the
+ /// functions in this graph (if any)
+ std::string getFunctionNames() const;
+
/// addNode - Add a new node to the graph.
///
void addNode(DSNode *N) { Nodes.push_back(N); }
/// getScalarMap - Get a map that describes what the nodes the scalars in this
/// function point to...
///
- std::map<Value*, DSNodeHandle> &getScalarMap() { return ScalarMap; }
- const std::map<Value*, DSNodeHandle> &getScalarMap() const {return ScalarMap;}
+ ScalarMapTy &getScalarMap() { return ScalarMap; }
+ const ScalarMapTy &getScalarMap() const {return ScalarMap;}
- std::vector<DSCallSite> &getFunctionCalls() {
- return FunctionCalls;
- }
+ /// getFunctionCalls - Return the list of call sites in the original local
+ /// graph...
+ ///
const std::vector<DSCallSite> &getFunctionCalls() const {
return FunctionCalls;
}
+ /// getAuxFunctionCalls - Get the call sites as modified by whatever passes
+ /// have been run.
+ ///
+ std::vector<DSCallSite> &getAuxFunctionCalls() {
+ return AuxFunctionCalls;
+ }
+ const std::vector<DSCallSite> &getAuxFunctionCalls() const {
+ return AuxFunctionCalls;
+ }
+
+ /// getInlinedGlobals - Get the set of globals that are have been inlined
+ /// (from callees in BU or from callers in TD) into the current graph.
+ ///
+ GlobalSetTy& getInlinedGlobals() {
+ return InlinedGlobals;
+ }
+
/// getNodeForValue - Given a value that is used or defined in the body of the
/// current function, return the DSNode that it points to.
///
DSNodeHandle &getNodeForValue(Value *V) { return ScalarMap[V]; }
const DSNodeHandle &getNodeForValue(Value *V) const {
- std::map<Value*, DSNodeHandle>::const_iterator I = ScalarMap.find(V);
+ ScalarMapTy::const_iterator I = ScalarMap.find(V);
assert(I != ScalarMap.end() &&
"Use non-const lookup function if node may not be in the map");
return I->second;
}
- const DSNodeHandle &getRetNode() const { return RetNode; }
- DSNodeHandle &getRetNode() { return RetNode; }
+ /// getReturnNodes - Return the mapping of functions to their return nodes for
+ /// this graph.
+ const ReturnNodesTy &getReturnNodes() const { return ReturnNodes; }
+ ReturnNodesTy &getReturnNodes() { return ReturnNodes; }
+ /// getReturnNodeFor - Return the return node for the specified function.
+ ///
+ DSNodeHandle &getReturnNodeFor(Function &F) {
+ ReturnNodesTy::iterator I = ReturnNodes.find(&F);
+ assert(I != ReturnNodes.end() && "F not in this DSGraph!");
+ return I->second;
+ }
+
+ const DSNodeHandle &getReturnNodeFor(Function &F) const {
+ ReturnNodesTy::const_iterator I = ReturnNodes.find(&F);
+ assert(I != ReturnNodes.end() && "F not in this DSGraph!");
+ return I->second;
+ }
+
+ /// getGraphSize - Return the number of nodes in this graph.
+ ///
unsigned getGraphSize() const {
return Nodes.size();
}
+ /// print - Print a dot graph to the specified ostream...
+ ///
void print(std::ostream &O) const;
+
+ /// dump - call print(std::cerr), for use from the debugger...
+ ///
void dump() const;
+
+ /// viewGraph - Emit a dot graph, run 'dot', run gv on the postscript file,
+ /// then cleanup. For use from the debugger.
+ void viewGraph() const;
+
void writeGraphToFile(std::ostream &O, const std::string &GraphName) const;
- // maskNodeTypes - Apply a mask to all of the node types in the graph. This
- // is useful for clearing out markers like Scalar or Incomplete.
- //
- void maskNodeTypes(unsigned char Mask);
+ /// maskNodeTypes - Apply a mask to all of the node types in the graph. This
+ /// is useful for clearing out markers like Incomplete.
+ ///
+ void maskNodeTypes(unsigned Mask) {
+ for (unsigned i = 0, e = Nodes.size(); i != e; ++i)
+ Nodes[i]->maskNodeTypes(Mask);
+ }
void maskIncompleteMarkers() { maskNodeTypes(~DSNode::Incomplete); }
// markIncompleteNodes - Traverse the graph, identifying nodes that may be
// the scope of current analysis may have modified it), the 'Incomplete' flag
// is added to the NodeType.
//
- void markIncompleteNodes(bool markFormalArgs = true);
-
- // removeTriviallyDeadNodes - After the graph has been constructed, this
- // method removes all unreachable nodes that are created because they got
- // merged with other nodes in the graph.
- //
- void removeTriviallyDeadNodes(bool KeepAllGlobals = false);
+ enum MarkIncompleteFlags {
+ MarkFormalArgs = 1, IgnoreFormalArgs = 0,
+ IgnoreGlobals = 2, MarkGlobalsIncomplete = 0,
+ };
+ void markIncompleteNodes(unsigned Flags);
- // removeDeadNodes - Use a more powerful reachability analysis to eliminate
- // subgraphs that are unreachable. This often occurs because the data
- // structure doesn't "escape" into it's caller, and thus should be eliminated
- // from the caller's graph entirely. This is only appropriate to use when
- // inlining graphs.
+ // removeDeadNodes - Use a reachability analysis to eliminate subgraphs that
+ // are unreachable. This often occurs because the data structure doesn't
+ // "escape" into it's caller, and thus should be eliminated from the caller's
+ // graph entirely. This is only appropriate to use when inlining graphs.
//
- void removeDeadNodes(bool KeepAllGlobals = false, bool KeepCalls = true);
+ enum RemoveDeadNodesFlags {
+ RemoveUnreachableGlobals = 1, KeepUnreachableGlobals = 0,
+ };
+ void removeDeadNodes(unsigned Flags);
- enum AllocaBit {
- StripAllocaBit,
- KeepAllocaBit
+ /// CloneFlags enum - Bits that may be passed into the cloneInto method to
+ /// specify how to clone the function graph.
+ enum CloneFlags {
+ StripAllocaBit = 1 << 0, KeepAllocaBit = 0,
+ DontCloneCallNodes = 1 << 1, CloneCallNodes = 0,
+ DontCloneAuxCallNodes = 1 << 2, CloneAuxCallNodes = 0,
+ StripModRefBits = 1 << 3, KeepModRefBits = 0,
+ StripIncompleteBit = 1 << 4, KeepIncompleteBit = 0,
};
- // cloneInto - Clone the specified DSGraph into the current graph, returning
- // the Return node of the graph. The translated ScalarMap for the old
- // function is filled into the OldValMap member. If StripAllocas is set to
- // 'StripAllocaBit', Alloca markers are removed from the graph as the graph is
- // being cloned.
- //
- DSNodeHandle cloneInto(const DSGraph &G,
- std::map<Value*, DSNodeHandle> &OldValMap,
- std::map<const DSNode*, DSNode*> &OldNodeMap,
- AllocaBit StripAllocas = KeepAllocaBit);
+private:
+ void cloneReachableNodes(const DSNode* Node,
+ unsigned BitsToClear,
+ NodeMapTy& OldNodeMap,
+ NodeMapTy& CompletedNodeMap);
+
+public:
+ void updateFromGlobalGraph();
+
+ void cloneReachableSubgraph(const DSGraph& G,
+ const hash_set<const DSNode*>& RootNodes,
+ NodeMapTy& OldNodeMap,
+ NodeMapTy& CompletedNodeMap,
+ unsigned CloneFlags = 0);
+
+ /// cloneInto - Clone the specified DSGraph into the current graph. The
+ /// translated ScalarMap for the old function is filled into the OldValMap
+ /// member, and the translated ReturnNodes map is returned into ReturnNodes.
+ ///
+ /// The CloneFlags member controls various aspects of the cloning process.
+ ///
+ void cloneInto(const DSGraph &G, ScalarMapTy &OldValMap,
+ ReturnNodesTy &OldReturnNodes, NodeMapTy &OldNodeMap,
+ unsigned CloneFlags = 0);
/// mergeInGraph - The method is used for merging graphs together. If the
/// argument graph is not *this, it makes a clone of the specified graph, then
/// the graph. If the StripAlloca's argument is 'StripAllocaBit' then Alloca
/// markers are removed from nodes.
///
- void mergeInGraph(DSCallSite &CS, const DSGraph &Graph,
- AllocaBit StripAllocas);
+ void mergeInGraph(const DSCallSite &CS, Function &F, const DSGraph &Graph,
+ unsigned CloneFlags);
-#if 0
- // cloneGlobalInto - Clone the given global node (or the node for the given
- // GlobalValue) from the GlobalsGraph and all its target links (recursively).
- //
- DSNode* cloneGlobalInto(const DSNode* GNode);
- DSNode* cloneGlobalInto(GlobalValue* GV) {
- assert(!GV || (((DSGraph*) GlobalsGraph)->ScalarMap[GV] != 0));
- return GV? cloneGlobalInto(((DSGraph*) GlobalsGraph)->ScalarMap[GV]) : 0;
+
+ /// getCallSiteForArguments - Get the arguments and return value bindings for
+ /// the specified function in the current graph.
+ ///
+ DSCallSite getCallSiteForArguments(Function &F) const;
+
+ // Methods for checking to make sure graphs are well formed...
+ void AssertNodeInGraph(const DSNode *N) const {
+ assert((!N || find(Nodes.begin(), Nodes.end(), N) != Nodes.end()) &&
+ "AssertNodeInGraph: Node is not in graph!");
+ }
+ void AssertNodeContainsGlobal(const DSNode *N, GlobalValue *GV) const {
+ assert(std::find(N->getGlobals().begin(), N->getGlobals().end(), GV) !=
+ N->getGlobals().end() && "Global value not in node!");
}
-#endif
-private:
- bool isNodeDead(DSNode *N);
+ void AssertCallSiteInGraph(const DSCallSite &CS) const {
+ if (CS.isIndirectCall())
+ AssertNodeInGraph(CS.getCalleeNode());
+ AssertNodeInGraph(CS.getRetVal().getNode());
+ for (unsigned j = 0, e = CS.getNumPtrArgs(); j != e; ++j)
+ AssertNodeInGraph(CS.getPtrArg(j).getNode());
+ }
+
+ void AssertCallNodesInGraph() const {
+ for (unsigned i = 0, e = FunctionCalls.size(); i != e; ++i)
+ AssertCallSiteInGraph(FunctionCalls[i]);
+ }
+ void AssertAuxCallNodesInGraph() const {
+ for (unsigned i = 0, e = AuxFunctionCalls.size(); i != e; ++i)
+ AssertCallSiteInGraph(AuxFunctionCalls[i]);
+ }
+
+ void AssertGraphOK() const;
+
+ /// mergeInGlobalsGraph - This method is useful for clients to incorporate the
+ /// globals graph into the DS, BU or TD graph for a function. This code
+ /// retains all globals, i.e., does not delete unreachable globals after they
+ /// are inlined.
+ ///
+ void mergeInGlobalsGraph();
+
+ /// removeTriviallyDeadNodes - After the graph has been constructed, this
+ /// method removes all unreachable nodes that are created because they got
+ /// merged with other nodes in the graph. This is used as the first step of
+ /// removeDeadNodes.
+ ///
+ void removeTriviallyDeadNodes();
};
#endif
projects / oota-llvm.git / blobdiff