Merge pull request diffblue#241 from diffblue/feature/slicer_integration

smowton · web-flow · commit 706d19f2e529 · 2017-10-27T15:34:13.000+01:00
SEC-41 : Integration of the 'full-slicer' into the pipe-line (tools-chain).
diff --git a/benchmarks/TRAINING/diffblue/taint_traces_01_evaluator.json b/benchmarks/TRAINING/diffblue/taint_traces_01_evaluator.json
@@ -25,7 +25,7 @@
                             },
                         "file": "Main.java",
                         "function": "java::Main.bug:(I)V",
-                        "goto_binary_file": "program_slicing/instrumented_goto_program_0.gbf",
+                        "goto_binary_file": "program_slicing/sliced_goto_program_0.gbf",
                         "line": 84
                     }
                 ]
diff --git a/benchmarks/TRAINING/diffblue/taint_traces_04_evaluator.json b/benchmarks/TRAINING/diffblue/taint_traces_04_evaluator.json
@@ -23,7 +23,7 @@
                         }, 
                         "file": "Main.java", 
                         "function": "java::Main.baz0:()V", 
-                        "goto_binary_file": "program_slicing/instrumented_goto_program_0.gbf", 
+                        "goto_binary_file": "program_slicing/sliced_goto_program_0.gbf", 
                         "line": 19
                     }, 
                     {
@@ -35,7 +35,7 @@
                         }, 
                         "file": "Main.java", 
                         "function": "java::Main.baz1:()V", 
-                        "goto_binary_file": "program_slicing/instrumented_goto_program_1.gbf", 
+                        "goto_binary_file": "program_slicing/sliced_goto_program_1.gbf", 
                         "line": 26
                     }, 
                     {
@@ -47,7 +47,7 @@
                         }, 
                         "file": "Main.java", 
                         "function": "java::Main.baz2:(LOther;)V", 
-                        "goto_binary_file": "program_slicing/instrumented_goto_program_2.gbf", 
+                        "goto_binary_file": "program_slicing/sliced_goto_program_2.gbf", 
                         "line": 32
                     }
                 ]
diff --git a/benchmarks/TRAINING/diffblue/taint_traces_05_evaluator.json b/benchmarks/TRAINING/diffblue/taint_traces_05_evaluator.json
@@ -23,7 +23,7 @@
                         }, 
                         "file": "DummyAssignmentSubmissionEdit.java", 
                         "function": "java::DummyAssignmentSubmissionEdit.setSubmittedText:(Ljava/lang/String;)V", 
-                        "goto_binary_file": "program_slicing/instrumented_goto_program_0.gbf", 
+                        "goto_binary_file": "program_slicing/sliced_goto_program_0.gbf", 
                         "line": 3
                     }
                 ]
diff --git a/benchmarks/TRAINING/diffblue/taint_traces_06_evaluator.json b/benchmarks/TRAINING/diffblue/taint_traces_06_evaluator.json
@@ -23,7 +23,7 @@
                         }, 
                         "file": "taint_test/test.java", 
                         "function": "java::taint_test.test.doGet:(Ljavax/servlet/http/HttpServletRequest;Ljavax/servlet/http/HttpServletResponse;)V", 
-                        "goto_binary_file": "program_slicing/instrumented_goto_program_0.gbf", 
+                        "goto_binary_file": "program_slicing/sliced_goto_program_0.gbf", 
                         "line": 143
                     }, 
                     {
@@ -35,7 +35,7 @@
                         }, 
                         "file": "taint_test/test.java", 
                         "function": "java::taint_test.test.doGet:(Ljavax/servlet/http/HttpServletRequest;Ljavax/servlet/http/HttpServletResponse;)V", 
-                        "goto_binary_file": "program_slicing/instrumented_goto_program_0.gbf", 
+                        "goto_binary_file": "program_slicing/sliced_goto_program_0.gbf", 
                         "line": 165
                     }
                 ]
diff --git a/benchmarks/TRAINING/diffblue/taint_traces_07_evaluator.json b/benchmarks/TRAINING/diffblue/taint_traces_07_evaluator.json
@@ -23,7 +23,7 @@
                         }, 
                         "file": "training07/test.java", 
                         "function": "java::training07.test.doGet:(Ltraining07/HttpServletRequest;Ltraining07/HttpServletResponse;)V", 
-                        "goto_binary_file": "program_slicing/instrumented_goto_program_0.gbf", 
+                        "goto_binary_file": "program_slicing/sliced_goto_program_0.gbf", 
                         "line": 109
                     }
                 ]
