svf-lib 1.0.747 → 1.0.748

package/SVF-osx/include/Graphs/ConsG.h

@@ -310,9 +310,9 @@ public:
     {
         return pag->isBlkObjOrConstantObj(id);
     }
-    inline NodeBS& getAllFieldsObjNode(NodeID id)
+    inline NodeBS& getAllFieldsObjVars(NodeID id)
     {
-        return pag->getAllFieldsObjNode(id);
+        return pag->getAllFieldsObjVars(id);
     }
     inline NodeID getBaseObjVar(NodeID id)
     {

package/SVF-osx/include/MemoryModel/PointerAnalysis.h

@@ -358,9 +358,9 @@ public:
     {
         return pag->getGepObjVar(id,ls);
     }
-    virtual inline const NodeBS& getAllFieldsObjNode(NodeID id)
+    virtual inline const NodeBS& getAllFieldsObjVars(NodeID id)
     {
-        return pag->getAllFieldsObjNode(id);
+        return pag->getAllFieldsObjVars(id);
     }
     inline void setObjFieldInsensitive(NodeID id)
     {

package/SVF-osx/include/MemoryModel/PointerAnalysisImpl.h

@@ -354,7 +354,7 @@ public:
         {
             if(pag->getBaseObjVar(cit->get_id())==cit->get_id())
             {
-                NodeBS& fields = pag->getAllFieldsObjNode(cit->get_id());
+                NodeBS& fields = pag->getAllFieldsObjVars(cit->get_id());
                 for(NodeBS::iterator it = fields.begin(), eit = fields.end(); it!=eit; ++it)
                 {
                     CVar cvar(cit->get_cond(),*it);

package/SVF-osx/include/MemoryModel/SVFIR.h

@@ -61,7 +61,7 @@ public:
     typedef Map<const RetBlockNode*,const SVFVar*> CSToRetMap;
     typedef Map<const SVFFunction*,const SVFVar*> FunToRetMap;
     typedef Map<const SVFFunction*,SVFStmtSet> FunToPAGEdgeSetMap;
-    typedef Map<const ICFGNode*,SVFStmtList> Inst2PAGEdgesMap;
+    typedef Map<const ICFGNode*,SVFStmtList> ICFGNode2SVFStmtsMap;
     typedef Map<NodeID, NodeID> NodeToNodeMap;
     typedef std::pair<NodeID, Size_t> NodeOffset;
     typedef std::pair<NodeID, LocationSet> NodeLocationSet;
@@ -73,8 +73,8 @@ public:
 private:
     /// ValueNodes - This map indicates the Node that a particular Value* is
     /// represented by.  This contains entries for all pointers.
-    Inst2PAGEdgesMap inst2SVFStmtsMap;	///< Map a instruction to its PAGEdges
-    Inst2PAGEdgesMap inst2PTASVFStmtsMap;	///< Map a instruction to its PointerAnalysis related PAGEdges
+    ICFGNode2SVFStmtsMap icfgNode2SVFStmtsMap;	///< Map an ICFGNode to its SVFStmts
+    ICFGNode2SVFStmtsMap icfgNode2PTASVFStmtsMap;	///< Map an ICFGNode to its PointerAnalysis related SVFStmts
     GepValueVarMap GepValObjMap;	///< Map a pair<base,off> to a gep value node id
     NodeLocationSetMap GepObjVarMap;	///< Map a pair<base,off> to a gep obj node id
     MemObjToFieldsMap memToFieldsMap;	///< Map a mem object id to all its fields
@@ -171,29 +171,29 @@ public:
     /// Whether this instruction has SVFIR Edge
     inline bool hasSVFStmtList(const ICFGNode* inst) const
     {
-        return inst2SVFStmtsMap.find(inst)!=inst2SVFStmtsMap.end();
+        return icfgNode2SVFStmtsMap.find(inst)!=icfgNode2SVFStmtsMap.end();
     }
     inline bool hasPTASVFStmtList(const ICFGNode* inst) const
     {
-        return inst2PTASVFStmtsMap.find(inst)!=inst2PTASVFStmtsMap.end();
+        return icfgNode2PTASVFStmtsMap.find(inst)!=icfgNode2PTASVFStmtsMap.end();
     }
     /// Given an instruction, get all its PAGEdges
     inline SVFStmtList& getSVFStmtList(const ICFGNode* inst)
     {
-        return inst2SVFStmtsMap[inst];
+        return icfgNode2SVFStmtsMap[inst];
     }
     /// Given an instruction, get all its PTA PAGEdges
     inline SVFStmtList& getPTASVFStmtList(const ICFGNode* inst)
     {
-        return inst2PTASVFStmtsMap[inst];
+        return icfgNode2PTASVFStmtsMap[inst];
     }
     /// Add a SVFStmt into instruction map
     inline void addToSVFStmtList(ICFGNode* inst, SVFStmt* edge)
     {
         edge->setICFGNode(inst);
-        inst2SVFStmtsMap[inst].push_back(edge);
+        icfgNode2SVFStmtsMap[inst].push_back(edge);
         if (edge->isPTAEdge())
-            inst2PTASVFStmtsMap[inst].push_back(edge);
+            icfgNode2PTASVFStmtsMap[inst].push_back(edge);
     }
     /// Get global PAGEdges (not in a procedure)
     inline SVFStmtSet& getGlobalSVFStmtSet()
@@ -454,8 +454,8 @@ public:
 
     /// Get all fields of an object
     //@{
-    NodeBS& getAllFieldsObjNode(const MemObj* obj);
-    NodeBS& getAllFieldsObjNode(NodeID id);
+    NodeBS& getAllFieldsObjVars(const MemObj* obj);
+    NodeBS& getAllFieldsObjVars(NodeID id);
     NodeBS getFieldsAfterCollapse(NodeID id);
     //@}
     inline NodeID addDummyValNode()
@@ -631,7 +631,7 @@ private:
     /// Add phi node information
     PhiStmt*  addPhiStmt(NodeID res, NodeID opnd);
     /// Add Copy edge
-    CmpStmt* addCmpStmt(NodeID op1, NodeID op2, NodeID dst, u32_t opcode);
+    CmpStmt* addCmpStmt(NodeID op1, NodeID op2, NodeID dst, u32_t predict);
     /// Add Copy edge
     BinaryOPStmt* addBinaryOPStmt(NodeID op1, NodeID op2, NodeID dst, u32_t opcode);
     /// Add Unary edge

package/SVF-osx/include/MemoryModel/SVFStatements.h

@@ -41,15 +41,15 @@ namespace SVF
 class SVFVar;
 
 /*
- * SVFIR edge between nodes
+ * SVFIR program statements (PAGEdges)
  */
 typedef GenericEdge<SVFVar> GenericPAGEdgeTy;
 class SVFStmt : public GenericPAGEdgeTy
 {
 
 public:
-    /// Thirteen kinds of SVFIR edges
-    /// Gep represents offset edge for field sensitivity
+    /// Types of SVFIR statements
+    /// Gep represents (base + offset) for field sensitivity
     /// ThreadFork/ThreadJoin is to model parameter passings between thread spawners and spawnees.
     enum PEDGEK
     {
@@ -192,7 +192,7 @@ private:
 
 
 /*!
- * Copy edge
+ * Address statement (memory allocations)
  */
 class AddrStmt: public SVFStmt
 {
@@ -227,7 +227,7 @@ public:
 
 
 /*!
- * Copy edge
+ * Copy statements (simple assignment and casting)
  */
 class CopyStmt: public SVFStmt
 {
@@ -260,6 +260,9 @@ public:
     virtual const std::string toString() const override;
 };
 
+/*
+* Program statements with multiple operands including BinaryOPStmt, CmpStmt and PhiStmt
+*/
 class MultiOpndStmt : public SVFStmt{
 public:
     typedef std::vector<SVFVar*> OPVars;
@@ -324,7 +327,8 @@ public:
 };
 
 /*!
- * Phi instruction edge
+ * Phi statement (e.g., p = phi(q,r) which receives values from variables q and r from different paths)
+ * it is typically at a joint point of the control-flow graph
  */
 class PhiStmt: public MultiOpndStmt
 {
@@ -370,7 +374,7 @@ public:
 
 
 /*!
- * Compare instruction edge
+ * Comparison statement
  */
 class CmpStmt: public MultiOpndStmt
 {
@@ -383,7 +387,7 @@ private:
     SVFVar* getSrcID();  ///< place holder, use getOpVarID(pos) instead
     SVFVar* getDstID();    ///< place holder, use getResID() instead
 
-    u32_t opcode;
+    u32_t predicate;
 public:
     /// Methods for support type inquiry through isa, cast, and dyn_cast:
     //@{
@@ -406,13 +410,13 @@ public:
     //@}
 
     /// constructor
-    CmpStmt(SVFVar* s, const OPVars& opnds, u32_t oc) : MultiOpndStmt(s,opnds,SVFStmt::Cmp), opcode(oc)
+    CmpStmt(SVFVar* s, const OPVars& opnds, u32_t pre) : MultiOpndStmt(s,opnds,SVFStmt::Cmp), predicate(pre)
     {
     }
 
-    u32_t getOpcode() const
+    u32_t getPredicate() const
     {
-        return opcode;
+        return predicate;
     }
     
     virtual const std::string toString() const override;
@@ -420,7 +424,7 @@ public:
 
 
 /*!
- * Binary instruction edge
+ * Binary statement
  */
 class BinaryOPStmt: public MultiOpndStmt
 {
@@ -470,7 +474,7 @@ public:
 };
 
 /*!
- * Unary instruction edge
+ * Unary statement
  */
 class UnaryOPStmt: public SVFStmt
 {
@@ -587,7 +591,7 @@ public:
 };
 
 /*!
- * Store edge
+ * Store statement
  */
 class StoreStmt: public SVFStmt
 {
@@ -624,7 +628,7 @@ public:
 
 
 /*!
- * Load edge
+ * Load statement
  */
 class LoadStmt: public SVFStmt
 {
@@ -660,7 +664,7 @@ public:
 
 
 /*!
- * Gep edge
+ * Gep statement for field access and pointer arithmetic
  */
 class GepStmt: public SVFStmt
 {
@@ -700,7 +704,7 @@ protected:
 
 
 /*!
- * Gep edge with a fixed offset
+ * Gep statement with a fixed offset
  */
 class NormalGepStmt : public GepStmt
 {
@@ -750,7 +754,7 @@ public:
 };
 
 /*!
- * Gep edge with a variant offset
+ * Gep statement with a variant offset
  */
 class VariantGepStmt : public GepStmt
 {
@@ -789,7 +793,7 @@ public:
 
 
 /*!
- * Call edge
+ * Call 
  */
 class CallPE: public SVFStmt
 {
@@ -841,7 +845,7 @@ public:
 
 
 /*!
- * Return edge
+ * Return 
  */
 class RetPE: public SVFStmt
 {
@@ -893,7 +897,7 @@ public:
 
 
 /*!
- * Thread Fork Edge
+ * Thread Fork 
  */
 class TDForkPE: public CallPE
 {
@@ -931,7 +935,7 @@ public:
 
 
 /*!
- * Thread Join Edge
+ * Thread Join 
  */
 class TDJoinPE: public RetPE
 {

package/SVF-osx/include/MemoryModel/SVFVariables.h

@@ -40,14 +40,14 @@ namespace SVF
 
 class SVFVar;
 /*
- * SVFIR node
+ * SVFIR program variables (PAGNodes)
  */
 typedef GenericNode<SVFVar,SVFStmt> GenericPAGNodeTy;
 class SVFVar : public GenericPAGNodeTy
 {
 
 public:
-    /// Nine kinds of SVFIR nodes
+    /// Nine kinds of SVFIR variables
     /// ValNode: llvm pointer value
     /// ObjNode: memory object
     /// RetNode: unique return node
@@ -157,19 +157,19 @@ public:
         return nullptr;
     }
 
-    /// Get incoming SVFIR edges
+    /// Get incoming SVFIR statements (edges)
     inline SVFStmt::SVFStmtSetTy& getIncomingEdges(SVFStmt::PEDGEK kind)
     {
         return InEdgeKindToSetMap[kind];
     }
 
-    /// Get outgoing SVFIR edges
+    /// Get outgoing SVFIR statements (edges)
     inline SVFStmt::SVFStmtSetTy& getOutgoingEdges(SVFStmt::PEDGEK kind)
     {
         return OutEdgeKindToSetMap[kind];
     }
 
-    /// Has incoming SVFIR edges
+    /// Has incoming SVFIR statements (edges)
     inline bool hasIncomingEdges(SVFStmt::PEDGEK kind) const
     {
         SVFStmt::KindToSVFStmtMapTy::const_iterator it = InEdgeKindToSetMap.find(kind);
@@ -206,7 +206,7 @@ public:
         return it->second.end();
     }
 
-    /// Has outgoing SVFIR edges
+    /// Has outgoing SVFIR statements (edges)
     inline bool hasOutgoingEdges(SVFStmt::PEDGEK kind) const
     {
         SVFStmt::KindToSVFStmtMapTy::const_iterator it = OutEdgeKindToSetMap.find(kind);
@@ -268,7 +268,7 @@ public:
 
 
 /*
- * Value(Pointer) node
+ * Value (Pointer) variable
  */
 class ValVar: public SVFVar
 {
@@ -312,7 +312,7 @@ public:
 
 
 /*
- * Memory Object node
+ * Memory Object variable
  */
 class ObjVar: public SVFVar
 {
@@ -377,9 +377,9 @@ public:
 
 
 /*
- * Gep Value (Pointer) node, this node can be dynamic generated for field sensitive analysis
- * e.g. memcpy, temp gep value node needs to be created
- * Each Gep Value node is connected to base value node via gep edge
+ * Gep Value (Pointer) variable, this variable can be dynamic generated for field sensitive analysis
+ * e.g. memcpy, temp gep value variable needs to be created
+ * Each Gep Value variable is connected to base value variable via gep edge
  */
 class GepValVar: public ValVar
 {
@@ -416,7 +416,7 @@ public:
     {
     }
 
-    /// offset of the base value node
+    /// offset of the base value variable
     inline u32_t getOffset() const
     {
         return ls.getOffset();
@@ -445,8 +445,8 @@ public:
 
 
 /*
- * Gep Obj node, this is dynamic generated for field sensitive analysis
- * Each gep obj node is one field of a MemObj (base)
+ * Gep Obj variable, this is dynamic generated for field sensitive analysis
+ * Each gep obj variable is one field of a MemObj (base)
  */
 class GepObjPN: public ObjVar
 {
@@ -521,7 +521,7 @@ public:
 };
 
 /*
- * Field-insensitive Gep Obj node, this is dynamic generated for field sensitive analysis
+ * Field-insensitive Gep Obj variable, this is dynamic generated for field sensitive analysis
  * Each field-insensitive gep obj node represents all fields of a MemObj (base)
  */
 class FIObjVar: public ObjVar
@@ -649,7 +649,7 @@ public:
 
 
 /*
- * Dummy node
+ * Dummy variable without any LLVM value
  */
 class DummyValVar: public ValVar
 {
@@ -688,7 +688,7 @@ public:
 
 
 /*
- * Dummy node
+ * Dummy object variable
  */
 class DummyObjVar: public ObjVar
 {

package/SVF-osx/include/SVF-FE/SVFIRBuilder.h

@@ -302,9 +302,9 @@ public:
         return edge;
     }
     /// Add Copy edge
-    inline CmpStmt* addCmpEdge(NodeID op1, NodeID op2, NodeID dst, u32_t opcode)
+    inline CmpStmt* addCmpEdge(NodeID op1, NodeID op2, NodeID dst, u32_t predict)
     {
-        CmpStmt *edge = pag->addCmpStmt(op1, op2, dst, opcode);
+        CmpStmt *edge = pag->addCmpStmt(op1, op2, dst, predict);
         setCurrentBBAndValueForPAGEdge(edge);
         return edge;
     }

package/SVF-osx/include/WPA/Andersen.h

@@ -383,7 +383,7 @@ protected:
 
             for (NodeID o : fldInsenObjs)
             {
-                const NodeBS &allFields = consCG->getAllFieldsObjNode(o);
+                const NodeBS &allFields = consCG->getAllFieldsObjVars(o);
                 for (NodeID f : allFields) addPts(it->first, f);
             }
         }

package/SVF-osx/include/WPA/FlowSensitiveTBHC.h

@@ -73,7 +73,7 @@ public:
     virtual bool processPhi(const PHISVFGNode* phi) override;
     virtual bool processCopy(const CopySVFGNode* copy) override;
 
-    virtual inline const NodeBS& getAllFieldsObjNode(NodeID id) override;
+    virtual inline const NodeBS& getAllFieldsObjVars(NodeID id) override;
 
     virtual inline bool updateInFromIn(const SVFGNode* srcStmt, NodeID srcVar, const SVFGNode* dstStmt, NodeID dstVar) override;
     virtual inline bool updateInFromOut(const SVFGNode* srcStmt, NodeID srcVar, const SVFGNode* dstStmt, NodeID dstVar) override;

package/package.json

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