soot.jimple.toolkits.invoke.StaticInliner Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of soot Show documentation
A Java Optimization Framework
The newest version!
package soot.jimple.toolkits.invoke;

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

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

import soot.G;
import soot.Pack;
import soot.PackManager;
import soot.PhaseOptions;
import soot.Scene;
import soot.SceneTransformer;
import soot.Singletons;
import soot.SootClass;
import soot.SootMethod;
import soot.Unit;
import soot.jimple.Stmt;
import soot.jimple.toolkits.callgraph.CallGraph;
import soot.jimple.toolkits.callgraph.ExplicitEdgesPred;
import soot.jimple.toolkits.callgraph.Filter;
import soot.jimple.toolkits.callgraph.Targets;
import soot.jimple.toolkits.callgraph.TopologicalOrderer;
import soot.options.Options;
import soot.tagkit.Host;

/** Uses the Scene's currently-active InvokeGraph to inline monomorphic call sites. */
public class StaticInliner extends SceneTransformer {
  private static final Logger logger = LoggerFactory.getLogger(StaticInliner.class);

  private final HashMap methodToOriginalSize = new HashMap();

  public StaticInliner(Singletons.Global g) {
  }

  public static StaticInliner v() {
    return G.v().soot_jimple_toolkits_invoke_StaticInliner();
  }

  @Override
  protected void internalTransform(String phaseName, Map options) {
    final Filter explicitInvokesFilter = new Filter(new ExplicitEdgesPred());
    if (Options.v().verbose()) {
      logger.debug("[" + phaseName + "] Inlining methods...");
    }

    computeAverageMethodSizeAndSaveOriginalSizes();

    final String modifierOptions = PhaseOptions.getString(options, "allowed-modifier-changes");
    final ArrayList sitesToInline = new ArrayList();

    // Visit each potential site in reverse pseudo topological order.
    {
      final CallGraph cg = Scene.v().getCallGraph();
      final TopologicalOrderer orderer = new TopologicalOrderer(cg);
      orderer.go();
      List order = orderer.order();
      for (ListIterator it = order.listIterator(order.size()); it.hasPrevious();) {
        SootMethod container = it.previous();
        if (!container.isConcrete() || !methodToOriginalSize.containsKey(container)
            || !explicitInvokesFilter.wrap(cg.edgesOutOf(container)).hasNext()) {
          continue;
        }

        for (Unit u : new ArrayList(container.retrieveActiveBody().getUnits())) {
          final Stmt s = (Stmt) u;
          if (!s.containsInvokeExpr()) {
            continue;
          }

          final Targets targets = new Targets(explicitInvokesFilter.wrap(cg.edgesOutOf(s)));
          if (!targets.hasNext()) {
            continue;
          }
          final SootMethod target = (SootMethod) targets.next();
          if (targets.hasNext() || !target.isConcrete() || !target.getDeclaringClass().isApplicationClass()
              || !InlinerSafetyManager.ensureInlinability(target, s, container, modifierOptions)) {
            continue;
          }

          sitesToInline.add(new Host[] { target, s, container });
        }
      }
    }

    // Proceed to inline the sites, one at a time, keeping track of expansion rates.
    {
      final float expansionFactor = PhaseOptions.getFloat(options, "expansion-factor");
      final int maxContainerSize = PhaseOptions.getInt(options, "max-container-size");
      final int maxInlineeSize = PhaseOptions.getInt(options, "max-inlinee-size");
      final Pack jbPack = PhaseOptions.getBoolean(options, "rerun-jb") ? PackManager.v().getPack("jb") : null;
      for (Host[] site : sitesToInline) {
        SootMethod inlinee = (SootMethod) site[0];
        int inlineeSize = inlinee.retrieveActiveBody().getUnits().size();

        SootMethod container = (SootMethod) site[2];
        int containerSize = container.retrieveActiveBody().getUnits().size();

        if (inlineeSize > maxInlineeSize) {
          continue;
        }

        int inlinedSize = inlineeSize + containerSize;
        if (inlinedSize > maxContainerSize || inlinedSize > expansionFactor * methodToOriginalSize.get(container)) {
          continue;
        }

        Stmt invokeStmt = (Stmt) site[1];
        // Not that it is important to check right before inlining if the site is still valid.
        if (InlinerSafetyManager.ensureInlinability(inlinee, invokeStmt, container, modifierOptions)) {
          SiteInliner.inlineSite(inlinee, invokeStmt, container, options);
          if (jbPack != null) {
            jbPack.apply(container.getActiveBody());
          }
        }
      }
    }
  }

  private void computeAverageMethodSizeAndSaveOriginalSizes() {
    // long sum = 0, count = 0;
    for (SootClass c : Scene.v().getApplicationClasses()) {
      for (Iterator methodsIt = c.methodIterator(); methodsIt.hasNext();) {
        SootMethod m = methodsIt.next();
        if (m.isConcrete()) {
          int size = m.retrieveActiveBody().getUnits().size();
          // sum += size;
          methodToOriginalSize.put(m, size);
          // count++;
        }
      }
    }
    // if (count == 0) {
    // return;
    // }
  }
}