Skip to content

Commit c326065

Browse files
goderbauerCommit Queue
goderbauer
authored and
Commit Queue
committed
[vm/ffi] Exposes an iterable Array.elements
For the arrays of the Int/Uint/Float/Double types this has been implemented straight in the ffi_patch.dart file and `elements` returns a typed-data list view on the original data backing the array. The Bool and Pointer arrays return helper classes from their `elements` getter. These helper classes implement the `List` interface utilizing the `operator []` implementation of the underlying arrays. This is also implemented directly in the ffi_patch.dart file. The `elements` getter for array arrays is rewritten in the CFE (use_sites.dart) to instantiate a helper class to which the size of a single element of the array is passed (this information is not available in ffi_patch.dart, hence the rewrite in the CFE). The helper class implements the `List` interface and performs some pointer arithmetic with the provided element size to implement its methods. The `elements` getters for struct and union arrays are also rewritten in the CFE to instantiate a helper class to which a constructor tearoff for instantiating the underlying struct/union type is passed. The helper class also implements the `List` interface and uses the provided constructor tearoff to create instantiated structs/unions of the elements in the list. Last, but not least, the `elements` getter for abi-specific integer arrays is also rewritten in the CFI to instantiate a helper class to which a closure is provided to load abi specific integers from the underlying array data structure. TEST=tests/ffi/array_compound_elements_test.dart TEST=tests/ffi/array_primitive_elements_generated_test.dart CoreLibraryReviewExempt: Dart VM only. Bug: #45508 Change-Id: I211a42174057c39632c6a363d4e8e6fa8e94e801 Cq-Include-Trybots: dart/try:vm-aot-android-release-arm64c-try,vm-aot-android-release-arm_x64-try,vm-aot-asan-linux-release-x64-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-msan-linux-release-x64-try,vm-aot-obfuscate-linux-release-x64-try,vm-aot-optimization-level-linux-release-x64-try,vm-aot-tsan-linux-release-x64-try,vm-aot-ubsan-linux-release-x64-try,vm-aot-win-debug-arm64-try,vm-aot-win-debug-x64-try,vm-aot-win-debug-x64c-try,vm-appjit-linux-debug-x64-try,vm-asan-linux-release-arm64-try,vm-asan-linux-release-x64-try,vm-checked-mac-release-arm64-try,vm-eager-optimization-linux-release-ia32-try,vm-eager-optimization-linux-release-x64-try,vm-ffi-android-debug-arm-try,vm-ffi-android-debug-arm64c-try,vm-ffi-mac-debug-simarm64_arm64-try,vm-ffi-qemu-linux-release-arm-try,vm-ffi-qemu-linux-release-riscv64-try,vm-fuchsia-release-arm64-try,vm-fuchsia-release-x64-try,vm-linux-debug-ia32-try,vm-linux-debug-x64-try,vm-linux-debug-x64c-try,vm-mac-debug-arm64-try,vm-mac-debug-x64-try,vm-msan-linux-release-arm64-try,vm-msan-linux-release-x64-try,vm-reload-linux-debug-x64-try,vm-reload-rollback-linux-debug-x64-try,vm-tsan-linux-release-arm64-try,vm-tsan-linux-release-x64-try,vm-ubsan-linux-release-arm64-try,vm-ubsan-linux-release-x64-try,vm-win-debug-arm64-try,vm-win-debug-x64-try,vm-win-debug-x64c-try,vm-win-release-ia32-try Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/414821 Commit-Queue: Daco Harkes <[email protected]> Reviewed-by: Daco Harkes <[email protected]> Reviewed-by: Alexander Markov <[email protected]> Reviewed-by: Lasse Nielsen <[email protected]>
1 parent 913e998 commit c326065

12 files changed

+3748
-58
lines changed

‎BUILD.gn

