#include <CHG.h>

Inheritance diagram for SVF::CHGraph:

Public Types
enum	RELATIONTYPE { CONSTRUCTOR = 0x1 , DESTRUCTOR = 0x2 }
typedef Set< const CHNode * >	CHNodeSetTy
typedef FIFOWorkList< const CHNode * >	WorkList
typedef Map< std::string, CHNodeSetTy >	NameToCHNodesMap
typedef Map< const ICFGNode *, CHNodeSetTy >	CallNodeToCHNodesMap
typedef Map< const ICFGNode *, VTableSet >	CallNodeToVTableSetMap
typedef Map< const ICFGNode *, VFunSet >	CallNodeToVFunSetMap
Public Types inherited from SVF::CommonCHGraph
enum	CHGKind { Standard , DI }
Public Types inherited from SVF::GenericGraph< CHNode, CHEdge >
typedef CHNode	NodeType
typedef CHEdge	EdgeType
typedef OrderedMap< NodeID, NodeType * >	IDToNodeMapTy
	NodeID to GenericNode map.
typedef IDToNodeMapTy::iterator	iterator
	Node Iterators.
typedef IDToNodeMapTy::const_iterator	const_iterator

Public Member Functions
	CHGraph ()
	~CHGraph () override=default
void	addEdge (const std::string className, const std::string baseClassName, CHEdge::CHEDGETYPE edgeType)
CHNode *	getNode (const std::string name) const
void	getVFnsFromVtbls (const CallICFGNode *cs, const VTableSet &vtbls, VFunSet &virtualFunctions) override
void	dump (const std::string &filename)
void	view ()
void	printCH ()
u32_t	getVirtualFunctionID (const FunObjVar *vfn) const
const FunObjVar *	getVirtualFunctionBasedonID (u32_t id) const
void	addInstances (const std::string templateName, CHNode *node)
const CHNodeSetTy &	getDescendants (const std::string className)
const CHNodeSetTy &	getInstances (const std::string className)
bool	csHasVtblsBasedonCHA (const CallICFGNode *cs) override
bool	csHasVFnsBasedonCHA (const CallICFGNode *cs) override
const VTableSet &	getCSVtblsBasedonCHA (const CallICFGNode *cs) override
const VFunSet &	getCSVFsBasedonCHA (const CallICFGNode *cs) override
Public Member Functions inherited from SVF::CommonCHGraph
virtual	~CommonCHGraph ()
CHGKind	getKind (void) const
Public Member Functions inherited from SVF::GenericGraph< CHNode, CHEdge >
	GenericGraph ()
	Constructor.
virtual	~GenericGraph ()
	Destructor.
void	destroy ()
	Release memory.
iterator	begin ()
	Iterators.
iterator	end ()
const_iterator	begin () const
const_iterator	end () const
void	addGNode (NodeID id, NodeType *node)
	Add a Node.
NodeType *	getGNode (NodeID id) const
	Get a node.
bool	hasGNode (NodeID id) const
	Has a node.
void	removeGNode (NodeType *node)
	Delete a node.
u32_t	getTotalNodeNum () const
	Get total number of node/edge.
u32_t	getTotalEdgeNum () const
void	incNodeNum ()
	Increase number of node/edge.
void	incEdgeNum ()

Static Public Member Functions
static bool	classof (const CommonCHGraph *chg)

Friends
class	CHGBuilder
class	GraphDBClient

Additional Inherited Members
Public Attributes inherited from SVF::GenericGraph< CHNode, CHEdge >
u32_t	edgeNum
	total num of node
u32_t	nodeNum
	total num of edge
Protected Attributes inherited from SVF::CommonCHGraph
CHGKind	kind
Protected Attributes inherited from SVF::GenericGraph< CHNode, CHEdge >
IDToNodeMapTy	IDToNodeMap
	node map

Detailed Description

Definition at line 240 of file CHG.h.

Member Typedef Documentation

◆ CallNodeToCHNodesMap

typedef Map<const ICFGNode*, CHNodeSetTy> SVF::CHGraph::CallNodeToCHNodesMap

Definition at line 250 of file CHG.h.

◆ CallNodeToVFunSetMap

typedef Map<const ICFGNode*, VFunSet> SVF::CHGraph::CallNodeToVFunSetMap

Definition at line 252 of file CHG.h.

◆ CallNodeToVTableSetMap

typedef Map<const ICFGNode*, VTableSet> SVF::CHGraph::CallNodeToVTableSetMap

Definition at line 251 of file CHG.h.

◆ CHNodeSetTy

typedef Set<const CHNode*> SVF::CHGraph::CHNodeSetTy

Definition at line 246 of file CHG.h.

◆ NameToCHNodesMap

typedef Map<std::string, CHNodeSetTy> SVF::CHGraph::NameToCHNodesMap

