svf-tools 1.0.645 → 1.0.646

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svf-tools",
-  "version": "1.0.645",
+  "version": "1.0.646",
   "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/Graphs/CFBasicBlockG.h

@@ -0,0 +1,246 @@
+//===- CFBasicBlockG.h ----------------------------------------------------------------//
+//
+//                     SVF: Static Value-Flow Analysis
+//
+// Copyright (C) <2013-2018>  <Yulei Sui>
+//
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU 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 General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+//===----------------------------------------------------------------------===//
+
+/*
+ * CFBasicBlockG.h
+ *
+ *  Created on: 24 Dec. 2022
+ *      Author: Xiao, Jiawei
+ */
+
+#ifndef SVF_CFBASICBLOCKG_H
+#define SVF_CFBASICBLOCKG_H
+#include "Util/SVFUtil.h"
+#include "Graphs/ICFGNode.h"
+#include "Graphs/GenericGraph.h"
+
+namespace SVF
+{
+class CFBasicBlockNode;
+class SVFIR;
+
+typedef GenericEdge<CFBasicBlockNode> GenericCFBasicBlockEdgeTy;
+
+class CFBasicBlockEdge : public GenericCFBasicBlockEdgeTy
+{
+public:
+    CFBasicBlockEdge(CFBasicBlockNode *src, CFBasicBlockNode *dst) : GenericCFBasicBlockEdgeTy(src, dst, 0) {}
+
+
+    friend std::ostream &operator<<(std::ostream &o, const CFBasicBlockEdge &edge)
+    {
+        o << edge.toString();
+        return o;
+    }
+
+    virtual const std::string toString() const
+    {
+        return std::to_string(getSrcID()) + " --> " + std::to_string(getDstID());
+    }
+};
+
+typedef GenericNode<CFBasicBlockNode, CFBasicBlockEdge> GenericCFBasicBlockNodeTy;
+
+class CFBasicBlockNode : public GenericCFBasicBlockNodeTy
+{
+private:
+    const SVFBasicBlock *_svfBasicBlock; /// Every CFBasicBlockNode holds a SVFBasicBlock
+    std::vector<const ICFGNode *> _icfgNodes; /// Every CBFGNode holds a vector of ICFGNodes
+
+public:
+    CFBasicBlockNode(u32_t id, const SVFBasicBlock *svfBasicBlock);
+
+    friend std::ostream &operator<<(std::ostream &o, const CFBasicBlockNode &node)
+    {
+        o << node.toString();
+        return o;
+    }
+
+    virtual const std::string toString() const;
+
+    inline std::string getName() const;
+
+    inline const SVFBasicBlock *getSVFBasicBlock() const;
+
+    inline const SVFFunction *getFunction() const;
+
+    inline std::vector<const ICFGNode *>::const_iterator begin() const
+    {
+        return _icfgNodes.cbegin();
+    }
+
+    inline std::vector<const ICFGNode *>::const_iterator end() const
+    {
+        return _icfgNodes.cend();
+    }
+};
+
+typedef GenericGraph<CFBasicBlockNode, CFBasicBlockEdge> GenericCFBasicBlockGTy;
+
+class CFBasicBlockGraph : public GenericCFBasicBlockGTy
+{
+    friend class CFBasicBlockGBuilder;
+
+public:
+    typedef Map<const SVFBasicBlock *, CFBasicBlockNode *> SVFBasicBlockToCFBasicBlockNodeMap;
+
+private:
+    SVFBasicBlockToCFBasicBlockNodeMap _bbToNode;
+    const SVFFunction *_svfFunction;
+    u32_t _totalCFBasicBlockNode{0};
+    u32_t _totalCFBasicBlockEdge{0};
+
+public:
+
+    CFBasicBlockGraph(const SVFFunction *svfFunction) : _svfFunction(svfFunction)
+    {
+
+    }
+
+    ~CFBasicBlockGraph() override = default;
+
+    /// Dump graph into dot file
+    void dump(const std::string &filename)
+    {
+        GraphPrinter::WriteGraphToFile(SVFUtil::outs(), filename, this);
+    }
+
+    inline CFBasicBlockNode *getCFBasicBlockNode(u32_t id) const;
+
+    inline CFBasicBlockNode *getCFBasicBlockNode(const SVFBasicBlock *bb) const;
+
+    inline bool hasCFBasicBlockEdge(CFBasicBlockNode *src, CFBasicBlockNode *dst);
+
+    CFBasicBlockEdge* getCFBasicBlockEdge(const CFBasicBlockNode *src, const CFBasicBlockNode *dst);
+
+    CFBasicBlockEdge* getCFBasicBlockEdge(const SVFBasicBlock *src, const SVFBasicBlock *dst);
+
+private:
+
+    /// Add a CFBasicBlockNode
+    inline const CFBasicBlockNode* getOrAddCFBasicBlockNode(const SVFBasicBlock *bb);
+
+    inline const CFBasicBlockEdge *getOrAddCFBasicBlockEdge(CFBasicBlockNode *src, CFBasicBlockNode *dst);
+
+};
+
+class CFBasicBlockGBuilder
+{
+
+private:
+    CFBasicBlockGraph* _CFBasicBlockG;
+
+public:
+    CFBasicBlockGBuilder(const SVFFunction *func) : _CFBasicBlockG(new CFBasicBlockGraph(func)) {}
+
+    void build();
+
+    inline CFBasicBlockGraph* getCFBasicBlockGraph()
+    {
+        return _CFBasicBlockG;
+    }
+};
+}
+
+
+namespace SVF
+{
+/* !
+ * GenericGraphTraits specializations for generic graph algorithms.
+ * Provide graph traits for traversing from a constraint node using standard graph ICFGTraversals.
+ */
+template<>
+struct GenericGraphTraits<SVF::CFBasicBlockNode *>
+    : public GenericGraphTraits<SVF::GenericNode<SVF::CFBasicBlockNode, SVF::CFBasicBlockEdge> *>
+{
+};
+
+/// Inverse GenericGraphTraits specializations for call graph node, it is used for inverse ICFGTraversal.
+template<>
+struct GenericGraphTraits<Inverse< SVF::CFBasicBlockNode *> > : public GenericGraphTraits<
+    Inverse<SVF::GenericNode<SVF::CFBasicBlockNode, SVF::CFBasicBlockEdge> *> >
+{
+};
+
+template<>
+struct GenericGraphTraits<SVF::CFBasicBlockGraph *>
+    : public GenericGraphTraits<SVF::GenericGraph<SVF::CFBasicBlockNode, SVF::CFBasicBlockEdge> *>
+{
+    typedef SVF::CFBasicBlockNode *NodeRef;
+};
+
+template<>
+struct DOTGraphTraits<SVF::CFBasicBlockGraph *> : public DOTGraphTraits<SVF::SVFIR *>
+{
+
+    typedef SVF::CFBasicBlockNode NodeType;
+
+    DOTGraphTraits(bool isSimple = false) :
+        DOTGraphTraits<SVF::SVFIR *>(isSimple)
+    {
+    }
+
+    /// Return name of the graph
+    static std::string getGraphName(SVF::CFBasicBlockGraph *)
+    {
+        return "CFBasicBlockGraph";
+    }
+
+    std::string getNodeLabel(NodeType *node, SVF::CFBasicBlockGraph *graph)
+    {
+        return getSimpleNodeLabel(node, graph);
+    }
+
+    /// Return the label of an ICFG node
+    static std::string getSimpleNodeLabel(NodeType *node, SVF::CFBasicBlockGraph *)
+    {
+        std::string str;
+        std::stringstream rawstr(str);
+        rawstr << "NodeID: " << node->getId() << "\n";
+        rawstr << node->toString();
+
+        return rawstr.str();
+    }
+
+    static std::string getNodeAttributes(NodeType *node, SVF::CFBasicBlockGraph *)
+    {
+        std::string str;
+        std::stringstream rawstr(str);
+        rawstr << "color=black";
+        return rawstr.str();
+    }
+
+    template<class EdgeIter>
+    static std::string getEdgeAttributes(NodeType *, EdgeIter EI, SVF::CFBasicBlockGraph *)
+    {
+        return "style=solid";
+    }
+
+    template<class EdgeIter>
+    static std::string getEdgeSourceLabel(NodeType *, EdgeIter EI)
+    {
+        return "";
+    }
+};
+
+} // End namespace SVF
+#endif //SVF_CFBASICBLOCKG_H

