SVF::DCHGraph Class Reference

Dwarf based CHG. More...

#include <DCHG.h>

Inheritance diagram for SVF::DCHGraph:

Public Member Functions
	DCHGraph ()
virtual	~DCHGraph ()
virtual void	buildCHG (bool extend)
void	dump (const std::string &filename)
void	print (void)
virtual bool	csHasVFnsBasedonCHA (const CallICFGNode *cs) override
virtual const VFunSet &	getCSVFsBasedonCHA (const CallICFGNode *cs) override
virtual bool	csHasVtblsBasedonCHA (CallBase *cs)
virtual bool	csHasVtblsBasedonCHA (const CallICFGNode *cs) override
virtual const VTableSet &	getCSVtblsBasedonCHA (const CallICFGNode *cs) override
virtual void	getVFnsFromVtbls (const CallICFGNode *cs, const VTableSet &vtbls, VFunSet &virtualFunctions) override
virtual bool	isBase (const DIType *a, const DIType *b, bool firstField)
virtual bool	isFieldOf (const DIType *f, const DIType *b)
	Returns true if f is a field of b (fields from getFieldTypes).
const DIType *	getCanonicalType (const DIType *t)
const DIType *	getFieldType (const DIType *base, unsigned idx)
	Returns the type of field number idx (flattened) in base.
const std::vector< const DIType * > &	getFieldTypes (const DIType *base)
	Returns a vector of the types of all fields in base.
unsigned	getNumFields (const DIType *base)
const Set< const DIType * > &	getAggs (const DIType *base)
	Returns all the aggregates contained (transitively) in base.
bool	isFirstField (const DIType *f, const DIType *b)
Public Member Functions inherited from SVF::CommonCHGraph
virtual	~CommonCHGraph ()
CHGKind	getKind (void) const
Public Member Functions inherited from SVF::GenericGraph< DCHNode, DCHEdge >
	GenericGraph ()
	Constructor.
virtual	~GenericGraph ()
	Destructor.
void	destroy ()
	Release memory.
iterator	begin ()
	Iterators.
const_iterator	begin () const
iterator	end ()
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 const DIType *	stripQualifiers (const DIType *)
	Returns the DIType beneath the qualifiers. Does not strip away "DW_TAG_members".
static const DIType *	stripArray (const DIType *)
	Returns the DIType beneath all qualifiers and arrays.
static bool	teq (const DIType *t1, const DIType *t2)
static std::string	diTypeToStr (const DIType *)
	Returns a human-readable version of the DIType.
static bool	isAgg (const DIType *t)
static bool	classof (const CommonCHGraph *chg)

Protected Attributes
bool	extended = false
	Whether this CHG is an extended CHG (first-field). Set by buildCHG.
Map< const DIType *, DCHNode * >	diTypeToNodeMap
	Maps DITypes to their nodes.
Map< const GlobalObjVar *, const DIType * >	vtblToTypeMap
	Maps VTables to the DIType associated with them.
Map< const DIType *, NodeBS >	chaMap
	Maps types to all children (i.e. CHA).
Map< const DIType *, NodeBS >	chaFFMap
	Maps types to all children but also considering first field.
Map< const DIType *, VTableSet >	vtblCHAMap
	Maps types to a set with their vtable and all their children's.
Map< const CallICFGNode *, VFunSet >	csCHAMap
	Maps callsites to a set of potential virtual functions based on CHA.
Map< const DIType *, const DIType * >	canonicalTypeMap
	Maps types to their canonical type (many-to-one).
Set< const DIType * >	canonicalTypes
	Set of all possible canonical types (i.e. values of canonicalTypeMap).
Map< const DIType *, std::vector< const DIType * > >	fieldTypes
	Maps types to their flattened fields' types.
Map< const DIType *, Set< const DIType * > >	containingAggs
	Maps aggregate types to all the aggregate types it transitively contains.
Protected Attributes inherited from SVF::CommonCHGraph
CHGKind	kind
Protected Attributes inherited from SVF::GenericGraph< DCHNode, DCHEdge >
IDToNodeMapTy	IDToNodeMap
	node map

Private Member Functions
void	handleDIBasicType (const DIBasicType *basicType)
	Construction helper to process DIBasicTypes.
void	handleDICompositeType (const DICompositeType *compositeType)
	Construction helper to process DICompositeTypes.
void	handleDIDerivedType (const DIDerivedType *derivedType)
	Construction helper to process DIDerivedTypes.
void	handleDISubroutineType (const DISubroutineType *subroutineType)
	Construction helper to process DISubroutineTypes.
void	buildVTables ()
	Finds all defined virtual functions and attaches them to nodes.
const NodeBS &	cha (const DIType *type, bool firstField)
	Returns a set of all children of type (CHA). Also gradually builds chaMap.
void	handleTypedef (const DIType *typedefType)
	Attaches the typedef(s) to the base node.
void	flatten (const DICompositeType *type)
	Populates fieldTypes for type and all its elements.
void	gatherAggs (const DICompositeType *type)
	Populates containingAggs for type and all its elements.
DCHNode *	getOrCreateNode (const DIType *type)
	Creates a node from type, or returns it if it exists.
const DIType *	getCSStaticType (CallBase *cs) const
	Retrieves the metadata associated with a virtual callsite.
const DIType *	getCSStaticType (const CallICFGNode *cs) const
bool	hasNode (const DIType *type)
	Checks if a node exists for type.
