soot.grimp.toolkits.base.ConstructorFolder Maven / Gradle / Ivy

package soot.grimp.toolkits.base;

/*-
 * #%L
 * Soot - a J*va Optimization Framework
 * %%
 * Copyright (C) 1999 Patrick Lam
 * %%
 * 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.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

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

import soot.Body;
import soot.BodyTransformer;
import soot.G;
import soot.Local;
import soot.Singletons;
import soot.Unit;
import soot.Value;
import soot.grimp.Grimp;
import soot.grimp.GrimpBody;
import soot.jimple.AssignStmt;
import soot.jimple.InvokeStmt;
import soot.jimple.NewExpr;
import soot.jimple.SpecialInvokeExpr;
import soot.jimple.Stmt;
import soot.options.Options;
import soot.toolkits.scalar.LocalUses;
import soot.toolkits.scalar.UnitValueBoxPair;
import soot.util.Chain;

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

  public ConstructorFolder(Singletons.Global g) {
  }

  public static ConstructorFolder v() {
    return G.v().soot_grimp_toolkits_base_ConstructorFolder();
  }

  /** This method change all new Obj/(args) pairs to new Obj(args) idioms. */
  protected void internalTransform(Body b, String phaseName, Map options) {
    GrimpBody body = (GrimpBody) b;

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

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

    Iterator it = stmtList.iterator();

    LocalUses localUses = LocalUses.Factory.newLocalUses(b);

    /* fold in NewExpr's with specialinvoke's */
    while (it.hasNext()) {
      Stmt s = (Stmt) it.next();

      if (!(s instanceof AssignStmt)) {
        continue;
      }

      /* this should be generalized to ArrayRefs */
      Value lhs = ((AssignStmt) s).getLeftOp();
      if (!(lhs instanceof Local)) {
        continue;
      }

      Value rhs = ((AssignStmt) s).getRightOp();
      if (!(rhs instanceof NewExpr)) {
        continue;
      }

      /*
       * TO BE IMPLEMENTED LATER: move any copy of the object reference for lhs down beyond the NewInvokeExpr, with the
       * rationale being that you can't modify the object before the constructor call in any case.
       *
       * Also, do note that any new's (object creation) without corresponding constructors must be dead.
       */

      List lu = localUses.getUsesOf(s);
      Iterator luIter = lu.iterator();
      boolean MadeNewInvokeExpr = false;

      while (luIter.hasNext()) {
        Unit use = ((UnitValueBoxPair) (luIter.next())).unit;
        if (!(use instanceof InvokeStmt)) {
          continue;
        }
        InvokeStmt is = (InvokeStmt) use;
        if (!(is.getInvokeExpr() instanceof SpecialInvokeExpr)
            || lhs != ((SpecialInvokeExpr) is.getInvokeExpr()).getBase()) {
          continue;
        }

        SpecialInvokeExpr oldInvoke = ((SpecialInvokeExpr) is.getInvokeExpr());
        LinkedList invokeArgs = new LinkedList();
        for (int i = 0; i < oldInvoke.getArgCount(); i++) {
          invokeArgs.add(oldInvoke.getArg(i));
        }

        AssignStmt constructStmt = Grimp.v().newAssignStmt((AssignStmt) s);
        constructStmt
            .setRightOp(Grimp.v().newNewInvokeExpr(((NewExpr) rhs).getBaseType(), oldInvoke.getMethodRef(), invokeArgs));
        MadeNewInvokeExpr = true;

        use.redirectJumpsToThisTo(constructStmt);
        units.insertBefore(constructStmt, use);
        units.remove(use);
      }
      if (MadeNewInvokeExpr) {
        units.remove(s);
      }
    }
  }
}