SVF::LocationSet Class Reference

#include <LocationSet.h>

Public Types
enum	LSRelation {   NonOverlap, Overlap, Subset, Superset,   Same }
typedef FieldInfo::ElemNumStridePairVec	ElemNumStridePairVec

Public Member Functions
	LocationSet (Size_t o=0)
	Constructor. More...
	LocationSet (const LocationSet &ls)
	Copy Constructor. More...
	LocationSet (const FieldInfo &fi)
	Initialization from FieldInfo. More...
	~LocationSet ()
void	addElemNumStridePair (const NodePair &pair)
bool	isConstantOffset () const
	Return TRUE if this is a constant location set. More...
bool	intersects (const LocationSet &RHS) const
	Return TRUE if we share any location in common with RHS. More...
std::string	dump () const
	Dump location set. More...
LocationSet	operator+ (const LocationSet &rhs) const
	Overload operators. More...
const LocationSet &	operator= (const LocationSet &rhs)
bool	operator< (const LocationSet &rhs) const
bool	operator== (const LocationSet &rhs) const
Size_t	getOffset () const
	Get methods. More...
Size_t	getByteOffset () const
void	setFldIdx (Size_t idx)
void	setByteOffset (Size_t os)
const ElemNumStridePairVec &	getNumStridePair () const

Static Public Member Functions
static LSRelation	checkRelation (const LocationSet &LHS, const LocationSet &RHS)
	Check relations of two location sets. More...

Private Member Functions
bool	increaseIfNotReachUpperBound (std::vector< NodeID > &indices, const ElemNumStridePairVec &pairVec) const
	Return TRUE if successfully increased any index by 1. More...
PointsTo	computeAllLocations () const
	Compute all possible locations according to offset and number-stride pairs. More...
unsigned	gcd (unsigned n1, unsigned n2) const
	Return greatest common divisor. More...

Private Attributes
Size_t	fldIdx
	offset relative to base More...
Size_t	byteOffset
	offset relative to base More...
ElemNumStridePairVec	numStridePair
	element number and stride pair More...

Friends
class	SymbolTableInfo
class	LocSymTableInfo

Detailed Description

Definition at line 93 of file LocationSet.h.

Member Typedef Documentation

ElemNumStridePairVec

typedef FieldInfo::ElemNumStridePairVec SVF::LocationSet::ElemNumStridePairVec

Definition at line 103 of file LocationSet.h.

Member Enumeration Documentation

LSRelation

enum SVF::LocationSet::LSRelation

Enumerator
NonOverlap
Overlap
Subset
Superset
Same

Definition at line 98 of file LocationSet.h.

    {
        NonOverlap, Overlap, Subset, Superset, Same
    };

Constructor & Destructor Documentation

LocationSet() [1/3]

SVF::LocationSet::LocationSet ( Size_t  o = 0 )

inline

Constructor.

Definition at line 106 of file LocationSet.h.

                              : fldIdx(o), byteOffset(o)
    {}

LocationSet() [2/3]

SVF::LocationSet::LocationSet ( const LocationSet &  ls )

inline

Copy Constructor.

Definition at line 110 of file LocationSet.h.

        : fldIdx(ls.fldIdx), byteOffset(ls.byteOffset)
    {
        const ElemNumStridePairVec& vec = ls.getNumStridePair();
        ElemNumStridePairVec::const_iterator it = vec.begin();
        ElemNumStridePairVec::const_iterator eit = vec.end();
        for (; it != eit; ++it)
            addElemNumStridePair(*it);
    }

LocationSet() [3/3]

SVF::LocationSet::LocationSet ( const FieldInfo &  fi )

inline

Initialization from FieldInfo.

Definition at line 121 of file LocationSet.h.

        : fldIdx(fi.getFlattenFldIdx()), byteOffset(fi.getFlattenByteOffset())
    {
        const ElemNumStridePairVec& vec = fi.getElemNumStridePairVect();
        ElemNumStridePairVec::const_iterator it = vec.begin();
        ElemNumStridePairVec::const_iterator eit = vec.end();
        for (; it != eit; ++it)
            addElemNumStridePair(*it);
    }

~LocationSet()

SVF::LocationSet::~LocationSet ( )

inline

Definition at line 131 of file LocationSet.h.

{}

Member Function Documentation

addElemNumStridePair()

void LocationSet::addElemNumStridePair

(

const NodePair &

pair

)

Add element num and stride pair

The pair will not be added if any number of a stride is zero, because they will not have effect on the locations represented by this LocationSet.

Find the GCD stride

Definition at line 42 of file LocationSet.cpp.

