#include <string>
class Type;
-class CallInst;
-class AllocationInst;
-class Argument;
-class DSNode;
-class FunctionRepBuilder;
class GlobalValue;
-class FunctionDSGraph;
-class DataStructure;
-class DSNodeIterator;
-class ShadowDSNode;
-
-// FIXME: move this somewhere private
-unsigned countPointerFields(const Type *Ty);
-
-// PointerVal - Represent a pointer to a datastructure. The pointer points to
-// a node, and can index into it. This is used for getelementptr instructions,
-// which do not affect which node a pointer points to, but does change the field
-// index
-//
-struct PointerVal {
- DSNode *Node;
- unsigned Index; // Index into Node->FieldLinks[]
-public:
- PointerVal(DSNode *N, unsigned Idx = 0) : Node(N), Index(Idx) {}
-
- DSNode *getNode() const { return Node; }
- unsigned getIndex() const { return Index; }
+class DSNode; // Each node in the graph
+class DSGraph; // A graph for a function
+class DSNodeIterator; // Data structure graph traversal iterator
+class LocalDataStructures; // A collection of local graphs for a program
+class BUDataStructures; // A collection of bu graphs for a program
+class TDDataStructures; // A collection of td graphs for a program
- inline bool operator==(DSNode *N) const { return Node == N; }
- inline bool operator!=(DSNode *N) const { return Node != N; }
-
- // operator< - Allow insertion into a map...
- bool operator<(const PointerVal &PV) const {
- return Node < PV.Node || (Node == PV.Node && Index < PV.Index);
- }
-
- inline bool operator==(const PointerVal &PV) const {
- return Node == PV.Node && Index == PV.Index;
- }
- inline bool operator!=(const PointerVal &PV) const { return !operator==(PV); }
-
- void print(std::ostream &O) const;
-};
-
-
-// PointerValSet - This class represents a list of pointer values. The add
-// method is used to add values to the set, and ensures that duplicates cannot
-// happen.
+//===----------------------------------------------------------------------===//
+// 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.
//
-class PointerValSet {
- std::vector<PointerVal> Vals;
- void dropRefs();
- void addRefs();
+class DSNodeHandle {
+ DSNode *N;
public:
- PointerValSet() {}
- PointerValSet(const PointerValSet &PVS) : Vals(PVS.Vals) { addRefs(); }
- ~PointerValSet() { dropRefs(); }
- const PointerValSet &operator=(const PointerValSet &PVS);
-
- // operator< - Allow insertion into a map...
- bool operator<(const PointerValSet &PVS) const;
- bool operator==(const PointerValSet &PVS) const;
-
- const PointerVal &operator[](unsigned i) const { return Vals[i]; }
-
- unsigned size() const { return Vals.size(); }
- bool empty() const { return Vals.empty(); }
- void clear() { dropRefs(); Vals.clear(); }
-
- // add - Add the specified pointer, or contents of the specified PVS to this
- // pointer set. If a 'Pointer' value is provided, notify the underlying data
- // structure node that the pointer is pointing to it, so that it can be
- // invalidated if neccesary later. True is returned if the value is new to
- // this pointer.
- //
- bool add(const PointerVal &PV, Value *Pointer = 0);
- bool add(const PointerValSet &PVS, Value *Pointer = 0) {
- bool Changed = false;
- for (unsigned i = 0, e = PVS.size(); i != e; ++i)
- Changed |= add(PVS[i], Pointer);
- return Changed;
+ // Allow construction, destruction, and assignment...
+ DSNodeHandle(DSNode *n = 0) : N(0) { operator=(n); }
+ DSNodeHandle(const DSNodeHandle &H) : N(0) { operator=(H.N); }
+ ~DSNodeHandle() { operator=(0); }
+ DSNodeHandle &operator=(const DSNodeHandle &H) {operator=(H.N); return *this;}
+
+ // Assignment of DSNode*, implement all of the add/un'refing (defined later)
+ inline DSNodeHandle &operator=(DSNode *n);
+
+ // Allow automatic, implicit, conversion to DSNode*
+ operator DSNode*() { return N; }
+ operator const DSNode*() const { return N; }
+ operator bool() const { return N != 0; }
+ operator bool() { return N != 0; }
+
+ bool operator<(const DSNodeHandle &H) const { // Allow sorting
+ return N < H.N;
+ }
+ bool operator==(const DSNodeHandle &H) const { return N == H.N; }
+ bool operator!=(const DSNodeHandle &H) const { return N != H.N; }
+ bool operator==(const DSNode *Node) const { return N == Node; }
+ bool operator!=(const DSNode *Node) const { return N != Node; }
+ bool operator==(DSNode *Node) const { return N == Node; }
+ bool operator!=(DSNode *Node) const { return N != Node; }
+
+ // Avoid having comparisons to null cause errors...
+ bool operator==(int X) const {
+ assert(X == 0 && "Bad comparison!");
+ return operator==((DSNode*)0);
}
+ bool operator!=(int X) const { return !operator==(X); }
- // removePointerTo - Remove a single pointer val that points to the specified
- // node...
- void removePointerTo(DSNode *Node);
+ // Allow explicit conversion to DSNode...
+ DSNode *get() { return N; }
+ const DSNode *get() const { return N; }
- void print(std::ostream &O) const;
+ // Allow this to be treated like a pointer...
+ DSNode *operator->() { return N; }
+ const DSNode *operator->() const { return N; }
};
//===----------------------------------------------------------------------===//
-// DSNode - Base class for all data structure nodes...
+// DSNode - Data structure node class
+//
+// This class keeps track of a node's type, and the fields in the data
+// structure.
//
-// This class keeps track of its type, the pointer fields in the data structure,
-// and a list of LLVM values that are pointing to this node.
//
class DSNode {
- friend class FunctionDSGraph;
const Type *Ty;
- std::vector<PointerValSet> FieldLinks;
- std::vector<Value*> Pointers; // Values pointing to me...
- std::vector<PointerValSet*> Referrers;
+ std::vector<DSNodeHandle> Links;
+ std::vector<DSNodeHandle*> Referrers;
+
+ // Globals - The list of global values that are merged into this node.
+ std::vector<GlobalValue*> Globals;
- std::vector<std::pair<const Type *, ShadowDSNode *> > SynthNodes;
-
- DSNode(const DSNode &); // DO NOT IMPLEMENT
void operator=(const DSNode &); // DO NOT IMPLEMENT
public:
enum NodeTy {
- NewNode, CallNode, ShadowNode, GlobalNode
- } NodeType;
+ ShadowNode = 0 << 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
+ SubElement = 1 << 4, // This node is a part of some other node
+ CastNode = 1 << 5, // This node is accessed in unsafe ways
+ Incomplete = 1 << 6, // This node may not be complete
+ };
+
+ // 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;
DSNode(enum NodeTy NT, const Type *T);
- virtual ~DSNode() {
- dropAllReferences();
+ DSNode(const DSNode &);
+
+ ~DSNode() {
+#ifndef NDEBUG
+ dropAllReferences(); // Only needed to satisfy assertion checks...
+#endif
assert(Referrers.empty() && "Referrers to dead node exist!");
}
+ // Iterator for graph interface...
typedef DSNodeIterator iterator;
inline iterator begin(); // Defined in DataStructureGraph.h
inline iterator end();
- unsigned getNumLinks() const { return FieldLinks.size(); }
- PointerValSet &getLink(unsigned i) {
+ // Accessors
+ const Type *getType() const { return Ty; }
+
+ unsigned getNumLinks() const { return Links.size(); }
+ DSNode *getLink(unsigned i) {
assert(i < getNumLinks() && "Field links access out of range...");
- return FieldLinks[i];
+ return Links[i];
}
- const PointerValSet &getLink(unsigned i) const {
+ const DSNode *getLink(unsigned i) const {
assert(i < getNumLinks() && "Field links access out of range...");
- return FieldLinks[i];
+ return Links[i];
}
- // addReferrer - Keep the referrer set up to date...
- void addReferrer(PointerValSet *PVS) { Referrers.push_back(PVS); }
- void removeReferrer(PointerValSet *PVS);
- const std::vector<PointerValSet*> &getReferrers() const { return Referrers; }
-
- // removeAllIncomingEdges - Erase all edges in the graph that point to
- // this node
- void removeAllIncomingEdges();
-
- void addPointer(Value *V) { Pointers.push_back(V); }
- const std::vector<Value*> &getPointers() const { return Pointers; }
+ void setLink(unsigned i, DSNode *N) {
+ assert(i < getNumLinks() && "Field links access out of range...");
+ Links[i] = N;
+ }
- const Type *getType() const { return Ty; }
+ // 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.
+ //
+ void addGlobal(GlobalValue *GV);
+ const std::vector<GlobalValue*> &getGlobals() const { return Globals; }
+ std::vector<GlobalValue*> &getGlobals() { return Globals; }
- // getNumOutgoingLinks - Return the number of outgoing links, which is usually
- // the number of normal links, but for call nodes it also includes their
- // arguments.
+ // addEdgeTo - Add an edge from the current node to the specified node. This
+ // can cause merging of nodes in the graph.
//
- virtual unsigned getNumOutgoingLinks() const { return getNumLinks(); }
- virtual PointerValSet &getOutgoingLink(unsigned Link) {
- return getLink(Link);
+ void addEdgeTo(unsigned LinkNo, DSNode *N);
+ void addEdgeTo(DSNode *N) {
+ assert(getNumLinks() == 1 && "Must specify a field number to add edge if "
+ " more than one field exists!");
+ addEdgeTo(0, N);
}
- virtual const PointerValSet &getOutgoingLink(unsigned Link) const {
- return getLink(Link);
- }
-
- void print(std::ostream &O) const;
- void dump() const;
- virtual std::string getCaption() const = 0;
- virtual const std::vector<PointerValSet> *getAuxLinks() const {
- return 0; // Default to nothing...
- }
+ // mergeWith - Merge this node into the specified node, moving all links to
+ // and from the argument node into the current node. The specified node may
+ // be a null pointer (in which case, nothing happens).
+ //
+ void mergeWith(DSNode *N);
- // isEquivalentTo - Return true if the nodes should be merged...
- virtual bool isEquivalentTo(DSNode *Node) const = 0;
- virtual void mergeInto(DSNode *Node) const {}
+ // addReferrer - Keep the referrer set up to date...
+ void addReferrer(DSNodeHandle *H) { Referrers.push_back(H); }
+ void removeReferrer(DSNodeHandle *H);
+ const std::vector<DSNodeHandle*> &getReferrers() const { return Referrers; }
- DSNode *clone() const {
- DSNode *New = cloneImpl();
- // Add all of the pointers to the new node...
- for (unsigned pn = 0, pe = Pointers.size(); pn != pe; ++pn)
- New->addPointer(Pointers[pn]);
- return New;
- }
+ void print(std::ostream &O, const DSGraph *G) const;
+ void dump() const;
- // synthesizeNode - Create a new shadow node that is to be linked into this
- // chain..
- //
- ShadowDSNode *synthesizeNode(const Type *Ty, FunctionRepBuilder *Rep);
+ std::string getCaption(const DSGraph *G) const;
- virtual void dropAllReferences() {
- FieldLinks.clear();
+ void dropAllReferences() {
+ Links.clear();
}
-
- static bool classof(const DSNode *N) { return true; }
-protected:
- virtual DSNode *cloneImpl() const = 0;
- virtual void mapNode(std::map<const DSNode*, DSNode*> &NodeMap,
- const DSNode *Old);
};
-// AllocDSNode - Represent all allocation (malloc or alloca) in the program.
-//
-class AllocDSNode : public DSNode {
- AllocationInst *Allocation;
- bool isVarSize; // Allocating variable sized objects
-public:
- AllocDSNode(AllocationInst *V, bool isVarSize = false);
-
- virtual std::string getCaption() const;
-
- bool isAllocaNode() const;
- bool isMallocNode() const { return !isAllocaNode(); }
-
- AllocationInst *getAllocation() const { return Allocation; }
- bool isVariableSize() const { return isVarSize; }
-
- // isEquivalentTo - Return true if the nodes should be merged...
- virtual bool isEquivalentTo(DSNode *Node) const;
- virtual void mergeInto(DSNode *Node) const;
-
- // Support type inquiry through isa, cast, and dyn_cast...
- static bool classof(const AllocDSNode *) { return true; }
- static bool classof(const DSNode *N) { return N->NodeType == NewNode; }
-protected:
- virtual AllocDSNode *cloneImpl() const { return new AllocDSNode(Allocation,
- isVarSize); }
-};
+inline DSNodeHandle &DSNodeHandle::operator=(DSNode *n) {
+ if (N) N->removeReferrer(this);
+ N = n;
+ if (N) N->addReferrer(this);
+ return *this;
+}
-// GlobalDSNode - Represent the memory location that a global variable occupies
+// DSGraph - The graph that represents a function.
//
-class GlobalDSNode : public DSNode {
- GlobalValue *Val;
-public:
- GlobalDSNode(GlobalValue *V);
-
- GlobalValue *getGlobal() const { return Val; }
+class DSGraph {
+ Function &Func;
+ std::vector<DSNode*> Nodes;
+ DSNodeHandle RetNode; // Node that gets returned...
+ std::map<Value*, DSNodeHandle> ValueMap;
+
+ // 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.
+ //
+ std::vector<std::vector<DSNodeHandle> > FunctionCalls;
+
+ // OrigFunctionCalls - This vector retains a copy of the original function
+ // calls of the current graph. This is needed to support top-down inlining
+ // after bottom-up inlining is complete, since the latter deletes call nodes.
+ //
+ std::vector<std::vector<DSNodeHandle> > OrigFunctionCalls;
+
+ // PendingCallers - This vector records all unresolved callers of the
+ // current function, i.e., ones whose graphs have not been inlined into
+ // the current graph. As long as there are unresolved callers, the nodes
+ // for formal arguments in the current graph cannot be eliminated, and
+ // nodes in the graph reachable from the formal argument nodes or
+ // global variable nodes must be considered incomplete.
+ std::vector<Function*> PendingCallers;
- virtual std::string getCaption() const;
-
- // isEquivalentTo - Return true if the nodes should be merged...
- virtual bool isEquivalentTo(DSNode *Node) const;
-
- // Support type inquiry through isa, cast, and dyn_cast...
- static bool classof(const GlobalDSNode *) { return true; }
- static bool classof(const DSNode *N) { return N->NodeType == GlobalNode; }
private:
- virtual GlobalDSNode *cloneImpl() const { return new GlobalDSNode(Val); }
-};
-
+ // Define the interface only accessable to DataStructure
+ friend class LocalDataStructures;
+ friend class BUDataStructures;
+ friend class TDDataStructures;
+ DSGraph(Function &F); // Compute the local DSGraph
+ DSGraph(const DSGraph &DSG); // Copy ctor
+ ~DSGraph();
+
+ // clone all the call nodes and save the copies in OrigFunctionCalls
+ void saveOrigFunctionCalls() {
+ assert(OrigFunctionCalls.size() == 0 && "Do this only once!");
+ OrigFunctionCalls = FunctionCalls;
+ }
+
+ // get the saved copies of the original function call nodes
+ std::vector<std::vector<DSNodeHandle> > &getOrigFunctionCalls() {
+ return OrigFunctionCalls;
+ }
-// CallDSNode - Represent a call instruction in the program...
-//
-class CallDSNode : public DSNode {
- friend class FunctionDSGraph;
- CallInst *CI;
- std::vector<PointerValSet> ArgLinks;
+ void operator=(const DSGraph &); // DO NOT IMPLEMENT
public:
- CallDSNode(CallInst *CI);
- ~CallDSNode() {
- ArgLinks.clear();
- }
- CallInst *getCall() const { return CI; }
+ Function &getFunction() const { return Func; }
- const std::vector<PointerValSet> *getAuxLinks() const { return &ArgLinks; }
- virtual std::string getCaption() const;
+ // getValueMap - Get a map that describes what the nodes the scalars in this
+ // function point to...
+ //
+ std::map<Value*, DSNodeHandle> &getValueMap() { return ValueMap; }
+ const std::map<Value*, DSNodeHandle> &getValueMap() const { return ValueMap;}
- bool addArgValue(unsigned ArgNo, const PointerValSet &PVS) {
- return ArgLinks[ArgNo].add(PVS);
+ std::vector<std::vector<DSNodeHandle> > &getFunctionCalls() {
+ return FunctionCalls;
}
- unsigned getNumArgs() const { return ArgLinks.size(); }
- const PointerValSet &getArgValues(unsigned ArgNo) const {
- assert(ArgNo < ArgLinks.size() && "Arg # out of range!");
- return ArgLinks[ArgNo];
- }
- PointerValSet &getArgValues(unsigned ArgNo) {
- assert(ArgNo < ArgLinks.size() && "Arg # out of range!");
- return ArgLinks[ArgNo];
- }
- const std::vector<PointerValSet> &getArgs() const { return ArgLinks; }
+ const DSNode *getRetNode() const { return RetNode; }
- virtual void dropAllReferences() {
- DSNode::dropAllReferences();
- ArgLinks.clear();
+ unsigned getGraphSize() const {
+ return Nodes.size();
}
- // getNumOutgoingLinks - Return the number of outgoing links, which is usually
- // the number of normal links, but for call nodes it also includes their
- // arguments.
+ void print(std::ostream &O) const;
+ void dump() 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.
//
- virtual unsigned getNumOutgoingLinks() const {
- return getNumLinks() + getNumArgs();
- }
- virtual PointerValSet &getOutgoingLink(unsigned Link) {
- if (Link < getNumLinks()) return getLink(Link);
- return getArgValues(Link-getNumLinks());
- }
- virtual const PointerValSet &getOutgoingLink(unsigned Link) const {
- if (Link < getNumLinks()) return getLink(Link);
- return getArgValues(Link-getNumLinks());
- }
+ void maskNodeTypes(unsigned char Mask);
+ void maskIncompleteMarkers() { maskNodeTypes(~DSNode::Incomplete); }
- // isEquivalentTo - Return true if the nodes should be merged...
- virtual bool isEquivalentTo(DSNode *Node) const;
+ // 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();
+
+ // 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();
- // Support type inquiry through isa, cast, and dyn_cast...
- static bool classof(const CallDSNode *) { return true; }
- static bool classof(const DSNode *N) { return N->NodeType == CallNode; }
+ // 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();
+
+
+ // AddCaller - add a known caller node into the graph and mark it pending.
+ // getCallers - get a vector of the functions that call this one
+ // getCallersPending - get a matching vector of bools indicating if each
+ // caller's DSGraph has been resolved into this one.
+ //
+ void addCaller(Function& caller) {
+ PendingCallers.push_back(&caller);
+ }
+ std::vector<Function*>& getPendingCallers() {
+ return PendingCallers;
+ }
+
+ // 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 StripLocals is set to true, Scalar
+ // and Alloca markers are removed from the graph, as the graph is being cloned
+ // into a calling function's graph.
+ //
+ DSNode *cloneInto(const DSGraph &G, std::map<Value*, DSNodeHandle> &OldValMap,
+ std::map<const DSNode*, DSNode*>& OldNodeMap,
+ bool StripLocals = true);
private:
- virtual CallDSNode *cloneImpl() const { return new CallDSNode(CI); }
- virtual void mapNode(std::map<const DSNode*, DSNode*> &NodeMap,
- const DSNode *Old);
-};
+ bool isNodeDead(DSNode *N);
+};
-// ShadowDSNode - Represent a chunk of memory that we need to be able to
-// address. These are generated due to (for example) pointer type method
-// arguments... if the pointer is dereferenced, we need to have a node to point
-// to. When functions are integrated into each other, shadow nodes are
-// resolved.
+
+// LocalDataStructures - The analysis that computes the local data structure
+// graphs for all of the functions in the program.
+//
+// FIXME: This should be a Function pass that can be USED by a Pass, and would
+// be automatically preserved. Until we can do that, this is a Pass.
//
-class ShadowDSNode : public DSNode {
- friend class FunctionDSGraph;
- friend class FunctionRepBuilder;
- Module *Mod;
- DSNode *ShadowParent; // Nonnull if this is a synthesized node...
+class LocalDataStructures : public Pass {
+ // DSInfo, one graph for each function
+ std::map<Function*, DSGraph*> DSInfo;
public:
- ShadowDSNode(const Type *Ty, Module *M);
- virtual std::string getCaption() const;
-
- // isEquivalentTo - Return true if the nodes should be merged...
- virtual bool isEquivalentTo(DSNode *Node) const;
+ static AnalysisID ID; // DataStructure Analysis ID
- DSNode *getShadowParent() const { return ShadowParent; }
+ ~LocalDataStructures() { releaseMemory(); }
- // Support type inquiry through isa, cast, and dyn_cast...
- static bool classof(const ShadowDSNode *) { return true; }
- static bool classof(const DSNode *N) { return N->NodeType == ShadowNode; }
+ virtual bool run(Module &M);
-private:
- ShadowDSNode(const Type *Ty, Module *M, DSNode *ShadParent);
-protected:
- virtual ShadowDSNode *cloneImpl() const {
- if (ShadowParent)
- return new ShadowDSNode(getType(), Mod, ShadowParent);
- else
- return new ShadowDSNode(getType(), Mod);
+ // getDSGraph - Return the data structure graph for the specified function.
+ DSGraph &getDSGraph(Function &F) const {
+ std::map<Function*, DSGraph*>::const_iterator I = DSInfo.find(&F);
+ assert(I != DSInfo.end() && "Function not in module!");
+ return *I->second;
}
-};
+ // print - Print out the analysis results...
+ void print(std::ostream &O, const Module *M) const;
-// FunctionDSGraph - The graph that represents a method.
-//
-class FunctionDSGraph {
- Function *Func;
- std::vector<AllocDSNode*> AllocNodes;
- std::vector<ShadowDSNode*> ShadowNodes;
- std::vector<GlobalDSNode*> GlobalNodes;
- std::vector<CallDSNode*> CallNodes;
- PointerValSet RetNode; // Node that gets returned...
- std::map<Value*, PointerValSet> ValueMap;
-
- // cloneFunctionIntoSelf - Clone the specified method graph into the current
- // method graph, returning the Return's set of the graph. If ValueMap is set
- // to true, the ValueMap of the function is cloned into this function as well
- // as the data structure graph itself. Regardless, the arguments value sets
- // of DSG are copied into Args.
- //
- PointerValSet cloneFunctionIntoSelf(const FunctionDSGraph &G, bool ValueMap,
- std::vector<PointerValSet> &Args);
+ // If the pass pipeline is done with this pass, we can release our memory...
+ virtual void releaseMemory();
- bool RemoveUnreachableNodes();
- bool UnlinkUndistinguishableNodes();
- void MarkEscapeableNodesReachable(std::vector<bool> &RSN,
- std::vector<bool> &RAN);
+ // getAnalysisUsage - This obviously provides a data structure graph.
+ virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+ AU.setPreservesAll();
+ AU.addProvided(ID);
+ }
+};
-private:
- // Define the interface only accessable to DataStructure
- friend class DataStructure;
- FunctionDSGraph(Function *F);
- FunctionDSGraph(const FunctionDSGraph &DSG);
- ~FunctionDSGraph();
- void computeClosure(const DataStructure &DS);
+// BUDataStructures - The analysis that computes the interprocedurally closed
+// data structure graphs for all of the functions in the program. This pass
+// only performs a "Bottom Up" propogation (hence the name).
+//
+class BUDataStructures : public Pass {
+ // DSInfo, one graph for each function
+ std::map<Function*, DSGraph*> DSInfo;
public:
+ static AnalysisID ID; // BUDataStructure Analysis ID
- Function *getFunction() const { return Func; }
+ ~BUDataStructures() { releaseMemory(); }
- // getEscapingAllocations - Add all allocations that escape the current
- // function to the specified vector.
- //
- void getEscapingAllocations(std::vector<AllocDSNode*> &Allocs);
+ virtual bool run(Module &M);
- // getNonEscapingAllocations - Add all allocations that do not escape the
- // current function to the specified vector.
- //
- void getNonEscapingAllocations(std::vector<AllocDSNode*> &Allocs);
-
- // getValueMap - Get a map that describes what the nodes the scalars in this
- // function point to...
- //
- std::map<Value*, PointerValSet> &getValueMap() { return ValueMap; }
- const std::map<Value*, PointerValSet> &getValueMap() const { return ValueMap;}
+ // getDSGraph - Return the data structure graph for the specified function.
+ DSGraph &getDSGraph(Function &F) const {
+ std::map<Function*, DSGraph*>::const_iterator I = DSInfo.find(&F);
+ assert(I != DSInfo.end() && "Function not in module!");
+ return *I->second;
+ }
+
+ // print - Print out the analysis results...
+ void print(std::ostream &O, const Module *M) const;
- const PointerValSet &getRetNodes() const { return RetNode; }
+ // If the pass pipeline is done with this pass, we can release our memory...
+ virtual void releaseMemory();
- unsigned getGraphSize() const {
- return AllocNodes.size() + ShadowNodes.size() +
- GlobalNodes.size() + CallNodes.size();
+ // getAnalysisUsage - This obviously provides a data structure graph.
+ virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+ AU.setPreservesAll();
+ AU.addProvided(ID);
+ AU.addRequired(LocalDataStructures::ID);
}
-
- void printFunction(std::ostream &O, const char *Label) const;
+private:
+ DSGraph &calculateGraph(Function &F);
};
-// FIXME: This should be a FunctionPass. When the pass framework sees a 'Pass'
-// that uses the output of a FunctionPass, it should automatically build a map
-// of output from the method pass that the pass can use.
+// TDDataStructures - Analysis that computes new data structure graphs
+// for each function using the closed graphs for the callers computed
+// by the bottom-up pass.
//
-class DataStructure : public Pass {
- // DSInfo, one intraprocedural and one closed graph for each method...
- typedef std::map<Function*, std::pair<FunctionDSGraph*,
- FunctionDSGraph*> > InfoMap;
- mutable InfoMap DSInfo;
+class TDDataStructures : public Pass {
+ // DSInfo, one graph for each function
+ std::map<Function*, DSGraph*> DSInfo;
public:
- static AnalysisID ID; // DataStructure Analysis ID
+ static AnalysisID ID; // TDDataStructure Analysis ID
- DataStructure(AnalysisID id) { assert(id == ID); }
- ~DataStructure() { releaseMemory(); }
+ ~TDDataStructures() { releaseMemory(); }
- virtual const char *getPassName() const { return "Data Structure Analysis"; }
-
- // run - Do nothing, because methods are analyzed lazily
- virtual bool run(Module *TheModule) { return false; }
-
- // getDSGraph - Return the data structure graph for the specified method.
- // Since method graphs are lazily computed, we may have to create one on the
- // fly here.
- //
- FunctionDSGraph &getDSGraph(Function *F) const {
- std::pair<FunctionDSGraph*, FunctionDSGraph*> &N = DSInfo[F];
- if (N.first) return *N.first;
- return *(N.first = new FunctionDSGraph(F));
+ virtual const char *getPassName() const {
+ return "Top-down Data Structure Analysis Closure";
}
- // getClosedDSGraph - Return the data structure graph for the specified
- // method. Since method graphs are lazily computed, we may have to create one
- // on the fly here. This is different than the normal DSGraph for the method
- // because any function calls that are resolvable will have the data structure
- // graphs of the called function incorporated into this function as well.
- //
- FunctionDSGraph &getClosedDSGraph(Function *F) const {
- std::pair<FunctionDSGraph*, FunctionDSGraph*> &N = DSInfo[F];
- if (N.second) return *N.second;
- N.second = new FunctionDSGraph(getDSGraph(F));
- N.second->computeClosure(*this);
- return *N.second;
- }
+ virtual bool run(Module &M);
- // invalidateFunction - Inform this analysis that you changed the specified
- // function, so the graphs that depend on it are out of date.
- //
- void invalidateFunction(Function *F) const {
- // FIXME: THis should invalidate all functions who have inlined the
- // specified graph!
- //
- std::pair<FunctionDSGraph*, FunctionDSGraph*> &N = DSInfo[F];
- delete N.first;
- delete N.second;
- N.first = N.second = 0;
+ // getDSGraph - Return the data structure graph for the specified function.
+ DSGraph &getDSGraph(Function &F) const {
+ std::map<Function*, DSGraph*>::const_iterator I = DSInfo.find(&F);
+ assert(I != DSInfo.end() && "Function not in module!");
+ return *I->second;
}
// print - Print out the analysis results...
- void print(std::ostream &O, Module *M) const;
+ void print(std::ostream &O, const Module *M) const;
// If the pass pipeline is done with this pass, we can release our memory...
virtual void releaseMemory();
- // getAnalysisUsage - This obviously provides a call graph
+ // getAnalysisUsage - This obviously provides a data structure graph.
virtual void getAnalysisUsage(AnalysisUsage &AU) const {
AU.setPreservesAll();
AU.addProvided(ID);
+ AU.addRequired(BUDataStructures::ID);
}
+private:
+ DSGraph &calculateGraph(Function &F);
+ void pushGraphIntoCallee(DSGraph &callerGraph, DSGraph &calleeGraph,
+ std::map<Value*, DSNodeHandle> &OldValMap,
+ std::map<const DSNode*, DSNode*> &OldNodeMap);
};
-
#endif
projects / oota-llvm.git / blobdiff