soot.jimple.toolkits.thread.mhp.PegChain 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.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;

import soot.Body;
import soot.Hierarchy;
import soot.IntType;
import soot.Local;
import soot.LongType;
import soot.RefType;
import soot.SootClass;
import soot.SootMethod;
import soot.Trap;
import soot.Type;
import soot.Unit;
import soot.Value;
import soot.jimple.EnterMonitorStmt;
import soot.jimple.ExitMonitorStmt;
import soot.jimple.InstanceInvokeExpr;
import soot.jimple.InvokeExpr;
import soot.jimple.MonitorStmt;
import soot.jimple.NewExpr;
import soot.jimple.StaticInvokeExpr;
import soot.jimple.Stmt;
import soot.jimple.internal.JIdentityStmt;
import soot.jimple.spark.pag.AllocNode;
import soot.jimple.spark.pag.Node;
import soot.jimple.spark.pag.PAG;
import soot.jimple.spark.sets.P2SetVisitor;
import soot.jimple.spark.sets.PointsToSetInternal;
import soot.jimple.toolkits.callgraph.CallGraph;
import soot.jimple.toolkits.thread.mhp.stmt.BeginStmt;
import soot.jimple.toolkits.thread.mhp.stmt.JPegStmt;
import soot.jimple.toolkits.thread.mhp.stmt.JoinStmt;
import soot.jimple.toolkits.thread.mhp.stmt.MonitorEntryStmt;
import soot.jimple.toolkits.thread.mhp.stmt.MonitorExitStmt;
import soot.jimple.toolkits.thread.mhp.stmt.NotifiedEntryStmt;
import soot.jimple.toolkits.thread.mhp.stmt.NotifyAllStmt;
import soot.jimple.toolkits.thread.mhp.stmt.NotifyStmt;
import soot.jimple.toolkits.thread.mhp.stmt.OtherStmt;
import soot.jimple.toolkits.thread.mhp.stmt.StartStmt;
import soot.jimple.toolkits.thread.mhp.stmt.WaitStmt;
import soot.jimple.toolkits.thread.mhp.stmt.WaitingStmt;
import soot.tagkit.StringTag;
import soot.toolkits.graph.CompleteUnitGraph;
import soot.toolkits.graph.UnitGraph;
import soot.toolkits.scalar.ArraySparseSet;
import soot.toolkits.scalar.FlowSet;
import soot.util.Chain;
import soot.util.HashChain;

//add for add tag
//import soot.util.cfgcmd.*;

// *** USE AT YOUR OWN RISK ***
// May Happen in Parallel (MHP) analysis by Lin Li.
// This code should be treated as beta-quality code.
// It was written in 2003, but not incorporated into Soot until 2006.
// As such, it may contain incorrect assumptions about the usage
// of certain Soot classes.
// Some portions of this MHP analysis have been quality-checked, and are
// now used by the Transactions toolkit.
//
// -Richard L. Halpert, 2006-11-30

// NOTE that this graph builder will only run to completion if all virtual
// method calls can be resolved to a single target method.  This is a severely
// limiting caveat.

public class PegChain extends HashChain {

  CallGraph callGraph;
  private final List heads = new ArrayList();
  private final List tails = new ArrayList();
  private final FlowSet pegNodes = new ArraySparseSet();

  private final Map unitToPeg = new HashMap();
  private final Map waitingNodes;
  private final PegGraph pg;
  private final Set> joinNeedReconsidered = new HashSet>();
  public Body body; // body from which this peg chain was created
  // private Map startToThread;

  Hierarchy hierarchy;
  PAG pag;
  Set threadAllocSites;
  Set methodsNeedingInlining;
  Set allocNodes;
  List inlineSites;
  Map synchObj;
  Set multiRunAllocNodes;
  Map allocNodeToObj;

  PegChain(CallGraph callGraph, Hierarchy hierarchy, PAG pag, Set threadAllocSites, Set methodsNeedingInlining,
      Set allocNodes, List inlineSites, Map synchObj, Set multiRunAllocNodes,
      Map allocNodeToObj, Body unitBody, SootMethod sm, String threadName, boolean addBeginNode,
      PegGraph pegGraph) {
    this.allocNodeToObj = allocNodeToObj;
    this.multiRunAllocNodes = multiRunAllocNodes;
    this.synchObj = synchObj;
    this.inlineSites = inlineSites;
    this.allocNodes = allocNodes;
    this.methodsNeedingInlining = methodsNeedingInlining;
    this.threadAllocSites = threadAllocSites;
    this.hierarchy = hierarchy;
    this.pag = pag;
    this.callGraph = callGraph;
    body = unitBody;
    pg = pegGraph;
    waitingNodes = pegGraph.getWaitingNodes();
    // Find exception handlers
    Iterator trapIt = unitBody.getTraps().iterator();
    Set exceHandlers = pg.getExceHandlers();
    while (trapIt.hasNext()) {
      Trap trap = (Trap) trapIt.next();
      Unit handlerUnit = trap.getHandlerUnit();
      exceHandlers.add(handlerUnit);
    }

    // System.out.println("entering buildPegChain");
    UnitGraph graph = new CompleteUnitGraph(unitBody);

    Iterator unitIt = graph.iterator();
    // HashMap unitToPeg = new HashMap((graph.size())*2+1,0.7f);
    // June 19 add begin node

    if (addBeginNode) {
      // create PEG begin statement
      JPegStmt beginStmt = new BeginStmt("*", threadName, graph, sm);
      pg.getCanNotBeCompacted().add(beginStmt);
      addNode(beginStmt);
      heads.add(beginStmt);

    }
    // end June 19 add begin node

    Iterator it = graph.getHeads().iterator();

    while (it.hasNext()) {
      Object head = it.next();
      // breadth first scan
      Set gray = new HashSet();
      LinkedList