svf-lib 1.0.1376 → 1.0.1377

package/SVF-linux/svf/include/include/MSSA/MemSSA.h

@@ -1,452 +0,0 @@
-//===- MemSSA.h -- Memory SSA-------------------------------------------------//
-//
-//                     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 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/>.
-//
-//===----------------------------------------------------------------------===//
-
-/*
- * MemorySSAPass.h
- *
- *  Created on: Jul 14, 2013
- *      Author: Yulei Sui
- *
- * The implementation is based on
- * Yulei Sui, Hua Yan, Yunpeng Zhang, Jingling Xue and Zheng Zheng.
- * "Parallel Construction of Interprocedural Memory SSA Form".
- * Journal of Systems and Software (JSS'16), Algorithm 3 in the paper
- */
-
-
-#ifndef MEMORYSSAPASS_H_
-#define MEMORYSSAPASS_H_
-
-#include "MSSA/MemRegion.h"
-#include "MSSA/MSSAMuChi.h"
-
-#include <vector>
-
-namespace SVF
-{
-
-class PointerAnalysis;
-class MemSSAStat;
-/*
- * Memory SSA implementation on top of partial SSA
- */
-class MemSSA
-{
-
-public:
-
-    /// define condition here changes needed if we add new type
-    typedef MemRegion::Condition Condition;
-    typedef MSSAMU<Condition> MU;
-    typedef RetMU<Condition> RETMU;
-    typedef LoadMU<Condition> LOADMU;
-    typedef CallMU<Condition> CALLMU;
-    typedef MSSACHI<Condition> CHI;
-    typedef EntryCHI<Condition> ENTRYCHI;
-    typedef StoreCHI<Condition> STORECHI;
-    typedef CallCHI<Condition> CALLCHI;
-    typedef MSSAPHI<Condition> PHI;
-    typedef MSSADEF MDEF;
-
-    typedef Set<MU*> MUSet;
-    typedef Set<CHI*> CHISet;
-    typedef Set<PHI*> PHISet;
-
-    ///Define mem region set
-    typedef MRGenerator::MRSet MRSet;
-    typedef std::vector<const MemRegion*> MRVector;
-    /// Map loads/stores to its mem regions,
-    /// TODO:visitAtomicCmpXchgInst, visitAtomicRMWInst??
-    //@{
-    typedef Map<const LoadStmt*, MUSet> LoadToMUSetMap;
-    typedef Map<const StoreStmt*, CHISet> StoreToChiSetMap;
-    typedef Map<const CallICFGNode*, MUSet> CallSiteToMUSetMap;
-    typedef Map<const CallICFGNode*, CHISet> CallSiteToCHISetMap;
-    typedef OrderedMap<const SVFBasicBlock*, PHISet> BBToPhiSetMap;
-    //@}
-
-    /// Map from fun to its entry chi set and return mu set
-    typedef Map<const SVFFunction*, CHISet> FunToEntryChiSetMap;
-    typedef Map<const SVFFunction*, MUSet> FunToReturnMuSetMap;
-
-    /// For phi insertion
-    //@{
-    typedef std::vector<const SVFBasicBlock*> BBList;
-    typedef Map<const SVFBasicBlock*, MRSet> BBToMRSetMap;
-    typedef Map<const MemRegion*, BBList> MemRegToBBsMap;
-    //@}
-
-    /// For SSA renaming
-    typedef Map<const MemRegion*, std::vector<MRVer*> > MemRegToVerStackMap;
-    typedef Map<const MemRegion*, MRVERSION> MemRegToCounterMap;
-
-    /// SVFIR edge list
-    typedef SVFIR::SVFStmtList SVFStmtList;
-
-    /// Statistics
-    //@{
-    static double timeOfGeneratingMemRegions;	///< Time for allocating regions
-    static double timeOfCreateMUCHI;	///< Time for generating mu/chi for load/store/calls
-    static double timeOfInsertingPHI;	///< Time for inserting phis
-    static double timeOfSSARenaming;	///< Time for SSA rename
-    //@}
-
-    enum MemPartition
-    {
-        Distinct,
-        IntraDisjoint,
-        InterDisjoint
-    };
-
-protected:
-    BVDataPTAImpl* pta;
-    MRGenerator* mrGen;
-    MemSSAStat* stat;
-
-    /// Create mu chi for candidate regions in a function
-    virtual void createMUCHI(const SVFFunction& fun);
-    /// Insert phi for candidate regions in a fucntion
-    virtual void insertPHI(const SVFFunction& fun);
-    /// SSA rename for a function
-    virtual void SSARename(const SVFFunction& fun);
-    /// SSA rename for a basic block
-    virtual void SSARenameBB(const SVFBasicBlock& bb);
-private:
-    LoadToMUSetMap load2MuSetMap;
-    StoreToChiSetMap store2ChiSetMap;
-    CallSiteToMUSetMap callsiteToMuSetMap;
-    CallSiteToCHISetMap callsiteToChiSetMap;
-    BBToPhiSetMap bb2PhiSetMap;
-
-    FunToEntryChiSetMap funToEntryChiSetMap;
-    FunToReturnMuSetMap funToReturnMuSetMap;
-
-    MemRegToVerStackMap mr2VerStackMap;
-    MemRegToCounterMap mr2CounterMap;
-
-    /// The following three set are used for prune SSA phi insertion
-    // (see algorithm in book Engineering A Compiler section 9.3)
-    ///@{
-    /// Collects used memory regions
-    MRSet usedRegs;
-    /// Maps memory region to its basic block
-    MemRegToBBsMap reg2BBMap;
-    /// Collect memory regions whose definition killed
-    MRSet varKills;
-    //@}
-
-    std::vector<std::unique_ptr<MRVer>> usedMRVers;
-
-    /// Release the memory
-    void destroy();
-
-    /// Get a new SSA name of a memory region
-    MRVer* newSSAName(const MemRegion* mr, MSSADEF* def);
-
-    /// Get the last version of the SSA ver of memory region
-    inline MRVer* getTopStackVer(const MemRegion* mr)
-    {
-        std::vector<MRVer*> &stack = mr2VerStackMap[mr];
-        assert(!stack.empty() && "stack is empty!!");
-        return stack.back();
-    }
-
-    /// Collect region uses and region defs according to mus/chis, in order to insert phis
-    //@{
-    inline void collectRegUses(const MemRegion* mr)
-    {
-        if (0 == varKills.count(mr))
-            usedRegs.insert(mr);
-    }
-    inline void collectRegDefs(const SVFBasicBlock* bb, const MemRegion* mr)
-    {
-        varKills.insert(mr);
-        reg2BBMap[mr].push_back(bb);
-    }
-    //@}
-
-    /// Add methods for mus/chis/phis
-    //@{
-    inline void AddLoadMU(const SVFBasicBlock* bb, const LoadStmt* load, const MRSet& mrSet)
-    {
-        for (MRSet::iterator iter = mrSet.begin(), eiter = mrSet.end(); iter != eiter; ++iter)
-            AddLoadMU(bb,load,*iter);
-    }
-    inline void AddStoreCHI(const SVFBasicBlock* bb, const StoreStmt* store, const MRSet& mrSet)
-    {
-        for (MRSet::iterator iter = mrSet.begin(), eiter = mrSet.end(); iter != eiter; ++iter)
-            AddStoreCHI(bb,store,*iter);
-    }
-    inline void AddCallSiteMU(const CallICFGNode* cs,  const MRSet& mrSet)
-    {
-        for (MRSet::iterator iter = mrSet.begin(), eiter = mrSet.end(); iter != eiter; ++iter)
-            AddCallSiteMU(cs,*iter);
-    }
-    inline void AddCallSiteCHI(const CallICFGNode* cs,  const MRSet& mrSet)
-    {
-        for (MRSet::iterator iter = mrSet.begin(), eiter = mrSet.end(); iter != eiter; ++iter)
-            AddCallSiteCHI(cs,*iter);
-    }
-    inline void AddMSSAPHI(const SVFBasicBlock* bb, const MRSet& mrSet)
-    {
-        for (MRSet::iterator iter = mrSet.begin(), eiter = mrSet.end(); iter != eiter; ++iter)
-            AddMSSAPHI(bb,*iter);
-    }
-    inline void AddLoadMU(const SVFBasicBlock* bb, const LoadStmt* load, const MemRegion* mr)
-    {
-        LOADMU* mu = new LOADMU(bb,load, mr);
-        load2MuSetMap[load].insert(mu);
-        collectRegUses(mr);
-    }
-    inline void AddStoreCHI(const SVFBasicBlock* bb, const StoreStmt* store, const MemRegion* mr)
-    {
-        STORECHI* chi = new STORECHI(bb,store, mr);
-        store2ChiSetMap[store].insert(chi);
-        collectRegUses(mr);
-        collectRegDefs(bb,mr);
-    }
-    inline void AddCallSiteMU(const CallICFGNode* cs, const MemRegion* mr)
-    {
-        CALLMU* mu = new CALLMU(cs, mr);
-        callsiteToMuSetMap[cs].insert(mu);
-        collectRegUses(mr);
-    }
-    inline void AddCallSiteCHI(const CallICFGNode* cs, const MemRegion* mr)
-    {
-        CALLCHI* chi = new CALLCHI(cs, mr);
-        callsiteToChiSetMap[cs].insert(chi);
-        collectRegUses(mr);
-        collectRegDefs(chi->getBasicBlock(),mr);
-    }
-    inline void AddMSSAPHI(const SVFBasicBlock* bb, const MemRegion* mr)
-    {
-        bb2PhiSetMap[bb].insert(new PHI(bb, mr));
-    }
-    //@}
-
-    /// Rename mus, chis and phis
-    //@{
-    /// Rename mu set
-    inline void RenameMuSet(const MUSet& muSet)
-    {
-        for (MUSet::const_iterator mit = muSet.begin(), emit = muSet.end();
-                mit != emit; ++mit)
-        {
-            MU* mu = (*mit);
-            mu->setVer(getTopStackVer(mu->getMR()));
-        }
-    }
-
-    /// Rename chi set
-    inline void RenameChiSet(const CHISet& chiSet, MRVector& memRegs)
-    {
-        for (CHISet::const_iterator cit = chiSet.begin(), ecit = chiSet.end();
-                cit != ecit; ++cit)
-        {
-            CHI* chi = (*cit);
-            chi->setOpVer(getTopStackVer(chi->getMR()));
-            chi->setResVer(newSSAName(chi->getMR(),chi));
-            memRegs.push_back(chi->getMR());
-        }
-    }
-
-    /// Rename result (LHS) of phis
-    inline void RenamePhiRes(const PHISet& phiSet, MRVector& memRegs)
-    {
-        for (PHISet::const_iterator iter = phiSet.begin(), eiter = phiSet.end();
-                iter != eiter; ++iter)
-        {
-            PHI* phi = *iter;
-            phi->setResVer(newSSAName(phi->getMR(),phi));
-            memRegs.push_back(phi->getMR());
-        }
-    }
-
-    /// Rename operands (RHS) of phis
-    inline void RenamePhiOps(const PHISet& phiSet, u32_t pos, MRVector&)
-    {
-        for (PHISet::const_iterator iter = phiSet.begin(), eiter = phiSet.end();
-                iter != eiter; ++iter)
-        {
-            PHI* phi = *iter;
-            phi->setOpVer(getTopStackVer(phi->getMR()), pos);
-        }
-    }
-    //@}
-
-public:
-    /// Constructor
-    MemSSA(BVDataPTAImpl* p, bool ptrOnlyMSSA);
-
-    /// Destructor
-    virtual ~MemSSA()
-    {
-        destroy();
-    }
-    /// Return SVFIR
-    inline SVFIR* getPAG();
-    /// Return PTA
-    inline BVDataPTAImpl* getPTA() const
-    {
-        return pta;
-    }
-    /// Return MRGenerator
-    inline MRGenerator* getMRGenerator()
-    {
-        return mrGen;
-    }
-    /// We start from here
-    virtual void buildMemSSA(const SVFFunction& fun);
-
-    /// Perform statistics
-    void performStat();
-
-    /// Has mu/chi methods
-    //@{
-    inline bool hasMU(const PAGEdge* inst) const
-    {
-        if (const LoadStmt* load = SVFUtil::dyn_cast<LoadStmt>(inst))
-        {
-            bool hasMu = load2MuSetMap.count(load) != 0;
-            assert(hasMu && "not associated with mem region!");
-            return hasMu;
-        }
-        else
-            return false;
-    }
-    inline bool hasCHI(const PAGEdge* inst) const
-    {
-        if (const StoreStmt* store = SVFUtil::dyn_cast<StoreStmt>(
-                                         inst))
-        {
-            bool has_store = store2ChiSetMap.count(store) != 0;
-            assert(has_store && "not associated with mem region!");
-            return has_store;
-        }
-        else
-            return false;
-    }
-    inline bool hasMU(const CallICFGNode* cs) const
-    {
-        return callsiteToMuSetMap.find(cs)!=callsiteToMuSetMap.end();
-    }
-    inline bool hasCHI(const CallICFGNode* cs) const
-    {
-        return callsiteToChiSetMap.find(cs)!=callsiteToChiSetMap.end();
-    }
-    //@}
-
-    /// Has function entry chi or return mu
-    //@{
-    inline bool hasFuncEntryChi(const SVFFunction * fun) const
-    {
-        return (funToEntryChiSetMap.find(fun) != funToEntryChiSetMap.end());
-    }
-    inline bool hasReturnMu(const SVFFunction * fun) const
-    {
-        return (funToReturnMuSetMap.find(fun) != funToReturnMuSetMap.end());
-    }
-
-    inline CHISet& getFuncEntryChiSet(const SVFFunction * fun)
-    {
-        return funToEntryChiSetMap[fun];
-    }
-    inline MUSet& getReturnMuSet(const SVFFunction * fun)
-    {
-        return funToReturnMuSetMap[fun];
-    }
-    //@}
-
-    /// Get methods of mu/chi/phi
-    //@{
-    inline MUSet& getMUSet(const LoadStmt* ld)
-    {
-        return load2MuSetMap[ld];
-    }
-    inline CHISet& getCHISet(const StoreStmt* st)
-    {
-        return store2ChiSetMap[st];
-    }
-    inline MUSet& getMUSet(const CallICFGNode* cs)
-    {
-        return callsiteToMuSetMap[cs];
-    }
-    inline CHISet& getCHISet(const CallICFGNode* cs)
-    {
-        return callsiteToChiSetMap[cs];
-    }
-    inline PHISet& getPHISet(const SVFBasicBlock* bb)
-    {
-        return bb2PhiSetMap[bb];
-    }
-    inline bool hasPHISet(const SVFBasicBlock* bb) const
-    {
-        return bb2PhiSetMap.find(bb)!=bb2PhiSetMap.end();
-    }
-    inline LoadToMUSetMap& getLoadToMUSetMap()
-    {
-        return load2MuSetMap;
-    }
-    inline StoreToChiSetMap& getStoreToChiSetMap()
-    {
-        return store2ChiSetMap;
-    }
-    inline FunToReturnMuSetMap& getFunToRetMuSetMap()
-    {
-        return funToReturnMuSetMap;
-    }
-    inline FunToEntryChiSetMap& getFunToEntryChiSetMap()
-    {
-        return funToEntryChiSetMap;
-    }
-    inline CallSiteToMUSetMap& getCallSiteToMuSetMap()
-    {
-        return callsiteToMuSetMap;
-    }
-    inline CallSiteToCHISetMap& getCallSiteToChiSetMap()
-    {
-        return callsiteToChiSetMap;
-    }
-    inline BBToPhiSetMap& getBBToPhiSetMap()
-    {
-        return bb2PhiSetMap;
-    }
-    //@}
-
-    /// Stat methods
-    //@{
-    u32_t getLoadMuNum() const;
-    u32_t getStoreChiNum() const;
-    u32_t getFunEntryChiNum() const;
-    u32_t getFunRetMuNum() const;
-    u32_t getCallSiteMuNum() const;
-    u32_t getCallSiteChiNum() const;
-    u32_t getBBPhiNum() const;
-    //@}
-
-    /// Print Memory SSA
-    void dumpMSSA(OutStream & Out = SVFUtil::outs());
-};
-
-} // End namespace SVF
-
-#endif /* MEMORYSSAPASS_H_ */

