Skip to content

Migration Help

Version 3.0.2

  • Identifiers are hash-consed: the IdentifierFactory hands out the same instance for equal ClassTypes, MethodSignatures, FieldSignatures, their sub signatures and PackageNames. They can therefore be compared with == and used as keys of an IdentityHashMap.
  • As a consequence the constructors of these classes are not public anymore. Obtain them from the IdentifierFactory of the View that the identifiers are used with: 
    1
    ClassType classType = view.getIdentifierFactory().getClassType("example.HelloWorld");
  • JavaIdentifierFactory.getInstance() and JavaModuleIdentifierFactory.getInstance() were removed - the factory belongs to a View now. Use view.getIdentifierFactory(); if there is no View at hand (e.g. while setting one up), instantiate it with new JavaIdentifierFactory().
  • JavaModuleIdentifierFactory.getInstance(module) was replaced by the instance method forModule(module): 
    1
2
3
    JavaModuleIdentifierFactory factory =
        (JavaModuleIdentifierFactory) moduleView.getIdentifierFactory();
JavaModuleIdentifierFactory factoryOfModule = factory.forModule("mymodule");

Version 1.3.0

  • The Typehierarchy API is now returning Stream<ClassType> instead of Collection<ClassType>. The simplest fix to have the same behaviour as before would be to collect the Stream on your own ( e.g. via .collect(Collectors.toList()) ).
  • Default BytecodeBodyinterceptors are enabled to improve Jimple. To mitigate that adapt the List of BodyInterceptors to your needs.

Version 1.2.0

  • The (Java)Project structure was removed. You can configure the (Java)View directly.
  • Bodyinterceptors are now passed as arguments into AnalysisInputLocations.

From Soot

  • The Scene singleton is dead. Long live the Scene. We have a central View object(!) now.
  • Library first! No command line tool as primary goal. So you can configure parts of SootUp (near) where it is actually used.
  • t.b.c.

Below we show a comparison of the code so far with the same functionality in sootup.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
AnalysisInputLocation<JavaSootClass> inputLocation =
new JavaClassPathAnalysisInputLocation("path2Binary");

JavaView view = new JavaView(inputLocation);

JavaClassType classType = 
        view.getIdentifierFactory().getClassType("HelloWorld");

MethodSignature methodSignature =
    view
        .getIdentifierFactory()
        .getMethodSignature(
            "main", classType, "void",
            Collections.singletonList("java.lang.String[]"));

JavaSootClass sootClass = view.getClass(classType).get();

MethodSubSignature mss = methodSignature.getSubSignature();
JavaSootMethod sootMethod =  sootClass.getMethod(mss).get();

sootMethod.getBody().getStmts();

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
G.reset();
String userdir = System.getProperty("user.dir");
String sootCp = 
        userdir 
        + File.separator 
        + "target" 
        + File.separator 
        + "test-classes"
        + File.pathSeparator + "lib"+File.separator+"rt.jar";

Options.v().set_soot_classpath(sootCp);
Options.v().set_whole_program(true);
Options.v().setPhaseOption("cg.cha", "on");
Options.v().setPhaseOption("cg", "all-reachable:true");
Options.v().set_no_bodies_for_excluded(true);
Options.v().set_allow_phantom_refs(true);
Options.v().setPhaseOption("jb", "use-original-names:true");
Options.v().set_prepend_classpath(false);

Scene.v().addBasicClass("java.lang.StringBuilder");
SootClass c = 
    Scene.v().forceResolve(targetTestClassName, SootClass.BODIES);
if (c != null) {
    c.setApplicationClass();
}
Scene.v().loadNecessaryClasses();

SootMethod method;
for (SootClass c : Scene.v().getApplicationClasses()) {
    if(c.getName().equals("example.HelloWorld")){
        for (SootMethod m : c.getMethods()) {
            if (!m.hasActiveBody()) {
                continue;
            }
            if (m.getName().equals("entryPoint")) {
                method = m;
                break;
            }
        }
    }
}

method.getActiveBody().getUnits();