[vm/ffi] Expose dart_native_api.h symbols via dart:ffi

This enables dynamic linking of the symbols in dart_native_api.h to work around the Windows linking issue and Dart embedders not exposing symbols.

Issue: #40607
Closes: #40564

Change-Id: I6f797cc915b53ec63fa5953529f17c40e52a2aed
Cq-Include-Trybots: luci.dart.try:vm-ffi-android-debug-arm-try,vm-ffi-android-debug-arm64-try,app-kernel-linux-debug-x64-try,vm-kernel-linux-debug-ia32-try,vm-kernel-win-debug-x64-try,vm-kernel-win-debug-ia32-try,vm-kernel-precomp-linux-debug-x64-try,vm-dartkb-linux-release-x64-abi-try,vm-kernel-precomp-android-release-arm64-try,vm-kernel-asan-linux-release-x64-try,vm-kernel-linux-release-simarm-try,vm-kernel-linux-release-simarm64-try,vm-kernel-precomp-android-release-arm_x64-try,vm-kernel-precomp-obfuscate-linux-release-x64-try,dart-sdk-linux-try,analyzer-analysis-server-linux-try,analyzer-linux-release-try,front-end-linux-release-x64-try,vm-kernel-precomp-win-release-x64-try
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/136962
Commit-Queue: Daco Harkes <[email protected]>
Reviewed-by: Vyacheslav Egorov <[email protected]>
Reviewed-by: Martin Kustermann <[email protected]>

Author: dcharkes

runtime/bin/ffi_test/ffi_test_functions_vmspecific.cc

