[vm] Expose Dart_{CurrentIsolate,ExitIsolate,EnterIsolate}

For applications that want to have arbitrary number of isolates call
into native code that may be blocking, we expose the API functions that
allows those native threads to exit an isolate before running
long/blocking code.

Without the ability to exit/re-enter isolate, one may experience
deadlocks as we have a fixed limit on the number of concurrently
executing isolates atm.

In the longer term we may find a way to do this automatically
with low overhead, see [0]. But since those API functions are quite
stable and we already expose e.g. `Dart_{Enter,Exit}Scope`, I don't
see a reason not to expose `Dart_{Enter,Exit}Isolate`.

[0] Issue #51261

Issue #51254

TEST=ffi{,_2}/dl_api_exit_enter_isolate_test

Change-Id: I91c772ca962fddb87919663fea07939a498fa205
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/292722
Commit-Queue: Martin Kustermann <[email protected]>
Reviewed-by: Daco Harkes <[email protected]>
Reviewed-by: Ryan Macnak <[email protected]>

runtime/bin/ffi_test/ffi_test_functions_vmspecific.cc

@@ -30,6 +30,8 @@
 #include <iostream>
 #include <limits>
 
+#include "bin/lockers.h"
+
 // TODO(dartbug.com/40579): This requires static linking to either link
 // dart.exe or dart_precompiled_runtime.exe on Windows.
 // The sample currently fails on Windows in AOT mode.
@@ -420,16 +422,6 @@ DART_EXPORT intptr_t InitDartApiDL(void* data) {
 //
 // sample_async_callback.dart
 
-void Fatal(char const* file, int line, char const* error) {
-  printf("FATAL %s:%i\n", file, line);
-  printf("%s\n", error);
-  Dart_DumpNativeStackTrace(nullptr);
-  Dart_PrepareToAbort();
-  abort();
-}
-
-#define FATAL(error) Fatal(__FILE__, __LINE__, error)
-
 DART_EXPORT void SleepOnAnyOS(intptr_t seconds) {
 #if defined(DART_HOST_OS_WINDOWS)
   Sleep(1000 * seconds);
@@ -1282,6 +1274,28 @@ DART_EXPORT void SetFfiNativeResolverForTest(Dart_Handle url) {
   ENSURE(!Dart_IsError(result));
 }
 
+DART_EXPORT void WaitUntilNThreadsEnterBarrier(intptr_t num_threads) {
+  Dart_Isolate isolate = Dart_CurrentIsolate_DL();
+  Dart_ExitIsolate_DL();
+  {
+    ENSURE(Dart_CurrentIsolate_DL() == nullptr);
+
+    // Guaranteed to be initialized exactly once (no race between multiple
+    // threads).
+    static dart::bin::Monitor monitor;
+    static intptr_t thread_count = 0;
+
+    dart::bin::MonitorLocker ml(&monitor);
+    ++thread_count;
+    while (thread_count < num_threads) {
+      ml.Wait();
+    }
+    if (thread_count != num_threads) UNREACHABLE();
+    ml.NotifyAll();
+  }
+  Dart_EnterIsolate_DL(isolate);
+}
+
 ////////////////////////////////////////////////////////////////////////////////
 // Helper for the regression test for b/216834909
 ////////////////////////////////////////////////////////////////////////////////

runtime/include/dart_api_dl.h

@@ -90,6 +90,10 @@ typedef void (*Dart_NativeMessageHandler_DL)(Dart_Port_DL dest_port_id,
   F(Dart_UpdateFinalizableExternalSize, void,                                  \
     (Dart_FinalizableHandle object, Dart_Handle strong_ref_to_object,          \
      intptr_t external_allocation_size))                                       \
+  /* Isolates */                                                               \
+  F(Dart_CurrentIsolate, Dart_Isolate, (void))                                 \
+  F(Dart_ExitIsolate, void, (void))                                            \
+  F(Dart_EnterIsolate, void, (Dart_Isolate))                                   \
   /* Dart_Port */                                                              \
   F(Dart_Post, bool, (Dart_Port_DL port_id, Dart_Handle object))               \
   F(Dart_NewSendPort, Dart_Handle, (Dart_Port_DL port_id))                     \

runtime/include/dart_version.h

@@ -11,6 +11,6 @@
 // On backwards compatible changes the minor version is increased.
 // The versioning covers the symbols exposed in dart_api_dl.h
 #define DART_API_DL_MAJOR_VERSION 2
-#define DART_API_DL_MINOR_VERSION 2
+#define DART_API_DL_MINOR_VERSION 3
 
 #endif /* RUNTIME_INCLUDE_DART_VERSION_H_ */ /* NOLINT */

tests/ffi/dl_api_exit_enter_isolate_test.dart

@@ -0,0 +1,33 @@
+// Copyright (c) 2023, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+// SharedObjects=ffi_test_functions
+
+import 'dart:ffi';
+import 'dart:isolate';
+
+import 'package:expect/expect.dart';
+
+import 'dylib_utils.dart';
+
+final ffiTestFunctions = dlopenPlatformSpecific("ffi_test_functions");
+
+final initializeApi = ffiTestFunctions.lookupFunction<
+    IntPtr Function(Pointer<Void>),
+    int Function(Pointer<Void>)>("InitDartApiDL");
+final enterBarrier =
+    ffiTestFunctions.lookupFunction<Void Function(IntPtr), void Function(int)>(
+        "WaitUntilNThreadsEnterBarrier");
+
+main() async {
+  const threadBarrierCount = 30;
+
+  initializeApi(NativeApi.initializeApiDLData);
+
+  final all = <Future>[];
+  for (int i = 0; i < threadBarrierCount; ++i) {
+    all.add(Isolate.run(() => enterBarrier(threadBarrierCount)));
+  }
+  await Future.wait(all);
+}

tests/ffi_2/dl_api_exit_enter_isolate_test.dart

@@ -0,0 +1,35 @@
+// Copyright (c) 2023, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+// @dart = 2.9
+
+// SharedObjects=ffi_test_functions
+
+import 'dart:ffi';
+import 'dart:isolate';
+
+import 'package:expect/expect.dart';
+
+import 'dylib_utils.dart';
+
+final ffiTestFunctions = dlopenPlatformSpecific("ffi_test_functions");
+
+final initializeApi = ffiTestFunctions.lookupFunction<
+    IntPtr Function(Pointer<Void>),
+    int Function(Pointer<Void>)>("InitDartApiDL");
+final enterBarrier =
+    ffiTestFunctions.lookupFunction<Void Function(IntPtr), void Function(int)>(
+        "WaitUntilNThreadsEnterBarrier");
+
+main() async {
+  const threadBarrierCount = 30;
+
+  initializeApi(NativeApi.initializeApiDLData);
+
+  final all = <Future>[];
+  for (int i = 0; i < threadBarrierCount; ++i) {
+    all.add(Isolate.run(() => enterBarrier(threadBarrierCount)));
+  }
+  await Future.wait(all);
+}