svf-lib 1.0.2319 → 1.0.2321

package/SVF-osx/Release-build/include/SVF/Graphs/CallGraph.h

@@ -0,0 +1,497 @@
+//===- PTACallGraph.h -- Call graph representation----------------------------//
+//
+//                     SVF: Static Value-Flow Analysis
+//
+// Copyright (C) <2013-2017>  <Yulei Sui>
+//
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+//===----------------------------------------------------------------------===//
+
+/*
+ * PTACallGraph.h
+ *
+ *  Created on: Nov 7, 2013
+ *      Author: Yulei Sui
+ */
+
+#ifndef PTACALLGRAPH_H_
+#define PTACALLGRAPH_H_
+
+#include "Graphs/GenericGraph.h"
+#include "SVFIR/SVFValue.h"
+#include "Graphs/ICFG.h"
+#include <set>
+
+namespace SVF
+{
+
+class CallGraphNode;
+class CallGraph;
+
+
+/*
+ * Call Graph edge representing a calling relation between two functions
+ * Multiple calls from function A to B are merged into one call edge
+ * Each call edge has a set of direct callsites and a set of indirect callsites
+ */
+typedef GenericEdge<CallGraphNode> GenericPTACallGraphEdgeTy;
+class CallGraphEdge : public GenericPTACallGraphEdgeTy
+{
+
+public:
+    typedef Set<const CallICFGNode*> CallInstSet;
+    enum CEDGEK
+    {
+        CallRetEdge,TDForkEdge,TDJoinEdge,HareParForEdge
+    };
+
+
+private:
+    CallInstSet directCalls;
+    CallInstSet indirectCalls;
+    CallSiteID csId;
+public:
+    /// Constructor
+    CallGraphEdge(CallGraphNode* s, CallGraphNode* d, CEDGEK kind, CallSiteID cs) :
+        GenericPTACallGraphEdgeTy(s, d, makeEdgeFlagWithInvokeID(kind, cs)), csId(cs)
+    {
+    }
+    /// Destructor
+    virtual ~CallGraphEdge()
+    {
+    }
+    /// Compute the unique edgeFlag value from edge kind and CallSiteID.
+    static inline GEdgeFlag makeEdgeFlagWithInvokeID(GEdgeKind k, CallSiteID cs)
+    {
+        return (cs << EdgeKindMaskBits) | k;
+    }
+    /// Get direct and indirect calls
+    //@{
+    inline CallSiteID getCallSiteID() const
+    {
+        return csId;
+    }
+    inline bool isDirectCallEdge() const
+    {
+        return !directCalls.empty() && indirectCalls.empty();
+    }
+    inline bool isIndirectCallEdge() const
+    {
+        return directCalls.empty() && !indirectCalls.empty();
+    }
+    inline CallInstSet& getDirectCalls()
+    {
+        return directCalls;
+    }
+    inline CallInstSet& getIndirectCalls()
+    {
+        return indirectCalls;
+    }
+    inline const CallInstSet& getDirectCalls() const
+    {
+        return directCalls;
+    }
+    inline const CallInstSet& getIndirectCalls() const
+    {
+        return indirectCalls;
+    }
+    //@}
+
+    /// Add direct and indirect callsite
+    //@{
+    void addDirectCallSite(const CallICFGNode* call);
+
+    void addInDirectCallSite(const CallICFGNode* call);
+    //@}
+
+    /// Iterators for direct and indirect callsites
+    //@{
+    inline CallInstSet::const_iterator directCallsBegin() const
+    {
+        return directCalls.begin();
+    }
+    inline CallInstSet::const_iterator directCallsEnd() const
+    {
+        return directCalls.end();
+    }
+
+    inline CallInstSet::const_iterator indirectCallsBegin() const
+    {
+        return indirectCalls.begin();
+    }
+    inline CallInstSet::const_iterator indirectCallsEnd() const
+    {
+        return indirectCalls.end();
+    }
+    //@}
+
+    /// ClassOf
+    //@{
+    static inline bool classof(const CallGraphEdge*)
+    {
+        return true;
+    }
+    static inline bool classof(const GenericPTACallGraphEdgeTy *edge)
+    {
+        return edge->getEdgeKind() == CallGraphEdge::CallRetEdge ||
+               edge->getEdgeKind() == CallGraphEdge::TDForkEdge ||
+               edge->getEdgeKind() == CallGraphEdge::TDJoinEdge;
+    }
+    //@}
+
+    /// Overloading operator << for dumping ICFG node ID
+    //@{
+    friend OutStream& operator<< (OutStream &o, const CallGraphEdge&edge)
+    {
+        o << edge.toString();
+        return o;
+    }
+    //@}
+
+    virtual const std::string toString() const;
+
+    typedef GenericNode<CallGraphNode, CallGraphEdge>::GEdgeSetTy CallGraphEdgeSet;
+
+};
+
+class FunObjVar;
+
+/*
+ * Call Graph node representing a function
+ */
+typedef GenericNode<CallGraphNode, CallGraphEdge> GenericPTACallGraphNodeTy;
+class CallGraphNode : public GenericPTACallGraphNodeTy
+{
+private:
+    const FunObjVar* fun;
+
+public:
+    /// Constructor
+    CallGraphNode(NodeID i, const FunObjVar* f) : GenericPTACallGraphNodeTy(i,CallNodeKd), fun(f)
+    {
+
+    }
+
+    const std::string &getName() const;
+
+    /// Get function of this call node
+    inline const FunObjVar* getFunction() const
+    {
+        return fun;
+    }
+
+    /// Return TRUE if this function can be reached from main.
+    bool isReachableFromProgEntry(Map<NodeID, bool> &reachableFromEntry, NodeBS &visitedNodes) const;
+
+
+    /// Overloading operator << for dumping ICFG node ID
+    //@{
+    friend OutStream& operator<< (OutStream &o, const CallGraphNode&node)
+    {
+        o << node.toString();
+        return o;
+    }
+    //@}
+
+    virtual const std::string toString() const;
+
+    /// Methods for support type inquiry through isa, cast, and dyn_cast:
+    //@{
+    static inline bool classof(const CallGraphNode*)
+    {
+        return true;
+    }
+
+    static inline bool classof(const GenericICFGNodeTy* node)
+    {
+        return node->getNodeKind() == CallNodeKd;
+    }
+
+    static inline bool classof(const SVFValue* node)
+    {
+        return node->getNodeKind() == CallNodeKd;
+    }
+    //@}
+};
+
+/*!
+ * Pointer Analysis Call Graph used internally for various pointer analysis
+ */
+typedef GenericGraph<CallGraphNode, CallGraphEdge> GenericPTACallGraphTy;
+class CallGraph : public GenericPTACallGraphTy
+{
+
+public:
+    typedef CallGraphEdge::CallGraphEdgeSet CallGraphEdgeSet;
+    typedef Map<const FunObjVar*, CallGraphNode*> FunToCallGraphNodeMap;
+    typedef Map<const CallICFGNode*, CallGraphEdgeSet> CallInstToCallGraphEdgesMap;
+    typedef std::pair<const CallICFGNode*, const FunObjVar*> CallSitePair;
+    typedef Map<CallSitePair, CallSiteID> CallSiteToIdMap;
+    typedef Map<CallSiteID, CallSitePair> IdToCallSiteMap;
+    typedef Set<const FunObjVar*> FunctionSet;
+    typedef OrderedMap<const CallICFGNode*, FunctionSet> CallEdgeMap;
+    typedef CallGraphEdgeSet::iterator CallGraphEdgeIter;
+    typedef CallGraphEdgeSet::const_iterator CallGraphEdgeConstIter;
+
+    enum CGEK
+    {
+        NormCallGraph, ThdCallGraph
+    };
+
+private:
+    /// Indirect call map
+    CallEdgeMap indirectCallMap;
+
+    /// Call site information
+    static CallSiteToIdMap csToIdMap;	///< Map a pair of call instruction and callee to a callsite ID
+    static IdToCallSiteMap idToCSMap;	///< Map a callsite ID to a pair of call instruction and callee
+    static CallSiteID totalCallSiteNum;	///< CallSiteIDs, start from 1;
+
+protected:
+    FunToCallGraphNodeMap funToCallGraphNodeMap; ///< Call Graph node map
+    CallInstToCallGraphEdgesMap callinstToCallGraphEdgesMap; ///< Map a call instruction to its corresponding call edges
+
+    NodeID callGraphNodeNum;
+    u32_t numOfResolvedIndCallEdge;
+    CGEK kind;
+
+    /// Clean up memory
+    void destroy();
+
+protected:
+    /// Add CallSiteID
+    inline CallSiteID addCallSite(const CallICFGNode* cs, const FunObjVar* callee)
+    {
+        std::pair<const CallICFGNode*, const FunObjVar*> newCS(std::make_pair(cs, callee));
+        CallSiteToIdMap::const_iterator it = csToIdMap.find(newCS);
+        //assert(it == csToIdMap.end() && "cannot add a callsite twice");
+        if(it == csToIdMap.end())
+        {
+            CallSiteID id = totalCallSiteNum++;
+            csToIdMap.insert(std::make_pair(newCS, id));
+            idToCSMap.insert(std::make_pair(id, newCS));
+            return id;
+        }
+        return it->second;
+    }
+
+    /// Add call graph edge
+    inline void addEdge(CallGraphEdge* edge)
+    {
+        edge->getDstNode()->addIncomingEdge(edge);
+        edge->getSrcNode()->addOutgoingEdge(edge);
+    }
+
+public:
+    /// Constructor
+    CallGraph(CGEK k = NormCallGraph);
+
+    /// Copy constructor
+    CallGraph(const CallGraph& other);
+
+    /// Destructor
+    virtual ~CallGraph()
+    {
+        destroy();
+    }
+
+    /// Return type of this callgraph
+    inline CGEK getKind() const
+    {
+        return kind;
+    }
+
+    /// Get callees from an indirect callsite
+    //@{
+    inline CallEdgeMap& getIndCallMap()
+    {
+        return indirectCallMap;
+    }
+    inline bool hasIndCSCallees(const CallICFGNode* cs) const
+    {
+        return (indirectCallMap.find(cs) != indirectCallMap.end());
+    }
+    inline const FunctionSet& getIndCSCallees(const CallICFGNode* cs) const
+    {
+        CallEdgeMap::const_iterator it = indirectCallMap.find(cs);
+        assert(it!=indirectCallMap.end() && "not an indirect callsite!");
+        return it->second;
+    }
+    //@}
+    inline u32_t getTotalCallSiteNumber() const
+    {
+        return totalCallSiteNum;
+    }
+
+    inline u32_t getNumOfResolvedIndCallEdge() const
+    {
+        return numOfResolvedIndCallEdge;
+    }
+
+    inline const CallInstToCallGraphEdgesMap& getCallInstToCallGraphEdgesMap() const
+    {
+        return callinstToCallGraphEdgesMap;
+    }
+
+    /// Issue a warning if the function which has indirect call sites can not be reached from program entry.
+    void verifyCallGraph();
+
+    /// Add direct call edges
+    void addDirectCallGraphEdge(const CallICFGNode* call, const FunObjVar* callerFun, const FunObjVar* calleeFun);
+
+    void addCallGraphNode(const FunObjVar* fun);
+
+    /// Get call graph node
+    //@{
+
+    const CallGraphNode* getCallGraphNode(const std::string& name);
+
+    inline CallGraphNode* getCallGraphNode(NodeID id) const
+    {
+        return getGNode(id);
+    }
+    inline CallGraphNode* getCallGraphNode(const FunObjVar* fun) const
+    {
+        FunToCallGraphNodeMap::const_iterator it = funToCallGraphNodeMap.find(fun);
+        assert(it!=funToCallGraphNodeMap.end() && "call graph node not found!!");
+        return it->second;
+    }
+
+    //@}
+
+    /// Get CallSiteID
+    //@{
+    inline CallSiteID getCallSiteID(const CallICFGNode* cs, const FunObjVar* callee) const
+    {
+        CallSitePair newCS(std::make_pair(cs, callee));
+        CallSiteToIdMap::const_iterator it = csToIdMap.find(newCS);
+        assert(it != csToIdMap.end() && "callsite id not found! This maybe a partially resolved callgraph, please check the indCallEdge limit");
+        return it->second;
+    }
+    inline bool hasCallSiteID(const CallICFGNode* cs, const FunObjVar* callee) const
+    {
+        CallSitePair newCS(std::make_pair(cs, callee));
+        CallSiteToIdMap::const_iterator it = csToIdMap.find(newCS);
+        return it != csToIdMap.end();
+    }
+    inline const CallSitePair& getCallSitePair(CallSiteID id) const
+    {
+        IdToCallSiteMap::const_iterator it = idToCSMap.find(id);
+        assert(it != idToCSMap.end() && "cannot find call site for this CallSiteID");
+        return (it->second);
+    }
+    inline const CallICFGNode* getCallSite(CallSiteID id) const
+    {
+        return getCallSitePair(id).first;
+    }
+    const FunObjVar* getCallerOfCallSite(CallSiteID id) const;
+    inline const FunObjVar* getCalleeOfCallSite(CallSiteID id) const
+    {
+        return getCallSitePair(id).second;
+    }
+    //@}
+    /// Whether we have already created this call graph edge
+    CallGraphEdge* hasGraphEdge(CallGraphNode* src, CallGraphNode* dst,
+                                CallGraphEdge::CEDGEK kind, CallSiteID csId) const;
+    /// Get call graph edge via nodes
+    CallGraphEdge* getGraphEdge(CallGraphNode* src, CallGraphNode* dst,
+                                CallGraphEdge::CEDGEK kind, CallSiteID csId);
+
+    /// Get all callees for a callsite
+    inline void getCallees(const CallICFGNode* cs, FunctionSet& callees)
+    {
+        if(hasCallGraphEdge(cs))
+        {
+            for (CallGraphEdgeSet::const_iterator it = getCallEdgeBegin(cs), eit =
+                        getCallEdgeEnd(cs); it != eit; ++it)
+            {
+                callees.insert((*it)->getDstNode()->getFunction());
+            }
+        }
+    }
+
+    /// Get call graph edge via call instruction
+    //@{
+    /// whether this call instruction has a valid call graph edge
+    inline bool hasCallGraphEdge(const CallICFGNode* inst) const
+    {
+        return callinstToCallGraphEdgesMap.find(inst)!=callinstToCallGraphEdgesMap.end();
+    }
+    inline CallGraphEdgeSet::const_iterator getCallEdgeBegin(const CallICFGNode* inst) const
+    {
+        CallInstToCallGraphEdgesMap::const_iterator it = callinstToCallGraphEdgesMap.find(inst);
+        assert(it!=callinstToCallGraphEdgesMap.end()
+               && "call instruction does not have a valid callee");
+        return it->second.begin();
+    }
+    inline CallGraphEdgeSet::const_iterator getCallEdgeEnd(const CallICFGNode* inst) const
+    {
+        CallInstToCallGraphEdgesMap::const_iterator it = callinstToCallGraphEdgesMap.find(inst);
+        assert(it!=callinstToCallGraphEdgesMap.end()
+               && "call instruction does not have a valid callee");
+        return it->second.end();
+    }
+    //@}
+
+
+    /// Add indirect call edges
+    //@{
+    void addIndirectCallGraphEdge(const CallICFGNode* cs,const FunObjVar* callerFun, const FunObjVar* calleeFun);
+    //@}
+
+    /// Get callsites invoking the callee
+    //@{
+    void getAllCallSitesInvokingCallee(const FunObjVar* callee, CallGraphEdge::CallInstSet& csSet);
+    void getDirCallSitesInvokingCallee(const FunObjVar* callee, CallGraphEdge::CallInstSet& csSet);
+    void getIndCallSitesInvokingCallee(const FunObjVar* callee, CallGraphEdge::CallInstSet& csSet);
+    //@}
+
+    /// Whether its reachable between two functions
+    bool isReachableBetweenFunctions(const FunObjVar* srcFn, const FunObjVar* dstFn) const;
+
+    /// Dump the graph
+    void dump(const std::string& filename);
+
+    /// View the graph from the debugger
+    void view();
+};
+
+} // End namespace SVF
+
+namespace SVF
+{
+/* !
+ * GenericGraphTraits specializations for generic graph algorithms.
+ * Provide graph traits for traversing from a constraint node using standard graph traversals.
+ */
+template<> struct GenericGraphTraits<SVF::CallGraphNode*> : public GenericGraphTraits<SVF::GenericNode<SVF::CallGraphNode,SVF::CallGraphEdge>*  >
+{
+};
+
+/// Inverse GenericGraphTraits specializations for call graph node, it is used for inverse traversal.
+template<>
+struct GenericGraphTraits<Inverse<SVF::CallGraphNode*> > : public GenericGraphTraits<Inverse<SVF::GenericNode<SVF::CallGraphNode,SVF::CallGraphEdge>* > >
+{
+};
+
+template<> struct GenericGraphTraits<SVF::CallGraph*> : public GenericGraphTraits<SVF::GenericGraph<SVF::CallGraphNode,SVF::CallGraphEdge>* >
+{
+    typedef SVF::CallGraphNode*NodeRef;
+};
+
+} // End namespace llvm
+
+#endif /* PTACALLGRAPH_H_ */