Use RuntimeConfig for microtasks

Summary: Changelog: [general][change] - Use RuntimeConfig instead of VM Experiment Flag to set up the micro task queue. Reviewed By: neildhar Differential Revision: D37353947 fbshipit-source-id: 5c8f35c0a79d70cb0d234e881e55058cffb44ac8
gmh5225 · Jul 14, 2022 · 0ee7e45 · 0ee7e45
1 parent fb435a7
commit 0ee7e45
Show file tree

Hide file tree

Showing 18 changed files with 37 additions and 16 deletions.
diff --git a/API/hermes/SynthTrace.cpp b/API/hermes/SynthTrace.cpp
@@ -136,6 +136,7 @@ SynthTrace::SynthTrace(
     json_->emitKeyValue("ES6Promise", conf.getES6Promise());
     json_->emitKeyValue("ES6Proxy", conf.getES6Proxy());
     json_->emitKeyValue("Intl", conf.getIntl());
+    json_->emitKeyValue("MicrotasksQueue", conf.getMicrotaskQueue());
     json_->emitKeyValue("enableSampledStats", conf.getEnableSampledStats());
     json_->emitKeyValue("vmExperimentFlags", conf.getVMExperimentFlags());
     json_->closeDict();

diff --git a/API/hermes/SynthTraceParser.cpp b/API/hermes/SynthTraceParser.cpp
@@ -142,6 +142,9 @@ ::hermes::vm::RuntimeConfig::Builder getRuntimeConfig(JSONObject *rtConfig) {
   if (auto *intl = rtConfig->get("Intl")) {
     conf.withIntl(llvh::cast<JSONBoolean>(intl)->getValue());
   }
+  if (auto *microtasks = rtConfig->get("MicrotasksQueue")) {
+    conf.withMicrotaskQueue(llvh::cast<JSONBoolean>(microtasks)->getValue());
+  }
   if (auto *enableSampledStats = rtConfig->get("enableSampledStats")) {
     conf.withEnableSampledStats(
         llvh::cast<JSONBoolean>(enableSampledStats)->getValue());

diff --git a/API/hermes/hermes.cpp b/API/hermes/hermes.cpp
@@ -1511,7 +1511,7 @@ jsi::Value HermesRuntimeImpl::evaluateJavaScript(
 }
 
 bool HermesRuntimeImpl::drainMicrotasks(int maxMicrotasksHint) {
-  if (runtime_.useJobQueue()) {
+  if (runtime_.hasMicrotaskQueue()) {
     checkStatus(runtime_.drainJobs());
   }
   // \c drainJobs is currently an unbounded execution, hence no exceptions

diff --git a/include/hermes/ConsoleHost/ConsoleHost.h b/include/hermes/ConsoleHost/ConsoleHost.h
@@ -92,7 +92,7 @@ namespace microtask {
 /// until there was no errors (implying queue exhaustiveness).
 /// Note that exceptions are directly printed to stderr.
 inline void performCheckpoint(vm::Runtime &runtime) {
-  if (!runtime.useJobQueue())
+  if (!runtime.hasMicrotaskQueue())
     return;
 
   while (LLVM_UNLIKELY(runtime.drainJobs() == vm::ExecutionStatus::EXCEPTION)) {

diff --git a/include/hermes/ConsoleHost/RuntimeFlags.h b/include/hermes/ConsoleHost/RuntimeFlags.h
@@ -143,6 +143,12 @@ static opt<bool> Intl(
     init(RuntimeConfig::getDefaultIntl()),
     cat(RuntimeCategory));
 
+static opt<bool> MicrotaskQueue(
+    "Xmicrotask-queue",
+    desc("Enable support for using microtasks"),
+    init(RuntimeConfig::getDefaultMicrotaskQueue()),
+    cat(RuntimeCategory));
+
 static llvh::cl::opt<bool> StopAfterInit(
     "stop-after-module-init",
     llvh::cl::desc("Exit once module loading is finished. Useful "

diff --git a/include/hermes/VM/Runtime.h b/include/hermes/VM/Runtime.h
@@ -849,8 +849,8 @@ class Runtime : public PointerBase,
     return hasArrayBuffer_;
   }
 
-  bool useJobQueue() const {
-    return getVMExperimentFlags() & experiments::JobQueue;
+  bool hasMicrotaskQueue() const {
+    return hasMicrotaskQueue_;
   }
 
   bool builtinsAreFrozen() const {
@@ -1117,6 +1117,9 @@ class Runtime : public PointerBase,
   /// Set to true if we should enable ArrayBuffer, DataView and typed arrays.
   const bool hasArrayBuffer_;
 
+  /// Set to true if we are using microtasks.
+  const bool hasMicrotaskQueue_;
+
   /// Set to true if we should randomize stack placement etc.
   const bool shouldRandomizeMemoryLayout_;
 

diff --git a/include/hermes/VM/VMExperiments.h b/include/hermes/VM/VMExperiments.h
@@ -30,7 +30,7 @@ enum {
   // GenGC = 1 << 11,
   // HadesTimedIncremental = 1 << 12,
   CrashTrace = 1 << 13,
-  JobQueue = 1 << 14,
+  // JobQueue = 1 << 14,
 };
 
 /// Set of flags for active VM experiments.

diff --git a/lib/VM/JSLib/HermesInternal.cpp b/lib/VM/JSLib/HermesInternal.cpp
@@ -505,7 +505,7 @@ hermesInternalHasPromise(void *, Runtime &runtime, NativeArgs args) {
 
 CallResult<HermesValue>
 hermesInternalUseEngineQueue(void *, Runtime &runtime, NativeArgs args) {
-  return HermesValue::encodeBoolValue(runtime.useJobQueue());
+  return HermesValue::encodeBoolValue(runtime.hasMicrotaskQueue());
 }
 
 /// \code

diff --git a/lib/VM/Runtime.cpp b/lib/VM/Runtime.cpp
@@ -225,6 +225,7 @@ Runtime::Runtime(
       hasES6Proxy_(runtimeConfig.getES6Proxy()),
       hasIntl_(runtimeConfig.getIntl()),
       hasArrayBuffer_(runtimeConfig.getArrayBuffer()),
+      hasMicrotaskQueue_(runtimeConfig.getMicrotaskQueue()),
       shouldRandomizeMemoryLayout_(runtimeConfig.getRandomizeMemoryLayout()),
       bytecodeWarmupPercent_(runtimeConfig.getBytecodeWarmupPercent()),
       trackIO_(runtimeConfig.getTrackIO()),

diff --git a/public/hermes/Public/RuntimeConfig.h b/public/hermes/Public/RuntimeConfig.h
@@ -64,6 +64,9 @@ class PinnedHermesValue;
   /* Support for ArrayBuffer, DataView and typed arrays. */            \
   F(constexpr, bool, ArrayBuffer, true)                                \
                                                                        \
+  /* Support for using microtasks. */                                  \
+  F(constexpr, bool, MicrotaskQueue, false)                            \
+                                                                       \
   /* Enable synth trace. */                                            \
   F(constexpr, bool, TraceEnabled, false)                              \
                                                                        \

diff --git a/test/hermes/console-host-job-throw.js b/test/hermes/console-host-job-throw.js
@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-// RUN: %hermes -Xvm-experiment-flags=16384 %s 2>&1 | %FileCheck --match-full-lines %s
+// RUN: %hermes -Xmicrotask-queue %s 2>&1 | %FileCheck --match-full-lines %s
 
 print("ConsoleHost job throws");
 // CHECK-LABEL: ConsoleHost job throws

diff --git a/test/hermes/promise-jobs-scheduled-in-scripts.js b/test/hermes/promise-jobs-scheduled-in-scripts.js
@@ -6,7 +6,7 @@
  */
 
 // RUN: %hermes %s | %FileCheck --match-full-lines --check-prefix=TASK %s
-// RUN: %hermes -Xvm-experiment-flags=16384 %s | %FileCheck --match-full-lines --check-prefix=MICROTASK %s
+// RUN: %hermes -Xmicrotask-queue %s | %FileCheck --match-full-lines --check-prefix=MICROTASK %s
 
 print('promise jobs scheduled in scripts');
 // CHECK-LABEL: promise jobs scheduled in scripts

diff --git a/test/hermes/promise-jobs-scheduled-in-tasks.js b/test/hermes/promise-jobs-scheduled-in-tasks.js
@@ -6,7 +6,7 @@
  */
 
 // RUN: %hermes %s | %FileCheck --match-full-lines --check-prefix=TASK %s
-// RUN: %hermes -Xvm-experiment-flags=16384 %s | %FileCheck --match-full-lines --check-prefix=MICROTASK %s
+// RUN: %hermes -Xmicrotask-queue %s | %FileCheck --match-full-lines --check-prefix=MICROTASK %s
 
 print('promise jobs scheduled in tasks');
 // CHECK-LABEL: promise jobs scheduled in tasks

diff --git a/test/hermes/promise.js b/test/hermes/promise.js
@@ -6,7 +6,7 @@
  */
 
 // RUN: %hermes -Xes6-promise %s | %FileCheck --match-full-lines %s
-// RUN: %hermes -Xvm-experiment-flags=16384 %s | %FileCheck --match-full-lines %s
+// RUN: %hermes -Xmicrotask-queue %s | %FileCheck --match-full-lines %s
 // RUN: %hermesc -O -emit-binary -out %t.hbc %s && %hermes -Xes6-promise %t.hbc | %FileCheck --match-full-lines %s
 
 print('promise');

diff --git a/tools/hermes/hermes.cpp b/tools/hermes/hermes.cpp
@@ -107,6 +107,7 @@ static int executeHBCBytecodeFromCL(
           .withES6Promise(cl::ES6Promise)
           .withES6Proxy(cl::ES6Proxy)
           .withIntl(cl::Intl)
+          .withMicrotaskQueue(cl::MicrotaskQueue)
           .withEnableSampleProfiling(cl::SampleProfiling)
           .withRandomizeMemoryLayout(cl::RandomizeMemoryLayout)
           .withTrackIO(cl::TrackBytecodeIO)
@@ -165,6 +166,7 @@ static vm::RuntimeConfig getReplRuntimeConfig() {
       .withES6Promise(cl::ES6Promise)
       .withES6Proxy(cl::ES6Proxy)
       .withIntl(cl::Intl)
+      .withMicrotaskQueue(cl::MicrotaskQueue)
       .withEnableHermesInternal(cl::EnableHermesInternal)
       .withEnableHermesInternalTestMethods(cl::EnableHermesInternalTestMethods)
       .build();

diff --git a/tools/hvm/hvm.cpp b/tools/hvm/hvm.cpp
@@ -123,6 +123,7 @@ int main(int argc, char **argv) {
           .withES6Promise(cl::ES6Promise)
           .withES6Proxy(cl::ES6Proxy)
           .withIntl(cl::Intl)
+          .withMicrotaskQueue(cl::MicrotaskQueue)
           .withTrackIO(cl::TrackBytecodeIO)
           .withEnableHermesInternal(cl::EnableHermesInternal)
           .withEnableHermesInternalTestMethods(

diff --git a/unittests/API/SynthTraceTest.cpp b/unittests/API/SynthTraceTest.cpp
@@ -1070,12 +1070,11 @@ TEST_F(SynthTraceReplayTest, SetPropertyReplay) {
 
 struct JobQueueReplayTest : public SynthTraceReplayTest {
   JobQueueReplayTest()
-      : SynthTraceReplayTest(
-            ::hermes::vm::RuntimeConfig::Builder()
-                .withTraceEnabled(true)
-                .withEnableHermesInternal(true)
-                .withVMExperimentFlags(::hermes::vm::experiments::JobQueue)
-                .build()) {}
+      : SynthTraceReplayTest(::hermes::vm::RuntimeConfig::Builder()
+                                 .withTraceEnabled(true)
+                                 .withEnableHermesInternal(true)
+                                 .withMicrotaskQueue(true)
+                                 .build()) {}
 };
 
 TEST_F(JobQueueReplayTest, DrainSingleMicrotask) {

diff --git a/utils/testsuite/testsuite.py b/utils/testsuite/testsuite.py
@@ -363,6 +363,7 @@ def showStatus(filename):
 
 es6_args = ["-Xes6-promise", "-Xes6-proxy"]
 extra_run_args = ["-Xhermes-internal-test-methods"]
+useMicrotasksFlag = ["-Xmicrotask-queue"]
 
 extra_compile_flags = ["-fno-static-builtins"]
 
@@ -708,6 +709,7 @@ def runTest(
                     + es6_args
                     + extra_run_args
                     + disableHandleSanFlag
+                    + useMicrotasksFlag
                 )
                 if lazy:
                     args.append("-lazy")