#include <MemRegion.h>

Inheritance diagram for SVF::MRGenerator:

Public Types
typedef FIFOWorkList< NodeID >	WorkList

typedef OrderedSet< const MemRegion *, MemRegion::equalMemRegion >	MRSet
	Get typedef from Pointer Analysis.

typedef Map< const PAGEdge , const SVFFunction >	PAGEdgeToFunMap

typedef OrderedSet< NodeBS, SVFUtil::equalNodeBS >	PointsToList

typedef Map< const SVFFunction *, NodeBS >	FunToPointsToMap

typedef Map< const SVFFunction *, PointsToList >	FunToPointsTosMap

typedef OrderedMap< NodeBS, NodeBS, SVFUtil::equalNodeBS >	PtsToRepPtsSetMap

typedef Map< const SVFFunction *, MRSet >	FunToMRsMap
	Map a function to its region set.

typedef Map< const LoadStmt *, MRSet >	LoadsToMRsMap

typedef Map< const StoreStmt *, MRSet >	StoresToMRsMap

typedef Map< const CallICFGNode *, MRSet >	CallSiteToMRsMap

typedef Map< const LoadStmt *, NodeBS >	LoadsToPointsToMap
	Map loads/stores/callsites to their cpts set.

typedef Map< const StoreStmt *, NodeBS >	StoresToPointsToMap

typedef Map< const CallICFGNode *, NodeBS >	CallSiteToPointsToMap

typedef Map< const SVFFunction *, NodeBS >	FunToNodeBSMap
	Maps Mod-Ref analysis.

typedef Map< const CallICFGNode *, NodeBS >	CallSiteToNodeBSMap
	Map a callsite to its indirect refs/mods of memory objects.

typedef Map< NodeID, NodeBS >	NodeToPTSSMap

typedef SVFIR::SVFStmtList	SVFStmtList
	SVFIR edge list.

typedef SCCDetection< PTACallGraph * >	SCC
	Call Graph SCC.

Public Member Functions
MRSet &	getMRSet ()

const NodeBS &	getRepPointsTo (const NodeBS &cpts) const
	Get superset cpts set.

const MemRegion *	getMR (const NodeBS &cpts) const
	Get a memory region according to cpts.

u32_t	getMRNum () const

virtual	~MRGenerator ()
	Destructor.

virtual void	generateMRs ()
	Start generating memory regions.

const SVFFunction *	getFunction (const PAGEdge *pagEdge) const
	Get the function which SVFIR Edge located.

MRSet &	getFunMRSet (const SVFFunction *fun)
	Get Memory Region set.

MRSet &	getLoadMRSet (const LoadStmt *load)

MRSet &	getStoreMRSet (const StoreStmt *store)

bool	hasRefMRSet (const CallICFGNode *cs)

bool	hasModMRSet (const CallICFGNode *cs)

MRSet &	getCallSiteRefMRSet (const CallICFGNode *cs)

MRSet &	getCallSiteModMRSet (const CallICFGNode *cs)

bool	hasSVFStmtList (const ICFGNode *icfgNode)
	Whether this instruction has SVFIR Edge.

SVFStmtList &	getPAGEdgesFromInst (const ICFGNode *node)
	Given an instruction, get all its the PAGEdge (statement) in sequence.

NodeBS	getModInfoForCall (const CallICFGNode *cs)
	getModRefInfo APIs

NodeBS	getRefInfoForCall (const CallICFGNode *cs)

ModRefInfo	getModRefInfo (const CallICFGNode *cs)

ModRefInfo	getModRefInfo (const CallICFGNode cs, const SVFValue V)

ModRefInfo	getModRefInfo (const CallICFGNode cs1, const CallICFGNode cs2)

Protected Member Functions
	MRGenerator (BVDataPTAImpl *p, bool ptrOnly)

void	createMR (const SVFFunction *fun, const NodeBS &cpts)
	Generate a memory region and put in into functions which use it.

void	collectGlobals ()
	Collect all global variables for later escape analysis.

virtual void	collectModRefForLoadStore ()
	Generate regions for loads/stores.

virtual void	collectModRefForCall ()
	Generate regions for calls/rets.

virtual void	partitionMRs ()
	Partition regions.

virtual void	updateAliasMRs ()
	Update aliased regions for loads/stores/callsites.

virtual void	sortPointsTo (const NodeBS &cpts)
	Given a condition pts, insert into cptsToRepCPtsMap for region generation.

virtual bool	isAliasedMR (const NodeBS &cpts, const MemRegion *mr)
	Whether a region is aliased with a conditional points-to.

virtual void	getAliasMemRegions (MRSet &aliasMRs, const NodeBS &cpts, const SVFFunction *fun)
	Get all aliased mem regions from function fun according to cpts.

virtual void	getMRsForLoad (MRSet &aliasMRs, const NodeBS &cpts, const SVFFunction *)
	Get memory regions for a load statement according to cpts.

virtual void	getMRsForCallSiteRef (MRSet &aliasMRs, const NodeBS &cpts, const SVFFunction *)
	Get memory regions for call site ref according to cpts.

virtual void	modRefAnalysis (PTACallGraphNode *callGraphNode, WorkList &worklist)
	Mod-Ref analysis for callsite invoking this callGraphNode.

virtual bool	handleCallsiteModRef (NodeBS &mod, NodeBS &ref, const CallICFGNode cs, const SVFFunction fun)
	Get Mod-Ref of a callee function.

void	addCPtsToStore (NodeBS &cpts, const StoreStmt st, const SVFFunction fun)
	Add cpts to store/load.

void	addCPtsToLoad (NodeBS &cpts, const LoadStmt ld, const SVFFunction fun)

void	addCPtsToCallSiteRefs (NodeBS &cpts, const CallICFGNode *cs)

void	addCPtsToCallSiteMods (NodeBS &cpts, const CallICFGNode *cs)

bool	hasCPtsList (const SVFFunction *fun) const

PointsToList &	getPointsToList (const SVFFunction *fun)

FunToPointsTosMap &	getFunToPointsToList ()

void	addRefSideEffectOfFunction (const SVFFunction *fun, const NodeBS &refs)
	Add/Get methods for side-effect of functions and callsites.

void	addModSideEffectOfFunction (const SVFFunction *fun, const NodeBS &mods)
	Add indirect def an memory object in the function.

bool	addRefSideEffectOfCallSite (const CallICFGNode *cs, const NodeBS &refs)
	Add indirect uses an memory object in the function.

bool	addModSideEffectOfCallSite (const CallICFGNode *cs, const NodeBS &mods)
	Add indirect def an memory object in the function.

const NodeBS &	getRefSideEffectOfFunction (const SVFFunction *fun)
	Get indirect refs of a function.

const NodeBS &	getModSideEffectOfFunction (const SVFFunction *fun)
	Get indirect mods of a function.

const NodeBS &	getRefSideEffectOfCallSite (const CallICFGNode *cs)
	Get indirect refs of a callsite.

const NodeBS &	getModSideEffectOfCallSite (const CallICFGNode *cs)
	Get indirect mods of a callsite.

bool	hasRefSideEffectOfCallSite (const CallICFGNode *cs)
	Has indirect refs of a callsite.

bool	hasModSideEffectOfCallSite (const CallICFGNode *cs)
	Has indirect mods of a callsite.

Protected Attributes
MRSet	memRegSet
	A set of All memory regions.

PtsToRepPtsSetMap	cptsToRepCPtsMap
	Map a condition pts to its rep conditional pts (super set points-to)

Private Member Functions
void	destroy ()
	Clean up memory.

void	collectCallSitePts (const CallICFGNode *cs)

NodeBS &	CollectPtsChain (NodeID id)

NodeBS &	getCallSiteArgsPts (const CallICFGNode *cs)
	Return the pts chain of all callsite arguments.

NodeBS &	getCallSiteRetPts (const CallICFGNode *cs)
	Return the pts chain of the return parameter of the callsite.

