CFL Client Base Class. More...

#include <CFLBase.h>

Inheritance diagram for SVF::CFLBase:

Public Member Functions
	CFLBase (SVFIR *ir, PointerAnalysis::PTATY pty)

virtual	~CFLBase ()
	Destructor.

virtual void	checkParameter ()
	Parameter Checking.

virtual void	buildCFLGrammar ()
	Build Grammar from text file.

virtual void	buildCFLGraph ()
	Build CFLGraph based on Option.

virtual void	normalizeCFLGrammar ()
	Normalize grammar.

CFLGraph *	getCFLGraph ()
	Get CFL graph.

virtual void	countSumEdges ()
	Count the num of Nonterminal Edges.

virtual void	solve ()
	Solving CFL Reachability.

virtual void	finalize ()
	Finalize extra stat info passing.

virtual void	analyze ()
	Perform analyze (main part of CFLR Analysis)

Public Member Functions inherited from SVF::BVDataPTAImpl
	BVDataPTAImpl (SVFIR *pag, PointerAnalysis::PTATY type, bool alias_check=true)
	Constructor.

	~BVDataPTAImpl () override=default
	Destructor.

PersistentPointsToCache< PointsTo > &	getPtCache ()

const PointsTo &	getPts (NodeID id) override

const NodeSet &	getRevPts (NodeID nodeId) override

virtual void	clearPts (NodeID id, NodeID element)
	Remove element from the points-to set of id.

virtual void	clearFullPts (NodeID id)
	Clear points-to set of id.

virtual bool	unionPts (NodeID id, const PointsTo &target)

virtual bool	unionPts (NodeID id, NodeID ptd)

virtual bool	addPts (NodeID id, NodeID ptd)

virtual void	clearAllPts ()
	Clear all data.

virtual void	expandFIObjs (const PointsTo &pts, PointsTo &expandedPts)
	Expand FI objects.

virtual void	expandFIObjs (const NodeBS &pts, NodeBS &expandedPts)
	TODO: remove repetition.

void	remapPointsToSets (void)
	Remap all points-to sets to use the current mapping.

virtual void	writeToFile (const std::string &filename)
	Interface for analysis result storage on filesystem.

virtual void	writeObjVarToFile (const std::string &filename)

virtual void	writePtsResultToFile (std::fstream &f)

virtual void	writeGepObjVarMapToFile (std::fstream &f)

virtual bool	readFromFile (const std::string &filename)

virtual void	readPtsResultFromFile (std::ifstream &f)

virtual void	readGepObjVarMapFromFile (std::ifstream &f)

virtual void	readAndSetObjFieldSensitivity (std::ifstream &f, const std::string &delimiterStr)

AliasResult	alias (const SVFVar V1, const SVFVar V2) override
	Interface expose to users of our pointer analysis, given Value infos.

AliasResult	alias (NodeID node1, NodeID node2) override
	Interface expose to users of our pointer analysis, given PAGNodeID.

virtual AliasResult	alias (const PointsTo &pts1, const PointsTo &pts2)
	Interface expose to users of our pointer analysis, given two pts.

void	dumpCPts () override
	dump and debug, print out conditional pts

void	dumpTopLevelPtsTo () override

void	dumpAllPts () override

Public Member Functions inherited from SVF::PointerAnalysis
ICFG *	getICFG () const
	Get ICFG.

u32_t	getNumOfResolvedIndCallEdge () const
	Return number of resolved indirect call edges.

CallGraph *	getCallGraph () const
	Return call graph.

CallGraphSCC *	getCallGraphSCC () const
	Return call graph SCC.

	PointerAnalysis (SVFIR *pag, PTATY ty=Default_PTA, bool alias_check=true)
	Constructor.

PTATY	getAnalysisTy () const
	Type of pointer analysis.

PTAImplTy	getImplTy () const
	Return implementation type of the pointer analysis.

bool	printStat ()
	Whether print statistics.

void	disablePrintStat ()
	Whether print statistics.

