PTData backed by a PersistentPointsToCache. More...

#include <PersistentPointsToDS.h>

Inheritance diagram for SVF::PersistentPTData< Key, KeySet, Data, DataSet >:

Public Types
typedef PTData< Key, KeySet, Data, DataSet >	BasePTData

typedef BasePTData::PTDataTy	PTDataTy

typedef Map< Key, PointsToID >	KeyToIDMap

typedef Map< Data, KeySet >	RevPtsMap

Public Types inherited from SVF::PTData< Key, KeySet, Data, DataSet >
enum	PTDataTy { Base , MutBase , Diff , MutDiff , DataFlow , MutDataFlow , MutIncDataFlow , Versioned , MutVersioned , PersBase , PersDiff , PersDataFlow , PersIncDataFlow , PersVersioned }
	Types of a points-to data structures. More...

Public Member Functions
	PersistentPTData (PersistentPointsToCache< DataSet > &cache, bool reversePT=true, PTDataTy ty=PTDataTy::PersBase)
	Constructor.

	~PersistentPTData () override=default

void	clear () override
	Clears all points-to sets as if nothing is stored.

const DataSet &	getPts (const Key &var) override
	Get points-to set of var.

const KeySet &	getRevPts (const Data &data) override
	Get reverse points-to set of a datum.

bool	addPts (const Key &dstKey, const Data &element) override
	Adds element to the points-to set associated with var.

bool	unionPts (const Key &dstKey, const Key &srcKey) override
	Performs pts(dstVar) = pts(dstVar) U pts(srcVar).

bool	unionPts (const Key &dstKey, const DataSet &srcData) override
	Performs pts(dstVar) = pts(dstVar) U srcDataSet.

void	dumpPTData () override
	Dump stored keys and points-to sets.

void	clearPts (const Key &var, const Data &element) override
	Clears element from the points-to set of var.

void	clearFullPts (const Key &var) override
	Fully clears the points-to set of var.

void	remapAllPts () override
	Remaps all points-to sets to use the current mapping.

Map< DataSet, unsigned >	getAllPts (bool liveOnly) const override

Public Member Functions inherited from SVF::PTData< Key, KeySet, Data, DataSet >
	PTData (bool reversePT=true, PTDataTy ty=PTDataTy::Base)

virtual	~PTData ()

PTDataTy	getPTDTY () const
	Get the type of points-to data structure that this is.

Static Public Member Functions

static bool	classof (const PersistentPTData< Key, KeySet, Data, DataSet > *)

static bool	classof (const PTData< Key, KeySet, Data, DataSet > *ptd)

Protected Attributes
PersistentPointsToCache< DataSet > &	ptCache

KeyToIDMap	ptsMap

RevPtsMap	revPtsMap

Protected Attributes inherited from SVF::PTData< Key, KeySet, Data, DataSet >
bool	rev
	Whether we maintain reverse points-to sets or not.

PTDataTy	ptdTy

Private Member Functions
bool	unionPtsFromId (const Key &dstKey, PointsToID srcId)

void	clearSingleRevPts (KeySet &revSet, const Key &k)

void	clearRevPts (const DataSet &pts, const Key &k)

Friends
template<typename K , typename KS , typename D , typename DS , typename VK , typename VKS >
class	PersistentVersionedPTData

class	PersistentDFPTData< Key, KeySet, Data, DataSet >

class	PersistentIncDFPTData< Key, KeySet, Data, DataSet >

Detailed Description

template<typename Key, typename KeySet, typename Data, typename DataSet>
class SVF::PersistentPTData< Key, KeySet, Data, DataSet >

PTData backed by a PersistentPointsToCache.

Definition at line 33 of file PersistentPointsToDS.h.

Member Typedef Documentation

◆ BasePTData

template<typename Key , typename KeySet , typename Data , typename DataSet >

