Refactoring for better code structure.

Change a default behavior: update Soot call graph and rechable methods after geomPTA.

Author: richardxx

src/soot/jimple/spark/geom/geomE/FullSensitiveNode.java

@@ -37,6 +37,7 @@
 import soot.jimple.spark.geom.geomPA.GeomPointsTo;
 import soot.jimple.spark.geom.geomPA.IVarAbstraction;
 import soot.jimple.spark.geom.geomPA.IWorklist;
+import soot.jimple.spark.geom.geomPA.Parameters;
 import soot.jimple.spark.pag.AllocNode;
 import soot.jimple.spark.pag.ClassConstantNode;
 import soot.jimple.spark.pag.Node;
@@ -700,14 +701,14 @@ private boolean addFlowsTo(int code, IVarAbstraction qv)
 	private void do_pts_interval_merge()
 	{
 		for ( GeometricManager gm : new_pts.values() ) {
-			gm.mergeFigures( Constants.max_pts_budget );
+			gm.mergeFigures( Parameters.max_pts_budget );
 		}
 	}
 
 	private void do_flow_edge_interval_merge()
 	{
 		for ( GeometricManager gm : flowto.values() ) {
-			gm.mergeFigures( Constants.max_cons_budget );
+			gm.mergeFigures( Parameters.max_cons_budget );
 		}
 	}
 

src/soot/jimple/spark/geom/geomPA/Constants.java

@@ -21,19 +21,23 @@
 import soot.RefType;
 
 /**
- * Parameters to control the behaviors of geom points-to solver.
- * Not all fields are really constants.
+ * Named constants used in the geomPA.
  * 
  * @author xiao
  *
  */
