Skip to content

Commit 1ef9fb1

Browse files
authored
[record_use] JSON objects for loading units (dart-lang#3116)
The storage part of: * dart-lang#2979
1 parent 5dbae2b commit 1ef9fb1

42 files changed

Lines changed: 479 additions & 133 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎pkgs/record_use/doc/schema/record_use.schema.json‎

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@
1919
}
2020
]
2121
},
22-
"loading_unit": {
23-
"type": "string"
22+
"loading_unit_index": {
23+
"type": "integer"
2424
}
2525
},
2626
"required": [
27-
"loading_unit",
27+
"loading_unit_index",
2828
"type"
2929
],
3030
"if": {
@@ -281,12 +281,12 @@
281281
}
282282
]
283283
},
284-
"loading_unit": {
285-
"type": "string"
284+
"loading_unit_index": {
285+
"type": "integer"
286286
}
287287
},
288288
"required": [
289-
"loading_unit",
289+
"loading_unit_index",
290290
"type"
291291
],
292292
"allOf": [
@@ -342,6 +342,17 @@
342342
}
343343
]
344344
},
345+
"LoadingUnit": {
346+
"type": "object",
347+
"properties": {
348+
"name": {
349+
"type": "string"
350+
}
351+
},
352+
"required": [
353+
"name"
354+
]
355+
},
345356
"MapEntry": {
346357
"type": "object",
347358
"properties": {
@@ -422,6 +433,12 @@
422433
"$ref": "#/definitions/Constant"
423434
}
424435
},
436+
"loading_units": {
437+
"type": "array",
438+
"items": {
439+
"$ref": "#/definitions/LoadingUnit"
440+
}
441+
},
425442
"metadata": {
426443
"type": "object",
427444
"properties": {

‎pkgs/record_use/lib/src/recordings.dart‎

Lines changed: 52 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,11 @@ Error: $e
6666
}
6767

6868
factory Recordings._fromSyntax(RecordedUsesSyntax syntax) {
69-
final definitionContext = _deserializeDefinitions(syntax);
69+
final loadingUnitContext = _deserializeLoadingUnits(syntax);
70+
final definitionContext = _deserializeDefinitions(
71+
syntax,
72+
loadingUnitContext,
73+
);
7074
final context = _deserializeConstants(syntax, definitionContext);
7175

7276
final callsForDefinition = <Definition, List<CallReference>>{};
@@ -109,14 +113,28 @@ Error: $e
109113
);
110114
}
111115

116+
static LoadingUnitDeserializationContext _deserializeLoadingUnits(
117+
RecordedUsesSyntax syntax,
118+
) {
119+
final loadingUnits = <String>[];
120+
for (final unit in syntax.loadingUnits ?? <LoadingUnitSyntax>[]) {
121+
loadingUnits.add(unit.name);
122+
}
123+
return LoadingUnitDeserializationContext(loadingUnits);
124+
}
125+
112126
static DefinitionDeserializationContext _deserializeDefinitions(
113127
RecordedUsesSyntax syntax,
128+
LoadingUnitDeserializationContext loadingUnitContext,
114129
) {
115130
final definitions = <Definition>[];
116131
for (final definitionSyntax in syntax.definitions ?? <DefinitionSyntax>[]) {
117132
definitions.add(DefinitionProtected.fromSyntax(definitionSyntax));
118133
}
119-
return DefinitionDeserializationContext(definitions);
134+
return DefinitionDeserializationContext.fromPrevious(
135+
loadingUnitContext,
136+
definitions,
137+
);
120138
}
121139

