[GR-38753] Benchmark bisect 'rerun with commands' feature.

PullRequest: graalpython/2266

Author: steve-s

bisect-benchmark.ini

@@ -27,6 +27,27 @@ build_command = mx --dy /compiler build
 # "-XX ..." list is not part of the command, that's already part of the output
 benchmark_command = mx --dy /compiler benchmark micro:try-except-simple
 
+# Once the good and bad commits are identified, the tool will run all the
+# following benchmark commands on both the good and bad revisions. One can
+# run the benchmarks again with some extra logging, IGV dumping, ...
+#
+# Individual commands can be separated by ';'. Trailing whitespace including
+# newlines is removed from the commands.
+#
+# The example commands below are good default that should provide good insight
+# into the regression at hand:
+#   * "--checkup" runs the benchmark with extra iterations, and extra compilation
+#       and GC logging
+#   * "--cpusampler" with delay of 10000ms (adjust if the whole benchmark command
+#       runs for less than that)
+#   * "--cputracer" and IGV dumping: they filter the roots with name "*measure*",
+#       adjust that to the benchmark main function(s)
+rerun_with_commands =
+    mx --dy /compiler benchmark micro:try-except-simple -- --checkup ;
+    mx --dy /compiler benchmark micro:try-except-simple -- --cpusampler --cpusampler.Delay=10000 ;
+    mx --dy /compiler benchmark micro:try-except-simple -- --cputracer --cputracer.TraceStatements --cputracer.FilterRootName=measure ;
+    mx --dy /compiler benchmark micro:try-except-simple -- --vm.Dgraal.Dump=Truffle:2 --vm.Dgraal.MethodFilter="*measure*"
+
 # The first known "bad" merge commit for bisection. Try to use long commit
 # SHAs, the CI cache has higher probability of short SHAs being ambiguous
 bad = 1234deadbeef

mx.graalpython/mx_graalpython_bisect.py

@@ -47,6 +47,10 @@
 import mx
 
 
+def print_line(l):
+    print('=' * l)
+
+
 def get_suite(name):
     suite_name = name.lstrip('/')
     suite = mx.suite(suite_name, fatalIfMissing=False)
@@ -186,13 +190,17 @@ def _bisect_benchmark(argv, bisect_id, email_to):
         args.benchmark_criterion = sec.get('benchmark_criterion', 'BEST')
         args.enterprise = sec.getboolean('enterprise', False)
         args.no_clean = sec.getboolean('no_clean', False)
+        args.rerun_with_commands = sec['rerun_with_commands']
     else:
         parser = argparse.ArgumentParser()
         parser.add_argument('bad', help="Bad commit for bisection")
         parser.add_argument('good', help="Good commit for bisection")
         parser.add_argument('build_command', help="Command to run in order to build the configuration")
         parser.add_argument('benchmark_command',
                             help="Command to run in order to run the benchmark. Output needs to be in mx's format")
+        parser.add_argument('--rerun-with-commands',
+                            help="Re-run the bad and good commits with this benchmark command(s) "
+                                 "(multiple commands separated by ';')")
         parser.add_argument('--benchmark-criterion', default='BEST',
                             help="Which result parameter should be used for comparisons")
         parser.add_argument('--enterprise', action='store_true', help="Whether to checkout graal-enterprise")
@@ -203,7 +211,7 @@ def _bisect_benchmark(argv, bisect_id, email_to):
 
     fetched_enterprise = [False]
 
-    def benchmark_callback(suite, commit):
+    def checkout_suite(suite, commit):
         suite.vc.update_to_branch(suite.vc_dir, commit)
         mx.run_mx(['sforceimports'], suite=suite)
         mx.run_mx(['--env', 'ce', 'sforceimports'], suite=get_suite('/vm'))
@@ -223,6 +231,9 @@ def benchmark_callback(suite, commit):
         if args.enterprise:
             debug_str += " graal-enterprise={}".format(get_commit(get_suite('/vm-enterprise')))
         print(debug_str)
+
+    def checkout_and_build_suite(suite, commit):
+        checkout_suite(suite, commit)
         build_command = shlex.split(args.build_command)
         if not args.no_clean:
             try:
@@ -235,8 +246,11 @@ def benchmark_callback(suite, commit):
         retcode = mx.run(build_command, nonZeroIsFatal=False)
         if retcode:
             raise RuntimeError("Failed to execute the build command for {}".format(commit))
+
+    def benchmark_callback(suite, commit, bench_command=args.benchmark_command):
+        checkout_and_build_suite(suite, commit)
         output = mx.OutputCapture()
-        retcode = mx.run(shlex.split(args.benchmark_command), out=mx.TeeOutputCapture(output), nonZeroIsFatal=False)
+        retcode = mx.run(shlex.split(bench_command), out=mx.TeeOutputCapture(output), nonZeroIsFatal=False)
         if retcode:
             if args.benchmark_criterion == 'WORKS':
                 return sys.maxsize
@@ -260,6 +274,28 @@ def benchmark_callback(suite, commit):
     print()
     print(summary)
 
+    if args.rerun_with_commands:
+        print('\n\nRerunning the good and bad commits with extra benchmark commands:')
+        current_result = result
+        current_suite = primary_suite
+        while current_result.subresults and current_result.bad_index in current_result.subresults:
+            downstream_suite = get_downstream_suite(current_suite)
+            next_result = current_result.subresults[current_result.bad_index]
+            if not next_result.good_commit or not next_result.bad_commit:
+                print("Next downstream suite {} does not have both good and bad commits".format(downstream_suite.name))
+                break
+            print("Recursing to downstream suite: {}, commit: {}".format(downstream_suite.name, current_result.bad_commit))
+            checkout_suite(current_suite, current_result.bad_commit)
+            current_result = next_result
+            current_suite = downstream_suite
+        for commit in [current_result.good_commit, current_result.bad_commit]:
+            print_line(80)
+            print("Commit: {}".format(commit))
+            checkout_and_build_suite(current_suite, commit)
+            for cmd in args.rerun_with_commands.split(";"):
+                print_line(40)
+                mx.run(shlex.split(cmd.strip()), nonZeroIsFatal=False)
+
     send_email(
         bisect_id,
         email_to,