svf-ex.cpp File Reference

#include "AE/Core/AbstractState.h"
#include "Graphs/SVFG.h"
#include "MSSA/SVFGBuilder.h"
#include "SVF-LLVM/LLVMUtil.h"
#include "SVF-LLVM/SVFIRBuilder.h"
#include "Util/CommandLine.h"
#include "Util/Options.h"
#include "WPA/Andersen.h"

Go to the source code of this file.

Functions
SVF::AliasResult	aliasQuery (PointerAnalysis *pta, const SVFVar *v1, const SVFVar *v2)
std::string	printPts (PointerAnalysis *pta, const SVFVar *svfval)
void	traverseOnICFG (ICFG *icfg, const ICFGNode *iNode)
void	dummyVisit (const VFGNode *node)
void	traverseOnVFG (const SVFG *vfg, const ValVar *svfval)
int	main (int argc, char **argv)

Function Documentation

aliasQuery()

SVF::AliasResult aliasQuery	(	PointerAnalysis *	pta,
		const SVFVar *	v1,
		const SVFVar *	v2
	)

An example to query alias results of two SVF values

Definition at line 45 of file svf-ex.cpp.

{
    return pta->alias(v1->getId(), v2->getId());
}

dummyVisit()

void dummyVisit

(

const VFGNode *

node

)

Definition at line 99 of file svf-ex.cpp.

{
 
}

main()

int main	(	int	argc,
		char **	argv
	)

Build Program Assignment Graph (SVFIR)

Create Andersen's pointer analysis

Call Graph

ICFG

Value-Flow Graph (VFG)

Sparse value-flow graph (SVFG)

Collect uses of an LLVM Value

Print points-to information

Collect all successor nodes on ICFG

Definition at line 143 of file svf-ex.cpp.

{
 
    std::vector<std::string> moduleNameVec;
    moduleNameVec = OptionBase::parseOptions(
                        argc, argv, "Whole Program Points-to Analysis", "[options] <input-bitcode...>"
                    );
 
    LLVMModuleSet::preProcessBCs(moduleNameVec);
    LLVMModuleSet::buildSVFModule(moduleNameVec);
 
    SVFIRBuilder builder;
    SVFIR* pag = builder.build();
 
    Andersen* ander = AndersenWaveDiff::createAndersenWaveDiff(pag);
 
 
    CallGraph* callgraph = ander->getCallGraph();
 
    ICFG* icfg = pag->getICFG();
 
    VFG* vfg = new VFG(callgraph);
 
    SVFGBuilder svfBuilder;
    SVFG* svfg = svfBuilder.buildFullSVFG(ander);
 
    if (Options::PTSPrint())
    {
        for (const auto& it : *svfg)
        {
            const SVFGNode* node = it.second;
            if (node->getValue())
            {
                if (const ValVar* valVar = SVFUtil::dyn_cast<ValVar>(node->getValue()))
                {
                    traverseOnVFG(svfg, valVar);
                }
                printPts(ander, node->getValue());
                for (const SVFGEdge* edge : node->getOutEdges())
                {
                    const SVFGNode* node2 = edge->getDstNode();
                    if (node2->getValue())
                        aliasQuery(ander, node->getValue(), node2->getValue());
                }
            }
        }
    }
 
    if (Options::PTSPrint())
    {
        for (const auto& it : *icfg)
        {
            const ICFGNode* node = it.second;
            traverseOnICFG(icfg, node);
        }
    }
 
    // clean up memory
    delete vfg;
    AndersenWaveDiff::releaseAndersenWaveDiff();
    SVFIR::releaseSVFIR();
 
    LLVMModuleSet::getLLVMModuleSet()->dumpModulesToFile(".svf.bc");
    SVF::LLVMModuleSet::releaseLLVMModuleSet();
#if LLVM_VERSION_MAJOR < 21
    llvm::llvm_shutdown();
#endif
    return 0;
}

printPts()

std::string printPts	(	PointerAnalysis *	pta,
		const SVFVar *	svfval
	)

An example to print points-to set of an SVF value

Definition at line 53 of file svf-ex.cpp.

{
 
    std::string str;
    raw_string_ostream rawstr(str);
 
    NodeID pNodeId = svfval->getId();
    const PointsTo& pts = pta->getPts(pNodeId);
    for (PointsTo::iterator ii = pts.begin(), ie = pts.end();
            ii != ie; ii++)
    {
        rawstr << " " << *ii << " ";
        PAGNode* targetObj = pta->getPAG()->getGNode(*ii);
        rawstr << "(" << targetObj->toString() << ")\t ";
    }
 
    return rawstr.str();
 
}

traverseOnICFG()

void traverseOnICFG	(	ICFG *	icfg,
		const ICFGNode *	iNode
	)

An example to query/collect all successor nodes from a ICFGNode (iNode) along control-flow graph (ICFG)

Traverse along VFG

Definition at line 75 of file svf-ex.cpp.

{
    FIFOWorkList<const ICFGNode*> worklist;
    Set<const ICFGNode*> visited;
    worklist.push(iNode);
 
    while (!worklist.empty())
    {
        const ICFGNode* vNode = worklist.pop();
        for (ICFGNode::const_iterator it = vNode->OutEdgeBegin(), eit =
                    vNode->OutEdgeEnd(); it != eit; ++it)
        {
            ICFGEdge* edge = *it;
            ICFGNode* succNode = edge->getDstNode();
            if (visited.find(succNode) == visited.end())
            {
                visited.insert(succNode);
                worklist.push(succNode);
            }
        }
    }
}

traverseOnVFG()

void traverseOnVFG	(	const SVFG *	vfg,
		const ValVar *	svfval
	)

An example to query/collect all the uses of a definition of a value along value-flow graph (VFG)

Traverse along VFG

Collect all LLVM Values

can only query VFGNode involving top-level pointers (starting with % or @ in LLVM IR) PAGNode* pNode = vfg->getLHSTopLevPtr(node); Value* val = pNode->getValue();

Definition at line 106 of file svf-ex.cpp.

{
    if (!vfg->hasDefSVFGNode(svfval))
        return;
    const VFGNode* vNode = vfg->getDefSVFGNode(svfval);
    FIFOWorkList<const VFGNode*> worklist;
    Set<const VFGNode*> visited;
    worklist.push(vNode);
 
    while (!worklist.empty())
    {
        const VFGNode* vNode = worklist.pop();
        for (VFGNode::const_iterator it = vNode->OutEdgeBegin(), eit =
                    vNode->OutEdgeEnd(); it != eit; ++it)
        {
            VFGEdge* edge = *it;
            VFGNode* succNode = edge->getDstNode();
            if (visited.find(succNode) == visited.end())
            {
                visited.insert(succNode);
                worklist.push(succNode);
            }
        }
    }
 
    for(Set<const VFGNode*>::const_iterator it = visited.begin(), eit = visited.end(); it!=eit; ++it)
    {
        const VFGNode* node = *it;
        dummyVisit(node);
    }
}