Allow running 23.11-MR2-chopin with launchers

Author: liufengyun

compiler/ci/ci_common/benchmark-suites.libsonnet

@@ -41,7 +41,7 @@
     run+: [
       self.benchmark_cmd + ["dacapo:*", "--"] + self.extra_vm_args
     ],
-    timelimit: "50:00",
+    timelimit: "1:30:00",
     forks_batches:: 2,
     bench_forks_per_batch:: 3,
     forks_timelimit:: "3:00:00",

compiler/ci/ci_common/gate.jsonnet

@@ -59,6 +59,9 @@
     logs+: [
         "*/gcutils_heapdump_*.hprof.gz",
     ],
+    catch_files+: [
+      "Report is located at: (?P<filename>.+\\.txt)"
+    ],
     targets: ["gate"],
     python_version: "3"
   },

compiler/mx.compiler/mx_compiler.py

@@ -425,11 +425,25 @@ def _gate_dacapo(name, iterations, extraVMarguments=None, force_serial_gc=True,
         return
     vmargs = ['-XX:+UseSerialGC'] if force_serial_gc else []
     vmargs += ['-Xmx8g', '-XX:-UseCompressedOops', '-Djava.net.preferIPv4Stack=true'] + _compiler_error_options() + _remove_empty_entries(extraVMarguments, filter_gcs=force_serial_gc)
-    args = ['-n', str(iterations), '--preserve']
+    scratch_dir = os.path.abspath("./scratch")
+    args = ['-n', str(iterations), '--preserve', '--scratch-directory', scratch_dir]
+
+    # pmd validation fails on Windows, see official dacapobench issue #165
+    if name == 'pmd':
+        args += ['--no-validation']
+
     if threads is not None:
         args += ['-t', str(threads)]
-    return _run_benchmark('dacapo', name, args, vmargs)
 
+    # catch `*-report.txt` if the benchmark fails
+    try:
+        return _run_benchmark('dacapo', name, args, vmargs)
+    except BaseException as e:
+        file = os.path.join(scratch_dir, f"{name}-report.txt")
+        # not all benchmarks produce a report file
+        if os.path.isfile(file):
+            print("Report is located at: " + file)
+        raise e
 
 def jdk_includes_corba(jdk):
     # corba has been removed since JDK11 (http://openjdk.java.net/jeps/320)

sdk/mx.sdk/mx_sdk_benchmark.py

@@ -296,19 +296,35 @@ def postprocessRunArgs(self, benchname, runArgs):
                 iterations = iterations + int(self.getExtraIterationCount(iterations) * args.sf)
                 return ["-n", str(iterations)] + otherArgs
 
+    def jarPath(self, benchmark):
+        if self.version() == "23.11-MR2-chopin":
+            return os.path.join(self.dataLocation(), "launchers", benchmark + ".jar")
+        else:
+            return self.daCapoPath()
+
+    # The directory that contains `stats`, `launchers`, `dat` and `jar`
+    def dataLocation(self):
+        if self.version() == "23.11-MR2-chopin":
+            basePath = self.daCapoPath()
+            return os.path.join(basePath, "dacapo-23.11-MR2-chopin")
+        else:
+            raise "data location is only supported for version 23.11-MR2-chopin"
+
     def createCommandLineArgs(self, benchmarks, bmSuiteArgs):
         if benchmarks is None:
             raise RuntimeError(
                 "Suite runs only a single benchmark.")
         if len(benchmarks) != 1:
             raise RuntimeError(
                 "Suite runs only a single benchmark, got: {0}".format(benchmarks))
-        runArgs = self.postprocessRunArgs(benchmarks[0], self.runArgs(bmSuiteArgs))
+
+        benchmark = benchmarks[0]
+        runArgs = self.postprocessRunArgs(benchmark, self.runArgs(bmSuiteArgs))
         if runArgs is None:
             return None
-        return (
-                self.vmArgs(bmSuiteArgs) + ["-jar"] + [self.daCapoPath()] +
-                [benchmarks[0]] + runArgs)
+
+        jarPath = self.jarPath(benchmark)
+        return self.vmArgs(bmSuiteArgs) + ["-jar"] + [jarPath, benchmark] + runArgs
 
     def benchmarkList(self, bmSuiteArgs):
         missing_sizes = set(self.daCapoIterations().keys()).difference(set(self.daCapoSizes().keys()))
@@ -455,7 +471,7 @@ def defaultSuiteVersion(self):
         return self.availableSuiteVersions()[-1]
 
     def availableSuiteVersions(self):
-        return ["9.12-bach", "9.12-MR1-bach", "9.12-MR1-git+2baec49"]
+        return ["9.12-bach", "9.12-MR1-bach", "9.12-MR1-git+2baec49", "23.11-MR2-chopin"]
 
     def workloadSize(self):
         return "default"
@@ -470,6 +486,8 @@ def daCapoLibraryName(self):
             return "DACAPO_MR1_BACH"
         elif self.version() == "9.12-MR1-git+2baec49":  # commit from July 2018
             return "DACAPO_MR1_2baec49"
+        elif self.version() == "23.11-MR2-chopin":
+            return "DACAPO_23.11_MR2_chopin"
         else:
             return None
 

sdk/mx.sdk/suite.py

@@ -301,6 +301,12 @@
       "digest" : "sha512:3707b0aee8b1f53828832a85d118981c9b0919c7c1f26dc86fd368d8092857a0b5b75cb5427fee791b0ea89bb7b60a66e2130f55a037c8b082235d3035d9e9cf",
     },
 
