RaceResultValidator Class Reference

Validate the result of concurrent analysis. More...

#include <MTAResultValidator.h>

Inheritance diagram for RaceResultValidator:

Classes
class	AccessPair

Public Types
typedef int	RC_FLAG

Public Member Functions
virtual	~RaceResultValidator ()
	Destructor. More...
void	init (SVFModule *M)
	Initialization. More...
void	analyze ()
	Analysis. More...
void	release ()
	Release resource. More...
bool	hasValidationTarget () const
	Check if the input program has validation target. More...

Protected Member Functions
void	collectValidationTargets ()
void	validateAll ()
	Perform validation for all targets. More...
std::string	getOutput (const char *scenario, bool analysisRes, bool expectedRes)
	Get the validation result string of a single validation scenario. More...
virtual bool	mayAccessAliases (const Instruction *I1, const Instruction *I2)
virtual bool	mayHappenInParallel (const Instruction *I1, const Instruction *I2)
virtual bool	protectedByCommonLocks (const Instruction *I1, const Instruction *I2)
virtual bool	mayHaveDataRace (const Instruction *I1, const Instruction *I2)

Private Member Functions
const Instruction *	getPreviousMemoryAccessInst (const Instruction *I)

Static Private Member Functions
static bool	compare (const CallInst *CI1, const CallInst *CI2)

Private Attributes
SVFModule *	M
std::vector< AccessPair >	accessPairs
RC_FLAG	selectedValidationScenarios

Static Private Attributes
static constexpr char const *	RC_ACCESS = "RC_ACCESS"
static const RC_FLAG	RC_MHP = 0x01
	Constant RC_FLAG values. More...
static const RC_FLAG	RC_ALIASES = 0x02
static const RC_FLAG	RC_PROTECTED = 0x04
static const RC_FLAG	RC_RACE = 0x10

Detailed Description

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.

Definition at line 159 of file MTAResultValidator.h.

Member Typedef Documentation

RC_FLAG

typedef int RaceResultValidator::RC_FLAG

Definition at line 162 of file MTAResultValidator.h.

Constructor & Destructor Documentation

~RaceResultValidator()

virtual RaceResultValidator::~RaceResultValidator ( )

inlinevirtual

Destructor.

Definition at line 200 of file MTAResultValidator.h.

    {
        release();
    }

Member Function Documentation

analyze()

void RaceResultValidator::analyze ( )

inline

Analysis.

Definition at line 214 of file MTAResultValidator.h.

    {
        validateAll();
    }

collectValidationTargets()

void RaceResultValidator::collectValidationTargets ( )

inlineprotected

Collect the targets for validations. The targets should be memory access Instructions in pairs. The collected targets are stored in the member variable "accessPairs".

Definition at line 265 of file MTAResultValidator.h.

    {
        // Collect call sites of all RC_ACCESS function calls.
        std::vector<const CallInst*> csInsts;
        const Function *F = M.getFunction(RC_ACCESS);
        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();
            const CallInst *csInst = SVFUtil::dyn_cast<CallInst>(user);
            assert(csInst);
            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 CallInst *CI1 = csInsts[i++];
            const CallInst *CI2 = csInsts[i++];
            const ConstantInt *C = SVFUtil::dyn_cast<ConstantInt>(CI1->getOperand(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));
        }
    }

compare()

static bool RaceResultValidator::compare ( const CallInst *  CI1, const CallInst *  CI2  )

inlinestaticprivate

Comparison function to sort the validation targets in ascending order of the validation id (i.e., the 1st argument of RC_ACCESS function call).