bool	isNonLocalObject (NodeID id, const SVFFunction *curFun) const

void	getEscapObjviaGlobals (NodeBS &globs, const NodeBS &pts)
	Get all the objects in callee's modref escaped via global objects (the chain pts of globals)

void	getCallGraphSCCRevTopoOrder (WorkList &worklist)
	Get reverse topo call graph scc.

Private Attributes
BVDataPTAImpl *	pta

SCC *	callGraphSCC

PTACallGraph *	callGraph

bool	ptrOnlyMSSA

FunToMRsMap	funToMRsMap
	Map a function to all its memory regions.

LoadsToMRsMap	loadsToMRsMap
	Map a load SVFIR Edge to its memory regions sets in order for inserting mus in Memory SSA.

StoresToMRsMap	storesToMRsMap
	Map a store SVFIR Edge to its memory regions sets in order for inserting chis in Memory SSA.

CallSiteToMRsMap	callsiteToRefMRsMap
	Map a callsite to its refs regions.

CallSiteToMRsMap	callsiteToModMRsMap
	Map a callsite to its mods regions.

LoadsToPointsToMap	loadsToPointsToMap
	Map a load SVFIR Edge to its CPts set map.

StoresToPointsToMap	storesToPointsToMap
	Map a store SVFIR Edge to its CPts set map.

CallSiteToPointsToMap	callsiteToRefPointsToMap
	Map a callsite to it refs cpts set.

CallSiteToPointsToMap	callsiteToModPointsToMap
	Map a callsite to it mods cpts set.

FunToPointsTosMap	funToPointsToMap
	Map a function to all of its conditional points-to sets.

PAGEdgeToFunMap	pagEdgeToFunMap
	Map a PAGEdge to its fun.

FunToPointsToMap	funToRefsMap
	Map a function to its indirect uses of memory objects.

FunToPointsToMap	funToModsMap
	Map a function to its indirect defs of memory objects.

CallSiteToPointsToMap	csToRefsMap
	Map a callsite to its indirect uses of memory objects.

CallSiteToPointsToMap	csToModsMap
	Map a callsite to its indirect defs of memory objects.

CallSiteToPointsToMap	csToCallSiteArgsPtsMap
	Map a callsite to all its object might pass into its callees.

CallSiteToPointsToMap	csToCallSiteRetPtsMap
	Map a callsite to all its object might return from its callees.

NodeToPTSSMap	cachedPtsChainMap
	Map a pointer to its cached points-to chain;.

NodeBS	allGlobals
	All global variable SVFIR node ids.

Detailed Description

Memory Region Partitioning

Definition at line 131 of file MemRegion.h.

Member Typedef Documentation

◆ CallSiteToMRsMap

typedef Map<const CallICFGNode*, MRSet> SVF::MRGenerator::CallSiteToMRsMap

Definition at line 155 of file MemRegion.h.

◆ CallSiteToNodeBSMap

typedef Map<const CallICFGNode*, NodeBS> SVF::MRGenerator::CallSiteToNodeBSMap

Map a callsite to its indirect refs/mods of memory objects.

Definition at line 170 of file MemRegion.h.

◆ CallSiteToPointsToMap

typedef Map<const CallICFGNode*, NodeBS> SVF::MRGenerator::CallSiteToPointsToMap

Definition at line 162 of file MemRegion.h.

◆ FunToMRsMap

typedef Map<const SVFFunction*, MRSet> SVF::MRGenerator::FunToMRsMap

Map a function to its region set.

Definition at line 149 of file MemRegion.h.

◆ FunToNodeBSMap

typedef Map<const SVFFunction*, NodeBS> SVF::MRGenerator::FunToNodeBSMap

Maps Mod-Ref analysis.

Map a function to its indirect refs/mods of memory objects

Definition at line 168 of file MemRegion.h.

◆ FunToPointsToMap

typedef Map<const SVFFunction*, NodeBS> SVF::MRGenerator::FunToPointsToMap

Definition at line 144 of file MemRegion.h.

◆ FunToPointsTosMap

typedef Map<const SVFFunction*, PointsToList> SVF::MRGenerator::FunToPointsTosMap

Definition at line 145 of file MemRegion.h.

◆ LoadsToMRsMap

typedef Map<const LoadStmt*, MRSet> SVF::MRGenerator::LoadsToMRsMap

Map loads/stores to its mem regions, TODO:visitAtomicCmpXchgInst, visitAtomicRMWInst??

Definition at line 153 of file MemRegion.h.

◆ LoadsToPointsToMap

typedef Map<const LoadStmt*, NodeBS> SVF::MRGenerator::LoadsToPointsToMap

Map loads/stores/callsites to their cpts set.

Definition at line 160 of file MemRegion.h.

◆ MRSet

typedef OrderedSet<const MemRegion*, MemRegion::equalMemRegion> SVF::MRGenerator::MRSet

Get typedef from Pointer Analysis.

Define mem region set

Definition at line 141 of file MemRegion.h.

◆ NodeToPTSSMap

typedef Map<NodeID, NodeBS> SVF::MRGenerator::NodeToPTSSMap

Definition at line 173 of file MemRegion.h.

◆ PAGEdgeToFunMap

typedef Map<const PAGEdge*, const SVFFunction*> SVF::MRGenerator::PAGEdgeToFunMap

Definition at line 142 of file MemRegion.h.

◆ PointsToList

typedef OrderedSet<NodeBS, SVFUtil::equalNodeBS> SVF::MRGenerator::PointsToList

Definition at line 143 of file MemRegion.h.

◆ PtsToRepPtsSetMap

typedef OrderedMap<NodeBS, NodeBS, SVFUtil::equalNodeBS> SVF::MRGenerator::PtsToRepPtsSetMap

Definition at line 146 of file MemRegion.h.

◆ SCC

typedef SCCDetection<PTACallGraph*> SVF::MRGenerator::SCC

Call Graph SCC.

Definition at line 178 of file MemRegion.h.

◆ StoresToMRsMap

typedef Map<const StoreStmt*, MRSet> SVF::MRGenerator::StoresToMRsMap

Definition at line 154 of file MemRegion.h.

◆ StoresToPointsToMap

typedef Map<const StoreStmt*, NodeBS> SVF::MRGenerator::StoresToPointsToMap

Definition at line 161 of file MemRegion.h.

◆ SVFStmtList

typedef SVFIR::SVFStmtList SVF::MRGenerator::SVFStmtList

SVFIR edge list.

Definition at line 176 of file MemRegion.h.

◆ WorkList

typedef FIFOWorkList<NodeID> SVF::MRGenerator::WorkList

Definition at line 135 of file MemRegion.h.

Constructor & Destructor Documentation

◆ MRGenerator()

MRGenerator::MRGenerator	(	BVDataPTAImpl *	p,
		bool	ptrOnly
	)

protected

Definition at line 42 of file MemRegion.cpp.

                                                       :
    pta(p), ptrOnlyMSSA(ptrOnly)
{
    callGraph = pta->getCallGraph();
    callGraphSCC = new SCC(callGraph);
}

◆ ~MRGenerator()

virtual SVF::MRGenerator::~MRGenerator ( )

inlinevirtual

Destructor.

Definition at line 426 of file MemRegion.h.

    {
        destroy();
    }

Member Function Documentation

◆ addCPtsToCallSiteMods()

void SVF::MRGenerator::addCPtsToCallSiteMods	(	NodeBS &	cpts,
		const CallICFGNode *	cs
	)

inlineprotected

Definition at line 358 of file MemRegion.h.

    {
        callsiteToModPointsToMap[cs] |= cpts;
        funToPointsToMap[cs->getCaller()].insert(cpts);
    }

◆ addCPtsToCallSiteRefs()

void SVF::MRGenerator::addCPtsToCallSiteRefs	(	NodeBS &	cpts,
		const CallICFGNode *	cs
	)

inlineprotected

Definition at line 353 of file MemRegion.h.

    {
        callsiteToRefPointsToMap[cs] |= cpts;
        funToPointsToMap[cs->getCaller()].insert(cpts);
    }

