svf-tools 1.0.719 → 1.0.721

package/.gitignore

@@ -2,7 +2,7 @@ Release*/
 Debug*/
 build/
 html/
-Test-Suite/
+Test-Suite
 Release+Asserts/
 Debug+Asserts/
 autoconf/
@@ -21,3 +21,4 @@ doxygen/
 *.obj
 *.svf
 cmake-build-debug/
+compile_commands.json

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svf-tools",
-  "version": "1.0.719",
+  "version": "1.0.721",
   "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/SVFIR/SVFType.h

@@ -264,6 +264,7 @@ private:
     StInfo* typeinfo;   ///< SVF's TypeInfo
     bool isSingleValTy; ///< The type represents a single value, not struct or
     ///< array
+
 protected:
     SVFType(bool svt, SVFTyKind k)
         : kind(k), getPointerToTy(nullptr), typeinfo(nullptr),
@@ -280,9 +281,11 @@ public:
         return kind;
     }
 
-    /// Needs to be implemented by a specific SVF front end (e.g., the
-    /// implementation in LLVMUtil)
-    virtual const std::string toString() const;
+    /// Note: Use `os<<svfType` or `svfType.print(os)` when possible to avoid
+    /// string concatenation.
+    std::string toString() const;
+
+    virtual void print(std::ostream& OS) const = 0;
 
     inline void setPointerTo(const SVFPointerType* ty)
     {
@@ -323,6 +326,8 @@ public:
     }
 };
 
+std::ostream& operator<<(std::ostream& OS, const SVFType& type);
+
 class SVFPointerType : public SVFType
 {
     friend class SVFIRWriter;
@@ -344,6 +349,8 @@ public:
     {
         return ptrElementType;
     }
+
+    void print(std::ostream& OS) const override;
 };
 
 class SVFIntegerType : public SVFType
@@ -354,6 +361,8 @@ public:
     {
         return node->getKind() == SVFIntegerTy;
     }
+
+    void print(std::ostream& OS) const override;
 };
 
 class SVFFunctionType : public SVFType
@@ -377,36 +386,89 @@ public:
     {
         return retTy;
     }
+
+    void print(std::ostream& OS) const override;
 };
 
 class SVFStructType : public SVFType
 {
+    friend class SVFIRWriter;
+    friend class SVFIRReader;
+
+private:
+    std::string name;
+
 public:
     SVFStructType() : SVFType(false, SVFStructTy) {}
+
     static inline bool classof(const SVFType* node)
     {
         return node->getKind() == SVFStructTy;
     }
+
+    void print(std::ostream& OS) const override;
+
+    std::string& getName()
+    {
+        return name;
+    }
 };
 
 class SVFArrayType : public SVFType
 {
+    friend class SVFIRWriter;
+    friend class SVFIRReader;
+
+private:
+    unsigned numOfElement; /// For printing
+    SVFType* typeOfElement; /// For printing
+
 public:
-    SVFArrayType() : SVFType(false, SVFArrayTy) {}
+    SVFArrayType()
+        : SVFType(false, SVFArrayTy), numOfElement(0), typeOfElement(nullptr)
+    {
+    }
+
     static inline bool classof(const SVFType* node)
     {
         return node->getKind() == SVFArrayTy;
     }
+
+    void print(std::ostream& OS) const override;
+
+    void setTypeOfElement(SVFType* elemType)
+    {
+        typeOfElement = elemType;
+    }
+
+    void setNumOfElement(unsigned elemNum)
+    {
+        numOfElement = elemNum;
+    }
 };
 
 class SVFOtherType : public SVFType
 {
+    friend class SVFIRWriter;
+    friend class SVFIRReader;
+
+private:
+    std::string repr; /// Field representation for printing
+
 public:
     SVFOtherType(bool isSingleValueTy) : SVFType(isSingleValueTy, SVFOtherTy) {}
+
     static inline bool classof(const SVFType* node)
     {
         return node->getKind() == SVFOtherTy;
     }
+
+    std::string& getRepr()
+    {
+        return repr;
+    }
+
+    void print(std::ostream& OS) const override;
 };
 
 // TODO: be explicit that this is a pair of 32-bit unsigneds?

package/svf/lib/AbstractExecution/SVFIR2ItvExeState.cpp

@@ -300,7 +300,7 @@ void SVFIR2ItvExeState::initValVar(const ValVar *valVar, u32_t varId)
         else
         {
 
-            SVFUtil::errs() << valVar->getValue()->toString() << "\n" << " type: " << type->toString() << "\n";
+            SVFUtil::errs() << valVar->getValue()->toString() << "\n" << " type: " << *type << "\n";
             assert(false && "what other types we have");
         }
     }

