X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FAnalysis%2FCallGraph.h;h=de839694dc8a3d812635c6321eeab54683856d45;hb=b679de2a21f5ecbae81b444290d72af93aa5b0b3;hp=446ea500d468c1a41626d836a08f23dcfa946321;hpb=b12914bfc0f76a7a48357162d5f4c39a1343e69b;p=oota-llvm.git diff --git a/include/llvm/Analysis/CallGraph.h b/include/llvm/Analysis/CallGraph.h index 446ea500d46..de839694dc8 100644 --- a/include/llvm/Analysis/CallGraph.h +++ b/include/llvm/Analysis/CallGraph.h @@ -1,13 +1,13 @@ //===- CallGraph.h - Build a Module's call graph ----------------*- C++ -*-===// -// +// // The LLVM Compiler Infrastructure // -// This file was developed by the LLVM research group and is distributed under -// the University of Illinois Open Source License. See LICENSE.TXT for details. -// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// //===----------------------------------------------------------------------===// // -// This interface is used to build and manipulate a call graph, which is a very +// This interface is used to build and manipulate a call graph, which is a very // useful tool for interprocedural optimization. // // Every function in a module is represented as a node in the call graph. The @@ -54,6 +54,9 @@ #include "llvm/ADT/GraphTraits.h" #include "llvm/ADT/STLExtras.h" #include "llvm/Pass.h" +#include "llvm/Support/CallSite.h" +#include "llvm/System/IncludeFile.h" +#include namespace llvm { @@ -64,41 +67,21 @@ class CallGraphNode; //===----------------------------------------------------------------------===// // CallGraph class definition // -class CallGraph : public ModulePass { +class CallGraph { +protected: Module *Mod; // The module this call graph represents typedef std::map FunctionMapTy; FunctionMapTy FunctionMap; // Map from a function to its node - // Root is root of the call graph, or the external node if a 'main' function - // couldn't be found. - // - CallGraphNode *Root; - - // ExternalCallingNode - This node has edges to all external functions and - // those internal functions that have their address taken. - CallGraphNode *ExternalCallingNode; - - // CallsExternalNode - This node has edges to it from all functions making - // indirect calls or calling an external function. - CallGraphNode *CallsExternalNode; - public: + static char ID; // Class identification, replacement for typeinfo //===--------------------------------------------------------------------- // Accessors... // typedef FunctionMapTy::iterator iterator; typedef FunctionMapTy::const_iterator const_iterator; - CallGraphNode *getExternalCallingNode() const { return ExternalCallingNode; } - CallGraphNode *getCallsExternalNode() const { return CallsExternalNode; } - - // getRoot - Return the root of the call graph, which is either main, or if - // main cannot be found, the external node. - // - CallGraphNode *getRoot() { return Root; } - const CallGraphNode *getRoot() const { return Root; } - /// getModule - Return the module the call graph corresponds to. /// Module &getModule() const { return *Mod; } @@ -108,7 +91,6 @@ public: inline const_iterator begin() const { return FunctionMap.begin(); } inline const_iterator end() const { return FunctionMap.end(); } - // Subscripting operators, return the call graph node for the provided // function inline const CallGraphNode *operator[](const Function *F) const { @@ -122,6 +104,16 @@ public: return I->second; } + /// Returns the CallGraphNode which is used to represent undetermined calls + /// into the callgraph. Override this if you want behavioral inheritance. + virtual CallGraphNode* getExternalCallingNode() const { return 0; } + + /// Return the root/main method in the module, or some other root node, such + /// as the externalcallingnode. Overload these if you behavioral + /// inheritance. + virtual CallGraphNode* getRoot() { return 0; } + virtual const CallGraphNode* getRoot() const { return 0; } + //===--------------------------------------------------------------------- // Functions to keep a call graph up to date with a function that has been // modified. @@ -144,72 +136,52 @@ public: /// old code over). void changeFunction(Function *OldF, Function *NewF); + /// getOrInsertFunction - This method is identical to calling operator[], but + /// it will insert a new CallGraphNode for the specified function if one does + /// not already exist. + CallGraphNode *getOrInsertFunction(const Function *F); + //===--------------------------------------------------------------------- // Pass infrastructure interface glue code... // - CallGraph() : Root(0), CallsExternalNode(0) {} - ~CallGraph() { destroy(); } - - // runOnModule - Compute the call graph for the specified module. - virtual bool runOnModule(Module &M); - - // getAnalysisUsage - This obviously provides a call graph - virtual void getAnalysisUsage(AnalysisUsage &AU) const { - AU.setPreservesAll(); - } +protected: + CallGraph() {} - // releaseMemory - Data structures can be large, so free memory aggressively. - virtual void releaseMemory() { - destroy(); - } +public: + virtual ~CallGraph() { destroy(); } - /// Print the types found in the module. If the optional Module parameter is - /// passed in, then the types are printed symbolically if possible, using the - /// symbol table from the module. + /// initialize - Call this method before calling other methods, + /// re/initializes the state of the CallGraph. /// - void print(std::ostream &o, const Module *M) const; + void initialize(Module &M); - /// dump - Print out this call graph. - /// + virtual void print(std::ostream &o, const Module *M) const; + void print(std::ostream *o, const Module *M) const { if (o) print(*o, M); } void dump() const; - // stub - dummy function, just ignore it - static void stub(); -private: - //===--------------------------------------------------------------------- - // Implementation of CallGraph construction - // - - // getNodeFor - Return the node for the specified function or create one if it - // does not already exist. - // - CallGraphNode *getNodeFor(Function *F); - - // addToCallGraph - Add a function to the call graph, and link the node to all - // of the functions that it calls. - // - void addToCallGraph(Function *F); - +protected: // destroy - Release memory for the call graph - void destroy(); + virtual void destroy(); }; - //===----------------------------------------------------------------------===// // CallGraphNode class definition // class CallGraphNode { Function *F; - std::vector CalledFunctions; + typedef std::pair CallRecord; + std::vector CalledFunctions; CallGraphNode(const CallGraphNode &); // Do not implement public: + typedef std::vector CalledFunctionsVector; + //===--------------------------------------------------------------------- // Accessor methods... // - typedef std::vector::iterator iterator; - typedef std::vector::const_iterator const_iterator; + typedef std::vector::iterator iterator; + typedef std::vector::const_iterator const_iterator; // getFunction - Return the function that this call graph node represents... Function *getFunction() const { return F; } @@ -218,16 +190,20 @@ public: inline iterator end() { return CalledFunctions.end(); } inline const_iterator begin() const { return CalledFunctions.begin(); } inline const_iterator end() const { return CalledFunctions.end(); } - inline unsigned size() const { return CalledFunctions.size(); } + inline bool empty() const { return CalledFunctions.empty(); } + inline unsigned size() const { return (unsigned)CalledFunctions.size(); } // Subscripting operator - Return the i'th called function... // - CallGraphNode *operator[](unsigned i) const { return CalledFunctions[i];} + CallGraphNode *operator[](unsigned i) const { + return CalledFunctions[i].second; + } /// dump - Print out this call graph node. /// void dump() const; void print(std::ostream &OS) const; + void print(std::ostream *OS) const { if (OS) print(*OS); } //===--------------------------------------------------------------------- // Methods to keep a call graph up to date with a function that has been @@ -240,45 +216,65 @@ public: CalledFunctions.clear(); } - /// addCalledFunction add a function to the list of functions called by this + /// addCalledFunction - Add a function to the list of functions called by this /// one. - void addCalledFunction(CallGraphNode *M) { - CalledFunctions.push_back(M); + void addCalledFunction(CallSite CS, CallGraphNode *M) { + CalledFunctions.push_back(std::make_pair(CS, M)); } - /// removeCallEdgeTo - This method removes a *single* edge to the specified - /// callee function. Note that this method takes linear time, so it should be - /// used sparingly. - void removeCallEdgeTo(CallGraphNode *Callee); + /// removeCallEdgeFor - This method removes the edge in the node for the + /// specified call site. Note that this method takes linear time, so it + /// should be used sparingly. + void removeCallEdgeFor(CallSite CS); - /// removeAnyCallEdgeTo - This method removes any call edges from this node to - /// the specified callee function. This takes more time to execute than + /// removeAnyCallEdgeTo - This method removes all call edges from this node + /// to the specified callee function. This takes more time to execute than /// removeCallEdgeTo, so it should not be used unless necessary. void removeAnyCallEdgeTo(CallGraphNode *Callee); -private: // Stuff to construct the node, used by CallGraph + /// removeOneAbstractEdgeTo - Remove one edge associated with a null callsite + /// from this node to the specified callee function. + void removeOneAbstractEdgeTo(CallGraphNode *Callee); + + /// replaceCallSite - Make the edge in the node for Old CallSite be for + /// New CallSite instead. Note that this method takes linear time, so it + /// should be used sparingly. + void replaceCallSite(CallSite Old, CallSite New); + friend class CallGraph; - // CallGraphNode ctor - Create a node for the specified function... + // CallGraphNode ctor - Create a node for the specified function. inline CallGraphNode(Function *f) : F(f) {} }; - - //===----------------------------------------------------------------------===// // GraphTraits specializations for call graphs so that they can be treated as -// graphs by the generic graph algorithms... +// graphs by the generic graph algorithms. // // Provide graph traits for tranversing call graphs using standard graph // traversals. template <> struct GraphTraits { typedef CallGraphNode NodeType; - typedef NodeType::iterator ChildIteratorType; + + typedef std::pair CGNPairTy; + typedef std::pointer_to_unary_function CGNDerefFun; static NodeType *getEntryNode(CallGraphNode *CGN) { return CGN; } - static inline ChildIteratorType child_begin(NodeType *N) { return N->begin();} - static inline ChildIteratorType child_end (NodeType *N) { return N->end(); } + + typedef mapped_iterator ChildIteratorType; + + static inline ChildIteratorType child_begin(NodeType *N) { + return map_iterator(N->begin(), CGNDerefFun(CGNDeref)); + } + static inline ChildIteratorType child_end (NodeType *N) { + return map_iterator(N->end(), CGNDerefFun(CGNDeref)); + } + + static CallGraphNode *CGNDeref(CGNPairTy P) { + return P.second; + } + }; template <> struct GraphTraits { @@ -306,11 +302,11 @@ template<> struct GraphTraits : public GraphTraits { return map_iterator(CG->end(), DerefFun(CGdereference)); } - static CallGraphNode &CGdereference (std::pair P) { + static CallGraphNode &CGdereference(PairTy P) { return *P.second; } }; + template<> struct GraphTraits : public GraphTraits { static NodeType *getEntryNode(const CallGraph *CGN) { @@ -322,10 +318,9 @@ template<> struct GraphTraits : static nodes_iterator nodes_end (const CallGraph *CG) { return CG->end(); } }; -// Make sure that any clients of this file link in PostDominators.cpp -static IncludeFile -CALLGRAPH_INCLUDE_FILE((void*)&CallGraph::stub); - } // End llvm namespace +// Make sure that any clients of this file link in CallGraph.cpp +FORCE_DEFINING_FILE_TO_BE_LINKED(CallGraph) + #endif