SVF::SVFStat Class Reference

#include <SVFStat.h>

Inheritance diagram for SVF::SVFStat:

Public Types
enum class	ClockType { Wall , CPU }
typedef OrderedMap< std::string, u32_t >	NUMStatMap
typedef OrderedMap< std::string, double >	TIMEStatMap

Public Member Functions
	SVFStat ()
virtual	~SVFStat ()
virtual void	startClk ()
virtual void	endClk ()
virtual void	performStat ()=0
virtual void	printStat (std::string str="")
virtual void	performStatPerQuery (NodeID)
virtual void	printStatPerQuery (NodeID, const PointsTo &)
virtual void	callgraphStat ()

Static Public Member Functions
static double	getClk (bool mark=false)

Public Attributes
NUMStatMap	generalNumMap
NUMStatMap	PTNumStatMap
TIMEStatMap	timeStatMap
double	startTime
double	endTime

Static Public Attributes
static bool	printGeneralStats = true
	SVF's general statistics are only printed once even if you run multiple anayses.
static double	timeOfBuildingLLVMModule = 0
static double	timeOfBuildingSymbolTable = 0
static double	timeOfBuildingSVFIR = 0

Private Member Functions
void	branchStat ()

Private Attributes
std::string	moduleName

Detailed Description

Pointer Analysis Statistics

Definition at line 43 of file SVFStat.h.

Member Typedef Documentation

NUMStatMap

typedef OrderedMap<std::string, u32_t> SVF::SVFStat::NUMStatMap

Definition at line 47 of file SVFStat.h.

TIMEStatMap

typedef OrderedMap<std::string, double> SVF::SVFStat::TIMEStatMap

Definition at line 49 of file SVFStat.h.

Member Enumeration Documentation

ClockType

enum class SVF::SVFStat::ClockType

strong

Enumerator
Wall
CPU

Definition at line 51 of file SVFStat.h.

    {
        Wall,
        CPU,
    };

Constructor & Destructor Documentation

SVFStat()

SVFStat::SVFStat

(

)

Definition at line 46 of file SVFStat.cpp.

                 : startTime(0), endTime(0)
{
    assert((Options::ClockType() == ClockType::Wall || Options::ClockType() == ClockType::CPU)
           && "PTAStat: unknown clock type!");
}

~SVFStat()

virtual SVF::SVFStat::~SVFStat ( )

inlinevirtual

Definition at line 59 of file SVFStat.h.

{}

Member Function Documentation

branchStat()

void SVFStat::branchStat ( )

private

Definition at line 226 of file SVFStat.cpp.

{
    u32_t numOfBB_2Succ = 0;
    u32_t numOfBB_3Succ = 0;
    const CallGraph* svfirCallGraph = PAG::getPAG()->getCallGraph();
    for (const auto& item: *svfirCallGraph)
    {
        const FunObjVar* func = item.second->getFunction();
        for (FunObjVar::const_bb_iterator bbIt = func->begin(), bbEit = func->end();
                bbIt != bbEit; ++bbIt)
        {
            const SVFBasicBlock* bb = bbIt->second;
            u32_t numOfSucc = bb->getNumSuccessors();
            if (numOfSucc == 2)
                numOfBB_2Succ++;
            else if (numOfSucc > 2)
                numOfBB_3Succ++;
        }
    }
 
    generalNumMap["BBWith2Succ"] = numOfBB_2Succ;
    generalNumMap["BBWith3Succ"] = numOfBB_3Succ;
}

callgraphStat()

virtual void SVF::SVFStat::callgraphStat ( )

inlinevirtual

Reimplemented in SVF::PTAStat.

Definition at line 94 of file SVFStat.h.

{}

endClk()

virtual void SVF::SVFStat::endClk ( )

inlinevirtual

Definition at line 66 of file SVFStat.h.

    {
        endTime = getClk(true);
    }

getClk()

double SVFStat::getClk ( bool  mark = false )

static

When mark is true, real clock is always returned. When mark is false, it is only returned when Options::MarkedClocksOnly is not set. Default call for getClk is unmarked, while MarkedClocksOnly is false by default.

Definition at line 52 of file SVFStat.cpp.

{
    if (Options::MarkedClocksOnly() && !mark) return 0.0;
 
    if (Options::ClockType() == ClockType::Wall)
    {
        return std::chrono::duration<double, std::milli>(
                   std::chrono::steady_clock::now().time_since_epoch()
               ).count();
    }
    else if (Options::ClockType() == ClockType::CPU)
    {
        return CLOCK_IN_MS();
    }
 
    assert(false && "PTAStat::getClk: unknown clock type");
    abort();
}

performStat()

void SVFStat::performStat ( )

pure virtual

SVF's general statistics are only printed once even if you run multiple anayses

