svf-lib 1.0.2319 → 1.0.2321

package/SVF-osx/Release-build/include/SVF/DDA/FlowDDA.h

@@ -0,0 +1,178 @@
+//===- FlowDDA.h -- Flow-sensitive demand-driven analysis -------------//
+//
+//                     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 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/>.
+//
+//===----------------------------------------------------------------------===//
+
+/*
+ * FlowDDA.h
+ *
+ *  Created on: Jun 30, 2014
+ *      Author: Yulei Sui, Sen Ye
+ *
+ * The implementation is based on
+ * (1) Yulei Sui and Jingling Xue. "On-Demand Strong Update Analysis via Value-Flow Refinement".
+ * ACM SIGSOFT International Symposium on the Foundation of Software Engineering (FSE'16)
+ *
+ * (2) Yulei Sui and Jingling Xue. "Value-Flow-Based Demand-Driven Pointer Analysis for C and C++".
+ * IEEE Transactions on Software Engineering (TSE'18)
+ */
+
+#ifndef FlowDDA_H_
+#define FlowDDA_H_
+
+#include "MemoryModel/PointerAnalysisImpl.h"
+#include "Util/DPItem.h"
+#include "DDA/DDAVFSolver.h"
+
+namespace SVF
+{
+
+class DDAClient;
+typedef StmtDPItem<SVFGNode> LocDPItem;
+
+/*!
+ * Flow sensitive demand-driven analysis on value-flow graph
+ */
+class FlowDDA : public BVDataPTAImpl, public DDAVFSolver<NodeID,PointsTo,LocDPItem>
+{
+
+public:
+    typedef BVDataPTAImpl::CallSiteSet CallSiteSet;
+    typedef BVDataPTAImpl::CallEdgeMap	CallEdgeMap;
+    typedef BVDataPTAImpl::FunctionSet	FunctionSet;
+    /// Constructor
+    FlowDDA(SVFIR* _pag, DDAClient* client): BVDataPTAImpl(_pag, PointerAnalysis::FlowS_DDA),
+        DDAVFSolver<NodeID,PointsTo,LocDPItem>(),
+        _client(client)
+    {
+    }
+    /// Destructor
+    inline virtual ~FlowDDA()
+    {
+    }
+    /// dummy analyze method
+    virtual void analyze() override {}
+
+    /// Compute points-to set for all top variable
+    void computeDDAPts(NodeID id) override;
+
+    /// Handle out-of-budget dpm
+    void handleOutOfBudgetDpm(const LocDPItem& dpm);
+
+    /// Handle condition for flow analysis (backward analysis)
+    virtual bool handleBKCondition(LocDPItem& dpm, const SVFGEdge* edge) override;
+
+    /// refine indirect call edge
+    bool testIndCallReachability(LocDPItem& dpm, const FunObjVar* callee, CallSiteID csId);
+
+    /// Initialization of the analysis
+    inline virtual void initialize() override
+    {
+        BVDataPTAImpl::initialize();
+        buildSVFG(pag);
+        setCallGraph(getCallGraph());
+        setCallGraphSCC(getCallGraphSCC());
+        stat = setDDAStat(new DDAStat(this));
+    }
+
+    /// Finalize analysis
+    inline virtual void finalize() override
+    {
+        BVDataPTAImpl::finalize();
+    }
+
+    /// we exclude concrete heap here following the conditions:
+    /// (1) local allocated heap and
+    /// (2) not escaped to the scope outside the current function
+    /// (3) not inside loop
+    /// (4) not involved in recursion
+    virtual bool isHeapCondMemObj(const NodeID& var, const StoreSVFGNode* store) override;
+
+    /// Override parent method
+    virtual inline PointsTo getConservativeCPts(const LocDPItem& dpm) override
+    {
+        return getAndersenAnalysis()->getPts(dpm.getCurNodeID());
+    }
+    /// Override parent method
+    virtual inline NodeID getPtrNodeID(const NodeID& var) const override
+    {
+        return var;
+    }
+    /// Handle Address SVFGNode to add proper points-to
+    virtual inline void handleAddr(PointsTo& pts,const LocDPItem& dpm,const AddrSVFGNode* addr) override
+    {
+        NodeID srcID = addr->getPAGSrcNodeID();
+        /// whether this object is set field-insensitive during pre-analysis
+        if (isFieldInsensitive(srcID))
+            srcID = getFIObjVar(srcID);
+
+        addDDAPts(pts,srcID);
+        DBOUT(DDDA, SVFUtil::outs() << "\t add points-to target " << srcID << " to dpm ");
+        DBOUT(DDDA, dpm.dump());
+    }
+    /// processGep node
+    virtual PointsTo processGepPts(const GepSVFGNode* gep, const PointsTo& srcPts) override;
+
+    /// Update call graph.
+    //@{
+    virtual void updateCallGraphAndSVFG(const LocDPItem& dpm,const CallICFGNode* cs,SVFGEdgeSet& svfgEdges) override
+    {
+        CallEdgeMap newEdges;
+        resolveIndCalls(cs, getCachedPointsTo(dpm), newEdges);
+        for (CallEdgeMap::const_iterator iter = newEdges.begin(),eiter = newEdges.end(); iter != eiter; iter++)
+        {
+            const CallICFGNode* newcs = iter->first;
+            const FunctionSet & functions = iter->second;
+            for (FunctionSet::const_iterator func_iter = functions.begin(); func_iter != functions.end(); func_iter++)
+            {
+                const FunObjVar* func = *func_iter;
+                getSVFG()->connectCallerAndCallee(newcs, func, svfgEdges);
+            }
+        }
+    }
+    //@}
+
+    /// Override parent class functions to get/add cached points-to directly via PAGNode ID
+    //@{
+    virtual inline const PointsTo& getCachedTLPointsTo(const LocDPItem& dpm) override
+    {
+        return getPts(dpm.getCurNodeID());
+    }
+    //@}
+
+    /// Union pts
+    bool unionDDAPts(LocDPItem dpm, const PointsTo& targetPts) override
+    {
+        if (isTopLevelPtrStmt(dpm.getLoc())) return unionPts(dpm.getCurNodeID(), targetPts);
+        else return dpmToADCPtSetMap[dpm] |= targetPts;
+    }
+
+    virtual const std::string PTAName() const override
+    {
+        return "FlowSensitive DDA";
+    }
+
+private:
+    DDAClient* _client;				///< DDA client
+};
+
+} // End namespace SVF
+
+#endif /* FlowDDA_H_ */

