proguard.analysis.cpa.defaults.BamCpaRun Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proguard-core Show documentation
ProGuardCORE is a free library to read, analyze, modify, and write Java class files.
There is a newer version: 9.1.7
/*
 * ProGuardCORE -- library to process Java bytecode.
 *
 * Copyright (c) 2002-2022 Guardsquare NV
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package proguard.analysis.cpa.defaults;

import proguard.analysis.cpa.interfaces.AbortOperator;
import proguard.classfile.Signature;
import proguard.analysis.cpa.bam.BamCache;
import proguard.analysis.cpa.bam.BamCacheImpl;
import proguard.analysis.cpa.bam.BamCpa;
import proguard.analysis.cpa.bam.CpaWithBamOperators;
import proguard.analysis.cpa.bam.ExpandOperator;
import proguard.analysis.cpa.bam.NoOpRebuildOperator;
import proguard.analysis.cpa.bam.RebuildOperator;
import proguard.analysis.cpa.bam.ReduceOperator;
import proguard.analysis.cpa.interfaces.AbstractState;
import proguard.analysis.cpa.interfaces.CfaEdge;
import proguard.analysis.cpa.interfaces.CfaNode;
import proguard.analysis.cpa.interfaces.ConfigurableProgramAnalysis;

/**
 * This abstract wrapper class constructs a {@link CpaWithBamOperators} based on the intraprocedural {@link ConfigurableProgramAnalysis}, runs it, and returns
 * the {@link proguard.analysis.cpa.interfaces.ReachedSet}.
 *
 * @author Dmitry Ivanov
 */
public abstract class BamCpaRun,
                                CfaEdgeT extends CfaEdge,
                                SignatureT extends Signature>
    extends CpaRun, AbstractStateT>
{

    private final int maxCallStackDepth;

    /**
     * Create a BAM CPA run.
     *
     * @param abortOperator     an abort operator
     * @param maxCallStackDepth the maximum depth of the call stack analyzed interprocedurally
     *                          0 means intraprocedural analysis
     *                          < 0 means no maximum depth
     */
    protected BamCpaRun(AbortOperator abortOperator, int maxCallStackDepth)
    {
        this.abortOperator = abortOperator;
        this.maxCallStackDepth = maxCallStackDepth;
    }

    // implementations for CpaRun


    @Override
    public BamCpa getCpa()
    {
        return cpa == null
               ? cpa = new BamCpa<>(new CpaWithBamOperators<>(createIntraproceduralCPA(),
                                                              createReduceOperator(),
                                                              createExpandOperator(),
                                                              createRebuildOperator()),
                                    getCfa(),
                                    getMainSignature(),
                                    createCache(),
                                    getMaxCallStackDepth(),
                                    abortOperator)
               : super.getCpa();
    }

    /**
     * Returns the intraprocedural CPA.
     */
    public abstract CpaT createIntraproceduralCPA();

    /**
     * Returns the reduce operator.
     */
    public abstract ReduceOperator createReduceOperator();

    /**
     * Returns the expand operator.
     */
    public abstract ExpandOperator createExpandOperator();

    /**
     * Returns the rebuild operator.
     */
    public RebuildOperator createRebuildOperator()
    {
        return new NoOpRebuildOperator();
    }

    /**
     * Returns a fresh BAM cache.
     */
    public BamCache createCache()
    {
        return new BamCacheImpl<>();
    }

    /**
     * Returns the CFA.
     */
    public abstract Cfa getCfa();

    /**
     * Returns the signature of the main procedure.
     */
    public abstract SignatureT getMainSignature();

    /**
     * Returns the maximal call stack depth. If negative the maximum call stack depth is unlimited.
     */
    public int getMaxCallStackDepth()
    {
        return maxCallStackDepth;
    }
}