soot.EntryPoints Maven / Gradle / Ivy

package soot;

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

import soot.util.NumberedString;

/**
 * Returns the various potential entry points of a Java program.
 * 
 * @author Ondrej Lhotak
 */
public class EntryPoints {
  public EntryPoints(Singletons.Global g) {
  }

  public static EntryPoints v() {
    return G.v().soot_EntryPoints();
  }

  final NumberedString sigMain = Scene.v().getSubSigNumberer().findOrAdd("void main(java.lang.String[])");
  final NumberedString sigFinalize = Scene.v().getSubSigNumberer().findOrAdd("void finalize()");
  final NumberedString sigExit = Scene.v().getSubSigNumberer().findOrAdd("void exit()");
  final NumberedString sigClinit = Scene.v().getSubSigNumberer().findOrAdd("void ()");
  final NumberedString sigInit = Scene.v().getSubSigNumberer().findOrAdd("void ()");
  final NumberedString sigStart = Scene.v().getSubSigNumberer().findOrAdd("void start()");
  final NumberedString sigRun = Scene.v().getSubSigNumberer().findOrAdd("void run()");
  final NumberedString sigObjRun = Scene.v().getSubSigNumberer().findOrAdd("java.lang.Object run()");
  final NumberedString sigForName = Scene.v().getSubSigNumberer().findOrAdd("java.lang.Class forName(java.lang.String)");

  protected void addMethod(List set, SootClass cls, NumberedString methodSubSig) {
    SootMethod sm = cls.getMethodUnsafe(methodSubSig);
    if (sm != null) {
      set.add(sm);
    }
  }

  protected void addMethod(List set, String methodSig) {
    if (Scene.v().containsMethod(methodSig)) {
      set.add(Scene.v().getMethod(methodSig));
    }
  }

  /**
   * Returns only the application entry points, not including entry points invoked implicitly by the VM.
   */
  public List application() {
    List ret = new ArrayList();
    if (Scene.v().hasMainClass()) {
      addMethod(ret, Scene.v().getMainClass(), sigMain);
      for (SootMethod clinit : clinitsOf(Scene.v().getMainClass())) {
        ret.add(clinit);
      }
    }
    return ret;
  }

  /** Returns only the entry points invoked implicitly by the VM. */
  public List implicit() {
    List ret = new ArrayList();
    addMethod(ret, "");
    addMethod(ret, "()>");
    // addMethod( ret, "");
    addMethod(ret, "");
    addMethod(ret, "");
    // addMethod( ret, "");
    addMethod(ret, "()>");
    addMethod(ret, "");
    addMethod(ret, "");
    addMethod(ret, "");
    addMethod(ret, "");
    addMethod(ret, "(java.lang.Exception)>");
    // addMethod( ret, "");
    addMethod(ret, "");
    addMethod(ret, "(java.lang.ThreadGroup,java.lang.Runnable)>");
    addMethod(ret, "(java.lang.ThreadGroup,java.lang.String)>");
    return ret;
  }

  /** Returns all the entry points. */
  public List all() {
    List ret = new ArrayList();
    ret.addAll(application());
    ret.addAll(implicit());
    return ret;
  }

  /** Returns a list of all static initializers. */
  public List clinits() {
    List ret = new ArrayList();
    for (Iterator clIt = Scene.v().getClasses().iterator(); clIt.hasNext();) {
      final SootClass cl = clIt.next();
      addMethod(ret, cl, sigClinit);
    }
    return ret;
  }

  /** Returns a list of all constructors taking no arguments. */
  public List inits() {
    List ret = new ArrayList();
    for (Iterator clIt = Scene.v().getClasses().iterator(); clIt.hasNext();) {
      final SootClass cl = clIt.next();
      addMethod(ret, cl, sigInit);
    }
    return ret;
  }

  /** Returns a list of all constructors. */
  public List allInits() {
    List ret = new ArrayList();
    for (Iterator clIt = Scene.v().getClasses().iterator(); clIt.hasNext();) {
      final SootClass cl = clIt.next();
      for (SootMethod m : cl.getMethods()) {
        if (m.getName().equals("")) {
          ret.add(m);
        }
      }
    }
    return ret;
  }

  /** Returns a list of all concrete methods of all application classes. */
  public List methodsOfApplicationClasses() {
    List ret = new ArrayList();
    for (Iterator clIt = Scene.v().getApplicationClasses().iterator(); clIt.hasNext();) {
      final SootClass cl = clIt.next();
      for (Iterator mIt = cl.getMethods().iterator(); mIt.hasNext();) {
        final SootMethod m = mIt.next();
        if (m.isConcrete()) {
          ret.add(m);
        }
      }
    }
    return ret;
  }

  /**
   * Returns a list of all concrete main(String[]) methods of all application classes.
   */
  public List mainsOfApplicationClasses() {
    List ret = new ArrayList();
    for (Iterator clIt = Scene.v().getApplicationClasses().iterator(); clIt.hasNext();) {
      final SootClass cl = clIt.next();
      SootMethod m = cl.getMethodUnsafe("void main(java.lang.String[])");
      if (m != null) {
        if (m.isConcrete()) {
          ret.add(m);
        }
      }
    }
    return ret;
  }

  /** Returns a list of all clinits of class cl and its superclasses. */
  public Iterable clinitsOf(SootClass cl) {
    // Do not create an actual list, since this method gets called quite
    // often
    // Instead, callers usually just want to iterate over the result.
    final SootMethod initStart = cl.getMethodUnsafe(sigClinit);
    if (initStart == null) {
      return Collections.emptyList();
    }
    return new Iterable() {

      @Override
      public Iterator iterator() {
        return new Iterator() {
          SootMethod current = initStart;

          @Override
          public SootMethod next() {
            if (!hasNext()) {
              throw new NoSuchElementException();
            }
            SootMethod n = current;

            // Pre-fetch the next element
            current = null;
            SootClass currentClass = n.getDeclaringClass();
            while (true) {
              SootClass superClass = currentClass.getSuperclassUnsafe();
              if (superClass == null) {
                break;
              }

              SootMethod m = superClass.getMethodUnsafe(sigClinit);
              if (m != null) {
                current = m;
                break;
              }

              currentClass = superClass;
            }

            return n;
          }

          @Override
          public boolean hasNext() {
            return current != null;
          }
        };
      }
    };
  }
}