svf-lib 1.0.2319 → 1.0.2321

package/SVF-osx/Release-build/include/SVF/SABER/SaberCondAllocator.h

@@ -0,0 +1,317 @@
+//===- SaberCondAllocator.h -- Path condition manipulation---------------------//
+//
+//                     SVF: Static Value-Flow Analysis
+//
+// Copyright (C) <2013->  <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/>.
+//
+//===----------------------------------------------------------------------===//
+
+/*
+ * PathAllocator.h
+ *
+ *  Created on: Apr 3, 2014
+ *      Author: Yulei Sui
+ */
+
+#ifndef PATHALLOCATOR_H_
+#define PATHALLOCATOR_H_
+
+#include "SVFIR/SVFValue.h"
+#include "Util/WorkList.h"
+#include "Graphs/SVFG.h"
+#include "Util/Z3Expr.h"
+
+
+namespace SVF
+{
+
+/**
+ * SaberCondAllocator allocates conditions for each basic block of a certain CFG.
+ */
+class SaberCondAllocator
+{
+
+public:
+
+    typedef Z3Expr Condition;   /// z3 condition
+    typedef Map<u32_t, const ICFGNode*> IndexToTermInstMap; /// id to instruction map for z3
+    typedef Map<u32_t,Condition> CondPosMap;		///< map a branch to its Condition
+    typedef Map<const SVFBasicBlock*, CondPosMap > BBCondMap;	/// map bb to a Condition
+    typedef Set<const SVFBasicBlock*> BasicBlockSet;
+    typedef Map<const FunObjVar*,  BasicBlockSet> FunToExitBBsMap;  ///< map a function to all its basic blocks calling program exit
+    typedef Map<const SVFBasicBlock*, Condition> BBToCondMap;	///< map a basic block to its condition during control-flow guard computation
+    typedef FIFOWorkList<const SVFBasicBlock*> CFWorkList;	///< worklist for control-flow guard computation
+    typedef Map<const SVFGNode*, Set<const SVFGNode*>> SVFGNodeToSVFGNodeSetMap;
+
+
+    /// Constructor
+    SaberCondAllocator();
+
+    /// Destructor
+    virtual ~SaberCondAllocator()
+    {
+    }
+    /// Statistics
+    //@{
+    inline std::string getMemUsage()
+    {
+        u32_t vmrss, vmsize;
+        if (SVFUtil::getMemoryUsageKB(&vmrss, &vmsize))
+            return std::to_string(vmsize) + "KB";
+        else
+            return "cannot read memory usage";
+    }
+    inline u32_t getCondNum()
+    {
+        return totalCondNum;
+    }
+    //@}
+
+    /// Condition operations
+    //@{
+    inline Condition condAnd(const Condition& lhs, const Condition& rhs)
+    {
+        return Condition::AND(lhs,rhs);
+    }
+    inline Condition condOr(const Condition& lhs, const Condition& rhs)
+    {
+        return Condition::OR(lhs,rhs);
+    }
+    inline Condition condNeg(const Condition& cond)
+    {
+        return Condition::NEG(cond);
+    }
+    inline Condition getTrueCond() const
+    {
+        return Condition::getTrueCond();
+    }
+    inline Condition getFalseCond() const
+    {
+        return Condition::getFalseCond();
+    }
+    /// Iterator every element of the condition
+    inline NodeBS exactCondElem(const Condition& cond)
+    {
+        NodeBS elems;
+        extractSubConds(cond, elems);
+        return elems;
+    }
+
+    inline std::string dumpCond(const Condition& cond) const
+    {
+        return Condition::dumpStr(cond);
+    }
+
+    /// Allocate a new condition
+    Condition newCond(const ICFGNode* inst);
+
+    /// Perform path allocation
+    void allocate();
+
+    /// Get/Set instruction based on Z3 expression id
+    //{@
+    inline const ICFGNode* getCondInst(u32_t id) const
+    {
+        IndexToTermInstMap::const_iterator it = idToTermInstMap.find(id);
+        assert(it != idToTermInstMap.end() && "this should be a fresh condition");
+        return it->second;
+    }
+
+    inline void setCondInst(const Condition &condition, const ICFGNode* inst)
+    {
+        assert(idToTermInstMap.find(condition.id()) == idToTermInstMap.end() && "this should be a fresh condition");
+        idToTermInstMap[condition.id()] = inst;
+    }
+    //@}
+
+    bool isNegCond(u32_t id) const
+    {
+        return negConds.test(id);
+    }
+
+    inline bool postDominate(const SVFBasicBlock* bbKey, const SVFBasicBlock* bbValue) const
+    {
+        const FunObjVar*  keyFunc = bbKey->getParent();
+        const FunObjVar*  valueFunc = bbValue->getParent();
+        bool funcEq = (keyFunc == valueFunc);
+        (void)funcEq; // Suppress warning of unused variable under release build
+        assert(funcEq && "two basicblocks should be in the same function!");
+        return keyFunc->postDominate(bbKey,bbValue);
+    }
+
+    inline bool dominate(const SVFBasicBlock* bbKey, const SVFBasicBlock* bbValue) const
+    {
+        const FunObjVar*  keyFunc = bbKey->getParent();
+        const FunObjVar*  valueFunc = bbValue->getParent();
+        bool funcEq = (keyFunc == valueFunc);
+        (void)funcEq; // Suppress warning of unused variable under release build
+        assert(funcEq && "two basicblocks should be in the same function!");
+        return keyFunc->dominate(bbKey,bbValue);
+    }
+
+    /// Guard Computation for a value-flow (between two basic blocks)
+    //@{
+    virtual Condition ComputeIntraVFGGuard(const SVFBasicBlock* src, const SVFBasicBlock* dst);
+    virtual Condition ComputeInterCallVFGGuard(const SVFBasicBlock* src, const SVFBasicBlock* dst, const SVFBasicBlock* callBB);
+    virtual Condition ComputeInterRetVFGGuard(const SVFBasicBlock* src, const SVFBasicBlock* dst, const SVFBasicBlock* retBB);
+
+    /// Get complement condition (from B1 to B0) according to a complementBB (BB2) at a phi
+    /// e.g., B0: dstBB; B1:incomingBB; B2:complementBB
+    virtual Condition getPHIComplementCond(const SVFBasicBlock* BB1, const SVFBasicBlock* BB2, const SVFBasicBlock* BB0);
+
+    inline void clearCFCond()
+    {
+        bbToCondMap.clear();
+    }
+    /// Set current value for branch condition evaluation
+    inline void setCurEvalSVFGNode(const SVFGNode* node)
+    {
+        curEvalSVFGNode = node;
+    }
+    /// Get current value for branch condition evaluation
+    inline const SVFGNode* getCurEvalSVFGNode() const
+    {
+        return curEvalSVFGNode;
+    }
+    //@}
+
+    /// Print out the path condition information
+    void printPathCond();
+
+    /// whether condition is satisfiable
+    bool isSatisfiable(const Condition& condition);
+
+    /// whether condition is satisfiable for all possible boolean guards
+    inline bool isAllPathReachable(Condition& condition)
+    {
+        return isEquivalentBranchCond(condition, Condition::getTrueCond());
+    }
+
+    /// Whether lhs and rhs are equivalent branch conditions
+    bool isEquivalentBranchCond(const Condition &lhs, const Condition &rhs) const;
+
+    inline ICFG* getICFG() const
+    {
+        return PAG::getPAG()->getICFG();
+    }
+
+    /// Get/Set control-flow conditions
+    //@{
+    inline bool setCFCond(const SVFBasicBlock* bb, const Condition& cond)
+    {
+        BBToCondMap::iterator it = bbToCondMap.find(bb);
+        // until a fixed-point is reached (condition is not changed)
+        if(it!=bbToCondMap.end() && isEquivalentBranchCond(it->second, cond))
+            return false;
+
+        bbToCondMap[bb] = cond;
+        return true;
+    }
+    inline Condition getCFCond(const SVFBasicBlock* bb) const
+    {
+        BBToCondMap::const_iterator it = bbToCondMap.find(bb);
+        if(it==bbToCondMap.end())
+        {
+            return getFalseCond();
+        }
+        return it->second;
+    }
+    //@}
+
+
+    /// mark neg Z3 expression
+    inline void setNegCondInst(const Condition &condition, const ICFGNode* inst)
+    {
+        setCondInst(condition, inst);
+        negConds.set(condition.id());
+    }
+
+    SVFGNodeToSVFGNodeSetMap & getRemovedSUVFEdges()
+    {
+        return removedSUVFEdges;
+    }
+
+private:
+
+    /// Allocate path condition for every basic block
+    virtual void allocateForBB(const SVFBasicBlock& bb);
+
+    /// Get/Set a branch condition, and its terminator instruction
+    //@{
+    /// Set branch condition
+    void setBranchCond(const SVFBasicBlock* bb, const SVFBasicBlock* succ, const Condition& cond);
+    /// Get branch condition
+    Condition getBranchCond(const SVFBasicBlock*  bb, const SVFBasicBlock* succ) const;
+    ///Get a condition, evaluate the value for conditions if necessary (e.g., testNull like express)
+    Condition getEvalBrCond(const SVFBasicBlock*  bb, const SVFBasicBlock* succ);
+    //@}
+    /// Evaluate branch conditions
+    //@{
+    /// Evaluate the branch condition
+    Condition evaluateBranchCond(const SVFBasicBlock*  bb, const SVFBasicBlock* succ) ;
+    /// Evaluate loop exit branch
+    Condition evaluateLoopExitBranch(const SVFBasicBlock*  bb, const SVFBasicBlock* succ);
+    /// Return branch condition after evaluating test null like expression
+    Condition evaluateTestNullLikeExpr(const BranchStmt* branchStmt, const SVFBasicBlock* succ);
+    /// Return condition when there is a branch calls program exit
+    Condition evaluateProgExit(const BranchStmt* branchStmt, const SVFBasicBlock* succ);
+    /// Collect basic block contains program exit function call
+    void collectBBCallingProgExit(const SVFBasicBlock& bb);
+    bool isBBCallsProgExit(const SVFBasicBlock* bb);
+    //@}
+
+    /// Evaluate test null/not null like expressions
+    //@{
+    /// Return true if the predicate of this compare instruction is equal
+    bool isEQCmp(const CmpStmt* cmp) const;
+    /// Return true if the predicate of this compare instruction is not equal
+    bool isNECmp(const CmpStmt* cmp) const;
+    /// Return true if this is a test null expression
+    bool isTestNullExpr(const ICFGNode* test) const;
+    /// Return true if this is a test not null expression
+    bool isTestNotNullExpr(const ICFGNode* test) const;
+    /// Return true if two values on the predicate are what we want
+    bool isTestContainsNullAndTheValue(const CmpStmt* cmp) const;
+    //@}
+
+    /// Release memory
+    void destroy()
+    {
+
+    }
+
+    /// extract subexpression from a Z3 expression
+    void extractSubConds(const Condition &condition, NodeBS &support) const;
+
+
+    FunToExitBBsMap funToExitBBsMap;		///< map a function to all its basic blocks calling program exit
+    BBToCondMap bbToCondMap;				///< map a basic block to its path condition starting from root
+    const SVFGNode* curEvalSVFGNode{};			///< current llvm value to evaluate branch condition when computing guards
+    IndexToTermInstMap idToTermInstMap;     ///key: z3 expression id, value: instruction
+    NodeBS negConds;                        ///bit vector for distinguish neg
+    std::vector<Condition> conditionVec;          /// vector storing z3expression
+    static u32_t totalCondNum; /// a counter for fresh condition
+    SVFGNodeToSVFGNodeSetMap removedSUVFEdges;
+
+protected:
+    BBCondMap bbConds;						///< map basic block to its successors/predecessors branch conditions
+
+};
+
+} // End namespace SVF
+
+#endif /* PATHALLOCATOR_H_ */

