TypeBasedHeapCloning.h

Go to the documentation of this file.

//===- TypeBasedHeapCloning.h -- Type filter/type-based heap cloning base ------------//

/*
 * TypeBasedHeapCloning.h
 *
 * Contains data structures and functions to extend a pointer analysis
 * with type-based heap cloning/type filtering.
 *
 *  Created on: Feb 08, 2020
 *      Author: Mohamad Barbar
 */

#include "SVF-FE/DCHG.h"
#include "Graphs/PAG.h"
#include "MemoryModel/PointerAnalysisImpl.h"
#include "Util/BasicTypes.h"

namespace SVF
{

class TypeBasedHeapCloning
{
public:
    static const MDNode *getRawCTirMetadata(const Value *);

    virtual ~TypeBasedHeapCloning() { };

protected:
    static const DIType *undefType;

    static const std::string derefFnName;
    static const std::string mangledDerefFnName;

    TypeBasedHeapCloning(BVDataPTAImpl *pta);

    virtual void backPropagate(NodeID clone) = 0;

    DCHGraph *dchg = nullptr;

    void setDCHG(DCHGraph *dchg);
    void setPAG(PAG *pag);

    bool isBlkObjOrConstantObj(NodeID o) const;

    bool isBase(const DIType *a, const DIType *b) const;

    bool isClone(NodeID o) const;

    void setType(NodeID o, const DIType *t);
    const DIType *getType(NodeID o) const;

    void setAllocationSite(NodeID o, NodeID site);
    NodeID getAllocationSite(NodeID o) const;

    const NodeBS getObjsWithClones(void);
    void addClone(NodeID o, NodeID c);
    const NodeBS &getClones(NodeID o);

    // Set o as the original object of clone c.
    void setOriginalObj(NodeID c, NodeID o);
    NodeID getOriginalObj(NodeID c) const;

    PointsTo &getFilterSet(NodeID loc);

    void addGepToObj(NodeID gep, NodeID base, unsigned offset);
    const NodeBS &getGepObjsFromMemObj(const MemObj *memObj, unsigned offset);
    const NodeBS &getGepObjs(NodeID base);

    const NodeBS getGepObjClones(NodeID base, unsigned offset);

    bool init(NodeID loc, NodeID p, const DIType *tildet, bool reuse, bool gep=false);

    NodeID cloneObject(NodeID o, const DIType *type, bool reuse);

    inline NodeID addCloneDummyObjNode(const MemObj *mem);
    inline NodeID addCloneGepObjNode(const MemObj *mem, const LocationSet &l);
    inline NodeID addCloneFIObjNode(const MemObj *mem);

    const DIType *getTypeFromCTirMetadata(const Value *);

    void validateTBHCTests(SVFModule *svfMod);

    void dumpStats(void);

private:
    BVDataPTAImpl *pta;
    PAG *ppag = nullptr;

    Map<NodeID, const DIType *> objToType;
    Map<NodeID, NodeID> objToAllocation;
    Map<NodeID, NodeBS> objToClones;
    Map<NodeID, NodeID> cloneToOriginalObj;
    Map<NodeID, PointsTo> locToFilterSet;
    Map<NodeID, NodeBS> objToGeps;
    Map<const MemObj *, Map<unsigned, NodeBS>> memObjToGeps;

    bool isGep(const PAGNode *n) const;

    // Bunch of stats to keep track of.
    unsigned numInit  = 0;
    unsigned numTBWU  = 0;
    unsigned numTBSSU = 0;
    unsigned numTBSU  = 0;
    unsigned numReuse = 0;
    unsigned numAgg   = 0;

    // Previous stats but only upon stack/global objects.
    unsigned numSGInit  = 0;
    unsigned numSGTBWU  = 0;
    unsigned numSGTBSSU = 0;
    unsigned numSGTBSU  = 0;
    unsigned numSGReuse = 0;
    unsigned numSGAgg   = 0;
};

} // End namespace SVF