DCHNode *	getNode (const DIType *type)
	Returns the node for type (nullptr if it doesn't exist).
DCHEdge *	addEdge (const DIType *t1, const DIType *t2, DCHEdge::GEdgeKind et)
	Creates an edge between from t1 to t2.
DCHEdge *	hasEdge (const DIType *t1, const DIType *t2, DCHEdge::GEdgeKind et)
	Returns the edge between t1 and t2 if it exists, returns nullptr otherwise.

Private Attributes
NodeID	numTypes
	Number of types (nodes) in the graph.

Additional Inherited Members
Public Types inherited from SVF::CommonCHGraph
enum	CHGKind { Standard , DI }
Public Types inherited from SVF::GenericGraph< DCHNode, DCHEdge >
typedef DCHNode	NodeType
typedef DCHEdge	EdgeType
typedef OrderedMap< NodeID, NodeType * >	IDToNodeMapTy
	NodeID to GenericNode map.
typedef IDToNodeMapTy::iterator	iterator
	Node Iterators.
typedef IDToNodeMapTy::const_iterator	const_iterator
Public Attributes inherited from SVF::GenericGraph< DCHNode, DCHEdge >
u32_t	edgeNum
	total num of node
u32_t	nodeNum
	total num of edge

Detailed Description

Dwarf based CHG.

Definition at line 206 of file DCHG.h.

Constructor & Destructor Documentation

DCHGraph()

SVF::DCHGraph::DCHGraph ( )

inline

Definition at line 231 of file DCHG.h.

        :numTypes(0)   // vfID(0), buildingCHGTime(0) {
    {
        this->kind = DI;
    }

~DCHGraph()

virtual SVF::DCHGraph::~DCHGraph ( )

inlinevirtual

Definition at line 237 of file DCHG.h.

{ };

Member Function Documentation

addEdge()

DCHEdge * DCHGraph::addEdge ( const DIType *  t1, const DIType *  t2, DCHEdge::GEdgeKind  et  )

private

Creates an edge between from t1 to t2.

Definition at line 435 of file DCHG.cpp.

{
    DCHNode *src = getOrCreateNode(t1);
    DCHNode *dst = getOrCreateNode(t2);
 
    DCHEdge *edge = hasEdge(t1, t2, et);
    if (edge == nullptr)
    {
        // Create a new edge.
        edge = new DCHEdge(src, dst, et);
        src->addOutgoingEdge(edge);
        dst->addIncomingEdge(edge);
    }
 
    return edge;
}

buildCHG()

void DCHGraph::buildCHG ( bool  extend )

virtual

Builds the CHG from DWARF debug information. extend determines whether to extend the CHG with first field edges.

Definition at line 471 of file DCHG.cpp.

{
    extended = extend;
    DebugInfoFinder finder;
    for (Module &M : LLVMModuleSet::getLLVMModuleSet()->getLLVMModules())
    {
        finder.processModule(M);
    }
 
    // Create the void node regardless of whether it appears.
    getOrCreateNode(nullptr);
    // Find any char type.
    const DIType *charType = nullptr;
    /*
     * We want void at the top, char as a child, and everything is a child of char:
     *     void
     *      |
     *     char
     *    / | \
     *   x  y  z
     */
 
 
    for (const DIType *type : finder.types())
    {
        if (const DIBasicType *basicType = SVFUtil::dyn_cast<DIBasicType>(type))
        {
            if (basicType->getEncoding() == dwarf::DW_ATE_unsigned_char
                    || basicType->getEncoding() == dwarf::DW_ATE_signed_char)
            {
                charType = type;
            }
 
            handleDIBasicType(basicType);
        }
        else if (const DICompositeType *compositeType = SVFUtil::dyn_cast<DICompositeType>(type))
        {
            handleDICompositeType(compositeType);
        }
        else if (const DIDerivedType *derivedType = SVFUtil::dyn_cast<DIDerivedType>(type))
        {
            handleDIDerivedType(derivedType);
        }
        else if (const DISubroutineType *subroutineType = SVFUtil::dyn_cast<DISubroutineType>(type))
        {
            handleDISubroutineType(subroutineType);
        }
        else
        {
            assert(false && "DCHGraph::buildCHG: unexpected DIType.");
        }
    }
 
    buildVTables();
 
    // Build the void/char/everything else relation.
    if (extended && charType != nullptr)
    {
        // void <-- char
        addEdge(charType, nullptr, DCHEdge::STD_DEF);
        // char <-- x, char <-- y, ...
        for (iterator nodeI = begin(); nodeI != end(); ++nodeI)
        {
            // Everything without a parent gets char as a parent.
            if (nodeI->second->getDIType() != nullptr
                    && nodeI->second->getOutEdges().size() == 0)
            {
                addEdge(nodeI->second->getDIType(), charType, DCHEdge::STD_DEF);
            }
        }
    }
 
    if (Options::PrintDCHG())
    {
        print();
    }
}

buildVTables()

void DCHGraph::buildVTables ( )

private

Finds all defined virtual functions and attaches them to nodes.

Definition at line 166 of file DCHG.cpp.

{
    for (Module &M : LLVMModuleSet::getLLVMModuleSet()->getLLVMModules())
    {
        for (Module::const_global_iterator gvI = M.global_begin(); gvI != M.global_end(); ++gvI)
        {
            // Though this will return more than GlobalVariables, we only care about GlobalVariables (for the vtbls).
            const GlobalVariable *gv = SVFUtil::dyn_cast<const GlobalVariable>(&*gvI);
            if (gv == nullptr) continue;
            if (gv->hasMetadata(cppUtil::ctir::vtMDName) && gv->getNumOperands() > 0)
            {
                DIType *type = SVFUtil::dyn_cast<DIType>(gv->getMetadata(cppUtil::ctir::vtMDName));
                assert(type && "DCHG::buildVTables: bad metadata for ctir.vt");
                DCHNode *node = getOrCreateNode(type);
                NodeID i = LLVMModuleSet::getLLVMModuleSet()->getObjectNode(gv);
                GlobalObjVar* globalObjVar =
                    SVFUtil::cast<GlobalObjVar>(PAG::getPAG()->getGNode(i));
                node->setVTable(globalObjVar);
                vtblToTypeMap[globalObjVar] = getCanonicalType(type);
 
                const ConstantStruct *vtbls = cppUtil::getVtblStruct(gv);
                for (unsigned nthVtbl = 0; nthVtbl < vtbls->getNumOperands(); ++nthVtbl)
                {
                    const ConstantArray *vtbl = SVFUtil::dyn_cast<ConstantArray>(vtbls->getOperand(nthVtbl));
                    assert(vtbl && "Element of vtbl struct not an array");
 
                    std::vector<const Function* > &vfns = node->getVfnVector(nthVtbl);
 
                    // Iterating over the vtbl, we will run into:
                    // 1. i8* null         (don't care for now).
                    // 2. i8* inttoptr ... (don't care for now).
                    // 3. i8* bitcast  ... (we only care when a function pointer is being bitcasted).
                    for (unsigned cN = 0; cN < vtbl->getNumOperands(); ++cN)
                    {
                        Constant *c = vtbl->getOperand(cN);
                        if (SVFUtil::isa<ConstantPointerNull>(c))
                        {
                            // Don't care for now.
                            continue;
                        }
 
                        ConstantExpr *ce = SVFUtil::dyn_cast<ConstantExpr>(c);
                        assert(ce && "non-ConstantExpr, non-ConstantPointerNull in vtable?");
                        if (ce->getOpcode() == Instruction::BitCast)
                        {
                            // Could be a GlobalAlias which we don't care about, or a virtual/thunk function.
                            const Function* vfn = SVFUtil::dyn_cast<Function>(ce->getOperand(0));
                            if (vfn != nullptr)
                            {
                                vfns.push_back(vfn);
                            }
                        }
                    }
                }
            }
        }
    }
}

cha()

const NodeBS & DCHGraph::cha ( const DIType *  type, bool  firstField  )

private

Returns a set of all children of type (CHA). Also gradually builds chaMap.

Definition at line 225 of file DCHG.cpp.

{
    type = getCanonicalType(type);
    Map<const DIType *, NodeBS> &cacheMap = firstField ? chaFFMap : chaMap;
 
    // Check if we've already computed.
    if (cacheMap.find(type) != cacheMap.end())
    {
        return cacheMap[type];
    }
 
    NodeBS children;
    const DCHNode *node = getOrCreateNode(type);
    // Consider oneself a child, otherwise the recursion will just come up with nothing.
    children.set(node->getId());
    for (const DCHEdge *edge : node->getInEdges())
    {
        // Don't care about anything but inheritance, first-field, and standard def. edges.
        if (   edge->getEdgeKind() != DCHEdge::INHERITANCE
                && edge->getEdgeKind() != DCHEdge::FIRST_FIELD
                && edge->getEdgeKind() != DCHEdge::STD_DEF)
        {
            continue;
        }
 
        // We only care about first-field edges if the flag is on.
        if (!firstField && edge->getEdgeKind() == DCHEdge::FIRST_FIELD)
        {
            continue;
        }
 
        const NodeBS &cchildren = cha(edge->getSrcNode()->getDIType(), firstField);
        // Children's children are my children.
        for (NodeID cchild : cchildren)
        {
            children.set(cchild);
        }
    }
 
    // Cache results.
    cacheMap.insert({type, children});
    // Return the permanent object; we're returning a reference.
    return cacheMap[type];
}

classof()

static bool SVF::DCHGraph::classof ( const CommonCHGraph *  chg )

inlinestatic

Definition at line 285 of file DCHG.h.

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

csHasVFnsBasedonCHA()

virtual bool SVF::DCHGraph::csHasVFnsBasedonCHA ( const CallICFGNode *  cs )

inlineoverridevirtual

Implements SVF::CommonCHGraph.

Definition at line 250 of file DCHG.h.

    {
        return csHasVtblsBasedonCHA(cs);
    }

csHasVtblsBasedonCHA() [1/2]

virtual bool SVF::DCHGraph::csHasVtblsBasedonCHA ( CallBase *  cs )

inlinevirtual

Definition at line 257 of file DCHG.h.

    {
        assert(false && "not supported");
        const DIType *type = getCanonicalType(getCSStaticType(cs));
        if (!hasNode(type))
        {
            return false;
        }
 
        return getNode(type)->getVTable() != nullptr;
    }

csHasVtblsBasedonCHA() [2/2]

virtual bool SVF::DCHGraph::csHasVtblsBasedonCHA ( const CallICFGNode *  cs )

inlineoverridevirtual

Implements SVF::CommonCHGraph.

Definition at line 269 of file DCHG.h.

    {
        assert(false && "not supported!");
        abort();
    }

diTypeToStr()

std::string DCHGraph::diTypeToStr ( const DIType *  t )

static

Returns a human-readable version of the DIType.

Definition at line 969 of file DCHG.cpp.

{
    std::stringstream ss;
 
    if (t == nullptr)
    {
        return "void";
    }
 
    if (const DIBasicType *bt = SVFUtil::dyn_cast<DIBasicType>(t))
    {
        ss << bt->getName().str();
    }
    else if (const DIDerivedType *dt = SVFUtil::dyn_cast<DIDerivedType>(t))
    {
        if (dt->getName() == "__vtbl_ptr_type")
        {
            ss << "(vtbl * =) __vtbl_ptr_type";
        }
        else if (dt->getTag() == dwarf::DW_TAG_const_type)
        {
            ss << "const " << diTypeToStr(dt->getBaseType());
        }
        else if (dt->getTag() == dwarf::DW_TAG_volatile_type)
        {
            ss << "volatile " << diTypeToStr(dt->getBaseType());
        }
        else if (dt->getTag() == dwarf::DW_TAG_restrict_type)
        {
            ss << "restrict " << diTypeToStr(dt->getBaseType());
        }
        else if (dt->getTag() == dwarf::DW_TAG_atomic_type)
        {
            ss << "atomic " << diTypeToStr(dt->getBaseType());
        }
        else if (dt->getTag() == dwarf::DW_TAG_pointer_type)
        {
            ss << diTypeToStr(dt->getBaseType()) << " *";
        }
        else if (dt->getTag() == dwarf::DW_TAG_ptr_to_member_type)
        {
            ss << diTypeToStr(dt->getBaseType())
               << " " << diTypeToStr(SVFUtil::dyn_cast<DIType>(dt->getExtraData())) << "::*";
        }
        else if (dt->getTag() == dwarf::DW_TAG_reference_type)
        {
            ss << diTypeToStr(dt->getBaseType()) << " &";
        }
        else if (dt->getTag() == dwarf::DW_TAG_rvalue_reference_type)
        {
            ss << diTypeToStr(dt->getBaseType()) << " &&";
        }
        else if (dt->getTag() == dwarf::DW_TAG_typedef)
        {
            ss << dt->getName().str() << "->" << diTypeToStr(dt->getBaseType());
        }
    }
    else if (const DICompositeType *ct = SVFUtil::dyn_cast<DICompositeType>(t))
    {
        if (ct->getTag() == dwarf::DW_TAG_class_type
                || ct->getTag() == dwarf::DW_TAG_structure_type
                || ct->getTag() == dwarf::DW_TAG_union_type)
        {
 
            if (ct->getTag() == dwarf::DW_TAG_class_type)
            {
                ss << "class";
            }
            else if (ct->getTag() == dwarf::DW_TAG_structure_type)
            {
                ss << "struct";
            }
            else if (ct->getTag() == dwarf::DW_TAG_union_type)
            {
                ss << "union";
            }
 
            ss << ".";
 
            if (ct->getName() != "")
            {
                ss << ct->getName().str();
            }
            else
            {
                // Iterate over the element types.
                ss << "{ ";
 
                DINodeArray fields = ct->getElements();
                for (unsigned i = 0; i < fields.size(); ++i)
                {
                    // fields[i] gives a type which is DW_TAG_member, we want the member's type (getBaseType).
                    // It can also give a Subprogram type if the class just had non-virtual functions.
                    if (const DISubprogram *sp = SVFUtil::dyn_cast<DISubprogram>(fields[i]))
                    {
                        ss << sp->getName().str();
                    }
                    else if (const DIDerivedType *mt = SVFUtil::dyn_cast<DIDerivedType>(fields[i]))
                    {
                        assert(mt->getTag() == dwarf::DW_TAG_member && "DCHG: expected member");
                        ss << diTypeToStr(mt->getBaseType());
                    }
 
                    if (i != fields.size() - 1)
                    {
                        ss << ", ";
                    }
                }
 
                ss << " }";
            }
        }
        else if (ct->getTag() == dwarf::DW_TAG_array_type)
        {
            ss << diTypeToStr(ct->getBaseType());
            DINodeArray sizes = ct->getElements();
            for (unsigned i = 0; i < sizes.size(); ++i)
            {
                DISubrange *sr = SVFUtil::dyn_cast<DISubrange>(sizes[0]);
                assert(sr != nullptr && "DCHG: non-subrange as array element?");
                int64_t count = -1;
                if (const ConstantInt* ci = sr->getCount().dyn_cast<ConstantInt* >())
                {
                    count = LLVMUtil::getIntegerValue(ci).first;
                }
 
                ss << "[" << count << "]";
            }
        }
        else if (ct->getTag() == dwarf::DW_TAG_enumeration_type)
        {
            ss << "enum " << diTypeToStr(ct->getBaseType());
        }
        else if (ct->getTag() == dwarf::DW_TAG_union_type)
        {
 
        }
    }
    else if (const DISubroutineType *st = SVFUtil::dyn_cast<DISubroutineType>(t))
    {
        DITypeRefArray types = st->getTypeArray();
        // Must have one element at least (the first type).
        ss << diTypeToStr(types[0]) << " fn(";
        if (types.size() == 1)
        {
            ss << "void)";
        }
        else
        {
            for (unsigned i = 1; i < types.size(); ++i)
            {
                ss << diTypeToStr(types[i]);
                if (i + 1 != types.size())
                {
                    // There's another type.
                    ss << ", ";
                }
            }
 
            ss << ")";
        }
 
        ss << st->getName().str();
    }
 
    return ss.str();
}

dump()

void SVF::DCHGraph::dump ( const std::string &  filename )

inline

Definition at line 243 of file DCHG.h.

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

flatten()

void DCHGraph::flatten ( const DICompositeType *  type )

private

Populates fieldTypes for type and all its elements.

Definition at line 270 of file DCHG.cpp.

{
    type = SVFUtil::dyn_cast<DICompositeType>(getCanonicalType(type));
    assert(type && "DCHG::flatten: canon type of struct/class is not struct/class");
    if (fieldTypes.find(type) != fieldTypes.end())
    {
        // Already done (necessary because of the recursion).
        return;
    }
 
    // Create empty vector.
    fieldTypes[type];
 
    assert(type != nullptr
           && (type->getTag() == dwarf::DW_TAG_class_type
               || type->getTag() == dwarf::DW_TAG_structure_type)
           && "DCHG::flatten: expected a class/struct");
 
    // Sort the fields from getElements. Especially a problem for classes; it's all jumbled up.
    std::vector<const DIDerivedType *> fields;
    DINodeArray fieldsDINA = type->getElements();
    for (unsigned i = 0; i < fieldsDINA.size(); ++i)
    {
        if (const DIDerivedType *dt = SVFUtil::dyn_cast<DIDerivedType>(fieldsDINA[i]))
        {
            // Don't care about subprograms, only member/inheritance.
            fields.push_back(dt);
        }
    }
 
    // TODO: virtual inheritance is not handled at all!
    std::sort(fields.begin(), fields.end(),
              [](const DIDerivedType *&a, const DIDerivedType *&b) -> bool
    { return a->getOffsetInBits() < b->getOffsetInBits(); });
 
    for (const DIDerivedType *mt : fields)
    {
        assert((mt->getTag() == dwarf::DW_TAG_member || mt->getTag() == dwarf::DW_TAG_inheritance)
               && "DCHG: expected member/inheritance");
        // Either we have a class, struct, array, or something not in need of flattening.
        const DIType *fieldType = mt->getBaseType();
        if (fieldType->getTag() == dwarf::DW_TAG_structure_type
                || fieldType->getTag() == dwarf::DW_TAG_class_type)
        {
            flatten(SVFUtil::dyn_cast<DICompositeType>(fieldType));
            for (const DIType *ft : fieldTypes[fieldType])
            {
                // ft is already a canonical type because the "root" additions insert
                // canonical types.
                fieldTypes[type].push_back(ft);
            }
        }
        else if (fieldType->getTag() == dwarf::DW_TAG_array_type)
        {
            const DICompositeType *arrayType = SVFUtil::dyn_cast<DICompositeType>(fieldType);
            const DIType *baseType = arrayType->getBaseType();
            if (const DICompositeType *cbt = SVFUtil::dyn_cast<DICompositeType>(baseType))
            {
                flatten(cbt);
                for (const DIType *ft : fieldTypes[cbt])
                {
                    // ft is already a canonical type like above.
                    fieldTypes[type].push_back(ft);
                }
            }
            else
            {
                fieldTypes[type].push_back(getCanonicalType(baseType));
            }
        }
        else
        {
            fieldTypes[type].push_back(getCanonicalType(fieldType));
        }
    }
}

gatherAggs()

void DCHGraph::gatherAggs ( const DICompositeType *  type )

private

Populates containingAggs for type and all its elements.

Definition at line 355 of file DCHG.cpp.

{
    if (containingAggs.find(getCanonicalType(type)) != containingAggs.end())
    {
        return;
    }
 
    // Initialise an empty set. We want all aggregates to have a value in
    // this map, even if empty (e.g. struct has no aggs, only scalars).
    containingAggs[getCanonicalType(type)];
 
    if (type->getTag() == dwarf::DW_TAG_array_type)
    {
        const DIType *bt = type->getBaseType();
        bt = stripQualifiers(bt);
 
        if (isAgg(bt))
        {
            const DICompositeType *cbt = SVFUtil::dyn_cast<DICompositeType>(bt);
            containingAggs[getCanonicalType(type)].insert(getCanonicalType(cbt));
            gatherAggs(cbt);
            // These must be canonical already because of aggs.insert above/below.
            containingAggs[getCanonicalType(type)].insert(
                containingAggs[getCanonicalType(cbt)].begin(),
                containingAggs[getCanonicalType(cbt)].end());
        }
    }
    else
    {
        DINodeArray fields = type->getElements();
        for (unsigned i = 0; i < fields.size(); ++i)
        {
            // Unwrap the member (could be a subprogram, not type, so guard needed).
            if (const DIDerivedType *mt = SVFUtil::dyn_cast<DIDerivedType>(fields[i]))
            {
                const DIType *ft = mt->getBaseType();
                ft = stripQualifiers(ft);
 
                if (isAgg(ft))
                {
                    const DICompositeType *cft = SVFUtil::dyn_cast<DICompositeType>(ft);
                    containingAggs[getCanonicalType(type)].insert(getCanonicalType(cft));
                    gatherAggs(cft);
                    // These must be canonical already because of aggs.insert above.
                    containingAggs[getCanonicalType(type)].insert(
                        containingAggs[getCanonicalType(cft)].begin(),
                        containingAggs[getCanonicalType(cft)].end());
                }
            }
        }
    }
}

getAggs()

const Set< const DIType * > & SVF::DCHGraph::getAggs ( const DIType *  base )

inline

Returns all the aggregates contained (transitively) in base.

Definition at line 349 of file DCHG.h.

    {
        base = getCanonicalType(base);
        assert(containingAggs.find(base) != containingAggs.end() && "DCHG: aggregates not gathered for base!");
        return containingAggs[base];
    }

getCanonicalType()

const DIType * DCHGraph::getCanonicalType

(

const DIType *

t

)

Returns the type representing all qualifier-variations of t. This should only matter in the case of DerivedTypes where qualifiers and have qualified base types cause a mess.

Definition at line 724 of file DCHG.cpp.

{
    // We want stripped types to be canonical.
    const DIType *unstrippedT = t;
    t = stripQualifiers(t);
 
    // Is there a mapping for the unstripped type? Yes - return it.
    if (canonicalTypeMap.find(unstrippedT) != canonicalTypeMap.end())
    {
        return canonicalTypeMap[unstrippedT];
    }
 
    // There is no mapping for unstripped type (^), is there one for the stripped
    // type? Yes - map the unstripped type to the same thing.
    if (unstrippedT != t)
    {
        if (canonicalTypeMap.find(t) != canonicalTypeMap.end())
        {
            canonicalTypeMap[unstrippedT] = canonicalTypeMap[t];
            return canonicalTypeMap[unstrippedT];
        }
    }
 
    // Canonical type for t is not cached, find one for it.
    for (const DIType *canonType : canonicalTypes)
    {
        if (teq(t, canonType))
        {
            // Found a canonical type.
            canonicalTypeMap[t] = canonType;
            return canonicalTypeMap[t];
        }
    }
 
    // No canonical type found, so t will be a canonical type.
    canonicalTypes.insert(t);
    canonicalTypeMap.insert({t, t});
 
    return canonicalTypeMap[t];
}

getCSStaticType() [1/2]

const DIType * DCHGraph::getCSStaticType ( CallBase *  cs ) const

private

Retrieves the metadata associated with a virtual callsite.

Definition at line 426 of file DCHG.cpp.

{
    MDNode *md = cs->getMetadata(cppUtil::ctir::derefMDName);
    assert(md != nullptr && "Missing type metadata at virtual callsite");
    DIType *diType = SVFUtil::dyn_cast<DIType>(md);
    assert(diType != nullptr && "Incorrect metadata type at virtual callsite");
    return diType;
}

getCSStaticType() [2/2]

const DIType * SVF::DCHGraph::getCSStaticType ( const CallICFGNode *  cs ) const

inlineprivate

Definition at line 413 of file DCHG.h.

    {
        assert(false && "not supported!");
        abort();
    }

getCSVFsBasedonCHA()

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

overridevirtual

Implements SVF::CommonCHGraph.

Definition at line 549 of file DCHG.cpp.

{
    if (csCHAMap.find(cs) != csCHAMap.end())
    {
        return csCHAMap[cs];
    }
 
    VFunSet vfns;
    const VTableSet &vtbls = getCSVtblsBasedonCHA(cs);
    getVFnsFromVtbls(cs, vtbls, vfns);
 
    // Cache.
    csCHAMap.insert({cs, vfns});
    // Return cached object, not the stack object.
    return csCHAMap[cs];
}

getCSVtblsBasedonCHA()

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

overridevirtual

Implements SVF::CommonCHGraph.

Definition at line 566 of file DCHG.cpp.

{
    const DIType *type = getCanonicalType(getCSStaticType(cs));
    // Check if we've already computed.
    if (vtblCHAMap.find(type) != vtblCHAMap.end())
    {
        return vtblCHAMap[type];
    }
 
    VTableSet vtblSet;
    const NodeBS &children = cha(type, false);
    for (NodeID childId : children)
    {
        DCHNode *child = getGNode(childId);
        const GlobalObjVar *vtbl = child->getVTable();
        // TODO: what if it is null?
        if (vtbl != nullptr)
        {
            vtblSet.insert(vtbl);
        }
    }
 
    // Cache.
    vtblCHAMap.insert({type, vtblSet});
    // Return cached version - not the stack object.
    return vtblCHAMap[type];
}

getFieldType()

const DIType * SVF::DCHGraph::getFieldType ( const DIType *  base, unsigned  idx  )

inline

Returns the type of field number idx (flattened) in base.

Definition at line 296 of file DCHG.h.

    {
        base = getCanonicalType(base);
        if (base == nullptr)
        {
            // Conservative; the base object is untyped, sadly.
            return nullptr;
        }
 
        // For TBHC this is conservative because the union type is lower in the DCHG
        // than its fields. TODO: make more precise.
        if (base->getTag() == dwarf::DW_TAG_union_type)
        {
            return base;
        }
 
        if (base->getTag() == dwarf::DW_TAG_array_type)
        {
            const DICompositeType* cbase =
                SVFUtil::dyn_cast<DICompositeType>(base);
            assert(cbase && "DCHG: bad DIComposite case");
            return cbase->getBaseType();
        }
 
        if (!(base->getTag() == dwarf::DW_TAG_class_type ||
                base->getTag() == dwarf::DW_TAG_structure_type))
        {
            return nullptr;
        }
 
        assert(fieldTypes.find(base) != fieldTypes.end() && "DCHG: base not flattened!");
        std::vector<const DIType *> &fields = fieldTypes[base];
        assert(fields.size() > idx && "DCHG: idx into struct larger than # fields!");
        return getCanonicalType(fields[idx]);
    }

getFieldTypes()

const std::vector< const DIType * > & SVF::DCHGraph::getFieldTypes ( const DIType *  base )

inline

Returns a vector of the types of all fields in base.

Definition at line 333 of file DCHG.h.

    {
        base = getCanonicalType(base);
        assert(fieldTypes.find(base) != fieldTypes.end() && "DCHG: base not flattened!");
        return fieldTypes[base];
    }

getNode()

DCHNode * SVF::DCHGraph::getNode ( const DIType *  type )

inlineprivate

Returns the node for type (nullptr if it doesn't exist).

Definition at line 427 of file DCHG.h.

    {
        type = getCanonicalType(type);
        if (hasNode(type))
        {
            return diTypeToNodeMap.at(type);
        }
 
        return nullptr;
    }

getNumFields()

unsigned SVF::DCHGraph::getNumFields ( const DIType *  base )

inline

Definition at line 341 of file DCHG.h.

    {
        base = getCanonicalType(base);
        assert(fieldTypes.find(base) != fieldTypes.end() && "DCHG: base not flattened!");
        return fieldTypes[base].size();
    }

getOrCreateNode()

DCHNode * DCHGraph::getOrCreateNode ( const DIType *  type )

private

Creates a node from type, or returns it if it exists.

Definition at line 408 of file DCHG.cpp.

{
    type = getCanonicalType(type);
 
    // Check, does the node for type exist?
    if (diTypeToNodeMap[type] != nullptr)
    {
        return diTypeToNodeMap[type];
    }
 
    DCHNode *node = new DCHNode(type, numTypes++);
    addGNode(node->getId(), node);
    diTypeToNodeMap[type] = node;
    // TODO: handle templates.
 
    return node;
}

getVFnsFromVtbls()

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

overridevirtual

Implements SVF::CommonCHGraph.

Definition at line 594 of file DCHG.cpp.

{
    size_t idx = callsite->getFunIdxInVtable();
    std::string funName = callsite->getFunNameOfVirtualCall();
    for (const GlobalObjVar *vtbl : vtbls)
    {
        assert(vtblToTypeMap.find(vtbl) != vtblToTypeMap.end() && "floating vtbl");
        const DIType *type = vtblToTypeMap[vtbl];
        assert(hasNode(type) && "trying to get vtbl for type not in graph");
        const DCHNode *node = getNode(type);
        std::vector<std::vector<const Function* >> allVfns = node->getVfnVectors();
        for (std::vector<const Function* > vfnV : allVfns)
        {
            // We only care about any virtual function corresponding to idx.
            if (idx >= vfnV.size())
            {
                continue;
            }
 
            const Function* callee = vfnV[idx];
            // Practically a copy of that in lib/MemoryModel/CHA.cpp
            if (callsite->arg_size() == callee->arg_size() || (callsite->isVarArg() && callee->isVarArg()))
            {
                cppUtil::DemangledName dname = cppUtil::demangle(callee->getName().str());
                std::string calleeName = dname.funcName;
 
                /*
                 * 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 suffixPos = calleeName.rfind(suffix);
                if (suffixPos != std::string::npos)
                {
                    calleeName.erase(suffixPos, suffix.size());
                }
 
                /*
                 * if we can't get the function name of a virtual callsite, all virtual
                 * functions corresponding to idx will be valid
                 */
                if (funName.size() == 0)
                {
                    virtualFunctions.insert(LLVMUtil::getFunObjVar(callee->getName().str()));
                }
                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(LLVMUtil::getFunObjVar(callee->getName().str()));
                    }
                }
                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(LLVMUtil::getFunObjVar(callee->getName().str()));
                    }
                }
            }
        }
    }
}

