[sil-bug-reducer] Make the output more explicit about the final file, passes, and given a full command line to reproduce.

Author: gottesmm

utils/bug_reducer/bug_reducer/bug_reducer_utils.py

@@ -66,6 +66,7 @@ def maybe_abspath(x):
         return x
     return os.path.abspath(x)
 
+
 class SILOptInvoker(object):
 
     def __init__(self, args, tools, early_passes, extra_args):
@@ -89,15 +90,15 @@ def __init__(self, args, tools, early_passes, extra_args):
 
         # First emit an initial *.sib file. This ensures no matter if we have a
         # *.swiftmodule, *.sil, or *.sib file, we are always using *.sib.
-        self._invoke(args.input_file, self.get_suffixed_filename('initial'),
-                     [])
+        self._invoke(args.input_file, [],
+                     self.get_suffixed_filename('initial'))
         self.input_file = self.get_suffixed_filename('initial+early')
 
         # Finally, run the initial sil-opt invocation running the
         # early-passes. We will not run them again.
         self._invoke(self.get_suffixed_filename('initial'),
-                     self.input_file,
-                     early_passes)
+                     early_passes,
+                     self.input_file)
 
     def get_suffixed_filename(self, suffix):
         basename = self.base_input_file_stem + '_' + suffix
@@ -119,17 +120,22 @@ def base_args(self):
             x.append("-module-name=%s" % self.module_name)
         return x
 
-    def _invoke(self, input_file, output_file, passes):
+    def _cmdline(self, input_file, passes, output_file='-'):
         base_args = self.base_args
-        base_args.extend([
-            input_file,
-            '-o', output_file])
+        base_args.extend([input_file, '-o', output_file])
         base_args.extend(self.extra_args)
         base_args.extend(passes)
-        return br_call(base_args)
+        return base_args
+
+    def _invoke(self, input_file, passes, output_filename):
+        cmdline = self._cmdline(input_file, passes, output_filename)
+        return br_call(cmdline)
+
+    def invoke_with_passlist(self, passes, output_filename):
+        return self._invoke(self.input_file, passes, output_filename)
 
-    def invoke_with_passlist(self, output_filename, passes):
-        return self._invoke(self.input_file, output_filename, passes)
+    def cmdline_with_passlist(self, passes):
+        return self._cmdline(self.input_file, passes)
 
 
 def get_silopt_invoker(args):

utils/bug_reducer/bug_reducer/opt_bug_reducer.py

@@ -25,8 +25,8 @@ def run_test(self, prefix, suffix):
         print("Checking to see if '%s' compiles correctly" % suffix_joined)
 
         result = self.invoker.invoke_with_passlist(
-            self.invoker.get_suffixed_filename(suffix_hash),
-            suffix)
+            suffix,
+            self.invoker.get_suffixed_filename(suffix_hash))
 
         # Found a miscompile! Keep the suffix
         if result != 0:
@@ -51,8 +51,8 @@ def run_test(self, prefix, suffix):
         # passes.
         prefix_path = self.invoker.get_suffixed_filename(prefix_hash)
         result = self.invoker.invoke_with_passlist(
-            prefix_path,
-            prefix)
+            prefix,
+            prefix_path)
         if result != 0:
             print("Prefix maintains the predicate by itself. Returning keep "
                   "prefix")
@@ -71,8 +71,8 @@ def run_test(self, prefix, suffix):
         print("Checking to see if '%s' compiles correctly after the '%s' "
               "passes" % (suffix_joined, prefix_joined))
         result = self.invoker.invoke_with_passlist(
-            self.invoker.get_suffixed_filename(suffix_hash),
-            suffix)
+            suffix,
+            self.invoker.get_suffixed_filename(suffix_hash))
 
         # If we failed at this point, then the prefix is our new
         # baseline. Return keep suffix.
@@ -117,7 +117,7 @@ def pass_bug_reducer(args):
 
     # Make sure that the base case /does/ crash.
     filename = sil_opt_invoker.get_suffixed_filename('base_case')
-    result = sil_opt_invoker.invoke_with_passlist(filename, passes)
+    result = sil_opt_invoker.invoke_with_passlist(passes, filename)
     # If we succeed, there is no further work to do.
     if result == 0:
         print("Success with PassList: %s" % (' '.join(passes)))
@@ -127,7 +127,11 @@ def pass_bug_reducer(args):
     r = ReduceMiscompilingPasses(passes, sil_opt_invoker)
     if not r.reduce_list():
         print("Failed to find miscompiling pass list!")
-    print("Found miscompiling passes: %s" % (' '.join(r.target_list)))
+    cmdline = sil_opt_invoker.cmdline_with_passlist(r.target_list)
+    print("*** Found miscompiling passes!")
+    print("*** Final File: %s" % sil_opt_invoker.input_file)
+    print("*** Final Passes: %s" % (' '.join(r.target_list)))
+    print("*** Repro command line: %s" % (' '.join(cmdline)))
 
 
 def add_parser_arguments(parser):

utils/bug_reducer/bug_reducer/random_bug_finder.py

@@ -38,7 +38,7 @@ def random_bug_finder(args):
         print("Running round %i/%i" % (count, max_count))
         random.shuffle(passes)
         filename = sil_opt_invoker.get_suffixed_filename(str(count))
-        result = sil_opt_invoker.invoke_with_passlist(filename, passes)
+        result = sil_opt_invoker.invoke_with_passlist(passes, filename)
         if result == 0:
             print("Success with PassList: %s" % (' '.join(passes)))
         else:

utils/bug_reducer/tests/test_optbugreducer.py

@@ -96,8 +96,10 @@ def test_basic(self):
         ]
         args.extend(self.passes)
         output = subprocess.check_output(args).split("\n")
-        success_message = 'Found miscompiling passes: --bug-reducer-tester'
-        self.assertTrue(success_message in output)
+        success_messages = ['*** Found miscompiling passes!',
+                            '*** Final Passes: --bug-reducer-tester']
+        for msg in success_messages:
+            self.assertTrue(msg in output)
 
 if __name__ == '__main__':
     unittest.main()