soot.jimple.toolkits.annotation.purity.PurityInterproceduralAnalysis Maven / Gradle / Ivy

package soot.jimple.toolkits.annotation.purity;

/*-
 * #%L
 * Soot - a J*va Optimization Framework
 * %%
 * Copyright (C) 2005 Antoine Mine
 * %%
 * 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.Date;
import java.util.Iterator;
import java.util.List;

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

import soot.Body;
import soot.Local;
import soot.RefLikeType;
import soot.SootMethod;
import soot.Type;
import soot.Value;
import soot.jimple.AssignStmt;
import soot.jimple.InstanceInvokeExpr;
import soot.jimple.InvokeExpr;
import soot.jimple.StaticInvokeExpr;
import soot.jimple.Stmt;
import soot.jimple.toolkits.callgraph.CallGraph;
import soot.options.PurityOptions;
import soot.tagkit.GenericAttribute;
import soot.tagkit.StringTag;
import soot.toolkits.graph.ExceptionalUnitGraph;
import soot.util.dot.DotGraph;

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

  // Note: these method lists are adapted to JDK-1.4.2.06 and may
  // not work for other versions
  //
  // unanalysed methods assumed pure (& return a new obj)
  // class name prefix / method name
  static private final String[][] pureMethods = { { "java.lang.", "valueOf" }, { "java.", "equals" }, { "javax.", "equals" },
      { "sun.", "equals" }, { "java.", "compare" }, { "javax.", "compare" }, { "sun.", "compare" }, { "java.", "getClass" },
      { "javax.", "getClass" }, { "sun.", "getClass" }, { "java.", "hashCode" }, { "javax.", "hashCode" },
      { "sun.", "hashCode" }, { "java.", "toString" }, { "javax.", "toString" }, { "sun.", "toString" },
      { "java.", "valueOf" }, { "javax.", "valueOf" }, { "sun.", "valueOf" }, { "java.", "compareTo" },
      { "javax.", "compareTo" }, { "sun.", "compareTo" }, { "java.lang.System", "identityHashCode" },
      // we assume that all standard class initialisers are pure!!!
      { "java.", "" }, { "javax.", "" }, { "sun.", "" },
      // if we define these as pure, the analysis will find them impure as
      // they call static native functions that could, in theory,
      // change the whole program state under our feets
      { "java.lang.Math", "abs" }, { "java.lang.Math", "acos" }, { "java.lang.Math", "asin" }, { "java.lang.Math", "atan" },
      { "java.lang.Math", "atan2" }, { "java.lang.Math", "ceil" }, { "java.lang.Math", "cos" }, { "java.lang.Math", "exp" },
      { "java.lang.Math", "floor" }, { "java.lang.Math", "IEEEremainder" }, { "java.lang.Math", "log" },
      { "java.lang.Math", "max" }, { "java.lang.Math", "min" }, { "java.lang.Math", "pow" }, { "java.lang.Math", "rint" },
      { "java.lang.Math", "round" }, { "java.lang.Math", "sin" }, { "java.lang.Math", "sqrt" }, { "java.lang.Math", "tan" },
      // TODO: put StrictMath as well ?
      { "java.lang.Throwable", "" },
      // to break the cycle exception -> getCharsAt -> exception
      { "java.lang.StringIndexOutOfBoundsException", "" } };

  // unanalysed methods that modify the whole environment
  static private final String[][] impureMethods = { { "java.io.", "" }, { "java.io.", "close" },
      { "java.io.", "read" }, { "java.io.", "write" }, { "java.io.", "flush" }, { "java.io.", "flushBuffer" },
      { "java.io.", "print" }, { "java.io.", "println" }, { "java.lang.Runtime",
          "exit" }, /*
                     * // for soot... {"java.io.","skip"}, {"java.io.","ensureOpen"}, {"java.io.","fill"},
                     * {"java.io.","readLine"}, {"java.io.","available"}, {"java.io.","mark"}, {"java.io.","reset"},
                     * {"java.io.","toByteArray"}, {"java.io.","size"}, {"java.io.","writeTo"}, {"java.io.","readBoolean"},
                     * {"java.io.","readChar"}, {"java.io.","readDouble"}, {"java.io.","readFloat"}, {"java.io.","readByte"},
                     * {"java.io.","readShort"}, {"java.io.","readInt"}, {"java.io.","readLong"},
                     * {"java.io.","readUnsignedByte"}, {"java.io.","readUnsignedShort"}, {"java.io.","readUTF"},
                     * {"java.io.","readFully"}, {"java.io.","writeBoolean"}, {"java.io.","writeChar"},
                     * {"java.io.","writeChars"}, {"java.io.","writeDouble"}, {"java.io.","writeFloat"},
                     * {"java.io.","writeByte"}, {"java.io.","writeBytes"}, {"java.io.","writeShort"},
                     * {"java.io.","writeInt"}, {"java.io.","writeLong"}, {"java.io.","writeUTF"}, {"java.io.","canRead"},
                     * {"java.io.","delete"}, {"java.io.","exists"}, {"java.io.","isDirectory"}, {"java.io.","isFile"},
                     * {"java.io.","mkdir"}, {"java.io.","mkdirs"}, {"java.io.","getAbsoluteFile"},
                     * {"java.io.","getCanonicalFile"}, {"java.io.","getParentFile"}, {"java.io.","listFiles"},
                     * {"java.io.","getAbsolutePath"}, {"java.io.","getCanonicalPath"}, {"java.io.","getName"},
                     * {"java.io.","getParent"}, {"java.io.","getPath"}, {"java.io.","list"}, {"java.io.","toURI"},
                     * {"java.io.","lastModified"}, {"java.io.","length"}, {"java.io.","implies"},
                     * {"java.io.","newPermissionCollection"}, {"java.io.","getLineNumber"},
                     * {"java.io.","enableResolveObject"}, {"java.io.","readClassDescriptor"}, {"java.io.","readFields"},
                     * {"java.io.","readObject"}, {"java.io.","readUnshared"}, {"java.io.","defaultReadObject"},
                     * {"java.io.","defaultWriteObject"}, {"java.io.","putFields"}, {"java.io.","writeFields"},
                     * {"java.io.","writeObject"}, {"java.io.","writeUnshared"}, {"java.io.","unread"},
                     * {"java.io.","lineno"}, {"java.io.","nextToken"}, {"java.io.","commentChar"},
                     * {"java.io.","lowerCaseMode"}, {"java.io.","ordinaryChar"}, {"java.io.","quoteChar"},
                     * {"java.io.","resetSyntax"}, {"java.io.","slashSlashComments"}, {"java.io.","slashSltarComments"},
                     * {"java.io.","whitespaceChars"}, {"java.io.","wordChars"}, {"java.io.","markSupported"},
                     * {"java.","getCause"}, {"java.","getMessage"}, {"java.","getReason"},
                     */ };

  // unanalysed methods that alter its arguments, but have no side effect
  static private final String[][] alterMethods = { { "java.lang.System", "arraycopy" },
      // these are really huge methods used internally by StringBuffer
      // printing => put here to speed-up the analysis
      { "java.lang.FloatingDecimal", "dtoa" }, { "java.lang.FloatingDecimal", "developLongDigits" },
      { "java.lang.FloatingDecimal", "big5pow" }, { "java.lang.FloatingDecimal", "getChars" },
      { "java.lang.FloatingDecimal", "roundup" } };

  /**
   * Filter out some method.
   */
  static private class Filter implements SootMethodFilter {

    @Override
    public boolean want(SootMethod method) {
      // could be optimized with HashSet....
      String c = method.getDeclaringClass().toString();
      String m = method.getName();
      for (String[] element : PurityInterproceduralAnalysis.pureMethods) {
        if (m.equals(element[1]) && c.startsWith(element[0])) {
          return false;
        }
      }
      for (String[] element : PurityInterproceduralAnalysis.impureMethods) {
        if (m.equals(element[1]) && c.startsWith(element[0])) {
          return false;
        }
      }
      for (String[] element : PurityInterproceduralAnalysis.alterMethods) {
        if (m.equals(element[1]) && c.startsWith(element[0])) {
          return false;
        }
      }
      return true;
    }
  }

  /**
   * The constructor does it all!
   */
  PurityInterproceduralAnalysis(CallGraph cg, Iterator heads, PurityOptions opts) {
    super(cg, new Filter(), heads, opts.dump_cg());

    if (opts.dump_cg()) {
      logger.debug("[AM] Dumping empty .dot call-graph");
      drawAsOneDot("EmptyCallGraph");
    }

    Date start = new Date();
    logger.debug("[AM] Analysis began");
    doAnalysis(opts.verbose());
    logger.debug("[AM] Analysis finished");
    Date finish = new Date();
    long runtime = finish.getTime() - start.getTime();
    logger.debug("[AM] run time: " + runtime / 1000. + " s");

    if (opts.dump_cg()) {
      logger.debug("[AM] Dumping annotated .dot call-graph");
      drawAsOneDot("CallGraph");
    }

    if (opts.dump_summaries()) {
      logger.debug("[AM] Dumping .dot summaries of analysed methods");
      drawAsManyDot("Summary_", false);
    }

    if (opts.dump_intra()) {
      logger.debug("[AM] Dumping .dot full intra-procedural method analyses");
      // relaunch the interprocedural analysis once on each method
      // to get a purity graph at each statement, not only summaries
      for (Iterator it = getAnalysedMethods(); it.hasNext();) {
        SootMethod method = it.next();
        Body body = method.retrieveActiveBody();
        ExceptionalUnitGraph graph = new ExceptionalUnitGraph(body);
        if (opts.verbose()) {
          logger.debug("  |- " + method);
        }
        PurityIntraproceduralAnalysis r = new PurityIntraproceduralAnalysis(graph, this);
        r.drawAsOneDot("Intra_", method.toString());
        PurityGraphBox b = new PurityGraphBox();
        r.copyResult(b);
      }
    }

    {
      logger.debug("[AM] Annotate methods. ");
      for (Iterator it = getAnalysedMethods(); it.hasNext();) {
        SootMethod m = it.next();
        PurityGraphBox b = getSummaryFor(m);

        // purity
        boolean isPure = m.toString().contains("") ? b.g.isPureConstructor() : b.g.isPure();

        /*
         * m.addTag(new GenericAttribute("isPure", (new String(isPure?"yes":"no")).getBytes()));
         */
        m.addTag(new StringTag("purity: " + (isPure ? "pure" : "impure")));
        if (isPure && opts.annotate()) {
          m.addTag(new GenericAttribute("Pure", new byte[0]));
        }
        if (opts.print()) {
          logger.debug("  |- method " + m.toString() + " is " + (isPure ? "pure" : "impure"));
        }

        // param & this ro / safety
        if (!m.isStatic()) {
          String s;
          switch (b.g.thisStatus()) {
            case PurityGraph.PARAM_RW:
              s = "read/write";
              break;
            case PurityGraph.PARAM_RO:
              s = "read-only";
              break;
            case PurityGraph.PARAM_SAFE:
              s = "Safe";
              break;
            default:
              s = "unknown";
          }
          /*
           * m.addTag(new GenericAttribute("thisStatus",s.getBytes()));
           */
          m.addTag(new StringTag("this: " + s));
          if (opts.print()) {
            logger.debug("  |   |- this is " + s);
          }
        }

        int i = 0;
        for (Type t : m.getParameterTypes()) {
          if (t instanceof RefLikeType) {
            String s;
            switch (b.g.paramStatus(i)) {
              case PurityGraph.PARAM_RW:
                s = "read/write";
                break;
              case PurityGraph.PARAM_RO:
                s = "read-only";
                break;
              case PurityGraph.PARAM_SAFE:
                s = "safe";
                break;
              default:
                s = "unknown";
            }
            /*
             * m.addTag(new GenericAttribute("param"+i+"Status", s.getBytes()));
             */
            m.addTag(new StringTag("param" + i + ": " + s));
            if (opts.print()) {
              logger.debug("  |   |- param " + i + " is " + s);
            }
          }
          i++;
        }
      }
    }

  }

  @Override
  protected PurityGraphBox newInitialSummary() {
    return new PurityGraphBox();
  }

  @Override
  protected void merge(PurityGraphBox in1, PurityGraphBox in2, PurityGraphBox out) {
    if (out != in1) {
      out.g = new PurityGraph(in1.g);
    }
    out.g.union(in2.g);
  }

  @Override
  protected void copy(PurityGraphBox source, PurityGraphBox dest) {
    dest.g = new PurityGraph(source.g);
  }

  @Override
  protected void analyseMethod(SootMethod method, PurityGraphBox dst) {
    Body body = method.retrieveActiveBody();
    ExceptionalUnitGraph graph = new ExceptionalUnitGraph(body);
    new PurityIntraproceduralAnalysis(graph, this).copyResult(dst);
  }

  /**
   * @return
   *
   * @see PurityGraph.conservativeGraph
   * @see PurityGraph.freshGraph
   */
  @Override
  protected PurityGraphBox summaryOfUnanalysedMethod(SootMethod method) {
    PurityGraphBox b = new PurityGraphBox();
    String c = method.getDeclaringClass().toString();
    String m = method.getName();

    // impure with side-effect, unless otherwise specified
    b.g = PurityGraph.conservativeGraph(method, true);

    for (String[] element : PurityInterproceduralAnalysis.pureMethods) {
      if (m.equals(element[1]) && c.startsWith(element[0])) {
        b.g = PurityGraph.freshGraph(method);
      }
    }

    for (String[] element : PurityInterproceduralAnalysis.alterMethods) {
      if (m.equals(element[1]) && c.startsWith(element[0])) {
        b.g = PurityGraph.conservativeGraph(method, false);
      }
    }

    return b;
  }

  /**
   * @param stmt
   *          any statement containing an InvokeExpr
   *
   * @see PurityGraph.methodCall
   */
  @Override
  protected void applySummary(PurityGraphBox src, Stmt stmt, PurityGraphBox summary, PurityGraphBox dst) {
    // extract call info
    InvokeExpr e = stmt.getInvokeExpr();
    Local ret = null;
    if (stmt instanceof AssignStmt) {
      Local v = (Local) ((AssignStmt) stmt).getLeftOp();
      if (v.getType() instanceof RefLikeType) {
        ret = v;
      }
    }
    Local obj = null;
    if (!(e instanceof StaticInvokeExpr)) {
      obj = (Local) ((InstanceInvokeExpr) e).getBase();
    }
    List args = e.getArgs();

    // call methoCall on the PurityGraph
    PurityGraph g = new PurityGraph(src.g);
    g.methodCall(summary.g, obj, args, ret);
    dst.g = g;
  }

  @Override
  protected void fillDotGraph(String prefix, PurityGraphBox o, DotGraph out) {
    o.g.fillDotGraph(prefix, out);
  }
}