handleDIBasicType()

void DCHGraph::handleDIBasicType ( const DIBasicType *  basicType )

private

Construction helper to process DIBasicTypes.

Definition at line 22 of file DCHG.cpp.

{
    getOrCreateNode(basicType);
}

handleDICompositeType()

void DCHGraph::handleDICompositeType ( const DICompositeType *  compositeType )

private

Construction helper to process DICompositeTypes.

Definition at line 27 of file DCHG.cpp.

{
    switch (compositeType->getTag())
    {
    case dwarf::DW_TAG_array_type:
        if (extended) getOrCreateNode(compositeType);
        gatherAggs(compositeType);
        break;
    case dwarf::DW_TAG_class_type:
    case dwarf::DW_TAG_structure_type:
        getOrCreateNode(compositeType);
        // If we're extending, we need to add the first-field relation.
        if (extended)
        {
            DINodeArray fields = compositeType->getElements();
            if (!fields.empty())
            {
                // We want the first non-static, non-function member; it may not exist.
                DIDerivedType *firstMember = nullptr;
                for (DINode *n : fields)
                {
                    if (DIDerivedType *fm = SVFUtil::dyn_cast<DIDerivedType>(n))
                    {
                        if (fm->getTag() == dwarf::DW_TAG_member && !fm->isStaticMember())
                        {
                            firstMember = fm;
                            break;
                        }
                    }
                }
 
                if (firstMember != nullptr)
                {
                    // firstMember is a DW_TAG_member, we want the base type beneath it.
                    addEdge(compositeType, firstMember->getBaseType(), DCHEdge::FIRST_FIELD);
                }
            }
        }
 
        flatten(compositeType);
        gatherAggs(compositeType);
 
        break;
    case dwarf::DW_TAG_union_type:
        getOrCreateNode(compositeType);
        // All fields are first fields.
        if (extended)
        {
            DINodeArray fields = compositeType->getElements();
            for (DINode *field : fields)
            {
                // fields[0] gives a type which is DW_TAG_member, we want the member's type (getBaseType).
                DIDerivedType *firstMember = SVFUtil::dyn_cast<DIDerivedType>(field);
                assert(firstMember != nullptr && "DCHG: expected member type");
                addEdge(compositeType, firstMember->getBaseType(), DCHEdge::FIRST_FIELD);
            }
        }
 
        // flatten(compositeType);
        gatherAggs(compositeType);
 
        break;
    case dwarf::DW_TAG_enumeration_type:
        getOrCreateNode(compositeType);
        break;
    default:
        assert(false && "DCHGraph::buildCHG: unexpected CompositeType tag.");
    }
}

