svf-tools 1.0.1033 → 1.0.1035

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svf-tools",
-  "version": "1.0.1033",
+  "version": "1.0.1035",
   "description": "* <b>[TypeClone](https://github.com/SVF-tools/SVF/wiki/TypeClone) published in our [ECOOP paper](https://yuleisui.github.io/publications/ecoop20.pdf) is now available in SVF </b> * <b>SVF now uses a single script for its build. Just type [`source ./build.sh`](https://github.com/SVF-tools/SVF/blob/master/build.sh) in your terminal, that's it!</b> * <b>SVF now supports LLVM-10.0.0! </b> * <b>We thank [bsauce](https://github.com/bsauce) for writing a user manual of SVF ([link1](https://www.jianshu.com/p/068a08ec749c) and [link2](https://www.jianshu.com/p/777c30d4240e)) in Chinese </b> * <b>SVF now supports LLVM-9.0.0 (Thank [Byoungyoung Lee](https://github.com/SVF-tools/SVF/issues/142) for his help!). </b> * <b>SVF now supports a set of [field-sensitive pointer analyses](https://yuleisui.github.io/publications/sas2019a.pdf). </b> * <b>[Use SVF as an external lib](https://github.com/SVF-tools/SVF/wiki/Using-SVF-as-a-lib-in-your-own-tool) for your own project (Contributed by [Hongxu Chen](https://github.com/HongxuChen)). </b> * <b>SVF now supports LLVM-7.0.0. </b> * <b>SVF now supports Docker. [Try SVF in Docker](https://github.com/SVF-tools/SVF/wiki/Try-SVF-in-Docker)! </b> * <b>SVF now supports [LLVM-6.0.0](https://github.com/svf-tools/SVF/pull/38) (Contributed by [Jack Anthony](https://github.com/jackanth)). </b> * <b>SVF now supports [LLVM-4.0.0](https://github.com/svf-tools/SVF/pull/23) (Contributed by Jared Carlson. Thank [Jared](https://github.com/jcarlson23) and [Will](https://github.com/dtzWill) for their in-depth [discussions](https://github.com/svf-tools/SVF/pull/18) about updating SVF!) </b> * <b>SVF now supports analysis for C++ programs.</b> <br />",
   "main": "index.js",
   "scripts": {

package/svf/include/AE/Svfexe/AbsExtAPI.h

@@ -130,13 +130,6 @@ public:
      */
     AbstractState& getAbsStateFromTrace(const ICFGNode* node);
 
-    /**
-     * @brief Retrieves the SVF variable from a given SVF value.
-     * @param val Pointer to the SVF value.
-     * @return Pointer to the corresponding SVF variable.
-     */
-    const SVFVar* getSVFVar(const SVFValue* val);
-
 protected:
     SVFIR* svfir; ///< Pointer to the SVF intermediate representation.
     ICFG* icfg; ///< Pointer to the interprocedural control flow graph.

package/svf/include/CFL/CFLAlias.h

@@ -61,14 +61,6 @@ public:
     /// Solving CFL Reachability
     virtual void solve();
 
-    /// Interface exposed to users of our Alias analysis, given Value infos
-    virtual AliasResult alias(const SVFValue* v1, const SVFValue* v2)
-    {
-        NodeID n1 = svfir->getValueNode(v1);
-        NodeID n2 = svfir->getValueNode(v2);
-        return alias(n1,n2);
-    }
-
     /// Interface exposed to users of our Alias analysis, given PAGNodeID
     virtual AliasResult alias(NodeID node1, NodeID node2)
     {

package/svf/include/DDA/DDAPass.h

@@ -57,7 +57,10 @@ public:
     ~DDAPass();
 
     /// Interface expose to users of our pointer analysis, given Value infos
-    virtual AliasResult alias(const SVFValue* V1,	const SVFValue* V2);
+    virtual AliasResult alias(const SVFVar* V1,	const SVFVar* V2)
+    {
+        return alias(V1->getId(), V2->getId());
+    }
 
     /// Interface expose to users of our pointer analysis, given PAGNodes
     virtual AliasResult alias(NodeID V1, NodeID V2);

package/svf/include/Graphs/BasicBlockG.h

@@ -0,0 +1,310 @@
+//===- 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 SVFFunction;
+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 SVFFunction;
+    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 SVFFunction* 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 SVFFunction* f): GenericBasicBlockNodeTy(id, BasicBlockKd), fun(f)
+    {
+
+    }
+    SVFBasicBlock() = delete;
+    ~SVFBasicBlock()
+    {
+
+    }
+
+    static inline bool classof(const SVFBaseNode* node)
+    {
+        return node->getNodeKind() == SVFBaseNode::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 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 SVFFunction* getParent() const
+    {
+        return fun;
+    }
+
+    inline const SVFFunction* getFunction() const
+    {
+        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};
+    const SVFFunction* fun;
+public:
+    /// Constructor
+    BasicBlockGraph(const SVFFunction* f): fun(f)
+    {
+
+    }
+
+    SVFBasicBlock* addBasicBlock(const std::string& bbname)
+    {
+        id++;
+        SVFBasicBlock* bb = new SVFBasicBlock(id, fun);
+        addGNode(id, bb);
+        bb->setName(bbname);
+        return bb;
+    }
+
+};
+}
+
+#endif