Definition at line 248 of file CHG.h.

◆ WorkList

typedef FIFOWorkList<const CHNode*> SVF::CHGraph::WorkList

Definition at line 247 of file CHG.h.

Member Enumeration Documentation

◆ RELATIONTYPE

enum SVF::CHGraph::RELATIONTYPE

Enumerator
CONSTRUCTOR
DESTRUCTOR

Definition at line 254 of file CHG.h.

    {
        CONSTRUCTOR = 0x1, // connect node based on constructor
        DESTRUCTOR = 0x2 // connect node based on destructor
    } RELATIONTYPE;

Constructor & Destructor Documentation

◆ CHGraph()

SVF::CHGraph::CHGraph ( )

inline

Definition at line 260 of file CHG.h.

             : classNum(0), vfID(0), buildingCHGTime(0)
    {
        this->kind = Standard;
    }

◆ ~CHGraph()

SVF::CHGraph::~CHGraph ( )

overridedefault

Member Function Documentation

◆ addEdge()

void CHGraph::addEdge	(	const std::string	className,
		const std::string	baseClassName,
		CHEdge::CHEDGETYPE	edgeType )

Definition at line 98 of file CHG.cpp.

{
    CHNode *srcNode = getNode(className);
    CHNode *dstNode = getNode(baseClassName);
    assert(srcNode && dstNode && "node not found?");
 
    if (!hasEdge(srcNode, dstNode, edgeType))
    {
        CHEdge *edge = new CHEdge(srcNode, dstNode, edgeType);
        srcNode->addOutgoingEdge(edge);
        dstNode->addIncomingEdge(edge);
    }
}

◆ addInstances()

void SVF::CHGraph::addInstances	(	const std::string	templateName,
		CHNode *	node )

inline

Definition at line 296 of file CHG.h.

    {
        NameToCHNodesMap::iterator it = templateNameToInstancesMap.find(
                                            templateName);
        if (it != templateNameToInstancesMap.end())
            it->second.insert(node);
        else
            templateNameToInstancesMap[templateName].insert(node);
    }

◆ classof()

bool SVF::CHGraph::classof ( const CommonCHGraph * chg )

inlinestatic

Definition at line 319 of file CHG.h.

    {
        return chg->getKind() == Standard;
    }

◆ csHasVFnsBasedonCHA()

bool CHGraph::csHasVFnsBasedonCHA ( const CallICFGNode * cs )

overridevirtual

Implements SVF::CommonCHGraph.

Definition at line 80 of file CHG.cpp.

{
    CallNodeToVFunSetMap::const_iterator it = callNodeToCHAVFnsMap.find(cs);
    return it != callNodeToCHAVFnsMap.end();
}

◆ csHasVtblsBasedonCHA()

bool CHGraph::csHasVtblsBasedonCHA ( const CallICFGNode * cs )

overridevirtual

Implements SVF::CommonCHGraph.

Definition at line 75 of file CHG.cpp.

{
    CallNodeToVTableSetMap::const_iterator it = callNodeToCHAVtblsMap.find(cs);
    return it != callNodeToCHAVtblsMap.end();
}

◆ dump()

void CHGraph::dump ( const std::string & filename )

Dump call graph into dot file

Definition at line 243 of file CHG.cpp.

{
    GraphPrinter::WriteGraphToFile(outs(), filename, this);
    printCH();
}

◆ getCSVFsBasedonCHA()

const VFunSet & CHGraph::getCSVFsBasedonCHA ( const CallICFGNode * cs )

overridevirtual

Implements SVF::CommonCHGraph.

Definition at line 91 of file CHG.cpp.

{
    CallNodeToVFunSetMap::const_iterator it = callNodeToCHAVFnsMap.find(cs);
    assert(it != callNodeToCHAVFnsMap.end() && "cs does not have vfns based on CHA.");
    return it->second;
}

◆ getCSVtblsBasedonCHA()

const VTableSet & CHGraph::getCSVtblsBasedonCHA ( const CallICFGNode * cs )

overridevirtual

Implements SVF::CommonCHGraph.

Definition at line 85 of file CHG.cpp.

{
    CallNodeToVTableSetMap::const_iterator it = callNodeToCHAVtblsMap.find(cs);
    assert(it != callNodeToCHAVtblsMap.end() && "cs does not have vtabls based on CHA.");
    return it->second;
}

◆ getDescendants()

const CHNodeSetTy & SVF::CHGraph::getDescendants ( const std::string className )

inline

Definition at line 305 of file CHG.h.

    {
        return classNameToDescendantsMap[className];
    }

◆ getInstances()

const CHNodeSetTy & SVF::CHGraph::getInstances ( const std::string className )

inline

Definition at line 309 of file CHG.h.

    {
        return templateNameToInstancesMap[className];
    }