handleDIDerivedType()

void DCHGraph::handleDIDerivedType ( const DIDerivedType *  derivedType )

private

Construction helper to process DIDerivedTypes.

Definition at line 97 of file DCHG.cpp.

{
    switch (derivedType->getTag())
    {
    case dwarf::DW_TAG_inheritance:
    {
        assert(SVFUtil::isa<DIType>(derivedType->getScope()) && "inheriting from non-type?");
        DCHEdge *edge = addEdge(SVFUtil::dyn_cast<DIType>(derivedType->getScope()),
                                derivedType->getBaseType(), DCHEdge::INHERITANCE);
        // If the offset does not exist (for primary base), getConstantFieldIdx should return 0.
        edge->setOffset(derivedType->getOffsetInBits());
        break;
    }
    case dwarf::DW_TAG_member:
    case dwarf::DW_TAG_friend:
        // Don't care.
        break;
    case dwarf::DW_TAG_typedef:
        handleTypedef(derivedType);
        break;
    case dwarf::DW_TAG_pointer_type:
    case dwarf::DW_TAG_ptr_to_member_type:
    case dwarf::DW_TAG_reference_type:
    case dwarf::DW_TAG_rvalue_reference_type:
        if (extended) getOrCreateNode(derivedType);
        break;
    case dwarf::DW_TAG_const_type:
    case dwarf::DW_TAG_atomic_type:
    case dwarf::DW_TAG_volatile_type:
    case dwarf::DW_TAG_restrict_type:
        break;
    default:
        assert(false && "DCHGraph::buildCHG: unexpected DerivedType tag.");
    }
}

