soot.jimple.toolkits.thread.mhp.StartJoinFinder Maven / Gradle / Ivy

package soot.jimple.toolkits.thread.mhp;

/*-
 * #%L
 * Soot - a J*va Optimization Framework
 * %%
 * Copyright (C) 1997 - 2018 Raja Vallée-Rai and others
 * %%
 * 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.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;

import soot.Body;
import soot.Scene;
import soot.SootClass;
import soot.SootMethod;
import soot.jimple.Stmt;
import soot.jimple.spark.pag.AllocNode;
import soot.jimple.spark.pag.PAG;
import soot.jimple.toolkits.callgraph.CallGraph;
import soot.jimple.toolkits.callgraph.Edge;
import soot.toolkits.graph.ExceptionalUnitGraph;

// StartJoinFinder written by Richard L. Halpert, 2006-12-04
// This can be used as an alternative to PegGraph and PegChain
// if only thread start, join, and type information is needed

public class StartJoinFinder {
  Set startStatements;
  Set joinStatements;

  Map> startToRunMethods;
  Map> startToAllocNodes;
  Map startToJoin;
  Map startToContainingMethod;

  public StartJoinFinder(CallGraph callGraph, PAG pag) {
    startStatements = new HashSet();
    joinStatements = new HashSet();

    startToRunMethods = new HashMap>();
    startToAllocNodes = new HashMap>();
    startToJoin = new HashMap();
    startToContainingMethod = new HashMap();

    Iterator runAnalysisClassesIt = Scene.v().getApplicationClasses().iterator();
    while (runAnalysisClassesIt.hasNext()) {
      SootClass appClass = (SootClass) runAnalysisClassesIt.next();
      Iterator methodsIt = appClass.getMethods().iterator();
      while (methodsIt.hasNext()) {
        SootMethod method = (SootMethod) methodsIt.next();

        // If this method may have a start or run method as a target, then do a start/join analysis
        boolean mayHaveStartStmt = false;
        Iterator edgesIt = callGraph.edgesOutOf(method);
        while (edgesIt.hasNext()) {
          SootMethod target = ((Edge) edgesIt.next()).tgt();
          if (target.getName().equals("start") || target.getName().equals("run")) {
            mayHaveStartStmt = true;
          }
        }

        if (mayHaveStartStmt && method.isConcrete()) {
          Body b = method.retrieveActiveBody();

          // run the intraprocedural analysis
          StartJoinAnalysis sja = new StartJoinAnalysis(new ExceptionalUnitGraph(b), method, callGraph, pag);

          // Add to interprocedural results
          startStatements.addAll(sja.getStartStatements());
          joinStatements.addAll(sja.getJoinStatements());
          startToRunMethods.putAll(sja.getStartToRunMethods());
          startToAllocNodes.putAll(sja.getStartToAllocNodes());
          startToJoin.putAll(sja.getStartToJoin());
          Iterator startIt = sja.getStartStatements().iterator();
          while (startIt.hasNext()) {
            Stmt start = startIt.next();
            startToContainingMethod.put(start, method);
          }
        }
      }
    }
  }

  public Set getStartStatements() {
    return startStatements;
  }

  public Set getJoinStatements() {
    return joinStatements;
  }

  public Map> getStartToRunMethods() {
    return startToRunMethods;
  }

  public Map> getStartToAllocNodes() {
    return startToAllocNodes;
  }

  public Map getStartToJoin() {
    return startToJoin;
  }

  public Map getStartToContainingMethod() {
    return startToContainingMethod;
  }
}