SparseObjGraph.h

Go to the documentation of this file.

//===- SparseObjGraph.h - Static packed Obj value-flow routes -------------===//
 
#ifndef INCLUDE_GRAPHS_SPARSEOBJGRAPH_H_
#define INCLUDE_GRAPHS_SPARSEOBJGRAPH_H_
 
#include "Graphs/ICFG.h"
 
namespace SVF
{
 
class PointerAnalysis;
class SVFIR;
class SVFG;
class SparseObjNode;
 
typedef GenericEdge<SparseObjNode> GenericSparseObjEdgeTy;

class SparseObjEdge : public GenericSparseObjEdgeTy
{
public:
    SparseObjEdge(SparseObjNode* source, SparseObjNode* target)
        : GenericSparseObjEdgeTy(source, target, 0) {}
 
    std::string toString() const;
};
 
typedef GenericNode<SparseObjNode, SparseObjEdge> GenericSparseObjNodeTy;

class SparseObjNode : public GenericSparseObjNodeTy
{
public:
    SparseObjNode(NodeID id, NodeID base, const ICFGNode* location,
                  const IntraCFGEdge* branch)
        : GenericSparseObjNodeTy(id, OtherKd), base(base), location(location),
          branch(branch) {}
 
    NodeID base;
    const ICFGNode* location;
    const IntraCFGEdge* branch;
 
    const ICFGNode* getICFGNode() const
    {
        return location;
    }
    std::string toString() const;
};
 
typedef GenericGraph<SparseObjNode, SparseObjEdge> GenericSparseObjGraphTy;

class SparseObjGraph : public GenericSparseObjGraphTy
{
public:
    typedef SparseObjNode Node;
    typedef SparseObjEdge Edge;

    SparseObjGraph(const SVFG& svfg, ICFG& icfg,
                   PointerAnalysis& pta, const SVFIR& svfir);
    SparseObjGraph(const SparseObjGraph&) = delete;
    SparseObjGraph& operator=(const SparseObjGraph&) = delete;

    const std::vector<const Edge*>& getInputs(const ICFGNode* node) const;
    std::string toString() const;
    void dump(const std::string& file);
 
private:
    bool isBranch(const ICFGNode* node) const;
    Node* getOrCreateBaseObjNode(NodeID baseObjId, const ICFGNode* location);
    Node* getBranchNode(NodeID base, const IntraCFGEdge* branch);
    void addRouteEdge(Node* source, Node* target);
    void addEdge(NodeID base, const ICFGNode* source,
                 const ICFGNode* target, const IntraCFGEdge* branch);
    void connectFrom(NodeID base, const ICFGNode* source,
                     const Set<const ICFGNode*>& events,
                     Set<const ICFGNode*>& newSources);
 
    ICFG& icfg;
    Map<NodeID, Map<const ICFGNode*, Node*>> groupNodes;
    Map<NodeID, Map<const IntraCFGEdge*, Node*>> branchNodes;
    Map<const ICFGNode*, std::vector<const Edge*>> inputs;
    Map<const ICFGNode*, Set<NodeID>> returnedGroups;
    Map<const ICFGNode*, Map<const FunObjVar*, Set<NodeID>>> returnedGroupsByCallee;
};
 
} // namespace SVF
 
namespace SVF
{
 
template<>
struct GenericGraphTraits<SparseObjNode*>
    :
    public GenericGraphTraits<GenericNode<SparseObjNode, SparseObjEdge>*>
{
};
 
template<>
struct GenericGraphTraits<Inverse<SparseObjNode*>>
    : public GenericGraphTraits<Inverse<GenericNode<SparseObjNode, SparseObjEdge>*>>
{
};
 
template<>
struct GenericGraphTraits<SparseObjGraph*>
    : public GenericGraphTraits<GenericGraph<SparseObjNode, SparseObjEdge>*>
{
    typedef SparseObjNode* NodeRef;
};
 
} // namespace SVF
 
#endif