◆ addCPtsToLoad()

void SVF::MRGenerator::addCPtsToLoad	(	NodeBS &	cpts,
		const LoadStmt *	ld,
		const SVFFunction *	fun
	)

inlineprotected

Definition at line 347 of file MemRegion.h.

    {
        loadsToPointsToMap[ld] = cpts;
        funToPointsToMap[fun].insert(cpts);
        addRefSideEffectOfFunction(fun,cpts);
    }

◆ addCPtsToStore()

void SVF::MRGenerator::addCPtsToStore	(	NodeBS &	cpts,
		const StoreStmt *	st,
		const SVFFunction *	fun
	)

inlineprotected

Add cpts to store/load.

Definition at line 341 of file MemRegion.h.

    {
        storesToPointsToMap[st] = cpts;
        funToPointsToMap[fun].insert(cpts);
        addModSideEffectOfFunction(fun,cpts);
    }

◆ addModSideEffectOfCallSite()

bool MRGenerator::addModSideEffectOfCallSite	(	const CallICFGNode *	cs,
		const NodeBS &	mods
	)

protected

Add indirect def an memory object in the function.

Add indirect def an memory object in the function

Definition at line 445 of file MemRegion.cpp.

{
    if(!mods.empty())
    {
        NodeBS modset = mods;
        modset &= (getCallSiteArgsPts(cs) | getCallSiteRetPts(cs));
        getEscapObjviaGlobals(modset,mods);
        addModSideEffectOfFunction(cs->getCaller(),modset);
        return csToModsMap[cs] |= modset;
    }
    return false;
}

◆ addModSideEffectOfFunction()

void MRGenerator::addModSideEffectOfFunction	(	const SVFFunction *	fun,
		const NodeBS &	mods
	)

protected

Add indirect def an memory object in the function.

Add indirect def an memory object in the function

Definition at line 417 of file MemRegion.cpp.

{
    for(NodeBS::iterator it = mods.begin(), eit = mods.end(); it!=eit; ++it)
    {
        if(isNonLocalObject(*it,fun))
            funToModsMap[fun].set(*it);
    }
}

◆ addRefSideEffectOfCallSite()

bool MRGenerator::addRefSideEffectOfCallSite	(	const CallICFGNode *	cs,
		const NodeBS &	refs
	)

protected

Add indirect uses an memory object in the function.

Add indirect uses an memory object in the function

Definition at line 429 of file MemRegion.cpp.

{
    if(!refs.empty())
    {
        NodeBS refset = refs;
        refset &= getCallSiteArgsPts(cs);
        getEscapObjviaGlobals(refset,refs);
        addRefSideEffectOfFunction(cs->getCaller(),refset);
        return csToRefsMap[cs] |= refset;
    }
    return false;
}

◆ addRefSideEffectOfFunction()

void MRGenerator::addRefSideEffectOfFunction	(	const SVFFunction *	fun,
		const NodeBS &	refs
	)

protected

Add/Get methods for side-effect of functions and callsites.

Add indirect uses an memory object in the function

Definition at line 405 of file MemRegion.cpp.

{
    for(NodeBS::iterator it = refs.begin(), eit = refs.end(); it!=eit; ++it)
    {
        if(isNonLocalObject(*it,fun))
            funToRefsMap[fun].set(*it);
    }
}

◆ collectCallSitePts()

void MRGenerator::collectCallSitePts ( const CallICFGNode * cs )

private

Get all objects might pass into and pass out of callee(s) from a callsite

collect the pts chain of the callsite arguments

collect the pts chain of the return argument

Definition at line 477 of file MemRegion.cpp.

{
    NodeBS& argsPts = csToCallSiteArgsPtsMap[cs];
    SVFIR* pag = pta->getPAG();
    CallICFGNode* callBlockNode = const_cast<CallICFGNode*>(cs);
    const RetICFGNode* retBlockNode = cs->getRetICFGNode();
 
    WorkList worklist;
    if (pag->hasCallSiteArgsMap(callBlockNode))
    {
        const SVFIR::SVFVarList& args = pta->getPAG()->getCallSiteArgsList(callBlockNode);
        for(SVFIR::SVFVarList::const_iterator itA = args.begin(), ieA = args.end(); itA!=ieA; ++itA)
        {
            const PAGNode* node = *itA;
            if(node->isPointer())
                worklist.push(node->getId());
        }
    }
 
    while(!worklist.empty())
    {
        NodeID nodeId = worklist.pop();
        const NodeBS& tmp = pta->getPts(nodeId).toNodeBS();
        for(NodeBS::iterator it = tmp.begin(), eit = tmp.end(); it!=eit; ++it)
            argsPts |= CollectPtsChain(*it);
    }
 
    NodeBS& retPts = csToCallSiteRetPtsMap[cs];
 
    if (pta->getPAG()->callsiteHasRet(retBlockNode))
    {
        const PAGNode* node = pta->getPAG()->getCallSiteRet(retBlockNode);
        if(node->isPointer())
        {
            const NodeBS& tmp = pta->getPts(node->getId()).toNodeBS();
            for(NodeBS::iterator it = tmp.begin(), eit = tmp.end(); it!=eit; ++it)
                retPts |= CollectPtsChain(*it);
        }
    }
 
}

◆ collectGlobals()

void MRGenerator::collectGlobals ( )

protected

Collect all global variables for later escape analysis.

Collect globals for escape analysis

Definition at line 105 of file MemRegion.cpp.

{
    SVFIR* pag = pta->getPAG();
    for (SVFIR::iterator nIter = pag->begin(); nIter != pag->end(); ++nIter)
    {
        if(ObjVar* obj = SVFUtil::dyn_cast<ObjVar>(nIter->second))
        {
            if (obj->getMemObj()->isGlobalObj())
            {
                allGlobals.set(nIter->first);
                allGlobals |= CollectPtsChain(nIter->first);
            }
        }
    }
}

◆ collectModRefForCall()

void MRGenerator::collectModRefForCall ( )

protectedvirtual

Generate regions for calls/rets.

Generate memory regions for calls

collect points-to information for callsites

handle all sub scc nodes of this rep node

Get mod-ref of all callsites calling callGraphNode

mods are treated as both def and use of memory objects

Definition at line 227 of file MemRegion.cpp.

{
 
    DBOUT(DGENERAL, outs() << pasMsg("\t\tCollect Callsite PointsTo \n"));
 
    for(SVFIR::CallSiteSet::const_iterator it =  pta->getPAG()->getCallSiteSet().begin(),
            eit = pta->getPAG()->getCallSiteSet().end(); it!=eit; ++it)
    {
        collectCallSitePts((*it));
    }
 
    DBOUT(DGENERAL, outs() << pasMsg("\t\tPerform Callsite Mod-Ref \n"));
 
    WorkList worklist;
    getCallGraphSCCRevTopoOrder(worklist);
 
    while(!worklist.empty())
    {
        NodeID callGraphNodeID = worklist.pop();
        const NodeBS& subNodes = callGraphSCC->subNodes(callGraphNodeID);
        for(NodeBS::iterator it = subNodes.begin(), eit = subNodes.end(); it!=eit; ++it)
        {
            PTACallGraphNode* subCallGraphNode = callGraph->getCallGraphNode(*it);
            modRefAnalysis(subCallGraphNode,worklist);
        }
    }
 
    DBOUT(DGENERAL, outs() << pasMsg("\t\tAdd PointsTo to Callsites \n"));
 
    for (const CallICFGNode* callBlockNode : pta->getPAG()->getCallSiteSet())
    {
        if(hasRefSideEffectOfCallSite(callBlockNode))
        {
            NodeBS refs = getRefSideEffectOfCallSite(callBlockNode);
            addCPtsToCallSiteRefs(refs,callBlockNode);
        }
        if(hasModSideEffectOfCallSite(callBlockNode))
        {
            NodeBS mods = getModSideEffectOfCallSite(callBlockNode);
            addCPtsToCallSiteMods(mods,callBlockNode);
            addCPtsToCallSiteRefs(mods,callBlockNode);
        }
    }
}