CallEdgeMap &	getIndCallMap ()
	Get callees from an indirect callsite.

bool	hasIndCSCallees (const CallICFGNode *cs) const

const FunctionSet &	getIndCSCallees (const CallICFGNode *cs) const

virtual void	resolveIndCalls (const CallICFGNode *cs, const PointsTo &target, CallEdgeMap &newEdges)
	Resolve indirect call edges.

void	callGraphSCCDetection ()
	PTACallGraph SCC related methods.

NodeID	getCallGraphSCCRepNode (NodeID id) const
	Get SCC rep node of a SVFG node.

bool	inSameCallGraphSCC (const FunObjVar fun1, const FunObjVar fun2)
	Return TRUE if this edge is inside a PTACallGraph SCC, i.e., src node and dst node are in the same SCC on the SVFG.

bool	isInRecursion (const FunObjVar *fun) const

bool	isLocalVarInRecursiveFun (NodeID id) const
	Whether a local variable is in function recursions.

virtual const std::string	PTAName () const
	Return PTA name.

CommonCHGraph *	getCHGraph () const
	get CHGraph

void	getVFnsFromCHA (const CallICFGNode *cs, VFunSet &vfns)

void	getVFnsFromPts (const CallICFGNode *cs, const PointsTo &target, VFunSet &vfns)

void	connectVCallToVFns (const CallICFGNode *cs, const VFunSet &vfns, CallEdgeMap &newEdges)

virtual void	resolveCPPIndCalls (const CallICFGNode *cs, const PointsTo &target, CallEdgeMap &newEdges)
	Resolve cpp indirect call edges.

SVFIR *	getPAG () const

PTAStat *	getStat () const
	Get PTA stat.

OrderedNodeSet &	getAllValidPtrs ()
	Get all Valid Pointers for resolution.

virtual void	initialize ()
	Initialization of a pointer analysis, including building symbol table and SVFIR etc.

virtual void	computeDDAPts (NodeID)
	Compute points-to results on-demand, overridden by derived classes.

void	printIndCSTargets (const CallICFGNode *cs, const FunctionSet &targets)
	Print targets of a function pointer.

virtual void	dumpPts (NodeID ptr, const PointsTo &pts)

void	printIndCSTargets ()

void	dumpAllTypes ()

void	dumpStat ()
	Dump the statistics.

bool	containBlackHoleNode (const PointsTo &pts)
	Determine whether a points-to contains a black hole or constant node.

bool	containConstantNode (const PointsTo &pts)

virtual bool	isBlkObjOrConstantObj (NodeID ptd) const

bool	isHeapMemObj (NodeID id) const
	Whether this object is heap or array.

bool	isArrayMemObj (NodeID id) const

bool	isFIObjNode (NodeID id) const

NodeID	getBaseObjVar (NodeID id)

NodeID	getFIObjVar (NodeID id)

NodeID	getGepObjVar (NodeID id, const APOffset &ap)

virtual const NodeBS &	getAllFieldsObjVars (NodeID id)

void	setObjFieldInsensitive (NodeID id)

bool	isFieldInsensitive (NodeID id) const

Static Public Attributes
static double	timeOfBuildCFLGrammar = 0
	Statistics.

static double	timeOfNormalizeGrammar = 0

static double	timeOfBuildCFLGraph = 0

static double	numOfTerminalEdges = 0

static double	numOfTemporaryNonterminalEdges = 0

static double	numOfNonterminalEdges = 0

static double	numOfStartEdges = 0

static double	numOfIteration = 1

static double	numOfChecks = 1

static double	timeOfSolving = 0

Static Public Attributes inherited from SVF::PointerAnalysis
static const std::string	aliasTestMayAlias = "MAYALIAS"

static const std::string	aliasTestMayAliasMangled = "_Z8MAYALIASPvS_"

static const std::string	aliasTestNoAlias = "NOALIAS"

static const std::string	aliasTestNoAliasMangled = "_Z7NOALIASPvS_"

static const std::string	aliasTestPartialAlias = "PARTIALALIAS"

