svf-tools 1.0.677 → 1.0.679

package/svf/include/SVFIR/SVFType.h

@@ -133,6 +133,7 @@ template <typename Key, typename Value, typename Hash = Hash<Key>,
 {
     friend class SVFModuleWrite;
     friend class SVFModuleRead;
+    friend class SVFIRWriter;
 
 private:
     /// flattened field indices of a struct (ignoring arrays)
@@ -243,6 +244,7 @@ class SVFType
 {
     friend class SVFModuleWrite;
     friend class SVFModuleRead;
+    friend class SVFIRWriter;
 
 public:
     typedef s64_t GNodeK;
@@ -328,6 +330,7 @@ class SVFPointerType : public SVFType
 {
     friend class SVFModuleWrite;
     friend class SVFModuleRead;
+    friend class SVFIRWriter;
 
 private:
     const SVFType* ptrElementType;
@@ -361,6 +364,7 @@ class SVFFunctionType : public SVFType
 {
     friend class SVFModuleWrite;
     friend class SVFModuleRead;
+    friend class SVFIRWriter;
 
 private:
     const SVFType* retTy;

package/svf/include/SVFIR/SVFValue.h

@@ -51,6 +51,7 @@ class SVFLoopAndDomInfo
 {
     friend class SVFModuleWrite;
     friend class SVFModuleRead;
+    friend class SVFIRWriter;
 public:
     typedef Set<const SVFBasicBlock*> BBSet;
     typedef std::vector<const SVFBasicBlock*> BBList;
@@ -151,6 +152,7 @@ class SVFValue
 {
     friend class SVFModuleWrite;
     friend class SVFModuleRead;
+    friend class SVFIRWriter;
     friend class LLVMModuleSet;
 
 public:
@@ -186,9 +188,10 @@ protected:
     std::string name;       ///< Short name of this value for debugging
     std::string sourceLoc;  ///< Source code information of this value
     /// Constructor
-    SVFValue(const std::string& val, const SVFType* ty, SVFValKind k): kind(k),
-        ptrInUncalledFun(false), constDataOrAggData(SVFConstData==k), type(ty),
-        name(val), sourceLoc("No source code Info")
+    SVFValue(const std::string& val, const SVFType* ty, SVFValKind k)
+        : kind(k), ptrInUncalledFun(false),
+          constDataOrAggData(SVFConstData == k), type(ty), name(val),
+          sourceLoc("No source code Info")
     {
     }
 
@@ -212,6 +215,7 @@ public:
         return kind;
     }
 
+    // TODO: (Optimization) Returns `const std::string&`?
     inline virtual const std::string getName() const
     {
         return name;
@@ -264,6 +268,7 @@ class SVFFunction : public SVFValue
     friend class LLVMModuleSet;
     friend class SVFModuleWrite;
     friend class SVFModuleRead;
+    friend class SVFIRWriter;
 
 public:
     typedef std::vector<const SVFBasicBlock*>::const_iterator const_iterator;
@@ -480,6 +485,7 @@ class SVFBasicBlock : public SVFValue
     friend class LLVMModuleSet;
     friend class SVFModuleWrite;
     friend class SVFModuleRead;
+    friend class SVFIRWriter;
 
 public:
     typedef std::vector<const SVFInstruction*>::const_iterator const_iterator;
@@ -580,6 +586,7 @@ class SVFInstruction : public SVFValue
 {
     friend class SVFModuleWrite;
     friend class SVFModuleRead;
+    friend class SVFIRWriter;
 public:
     typedef std::vector<const SVFInstruction*> InstVec;
 
@@ -647,6 +654,7 @@ class SVFCallInst : public SVFInstruction
 {
     friend class SVFModuleWrite;
     friend class SVFModuleRead;
+    friend class SVFIRWriter;
     friend class LLVMModuleSet;
 
 private:
@@ -721,6 +729,7 @@ class SVFVirtualCallInst : public SVFCallInst
 {
     friend class SVFModuleWrite;
     friend class SVFModuleRead;
+    friend class SVFIRWriter;
     friend class LLVMModuleSet;
 
 private:
@@ -779,6 +788,7 @@ class SVFConstant : public SVFValue
 {
     friend class SVFModuleWrite;
     friend class SVFModuleRead;
+    friend class SVFIRWriter;
 public:
     SVFConstant(const std::string& _const, const SVFType* ty, SVFValKind k = SVFConst): SVFValue(_const, ty, k)
     {
@@ -801,6 +811,7 @@ class SVFGlobalValue : public SVFConstant
 {
     friend class SVFModuleWrite;
     friend class SVFModuleRead;
+    friend class SVFIRWriter;
     friend class LLVMModuleSet;
 
 private:
@@ -839,6 +850,7 @@ class SVFArgument : public SVFValue
 {
     friend class SVFModuleWrite;
     friend class SVFModuleRead;
+    friend class SVFIRWriter;
 private:
     const SVFFunction* fun;
     u32_t argNo;
@@ -878,6 +890,7 @@ class SVFConstantData : public SVFConstant
 {
     friend class SVFModuleWrite;
     friend class SVFModuleRead;
+    friend class SVFIRWriter;
 public:
     SVFConstantData(const std::string& _const, const SVFType* ty, SVFValKind k = SVFConstData): SVFConstant(_const, ty, k)
     {
@@ -907,6 +920,7 @@ class SVFConstantInt : public SVFConstantData
 {
     friend class SVFModuleWrite;
     friend class SVFModuleRead;
+    friend class SVFIRWriter;
 private:
     u64_t zval;
     s64_t sval;
@@ -941,6 +955,7 @@ class SVFConstantFP : public SVFConstantData
 {
     friend class SVFModuleWrite;
     friend class SVFModuleRead;
+    friend class SVFIRWriter;
 private:
     float dval;
 public:
@@ -968,6 +983,7 @@ class SVFConstantNullPtr : public SVFConstantData
 {
     friend class SVFModuleWrite;
     friend class SVFModuleRead;
+    friend class SVFIRWriter;
 
 public:
     SVFConstantNullPtr(const std::string& _const, const SVFType* ty): SVFConstantData(_const, ty, SVFValue::SVFNullPtr)
@@ -989,6 +1005,7 @@ class SVFBlackHoleValue : public SVFConstantData
 {
     friend class SVFModuleWrite;
     friend class SVFModuleRead;
+    friend class SVFIRWriter;
 
 public:
     SVFBlackHoleValue(const std::string& _const, const SVFType* ty): SVFConstantData(_const, ty, SVFValue::SVFBlackHole)
@@ -1010,6 +1027,7 @@ class SVFOtherValue : public SVFValue
 {
     friend class SVFModuleWrite;
     friend class SVFModuleRead;
+    friend class SVFIRWriter;
 public:
     SVFOtherValue(const std::string& other, const SVFType* ty, SVFValKind k = SVFValue::SVFOther): SVFValue(other, ty, k)
     {
@@ -1029,6 +1047,7 @@ class SVFMetadataAsValue : public SVFOtherValue
 {
     friend class SVFModuleWrite;
     friend class SVFModuleRead;
+    friend class SVFIRWriter;
 public:
     SVFMetadataAsValue(const std::string& other, const SVFType* ty): SVFOtherValue(other, ty, SVFValue::SVFMetaAsValue)
     {
@@ -1049,9 +1068,10 @@ public:
 class CallSite
 {
 private:
-    const SVFCallInst *CB;
+    const SVFCallInst* CB;
+
 public:
-    CallSite(const SVFInstruction *I) : CB(SVFUtil::dyn_cast<SVFCallInst>(I))
+    CallSite(const SVFInstruction* I) : CB(SVFUtil::dyn_cast<SVFCallInst>(I))
     {
         assert(CB && "not a callsite?");
     }
@@ -1118,19 +1138,18 @@ public:
         assert(isVirtualCall() && "not a virtual call?");
         return SVFUtil::cast<SVFVirtualCallInst>(CB)->getFunNameOfVirtualCall();
     }
-    bool operator==(const CallSite &CS) const
+    bool operator==(const CallSite& CS) const
     {
         return CB == CS.CB;
     }
-    bool operator!=(const CallSite &CS) const
+    bool operator!=(const CallSite& CS) const
     {
         return CB != CS.CB;
     }
-    bool operator<(const CallSite &CS) const
+    bool operator<(const CallSite& CS) const
     {
         return getInstruction() < CS.getInstruction();
     }
-
 };
 
 template <typename F, typename S>

package/svf/include/SVFIR/SVFVariables.h

@@ -41,9 +41,10 @@ class SVFVar;
 /*
  * SVFIR program variables (PAGNodes)
  */
-typedef GenericNode<SVFVar,SVFStmt> GenericPAGNodeTy;
+typedef GenericNode<SVFVar, SVFStmt> GenericPAGNodeTy;
 class SVFVar : public GenericPAGNodeTy
 {
+    friend class SVFIRWriter;
     friend class IRGraph;
     friend class SVFIR;
     friend class VFG;
@@ -82,31 +83,31 @@ public:
     /// Constructor
     SVFVar(const SVFValue* val, NodeID i, PNODEK k);
     /// Destructor
-    virtual ~SVFVar()
-    {
-    }
+    virtual ~SVFVar() {}
 
     ///  Get/has methods of the components
     //@{
     inline const SVFValue* getValue() const
     {
-        assert((this->getNodeKind() != DummyValNode && this->getNodeKind() != DummyObjNode) && "dummy node do not have value!");
-        assert((SymbolTableInfo::isBlkObjOrConstantObj(this->getId())==false) && "blackhole and constant obj do not have value");
-        assert(value && "value is null (GepObjNode whose basenode is a DummyObj?)");
+        assert(this->getNodeKind() != DummyValNode &&
+               this->getNodeKind() != DummyObjNode &&
+               "dummy node do not have value!");
+        assert(!SymbolTableInfo::isBlkObjOrConstantObj(this->getId()) &&
+               "blackhole and constant obj do not have value");
+        assert(value &&
+               "value is null (GepObjNode whose basenode is a DummyObj?)");
         return value;
     }
 
     /// Return type of the value
     inline virtual const SVFType* getType() const
     {
-        if (value)
-            return value->getType();
-        return nullptr;
+        return value ? value->getType() : nullptr;
     }
 
     inline bool hasValue() const
     {
-        return value!=nullptr;
+        return value != nullptr;
     }
     /// Whether it is a pointer
     virtual inline bool isPointer() const
@@ -121,18 +122,19 @@ public:
     bool isIsolatedNode() const;
 
     /// Get name of the LLVM value
+    // TODO: (Optimization) Should it return const reference instead of value?
     virtual const std::string getValueName() const = 0;
 
     /// Return the function that this SVFVar resides in. Return nullptr if it is a global or constantexpr node
     virtual inline const SVFFunction* getFunction() const
     {
-        if(value)
+        if (value)
         {
-            if(const SVFInstruction* inst = SVFUtil::dyn_cast<SVFInstruction>(value))
+            if (auto inst = SVFUtil::dyn_cast<SVFInstruction>(value))
                 return inst->getParent()->getParent();
-            else if (const SVFArgument* arg = SVFUtil::dyn_cast<SVFArgument>(value))
+            else if (auto arg = SVFUtil::dyn_cast<SVFArgument>(value))
                 return arg->getParent();
-            else if (const SVFFunction* fun = SVFUtil::dyn_cast<SVFFunction>(value))
+            else if (auto fun = SVFUtil::dyn_cast<SVFFunction>(value))
                 return fun;
         }
         return nullptr;
@@ -255,15 +257,16 @@ public:
  */
 class ValVar: public SVFVar
 {
+    friend class SVFIRWriter;
 
 public:
     /// Methods for support type inquiry through isa, cast, and dyn_cast:
     //@{
-    static inline bool classof(const ValVar *)
+    static inline bool classof(const ValVar*)
     {
         return true;
     }
-    static inline bool classof(const SVFVar *node)
+    static inline bool classof(const SVFVar* node)
     {
         return node->getNodeKind() == SVFVar::ValNode ||
                node->getNodeKind() == SVFVar::GepValNode ||
@@ -271,7 +274,7 @@ public:
                node->getNodeKind() == SVFVar::VarargNode ||
                node->getNodeKind() == SVFVar::DummyValNode;
     }
-    static inline bool classof(const GenericPAGNodeTy *node)
+    static inline bool classof(const GenericPAGNodeTy* node)
     {
         return node->getNodeKind() == SVFVar::ValNode ||
                node->getNodeKind() == SVFVar::GepValNode ||
@@ -282,8 +285,8 @@ public:
     //@}
 
     /// Constructor
-    ValVar(const SVFValue* val, NodeID i, PNODEK ty = ValNode) :
-        SVFVar(val, i, ty)
+    ValVar(const SVFValue* val, NodeID i, PNODEK ty = ValNode)
+        : SVFVar(val, i, ty)
     {
     }
     /// Return name of a LLVM value
@@ -297,12 +300,12 @@ public:
     virtual const std::string toString() const;
 };
 
-
 /*
  * Memory Object variable
  */
 class ObjVar: public SVFVar
 {
+    friend class SVFIRWriter;
 
 protected:
     const MemObj* mem;	///< memory object
@@ -314,18 +317,18 @@ protected:
 public:
     /// Methods for support type inquiry through isa, cast, and dyn_cast:
     //@{
-    static inline bool classof(const ObjVar *)
+    static inline bool classof(const ObjVar*)
     {
         return true;
     }
-    static inline bool classof(const SVFVar *node)
+    static inline bool classof(const SVFVar* node)
     {
         return node->getNodeKind() == SVFVar::ObjNode ||
                node->getNodeKind() == SVFVar::GepObjNode ||
                node->getNodeKind() == SVFVar::FIObjNode ||
                node->getNodeKind() == SVFVar::DummyObjNode;
     }
-    static inline bool classof(const GenericPAGNodeTy *node)
+    static inline bool classof(const GenericPAGNodeTy* node)
     {
         return node->getNodeKind() == SVFVar::ObjNode ||
                node->getNodeKind() == SVFVar::GepObjNode ||
@@ -364,6 +367,7 @@ public:
  */
 class GepValVar: public ValVar
 {
+    friend class SVFIRWriter;
 
 private:
     LocationSet ls;	// LocationSet
@@ -391,8 +395,9 @@ public:
     //@}
 
     /// Constructor
-    GepValVar(const SVFValue* val, NodeID i, const LocationSet& l, const SVFType* ty) :
-        ValVar(val, i, GepValNode), ls(l), gepValType(ty)
+    GepValVar(const SVFValue* val, NodeID i, const LocationSet& l,
+              const SVFType* ty)
+        : ValVar(val, i, GepValNode), ls(l), gepValType(ty)
     {
     }
 
@@ -406,7 +411,8 @@ public:
     inline const std::string getValueName() const
     {
         if (value)
-            return value->getName() + "_" + std::to_string(getConstantFieldIdx());
+            return value->getName() + "_" +
+                   std::to_string(getConstantFieldIdx());
         return "offset_" + std::to_string(getConstantFieldIdx());
     }
 
@@ -425,6 +431,8 @@ public:
  */
 class GepObjVar: public ObjVar
 {
+    friend class SVFIRWriter;
+
 private:
     LocationSet ls;
     NodeID base = 0;
@@ -432,27 +440,28 @@ private:
 public:
     /// Methods for support type inquiry through isa, cast, and dyn_cast:
     //@{
-    static inline bool classof(const GepObjVar *)
+    static inline bool classof(const GepObjVar*)
     {
         return true;
     }
-    static inline bool classof(const ObjVar * node)
+    static inline bool classof(const ObjVar* node)
     {
         return node->getNodeKind() == SVFVar::GepObjNode;
     }
-    static inline bool classof(const SVFVar *node)
+    static inline bool classof(const SVFVar* node)
     {
         return node->getNodeKind() == SVFVar::GepObjNode;
     }
-    static inline bool classof(const GenericPAGNodeTy *node)
+    static inline bool classof(const GenericPAGNodeTy* node)
     {
         return node->getNodeKind() == SVFVar::GepObjNode;
     }
     //@}
 
     /// Constructor
-    GepObjVar(const MemObj* mem, NodeID i, const LocationSet& l, PNODEK ty = GepObjNode) :
-        ObjVar(mem->getValue(), i, mem, ty), ls(l)
+    GepObjVar(const MemObj* mem, NodeID i, const LocationSet& l,
+              PNODEK ty = GepObjNode)
+        : ObjVar(mem->getValue(), i, mem, ty), ls(l)
     {
         base = mem->getId();
     }
@@ -504,31 +513,33 @@ public:
  */
 class FIObjVar: public ObjVar
 {
-public:
+    friend class SVFIRWriter;
 
+public:
     ///  Methods for support type inquiry through isa, cast, and dyn_cast:
     //@{
-    static inline bool classof(const FIObjVar *)
+    static inline bool classof(const FIObjVar*)
     {
         return true;
     }
-    static inline bool classof(const ObjVar * node)
+    static inline bool classof(const ObjVar* node)
     {
         return node->getNodeKind() == SVFVar::FIObjNode;
     }
-    static inline bool classof(const SVFVar *node)
+    static inline bool classof(const SVFVar* node)
     {
         return node->getNodeKind() == SVFVar::FIObjNode;
     }
-    static inline bool classof(const GenericPAGNodeTy *node)
+    static inline bool classof(const GenericPAGNodeTy* node)
     {
         return node->getNodeKind() == SVFVar::FIObjNode;
     }
     //@}
 
     /// Constructor
-    FIObjVar(const SVFValue* val, NodeID i, const MemObj* mem, PNODEK ty = FIObjNode) :
-        ObjVar(val, i, mem, ty)
+    FIObjVar(const SVFValue* val, NodeID i, const MemObj* mem,
+             PNODEK ty = FIObjNode)
+        : ObjVar(val, i, mem, ty)
     {
     }
 
@@ -548,33 +559,30 @@ public:
  */
 class RetPN: public ValVar
 {
+    friend class SVFIRWriter;
 
 public:
-
     //@{ Methods for support type inquiry through isa, cast, and dyn_cast:
-    static inline bool classof(const RetPN *)
+    static inline bool classof(const RetPN*)
     {
         return true;
     }
-    static inline bool classof(const SVFVar *node)
+    static inline bool classof(const SVFVar* node)
     {
         return node->getNodeKind() == SVFVar::RetNode;
     }
-    static inline bool classof(const ValVar *node)
+    static inline bool classof(const ValVar* node)
     {
         return node->getNodeKind() == SVFVar::RetNode;
     }
-    static inline bool classof(const GenericPAGNodeTy *node)
+    static inline bool classof(const GenericPAGNodeTy* node)
     {
         return node->getNodeKind() == SVFVar::RetNode;
     }
     //@}
 
     /// Constructor
-    RetPN(const SVFFunction* val, NodeID i) :
-        ValVar(val, i, RetNode)
-    {
-    }
+    RetPN(const SVFFunction* val, NodeID i) : ValVar(val, i, RetNode) {}
 
     /// Return name of a LLVM value
     const std::string getValueName() const
@@ -585,39 +593,35 @@ public:
     virtual const std::string toString() const;
 };
 
-
 /*
  * Unique vararg node of a procedure
  */
 class VarArgPN: public ValVar
 {
+    friend class SVFIRWriter;
 
 public:
-
     //@{ Methods for support type inquiry through isa, cast, and dyn_cast:
-    static inline bool classof(const VarArgPN *)
+    static inline bool classof(const VarArgPN*)
     {
         return true;
     }
-    static inline bool classof(const SVFVar *node)
+    static inline bool classof(const SVFVar* node)
     {
         return node->getNodeKind() == SVFVar::VarargNode;
     }
-    static inline bool classof(const ValVar *node)
+    static inline bool classof(const ValVar* node)
     {
         return node->getNodeKind() == SVFVar::VarargNode;
     }
-    static inline bool classof(const GenericPAGNodeTy *node)
+    static inline bool classof(const GenericPAGNodeTy* node)
     {
         return node->getNodeKind() == SVFVar::VarargNode;
     }
     //@}
 
     /// Constructor
-    VarArgPN(const SVFFunction* val, NodeID i) :
-        ValVar(val, i, VarargNode)
-    {
-    }
+    VarArgPN(const SVFFunction* val, NodeID i) : ValVar(val, i, VarargNode) {}
 
     /// Return name of a LLVM value
     inline const std::string getValueName() const
@@ -628,41 +632,35 @@ public:
     virtual const std::string toString() const;
 };
 
-
-
-
 /*
  * Dummy variable without any LLVM value
  */
 class DummyValVar: public ValVar
 {
+    friend class SVFIRWriter;
 
 public:
-
     //@{ Methods for support type inquiry through isa, cast, and dyn_cast:
-    static inline bool classof(const DummyValVar *)
+    static inline bool classof(const DummyValVar*)
     {
         return true;
     }
-    static inline bool classof(const SVFVar *node)
+    static inline bool classof(const SVFVar* node)
     {
         return node->getNodeKind() == SVFVar::DummyValNode;
     }
-    static inline bool classof(const ValVar *node)
+    static inline bool classof(const ValVar* node)
     {
         return node->getNodeKind() == SVFVar::DummyValNode;
     }
-    static inline bool classof(const GenericPAGNodeTy *node)
+    static inline bool classof(const GenericPAGNodeTy* node)
     {
         return node->getNodeKind() == SVFVar::DummyValNode;
     }
     //@}
 
     /// Constructor
-    DummyValVar(NodeID i) : ValVar(nullptr, i, DummyValNode)
-    {
-    }
-
+    DummyValVar(NodeID i) : ValVar(nullptr, i, DummyValNode) {}
 
     /// Return name of this node
     inline const std::string getValueName() const
@@ -673,36 +671,35 @@ public:
     virtual const std::string toString() const;
 };
 
-
 /*
  * Dummy object variable
  */
 class DummyObjVar: public ObjVar
 {
+    friend class SVFIRWriter;
 
 public:
-
     //@{ Methods for support type inquiry through isa, cast, and dyn_cast:
-    static inline bool classof(const DummyObjVar *)
+    static inline bool classof(const DummyObjVar*)
     {
         return true;
     }
-    static inline bool classof(const SVFVar *node)
+    static inline bool classof(const SVFVar* node)
     {
         return node->getNodeKind() == SVFVar::DummyObjNode;
     }
-    static inline bool classof(const ObjVar *node)
+    static inline bool classof(const ObjVar* node)
     {
         return node->getNodeKind() == SVFVar::DummyObjNode;
     }
-    static inline bool classof(const GenericPAGNodeTy *node)
+    static inline bool classof(const GenericPAGNodeTy* node)
     {
         return node->getNodeKind() == SVFVar::DummyObjNode;
     }
     //@}
 
     /// Constructor
-    DummyObjVar(NodeID i,const MemObj* m, PNODEK ty = DummyObjNode)
+    DummyObjVar(NodeID i, const MemObj* m, PNODEK ty = DummyObjNode)
         : ObjVar(nullptr, i, m, ty)
     {
     }