Implemented in SVF::CFLStat, SVF::ICFGStat, SVF::AndersenStat, SVF::FlowSensitiveStat, SVF::VersionedFlowSensitiveStat, SVF::AEStat, SVF::DDAStat, SVF::MemSSAStat, SVF::SVFGStat, and SVF::PTAStat.

Definition at line 114 of file SVFStat.cpp.

{
 
    if(printGeneralStats == false)
        return;
 
    SVFIR* pag = SVFIR::getPAG();
    u32_t numOfFunction = 0;
    u32_t numOfGlobal = 0;
    u32_t numOfStack = 0;
    u32_t numOfHeap = 0;
    u32_t numOfHasVarArray = 0;
    u32_t numOfHasVarStruct = 0;
    u32_t numOfHasConstArray = 0;
    u32_t numOfHasConstStruct = 0;
    u32_t numOfScalar = 0;
    u32_t numOfConstant = 0;
    u32_t fiObjNumber = 0;
    u32_t fsObjNumber = 0;
    Set<NodeID> memObjSet;
    for(SVFIR::iterator it = pag->begin(), eit = pag->end(); it!=eit; ++it)
    {
        PAGNode* node = it->second;
        if(ObjVar* obj = SVFUtil::dyn_cast<ObjVar>(node))
        {
            const BaseObjVar* mem = pag->getBaseObject(obj->getId());
            if (memObjSet.insert(mem->getId()).second == false)
                continue;
            if(mem->isBlackHoleObj())
                continue;
            if(mem->isFunction())
                numOfFunction++;
            if(mem->isGlobalObj())
                numOfGlobal++;
            if (pag->getBaseObject(obj->getId()) &&
                    SVFUtil::isa<StackObjVar>(
                        pag->getBaseObject(obj->getId())))
                numOfStack++;
            if (pag->getBaseObject(obj->getId()) &&
                    SVFUtil::isa<HeapObjVar, DummyObjVar>(
                        pag->getBaseObject(obj->getId())))
            {
                numOfHeap++;
            }
            if(mem->isVarArray())
                numOfHasVarArray++;
            if(mem->isVarStruct())
                numOfHasVarStruct++;
            if(mem->isConstantArray())
                numOfHasConstArray++;
            if(mem->isConstantStruct())
                numOfHasConstStruct++;
            if(mem->getType()->isPointerTy() == false)
                numOfScalar++;
            if(mem->isConstDataOrConstGlobal())
                numOfConstant++;
 
            if (mem->isFieldInsensitive())
                fiObjNumber++;
            else
                fsObjNumber++;
        }
    }
 
 
 
    generalNumMap["TotalPointers"] = pag->getValueNodeNum();
    generalNumMap["TotalObjects"] = pag->getObjectNodeNum();
    generalNumMap["TotalFieldObjects"] = pag->getFieldObjNodeNum();
    generalNumMap["MaxStructSize"] = pag->getMaxStructSize();
    generalNumMap["TotalSVFStmts"] = pag->getSVFStmtNum();
    generalNumMap["TotalPTASVFStmts"] = pag->getPTAPAGEdgeNum();
    generalNumMap["FIObjNum"] = fiObjNumber;
    generalNumMap["FSObjNum"] = fsObjNumber;
 
    generalNumMap["AddrsNum"] = pag->getSVFStmtSet(SVFStmt::Addr).size();
    generalNumMap["LoadsNum"] = pag->getSVFStmtSet(SVFStmt::Load).size();
    generalNumMap["StoresNum"] = pag->getSVFStmtSet(SVFStmt::Store).size();
    generalNumMap["CopysNum"] =  pag->getSVFStmtSet(SVFStmt::Copy).size();
    generalNumMap["GepsNum"] =  pag->getSVFStmtSet(SVFStmt::Gep).size();
    generalNumMap["CallsNum"] = pag->getSVFStmtSet(SVFStmt::Call).size();
    generalNumMap["ReturnsNum"] = pag->getSVFStmtSet(SVFStmt::Ret).size();
 
    generalNumMap["FunctionObjs"] = numOfFunction;
    generalNumMap["GlobalObjs"] = numOfGlobal;
    generalNumMap["HeapObjs"]  = numOfHeap;
    generalNumMap["StackObjs"] = numOfStack;
 
    generalNumMap["VarStructObj"] = numOfHasVarStruct;
    generalNumMap["VarArrayObj"] = numOfHasVarArray;
    generalNumMap["ConstStructObj"] = numOfHasConstStruct;
    generalNumMap["ConstArrayObj"] = numOfHasConstArray;
    generalNumMap["NonPtrObj"] = numOfScalar;
    generalNumMap["ConstantObj"] = numOfConstant;
 
    generalNumMap["IndCallSites"] = pag->getIndirectCallsites().size();
    generalNumMap["TotalCallSite"] = pag->getCallSiteSet().size();
 
    timeStatMap["LLVMIRTime"] = SVFStat::timeOfBuildingLLVMModule;
    timeStatMap["SymbolTableTime"] = SVFStat::timeOfBuildingSymbolTable;
    timeStatMap["SVFIRTime"] = SVFStat::timeOfBuildingSVFIR;
 
    // REFACTOR-TODO bitcastInstStat();
    branchStat();
 
    printStat("General Stats");
 
    printGeneralStats = false;
}