static const std::string	aliasTestPartialAliasMangled = "_Z12PARTIALALIASPvS_"

static const std::string	aliasTestMustAlias = "MUSTALIAS"

static const std::string	aliasTestMustAliasMangled = "_Z9MUSTALIASPvS_"

static const std::string	aliasTestFailMayAlias = "EXPECTEDFAIL_MAYALIAS"

static const std::string	aliasTestFailMayAliasMangled = "_Z21EXPECTEDFAIL_MAYALIASPvS_"

static const std::string	aliasTestFailNoAlias = "EXPECTEDFAIL_NOALIAS"

static const std::string	aliasTestFailNoAliasMangled = "_Z20EXPECTEDFAIL_NOALIASPvS_"

Protected Attributes
SVFIR *	svfir

CFLGraph *	graph

GrammarBase *	grammarBase

CFGrammar *	grammar

CFLSolver *	solver

Protected Attributes inherited from SVF::PointerAnalysis
bool	print_stat
	User input flags.

bool	alias_validation
	Flag for validating points-to/alias results.

u32_t	OnTheFlyIterBudgetForStat
	Flag for iteration budget for on-the-fly statistics.

PTATY	ptaTy
	Pointer analysis Type.

PTAImplTy	ptaImplTy
	PTA implementation type.

PTAStat *	stat
	Statistics.

CallGraph *	callgraph
	Call graph used for pointer analysis.

CallGraphSCC *	callGraphSCC
	SCC for PTACallGraph.

ICFG *	icfg
	Interprocedural control-flow graph.

CommonCHGraph *	chgraph
	CHGraph.

Additional Inherited Members
Public Types inherited from SVF::BVDataPTAImpl
enum	PTBackingType { Mutable , Persistent }
	How the PTData used is implemented. More...

typedef PTData< NodeID, NodeSet, NodeID, PointsTo >	PTDataTy

typedef DiffPTData< NodeID, NodeSet, NodeID, PointsTo >	DiffPTDataTy

typedef DFPTData< NodeID, NodeSet, NodeID, PointsTo >	DFPTDataTy

typedef VersionedPTData< NodeID, NodeSet, NodeID, PointsTo, VersionedVar, Set< VersionedVar > >	VersionedPTDataTy

typedef MutablePTData< NodeID, NodeSet, NodeID, PointsTo >	MutPTDataTy

typedef MutableDiffPTData< NodeID, NodeSet, NodeID, PointsTo >	MutDiffPTDataTy

typedef MutableDFPTData< NodeID, NodeSet, NodeID, PointsTo >	MutDFPTDataTy

typedef MutableIncDFPTData< NodeID, NodeSet, NodeID, PointsTo >	MutIncDFPTDataTy

typedef MutableVersionedPTData< NodeID, NodeSet, NodeID, PointsTo, VersionedVar, Set< VersionedVar > >	MutVersionedPTDataTy

typedef PersistentPTData< NodeID, NodeSet, NodeID, PointsTo >	PersPTDataTy

typedef PersistentDiffPTData< NodeID, NodeSet, NodeID, PointsTo >	PersDiffPTDataTy

typedef PersistentDFPTData< NodeID, NodeSet, NodeID, PointsTo >	PersDFPTDataTy

typedef PersistentIncDFPTData< NodeID, NodeSet, NodeID, PointsTo >	PersIncDFPTDataTy

typedef PersistentVersionedPTData< NodeID, NodeSet, NodeID, PointsTo, VersionedVar, Set< VersionedVar > >	PersVersionedPTDataTy

Public Types inherited from SVF::PointerAnalysis
enum	PTATY { Andersen_BASE , Andersen_WPA , AndersenSCD_WPA , AndersenSFR_WPA , AndersenWaveDiff_WPA , Steensgaard_WPA , CSCallString_WPA , CSSummary_WPA , FSDATAFLOW_WPA , FSSPARSE_WPA , VFS_WPA , FSCS_WPA , CFLFICI_WPA , CFLFSCI_WPA , CFLFSCS_WPA , TypeCPP_WPA , FieldS_DDA , FlowS_DDA , PathS_DDA , Cxt_DDA , Default_PTA }
	Pointer analysis type list. More...