◆ getNode()

CHNode * CHGraph::getNode ( const std::string name ) const

Definition at line 113 of file CHG.cpp.

{
    auto chNode = classNameToNodeMap.find(name);
    if (chNode != classNameToNodeMap.end()) return chNode->second;
    else return nullptr;
}

◆ getVFnsFromVtbls()

void CHGraph::getVFnsFromVtbls	(	const CallICFGNode *	cs,
		const VTableSet &	vtbls,
		VFunSet &	virtualFunctions )

overridevirtual

get target virtual functions

get the function name of the virtual callsite

Implements SVF::CommonCHGraph.

Definition at line 125 of file CHG.cpp.

{
    size_t idx = callsite->getFunIdxInVtable();
    string funName = callsite->getFunNameOfVirtualCall();
    for (const GlobalObjVar *vt : vtbls)
    {
        const CHNode *child = getNode(vt->getName());
        if (child == nullptr)
            continue;
        CHNode::FuncVector vfns;
        child->getVirtualFunctions(idx, vfns);
        for (CHNode::FuncVector::const_iterator fit = vfns.begin(),
                feit = vfns.end(); fit != feit; ++fit)
        {
            const FunObjVar* callee = *fit;
            if (callsite->arg_size() == callee->arg_size() ||
                    (callsite->isVarArg() && callee->isVarArg()))
            {
 
                // if argument types do not match
                // skip this one
                if (!checkArgTypes(callsite, callee))
                    continue;
 
                string calleeName = callee->getName();
 
                /*
                 * The compiler will add some special suffix (e.g.,
                 * "[abi:cxx11]") to the end of some virtual function:
                 * In dealII
                 * function: FE_Q<3>::get_name
                 * will be mangled as: _ZNK4FE_QILi3EE8get_nameB5cxx11Ev
                 * after demangling: FE_Q<3>::get_name[abi:cxx11]
                 * The special suffix ("[abi:cxx11]") needs to be removed
                 */
                const std::string suffix("[abi:cxx11]");
                size_t suffix_pos = calleeName.rfind(suffix);
                if (suffix_pos != string::npos)
                    calleeName.erase(suffix_pos, suffix.size());
 
                /*
                 * if we can't get the function name of a virtual callsite, all virtual
                 * functions calculated by idx will be valid
                 */
                if (funName.size() == 0)
                {
                    virtualFunctions.insert(callee);
                }
                else if (funName[0] == '~')
                {
                    /*
                     * if the virtual callsite is calling a destructor, then all
                     * destructors in the ch will be valid
                     * class A { virtual ~A(){} };
                     * class B: public A { virtual ~B(){} };
                     * int main() {
                     *   A *a = new B;
                     *   delete a;  /// the function name of this virtual callsite is ~A()
                     * }
                     */
                    if (calleeName[0] == '~')
                    {
                        virtualFunctions.insert(callee);
                    }
                }
                else
                {
                    /*
                     * for other virtual function calls, the function name of the callsite
                     * and the function name of the target callee should match exactly
                     */
                    if (funName.compare(calleeName) == 0)
                    {
                        virtualFunctions.insert(callee);
                    }
                }
            }
        }
    }
}

◆ getVirtualFunctionBasedonID()

const FunObjVar * SVF::CHGraph::getVirtualFunctionBasedonID ( u32_t id ) const

inline

Definition at line 284 of file CHG.h.

    {
        Map<const FunObjVar*, u32_t>::const_iterator it, eit;
        for (it = virtualFunctionToIDMap.begin(), eit =
                    virtualFunctionToIDMap.end(); it != eit; ++it)
        {
            if (it->second == id)
                return it->first;
        }
        return nullptr;
    }

◆ getVirtualFunctionID()

u32_t SVF::CHGraph::getVirtualFunctionID ( const FunObjVar * vfn ) const

inline

Definition at line 275 of file CHG.h.

    {
        Map<const FunObjVar*, u32_t>::const_iterator it =
            virtualFunctionToIDMap.find(vfn);
        if (it != virtualFunctionToIDMap.end())
            return it->second;
        else
            return -1;
    }

◆ printCH()

void CHGraph::printCH ( )

Definition at line 219 of file CHG.cpp.

{
    for (CHGraph::const_iterator it = this->begin(), eit = this->end();
            it != eit; ++it)
    {
        const CHNode *node = it->second;
        outs() << "class: " << node->getName() << "\n";
        for (CHEdge::CHEdgeSetTy::const_iterator it = node->OutEdgeBegin();
                it != node->OutEdgeEnd(); ++it)
        {
            if ((*it)->getEdgeType() == CHEdge::INHERITANCE)
                outs() << (*it)->getDstNode()->getName() << " --inheritance--> "
                       << (*it)->getSrcNode()->getName() << "\n";
            else
                outs() << (*it)->getSrcNode()->getName() << " --instance--> "
                       << (*it)->getDstNode()->getName() << "\n";
        }
    }
    outs() << '\n';
}

