soot.jimple.infoflow.data.pathBuilders.BatchPathBuilder 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
There is a newer version: 2.9.0
package soot.jimple.infoflow.data.pathBuilders;

import java.util.HashSet;
import java.util.Iterator;
import java.util.Set;
import java.util.concurrent.TimeUnit;

import soot.jimple.infoflow.InfoflowManager;
import soot.jimple.infoflow.data.AbstractionAtSink;
import soot.jimple.infoflow.memory.ISolverTerminationReason;
import soot.jimple.infoflow.results.InfoflowResults;
import soot.jimple.infoflow.solver.executors.InterruptableExecutor;

/**
 * Path builder that forwards all its requests to another path builder in
 * batches. This builder waits for each batch to complete before submitting
 * another batch. Use this path builder to reduce the memory consumption of the
 * path building process by keeping less paths in memory at the same time.
 * 
 * @author Steven Arzt
 *
 */
public class BatchPathBuilder extends AbstractAbstractionPathBuilder {

	private final IAbstractionPathBuilder innerBuilder;
	private int batchSize = 5;
	private ISolverTerminationReason terminationReason = null;

	public BatchPathBuilder(InfoflowManager manager, IAbstractionPathBuilder innerBuilder) {
		super(manager);
		this.innerBuilder = innerBuilder;
	}

	@Override
	public void computeTaintPaths(Set res) {
		Set batch = new HashSet<>();
		Iterator resIt = res.iterator();
		int batchId = 1;
		while (resIt.hasNext()) {
			// Build the next batch
			while (batch.size() < this.batchSize && resIt.hasNext())
				batch.add(resIt.next());
			logger.info(
					String.format("Running path reconstruction batch %d with %d elements", batchId++, batch.size()));

			// Run the next batch
			innerBuilder.reset();
			innerBuilder.computeTaintPaths(batch);

			// Save the termination reason
			if (this.terminationReason == null)
				this.terminationReason = innerBuilder.getTerminationReason();
			else
				this.terminationReason = this.terminationReason.combine(innerBuilder.getTerminationReason());

			// Wait for the batch to complete
			if (innerBuilder instanceof ConcurrentAbstractionPathBuilder) {
				ConcurrentAbstractionPathBuilder concurrentBuilder = (ConcurrentAbstractionPathBuilder) innerBuilder;
				final InterruptableExecutor resultExecutor = concurrentBuilder.getExecutor();
				try {
					// The path reconstruction should stop on time anyway. In case it doesn't, we
					// make sure that we don't get stuck.
					long pathTimeout = manager.getConfig().getPathConfiguration().getPathReconstructionTimeout();
					if (pathTimeout > 0)
						resultExecutor.awaitCompletion(pathTimeout + 20, TimeUnit.SECONDS);
					else
						resultExecutor.awaitCompletion();
				} catch (InterruptedException e) {
					logger.error("Could not wait for executor termination", e);
				}
				resultExecutor.reset();
			}

			// Prepare for the next batch
			batch.clear();
		}
	}

	@Override
	public InfoflowResults getResults() {
		return innerBuilder.getResults();
	}

	@Override
	public void runIncrementalPathCompuation() {
		innerBuilder.runIncrementalPathCompuation();
	}

	@Override
	public void forceTerminate(ISolverTerminationReason reason) {
		innerBuilder.forceTerminate(reason);
	}

	@Override
	public boolean isTerminated() {
		return innerBuilder.isTerminated();
	}

	@Override
	public boolean isKilled() {
		return innerBuilder.isKilled();
	}

	@Override
	public ISolverTerminationReason getTerminationReason() {
		return terminationReason;
	}

	@Override
	public void reset() {
		innerBuilder.reset();
	}

	@Override
	public void addStatusListener(IMemoryBoundedSolverStatusNotification listener) {
		innerBuilder.addStatusListener(listener);
	}

	/**
	 * Sets the number of paths that shall be part of one batch, i.e., that shall be
	 * forwarded to the inner path builder at the same time
	 * 
	 * @param batchSize
	 *            The number of paths in one batch
	 */
	public void setBatchSize(int batchSize) {
		this.batchSize = batchSize;
	}

}