svf-lib 1.0.2319 → 1.0.2321

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

@@ -0,0 +1,434 @@
+//===- Andersen.h -- Field-sensitive Andersen's pointer analysis-------------//
+//
+//                     SVF: Static Value-Flow Analysis
+//
+// Copyright (C) <2013-2017>  <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/>.
+//
+//===----------------------------------------------------------------------===//
+
+/*
+ * Andersen.h
+ *
+ *  Created on: Nov 12, 2013
+ *      Author: Yulei Sui
+ *
+ * The field-sensitive implementation is improved based on
+ *
+ * Yuxiang Lei and Yulei Sui. "Fast and Precise Handling of Positive Weight Cycles for Field-sensitive Pointer Analysis".
+ * 26th International Static Analysis Symposium (SAS'19)
+ */
+
+#ifndef INCLUDE_WPA_ANDERSEN_H_
+#define INCLUDE_WPA_ANDERSEN_H_
+
+#include "MemoryModel/PointerAnalysisImpl.h"
+#include "WPA/WPAStat.h"
+#include "WPA/WPASolver.h"
+#include "SVFIR/SVFIR.h"
+#include "Graphs/ConsG.h"
+#include "Util/Options.h"
+
+namespace SVF
+{
+
+
+class ThreadCallGraph;
+
+/*!
+ * Abstract class of inclusion-based Pointer Analysis
+ */
+typedef WPASolver<ConstraintGraph*> WPAConstraintSolver;
+
+class AndersenBase:  public WPAConstraintSolver, public BVDataPTAImpl
+{
+public:
+    typedef OrderedMap<const CallICFGNode*, NodeID> CallSite2DummyValPN;
+
+public:
+
+    /// Constructor
+    AndersenBase(SVFIR* _pag, PTATY type = Andersen_BASE, bool alias_check = true)
+        :  BVDataPTAImpl(_pag, type, alias_check), consCG(nullptr)
+    {
+        iterationForPrintStat = OnTheFlyIterBudgetForStat;
+    }
+
+    /// Destructor
+    ~AndersenBase() override;
+
+    /// Andersen analysis
+    virtual void analyze() override;
+
+    virtual void solveAndwritePtsToFile(const std::string& filename);
+
+    virtual void readPtsFromFile(const std::string& filename);
+
+    virtual void solveConstraints();
+
+    /// Initialize analysis
+    virtual void initialize() override;
+
+    /// Finalize analysis
+    virtual void finalize() override;
+
+    /// Update call graph
+    virtual bool updateCallGraph(const CallSiteToFunPtrMap&) override;
+
+    /// Update thread call graph
+    virtual bool updateThreadCallGraph(const CallSiteToFunPtrMap&, NodePairSet&);
+
+    /// Connect formal and actual parameters for indirect forksites
+    virtual void connectCaller2ForkedFunParams(const CallICFGNode* cs, const FunObjVar* F,
+            NodePairSet& cpySrcNodes);
+
+    /// Connect formal and actual parameters for indirect callsites
+    virtual void connectCaller2CalleeParams(const CallICFGNode* cs, const FunObjVar* F,
+                                            NodePairSet& cpySrcNodes);
+
+    /// Methods for support type inquiry through isa, cast, and dyn_cast:
+    //@{
+    static inline bool classof(const AndersenBase *)
+    {
+        return true;
+    }
+    static inline bool classof(const PointerAnalysis *pta)
+    {
+        return ( pta->getAnalysisTy() == Andersen_BASE
+                 || pta->getAnalysisTy() == Andersen_WPA
+                 || pta->getAnalysisTy() == AndersenWaveDiff_WPA
+                 || pta->getAnalysisTy() == AndersenSCD_WPA
+                 || pta->getAnalysisTy() == AndersenSFR_WPA
+                 || pta->getAnalysisTy() == TypeCPP_WPA
+                 || pta->getAnalysisTy() == Steensgaard_WPA);
+    }
+    //@}
+
+    /// Get constraint graph
+    ConstraintGraph* getConstraintGraph()
+    {
+        return consCG;
+    }
+
+    /// SCC methods
+    //@{
+    inline NodeID sccRepNode(NodeID id) const override
+    {
+        return consCG->sccRepNode(id);
+    }
+    inline NodeBS& sccSubNodes(NodeID repId)
+    {
+        return consCG->sccSubNodes(repId);
+    }
+    //@}
+
+    /// Add copy edge on constraint graph
+    virtual bool addCopyEdge(NodeID src, NodeID dst) = 0;
+
+    /// dump statistics
+    inline void printStat()
+    {
+        PointerAnalysis::dumpStat();
+    }
+
+    virtual void normalizePointsTo() override;
+
+    /// remove redundant gepnodes in constraint graph
+    void cleanConsCG(NodeID id);
+
+    NodeBS redundantGepNodes;
+
+    /// Statistics
+    //@{
+    static u32_t numOfProcessedAddr;   /// Number of processed Addr edge
+    static u32_t numOfProcessedCopy;   /// Number of processed Copy edge
+    static u32_t numOfProcessedGep;    /// Number of processed Gep edge
+    static u32_t numOfProcessedLoad;   /// Number of processed Load edge
+    static u32_t numOfProcessedStore;  /// Number of processed Store edge
+    static u32_t numOfSfrs;
+    static u32_t numOfFieldExpand;
+
+    static u32_t numOfSCCDetection;
+    static double timeOfSCCDetection;
+    static double timeOfSCCMerges;
+    static double timeOfCollapse;
+    static u32_t AveragePointsToSetSize;
+    static u32_t MaxPointsToSetSize;
+    static double timeOfProcessCopyGep;
+    static double timeOfProcessLoadStore;
+    static double timeOfUpdateCallGraph;
+    //@}
+
+protected:
+    /// Constraint Graph
+    ConstraintGraph* consCG;
+    CallSite2DummyValPN
+    callsite2DummyValPN; ///< Map an instruction to a dummy obj which
+    ///< created at an indirect callsite, which invokes
+    ///< a heap allocator
+    void heapAllocatorViaIndCall(const CallICFGNode* cs, NodePairSet& cpySrcNodes);
+};
+
+/*!
+ * Inclusion-based Pointer Analysis
+ */
+class Andersen:  public AndersenBase
+{
+
+
+public:
+    typedef SCCDetection<ConstraintGraph*> CGSCC;
+
+    /// Constructor
+    Andersen(SVFIR* _pag, PTATY type = Andersen_WPA, bool alias_check = true)
+        :  AndersenBase(_pag, type, alias_check)
+    {
+    }
+
+    /// Destructor
+    virtual ~Andersen()
+    {
+
+    }
+
+    /// Initialize analysis
+    virtual void initialize();
+
+    /// Finalize analysis
+    virtual void finalize();
+
+    /// Reset data
+    inline void resetData()
+    {
+        AveragePointsToSetSize = 0;
+        MaxPointsToSetSize = 0;
+        timeOfProcessCopyGep = 0;
+        timeOfProcessLoadStore = 0;
+    }
+
+    /// Methods for support type inquiry through isa, cast, and dyn_cast:
+    //@{
+    static inline bool classof(const Andersen *)
+    {
+        return true;
+    }
+    static inline bool classof(const PointerAnalysis *pta)
+    {
+        return (pta->getAnalysisTy() == Andersen_WPA
+                || pta->getAnalysisTy() == AndersenWaveDiff_WPA
+                || pta->getAnalysisTy() == AndersenSCD_WPA
+                || pta->getAnalysisTy() == AndersenSFR_WPA);
+    }
+    //@}
+
+    /// Operation of points-to set
+    virtual inline const PointsTo& getPts(NodeID id)
+    {
+        return getPTDataTy()->getPts(sccRepNode(id));
+    }
+    virtual inline bool unionPts(NodeID id, const PointsTo& target)
+    {
+        id = sccRepNode(id);
+        return getPTDataTy()->unionPts(id, target);
+    }
+    virtual inline bool unionPts(NodeID id, NodeID ptd)
+    {
+        id = sccRepNode(id);
+        ptd = sccRepNode(ptd);
+        return getPTDataTy()->unionPts(id,ptd);
+    }
+
+
+    void dumpTopLevelPtsTo();
+
+    void setDetectPWC(bool flag)
+    {
+        Options::DetectPWC.setValue(flag);
+    }
+
+protected:
+
+    CallSite2DummyValPN callsite2DummyValPN;        ///< Map an instruction to a dummy obj which created at an indirect callsite, which invokes a heap allocator
+
+    /// Handle diff points-to set.
+    virtual inline void computeDiffPts(NodeID id)
+    {
+        if (Options::DiffPts())
+        {
+            NodeID rep = sccRepNode(id);
+            getDiffPTDataTy()->computeDiffPts(rep, getDiffPTDataTy()->getPts(rep));
+        }
+    }
+    virtual inline const PointsTo& getDiffPts(NodeID id)
+    {
+        NodeID rep = sccRepNode(id);
+        if (Options::DiffPts())
+            return getDiffPTDataTy()->getDiffPts(rep);
+        else
+            return getPTDataTy()->getPts(rep);
+    }
+
+    /// Handle propagated points-to set.
+    inline void updatePropaPts(NodeID dstId, NodeID srcId)
+    {
+        if (!Options::DiffPts())
+            return;
+        NodeID srcRep = sccRepNode(srcId);
+        NodeID dstRep = sccRepNode(dstId);
+        getDiffPTDataTy()->updatePropaPtsMap(srcRep, dstRep);
+    }
+    inline void clearPropaPts(NodeID src)
+    {
+        if (Options::DiffPts())
+        {
+            NodeID rep = sccRepNode(src);
+            getDiffPTDataTy()->clearPropaPts(rep);
+        }
+    }
+
+    virtual void initWorklist() {}
+
+    /// Override WPASolver function in order to use the default solver
+    virtual void processNode(NodeID nodeId);
+
+    /// handling various constraints
+    //@{
+    void processAllAddr();
+
+    virtual bool processLoad(NodeID node, const ConstraintEdge* load);
+    virtual bool processStore(NodeID node, const ConstraintEdge* load);
+    virtual bool processCopy(NodeID node, const ConstraintEdge* edge);
+    virtual bool processGep(NodeID node, const GepCGEdge* edge);
+    virtual void handleCopyGep(ConstraintNode* node);
+    virtual void handleLoadStore(ConstraintNode* node);
+    virtual void processAddr(const AddrCGEdge* addr);
+    virtual bool processGepPts(const PointsTo& pts, const GepCGEdge* edge);
+    //@}
+
+    /// Add copy edge on constraint graph
+    virtual inline bool addCopyEdge(NodeID src, NodeID dst)
+    {
+        if (consCG->addCopyCGEdge(src, dst))
+        {
+            updatePropaPts(src, dst);
+            return true;
+        }
+        return false;
+    }
+
+    /// Merge sub node to its rep
+    virtual void mergeNodeToRep(NodeID nodeId,NodeID newRepId);
+
+    virtual bool mergeSrcToTgt(NodeID srcId,NodeID tgtId);
+
+    /// Merge sub node in a SCC cycle to their rep node
+    //@{
+    void mergeSccNodes(NodeID repNodeId, const NodeBS& subNodes);
+    void mergeSccCycle();
+    //@}
+    /// Collapse a field object into its base for field insensitive analysis
+    //@{
+    virtual void collapsePWCNode(NodeID nodeId);
+    void collapseFields();
+    bool collapseNodePts(NodeID nodeId);
+    bool collapseField(NodeID nodeId);
+    //@}
+
+    /// Updates subnodes of its rep, and rep node of its subs
+    void updateNodeRepAndSubs(NodeID nodeId,NodeID newRepId);
+
+    /// SCC detection
+    virtual NodeStack& SCCDetect();
+
+
+
+    /// Sanitize pts for field insensitive objects
+    void sanitizePts()
+    {
+        for(ConstraintGraph::iterator it = consCG->begin(), eit = consCG->end(); it!=eit; ++it)
+        {
+            const PointsTo& pts = getPts(it->first);
+            NodeBS fldInsenObjs;
+
+            for (NodeID o : pts)
+            {
+                if(isFieldInsensitive(o))
+                    fldInsenObjs.set(o);
+            }
+
+            for (NodeID o : fldInsenObjs)
+            {
+                const NodeBS &allFields = consCG->getAllFieldsObjVars(o);
+                for (NodeID f : allFields) addPts(it->first, f);
+            }
+        }
+    }
+
+    /// Get PTA name
+    virtual const std::string PTAName() const
+    {
+        return "AndersenWPA";
+    }
+
+    /// Runs a Steensgaard analysis and performs clustering based on those
+    /// results set the global best mapping.
+    virtual void cluster(void) const;
+};
+
+
+
+/**
+ * Wave propagation with diff points-to set.
+ */
+class AndersenWaveDiff : public Andersen
+{
+
+private:
+
+    static AndersenWaveDiff* diffWave; // static instance
+
+public:
+    AndersenWaveDiff(SVFIR* _pag, PTATY type = AndersenWaveDiff_WPA, bool alias_check = true): Andersen(_pag, type, alias_check) {}
+
+    /// Create an singleton instance directly instead of invoking llvm pass manager
+    static AndersenWaveDiff* createAndersenWaveDiff(SVFIR* _pag)
+    {
+        if(diffWave==nullptr)
+        {
+            diffWave = new AndersenWaveDiff(_pag, AndersenWaveDiff_WPA, false);
+            diffWave->analyze();
+            return diffWave;
+        }
+        return diffWave;
+    }
+    static void releaseAndersenWaveDiff()
+    {
+        if (diffWave)
+            delete diffWave;
+        diffWave = nullptr;
+    }
+
+    virtual void initialize();
+    virtual void solveWorklist();
+    virtual void processNode(NodeID nodeId);
+    virtual void postProcessNode(NodeID nodeId);
+    virtual bool handleLoad(NodeID id, const ConstraintEdge* load);
+    virtual bool handleStore(NodeID id, const ConstraintEdge* store);
+};
+
+} // End namespace SVF
+
+#endif /* INCLUDE_WPA_ANDERSEN_H_ */