{
    if (pair.first == 0 || pair.second == 0)
        return;

    if (Options::SingleStride)
    {
        if (numStridePair.empty())
            numStridePair.push_back(std::make_pair(StInfo::getMaxFieldLimit(),pair.second));
        else
        {
            NodeID existStride = (*numStridePair.begin()).second;
            NodeID newStride = gcd(pair.second, existStride);
            if (newStride != existStride)
            {
                numStridePair.pop_back();
                numStridePair.push_back(std::make_pair(StInfo::getMaxFieldLimit(),newStride));
            }
        }
    }
    else
    {
        numStridePair.push_back(pair);
    }
}

checkRelation()

static LSRelation SVF::LocationSet::checkRelation ( const LocationSet &  LHS, const LocationSet &  RHS  )

inlinestatic

Check relations of two location sets.

Definition at line 231 of file LocationSet.h.

    {
        PointsTo lhsLocations = LHS.computeAllLocations();
        PointsTo rhsLocations = RHS.computeAllLocations();
        if (lhsLocations.intersects(rhsLocations))
        {
            if (lhsLocations == rhsLocations)
                return Same;
            else if (lhsLocations.contains(rhsLocations))
                return Superset;
            else if (rhsLocations.contains(lhsLocations))
                return Subset;
            else
                return Overlap;
        }
        else
        {
            return NonOverlap;
        }
    }

computeAllLocations()

PointsTo LocationSet::computeAllLocations ( ) const

private

Compute all possible locations according to offset and number-stride pairs.

Compute all possible locations according to offset and number-stride pairs.

Definition at line 116 of file LocationSet.cpp.

{

    PointsTo result;
    result.set(getOffset());

    if (isConstantOffset() == false)
    {
        const ElemNumStridePairVec& lhsVec = getNumStridePair();
        std::vector<NodeID> indices;
        u32_t size = lhsVec.size();
        while (size)
        {
            indices.push_back(0);
            size--;
        }

        do
        {
            u32_t i = 0;
            NodeID ofst = getOffset();
            while (i < lhsVec.size())
            {
                ofst += (lhsVec[i].second * indices[i]);
                i++;
            }

            result.set(ofst);

        }
        while (increaseIfNotReachUpperBound(indices, lhsVec));
    }

    return result;
}

dump()

std::string SVF::LocationSet::dump ( ) const

inline

Dump location set.

Definition at line 253 of file LocationSet.h.

    {
        std::string str;
        raw_string_ostream rawstr(str);

        rawstr << "LocationSet\tField_Index: " << getOffset();
        rawstr << "\tOffset: " << getByteOffset()
               << ",\tNum-Stride: {";
        const ElemNumStridePairVec& vec = getNumStridePair();
        ElemNumStridePairVec::const_iterator it = vec.begin();
        ElemNumStridePairVec::const_iterator eit = vec.end();
        for (; it != eit; ++it)
        {
            rawstr << " (" << it->first << "," << it->second << ")";
        }
        rawstr << " }\n";
        return rawstr.str();
    }

gcd()

unsigned SVF::LocationSet::gcd ( unsigned  n1, unsigned  n2  ) const

inlineprivate

Return greatest common divisor.

Definition at line 279 of file LocationSet.h.

    {
        return (n2 == 0) ? n1 : gcd (n2, n1 % n2);
    }

getByteOffset()

Size_t SVF::LocationSet::getByteOffset ( ) const

inline

Definition at line 198 of file LocationSet.h.

    {
        return byteOffset;
    }

getNumStridePair()

const ElemNumStridePairVec& SVF::LocationSet::getNumStridePair ( ) const

inline

Definition at line 210 of file LocationSet.h.

    {
        return numStridePair;
    }

getOffset()

Size_t SVF::LocationSet::getOffset ( ) const

inline

Get methods.

Definition at line 194 of file LocationSet.h.

    {
        return fldIdx;
    }

increaseIfNotReachUpperBound()

bool LocationSet::increaseIfNotReachUpperBound ( std::vector< NodeID > &  indices, const ElemNumStridePairVec &  pairVec  ) const

private

Return TRUE if successfully increased any index by 1.

Return TRUE if it successfully increases any index by 1

Check if all indices reach upper bound

Increase index if not reach upper bound

Definition at line 75 of file LocationSet.cpp.

