CFLGraphBuilder.h

Go to the documentation of this file.

//===----- CFLGraphBuilder.h -- CFL Graph Builder --------------//
//
//                     SVF: Static Value-Flow Analysis
//
// Copyright (C) <2013->  <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/>.
//
//===----------------------------------------------------------------------===//
 
/*
 * CFLGraphBuilder.h
 *
 *  Created on: May 22, 2022
 *      Author: Pei Xu
 */
 
#ifndef INCLUDE_CFL_CFLGRAPHBUILDER_H_
#define INCLUDE_CFL_CFLGRAPHBUILDER_H_
 
#include "CFL/CFGrammar.h"
#include "Graphs/CFLGraph.h"
#include "Graphs/SVFG.h"
#include "Util/GeneralType.h"
 
namespace SVF
{
 
enum class BuildDirection
{
    plain,
    bidirection,
};

class CFLGraphBuilder
{
protected:
    typedef CFGrammar::Kind Kind;
    typedef CFGrammar::Symbol Symbol;

    Map<std::string, Kind> labelToKindMap;
    Map<Kind, std::string> kindToLabelMap;

    Map<CFGrammar::Kind,  Set<CFGrammar::Attribute>> kindToAttrsMap;
 
    Kind current;
    CFLGraph *cflGraph;

    void addAttribute(CFGrammar::Kind kind, CFGrammar::Attribute attribute);

    void buildlabelToKindMap(GrammarBase *grammar);

    CFLNode* addGNode(u32_t NodeID);

    CFLGraph* buildFromText(std::string fileName, GrammarBase *grammar, BuildDirection direction = BuildDirection::plain);

    CFLGraph *buildFromDot(std::string filename, GrammarBase *grammar, BuildDirection direction = BuildDirection::plain);

    CFLGraph *buildFromJson(std::string filename, GrammarBase *grammar, BuildDirection direction = BuildDirection::plain);
 
public:
    template<class N, class E>
    CFLGraph* build(GenericGraph<N,E>* graph, GrammarBase *grammar, BuildDirection direction = BuildDirection::plain);

    CFLGraph* build(std::string fileName, GrammarBase *grammar, BuildDirection direction = BuildDirection::plain);


    Map<std::string, Kind>& getLabelToKindMap()
    {
        return this->labelToKindMap;
    }

    Map<Kind, std::string>& getKindToLabelMap()
    {
        return this->kindToLabelMap;
    }

    Map<CFGrammar::Kind,  Set<CFGrammar::Attribute>>& getKindToAttrsMap()
    {
        return this->kindToAttrsMap;
    }

};

class AliasCFLGraphBuilder :
    public CFLGraphBuilder
{
public:
    CFLGraph* buildBigraph(ConstraintGraph *graph, Kind startKind, GrammarBase *grammar);

    CFLGraph* buildBiPEGgraph(ConstraintGraph *graph, Kind startKind, GrammarBase *grammar, SVFIR* pag);
 
private:
    void connectVGep(CFLGraph *cflGraph,  ConstraintGraph *graph, ConstraintNode *src, ConstraintNode *dst, u32_t level, SVFIR* pag);

    void addBiCFLEdge(CFLGraph *cflGraph,  ConstraintNode* src, ConstraintNode* dst, CFGrammar::Kind label);

    void addBiGepCFLEdge(CFLGraph *cflGraph,  ConstraintNode* src, ConstraintNode* dst, CFGrammar::Attribute attri);
};

class VFCFLGraphBuilder :
    public CFLGraphBuilder
{
public:
    CFLGraph* buildBigraph(SVFG *graph, Kind startKind, GrammarBase *grammar);

    CFLGraph* buildBiPEGgraph(ConstraintGraph *graph, Kind startKind, GrammarBase *grammar, SVFIR* pag);
 
private:
    void connectVGep(CFLGraph *cflGraph,  ConstraintGraph *graph, ConstraintNode *src, ConstraintNode *dst, u32_t level, SVFIR* pag);

    void addBiCFLEdge(CFLGraph *cflGraph,  ConstraintNode* src, ConstraintNode* dst, CFGrammar::Kind label);

    void addBiGepCFLEdge(CFLGraph *cflGraph,  ConstraintNode* src, ConstraintNode* dst, CFGrammar::Attribute attri);
};
 
 
}// SVF
 
#endif /* INCLUDE_CFL_CFLGRAPHBUILDER_H_*/