svf-lib 1.0.2192 → 1.0.2193

package/SVF-osx/Release-build/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-osx/Release-build/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-osx/Release-build/include/SVF-LLVM/LLVMModule.h

@@ -34,6 +34,7 @@
 #include "SVFIR/SVFValue.h"
 #include "SVFIR/SVFModule.h"
 #include "Util/Options.h"
+#include "Graphs/BasicBlockG.h"
 
 namespace SVF
 {
@@ -177,11 +178,14 @@ public:
 
     void addFunctionMap(const Function* func, CallGraphNode* svfFunc);
 
-    inline void addBasicBlockMap(const BasicBlock* bb, SVFBasicBlock* svfBB)
+    // create a SVFBasicBlock according to LLVM BasicBlock, then add it to SVFFunction's BasicBlockGraph
+    inline void addBasicBlock(SVFFunction* fun, const BasicBlock* bb)
     {
+        SVFBasicBlock* svfBB = fun->getBasicBlockGraph()->addBasicBlock(bb->getName().str());
         LLVMBB2SVFBB[bb] = svfBB;
-        setValueAttr(bb,svfBB);
+        SVFBaseNode2LLVMValue[svfBB] = bb;
     }
+
     inline void addInstructionMap(const Instruction* inst, SVFInstruction* svfInst)
     {
         LLVMInst2SVFInst[inst] = svfInst;
@@ -246,7 +250,7 @@ public:
     const Value* getLLVMValue(const SVFBaseNode* value) const
     {
         SVFBaseNode2LLVMValueMap ::const_iterator it = SVFBaseNode2LLVMValue.find(value);
-        assert(it!=SVFBaseNode2LLVMValue.end() && "can't find corresponding llvm value!");
+        assert(it != SVFBaseNode2LLVMValue.end() && "can't find corresponding llvm value!");
         return it->second;
     }
 
@@ -264,7 +268,7 @@ public:
         return it->second;
     }
 
-    inline SVFBasicBlock* getSVFBasicBlock(const BasicBlock* bb) const
+    SVFBasicBlock* getSVFBasicBlock(const BasicBlock* bb)
     {
         LLVMBB2SVFBBMap::const_iterator it = LLVMBB2SVFBB.find(bb);
         assert(it!=LLVMBB2SVFBB.end() && "SVF BasicBlock not found!");

package/SVF-osx/Release-build/include/SVFIR/SVFValue.h

@@ -33,6 +33,7 @@
 #include "SVFIR/SVFType.h"
 #include "Graphs/GraphPrinter.h"
 #include "Util/Casting.h"
+#include "Graphs/BasicBlockG.h"
 
 namespace SVF
 {
@@ -299,7 +300,8 @@ class SVFFunction : public SVFValue
     friend class SVFIRBuilder;
 
 public:
-    typedef std::vector<const SVFBasicBlock*>::const_iterator const_iterator;
+    typename BasicBlockGraph::IDToNodeMapTy::iterator iterator;
+    typedef BasicBlockGraph::IDToNodeMapTy::const_iterator const_iterator;
     typedef SVFLoopAndDomInfo::BBSet BBSet;
     typedef SVFLoopAndDomInfo::BBList BBList;
     typedef SVFLoopAndDomInfo::LoopBBs LoopBBs;
@@ -314,10 +316,10 @@ private:
     const SVFFunctionType* funcType; /// FunctionType, which is different from the type (PointerType) of this SVFFunction
     SVFLoopAndDomInfo* loopAndDom;  /// the loop and dominate information
     const SVFFunction* realDefFun;  /// the definition of a function across multiple modules
-    std::vector<const SVFBasicBlock*> allBBs;   /// all BasicBlocks of this function
     std::vector<const SVFArgument*> allArgs;    /// all formal arguments of this function
     SVFBasicBlock *exitBlock;             /// a 'single' basic block having no successors and containing return instruction in a function
     const CallGraphNode *callGraphNode;          /// call graph node for this function
+    BasicBlockGraph* bbGraph; /// the basic block graph of this function
 
 protected:
     inline void setCallGraphNode(CallGraphNode *cgn)
@@ -325,12 +327,6 @@ protected:
         callGraphNode = cgn;
     }
 
-    ///@{ attributes to be set only through Module builders e.g., LLVMModule
-    inline void addBasicBlock(const SVFBasicBlock* bb)
-    {
-        allBBs.push_back(bb);
-    }
-
     inline void addArgument(SVFArgument* arg)
     {
         allArgs.push_back(arg);
@@ -376,6 +372,21 @@ public:
         return isDecl;
     }
 
+    void setBasicBlockGraph(BasicBlockGraph* graph)
+    {
+        this->bbGraph = graph;
+    }
+
+    BasicBlockGraph* getBasicBlockGraph()
+    {
+        return bbGraph;
+    }
+
+    const BasicBlockGraph* getBasicBlockGraph() const
+    {
+        return bbGraph;
+    }
+
     inline bool isIntrinsic() const
     {
         return intrinsic;
@@ -411,13 +422,14 @@ public:
 
     inline bool hasBasicBlock() const
     {
-        return !allBBs.empty();
+        return bbGraph && bbGraph->begin() != bbGraph->end();
     }
 
     inline const SVFBasicBlock* getEntryBlock() const
     {
         assert(hasBasicBlock() && "function does not have any Basicblock, external function?");
-        return allBBs.front();
+        assert(bbGraph->begin()->second->getInEdges().size() == 0 && "the first basic block is not entry block");
+        return bbGraph->begin()->second;
     }
 
     /// Carefully! when you call getExitBB, you need ensure the function has return instruction
@@ -437,23 +449,19 @@ public:
         /// Carefully! 'back' is just the last basic block of function,
         /// but not necessarily a exit basic block
         /// more refer to: https://github.com/SVF-tools/SVF/pull/1262
-        return allBBs.back();
+        return std::prev(bbGraph->end())->second;
     }
 
     inline const_iterator begin() const
     {
-        return allBBs.begin();
+        return bbGraph->begin();
     }
 
     inline const_iterator end() const
     {
-        return allBBs.end();
+        return bbGraph->end();
     }
 
-    inline const std::vector<const SVFBasicBlock*>& getBasicBlockList() const
-    {
-        return allBBs;
-    }
 
     inline const std::vector<const SVFBasicBlock*>& getReachableBBs() const
     {
@@ -523,113 +531,6 @@ public:
 
 class ICFGNode;
 
-class SVFBasicBlock : public SVFValue
-{
-    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;
-
-private:
-    std::vector<const ICFGNode*> allICFGNodes;    ///< all ICFGNodes in this BasicBlock
-    std::vector<const SVFBasicBlock*> succBBs;  ///< all successor BasicBlocks of this BasicBlock
-    std::vector<const SVFBasicBlock*> predBBs;  ///< all predecessor BasicBlocks of 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);
-    }
-
-    inline void addSuccBasicBlock(const SVFBasicBlock* succ)
-    {
-        succBBs.push_back(succ);
-    }
-
-    inline void addPredBasicBlock(const SVFBasicBlock* pred)
-    {
-        predBBs.push_back(pred);
-    }
-    /// @}
-
-public:
-    /// Constructor without name
-    SVFBasicBlock(const SVFType* ty, const SVFFunction* f);
-    SVFBasicBlock() = delete;
-    ~SVFBasicBlock() override;
-
-    static inline bool classof(const SVFValue *node)
-    {
-        return node->getKind() == SVFBB;
-    }
-
-    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 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 const std::vector<const SVFBasicBlock*>& getSuccessors() const
-    {
-        return succBBs;
-    }
-
-    inline const std::vector<const SVFBasicBlock*>& getPredecessors() const
-    {
-        return predBBs;
-    }
-    u32_t getNumSuccessors() const
-    {
-        return succBBs.size();
-    }
-    u32_t getBBSuccessorPos(const SVFBasicBlock* succbb);
-    u32_t getBBSuccessorPos(const SVFBasicBlock* succbb) const;
-    u32_t getBBPredecessorPos(const SVFBasicBlock* succbb);
-    u32_t getBBPredecessorPos(const SVFBasicBlock* succbb) const;
-};
-
 class SVFInstruction : public SVFValue
 {
     friend class SVFIRWriter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svf-lib",
-  "version": "1.0.2192",
+  "version": "1.0.2193",
   "description": "SVF's npm support",
   "main": "index.js",
   "scripts": {