package/SVF-linux/svf/include/include/MSSA/SVFGBuilder.h

@@ -1,98 +0,0 @@
-//===- SVFGBuilder.h -- Building SVFG-----------------------------------------//
-//
-//                     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 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/>.
-//
-//===----------------------------------------------------------------------===//
-
-/*
- * AndersenMemSSA.h
- *
- *  Created on: Oct 27, 2013
- *      Author: Yulei Sui
- */
-
-#ifndef ANDERSENMEMSSA_H_
-#define ANDERSENMEMSSA_H_
-
-#include "MemoryModel/PointerAnalysis.h"
-#include "Graphs/SVFGOPT.h"
-
-namespace SVF
-{
-
-/*!
- * SVFG Builder
- */
-class SVFGBuilder
-{
-
-public:
-    typedef PointerAnalysis::CallSiteSet CallSiteSet;
-    typedef PointerAnalysis::CallEdgeMap CallEdgeMap;
-    typedef PointerAnalysis::FunctionSet FunctionSet;
-    typedef SVFG::SVFGEdgeSetTy SVFGEdgeSet;
-
-    /// Constructor
-    explicit SVFGBuilder(bool _SVFGWithIndCall = false): svfg(nullptr), SVFGWithIndCall(_SVFGWithIndCall) {}
-
-    /// Destructor
-    virtual ~SVFGBuilder() = default;
-
-    SVFG* buildPTROnlySVFG(BVDataPTAImpl* pta);
-    SVFG* buildFullSVFG(BVDataPTAImpl* pta);
-
-    /// Get SVFG instance
-    inline SVFG* getSVFG() const
-    {
-        return svfg.get();
-    }
-
-    /// Mark feasible VF edge by removing it from set vfEdgesAtIndCallSite
-    inline void markValidVFEdge(SVFGEdgeSet& edges)
-    {
-        for(SVFGEdgeSet::iterator it = edges.begin(), eit = edges.end(); it!=eit; ++it)
-            vfEdgesAtIndCallSite.erase(*it);
-    }
-    /// Return true if this is an VF Edge pre-connected by Andersen's analysis
-    inline bool isSpuriousVFEdgeAtIndCallSite(const SVFGEdge* edge)
-    {
-        return vfEdgesAtIndCallSite.find(const_cast<SVFGEdge*>(edge))!=vfEdgesAtIndCallSite.end();
-    }
-
-    /// Build Memory SSA
-    virtual std::unique_ptr<MemSSA> buildMSSA(BVDataPTAImpl* pta, bool ptrOnlyMSSA);
-
-protected:
-    /// Create a DDA SVFG. By default actualOut and FormalIN are removed, unless withAOFI is set true.
-    SVFG* build(BVDataPTAImpl* pta, VFG::VFGK kind);
-    /// Can be rewritten by subclasses
-    virtual void buildSVFG();
-    /// Release global SVFG
-    virtual void releaseMemory();
-
-    /// SVFG Edges connected at indirect call/ret sites
-    SVFGEdgeSet vfEdgesAtIndCallSite;
-    std::unique_ptr<SVFG> svfg;
-    /// SVFG with precomputed indirect call edges
-    bool SVFGWithIndCall;
-};
-
-} // End namespace SVF
-
-#endif /* ANDERSENMEMSSA_H_ */