svf-tools 1.0.977 → 1.0.978

package/svf/include/MTA/MTAResultValidator.h

@@ -1,448 +0,0 @@
-/*
- * MTAResultValidator.h
- *
- *  Created on: 29/06/2015
- *      Author: Peng Di and Ding Ye
- */
-
-#ifndef MTARESULTVALIDATOR_H_
-#define MTARESULTVALIDATOR_H_
-
-#include "MTA/MHP.h"
-
-/*!
- * Validate the result of context-sensitive analysis, including context-sensitive
- * thread detection and thread interleaving.
- */
-namespace SVF
-{
-typedef unsigned NodeID;
-
-class MTAResultValidator
-{
-
-public:
-    typedef int INTERLEV_FLAG;
-    MTAResultValidator(MHP* mh) :
-        mhp(mh)
-    {
-        tcg = mhp->getThreadCallGraph();
-        tdAPI = tcg->getThreadAPI();
-        mod = mhp->getTCT()->getSVFModule();
-    }
-    // Destructor
-    ~MTAResultValidator()
-    {
-    }
-
-    // Analysis
-    void analyze();
-    inline SVFModule* getModule() const
-    {
-        return mod;
-    }
-protected:
-
-    /*
-     * Assistant functions
-     */
-
-    // Split string
-    std::vector<std::string> &split(const std::string &s, char delim, std::vector<std::string> &elems);
-    std::vector<std::string> split(const std::string &s, char delim);
-
-    // Get special arguments of given call sites
-    NodeID getIntArg(const Instruction* inst, unsigned int arg_num);
-    std::vector<std::string> getStringArg(const Instruction* inst, unsigned int arg_num);
-    CallStrCxt getCxtArg(const Instruction* inst, unsigned int arg_num);
-
-    /*
-     * Get the previous LoadInst or StoreInst from Instruction "I" in the
-     * same BasicBlock. Return nullptr if none exists.
-     */
-    const Instruction* getPreviousMemoryAccessInst(const Instruction* I);
-
-    // Compare two cxts
-    bool matchCxt(const CallStrCxt cxt1, const CallStrCxt cxt2) const;
-
-    // Dump calling context information
-    void dumpCxt(const CallStrCxt& cxt) const;
-
-    void dumpInterlev(NodeBS& lev);
-
-    // Get the validation result string of a single validation scenario.
-    inline std::string getOutput(const char *scenario, bool analysisRes);
-    inline std::string getOutputforInterlevAnalysis(const char *scenario, INTERLEV_FLAG analysisRes);
-
-    /*
-     * Collect the callsite targets for validations.
-     * The targets are labeled by "cs1:", "cs2:"... that are the names of its basic blocks.
-     * The collected targets are stored in csnumToInstMap that maps label "cs1" to its Callsite.
-     */
-    bool collectCallsiteTargets();
-
-    /*
-     * Collect the CxtThread targets for validations.
-     * The collected targets are stored in vthdToCxt that maps vthd to cxt.
-     */
-    bool collectCxtThreadTargets();
-
-    /*
-     * Collect TCT targets for validations.
-     * The collected targets are stored in rthdToChildren.
-     */
-    bool collectTCTTargets();
-
-    /*
-     * Collect the thread interleaving targets for validations.
-     * The collected targets are stored in instToTSMap and threadStmtToInterLeaving.
-     */
-    bool collectInterleavingTargets();
-
-    /*
-     * Perform validation for Cxtthread.
-     * If correct, the validator maps given thread vthd to static CxtThread rthd stored in vthdTorthd.
-     */
-    bool validateCxtThread();
-
-    /*
-     * Perform validation for TCT.
-     */
-    bool validateTCT();
-
-    /*
-     * Perform validation for thread interleaving.
-     */
-    INTERLEV_FLAG validateInterleaving();
-
-private:
-
-    typedef Map<NodeID, const SVFInstruction*> csnumToInst;
-    typedef Map<NodeID, CallStrCxt> vthdToCxtMap;
-    typedef Map<NodeID, NodeID> vthdTorthdMap;
-    typedef Map<NodeID, NodeID> rthdTovthdMap;
-
-    typedef Map<NodeID, Set<NodeID>> rthdToChildrenMap;
-
-    MHP::InstToThreadStmtSetMap instToTSMap; // Map a instruction to CxtThreadStmtSet
-    MHP::ThreadStmtToThreadInterleav threadStmtToInterLeaving; /// Map a statement to its thread interleavings
-
-    static constexpr char const *CXT_THREAD = "CXT_THREAD";
-    static constexpr char const *INTERLEV_ACCESS = "INTERLEV_ACCESS";
-    static constexpr char const *TCT_ACCESS = "TCT_ACCESS";
-
-    ThreadAPI* tdAPI;
-    ThreadCallGraph* tcg;
-    MHP* mhp;
-    vthdToCxtMap vthdToCxt;
-    vthdTorthdMap vthdTorthd;
-    rthdTovthdMap rthdTovthd;
-    csnumToInst	csnumToInstMap;
-    rthdToChildrenMap rthdToChildren;
-    SVFModule* mod;
-    /// Constant INTERLEV_FLAG values
-    //@{
-    static const INTERLEV_FLAG INTERLEV_TRUE = 0x01;
-    static const INTERLEV_FLAG INTERLEV_IMPRECISE = 0x02;
-    static const INTERLEV_FLAG INTERLEV_UNSOUND = 0x04;
-    //@}
-};
-
-
-
-/*!
- * \brief Validate the result of concurrent analysis.
- *
- * The properties to validate of two memory accesses include
- * one or more of the following four:
- * (1) they may accesses aliases;
- * (2) they may happen in parallel;
- * (3) they are protected by common lock(s);
- * (4) they may cause a data race error.
- * The ground truth are specified by the "RC_ACCESS" function in the target program.
- *
- * Users may utilize this result validator to validate their analysis with
- * one or more of the four properties, by inheriting the RCResultValidator class.
- * The corresponding virtual function of the desired property should be overridden.
- */
-class RaceResultValidator
-{
-public:
-    typedef int RC_FLAG;
-
-    /*!
-     * Data structure for recording access pairs for the validation.
-     */
-    class AccessPair
-    {
-    public:
-        /// Constructor
-        AccessPair(const Instruction* I1, const Instruction* I2,
-                   const RC_FLAG flags) :
-            I1(I1), I2(I2), flags(flags)
-        {
-        }
-
-        /// Class member access
-        //@{
-        inline bool isFlaged(const RC_FLAG flag) const
-        {
-            return flags & flag;
-        }
-        inline const Instruction* getInstruction1() const
-        {
-            return I1;
-        }
-        inline const Instruction* getInstruction2() const
-        {
-            return I2;
-        }
-        //@}
-
-    private:
-        const Instruction* I1;
-        const Instruction* I2;
-        RC_FLAG flags;
-    };
-
-    /// Destructor
-    virtual ~RaceResultValidator()
-    {
-        release();
-    }
-
-    /// Initialization
-    void init(SVFModule* M)
-    {
-        this->M = M;
-        selectedValidationScenarios = RC_MHP | RC_ALIASES | RC_PROTECTED | RC_RACE;
-        collectValidationTargets();
-    }
-
-    /// Analysis
-    void analyze()
-    {
-        validateAll();
-    }
-
-    /// Release resource
-    void release()
-    {
-    }
-
-    /// Check if the input program has validation target
-    inline bool hasValidationTarget() const
-    {
-        return !accessPairs.empty();
-    }
-
-protected:
-    /// Interface to the specific validation properties.
-    /// Override one or more to implement your own analysis.
-    //@{
-    virtual bool mayAccessAliases(const Instruction* I1,
-                                  const Instruction* I2)
-    {
-        selectedValidationScenarios &= ~RC_ALIASES;
-        return true;
-    }
-    virtual bool mayHappenInParallel(const Instruction* I1,
-                                     const Instruction* I2)
-    {
-        selectedValidationScenarios &= ~RC_MHP;
-        return true;
-    }
-    virtual bool protectedByCommonLocks(const Instruction* I1,
-                                        const Instruction* I2)
-    {
-        selectedValidationScenarios &= ~RC_PROTECTED;
-        return true;
-    }
-    virtual bool mayHaveDataRace(const Instruction* I1,
-                                 const Instruction* I2)
-    {
-        selectedValidationScenarios &= ~RC_RACE;
-        return true;
-    }
-    //@}
-
-    /*!
-     * Collect the targets for validations.
-     * The targets should be memory access Instructions in pairs.
-     * The collected targets are stored in the member variable "accessPairs".
-     */
-    void collectValidationTargets()
-    {
-        // Collect call sites of all RC_ACCESS function calls.
-        std::vector<const CallBase*> csInsts;
-        const Function* F = nullptr;
-        for (Module &M : LLVMModuleSet::getLLVMModuleSet()->getLLVMModules())
-        {
-            for(auto it = M.begin(); it != M.end(); it++)
-            {
-                const std::string fName = (*it).getName().str();
-                if(fName.find(RC_ACCESS) != std::string::npos)
-                {
-                    F = &(*it);
-                    break;
-                }
-            }
-        }
-        if (!F)     return;
-
-        for (Value::const_use_iterator it = F->use_begin(), ie =
-                    F->use_end(); it != ie; ++it)
-        {
-            const Use *u = &*it;
-            const Value *user = u->getUser();
-            if(LLVMUtil::isCallSite(user))
-            {
-                const CallBase* csInst = LLVMUtil::getLLVMCallSite(user);
-                csInsts.push_back(csInst);
-            }
-        }
-        assert(csInsts.size() % 2 == 0 && "We should have RC_ACCESS called in pairs.");
-
-        // Sort the validation sites according to their ids.
-        std::sort(csInsts.begin(), csInsts.end(), compare);
-
-        // Generate access pairs.
-        for (int i = 0, e = csInsts.size(); i != e;)
-        {
-            const CallBase* CI1 = csInsts[i++];
-            const CallBase* CI2 = csInsts[i++];
-            const ConstantInt* C = SVFUtil::dyn_cast<ConstantInt>(CI1->getArgOperand(1));
-            assert(C);
-            const Instruction* I1 = getPreviousMemoryAccessInst(CI1);
-            const Instruction* I2 = getPreviousMemoryAccessInst(CI2);
-            assert(I1 && I2 && "RC_ACCESS should be placed immediately after the target memory access.");
-            RC_FLAG flags = C->getZExtValue();
-            accessPairs.push_back(AccessPair(I1, I2, flags));
-        }
-    }
-
-    /// Perform validation for all targets.
-    void validateAll()
-    {
-        SVFUtil::outs() << SVFUtil::pasMsg(" --- Analysis Result Validation ---\n");
-
-        // Iterate every memory access pair to perform the validation.
-        for (int i = 0, e = accessPairs.size(); i != e; ++i)
-        {
-            const AccessPair &ap = accessPairs[i];
-            const Instruction* I1 = ap.getInstruction1();
-            const Instruction* I2 = ap.getInstruction2();
-
-            bool mhp = mayHappenInParallel(I1, I2);
-            bool alias = mayAccessAliases(I1, I2);
-            bool protect = protectedByCommonLocks(I1, I2);
-            bool racy = mayHaveDataRace(I1, I2);
-
-            SVFUtil::outs() << "For the memory access pair at ("
-                            << LLVMModuleSet::getLLVMModuleSet()->getSVFValue(I1)->getSourceLoc() << ", "
-                            << LLVMModuleSet::getLLVMModuleSet()->getSVFValue(I2)->getSourceLoc() << ")\n";
-            if (selectedValidationScenarios & RC_ALIASES)
-            {
-                SVFUtil::outs() << "\t"
-                                << getOutput("ALIASES", alias, ap.isFlaged(RC_ALIASES))
-                                << "\n";
-            }
-            if (selectedValidationScenarios & RC_MHP)
-            {
-                SVFUtil::outs() << "\t"
-                                << getOutput("MHP", mhp, ap.isFlaged(RC_MHP)) << "\n";
-            }
-            if (selectedValidationScenarios & RC_PROTECTED)
-            {
-                SVFUtil::outs() << "\t"
-                                << getOutput("PROTECT", protect,
-                                             ap.isFlaged(RC_PROTECTED)) << "\n";
-            }
-            if (selectedValidationScenarios & RC_RACE)
-            {
-                SVFUtil::outs() << "\t"
-                                << getOutput("RACE", racy, ap.isFlaged(RC_RACE))
-                                << "\n";
-            }
-        }
-
-        SVFUtil::outs() << "\n";
-    }
-
-    /// Get the validation result string of a single validation scenario.
-    inline std::string getOutput(const char *scenario,
-                                 bool analysisRes, bool expectedRes)
-    {
-        std::string ret(scenario);
-        ret += "\t";
-        if (expectedRes)
-            ret += " T: ";
-        else
-            ret += " F: ";
-        if (analysisRes == expectedRes)
-            ret += SVFUtil::sucMsg("SUCCESS");
-        else
-            ret += SVFUtil::errMsg("FAILURE");
-        return ret;
-    }
-
-private:
-    SVFModule* M;
-    std::vector<AccessPair> accessPairs;
-    RC_FLAG selectedValidationScenarios;
-
-    /*!
-     * Comparison function to sort the validation targets in ascending order of
-     * the validation id (i.e., the 1st argument of RC_ACCESS function call).
-     */
-    static bool compare(const CallBase* CI1, const CallBase* CI2)
-    {
-        const Value *V1 = CI1->getArgOperand(0);
-        const Value *V2 = CI2->getArgOperand(0);
-        const ConstantInt* C1 = SVFUtil::dyn_cast<ConstantInt>(V1);
-        const ConstantInt* C2 = SVFUtil::dyn_cast<ConstantInt>(V2);
-        assert(0 != C1 && 0 != C2);
-        return C1->getZExtValue() < C2->getZExtValue();
-    }
-
-    /*!
-     * Get the previous LoadInst or StoreInst from Instruction "I" in the
-     * same BasicBlock.
-     * Return nullptr if none exists.
-     */
-    const Instruction* getPreviousMemoryAccessInst(
-        const Instruction* I)
-    {
-        I = I->getPrevNode();
-        while (I)
-        {
-            if (SVFUtil::isa<LoadInst, StoreInst>(I))
-                return I;
-
-            const SVFInstruction* inst = LLVMModuleSet::getLLVMModuleSet()->getSVFInstruction(I);
-
-            if (const SVFFunction *callee = SVFUtil::getCallee(inst))
-            {
-                if (callee->getName().find("llvm.memset") != std::string::npos)
-                    return I;
-
-            }
-            I = I->getPrevNode();
-        }
-        return nullptr;
-    }
-
-    /// Constant RC_FLAG values
-    //@{
-    static const RC_FLAG RC_MHP = 0x01;
-    static const RC_FLAG RC_ALIASES = 0x02;
-    static const RC_FLAG RC_PROTECTED = 0x04;
-    static const RC_FLAG RC_RACE = 0x10;
-    //@}
-
-    /// The name of the function which is used to specify the ground truth
-    /// of the validation properties in the target program.
-    static constexpr char const *RC_ACCESS = "RC_ACCESS";
-};
-}	// namespace SVF end
-#endif /* MTARESULTVALIDATOR_H_ */

