soot.jimple.infoflow.util.DebugAbstractionTree Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of soot-infoflow Show documentation
Soot extending data flow tracking components for Java
The newest version!
package soot.jimple.infoflow.util;

import java.util.ArrayDeque;
import java.util.Deque;
import java.util.IdentityHashMap;
import java.util.Set;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.google.common.collect.Sets;
import com.google.common.html.HtmlEscapers;

import soot.jimple.infoflow.data.Abstraction;
import soot.util.IdentityHashSet;

/**
 * Creates a Graphviz/dot graph of a {@link Abstraction} tree. Contains the
 * abstractions as well as its predecessors an neighbors
 * 
 * @author Marc Miltenberger
 */
public final class DebugAbstractionTree {

	private static final Logger logger = LoggerFactory.getLogger(DebugAbstractionTree.class);

	private DebugAbstractionTree() {
	}

	/**
	 * Creates a dot graph with indices as labels for the abstractions (otherwise,
	 * it would be way too large). The correspondence is printed to log.
	 * 
	 * @param absStart       start abstraction of the tree (root)
	 * @param printNeighbors whether to print neighbors
	 * @return the dot graph
	 */
	public static String createDotGraph(Abstraction absStart, boolean printNeighbors) {
		return createDotGraph(absStart, printNeighbors, false);
	}

	/**
	 * Creates a dot graph with indices as labels for the abstractions (otherwise,
	 * it would be way too large). The correspondence is printed to log.
	 * 
	 * @param absStart       start abstraction of the tree (root)
	 * @param printNeighbors whether to print neighbors
	 * @param verbose        whether to print the access path and statement
	 * @return the dot graph
	 */
	public static String createDotGraph(Abstraction absStart, boolean printNeighbors, boolean verbose) {
		IdentityHashMap absToId = new IdentityHashMap<>();
		ArrayDeque workQueue = new ArrayDeque<>();
		StringBuilder sbNodes = new StringBuilder();
		StringBuilder sbEdges = new StringBuilder();

		int idCounter = 0;

		workQueue.add(absStart);
		while (!workQueue.isEmpty()) {
			Abstraction p = workQueue.poll();
			Integer id = absToId.get(p);
			if (id == null) {
				idCounter++;
				absToId.put(p, idCounter);
				String absName = String.valueOf(idCounter);
				if (p.getSourceContext() != null)
					absName += " [source]";
				if (verbose) {
					absName += "
";
					absName += escape(p.toString());
					if (p.getCurrentStmt() != null) {
						absName += "
@ ";
						absName += p.getCurrentStmt().toString();
						int ln = p.getCurrentStmt().getJavaSourceStartLineNumber();
						if (ln != -1)
							absName += " in line ";
					}
				}
				absName = p.isAbstractionActive() ? absName : "-" + absName;
				logger.info(idCounter + ": " + p);
				StringBuilder neighbors = new StringBuilder();
				for (int i = 0; i < p.getNeighborCount(); i++) {
					neighbors.append(String.format("| n%d", i, i));
				}
				if (p.getNeighborCount() > 0 && printNeighbors)
					workQueue.addAll(p.getNeighbors());
				if (p.getPredecessor() != null)
					workQueue.add(p.getPredecessor());

				sbNodes.append(String.format("    abs%d[label=\"{%s|{ A%s}}\"];\n", idCounter, absName,
						neighbors.toString()));
			}
		}
		workQueue.add(absStart);
		Set seen = new IdentityHashSet<>();
		while (!workQueue.isEmpty()) {
			Abstraction p = workQueue.poll();
			if (seen.add(p)) {
				Integer id = absToId.get(p);
				Abstraction pred = p.getPredecessor();
				if (pred != null) {
					int dest = absToId.get(pred);
					sbEdges.append(String.format("    abs%s:a -> abs%d;\n", id, dest));
					workQueue.add(pred);
				}
				if (p.getNeighborCount() > 0 && printNeighbors) {
					int i = 0;
					for (Abstraction n : p.getNeighbors()) {
						int dest = absToId.get(n);
						sbEdges.append(String.format("    abs%s:n%s -> abs%d;\n", id, i, dest));
						i++;
					}
					workQueue.addAll(p.getNeighbors());
				}
			}
		}

		return "digraph Debug {\n" + "    node [shape=record];\n" + sbNodes.toString() + sbEdges.toString() + "}";
	}

	private static String escape(String string) {
		return HtmlEscapers.htmlEscaper().escape(string).replace("|", "\\|");
	}

	/**
	 * Counts the nodes in an abstraction graph
	 *
	 * @param abs abstraction to start with
	 * @return number of nodes in the graph
	 */
	public static long countNodes(Abstraction abs) {
		Set visited = Sets.newIdentityHashSet();
		Deque worklist = new ArrayDeque<>();
		worklist.add(abs);
		while (!worklist.isEmpty()) {
			Abstraction curr = worklist.poll();
			if (visited.add(curr)) {
				if (curr.getPredecessor() != null)
					worklist.add(curr.getPredecessor());
				if (curr.getNeighborCount() > 0)
					worklist.addAll(curr.getNeighbors());
			}
		}
		return visited.size();
	}
}
Related Artifacts