◆ collectModRefForLoadStore()

void MRGenerator::collectModRefForLoadStore ( )

protectedvirtual

Generate regions for loads/stores.

Generate memory regions for loads/stores

if this function does not have any caller, then we do not care its MSSA

Definition at line 174 of file MemRegion.cpp.

{
 
    CallGraph* svfirCallGraph = PAG::getPAG()->getCallGraph();
    for (const auto& item: *svfirCallGraph)
    {
        const SVFFunction& fun = *item.second->getFunction();
 
        if (Options::IgnoreDeadFun() && fun.isUncalledFunction())
            continue;
 
        for (SVFFunction::const_iterator iter = fun.begin(), eiter = fun.end();
                iter != eiter; ++iter)
        {
            const SVFBasicBlock* bb = *iter;
            for (const auto& inst: bb->getICFGNodeList())
            {
                SVFStmtList& pagEdgeList = getPAGEdgesFromInst(inst);
                for (SVFStmtList::iterator bit = pagEdgeList.begin(), ebit =
                            pagEdgeList.end(); bit != ebit; ++bit)
                {
                    const PAGEdge* inst = *bit;
                    pagEdgeToFunMap[inst] = &fun;
                    if (const StoreStmt *st = SVFUtil::dyn_cast<StoreStmt>(inst))
                    {
                        NodeBS cpts(pta->getPts(st->getLHSVarID()).toNodeBS());
                        // TODO: change this assertion check later when we have conditional points-to set
                        if (cpts.empty())
                            continue;
                        assert(!cpts.empty() && "null pointer!!");
                        addCPtsToStore(cpts, st, &fun);
                    }
 
                    else if (const LoadStmt *ld = SVFUtil::dyn_cast<LoadStmt>(inst))
                    {
                        NodeBS cpts(pta->getPts(ld->getRHSVarID()).toNodeBS());
                        // TODO: change this assertion check later when we have conditional points-to set
                        if (cpts.empty())
                            continue;
                        assert(!cpts.empty() && "null pointer!!");
                        addCPtsToLoad(cpts, ld, &fun);
                    }
                }
            }
        }
    }
}

◆ CollectPtsChain()

NodeBS & MRGenerator::CollectPtsChain ( NodeID id )

private

Recursively collect all points-to of the whole struct fields

Definition at line 525 of file MemRegion.cpp.

{
    NodeID baseId = pta->getPAG()->getBaseObjVar(id);
    NodeToPTSSMap::iterator it = cachedPtsChainMap.find(baseId);
    if(it!=cachedPtsChainMap.end())
        return it->second;
    else
    {
        NodeBS& pts = cachedPtsChainMap[baseId];
        pts |= pta->getPAG()->getFieldsAfterCollapse(baseId);
 
        WorkList worklist;
        for(NodeBS::iterator it = pts.begin(), eit = pts.end(); it!=eit; ++it)
            worklist.push(*it);
 
        while(!worklist.empty())
        {
            NodeID nodeId = worklist.pop();
            const NodeBS& tmp = pta->getPts(nodeId).toNodeBS();
            for(NodeBS::iterator it = tmp.begin(), eit = tmp.end(); it!=eit; ++it)
            {
                pts |= CollectPtsChain(*it);
            }
        }
        return pts;
    }
 
}

◆ createMR()

void MRGenerator::createMR	(	const SVFFunction *	fun,
		const NodeBS &	cpts
	)

protected

Generate a memory region and put in into functions which use it.

Generate a memory region and put in into functions which use it

Definition at line 70 of file MemRegion.cpp.

{
    const NodeBS& repCPts = getRepPointsTo(cpts);
    MemRegion mr(repCPts);
    MRSet::const_iterator mit = memRegSet.find(&mr);
    if(mit!=memRegSet.end())
    {
        const MemRegion* mr = *mit;
        MRSet& mrs = funToMRsMap[fun];
        if(mrs.find(mr)==mrs.end())
            mrs.insert(mr);
    }
    else
    {
        MemRegion* m = new MemRegion(repCPts);
        memRegSet.insert(m);
        funToMRsMap[fun].insert(m);
    }
}

◆ destroy()

void MRGenerator::destroy ( )

private

Clean up memory.

Clean up memory

Definition at line 52 of file MemRegion.cpp.

{
 
    for (MRSet::iterator it = memRegSet.begin(), eit = memRegSet.end();
            it != eit; ++it)
    {
        delete *it;
    }
 
    delete callGraphSCC;
    callGraphSCC = nullptr;
    callGraph = nullptr;
    pta = nullptr;
}

◆ generateMRs()

void MRGenerator::generateMRs ( )

virtual

Start generating memory regions.

Generate memory regions according to pointer analysis results Attach regions on loads/stores

collect mod-ref for loads/stores

collect mod-ref for calls

Partition memory regions

attach memory regions for loads/stores/calls

Definition at line 125 of file MemRegion.cpp.

{
 
    DBOUT(DGENERAL, outs() << pasMsg("Generate Memory Regions \n"));
 
    collectGlobals();
 
    callGraphSCC->find();
 
    DBOUT(DGENERAL, outs() << pasMsg("\tCollect ModRef For Load/Store \n"));
 
    collectModRefForLoadStore();
 
    DBOUT(DGENERAL, outs() << pasMsg("\tCollect ModRef For const CallICFGNode*\n"));
 
    collectModRefForCall();
 
    DBOUT(DGENERAL, outs() << pasMsg("\tPartition Memory Regions \n"));
    partitionMRs();
    updateAliasMRs();
}

◆ getAliasMemRegions()

virtual void SVF::MRGenerator::getAliasMemRegions	(	MRSet &	aliasMRs,
		const NodeBS &	cpts,
		const SVFFunction *	fun
	)

inlineprotectedvirtual

Get all aliased mem regions from function fun according to cpts.

Definition at line 309 of file MemRegion.h.

    {
        for(MRSet::const_iterator it = funToMRsMap[fun].begin(), eit = funToMRsMap[fun].end(); it!=eit; ++it)
        {
            if(isAliasedMR(cpts,*it))
                aliasMRs.insert(*it);
        }
    }

◆ getCallGraphSCCRevTopoOrder()

void MRGenerator::getCallGraphSCCRevTopoOrder ( WorkList & worklist )

private

Get reverse topo call graph scc.

Get the reverse topo order of scc call graph

Definition at line 462 of file MemRegion.cpp.

{
 
    NodeStack& topoOrder = callGraphSCC->topoNodeStack();
    while(!topoOrder.empty())
    {
        NodeID callgraphNodeID = topoOrder.top();
        topoOrder.pop();
        worklist.push(callgraphNodeID);
    }
}

◆ getCallSiteArgsPts()

NodeBS & SVF::MRGenerator::getCallSiteArgsPts ( const CallICFGNode * cs )

inlineprivate

Return the pts chain of all callsite arguments.

Definition at line 255 of file MemRegion.h.

    {
        return csToCallSiteArgsPtsMap[cs];
    }

◆ getCallSiteModMRSet()

MRSet & SVF::MRGenerator::getCallSiteModMRSet ( const CallICFGNode * cs )

inline

Definition at line 467 of file MemRegion.h.

    {
        return callsiteToModMRsMap[cs];
    }

◆ getCallSiteRefMRSet()

MRSet & SVF::MRGenerator::getCallSiteRefMRSet ( const CallICFGNode * cs )

inline

Definition at line 463 of file MemRegion.h.

    {
        return callsiteToRefMRsMap[cs];
    }

◆ getCallSiteRetPts()

NodeBS & SVF::MRGenerator::getCallSiteRetPts ( const CallICFGNode * cs )

inlineprivate

Return the pts chain of the return parameter of the callsite.

Definition at line 260 of file MemRegion.h.

    {
        return csToCallSiteRetPtsMap[cs];
    }