package/SVF-osx/Release-build/include/SVF/FastCluster/fastcluster.h

@@ -0,0 +1,80 @@
+//
+// C++ standalone version of fastcluster by Daniel Muellner
+//
+// Copyright: Daniel Muellner, 2011
+//            Christoph Dalitz, 2020
+// License:   BSD style license
+//            (see the file LICENSE for details)
+//
+
+#ifndef fastclustercpp_H
+#define fastclustercpp_H
+
+//
+// Assigns cluster labels (0, ..., nclust-1) to the n points such
+// that the cluster result is split into nclust clusters.
+//
+// Input arguments:
+//   n      = number of observables
+//   merge  = clustering result in R format
+//   nclust = number of clusters
+// Output arguments:
+//   labels = allocated integer array of size n for result
+//
+void cutree_k(int n, const int* merge, int nclust, int* labels);
+
+//
+// Assigns cluster labels (0, ..., nclust-1) to the n points such
+// that the hierarchical clustering is stopped at cluster distance cdist
+//
+// Input arguments:
+//   n      = number of observables
+//   merge  = clustering result in R format
+//   height = cluster distance at each merge step
+//   cdist  = cutoff cluster distance
+// Output arguments:
+//   labels = allocated integer array of size n for result
+//
+void cutree_cdist(int n, const int* merge, double* height, double cdist, int* labels);
+
+//
+// Hierarchical clustering with one of Daniel Muellner's fast algorithms
+//
+// Input arguments:
+//   n       = number of observables
+//   distmat = condensed distance matrix, i.e. an n*(n-1)/2 array representing
+//             the upper triangle (without diagonal elements) of the distance
+//             matrix, e.g. for n=4:
+//               d00 d01 d02 d03
+//               d10 d11 d12 d13   ->  d01 d02 d03 d12 d13 d23
+//               d20 d21 d22 d23
+//               d30 d31 d32 d33
+//   method  = cluster metric (see enum hclust_fast_methods)
+// Output arguments:
+//   merge   = allocated (n-1)x2 matrix (2*(n-1) array) for storing result.
+//             Result follows R hclust convention:
+//              - observable indices start with one
+//              - merge[i][] contains the merged nodes in step i
+//              - merge[i][j] is negative when the node is an atom
+//   height  = allocated (n-1) array with distances at each merge step
+// Return code:
+//   0 = ok
+//   1 = invalid method
+//
+int hclust_fast(int n, double* distmat, int method, int* merge, double* height);
+enum hclust_fast_methods
+{
+    // single link with the minimum spanning tree algorithm (Rohlf, 1973)
+    HCLUST_METHOD_SINGLE = 0,
+    // complete link with the nearest-neighbor-chain algorithm (Murtagh, 1984)
+    HCLUST_METHOD_COMPLETE = 1,
+    // complete link with the nearest-neighbor-chain algorithm (Murtagh, 1984)
+    HCLUST_METHOD_AVERAGE = 2,
+    // median link with the generic algorithm (Müllner, 2011)
+    HCLUST_METHOD_MEDIAN = 3,
+    // To indicate to try all methods and pick the best.
+    HCLUST_METHOD_SVF_BEST = 4
+};
+
+
+#endif

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

