pascal.taie.analysis.graph.icfg.ICFGBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tai-e Show documentation
An easy-to-learn/use static analysis framework for Java
The newest version!
/*
 * Tai-e: A Static Analysis Framework for Java
 *
 * Copyright (C) 2022 Tian Tan 
 * Copyright (C) 2022 Yue Li 
 *
 * This file is part of Tai-e.
 *
 * Tai-e is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * Tai-e 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 Lesser General
 * Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Tai-e. If not, see .
 */

package pascal.taie.analysis.graph.icfg;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import pascal.taie.World;
import pascal.taie.analysis.ProgramAnalysis;
import pascal.taie.analysis.graph.callgraph.CallGraph;
import pascal.taie.analysis.graph.callgraph.CallGraphBuilder;
import pascal.taie.analysis.graph.cfg.CFG;
import pascal.taie.analysis.graph.cfg.CFGBuilder;
import pascal.taie.analysis.graph.cfg.CFGDumper;
import pascal.taie.config.AnalysisConfig;
import pascal.taie.ir.stmt.Stmt;
import pascal.taie.language.classes.JMethod;
import pascal.taie.util.Indexer;
import pascal.taie.util.SimpleIndexer;
import pascal.taie.util.graph.DotAttributes;
import pascal.taie.util.graph.DotDumper;

import java.io.File;

public class ICFGBuilder extends ProgramAnalysis> {

    public static final String ID = "icfg";

    private static final Logger logger = LogManager.getLogger(ICFGBuilder.class);

    private final boolean isDump;

    public ICFGBuilder(AnalysisConfig config) {
        super(config);
        isDump = getOptions().getBoolean("dump");
    }

    @Override
    public ICFG analyze() {
        CallGraph callGraph = World.get().getResult(CallGraphBuilder.ID);
        ICFG icfg = new DefaultICFG(callGraph);
        if (isDump) {
            dumpICFG(icfg);
        }
        return icfg;
    }

    private static void dumpICFG(ICFG icfg) {
        JMethod mainMethod;
        String fileName;
        if ((mainMethod = World.get().getMainMethod()) != null) {
            fileName = mainMethod.getDeclaringClass() + "-icfg.dot";
        } else {
            fileName = "icfg.dot";
        }
        File dotFile = new File(World.get().getOptions().getOutputDir(), fileName);
        logger.info("Dumping ICFG to {}", dotFile.getAbsolutePath());
        Indexer indexer = new SimpleIndexer<>();
        new DotDumper()
                .setNodeToString(n -> Integer.toString(indexer.getIndex(n)))
                .setNodeLabeler(n -> toLabel(n, icfg))
                .setGlobalNodeAttributes(DotAttributes.of("shape", "box",
                        "style", "filled", "color", "\".3 .2 1.0\""))
                .setEdgeAttributer(e -> {
                    if (e instanceof CallEdge) {
                        return DotAttributes.of("style", "dashed", "color", "blue");
                    } else if (e instanceof ReturnEdge) {
                        return DotAttributes.of("style", "dashed", "color", "red");
                    } else if (e instanceof CallToReturnEdge) {
                        return DotAttributes.of("style", "dashed");
                    } else {
                        return DotAttributes.of();
                    }
                })
                .dump(icfg, dotFile);
    }

    private static String toLabel(Stmt stmt, ICFG icfg) {
        JMethod method = icfg.getContainingMethodOf(stmt);
        CFG cfg = getCFGOf(method);
        return CFGDumper.toLabel(stmt, cfg);
    }

    static CFG getCFGOf(JMethod method) {
        return method.getIR().getResult(CFGBuilder.ID);
    }
}