package/svf/include/Graphs/ConsG.h

@@ -76,11 +76,6 @@ protected:
 
     /// Wrappers used internally, not expose to Andersen Pass
     //@{
-    inline NodeID getValueNode(const SVFValue* value) const
-    {
-        return sccRepNode(pag->getValueNode(value));
-    }
-
     inline NodeID getReturnNode(const SVFFunction* value) const
     {
         return pag->getReturnNode(value);

package/svf/include/Graphs/GenericGraph.h

@@ -240,6 +240,7 @@ public:
         ConstraintNodeKd, // Constraint graph node
         TCTNodeKd,        // Thread creation tree node
         DCHNodeKd,        // DCHG node
+        BasicBlockKd,     // Basic block node
         OtherKd           // Other node kind
     };
 

package/svf/include/Graphs/IRGraph.h

@@ -53,7 +53,6 @@ class IRGraph : public GenericGraph<SVFVar, SVFStmt>
 
 public:
     typedef Set<const SVFStmt*> SVFStmtSet;
-    typedef Map<const SVFValue*,SVFStmtSet> ValueToEdgeMap;
 
 protected:
     SVFStmt::KindToSVFStmtMapTy KindToSVFStmtSetMap; ///< SVFIR edge map containing all PAGEdges
@@ -61,7 +60,6 @@ protected:
     bool fromFile; ///< Whether the SVFIR is built according to user specified data from a txt file
     NodeID nodeNumAfterPAGBuild; ///< initial node number after building SVFIR, excluding later added nodes, e.g., gepobj nodes
     u32_t totalPTAPAGEdge;
-    ValueToEdgeMap valueToEdgeMap; ///< Map SVFValues (e.g., ICFGNodes) to all corresponding PAGEdges
     SymbolTableInfo* symInfo;
 
     /// Add a node into the graph
@@ -86,22 +84,11 @@ protected:
     SVFStmt* hasLabeledEdge(SVFVar* src, SVFVar* op1, SVFStmt::PEDGEK kind,
                             const SVFVar* op2);
 
-    /// Map a value to a set of edges
-    inline void mapValueToEdge(const SVFValue* V, SVFStmt *edge)
-    {
-        auto inserted = valueToEdgeMap.emplace(V, SVFStmtSet{edge});
-        if (!inserted.second)
-        {
-            inserted.first->second.emplace(edge);
-        }
-    }
 public:
     IRGraph(bool buildFromFile)
         : fromFile(buildFromFile), nodeNumAfterPAGBuild(0), totalPTAPAGEdge(0)
     {
         symInfo = SymbolTableInfo::SymbolInfo();
-        // insert dummy value if a correct value cannot be found
-        valueToEdgeMap[nullptr] = SVFStmtSet();
     }
 
     virtual ~IRGraph();
@@ -115,17 +102,6 @@ public:
     {
         return fromFile;
     }
-    /// Get all SVFIR Edges that corresponds to an LLVM value
-    inline const SVFStmtSet& getValueEdges(const SVFValue* V)
-    {
-        auto it = valueToEdgeMap.find(V);
-        if (it == valueToEdgeMap.end())
-        {
-            //special empty set
-            return valueToEdgeMap.at(nullptr);
-        }
-        return it->second;
-    }
 
     /// Get SVFIR Node according to LLVM value
     ///getNode - Return the node corresponding to the specified pointer.

