Add option to run a workload twice with a shared engine

Author: bjfish

src/launcher/java/org/truffleruby/launcher/RubyLauncher.java

@@ -201,7 +201,30 @@ private int runRubyMain(Context.Builder contextBuilder, CommandLineOptions confi
             return 0;
         }
 
-        try (Context context = createContext(contextBuilder, config)) {
+        if (config.isGemOrBundle() && getImplementationNameFromEngine().contains("Graal")) {
+            // Apply options to run gem/bundle more efficiently
+            contextBuilder.option("engine.Mode", "latency");
+            if (Boolean.getBoolean("truffleruby.launcher.log")) {
+                System.err.println("[ruby] CONFIG: detected gem or bundle command, using --engine.Mode=latency");
+            }
+        }
+
+        contextBuilder.options(config.getOptions());
+
+        contextBuilder.arguments(TruffleRuby.LANGUAGE_ID, config.getArguments());
+
+        int result = runContext(contextBuilder, config);
+
+        final boolean runTwice = config.getUnknownArguments().contains("--run-twice=true");
+        if (runTwice) {
+            result = runContext(contextBuilder, config);
+        }
+
+        return result;
+    }
+
+    private int runContext(Context.Builder builder, CommandLineOptions config) {
+        try (Context context = builder.build()) {
             Metrics.printTime("before-run");
 
             if (config.executionAction == ExecutionAction.PATH) {
@@ -244,22 +267,6 @@ private int runRubyMain(Context.Builder contextBuilder, CommandLineOptions confi
         }
     }
 
-    private Context createContext(Context.Builder builder, CommandLineOptions config) {
-        if (config.isGemOrBundle() && getImplementationNameFromEngine().contains("Graal")) {
-            // Apply options to run gem/bundle more efficiently
-            builder.option("engine.Mode", "latency");
-            if (Boolean.getBoolean("truffleruby.launcher.log")) {
-                System.err.println("[ruby] CONFIG: detected gem or bundle command, using --engine.Mode=latency");
-            }
-        }
-
-        builder.options(config.getOptions());
-
-        builder.arguments(TruffleRuby.LANGUAGE_ID, config.getArguments());
-
-        return builder.build();
-    }
-
     private static List<String> getArgsFromEnvVariable(String name) {
         String value = System.getenv(name);
         if (value != null) {

src/main/java/org/truffleruby/options/Options.java

@@ -193,6 +193,8 @@ public class Options {
     public final boolean METRICS_TIME_REQUIRE;
     /** --testing-rubygems=false */
     public final boolean TESTING_RUBYGEMS;
+    /** --run-twice=false */
+    public final boolean RUN_TWICE;
     /** --compare-regex-engines=false */
     public final boolean COMPARE_REGEX_ENGINES;
 
@@ -282,6 +284,7 @@ public Options(Env env, OptionValues options, LanguageOptions languageOptions) {
         METRICS_TIME_PARSING_FILE = options.get(OptionsCatalog.METRICS_TIME_PARSING_FILE_KEY);
         METRICS_TIME_REQUIRE = options.get(OptionsCatalog.METRICS_TIME_REQUIRE_KEY);
         TESTING_RUBYGEMS = options.get(OptionsCatalog.TESTING_RUBYGEMS_KEY);
+        RUN_TWICE = options.get(OptionsCatalog.RUN_TWICE_KEY);
         COMPARE_REGEX_ENGINES = options.get(OptionsCatalog.COMPARE_REGEX_ENGINES_KEY);
     }
 
@@ -457,6 +460,8 @@ public Object fromDescriptor(OptionDescriptor descriptor) {
                 return METRICS_TIME_REQUIRE;
             case "ruby.testing-rubygems":
                 return TESTING_RUBYGEMS;
+            case "ruby.run-twice":
+                return RUN_TWICE;
             case "ruby.compare-regex-engines":
                 return COMPARE_REGEX_ENGINES;
             default:

src/options.yml

@@ -247,6 +247,7 @@ INTERNAL: # Options for debugging the TruffleRuby implementation
     # Options for testing
     TESTING_RUBYGEMS: [testing-rubygems, boolean, false, 'Indicates rubygems is being tested']
     EXPERIMENTAL_ENGINE_CACHING: [experimental-engine-caching, boolean, false, 'Enables experimental support for engine caching for TruffleRuby']
+    RUN_TWICE: [run-twice, boolean, false, 'Run a workload twice using a shared engine in the same process']
 
     # Options for the regular expression engines
     COMPARE_REGEX_ENGINES: [compare-regex-engines, boolean, false, 'Uses both Joni and the TRegex engine and compares their results']

src/shared/java/org/truffleruby/shared/options/OptionsCatalog.java

@@ -156,6 +156,7 @@ public class OptionsCatalog {
     public static final OptionKey<Boolean> SHARED_OBJECTS_FORCE_KEY = new OptionKey<>(false);
     public static final OptionKey<Boolean> TESTING_RUBYGEMS_KEY = new OptionKey<>(false);
     public static final OptionKey<Boolean> EXPERIMENTAL_ENGINE_CACHING_KEY = new OptionKey<>(false);
+    public static final OptionKey<Boolean> RUN_TWICE_KEY = new OptionKey<>(false);
     public static final OptionKey<Boolean> COMPARE_REGEX_ENGINES_KEY = new OptionKey<>(false);
 
     public static final OptionDescriptor LOAD_PATHS = OptionDescriptor
@@ -1110,6 +1111,13 @@ public class OptionsCatalog {
             .stability(OptionStability.EXPERIMENTAL)
             .build();
 
+    public static final OptionDescriptor RUN_TWICE = OptionDescriptor
+            .newBuilder(RUN_TWICE_KEY, "ruby.run-twice")
+            .help("Run a workload twice using a shared engine in the same process")
+            .category(OptionCategory.INTERNAL)
+            .stability(OptionStability.EXPERIMENTAL)
+            .build();
+
     public static final OptionDescriptor COMPARE_REGEX_ENGINES = OptionDescriptor
             .newBuilder(COMPARE_REGEX_ENGINES_KEY, "ruby.compare-regex-engines")
             .help("Uses both Joni and the TRegex engine and compares their results")
@@ -1391,6 +1399,8 @@ public static OptionDescriptor fromName(String name) {
                 return TESTING_RUBYGEMS;
             case "ruby.experimental-engine-caching":
                 return EXPERIMENTAL_ENGINE_CACHING;
+            case "ruby.run-twice":
+                return RUN_TWICE;
             case "ruby.compare-regex-engines":
                 return COMPARE_REGEX_ENGINES;
             default:
@@ -1536,6 +1546,7 @@ public static OptionDescriptor[] allDescriptors() {
             SHARED_OBJECTS_FORCE,
             TESTING_RUBYGEMS,
             EXPERIMENTAL_ENGINE_CACHING,
+            RUN_TWICE,
             COMPARE_REGEX_ENGINES,
         };
     }