handleDISubroutineType()

void DCHGraph::handleDISubroutineType ( const DISubroutineType *  subroutineType )

private

Construction helper to process DISubroutineTypes.

Definition at line 133 of file DCHG.cpp.

{
    getOrCreateNode(subroutineType);
}

handleTypedef()

void DCHGraph::handleTypedef ( const DIType *  typedefType )

private

Attaches the typedef(s) to the base node.

Definition at line 138 of file DCHG.cpp.

{
    assert(typedefType && typedefType->getTag() == dwarf::DW_TAG_typedef);
 
    // Need to gather them in a set first because we don't know the base type till
    // we get to the bottom of the (potentially many) typedefs.
    std::vector<const DIDerivedType *> typedefs;
    // Check for nullptr because you can typedef void.
    while (typedefType != nullptr && typedefType->getTag() == dwarf::DW_TAG_typedef)
    {
        const DIDerivedType *typedefDerivedType = SVFUtil::dyn_cast<DIDerivedType>(typedefType);
        // The typedef itself.
        typedefs.push_back(typedefDerivedType);
 
        // Next in the typedef line.
        typedefType = typedefDerivedType->getBaseType();
    }
 
    const DIType *baseType = typedefType;
    DCHNode *baseTypeNode = getOrCreateNode(baseType);
 
    for (const DIDerivedType *tdef : typedefs)
    {
        // Base type needs to hold its typedefs.
        baseTypeNode->addTypedef(tdef);
    }
}