typedef PTData<Key, KeySet, Data, DataSet> SVF::PersistentPTData< Key, KeySet, Data, DataSet >::BasePTData

Definition at line 40 of file PersistentPointsToDS.h.

◆ KeyToIDMap

template<typename Key , typename KeySet , typename Data , typename DataSet >

typedef Map<Key, PointsToID> SVF::PersistentPTData< Key, KeySet, Data, DataSet >::KeyToIDMap

Definition at line 43 of file PersistentPointsToDS.h.

◆ PTDataTy

template<typename Key , typename KeySet , typename Data , typename DataSet >

typedef BasePTData::PTDataTy SVF::PersistentPTData< Key, KeySet, Data, DataSet >::PTDataTy

Definition at line 41 of file PersistentPointsToDS.h.

◆ RevPtsMap

template<typename Key , typename KeySet , typename Data , typename DataSet >

typedef Map<Data, KeySet> SVF::PersistentPTData< Key, KeySet, Data, DataSet >::RevPtsMap

Definition at line 44 of file PersistentPointsToDS.h.

Constructor & Destructor Documentation

◆ PersistentPTData()

template<typename Key , typename KeySet , typename Data , typename DataSet >

SVF::PersistentPTData< Key, KeySet, Data, DataSet >::PersistentPTData	(	PersistentPointsToCache< DataSet > &	cache,
		bool	reversePT = `true`,
		PTDataTy	ty = `PTDataTy::PersBase`
	)

inlineexplicit

Constructor.

Definition at line 47 of file PersistentPointsToDS.h.

48 : BasePTData(reversePT, ty), ptCache(cache) { }

SVF::PersistentPTData::ptCache

PersistentPointsToCache< DataSet > & ptCache

Definition PersistentPointsToDS.h:192

SVF::PersistentPTData::BasePTData

PTData< Key, KeySet, Data, DataSet > BasePTData

Definition PersistentPointsToDS.h:40

SVF::IRBuilder

llvm::IRBuilder IRBuilder

Definition BasicTypes.h:76

◆ ~PersistentPTData()

template<typename Key , typename KeySet , typename Data , typename DataSet >

SVF::PersistentPTData< Key, KeySet, Data, DataSet >::~PersistentPTData ( )

overridedefault

Member Function Documentation

◆ addPts()

template<typename Key , typename KeySet , typename Data , typename DataSet >

bool SVF::PersistentPTData< Key, KeySet, Data, DataSet >::addPts	(	const Key &	var,
		const Data &	element
	)

inlineoverridevirtual

Adds element to the points-to set associated with var.

Implements SVF::PTData< Key, KeySet, Data, DataSet >.

Definition at line 70 of file PersistentPointsToDS.h.

    {
        DataSet srcPts;
        srcPts.set(element);
        PointsToID srcId = ptCache.emplacePts(srcPts);
        return unionPtsFromId(dstKey, srcId);
    }

◆ classof() [1/2]

template<typename Key , typename KeySet , typename Data , typename DataSet >

static bool SVF::PersistentPTData< Key, KeySet, Data, DataSet >::classof ( const PersistentPTData< Key, KeySet, Data, DataSet > * )

inlinestatic

Methods to support type inquiry through isa, cast, and dyn_cast:

Definition at line 139 of file PersistentPointsToDS.h.

    {
        return true;
    }

◆ classof() [2/2]

template<typename Key , typename KeySet , typename Data , typename DataSet >

static bool SVF::PersistentPTData< Key, KeySet, Data, DataSet >::classof ( const PTData< Key, KeySet, Data, DataSet > * ptd )

inlinestatic

Definition at line 144 of file PersistentPointsToDS.h.

    {
        return ptd->getPTDTY() == PTDataTy::PersBase;
    }

◆ clear()

template<typename Key , typename KeySet , typename Data , typename DataSet >

void SVF::PersistentPTData< Key, KeySet, Data, DataSet >::clear ( )