package/svf/include/MSSA/MemRegion.h

@@ -480,7 +480,7 @@ public:
     NodeBS getModInfoForCall(const CallICFGNode* cs);
     NodeBS getRefInfoForCall(const CallICFGNode* cs);
     ModRefInfo getModRefInfo(const CallICFGNode* cs);
-    ModRefInfo getModRefInfo(const CallICFGNode* cs, const SVFValue* V);
+    ModRefInfo getModRefInfo(const CallICFGNode* cs, const SVFVar* V);
     ModRefInfo getModRefInfo(const CallICFGNode* cs1, const CallICFGNode* cs2);
     //@}
 

package/svf/include/MemoryModel/PointerAnalysis.h

@@ -233,8 +233,8 @@ public:
     virtual void computeDDAPts(NodeID) {}
 
     /// Interface exposed to users of our pointer analysis, given Value infos
-    virtual AliasResult alias(const SVFValue* V1,
-                              const SVFValue* V2) = 0;
+    virtual AliasResult alias(const SVFVar* V1,
+                              const SVFVar* V2) = 0;
 
     /// Interface exposed to users of our pointer analysis, given PAGNodeID
     virtual AliasResult alias(NodeID node1, NodeID node2) = 0;

package/svf/include/MemoryModel/PointerAnalysisImpl.h

@@ -215,8 +215,11 @@ private:
 
 public:
     /// Interface expose to users of our pointer analysis, given Value infos
-    AliasResult alias(const SVFValue* V1,
-                      const SVFValue* V2) override;
+    AliasResult alias(const SVFVar* V1,
+                      const SVFVar* V2) override
+    {
+        return alias(V1->getId(), V2->getId());
+    }
 
     /// Interface expose to users of our pointer analysis, given PAGNodeID
     AliasResult alias(NodeID node1, NodeID node2) override;
@@ -501,9 +504,9 @@ public:
     }
 
     /// Interface expose to users of our pointer analysis, given Value infos
-    virtual inline AliasResult alias(const SVFValue* V1, const SVFValue* V2)
+    virtual inline AliasResult alias(const SVFVar* V1, const SVFVar* V2)
     {
-        return  alias(pag->getValueNode(V1),pag->getValueNode(V2));
+        return  alias(V1->getId(), V2->getId());
     }
     /// Interface expose to users of our pointer analysis, given two pointers
     virtual inline AliasResult alias(NodeID node1, NodeID node2)

package/svf/include/SVFIR/SVFIR.h

@@ -70,7 +70,7 @@ public:
     typedef std::pair<NodeID, AccessPath> NodeAccessPath;
     typedef Map<NodeOffset,NodeID> NodeOffsetMap;
     typedef Map<NodeAccessPath,NodeID> NodeAccessPathMap;
-    typedef Map<const SVFValue*, NodeAccessPathMap> GepValueVarMap;
+    typedef Map<NodeID, NodeAccessPathMap> GepValueVarMap;
     typedef std::pair<const SVFType*, std::vector<AccessPath>> SVFTypeLocSetsPair;
     typedef Map<NodeID, SVFTypeLocSetsPair> TypeLocSetsMap;
     typedef Map<NodePair,NodeID> NodePairSetMap;
@@ -343,7 +343,7 @@ public:
     //@}
 
     /// Due to constraint expression, curInst is used to distinguish different instructions (e.g., memorycpy) when creating GepValVar.
-    NodeID getGepValVar(const SVFValue* curInst, NodeID base,
+    NodeID getGepValVar(NodeID curInst, NodeID base,
                         const AccessPath& ap) const;
 
     /// Add/get indirect callsites
@@ -693,7 +693,7 @@ private:
     }
 
     /// Add a temp field value node, this method can only invoked by getGepValVar
-    NodeID addGepValNode(const SVFValue* curInst,const SVFValue* val, const AccessPath& ap, NodeID i, const SVFType* type, const ICFGNode* node);
+    NodeID addGepValNode(NodeID curInst, const ValVar* base, const AccessPath& ap, NodeID i, const SVFType* type, const ICFGNode* node);
     /// Add a field obj node, this method can only invoked by getGepObjVar
     NodeID addGepObjNode(const BaseObjVar* baseObj, const APOffset& apOffset, const NodeID gepId);
     /// Add a field-insensitive node, this method can only invoked by getFIGepObjNode