-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdependencies.rs
More file actions
890 lines (860 loc) · 38.2 KB
/
Copy pathdependencies.rs
File metadata and controls
890 lines (860 loc) · 38.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
use std::collections::BTreeSet;
use crate::{
abi::AbiImportId,
ast::{ActionKind, ManagedFieldId, Program, SettingFileFilter, SettingKind, StateSource},
intrinsic_registry::{self, DependencyRoot, RuntimeHelperId},
semantic::{ResolvedMember, ResolvedValue, SemanticModel},
stdlib::{CoreTypeId, Implementation, IntrinsicId, StdlibItemId, StdlibTypeId},
types::{TypeId, TypeKind},
wasm_ir,
};
use super::runtime_helper_registry;
#[derive(Debug, Default)]
pub(super) struct BackendDependencies {
stdlib_items: BTreeSet<StdlibItemId>,
helpers: BTreeSet<RuntimeHelperId>,
host_imports: BTreeSet<AbiImportId>,
needs_native_pointer_size: bool,
memory_read_capacity: u32,
}
impl BackendDependencies {
pub fn analyze(
program: &Program,
semantics: &SemanticModel,
wasm_ir: &wasm_ir::Program,
reachability: &super::reachability::Reachability,
capabilities: &crate::capabilities::CapabilityAnalysis,
automatic_shape: Option<&crate::shape_selection::ShapeSelectionPlan>,
) -> Self {
let mut dependencies = Self::default();
if program
.actions
.iter()
.any(|action| action.kind == ActionKind::SelectProcess)
{
dependencies.require_import(AbiImportId::ProcessAttachByPid);
dependencies.require_import(AbiImportId::ProcessListByName);
} else {
dependencies.require_import(AbiImportId::ProcessAttach);
}
dependencies.require_import(AbiImportId::ProcessDetach);
dependencies.require_import(AbiImportId::ProcessIsOpen);
// Polling rates are lifecycle policy even when source never calls the
// dynamic setTickRate API directly.
dependencies.require_import(AbiImportId::RuntimeSetTickRate);
if automatic_shape.is_some() {
dependencies.require_import(AbiImportId::RuntimePrintMessage);
}
// Snapshot readers materialize every instance field of a reachable
// class. Direct field paths below cover static and live-reference
// reads. Keeping these roots separate prevents an unused declaration
// from retaining the managed-string decoder.
for class in reachability.managed_snapshots() {
let declaration = program
.managed_class(class)
.expect("reachable managed classes belong to the program");
if reachability.managed_decoders().next().is_some()
|| declaration
.all_fields()
.filter(|field| !field.is_static)
.any(|field| {
semantics.managed_field_snapshot_type(field.id)
!= semantics.managed_field_value_type(field.id)
|| semantics
.managed_field_value_type(field.id)
.is_some_and(|value| {
matches!(
crate::managed::ManagedFieldRead::for_type(
value, semantics
),
crate::managed::ManagedFieldRead::ManagedString { .. }
)
})
})
|| declaration
.all_fields()
.filter(|field| !field.is_static)
.count()
> crate::managed_read::MAX_SNAPSHOT_WORK as usize
{
dependencies.require(RuntimeHelperId::EnterManagedObject);
dependencies.require(RuntimeHelperId::ChargeManagedWork);
}
for field in declaration.all_fields().filter(|field| !field.is_static) {
dependencies.require_managed_field_reader(
field.id,
program,
semantics,
capabilities,
);
}
}
for value in reachability.managed_decoders() {
Self::require_decoder(&mut dependencies, value, semantics, capabilities);
}
if let Some(state) = &program.state {
let pointer_providers = state
.all_fields()
.filter(|field| matches!(field.source, StateSource::Pointer(_)))
.filter_map(|field| semantics.state_field_provider(field.id))
.collect::<BTreeSet<_>>();
for provider in pointer_providers {
let provider = wasm_ir.standard_library().state_provider(provider);
let Implementation::Intrinsic(direct_read) = wasm_ir
.standard_library()
.item(provider.direct_read)
.implementation
else {
unreachable!("validated state-provider reads are intrinsic")
};
dependencies.require_intrinsic(direct_read);
}
for field in state.all_fields() {
if let StateSource::Pointer(path) = &field.source {
dependencies.require_import(AbiImportId::ProcessRead);
if let Some(decoder) = path.decoder {
dependencies.require(match decoder {
crate::ast::StateMemoryDecoder::Utf8 { .. } => {
RuntimeHelperId::ReadUtf8String
}
crate::ast::StateMemoryDecoder::Utf16Le { .. } => {
RuntimeHelperId::ReadUtf16LeString
}
});
}
if matches!(path.base, crate::ast::PointerPathBase::Module { .. }) {
dependencies.require_import(AbiImportId::ProcessGetModuleAddress);
}
let direct_read = semantics.state_field_provider(field.id).map(|provider| {
let Implementation::Intrinsic(intrinsic) = wasm_ir
.standard_library()
.item(
wasm_ir
.standard_library()
.state_provider(provider)
.direct_read,
)
.implementation
else {
unreachable!("provider reads are intrinsic")
};
intrinsic
});
let native = direct_read == Some(IntrinsicId::ProcessRead);
let value =
semantics
.value_type(field.id)
.map(|ty| match semantics.types().kind(ty) {
TypeKind::Option { value, .. } => *value,
_ => ty,
});
if path.decoder.is_none() {
dependencies.require_memory_read(
value.expect("checked pointer fields have value types"),
direct_read
.and_then(intrinsic_registry::provider_read_contract)
.map(|contract| contract.address_width),
semantics,
capabilities,
);
}
if native
&& (!path.offsets.is_empty()
|| value.is_some_and(|ty| {
capabilities
.memory()
.depends_on_address_width(ty, semantics)
}))
{
dependencies.needs_native_pointer_size = true;
}
}
}
}
for action in &program.actions {
match action.kind {
ActionKind::OnStart | ActionKind::OnReset => {
dependencies.require_import(AbiImportId::TimerGetState);
}
ActionKind::Start => {
dependencies.require_import(AbiImportId::TimerGetState);
dependencies.require_import(AbiImportId::TimerStart);
}
ActionKind::Split => {
dependencies.require_import(AbiImportId::TimerGetState);
dependencies.require_import(AbiImportId::TimerSplit);
}
ActionKind::Reset => {
dependencies.require_import(AbiImportId::TimerGetState);
dependencies.require_import(AbiImportId::TimerReset);
}
ActionKind::IsLoading => {
dependencies.require_import(AbiImportId::TimerGetState);
dependencies.require_import(AbiImportId::TimerPauseGameTime);
dependencies.require_import(AbiImportId::TimerResumeGameTime);
}
ActionKind::GameTime => {
dependencies.require_import(AbiImportId::TimerGetState);
dependencies.require_import(AbiImportId::TimerSetGameTime);
}
ActionKind::Setup
| ActionKind::SelectProcess
| ActionKind::OnAttach
| ActionKind::OnDetach
| ActionKind::OnStateReady
| ActionKind::WhileAttached => {}
}
}
for (owner, expression_id) in reachability.expression_instances() {
let expression = wasm_ir
.expression(expression_id)
.expect("reachable expressions belong to Wasm IR");
let specialize = |ty| {
owner
.as_ref()
.map_or(ty, |instance| semantics.specialize_type(instance, ty))
};
match &expression.kind {
wasm_ir::ExpressionKind::Path { root, members } => {
if let Some(ResolvedValue::ManagedStatic { field, .. }) = root {
dependencies.require_managed_field_reader(
*field,
program,
semantics,
capabilities,
);
}
for member in members {
if let ResolvedMember::ManagedField(field) = member {
dependencies.require_managed_field_reader(
*field,
program,
semantics,
capabilities,
);
}
}
}
wasm_ir::ExpressionKind::Member { members, .. } => {
for member in members {
if let ResolvedMember::ManagedField(field) = member {
dependencies.require_managed_field_reader(
*field,
program,
semantics,
capabilities,
);
}
}
}
_ => {}
}
match &expression.kind {
wasm_ir::ExpressionKind::Inspect { value, .. } => {
dependencies.require(RuntimeHelperId::TimerSetVariable);
dependencies.require_display_helpers(
specialize(wasm_ir.effective_expression_type(*value)),
semantics,
reachability,
capabilities,
);
}
wasm_ir::ExpressionKind::Call { target, .. }
if matches!(
reachability.resolved_call_target(owner.as_ref(), expression.id, target),
wasm_ir::CallTarget::ManagedInstances { .. }
) =>
{
dependencies.require(RuntimeHelperId::ScanAlignedPointerRange);
dependencies.require_import(AbiImportId::ProcessGetMemoryRangeCount);
dependencies.require_import(AbiImportId::ProcessGetMemoryRangeAddress);
dependencies.require_import(AbiImportId::ProcessGetMemoryRangeSize);
dependencies.require_import(AbiImportId::ProcessGetMemoryRangeFlags);
}
wasm_ir::ExpressionKind::Call { target, .. }
if matches!(
reachability.resolved_call_target(owner.as_ref(), expression.id, target),
wasm_ir::CallTarget::DefaultFormatting { .. }
) =>
{
let wasm_ir::CallTarget::DefaultFormatting {
mode,
receiver_type,
..
} = reachability.resolved_call_target(owner.as_ref(), expression.id, target)
else {
unreachable!()
};
let receiver_type = specialize(*receiver_type);
if *mode == wasm_ir::FormattingMode::Debug
&& matches!(
semantics.types().kind(receiver_type),
TypeKind::Standard(StdlibTypeId::String)
| TypeKind::Builtin(CoreTypeId::Char)
)
{
dependencies.require(RuntimeHelperId::QuoteDebugString);
}
dependencies.require_display_helpers(
receiver_type,
semantics,
reachability,
capabilities,
);
}
wasm_ir::ExpressionKind::Call {
target, arguments, ..
} if matches!(
reachability.resolved_call_target(owner.as_ref(), expression.id, target),
wasm_ir::CallTarget::Intrinsic { .. }
) =>
{
let wasm_ir::CallTarget::Intrinsic {
item,
intrinsic,
receiver_type,
type_arguments,
..
} = reachability.resolved_call_target(owner.as_ref(), expression.id, target)
else {
unreachable!()
};
dependencies.stdlib_items.insert(*item);
dependencies.require_intrinsic(*intrinsic);
if *intrinsic == IntrinsicId::ProcessRead
|| intrinsic_registry::provider_read_contract(*intrinsic).is_some()
{
dependencies.require_memory_read(
specialize(type_arguments[0]),
intrinsic_registry::provider_read_contract(*intrinsic)
.map(|contract| contract.address_width),
semantics,
capabilities,
);
}
if *intrinsic == IntrinsicId::ProcessFollow
|| (*intrinsic == IntrinsicId::ProcessRead
&& type_arguments.first().is_some_and(|ty| {
capabilities
.memory()
.depends_on_address_width(specialize(*ty), semantics)
}))
{
dependencies.needs_native_pointer_size = true;
}
if matches!(
intrinsic,
IntrinsicId::MemoryReaderReadUtf8 | IntrinsicId::MemoryReaderReadUtf16Le
) {
let receiver_type = specialize(
receiver_type.expect("MemoryReader intrinsics always have a receiver"),
);
let TypeKind::Standard(reader) = semantics.types().kind(receiver_type)
else {
unreachable!("concrete MemoryReader receivers are standard types")
};
let reads_utf8 = *intrinsic == IntrinsicId::MemoryReaderReadUtf8;
match intrinsic_registry::memory_reader_backend(*reader)
.expect("catalog MemoryReader implementations have a backend")
{
intrinsic_registry::MemoryReaderBackend::Process => {
dependencies.require(if reads_utf8 {
RuntimeHelperId::ReadUtf8String
} else {
RuntimeHelperId::ReadUtf16LeString
});
}
intrinsic_registry::MemoryReaderBackend::Provider(contract) => {
dependencies.require(contract.reader);
dependencies.require(if reads_utf8 {
RuntimeHelperId::Utf8StringFromMemory
} else {
RuntimeHelperId::Utf16LeStringFromMemory
});
}
}
}
for displayed in intrinsic_registry::contract(*intrinsic)
.dependency_roots
.iter()
.filter_map(|root| match root {
DependencyRoot::DisplayArgument(index) => {
arguments.get(usize::from(*index))
}
DependencyRoot::Helper(_)
| DependencyRoot::HostImport(_)
| DependencyRoot::MemoryReader => None,
})
{
let ty = wasm_ir
.expression(*displayed)
.expect("intrinsic arguments belong to Wasm IR")
.ty;
dependencies.require_display_helpers(
specialize(ty),
semantics,
reachability,
capabilities,
);
}
}
wasm_ir::ExpressionKind::InterpolatedString(parts) => {
dependencies.require(RuntimeHelperId::JoinStrings);
for source in parts.iter().filter_map(|part| match part {
wasm_ir::InterpolatedPart::Expression {
string_conversion_source,
..
} => *string_conversion_source,
wasm_ir::InterpolatedPart::Text(_) => None,
}) {
dependencies.require_display_helpers(
specialize(source),
semantics,
reachability,
capabilities,
);
}
}
wasm_ir::ExpressionKind::Cast { value }
if matches!(
semantics.types().kind(specialize(expression.ty)),
TypeKind::Standard(StdlibTypeId::String)
) =>
{
let source = wasm_ir
.expression(*value)
.expect("cast operand belongs to Wasm IR")
.ty;
let source = specialize(source);
dependencies.require_display_helpers(
source,
semantics,
reachability,
capabilities,
);
}
_ => {}
}
}
if reachability.requires_string_equality() {
dependencies.require(RuntimeHelperId::StringEquality);
}
if reachability.derived_debugs().any(|ty| {
capabilities.derived_debug_kind(ty, semantics)
== Some(crate::capabilities::DerivedDebugKind::Structural)
}) {
dependencies.require(RuntimeHelperId::JoinStrings);
dependencies.require(RuntimeHelperId::IndentDisplay);
dependencies.require(RuntimeHelperId::WrapDebugEntry);
dependencies.require(RuntimeHelperId::WrapDebugVariant);
dependencies.require(RuntimeHelperId::QuoteDebugString);
}
for ty in reachability.derived_debugs() {
dependencies.require_display_helpers(ty, semantics, reachability, capabilities);
}
if !program.settings.is_empty() {
let has_values = program
.settings
.iter()
.any(|setting| !matches!(&setting.kind, SettingKind::Title { .. }));
let has_string_values = program.settings.iter().any(|setting| {
matches!(
&setting.kind,
SettingKind::Text { .. }
| SettingKind::Choice { .. }
| SettingKind::File { .. }
)
});
if has_values {
dependencies.require(RuntimeHelperId::RefreshSettings);
dependencies.require_import(AbiImportId::SettingsMapLoad);
dependencies.require_import(AbiImportId::SettingsMapFree);
dependencies.require_import(AbiImportId::SettingsMapGet);
dependencies.require_import(AbiImportId::SettingValueFree);
}
if has_string_values {
dependencies.require(RuntimeHelperId::StringFromMemory);
}
if program
.settings
.iter()
.any(|setting| matches!(&setting.kind, SettingKind::Choice { .. }))
{
dependencies.require(RuntimeHelperId::StringEquality);
}
for setting in &program.settings {
if setting.tooltip.is_some() {
dependencies.require_import(AbiImportId::UserSettingsSetTooltip);
}
match &setting.kind {
SettingKind::Bool { .. } => {
dependencies.require_import(AbiImportId::UserSettingsAddBool);
dependencies.require_import(AbiImportId::SettingValueGetBool);
}
SettingKind::Text { .. } => {
dependencies.require_import(AbiImportId::UserSettingsAddTextInput);
dependencies.require_import(AbiImportId::SettingValueGetString);
}
SettingKind::Title { .. } => {
dependencies.require_import(AbiImportId::UserSettingsAddTitle);
}
SettingKind::Choice { .. } => {
dependencies.require_import(AbiImportId::UserSettingsAddChoice);
dependencies.require_import(AbiImportId::UserSettingsAddChoiceOption);
dependencies.require_import(AbiImportId::SettingValueGetString);
}
SettingKind::File { filters, .. } => {
dependencies.require_import(AbiImportId::UserSettingsAddFileSelect);
dependencies.require_import(AbiImportId::SettingValueGetString);
for filter in filters {
dependencies.require_import(match filter {
SettingFileFilter::Name { .. } => {
AbiImportId::UserSettingsAddFileSelectNameFilter
}
SettingFileFilter::Mime { .. } => {
AbiImportId::UserSettingsAddFileSelectMimeFilter
}
});
}
}
}
}
}
if dependencies.needs_native_pointer_size {
dependencies.require(RuntimeHelperId::DetectProcessPointerSize);
dependencies.require_import(AbiImportId::ProcessGetModuleAddress);
}
dependencies
}
// Error paths are demanded after propagation analysis. These helpers use
// only strings and numeric values, and introduce no additional Result flows.
pub fn require_managed_error_paths(
&mut self,
program: &Program,
semantics: &SemanticModel,
reachability: &super::reachability::Reachability,
capabilities: &crate::capabilities::CapabilityAnalysis,
payloads: &super::failure_payload::FailurePayloadDemand,
) -> bool {
let before = self.helpers.len();
let observed = |ty| {
semantics.types().iter().any(|(_, kind)| {
matches!(kind, TypeKind::Result { layout, value }
if *value == ty && payloads.is_demanded(*layout))
})
};
for class in reachability.managed_snapshots() {
if observed(semantics.types().id_for_managed_class(class))
&& program
.managed_class(class)
.unwrap()
.all_fields()
.any(|field| !field.is_static)
{
self.require(RuntimeHelperId::ManagedErrorField);
}
}
for source in reachability.managed_decoders() {
let decoder = capabilities.managed_decoder(source).unwrap();
if observed(decoder.output)
&& matches!(
decoder.kind,
crate::managed_read::ManagedDecoderKind::Array { .. }
| crate::managed_read::ManagedDecoderKind::List { .. }
| crate::managed_read::ManagedDecoderKind::Map { .. }
| crate::managed_read::ManagedDecoderKind::Set { .. }
)
{
self.require(RuntimeHelperId::ManagedErrorIndex);
}
}
before != self.helpers.len()
}
fn require_managed_field_reader(
&mut self,
field: ManagedFieldId,
program: &Program,
semantics: &SemanticModel,
capabilities: &crate::capabilities::CapabilityAnalysis,
) {
let declaration = program
.managed_class_declarations()
.into_iter()
.flat_map(|class| class.all_fields())
.find(|candidate| candidate.id == field)
.expect("resolved managed fields belong to the program");
let value = semantics
.managed_field_value_type(field)
.expect("checked managed fields have semantic value types");
if !declaration.is_static {
self.require(RuntimeHelperId::ManagedFieldAddress);
}
if capabilities
.memory()
.depends_on_address_width(value, semantics)
{
self.needs_native_pointer_size = true;
}
if crate::managed::ManagedFieldRead::for_type(value, semantics)
== crate::managed::ManagedFieldRead::Recursive
{
return; // The recursive decoder graph owns this read's dependencies.
}
if crate::managed::ManagedFieldRead::for_type(value, semantics)
== crate::managed::ManagedFieldRead::Fixed
{
self.require(RuntimeHelperId::ReadManagedMemory);
self.require_memory_read(value, None, semantics, capabilities);
return;
}
self.require(
if matches!(semantics.types().kind(value), TypeKind::Option { .. }) {
RuntimeHelperId::ReadOptionalManagedStringField
} else {
RuntimeHelperId::ReadManagedStringField
},
);
}
pub fn uses_helper(&self, helper: RuntimeHelperId) -> bool {
self.helpers.contains(&helper)
}
fn require_memory_read(
&mut self,
mut ty: TypeId,
address_width: Option<crate::memory::MemoryAddressWidth>,
semantics: &SemanticModel,
capabilities: &crate::capabilities::CapabilityAnalysis,
) {
if let TypeKind::Option { value, .. } = semantics.types().kind(ty) {
ty = *value;
}
if matches!(semantics.types().kind(ty), TypeKind::ManagedReference(_)) {
self.memory_read_capacity = self.memory_read_capacity.max(8);
return;
}
for width in [
crate::memory::MemoryAddressWidth::Bit32,
crate::memory::MemoryAddressWidth::Bit64,
] {
if address_width.is_some_and(|selected| selected != width) {
continue;
}
let size = capabilities
.memory()
.layout(ty, semantics, width)
.expect("reachable fixed-layout reads are MemoryReadable")
.size();
self.memory_read_capacity = self.memory_read_capacity.max(size);
}
}
pub fn scratch_requirements(
&self,
maximum_signature_len: u32,
) -> super::memory_plan::ScratchRequirements {
use super::memory_plan::{ScratchRequirements, ScratchRole};
let mut requirements = ScratchRequirements {
maximum_signature_len,
read_padding: u32::from(self.uses_helper(RuntimeHelperId::GenesisReadMemory)) * 2,
roles: self
.helpers()
.flat_map(|helper| {
runtime_helper_registry::descriptor(helper)
.scratch
.iter()
.copied()
})
.collect(),
..Default::default()
};
// Fixed helper/ABI records need at most 16 bytes; native pointer-width
// detection reads a 64-byte executable header. Dynamic-size process
// reads are bounded by their reachable types, not all declared types.
if self.host_imports().any(|import| {
matches!(
import,
AbiImportId::ProcessRead
| AbiImportId::ProcessGetModulePath
| AbiImportId::ProcessGetPath
| AbiImportId::RuntimeGetOs
| AbiImportId::RuntimeGetArch
| AbiImportId::WasiClockTimeGet
| AbiImportId::WasiFdPrestatGet
| AbiImportId::WasiPathOpen
| AbiImportId::WasiFdRead
| AbiImportId::WasiFdSeek
)
}) {
// Word-swapped emulator reads can need a byte at either end.
requirements.abi_read_capacity = self
.memory_read_capacity
.saturating_add(requirements.read_padding)
.max(if self.needs_native_pointer_size {
64
} else {
16
});
}
if self
.host_imports
.contains(&AbiImportId::SettingValueGetString)
{
requirements.roles.insert(ScratchRole::SettingsString);
requirements.roles.insert(ScratchRole::SettingsLength);
}
if self
.host_imports
.contains(&AbiImportId::SettingValueGetBool)
|| self.host_imports.contains(&AbiImportId::ProcessListByName)
{
requirements.roles.insert(ScratchRole::SettingsLength);
}
requirements
}
pub fn uses_float_format(&self) -> bool {
self.uses_helper(RuntimeHelperId::FormatF32) || self.uses_helper(RuntimeHelperId::FormatF64)
}
pub fn helpers(&self) -> impl Iterator<Item = RuntimeHelperId> + '_ {
runtime_helper_registry::DESCRIPTORS
.iter()
.map(|descriptor| descriptor.id)
.filter(|helper| self.uses_helper(*helper))
}
pub fn host_imports(&self) -> impl Iterator<Item = AbiImportId> + '_ {
self.host_imports.iter().copied()
}
pub fn needs_native_pointer_size(&self) -> bool {
self.needs_native_pointer_size
}
fn require_intrinsic(&mut self, intrinsic: IntrinsicId) {
for root in intrinsic_registry::contract(intrinsic).dependency_roots {
match root {
DependencyRoot::Helper(helper) => self.require(*helper),
DependencyRoot::HostImport(import) => self.require_import(*import),
DependencyRoot::DisplayArgument(_) => {}
DependencyRoot::MemoryReader => {}
}
}
}
fn require_display_helpers(
&mut self,
ty: TypeId,
semantics: &SemanticModel,
reachability: &super::reachability::Reachability,
capabilities: &crate::capabilities::CapabilityAnalysis,
) {
let mut pending = vec![ty];
let mut visited = BTreeSet::new();
while let Some(ty) = pending.pop() {
if !visited.insert(ty) {
continue;
}
// A custom Display/Debug implementation is an opaque formatting
// boundary. Its own reachable body contributes any helpers it
// actually uses; deriving through the source type here would keep
// an additional formatter that can never be called.
if reachability.has_custom_formatting(ty) {
continue;
}
match semantics.types().kind(ty) {
TypeKind::Builtin(CoreTypeId::F32) => self.require(RuntimeHelperId::FormatF32),
TypeKind::Builtin(CoreTypeId::F64) => self.require(RuntimeHelperId::FormatF64),
TypeKind::Builtin(CoreTypeId::Char) => self.require(RuntimeHelperId::FormatChar),
TypeKind::Builtin(
CoreTypeId::I8
| CoreTypeId::U8
| CoreTypeId::I16
| CoreTypeId::U16
| CoreTypeId::I32
| CoreTypeId::U32
| CoreTypeId::I64
| CoreTypeId::U64
| CoreTypeId::Address,
) => self.require(RuntimeHelperId::FormatI64),
_ => pending.extend(capabilities.debug_dependency_types(ty, semantics)),
}
}
}
fn require(&mut self, helper: RuntimeHelperId) {
if !self.helpers.insert(helper) {
return;
}
let descriptor = runtime_helper_registry::descriptor(helper);
for import in descriptor.host_imports {
self.require_import(*import);
}
for dependency in descriptor.dependencies {
self.require(*dependency);
}
}
fn require_import(&mut self, import: AbiImportId) {
self.host_imports.insert(import);
}
fn require_decoder(
dependencies: &mut BackendDependencies,
value: TypeId,
semantics: &SemanticModel,
capabilities: &crate::capabilities::CapabilityAnalysis,
) {
use crate::managed_read::ManagedDecoderKind;
dependencies.require(RuntimeHelperId::ReadManagedMemory);
if matches!(
capabilities.managed_decoder(value).unwrap().kind,
ManagedDecoderKind::Map { .. } | ManagedDecoderKind::Set { .. }
) {
dependencies.require(RuntimeHelperId::ChargeManagedScan);
dependencies.require(RuntimeHelperId::ChargeManagedWork);
}
match capabilities.managed_decoder(value).unwrap().kind {
ManagedDecoderKind::Array { .. }
| ManagedDecoderKind::List { .. }
| ManagedDecoderKind::Map { .. }
| ManagedDecoderKind::Set { .. } => {
dependencies.require(RuntimeHelperId::EnterManagedObject);
dependencies.require(RuntimeHelperId::ChargeManagedBytes);
dependencies.require(RuntimeHelperId::ChargeManagedElements);
dependencies.memory_read_capacity = dependencies.memory_read_capacity.max(16);
}
ManagedDecoderKind::Memory => {
let (bytes, elements) = crate::managed_read::inline_materialization_cost(
value,
capabilities.memory(),
semantics,
);
if bytes != 0 {
dependencies.require(RuntimeHelperId::ChargeManagedBytes);
}
if elements != 0 {
dependencies.require(RuntimeHelperId::ChargeManagedElements);
}
dependencies.require_memory_read(value, None, semantics, capabilities);
if capabilities
.memory()
.depends_on_address_width(value, semantics)
{
dependencies.needs_native_pointer_size = true;
}
}
ManagedDecoderKind::String => dependencies.require(RuntimeHelperId::ReadManagedString),
_ => {}
}
}
#[cfg(test)]
pub fn with_host_imports(imports: impl IntoIterator<Item = AbiImportId>) -> Self {
let mut dependencies = Self::default();
dependencies.host_imports.extend(imports);
dependencies
}
}
#[cfg(test)]
mod tests {
use crate::intrinsic_registry::RuntimeHelperId;
use super::BackendDependencies;
#[test]
fn helper_dependencies_are_closed_transitively() {
let mut dependencies = BackendDependencies::default();
dependencies.require(RuntimeHelperId::ReadUtf8String);
assert!(dependencies.uses_helper(RuntimeHelperId::ReadUtf8String));
assert!(dependencies.uses_helper(RuntimeHelperId::Utf8StringFromMemory));
assert!(dependencies.uses_helper(RuntimeHelperId::StringFromMemory));
}
}