ExternalPAG.h

Go to the documentation of this file.

//===- ExternalPAG.h -- Program assignment graph------------------------------//

/*
 * ExternalPAG.h
 *
 *  Created on: Aug 20, 2018
 *      Author: Mohamad Barbar
 */

#ifndef EXTERNALPAG_H_
#define EXTERNALPAG_H_

#include "Graphs/PAGNode.h"

extern llvm::cl::list<std::string> DumpPAGFunctions;

namespace SVF
{

class ExternalPAG
{
private:
    static Map<const SVFFunction*, Map<int, PAGNode *>>
            functionToExternalPAGEntries;
    static Map<const SVFFunction*, PAGNode *> functionToExternalPAGReturns;

    std::string functionName;

    NodeSet valueNodes;
    NodeSet objectNodes;
    OrderedSet<std::tuple<NodeID, NodeID, std::string, int>> edges;

    // Special nodes.

    Map<int, NodeID> argNodes;
    NodeID returnNode;

    bool hasReturn;

    static std::vector<std::pair<std::string, std::string>>
            parseExternalPAGs(llvm::cl::list<std::string> &extpagsArgs);

    void readFromFile(std::string filename);

public:
    ExternalPAG(std::string functionName) : functionName(functionName),
        returnNode(-1), hasReturn(false) {}

    ~ExternalPAG() {}

    static void initialise(SVFModule* svfModule);

    static bool connectCallsiteToExternalPAG(CallSite *cs);

    static bool hasExternalPAG(const SVFFunction* function);

    static void dumpFunctions(std::vector<std::string> functions);

    std::string getFunctionName() const
    {
        return functionName;
    }

    NodeSet &getValueNodes()
    {
        return valueNodes;
    }
    NodeSet &getObjectNodes()
    {
        return objectNodes;
    }
    OrderedSet<std::tuple<NodeID, NodeID, std::string, int>> &getEdges()
    {
        return edges;
    }

    Map<int, NodeID> &getArgNodes()
    {
        return argNodes;
    }

    NodeID getReturnNode() const
    {
        return returnNode;
    }
    void setReturnNode(NodeID returnNode)
    {
        this->returnNode = returnNode;
        hasReturn = true;
    }

    bool hasReturnNode() const
    {
        return hasReturn;
    }

    bool addExternalPAG(const SVFFunction* function);

};

} // End namespace SVF

#endif  /* EXTERNALPAG_H_ */