adding partial results

Author: pedro-patriota

src/main/arguments/ArgsParser.groovy

@@ -39,6 +39,7 @@ class ArgsParser {
         this.cli.e(longOpt: 'extension', args: 1, argName: 'file extenson', 'Specify the file extension that should be used in the analysis (e.g. .rb, .ts, .java, .cpp. Default: .java)')
         this.cli.l(longOpt: 'language-separators', args: 1, argName: 'language syntactic separators', 'Specify the language separators that should be used in the analysis. Required for (and only considered when) running studies with the CSDiff tool. Default: \"{ } ( ) ; ,\"')
         this.cli.log(longOpt: 'log-level', args: 1, argName: 'log level', 'Specify the minimum log level: (OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL). Default: \"INFO\"')
+        this.cli.prt(longOpt: 'partial-results-on-timeout', 'When a soot analysis times out, capture and record the partial results found up to that point instead of discarding them')
     }
 
     Arguments parse(args) {
@@ -142,6 +143,10 @@ class ArgsParser {
         if(this.options.log) {
             args.setLogLevel(Level.toLevel(this.options.log))
         }
+
+        if (this.options.prt) {
+            args.setPartialResultsOnTimeout(true)
+        }
     }
 
     private boolean repositoryExists(String repositoryURL) {

src/main/arguments/Arguments.groovy

@@ -21,6 +21,7 @@ class Arguments {
     private String syntacticSeparators
     private String fileExtension
     private Level logLevel
+    private boolean partialResultsOnTimeout
 
     Arguments() { // set the default values for all parameters
         randomSeed = 1
@@ -37,6 +38,7 @@ class Arguments {
         syntacticSeparators = '{ } ( ) ; ,'
         fileExtension = '.java'
         logLevel = Level.INFO
+        partialResultsOnTimeout = false
     }
 
     void setRandomSeed(int randomSeed) {
@@ -167,4 +169,12 @@ class Arguments {
         this.logLevel = logLevel
         Configurator.setRootLevel(logLevel)
     }
+
+    boolean isPartialResultsOnTimeout() {
+        return partialResultsOnTimeout
+    }
+
+    void setPartialResultsOnTimeout(boolean partialResultsOnTimeout) {
+        this.partialResultsOnTimeout = partialResultsOnTimeout
+    }
 }

src/main/services/outputProcessors/soot/ConflictDetectionAlgorithm.groovy

@@ -3,6 +3,7 @@ package services.outputProcessors.soot
 import util.ProcessRunner
 
 import java.util.concurrent.TimeUnit
+import java.util.concurrent.atomic.AtomicReference
 
 /**
  * Runs a soot algorithm with:
@@ -20,6 +21,10 @@ class ConflictDetectionAlgorithm {
     private boolean interprocedural;
     private long depthLimit;
     private String callgraph;
+    private boolean partialResultsOnTimeout;
+
+    // Grace period to let the output thread finish reading buffered output after process is destroyed
+    private static final long GRACE_PERIOD_MILLIS = 5000L;
 
 
     ConflictDetectionAlgorithm(String name,
@@ -28,14 +33,16 @@ class ConflictDetectionAlgorithm {
                                long timeout,
                                boolean interprocedural = false,
                                long depthLimit = 5,
-                               String callgraph = "SPARK") {
+                               String callgraph = "SPARK",
+                               boolean partialResultsOnTimeout = false) {
         this.name = name
         this.mode = mode
         this.sootWrapper = sootWrapper
         this.timeout = timeout
         this.interprocedural = interprocedural
         this.depthLimit = depthLimit
         this.callgraph = callgraph
+        this.partialResultsOnTimeout = partialResultsOnTimeout
     }
 
     String getMode() {
@@ -54,6 +61,10 @@ class ConflictDetectionAlgorithm {
         return interprocedural
     }
 
+    void setPartialResultsOnTimeout(boolean partialResultsOnTimeout) {
+        this.partialResultsOnTimeout = partialResultsOnTimeout
+    }
+
     @Override
     String toString() {
         return "ConflictDetectionAlgorithm{" +
@@ -97,7 +108,10 @@ class ConflictDetectionAlgorithm {
 
 
     protected String runAndReportResult(SootConfig sootConfig) throws InterruptedException, IOException {
-        String result;
+        // AtomicReference allows the output thread to safely publish its result to the main thread
+        // Default is "false": if timeout fires before any [CONFLICT_FOUND] is seen, we record false
+        AtomicReference<String> atomicResult = new AtomicReference<>("false")
+
         println "Using jar at " + sootConfig.getClassPath()
 
         File inputFile = new File(sootConfig.getInputFilePath());
@@ -108,51 +122,57 @@ class ConflictDetectionAlgorithm {
 
         Process sootProcess = sootWrapper.executeSoot(sootConfig);
 
-        // this is needed because if th waitFor command is called without reading the output
-        // in some executions the output buffer might get full and block the process
-        // so we execute both the output reading and the process waiting in parallel
+        // Reading output and waiting for process must run in parallel to avoid blocking
+        // when the output buffer fills up before the process finishes
         Thread processOutputThread = new Thread(new Runnable() {
             @Override
             void run() {
-                result = hasSootFlow(sootProcess);
+                atomicResult.set(hasSootFlow(sootProcess));
             }
         })
-        processOutputThread.start(); // start processing the output
+        processOutputThread.start();
 
         boolean executionCompleted = true;
         if (timeout > 0) {
-            // wait for the execution to end setting a timeout
             executionCompleted = sootProcess.waitFor(timeout, TimeUnit.SECONDS)
         }
 
-        // if the timeout has been reached
         if (!executionCompleted) {
-            processOutputThread.interrupt(); // cancel the output reading thread
-            print ("Execution exceeded the timeout of " + timeout + " seconds")
-            result = "timeout";
-        } else {
-            processOutputThread.join();
+            println "Execution exceeded the timeout of ${timeout} seconds"
+            // Destroy the process first so its output stream closes, allowing the reader thread to exit
+            sootProcess.destroy();
+
+            if (partialResultsOnTimeout) {
+                // Wait for the reader thread to finish consuming any buffered output that was
+                // already in the pipe before the process was destroyed
+                processOutputThread.join(GRACE_PERIOD_MILLIS)
+                String partial = atomicResult.get()
+                println "Result at timeout: ${partial}"
+                return partial
+            } else {
+                processOutputThread.interrupt();
+            }
+            return "timeout";
         }
 
-
-        // force destroy process
-        // if we don't use this command some processes will keep running and consuming a lot of memory
-        // even after the analysis execution ends
+        processOutputThread.join();
+        // Force destroy to prevent zombie processes that keep consuming memory
         sootProcess.destroy();
 
-        return result;
+        return atomicResult.get();
     }
 
     private String hasSootFlow(Process sootProcess) {
-        String result = "error"
-
-        sootProcess.getInputStream().eachLine {
-            println it;
-            if (it.stripIndent().startsWith("Number of conflicts:")) {
-                result = "true"
-            } else if (it.stripIndent() == "No conflicts detected") {
-                result = "false"
+        String result = "false"
+        try {
+            sootProcess.getInputStream().eachLine {
+                println it;
+                if (it.stripIndent() == "[CONFLICT_FOUND]") {
+                    result = "true"
+                }
             }
+        } catch (IOException ignored) {
+            // Stream closed because the process was destroyed (timeout case) — return whatever was found so far
         }
         return result
     }

src/main/services/outputProcessors/soot/Main.groovy

@@ -40,6 +40,10 @@ class Main {
                     sootRunner.setDetectionAlgorithms(configureDetectionAlgorithms(appArguments, sootWrapper))
                 }
 
+                if (appArguments.getPartialResultsOnTimeout()) {
+                    sootRunner.configurePartialResultsOnTimeout(true)
+                }
+
                 sootRunner.executeAnalyses(outputPath)
 
                 if (appArguments.isReport()) {

src/main/services/outputProcessors/soot/RunSootAnalysisOutputProcessor.groovy

@@ -66,9 +66,18 @@ class RunSootAnalysisOutputProcessor implements OutputProcessor {
         }
     }
 
+    void configurePartialResultsOnTimeout(boolean partialResultsOnTimeout) {
+        for (ConflictDetectionAlgorithm algorithm : detectionAlgorithms) {
+            algorithm.setPartialResultsOnTimeout(partialResultsOnTimeout);
+        }
+    }
+
     void processOutput() {
         // check if file generated by FetchBuildsOutputProcessor exists
         println "Executing RunSootAnalysisOutputProcessor"
+        if (arguments.isPartialResultsOnTimeout()) {
+            configurePartialResultsOnTimeout(true)
+        }
         executeAnalyses(arguments.getOutputPath())
     }
 

src/main/services/outputProcessors/soot/arguments/ArgsParser.groovy

@@ -38,6 +38,7 @@ class ArgsParser {
         this.cli.report(longOpt: 'report',  "Run report results for experiment using -icf -ioa -idfp -pdg")
         this.cli.r(longOpt: 'reachability',  "Run reachability")
         this.cli.cg(longOpt: 'callgraph', args: 1, argName: 'algorithm', "Call graph algorithm [CHA, RTA, VTA, SPARK]")
+        this.cli.prt(longOpt: 'partial-results-on-timeout', "When a soot analysis times out, capture and record the partial results found up to that point instead of discarding them")
     }
 
     Arguments parse(args) {
@@ -125,5 +126,8 @@ class ArgsParser {
             }
             args.setCallgraph(algorithm)
         }
+        if (this.options.prt) {
+            args.setPartialResultsOnTimeout(true)
+        }
     }
 }

src/main/services/outputProcessors/soot/arguments/Arguments.groovy

@@ -24,6 +24,7 @@ class Arguments {
     private long depthLimit
     private boolean printDepthSVFA
     private String callgraph
+    private boolean partialResultsOnTimeout
 
     Arguments() { // set the default values for all parameters
         isHelp = false
@@ -49,6 +50,7 @@ class Arguments {
         printDepthSVFA = false
         depthLimit = 5
         callgraph = "SPARK"
+        partialResultsOnTimeout = false
     }
 
     boolean getOaIntraWithoutPA() {
@@ -234,4 +236,12 @@ class Arguments {
     void setCallgraph(String callgraph) {
         this.callgraph = callgraph
     }
+
+    boolean getPartialResultsOnTimeout() {
+        return partialResultsOnTimeout
+    }
+
+    void setPartialResultsOnTimeout(boolean partialResultsOnTimeout) {
+        this.partialResultsOnTimeout = partialResultsOnTimeout
+    }
 }