package/SVF-osx/Release-build/include/SVF/SABER/SaberSVFGBuilder.h

@@ -0,0 +1,114 @@
+//===- SaberSVFGBuilder.h -- Building SVFG for Saber--------------------------//
+//
+//                     SVF: Static Value-Flow Analysis
+//
+// Copyright (C) <2013->  <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/>.
+//
+//===----------------------------------------------------------------------===//
+
+/*
+ * SaberSVFGBuilder.h
+ *
+ *  Created on: May 1, 2014
+ *      Author: Yulei Sui
+ */
+
+#ifndef SABERSVFGBUILDER_H_
+#define SABERSVFGBUILDER_H_
+
+#include "MSSA/SVFGBuilder.h"
+#include "SVFIR/SVFValue.h"
+#include "Util/WorkList.h"
+
+
+namespace SVF
+{
+
+class SaberCondAllocator;
+
+class SaberSVFGBuilder : public SVFGBuilder
+{
+
+public:
+    typedef Set<const SVFGNode*> SVFGNodeSet;
+    typedef Map<NodeID, PointsTo> NodeToPTSSMap;
+    typedef FIFOWorkList<NodeID> WorkList;
+
+    /// Constructor
+    SaberSVFGBuilder(): SVFGBuilder(true) {}
+
+    /// Destructor
+    virtual ~SaberSVFGBuilder() {}
+
+    inline bool isGlobalSVFGNode(const SVFGNode* node) const
+    {
+        return globSVFGNodes.find(node)!=globSVFGNodes.end();
+    }
+
+    /// Add ActualParmVFGNode
+    inline void addActualParmVFGNode(const PAGNode* pagNode, const CallICFGNode* cs)
+    {
+        svfg->addActualParmVFGNode(pagNode, cs);
+    }
+
+    void setSaberCondAllocator(SaberCondAllocator* allocator)
+    {
+        saberCondAllocator = allocator;
+    }
+
+protected:
+    /// Re-write create SVFG method
+    virtual void buildSVFG();
+
+    /// Return TRUE if this is a strong update STORE statement.
+    bool isStrongUpdate(const SVFGNode* node, NodeID& singleton, BVDataPTAImpl* pta);
+
+protected:
+    /// Remove direct value-flow edge to a dereference point for Saber source-sink memory error detection
+    /// for example, given two statements: p = alloc; q = *p, the direct SVFG edge between them is deleted
+    /// Because those edges only stand for values used at the dereference points but they can not pass the value to other definitions
+    void rmDerefDirSVFGEdges(BVDataPTAImpl* pta);
+
+    /// Remove Incoming Edge for strong-update (SU) store instruction
+    /// Because the SU node does not receive indirect value
+    virtual void rmIncomingEdgeForSUStore(BVDataPTAImpl* pta);
+
+    /// Add actual parameter SVFGNode for 1st argument of a deallocation like external function
+    /// In order to path sensitive leak detection
+    virtual void AddExtActualParmSVFGNodes(CallGraph* callgraph);
+
+    /// Collect memory pointed global pointers,
+    /// note that this collection is recursively performed, for example gp-->obj-->obj'
+    /// obj and obj' are both considered global memory
+    void collectGlobals(BVDataPTAImpl* pta);
+
+    /// Whether points-to of a PAGNode points-to global variable
+    bool accessGlobal(BVDataPTAImpl* pta,const PAGNode* pagNode);
+
+    /// Collect objects along points-to chains
+    PointsTo& CollectPtsChain(BVDataPTAImpl* pta,NodeID id, NodeToPTSSMap& cachedPtsMap);
+
+    PointsTo globs;
+    /// Store all global SVFG nodes
+    SVFGNodeSet globSVFGNodes;
+
+    SaberCondAllocator* saberCondAllocator;
+};
+
+} // End namespace SVF
+
+#endif /* SABERSVFGBUILDER_H_ */