package/svf/include/MTA/PCG.h

@@ -1,229 +0,0 @@
-//===- PCG.h -- Procedure creation graph-------------//
-//
-//                     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/>.
-//
-//===----------------------------------------------------------------------===//
-
-/*
- * MHP.h
- *
- *  Created on: Jan 21, 2014
- *      Author: Yulei Sui, Peng Di
- */
-
-#ifndef PCG_H_
-#define PCG_H_
-
-#include "Util/ThreadAPI.h"
-#include "Graphs/PTACallGraph.h"
-#include "Util/WorkList.h"
-#include "WPA/Andersen.h"
-#include <set>
-#include <vector>
-
-#include "MHP.h"
-
-namespace SVF
-{
-
-/*!
- * This class serves as a base may-happen in parallel analysis for multithreaded program
- * It distinguish thread spawner, spawnee, follower in procedure level by
- * modeling pthread_create, pthread_join, pthread_exit, pthread_cancel synchronization operations
- */
-class PCG
-{
-
-public:
-    typedef Set<const SVFFunction*> FunSet;
-    typedef std::vector<const SVFFunction*> FunVec;
-    typedef Set<const SVFInstruction*> CallInstSet;
-    typedef FIFOWorkList<const SVFFunction*> FunWorkList;
-    typedef FIFOWorkList<const SVFBasicBlock*> BBWorkList;
-
-private:
-    FunSet spawners;
-    FunSet spawnees;
-    FunSet followers;
-    FunSet mhpfuns;
-    PTACallGraph* callgraph;
-    SVFModule* mod;
-    PointerAnalysis* pta;
-    ThreadAPI* tdAPI;
-
-    /// Callsites direct or Indirect call a function which spawn a thread
-    CallInstSet spawnCallSites;
-
-    /// Add/Get methods for thread properties of a procedure
-    //@{
-    inline bool isSpawnerFun(const SVFFunction* fun) const
-    {
-        return spawners.find(fun) != spawners.end();
-    }
-    inline bool isSpawneeFun(const SVFFunction* fun) const
-    {
-        return spawnees.find(fun) != spawnees.end();
-    }
-    inline bool isFollowerFun(const SVFFunction* fun) const
-    {
-        return followers.find(fun) != followers.end();
-    }
-    inline bool addSpawnerFun(const SVFFunction* fun)
-    {
-        if (fun->isDeclaration())
-            return false;
-        return spawners.insert(fun).second;
-    }
-    inline bool addSpawneeFun(const SVFFunction* fun)
-    {
-        if (fun->isDeclaration())
-            return false;
-        return spawnees.insert(fun).second;
-    }
-    inline bool addFollowerFun(const SVFFunction* fun)
-    {
-        if (fun->isDeclaration())
-            return false;
-        return followers.insert(fun).second;
-    }
-    //@}
-
-    /// Add/search spawn sites which directly or indirectly create a thread
-    //@{
-    inline bool addSpawnsite(const SVFInstruction* callInst)
-    {
-        return spawnCallSites.insert(callInst).second;
-    }
-    inline bool isSpawnsite(const SVFInstruction* callInst)
-    {
-        return spawnCallSites.find(callInst) != spawnCallSites.end();
-    }
-    //@}
-    /// Spawn sites iterators
-    //@{
-    inline CallInstSet::const_iterator spawnSitesBegin() const
-    {
-        return spawnCallSites.begin();
-    }
-    inline CallInstSet::const_iterator spawnSitesEnd() const
-    {
-        return spawnCallSites.end();
-    }
-    //@}
-
-public:
-
-    /// Constructor
-    PCG(PointerAnalysis* an) : pta(an)
-    {
-        mod = pta->getModule();
-        tdAPI=ThreadAPI::getThreadAPI();
-        callgraph = pta->getPTACallGraph();
-    }
-
-    /// We start the pass here
-    virtual bool analyze();
-
-    /// Destructor
-    virtual ~PCG()
-    {
-    }
-
-    CallICFGNode* getCallICFGNode(const SVFInstruction* inst)
-    {
-        return pta->getICFG()->getCallICFGNode(inst);
-    }
-    /// Interface to query whether two function may happen-in-parallel
-    virtual bool mayHappenInParallel(const SVFInstruction* i1, const SVFInstruction* i2) const;
-    bool mayHappenInParallelBetweenFunctions(const SVFFunction* fun1, const SVFFunction* fun2) const;
-    inline const FunSet& getMHPFunctions() const
-    {
-        return mhpfuns;
-    }
-
-    /// Initialize spawner and spawnee sets with threadAPI
-    void initFromThreadAPI(SVFModule* module);
-
-    /// Infer spawner spawnee and followers sets by traversing on callGraph
-    //@{
-    void inferFromCallGraph();
-    void collectSpawners();
-    void collectSpawnees();
-    void collectFollowers();
-    void identifyFollowers();
-    //@}
-
-    /// Get spawners/spawnees/followers
-    //@{
-    inline const FunSet& getSpawners() const
-    {
-        return spawners;
-    }
-    inline const FunSet& getSpawnees() const
-    {
-        return spawnees;
-    }
-    inline const FunSet& getFollowers() const
-    {
-        return followers;
-    }
-    //@}
-
-    /// Iterators for thread properties of a procedure
-    //@{
-    inline FunSet::const_iterator spawnersBegin(const SVFFunction* fun) const
-    {
-        return spawners.begin();
-    }
-    inline FunSet::const_iterator spawnersEnd(const SVFFunction* fun) const
-    {
-        return spawners.end();
-    }
-    inline FunSet::const_iterator spawneesBegin(const SVFFunction* fun) const
-    {
-        return spawnees.begin();
-    }
-    inline FunSet::const_iterator spawneesEnd(const SVFFunction* fun) const
-    {
-        return spawnees.end();
-    }
-    inline FunSet::const_iterator followersBegin(const SVFFunction* fun) const
-    {
-        return followers.begin();
-    }
-    inline FunSet::const_iterator followersEnd(const SVFFunction* fun) const
-    {
-        return followers.end();
-    }
-    //@}
-
-    /// Thread interferenceAnalysis
-    void interferenceAnalysis();
-
-    /// Print analysis results
-    void printResults();
-    /*!
-     * Print Thread sensitive properties for each function
-     */
-    void printTDFuns();
-};
-
-} // End namespace SVF
-
-#endif /* PCG_H_ */