soot.jimple.toolkits.base.JimpleConstructorFolder Maven / Gradle / Ivy

package soot.jimple.toolkits.base;

/*-
 * #%L
 * Soot - a J*va Optimization Framework
 * %%
 * Copyright (C) 2006 Ondrej Lhotak
 * %%
 * 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 java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import soot.Body;
import soot.BodyTransformer;
import soot.Local;
import soot.SootMethod;
import soot.Unit;
import soot.Value;
import soot.ValueBox;
import soot.jimple.AssignStmt;
import soot.jimple.InstanceInvokeExpr;
import soot.jimple.InvokeExpr;
import soot.jimple.InvokeStmt;
import soot.jimple.Jimple;
import soot.jimple.JimpleBody;
import soot.jimple.NewExpr;
import soot.jimple.SpecialInvokeExpr;
import soot.jimple.Stmt;
import soot.options.Options;
import soot.toolkits.graph.BriefUnitGraph;
import soot.toolkits.graph.DirectedGraph;
import soot.toolkits.scalar.ForwardFlowAnalysis;
import soot.util.Chain;
import soot.util.HashMultiMap;
import soot.util.MultiMap;

public class JimpleConstructorFolder extends BodyTransformer {
  private static final Logger logger = LoggerFactory.getLogger(JimpleConstructorFolder.class);

  static boolean isNew(Stmt s) {
    if (!(s instanceof AssignStmt)) {
      return false;
    }
    if (!(rhs(s) instanceof NewExpr)) {
      return false;
    }
    return true;
  }

  static boolean isConstructor(Stmt s) {
    if (!(s instanceof InvokeStmt)) {
      return false;
    }
    InvokeStmt is = (InvokeStmt) s;
    InvokeExpr expr = is.getInvokeExpr();
    if (!(expr instanceof SpecialInvokeExpr)) {
      return false;
    }
    SpecialInvokeExpr sie = (SpecialInvokeExpr) expr;
    if (!sie.getMethodRef().name().equals(SootMethod.constructorName)) {
      return false;
    }
    return true;
  }

  static Local base(Stmt s) {
    InvokeStmt is = (InvokeStmt) s;
    InstanceInvokeExpr expr = (InstanceInvokeExpr) is.getInvokeExpr();
    return (Local) expr.getBase();
  }

  static void setBase(Stmt s, Local l) {
    InvokeStmt is = (InvokeStmt) s;
    InstanceInvokeExpr expr = (InstanceInvokeExpr) is.getInvokeExpr();
    expr.getBaseBox().setValue(l);
  }

  static boolean isCopy(Stmt s) {
    if (!(s instanceof AssignStmt)) {
      return false;
    }
    if (!(rhs(s) instanceof Local)) {
      return false;
    }
    if (!(lhs(s) instanceof Local)) {
      return false;
    }
    return true;
  }

  static Value rhs(Stmt s) {
    AssignStmt as = (AssignStmt) s;
    return as.getRightOp();
  }

  static Value lhs(Stmt s) {
    AssignStmt as = (AssignStmt) s;
    return as.getLeftOp();
  }

  static Local rhsLocal(Stmt s) {
    return (Local) rhs(s);
  }

  static Local lhsLocal(Stmt s) {
    return (Local) lhs(s);
  }

  private class Fact {
    private Map varToStmt = new HashMap();
    private MultiMap stmtToVar = new HashMultiMap();
    private Stmt alloc = null;

    public void add(Local l, Stmt s) {
      varToStmt.put(l, s);
      stmtToVar.put(s, l);
    }

    public Stmt get(Local l) {
      return varToStmt.get(l);
    }

    public Set get(Stmt s) {
      return stmtToVar.get(s);
    }

    public void removeAll(Stmt s) {
      for (Local var : stmtToVar.get(s)) {
        varToStmt.remove(var);
      }

      stmtToVar.remove(s);
    }

    public void copyFrom(Fact in) {
      varToStmt = new HashMap(in.varToStmt);
      stmtToVar = new HashMultiMap(in.stmtToVar);
      alloc = in.alloc;
    }

    public void mergeFrom(Fact in1, Fact in2) {
      varToStmt = new HashMap();

      for (Map.Entry e : in1.varToStmt.entrySet()) {
        Local l = e.getKey();
        Stmt newStmt = e.getValue();
        if (in2.varToStmt.containsKey(l)) {
          Stmt newStmt2 = in2.varToStmt.get(l);
          if (!newStmt.equals(newStmt2)) {
            throw new RuntimeException("Merge of different uninitialized values; are you sure this bytecode is verifiable?");
          }
        }
        add(l, newStmt);
      }
      for (Map.Entry e : in2.varToStmt.entrySet()) {
        Local l = e.getKey();
        Stmt newStmt = e.getValue();
        add(l, newStmt);
      }
      if (in1.alloc != null && in1.alloc.equals(in2.alloc)) {
        alloc = in1.alloc;
      } else {
        alloc = null;
      }
    }

    public boolean equals(Object other) {
      if (!(other instanceof Fact)) {
        return false;
      }
      Fact o = (Fact) other;
      if (!stmtToVar.equals(o.stmtToVar)) {
        return false;
      }
      if (alloc == null && o.alloc != null) {
        return false;
      }
      if (alloc != null && o.alloc == null) {
        return false;
      }
      if (alloc != null && !alloc.equals(o.alloc)) {
        return false;
      }
      return true;
    }

    public Stmt alloc() {
      return alloc;
    }

    public void setAlloc(Stmt newAlloc) {
      alloc = newAlloc;
    }
  }

  private class Analysis extends ForwardFlowAnalysis {
    public Analysis(DirectedGraph graph) {
      super(graph);
      doAnalysis();
    }

    protected Fact newInitialFlow() {
      return new Fact();
    }

    public void flowThrough(Fact in, Unit u, Fact out) {
      Stmt s = (Stmt) u;
      copy(in, out);
      out.setAlloc(null);

      if (isNew(s)) {
        out.add(lhsLocal(s), s);
      } else if (isCopy(s)) {
        Stmt newStmt = out.get(rhsLocal(s));
        if (newStmt != null) {
          out.add(lhsLocal(s), newStmt);
        }
      } else if (isConstructor(s)) {
        Stmt newStmt = out.get(base(s));
        if (newStmt != null) {
          out.removeAll(newStmt);
          out.setAlloc(newStmt);
        }
      }
    }

    public void copy(Fact source, Fact dest) {
      dest.copyFrom(source);
    }

    public void merge(Fact in1, Fact in2, Fact out) {
      out.mergeFrom(in1, in2);
    }
  }

  /**
   * This method pushes all newExpr down to be the stmt directly before every invoke of the init
   */
  public void internalTransform(Body b, String phaseName, Map options) {
    JimpleBody body = (JimpleBody) b;

    // PhaseDumper.v().dumpBody(body, "constructorfolder.in");

    if (Options.v().verbose()) {
      logger.debug("[" + body.getMethod().getName() + "] Folding Jimple constructors...");
    }

    Analysis analysis = new Analysis(new BriefUnitGraph(body));

    Chain units = body.getUnits();
    List stmtList = new ArrayList();
    stmtList.addAll(units);

    for (Unit u : stmtList) {
      Stmt s = (Stmt) u;
      if (isCopy(s)) {
        continue;
      }
      if (isConstructor(s)) {
        continue;
      }
      Fact before = analysis.getFlowBefore(s);
      for (ValueBox usebox : s.getUseBoxes()) {
        Value value = usebox.getValue();
        if (!(value instanceof Local)) {
          continue;
        }
        Local local = (Local) value;
        if (before.get(local) != null) {
          throw new RuntimeException("Use of an unitialized value " + "before constructor call; are you sure this "
              + "bytecode is verifiable?\n" + s);
        }
      }
    }

    // throw out all new statements
    for (Unit u : stmtList) {
      Stmt s = (Stmt) u;
      if (isNew(s)) {
        units.remove(s);
      }
    }

    for (Unit u : stmtList) {
      Stmt s = (Stmt) u;
      Fact before = analysis.getFlowBefore(s);
      Fact after = analysis.getFlowAfter(s);

      // throw out copies of uninitialized variables
      if (isCopy(s)) {
        Stmt newStmt = before.get(rhsLocal(s));
        if (newStmt != null) {
          units.remove(s);
        }
      } else if (after.alloc() != null) {
        // insert the new just before the constructor
        Stmt newStmt = before.get(base(s));
        setBase(s, lhsLocal(newStmt));
        units.insertBefore(newStmt, s);

        // add necessary copies
        for (Local l : before.get(newStmt)) {
          if (l.equals(base(s))) {
            continue;
          }
          units.insertAfter(Jimple.v().newAssignStmt(l, base(s)), s);
        }
      }
    }
    // PhaseDumper.v().dumpBody(body, "constructorfolder.out");
  }
}