soot.jimple.toolkits.ide.exampleproblems.IFDSUninitializedVariables Maven / Gradle / Ivy
package soot.jimple.toolkits.ide.exampleproblems;
/*-
* #%L
* Soot - a J*va Optimization Framework
* %%
* Copyright (C) 1997 - 2013 Eric Bodden and others
* %%
* This program 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 2.1 of the
* License, or (at your option) any later version.
*
* This program 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 General Lesser Public License for more details.
*
* You should have received a copy of the GNU General Lesser Public
* License along with this program. If not, see
* .
* #L%
*/
import heros.DefaultSeeds;
import heros.FlowFunction;
import heros.FlowFunctions;
import heros.InterproceduralCFG;
import heros.flowfunc.Identity;
import heros.flowfunc.Kill;
import heros.flowfunc.KillAll;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import soot.Local;
import soot.NullType;
import soot.Scene;
import soot.SootMethod;
import soot.Unit;
import soot.Value;
import soot.ValueBox;
import soot.jimple.DefinitionStmt;
import soot.jimple.InvokeExpr;
import soot.jimple.ReturnStmt;
import soot.jimple.Stmt;
import soot.jimple.ThrowStmt;
import soot.jimple.internal.JimpleLocal;
import soot.jimple.toolkits.ide.DefaultJimpleIFDSTabulationProblem;
public class IFDSUninitializedVariables
extends DefaultJimpleIFDSTabulationProblem> {
public IFDSUninitializedVariables(InterproceduralCFG icfg) {
super(icfg);
}
@Override
public FlowFunctions createFlowFunctionsFactory() {
return new FlowFunctions() {
@Override
public FlowFunction getNormalFlowFunction(Unit curr, Unit succ) {
final SootMethod m = interproceduralCFG().getMethodOf(curr);
if (Scene.v().getEntryPoints().contains(m) && interproceduralCFG().isStartPoint(curr)) {
return new FlowFunction() {
@Override
public Set computeTargets(Local source) {
if (source == zeroValue()) {
Set res = new LinkedHashSet();
res.addAll(m.getActiveBody().getLocals());
for (int i = 0; i < m.getParameterCount(); i++) {
res.remove(m.getActiveBody().getParameterLocal(i));
}
return res;
}
return Collections.emptySet();
}
};
}
if (curr instanceof DefinitionStmt) {
final DefinitionStmt definition = (DefinitionStmt) curr;
final Value leftOp = definition.getLeftOp();
if (leftOp instanceof Local) {
final Local leftOpLocal = (Local) leftOp;
return new FlowFunction() {
@Override
public Set computeTargets(final Local source) {
List useBoxes = definition.getUseBoxes();
for (ValueBox valueBox : useBoxes) {
if (valueBox.getValue().equivTo(source)) {
LinkedHashSet res = new LinkedHashSet();
res.add(source);
res.add(leftOpLocal);
return res;
}
}
if (leftOp.equivTo(source)) {
return Collections.emptySet();
}
return Collections.singleton(source);
}
};
}
}
return Identity.v();
}
@Override
public FlowFunction getCallFlowFunction(Unit callStmt, final SootMethod destinationMethod) {
Stmt stmt = (Stmt) callStmt;
InvokeExpr invokeExpr = stmt.getInvokeExpr();
final List args = invokeExpr.getArgs();
final List localArguments = new ArrayList();
for (Value value : args) {
if (value instanceof Local) {
localArguments.add((Local) value);
}
}
return new FlowFunction() {
@Override
public Set computeTargets(final Local source) {
// Do not map parameters for edges
if (destinationMethod.getName().equals("") || destinationMethod.getSubSignature().equals("void run()")) {
return Collections.emptySet();
}
for (Local localArgument : localArguments) {
if (source.equivTo(localArgument)) {
return Collections
.singleton(destinationMethod.getActiveBody().getParameterLocal(args.indexOf(localArgument)));
}
}
if (source == zeroValue()) {
// gen all locals that are not parameter locals
Collection locals = destinationMethod.getActiveBody().getLocals();
LinkedHashSet uninitializedLocals = new LinkedHashSet(locals);
for (int i = 0; i < destinationMethod.getParameterCount(); i++) {
uninitializedLocals.remove(destinationMethod.getActiveBody().getParameterLocal(i));
}
return uninitializedLocals;
}
return Collections.emptySet();
}
};
}
@Override
public FlowFunction getReturnFlowFunction(final Unit callSite, SootMethod calleeMethod, final Unit exitStmt,
Unit returnSite) {
if (callSite instanceof DefinitionStmt) {
final DefinitionStmt definition = (DefinitionStmt) callSite;
if (definition.getLeftOp() instanceof Local) {
final Local leftOpLocal = (Local) definition.getLeftOp();
if (exitStmt instanceof ReturnStmt) {
final ReturnStmt returnStmt = (ReturnStmt) exitStmt;
return new FlowFunction() {
@Override
public Set computeTargets(Local source) {
if (returnStmt.getOp().equivTo(source)) {
return Collections.singleton(leftOpLocal);
}
return Collections.emptySet();
}
};
} else if (exitStmt instanceof ThrowStmt) {
// if we throw an exception, LHS of call is undefined
return new FlowFunction() {
@Override
public Set computeTargets(final Local source) {
if (source == zeroValue()) {
return Collections.singleton(leftOpLocal);
} else {
return Collections.emptySet();
}
}
};
}
}
}
return KillAll.v();
}
@Override
public FlowFunction getCallToReturnFlowFunction(Unit callSite, Unit returnSite) {
if (callSite instanceof DefinitionStmt) {
DefinitionStmt definition = (DefinitionStmt) callSite;
if (definition.getLeftOp() instanceof Local) {
final Local leftOpLocal = (Local) definition.getLeftOp();
return new Kill(leftOpLocal);
}
}
return Identity.v();
}
};
}
public Map> initialSeeds() {
return DefaultSeeds.make(Collections.singleton(Scene.v().getMainMethod().getActiveBody().getUnits().getFirst()),
zeroValue());
}
@Override
public Local createZeroValue() {
return new JimpleLocal("<>", NullType.v());
}
}