All Downloads are FREE. Search and download functionalities are using the official Maven repository.

soot.jimple.toolkits.thread.mhp.CompactSequentNodes 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.List;
import java.util.ListIterator;
import java.util.Map;
import java.util.Set;

import soot.toolkits.scalar.FlowSet;
import soot.util.Chain;

// *** 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

public class CompactSequentNodes {
  long compactNodes = 0;
  long add = 0;

  public CompactSequentNodes(PegGraph pg) {
    Chain mainPegChain = pg.getMainPegChain();
    compactGraph(mainPegChain, pg);
    compactStartChain(pg);
    // PegToDotFile printer = new PegToDotFile(pg, false, "sequence");
    System.err.println("compact seq. node: " + compactNodes);
    System.err.println("number of compacting seq. nodes: " + add);
  }

  private void compactGraph(Chain chain, PegGraph peg) {
    Set canNotBeCompacted = peg.getCanNotBeCompacted();
    List> list = computeSequentNodes(chain, peg);
    // printSeq(list);
    Iterator> it = list.iterator();
    while (it.hasNext()) {
      List s = it.next();

      if (!checkIfContainsElemsCanNotBeCompacted(s, canNotBeCompacted)) {
        add++;
        compact(s, chain, peg);
      }

    }
  }

  private void compactStartChain(PegGraph graph) {
    Set maps = graph.getStartToThread().entrySet();
    for (Iterator iter = maps.iterator(); iter.hasNext();) {
      Map.Entry entry = (Map.Entry) iter.next();
      List runMethodChainList = (List) entry.getValue();
      Iterator it = runMethodChainList.iterator();
      while (it.hasNext()) {
        Chain chain = (Chain) it.next();
        compactGraph(chain, graph);
      }
    }

  }

  private List> computeSequentNodes(Chain chain, PegGraph pg) {
    Set gray = new HashSet();
    List> sequentNodes = new ArrayList>();

    Set canNotBeCompacted = pg.getCanNotBeCompacted();
    TopologicalSorter ts = new TopologicalSorter(chain, pg);
    ListIterator it = ts.sorter().listIterator();
    while (it.hasNext()) {
      Object node = it.next();
      List list = new ArrayList();
      if (!gray.contains(node)) {
        visitNode(pg, node, list, canNotBeCompacted, gray);
        if (list.size() > 1) {
          gray.addAll(list);
          sequentNodes.add(list);
        }

      }
    }
    return sequentNodes;
  }

  private void visitNode(PegGraph pg, Object node, List list, Set canNotBeCompacted, Set gray) {
    // System.out.println("node is: "+node);
    if (pg.getPredsOf(node).size() == 1 && pg.getSuccsOf(node).size() == 1 && !canNotBeCompacted.contains(node)
        && !gray.contains(node)) {
      list.add(node);
      Iterator it = pg.getSuccsOf(node).iterator();
      while (it.hasNext()) {
        Object o = it.next();
        visitNode(pg, o, list, canNotBeCompacted, gray);
      }

    }

    return;

  }

  private boolean checkIfContainsElemsCanNotBeCompacted(List list, Set canNotBeCompacted) {
    Iterator sccIt = list.iterator();
    while (sccIt.hasNext()) {
      Object node = sccIt.next();

      if (canNotBeCompacted.contains(node)) {
        // System.out.println("find a syn method!!");
        return true;
      }
    }
    return false;
  }

  private void compact(List list, Chain chain, PegGraph peg) {

    Iterator it = list.iterator();
    FlowSet allNodes = peg.getAllNodes();
    HashMap unitToSuccs = peg.getUnitToSuccs();
    HashMap unitToPreds = peg.getUnitToPreds();
    List newPreds = new ArrayList();
    List newSuccs = new ArrayList();

    while (it.hasNext()) {
      Object s = it.next();
      {
        Iterator predsIt = peg.getPredsOf(s).iterator();
        while (predsIt.hasNext()) {
          Object pred = predsIt.next();
          List succsOfPred = peg.getSuccsOf(pred);
          succsOfPred.remove(s);
          if (!list.contains(pred)) {
            newPreds.add(pred);
            succsOfPred.add(list);
          }
        }
      }
      {
        Iterator succsIt = peg.getSuccsOf(s).iterator();
        while (succsIt.hasNext()) {
          Object succ = succsIt.next();
          List predsOfSucc = peg.getPredsOf(succ);
          predsOfSucc.remove(s);
          if (!list.contains(succ)) {
            newSuccs.add(succ);
            predsOfSucc.add(list);
          }
        }
      }

    }
    unitToSuccs.put(list, newSuccs);
    // System.out.println("put list"+list+"\n"+ "newSuccs: "+newSuccs);
    unitToPreds.put(list, newPreds);
    allNodes.add(list);
    chain.add(list);
    updateMonitor(peg, list);
    {
      it = list.iterator();
      while (it.hasNext()) {
        Object s = it.next();
        chain.remove(s);
        allNodes.remove(s);
        unitToSuccs.remove(s);
        unitToPreds.remove(s);
      }

    }
    // System.out.println("inside compactSCC");
    // testListSucc(peg);
    compactNodes += list.size();
  }

  // The compacted nodes may inside some monitors. We need to update monitor objects.

  private void updateMonitor(PegGraph pg, List list) {
    // System.out.println("=======update monitor===");
    // add list to corresponding monitor objects sets
    Set maps = pg.getMonitor().entrySet();

    // System.out.println("---test list----");
    // testList(list);

    for (Iterator iter = maps.iterator(); iter.hasNext();) {
      Map.Entry entry = (Map.Entry) iter.next();
      FlowSet fs = (FlowSet) entry.getValue();

      Iterator it = list.iterator();
      while (it.hasNext()) {
        Object obj = it.next();
        if (fs.contains(obj)) {

          fs.add(list);
          // flag = true;
          break;
          // System.out.println("add list to monitor: "+entry.getKey());

        }

      }

    }
    // System.out.println("=======update monitor==end====");
  }
}