svf-lib 1.0.2238 → 1.0.2239

package/SVF-linux-aarch64/Release-build/include/Graphs/ThreadCallGraph.h

@@ -0,0 +1,400 @@
+//===- ThreadCallGraph.h -- Call graph considering thread fork/join-----------//
+//
+//                     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/>.
+//
+//===----------------------------------------------------------------------===//
+
+/*
+ * ThreadCallGraph.h
+ *
+ *  Created on: Jul 7, 2014
+ *      Authors: Peng Di, Yulei Sui, Ding Ye
+ */
+
+#ifndef RCG_H_
+#define RCG_H_
+
+#include "Graphs/CallGraph.h"
+
+namespace SVF
+{
+
+class SVFModule;
+class ThreadAPI;
+class PointerAnalysis;
+/*!
+ * PTA thread fork edge from fork site to the entry of a start routine function
+ */
+class ThreadForkEdge: public CallGraphEdge
+{
+
+public:
+    /// Constructor
+    ThreadForkEdge(CallGraphNode* s, CallGraphNode* d, CallSiteID csId) :
+        CallGraphEdge(s, d, CallGraphEdge::TDForkEdge, csId)
+    {
+    }
+    /// Destructor
+    virtual ~ThreadForkEdge()
+    {
+    }
+
+    /// ClassOf
+    //@{
+    static inline bool classof(const ThreadForkEdge*)
+    {
+        return true;
+    }
+    static inline bool classof(const CallGraphEdge*edge)
+    {
+        return edge->getEdgeKind() == CallGraphEdge::TDForkEdge;
+    }
+    //@}
+
+    virtual const std::string toString() const;
+
+    typedef GenericNode<CallGraphNode, ThreadForkEdge>::GEdgeSetTy ForkEdgeSet;
+};
+
+/*!
+ * PTA thread join edge from the exit of a start routine function to a join point of the thread
+ */
+class ThreadJoinEdge: public CallGraphEdge
+{
+
+public:
+    /// Constructor
+    ThreadJoinEdge(CallGraphNode* s, CallGraphNode* d, CallSiteID csId) :
+        CallGraphEdge(s, d, CallGraphEdge::TDJoinEdge, csId)
+    {
+    }
+    /// Destructor
+    virtual ~ThreadJoinEdge()
+    {
+    }
+
+    static inline bool classof(const ThreadJoinEdge*)
+    {
+        return true;
+    }
+    static inline bool classof(const CallGraphEdge*edge)
+    {
+        return edge->getEdgeKind() == CallGraphEdge::TDJoinEdge;
+    }
+
+    virtual const std::string toString() const;
+
+    typedef GenericNode<CallGraphNode, ThreadJoinEdge>::GEdgeSetTy JoinEdgeSet;
+};
+
+/*!
+ * hare_parallel_for edge from fork site to the entry of a start routine function
+ */
+class HareParForEdge: public CallGraphEdge
+{
+
+public:
+    /// Constructor
+    HareParForEdge(CallGraphNode* s, CallGraphNode* d, CallSiteID csId) :
+        CallGraphEdge(s, d, CallGraphEdge::HareParForEdge, csId)
+    {
+    }
+    /// Destructor
+    virtual ~HareParForEdge()
+    {
+    }
+
+    /// ClassOf
+    //@{
+    static inline bool classof(const HareParForEdge*)
+    {
+        return true;
+    }
+    static inline bool classof(const CallGraphEdge*edge)
+    {
+        return edge->getEdgeKind() == CallGraphEdge::HareParForEdge;
+    }
+    //@}
+
+    typedef GenericNode<CallGraphNode, HareParForEdge>::GEdgeSetTy ParForEdgeSet;
+};
+
+
+/*!
+ * Thread sensitive call graph
+ */
+class ThreadCallGraph: public CallGraph
+{
+
+public:
+    typedef Set<const CallICFGNode*> InstSet;
+    typedef InstSet CallSiteSet;
+    typedef Set<CallSiteSet*> CtxSet;
+    typedef ThreadForkEdge::ForkEdgeSet ForkEdgeSet;
+    typedef Map<const CallICFGNode*, ForkEdgeSet> CallInstToForkEdgesMap;
+    typedef ThreadJoinEdge::JoinEdgeSet JoinEdgeSet;
+    typedef Map<const CallICFGNode*, JoinEdgeSet> CallInstToJoinEdgesMap;
+    typedef HareParForEdge::ParForEdgeSet ParForEdgeSet;
+    typedef Map<const CallICFGNode*, ParForEdgeSet> CallInstToParForEdgesMap;
+
+    /// Constructor
+    ThreadCallGraph(const CallGraph& cg);
+
+    ThreadCallGraph(ThreadCallGraph& cg) = delete;
+
+    /// Destructor
+    virtual ~ThreadCallGraph()
+    {
+    }
+
+    /// ClassOf
+    //@{
+    static inline bool classof(const ThreadCallGraph *)
+    {
+        return true;
+    }
+    static inline bool classof(const CallGraph*g)
+    {
+        return g->getKind() == CallGraph::ThdCallGraph;
+    }
+    //@}
+
+    /// Update call graph using pointer results
+    void updateCallGraph(PointerAnalysis* pta);
+    /// Update join edge using pointer analysis results
+    void updateJoinEdge(PointerAnalysis* pta);
+
+
+    /// Get call graph edge via call instruction
+    //@{
+    /// whether this call instruction has a valid call graph edge
+    inline bool hasThreadForkEdge(const CallICFGNode* cs) const
+    {
+        return callinstToThreadForkEdgesMap.find(cs) !=
+               callinstToThreadForkEdgesMap.end();
+    }
+    inline ForkEdgeSet::const_iterator getForkEdgeBegin(const CallICFGNode* cs) const
+    {
+        CallInstToForkEdgesMap::const_iterator it = callinstToThreadForkEdgesMap.find(cs);
+        assert(it != callinstToThreadForkEdgesMap.end() && "call instruction not found");
+        return it->second.begin();
+    }
+    inline ForkEdgeSet::const_iterator getForkEdgeEnd(const CallICFGNode* cs) const
+    {
+        CallInstToForkEdgesMap::const_iterator it = callinstToThreadForkEdgesMap.find(cs);
+        assert(it != callinstToThreadForkEdgesMap.end() && "call instruction not found");
+        return it->second.end();
+    }
+
+    /// Get call graph edge via call instruction
+    //@{
+    /// whether this call instruction has a valid call graph edge
+    inline bool hasThreadJoinEdge(const CallICFGNode* cs) const
+    {
+        return callinstToThreadJoinEdgesMap.find(cs) != callinstToThreadJoinEdgesMap.end();
+    }
+    inline JoinEdgeSet::const_iterator getJoinEdgeBegin(const CallICFGNode* cs) const
+    {
+        CallInstToJoinEdgesMap::const_iterator it = callinstToThreadJoinEdgesMap.find(cs);
+        assert(it != callinstToThreadJoinEdgesMap.end() && "call instruction does not have a valid callee");
+        return it->second.begin();
+    }
+    inline JoinEdgeSet::const_iterator getJoinEdgeEnd(const CallICFGNode* cs) const
+    {
+        CallInstToJoinEdgesMap::const_iterator it = callinstToThreadJoinEdgesMap.find(cs);
+        assert(it != callinstToThreadJoinEdgesMap.end() && "call instruction does not have a valid callee");
+        return it->second.end();
+    }
+    inline void getJoinSites(const CallGraphNode* routine, InstSet& csSet)
+    {
+        for(CallInstToJoinEdgesMap::const_iterator it = callinstToThreadJoinEdgesMap.begin(), eit = callinstToThreadJoinEdgesMap.end(); it!=eit; ++it)
+        {
+            for(JoinEdgeSet::const_iterator jit = it->second.begin(), ejit = it->second.end(); jit!=ejit; ++jit)
+            {
+                if((*jit)->getDstNode() == routine)
+                {
+                    csSet.insert(it->first);
+                }
+            }
+        }
+    }
+    //@}
+
+    /// Whether a callsite is a fork or join or hare_parallel_for
+    ///@{
+    inline bool isForksite(const CallICFGNode* csInst)
+    {
+        return forksites.find(csInst) != forksites.end();
+    }
+    inline bool isJoinsite(const CallICFGNode* csInst)
+    {
+        return joinsites.find(csInst) != joinsites.end();
+    }
+    inline bool isParForSite(const CallICFGNode* csInst)
+    {
+        return parForSites.find(csInst) != parForSites.end();
+    }
+    ///
+
+    /// Fork sites iterators
+    //@{
+    inline CallSiteSet::const_iterator forksitesBegin() const
+    {
+        return forksites.begin();
+    }
+    inline CallSiteSet::const_iterator forksitesEnd() const
+    {
+        return forksites.end();
+    }
+    //@}
+
+    /// Join sites iterators
+    //@{
+    inline CallSiteSet::const_iterator joinsitesBegin() const
+    {
+        return joinsites.begin();
+    }
+    inline CallSiteSet::const_iterator joinsitesEnd() const
+    {
+        return joinsites.end();
+    }
+    //@}
+
+    /// hare_parallel_for sites iterators
+    //@{
+    inline CallSiteSet::const_iterator parForSitesBegin() const
+    {
+        return parForSites.begin();
+    }
+    inline CallSiteSet::const_iterator parForSitesEnd() const
+    {
+        return parForSites.end();
+    }
+    //@}
+
+    /// Num of fork/join sites
+    //@{
+    inline u32_t getNumOfForksite() const
+    {
+        return forksites.size();
+    }
+    inline u32_t getNumOfJoinsite() const
+    {
+        return joinsites.size();
+    }
+    inline u32_t getNumOfParForSite() const
+    {
+        return parForSites.size();
+    }
+    //@}
+
+    /// Thread API
+    inline ThreadAPI* getThreadAPI() const
+    {
+        return tdAPI;
+    }
+
+    /// Add fork sites which directly or indirectly create a thread
+    //@{
+    inline bool addForksite(const CallICFGNode* cs)
+    {
+        callinstToThreadForkEdgesMap[cs];
+        return forksites.insert(cs).second;
+    }
+    inline bool addJoinsite(const CallICFGNode* cs)
+    {
+        callinstToThreadJoinEdgesMap[cs];
+        return joinsites.insert(cs).second;
+    }
+    inline bool addParForSite(const CallICFGNode* cs)
+    {
+        callinstToHareParForEdgesMap[cs];
+        return parForSites.insert(cs).second;
+    }
+    //@}
+
+    /// Add direct/indirect thread fork edges
+    //@{
+    bool addDirectForkEdge(const CallICFGNode* cs);
+    bool addIndirectForkEdge(const CallICFGNode* cs, const FunObjVar* callee);
+    //@}
+
+    /// Add thread join edges
+    //@{
+    void addDirectJoinEdge(const CallICFGNode* cs,const CallSiteSet& forksite);
+    //@}
+
+
+    /// map call instruction to its PTACallGraphEdge map
+    inline void addThreadForkEdgeSetMap(const CallICFGNode* cs, ThreadForkEdge* edge)
+    {
+        if(edge!=nullptr)
+        {
+            callinstToThreadForkEdgesMap[cs].insert(edge);
+            callinstToCallGraphEdgesMap[cs].insert(edge);
+        }
+    }
+
+    /// map call instruction to its PTACallGraphEdge map
+    inline void addThreadJoinEdgeSetMap(const CallICFGNode* cs, ThreadJoinEdge* edge)
+    {
+        if(edge!=nullptr)
+        {
+            callinstToThreadJoinEdgesMap[cs].insert(edge);
+            callinstToCallGraphEdgesMap[cs].insert(edge);
+        }
+    }
+
+    /// map call instruction to its PTACallGraphEdge map
+    inline void addHareParForEdgeSetMap(const CallICFGNode* cs, HareParForEdge* edge)
+    {
+        if(edge!=nullptr)
+        {
+            callinstToHareParForEdgesMap[cs].insert(edge);
+            callinstToCallGraphEdgesMap[cs].insert(edge);
+        }
+    }
+
+    /// has thread join edge
+    inline ThreadJoinEdge* hasThreadJoinEdge(const CallICFGNode* call, CallGraphNode* joinFunNode, CallGraphNode* threadRoutineFunNode, CallSiteID csId) const
+    {
+        ThreadJoinEdge joinEdge(joinFunNode,threadRoutineFunNode, csId);
+        CallInstToJoinEdgesMap::const_iterator it = callinstToThreadJoinEdgesMap.find(call);
+        if(it != callinstToThreadJoinEdgesMap.end())
+        {
+            JoinEdgeSet::const_iterator jit = it->second.find(&joinEdge);
+            if(jit!=it->second.end())
+                return *jit;
+        }
+        return nullptr;
+    }
+
+private:
+    ThreadAPI* tdAPI;		///< Thread API
+    CallSiteSet forksites; ///< all thread fork sites
+    CallSiteSet joinsites; ///< all thread fork sites
+    CallSiteSet parForSites; ///< all parallel for sites
+    CallInstToForkEdgesMap callinstToThreadForkEdgesMap; ///< Map a call instruction to its corresponding fork edges
+    CallInstToJoinEdgesMap callinstToThreadJoinEdgesMap; ///< Map a call instruction to its corresponding join edges
+    CallInstToParForEdgesMap callinstToHareParForEdgesMap; ///< Map a call instruction to its corresponding hare_parallel_for edges
+};
+
+} // End namespace SVF
+
+#endif /* RCG_H_ */