-public class Constants {
-
+public class Constants 
+{
 	// Available encodings
 	public static final String geomE = "Geom";
 	public static final String heapinsE = "HeapIns";
 	public static final String ptinsE = "PtIns";
 
+	// Evaluation level
+	public static final int eval_nothing = 0;
+	public static final int eval_basicInfo = 1;
+	public static final int eval_simpleClients = 2;
+	
 	// The constants for the constraints type identification
 	public static final int NEW_CONS = 0;
 	public static final int ASSIGN_CONS = 1;
@@ -52,9 +56,8 @@ public class Constants {
 	// Some commonly referred to information
 	public static final RefType exeception_type = RefType.v( "java.lang.Throwable" );
 
-	// The parameters that are used to tune the precision and performance tradeoff
-	public static int max_cons_budget = 40;
-	public static int max_pts_budget = 80;
-	public static int cg_refine_times = 1;
-
+	// The seed pointers for running constraints distillation
+	public static final int seedPts_all = 0;
+	public static final int seedPts_virtualBase = 1;
+	public static final int seedPts_staticCasts = 2;
 }

src/soot/jimple/spark/geom/geomPA/GeomPointsTo.java

@@ -304,9 +304,9 @@ else if ( solver_encoding == SparkOptions.geom_encoding_PtIns )
 		typeManager = getTypeManager();
 
 		// The tunable parameters
-		Constants.max_cons_budget = opts.geom_frac_base();
-		Constants.max_pts_budget = Constants.max_cons_budget * 2;
-		Constants.cg_refine_times = opts.geom_runs();
+		Parameters.max_cons_budget = opts.geom_frac_base();
+		Parameters.max_pts_budget = Parameters.max_cons_budget * 2;
+		Parameters.cg_refine_times = opts.geom_runs();
 
 		// Prepare for the containers
 		prepareContainers();
@@ -772,8 +772,8 @@ private int updateCallGraph()
 					p.is_obsoleted = true;
 				}
 				else if ( p.base_var != null 
-						&& (!thread_run_callsites.contains( p.sootEdge.srcStmt() ) ) 
-						) {
+						&& (!thread_run_callsites.contains( p.sootEdge.srcStmt() ) ) ) {
+					// We should care about the thread start method, it is treated specially
 					// It is a virtual call
 					keep_this_edge = false;
 					++all_virtual_edges;
@@ -782,23 +782,28 @@ else if ( p.base_var != null
 					if ( pn != null ) {
 						SootMethod sm = p.sootEdge.tgt();
 
-						for (AllocNode an : pn.get_all_points_to_objects()) {
-							Type t = an.getType();
-							if ( t == null )
-								continue;
-							else if ( t instanceof AnySubType )
-								t = ((AnySubType)t).getBase();
-							else if ( t instanceof ArrayType )
-								t = RefType.v( "java.lang.Object" );
-							
-							// Only the virtual calls do the following test
-							// We should care about the thread start method, it is treated specially
-							if ( Scene.v().getOrMakeFastHierarchy().
-									resolveConcreteDispatch( ((RefType)t).getSootClass(), sm) == sm ) {
-								keep_this_edge = true;
-								break;
+						try {
+							for (AllocNode an : pn.get_all_points_to_objects()) {
+								Type t = an.getType();
+								if ( t == null )
+									continue;
+								else if ( t instanceof AnySubType )
+									t = ((AnySubType)t).getBase();
+								else if ( t instanceof ArrayType )
+									t = RefType.v( "java.lang.Object" );
+								
+								// Only the virtual calls do the following test
+								if ( Scene.v().getOrMakeFastHierarchy().
+										resolveConcreteDispatch( ((RefType)t).getSootClass(), sm) == sm ) {
+									keep_this_edge = true;
+									break;
+								}
 							}
 						}
+						catch (RuntimeException e) {
+							// Perhaps there is a bug, either from soot or geomPTA
+							keep_this_edge = true;
+						}
 
 						if (keep_this_edge == false) {
 							p.is_obsoleted = true;
@@ -809,7 +814,7 @@ else if ( t instanceof ArrayType )
 					}
 					else {
 						System.err.println();
-						throw new RuntimeException("In update_call_graph: oops, what's up?");
+						throw new RuntimeException("In updateCallGraph: Oops, cannot find the virtual base pointer.");
 					}
 				}
 
@@ -874,9 +879,10 @@ protected int countReachableMethods( int s )
 	}
 
 	/**
-	 * Update the call graph and eliminate the pointers and objects appeared in the unreachable code.
+	 * 1. Update the call graph;
+	 * 2. Eliminate the pointers and objects appeared in the unreachable code.
 	 */
-	private void postProcess()
+	private void finalizeInternalData()
 	{
 		// Compute the set of reachable functions after the points-to analysis
 		for ( int i = 0; i < n_func; ++i ) vis_cg[i] = 0;
@@ -969,18 +975,17 @@ else if ( node instanceof AllocDotField ) {
 	/**
 	 * Stuff that is useless for querying is released.
 	 */
-	public void releaseUselessResources()
+	private void releaseUselessResources()
 	{
 		offlineProcessor.destroy();
 		IFigureManager.cleanCache();
 		System.gc(); System.gc(); System.gc(); System.gc(); System.gc();
 	}
 
 	/**
-	 * Programmers can call this function any time to use the up-to-date call graph.
-	 * Geom-pts does not update soot call graph by default.
+	 * Update Soot call graph and reachable methods.
 	 */
-	public void updateSootData()
+	protected void updateSootData()
 	{
 		// We first update the Soot call graph
 		for (CgEdge p : obsoletedEdges) {
@@ -1001,8 +1006,6 @@ public void updateSootData()
 	 */
 	public void transformToCIResult()
 	{	
-		updateSootData();
-		
 		for ( IVarAbstraction pn : pointers ) {
 			Node node = pn.getWrappedNode();
 			IVarAbstraction pRep = pn.getRepresentative();
@@ -1023,7 +1026,7 @@ public void solve()
 		long mem;
 		int rounds;
 		int n_obs;
-		int useClients = 0;
+		int seedPts = Constants.seedPts_all;
 
 		// Flush all accumulated outputs
 		G.v().out.flush();
@@ -1038,7 +1041,7 @@ public void solve()
 		offlineProcessor = new OfflineProcessor(n_var, this);
 		IFigureManager.cleanCache();
 
-		for ( rounds = 0, n_obs = 1000; rounds < Constants.cg_refine_times && n_obs > 0; ++rounds ) {
+		for ( rounds = 0, n_obs = 1000; rounds < Parameters.cg_refine_times && n_obs > 0; ++rounds ) {
 
 			ps.println("\n" + "[Geom] Propagation Round " + rounds + " ==> ");
 
@@ -1048,7 +1051,7 @@ public void solve()
 			// Offline process: 
 			// substantially use the points-to result for redundancy elimination prior to the analysis
 			Date prepare_begin = new Date();
-				offlineProcessor.runOptimizations( useClients, rounds == 0, basePointers );
+				offlineProcessor.runOptimizations( seedPts, rounds == 0, basePointers );
 			Date prepare_end = new Date();
 			prepare_time += prepare_end.getTime() - prepare_begin.getTime();	
 
@@ -1068,7 +1071,7 @@ public void solve()
 			solve_time -= update_cg_end.getTime() - update_cg_begin.getTime();
 		}
 
-		if ( rounds < Constants.cg_refine_times )
+		if ( rounds < Parameters.cg_refine_times )
 			ps.printf( "\nSorry, it's not necessary to iterate more times. We stop here.\n" );
 
 		Date end = new Date();
@@ -1081,22 +1084,27 @@ public void solve()
 		ps.printf("[Geom] Memory used : %.1f MB\n", (double) (mem) / 1024 / 1024 );
 
 		// Finish points-to analysis and prepare for querying
-		postProcess();
+		finalizeInternalData();
 
 		// We perform a set of tests to assess the quality of the points-to results for user pointers
 		int evalLevel = opts.geom_eval();
-		if ( evalLevel > 0 ) {
+		if ( evalLevel != Constants.eval_nothing ) {
 			GeomEvaluator ge = new GeomEvaluator(this, ps);
 			ge.reportBasicMetrics();
 
-			if ( evalLevel > 1 ) {
-				if ( useClients == 0 || useClients == 1 ) ge.checkCallGraph();
-				if ( useClients == 0 || useClients == 2 ) ge.checkCastsSafety();
-				if ( useClients == 0 ) ge.checkAliasAnalysis();
-				ge.estimateHeapDefuseGraph();
+			if ( evalLevel != Constants.eval_basicInfo ) {
+				if ( seedPts == Constants.seedPts_all || seedPts == Constants.seedPts_virtualBase ) ge.checkCallGraph();
+				if ( seedPts == Constants.seedPts_all || seedPts == Constants.seedPts_staticCasts ) ge.checkCastsSafety();
+				if ( seedPts == Constants.seedPts_all ) {
+					ge.checkAliasAnalysis();
+					//ge.estimateHeapDefuseGraph();
+				}
 			}
 		}
 
+		// Making changes available to Soot
+		updateSootData();
+		
 		if ( !opts.geom_trans() ) {
 			// We remove the SPARK points-to information for pointers that have geomPTA results
 			// At querying time, the SPARK points-to container will be used as query cache
@@ -1426,7 +1434,9 @@ public FileOutputStream createOutputFile( String file_name ) throws FileNotFound
 				new File( dump_dir, file_name ) );
 	}
 
+	// --------------------------------------------------------------------------------------------------------
 	// -------------------------------Soot Standard Points-to Query Interface----------------------------------
+	// --------------------------------------------------------------------------------------------------------
 
 	private PointsToSetInternal field_p2set( PointsToSet s, final SparkField f )
 	{
@@ -1502,11 +1512,14 @@ public PointsToSet reachingObjects(Context c, Local l)
 			return reachingObjects(l);
 
 		LocalVarNode vn = findLocalVarNode(l);
-		if ( vn == null ) return EmptyPointsToSet.v();
+		if ( vn == null ) 
+			return EmptyPointsToSet.v();
 
 		// Lookup the context sensitive points-to information for this pointer
 		IVarAbstraction pn = consG.get(vn);
-		if ( pn == null ) return reachingObjects(l);
+		if ( pn == null ) 
+			return vn.getP2Set();
+		
 		pn = pn.getRepresentative();
 
 		// Lookup the cache
@@ -1548,10 +1561,12 @@ public PointsToSet reachingObjects(SootField f)
             throw new RuntimeException( "The parameter f must be a *static* field." );
 
         VarNode vn = findGlobalVarNode( f );
-        if ( vn == null ) return EmptyPointsToSet.v();
+        if ( vn == null ) 
+        	return EmptyPointsToSet.v();
 
         IVarAbstraction pn = consG.get(f);
-        if( pn == null ) return vn.getP2Set();
+        if( pn == null ) 
+        	return vn.getP2Set();
 
         // Lookup the cache
         if ( hasTransformed ||
@@ -1598,9 +1613,14 @@ public PointsToSet reachingObjects(AllocNode an, SootField f)
 		AllocDotField adf = an.dot(f);
 		IVarAbstraction pn = consG.get(adf);
 
-		if ( adf == null || pn == null )
+		// No such pointer seen by SPARK
+		if ( adf == null )
 			return EmptyPointsToSet.v();
 
+		// Not seen by geomPTA
+		if ( pn == null )
+			return adf.getP2Set();
+		
 		if ( hasTransformed ||
 	        	adf.getP2Set() != EmptyPointsToSet.v() ) return adf.getP2Set();	
 

src/soot/jimple/spark/geom/geomPA/OfflineProcessor.java

@@ -96,7 +96,7 @@ public OfflineProcessor( int size, GeomPointsTo pta )
 		for ( int i = 0; i < size; ++i ) varGraph.add(null);
 	}
 
-	public void runOptimizations( int useClients, boolean useSpark, Set<VarNode> basePointers )
+	public void runOptimizations( int seedPts, boolean useSpark, Set<VarNode> basePointers )
 	{
 		// We prepare the essential data structure first
 		n_var = int2var.size();						// The size of the pointers will shrink after each round of analysis
@@ -109,15 +109,16 @@ public void runOptimizations( int useClients, boolean useSpark, Set<VarNode> bas
 		// The instance graph reverses the assignment relations. E.g., p = q  => p -> q
 		buildInstanceAssignmentGraph( useSpark );
 
-		switch (useClients) {
-		case 1:
+		switch (seedPts) {
+		case Constants.seedPts_virtualBase:
 			setVirualBaseVarsUseful();
 			break;
 
-		case 2:
+		case Constants.seedPts_staticCasts:
 			setStaticCastsVarUseful( useSpark );
 			break;
 
+		case Constants.seedPts_all:
 		default:
 			setAllUserCodeVariablesUseful();
 			break;

src/soot/jimple/spark/geom/geomPA/Parameters.java

@@ -0,0 +1,34 @@
+/* Soot - a J*va Optimization Framework
+ * Copyright (C) 2011-2014 Richard Xiao
+ *
+ * This library 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 library 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+package soot.jimple.spark.geom.geomPA;
+
+/**
+ * Parameters to control the behaviors of geom points-to solver.
+ * 
+ * @author xiao
+ *
+ */
+public class Parameters 
+{
+	// The parameters that are used to tune the precision and performance tradeoff
+	public static int max_cons_budget = 40;
+	public static int max_pts_budget = 80;
+	public static int cg_refine_times = 1;
+	
+}