inlineoverridevirtual

Clears all points-to sets as if nothing is stored.

Implements SVF::PTData< Key, KeySet, Data, DataSet >.

Definition at line 52 of file PersistentPointsToDS.h.

    {
        ptsMap.clear();
        revPtsMap.clear();
    }

◆ clearFullPts()

template<typename Key , typename KeySet , typename Data , typename DataSet >

void SVF::PersistentPTData< Key, KeySet, Data, DataSet >::clearFullPts ( const Key & var )

inlineoverridevirtual

Fully clears the points-to set of var.

Implements SVF::PTData< Key, KeySet, Data, DataSet >.

Definition at line 108 of file PersistentPointsToDS.h.

    {
        clearRevPts(getPts(var), var);
        ptsMap[var] = PersistentPointsToCache<DataSet>::emptyPointsToId();
    }

◆ clearPts()

template<typename Key , typename KeySet , typename Data , typename DataSet >

void SVF::PersistentPTData< Key, KeySet, Data, DataSet >::clearPts	(	const Key &	var,
		const Data &	element
	)

inlineoverridevirtual

Clears element from the points-to set of var.

Implements SVF::PTData< Key, KeySet, Data, DataSet >.

Definition at line 94 of file PersistentPointsToDS.h.

    {
        DataSet toRemoveData;
        toRemoveData.set(element);
        PointsToID toRemoveId = ptCache.emplacePts(toRemoveData);
        PointsToID varId = ptsMap[var];
        PointsToID complementId = ptCache.complementPts(varId, toRemoveId);
        if (varId != complementId)
        {
            ptsMap[var] = complementId;
            clearSingleRevPts(revPtsMap[element], var);
        }
    }

◆ clearRevPts()

template<typename Key , typename KeySet , typename Data , typename DataSet >

void SVF::PersistentPTData< Key, KeySet, Data, DataSet >::clearRevPts	(	const DataSet &	pts,
		const Key &	k
	)

inlineprivate

Definition at line 183 of file PersistentPointsToDS.h.

    {
        if (this->rev)
        {
            for (const Data &d : pts) clearSingleRevPts(revPtsMap[d], k);
        }
    }

◆ clearSingleRevPts()

template<typename Key , typename KeySet , typename Data , typename DataSet >

void SVF::PersistentPTData< Key, KeySet, Data, DataSet >::clearSingleRevPts	(	KeySet &	revSet,
		const Key &	k
	)

inlineprivate

Definition at line 175 of file PersistentPointsToDS.h.

    {
        if (this->rev)
        {
            SVFUtil::removeKey(k, revSet);
        }
    }

◆ dumpPTData()

template<typename Key , typename KeySet , typename Data , typename DataSet >

void SVF::PersistentPTData< Key, KeySet, Data, DataSet >::dumpPTData ( )

inlineoverridevirtual

Dump stored keys and points-to sets.

Implements SVF::PTData< Key, KeySet, Data, DataSet >.

Definition at line 90 of file PersistentPointsToDS.h.

91 {

92 }

◆ getAllPts()

template<typename Key , typename KeySet , typename Data , typename DataSet >

Map< DataSet, unsigned > SVF::PersistentPTData< Key, KeySet, Data, DataSet >::getAllPts ( bool liveOnly ) const

inlineoverridevirtual

Returns a mapping of points-to sets to the number of times they are stored. liveOnly indicates whether to include only points-to sets which correspond to a variable (matters when dealing with non-GC persistent PT).

Implements SVF::PTData< Key, KeySet, Data, DataSet >.

Definition at line 119 of file PersistentPointsToDS.h.

    {
        Map<DataSet, unsigned> allPts;
        if (liveOnly)
        {
            for (const typename KeyToIDMap::value_type &ki : ptsMap)
            {
                ++allPts[ptCache.getActualPts(ki.second)];
            }
        }
        else
        {
            allPts = ptCache.getAllPts();
        }
 
        return allPts;
    }