diff --git a/driver/analyser.py b/driver/analyser.py
@@ -2,6 +2,7 @@
 import time
 import json
 import utility
+#import shutil
 
 
 def __get_my_dir(): return os.path.dirname(os.path.realpath(__file__))
@@ -122,7 +123,8 @@ def run_program_slicing(
         json_cfg_fname,
         results_dir,
         timeout,
-        verbosity
+        verbosity,
+        dump_html_slice
         ):
     prof = {"calling_slicer": []}
     prof_start_time = time.time()
@@ -135,30 +137,53 @@ def run_program_slicing(
         src_plain_fname = os.path.splitext(os.path.basename(cfg["goto_binary_file"]))[0]
         src_idx_name = int(src_plain_fname[src_plain_fname.rfind("_")+1:])
         dst_goto_program_fname = os.path.join(results_dir, "sliced_goto_program_" + str(src_idx_name) + ".gbf")
+        dst_goto_stats_fname = os.path.join(results_dir, "sliced_goto_program_" + str(src_idx_name) + ".stats.json")
 
         command = (
             get_goto_instrument_pathname() + " " +
             "--full-slice " +
             "--verbosity " + str(1) + " " +
             cfg["goto_binary_file"] + " " +
-            "-o " + dst_goto_program_fname
+            dst_goto_program_fname + " " +
+            "--full-slice " +
+            "--verbosity " + str(verbosity) + " " +
+            "--save-code-statistics " + dst_goto_stats_fname
             )
         prof_calling_goto_instrument_start_time = time.time()
         print("Invoking 'goto-instrument' ...")
         with utility.PushCwd(results_dir) as cwd:
             if verbosity >= 9:
                 print("CWD: " + cwd.get())
                 print("CMD: " + command)
-            # TODO: Uncomment the next line when the slicer is functional!
-            # os.system(command)
+            os.system(command)
+            #shutil.copy(cfg["goto_binary_file"], dst_goto_program_fname)
+
         prof["calling_slicer"].append({
             "gbf_idx": src_idx_name,
             "duration": time.time() - prof_calling_goto_instrument_start_time
             })
 
         result.append(cfg.copy())
-        # TODO: Uncomment the next line when the slicer is functional!
-        # result[-1]["goto_binary_file"] = dst_goto_program_fname
+        result[-1]["goto_binary_file"] = dst_goto_program_fname
+
+        if dump_html_slice:
+            command = (
+                get_security_analyser_pathname() + " " +
+                dst_goto_program_fname + " " +
+                "--dump-html-program " +
+                "'" +
+                os.path.join(
+                    results_dir,
+                    "HTML_dump_of_sliced_GOTO_programs",
+                    os.path.splitext(os.path.basename(dst_goto_program_fname))[0]
+                    ) +
+                "'"
+                )
+            with utility.PushCwd(results_dir) as cwd:
+                if verbosity >= 9:
+                    print("CWD: " + cwd.get())
+                    print("CMD: " + command)
+                os.system(command)
 
     with open(os.path.join(results_dir, "sliced_goto_programs.json"), "w") as results_json:
         results_json.write(json.dumps(result, sort_keys=False, indent=4))
diff --git a/driver/presentation.py b/driver/presentation.py
@@ -349,6 +349,146 @@ def build_HTML_interface_to_slicing_tasks(root_dir,sub_dir,ofile):
     return len(instrumented_goto_programs)
 
 
+def build_HTML_interface_to_the_slicer(root_dir,sub_dir,ofile):
+    full_sub_dir=os.path.join(root_dir, sub_dir)
+    if not os.path.exists(full_sub_dir):
+        os.makedirs(full_sub_dir)
+    with open(os.path.join(full_sub_dir, "instrumented_goto_programs.json")) as json_file:
+        cfgs = json.load(json_file)
+    if cfgs is None:
+        ofile.write("<p>ERROR: Reading of the JSON file '" +
+                    escape_text_to_HTML(os.path.join(full_sub_dir, "instrumented_goto_programs.json")) +
+                    "' has failed.</p>")
+        return
+    for cfg in cfgs:
+        src_plain_fname = os.path.splitext(os.path.basename(cfg["goto_binary_file"]))[0]
+        src_idx_name = int(src_plain_fname[src_plain_fname.rfind("_")+1:])
+        dst_goto_program_fname = os.path.join(os.path.dirname(cfg["goto_binary_file"]),
+                                              "sliced_goto_program_" + str(src_idx_name) + ".gbf")
+        src_goto_stats_fname = os.path.splitext(cfg["goto_binary_file"])[0] + ".stats.json"
+        dst_goto_stats_fname = os.path.join(os.path.dirname(cfg["goto_binary_file"]),
+                                            "sliced_goto_program_" + str(src_idx_name) + ".stats.json")
+        ofile.write("<table>\n"
+                    "<caption>Result #" + str(src_idx_name) + ".</caption>\n"
+                    "  <tr>\n"
+                    "    <th>Property</th>\n"
+                    "    <th>value</th>\n"
+                    "  </tr>\n")
+        ofile.write("  <tr>\n")
+        ofile.write("    <td>Original GOTO binary</td>\n")
+        ofile.write("    <td>" + cfg["goto_binary_file"] + "</td>\n")
+        ofile.write("  </tr>\n")
+        ofile.write("  <tr>\n")
+        ofile.write("    <td>Sliced GOTO binary</td>\n")
+        ofile.write("    <td>" + escape_text_to_HTML(dst_goto_program_fname) + "</td>\n")
+        ofile.write("  </tr>\n")
+        sliced_program_html_dump = os.path.join(
+            full_sub_dir,
+            "HTML_dump_of_sliced_GOTO_programs",
+            "sliced_goto_program_" + str(src_idx_name),
+            "index.html"
+            )
+        if os.path.isfile(sliced_program_html_dump):
+            ofile.write("  <tr>\n")
+            ofile.write("    <td>Sliced GOTO program listing</td>\n")
+            ofile.write("    <td><a href=\"./" +
+                        os.path.relpath(sliced_program_html_dump, root_dir) +
+                        "\">here</a></td>\n")
+            ofile.write("  </tr>\n")
+
+        def load_stats(pathname):
+            if not os.path.isfile(pathname):
+                return None
+            with open(pathname, "r") as ifile:
+                return json.load(ifile)
+
+        def make_reduction_string(orig_value, reduced_value, add_percentage=True):
+            result = str(orig_value - reduced_value) + " (from " + str(orig_value)
+            if add_percentage:
+                percentage = 100 * (orig_value - reduced_value) / orig_value if orig_value != 0 else 0
+                result += "; " + "{:.1f}".format(percentage) + "%"
+            return result + ")"
+
+        src_stats = load_stats(src_goto_stats_fname)
+        dst_stats = load_stats(dst_goto_stats_fname)
+        stats_available = src_stats is not None and dst_stats is not None
+
+        ofile.write("  <tr>\n")
+        ofile.write("    <td>Reduced GOTO binary size [bytes]</td>\n")
+        ofile.write("    <td>" + (
+                    make_reduction_string(
+                        os.stat(cfg["goto_binary_file"]).st_size,
+                        os.stat(dst_goto_program_fname).st_size
+                        )
+                    if stats_available else "NOT AVAILABLE"
+                    ) + "</td>\n")
+        ofile.write("  </tr>\n")
+
+        ofile.write("  <tr>\n")
+        ofile.write("    <td>Removed functions</td>\n")
+        ofile.write("    <td>" + (
+                    make_reduction_string(src_stats["num_functions"], dst_stats["num_functions"])
+                    if stats_available else "NOT AVAILABLE"
+                    ) + "</td>\n")
+        ofile.write("  </tr>\n")
+        ofile.write("  <tr>\n")
+        ofile.write("    <td>Removed function calls</td>\n")
+        ofile.write("    <td>" + (
+                    make_reduction_string(src_stats["num_function_calls"], dst_stats["num_function_calls"])
+                    if stats_available else "NOT AVAILABLE"
+                    ) + "</td>\n")
+        ofile.write("  </tr>\n")
+        ofile.write("  <tr>\n")
+        ofile.write("    <td>Removed user variables</td>\n")
+        ofile.write("    <td>" + (
+                    make_reduction_string(src_stats["num_user_variables"], dst_stats["num_user_variables"])
+                    if stats_available else "NOT AVAILABLE"
+                    ) + "</td>\n")
+        ofile.write("  </tr>\n")
+        ofile.write("  <tr>\n")
+        ofile.write("    <td>Removed auxiliary variables</td>\n")
+        ofile.write("    <td>" + (
+                    make_reduction_string(src_stats["num_auxiliary_variables"], dst_stats["num_auxiliary_variables"])
+                    if stats_available else "NOT AVAILABLE"
+                    ) + "</td>\n")
+        ofile.write("  </tr>\n")
+        ofile.write("  <tr>\n")
+        ofile.write("    <td>Removed instructions</td>\n")
+        ofile.write("    <td>" + (
+                    make_reduction_string(src_stats["num_instructions"], dst_stats["num_instructions"])
+                    if stats_available else "NOT AVAILABLE"
+                    ) + "</td>\n")
+        ofile.write("  </tr>\n")
+        ofile.write("  <tr>\n")
+        ofile.write("    <td>Removed conditional jumps</td>\n")
+        ofile.write("    <td>" + (
+                    make_reduction_string(src_stats["num_conditional_gotos"], dst_stats["num_conditional_gotos"])
+                    if stats_available else "NOT AVAILABLE"
+                    ) + "</td>\n")
+        ofile.write("  </tr>\n")
+        ofile.write("  <tr>\n")
+        ofile.write("    <td>Removed unconditional jumps</td>\n")
+        ofile.write("    <td>" + (
+                    make_reduction_string(src_stats["num_unconditional_gotos"], dst_stats["num_unconditional_gotos"])
+                    if stats_available else "NOT AVAILABLE"
+                    ) + "</td>\n")
+        ofile.write("  </tr>\n")
+        ofile.write("  <tr>\n")
+        ofile.write("    <td>Removed loops</td>\n")
+        ofile.write("    <td>" + (
+                    make_reduction_string(src_stats["num_loops"], dst_stats["num_loops"])
+                    if stats_available else "NOT AVAILABLE"
+                    ) + "</td>\n")
+        ofile.write("  </tr>\n")
+        ofile.write("  <tr>\n")
+        ofile.write("    <td>Statistics in JSON</td>\n")
+        ofile.write("    <td><a href=\"./" +
+                    os.path.relpath(dst_goto_stats_fname, root_dir) +
+                    "\">here</a></td>\n")
+        ofile.write("  </tr>\n")
+        ofile.write("</table>\n")
+
+
 def build_HTML_interface_to_group_of_error_traces(traces,tool_name,tgt_file,tgt_line,ofile):
     ofile.write(get_html_prefix("Error traces " + tool_name))
 
@@ -698,7 +838,11 @@ def build_HTML_interface_to_results_and_statistics(
         if num_slicing_tasks == 0:
             ofile.write("<p>There was no slicing task generated.</p>\n")
         else:
-            ofile.write("<p>The slicer removes no code from now. We are waiting for Lucas'es PRs fixing the slicer.</p>\n")
+            build_HTML_interface_to_the_slicer(
+                cmdline.results_dir,
+                "program_slicing",
+                ofile
+                )
 
 
         #######################################################################################################
diff --git a/driver/run.py b/driver/run.py
@@ -128,7 +128,8 @@ def evaluate(cmdline):
         os.path.abspath(os.path.join(cmdline.results_dir,"program_slicing","instrumented_goto_programs.json")),
         os.path.abspath(os.path.join(cmdline.results_dir,"program_slicing")),
         cmdline.timeout,
-        cmdline.verbosity
+        cmdline.verbosity,
+        cmdline.dump_html_slice
         )
 
     print("Starting the search for error traces.")

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`	`},`
`26`	`26`	`"file": "Main.java",`
`27`	`27`	`"function": "java::Main.bug:(I)V",`
`28`		`- "goto_binary_file": "program_slicing/instrumented_goto_program_0.gbf",`
	`28`	`+ "goto_binary_file": "program_slicing/sliced_goto_program_0.gbf",`
`29`	`29`	`"line": 84`
`30`	`30`	`}`
`31`	`31`	`]`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`},`
`24`	`24`	`"file": "DummyAssignmentSubmissionEdit.java",`
`25`	`25`	`"function": "java::DummyAssignmentSubmissionEdit.setSubmittedText:(Ljava/lang/String;)V",`
`26`		`- "goto_binary_file": "program_slicing/instrumented_goto_program_0.gbf",`
	`26`	`+ "goto_binary_file": "program_slicing/sliced_goto_program_0.gbf",`
`27`	`27`	`"line": 3`
`28`	`28`	`}`
`29`	`29`	`]`
Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,8 @@ def evaluate(cmdline):`
`128`	`128`	`os.path.abspath(os.path.join(cmdline.results_dir,"program_slicing","instrumented_goto_programs.json")),`
`129`	`129`	`os.path.abspath(os.path.join(cmdline.results_dir,"program_slicing")),`
`130`	`130`	`cmdline.timeout,`
`131`		`- cmdline.verbosity`
	`131`	`+ cmdline.verbosity,`
	`132`	`+ cmdline.dump_html_slice`
`132`	`133`	`)`
`133`	`134`
`134`	`135`	`print("Starting the search for error traces.")`