-//===- DataStructure.h - Build data structure graphs -------------*- C++ -*--=//
+//===- DataStructure.h - Build data structure graphs ------------*- C++ -*-===//
//
// Implement the LLVM data structure analysis library.
//
#define LLVM_ANALYSIS_DATA_STRUCTURE_H
#include "llvm/Pass.h"
-#include <string>
+#include "Support/hash_set"
class Type;
-class CallInst;
-class AllocationInst;
-class FunctionArgument;
+class Instruction;
+class DSGraph;
class DSNode;
-class FunctionRepBuilder;
-class GlobalValue;
-class FunctionDSGraph;
-class DataStructure;
-
-// 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; }
-
- 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.
-//
-class PointerValSet {
- std::vector<PointerVal> Vals;
- void dropRefs();
- void addRefs();
-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.
+// FIXME: move this stuff to a private header
+namespace DataStructureAnalysis {
+ // isPointerType - Return true if this first class type is big enough to hold
+ // a 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;
- }
-
- // removePointerTo - Remove a single pointer val that points to the specified
- // node...
- void removePointerTo(DSNode *Node);
-
- void print(std::ostream &O) const;
-};
+ bool isPointerType(const Type *Ty);
+}
-//===----------------------------------------------------------------------===//
-// DSNode - Base class for all data structure nodes...
+// LocalDataStructures - The analysis that computes the local data structure
+// graphs for all of the functions in the program.
//
-// 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.
+// 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 DSNode {
- friend class FunctionDSGraph;
- const Type *Ty;
- std::vector<PointerValSet> FieldLinks;
- std::vector<Value*> Pointers; // Values pointing to me...
- std::vector<PointerValSet*> Referrers;
-
- DSNode(const DSNode &); // DO NOT IMPLEMENT
- void operator=(const DSNode &); // DO NOT IMPLEMENT
+class LocalDataStructures : public Pass {
+ // DSInfo, one graph for each function
+ hash_map<Function*, DSGraph*> DSInfo;
+ DSGraph *GlobalsGraph;
public:
- enum NodeTy {
- NewNode, CallNode, ShadowNode, ArgNode, GlobalNode
- } NodeType;
-
- DSNode(enum NodeTy NT, const Type *T);
- virtual ~DSNode() {
- dropAllReferences();
- assert(Referrers.empty() && "Referrers to dead node exist!");
- }
-
- unsigned getNumLinks() const { return FieldLinks.size(); }
- PointerValSet &getLink(unsigned i) {
- assert(i < getNumLinks() && "Field links access out of range...");
- return FieldLinks[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; }
+ ~LocalDataStructures() { releaseMemory(); }
- const Type *getType() const { return Ty; }
+ virtual bool run(Module &M);
- void print(std::ostream &O) const;
-
- virtual std::string getCaption() const = 0;
- virtual const std::vector<PointerValSet> *getAuxLinks() const {
- return 0; // Default to nothing...
- }
-
- // isEquivalentTo - Return true if the nodes should be merged...
- virtual bool isEquivalentTo(DSNode *Node) const = 0;
-
- 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;
+ bool hasGraph(const Function &F) const {
+ return DSInfo.find(const_cast<Function*>(&F)) != DSInfo.end();
}
-
- virtual void dropAllReferences() {
- FieldLinks.clear();
+ // getDSGraph - Return the data structure graph for the specified function.
+ DSGraph &getDSGraph(const Function &F) const {
+ hash_map<Function*, DSGraph*>::const_iterator I =
+ DSInfo.find(const_cast<Function*>(&F));
+ assert(I != DSInfo.end() && "Function not in module!");
+ return *I->second;
}
- 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;
-public:
- AllocDSNode(AllocationInst *V);
-
- virtual std::string getCaption() const;
-
- bool isAllocaNode() const;
- bool isMallocNode() const { return !isAllocaNode(); }
+ DSGraph &getGlobalsGraph() const { return *GlobalsGraph; }
- AllocationInst *getAllocation() const { return Allocation; }
-
- // 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 AllocDSNode *) { return true; }
- static bool classof(const DSNode *N) { return N->NodeType == NewNode; }
-protected:
- virtual AllocDSNode *cloneImpl() const { return new AllocDSNode(Allocation); }
-};
-
-
-// GlobalDSNode - Represent the memory location that a global variable occupies
-//
-class GlobalDSNode : public DSNode {
- GlobalValue *Val;
-public:
- GlobalDSNode(GlobalValue *V);
-
- GlobalValue *getGlobal() const { return Val; }
-
- virtual std::string getCaption() const;
+ // print - Print out the analysis results...
+ void print(std::ostream &O, const Module *M) const;
- // isEquivalentTo - Return true if the nodes should be merged...
- virtual bool isEquivalentTo(DSNode *Node) const;
+ // If the pass pipeline is done with this pass, we can release our memory...
+ virtual void releaseMemory();
- // 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); }
+ // getAnalysisUsage - This obviously provides a data structure graph.
+ virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+ AU.setPreservesAll();
+ }
};
-// CallDSNode - Represent a call instruction in the program...
+// 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" propagation (hence the name).
//
-class CallDSNode : public DSNode {
- friend class FunctionDSGraph;
- CallInst *CI;
- std::vector<PointerValSet> ArgLinks;
+class BUDataStructures : public Pass {
+ // DSInfo, one graph for each function
+ hash_map<Function*, DSGraph*> DSInfo;
+ DSGraph *GlobalsGraph;
+ hash_multimap<Instruction*, Function*> ActualCallees;
public:
- CallDSNode(CallInst *CI);
-
- CallInst *getCall() const { return CI; }
-
- const std::vector<PointerValSet> *getAuxLinks() const { return &ArgLinks; }
- virtual std::string getCaption() const;
+ ~BUDataStructures() { releaseMemory(); }
- bool addArgValue(unsigned ArgNo, const PointerValSet &PVS) {
- return ArgLinks[ArgNo].add(PVS);
- }
+ virtual bool run(Module &M);
- 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];
+ bool hasGraph(const Function &F) const {
+ return DSInfo.find(const_cast<Function*>(&F)) != DSInfo.end();
}
- const std::vector<PointerValSet> &getArgs() const { return ArgLinks; }
- virtual void dropAllReferences() {
- DSNode::dropAllReferences();
- ArgLinks.clear();
+ // getDSGraph - Return the data structure graph for the specified function.
+ DSGraph &getDSGraph(const Function &F) const {
+ hash_map<Function*, DSGraph*>::const_iterator I =
+ DSInfo.find(const_cast<Function*>(&F));
+ assert(I != DSInfo.end() && "Function not in module!");
+ return *I->second;
}
- // 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 CallDSNode *) { return true; }
- static bool classof(const DSNode *N) { return N->NodeType == CallNode; }
-private:
- virtual CallDSNode *cloneImpl() const { return new CallDSNode(CI); }
- virtual void mapNode(std::map<const DSNode*, DSNode*> &NodeMap,
- const DSNode *Old);
-};
-
-
-// ArgDSNode - Represent an incoming argument to the current function...
-//
-class ArgDSNode : public DSNode {
- FunctionArgument *FuncArg;
-public:
- ArgDSNode(FunctionArgument *MA);
- virtual std::string getCaption() const;
-
- // isEquivalentTo - Return true if the nodes should be merged...
- virtual bool isEquivalentTo(DSNode *Node) const;
+ DSGraph &getGlobalsGraph() const { return *GlobalsGraph; }
- // Support type inquiry through isa, cast, and dyn_cast...
- static bool classof(const ArgDSNode *) { return true; }
- static bool classof(const DSNode *N) { return N->NodeType == ArgNode; }
-private:
- virtual ArgDSNode *cloneImpl() const { return new ArgDSNode(FuncArg); }
-};
-
-
-// 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.
-//
-// Shadow nodes may be marked as "critical" nodes when they are created. This
-// mark indicates that the node is the result of a function call, the value
-// pointed to by an incoming argument, or the value pointed to by a global
-// variable [fixme todo]. Since it is not possible to know what these nodes
-// point to, given just the current context, they are marked "Critical" to avoid
-// having the shadow node merger eliminate them.
-//
-class ShadowDSNode : public DSNode {
- friend class FunctionDSGraph;
- DSNode *Parent;
- Module *Mod;
- ShadowDSNode *ShadowParent; // Nonnull if this is a synthesized node...
- std::vector<std::pair<const Type *, ShadowDSNode *> > SynthNodes;
- bool CriticalNode;
-public:
- ShadowDSNode(DSNode *Parent, Module *M, bool Critical = false);
- virtual std::string getCaption() const;
-
- // synthesizeNode - Create a new shadow node that is to be linked into this
- // chain..
- //
- ShadowDSNode *synthesizeNode(const Type *Ty, FunctionRepBuilder *Rep);
-
- bool isCriticalNode() const { return CriticalNode; }
- void resetCriticalMark() { CriticalNode = false; }
-
- // isEquivalentTo - Return true if the nodes should be merged...
- virtual bool isEquivalentTo(DSNode *Node) const;
+ // print - Print out the analysis results...
+ void print(std::ostream &O, const Module *M) const;
- // 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; }
+ // If the pass pipeline is done with this pass, we can release our memory...
+ virtual void releaseMemory();
-private:
- ShadowDSNode(const Type *Ty, Module *M, ShadowDSNode *ShadParent);
-protected:
- virtual void mapNode(std::map<const DSNode*, DSNode*> &NodeMap,
- const DSNode *Old);
- virtual ShadowDSNode *cloneImpl() const {
- if (ShadowParent)
- return new ShadowDSNode(getType(), Mod, ShadowParent);
- else
- return new ShadowDSNode(Parent, Mod, CriticalNode);
+ virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+ AU.setPreservesAll();
+ AU.addRequired<LocalDataStructures>();
}
-};
-
-// FunctionDSGraph - The graph that represents a method.
-//
-class FunctionDSGraph {
- Function *Func;
- std::vector<ArgDSNode*> ArgNodes;
- 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.
- //
- PointerValSet cloneFunctionIntoSelf(const FunctionDSGraph &G, bool ValueMap);
- bool RemoveUnreachableNodes();
- bool UnlinkUndistinguishableNodes();
- void MarkEscapeableNodesReachable(std::vector<bool> &RSN,
- std::vector<bool> &RAN);
+ typedef hash_multimap<Instruction*, Function*> ActualCalleesTy;
+ const ActualCalleesTy &getActualCallees() const {
+ return ActualCallees;
+ }
private:
- // Define the interface only accessable to DataStructure
- friend class DataStructure;
- FunctionDSGraph(Function *F);
- FunctionDSGraph(const FunctionDSGraph &DSG);
- ~FunctionDSGraph();
-
- void computeClosure(const DataStructure &DS);
-public:
-
- Function *getFunction() const { return Func; }
-
- // getEscapingAllocations - Add all allocations that escape the current
- // function to the specified vector.
- //
- void getEscapingAllocations(std::vector<AllocDSNode*> &Allocs);
-
- // getNonEscapingAllocations - Add all allocations that do not escape the
- // current function to the specified vector.
- //
- void getNonEscapingAllocations(std::vector<AllocDSNode*> &Allocs);
+ void calculateGraph(DSGraph &G);
- // getValueMap - Get a map that describes what the nodes the scalars in this
- // function point to...
- //
- std::map<Value*, PointerValSet> &getValueMap() { return ValueMap; }
+ void calculateReachableGraphs(Function *F);
+ DSGraph &getOrCreateGraph(Function *F);
- void printFunction(std::ostream &O, const char *Label) const;
+ unsigned calculateGraphs(Function *F, std::vector<Function*> &Stack,
+ unsigned &NextID,
+ hash_map<Function*, unsigned> &ValMap);
};
-// 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
+ hash_map<Function*, DSGraph*> DSInfo;
+ hash_set<Function*> ArgsRemainIncomplete;
+ DSGraph *GlobalsGraph;
public:
- static AnalysisID ID; // DataStructure Analysis ID
-
- DataStructure(AnalysisID id) { assert(id == ID); }
- ~DataStructure() { releaseMemory(); }
+ ~TDDataStructures() { releaseMyMemory(); }
- // run - Do nothing, because methods are analyzed lazily
- virtual bool run(Module *TheModule) { return false; }
+ virtual bool run(Module &M);
- // 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));
+ bool hasGraph(const Function &F) const {
+ return DSInfo.find(const_cast<Function*>(&F)) != DSInfo.end();
}
- // 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;
+ // getDSGraph - Return the data structure graph for the specified function.
+ DSGraph &getDSGraph(const Function &F) const {
+ hash_map<Function*, DSGraph*>::const_iterator I =
+ DSInfo.find(const_cast<Function*>(&F));
+ assert(I != DSInfo.end() && "Function not in module!");
+ return *I->second;
}
- // 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;
- }
+ DSGraph &getGlobalsGraph() const { return *GlobalsGraph; }
// 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();
+ virtual void releaseMyMemory();
- // getAnalysisUsageInfo - This obviously provides a call graph
- virtual void getAnalysisUsageInfo(AnalysisSet &Required,
- AnalysisSet &Destroyed,
- AnalysisSet &Provided) {
- Provided.push_back(ID);
+ // getAnalysisUsage - This obviously provides a data structure graph.
+ virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+ AU.setPreservesAll();
+ AU.addRequired<BUDataStructures>();
}
+
+private:
+ void markReachableFunctionsExternallyAccessible(DSNode *N,
+ hash_set<DSNode*> &Visited);
+
+ void inlineGraphIntoCallees(DSGraph &G);
+ DSGraph &getOrCreateDSGraph(Function &F);
+ void ComputePostOrder(Function &F, hash_set<DSGraph*> &Visited,
+ std::vector<DSGraph*> &PostOrder,
+ const BUDataStructures::ActualCalleesTy &ActualCallees);
};
#endif
projects / oota-llvm.git / blobdiff