#include <SVFGBuilder.h>

Inheritance diagram for SVF::SVFGBuilder:

Public Types
typedef PointerAnalysis::CallSiteSet	CallSiteSet

typedef PointerAnalysis::CallEdgeMap	CallEdgeMap

typedef PointerAnalysis::FunctionSet	FunctionSet

typedef SVFG::SVFGEdgeSetTy	SVFGEdgeSet

Public Member Functions
	SVFGBuilder (bool _SVFGWithIndCall=Options::SVFGWithIndirectCall(), bool _SVFGWithPostOpts=Options::OPTSVFG())
	Constructor.

virtual	~SVFGBuilder ()=default
	Destructor.

SVFG *	buildPTROnlySVFG (BVDataPTAImpl *pta)

SVFG *	buildFullSVFG (BVDataPTAImpl *pta)

SVFG *	getSVFG () const
	Get SVFG instance.

void	markValidVFEdge (SVFGEdgeSet &edges)
	Mark feasible VF edge by removing it from set vfEdgesAtIndCallSite.

bool	isSpuriousVFEdgeAtIndCallSite (const SVFGEdge *edge)
	Return true if this is an VF Edge pre-connected by Andersen's analysis.

virtual std::unique_ptr< MemSSA >	buildMSSA (BVDataPTAImpl *pta, bool ptrOnlyMSSA)
	Build Memory SSA.

Protected Member Functions
virtual std::unique_ptr< MRGenerator >	createMRGenerator (BVDataPTAImpl *pta, bool ptrOnlyMSSA)

SVFG *	build (BVDataPTAImpl *pta, VFG::VFGK kind)
	Create a DDA SVFG. By default actualOut and FormalIN are removed, unless withAOFI is set true.

virtual void	buildSVFG ()
	Can be rewritten by subclasses.

virtual void	releaseMemory ()
	Release global SVFG.

Protected Attributes
SVFGEdgeSet	vfEdgesAtIndCallSite
	SVFG Edges connected at indirect call/ret sites.

std::unique_ptr< SVFG >	svfg

bool	SVFGWithIndCall
	SVFG with precomputed indirect call edges.

bool	SVFGWithPostOpts
	Build optimised version of SVFG.

Detailed Description

SVFG Builder

Definition at line 43 of file SVFGBuilder.h.

Member Typedef Documentation

◆ CallEdgeMap

typedef PointerAnalysis::CallEdgeMap SVF::SVFGBuilder::CallEdgeMap

Definition at line 48 of file SVFGBuilder.h.

◆ CallSiteSet

typedef PointerAnalysis::CallSiteSet SVF::SVFGBuilder::CallSiteSet

Definition at line 47 of file SVFGBuilder.h.

◆ FunctionSet

typedef PointerAnalysis::FunctionSet SVF::SVFGBuilder::FunctionSet

Definition at line 49 of file SVFGBuilder.h.

◆ SVFGEdgeSet

typedef SVFG::SVFGEdgeSetTy SVF::SVFGBuilder::SVFGEdgeSet

Definition at line 50 of file SVFGBuilder.h.

Constructor & Destructor Documentation

◆ SVFGBuilder()

SVF::SVFGBuilder::SVFGBuilder	(	bool	_SVFGWithIndCall = `Options::SVFGWithIndirectCall()`,
		bool	_SVFGWithPostOpts = `Options::OPTSVFG()`
	)

inlineexplicit

Constructor.

Definition at line 53 of file SVFGBuilder.h.

        : svfg(nullptr), SVFGWithIndCall(_SVFGWithIndCall), SVFGWithPostOpts(_SVFGWithPostOpts)
    {
    }

◆ ~SVFGBuilder()

virtual SVF::SVFGBuilder::~SVFGBuilder ( )

virtualdefault

Destructor.

Member Function Documentation

◆ build()

SVFG * SVFGBuilder::build	(	BVDataPTAImpl *	pta,
		VFG::VFGK	kind
	)

protected

Create a DDA SVFG. By default actualOut and FormalIN are removed, unless withAOFI is set true.

Create DDA SVFG.

Update call graph using pre-analysis results

Definition at line 63 of file SVFGBuilder.cpp.

{
 
    auto mssa = buildMSSA(
                    pta, (VFG::PTRONLYSVFG == kind || VFG::PTRONLYSVFG_OPT == kind));
 
    DBOUT(DGENERAL, outs() << pasMsg("Build Sparse Value-Flow Graph \n"));
    if (kind == VFG::FULLSVFG_OPT || kind == VFG::PTRONLYSVFG_OPT)
        svfg = std::make_unique<SVFGOPT>(std::move(mssa), kind);
    else
        svfg = std::unique_ptr<SVFG>(new SVFG(std::move(mssa), kind));
    buildSVFG();
 
    if (SVFGWithIndCall)
        svfg->updateCallGraph(pta);
 
    if (svfg->getMSSA()->getPTA()->printStat())
        svfg->performStat();
 
    if (Options::DumpVFG())
        svfg->dump("svfg_final");
 
    return svfg.get();
}

◆ buildFullSVFG()

SVFG * SVFGBuilder::buildFullSVFG ( BVDataPTAImpl * pta )

Definition at line 48 of file SVFGBuilder.cpp.

{
    return this->SVFGWithPostOpts ? build(pta, VFG::FULLSVFG_OPT)
           : build(pta, VFG::FULLSVFG);
}

◆ buildMSSA()

std::unique_ptr< MemSSA > SVFGBuilder::buildMSSA	(	BVDataPTAImpl *	pta,
		bool	ptrOnlyMSSA
	)

virtual

Build Memory SSA.

Definition at line 117 of file SVFGBuilder.cpp.