enum	PTAImplTy { BaseImpl , BVDataImpl , CondImpl }
	Implementation type: BVDataPTAImpl or CondPTAImpl. More...

typedef Set< const CallICFGNode * >	CallSiteSet
	Indirect call edges type, map a callsite to a set of callees.

typedef SVFIR::CallSiteToFunPtrMap	CallSiteToFunPtrMap

typedef Set< const FunObjVar * >	FunctionSet

typedef OrderedMap< const CallICFGNode *, FunctionSet >	CallEdgeMap

typedef SCCDetection< CallGraph * >	CallGraphSCC

typedef Set< const GlobalObjVar * >	VTableSet

typedef Set< const FunObjVar * >	VFunSet

Static Public Member Functions inherited from SVF::BVDataPTAImpl
static bool	classof (const PointerAnalysis *pta)

Protected Member Functions inherited from SVF::BVDataPTAImpl
PTDataTy *	getPTDataTy () const
	Get points-to data structure.

virtual bool	updateCallGraph (const CallSiteToFunPtrMap &)
	Update callgraph. This should be implemented by its subclass.

DiffPTDataTy *	getDiffPTDataTy () const

DFPTDataTy *	getDFPTDataTy () const

MutDFPTDataTy *	getMutDFPTDataTy () const

VersionedPTDataTy *	getVersionedPTDataTy () const

virtual void	onTheFlyCallGraphSolve (const CallSiteToFunPtrMap &callsites, CallEdgeMap &newEdges)
	On the fly call graph construction.

virtual void	onTheFlyThreadCallGraphSolve (const CallSiteToFunPtrMap &callsites, CallEdgeMap &newForkEdges)
	On the fly thread call graph construction respecting forksite.

virtual void	normalizePointsTo ()

Protected Member Functions inherited from SVF::PointerAnalysis
const CallSiteToFunPtrMap &	getIndirectCallsites () const
	Return all indirect callsites.

NodeID	getFunPtr (const CallICFGNode *cs) const
	Return function pointer PAGNode at a callsite cs.

virtual void	validateTests ()
	Alias check functions to verify correctness of pointer analysis.

virtual void	validateSuccessTests (std::string fun)

virtual void	validateExpectedFailureTests (std::string fun)

void	resetObjFieldSensitive ()
	Reset all object node as field-sensitive.

Static Protected Attributes inherited from SVF::PointerAnalysis
static SVFIR *	pag = nullptr
	SVFIR.

Detailed Description

CFL Client Base Class.

Definition at line 49 of file CFLBase.h.

Constructor & Destructor Documentation

◆ CFLBase()

SVF::CFLBase::CFLBase	(	SVFIR *	ir,
		PointerAnalysis::PTATY	pty
	)

inline

Definition at line 53 of file CFLBase.h.

                                                 : BVDataPTAImpl(ir, pty), svfir(ir), graph(nullptr), grammar(nullptr), solver(nullptr)
    {
    }

◆ ~CFLBase()

virtual SVF::CFLBase::~CFLBase ( )

inlinevirtual

Destructor.

Definition at line 58 of file CFLBase.h.

    {
        delete solver;
        delete grammarBase;
    }

Member Function Documentation

◆ analyze()

void SVF::CFLBase::analyze ( )

virtual

Perform analyze (main part of CFLR Analysis)

Implements SVF::PointerAnalysis.

Definition at line 136 of file CFLBase.cpp.

{
    initialize();
 
    solve();
 
    finalize();
}

◆ buildCFLGrammar()

void SVF::CFLBase::buildCFLGrammar ( )

virtual

Build Grammar from text file.

Definition at line 65 of file CFLBase.cpp.