@@ -269,6 +269,34 @@ DART_EXPORT intptr_t TestCallbackWrongIsolate(void (*fn)()) {
 
 #endif  // defined(TARGET_OS_LINUX)
 
+////////////////////////////////////////////////////////////////////////////////
+// Dynamic linking of dart_native_api.h for the next two samples.
+typedef bool (*Dart_PostCObjectType)(Dart_Port port_id, Dart_CObject* message);
+Dart_PostCObjectType Dart_PostCObject_ = nullptr;
+
+DART_EXPORT void RegisterDart_PostCObject(
+    Dart_PostCObjectType function_pointer) {
+  Dart_PostCObject_ = function_pointer;
+}
+
+typedef Dart_Port (*Dart_NewNativePortType)(const char* name,
+                                            Dart_NativeMessageHandler handler,
+                                            bool handle_concurrently);
+Dart_NewNativePortType Dart_NewNativePort_ = nullptr;
+
+DART_EXPORT void RegisterDart_NewNativePort(
+    Dart_NewNativePortType function_pointer) {
+  Dart_NewNativePort_ = function_pointer;
+}
+
+typedef bool (*Dart_CloseNativePortType)(Dart_Port native_port_id);
+Dart_CloseNativePortType Dart_CloseNativePort_ = nullptr;
+
+DART_EXPORT void RegisterDart_CloseNativePort(
+    Dart_CloseNativePortType function_pointer) {
+  Dart_CloseNativePort_ = function_pointer;
+}
+
 ////////////////////////////////////////////////////////////////////////////////
 // Functions for async callbacks example.
 //
@@ -314,7 +342,7 @@ void NotifyDart(Dart_Port send_port, const Work* work) {
   dart_object.type = Dart_CObject_kInt64;
   dart_object.value.as_int64 = work_addr;
 
-  const bool result = Dart_PostCObject(send_port, &dart_object);
+  const bool result = Dart_PostCObject_(send_port, &dart_object);
   if (!result) {
     FATAL("C   :  Posting message to port failed.");
   }
@@ -476,16 +504,16 @@ class PendingCall {
   PendingCall(void** buffer, size_t* length)
       : response_buffer_(buffer), response_length_(length) {
     receive_port_ =
-        Dart_NewNativePort("cpp-response", &PendingCall::HandleResponse,
-                           /*handle_concurrently=*/false);
+        Dart_NewNativePort_("cpp-response", &PendingCall::HandleResponse,
+                            /*handle_concurrently=*/false);
   }
-  ~PendingCall() { Dart_CloseNativePort(receive_port_); }
+  ~PendingCall() { Dart_CloseNativePort_(receive_port_); }
 
   Dart_Port port() const { return receive_port_; }
 
   void PostAndWait(Dart_Port port, Dart_CObject* object) {
     std::unique_lock<std::mutex> lock(mutex);
-    const bool success = Dart_PostCObject(send_port_, object);
+    const bool success = Dart_PostCObject_(send_port_, object);
     if (!success) FATAL("Failed to send message, invalid port or isolate died");
 
     printf("C   :  Waiting for result.\n");
@@ -589,7 +617,7 @@ uint8_t MyCallback1(uint8_t a) {
   c_request.value.as_array.length =
       sizeof(c_request_arr) / sizeof(c_request_arr[0]);
 
-  printf("C   :  Dart_PostCObject(request: %" Px ", call: %" Px ").\n",
+  printf("C   :  Dart_PostCObject_(request: %" Px ", call: %" Px ").\n",
          reinterpret_cast<intptr_t>(&c_request),
          reinterpret_cast<intptr_t>(&c_pending_call));
   pending_call.PostAndWait(send_port_, &c_request);
@@ -637,10 +665,10 @@ void MyCallback2(uint8_t a) {
   c_request.value.as_array.length =
       sizeof(c_request_arr) / sizeof(c_request_arr[0]);
 
-  printf("C   :  Dart_PostCObject(request: %" Px ", call: %" Px ").\n",
+  printf("C   :  Dart_PostCObject_(request: %" Px ", call: %" Px ").\n",
          reinterpret_cast<intptr_t>(&c_request),
          reinterpret_cast<intptr_t>(&c_pending_call));
-  Dart_PostCObject(send_port_, &c_request);
+  Dart_PostCObject_(send_port_, &c_request);
 }
 
 // Simulated work for Thread #1.

runtime/lib/ffi.cc

@@ -3,6 +3,7 @@
 // BSD-style license that can be found in the LICENSE file.
 
 #include "include/dart_api.h"
+#include "include/dart_native_api.h"
 #include "platform/globals.h"
 #include "vm/bootstrap_natives.h"
 #include "vm/class_finalizer.h"
@@ -492,4 +493,21 @@ DEFINE_NATIVE_ENTRY(Ffi_pointerFromFunction, 1, 1) {
   return Pointer::New(type_arg, entry_point);
 }
 
+DEFINE_NATIVE_ENTRY(NativeApiFunctionPointer, 0, 1) {
+  GET_NON_NULL_NATIVE_ARGUMENT(String, name_dart, arguments->NativeArgAt(0));
+  const char* name = name_dart.ToCString();
+
+  if (strcmp(name, "Dart_PostCObject") == 0) {
+    return Integer::New(reinterpret_cast<int64_t>(Dart_PostCObject));
+  } else if (strcmp(name, "Dart_NewNativePort") == 0) {
+    return Integer::New(reinterpret_cast<int64_t>(Dart_NewNativePort));
+  } else if (strcmp(name, "Dart_CloseNativePort") == 0) {
+    return Integer::New(reinterpret_cast<int64_t>(Dart_CloseNativePort));
+  }
+
+  const String& error = String::Handle(
+      String::NewFormatted("Unknown dart_native_api.h symbol: %s.", name));
+  Exceptions::ThrowArgumentError(error);
+}
+
 }  // namespace dart

runtime/vm/bootstrap_natives.h

@@ -406,6 +406,7 @@ namespace dart {
   V(Ffi_asExternalTypedData, 2)                                                \
   V(Ffi_dl_processLibrary, 0)                                                  \
   V(Ffi_dl_executableLibrary, 0)                                               \
+  V(NativeApiFunctionPointer, 1)                                               \
   V(TransferableTypedData_factory, 2)                                          \
   V(TransferableTypedData_materialize, 1)                                      \
   V(Wasm_initModule, 2)                                                        \

samples/ffi/async/sample_async_callback.dart

@@ -7,8 +7,6 @@
 // main Dart thread.
 //
 // TODO(dartbug.com/37022): Update this when we get real async callbacks.
-// TODO(dartbug.com/40564): On Windows DLL is wrongly linked against dart.exe
-// instead of dart_precompiled_runtime.exe
 
 import 'dart:ffi';
 import 'dart:isolate';
@@ -28,8 +26,9 @@ main() async {
   print("C T2 = Some C thread executing C.");
   print("C    = C T1 or C T2.");
   print("Dart: Setup.");
-  final interactiveCppRequests = ReceivePort()..listen(requestExecuteCallback);
+  registerDart_PostCObject(NativeApi.nativeApiPostCObject);
 
+  final interactiveCppRequests = ReceivePort()..listen(requestExecuteCallback);
   final int nativePort = interactiveCppRequests.sendPort.nativePort;
   registerCallback1(nativePort, callback1FP);
   registerCallback2(nativePort, callback2FP);
@@ -102,6 +101,14 @@ final stopWorkSimulator =
 final executeCallback = dl.lookupFunction<Void Function(Pointer<Work>),
     void Function(Pointer<Work>)>('ExecuteCallback');
 
+final registerDart_PostCObject = dl.lookupFunction<
+    Void Function(
+        Pointer<NativeFunction<Int8 Function(Int64, Pointer<Dart_CObject>)>>
+            functionPointer),
+    void Function(
+        Pointer<NativeFunction<Int8 Function(Int64, Pointer<Dart_CObject>)>>
+            functionPointer)>('RegisterDart_PostCObject');
+
 class Work extends Struct {}
 
 Future asyncSleep(int ms) {

samples/ffi/async/sample_native_port_call.dart

@@ -35,6 +35,10 @@ main() async {
   print("C T2 = Some C thread executing C.");
   print("C    = C T1 or C T2.");
   print("Dart: Setup.");
+  registerDart_PostCObject(NativeApi.nativeApiPostCObject);
+  registerDart_NewNativePort(NativeApi.nativeApiNewNativePort);
+  registerDart_CloseNativePort(NativeApi.nativeApiCloseNativePort);
+
   final interactiveCppRequests = ReceivePort()..listen(handleCppRequests);
   final int nativePort = interactiveCppRequests.sendPort.nativePort;
   registerSendPort(nativePort);
@@ -126,6 +130,39 @@ final startWorkSimulator2 =
 final stopWorkSimulator2 =
     dl.lookupFunction<Void Function(), void Function()>('StopWorkSimulator2');
 
+final registerDart_PostCObject = dl.lookupFunction<
+    Void Function(
+        Pointer<NativeFunction<Int8 Function(Int64, Pointer<Dart_CObject>)>>
+            functionPointer),
+    void Function(
+        Pointer<NativeFunction<Int8 Function(Int64, Pointer<Dart_CObject>)>>
+            functionPointer)>('RegisterDart_PostCObject');
+
+final registerDart_NewNativePort = dl.lookupFunction<
+    Void Function(
+        Pointer<
+                NativeFunction<
+                    Int64 Function(
+                        Pointer<Uint8>,
+                        Pointer<NativeFunction<Dart_NativeMessageHandler>>,
+                        Int8)>>
+            functionPointer),
+    void Function(
+        Pointer<
+                NativeFunction<
+                    Int64 Function(
+                        Pointer<Uint8>,
+                        Pointer<NativeFunction<Dart_NativeMessageHandler>>,
+                        Int8)>>
+            functionPointer)>('RegisterDart_NewNativePort');
+
+final registerDart_CloseNativePort = dl.lookupFunction<
+        Void Function(
+            Pointer<NativeFunction<Int8 Function(Int64)>> functionPointer),
+        void Function(
+            Pointer<NativeFunction<Int8 Function(Int64)>> functionPointer)>(
+    'RegisterDart_CloseNativePort');
+
 Future asyncSleep(int ms) {
   return new Future.delayed(Duration(milliseconds: ms), () => true);
 }

samples/samples.status

@@ -14,9 +14,6 @@ sample_extension/test/sample_extension_app_snapshot_test: SkipByDesign # This te
 [ $compiler == dart2js && $runtime == none ]
 *: Fail, Pass # TODO(ahe): Triage these tests.
 
-[ $compiler == dartkp && $system == windows ]
-ffi/async/async_test: Skip # dartbug.com/40564 dartbug.com/40579
-
 [ $compiler == none && $mode == debug && $runtime == vm && $system == windows ]
 sample_extension/test/sample_extension_app_snapshot_test: Pass, RuntimeError # Issue 28842
 

sdk/lib/_internal/vm/lib/ffi_patch.dart

@@ -452,3 +452,27 @@ extension NativePort on SendPort {
   @patch
   int get nativePort native "SendPortImpl_get_id";
 }
+
+int _nativeApiFunctionPointer(String symbol) native "NativeApiFunctionPointer";
+
+@patch
+class NativeApi {
+  @patch
+  static Pointer<NativeFunction<Int8 Function(Int64, Pointer<Dart_CObject>)>>
+      get nativeApiPostCObject =>
+          Pointer.fromAddress(_nativeApiFunctionPointer("Dart_PostCObject"));
+
+  @patch
+  static Pointer<
+      NativeFunction<
+          Int64 Function(
+              Pointer<Uint8>,
+              Pointer<NativeFunction<Dart_NativeMessageHandler>>,
+              Int8)>> get nativeApiNewNativePort =>
+      Pointer.fromAddress(_nativeApiFunctionPointer("Dart_NewNativePort"));
+
+  @patch
+  static Pointer<NativeFunction<Int8 Function(Int64)>>
+      get nativeApiCloseNativePort => Pointer.fromAddress(
+          _nativeApiFunctionPointer("Dart_CloseNativePort"));
+}

sdk/lib/ffi/ffi.dart

@@ -622,3 +622,38 @@ extension NativePort on SendPort {
   /// `dart_native_api.h`.
   external int get nativePort;
 }
+
+/// Opaque, not exposing it's members.
+class Dart_CObject extends Struct {}
+
+typedef Dart_NativeMessageHandler = Void Function(Int64, Pointer<Dart_CObject>);
+
+/// Exposes function pointers to functions in `dart_native_api.h`.
+class NativeApi {
+  /// A function pointer to
+  /// `bool Dart_PostCObject(Dart_Port port_id, Dart_CObject* message)`
+  /// in `dart_native_api.h`.
+  external static Pointer<
+          NativeFunction<Int8 Function(Int64, Pointer<Dart_CObject>)>>
+      get nativeApiPostCObject;
+
+  /// A function pointer to
+  /// ```
+  /// Dart_Port Dart_NewNativePort(const char* name,
+  ///                              Dart_NativeMessageHandler handler,
+  ///                              bool handle_concurrently)
+  /// ```
+  /// in `dart_native_api.h`.
+  external static Pointer<
+      NativeFunction<
+          Int64 Function(
+              Pointer<Uint8>,
+              Pointer<NativeFunction<Dart_NativeMessageHandler>>,
+              Int8)>> get nativeApiNewNativePort;
+
+  /// A function pointer to
+  /// `bool Dart_CloseNativePort(Dart_Port native_port_id)`
+  /// in `dart_native_api.h`.
+  external static Pointer<NativeFunction<Int8 Function(Int64)>>
+      get nativeApiCloseNativePort;
+}

sdk_nnbd/lib/_internal/vm/lib/ffi_patch.dart

@@ -450,3 +450,27 @@ extension NativePort on SendPort {
   @patch
   int get nativePort native "SendPortImpl_get_id";
 }
+
+int _nativeApiFunctionPointer(String symbol) native "NativeApiFunctionPointer";
+
+@patch
+class NativeApi {
+  @patch
+  static Pointer<NativeFunction<Int8 Function(Int64, Pointer<Dart_CObject>)>>
+      get nativeApiPostCObject =>
+          Pointer.fromAddress(_nativeApiFunctionPointer("Dart_PostCObject"));
+
+  @patch
+  static Pointer<
+      NativeFunction<
+          Int64 Function(
+              Pointer<Uint8>,
+              Pointer<NativeFunction<Dart_NativeMessageHandler>>,
+              Int8)>> get nativeApiNewNativePort =>
+      Pointer.fromAddress(_nativeApiFunctionPointer("Dart_NewNativePort"));
+
+  @patch
+  static Pointer<NativeFunction<Int8 Function(Int64)>>
+      get nativeApiCloseNativePort => Pointer.fromAddress(
+          _nativeApiFunctionPointer("Dart_CloseNativePort"));
+}

sdk_nnbd/lib/ffi/ffi.dart

@@ -621,3 +621,38 @@ extension NativePort on SendPort {
   /// `dart_native_api.h`.
   external int get nativePort;
 }
+
+/// Opaque, not exposing it's members.
+class Dart_CObject extends Struct {}
+
+typedef Dart_NativeMessageHandler = Void Function(Int64, Pointer<Dart_CObject>);
+
+/// Exposes function pointers to functions in `dart_native_api.h`.
+class NativeApi {
+  /// A function pointer to
+  /// `bool Dart_PostCObject(Dart_Port port_id, Dart_CObject* message)`
+  /// in `dart_native_api.h`.
+  external static Pointer<
+          NativeFunction<Int8 Function(Int64, Pointer<Dart_CObject>)>>
+      get nativeApiPostCObject;
+
+  /// A function pointer to
+  /// ```
+  /// Dart_Port Dart_NewNativePort(const char* name,
+  ///                              Dart_NativeMessageHandler handler,
+  ///                              bool handle_concurrently)
+  /// ```
+  /// in `dart_native_api.h`.
+  external static Pointer<
+      NativeFunction<
+          Int64 Function(
+              Pointer<Uint8>,
+              Pointer<NativeFunction<Dart_NativeMessageHandler>>,
+              Int8)>> get nativeApiNewNativePort;
+
+  /// A function pointer to
+  /// `bool Dart_CloseNativePort(Dart_Port native_port_id)`
+  /// in `dart_native_api.h`.
+  external static Pointer<NativeFunction<Int8 Function(Int64)>>
+      get nativeApiCloseNativePort;
+}