pascal.taie.analysis.bugfinder.CloneIdiom 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.bugfinder;

import pascal.taie.World;
import pascal.taie.analysis.ClassAnalysis;
import pascal.taie.config.AnalysisConfig;
import pascal.taie.ir.exp.InvokeExp;
import pascal.taie.ir.exp.InvokeSpecial;
import pascal.taie.ir.stmt.Invoke;
import pascal.taie.ir.stmt.Stmt;
import pascal.taie.language.classes.ClassHierarchy;
import pascal.taie.language.classes.ClassNames;
import pascal.taie.language.classes.JClass;
import pascal.taie.language.classes.JMethod;
import pascal.taie.util.collection.Sets;

import java.util.Set;

public class CloneIdiom extends ClassAnalysis> {

    public static final String ID = "clone-idiom";

    public CloneIdiom(AnalysisConfig config) {
        super(config);
    }

    /*
        1.analyze class
        2.analyze clone method
        3.analyze the ir of clone method
        4.produce result
     */
    @Override
    public Set analyze(JClass jclass) {
        boolean implementsCloneableDirectly = false;
        boolean invokesSuperClone = false;
        boolean isCloneable = false;
        boolean isFinal = jclass.isFinal();
        Set bugInstances = Sets.newSet();

        if (jclass.isInterface() || jclass.isAbstract()) {
            return Set.of();
        }

        for (JClass iface : jclass.getInterfaces()) {
            if (ClassNames.CLONEABLE.equals(iface.getName())) {
                implementsCloneableDirectly = true;
                isCloneable = true;
                break;
            }
        }

        ClassHierarchy hierarchy = World.get().getClassHierarchy();
        JClass classCloneable = hierarchy.getClass(ClassNames.CLONEABLE);
        if (hierarchy.isSubclass(classCloneable, jclass)) {
            isCloneable = true;
        }

        boolean cloneIsDeprecated = false;
        boolean hasCloneMethod = false;
        for (JMethod jmethod : jclass.getDeclaredMethods()) {
            if (!jmethod.isAbstract() && jmethod.isPublic() && jmethod.getSubsignature().toString().equals("java.lang.Object clone()")) {
                hasCloneMethod = true;
                cloneIsDeprecated = jmethod.getAnnotation("java.lang.Deprecated") != null;
                // ir
                for (Stmt stmt : jmethod.getIR()) {
                    if (stmt instanceof Invoke invoke) {
                        InvokeExp invokeExp = invoke.getInvokeExp();
                        if (invokeExp instanceof InvokeSpecial && ((InvokeSpecial) invokeExp).getBase().getName().equals("%this")) {
                            invokesSuperClone = true;
                        }
                    }
                }
            }
        }

        //generate analysis result
        if (implementsCloneableDirectly && !hasCloneMethod) {
            bugInstances.add(new BugInstance(BugType.CN_IDIOM, Severity.MINOR, jclass));
        }

        if (hasCloneMethod && isCloneable && !invokesSuperClone && !isFinal && jclass.isPublic()) {
            bugInstances.add(new BugInstance(
                    BugType.CN_IDIOM_NO_SUPER_CALL, Severity.MINOR, jclass));
        } else if (hasCloneMethod && !isCloneable && !cloneIsDeprecated && !jclass.isAbstract()) {
            bugInstances.add(new BugInstance(
                    BugType.CN_IMPLEMENTS_CLONE_BUT_NOT_CLONEABLE, Severity.MINOR, jclass));
        }
        return bugInstances;
    }

    private enum BugType implements pascal.taie.analysis.bugfinder.BugType {
        CN_IDIOM,
        CN_IDIOM_NO_SUPER_CALL,
        CN_IMPLEMENTS_CLONE_BUT_NOT_CLONEABLE
    }
}