{
    // Start building grammar
    double start = stat->getClk(true);
 
    GrammarBuilder grammarBuilder = GrammarBuilder(Options::GrammarFilename());
    grammarBase = grammarBuilder.build();
 
    // Get time of build grammar
    double end = stat->getClk(true);
    timeOfBuildCFLGrammar += (end - start) / TIMEINTERVAL;
}

◆ buildCFLGraph()

void SVF::CFLBase::buildCFLGraph ( )

virtual

Build CFLGraph based on Option.

Reimplemented in SVF::CFLVF.

Definition at line 78 of file CFLBase.cpp.

{
    // Start building CFLGraph
    double start = stat->getClk(true);
 
    AliasCFLGraphBuilder cflGraphBuilder = AliasCFLGraphBuilder();
    if (Options::CFLGraph().empty()) // built from svfir
    {
        PointerAnalysis::initialize();
        ConstraintGraph *consCG = new ConstraintGraph(svfir);
        if (Options::PEGTransfer())
            graph = cflGraphBuilder.buildBiPEGgraph(consCG, grammarBase->getStartKind(), grammarBase, svfir);
        else
            graph = cflGraphBuilder.buildBigraph(consCG, grammarBase->getStartKind(), grammarBase);
        delete consCG;
    }
    else
        graph = cflGraphBuilder.build(Options::CFLGraph(), grammarBase);
    // Check CFL Graph and Grammar are accordance with grammar
    CFLGramGraphChecker cflChecker = CFLGramGraphChecker();
    cflChecker.check(grammarBase, &cflGraphBuilder, graph);
 
    // Get time of build graph
    double end = stat->getClk(true);
    timeOfBuildCFLGraph += (end - start) / TIMEINTERVAL;
}

◆ checkParameter()

void SVF::CFLBase::checkParameter ( )

virtual

Parameter Checking.

Reimplemented in SVF::CFLVF.

Definition at line 49 of file CFLBase.cpp.

{
    // Check for valid grammar file before parsing other options
    std::string filename = Options::GrammarFilename();
    bool pagfile = (filename.rfind("PAGGrammar.txt") == filename.length() - std::string("PAGGrammar.txt").length());
    bool pegfile = (filename.rfind("PEGGrammar.txt") == filename.length() - std::string("PEGGrammar.txt").length());
    bool vfgfile = (filename.rfind("VFGGrammar.txt") == filename.length() - std::string("VFGGrammar.txt").length());
    if (!Options::Customized()  && !(pagfile || pegfile || vfgfile))
    {
        SVFUtil::errs() << "Invalid alias grammar file: " << Options::GrammarFilename() << "\n"
                        << "Please use a file that ends with either 'CFGrammar.txt' or 'PEGGrammar.txt', "
                        << "or use the -customized flag to allow custom grammar files.\n";
        assert(false && "grammar loading failed!");  // exit with error
    }
}

◆ countSumEdges()

void SVF::CFLBase::countSumEdges ( )

virtual

Count the num of Nonterminal Edges.

Definition at line 150 of file CFLBase.cpp.

{
    numOfStartEdges = 0;
    for(auto it = getCFLGraph()->getCFLEdges().begin(); it != getCFLGraph()->getCFLEdges().end(); it++ )
    {
        if ((*it)->getEdgeKind() == grammar->getStartKind())
            numOfStartEdges++;
    }
}

◆ finalize()

void SVF::CFLBase::finalize ( )

virtual

Finalize extra stat info passing.

Reimplemented from SVF::BVDataPTAImpl.

Reimplemented in SVF::CFLAlias, and SVF::CFLVF.

Definition at line 129 of file CFLBase.cpp.

{
    numOfChecks = solver->numOfChecks;
 
    BVDataPTAImpl::finalize();
}

◆ getCFLGraph()

CFLGraph * SVF::CFLBase::getCFLGraph ( )

Get CFL graph.

Definition at line 145 of file CFLBase.cpp.

{
    return graph;
}

◆ normalizeCFLGrammar()

void SVF::CFLBase::normalizeCFLGrammar ( )

virtual