◆ getEscapObjviaGlobals()

void MRGenerator::getEscapObjviaGlobals	(	NodeBS &	globs,
		const NodeBS &	calleeModRef
	)

private

Get all the objects in callee's modref escaped via global objects (the chain pts of globals)

Get all the objects in callee's modref escaped via global objects (the chain pts of globals) Otherwise, the object in callee's modref would not escape through globals

Definition at line 559 of file MemRegion.cpp.

{
    for(NodeBS::iterator it = calleeModRef.begin(), eit = calleeModRef.end(); it!=eit; ++it)
    {
        const MemObj* obj = pta->getPAG()->getObject(*it);
        (void)obj; // Suppress warning of unused variable under release build
        assert(obj && "object not found!!");
        if(allGlobals.test(*it))
            globs.set(*it);
    }
}

◆ getFunction()

const SVFFunction * SVF::MRGenerator::getFunction ( const PAGEdge * pagEdge ) const

inline

Get the function which SVFIR Edge located.

Definition at line 435 of file MemRegion.h.

    {
        PAGEdgeToFunMap::const_iterator it = pagEdgeToFunMap.find(pagEdge);
        assert(it!=pagEdgeToFunMap.end() && "can not find its function, it is a global SVFIR edge");
        return it->second;
    }

◆ getFunMRSet()

MRSet & SVF::MRGenerator::getFunMRSet ( const SVFFunction * fun )

inline

Get Memory Region set.

Definition at line 443 of file MemRegion.h.

    {
        return funToMRsMap[fun];
    }

◆ getFunToPointsToList()

FunToPointsTosMap & SVF::MRGenerator::getFunToPointsToList ( )

inlineprotected

Definition at line 371 of file MemRegion.h.

    {
        return funToPointsToMap;
    }

◆ getLoadMRSet()

MRSet & SVF::MRGenerator::getLoadMRSet ( const LoadStmt * load )

inline

Definition at line 447 of file MemRegion.h.

    {
        return loadsToMRsMap[load];
    }

◆ getModInfoForCall()

NodeBS MRGenerator::getModInfoForCall ( const CallICFGNode * cs )

getModRefInfo APIs

Collect mod ref for external callsite other than heap alloc external call

Obtain the mod sets for a call, used for external ModRefInfo queries

Definition at line 670 of file MemRegion.cpp.

{
    if (isExtCall(cs) && !isHeapAllocExtCall(cs))
    {
        SVFStmtList& pagEdgeList = getPAGEdgesFromInst(cs);
        NodeBS mods;
        for (SVFStmtList::const_iterator bit = pagEdgeList.begin(), ebit =
                    pagEdgeList.end(); bit != ebit; ++bit)
        {
            const PAGEdge* edge = *bit;
            if (const StoreStmt* st = SVFUtil::dyn_cast<StoreStmt>(edge))
                mods |= pta->getPts(st->getLHSVarID()).toNodeBS();
        }
        return mods;
    }
    else
    {
        return getModSideEffectOfCallSite(cs);
    }
}

◆ getModRefInfo() [1/3]

ModRefInfo MRGenerator::getModRefInfo ( const CallICFGNode * cs )

Determine whether a CallSite instruction can mod or ref any memory location

Definition at line 719 of file MemRegion.cpp.

{
    bool ref = !getRefInfoForCall(cs).empty();
    bool mod = !getModInfoForCall(cs).empty();
 
    if (mod && ref)
        return ModRefInfo::ModRef;
    else if (ref)
        return ModRefInfo::Ref;
    else if (mod)
        return ModRefInfo::Mod;
    else
        return ModRefInfo::NoModRef;
}

◆ getModRefInfo() [2/3]

ModRefInfo MRGenerator::getModRefInfo	(	const CallICFGNode *	cs,
		const SVFValue *	V
	)

Determine whether a const CallICFGNode* instruction can mod or ref a specific memory location pointed by V

Definition at line 738 of file MemRegion.cpp.

{
    bool ref = false;
    bool mod = false;
 
    if (pta->getPAG()->hasValueNode(V))
    {
        const NodeBS pts(pta->getPts(pta->getPAG()->getValueNode(V)).toNodeBS());
        const NodeBS csRef = getRefInfoForCall(cs);
        const NodeBS csMod = getModInfoForCall(cs);
        NodeBS ptsExpanded, csRefExpanded, csModExpanded;
        pta->expandFIObjs(pts, ptsExpanded);
        pta->expandFIObjs(csRef, csRefExpanded);
        pta->expandFIObjs(csMod, csModExpanded);
 
        if (csRefExpanded.intersects(ptsExpanded))
            ref = true;
        if (csModExpanded.intersects(ptsExpanded))
            mod = true;
    }
 
    if (mod && ref)
        return ModRefInfo::ModRef;
    else if (ref)
        return ModRefInfo::Ref;
    else if (mod)
        return ModRefInfo::Mod;
    else
        return ModRefInfo::NoModRef;
}

◆ getModRefInfo() [3/3]

ModRefInfo MRGenerator::getModRefInfo	(	const CallICFGNode *	cs1,
		const CallICFGNode *	cs2
	)

Determine mod-ref relations between two const CallICFGNode* instructions

return NoModRef neither two callsites ref or mod any memory

Ref: cs1 ref memory mod by cs2

Mod: cs1 mod memory ref or mod by cs2

ModRef: cs1 ref and mod memory mod by cs2

Definition at line 772 of file MemRegion.cpp.

{
    bool ref = false;
    bool mod = false;
 
    if (getModRefInfo(cs1) == ModRefInfo::NoModRef || getModRefInfo(cs2) == ModRefInfo::NoModRef)
        return ModRefInfo::NoModRef;
 
    const NodeBS cs1Ref = getRefInfoForCall(cs1);
    const NodeBS cs1Mod = getModInfoForCall(cs1);
    const NodeBS cs2Ref = getRefInfoForCall(cs2);
    const NodeBS cs2Mod = getModInfoForCall(cs2);
    NodeBS cs1RefExpanded, cs1ModExpanded, cs2RefExpanded, cs2ModExpanded;
    pta->expandFIObjs(cs1Ref, cs1RefExpanded);
    pta->expandFIObjs(cs1Mod, cs1ModExpanded);
    pta->expandFIObjs(cs2Ref, cs2RefExpanded);
    pta->expandFIObjs(cs2Mod, cs2ModExpanded);
 
    if (cs1RefExpanded.intersects(cs2ModExpanded))
        ref = true;
    if (cs1ModExpanded.intersects(cs2RefExpanded) || cs1ModExpanded.intersects(cs2ModExpanded))
        mod = true;
    if (cs1RefExpanded.intersects(cs2ModExpanded) && cs1ModExpanded.intersects(cs2ModExpanded))
        ref = mod = true;
 
    if (ref && mod)
        return ModRefInfo::ModRef;
    else if (ref)
        return ModRefInfo::Ref;
    else if (mod)
        return ModRefInfo::Mod;
    else
        return ModRefInfo::NoModRef;
}

◆ getModSideEffectOfCallSite()

const NodeBS & SVF::MRGenerator::getModSideEffectOfCallSite ( const CallICFGNode * cs )

inlineprotected

Get indirect mods of a callsite.

Definition at line 403 of file MemRegion.h.

    {
        return csToModsMap[cs];
    }

◆ getModSideEffectOfFunction()

const NodeBS & SVF::MRGenerator::getModSideEffectOfFunction ( const SVFFunction * fun )

inlineprotected

Get indirect mods of a function.

Definition at line 393 of file MemRegion.h.

    {
        return funToModsMap[fun];
    }

◆ getMR()

const MemRegion * MRGenerator::getMR ( const NodeBS & cpts ) const

Get a memory region according to cpts.

Generate a memory region and put in into functions which use it

Definition at line 93 of file MemRegion.cpp.

{
    MemRegion mr(getRepPointsTo(cpts));
    MRSet::iterator mit = memRegSet.find(&mr);
    assert(mit!=memRegSet.end() && "memory region not found!!");
    return *mit;
}

