//===- DSGraph.h - Represent a collection of data structures ----*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
//
-// This header defines the primative classes that make up a data structure
-// graph.
+// 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 header defines the data structure graph (DSGraph) and the
+// ReachabilityCloner class.
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_ANALYSIS_DSGRAPH_H
#define LLVM_ANALYSIS_DSGRAPH_H
-#include <vector>
-#include <map>
-#include <functional>
-
-class Function;
-class CallInst;
-class Value;
-class GlobalValue;
-class Type;
+#include "llvm/Analysis/DSNode.h"
-class DSNode; // Each node in the graph
-class DSGraph; // A graph for a function
-class DSNodeIterator; // Data structure graph traversal iterator
+namespace llvm {
+class GlobalValue;
//===----------------------------------------------------------------------===//
-/// DSNodeHandle - Implement a "handle" to a data structure node that takes care
-/// of all of the add/un'refing of the node to prevent the backpointers in the
-/// graph from getting out of date. This class represents a "pointer" in the
-/// graph, whose destination is an indexed offset into a node.
+/// DSScalarMap - An instance of this class is used to keep track of all of
+/// which DSNode each scalar in a function points to. This is specialized to
+/// keep track of globals with nodes in the function, and to keep track of the
+/// unique DSNodeHandle being used by the scalar map.
+///
+/// This class is crucial to the efficiency of DSA with some large SCC's. In
+/// these cases, the cost of iterating over the scalar map dominates the cost
+/// of DSA. In all of these cases, the DSA phase is really trying to identify
+/// globals or unique node handles active in the function.
///
-class DSNodeHandle {
- DSNode *N;
- unsigned Offset;
+class DSScalarMap {
+ typedef hash_map<Value*, DSNodeHandle> ValueMapTy;
+ ValueMapTy ValueMap;
+
+ typedef hash_set<GlobalValue*> GlobalSetTy;
+ GlobalSetTy GlobalSet;
public:
- // Allow construction, destruction, and assignment...
- DSNodeHandle(DSNode *n = 0, unsigned offs = 0) : N(0), Offset(offs) {
- setNode(n);
- }
- DSNodeHandle(const DSNodeHandle &H) : N(0), Offset(H.Offset) { setNode(H.N); }
- ~DSNodeHandle() { setNode((DSNode*)0); }
- DSNodeHandle &operator=(const DSNodeHandle &H) {
- setNode(H.N); Offset = H.Offset;
- return *this;
- }
- bool operator<(const DSNodeHandle &H) const { // Allow sorting
- return N < H.N || (N == H.N && Offset < H.Offset);
- }
- bool operator>(const DSNodeHandle &H) const { return H < *this; }
- bool operator==(const DSNodeHandle &H) const { // Allow comparison
- return N == H.N && Offset == H.Offset;
+ // Compatibility methods: provide an interface compatible with a map of
+ // Value* to DSNodeHandle's.
+ typedef ValueMapTy::const_iterator const_iterator;
+ typedef ValueMapTy::iterator iterator;
+ iterator begin() { return ValueMap.begin(); }
+ iterator end() { return ValueMap.end(); }
+ const_iterator begin() const { return ValueMap.begin(); }
+ const_iterator end() const { return ValueMap.end(); }
+ iterator find(Value *V) { return ValueMap.find(V); }
+ const_iterator find(Value *V) const { return ValueMap.find(V); }
+ unsigned count(Value *V) const { return ValueMap.count(V); }
+
+ void erase(Value *V) { erase(find(V)); }
+
+ DSNodeHandle &operator[](Value *V) {
+ std::pair<iterator,bool> IP =
+ ValueMap.insert(std::make_pair(V, DSNodeHandle()));
+ if (IP.second) { // Inserted the new entry into the map.
+ if (GlobalValue *GV = dyn_cast<GlobalValue>(V))
+ GlobalSet.insert(GV);
+ }
+ return IP.first->second;
}
- bool operator!=(const DSNodeHandle &H) const { return !operator==(H); }
-
- // Allow explicit conversion to DSNode...
- DSNode *getNode() const { return N; }
- unsigned getOffset() const { return Offset; }
- inline void setNode(DSNode *N); // Defined inline later...
- void setOffset(unsigned O) { Offset = O; }
-
- void addEdgeTo(unsigned LinkNo, const DSNodeHandle &N);
- void addEdgeTo(const DSNodeHandle &N) { addEdgeTo(0, N); }
-
- /// mergeWith - Merge the logical node pointed to by 'this' with the node
- /// pointed to by 'N'.
- ///
- void mergeWith(const DSNodeHandle &N);
-
- // hasLink - Return true if there is a link at the specified offset...
- inline bool hasLink(unsigned Num) const;
+ void erase(iterator I) {
+ assert(I != ValueMap.end() && "Cannot erase end!");
+ if (GlobalValue *GV = dyn_cast<GlobalValue>(I->first))
+ GlobalSet.erase(GV);
+ ValueMap.erase(I);
+ }
- /// getLink - Treat this current node pointer as a pointer to a structure of
- /// some sort. This method will return the pointer a mem[this+Num]
- ///
- inline const DSNodeHandle *getLink(unsigned Num) const;
- inline DSNodeHandle *getLink(unsigned Num);
+ void clear() {
+ ValueMap.clear();
+ GlobalSet.clear();
+ }
- inline void setLink(unsigned Num, const DSNodeHandle &NH);
+ // Access to the global set: the set of all globals currently in the
+ // scalar map.
+ typedef GlobalSetTy::const_iterator global_iterator;
+ global_iterator global_begin() const { return GlobalSet.begin(); }
+ global_iterator global_end() const { return GlobalSet.end(); }
};
//===----------------------------------------------------------------------===//
-/// DSNode - Data structure node class
-///
-/// This class represents an untyped memory object of Size bytes. It keeps
-/// track of any pointers that have been stored into the object as well as the
-/// different types represented in this object.
+/// DSGraph - The graph that represents a function.
///
-class DSNode {
- /// Links - Contains one entry for every _distinct_ pointer field in the
- /// memory block. These are demand allocated and indexed by the MergeMap
- /// vector.
- ///
- std::vector<DSNodeHandle> Links;
-
- /// MergeMap - Maps from every byte in the object to a signed byte number.
- /// This map is neccesary due to the merging that is possible as part of the
- /// unification algorithm. To merge two distinct bytes of the object together
- /// into a single logical byte, the indexes for the two bytes are set to the
- /// same value. This fully general merging is capable of representing all
- /// manners of array merging if neccesary.
- ///
- /// This map is also used to map outgoing pointers to various byte offsets in
- /// this data structure node. If this value is >= 0, then it indicates that
- /// the numbered entry in the Links vector contains the outgoing edge for this
- /// byte offset. In this way, the Links vector can be demand allocated and
- /// byte elements of the node may be merged without needing a Link allocated
- /// for it.
- ///
- /// Initially, each each element of the MergeMap is assigned a unique negative
- /// number, which are then merged as the unification occurs.
- ///
- std::vector<signed char> MergeMap;
+struct DSGraph {
+ // Public data-type declarations...
+ typedef DSScalarMap ScalarMapTy;
+ typedef hash_map<Function*, DSNodeHandle> ReturnNodesTy;
+ typedef hash_set<GlobalValue*> GlobalSetTy;
+ typedef std::vector<DSNode*> NodeListTy;
+
+ /// 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?
- /// Referrers - Keep track of all of the node handles that point to this
- /// DSNode. These pointers may need to be updated to point to a different
- /// node if this node gets merged with it.
- ///
- std::vector<DSNodeHandle*> Referrers;
+ NodeListTy Nodes;
+ ScalarMapTy ScalarMap;
- /// TypeRec - This structure is used to represent a single type that is held
- /// in a DSNode.
- struct TypeRec {
- const Type *Ty; // The type itself...
- unsigned Offset; // The offset in the node
- bool isArray; // Have we accessed an array of elements?
+ // 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;
- TypeRec() : Ty(0), Offset(0), isArray(false) {}
- TypeRec(const Type *T, unsigned O) : Ty(T), Offset(O), isArray(false) {}
+ // FunctionCalls - This vector maintains a single entry for each call
+ // 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;
- bool operator<(const TypeRec &TR) const {
- // Sort first by offset!
- return Offset < TR.Offset || (Offset == TR.Offset && Ty < TR.Ty);
- }
- bool operator==(const TypeRec &TR) const {
- return Ty == TR.Ty && Offset == TR.Offset;
- }
- bool operator!=(const TypeRec &TR) const { return !operator==(TR); }
- };
+ // 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;
- /// TypeEntries - As part of the merging process of this algorithm, nodes of
- /// different types can be represented by this single DSNode. This vector is
- /// kept sorted.
- ///
- std::vector<TypeRec> TypeEntries;
+ // InlinedGlobals - This set records which globals have been inlined from
+ // other graphs (callers or callees, depending on the pass) into this one.
+ //
+ GlobalSetTy InlinedGlobals;
- /// Globals - The list of global values that are merged into this node.
- ///
- std::vector<GlobalValue*> Globals;
+ /// TD - This is the target data object for the machine this graph is
+ /// constructed for.
+ const TargetData &TD;
+
+ void operator=(const DSGraph &); // DO NOT IMPLEMENT
- void operator=(const DSNode &); // DO NOT IMPLEMENT
public:
- enum NodeTy {
- ShadowNode = 0, // Nothing is known about this node...
- ScalarNode = 1 << 0, // Scalar of the current function contains this value
- AllocaNode = 1 << 1, // This node was allocated with alloca
- NewNode = 1 << 2, // This node was allocated with malloc
- GlobalNode = 1 << 3, // This node was allocated by a global var decl
- Incomplete = 1 << 4, // This node may not be complete
- Modified = 1 << 5, // This node is modified in this context
- Read = 1 << 6, // This node is read in this context
- };
-
- /// NodeType - A union of the above bits. "Shadow" nodes do not add any flags
- /// to the nodes in the data structure graph, so it is possible to have nodes
- /// with a value of 0 for their NodeType. Scalar and Alloca markers go away
- /// when function graphs are inlined.
- ///
- unsigned char NodeType;
+ // Create a new, empty, DSGraph.
+ DSGraph(const TargetData &td)
+ : GlobalsGraph(0), PrintAuxCalls(false), TD(td) {}
- DSNode(enum NodeTy NT, const Type *T);
- DSNode(const DSNode &);
+ // Compute the local DSGraph
+ DSGraph(const TargetData &td, Function &F, DSGraph *GlobalsGraph);
- ~DSNode() {
-#ifndef NDEBUG
- dropAllReferences(); // Only needed to satisfy assertion checks...
- assert(Referrers.empty() && "Referrers to dead node exist!");
-#endif
- }
+ // 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, NodeMapTy &NodeMap);
+ ~DSGraph();
- // Iterator for graph interface...
- typedef DSNodeIterator iterator;
- typedef DSNodeIterator const_iterator;
- inline iterator begin() const; // Defined in DSGraphTraits.h
- inline iterator end() const;
+ DSGraph *getGlobalsGraph() const { return GlobalsGraph; }
+ void setGlobalsGraph(DSGraph *G) { GlobalsGraph = G; }
- //===--------------------------------------------------
- // Accessors
+ /// getTargetData - Return the TargetData object for the current target.
+ ///
+ const TargetData &getTargetData() const { return TD; }
- /// getSize - Return the maximum number of bytes occupied by this object...
+ /// setPrintAuxCalls - If you call this method, the auxillary call vector will
+ /// be printed instead of the standard call vector to the dot file.
///
- unsigned getSize() const { return MergeMap.size(); }
+ void setPrintAuxCalls() { PrintAuxCalls = true; }
+ bool shouldPrintAuxCalls() const { return PrintAuxCalls; }
- // getTypeEntries - Return the possible types and their offsets in this object
- const std::vector<TypeRec> &getTypeEntries() const { return TypeEntries; }
+ /// getNodes - Get a vector of all the nodes in the graph
+ ///
+ typedef NodeListTy::const_iterator node_iterator;
+ node_iterator node_begin() const { return Nodes.begin(); }
+ node_iterator node_end() const { return Nodes.end(); }
- /// getReferrers - Return a list of the pointers to this node...
- ///
- const std::vector<DSNodeHandle*> &getReferrers() const { return Referrers; }
+ /// getFunctionNames - Return a space separated list of the name of the
+ /// functions in this graph (if any)
+ std::string getFunctionNames() const;
- /// isModified - Return true if this node may be modified in this context
+ /// addNode - Add a new node to the graph.
///
- bool isModified() const { return (NodeType & Modified) != 0; }
+ void addNode(DSNode *N) { Nodes.push_back(N); }
- /// isRead - Return true if this node may be read in this context
+ /// getScalarMap - Get a map that describes what the nodes the scalars in this
+ /// function point to...
///
- bool isRead() const { return (NodeType & Read) != 0; }
-
+ ScalarMapTy &getScalarMap() { return ScalarMap; }
+ const ScalarMapTy &getScalarMap() const { return ScalarMap; }
- /// hasLink - Return true if this memory object has a link at the specified
- /// location.
+ /// getFunctionCalls - Return the list of call sites in the original local
+ /// graph...
///
- bool hasLink(unsigned i) const {
- assert(i < getSize() && "Field Link index is out of range!");
- return MergeMap[i] >= 0;
+ const std::vector<DSCallSite> &getFunctionCalls() const {
+ return FunctionCalls;
}
- DSNodeHandle *getLink(unsigned i) {
- if (hasLink(i))
- return &Links[MergeMap[i]];
- return 0;
- }
- const DSNodeHandle *getLink(unsigned i) const {
- if (hasLink(i))
- return &Links[MergeMap[i]];
- return 0;
+ /// getAuxFunctionCalls - Get the call sites as modified by whatever passes
+ /// have been run.
+ ///
+ std::vector<DSCallSite> &getAuxFunctionCalls() {
+ return AuxFunctionCalls;
}
-
- int getMergeMapLabel(unsigned i) const {
- assert(i < MergeMap.size() && "MergeMap index out of range!");
- return MergeMap[i];
+ const std::vector<DSCallSite> &getAuxFunctionCalls() const {
+ return AuxFunctionCalls;
}
- /// setLink - Set the link at the specified offset to the specified
- /// NodeHandle, replacing what was there. It is uncommon to use this method,
- /// instead one of the higher level methods should be used, below.
- ///
- void setLink(unsigned i, const DSNodeHandle &NH);
-
- /// addEdgeTo - Add an edge from the current node to the specified node. This
- /// can cause merging of nodes in the graph.
+ /// getInlinedGlobals - Get the set of globals that are have been inlined
+ /// (from callees in BU or from callers in TD) into the current graph.
///
- void addEdgeTo(unsigned Offset, const DSNodeHandle &NH);
-
- /// mergeWith - Merge this node and the specified node, moving all links to
- /// and from the argument node into the current node, deleting the node
- /// argument. Offset indicates what offset the specified node is to be merged
- /// into the current node.
- ///
- /// The specified node may be a null pointer (in which case, nothing happens).
- ///
- void mergeWith(const DSNodeHandle &NH, unsigned Offset);
-
- /// mergeIndexes - If we discover that two indexes are equivalent and must be
- /// merged, this function is used to do the dirty work.
- ///
- void mergeIndexes(unsigned idx1, unsigned idx2) {
- assert(idx1 < getSize() && idx2 < getSize() && "Indexes out of range!");
- signed char MV1 = MergeMap[idx1];
- signed char MV2 = MergeMap[idx2];
- if (MV1 != MV2)
- mergeMappedValues(MV1, MV2);
+ GlobalSetTy& getInlinedGlobals() {
+ return InlinedGlobals;
}
-
- /// addGlobal - Add an entry for a global value to the Globals list. This
- /// also marks the node with the 'G' flag if it does not already have it.
+ /// getNodeForValue - Given a value that is used or defined in the body of the
+ /// current function, return the DSNode that it points to.
///
- void addGlobal(GlobalValue *GV);
- const std::vector<GlobalValue*> &getGlobals() const { return Globals; }
- std::vector<GlobalValue*> &getGlobals() { return Globals; }
-
- void print(std::ostream &O, const DSGraph *G) const;
- void dump() const;
+ DSNodeHandle &getNodeForValue(Value *V) { return ScalarMap[V]; }
- void dropAllReferences() {
- Links.clear();
+ const DSNodeHandle &getNodeForValue(Value *V) const {
+ 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;
}
- /// remapLinks - Change all of the Links in the current node according to the
- /// specified mapping.
- void remapLinks(std::map<const DSNode*, DSNode*> &OldNodeMap);
-
-private:
- friend class DSNodeHandle;
- // addReferrer - Keep the referrer set up to date...
- void addReferrer(DSNodeHandle *H) { Referrers.push_back(H); }
- void removeReferrer(DSNodeHandle *H);
-
- /// rewriteMergeMap - Loop over the mergemap, replacing any references to the
- /// index From to be references to the index To.
- ///
- void rewriteMergeMap(signed char From, signed char To) {
- assert(From != To && "Cannot change something into itself!");
- for (unsigned i = 0, e = MergeMap.size(); i != e; ++i)
- if (MergeMap[i] == From)
- MergeMap[i] = To;
- }
+ /// getReturnNodes - Return the mapping of functions to their return nodes for
+ /// this graph.
+ const ReturnNodesTy &getReturnNodes() const { return ReturnNodes; }
+ ReturnNodesTy &getReturnNodes() { return ReturnNodes; }
- /// mergeMappedValues - This is the higher level form of rewriteMergeMap. It
- /// is fully capable of merging links together if neccesary as well as simply
- /// rewriting the map entries.
+ /// getReturnNodeFor - Return the return node for the specified function.
///
- void mergeMappedValues(signed char V1, signed char V2);
-};
-
-
-//===----------------------------------------------------------------------===//
-// Define inline DSNodeHandle functions that depend on the definition of DSNode
-//
-
-inline void DSNodeHandle::setNode(DSNode *n) {
- if (N) N->removeReferrer(this);
- N = n;
- if (N) N->addReferrer(this);
-}
-
-inline bool DSNodeHandle::hasLink(unsigned Num) const {
- assert(N && "DSNodeHandle does not point to a node yet!");
- return N->hasLink(Num+Offset);
-}
-
-
-/// getLink - Treat this current node pointer as a pointer to a structure of
-/// some sort. This method will return the pointer a mem[this+Num]
-///
-inline const DSNodeHandle *DSNodeHandle::getLink(unsigned Num) const {
- assert(N && "DSNodeHandle does not point to a node yet!");
- return N->getLink(Num+Offset);
-}
-inline DSNodeHandle *DSNodeHandle::getLink(unsigned Num) {
- assert(N && "DSNodeHandle does not point to a node yet!");
- return N->getLink(Num+Offset);
-}
-
-inline void DSNodeHandle::setLink(unsigned Num, const DSNodeHandle &NH) {
- assert(N && "DSNodeHandle does not point to a node yet!");
- N->setLink(Num+Offset, NH);
-}
-
-/// addEdgeTo - Add an edge from the current node to the specified node. This
-/// can cause merging of nodes in the graph.
-///
-inline void DSNodeHandle::addEdgeTo(unsigned LinkNo, const DSNodeHandle &Node) {
- assert(N && "DSNodeHandle does not point to a node yet!");
- N->addEdgeTo(LinkNo+Offset, Node);
-}
-
-/// mergeWith - Merge the logical node pointed to by 'this' with the node
-/// pointed to by 'N'.
-///
-inline void DSNodeHandle::mergeWith(const DSNodeHandle &Node) {
- assert(N && "DSNodeHandle does not point to a node yet!");
- N->mergeWith(Node, Offset);
-}
-
-
-//===----------------------------------------------------------------------===//
-/// DSCallSite - Representation of a call site via its call instruction,
-/// the DSNode handle for the callee function (or function pointer), and
-/// the DSNode handles for the function arguments.
-///
-/// One unusual aspect of this callsite record is the ResolvingCaller member.
-/// If this is non-null, then it indicates the function that allowed a call-site
-/// to finally be resolved. Because of indirect calls, this function may not
-/// actually be the function that contains the Call instruction itself. This is
-/// used by the BU and TD passes to communicate.
-///
-class DSCallSite {
- CallInst *Inst; // Actual call site
- DSNodeHandle RetVal; // Returned value
- DSNodeHandle Callee; // The function node called
- std::vector<DSNodeHandle> CallArgs; // The pointer arguments
- Function *ResolvingCaller; // See comments above
-
- static void InitNH(DSNodeHandle &NH, const DSNodeHandle &Src,
- const std::map<const DSNode*, DSNode*> &NodeMap) {
- if (DSNode *N = Src.getNode()) {
- std::map<const DSNode*, DSNode*>::const_iterator I = NodeMap.find(N);
- assert(I != NodeMap.end() && "Not not in mapping!");
-
- NH.setOffset(Src.getOffset());
- NH.setNode(I->second);
- }
+ DSNodeHandle &getReturnNodeFor(Function &F) {
+ ReturnNodesTy::iterator I = ReturnNodes.find(&F);
+ assert(I != ReturnNodes.end() && "F not in this DSGraph!");
+ return I->second;
}
- static void InitNH(DSNodeHandle &NH, const DSNodeHandle &Src,
- const std::map<const DSNode*, DSNodeHandle> &NodeMap) {
- if (DSNode *N = Src.getNode()) {
- std::map<const DSNode*, DSNodeHandle>::const_iterator I = NodeMap.find(N);
- assert(I != NodeMap.end() && "Not not in mapping!");
-
- NH.setOffset(Src.getOffset()+I->second.getOffset());
- NH.setNode(I->second.getNode());
- }
+ 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;
}
- DSCallSite(); // DO NOT IMPLEMENT
-public:
- /// Constructor. Note - This ctor destroys the argument vector passed in. On
- /// exit, the argument vector is empty.
+ /// getGraphSize - Return the number of nodes in this graph.
///
- DSCallSite(CallInst &inst, const DSNodeHandle &rv, const DSNodeHandle &callee,
- std::vector<DSNodeHandle> &Args)
- : Inst(&inst), RetVal(rv), Callee(callee), ResolvingCaller(0) {
- Args.swap(CallArgs);
+ unsigned getGraphSize() const {
+ return Nodes.size();
}
- DSCallSite(const DSCallSite &DSCS) // Simple copy ctor
- : Inst(DSCS.Inst), RetVal(DSCS.RetVal),
- Callee(DSCS.Callee), CallArgs(DSCS.CallArgs),
- ResolvingCaller(DSCS.ResolvingCaller) {}
+ /// print - Print a dot graph to the specified ostream...
+ ///
+ void print(std::ostream &O) const;
- /// Mapping copy constructor - This constructor takes a preexisting call site
- /// to copy plus a map that specifies how the links should be transformed.
- /// This is useful when moving a call site from one graph to another.
+ /// dump - call print(std::cerr), for use from the debugger...
///
- template<typename MapTy>
- DSCallSite(const DSCallSite &FromCall, const MapTy &NodeMap) {
- Inst = FromCall.Inst;
- InitNH(RetVal, FromCall.RetVal, NodeMap);
- InitNH(Callee, FromCall.Callee, NodeMap);
-
- CallArgs.resize(FromCall.CallArgs.size());
- for (unsigned i = 0, e = FromCall.CallArgs.size(); i != e; ++i)
- InitNH(CallArgs[i], FromCall.CallArgs[i], NodeMap);
- ResolvingCaller = FromCall.ResolvingCaller;
- }
+ void dump() const;
- // Accessor functions...
- Function &getCaller() const;
- CallInst &getCallInst() const { return *Inst; }
- DSNodeHandle &getRetVal() { return RetVal; }
- DSNodeHandle &getCallee() { return Callee; }
- const DSNodeHandle &getRetVal() const { return RetVal; }
- const DSNodeHandle &getCallee() const { return Callee; }
- unsigned getNumPtrArgs() const { return CallArgs.size(); }
-
- Function *getResolvingCaller() const { return ResolvingCaller; }
- void setResolvingCaller(Function *F) { ResolvingCaller = F; }
-
- DSNodeHandle &getPtrArg(unsigned i) {
- assert(i < CallArgs.size() && "Argument to getPtrArgNode is out of range!");
- return CallArgs[i];
- }
- const DSNodeHandle &getPtrArg(unsigned i) const {
- assert(i < CallArgs.size() && "Argument to getPtrArgNode is out of range!");
- return CallArgs[i];
- }
+ /// viewGraph - Emit a dot graph, run 'dot', run gv on the postscript file,
+ /// then cleanup. For use from the debugger.
+ void viewGraph() const;
- bool operator<(const DSCallSite &CS) const {
- if (RetVal < CS.RetVal) return true;
- if (RetVal > CS.RetVal) return false;
- if (Callee < CS.Callee) return true;
- if (Callee > CS.Callee) return false;
- return CallArgs < CS.CallArgs;
- }
+ void writeGraphToFile(std::ostream &O, const std::string &GraphName) const;
- bool operator==(const DSCallSite &CS) const {
- return RetVal == CS.RetVal && Callee == CS.Callee &&
- CallArgs == CS.CallArgs;
+ /// 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 (node_iterator I = node_begin(), E = node_end(); I != E; ++I)
+ (*I)->maskNodeTypes(Mask);
}
-};
-
-
-//===----------------------------------------------------------------------===//
-/// DSGraph - The graph that represents a function.
-///
-class DSGraph {
- Function *Func;
- std::vector<DSNode*> Nodes;
- DSNodeHandle RetNode; // Node that gets returned...
- std::map<Value*, DSNodeHandle> ValueMap;
-
-#if 0
- // GlobalsGraph -- Reference to the common graph of globally visible objects.
- // This includes GlobalValues, New nodes, Cast nodes, and Calls.
- //
- GlobalDSGraph* GlobalsGraph;
-#endif
+ void maskIncompleteMarkers() { maskNodeTypes(~DSNode::Incomplete); }
- // 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.
+ // markIncompleteNodes - Traverse the graph, identifying nodes that may be
+ // modified by other functions that have not been resolved yet. This marks
+ // nodes that are reachable through three sources of "unknownness":
+ // Global Variables, Function Calls, and Incoming Arguments
//
- std::vector<DSCallSite> FunctionCalls;
+ // For any node that may have unknown components (because something outside
+ // the scope of current analysis may have modified it), the 'Incomplete' flag
+ // is added to the NodeType.
+ //
+ enum MarkIncompleteFlags {
+ MarkFormalArgs = 1, IgnoreFormalArgs = 0,
+ IgnoreGlobals = 2, MarkGlobalsIncomplete = 0,
+ };
+ void markIncompleteNodes(unsigned Flags);
- void operator=(const DSGraph &); // DO NOT IMPLEMENT
-public:
- DSGraph() : Func(0) {} // Create a new, empty, DSGraph.
- DSGraph(Function &F); // Compute the local DSGraph
+ // 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.
+ //
+ enum RemoveDeadNodesFlags {
+ RemoveUnreachableGlobals = 1, KeepUnreachableGlobals = 0,
+ };
+ void removeDeadNodes(unsigned Flags);
+
+ /// 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,
+ UpdateInlinedGlobals = 1 << 5, DontUpdateInlinedGlobals = 0,
+ };
- // 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.
- DSGraph(const DSGraph &DSG);
- DSGraph(const DSGraph &DSG, std::map<const DSNode*, DSNode*> &BUNodeMap);
- ~DSGraph();
+ void updateFromGlobalGraph();
- bool hasFunction() const { return Func != 0; }
- Function &getFunction() const { return *Func; }
+ /// computeNodeMapping - Given roots in two different DSGraphs, traverse the
+ /// nodes reachable from the two graphs, computing the mapping of nodes from
+ /// the first to the second graph.
+ ///
+ static void computeNodeMapping(const DSNodeHandle &NH1,
+ const DSNodeHandle &NH2, NodeMapTy &NodeMap,
+ bool StrictChecking = true);
- /// 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; }
- /// addNode - Add a new node to the graph.
+ /// 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.
+ /// OldNodeMap contains a mapping from the original nodes to the newly cloned
+ /// nodes.
///
- void addNode(DSNode *N) { Nodes.push_back(N); }
+ /// 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
+ /// merges the nodes specified in the call site with the formal arguments in
+ /// the graph. If the StripAlloca's argument is 'StripAllocaBit' then Alloca
+ /// markers are removed from nodes.
+ ///
+ void mergeInGraph(const DSCallSite &CS, Function &F, const DSGraph &Graph,
+ unsigned CloneFlags);
- /// getValueMap - Get a map that describes what the nodes the scalars in this
- /// function point to...
+
+ /// getCallSiteForArguments - Get the arguments and return value bindings for
+ /// the specified function in the current graph.
///
- std::map<Value*, DSNodeHandle> &getValueMap() { return ValueMap; }
- const std::map<Value*, DSNodeHandle> &getValueMap() const { return ValueMap;}
+ DSCallSite getCallSiteForArguments(Function &F) const;
- std::vector<DSCallSite> &getFunctionCalls() {
- return FunctionCalls;
+ // Methods for checking to make sure graphs are well formed...
+ void AssertNodeInGraph(const DSNode *N) const {
+ assert((!N || N->getParentGraph() == this) &&
+ "AssertNodeInGraph: Node is not in graph!");
}
- const std::vector<DSCallSite> &getFunctionCalls() const {
- return FunctionCalls;
+ 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!");
}
- /// 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 ValueMap[V]; }
-
- const DSNodeHandle &getRetNode() const { return RetNode; }
- DSNodeHandle &getRetNode() { return RetNode; }
+ 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());
+ }
- unsigned getGraphSize() const {
- return Nodes.size();
+ 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 print(std::ostream &O) const;
- void dump() const;
- void writeGraphToFile(std::ostream &O, const std::string &GraphName) const;
+ void AssertGraphOK() 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);
- void maskIncompleteMarkers() { maskNodeTypes(~DSNode::Incomplete); }
+ /// 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();
+};
- // markIncompleteNodes - Traverse the graph, identifying nodes that may be
- // modified by other functions that have not been resolved yet. This marks
- // nodes that are reachable through three sources of "unknownness":
- // Global Variables, Function Calls, and Incoming Arguments
- //
- // For any node that may have unknown components (because something outside
- // 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);
+ /// ReachabilityCloner - This class is used to incrementally clone and merge
+ /// nodes from a non-changing source graph into a potentially mutating
+ /// destination graph. Nodes are only cloned over on demand, either in
+ /// responds to a merge() or getClonedNH() call. When a node is cloned over,
+ /// all of the nodes reachable from it are automatically brought over as well.
+ class ReachabilityCloner {
+ DSGraph &Dest;
+ const DSGraph &Src;
+
+ /// BitsToKeep - These bits are retained from the source node when the
+ /// source nodes are merged into the destination graph.
+ unsigned BitsToKeep;
+ unsigned CloneFlags;
+
+ // NodeMap - A mapping from nodes in the source graph to the nodes that
+ // represent them in the destination graph.
+ DSGraph::NodeMapTy NodeMap;
+ public:
+ ReachabilityCloner(DSGraph &dest, const DSGraph &src, unsigned cloneFlags)
+ : Dest(dest), Src(src), CloneFlags(cloneFlags) {
+ assert(&Dest != &Src && "Cannot clone from graph to same graph!");
+ BitsToKeep = ~DSNode::DEAD;
+ if (CloneFlags & DSGraph::StripAllocaBit)
+ BitsToKeep &= ~DSNode::AllocaNode;
+ if (CloneFlags & DSGraph::StripModRefBits)
+ BitsToKeep &= ~(DSNode::Modified | DSNode::Read);
+ if (CloneFlags & DSGraph::StripIncompleteBit)
+ BitsToKeep &= ~DSNode::Incomplete;
+ }
+
+ DSNodeHandle getClonedNH(const DSNodeHandle &SrcNH);
- // 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.
- //
- void removeDeadNodes(bool KeepAllGlobals = false, bool KeepCalls = true);
+ void merge(const DSNodeHandle &NH, const DSNodeHandle &SrcNH);
- // cloneInto - Clone the specified DSGraph into the current graph, returning
- // the Return node of the graph. The translated ValueMap for the old function
- // is filled into the OldValMap member.
- // If StripScalars (StripAllocas) is set to true, Scalar (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,
- bool StripScalars = false, bool StripAllocas = false);
-
-#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)->ValueMap[GV] != 0));
- return GV? cloneGlobalInto(((DSGraph*) GlobalsGraph)->ValueMap[GV]) : 0;
- }
-#endif
+ /// mergeCallSite - Merge the nodes reachable from the specified src call
+ /// site into the nodes reachable from DestCS.
+ void mergeCallSite(const DSCallSite &DestCS, const DSCallSite &SrcCS);
-private:
- bool isNodeDead(DSNode *N);
-};
+ bool clonedNode() const { return !NodeMap.empty(); }
+
+ void destroy() { NodeMap.clear(); }
+ };
+} // End llvm namespace
#endif
projects / oota-llvm.git / blobdiff