package/SVF-osx/Release-build/include/SVF/WPA/AndersenPWC.h

@@ -0,0 +1,160 @@
+//===- AndersenSFR.h -- SFR based field-sensitive Andersen's analysis-------------//
+//
+//                     SVF: Static Value-Flow Analysis
+//
+// Copyright (C) <2013-2017>  <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/>.
+//
+//===----------------------------------------------------------------------===//
+
+/*
+ * AndersenSFR.h
+ *
+ *  Created on: 09, Feb, 2019
+ *      Author: Yuxiang Lei
+ */
+
+#ifndef PROJECT_ANDERSENSFR_H
+#define PROJECT_ANDERSENSFR_H
+
+
+#include "WPA/Andersen.h"
+#include "WPA/CSC.h"
+#include "MemoryModel/PointsTo.h"
+
+namespace SVF
+{
+
+/*!
+ * Selective Cycle Detection Based Andersen Analysis
+ */
+class AndersenSCD : public Andersen
+{
+public:
+    typedef Map<NodeID, NodeID> NodeToNodeMap;
+
+protected:
+    static AndersenSCD* scdAndersen;
+    NodeSet sccCandidates;
+    NodeToNodeMap pwcReps;
+
+public:
+    AndersenSCD(SVFIR* _pag, PTATY type = AndersenSCD_WPA) :
+        Andersen(_pag,type)
+    {
+    }
+
+    /// Create an singleton instance directly instead of invoking llvm pass manager
+    static AndersenSCD *createAndersenSCD(SVFIR* _pag)
+    {
+        if (scdAndersen == nullptr)
+        {
+            scdAndersen = new AndersenSCD(_pag);
+            scdAndersen->analyze();
+            return scdAndersen;
+        }
+        return scdAndersen;
+    }
+
+    static void releaseAndersenSCD()
+    {
+        if (scdAndersen)
+            delete scdAndersen;
+        scdAndersen = nullptr;
+    }
+
+protected:
+    inline void addSccCandidate(NodeID nodeId)
+    {
+        sccCandidates.insert(sccRepNode(nodeId));
+    }
+
+    virtual NodeStack& SCCDetect();
+    virtual void PWCDetect();
+    virtual void solveWorklist();
+    virtual void handleLoadStore(ConstraintNode* node);
+    virtual void processAddr(const AddrCGEdge* addr);
+    virtual bool addCopyEdge(NodeID src, NodeID dst);
+    virtual bool updateCallGraph(const CallSiteToFunPtrMap& callsites);
+    virtual void processPWC(ConstraintNode* rep);
+    virtual void handleCopyGep(ConstraintNode* node);
+
+};
+
+
+
+/*!
+ * Selective Cycle Detection with Stride-based Field Representation
+ */
+class AndersenSFR : public AndersenSCD
+{
+public:
+    typedef Map<NodeID, NodeBS> NodeStrides;
+    typedef Map<NodeID, NodeSet> FieldReps;
+    typedef Map<NodeID, std::pair<NodeID, NodeSet>> SFRTrait;
+
+private:
+    static AndersenSFR* sfrAndersen;
+
+    CSC* csc;
+    NodeSet sfrObjNodes;
+    FieldReps fieldReps;
+
+public:
+    AndersenSFR(SVFIR* _pag, PTATY type = AndersenSFR_WPA) :
+        AndersenSCD(_pag, type), csc(nullptr)
+    {
+    }
+
+    /// Create an singleton instance directly instead of invoking llvm pass manager
+    static AndersenSFR *createAndersenSFR(SVFIR* _pag)
+    {
+        if (sfrAndersen == nullptr)
+        {
+            sfrAndersen = new AndersenSFR(_pag);
+            sfrAndersen->analyze();
+            return sfrAndersen;
+        }
+        return sfrAndersen;
+    }
+
+    static void releaseAndersenSFR()
+    {
+        if (sfrAndersen)
+            delete sfrAndersen;
+    }
+
+    ~AndersenSFR()
+    {
+        if (csc != nullptr)
+        {
+            delete(csc);
+            csc = nullptr;
+        }
+    }
+
+protected:
+    void initialize();
+    void PWCDetect();
+    void fieldExpand(NodeSet& initials, APOffset offset, NodeBS& strides, PointsTo& expandPts);
+    bool processGepPts(const PointsTo& pts, const GepCGEdge* edge);
+    bool mergeSrcToTgt(NodeID nodeId, NodeID newRepId);
+
+};
+
+} // End namespace SVF
+
+#endif //PROJECT_ANDERSENSFR_H