+    "DACAPO_23.11_MR2_chopin" : {
+      "urls" : ["https://lafo.ssw.uni-linz.ac.at/pub/graal-external-deps/dacapo-23.11-MR2-chopin.zip"],
+      "digest" : "sha512:1399c9a743d4a52202372d7a5acef7e5d90181b79194484056cb716ba0284224c9bd7a7620b6db3a7a3c4ccdb8427ee4843fca4d23e37c0b13ada6ce9f041b6f",
+      "packedResource": True,
+    },
+
     "DACAPO_SCALA" : {
       "urls" : ["https://lafo.ssw.uni-linz.ac.at/pub/graal-external-deps/dacapo-scala-0.1.0-20120216.jar"],
       "digest" : "sha512:9a3908f3a0f2937bbc7edcd78f7e7e229bea8dee566d5f2d922bd4dc3c5b02cf97de294e479200372ff90bfbdf80e88dc7fc9fda9cb294088346e4a5ff28893e",

substratevm/mx.substratevm/mx_substratevm_benchmark.py

@@ -572,10 +572,19 @@ def _empty_file():
     # 2. Native-image picks a different service provider than the JVM for javax.xml.transform.TransformerFactory.
     #    We can simply remove the jar containing that provider as it is not required for the benchmark to run.
     'fop':      [f"-Djava.util.logging.config.file={_empty_file()}",
-                 '--initialize-at-run-time=org.apache.fop.render.rtf.rtflib.rtfdoc.RtfList'],
+                 '--initialize-at-run-time=org.apache.fop.render.rtf.rtflib.rtfdoc.RtfList',
+                 '-H:+ForeignAPISupport'],
     'batik':    []
 }
 