◆ getMRNum()

u32_t SVF::MRGenerator::getMRNum ( ) const

inline

Definition at line 420 of file MemRegion.h.

    {
        return memRegSet.size();
    }

◆ getMRSet()

MRSet & SVF::MRGenerator::getMRSet ( )

inline

Definition at line 180 of file MemRegion.h.

    {
        return memRegSet;
    }

◆ getMRsForCallSiteRef()

virtual void SVF::MRGenerator::getMRsForCallSiteRef	(	MRSet &	aliasMRs,
		const NodeBS &	cpts,
		const SVFFunction *
	)

inlineprotectedvirtual

Get memory regions for call site ref according to cpts.

Reimplemented in SVF::DistinctMRG, and SVF::IntraDisjointMRG.

Definition at line 326 of file MemRegion.h.

    {
        const MemRegion* mr = getMR(cpts);
        aliasMRs.insert(mr);
    }

◆ getMRsForLoad()

virtual void SVF::MRGenerator::getMRsForLoad	(	MRSet &	aliasMRs,
		const NodeBS &	cpts,
		const SVFFunction *
	)

inlineprotectedvirtual

Get memory regions for a load statement according to cpts.

Reimplemented in SVF::InterDisjointMRG, SVF::DistinctMRG, and SVF::IntraDisjointMRG.

Definition at line 319 of file MemRegion.h.

    {
        const MemRegion* mr = getMR(cpts);
        aliasMRs.insert(mr);
    }

◆ getPAGEdgesFromInst()

SVFIR::SVFStmtList & MRGenerator::getPAGEdgesFromInst ( const ICFGNode * node )

Given an instruction, get all its the PAGEdge (statement) in sequence.

Definition at line 161 of file MemRegion.cpp.

{
    SVFIR* pag = pta->getPAG();
    if (ptrOnlyMSSA)
        return pag->getPTASVFStmtList(node);
    else
        return pag->getSVFStmtList(node);
}

◆ getPointsToList()

PointsToList & SVF::MRGenerator::getPointsToList ( const SVFFunction * fun )

inlineprotected

Definition at line 367 of file MemRegion.h.

    {
        return funToPointsToMap[fun];
    }

◆ getRefInfoForCall()

NodeBS MRGenerator::getRefInfoForCall ( const CallICFGNode * cs )

Obtain the ref sets for a call, used for external ModRefInfo queries

Definition at line 694 of file MemRegion.cpp.

{
    if (isExtCall(cs) && !isHeapAllocExtCall(cs))
    {
        SVFStmtList& pagEdgeList = getPAGEdgesFromInst(cs);
        NodeBS refs;
        for (SVFStmtList::const_iterator bit = pagEdgeList.begin(), ebit =
                    pagEdgeList.end(); bit != ebit; ++bit)
        {
            const PAGEdge* edge = *bit;
            if (const LoadStmt* ld = SVFUtil::dyn_cast<LoadStmt>(edge))
                refs |= pta->getPts(ld->getRHSVarID()).toNodeBS();
        }
        return refs;
    }
    else
    {
        return getRefSideEffectOfCallSite(cs);
    }
}

◆ getRefSideEffectOfCallSite()

const NodeBS & SVF::MRGenerator::getRefSideEffectOfCallSite ( const CallICFGNode * cs )

inlineprotected

Get indirect refs of a callsite.

Definition at line 398 of file MemRegion.h.

    {
        return csToRefsMap[cs];
    }

◆ getRefSideEffectOfFunction()

const NodeBS & SVF::MRGenerator::getRefSideEffectOfFunction ( const SVFFunction * fun )

inlineprotected

Get indirect refs of a function.

Definition at line 388 of file MemRegion.h.

    {
        return funToRefsMap[fun];
    }

◆ getRepPointsTo()

const NodeBS & SVF::MRGenerator::getRepPointsTo ( const NodeBS & cpts ) const

inline

Get superset cpts set.

Definition at line 186 of file MemRegion.h.

    {
        PtsToRepPtsSetMap::const_iterator it = cptsToRepCPtsMap.find(cpts);
        assert(it!=cptsToRepCPtsMap.end() && "can not find superset of cpts??");
        return it->second;
    }

◆ getStoreMRSet()

MRSet & SVF::MRGenerator::getStoreMRSet ( const StoreStmt * store )

inline

Definition at line 451 of file MemRegion.h.

    {
        return storesToMRsMap[store];
    }

◆ handleCallsiteModRef()

bool MRGenerator::handleCallsiteModRef	(	NodeBS &	mod,
		NodeBS &	ref,
		const CallICFGNode *	cs,
		const SVFFunction *	callee
	)

protectedvirtual

Get Mod-Ref of a callee function.

Get Mod-Ref of a callee function

if a callee is a heap allocator function, then its mod set of this callsite is the heap object.

otherwise, we find the mod/ref sets from the callee function, who has definition and been processed

Definition at line 603 of file MemRegion.cpp.

{
    if(isHeapAllocExtCall(cs))
    {
        SVFStmtList& pagEdgeList = getPAGEdgesFromInst(cs);
        for (SVFStmtList::const_iterator bit = pagEdgeList.begin(),
                ebit = pagEdgeList.end(); bit != ebit; ++bit)
        {
            const PAGEdge* edge = *bit;
            if (const AddrStmt* addr = SVFUtil::dyn_cast<AddrStmt>(edge))
                mod.set(addr->getRHSVarID());
        }
    }
    else
    {
        mod = getModSideEffectOfFunction(callee);
        ref = getRefSideEffectOfFunction(callee);
    }
    // add ref set
    bool refchanged = addRefSideEffectOfCallSite(cs, ref);
    // add mod set
    bool modchanged = addModSideEffectOfCallSite(cs, mod);
 
    return refchanged || modchanged;
}

◆ hasCPtsList()

bool SVF::MRGenerator::hasCPtsList ( const SVFFunction * fun ) const

inlineprotected

Definition at line 363 of file MemRegion.h.

    {
        return funToPointsToMap.find(fun)!=funToPointsToMap.end();
    }

◆ hasModMRSet()

bool SVF::MRGenerator::hasModMRSet ( const CallICFGNode * cs )

inline

Definition at line 459 of file MemRegion.h.

    {
        return callsiteToModMRsMap.find(cs)!=callsiteToModMRsMap.end();
    }

◆ hasModSideEffectOfCallSite()

bool SVF::MRGenerator::hasModSideEffectOfCallSite ( const CallICFGNode * cs )

inlineprotected

Has indirect mods of a callsite.

Definition at line 413 of file MemRegion.h.

    {
        return csToModsMap.find(cs) != csToModsMap.end();
    }

◆ hasRefMRSet()

bool SVF::MRGenerator::hasRefMRSet ( const CallICFGNode * cs )

inline

Definition at line 455 of file MemRegion.h.

    {
        return callsiteToRefMRsMap.find(cs)!=callsiteToRefMRsMap.end();
    }

◆ hasRefSideEffectOfCallSite()

bool SVF::MRGenerator::hasRefSideEffectOfCallSite ( const CallICFGNode * cs )

inlineprotected

Has indirect refs of a callsite.

Definition at line 408 of file MemRegion.h.

    {
        return csToRefsMap.find(cs) != csToRefsMap.end();
    }

◆ hasSVFStmtList()

bool MRGenerator::hasSVFStmtList ( const ICFGNode * icfgNode )

Whether this instruction has SVFIR Edge.

Definition at line 151 of file MemRegion.cpp.

{
    SVFIR* pag = pta->getPAG();
    if (ptrOnlyMSSA)
        return pag->hasPTASVFStmtList(node);
    else
        return pag->hasSVFStmtList(node);
}

◆ isAliasedMR()

virtual bool SVF::MRGenerator::isAliasedMR	(	const NodeBS &	cpts,
		const MemRegion *	mr
	)

inlineprotectedvirtual

