pascal.taie.analysis.graph.callgraph.AbstractCallGraph 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.callgraph;

import pascal.taie.util.collection.Maps;
import pascal.taie.util.collection.MultiMap;
import pascal.taie.util.collection.Sets;
import pascal.taie.util.collection.Views;

import java.util.Collections;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
 * Common functionality for {@link CallGraph} implementations.
 * This class contains the data structures and methods for storing and
 * accessing information of a call graph. The logic of modifying
 * (adding new call edges and methods) is left to its subclasses.
 *
 * @param  type of call sites
 * @param    type of methods
 */
public abstract class AbstractCallGraph
        implements CallGraph {

    protected final MultiMap> callSiteToEdges = Maps.newMultiMap();
    protected final MultiMap> calleeToEdges = Maps.newMultiMap();
    protected final Map callSiteToContainer = Maps.newMap();
    protected final MultiMap callSitesIn = Maps.newMultiMap(Sets::newHybridOrderedSet);
    protected final Set entryMethods = Sets.newSet();

    /**
     * Set of reachable methods. This field is not final so that
     * it allows subclasses choose more efficient data structure.
     */
    protected Set reachableMethods = Sets.newSet();

    @Override
    public Set getCallersOf(Method callee) {
        return Views.toMappedSet(calleeToEdges.get(callee), Edge::getCallSite);
    }

    @Override
    public Set getCalleesOf(CallSite callSite) {
        return Views.toMappedSet(callSiteToEdges.get(callSite), Edge::getCallee);
    }

    @Override
    public Set getCalleesOfM(Method caller) {
        return callSitesIn(caller)
                .flatMap(cs -> getCalleesOf(cs).stream())
                .collect(Collectors.toUnmodifiableSet());
    }

    @Override
    public Method getContainerOf(CallSite callSite) {
        return callSiteToContainer.get(callSite);
    }

    @Override
    public Set getCallSitesIn(Method method) {
        return callSitesIn.get(method);
    }

    @Override
    public Stream> edgesOutOf(CallSite callSite) {
        return callSiteToEdges.get(callSite).stream();
    }

    @Override
    public Stream> edgesInTo(Method method) {
        return calleeToEdges.get(method).stream();
    }

    @Override
    public Stream> edges() {
        return callSiteToEdges.values().stream();
    }

    @Override
    public int getNumberOfEdges() {
        return callSiteToEdges.size();
    }

    @Override
    public Stream entryMethods() {
        return entryMethods.stream();
    }

    @Override
    public Stream reachableMethods() {
        return reachableMethods.stream();
    }

    @Override
    public int getNumberOfMethods() {
        return reachableMethods.size();
    }

    @Override
    public boolean contains(Method method) {
        return hasNode(method);
    }

    // Implementation for Graph interface.

    @Override
    public Set> getInEdgesOf(Method method) {
        return getCallersOf(method)
                .stream()
                .map(cs -> new MethodEdge<>(getContainerOf(cs), method, cs))
                .collect(Collectors.toUnmodifiableSet());
    }

    @Override
    public Set> getOutEdgesOf(Method method) {
        return callSitesIn(method)
                .flatMap(cs -> getCalleesOf(cs)
                        .stream()
                        .map(callee -> new MethodEdge<>(method, callee, cs)))
                .collect(Collectors.toUnmodifiableSet());
    }

    @Override
    public Set getPredsOf(Method node) {
        return getCallersOf(node)
                .stream()
                .map(this::getContainerOf)
                .collect(Collectors.toUnmodifiableSet());
    }

    @Override
    public Set getSuccsOf(Method node) {
        return callSitesIn(node)
                .flatMap(cs -> getCalleesOf(cs).stream())
                .collect(Collectors.toUnmodifiableSet());
    }

    @Override
    public Set getNodes() {
        return Collections.unmodifiableSet(reachableMethods);
    }
}