package/SVF-osx/Release-build/include/SVF/WPA/CSC.h

@@ -0,0 +1,95 @@
+//===- CSC.h -- Cycle Stride Calculation algorithm---------------------------------------//
+//
+//                     SVF: Static Value-Flow Analysis
+//
+// Copyright (C) <2013-2017>  <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/>.
+//
+//===----------------------------------------------------------------------===//
+
+/*
+ * CSC.h
+ *
+ *  Created on: 09, Feb, 2019
+ *      Author: Yuxiang Lei
+ */
+
+#ifndef PROJECT_CSC_H
+#define PROJECT_CSC_H
+
+#include "Graphs/ConsG.h"
+#include "Graphs/SCC.h"
+#include "SVFIR/SVFValue.h" // for NodeBS
+#include "Util/WorkList.h"
+#include <limits.h>
+#include <map>
+#include <stack>
+
+namespace SVF
+{
+
+typedef SCCDetection<ConstraintGraph *> CGSCC;
+
+/*!
+ * class CSC: cycle stride calculation
+ */
+class CSC
+{
+public:
+    typedef Map<NodeID, NodeID> IdToIdMap;
+    typedef FILOWorkList<NodeID> WorkStack;
+    typedef typename IdToIdMap::iterator iterator;
+
+private:
+    ConstraintGraph* _consG;
+    CGSCC* _scc;
+
+    NodeID _I;
+    IdToIdMap _D;       // the sum of weight of a path relevant to a certain node, while accessing the node via DFS
+    NodeStack _S;       // a stack holding a DFS branch
+    NodeSet _visited;   // a set holding visited nodes
+//    NodeStrides nodeStrides;
+//    IdToIdMap pwcReps;
+
+public:
+    CSC(ConstraintGraph* g, CGSCC* c)
+        : _consG(g), _scc(c), _I(0) {}
+
+    void find(NodeStack& candidates);
+    void visit(NodeID nodeId, s32_t _w);
+    void clear();
+
+    bool isVisited(NodeID nId)
+    {
+        return _visited.find(nId) != _visited.end();
+    }
+
+    void setVisited(NodeID nId)
+    {
+        _visited.insert(nId);
+    }
+//    inline iterator begin() { return pwcReps.begin(); }
+//
+//    inline iterator end() { return pwcReps.end(); }
+
+//    NodeStrides &getNodeStrides() { return nodeStrides; }
+
+//    const NodeSet& getPWCReps() const { return  _pwcReps; }
+};
+
+} // End namespace SVF
+
+#endif //PROJECT_CSC_H