122140
static DeserializationContext _deserializeConstants(
@@ -148,7 +166,12 @@ Error: $e
148166

149167
RecordedUsesSyntax _toSyntax() {
150168
final allConstants = _collectConstants();
151-
final definitionContext = _serializeDefinitions(allConstants);
169+
final allLoadingUnits = _collectLoadingUnits();
170+
final loadingUnitContext = _serializeLoadingUnits(allLoadingUnits);
171+
final definitionContext = _serializeDefinitions(
172+
allConstants,
173+
loadingUnitContext,
174+
);
152175
final (context, constantSyntax) = _serializeConstants(
153176
allConstants,
154177
definitionContext,
@@ -174,6 +197,11 @@ Error: $e
174197
return RecordedUsesSyntax(
175198
metadata: metadata.toSyntax(),
176199
constants: constantSyntax.isEmpty ? null : constantSyntax,
200+
loadingUnits: allLoadingUnits.isEmpty
201+
? null
202+
: allLoadingUnits
203+
.map((unit) => LoadingUnitSyntax(name: unit))
204+
.toList(),
177205
definitions: context.definitions.isEmpty
178206
? null
179207
: context.definitions.keys
@@ -185,7 +213,7 @@ Error: $e
185213
);
186214
}
187215

188-
List<Constant> _collectConstants() => {
216+
Iterable<Constant> _collectConstants() => {
189217
...calls.values
190218
.expand((calls) => calls)
191219
.whereType<CallWithArguments>()
@@ -222,23 +250,38 @@ Error: $e
222250
ConstructorTearoffReference() => <Constant>[],
223251
},
224252
),
225-
}.flatten().toList();
253+
}.flatten();
254+
255+
Iterable<String> _collectLoadingUnits() => {
256+
...calls.values.expand((calls) => calls).map((call) => call.loadingUnit!),
257+
...instances.values
258+
.expand((instances) => instances)
259+
.map((instance) => instance.loadingUnit!),
260+
};
261+
262+
LoadingUnitSerializationContext _serializeLoadingUnits(
263+
Iterable<String> allLoadingUnits,
264+
) => LoadingUnitSerializationContext(
265+
allLoadingUnits.asMapToIndices,
266+
);
226267

227268
DefinitionSerializationContext _serializeDefinitions(
228-
List<Constant> allConstants,
269+
Iterable<Constant> allConstants,
270+
LoadingUnitSerializationContext loadingUnitContext,
229271
) {
230272
final allDefinitions = {
231273
...calls.keys,
232274
...instances.keys,
233275
...allConstants.whereType<InstanceConstant>().map((c) => c.definition),
234-
}.toList();
235-
return DefinitionSerializationContext(
276+
};
277+
return DefinitionSerializationContext.fromPrevious(
278+
loadingUnitContext,
236279
allDefinitions.asMapToIndices,
237280
);
238281
}
239282