@@ -0,0 +1,318 @@
+//===- BasicBlockG.h -- BasicBlock node------------------------------------------------//
+//
+//                     SVF: Static Value-Flow Analysis
+//
+// Copyright (C) <2013-2025>  <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/>.
+//
+//===----------------------------------------------------------------------===//
+
+/*
+ * ICFGNode.h
+ *
+ *  Created on: 23 Jan, 2025
+ *      Author: Jiawei, Xiao
+ */
+
+#ifndef BASICBLOCKGRAPH_H_
+#define BASICBLOCKGRAPH_H_
+#include "GenericGraph.h"
+#include <sstream>
+#include <algorithm>
+
+
+namespace SVF
+{
+class SVFBasicBlock;
+class BasicBlockEdge;
+class ICFGNode;
+class FunObjVar;
+
+typedef GenericEdge<SVFBasicBlock> GenericBasicBlockEdgeTy;
+class BasicBlockEdge: public GenericBasicBlockEdgeTy
+{
+    friend class SVFIRWriter;
+    friend class SVFIRReader;
+
+public:
+public:
+    /// Constructor
+    BasicBlockEdge(SVFBasicBlock* s, SVFBasicBlock* d) : GenericBasicBlockEdgeTy(s, d, 0)
+    {
+    }
+    /// Destructor
+    ~BasicBlockEdge() {}
+
+    /// Overloading operator << for dumping ICFG node ID
+    //@{
+    friend OutStream& operator<<(OutStream& o, const BasicBlockEdge& edge)
+    {
+        o << edge.toString();
+        return o;
+    }
+    //@}
+
+    virtual const std::string toString() const;
+};
+
+
+typedef GenericNode<SVFBasicBlock, BasicBlockEdge> GenericBasicBlockNodeTy;
+class SVFBasicBlock : public GenericBasicBlockNodeTy
+{
+    friend class LLVMModuleSet;
+    friend class SVFIRWriter;
+    friend class SVFIRReader;
+    friend class SVFIRBuilder;
+    friend class FunObjVar;
+    friend class ICFGBuilder;
+    friend class ICFG;
+
+public:
+    typedef std::vector<const ICFGNode*>::const_iterator const_iterator;
+    std::vector<const SVFBasicBlock*> succBBs;
+    std::vector<const SVFBasicBlock*> predBBs;
+
+private:
+    std::vector<const ICFGNode*> allICFGNodes;    ///< all ICFGNodes in this BasicBlock
+    const FunObjVar* fun;                 /// Function where this BasicBlock is
+
+
+
+protected:
+    ///@{ attributes to be set only through Module builders e.g., LLVMModule
+
+    inline void addICFGNode(const ICFGNode* icfgNode)
+    {
+        assert(std::find(getICFGNodeList().begin(), getICFGNodeList().end(),
+                         icfgNode) == getICFGNodeList().end() && "duplicated icfgnode");
+        allICFGNodes.push_back(icfgNode);
+    }
+
+    /// @}
+
+public:
+    /// Constructor without name
+    SVFBasicBlock(NodeID id, const FunObjVar* f): GenericBasicBlockNodeTy(id, BasicBlockKd), fun(f)
+    {
+
+    }
+    SVFBasicBlock() = delete;
+    ~SVFBasicBlock()
+    {
+
+    }
+
+    static inline bool classof(const SVFValue* node)
+    {
+        return node->getNodeKind() == SVFValue::BasicBlockKd;
+    }
+
+    static inline bool classof(const SVFBasicBlock* node)
+    {
+        return true;
+    }
+
+    //@{
+    friend OutStream &operator<<(OutStream &o, const SVFBasicBlock&node)
+    {
+        o << node.toString();
+        return o;
+    }
+    //@}
+
+
+    inline const std::vector<const ICFGNode*>& getICFGNodeList() const
+    {
+        return allICFGNodes;
+    }
+
+    inline const_iterator begin() const
+    {
+        return allICFGNodes.begin();
+    }
+
+    inline const_iterator end() const
+    {
+        return allICFGNodes.end();
+    }
+
+
+    inline void setFun(const FunObjVar* f)
+    {
+        fun = f;
+    }
+
+    inline void addSuccBasicBlock(const SVFBasicBlock* succ2)
+    {
+        // check if the edge already exists
+        for (auto edge: this->getOutEdges())
+        {
+            if (edge->getDstNode() == succ2)
+                return;
+        }
+
+        SVFBasicBlock* succ = const_cast<SVFBasicBlock*>(succ2);
+        BasicBlockEdge* edge = new BasicBlockEdge(this, succ);
+        this->addOutgoingEdge(edge);
+        succ->addIncomingEdge(edge);
+        this->succBBs.push_back(succ);
+        succ->predBBs.push_back(this);
+    }
+
+    inline void addPredBasicBlock(const SVFBasicBlock* pred2)
+    {
+        // check if the edge already exists
+        for (auto edge: this->getInEdges())
+        {
+            if (edge->getSrcNode() == pred2)
+                return;
+        }
+        SVFBasicBlock* pred = const_cast<SVFBasicBlock*>(pred2);
+        BasicBlockEdge* edge = new BasicBlockEdge(pred, this);
+        this->addIncomingEdge(edge);
+        pred->addOutgoingEdge(edge);
+        this->predBBs.push_back(pred);
+        pred->succBBs.push_back(this);
+    }
+
+    inline const FunObjVar* getParent() const
+    {
+        assert(fun && "Function is null?");
+        return fun;
+    }
+
+    inline const FunObjVar* getFunction() const
+    {
+        assert(fun && "Function is null?");
+        return fun;
+    }
+
+    inline const ICFGNode* front() const
+    {
+        assert(!allICFGNodes.empty() && "bb empty?");
+        return allICFGNodes.front();
+    }
+
+    inline const ICFGNode* back() const
+    {
+        assert(!allICFGNodes.empty() && "bb empty?");
+        return allICFGNodes.back();
+    }
+
+    inline std::vector<const SVFBasicBlock*> getSuccessors() const
+    {
+        std::vector<const SVFBasicBlock*> res;
+        for (auto edge : this->getOutEdges())
+        {
+            res.push_back(edge->getDstNode());
+        }
+        return res;
+    }
+
+    inline std::vector<const SVFBasicBlock*> getPredecessors() const
+    {
+        std::vector<const SVFBasicBlock*> res;
+        for (auto edge : this->getInEdges())
+        {
+            res.push_back(edge->getSrcNode());
+        }
+        return res;
+    }
+    u32_t getNumSuccessors() const
+    {
+        return this->getOutEdges().size();
+    }
+    u32_t getBBSuccessorPos(const SVFBasicBlock* Succ)
+    {
+        u32_t i = 0;
+        for (const SVFBasicBlock* SuccBB: succBBs)
+        {
+            if (SuccBB == Succ)
+                return i;
+            i++;
+        }
+        assert(false && "Didn't find successor edge?");
+        return 0;
+    }
+    u32_t getBBSuccessorPos(const SVFBasicBlock* Succ) const
+    {
+        u32_t i = 0;
+        for (const SVFBasicBlock* SuccBB: succBBs)
+        {
+            if (SuccBB == Succ)
+                return i;
+            i++;
+        }
+        assert(false && "Didn't find successor edge?");
+        return 0;
+
+    }
+    u32_t getBBPredecessorPos(const SVFBasicBlock* succbb)
+    {
+        u32_t pos = 0;
+        for (const SVFBasicBlock* PredBB : succbb->getPredecessors())
+        {
+            if(PredBB == this)
+                return pos;
+            ++pos;
+        }
+        assert(false && "Didn't find predecessor edge?");
+        return pos;
+    }
+    u32_t getBBPredecessorPos(const SVFBasicBlock* succbb) const
+    {
+        u32_t pos = 0;
+        for (const SVFBasicBlock* PredBB : succbb->getPredecessors())
+        {
+            if(PredBB == this)
+                return pos;
+            ++pos;
+        }
+        assert(false && "Didn't find predecessor edge?");
+        return pos;
+    }
+
+    const std::string toString() const;
+
+};
+
+
+
+typedef GenericGraph<SVFBasicBlock, BasicBlockEdge> GenericBasicBlockGraphTy;
+class BasicBlockGraph: public GenericBasicBlockGraphTy
+{
+private:
+    NodeID id{0};
+public:
+    /// Constructor
+    BasicBlockGraph()
+    {
+
+    }
+
+    SVFBasicBlock* addBasicBlock(const std::string& bbname)
+    {
+        id++;
+        SVFBasicBlock* bb = new SVFBasicBlock(id, nullptr);
+        addGNode(id, bb);
+        bb->setName(bbname);
+        return bb;
+    }
+
+};
+}
+
+#endif