performStatPerQuery()

virtual void SVF::SVFStat::performStatPerQuery ( NodeID  )

inlinevirtual

Reimplemented in SVF::DDAStat.

Definition at line 90 of file SVFStat.h.

{}

printStat()

void SVFStat::printStat ( std::string  str = "" )

virtual

Reimplemented in SVF::ICFGStat, SVF::DDAStat, SVF::MemSSAStat, and SVF::SVFGStat.

Definition at line 71 of file SVFStat.cpp.

{
 
    std::string moduleName(SVFIR::getPAG()->getModuleIdentifier());
    std::vector<std::string> names = SVFUtil::split(moduleName,'/');
    if (names.size() > 1)
    {
        moduleName = names[names.size() - 1];
    }
 
    SVFUtil::outs() << "\n*********" << statname << "***************\n";
    SVFUtil::outs() << "################ (program : " << moduleName << ")###############\n";
    SVFUtil::outs().flags(std::ios::left);
    unsigned field_width = 20;
 
    for(NUMStatMap::iterator it = generalNumMap.begin(), eit = generalNumMap.end(); it!=eit; ++it)
    {
        // format out put with width 20 space
        std::cout << std::setw(field_width) << it->first << it->second << "\n";
    }
 
    if(!timeStatMap.empty())
        SVFUtil::outs() << "----------------Time and memory stats--------------------\n";
    for(TIMEStatMap::iterator it = timeStatMap.begin(), eit = timeStatMap.end(); it!=eit; ++it)
    {
        // format out put with width 20 space
        SVFUtil::outs() << std::setw(field_width) << it->first << it->second << "\n";
    }
 
    if(!PTNumStatMap.empty())
        SVFUtil::outs() << "----------------Numbers stats----------------------------\n";
    for(NUMStatMap::iterator it = PTNumStatMap.begin(), eit = PTNumStatMap.end(); it!=eit; ++it)
    {
        // format out put with width 20 space
        SVFUtil::outs() << std::setw(field_width) << it->first << it->second << "\n";
    }
    SVFUtil::outs() << "#######################################################" << std::endl;
    SVFUtil::outs().flush();
    generalNumMap.clear();
    PTNumStatMap.clear();
    timeStatMap.clear();
}

printStatPerQuery()

virtual void SVF::SVFStat::printStatPerQuery ( NodeID  , const PointsTo &    )

inlinevirtual

Reimplemented in SVF::DDAStat.

Definition at line 92 of file SVFStat.h.

{}

startClk()

virtual void SVF::SVFStat::startClk ( )

inlinevirtual

Definition at line 61 of file SVFStat.h.

    {
        startTime = getClk(true);
    }

Member Data Documentation

endTime

double SVF::SVFStat::endTime

Definition at line 84 of file SVFStat.h.

generalNumMap

NUMStatMap SVF::SVFStat::generalNumMap

Definition at line 79 of file SVFStat.h.

moduleName

std::string SVF::SVFStat::moduleName

private

Definition at line 102 of file SVFStat.h.

printGeneralStats

bool SVFStat::printGeneralStats = true

static

SVF's general statistics are only printed once even if you run multiple anayses.

Definition at line 77 of file SVFStat.h.

PTNumStatMap

NUMStatMap SVF::SVFStat::PTNumStatMap

Definition at line 80 of file SVFStat.h.

startTime

double SVF::SVFStat::startTime

Definition at line 83 of file SVFStat.h.

timeOfBuildingLLVMModule

double SVFStat::timeOfBuildingLLVMModule = 0

static

Definition at line 96 of file SVFStat.h.

timeOfBuildingSVFIR

double SVFStat::timeOfBuildingSVFIR = 0

static

Definition at line 98 of file SVFStat.h.

timeOfBuildingSymbolTable

double SVFStat::timeOfBuildingSymbolTable = 0

static

Definition at line 97 of file SVFStat.h.

timeStatMap

TIMEStatMap SVF::SVFStat::timeStatMap

Definition at line 81 of file SVFStat.h.

---

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

• /home/runner/work/SVF/SVF/svf/include/Util/SVFStat.h
• /home/runner/work/SVF/SVF/svf/lib/Util/SVFStat.cpp