package/svf/include/Graphs/GenericGraph.h

@@ -30,7 +30,7 @@
 #ifndef GENERICGRAPH_H_
 #define GENERICGRAPH_H_
 
-#include "SVFIR/SVFValue.h"
+#include "SVFIR/SVFType.h"
 #include "Util/iterator.h"
 #include "Graphs/GraphTraits.h"
 

package/svf/include/Graphs/IRGraph.h

@@ -36,6 +36,7 @@
 #include "Util/NodeIDAllocator.h"
 #include "Util/SVFUtil.h"
 #include "Graphs/ICFG.h"
+#include "Graphs/CFBasicBlockG.h"
 
 namespace SVF
 {

package/svf/lib/Graphs/CFBasicBlockG.cpp

@@ -0,0 +1,159 @@
+//===- CFBasicBlockG.cpp ----------------------------------------------------------------//
+//
+//                     SVF: Static Value-Flow Analysis
+//
+// Copyright (C) <2013-2018>  <Yulei Sui>
+//
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU 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 General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+//===----------------------------------------------------------------------===//
+
+/*
+ * CFBasicBlockG.cpp
+ *
+ *  Created on: 24 Dec. 2022
+ *      Author: Xiao, Jiawei
+ */
+
+#include "Graphs/CFBasicBlockG.h"
+#include "SVFIR/SVFIR.h"
+
+namespace SVF
+{
+CFBasicBlockNode::CFBasicBlockNode(u32_t id, const SVFBasicBlock *svfBasicBlock) : GenericCFBasicBlockNodeTy(id, 0),
+    _svfBasicBlock(svfBasicBlock)
+{
+    for (auto it = svfBasicBlock->begin(); it != svfBasicBlock->end(); ++it)
+    {
+        const SVFInstruction *ins = *it;
+        ICFGNode *icfgNode = PAG::getPAG()->getICFG()->getICFGNode(ins);
+        _icfgNodes.push_back(icfgNode);
+    }
+}
+
+const std::string CFBasicBlockNode::toString() const
+{
+    std::string rawStr;
+    std::stringstream stringstream(rawStr);
+    stringstream << "Block Name: " << _svfBasicBlock->getName() << "\n";
+    for (const auto &icfgNode: _icfgNodes)
+    {
+        stringstream << icfgNode->toString() << "\n";
+    }
+    return stringstream.str();
+}
+
+std::string CFBasicBlockNode::getName() const
+{
+    return _svfBasicBlock->getName();
+}
+
+const SVFBasicBlock* CFBasicBlockNode::getSVFBasicBlock() const
+{
+    return _svfBasicBlock;
+}
+
+const SVFFunction* CFBasicBlockNode::getFunction() const
+{
+    return _svfBasicBlock->getFunction();
+}
+
+bool CFBasicBlockGraph::hasCFBasicBlockEdge(CFBasicBlockNode *src, CFBasicBlockNode *dst)
+{
+    CFBasicBlockEdge edge(src, dst);
+    CFBasicBlockEdge *outEdge = src->hasOutgoingEdge(&edge);
+    CFBasicBlockEdge *inEdge = dst->hasIncomingEdge(&edge);
+    if (outEdge && inEdge)
+    {
+        assert(outEdge == inEdge && "edges not match");
+        return true;
+    }
+    else
+        return false;
+}
+
+CFBasicBlockNode* CFBasicBlockGraph::getCFBasicBlockNode(u32_t id) const
+{
+    if (!hasGNode(id)) return nullptr;
+    return getGNode(id);
+}
+
+CFBasicBlockNode* CFBasicBlockGraph::getCFBasicBlockNode(const SVFBasicBlock *bb) const
+{
+    auto it = _bbToNode.find(bb);
+    if (it == _bbToNode.end()) return nullptr;
+    return it->second;
+}
+
+CFBasicBlockEdge* CFBasicBlockGraph::getCFBasicBlockEdge(const SVFBasicBlock *src, const SVFBasicBlock *dst)
+{
+    return getCFBasicBlockEdge(getCFBasicBlockNode(src), getCFBasicBlockNode(dst));
+}
+
+CFBasicBlockEdge* CFBasicBlockGraph::getCFBasicBlockEdge(const CFBasicBlockNode *src, const CFBasicBlockNode *dst)
+{
+    CFBasicBlockEdge *edge = nullptr;
+    size_t counter = 0;
+    for (auto iter = src->OutEdgeBegin();
+            iter != src->OutEdgeEnd(); ++iter)
+    {
+        if ((*iter)->getDstID() == dst->getId())
+        {
+            counter++;
+            edge = (*iter);
+        }
+    }
+    assert(counter <= 1 && "there's more than one edge between two nodes");
+    return edge;
+}
+
+const CFBasicBlockNode* CFBasicBlockGraph::getOrAddCFBasicBlockNode(const SVFBasicBlock *bb)
+{
+    auto it = _bbToNode.find(bb);
+    if (it != _bbToNode.end()) return it->second;
+    CFBasicBlockNode *node = new CFBasicBlockNode(_totalCFBasicBlockNode++, bb);
+    _bbToNode[bb] = node;
+    addGNode(node->getId(), node);
+    return node;
+}
+
+const CFBasicBlockEdge* CFBasicBlockGraph::getOrAddCFBasicBlockEdge(CFBasicBlockNode *src, CFBasicBlockNode *dst)
+{
+    if (const CFBasicBlockEdge *edge = getCFBasicBlockEdge(src, dst)) return edge;
+    CFBasicBlockEdge *edge = new CFBasicBlockEdge(src, dst);
+    bool added1 = edge->getDstNode()->addIncomingEdge(edge);
+    bool added2 = edge->getSrcNode()->addOutgoingEdge(edge);
+    assert(added1 && added2 && "edge not added??");
+    _totalCFBasicBlockEdge++;
+    return edge;
+}
+
+void CFBasicBlockGBuilder::build()
+{
+    for (const auto &bb: *_CFBasicBlockG->_svfFunction)
+    {
+        _CFBasicBlockG->getOrAddCFBasicBlockNode(bb);
+    }
+    for (const auto &bb: *_CFBasicBlockG->_svfFunction)
+    {
+        for (const auto &succ: bb->getSuccessors())
+        {
+            _CFBasicBlockG->getOrAddCFBasicBlockEdge(_CFBasicBlockG->getCFBasicBlockNode(bb),
+                    _CFBasicBlockG->getCFBasicBlockNode(succ));
+        }
+    }
+}
+}
+