◆ view()

void CHGraph::view ( )

Definition at line 249 of file CHG.cpp.

{
    SVF::ViewGraph(this, "Class Hierarchy Graph");
}

◆ CHGBuilder

friend class CHGBuilder

friend

Definition at line 242 of file CHG.h.

◆ GraphDBClient

friend class GraphDBClient

friend

Definition at line 243 of file CHG.h.

Member Data Documentation

◆ buildingCHGTime

double SVF::CHGraph::buildingCHGTime

private

Definition at line 328 of file CHG.h.

◆ callNodeToCHAVFnsMap

CallNodeToVFunSetMap SVF::CHGraph::callNodeToCHAVFnsMap

private

Definition at line 339 of file CHG.h.

◆ callNodeToCHAVtblsMap

CallNodeToVTableSetMap SVF::CHGraph::callNodeToCHAVtblsMap

private

Definition at line 338 of file CHG.h.

◆ callNodeToClassesMap

CallNodeToCHNodesMap SVF::CHGraph::callNodeToClassesMap

private

Definition at line 334 of file CHG.h.

◆ classNameToAncestorsMap

NameToCHNodesMap SVF::CHGraph::classNameToAncestorsMap

private

Definition at line 331 of file CHG.h.

◆ classNameToDescendantsMap

NameToCHNodesMap SVF::CHGraph::classNameToDescendantsMap

private

Definition at line 330 of file CHG.h.

◆ classNameToInstAndDescsMap

NameToCHNodesMap SVF::CHGraph::classNameToInstAndDescsMap

private

Definition at line 332 of file CHG.h.

◆ classNameToNodeMap

Map<std::string, CHNode*> SVF::CHGraph::classNameToNodeMap

private

Definition at line 329 of file CHG.h.

◆ classNum

u32_t SVF::CHGraph::classNum

private

Definition at line 326 of file CHG.h.

◆ templateNameToInstancesMap

NameToCHNodesMap SVF::CHGraph::templateNameToInstancesMap

private

Definition at line 333 of file CHG.h.

◆ vfID

u32_t SVF::CHGraph::vfID

private

Definition at line 327 of file CHG.h.

◆ virtualFunctionToIDMap

Map<const FunObjVar*, u32_t> SVF::CHGraph::virtualFunctionToIDMap

private

Definition at line 336 of file CHG.h.

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

/home/runner/work/SVF/SVF/svf/include/Graphs/CHG.h
/home/runner/work/SVF/SVF/svf/lib/Graphs/CHG.cpp

Private Attributes
u32_t	classNum
u32_t	vfID
double	buildingCHGTime
Map< std::string, CHNode * >	classNameToNodeMap
NameToCHNodesMap	classNameToDescendantsMap
NameToCHNodesMap	classNameToAncestorsMap
NameToCHNodesMap	classNameToInstAndDescsMap
NameToCHNodesMap	templateNameToInstancesMap
CallNodeToCHNodesMap	callNodeToClassesMap
Map< const FunObjVar *, u32_t >	virtualFunctionToIDMap
CallNodeToVTableSetMap	callNodeToCHAVtblsMap
CallNodeToVFunSetMap	callNodeToCHAVFnsMap

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ CallNodeToCHNodesMap

◆ CallNodeToVFunSetMap

◆ CallNodeToVTableSetMap

◆ CHNodeSetTy

◆ NameToCHNodesMap

◆ WorkList

Member Enumeration Documentation

◆ RELATIONTYPE

Constructor & Destructor Documentation

◆ CHGraph()

◆ ~CHGraph()

Member Function Documentation

◆ addEdge()

◆ addInstances()

◆ classof()

◆ csHasVFnsBasedonCHA()

◆ csHasVtblsBasedonCHA()

◆ dump()

◆ getCSVFsBasedonCHA()

◆ getCSVtblsBasedonCHA()

◆ getDescendants()

◆ getInstances()

◆ getNode()

◆ getVFnsFromVtbls()

◆ getVirtualFunctionBasedonID()

◆ getVirtualFunctionID()

◆ printCH()

◆ view()

Friends And Related Symbol Documentation

◆ CHGBuilder

◆ GraphDBClient

Member Data Documentation

◆ buildingCHGTime

◆ callNodeToCHAVFnsMap

◆ callNodeToCHAVtblsMap

◆ callNodeToClassesMap

◆ classNameToAncestorsMap

◆ classNameToDescendantsMap

◆ classNameToInstAndDescsMap

◆ classNameToNodeMap

◆ classNum

◆ templateNameToInstancesMap

◆ vfID

◆ virtualFunctionToIDMap