+_DACAPO_EXTRA_IMAGE_RUN_ARGS = {
+    'pmd':         ['--no-validation'],
+    # JDK21 ForeignAPISupport is broken --- disable `enableMemorySegments` for now
+    'lusearch':    ['-Dorg.apache.lucene.store.MMapDirectory.enableMemorySegments=false', '--no-validation'],
+    'luindex':     ['-Dorg.apache.lucene.store.MMapDirectory.enableMemorySegments=false', '--no-validation'],
+    'fop':         ['-Djava.home=' + os.environ['JAVA_HOME']]
+}
+
 '''
 Benchmarks from DaCapo suite may require one or more zip archives from `dat` directory on the classpath.
 After the agent run we have all necessary resources (from `jar` and `dat` folders inside DaCapo fat jar).
@@ -642,15 +651,18 @@ def daCapoPath(self):
         return None
 
     def availableSuiteVersions(self):
-        # This version also ships a custom harness class to allow native image to find the entry point in the nested jar
-        return ["9.12-MR1-git+2baec49"]
+        # The version 9.12-MR1-git+2baec49 also ships a custom harness class to allow native image to find the entry point in the nested jar
+        return ["9.12-MR1-git+2baec49", "23.11-MR2-chopin"]
 
     def daCapoIterations(self):
         compiler_iterations = super(DaCapoNativeImageBenchmarkSuite, self).daCapoIterations()
         return {key: _daCapo_iterations[key] for key in compiler_iterations.keys() if key in _daCapo_iterations.keys()}
 
     def benchmark_resources(self, benchmark):
-        return _dacapo_resources[benchmark]
+        if self.version() == "23.11-MR2-chopin":
+            return []
+        else:
+            return _dacapo_resources[benchmark]
 
     def run(self, benchmarks, bmSuiteArgs) -> mx_benchmark.DataPoints:
         return self.intercept_run(super(), benchmarks, bmSuiteArgs)
@@ -661,13 +673,43 @@ def extra_agent_run_arg(self, benchmark, args, image_run_args):
         return ['-n', '1'] + mx_sdk_benchmark.strip_args_with_number('-n', user_args)
 
     def extra_profile_run_arg(self, benchmark, args, image_run_args, should_strip_run_args):
-        user_args = super(DaCapoNativeImageBenchmarkSuite, self).extra_profile_run_arg(benchmark, args, image_run_args, should_strip_run_args)
+        self.fixDataLocation()
+        user_args = ["-Duser.home=" + str(Path.home())]
+        user_args += super(DaCapoNativeImageBenchmarkSuite, self).extra_profile_run_arg(benchmark, args, image_run_args, should_strip_run_args)
+
+        if benchmark in _DACAPO_EXTRA_IMAGE_RUN_ARGS:
+            user_args = user_args + _DACAPO_EXTRA_IMAGE_RUN_ARGS[benchmark]
+
         # remove -n X argument from image run args
         if should_strip_run_args:
             return ['-n', '1'] + mx_sdk_benchmark.strip_args_with_number('-n', user_args)
         else:
             return user_args
 
+    def fixDataLocation(self):
+        if self.version() == "23.11-MR2-chopin":
+            print("Fixing data location...")
+            # DaCapo can get data location either from the JAR path or "~/.dacapo-config.properties"
+            # See official dacapobench issue #341
+            dataLocation = self.dataLocation()
+            configFilePath = os.path.join(Path.home(), ".dacapo-config.properties")
+            with open(configFilePath, "w") as config:
+                config.write(f"Data-Location={dataLocation}\n")
+
+            with open(configFilePath) as f:
+                print("Reading " + configFilePath + ":")
+                print("------")
+                print(f.read())
+                print("------")
+
+    def extra_run_arg(self, benchmark, args, image_run_args):
+        self.fixDataLocation()
+        run_args = ["-Duser.home=" + str(Path.home())]
+        run_args += super(DaCapoNativeImageBenchmarkSuite, self).extra_run_arg(benchmark, args, image_run_args)
+        if benchmark in _DACAPO_EXTRA_IMAGE_RUN_ARGS:
+            run_args = run_args + _DACAPO_EXTRA_IMAGE_RUN_ARGS[benchmark]
+        return run_args
+
     def skip_agent_assertions(self, benchmark, args):
         default_args = _DACAPO_SKIP_AGENT_ASSERTIONS[benchmark] if benchmark in _DACAPO_SKIP_AGENT_ASSERTIONS else []
         user_args = super(DaCapoNativeImageBenchmarkSuite, self).skip_agent_assertions(benchmark, args)
@@ -688,15 +730,20 @@ def createCommandLineArgs(self, benchmarks, bmSuiteArgs):
         else:
             self.benchmark_name = benchmarks[0]
 
-        run_args = self.postprocessRunArgs(self.benchmarkName(), self.runArgs(bmSuiteArgs))
+        benchmark = benchmarks[0]
+
+        run_args = self.postprocessRunArgs(benchmark, self.runArgs(bmSuiteArgs))
         vm_args = self.vmArgs(bmSuiteArgs)
-        return ['-cp', self.create_classpath(self.benchmarkName())] + vm_args + ['-jar', self.daCapoPath()] + [self.benchmarkName()] + run_args
+        return self.create_classpath(benchmark) + vm_args + ['-jar', self.jarPath(benchmark)] + [benchmark] + run_args
 
     def create_classpath(self, benchmark):
-        dacapo_extracted, dacapo_dat_resources, dacapo_nested_resources = self.create_dacapo_classpath(self.daCapoPath(), benchmark)
-        dacapo_jars = super(DaCapoNativeImageBenchmarkSuite, self).collect_unique_dependencies(os.path.join(dacapo_extracted, 'jar'), benchmark, _daCapo_exclude_lib)
-        cp = ':'.join([dacapo_extracted] + dacapo_jars + dacapo_dat_resources + dacapo_nested_resources)
-        return cp
+        if self.version() == "9.12-MR1-git+2baec49":
+            dacapo_extracted, dacapo_dat_resources, dacapo_nested_resources = self.create_dacapo_classpath(self.daCapoPath(), benchmark)
+            dacapo_jars = super(DaCapoNativeImageBenchmarkSuite, self).collect_unique_dependencies(os.path.join(dacapo_extracted, 'jar'), benchmark, _daCapo_exclude_lib)
+            cp = ':'.join([dacapo_extracted] + dacapo_jars + dacapo_dat_resources + dacapo_nested_resources)
+            return ["-cp", cp]
+        else:
+            return []
 
     def successPatterns(self):
         return super().successPatterns() + SUCCESSFUL_STAGE_PATTERNS