Whether a region is aliased with a conditional points-to.

Definition at line 304 of file MemRegion.h.

    {
        return mr->getPointsTo().intersects(cpts);
    }

◆ isNonLocalObject()

bool MRGenerator::isNonLocalObject	(	NodeID	id,
		const SVFFunction *	curFun
	)		const

private

Whether the object node is a non-local object including global, heap, and stack variable in recursions

if the object is heap or global

or if the local variable of its callers or a local variable is in function recursion cycles

Definition at line 575 of file MemRegion.cpp.

{
    const MemObj* obj = pta->getPAG()->getObject(id);
    assert(obj && "object not found!!");
    const BaseObjVar* pVar = pta->getPAG()->getBaseObject(id);
    assert(pVar && "object not found!");
    if(obj->isGlobalObj() || SVFUtil::isa<HeapObjVar, DummyObjVar>(pVar))
        return true;
    else if(SVFUtil::isa<StackObjVar>(pVar))
    {
        if(const SVFFunction* svffun = pVar->getFunction())
        {
            if(svffun!=curFun)
                return true;
            else
                return callGraphSCC->isInCycle(callGraph->getCallGraphNode(svffun)->getId());
        }
    }
 
    return false;
}

◆ modRefAnalysis()

void MRGenerator::modRefAnalysis	(	PTACallGraphNode *	callGraphNode,
		WorkList &	worklist
	)

protectedvirtual

Mod-Ref analysis for callsite invoking this callGraphNode.

Call site mod-ref analysis Compute mod-ref of all callsites invoking this call graph node

add ref/mod set of callee to its invocation callsites at caller

handle direct callsites

handle indirect callsites

Definition at line 635 of file MemRegion.cpp.

{
 
    for(PTACallGraphNode::iterator it = callGraphNode->InEdgeBegin(), eit = callGraphNode->InEdgeEnd();
            it!=eit; ++it)
    {
        PTACallGraphEdge* edge = *it;
 
        for(PTACallGraphEdge::CallInstSet::iterator cit = edge->getDirectCalls().begin(),
                ecit = edge->getDirectCalls().end(); cit!=ecit; ++cit)
        {
            NodeBS mod, ref;
            const CallICFGNode* cs = (*cit);
            bool modrefchanged = handleCallsiteModRef(mod, ref, cs, callGraphNode->getFunction());
            if(modrefchanged)
                worklist.push(edge->getSrcID());
        }
        for(PTACallGraphEdge::CallInstSet::iterator cit = edge->getIndirectCalls().begin(),
                ecit = edge->getIndirectCalls().end(); cit!=ecit; ++cit)
        {
            NodeBS mod, ref;
            const CallICFGNode* cs = (*cit);
            bool modrefchanged = handleCallsiteModRef(mod, ref, cs, callGraphNode->getFunction());
            if(modrefchanged)
                worklist.push(edge->getSrcID());
        }
    }
}

◆ partitionMRs()

void MRGenerator::partitionMRs ( )

protectedvirtual

Partition regions.

Partition memory regions

Compute all superset of all condition points-to sets TODO: we may need some refined region partitioning algorithm here For now, we just collapse all refs/mods objects at callsites into one region Consider modularly partition memory regions to speed up analysis (only partition regions within function scope)

Generate memory regions according to condition pts after computing superset

Reimplemented in SVF::DistinctMRG, SVF::IntraDisjointMRG, and SVF::InterDisjointMRG.

Definition at line 315 of file MemRegion.cpp.

{
 
    for(FunToPointsTosMap::iterator it = getFunToPointsToList().begin(), eit = getFunToPointsToList().end();
            it!=eit; ++it)
    {
        for(PointsToList::iterator cit = it->second.begin(), ecit = it->second.end(); cit!=ecit; ++cit)
        {
            sortPointsTo(*cit);
        }
    }
    for(FunToPointsTosMap::iterator it = getFunToPointsToList().begin(), eit = getFunToPointsToList().end();
            it!=eit; ++it)
    {
        const SVFFunction* fun = it->first;
        for(PointsToList::iterator cit = it->second.begin(), ecit = it->second.end(); cit!=ecit; ++cit)
        {
            createMR(fun,*cit);
        }
    }
 
}

◆ sortPointsTo()

void MRGenerator::sortPointsTo ( const NodeBS & cpts )

protectedvirtual

Given a condition pts, insert into cptsToRepCPtsMap for region generation.

Given a condition pts, insert into cptsToRepCPtsMap Always map it to its superset(rep) cpts according to existing items 1) map cpts to its superset(rep) which exists in the map, otherwise its superset is itself 2) adjust existing items in the map if their supersets are cpts

Definition at line 282 of file MemRegion.cpp.

{
 
    if(cptsToRepCPtsMap.find(cpts)!=cptsToRepCPtsMap.end())
        return;
 
    PointsToList subSetList;
    NodeBS repCPts = cpts;
    for(PtsToRepPtsSetMap::iterator it = cptsToRepCPtsMap.begin(),
            eit = cptsToRepCPtsMap.end(); it!=eit; ++it)
    {
        NodeBS& existCPts = it->second;
        if(cpts.contains(existCPts))
        {
            subSetList.insert(it->first);
        }
        else if(existCPts.contains(cpts))
        {
            repCPts = existCPts;
        }
    }
 
    for(PointsToList::iterator it = subSetList.begin(), eit = subSetList.end(); it!=eit; ++it)
    {
        cptsToRepCPtsMap[*it] = cpts;
    }
 
    cptsToRepCPtsMap[cpts] = repCPts;
}

◆ updateAliasMRs()

void MRGenerator::updateAliasMRs ( )

protectedvirtual

Update aliased regions for loads/stores/callsites.

Update aliased regions for loads/stores/callsites

update stores with its aliased regions

update callsites with its aliased regions

Definition at line 346 of file MemRegion.cpp.

{
 
    for(StoresToPointsToMap::const_iterator it = storesToPointsToMap.begin(), eit = storesToPointsToMap.end(); it!=eit; ++it)
    {
        MRSet aliasMRs;
        const SVFFunction* fun = getFunction(it->first);
        const NodeBS& storeCPts = it->second;
        getAliasMemRegions(aliasMRs,storeCPts,fun);
        for(MRSet::iterator ait = aliasMRs.begin(), eait = aliasMRs.end(); ait!=eait; ++ait)
        {
            storesToMRsMap[it->first].insert(*ait);
        }
    }
 
    for(LoadsToPointsToMap::const_iterator it = loadsToPointsToMap.begin(), eit = loadsToPointsToMap.end(); it!=eit; ++it)
    {
        MRSet aliasMRs;
        const SVFFunction* fun = getFunction(it->first);
        const NodeBS& loadCPts = it->second;
        getMRsForLoad(aliasMRs, loadCPts, fun);
        for(MRSet::iterator ait = aliasMRs.begin(), eait = aliasMRs.end(); ait!=eait; ++ait)
        {
            loadsToMRsMap[it->first].insert(*ait);
        }
    }
 
    for(CallSiteToPointsToMap::const_iterator it =  callsiteToModPointsToMap.begin(),
            eit = callsiteToModPointsToMap.end(); it!=eit; ++it)
    {
        const SVFFunction* fun = it->first->getCaller();
        MRSet aliasMRs;
        const NodeBS& callsiteModCPts = it->second;
        getAliasMemRegions(aliasMRs,callsiteModCPts,fun);
        for(MRSet::iterator ait = aliasMRs.begin(), eait = aliasMRs.end(); ait!=eait; ++ait)
        {
            callsiteToModMRsMap[it->first].insert(*ait);
        }
    }
    for(CallSiteToPointsToMap::const_iterator it =  callsiteToRefPointsToMap.begin(),
            eit = callsiteToRefPointsToMap.end(); it!=eit; ++it)
    {
        const SVFFunction* fun = it->first->getCaller();
        MRSet aliasMRs;
        const NodeBS& callsiteRefCPts = it->second;
        getMRsForCallSiteRef(aliasMRs, callsiteRefCPts, fun);
        for(MRSet::iterator ait = aliasMRs.begin(), eait = aliasMRs.end(); ait!=eait; ++ait)
        {
            callsiteToRefMRsMap[it->first].insert(*ait);
        }
    }
}