◆ getPts()

template<typename Key , typename KeySet , typename Data , typename DataSet >

const DataSet & SVF::PersistentPTData< Key, KeySet, Data, DataSet >::getPts ( const Key & var )

inlineoverridevirtual

Get points-to set of var.

Implements SVF::PTData< Key, KeySet, Data, DataSet >.

Definition at line 58 of file PersistentPointsToDS.h.

    {
        PointsToID id = ptsMap[var];
        return ptCache.getActualPts(id);
    }

◆ getRevPts()

template<typename Key , typename KeySet , typename Data , typename DataSet >

const KeySet & SVF::PersistentPTData< Key, KeySet, Data, DataSet >::getRevPts ( const Data & datum )

inlineoverridevirtual

Get reverse points-to set of a datum.

Implements SVF::PTData< Key, KeySet, Data, DataSet >.

Definition at line 64 of file PersistentPointsToDS.h.

    {
        assert(this->rev && "PersistentPTData::getRevPts: constructed without reverse PT support!");
        return revPtsMap[data];
    }

◆ remapAllPts()

template<typename Key , typename KeySet , typename Data , typename DataSet >

void SVF::PersistentPTData< Key, KeySet, Data, DataSet >::remapAllPts ( )

inlineoverridevirtual

Remaps all points-to sets to use the current mapping.

Implements SVF::PTData< Key, KeySet, Data, DataSet >.

Definition at line 114 of file PersistentPointsToDS.h.

    {
        ptCache.remapAllPts();
    }

◆ unionPts() [1/2]

template<typename Key , typename KeySet , typename Data , typename DataSet >

bool SVF::PersistentPTData< Key, KeySet, Data, DataSet >::unionPts	(	const Key &	dstVar,
		const DataSet &	srcDataSet
	)

inlineoverridevirtual

Performs pts(dstVar) = pts(dstVar) U srcDataSet.

Implements SVF::PTData< Key, KeySet, Data, DataSet >.

Definition at line 84 of file PersistentPointsToDS.h.

    {
        PointsToID srcId = ptCache.emplacePts(srcData);
        return unionPtsFromId(dstKey, srcId);
    }

◆ unionPts() [2/2]

template<typename Key , typename KeySet , typename Data , typename DataSet >

bool SVF::PersistentPTData< Key, KeySet, Data, DataSet >::unionPts	(	const Key &	dstVar,
		const Key &	srcVar
	)

inlineoverridevirtual

Performs pts(dstVar) = pts(dstVar) U pts(srcVar).

Implements SVF::PTData< Key, KeySet, Data, DataSet >.

Definition at line 78 of file PersistentPointsToDS.h.

    {
        PointsToID srcId = ptsMap[srcKey];
        return unionPtsFromId(dstKey, srcId);
    }

◆ unionPtsFromId()

template<typename Key , typename KeySet , typename Data , typename DataSet >

bool SVF::PersistentPTData< Key, KeySet, Data, DataSet >::unionPtsFromId	(	const Key &	dstKey,
		PointsToID	srcId
	)

inlineprivate

Internal unionPts since other methods follow the same pattern. Renamed because PointsToID and Key may be the same type...

Definition at line 153 of file PersistentPointsToDS.h.

    {
        PointsToID dstId = ptsMap[dstKey];
        PointsToID newDstId = ptCache.unionPts(dstId, srcId);
 
        bool changed = newDstId != dstId;
        if (changed)
        {
            ptsMap[dstKey] = newDstId;
 
            // Reverse points-to only needs to be handled when dst's
            // points-to set has changed (i.e., do it the first time only).
            if (this->rev)
            {
                const DataSet &srcPts = ptCache.getActualPts(srcId);
                for (const Data &d : srcPts) SVFUtil::insertKey(dstKey, revPtsMap[d]);
            }
        }
 
        return changed;
    }