package/svf/lib/MemoryModel/LocationSet.cpp

@@ -81,7 +81,7 @@ u32_t LocationSet::getElementNum(const SVFType* type) const
     }
     else
     {
-        SVFUtil::outs() << "GepIter Type" << type->toString() << "\n";
+        SVFUtil::outs() << "GepIter Type" << *type << "\n";
         assert(false && "What other types for this gep?");
         abort();
     }
@@ -228,7 +228,8 @@ std::string LocationSet::dump() const
     OffsetVarAndGepTypePairs::const_iterator eit = vec.end();
     for (; it != eit; ++it)
     {
-        rawstr << " (Svf var: " << it->first->toString() << ", Iter type: " << it->second->toString() << ")";
+        const SVFType* ty = it->second;
+        rawstr << " (Svf var: " << it->first->toString() << ", Iter type: " << *ty << ")";
     }
     rawstr << " }\n";
     return rawstr.str();

package/svf/lib/SVFIR/SVFFileSystem.cpp

@@ -498,17 +498,24 @@ cJSON* SVFIRWriter::contentToJson(const SVFFunctionType* type)
 
 cJSON* SVFIRWriter::contentToJson(const SVFStructType* type)
 {
-    return contentToJson(static_cast<const SVFType*>(type));
+    cJSON* root = contentToJson(static_cast<const SVFType*>(type));
+    JSON_WRITE_FIELD(root, type, name);
+    return root;
 }
 
 cJSON* SVFIRWriter::contentToJson(const SVFArrayType* type)
 {
-    return contentToJson(static_cast<const SVFType*>(type));
+    cJSON* root = contentToJson(static_cast<const SVFType*>(type));
+    JSON_WRITE_FIELD(root, type, numOfElement);
+    JSON_WRITE_FIELD(root, type, typeOfElement);
+    return root;
 }
 
 cJSON* SVFIRWriter::contentToJson(const SVFOtherType* type)
 {
-    return contentToJson(static_cast<const SVFType*>(type));
+    cJSON* root = contentToJson(static_cast<const SVFType*>(type));
+    JSON_WRITE_FIELD(root, type, repr);
+    return root;
 }
 
 cJSON* SVFIRWriter::contentToJson(const SVFValue* value)
@@ -2492,16 +2499,20 @@ void SVFIRReader::fill(const cJSON*& fieldJson, SVFFunctionType* type)
 void SVFIRReader::fill(const cJSON*& fieldJson, SVFStructType* type)
 {
     fill(fieldJson, static_cast<SVFType*>(type));
+    JSON_READ_FIELD_FWD(fieldJson, type, name);
 }
 
 void SVFIRReader::fill(const cJSON*& fieldJson, SVFArrayType* type)
 {
     fill(fieldJson, static_cast<SVFType*>(type));
+    JSON_READ_FIELD_FWD(fieldJson, type, numOfElement);
+    JSON_READ_FIELD_FWD(fieldJson, type, typeOfElement);
 }
 
 void SVFIRReader::fill(const cJSON*& fieldJson, SVFOtherType* type)
 {
     fill(fieldJson, static_cast<SVFType*>(type));
+    JSON_READ_FIELD_FWD(fieldJson, type, repr);
 }
 
 SVFIR* SVFIRReader::read(const std::string& path)

package/svf/lib/SVFIR/SVFType.cpp

@@ -0,0 +1,51 @@
+#include "SVFIR/SVFType.h"
+#include <sstream>
+
+namespace SVF
+{
+std::string SVFType::toString() const
+{
+    std::ostringstream os;
+    print(os);
+    return os.str();
+}
+
+std::ostream& operator<<(std::ostream& OS, const SVFType& type)
+{
+    type.print(OS);
+    return OS;
+}
+
+void SVFPointerType::print(std::ostream& OS) const
+{
+    getPtrElementType()->print(OS);
+    OS << "*";
+}
+
+void SVFIntegerType::print(std::ostream& OS) const
+{
+    // Making it more informative?
+    OS << "I";
+}
+
+void SVFFunctionType::print(std::ostream& OS) const
+{
+    OS << *getReturnType() << "()";
+}
+
+void SVFStructType::print(std::ostream& OS) const
+{
+    OS << "S." << name;
+}
+
+void SVFArrayType::print(std::ostream& OS) const
+{
+    OS << "[" << numOfElement << "x" << *typeOfElement << "]";
+}
+
+void SVFOtherType::print(std::ostream& OS) const
+{
+    OS << repr;
+}
+
+} // namespace SVF

package/svf/lib/SVFIR/SymbolTableInfo.cpp