Normalize grammar.

Definition at line 105 of file CFLBase.cpp.

{
    // Start normalize grammar
    double start = stat->getClk(true);
 
    CFGNormalizer normalizer = CFGNormalizer();
    grammar = normalizer.normalize(grammarBase);
 
    // Get time of normalize grammar
    double end = stat->getClk(true);
    timeOfNormalizeGrammar += (end - start) / TIMEINTERVAL;
}

◆ solve()

void SVF::CFLBase::solve ( )

virtual

Solving CFL Reachability.

Reimplemented in SVF::CFLAlias.

Definition at line 118 of file CFLBase.cpp.

{
    // Start solving
    double start = stat->getClk(true);
 
    solver->solve();
 
    double end = stat->getClk(true);
    timeOfSolving += (end - start) / TIMEINTERVAL;
}

Member Data Documentation

◆ grammar

CFGrammar* SVF::CFLBase::grammar

protected

Definition at line 112 of file CFLBase.h.

◆ grammarBase

GrammarBase* SVF::CFLBase::grammarBase

protected

Definition at line 111 of file CFLBase.h.

◆ graph

CFLGraph* SVF::CFLBase::graph

protected

Definition at line 110 of file CFLBase.h.

◆ numOfChecks

double SVF::CFLBase::numOfChecks = 1

static

Definition at line 104 of file CFLBase.h.

◆ numOfIteration

double SVF::CFLBase::numOfIteration = 1

static

Definition at line 103 of file CFLBase.h.

◆ numOfNonterminalEdges

double SVF::CFLBase::numOfNonterminalEdges = 0

static

Definition at line 100 of file CFLBase.h.

◆ numOfStartEdges

double SVF::CFLBase::numOfStartEdges = 0

static

Definition at line 101 of file CFLBase.h.

◆ numOfTemporaryNonterminalEdges

double SVF::CFLBase::numOfTemporaryNonterminalEdges = 0

static

Definition at line 99 of file CFLBase.h.

◆ numOfTerminalEdges

double SVF::CFLBase::numOfTerminalEdges = 0

static

Definition at line 98 of file CFLBase.h.

◆ solver

CFLSolver* SVF::CFLBase::solver

protected

Definition at line 113 of file CFLBase.h.

◆ svfir

SVFIR* SVF::CFLBase::svfir

protected

Definition at line 109 of file CFLBase.h.

◆ timeOfBuildCFLGrammar

double SVF::CFLBase::timeOfBuildCFLGrammar = 0

static

Statistics.

Definition at line 94 of file CFLBase.h.

◆ timeOfBuildCFLGraph

double SVF::CFLBase::timeOfBuildCFLGraph = 0

static

Definition at line 97 of file CFLBase.h.

◆ timeOfNormalizeGrammar

double SVF::CFLBase::timeOfNormalizeGrammar = 0

static

Definition at line 95 of file CFLBase.h.

◆ timeOfSolving

double SVF::CFLBase::timeOfSolving = 0

static

Definition at line 105 of file CFLBase.h.

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

/home/runner/work/SVF/SVF/svf/include/CFL/CFLBase.h
/home/runner/work/SVF/SVF/svf/lib/CFL/CFLBase.cpp

Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CFLBase()

◆ ~CFLBase()

Member Function Documentation

◆ analyze()

◆ buildCFLGrammar()

◆ buildCFLGraph()

◆ checkParameter()

◆ countSumEdges()

◆ finalize()

◆ getCFLGraph()

◆ normalizeCFLGrammar()

◆ solve()

Member Data Documentation

◆ grammar

◆ grammarBase

◆ graph

◆ numOfChecks

◆ numOfIteration

◆ numOfNonterminalEdges

◆ numOfStartEdges

◆ numOfTemporaryNonterminalEdges

◆ numOfTerminalEdges

◆ solver

◆ svfir

◆ timeOfBuildCFLGrammar

◆ timeOfBuildCFLGraph

◆ timeOfNormalizeGrammar

◆ timeOfSolving