Definition at line 375 of file MTAResultValidator.h.

    {
        const Value *V1 = CI1->getOperand(0);
        const Value *V2 = CI2->getOperand(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();
    }

getOutput()

std::string RaceResultValidator::getOutput ( const char *  scenario, bool  analysisRes, bool  expectedRes  )

inlineprotected

Get the validation result string of a single validation scenario.

Definition at line 350 of file MTAResultValidator.h.

    {
        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;
    }

getPreviousMemoryAccessInst()

const Instruction* RaceResultValidator::getPreviousMemoryAccessInst ( const Instruction *  I )

inlineprivate

Get the previous LoadInst or StoreInst from Instruction "I" in the same BasicBlock. Return nullptr if none exists.

Definition at line 390 of file MTAResultValidator.h.

    {
        I = I->getPrevNode();
        while (I)
        {
            if (SVFUtil::isa<LoadInst>(I) || SVFUtil::isa<StoreInst>(I))
                return I;
            if (const Function *callee = SVFUtil::getCallee(I))
            {
                if (ExtAPI::EFT_L_A0__A0R_A1R == ExtAPI::getExtAPI()->get_type(callee)
                        || callee->getName().find("llvm.memset") != StringRef::npos)
                    return I;
            }
            I = I->getPrevNode();
        }
        return nullptr;
    }

hasValidationTarget()

bool RaceResultValidator::hasValidationTarget ( ) const

inline

Check if the input program has validation target.

Definition at line 225 of file MTAResultValidator.h.

    {
        return !accessPairs.empty();
    }

init()

void RaceResultValidator::init ( SVFModule *  M )

inline

Initialization.

Definition at line 206 of file MTAResultValidator.h.

    {
        this->M = M;
        selectedValidationScenarios = RC_MHP | RC_ALIASES | RC_PROTECTED | RC_RACE;
        collectValidationTargets();
    }

mayAccessAliases()

virtual bool RaceResultValidator::mayAccessAliases ( const Instruction *  I1, const Instruction *  I2  )

inlineprotectedvirtual

Interface to the specific validation properties. Override one or more to implement your own analysis.

Definition at line 234 of file MTAResultValidator.h.

    {
        selectedValidationScenarios &= ~RC_ALIASES;
        return true;
    }

mayHappenInParallel()

virtual bool RaceResultValidator::mayHappenInParallel ( const Instruction *  I1, const Instruction *  I2  )

inlineprotectedvirtual

Definition at line 240 of file MTAResultValidator.h.

    {
        selectedValidationScenarios &= ~RC_MHP;
        return true;
    }

mayHaveDataRace()

virtual bool RaceResultValidator::mayHaveDataRace ( const Instruction *  I1, const Instruction *  I2  )

inlineprotectedvirtual

Definition at line 252 of file MTAResultValidator.h.

    {
        selectedValidationScenarios &= ~RC_RACE;
        return true;
    }

protectedByCommonLocks()

virtual bool RaceResultValidator::protectedByCommonLocks ( const Instruction *  I1, const Instruction *  I2  )

inlineprotectedvirtual

Definition at line 246 of file MTAResultValidator.h.

    {
        selectedValidationScenarios &= ~RC_PROTECTED;
        return true;
    }

release()

void RaceResultValidator::release ( )

inline

Release resource.

Definition at line 220 of file MTAResultValidator.h.

    {
    }

validateAll()

void RaceResultValidator::validateAll ( )

inlineprotected

Perform validation for all targets.

Definition at line 302 of file MTAResultValidator.h.

    {
        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 ("
                            << SVFUtil::getSourceLoc(I1) << ", "
                            << SVFUtil::getSourceLoc(I2) << ")\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";
    }

Member Data Documentation

accessPairs

std::vector<AccessPair> RaceResultValidator::accessPairs

private

Definition at line 368 of file MTAResultValidator.h.

M

SVFModule* RaceResultValidator::M

private

Definition at line 367 of file MTAResultValidator.h.

RC_ACCESS

constexpr char const* RaceResultValidator::RC_ACCESS = "RC_ACCESS"

staticprivate

The name of the function which is used to specify the ground truth of the validation properties in the target program.

Definition at line 419 of file MTAResultValidator.h.

RC_ALIASES

const RC_FLAG RaceResultValidator::RC_ALIASES = 0x02

staticprivate

Definition at line 412 of file MTAResultValidator.h.

RC_MHP

const RC_FLAG RaceResultValidator::RC_MHP = 0x01

staticprivate

Constant RC_FLAG values.

Definition at line 411 of file MTAResultValidator.h.

RC_PROTECTED

const RC_FLAG RaceResultValidator::RC_PROTECTED = 0x04

staticprivate

Definition at line 413 of file MTAResultValidator.h.

RC_RACE

const RC_FLAG RaceResultValidator::RC_RACE = 0x10

staticprivate

Definition at line 414 of file MTAResultValidator.h.

selectedValidationScenarios

RC_FLAG RaceResultValidator::selectedValidationScenarios

private

Definition at line 369 of file MTAResultValidator.h.

---

The documentation for this class was generated from the following file:

• /home/runner/work/SVF-1/SVF-1/include/MTA/MTAResultValidator.h