@@ -237,68 +237,49 @@ const std::vector<const SVFType*>& SymbolTableInfo::getFlattenFieldTypes(const S
 void SymbolTableInfo::printFlattenFields(const SVFType* type)
 {
 
-    if(const SVFArrayType *at = SVFUtil::dyn_cast<SVFArrayType> (type))
+    if (const SVFArrayType* at = SVFUtil::dyn_cast<SVFArrayType>(type))
     {
-        outs() <<"  {Type: ";
-        outs() << at->toString();
-        outs() << "}\n";
-        outs() << "\tarray type ";
-        outs() << "\t [element size = " << getNumOfFlattenElements(at) << "]\n";
-        outs() << "\n";
+        outs() << "  {Type: " << *at << "}\n"
+               << "\tarray type "
+               << "\t [element size = " << getNumOfFlattenElements(at) << "]\n"
+               << "\n";
     }
-
-    else if(const SVFStructType *st = SVFUtil::dyn_cast<SVFStructType> (type))
+    else if (const SVFStructType *st = SVFUtil::dyn_cast<SVFStructType>(type))
     {
-        outs() <<"  {Type: ";
-        outs() << st->toString();
-        outs() << "}\n";
+        outs() <<"  {Type: " << *st << "}\n";
         const std::vector<const SVFType*>& finfo = getTypeInfo(st)->getFlattenFieldTypes();
         int field_idx = 0;
-        for(std::vector<const SVFType*>::const_iterator it = finfo.begin(), eit = finfo.end();
-                it!=eit; ++it, field_idx++)
+        for(const SVFType* type : finfo)
         {
-            outs() << " \tField_idx = " << field_idx;
-            outs() << ", field type: ";
-            outs() << (*it)->toString();
-            outs() << "\n";
+            outs() << " \tField_idx = " << ++field_idx
+                   << ", field type: " << *type << "\n";
         }
         outs() << "\n";
     }
-
-    else if (const SVFPointerType* pt= SVFUtil::dyn_cast<SVFPointerType> (type))
+    else if (const SVFPointerType* pt= SVFUtil::dyn_cast<SVFPointerType>(type))
     {
         u32_t eSize = getNumOfFlattenElements(pt->getPtrElementType());
-        outs() << "  {Type: ";
-        outs() << pt->toString();
-        outs() << "}\n";
-        outs() <<"\t [target size = " << eSize << "]\n";
-        outs() << "\n";
+        outs() << "  {Type: " << *pt << "}\n"
+               << "\t [target size = " << eSize << "]\n"
+               << "\n";
     }
-
-    else if ( const SVFFunctionType* fu= SVFUtil::dyn_cast<SVFFunctionType> (type))
+    else if (const SVFFunctionType* fu =
+                 SVFUtil::dyn_cast<SVFFunctionType>(type))
     {
-        outs() << "  {Type: ";
-        outs() << fu->getReturnType()->toString();
-        outs() << "(Function)}\n\n";
+        outs() << "  {Type: " << *fu << "}\n\n";
     }
-
-    else if ( const SVFOtherType* ot= SVFUtil::dyn_cast<SVFOtherType> (type))
+    else if (const SVFOtherType* ot = SVFUtil::dyn_cast<SVFOtherType>(type))
     {
-        outs() << "  {Type: ";
-        outs() << ot->toString();
-        outs() << "(SVFOtherType)}\n\n";
+        outs() << "  {Type: "<< *ot << "(SVFOtherType)}\n\n";
     }
-
     else
     {
         assert(type->isSingleValueType() && "not a single value type, then what else!!");
         /// All rest types are scalar type?
         u32_t eSize = getNumOfFlattenElements(type);
-        outs() <<"  {Type: ";
-        outs() << type->toString();
-        outs() << "}\n";
-        outs() <<"\t [object size = " << eSize << "]\n";
-        outs() << "\n";
+        outs() << "  {Type: " << *type << "}\n"
+               << "\t [object size = " << eSize << "]\n"
+               << "\n";
     }
 }
 
@@ -593,4 +574,3 @@ bool SymbolTableInfo::hasValSym(const SVFValue* val)
     else
         return (valSymMap.find(val) != valSymMap.end());
 }
-

package/svf-llvm/lib/LLVMModule.cpp

@@ -1003,12 +1003,25 @@ SVFType* LLVMModuleSet::addSVFTypeInfo(const Type* T)
         svftype = new SVFIntegerType();
     else if (const FunctionType* ft = SVFUtil::dyn_cast<FunctionType>(T))
         svftype = new SVFFunctionType(getSVFType(ft->getReturnType()));
