SVFGStat.h

Go to the documentation of this file.

//===- SVFGStat.h -- Statistics of SVFG---------------------------------------//
//
//                     SVF: Static Value-Flow Analysis
//
// Copyright (C) <2013-2017>  <Yulei Sui>
//
 
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
 
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
//
//===----------------------------------------------------------------------===//
 
/*
 * @file: SVFGStat.h
 * @author: yesen
 * @date: 10/12/2013
 * @version: 1.0
 *
 * @section LICENSE
 *
 * @section DESCRIPTION
 *
 */
 
 
#ifndef SVFGSTAT_H_
#define SVFGSTAT_H_
 
#include "Graphs/SVFG.h"
#include "SCC.h"
#include "Util/PTAStat.h"
 
namespace SVF
{
 
class MemSSA;
 
class MemSSAStat : public PTAStat
{
 
public:
    static const char* TotalTimeOfConstructMemSSA;  
    static const char* TimeOfGeneratingMemRegions;  
    static const char* TimeOfCreateMUCHI;   
    static const char* TimeOfInsertingPHI;  
    static const char* TimeOfSSARenaming;   
 
    static const char* NumOfMaxRegion;  
    static const char* NumOfAveragePtsInRegion; 
    static const char* NumOfMemRegions; 
    static const char* NumOfEntryChi;   
    static const char* NumOfRetMu;  
    static const char* NumOfCSChi;  
    static const char* NumOfCSMu;   
    static const char* NumOfLoadMu; 
    static const char* NumOfStoreChi;   
    static const char* NumOfMSSAPhi;    
 
    static const char* NumOfFunHasEntryChi; 
    static const char* NumOfFunHasRetMu;    
    static const char* NumOfCSHasChi;   
    static const char* NumOfCSHasMu;    
    static const char* NumOfLoadHasMu;  
    static const char* NumOfStoreHasChi;    
    static const char* NumOfBBHasMSSAPhi;   
 
    MemSSAStat(MemSSA*);
 
    virtual ~MemSSAStat()
    {
 
    }
    virtual void performStat() override;
 
    virtual void printStat(std::string str = "") override;
 
private:
    MemSSA* mssa;
};
 
 
class SVFGStat : public PTAStat
{
public:
    typedef Set<const SVFGNode*> SVFGNodeSet;
    typedef OrderedSet<const SVFGEdge*> SVFGEdgeSet;
    typedef SCCDetection<SVFG*> SVFGSCC;
 
    SVFGStat(SVFG* g);
 
    virtual ~SVFGStat() {}
 
    virtual void performStat() override;
 
    virtual void printStat(std::string str = "") override;
 
    virtual void performSCCStat(SVFGEdgeSet insensitiveCalRetEdges);
 
    void dirVFEdgeStart()
    {
        connectDirSVFGEdgeTimeStart = PTAStat::getClk(true);
    }
 
    void dirVFEdgeEnd()
    {
        connectDirSVFGEdgeTimeEnd = PTAStat::getClk(true);
    }
 
    void indVFEdgeStart()
    {
        connectIndSVFGEdgeTimeStart = PTAStat::getClk(true);
    }
 
    void indVFEdgeEnd()
    {
        connectIndSVFGEdgeTimeEnd = PTAStat::getClk(true);
    }
 
    void TLVFNodeStart()
    {
        addTopLevelNodeTimeStart = PTAStat::getClk(true);
    }
 
    void TLVFNodeEnd()
    {
        addTopLevelNodeTimeEnd = PTAStat::getClk(true);
    }
 
    void ATVFNodeStart()
    {
        addAddrTakenNodeTimeStart = PTAStat::getClk(true);
    }
 
    void ATVFNodeEnd()
    {
        addAddrTakenNodeTimeEnd = PTAStat::getClk(true);
    }
 
    void sfvgOptStart()
    {
        svfgOptTimeStart = PTAStat::getClk(true);
    }
 
    void sfvgOptEnd()
    {
        svfgOptTimeEnd = PTAStat::getClk(true);
    }
 
private:
    void clear();
 
    void processGraph();
 
    void calculateNodeDegrees(SVFGNode* node, NodeSet& nodeHasIndInEdge, NodeSet& nodeHasIndOutEdge);
 
    NodeID getSCCRep(SVFGSCC* scc, NodeID id) const;
 
    NodeID nodeInCycle(SVFGSCC* scc, NodeID id) const;
 
    SVFG* graph;
 
    int numOfNodes; 
 
    int numOfFormalIn;  
    int numOfFormalOut; 
    int numOfFormalParam;
    int numOfFormalRet;
 
    int numOfActualIn;  
    int numOfActualOut; 
    int numOfActualParam;
    int numOfActualRet;
 
    int numOfLoad;  
    int numOfStore; 
    int numOfCopy;
    int numOfGep;
    int numOfAddr;
 
    int numOfMSSAPhi;   
    int numOfPhi;
 
    int totalInEdge;    
    int totalOutEdge;   
    int totalIndInEdge; 
    int totalIndOutEdge;
    int totalIndEdgeLabels; 
 
    int totalIndCallEdge;
    int totalIndRetEdge;
    int totalDirCallEdge;
    int totalDirRetEdge;
 
    int avgWeight;  
 
    int avgInDegree;    
    int avgOutDegree;   
    u32_t maxInDegree;  
    u32_t maxOutDegree; 
 
    int avgIndInDegree; 
    int avgIndOutDegree;    
    u32_t maxIndInDegree;   
    u32_t maxIndOutDegree;  
 
    double addTopLevelNodeTimeStart;
    double addTopLevelNodeTimeEnd;
 
    double addAddrTakenNodeTimeStart;
    double addAddrTakenNodeTimeEnd;
 
    double connectDirSVFGEdgeTimeStart;
    double connectDirSVFGEdgeTimeEnd;
 
    double connectIndSVFGEdgeTimeStart;
    double connectIndSVFGEdgeTimeEnd;
 
    double svfgOptTimeStart;
    double svfgOptTimeEnd;
 
    SVFGNodeSet forwardSlice;
    SVFGNodeSet backwardSlice;
    SVFGNodeSet sources;
    SVFGNodeSet sinks;
 
public:
    inline void addToSources(const SVFGNode* node)
    {
        sources.insert(node);
    }
    inline void addToSinks(const SVFGNode* node)
    {
        sinks.insert(node);
    }
    inline void addToForwardSlice(const SVFGNode* node)
    {
        forwardSlice.insert(node);
    }
    inline void addToBackwardSlice(const SVFGNode* node)
    {
        backwardSlice.insert(node);
    }
    inline bool inForwardSlice(const SVFGNode* node) const
    {
        return forwardSlice.find(node)!=forwardSlice.end();
    }
    inline bool inBackwardSlice(const SVFGNode* node) const
    {
        return backwardSlice.find(node)!=backwardSlice.end();
    }
    inline bool isSource(const SVFGNode* node) const
    {
        return sources.find(node)!=sources.end();
    }
    inline bool isSink(const SVFGNode* node) const
    {
        return sinks.find(node)!=sinks.end();
    }
};
 
} // End namespace SVF
 
#endif /* SVFGSTAT_H_ */