hasEdge()

DCHEdge * DCHGraph::hasEdge ( const DIType *  t1, const DIType *  t2, DCHEdge::GEdgeKind  et  )

private

Returns the edge between t1 and t2 if it exists, returns nullptr otherwise.

Definition at line 452 of file DCHG.cpp.

{
    DCHNode *src = getOrCreateNode(t1);
    DCHNode *dst = getOrCreateNode(t2);
 
    for (DCHEdge *edge : src->getOutEdges())
    {
        DCHNode *node = edge->getDstNode();
        DCHEdge::GEdgeKind edgeType = edge->getEdgeKind();
        if (node == dst && edgeType == et)
        {
            assert(SVFUtil::isa<DCHEdge>(edge) && "Non-DCHEdge in DCHNode edge set.");
            return edge;
        }
    }
 
    return nullptr;
}

hasNode()

bool SVF::DCHGraph::hasNode ( const DIType *  type )

inlineprivate

Checks if a node exists for type.

Definition at line 420 of file DCHG.h.

    {
        type = getCanonicalType(type);
        return diTypeToNodeMap.find(type) != diTypeToNodeMap.end();
    }

isAgg()

bool DCHGraph::isAgg ( const DIType *  t )

static

Definition at line 347 of file DCHG.cpp.

{
    if (t == nullptr) return false;
    return    t->getTag() == dwarf::DW_TAG_array_type
              || t->getTag() == dwarf::DW_TAG_structure_type
              || t->getTag() == dwarf::DW_TAG_class_type;
}

isBase()

bool DCHGraph::isBase ( const DIType *  a, const DIType *  b, bool  firstField  )

virtual

Returns true if a is a transitive base of b. firstField determines whether to consider first-field edges.

Definition at line 677 of file DCHG.cpp.

{
    a = getCanonicalType(a);
    b = getCanonicalType(b);
    assert(hasNode(a) && hasNode(b) && "DCHG: isBase query for non-existent node!");
    const DCHNode *bNode = getNode(b);
 
    const NodeBS &aChildren = cha(a, firstField);
    return aChildren.test(bNode->getId());
}

isFieldOf()

bool DCHGraph::isFieldOf ( const DIType *  f, const DIType *  b  )

virtual

Returns true if f is a field of b (fields from getFieldTypes).

Definition at line 688 of file DCHG.cpp.

{
    assert(f && b && "DCHG::isFieldOf: given nullptr!");
 
    f = getCanonicalType(f);
    b = getCanonicalType(b);
    if (f == b) return true;
 
    if (b->getTag() == dwarf::DW_TAG_array_type || b->getTag() == dwarf::DW_TAG_pointer_type)
    {
        const DIType *baseType = nullptr;
        if (const DICompositeType *arrayType = SVFUtil::dyn_cast<DICompositeType>(b))
        {
            baseType = arrayType->getBaseType();
        }
        else if (const DIDerivedType *ptrType = SVFUtil::dyn_cast<DIDerivedType>(b))
        {
            baseType = ptrType->getBaseType();
        }
        assert(baseType && "DCHG::isFieldOf: baseType is neither DIComposite nor DIDerived!");
 
        baseType = getCanonicalType(baseType);
        return f == baseType || (baseType != nullptr && isFieldOf(f, baseType));
    }
    else if (b->getTag() == dwarf::DW_TAG_class_type
             || b->getTag() == dwarf::DW_TAG_structure_type)
    {
        const std::vector<const DIType *> &fields = getFieldTypes(b);
        return std::find(fields.begin(), fields.end(), f) != fields.end();
    }
    else
    {
        return false;
    }
}

isFirstField()

bool DCHGraph::isFirstField	(	const DIType *	f,
		const DIType *	b
	)

Definition at line 942 of file DCHG.cpp.