-    else if (SVFUtil::isa<StructType>(T))
-        svftype = new SVFStructType();
-    else if (SVFUtil::isa<ArrayType>(T))
-        svftype = new SVFArrayType();
+    else if (const StructType* st = SVFUtil::dyn_cast<StructType>(T))
+    {
+        auto svfst = new SVFStructType;
+        svfst->getName() = st->getName().str();
+        svftype = svfst;
+    }
+    else if (const auto at = SVFUtil::dyn_cast<ArrayType>(T))
+    {
+        auto svfat = new SVFArrayType();
+        svfat->setNumOfElement(at->getNumElements());
+        svfat->setTypeOfElement(getSVFType(at->getElementType()));
+        svftype = svfat;
+    }
     else
-        svftype = new SVFOtherType(T->isSingleValueType());
+    {
+        auto ot = new SVFOtherType(T->isSingleValueType());
+        llvm::raw_string_ostream(ot->getRepr()) << *T;
+        svftype = ot;
+    }
 
     symInfo->addTypeInfo(svftype);
     LLVMType2SVFType[T] = svftype;
@@ -1044,8 +1057,9 @@ StInfo* LLVMModuleSet::collectArrayInfo(const ArrayType* ty)
     /// Array's flatten field infor is the same as its element's
     /// flatten infor.
     StInfo* elemStInfo = collectTypeInfo(elemTy);
-    u32_t nfE = elemStInfo->getNumOfFlattenFields();
-    for (u32_t j = 0; j < nfE; j++)
+    u32_t nfF = elemStInfo->getNumOfFlattenFields();
+    u32_t nfE = elemStInfo->getNumOfFlattenElements();
+    for (u32_t j = 0; j < nfF; j++)
     {
         const SVFType* fieldTy = elemStInfo->getFlattenFieldTypes()[j];
         stInfo->getFlattenFieldTypes().push_back(fieldTy);
@@ -1064,14 +1078,14 @@ StInfo* LLVMModuleSet::collectArrayInfo(const ArrayType* ty)
     {
         for (u32_t j = 0; j < nfE; ++j)
         {
-            const SVFType* et = elemStInfo->getFlattenFieldTypes()[j];
+            const SVFType* et = elemStInfo->getFlattenElementTypes()[j];
             stInfo->getFlattenElementTypes().push_back(et);
         }
     }
 
     assert(stInfo->getFlattenElementTypes().size() == nfE * totalElemNum &&
            "typeForArray size incorrect!!!");
-    stInfo->setNumOfFieldsAndElems(nfE, nfE * totalElemNum);
+    stInfo->setNumOfFieldsAndElems(nfF, nfE * totalElemNum);
 
     return stInfo;
 }
@@ -1099,23 +1113,22 @@ StInfo* LLVMModuleSet::collectStructInfo(const StructType* structTy,
         if (SVFUtil::isa<StructType, ArrayType>(elemTy))
         {
             StInfo* subStInfo = collectTypeInfo(elemTy);
-            u32_t nfE = subStInfo->getNumOfFlattenFields();
+            u32_t nfF = subStInfo->getNumOfFlattenFields();
+            u32_t nfE = subStInfo->getNumOfFlattenElements();
             // Copy ST's info, whose element 0 is the size of ST itself.
-            for (u32_t j = 0; j < nfE; ++j)
+            for (u32_t j = 0; j < nfF; ++j)
             {
                 const SVFType* elemTy = subStInfo->getFlattenFieldTypes()[j];
                 stInfo->getFlattenFieldTypes().push_back(elemTy);
             }
-            numFields += nfE;
-            strideOffset += nfE * subStInfo->getStride();
-            for (u32_t tpi = 0; tpi < subStInfo->getStride(); ++tpi)
+            numFields += nfF;
+            strideOffset += nfE;
+            for (u32_t tpj = 0; tpj < nfE; ++tpj)
             {
-                for (u32_t tpj = 0; tpj < nfE; ++tpj)
-                {
-                    const SVFType* ty = subStInfo->getFlattenFieldTypes()[tpj];
-                    stInfo->getFlattenElementTypes().push_back(ty);
-                }
+                const SVFType* ty = subStInfo->getFlattenElementTypes()[tpj];
+                stInfo->getFlattenElementTypes().push_back(ty);
             }
+
         }
         else
         {

package/svf-llvm/lib/LLVMUtil.cpp

@@ -1048,12 +1048,4 @@ const std::string SVFValue::toString() const
     return rawstr.str();
 }
 
-const std::string SVFType::toString() const
-{
-    std::string str;
-    llvm::raw_string_ostream rawstr(str);
-    const Type* ty = LLVMModuleSet::getLLVMModuleSet()->getLLVMType(this);
-    rawstr << *ty;
-    return rawstr.str();
 }
-}