+2
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,8 @@ if (is_fuchsia) {
240240
"tests/ffi/address_of_typeddata_generated_test.dart",
241241
"tests/ffi/aliasing_test.dart",
242242
"tests/ffi/allocator_test.dart",
243+
"tests/ffi/array_compound_elements_test.dart",
244+
"tests/ffi/array_primitive_elements_generated_test.dart",
243245
"tests/ffi/async_void_function_callbacks_test.dart",
244246
"tests/ffi/bool_test.dart",
245247
"tests/ffi/c_types_test.dart",

‎pkg/vm/lib/modular/transformations/ffi/common.dart

+38
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,13 @@ class FfiTransformer extends Transformer {
263263
final Procedure unionPointerMinusOperator;
264264
final Procedure unionPointerElementAtTearoff;
265265
final Procedure uint8PointerAsTypedList;
266+
final Constructor arrayListConstructor;
267+
final Constructor arrayArrayListConstructor;
268+
final Constructor abiSpecificIntegerArrayListConstructor;
269+
final Procedure arrayArrayElements;
270+
final Procedure structArrayElements;
271+
final Procedure unionArrayElements;
272+
final Procedure abiSpecificIntegerArrayElements;
266273
final Procedure structArrayElemAt;
267274
final Procedure unionArrayElemAt;
268275
final Procedure arrayArrayElemAt;
@@ -698,6 +705,37 @@ class FfiTransformer extends Transformer {
698705
'Uint8Pointer',
699706
'asTypedList',
700707
),
708+
arrayArrayElements = index.getProcedure(
709+
'dart:ffi',
710+
'ArrayArray',
711+
'get:elements',
712+
),
713+
structArrayElements = index.getProcedure(
714+
'dart:ffi',
715+
'StructArray',
716+
'get:elements',
717+
),
718+
unionArrayElements = index.getProcedure(
719+
'dart:ffi',
720+
'UnionArray',
721+
'get:elements',
722+
),
723+
abiSpecificIntegerArrayElements = index.getProcedure(
724+
'dart:ffi',
725+
'AbiSpecificIntegerArray',
726+
'get:elements',
727+
),
728+
arrayArrayListConstructor = index.getConstructor(
729+
'dart:ffi',
730+
'_ArrayArrayList',
731+
'',
732+
),
733+
arrayListConstructor = index.getConstructor('dart:ffi', '_ArrayList', ''),
734+
abiSpecificIntegerArrayListConstructor = index.getConstructor(
735+
'dart:ffi',
736+
'_AbiSpecificIntegerArrayList',
737+
'',
738+
),
701739
structArrayElemAt = index.getProcedure('dart:ffi', 'StructArray', '[]'),
702740
unionArrayElemAt = index.getProcedure('dart:ffi', 'UnionArray', '[]'),
703741
arrayArrayElemAt = index.getProcedure('dart:ffi', 'ArrayArray', '[]'),

‎pkg/vm/lib/modular/transformations/ffi/use_sites.dart

+179
Original file line numberDiff line numberDiff line change
@@ -436,6 +436,13 @@ mixin _FfiUseSiteTransformer on FfiTransformer {
436436
ensureNativeTypeValid(nativeType, node, allowStructAndUnion: true);
437437

438438
return _replaceRefArray(node);
439+
} else if (target == structArrayElements ||
440+
target == unionArrayElements) {
441+
final DartType nativeType = node.arguments.types[0];
442+
443+
ensureNativeTypeValid(nativeType, node, allowStructAndUnion: true);
444+
445+
return _replaceArrayElements(node);
439446
} else if (target == arrayArrayElemAt) {
440447
final DartType nativeType = node.arguments.types[0];
441448

@@ -447,6 +454,28 @@ mixin _FfiUseSiteTransformer on FfiTransformer {
447454
);
448455

449456
return _replaceArrayArrayElemAt(node);
457+
} else if (target == abiSpecificIntegerArrayElements) {
458+
final DartType nativeType = node.arguments.types[0];
459+
460+
ensureNativeTypeValid(
461+
nativeType,
462+
node,
463+
allowStructAndUnion: true,
464+
allowInlineArray: true,
465+
);
466+
467+
return _replaceAbiSpecificIntegerElements(node);
468+
} else if (target == arrayArrayElements) {
469+
final DartType nativeType = node.arguments.types[0];
470+
471+
ensureNativeTypeValid(
472+
nativeType,
473+
node,
474+
allowInlineArray: true,
475+
allowStructAndUnion: true,
476+
);
477+
478+
return _replaceArrayArrayElements(node);
450479
} else if (target == arrayArrayAssignAt) {
451480
final DartType nativeType = node.arguments.types[0];
452481

@@ -1355,6 +1384,156 @@ mixin _FfiUseSiteTransformer on FfiTransformer {
13551384
);
13561385
}
13571386

1387+
/// Replaces `StructArray<MyCompound>.elements` and `UnionArray<MyCompound>.elements` with:
1388+
///
1389+
/// ```
1390+
/// _ArrayList<MyCompound>(this._array, sizeOf(MyCompound), MyCompound.#fromTypedDataBase);
1391+
/// ```
1392+
Expression _replaceArrayElements(StaticInvocation node) {
1393+
final dartType = node.arguments.types[0];
1394+
final clazz = (dartType as InterfaceType).classNode;
1395+
final constructor = clazz.constructors.firstWhere(
1396+
(c) => c.name == Name("#fromTypedDataBase"),
1397+
);
1398+
1399+
return ConstructorInvocation(
1400+
arrayListConstructor,
1401+
Arguments(
1402+
[
1403+
node.arguments.positional[0],
1404+
inlineSizeOf(dartType)!,
1405+
ConstantExpression(
1406+
dartType.typeArguments.isNotEmpty
1407+
? InstantiationConstant(
1408+
ConstructorTearOffConstant(constructor),
1409+
dartType.typeArguments,
1410+
)
1411+
: ConstructorTearOffConstant(constructor),
1412+
),
1413+
],
1414+
types: [dartType],
1415+
),
1416+
);
1417+
}
1418+
1419+
/// Replaces `ArrayArray<Type>.elements` with:
1420+
///
1421+
/// ```
1422+
/// _ArrayArrayList<Type>(this._array, sizeOf(Type));
1423+
/// ```
1424+
Expression _replaceArrayArrayElements(StaticInvocation node) {
1425+
final dartType = node.arguments.types[0];
1426+
final elementType = arraySingleElementType(dartType as InterfaceType);
1427+
1428+
return ConstructorInvocation(
1429+
arrayArrayListConstructor,
1430+
Arguments(
1431+
[
1432+
node.arguments.positional[0],
1433+
inlineSizeOf(elementType as InterfaceType)!,
1434+
],
1435+
types: [dartType],
1436+
),
1437+
);
1438+
}
1439+
1440+
/// Replaces `AbiSpecificIntegerArray<Type>.elements` with:
1441+
///
1442+
/// ```
1443+
/// AbiSpecificIntegerArrayList<Type>(
1444+
/// this._array,
1445+
/// (Array<Type> array, int index) {
1446+
/// return _loadAbiSpecificIntAtIndex(array._typedDataBase, array._offsetInBytes, index);
1447+
/// },
1448+
/// (Array<Type> array, int index, int value) {
1449+
/// return _storeAbiSpecificIntAtIndex(array._typedDataBase, array._offsetInBytes, index, value);
1450+
/// }
1451+
/// );
1452+
/// ```
1453+
Expression _replaceAbiSpecificIntegerElements(StaticInvocation node) {
1454+
final typeArg = node.arguments.types[0];
1455+
final nativeTypeCfe =
1456+
NativeTypeCfe(this, typeArg) as AbiSpecificNativeTypeCfe;
1457+
1458+
final arrayLoadVar = VariableDeclaration(
1459+
"#array",
1460+
type: InterfaceType(arrayClass, Nullability.nonNullable, [typeArg]),
1461+
isSynthesized: true,
1462+
)..fileOffset = node.fileOffset;
1463+
final indexLoadVar = VariableDeclaration(
1464+
"#index",
1465+
type: coreTypes.intNonNullableRawType,
1466+
isSynthesized: true,
1467+
)..fileOffset = node.fileOffset;
1468+
final loadClosure = FunctionExpression(
1469+
FunctionNode(
1470+
ReturnStatement(
1471+
abiSpecificLoadOrStoreExpression(
1472+
nativeTypeCfe,
1473+
typedDataBase: getCompoundTypedDataBaseField(
1474+
VariableGet(arrayLoadVar),
1475+
node.fileOffset,
1476+
),
1477+
offsetInBytes: getCompoundOffsetInBytesField(
1478+
VariableGet(arrayLoadVar),
1479+
node.fileOffset,
1480+
),
1481+
index: VariableGet(indexLoadVar),
1482+
fileOffset: node.fileOffset,
1483+
),
1484+
),
1485+
positionalParameters: [arrayLoadVar, indexLoadVar],
1486+
returnType: coreTypes.intNonNullableRawType,
1487+
),
1488+
);
1489+
1490+
final arrayStoreVar = VariableDeclaration(
1491+
"#array",
1492+
type: InterfaceType(arrayClass, Nullability.nonNullable, [typeArg]),
1493+
isSynthesized: true,
1494+
)..fileOffset = node.fileOffset;
1495+
final indexStoreVar = VariableDeclaration(
1496+
"#index",
1497+
type: coreTypes.intNonNullableRawType,
1498+
isSynthesized: true,
1499+
)..fileOffset = node.fileOffset;
1500+
final valueStoreVar = VariableDeclaration(
1501+
"#value",
1502+
type: coreTypes.intNullableRawType,
1503+
isSynthesized: true,
1504+
)..fileOffset = node.fileOffset;
1505+
final storeClosure = FunctionExpression(
1506+
FunctionNode(
1507+
ReturnStatement(
1508+
abiSpecificLoadOrStoreExpression(
1509+
nativeTypeCfe,
1510+
typedDataBase: getCompoundTypedDataBaseField(
1511+
VariableGet(arrayStoreVar),
1512+
node.fileOffset,
1513+
),
1514+
offsetInBytes: getCompoundOffsetInBytesField(
1515+
VariableGet(arrayStoreVar),
1516+
node.fileOffset,
1517+
),
1518+
index: VariableGet(indexStoreVar),
1519+
value: VariableGet(valueStoreVar),
1520+
fileOffset: node.fileOffset,
1521+
),
1522+
),
1523+
positionalParameters: [arrayStoreVar, indexStoreVar, valueStoreVar],
1524+
returnType: coreTypes.intNonNullableRawType,
1525+
),
1526+
);
1527+
1528+
return ConstructorInvocation(
1529+
abiSpecificIntegerArrayListConstructor,
1530+
Arguments(
1531+
[node.arguments.positional[0], loadClosure, storeClosure],
1532+
types: [typeArg],
1533+
),
1534+
);
1535+
}
1536+
13581537
/// Generates an expression that returns a new `Array<dartType>`.
13591538
///
13601539
/// Sample input getter:

‎pkg/vm/testcases/transformations/ffi/compound_array_elements.dart

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
2+
// for details. All rights reserved. Use of this source code is governed by a
3+
// BSD-style license that can be found in the LICENSE file.
4+
5+
import 'dart:ffi';
6+
7+
void main() {
8+
final struct = Struct.create<TestStruct>();
9+
10+
print(struct.structArray.elements);
11+
print(struct.unionArray.elements);
12+
print(struct.arrayArray.elements);
13+
print(struct.abiSpecificIntegerArray.elements);
14+
}
15+
16+
final class TestStruct extends Struct {
17+
@Array(5)
18+
external Array<MyStruct> structArray;
19+
20+
@Array(5)
21+
external Array<MyUnion> unionArray;
22+
23+
@Array(5, 5)
24+
external Array<Array<Int8>> arrayArray;
25+
26+
@Array(5)
27+
external Array<WChar> abiSpecificIntegerArray;
28+
}
29+
30+
final class MyStruct extends Struct {
31+
@Int8()
32+
external int structValue;
33+
}
34+
35+
final class MyUnion extends Union {
36+
@Int32()
37+
external int unionAlt1;
38+
39+
@Float()
40+
external double unionAlt2;
41+
}

0 commit comments

Comments
 (0)