{
    // TODO: some improvements.
    //   - cha should be changed to accept which edge types to use,
    //     then we can call cha(..., DCHEdge::FIRST_FIELD).
    //   - If not ^, this could benefit from caching.
    f = getCanonicalType(f);
    b = getCanonicalType(b);
 
    if (f == b) return true;
 
    const DCHNode *node = getNode(f);
    assert(node && "DCHG::isFirstField: node not found");
    // Consider oneself a child, otherwise the recursion will just come up with nothing.
    for (const DCHEdge *edge : node->getInEdges())
    {
        // Only care about first-field edges.
        if (edge->getEdgeKind() == DCHEdge::FIRST_FIELD)
        {
            if (edge->getSrcNode()->getDIType() == b) return true;
            if (isFirstField(edge->getSrcNode()->getDIType(), b)) return true;
        }
    }
 
    return false;
}

print()

void DCHGraph::print

(

void

)

Definition at line 1142 of file DCHG.cpp.

{
    static const std::string line = "-------------------------------------\n";
    static const std::string thickLine = "=====================================\n";
    static const size_t singleIndent = 2;
 
    size_t currIndent = 0;
    SVFUtil::outs() << thickLine;
    unsigned numStructs = 0;
    unsigned largestStruct = 0;
    NodeSet nodes;
    for (DCHGraph::const_iterator it = begin(); it != end(); ++it)
    {
        nodes.insert(it->first);
    }
 
    for (NodeID id : nodes)
    {
        if (*nodes.begin() != id)
        {
            SVFUtil::outs() << line;
        }
 
        const DCHNode *node = getGNode(id);
 
        SVFUtil::outs() << indent(currIndent) << id << ": " << diTypeToStr(node->getDIType()) << " [" << node->getDIType() << "]" << "\n";
        if (node->getDIType() != nullptr
                && (node->getDIType()->getTag() == dwarf::DW_TAG_class_type
                    ||
                    node->getDIType()->getTag() == dwarf::DW_TAG_structure_type))
        {
            ++numStructs;
            unsigned numFields = getFieldTypes(node->getDIType()).size();
            largestStruct = numFields > largestStruct ? numFields : largestStruct;
        }
 
        currIndent += singleIndent;
        SVFUtil::outs() << indent(currIndent) << "Virtual functions\n";
        currIndent += singleIndent;
        const std::vector<std::vector<const Function* >> &vfnVectors = node->getVfnVectors();
        for (unsigned i = 0; i < vfnVectors.size(); ++i)
        {
            SVFUtil::outs() << indent(currIndent) << "[ vtable #" << i << " ]\n";
            currIndent += singleIndent;
            for (unsigned j = 0; j < vfnVectors[i].size(); ++j)
            {
                struct cppUtil::DemangledName dname = cppUtil::demangle(vfnVectors[i][j]->getName().str());
                SVFUtil::outs() << indent(currIndent) << "[" << j << "] "
                                << dname.className << "::" << dname.funcName << "\n";
            }
 
            currIndent -= singleIndent;
        }
 
        // Nothing was printed.
        if (vfnVectors.size() == 0)
        {
            SVFUtil::outs() << indent(currIndent) << "(none)\n";
        }
 
        currIndent -= singleIndent;
 
        SVFUtil::outs() << indent(currIndent) << "Bases\n";
        currIndent += singleIndent;
        for (const DCHEdge *edge : node->getOutEdges())
        {
            std::string arrow;
            if (edge->getEdgeKind() == DCHEdge::INHERITANCE)
            {
                arrow = "--inheritance-->";
            }
            else if (edge->getEdgeKind() == DCHEdge::FIRST_FIELD)
            {
                arrow = "--first-field-->";
            }
            else if (edge->getEdgeKind() == DCHEdge::INSTANCE)
            {
                arrow = "---instance---->";
            }
            else if (edge->getEdgeKind() == DCHEdge::STD_DEF)
            {
                arrow = "---standard---->";
            }
            else
            {
                arrow = "----unknown---->";
            }
 
            SVFUtil::outs() << indent(currIndent) << "[ " << diTypeToStr(node->getDIType()) << " ] "
                            << arrow << " [ " << diTypeToStr(edge->getDstNode()->getDIType()) << " ]\n";
        }
 
        if (node->getOutEdges().size() == 0)
        {
            SVFUtil::outs() << indent(currIndent) << "(none)\n";
        }
 
        currIndent -= singleIndent;
 
        SVFUtil::outs() << indent(currIndent) << "Typedefs\n";
 
        currIndent += singleIndent;
 
        const Set<const DIDerivedType *> &typedefs = node->getTypedefs();
        for (const DIDerivedType *tdef : typedefs)
        {
            std::string typedefName = "void";
            if (tdef != nullptr)
            {
                typedefName = tdef->getName().str();
            }
 
            SVFUtil::outs() << indent(currIndent) << typedefName << "\n";
        }
 
        if (typedefs.size() == 0)
        {
            SVFUtil::outs() << indent(currIndent) << "(none)\n";
        }
 
        currIndent -= singleIndent;
 
        currIndent -= singleIndent;
    }
 
    SVFUtil::outs() << thickLine;
 
    SVFUtil::outs() << "Other stats\n";
    SVFUtil::outs() << line;
    SVFUtil::outs() << "# Canonical types : " << canonicalTypes.size() << "\n";
    SVFUtil::outs() << "# structs         : " << numStructs << "\n";
    SVFUtil::outs() << "Largest struct    : " << largestStruct << " fields\n";
    SVFUtil::outs() << thickLine;
 
    SVFUtil::outs().flush();
}

stripArray()

const DIType * DCHGraph::stripArray ( const DIType *  t )

static

Returns the DIType beneath all qualifiers and arrays.

Definition at line 818 of file DCHG.cpp.

{
    t = stripQualifiers(t);
    if (t->getTag() == dwarf::DW_TAG_array_type)
    {
        const DICompositeType *at = SVFUtil::dyn_cast<DICompositeType>(t);
        return stripArray(at->getBaseType());
    }
 
    return t;
}

stripQualifiers()

const DIType * DCHGraph::stripQualifiers ( const DIType *  t )

static

Returns the DIType beneath the qualifiers. Does not strip away "DW_TAG_members".

Definition at line 765 of file DCHG.cpp.

{
    while (true)
    {
        // nullptr means void.
        if (t == nullptr
                || SVFUtil::isa<DIBasicType>(t)
                || SVFUtil::isa<DISubroutineType>(t))
        {
            break;
        }
 
        unsigned tag = t->getTag();
        // Verbose for clarity.
        if (   tag == dwarf::DW_TAG_const_type
                || tag == dwarf::DW_TAG_atomic_type
                || tag == dwarf::DW_TAG_volatile_type
                || tag == dwarf::DW_TAG_restrict_type
                || tag == dwarf::DW_TAG_typedef)
        {
            // Qualifier - get underlying type.
            const DIDerivedType *dt = SVFUtil::dyn_cast<DIDerivedType>(t);
            assert(t && "DCHG: expected DerivedType");
            t = dt->getBaseType();
        }
        else if (   tag == dwarf::DW_TAG_array_type
                    || tag == dwarf::DW_TAG_class_type
                    || tag == dwarf::DW_TAG_structure_type
                    || tag == dwarf::DW_TAG_union_type
                    || tag == dwarf::DW_TAG_enumeration_type
                    || tag == dwarf::DW_TAG_member
                    || tag == dwarf::DW_TAG_pointer_type
                    || tag == dwarf::DW_TAG_ptr_to_member_type
                    || tag == dwarf::DW_TAG_reference_type
                    || tag == dwarf::DW_TAG_rvalue_reference_type)
        {
            // Hit a non-qualifier.
            break;
        }
        else if (   tag == dwarf::DW_TAG_inheritance
                    || tag == dwarf::DW_TAG_friend)
        {
            assert(false && "DCHG: unexpected tag when stripping qualifiers");
        }
        else
        {
            assert(false && "DCHG: unhandled tag when stripping qualifiers");
        }
    }
 
    return t;
}

