[vm/shared] Allow sharing of ffi structs/unions.

Deeply immutable validator runs after the FFI definitions transform so it validates the inserted annotations.

ffi Arrays are not allowed to be shared at the moment. This doesn't prevent sharing structs with arrays because corresponding getter creates a new object.
Whole ffi NativeType hierarchy is not tagged as deeply immutable because of Array.

Updated FE test expectations:
```
$ tools/test.py -m release --vm-options -DupdateExpectations=true --timeout 600 pkg/vm/
$ dart --enable-asserts pkg/front_end/test/coverage_suite.dart --tasks=5 --add-and-remove-comments --update-expectations
$ dart pkg/front_end/tool/update_expectations.dart
```

BUG=#60825
TEST=shared_test

Change-Id: I50378058ddd9bc72eb1b60b22ca26ef936f5ba09
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/440523
Reviewed-by: Paul Berry <[email protected]>
Commit-Queue: Alexander Aprelev <[email protected]>

Author: aam

pkg/front_end/lib/src/compute_platform_binaries_location.dart

@@ -55,6 +55,7 @@ Uri computePlatformBinariesLocation({bool forceBuildDir = false}) {
           new Uri.file(resolvedExecutable ?? Platform.resolvedExecutable))
       .resolve(".");
   if (vmDirectory.path.endsWith("/bin/")) {
+    // Coverage-ignore-block(suite): Not run.
     // Looks like the VM is in a `/bin/` directory, so this is running from a
     // built SDK.
     return vmDirectory.resolve(forceBuildDir ? "../../" : "../lib/_internal/");

pkg/front_end/test/coverage_suite_expected.dart

@@ -425,7 +425,7 @@ const Map<String, ({int hitCount, int missCount})> _expect = {
   ),
   // 100.0%.
   "package:front_end/src/compute_platform_binaries_location.dart": (
-    hitCount: 46,
+    hitCount: 45,
     missCount: 0,
   ),
   // 100.0%.

pkg/front_end/testcases/general/ffi_external_in_part_file.dart.strong.transformed.expect

@@ -8,67 +8,70 @@ import "dart:_internal" as _in;
 import "dart:ffi";
 
 part ffi_external_in_part_lib.dart;
-@#C6
+@#C3
+@#C8
 final class Struct1ByteInt extends ffi::Struct {
   synthetic constructor •() → self::Struct1ByteInt
     : super ffi::Struct::•()
     ;
   constructor #fromTypedDataBase(synthesized core::Object #typedDataBase, synthesized core::int #offsetInBytes) → self::Struct1ByteInt
     : super ffi::Struct::_fromTypedDataBase(#typedDataBase, #offsetInBytes)
     ;
-  @#C8
+  @#C10
   constructor #fromTypedData(synthesized typ::TypedData #typedData, synthesized core::int #offset, synthesized core::int #sizeInBytes) → self::Struct1ByteInt
     : super ffi::Struct::_fromTypedData(#typedData, #offset, #sizeInBytes)
     ;
-  @#C9
-  @#C8
+  @#C11
+  @#C10
   get a0() → core::int
     return ffi::_loadInt8(this.{ffi::_Compound::_typedDataBase}{core::Object}, self::Struct1ByteInt::a0#offsetOf.{core::num::+}(this.{ffi::_Compound::_offsetInBytes}{core::int}){(core::num) → core::num});
-  @#C9
-  @#C8
+  @#C11
+  @#C10
   set a0(synthesized core::int #externalFieldValue) → void
     return ffi::_storeInt8(this.{ffi::_Compound::_typedDataBase}{core::Object}, self::Struct1ByteInt::a0#offsetOf.{core::num::+}(this.{ffi::_Compound::_offsetInBytes}{core::int}){(core::num) → core::num}, #externalFieldValue);
-  @#C8
+  @#C10
   static synthetic get a0#offsetOf() → core::int
-    return #C11.{core::List::[]}(ffi::_abi()){(core::int) → core::int};
-  @#C8
-  static get #sizeOf() → core::int
     return #C13.{core::List::[]}(ffi::_abi()){(core::int) → core::int};
+  @#C10
+  static get #sizeOf() → core::int
+    return #C15.{core::List::[]}(ffi::_abi()){(core::int) → core::int};
 }
 static method notMain() → void {
   core::print(self::returnStruct1ByteIntNative(1.{core::int::unary-}(){() → core::int}));
 }
-@#C19
-@#C8
+@#C21
+@#C10
 static method /* from org-dartlang-testcase:///ffi_external_in_part_lib.dart */ returnStruct1ByteIntNative(core::int a0) → self::Struct1ByteInt
   return block {
-    _in::_nativeEffect(new self::Struct1ByteInt::#fromTypedDataBase(typ::Uint8List::•(#C12), #C10));
+    _in::_nativeEffect(new self::Struct1ByteInt::#fromTypedDataBase(typ::Uint8List::•(#C14), #C12));
   } =>self::_returnStruct1ByteIntNative$Method$FfiNative(a0);
-@#C21
+@#C23
 external static method /* from org-dartlang-testcase:///ffi_external_in_part_lib.dart */ _returnStruct1ByteIntNative$Method$FfiNative(core::int #t0) → self::Struct1ByteInt;
 
 constants  {
-  #C1 = "vm:ffi:struct-fields"
-  #C2 = TypeLiteralConstant(ffi::Int8)
-  #C3 = <core::Type>[#C2]
-  #C4 = null
-  #C5 = ffi::_FfiStructLayout {fieldTypes:#C3, packing:#C4}
-  #C6 = core::pragma {name:#C1, options:#C5}
-  #C7 = "vm:prefer-inline"
-  #C8 = core::pragma {name:#C7, options:#C4}
-  #C9 = ffi::Int8 {}
-  #C10 = 0
-  #C11 = <core::int>[#C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10]
-  #C12 = 1
+  #C1 = "vm:deeply-immutable"
+  #C2 = null
+  #C3 = core::pragma {name:#C1, options:#C2}
+  #C4 = "vm:ffi:struct-fields"
+  #C5 = TypeLiteralConstant(ffi::Int8)
+  #C6 = <core::Type>[#C5]
+  #C7 = ffi::_FfiStructLayout {fieldTypes:#C6, packing:#C2}
+  #C8 = core::pragma {name:#C4, options:#C7}
+  #C9 = "vm:prefer-inline"
+  #C10 = core::pragma {name:#C9, options:#C2}
+  #C11 = ffi::Int8 {}
+  #C12 = 0
   #C13 = <core::int>[#C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12]
-  #C14 = "cfe:ffi:native-marker"
-  #C15 = "ReturnStruct1ByteInt"
-  #C16 = "org-dartlang-testcase:///ffi_external_in_part_file.dart"
-  #C17 = false
-  #C18 = ffi::Native<(ffi::Int8) → self::Struct1ByteInt> {symbol:#C15, assetId:#C16, isLeaf:#C17}
-  #C19 = core::pragma {name:#C14, options:#C18}
-  #C20 = "vm:ffi:native"
-  #C21 = core::pragma {name:#C20, options:#C18}
+  #C14 = 1
+  #C15 = <core::int>[#C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14]
+  #C16 = "cfe:ffi:native-marker"
+  #C17 = "ReturnStruct1ByteInt"
+  #C18 = "org-dartlang-testcase:///ffi_external_in_part_file.dart"
+  #C19 = false
+  #C20 = ffi::Native<(ffi::Int8) → self::Struct1ByteInt> {symbol:#C17, assetId:#C18, isLeaf:#C19}
+  #C21 = core::pragma {name:#C16, options:#C20}
+  #C22 = "vm:ffi:native"
+  #C23 = core::pragma {name:#C22, options:#C20}
 }
 
 Extra constant evaluation status:

pkg/front_end/testcases/general/ffi_sample.dart.strong.transformed.expect

@@ -21,79 +21,82 @@ import "dart:typed_data" as typ;
 import "dart:ffi";
 import "package:ffi/ffi.dart";
 
-@#C7
+@#C3
+@#C9
 class Coordinate extends ffi::Struct {
   constructor #fromTypedDataBase(synthesized core::Object #typedDataBase, synthesized core::int #offsetInBytes) → self::Coordinate
     : super ffi::Struct::_fromTypedDataBase(#typedDataBase, #offsetInBytes)
     ;
-  @#C9
+  @#C11
   constructor #fromTypedData(synthesized typ::TypedData #typedData, synthesized core::int #offset, synthesized core::int #sizeInBytes) → self::Coordinate
     : super ffi::Struct::_fromTypedData(#typedData, #offset, #sizeInBytes)
     ;
-  @#C10
-  @#C9
+  @#C12
+  @#C11
   get x() → core::double
     return ffi::_loadDouble(this.{ffi::_Compound::_typedDataBase}{core::Object}, self::Coordinate::x#offsetOf.{core::num::+}(this.{ffi::_Compound::_offsetInBytes}{core::int}){(core::num) → core::num});
-  @#C10
-  @#C9
+  @#C12
+  @#C11
   set x(synthesized core::double #externalFieldValue) → void
     return ffi::_storeDouble(this.{ffi::_Compound::_typedDataBase}{core::Object}, self::Coordinate::x#offsetOf.{core::num::+}(this.{ffi::_Compound::_offsetInBytes}{core::int}){(core::num) → core::num}, #externalFieldValue);
-  @#C10
-  @#C9
+  @#C12
+  @#C11
   get y() → core::double
     return ffi::_loadDouble(this.{ffi::_Compound::_typedDataBase}{core::Object}, self::Coordinate::y#offsetOf.{core::num::+}(this.{ffi::_Compound::_offsetInBytes}{core::int}){(core::num) → core::num});
-  @#C10
-  @#C9
+  @#C12
+  @#C11
   set y(synthesized core::double #externalFieldValue) → void
     return ffi::_storeDouble(this.{ffi::_Compound::_typedDataBase}{core::Object}, self::Coordinate::y#offsetOf.{core::num::+}(this.{ffi::_Compound::_offsetInBytes}{core::int}){(core::num) → core::num}, #externalFieldValue);
   static factory allocate(ffi::Allocator allocator, core::double x, core::double y, ffi::Pointer<self::Coordinate> next) → self::Coordinate {
-    return let final self::Coordinate #t1 = new self::Coordinate::#fromTypedDataBase(allocator.{ffi::Allocator::allocate}<self::Coordinate>(self::Coordinate::#sizeOf){(core::int, {alignment: core::int?}) → ffi::Pointer<self::Coordinate>}!, #C11) in block {
+    return let final self::Coordinate #t1 = new self::Coordinate::#fromTypedDataBase(allocator.{ffi::Allocator::allocate}<self::Coordinate>(self::Coordinate::#sizeOf){(core::int, {alignment: core::int?}) → ffi::Pointer<self::Coordinate>}!, #C13) in block {
       #t1.{self::Coordinate::x} = x;
       #t1.{self::Coordinate::y} = y;
       #t1.{self::Coordinate::next} = next;
     } =>#t1;
   }
-  @#C9
+  @#C11
   static synthetic get x#offsetOf() → core::int
-    return #C12.{core::List::[]}(ffi::_abi()){(core::int) → core::int};
-  @#C9
-  static synthetic get y#offsetOf() → core::int
     return #C14.{core::List::[]}(ffi::_abi()){(core::int) → core::int};
-  @#C9
-  static synthetic get next#offsetOf() → core::int
+  @#C11
+  static synthetic get y#offsetOf() → core::int
     return #C16.{core::List::[]}(ffi::_abi()){(core::int) → core::int};
-  @#C9
+  @#C11
+  static synthetic get next#offsetOf() → core::int
+    return #C18.{core::List::[]}(ffi::_abi()){(core::int) → core::int};
+  @#C11
   get next() → ffi::Pointer<self::Coordinate>
     return ffi::_loadPointer<self::Coordinate>(this.{ffi::_Compound::_typedDataBase}{core::Object}, self::Coordinate::next#offsetOf.{core::num::+}(this.{ffi::_Compound::_offsetInBytes}{core::int}){(core::num) → core::num});
-  @#C9
+  @#C11
   set next(synthesized ffi::Pointer<self::Coordinate> #v) → void
     return ffi::_storePointer<self::Coordinate>(this.{ffi::_Compound::_typedDataBase}{core::Object}, self::Coordinate::next#offsetOf.{core::num::+}(this.{ffi::_Compound::_offsetInBytes}{core::int}){(core::num) → core::num}, #v);
-  @#C9
+  @#C11
   static get #sizeOf() → core::int
-    return #C19.{core::List::[]}(ffi::_abi()){(core::int) → core::int};
+    return #C21.{core::List::[]}(ffi::_abi()){(core::int) → core::int};
 }
 static method main() → dynamic {}
 
 constants  {
-  #C1 = "vm:ffi:struct-fields"
-  #C2 = TypeLiteralConstant(ffi::Double)
-  #C3 = TypeLiteralConstant(ffi::Pointer<core::Object>)
-  #C4 = <core::Type>[#C2, #C2, #C3]
-  #C5 = null
-  #C6 = ffi::_FfiStructLayout {fieldTypes:#C4, packing:#C5}
-  #C7 = core::pragma {name:#C1, options:#C6}
-  #C8 = "vm:prefer-inline"
-  #C9 = core::pragma {name:#C8, options:#C5}
-  #C10 = ffi::Double {}
-  #C11 = 0
-  #C12 = <core::int>[#C11, #C11, #C11, #C11, #C11, #C11, #C11, #C11, #C11, #C11, #C11, #C11, #C11, #C11, #C11, #C11, #C11, #C11, #C11, #C11, #C11, #C11]
-  #C13 = 8
+  #C1 = "vm:deeply-immutable"
+  #C2 = null
+  #C3 = core::pragma {name:#C1, options:#C2}
+  #C4 = "vm:ffi:struct-fields"
+  #C5 = TypeLiteralConstant(ffi::Double)
+  #C6 = TypeLiteralConstant(ffi::Pointer<core::Object>)
+  #C7 = <core::Type>[#C5, #C5, #C6]
+  #C8 = ffi::_FfiStructLayout {fieldTypes:#C7, packing:#C2}
+  #C9 = core::pragma {name:#C4, options:#C8}
+  #C10 = "vm:prefer-inline"
+  #C11 = core::pragma {name:#C10, options:#C2}
+  #C12 = ffi::Double {}
+  #C13 = 0
   #C14 = <core::int>[#C13, #C13, #C13, #C13, #C13, #C13, #C13, #C13, #C13, #C13, #C13, #C13, #C13, #C13, #C13, #C13, #C13, #C13, #C13, #C13, #C13, #C13]
-  #C15 = 16
+  #C15 = 8
   #C16 = <core::int>[#C15, #C15, #C15, #C15, #C15, #C15, #C15, #C15, #C15, #C15, #C15, #C15, #C15, #C15, #C15, #C15, #C15, #C15, #C15, #C15, #C15, #C15]
-  #C17 = 24
-  #C18 = 20
-  #C19 = <core::int>[#C17, #C17, #C18, #C17, #C17, #C17, #C17, #C17, #C18, #C17, #C17, #C17, #C17, #C18, #C17, #C17, #C17, #C17, #C17, #C17, #C17, #C17]
+  #C17 = 16
+  #C18 = <core::int>[#C17, #C17, #C17, #C17, #C17, #C17, #C17, #C17, #C17, #C17, #C17, #C17, #C17, #C17, #C17, #C17, #C17, #C17, #C17, #C17, #C17, #C17]
+  #C19 = 24
+  #C20 = 20
+  #C21 = <core::int>[#C19, #C19, #C20, #C19, #C19, #C19, #C19, #C19, #C20, #C19, #C19, #C19, #C19, #C20, #C19, #C19, #C19, #C19, #C19, #C19, #C19, #C19]
 }
 
 

pkg/front_end/testcases/incremental/crash_05.yaml.world.1.expect

@@ -3,83 +3,87 @@ library from "org-dartlang-test:///lib.dart" as lib {
 
   import "dart:ffi";
 
-  @#C6
+  @#C3
+  @#C8
   final class Y extends dart.ffi::Struct {
     synthetic constructor •() → lib::Y
       : super dart.ffi::Struct::•()
       ;
     constructor #fromTypedDataBase(synthesized dart.core::Object #typedDataBase, synthesized dart.core::int #offsetInBytes) → lib::Y
       : super dart.ffi::Struct::_fromTypedDataBase(#typedDataBase, #offsetInBytes)
       ;
-    @#C8
+    @#C10
     constructor #fromTypedData(synthesized dart.typed_data::TypedData #typedData, synthesized dart.core::int #offset, synthesized dart.core::int #sizeInBytes) → lib::Y
       : super dart.ffi::Struct::_fromTypedData(#typedData, #offset, #sizeInBytes)
       ;
-    @#C9
-    @#C8
+    @#C11
+    @#C10
     get yy() → dart.core::int
       return dart.ffi::_loadUint32(this.{dart.ffi::_Compound::_typedDataBase}{dart.core::Object}, lib::Y::yy#offsetOf.{dart.core::num::+}(this.{dart.ffi::_Compound::_offsetInBytes}{dart.core::int}){(dart.core::num) → dart.core::num});
-    @#C9
-    @#C8
+    @#C11
+    @#C10
     set yy(synthesized dart.core::int #externalFieldValue) → void
       return dart.ffi::_storeUint32(this.{dart.ffi::_Compound::_typedDataBase}{dart.core::Object}, lib::Y::yy#offsetOf.{dart.core::num::+}(this.{dart.ffi::_Compound::_offsetInBytes}{dart.core::int}){(dart.core::num) → dart.core::num}, #externalFieldValue);
-    @#C8
+    @#C10
     static synthetic get yy#offsetOf() → dart.core::int
-      return #C11.{dart.core::List::[]}(dart.ffi::_abi()){(dart.core::int) → dart.core::int};
-    @#C8
-    static get #sizeOf() → dart.core::int
       return #C13.{dart.core::List::[]}(dart.ffi::_abi()){(dart.core::int) → dart.core::int};
+    @#C10
+    static get #sizeOf() → dart.core::int
+      return #C15.{dart.core::List::[]}(dart.ffi::_abi()){(dart.core::int) → dart.core::int};
   }
 }
 library from "org-dartlang-test:///main.dart" as main {
 
   import "dart:ffi";
   import "org-dartlang-test:///lib.dart";
 
-  @#C17
+  @#C3
+  @#C19
   final class X extends dart.ffi::Struct {
     synthetic constructor •() → main::X
       : super dart.ffi::Struct::•()
       ;
     constructor #fromTypedDataBase(synthesized dart.core::Object #typedDataBase, synthesized dart.core::int #offsetInBytes) → main::X
       : super dart.ffi::Struct::_fromTypedDataBase(#typedDataBase, #offsetInBytes)
       ;
-    @#C8
+    @#C10
     constructor #fromTypedData(synthesized dart.typed_data::TypedData #typedData, synthesized dart.core::int #offset, synthesized dart.core::int #sizeInBytes) → main::X
       : super dart.ffi::Struct::_fromTypedData(#typedData, #offset, #sizeInBytes)
       ;
-    @#C8
+    @#C10
     get xx() → lib::Y
       return new lib::Y::#fromTypedDataBase(this.{dart.ffi::_Compound::_typedDataBase}{dart.core::Object}, main::X::xx#offsetOf.{dart.core::num::+}(this.{dart.ffi::_Compound::_offsetInBytes}{dart.core::int}){(dart.core::num) → dart.core::num});
-    @#C8
+    @#C10
     set xx(synthesized lib::Y #externalFieldValue) → void
-      return dart.ffi::_memCopy(this.{dart.ffi::_Compound::_typedDataBase}{dart.core::Object}, main::X::xx#offsetOf.{dart.core::num::+}(this.{dart.ffi::_Compound::_offsetInBytes}{dart.core::int}){(dart.core::num) → dart.core::num}, #externalFieldValue.{dart.ffi::_Compound::_typedDataBase}{dart.core::Object}, #externalFieldValue.{dart.ffi::_Compound::_offsetInBytes}{dart.core::int}, #C13.{dart.core::List::[]}(dart.ffi::_abi()){(dart.core::int) → dart.core::int});
-    @#C8
+      return dart.ffi::_memCopy(this.{dart.ffi::_Compound::_typedDataBase}{dart.core::Object}, main::X::xx#offsetOf.{dart.core::num::+}(this.{dart.ffi::_Compound::_offsetInBytes}{dart.core::int}){(dart.core::num) → dart.core::num}, #externalFieldValue.{dart.ffi::_Compound::_typedDataBase}{dart.core::Object}, #externalFieldValue.{dart.ffi::_Compound::_offsetInBytes}{dart.core::int}, #C15.{dart.core::List::[]}(dart.ffi::_abi()){(dart.core::int) → dart.core::int});
+    @#C10
     static synthetic get xx#offsetOf() → dart.core::int
-      return #C11.{dart.core::List::[]}(dart.ffi::_abi()){(dart.core::int) → dart.core::int};
-    @#C8
-    static get #sizeOf() → dart.core::int
       return #C13.{dart.core::List::[]}(dart.ffi::_abi()){(dart.core::int) → dart.core::int};
+    @#C10
+    static get #sizeOf() → dart.core::int
+      return #C15.{dart.core::List::[]}(dart.ffi::_abi()){(dart.core::int) → dart.core::int};
   }
 }
 constants  {
-  #C1 = "vm:ffi:struct-fields"
-  #C2 = TypeLiteralConstant(dart.ffi::Uint32)
-  #C3 = <dart.core::Type>[#C2]
-  #C4 = null
-  #C5 = dart.ffi::_FfiStructLayout {fieldTypes:#C3, packing:#C4}
-  #C6 = dart.core::pragma {name:#C1, options:#C5}
-  #C7 = "vm:prefer-inline"
-  #C8 = dart.core::pragma {name:#C7, options:#C4}
-  #C9 = dart.ffi::Uint32 {}
-  #C10 = 0
-  #C11 = <dart.core::int>[#C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10, #C10]
-  #C12 = 4
+  #C1 = "vm:deeply-immutable"
+  #C2 = null
+  #C3 = dart.core::pragma {name:#C1, options:#C2}
+  #C4 = "vm:ffi:struct-fields"
+  #C5 = TypeLiteralConstant(dart.ffi::Uint32)
+  #C6 = <dart.core::Type>[#C5]
+  #C7 = dart.ffi::_FfiStructLayout {fieldTypes:#C6, packing:#C2}
+  #C8 = dart.core::pragma {name:#C4, options:#C7}
+  #C9 = "vm:prefer-inline"
+  #C10 = dart.core::pragma {name:#C9, options:#C2}
+  #C11 = dart.ffi::Uint32 {}
+  #C12 = 0
   #C13 = <dart.core::int>[#C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12, #C12]
-  #C14 = TypeLiteralConstant(lib::Y)
-  #C15 = <dart.core::Type>[#C14]
-  #C16 = dart.ffi::_FfiStructLayout {fieldTypes:#C15, packing:#C4}
-  #C17 = dart.core::pragma {name:#C1, options:#C16}
+  #C14 = 4
+  #C15 = <dart.core::int>[#C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14, #C14]
+  #C16 = TypeLiteralConstant(lib::Y)
+  #C17 = <dart.core::Type>[#C16]
+  #C18 = dart.ffi::_FfiStructLayout {fieldTypes:#C17, packing:#C2}
+  #C19 = dart.core::pragma {name:#C4, options:#C18}
 }