{
    assert(indices.size() == pairVec.size() && "vector size not match");

    bool reachUpperBound = true;
    for (u32_t i = 0; i < indices.size(); i++)
    {
        assert(pairVec[i].first > 0 && "number must be greater than 0");
        if (indices[i] < (pairVec[i].first - 1))
            reachUpperBound = false;
    }

    bool increased = false;
    if (reachUpperBound == false)
    {
        u32_t i = 0;
        while (increased == false)
        {
            if (indices[i] < (pairVec[i].first - 1))
            {
                indices[i] += 1;
                increased = true;
            }
            else
            {
                indices[i] = 0;
                i++;
            }
        }
    }

    return increased;
}

intersects()

bool SVF::LocationSet::intersects ( const LocationSet &  RHS ) const

inline

Return TRUE if we share any location in common with RHS.

Definition at line 225 of file LocationSet.h.

    {
        return computeAllLocations().intersects(RHS.computeAllLocations());
    }

isConstantOffset()

bool SVF::LocationSet::isConstantOffset ( ) const

inline

Return TRUE if this is a constant location set.

Definition at line 219 of file LocationSet.h.

    {
        return (numStridePair.size() == 0);
    }

operator+()

LocationSet SVF::LocationSet::operator+ ( const LocationSet &  rhs ) const

inline

Overload operators.

Definition at line 136 of file LocationSet.h.

    {
        LocationSet ls(rhs);
        ls.fldIdx += getOffset();
        ls.byteOffset += getByteOffset();
        ElemNumStridePairVec::const_iterator it = getNumStridePair().begin();
        ElemNumStridePairVec::const_iterator eit = getNumStridePair().end();
        for (; it != eit; ++it)
            ls.addElemNumStridePair(*it);

        return ls;
    }

operator<()

bool SVF::LocationSet::operator< ( const LocationSet &  rhs ) const

inline

Definition at line 155 of file LocationSet.h.

    {
        if (fldIdx != rhs.fldIdx)
            return (fldIdx < rhs.fldIdx);
//        else if (byteOffset != rhs.byteOffset)
//            return (byteOffset < rhs.byteOffset);
        else
        {
            const ElemNumStridePairVec& pairVec = getNumStridePair();
            const ElemNumStridePairVec& rhsPairVec = rhs.getNumStridePair();
            if (pairVec.size() != rhsPairVec.size())
                return (pairVec.size() < rhsPairVec.size());
            else
            {
                ElemNumStridePairVec::const_iterator it = pairVec.begin();
                ElemNumStridePairVec::const_iterator rhsIt = rhsPairVec.begin();
                for (; it != pairVec.end() && rhsIt != rhsPairVec.end(); ++it, ++rhsIt)
                {
                    if ((*it).first != (*rhsIt).first)
                        return ((*it).first < (*rhsIt).first);
                    else if ((*it).second != (*rhsIt).second)
                        return ((*it).second < (*rhsIt).second);
                }

                return false;
            }
        }
    }

operator=()

const LocationSet& SVF::LocationSet::operator= ( const LocationSet &  rhs )

inline

Definition at line 148 of file LocationSet.h.

    {
        fldIdx = rhs.fldIdx;
        byteOffset = rhs.byteOffset;
        numStridePair = rhs.getNumStridePair();
        return *this;
    }

operator==()

bool SVF::LocationSet::operator== ( const LocationSet &  rhs ) const

inline

Definition at line 184 of file LocationSet.h.

    {
        return this->fldIdx == rhs.fldIdx
               && this->byteOffset == rhs.byteOffset
               && this->numStridePair == rhs.numStridePair;
    }

setByteOffset()

void SVF::LocationSet::setByteOffset ( Size_t  os )

inline

Definition at line 206 of file LocationSet.h.

    {
        byteOffset = os;
    }

setFldIdx()

void SVF::LocationSet::setFldIdx ( Size_t  idx )

inline

Definition at line 202 of file LocationSet.h.

    {
        fldIdx = idx;
    }

Friends And Related Function Documentation

LocSymTableInfo

friend class LocSymTableInfo

friend

Definition at line 96 of file LocationSet.h.

SymbolTableInfo

friend class SymbolTableInfo

friend

Definition at line 95 of file LocationSet.h.

Member Data Documentation

byteOffset

Size_t SVF::LocationSet::byteOffset

private

offset relative to base

Definition at line 285 of file LocationSet.h.

fldIdx

Size_t SVF::LocationSet::fldIdx

private

offset relative to base

Definition at line 284 of file LocationSet.h.

numStridePair

ElemNumStridePairVec SVF::LocationSet::numStridePair

private

element number and stride pair

Definition at line 286 of file LocationSet.h.

---

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

• /home/runner/work/SVF-1/SVF-1/include/MemoryModel/LocationSet.h
• /home/runner/work/SVF-1/SVF-1/lib/MemoryModel/LocationSet.cpp