teq()

bool DCHGraph::teq ( const DIType *  t1, const DIType *  t2  )

static

Returns true if t1 and t2 are equivalent, ignoring qualifiers. For equality... Tags always need to be equal. DIBasicType: shallow pointer equality. DIDerivedType: base types (teq). DICompositeType: shallow pointer equality. DISubroutineType: shallow pointer equality.

Definition at line 830 of file DCHG.cpp.

{
    t1 = stripQualifiers(t1);
    t2 = stripQualifiers(t2);
 
    if (t1 == t2)
    {
        // Trivial case. Handles SubRoutineTypes too.
        return true;
    }
 
    if (t1 == nullptr || t2 == nullptr)
    {
        // Since t1 != t2 and one of them is null, it is
        // impossible for them to be equal.
        return false;
    }
 
    // Check if we need base type comparisons.
    if (SVFUtil::isa<DIBasicType>(t1) && SVFUtil::isa<DIBasicType>(t2))
    {
        const DIBasicType *b1 = SVFUtil::dyn_cast<DIBasicType>(t1);
        const DIBasicType *b2 = SVFUtil::dyn_cast<DIBasicType>(t2);
 
        unsigned enc1 = b1->getEncoding();
        unsigned enc2 = b2->getEncoding();
        bool okayEnc = ((enc1 == dwarf::DW_ATE_signed || enc1 == dwarf::DW_ATE_unsigned || enc1 == dwarf::DW_ATE_boolean)
                        && (enc2 == dwarf::DW_ATE_signed || enc2 == dwarf::DW_ATE_unsigned || enc2 == dwarf::DW_ATE_boolean))
                       ||
                       (enc1 == dwarf::DW_ATE_float && enc2 == dwarf::DW_ATE_float)
                       ||
                       ((enc1 == dwarf::DW_ATE_signed_char || enc1 == dwarf::DW_ATE_unsigned_char)
                        &&
                        (enc2 == dwarf::DW_ATE_signed_char || enc2 == dwarf::DW_ATE_unsigned_char));
 
        if (!okayEnc) return false;
        // Now we have split integers, floats, and chars, ignoring signedness.
 
        return t1->getSizeInBits() == t2->getSizeInBits()
               && t1->getAlignInBits() == t2->getAlignInBits();
    }
 
    // Check, do we need to compare base types?
    // This makes pointers, references, and arrays equivalent.
    // Will handle member types.
    if ((SVFUtil::isa<DIDerivedType>(t1) || t1->getTag() == dwarf::DW_TAG_array_type)
            && (SVFUtil::isa<DIDerivedType>(t2) || t2->getTag() == dwarf::DW_TAG_array_type))
    {
        const DIType *base1, *base2;
 
        // Set base1.
        if (const DIDerivedType *d1 = SVFUtil::dyn_cast<DIDerivedType>(t1))
        {
            base1 = d1->getBaseType();
        }
        else
        {
            const DICompositeType *c1 = SVFUtil::dyn_cast<DICompositeType>(t1);
            assert(c1 && "teq: bad cast for array type");
            base1 = c1->getBaseType();
        }
 
        // Set base2.
        if (const DIDerivedType *d2 = SVFUtil::dyn_cast<DIDerivedType>(t2))
        {
            base2 = d2->getBaseType();
        }
        else
        {
            const DICompositeType *c2 = SVFUtil::dyn_cast<DICompositeType>(t2);
            assert(c2 && "teq: bad cast for array type");
            base2 = c2->getBaseType();
        }
 
        // For ptr-to-member, there is some imprecision (but soundness) in
        // that we don't check the class type.
        return teq(base1, base2);
    }
 
    if (SVFUtil::isa<DICompositeType>(t1) && SVFUtil::isa<DICompositeType>(t2))
    {
        const DICompositeType *ct1 = SVFUtil::dyn_cast<DICompositeType>(t1);
        const DICompositeType *ct2 = SVFUtil::dyn_cast<DICompositeType>(t2);
 
        if (ct1->getTag() != ct2->getTag()) return false;
 
        // Treat all enums the same.
        if (ct1->getTag() == dwarf::DW_TAG_enumeration_type)
        {
            return true;
        }
 
        // C++ classes? Check mangled name.
        if (ct1->getTag() == dwarf::DW_TAG_class_type)
        {
            return ct1->getIdentifier() == ct2->getIdentifier();
        }
 
        // Either union or struct, simply test all fields are equal.
        // Seems like it is enough to check it was defined in the same place.
        // The elements sometimes differ but are referring to the same fields.
        return    ct1->getName() == ct2->getName()
                  && ct1->getFile() == ct2->getFile()
                  && ct1->getLine() == ct2->getLine();
    }
 
    // They were not equal base types (discounting signedness), nor were they
    // "equal" pointers/references/arrays, nor were they the structurally equivalent,
    // nor were they completely equal.
    return false;
}

Member Data Documentation

canonicalTypeMap

Map<const DIType*, const DIType*> SVF::DCHGraph::canonicalTypeMap

protected

Maps types to their canonical type (many-to-one).

Definition at line 374 of file DCHG.h.

canonicalTypes

Set<const DIType*> SVF::DCHGraph::canonicalTypes

protected

Set of all possible canonical types (i.e. values of canonicalTypeMap).

Definition at line 376 of file DCHG.h.

chaFFMap

Map<const DIType*, NodeBS> SVF::DCHGraph::chaFFMap

protected

Maps types to all children but also considering first field.

Definition at line 368 of file DCHG.h.

chaMap

Map<const DIType*, NodeBS> SVF::DCHGraph::chaMap

protected

Maps types to all children (i.e. CHA).

Definition at line 366 of file DCHG.h.

containingAggs

Map<const DIType*, Set<const DIType*> > SVF::DCHGraph::containingAggs

protected

Maps aggregate types to all the aggregate types it transitively contains.

Definition at line 380 of file DCHG.h.

csCHAMap

Map<const CallICFGNode*, VFunSet> SVF::DCHGraph::csCHAMap

protected

Maps callsites to a set of potential virtual functions based on CHA.

Definition at line 372 of file DCHG.h.

diTypeToNodeMap

Map<const DIType*, DCHNode*> SVF::DCHGraph::diTypeToNodeMap

protected

Maps DITypes to their nodes.

Definition at line 362 of file DCHG.h.

extended

bool SVF::DCHGraph::extended = false

protected

Whether this CHG is an extended CHG (first-field). Set by buildCHG.

Definition at line 360 of file DCHG.h.

fieldTypes

Map<const DIType*, std::vector<const DIType*> > SVF::DCHGraph::fieldTypes

protected

Maps types to their flattened fields' types.

Definition at line 378 of file DCHG.h.

numTypes

NodeID SVF::DCHGraph::numTypes

private

Number of types (nodes) in the graph.

Definition at line 445 of file DCHG.h.

vtblCHAMap

Map<const DIType*, VTableSet> SVF::DCHGraph::vtblCHAMap

protected

Maps types to a set with their vtable and all their children's.

Definition at line 370 of file DCHG.h.

vtblToTypeMap

Map<const GlobalObjVar*, const DIType*> SVF::DCHGraph::vtblToTypeMap

protected

Maps VTables to the DIType associated with them.

Definition at line 364 of file DCHG.h.

---

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

• /home/runner/work/SVF/SVF/svf-llvm/include/SVF-LLVM/DCHG.h
• /home/runner/work/SVF/SVF/svf-llvm/lib/DCHG.cpp