{
 
    DBOUT(DGENERAL, outs() << pasMsg("Build Memory SSA \n"));
 
    auto mssa = std::make_unique<MemSSA>(pta, createMRGenerator(pta, ptrOnlyMSSA));
 
    const CallGraph* svfirCallGraph = PAG::getPAG()->getCallGraph();
    for (const auto& item : *svfirCallGraph)
    {
 
        const FunObjVar* fun = item.second->getFunction();
        if (isExtCall(fun))
            continue;
 
        mssa->buildMemSSA(*fun);
    }
 
    mssa->performStat();
    if (Options::DumpMSSA())
    {
        mssa->dumpMSSA();
    }
 
    return mssa;
}

◆ buildPTROnlySVFG()

SVFG * SVFGBuilder::buildPTROnlySVFG ( BVDataPTAImpl * pta )

Definition at line 42 of file SVFGBuilder.cpp.

{
    return this->SVFGWithPostOpts ? build(pta, VFG::PTRONLYSVFG_OPT)
           : build(pta, VFG::PTRONLYSVFG);
}

◆ buildSVFG()

void SVFGBuilder::buildSVFG ( )

protectedvirtual

Can be rewritten by subclasses.

Create SVFG

Reimplemented in SVF::CFLSVFGBuilder, SVF::SaberSVFGBuilder, and SVF::MTASVFGBuilder.

Definition at line 57 of file SVFGBuilder.cpp.

{
    svfg->buildSVFG();
}

◆ createMRGenerator()

std::unique_ptr< MRGenerator > SVFGBuilder::createMRGenerator	(	BVDataPTAImpl *	pta,
		bool	ptrOnlyMSSA
	)

protectedvirtual

Hook supplying the MRGenerator for the MemSSA built above. The default builds the stock generator selected by Options::MemPar(); MTASVFGBuilder overrides this to inject a thread-aware (ThreadMRG) generator. Ownership transfers to the MemSSA constructed in buildMSSA.

Build the stock MRGenerator selected by Options::MemPar(). MTASVFGBuilder overrides this hook to inject a thread-aware (ThreadMRG) generator instead.

Reimplemented in SVF::MTASVFGBuilder.

Definition at line 101 of file SVFGBuilder.cpp.

{
    switch (Options::MemPar())
    {
    case MemSSA::MemPartition::Distinct:
        return std::make_unique<DistinctMRG>(pta, ptrOnlyMSSA);
    case MemSSA::MemPartition::IntraDisjoint:
        return std::make_unique<IntraDisjointMRG>(pta, ptrOnlyMSSA);
    case MemSSA::MemPartition::InterDisjoint:
        return std::make_unique<InterDisjointMRG>(pta, ptrOnlyMSSA);
    default:
        assert(false && "unrecognised memory partition strategy");
        return nullptr;
    }
}

◆ getSVFG()

SVFG * SVF::SVFGBuilder::getSVFG ( ) const

inline

Get SVFG instance.

Definition at line 65 of file SVFGBuilder.h.

    {
        return svfg.get();
    }

◆ isSpuriousVFEdgeAtIndCallSite()

bool SVF::SVFGBuilder::isSpuriousVFEdgeAtIndCallSite ( const SVFGEdge * edge )

inline

Return true if this is an VF Edge pre-connected by Andersen's analysis.

Definition at line 77 of file SVFGBuilder.h.

    {
        return vfEdgesAtIndCallSite.find(const_cast<SVFGEdge*>(edge))!=vfEdgesAtIndCallSite.end();
    }

◆ markValidVFEdge()

void SVF::SVFGBuilder::markValidVFEdge ( SVFGEdgeSet & edges )

inline

Mark feasible VF edge by removing it from set vfEdgesAtIndCallSite.

Definition at line 71 of file SVFGBuilder.h.

    {
        for(SVFGEdgeSet::iterator it = edges.begin(), eit = edges.end(); it!=eit; ++it)
            vfEdgesAtIndCallSite.erase(*it);
    }

◆ releaseMemory()

void SVFGBuilder::releaseMemory ( )

protectedvirtual

Release global SVFG.

Release memory

Definition at line 92 of file SVFGBuilder.cpp.

{
    svfg->clearMSSA();
}

Member Data Documentation

◆ svfg

std::unique_ptr<SVFG> SVF::SVFGBuilder::svfg

protected

Definition at line 101 of file SVFGBuilder.h.

◆ SVFGWithIndCall

bool SVF::SVFGBuilder::SVFGWithIndCall

protected

SVFG with precomputed indirect call edges.

Definition at line 103 of file SVFGBuilder.h.

◆ SVFGWithPostOpts

bool SVF::SVFGBuilder::SVFGWithPostOpts

protected

Build optimised version of SVFG.

Definition at line 105 of file SVFGBuilder.h.

◆ vfEdgesAtIndCallSite

SVFGEdgeSet SVF::SVFGBuilder::vfEdgesAtIndCallSite

protected

SVFG Edges connected at indirect call/ret sites.

Definition at line 100 of file SVFGBuilder.h.

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

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ CallEdgeMap

◆ CallSiteSet

◆ FunctionSet

◆ SVFGEdgeSet

Constructor & Destructor Documentation

◆ SVFGBuilder()

◆ ~SVFGBuilder()

Member Function Documentation

◆ build()

◆ buildFullSVFG()

◆ buildMSSA()

◆ buildPTROnlySVFG()

◆ buildSVFG()

◆ createMRGenerator()

◆ getSVFG()

◆ isSpuriousVFEdgeAtIndCallSite()

◆ markValidVFEdge()

◆ releaseMemory()

Member Data Documentation

◆ svfg

◆ SVFGWithIndCall

◆ SVFGWithPostOpts

◆ vfEdgesAtIndCallSite