240283
(SerializationContext, List<ConstantSyntax>) _serializeConstants(
241-
List<Constant> allConstants,
284+
Iterable<Constant> allConstants,
242285
DefinitionSerializationContext definitionContext,
243286
) {
244287
final constantsMap = allConstants.asMapToIndices;

‎pkgs/record_use/lib/src/reference.dart‎

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,13 @@ sealed class CallReference extends Reference {
5454
CallSyntax syntax,
5555
DeserializationContext context,
5656
) => switch (syntax) {
57-
TearoffCallSyntax() => CallTearoff(loadingUnit: syntax.loadingUnit),
57+
TearoffCallSyntax() => CallTearoff(
58+
loadingUnit: context.loadingUnits[syntax.loadingUnitIndex],
59+
),
5860
WithArgumentsCallSyntax(
5961
:final named,
6062
:final positional,
61-
:final loadingUnit,
63+
:final loadingUnitIndex,
6264
) =>
6365
CallWithArguments(
6466
positionalArguments: (positional ?? [])
@@ -67,7 +69,7 @@ sealed class CallReference extends Reference {
6769
namedArguments: (named ?? {}).map(
6870
(name, index) => MapEntry(name, _argumentFromSyntax(index, context)),
6971
),
70-
loadingUnit: loadingUnit,
72+
loadingUnit: context.loadingUnits[loadingUnitIndex],
7173
),
7274
_ => throw UnimplementedError('Unknown CallSyntax type'),
7375
};
@@ -127,7 +129,7 @@ final class CallWithArguments extends CallReference {
127129
}
128130

129131
return WithArgumentsCallSyntax(
130-
loadingUnit: loadingUnit!,
132+
loadingUnitIndex: context.loadingUnits[loadingUnit!]!,
131133
named: namedArgs.isNotEmpty ? namedArgs : null,
132134
positional: positionalArguments.isEmpty
133135
? null
@@ -238,7 +240,7 @@ final class CallTearoff extends CallReference {
238240

239241
@override
240242
TearoffCallSyntax _toSyntax(SerializationContext context) =>
241-
TearoffCallSyntax(loadingUnit: loadingUnit!);
243+
TearoffCallSyntax(loadingUnitIndex: context.loadingUnits[loadingUnit!]!);
242244

243245
@override
244246
@visibleForTesting
@@ -272,16 +274,16 @@ sealed class InstanceReference extends Reference {
272274
) => switch (syntax) {
273275
ConstantInstanceSyntax(
274276
:final constantIndex,
275-
:final loadingUnit,
277+
:final loadingUnitIndex,
276278
) =>
277279
InstanceConstantReference(
278280
instanceConstant: context.constants[constantIndex] as InstanceConstant,
279-
loadingUnit: loadingUnit,
281+
loadingUnit: context.loadingUnits[loadingUnitIndex],
280282
),
281283
CreationInstanceSyntax(
282284
:final named,
283285
:final positional,
284-
:final loadingUnit,
286+
:final loadingUnitIndex,
285287
) =>
286288
InstanceCreationReference(
287289
positionalArguments: (positional ?? [])
@@ -293,11 +295,12 @@ sealed class InstanceReference extends Reference {
293295
CallReference._argumentFromSyntax(index, context),
294296
),
295297
),
296-
loadingUnit: loadingUnit,
298+
loadingUnit: context.loadingUnits[loadingUnitIndex],
299+
),
300+
TearoffInstanceSyntax(:final loadingUnitIndex) =>
301+
ConstructorTearoffReference(
302+
loadingUnit: context.loadingUnits[loadingUnitIndex],
297303
),
298-
TearoffInstanceSyntax(:final loadingUnit) => ConstructorTearoffReference(
299-
loadingUnit: loadingUnit,
300-
),
301304
_ => throw UnimplementedError('Unknown InstanceSyntax type'),
302305
};
303306

@@ -330,7 +333,7 @@ final class InstanceConstantReference extends InstanceReference {
330333
ConstantInstanceSyntax _toSyntax(SerializationContext context) =>
331334
ConstantInstanceSyntax(
332335
constantIndex: context.constants[instanceConstant]!,
333-
loadingUnit: loadingUnit!,
336+
loadingUnitIndex: context.loadingUnits[loadingUnit!]!,
334337
);
335338

336339
@override
@@ -391,7 +394,7 @@ final class InstanceCreationReference extends InstanceReference {
391394
}
392395

393396
return CreationInstanceSyntax(
394-
loadingUnit: loadingUnit!,
397+
loadingUnitIndex: context.loadingUnits[loadingUnit!]!,
395398
named: namedArgs.isNotEmpty ? namedArgs : null,
396399
positional: positionalArguments.isEmpty
397400
? null
@@ -475,7 +478,9 @@ final class ConstructorTearoffReference extends InstanceReference {
475478

476479
@override
477480
TearoffInstanceSyntax _toSyntax(SerializationContext context) =>
478-
TearoffInstanceSyntax(loadingUnit: loadingUnit!);
481+
TearoffInstanceSyntax(
482+
loadingUnitIndex: context.loadingUnits[loadingUnit!]!,
483+
);
479484

480485
@override
481486
@visibleForTesting

‎pkgs/record_use/lib/src/serialization_context.dart‎

Lines changed: 39 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,17 @@
2929
/// The order of operations ensures that all dependencies are available at each
3030
/// step:
3131
///
32-
/// 1. **Definitions**: [Definition] objects are deserialized from or
33-
/// serialized to the [RecordedUsesSyntax.definitions] pool first.
34-
/// 2. **Constants**: [Constant] objects are deserialized from or serialized
35-
/// to the [RecordedUsesSyntax.constants] pool second. They may contain
32+
/// 1. **Loading Units**: Loading unit identifiers are deserialized from or
33+
/// serialized to the [RecordedUsesSyntax.loadingUnits] pool first.
34+
/// 2. **Definitions**: [Definition] objects are deserialized from or
35+
/// serialized to the [RecordedUsesSyntax.definitions] pool second.
36+
/// 3. **Constants**: [Constant] objects are deserialized from or serialized
37+
/// to the [RecordedUsesSyntax.constants] pool third. They may contain
3638
/// references to the definitions pool (e.g. for [InstanceConstant]) and the
3739
/// constants pool (for recursive collections).
38-
/// 3. **Recordings**: [Recordings] are (de)serialized last from or to
39-
/// [RecordedUsesSyntax.recordings] as they depend on [Constant]s and
40-
/// [Definition]s.
41-
// TODO(https://github.com/dart-lang/native/issues/2979): Add a pool for
42-
// loading units.
40+
/// 4. **Recordings**: [Recordings] are (de)serialized last from or to
41+
/// [RecordedUsesSyntax.recordings] as they depend on loading units,
42+
/// [Constant]s, and [Definition]s.
4343
library;
4444

4545
import 'package:meta/meta.dart';
@@ -49,12 +49,24 @@ import 'definition.dart';
4949
import 'recordings.dart';
5050
import 'syntax.g.dart';
5151

52+
/// Context providing access to the loading unit pool during deserialization.
53+
@immutable
54+
base class LoadingUnitDeserializationContext {
55+
final List<String> loadingUnits;
56+
57+
const LoadingUnitDeserializationContext(this.loadingUnits);
58+
}
59+
5260
/// Context providing access to the [Definition] pool during deserialization.
5361
@immutable
54-
base class DefinitionDeserializationContext {
62+
base class DefinitionDeserializationContext
63+
extends LoadingUnitDeserializationContext {
5564
final List<Definition> definitions;
5665

57-
const DefinitionDeserializationContext(this.definitions);
66+
DefinitionDeserializationContext.fromPrevious(
67+
LoadingUnitDeserializationContext previous,
68+
this.definitions,
69+
) : super(previous.loadingUnits);
5870
}
5971

6072
/// The final deserialization state where all pools are resolved.
@@ -67,15 +79,27 @@ final class DeserializationContext extends DefinitionDeserializationContext {
6779
DeserializationContext.fromPrevious(
6880
DefinitionDeserializationContext previous,
6981
this.constants,
70-
) : super(previous.definitions);
82+
) : super.fromPrevious(previous, previous.definitions);
83+
}
84+
85+
/// Context providing access to the loading unit index map during serialization.
86+
@immutable
87+
base class LoadingUnitSerializationContext {
88+
final Map<String, int> loadingUnits;
89+
90+
const LoadingUnitSerializationContext(this.loadingUnits);
7191
}
7292

7393
/// Context providing access to the [Definition] index map during serialization.
7494
@immutable
75-
base class DefinitionSerializationContext {
95+
base class DefinitionSerializationContext
96+
extends LoadingUnitSerializationContext {
7697
final Map<Definition, int> definitions;
7798

78-
const DefinitionSerializationContext(this.definitions);
99+
DefinitionSerializationContext.fromPrevious(
100+
LoadingUnitSerializationContext previous,
101+
this.definitions,
102+
) : super(previous.loadingUnits);
79103
}
80104

81105
/// The final serialization state where all index maps are available.
@@ -88,5 +112,5 @@ final class SerializationContext extends DefinitionSerializationContext {
88112
SerializationContext.fromPrevious(
89113
DefinitionSerializationContext previous,
90114
this.constants,
91-
) : super(previous.definitions);
115+
) : super.fromPrevious(previous, previous.definitions);
92116
}

0 commit comments

Comments
 (0)