pascal.taie.frontend.soot.VarManager 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.frontend.soot;

import pascal.taie.ir.exp.ClassLiteral;
import pascal.taie.ir.exp.Literal;
import pascal.taie.ir.exp.NullLiteral;
import pascal.taie.ir.exp.StringLiteral;
import pascal.taie.ir.exp.Var;
import pascal.taie.language.classes.JMethod;
import pascal.taie.language.type.Type;
import pascal.taie.util.collection.Maps;
import soot.Local;
import soot.Value;

import javax.annotation.Nullable;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Objects;

class VarManager {

    private static final String THIS = "%this";

    private static final String STRING_CONSTANT = "%stringconst";

    private static final String CLASS_CONSTANT = "%classconst";

    private static final String NULL_CONSTANT = "%nullconst";

    /**
     * The method which contains the variable managed by this VarManager.
     */
    private final JMethod method;

    private final Converter converter;

    private final Map varMap = Maps.newLinkedHashMap();

    private final List vars = new ArrayList<>();

    private Var thisVar;

    private final List params = new ArrayList<>();

    private Var nullConst;

    /**
     * Counter for indexing all variables.
     */
    private int varCounter = 0;

    /**
     * Counter for naming temporary constant variables.
     */
    private int tempConstCounter = 0;

    public VarManager(JMethod method, Converter converter) {
        this.method = method;
        this.converter = converter;
    }

    void addThis(Local thisLocal) {
        thisVar = newVar(THIS, getTypeOf(thisLocal));
        varMap.put(thisLocal, thisVar);
    }

    void addParams(List paramLocals) {
        for (int i = 0; i < paramLocals.size(); i++) {
            Local paramLocal = paramLocals.get(i);
            // soot frontend cannot ensure availability of all parameter names
            String paramName = Objects.requireNonNullElse(
                    method.getParamName(i), paramLocal.getName());
            Var param = varMap.computeIfAbsent(paramLocal, l ->
                    newVar(paramName, getTypeOf(l)));
            params.add(param);
        }
    }

    Var getVar(Local local) {
        return varMap.computeIfAbsent(local, l ->
                newVar(l.getName(), getTypeOf(l)));
    }

    /**
     * @return a new temporary variable that holds given literal value.
     */
    Var newConstantVar(Literal literal) {
        String varName;
        if (literal instanceof StringLiteral) {
            varName = STRING_CONSTANT + tempConstCounter++;
        } else if (literal instanceof ClassLiteral) {
            varName = CLASS_CONSTANT + tempConstCounter++;
        } else if (literal instanceof NullLiteral) {
            // each method has at most one variable for null constant
            Var v = nullConst;
            if (v == null) {
                v = newVar(NULL_CONSTANT, literal.getType(), literal);
                nullConst = v;
            }
            return v;
        } else {
            varName = "%" + literal.getType().getName() +
                    "const" + tempConstCounter++;
        }
        return newVar(varName, literal.getType(), literal);
    }

    Var getThis() {
        return thisVar;
    }

    List getParams() {
        return params;
    }

    List getVars() {
        return vars;
    }

    private Var newVar(String name, Type type) {
        return newVar(name, type, null);
    }

    private Var newVar(String name, Type type, @Nullable Literal literal) {
        Var var = new Var(method, name, type, varCounter++, literal);
        vars.add(var);
        return var;
    }

    /**
     * Shortcut: obtains Jimple Value's Type and convert to Tai-e Type.
     */
    private Type getTypeOf(Value value) {
        return converter.convertType(value.getType());
    }
}