svf-lib 1.0.1374 → 1.0.1376

package/SVF-osx/svf/include/MTA/TCT.h

@@ -0,0 +1,599 @@
+//===- TCT.h -- Thread creation tree-------------//
+//
+//                     SVF: Static Value-Flow Analysis
+//
+// Copyright (C) <2013->  <Yulei Sui>
+//
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU 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 General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+//===----------------------------------------------------------------------===//
+
+/*
+ * TCT.h
+ *
+ *  Created on: Jun 24, 2015
+ *      Author: Yulei Sui, Peng Di
+ */
+
+#ifndef TCTNodeDetector_H_
+#define TCTNodeDetector_H_
+
+#include "Util/SCC.h"
+#include "Util/SVFUtil.h"
+#include "Graphs/ThreadCallGraph.h"
+#include "Util/CxtStmt.h"
+#include <set>
+#include <vector>
+
+namespace SVF
+{
+
+class TCTNode;
+
+
+/*
+ * Thread creation edge represents a spawning relation between two context sensitive threads
+ */
+typedef GenericEdge<TCTNode> GenericTCTEdgeTy;
+class TCTEdge: public GenericTCTEdgeTy
+{
+public:
+    enum CEDGEK
+    {
+        ThreadCreateEdge
+    };
+    /// Constructor
+    TCTEdge(TCTNode* s, TCTNode* d, CEDGEK kind) :
+        GenericTCTEdgeTy(s, d, kind)
+    {
+    }
+    /// Destructor
+    virtual ~TCTEdge()
+    {
+    }
+    /// Classof
+    //@{
+    static inline bool classof(const TCTEdge*)
+    {
+        return true;
+    }
+    static inline bool classof(const GenericTCTEdgeTy *edge)
+    {
+        return edge->getEdgeKind() == TCTEdge::ThreadCreateEdge;
+    }
+    ///@}
+    typedef GenericNode<TCTNode, TCTEdge>::GEdgeSetTy ThreadCreateEdgeSet;
+
+};
+
+/*
+ * Each node represents a context-sensitive thread
+ */
+typedef GenericNode<TCTNode, TCTEdge> GenericTCTNodeTy;
+class TCTNode: public GenericTCTNodeTy
+{
+
+public:
+    /// Constructor
+    TCTNode(NodeID i, const CxtThread& cctx) :
+        GenericTCTNodeTy(i, 0), ctx(cctx), multiforked(false)
+    {
+    }
+
+    void dump()
+    {
+        SVFUtil::outs() << "---\ntid: " << this->getId() << "  inloop:" << ctx.isInloop() << "  incycle:" << ctx.isIncycle() << " multiforked:"<< isMultiforked();
+    }
+
+    /// Get CxtThread
+    inline const CxtThread& getCxtThread() const
+    {
+        return ctx;
+    }
+
+    /// inloop, incycle attributes
+    //@{
+    inline bool isInloop() const
+    {
+        return ctx.isInloop();
+    }
+    inline bool isIncycle() const
+    {
+        return ctx.isIncycle();
+    }
+    inline void setMultiforked(bool value)
+    {
+        multiforked = value;
+    }
+    inline bool isMultiforked() const
+    {
+        return multiforked;
+    }
+    //@}
+
+private:
+    const CxtThread ctx;
+    bool multiforked;
+};
+
+/*!
+ * Pointer Analysis Call Graph used internally for various pointer analysis
+ */
+typedef GenericGraph<TCTNode, TCTEdge> GenericThreadCreateTreeTy;
+class TCT: public GenericThreadCreateTreeTy
+{
+
+public:
+    typedef SVFLoopAndDomInfo::LoopBBs LoopBBs;
+    typedef TCTEdge::ThreadCreateEdgeSet ThreadCreateEdgeSet;
+    typedef ThreadCreateEdgeSet::iterator TCTNodeIter;
+    typedef Set<const SVFFunction*> FunSet;
+    typedef std::vector<const SVFInstruction*> InstVec;
+    typedef Set<const SVFInstruction*> InstSet;
+    typedef Set<const PTACallGraphNode*> PTACGNodeSet;
+    typedef Map<CxtThread,TCTNode*> CxtThreadToNodeMap;
+    typedef Map<CxtThread,CallStrCxt> CxtThreadToForkCxt;
+    typedef Map<CxtThread,const SVFFunction*> CxtThreadToFun;
+    typedef Map<const SVFInstruction*, LoopBBs> InstToLoopMap;
+    typedef FIFOWorkList<CxtThreadProc> CxtThreadProcVec;
+    typedef Set<CxtThreadProc> CxtThreadProcSet;
+    typedef SCCDetection<PTACallGraph*> ThreadCallGraphSCC;
+
+    /// Constructor
+    TCT(PointerAnalysis* p) :pta(p),TCTNodeNum(0),TCTEdgeNum(0),MaxCxtSize(0)
+    {
+        tcg = SVFUtil::cast<ThreadCallGraph>(pta->getPTACallGraph());
+        tcg->updateCallGraph(pta);
+        //tcg->updateJoinEdge(pta);
+        tcgSCC = pta->getCallGraphSCC();
+        tcgSCC->find();
+        build();
+    }
+
+    /// Destructor
+    virtual ~TCT()
+    {
+        destroy();
+    }
+    /// Get CallICFGNode given inst
+    CallICFGNode* getCallICFGNode(const SVFInstruction* inst)
+    {
+        return pta->getICFG()->getCallICFGNode(inst);
+    }
+    /// Get SVFFModule
+    SVFModule* getSVFModule() const
+    {
+        return pta->getModule();
+    }
+
+    /// Get TCG
+    inline ThreadCallGraph* getThreadCallGraph() const
+    {
+        return tcg;
+    }
+    /// Get PTA
+    inline PointerAnalysis* getPTA() const
+    {
+        return pta;
+    }
+    /// Get TCT node
+    inline TCTNode* getTCTNode(NodeID id) const
+    {
+        return getGNode(id);
+    }
+    /// Whether we have aleady created this call graph edge
+    TCTEdge* hasGraphEdge(TCTNode* src, TCTNode* dst, TCTEdge::CEDGEK kind) const;
+    /// Get call graph edge via nodes
+    TCTEdge* getGraphEdge(TCTNode* src, TCTNode* dst, TCTEdge::CEDGEK kind);
+
+    /// Get children and parent nodes
+    //@{
+    inline ThreadCreateEdgeSet::const_iterator getChildrenBegin(const TCTNode* node) const
+    {
+        return node->OutEdgeBegin();
+    }
+    inline ThreadCreateEdgeSet::const_iterator getChildrenEnd(const TCTNode* node) const
+    {
+        return node->OutEdgeEnd();
+    }
+    inline ThreadCreateEdgeSet::const_iterator getParentsBegin(const TCTNode* node) const
+    {
+        return node->InEdgeBegin();
+    }
+    inline ThreadCreateEdgeSet::const_iterator getParentsEnd(const TCTNode* node) const
+    {
+        return node->InEdgeEnd();
+    }
+    //@}
+
+    /// Get marked candidate functions
+    inline const FunSet& getMakredProcs() const
+    {
+        return candidateFuncSet;
+    }
+
+    /// Get marked candidate functions
+    inline const FunSet& getEntryProcs() const
+    {
+        return entryFuncSet;
+    }
+
+    /// Get Statistics
+    //@{
+    inline u32_t getTCTNodeNum() const
+    {
+        return TCTNodeNum;
+    }
+    inline u32_t getTCTEdgeNum() const
+    {
+        return TCTEdgeNum;
+    }
+    inline u32_t getMaxCxtSize() const
+    {
+        return MaxCxtSize;
+    }
+    //@}
+
+    /// Find/Get TCT node
+    //@{
+    inline bool hasTCTNode(const CxtThread& ct) const
+    {
+        return ctpToNodeMap.find(ct)!=ctpToNodeMap.end();
+    }
+    inline TCTNode* getTCTNode(const CxtThread& ct) const
+    {
+        CxtThreadToNodeMap::const_iterator it = ctpToNodeMap.find(ct);
+        assert(it!=ctpToNodeMap.end() && "TCT node not found??");
+        return it->second;
+    }
+    //@}
+
+    /// Whether it is a candidate function for indirect call
+    inline bool isCandidateFun(const PTACallGraph::FunctionSet& callees) const
+    {
+        for(PTACallGraph::FunctionSet::const_iterator cit = callees.begin(),
+                ecit = callees.end(); cit!=ecit; cit++)
+        {
+            if(candidateFuncSet.find((*cit))!=candidateFuncSet.end())
+                return true;
+        }
+        return false;
+    }
+    inline bool isCandidateFun(const SVFFunction* fun) const
+    {
+        return candidateFuncSet.find(fun)!=candidateFuncSet.end();
+    }
+    /// Whether two functions in the same callgraph scc
+    inline bool inSameCallGraphSCC(const PTACallGraphNode* src,const PTACallGraphNode* dst)
+    {
+        return (tcgSCC->repNode(src->getId()) == tcgSCC->repNode(dst->getId()));
+    }
+
+    /// Get parent and sibling threads
+    //@{
+    /// Has parent thread
+    inline bool hasParentThread(NodeID tid) const
+    {
+        const TCTNode* node = getTCTNode(tid);
+        return node->getInEdges().size()==1;
+    }
+    /// Get parent thread
+    inline NodeID getParentThread(NodeID tid) const
+    {
+        const TCTNode* node = getTCTNode(tid);
+        assert(node->getInEdges().size()<=1 && "should have at most one parent thread");
+        assert(node->getInEdges().size()==1 && "does not have a parent thread");
+        const TCTEdge* edge = *(node->getInEdges().begin());
+        return edge->getSrcID();
+    }
+    /// Get all ancestor threads
+    const NodeBS getAncestorThread(NodeID tid) const
+    {
+        NodeBS tds;
+        if(hasParentThread(tid) == false)
+            return tds;
+
+        FIFOWorkList<NodeID> worklist;
+        worklist.push(getParentThread(tid));
+
+        while(!worklist.empty())
+        {
+            NodeID t = worklist.pop();
+            if(tds.test_and_set(t))
+            {
+                if(hasParentThread(t))
+                    worklist.push(getParentThread(t));
+            }
+        }
+        return tds;
+    }
+    /// Get sibling threads
+    inline const NodeBS getSiblingThread(NodeID tid) const
+    {
+        NodeBS tds;
+        if(hasParentThread(tid) == false)
+            return tds;
+
+        const TCTNode* node = getTCTNode(getParentThread(tid));
+        for(ThreadCreateEdgeSet::const_iterator it = getChildrenBegin(node), eit = getChildrenEnd(node); it!=eit; ++it)
+        {
+            NodeID child = (*it)->getDstNode()->getId();
+            if(child!=tid)
+                tds.set(child);
+        }
+
+        return tds;
+    }
+    //@}
+
+    /// get the context of a thread at its spawning site (fork site)
+    const CallStrCxt& getCxtOfCxtThread(const CxtThread& ct) const
+    {
+        CxtThreadToForkCxt::const_iterator it = ctToForkCxtMap.find(ct);
+        assert(it!=ctToForkCxtMap.end() && "Cxt Thread not found!!");
+        return it->second;
+    }
+
+    /// get the start routine function of a thread
+    const SVFFunction* getStartRoutineOfCxtThread(const CxtThread& ct) const
+    {
+        CxtThreadToFun::const_iterator it = ctToRoutineFunMap.find(ct);
+        assert(it!=ctToRoutineFunMap.end() && "Cxt Thread not found!!");
+        return it->second;
+    }
+
+    /// Get loop for join site
+    inline LoopBBs& getJoinLoop(const SVFInstruction* join)
+    {
+        assert(tcg->getThreadAPI()->isTDJoin(join) && "not a join site");
+        InstToLoopMap::iterator it = joinSiteToLoopMap.find(join);
+        assert(it!=joinSiteToLoopMap.end() && "loop not found");
+        return it->second;
+    }
+
+    inline bool hasJoinLoop(const SVFInstruction* join) const
+    {
+        assert(tcg->getThreadAPI()->isTDJoin(join) && "not a join site");
+        InstToLoopMap::const_iterator it = joinSiteToLoopMap.find(join);
+        return it!=joinSiteToLoopMap.end();
+    }
+
+    bool hasLoop(const SVFBasicBlock* bb) const
+    {
+        const SVFFunction* fun = bb->getParent();
+        return fun->hasLoopInfo(bb);
+    }
+    bool hasLoop(const SVFInstruction* inst) const
+    {
+        return hasLoop(inst->getParent());
+    }
+    /// Return true if a join instruction must be executed inside a loop
+    bool isJoinMustExecutedInLoop(const LoopBBs& lp,const SVFInstruction* join);
+    /// Get loop for an instruction
+    const LoopBBs& getLoop(const SVFInstruction* inst);
+    /// Get loop for fork/join site
+    const LoopBBs& getLoop(const SVFBasicBlock* bb);
+
+    /// Push calling context
+    void pushCxt(CallStrCxt& cxt, const SVFInstruction* call, const SVFFunction* callee);
+    /// Match context
+    bool matchCxt(CallStrCxt& cxt, const SVFInstruction* call, const SVFFunction* callee);
+
+    inline void pushCxt(CallStrCxt& cxt, CallSiteID csId)
+    {
+        cxt.push_back(csId);
+        if (cxt.size() > MaxCxtSize)
+            MaxCxtSize = cxt.size();
+    }
+    /// Whether a join site is in recursion
+    inline bool isJoinSiteInRecursion(const SVFInstruction* join) const
+    {
+        assert(tcg->getThreadAPI()->isTDJoin(join) && "not a join site");
+        return inRecurJoinSites.find(join)!=inRecurJoinSites.end();
+    }
+    /// Dump calling context
+    void dumpCxt(CallStrCxt& cxt);
+
+    /// Dump the graph
+    void dump(const std::string& filename);
+
+    /// Print TCT information
+    void print() const;
+
+private:
+    ThreadCallGraph* tcg;
+    PointerAnalysis* pta;
+    u32_t TCTNodeNum;
+    u32_t TCTEdgeNum;
+    u32_t MaxCxtSize;
+
+    /// Add TCT node
+    inline TCTNode* addTCTNode(const CxtThread& ct)
+    {
+        assert(ctpToNodeMap.find(ct)==ctpToNodeMap.end() && "Already has this node!!");
+        NodeID id = TCTNodeNum;
+        TCTNode* node = new TCTNode(id, ct);
+        addGNode(id, node);
+        TCTNodeNum++;
+        ctpToNodeMap[ct] = node;
+        return node;
+    }
+    /// Add TCT edge
+    inline bool addTCTEdge(TCTNode* src, TCTNode* dst)
+    {
+        if (!hasGraphEdge(src, dst, TCTEdge::ThreadCreateEdge))
+        {
+            TCTEdge* edge = new TCTEdge(src, dst, TCTEdge::ThreadCreateEdge);
+            dst->addIncomingEdge(edge);
+            src->addOutgoingEdge(edge);
+            TCTEdgeNum++;
+            return true;
+        }
+        return false;
+    }
+
+    /// Build TCT
+    void build();
+
+    /// Mark relevant procedures that are backward reachable from any fork/join site
+    //@{
+    void markRelProcs();
+    void markRelProcs(const SVFFunction* fun);
+    //@}
+
+    /// Get entry functions that are neither called by other functions nor extern functions
+    void collectEntryFunInCallGraph();
+
+    /// Collect multi-forked threads whose 1, cxt is in loop or recursion;
+    /// 2, parent thread is a multi-forked thread.
+    void collectMultiForkedThreads();
+
+    /// Handle join site in loop
+    //@{
+    /// collect loop info for join sites
+    void collectLoopInfoForJoin();
+    /// Whether a given bb is a loop head of a inloop join site
+    bool isLoopHeaderOfJoinLoop(const SVFBasicBlock* bb);
+    /// Whether a given bb is an exit of a inloop join site
+    bool isLoopExitOfJoinLoop(const SVFBasicBlock* bb);
+    //@}
+
+    /// Multi-forked threads
+    //@{
+    /// Whether an instruction is in a loop
+    bool isInLoopInstruction(const SVFInstruction* inst);
+    /// Whether an instruction is in a recursion
+    bool isInRecursion(const SVFInstruction* inst) const;
+    //@}
+
+    /// Handle call relations
+    void handleCallRelation(CxtThreadProc& ctp, const PTACallGraphEdge* cgEdge, CallSite call);
+
+    /// Get or create a tct node based on CxtThread
+    //@{
+    inline TCTNode* getOrCreateTCTNode(const CallStrCxt& cxt, const SVFInstruction* fork,const CallStrCxt& oldCxt, const SVFFunction* routine)
+    {
+        CxtThread ct(cxt,fork);
+        CxtThreadToNodeMap::const_iterator it = ctpToNodeMap.find(ct);
+        if(it!=ctpToNodeMap.end())
+        {
+            return it->second;
+        }
+
+        addCxtOfCxtThread(oldCxt,ct);
+        addStartRoutineOfCxtThread(routine,ct);
+
+        setMultiForkedAttrs(ct);
+        return addTCTNode(ct);
+    }
+    //@}
+
+    /// Set multi-forked thread attributes
+    void setMultiForkedAttrs(CxtThread& ct)
+    {
+        /// non-main thread
+        if(ct.getThread() != nullptr)
+        {
+            const SVFInstruction* svfInst = ct.getThread();
+            ct.setInloop(isInLoopInstruction(svfInst));
+            ct.setIncycle(isInRecursion(svfInst));
+        }
+        /// main thread
+        else
+        {
+            ct.setInloop(false);
+            ct.setIncycle(false);
+        }
+    }
+
+    /// Add context for a thread at its spawning site (fork site)
+    void addCxtOfCxtThread(const CallStrCxt& cxt, const CxtThread& ct)
+    {
+        ctToForkCxtMap[ct] = cxt;
+    }
+    /// Add start routine function of a cxt thread
+    void addStartRoutineOfCxtThread(const SVFFunction* fun, const CxtThread& ct)
+    {
+        ctToRoutineFunMap[ct] = fun;
+    }
+
+    /// WorkList helper functions
+    //@{
+    inline bool pushToCTPWorkList(const CxtThreadProc& ctp)
+    {
+        if(isVisitedCTPs(ctp)==false)
+        {
+            visitedCTPs.insert(ctp);
+            return ctpList.push(ctp);
+        }
+        return false;
+    }
+    inline CxtThreadProc popFromCTPWorkList()
+    {
+        CxtThreadProc ctp = ctpList.pop();
+        return ctp;
+    }
+    inline bool isVisitedCTPs(const CxtThreadProc& ctp) const
+    {
+        return visitedCTPs.find(ctp)!=visitedCTPs.end();
+    }
+    //@}
+    /// Clean up memory
+    inline void destroy()
+    {
+        if(tcgSCC)
+            delete tcgSCC;
+        tcgSCC=nullptr;
+    }
+
+    FunSet entryFuncSet; /// Procedures that are neither called by other functions nor extern functions
+    FunSet candidateFuncSet; /// Procedures we care about during call graph traversing when creating TCT
+    ThreadCallGraphSCC* tcgSCC; /// Thread call graph SCC
+    CxtThreadProcVec ctpList;	/// CxtThreadProc List
+    CxtThreadProcSet visitedCTPs; /// Record all visited ctps
+    CxtThreadToNodeMap ctpToNodeMap; /// Map a ctp to its graph node
+    CxtThreadToForkCxt ctToForkCxtMap; /// Map a CxtThread to the context at its spawning site (fork site).
+    CxtThreadToFun ctToRoutineFunMap; /// Map a CxtThread to its start routine function.
+    InstToLoopMap joinSiteToLoopMap; ///< map an inloop join to its loop class
+    InstSet inRecurJoinSites;	///< Fork or Join sites in recursions
+};
+
+} // End namespace SVF
+
+namespace SVF
+{
+/* !
+ * GenericGraphTraits specializations for constraint graph so that they can be treated as
+ * graphs by the generic graph algorithms.
+ * Provide graph traits for traversing from a constraint node using standard graph traversals.
+ */
+template<> struct GenericGraphTraits<SVF::TCTNode*> : public GenericGraphTraits<SVF::GenericNode<SVF::TCTNode,SVF::TCTEdge>*  >
+{
+};
+
+/// Inverse GenericGraphTraits specializations for Value flow node, it is used for inverse traversal.
+template<>
+struct GenericGraphTraits<Inverse<SVF::TCTNode *> > : public GenericGraphTraits<Inverse<SVF::GenericNode<SVF::TCTNode,SVF::TCTEdge>* > >
+{
+};
+
+template<> struct GenericGraphTraits<SVF::TCT*> : public GenericGraphTraits<SVF::GenericGraph<SVF::TCTNode,SVF::TCTEdge>* >
+{
+    typedef SVF::TCTNode *NodeRef;
+};
+
+} // End namespace llvm
+
+#endif /* TCTNodeDetector_H_ */