[vm/ffi]: Add Native.addressOf

This adds the `Native.addressOf` function, which takes a constant tear-
off of a method annotated with `@Native` as a parameter and returns a
pointer to the underlying C function.

The CFE will resolve these calls in two steps: First, the existing
transformer for `@Native` methods adds a pragma describing the fully-
resolved native annotation (with the asset id inferred from the library
if not given explicitly). Then, the FFI use sites transformer rewrites
calls to `Native.addressOf` by searching for this pragma on the passed
function and passing the `Native` constants to `Native._addressOf`. The
latter method is implemented in the VM, which can re-use existing parts
already used for `@Native` calls.
An alternative implementation strategy would have been to forward
`addressOf` calls to `Native.ffi_resolver_function` directly without
any special consideration in the VM. However, the chosen approach makes
it easier to support static linking in the future, as this requires
unresolved symbols in the generated assembly.

Closes #50552

TEST=pkg/vm/testcases/transformations/ffi/ffinative.dart
TEST=tests/ffi/native_assets/asset_*_test.dart
TEST=tests/ffi/vmspecific_static_checks_ffinative_test.dart
TEST=pkg/analyzer/test/src/diagnostics/ffi_native_test.dart

Cq-Include-Trybots: luci.dart.try:vm-aot-linux-debug-x64-try,vm-aot-linux-debug-x64c-try,vm-aot-mac-release-arm64-try,vm-aot-mac-release-x64-try,vm-aot-obfuscate-linux-release-x64-try,vm-aot-optimization-level-linux-release-x64-try,vm-aot-win-debug-arm64-try,vm-aot-win-debug-x64c-try,vm-aot-win-release-x64-try,vm-kernel-precomp-linux-release-x64-try
CoreLibraryReviewExempt: VM & dart2wasm only feature
Change-Id: Ic8e3a390146dffd44c95578f975a4472db79a0ee
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/333920
Reviewed-by: Martin Kustermann <[email protected]>
Commit-Queue: Daco Harkes <[email protected]>
Reviewed-by: Daco Harkes <[email protected]>
Reviewed-by: Brian Wilkerson <[email protected]>

Author: simolus3

pkg/_fe_analyzer_shared/lib/src/messages/codes_generated.dart

@@ -4854,6 +4854,16 @@ const MessageCode messageFfiAbiSpecificIntegerMappingInvalid = const MessageCode
     problemMessage:
         r"""Classes extending 'AbiSpecificInteger' must have exactly one 'AbiSpecificIntegerMapping' annotation specifying the mapping from ABI to a NativeType integer with a fixed size.""");
 
+// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
+const Code<Null> codeFfiAddressOfMustBeNative = messageFfiAddressOfMustBeNative;
+
+// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
+const MessageCode messageFfiAddressOfMustBeNative = const MessageCode(
+    "FfiAddressOfMustBeNative",
+    analyzerCodes: <String>["ARGUMENT_MUST_BE_NATIVE"],
+    problemMessage:
+        r"""Argument to 'Native.addressOf' must be annotated with @Native.""");
+
 // DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
 const Template<Message Function(String string, String name)>
     templateFfiCompoundImplementsFinalizable =
@@ -4894,6 +4904,16 @@ const MessageCode messageFfiCreateOfStructOrUnion = const MessageCode(
     problemMessage:
         r"""Subclasses of 'Struct' and 'Union' are backed by native memory, and can't be instantiated by a generative constructor. Try allocating it via allocation, or load from a 'Pointer'.""");
 
+// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
+const Code<Null> codeFfiDefaultAssetDuplicate = messageFfiDefaultAssetDuplicate;
+
+// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
+const MessageCode messageFfiDefaultAssetDuplicate = const MessageCode(
+    "FfiDefaultAssetDuplicate",
+    analyzerCodes: <String>["FFI_NATIVE_INVALID_DUPLICATE_DEFAULT_ASSET"],
+    problemMessage:
+        r"""There may be at most one @DefaultAsset annotation on a library.""");
+
 // DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
 const Template<
     Message Function(
@@ -5134,6 +5154,17 @@ const MessageCode messageFfiLeafCallMustNotTakeHandle = const MessageCode(
     "FfiLeafCallMustNotTakeHandle",
     problemMessage: r"""FFI leaf call must not have Handle argument types.""");
 
+// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
+const Code<Null> codeFfiNativeDuplicateAnnotations =
+    messageFfiNativeDuplicateAnnotations;
+
+// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
+const MessageCode messageFfiNativeDuplicateAnnotations = const MessageCode(
+    "FfiNativeDuplicateAnnotations",
+    analyzerCodes: <String>["FFI_NATIVE_INVALID_MULTIPLE_ANNOTATIONS"],
+    problemMessage:
+        r"""Native functions must not have more than @Native annotation.""");
+
 // DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
 const Code<Null> codeFfiNativeMustBeExternal = messageFfiNativeMustBeExternal;
 

pkg/analysis_server/lib/src/services/correction/error_fix_status.yaml

@@ -1722,6 +1722,8 @@ FfiCode.ANNOTATION_ON_POINTER_FIELD:
   status: needsFix
 FfiCode.ARGUMENT_MUST_BE_A_CONSTANT:
   status: noFix
+FfiCode.ARGUMENT_MUST_BE_NATIVE:
+  status: needsEvaluation
 FfiCode.COMPOUND_IMPLEMENTS_FINALIZABLE:
   status: noFix
 FfiCode.CREATION_OF_STRUCT_OR_UNION:
@@ -1747,6 +1749,10 @@ FfiCode.FFI_NATIVE_UNEXPECTED_NUMBER_OF_PARAMETERS:
 FfiCode.FFI_NATIVE_UNEXPECTED_NUMBER_OF_PARAMETERS_WITH_RECEIVER:
   status: noFix
   since: ~2.15
+FfiCode.FFI_NATIVE_INVALID_DUPLICATE_DEFAULT_ASSET:
+  status: needsEvaluation
+FfiCode.FFI_NATIVE_INVALID_MULTIPLE_ANNOTATIONS:
+  status: needsEvaluation
 FfiCode.FIELD_IN_STRUCT_WITH_INITIALIZER:
   status: needsFix
   notes: |-

pkg/analyzer/lib/src/dart/error/ffi_code.g.dart

@@ -83,6 +83,13 @@ class FfiCode extends AnalyzerErrorCode {
     hasPublishedDocs: true,
   );
 
+  ///  No parameters
+  static const FfiCode ARGUMENT_MUST_BE_NATIVE = FfiCode(
+    'ARGUMENT_MUST_BE_NATIVE',
+    "Argument to 'Native.addressOf' must be annotated with @Native",
+    correctionMessage: "Try passing a static function annotated with '@Native'",
+  );
+
   ///  Parameters:
   ///  0: the name of the struct or union class
   static const FfiCode COMPOUND_IMPLEMENTS_FINALIZABLE = FfiCode(
@@ -130,6 +137,20 @@ class FfiCode extends AnalyzerErrorCode {
     hasPublishedDocs: true,
   );
 
+  ///  No parameters
+  static const FfiCode FFI_NATIVE_INVALID_DUPLICATE_DEFAULT_ASSET = FfiCode(
+    'FFI_NATIVE_INVALID_DUPLICATE_DEFAULT_ASSET',
+    "There may be at most one @DefaultAsset annotation on a library.",
+    correctionMessage: "Try removing the extra annotation.",
+  );
+
+  ///  No parameters
+  static const FfiCode FFI_NATIVE_INVALID_MULTIPLE_ANNOTATIONS = FfiCode(
+    'FFI_NATIVE_INVALID_MULTIPLE_ANNOTATIONS',
+    "Native functions must have exactly one `@Native` annotation.",
+    correctionMessage: "Try removing the extra annotation.",
+  );
+
   ///  No parameters.
   static const FfiCode FFI_NATIVE_MUST_BE_EXTERNAL = FfiCode(
     'FFI_NATIVE_MUST_BE_EXTERNAL',

pkg/analyzer/lib/src/error/error_code_values.g.dart

@@ -580,11 +580,14 @@ const List<ErrorCode> errorCodeValues = [
   FfiCode.ABI_SPECIFIC_INTEGER_MAPPING_UNSUPPORTED,
   FfiCode.ANNOTATION_ON_POINTER_FIELD,
   FfiCode.ARGUMENT_MUST_BE_A_CONSTANT,
+  FfiCode.ARGUMENT_MUST_BE_NATIVE,
   FfiCode.COMPOUND_IMPLEMENTS_FINALIZABLE,
   FfiCode.CREATION_OF_STRUCT_OR_UNION,
   FfiCode.EMPTY_STRUCT,
   FfiCode.EXTRA_ANNOTATION_ON_STRUCT_FIELD,
   FfiCode.EXTRA_SIZE_ANNOTATION_CARRAY,
+  FfiCode.FFI_NATIVE_INVALID_DUPLICATE_DEFAULT_ASSET,
+  FfiCode.FFI_NATIVE_INVALID_MULTIPLE_ANNOTATIONS,
   FfiCode.FFI_NATIVE_MUST_BE_EXTERNAL,
   FfiCode
       .FFI_NATIVE_ONLY_CLASSES_EXTENDING_NATIVEFIELDWRAPPERCLASS1_CAN_BE_POINTER,