Member Data Documentation

◆ allGlobals

NodeBS SVF::MRGenerator::allGlobals

private

All global variable SVFIR node ids.

Definition at line 243 of file MemRegion.h.

◆ cachedPtsChainMap

NodeToPTSSMap SVF::MRGenerator::cachedPtsChainMap

private

Map a pointer to its cached points-to chain;.

Definition at line 240 of file MemRegion.h.

◆ callGraph

PTACallGraph* SVF::MRGenerator::callGraph

private

Definition at line 199 of file MemRegion.h.

◆ callGraphSCC

SCC* SVF::MRGenerator::callGraphSCC

private

Definition at line 198 of file MemRegion.h.

◆ callsiteToModMRsMap

CallSiteToMRsMap SVF::MRGenerator::callsiteToModMRsMap

private

Map a callsite to its mods regions.

Definition at line 211 of file MemRegion.h.

◆ callsiteToModPointsToMap

CallSiteToPointsToMap SVF::MRGenerator::callsiteToModPointsToMap

private

Map a callsite to it mods cpts set.

Definition at line 219 of file MemRegion.h.

◆ callsiteToRefMRsMap

CallSiteToMRsMap SVF::MRGenerator::callsiteToRefMRsMap

private

Map a callsite to its refs regions.

Definition at line 209 of file MemRegion.h.

◆ callsiteToRefPointsToMap

CallSiteToPointsToMap SVF::MRGenerator::callsiteToRefPointsToMap

private

Map a callsite to it refs cpts set.

Definition at line 217 of file MemRegion.h.

◆ cptsToRepCPtsMap

PtsToRepPtsSetMap SVF::MRGenerator::cptsToRepCPtsMap

protected

Map a condition pts to its rep conditional pts (super set points-to)

Definition at line 280 of file MemRegion.h.

◆ csToCallSiteArgsPtsMap

CallSiteToPointsToMap SVF::MRGenerator::csToCallSiteArgsPtsMap

private

Map a callsite to all its object might pass into its callees.

Definition at line 235 of file MemRegion.h.

◆ csToCallSiteRetPtsMap

CallSiteToPointsToMap SVF::MRGenerator::csToCallSiteRetPtsMap

private

Map a callsite to all its object might return from its callees.

Definition at line 237 of file MemRegion.h.

◆ csToModsMap

CallSiteToPointsToMap SVF::MRGenerator::csToModsMap

private

Map a callsite to its indirect defs of memory objects.

Definition at line 233 of file MemRegion.h.

◆ csToRefsMap

CallSiteToPointsToMap SVF::MRGenerator::csToRefsMap

private

Map a callsite to its indirect uses of memory objects.

Definition at line 231 of file MemRegion.h.

◆ funToModsMap

FunToPointsToMap SVF::MRGenerator::funToModsMap

private

Map a function to its indirect defs of memory objects.

Definition at line 229 of file MemRegion.h.

◆ funToMRsMap

FunToMRsMap SVF::MRGenerator::funToMRsMap

private

Map a function to all its memory regions.

Definition at line 203 of file MemRegion.h.

◆ funToPointsToMap

FunToPointsTosMap SVF::MRGenerator::funToPointsToMap

private

Map a function to all of its conditional points-to sets.

Definition at line 222 of file MemRegion.h.

◆ funToRefsMap

FunToPointsToMap SVF::MRGenerator::funToRefsMap

private

Map a function to its indirect uses of memory objects.

Definition at line 227 of file MemRegion.h.

◆ loadsToMRsMap

LoadsToMRsMap SVF::MRGenerator::loadsToMRsMap

private

Map a load SVFIR Edge to its memory regions sets in order for inserting mus in Memory SSA.

Definition at line 205 of file MemRegion.h.

◆ loadsToPointsToMap

LoadsToPointsToMap SVF::MRGenerator::loadsToPointsToMap

private

Map a load SVFIR Edge to its CPts set map.

Definition at line 213 of file MemRegion.h.

◆ memRegSet

MRSet SVF::MRGenerator::memRegSet

protected

A set of All memory regions.

Definition at line 278 of file MemRegion.h.

◆ pagEdgeToFunMap

PAGEdgeToFunMap SVF::MRGenerator::pagEdgeToFunMap

private

Map a PAGEdge to its fun.

Definition at line 224 of file MemRegion.h.

◆ pta

BVDataPTAImpl* SVF::MRGenerator::pta

private

Definition at line 197 of file MemRegion.h.

◆ ptrOnlyMSSA

bool SVF::MRGenerator::ptrOnlyMSSA

private

Definition at line 200 of file MemRegion.h.

◆ storesToMRsMap

StoresToMRsMap SVF::MRGenerator::storesToMRsMap

private

Map a store SVFIR Edge to its memory regions sets in order for inserting chis in Memory SSA.

Definition at line 207 of file MemRegion.h.

◆ storesToPointsToMap

StoresToPointsToMap SVF::MRGenerator::storesToPointsToMap

private

Map a store SVFIR Edge to its CPts set map.

Definition at line 215 of file MemRegion.h.

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

/home/runner/work/SVF/SVF/svf/include/MSSA/MemRegion.h
/home/runner/work/SVF/SVF/svf/lib/MSSA/MemRegion.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CallSiteToMRsMap

◆ CallSiteToNodeBSMap

◆ CallSiteToPointsToMap

◆ FunToMRsMap

◆ FunToNodeBSMap

◆ FunToPointsToMap

◆ FunToPointsTosMap

◆ LoadsToMRsMap

◆ LoadsToPointsToMap

◆ MRSet

◆ NodeToPTSSMap

◆ PAGEdgeToFunMap

◆ PointsToList

◆ PtsToRepPtsSetMap

◆ SCC

◆ StoresToMRsMap

◆ StoresToPointsToMap

◆ SVFStmtList

◆ WorkList

Constructor & Destructor Documentation

◆ MRGenerator()

◆ ~MRGenerator()

Member Function Documentation

◆ addCPtsToCallSiteMods()

◆ addCPtsToCallSiteRefs()

◆ addCPtsToLoad()

◆ addCPtsToStore()

◆ addModSideEffectOfCallSite()

◆ addModSideEffectOfFunction()

◆ addRefSideEffectOfCallSite()

◆ addRefSideEffectOfFunction()

◆ collectCallSitePts()

◆ collectGlobals()

◆ collectModRefForCall()

◆ collectModRefForLoadStore()

◆ CollectPtsChain()

◆ createMR()

◆ destroy()

◆ generateMRs()

◆ getAliasMemRegions()

◆ getCallGraphSCCRevTopoOrder()

◆ getCallSiteArgsPts()

◆ getCallSiteModMRSet()

◆ getCallSiteRefMRSet()

◆ getCallSiteRetPts()

◆ getEscapObjviaGlobals()

◆ getFunction()

◆ getFunMRSet()

◆ getFunToPointsToList()

◆ getLoadMRSet()

◆ getModInfoForCall()

◆ getModRefInfo() [1/3]

◆ getModRefInfo() [2/3]

◆ getModRefInfo() [3/3]

◆ getModSideEffectOfCallSite()

◆ getModSideEffectOfFunction()

◆ getMR()

◆ getMRNum()

◆ getMRSet()

◆ getMRsForCallSiteRef()

◆ getMRsForLoad()

◆ getPAGEdgesFromInst()

◆ getPointsToList()

◆ getRefInfoForCall()

◆ getRefSideEffectOfCallSite()

◆ getRefSideEffectOfFunction()

◆ getRepPointsTo()

◆ getStoreMRSet()

◆ handleCallsiteModRef()

◆ hasCPtsList()

◆ hasModMRSet()

◆ hasModSideEffectOfCallSite()