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
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
//! Simulation construction, validation, and topology assembly.
//!
//! Split out from `sim.rs` to keep each concern readable. Holds:
//!
//! - [`Simulation::new`] and [`Simulation::new_with_hooks`]
//! - Config validation ([`Simulation::validate_config`] and helpers)
//! - Legacy and explicit topology builders
//! - [`Simulation::from_parts`] for snapshot restore
//! - Dispatch, reposition, and hook registration helpers
//!
//! Since this is a child module of `crate::sim`, it can access `Simulation`'s
//! private fields directly — no visibility relaxation required.
use std::collections::{BTreeMap, HashMap, HashSet};
use std::sync::Mutex;
use crate::components::{Elevator, ElevatorPhase, Line, Orientation, Position, Stop, Velocity};
use crate::config::SimConfig;
use crate::dispatch::{
BuiltinReposition, BuiltinStrategy, DispatchStrategy, ElevatorGroup, LineInfo,
RepositionStrategy,
};
use crate::door::DoorState;
use crate::entity::EntityId;
use crate::error::SimError;
use crate::events::EventBus;
use crate::hooks::{Phase, PhaseHooks};
use crate::ids::GroupId;
use crate::metrics::Metrics;
use crate::rider_index::RiderIndex;
use crate::stop::StopId;
use crate::time::TimeAdapter;
use crate::topology::TopologyGraph;
use crate::world::World;
use super::Simulation;
/// Bundled topology result: groups, dispatchers, and strategy IDs.
type TopologyResult = (
Vec<ElevatorGroup>,
BTreeMap<GroupId, Box<dyn DispatchStrategy>>,
BTreeMap<GroupId, BuiltinStrategy>,
);
/// Ensure DCS groups have `HallCallMode::Destination` at construction
/// time. Non-DCS groups are left at whatever the config specified —
/// forcing Classic here would clobber explicit config overrides (e.g. a
/// Scan group that the author deliberately set to Destination mode).
///
/// Runtime swaps via [`Simulation::set_dispatch`] do a full bidirectional
/// sync because a strategy change is an explicit user action where
/// resetting the mode is expected.
fn sync_hall_call_modes(
groups: &mut [ElevatorGroup],
strategy_ids: &BTreeMap<GroupId, BuiltinStrategy>,
) {
for group in groups.iter_mut() {
if strategy_ids.get(&group.id()) == Some(&BuiltinStrategy::Destination) {
group.set_hall_call_mode(crate::dispatch::HallCallMode::Destination);
}
}
}
/// Validate the physics fields shared by [`crate::config::ElevatorConfig`]
/// and [`super::ElevatorParams`]. Both construction-time validation and
/// the runtime `add_elevator` path call this so an invalid set of params
/// can never reach the world (zeroes blow up movement; zero door ticks
/// stall the door FSM).
#[allow(clippy::too_many_arguments)]
pub(super) fn validate_elevator_physics(
max_speed: f64,
acceleration: f64,
deceleration: f64,
weight_capacity: f64,
inspection_speed_factor: f64,
door_transition_ticks: u32,
door_open_ticks: u32,
bypass_load_up_pct: Option<f64>,
bypass_load_down_pct: Option<f64>,
) -> Result<(), SimError> {
if !max_speed.is_finite() || max_speed <= 0.0 {
return Err(SimError::InvalidConfig {
field: "elevators.max_speed",
reason: format!("must be finite and positive, got {max_speed}"),
});
}
if !acceleration.is_finite() || acceleration <= 0.0 {
return Err(SimError::InvalidConfig {
field: "elevators.acceleration",
reason: format!("must be finite and positive, got {acceleration}"),
});
}
if !deceleration.is_finite() || deceleration <= 0.0 {
return Err(SimError::InvalidConfig {
field: "elevators.deceleration",
reason: format!("must be finite and positive, got {deceleration}"),
});
}
if !weight_capacity.is_finite() || weight_capacity <= 0.0 {
return Err(SimError::InvalidConfig {
field: "elevators.weight_capacity",
reason: format!("must be finite and positive, got {weight_capacity}"),
});
}
if !inspection_speed_factor.is_finite() || inspection_speed_factor <= 0.0 {
return Err(SimError::InvalidConfig {
field: "elevators.inspection_speed_factor",
reason: format!("must be finite and positive, got {inspection_speed_factor}"),
});
}
if door_transition_ticks == 0 {
return Err(SimError::InvalidConfig {
field: "elevators.door_transition_ticks",
reason: "must be > 0".into(),
});
}
if door_open_ticks == 0 {
return Err(SimError::InvalidConfig {
field: "elevators.door_open_ticks",
reason: "must be > 0".into(),
});
}
validate_bypass_pct("elevators.bypass_load_up_pct", bypass_load_up_pct)?;
validate_bypass_pct("elevators.bypass_load_down_pct", bypass_load_down_pct)?;
Ok(())
}
/// `bypass_load_{up,down}_pct` must be a finite fraction in `(0.0, 1.0]`
/// when set. `pct = 0.0` would bypass at an empty car (nonsense); `NaN`
/// and infinities silently disable the bypass under the dispatch guard,
/// which is a silent foot-gun. Reject at config time instead.
fn validate_bypass_pct(field: &'static str, pct: Option<f64>) -> Result<(), SimError> {
let Some(pct) = pct else {
return Ok(());
};
if !pct.is_finite() || pct <= 0.0 || pct > 1.0 {
return Err(SimError::InvalidConfig {
field,
reason: format!("must be finite in (0.0, 1.0] when set, got {pct}"),
});
}
Ok(())
}
impl Simulation {
/// Create a new simulation from config and a dispatch strategy.
///
/// Returns `Err` if the config is invalid (zero stops, duplicate IDs,
/// negative speeds, etc.).
///
/// # Errors
///
/// Returns [`SimError::InvalidConfig`] if the configuration has zero stops,
/// duplicate stop IDs, zero elevators, non-positive physics parameters,
/// invalid starting stops, or non-positive tick rate.
pub fn new(
config: &SimConfig,
dispatch: impl DispatchStrategy + 'static,
) -> Result<Self, SimError> {
let mut dispatchers = BTreeMap::new();
dispatchers.insert(GroupId(0), Box::new(dispatch) as Box<dyn DispatchStrategy>);
Self::new_with_hooks(config, dispatchers, PhaseHooks::default())
}
/// Create a simulation with pre-configured lifecycle hooks.
///
/// Used by [`SimulationBuilder`](crate::builder::SimulationBuilder).
#[allow(clippy::too_many_lines)]
pub(crate) fn new_with_hooks(
config: &SimConfig,
builder_dispatchers: BTreeMap<GroupId, Box<dyn DispatchStrategy>>,
hooks: PhaseHooks,
) -> Result<Self, SimError> {
Self::validate_config(config)?;
let mut world = World::new();
// Create stop entities.
let mut stop_lookup: HashMap<StopId, EntityId> = HashMap::new();
for sc in &config.building.stops {
let eid = world.spawn();
world.set_stop(
eid,
Stop {
name: sc.name.clone(),
position: sc.position,
},
);
world.set_position(eid, Position { value: sc.position });
stop_lookup.insert(sc.id, eid);
}
// Build sorted-stops index for O(log n) PassingFloor detection.
let mut sorted: Vec<(f64, EntityId)> = world
.iter_stops()
.map(|(eid, stop)| (stop.position, eid))
.collect();
sorted.sort_by(|a, b| a.0.total_cmp(&b.0));
world.insert_resource(crate::world::SortedStops(sorted));
// Per-stop arrival signal, appended on rider spawn and queried
// by dispatch/reposition strategies to drive traffic-mode
// switches and predictive parking. The destination mirror is
// what powers down-peak detection — without it the classifier
// sees `total_dest = 0` and silently never emits `DownPeak`.
world.insert_resource(crate::arrival_log::ArrivalLog::default());
world.insert_resource(crate::arrival_log::DestinationLog::default());
world.insert_resource(crate::arrival_log::CurrentTick::default());
world.insert_resource(crate::arrival_log::ArrivalLogRetention::default());
// Traffic-mode classifier. Auto-refreshed in the metrics phase
// from the same rolling window; strategies read the current
// mode via `World::resource::<TrafficDetector>()`.
world.insert_resource(crate::traffic_detector::TrafficDetector::default());
// Per-car reposition cooldown. Populated by the movement
// phase when a repositioning car arrives; consulted by the
// reposition phase to skip cars that just parked so the
// hot-stop ranking can't flip them around again the next
// tick.
world.insert_resource(crate::dispatch::reposition::RepositionCooldowns::default());
// Expose tick rate to strategies that need to unit-convert
// tick-denominated elevator fields (door cycle, ack latency)
// into the second-denominated terms of their cost functions.
// Without this, ETD's door-overhead term was summing ticks
// into a seconds expression and getting ~60× over-weighted.
world.insert_resource(crate::time::TickRate(config.simulation.ticks_per_second));
let (mut groups, dispatchers, strategy_ids) =
if let Some(line_configs) = &config.building.lines {
Self::build_explicit_topology(
&mut world,
config,
line_configs,
&stop_lookup,
builder_dispatchers,
)
} else {
Self::build_legacy_topology(&mut world, config, &stop_lookup, builder_dispatchers)
};
sync_hall_call_modes(&mut groups, &strategy_ids);
let dt = 1.0 / config.simulation.ticks_per_second;
world.insert_resource(crate::tagged_metrics::MetricTags::default());
// Auto-register dispatch-internal extension types the sim itself
// owns. The same registration runs in `from_parts` (the
// snapshot-restore path); doing it here too means snapshot bytes
// taken from a fresh sim and from a restored sim agree on the
// extensions BTreeMap shape (#534's review surfaced this
// asymmetry: pre-fix, fresh sims had no `assigned_car` extension
// entry while restored sims did, breaking byte-equality of the
// snapshot bytes round-trip and the lockstep checksum).
world.register_ext::<crate::dispatch::destination::AssignedCar>(
crate::dispatch::destination::ASSIGNED_CAR_KEY,
);
// Collect line tag info (entity + name + elevator entities) before
// borrowing world mutably for MetricTags.
let line_tag_info: Vec<(EntityId, String, Vec<EntityId>)> = groups
.iter()
.flat_map(|group| {
group.lines().iter().filter_map(|li| {
let line_comp = world.line(li.entity())?;
Some((li.entity(), line_comp.name.clone(), li.elevators().to_vec()))
})
})
.collect();
// Tag line entities and their elevators with "line:{name}".
if let Some(tags) = world.resource_mut::<crate::tagged_metrics::MetricTags>() {
for (line_eid, name, elevators) in &line_tag_info {
let tag = format!("line:{name}");
tags.tag(*line_eid, tag.clone());
for elev_eid in elevators {
tags.tag(*elev_eid, tag.clone());
}
}
}
// Wire reposition strategies from group configs.
let mut repositioners: BTreeMap<GroupId, Box<dyn RepositionStrategy>> = BTreeMap::new();
let mut reposition_ids: BTreeMap<GroupId, BuiltinReposition> = BTreeMap::new();
if let Some(group_configs) = &config.building.groups {
for gc in group_configs {
if let Some(ref repo_id) = gc.reposition
&& let Some(strategy) = repo_id.instantiate()
{
let gid = GroupId(gc.id);
repositioners.insert(gid, strategy);
reposition_ids.insert(gid, repo_id.clone());
}
}
}
Ok(Self {
world,
events: EventBus::default(),
pending_output: Vec::new(),
tick: 0,
dt,
groups,
stop_lookup,
dispatchers,
strategy_ids,
repositioners,
reposition_ids,
metrics: Metrics::new(),
time: TimeAdapter::new(config.simulation.ticks_per_second),
hooks,
elevator_ids_buf: Vec::new(),
reposition_buf: Vec::new(),
dispatch_scratch: crate::dispatch::DispatchScratch::default(),
topo_graph: Mutex::new(TopologyGraph::new()),
rider_index: RiderIndex::default(),
tick_in_progress: false,
})
}
/// Spawn a single elevator entity from an `ElevatorConfig` onto `line`.
///
/// Sets position, velocity, all `Elevator` fields, optional energy profile,
/// optional service mode, and an empty `DestinationQueue`.
/// Returns the new entity ID.
fn spawn_elevator_entity(
world: &mut World,
ec: &crate::config::ElevatorConfig,
line: EntityId,
stop_lookup: &HashMap<StopId, EntityId>,
start_pos_lookup: &[crate::stop::StopConfig],
) -> EntityId {
let eid = world.spawn();
let start_pos = start_pos_lookup
.iter()
.find(|s| s.id == ec.starting_stop)
.map_or(0.0, |s| s.position);
world.set_position(eid, Position { value: start_pos });
world.set_velocity(eid, Velocity { value: 0.0 });
let restricted: HashSet<EntityId> = ec
.restricted_stops
.iter()
.filter_map(|sid| stop_lookup.get(sid).copied())
.collect();
world.set_elevator(
eid,
Elevator {
phase: ElevatorPhase::Idle,
door: DoorState::Closed,
max_speed: ec.max_speed,
acceleration: ec.acceleration,
deceleration: ec.deceleration,
weight_capacity: ec.weight_capacity,
current_load: crate::components::Weight::ZERO,
riders: Vec::new(),
target_stop: None,
door_transition_ticks: ec.door_transition_ticks,
door_open_ticks: ec.door_open_ticks,
line,
repositioning: false,
restricted_stops: restricted,
inspection_speed_factor: ec.inspection_speed_factor,
going_up: true,
going_down: true,
move_count: 0,
door_command_queue: Vec::new(),
manual_target_velocity: None,
bypass_load_up_pct: ec.bypass_load_up_pct,
bypass_load_down_pct: ec.bypass_load_down_pct,
home_stop: None,
},
);
#[cfg(feature = "energy")]
if let Some(ref profile) = ec.energy_profile {
world.set_energy_profile(eid, profile.clone());
world.set_energy_metrics(eid, crate::energy::EnergyMetrics::default());
}
if let Some(mode) = ec.service_mode {
world.set_service_mode(eid, mode);
}
world.set_destination_queue(eid, crate::components::DestinationQueue::new());
eid
}
/// Build topology from the legacy flat elevator list (single default line + group).
fn build_legacy_topology(
world: &mut World,
config: &SimConfig,
stop_lookup: &HashMap<StopId, EntityId>,
builder_dispatchers: BTreeMap<GroupId, Box<dyn DispatchStrategy>>,
) -> TopologyResult {
// Iterate the config's stop list (deterministic Vec order) and
// resolve each through the lookup. Walking `stop_lookup.values()`
// would expose `HashMap` iteration order — which varies by
// per-process hash seed — into `LineInfo.serves` and from
// there into snapshot bytes.
let all_stop_entities: Vec<EntityId> = config
.building
.stops
.iter()
.filter_map(|s| stop_lookup.get(&s.id).copied())
.collect();
let stop_positions: Vec<f64> = config.building.stops.iter().map(|s| s.position).collect();
let min_pos = stop_positions.iter().copied().fold(f64::INFINITY, f64::min);
let max_pos = stop_positions
.iter()
.copied()
.fold(f64::NEG_INFINITY, f64::max);
let default_line_eid = world.spawn();
world.set_line(
default_line_eid,
Line {
name: "Default".into(),
group: GroupId(0),
orientation: Orientation::Vertical,
position: None,
min_position: min_pos,
max_position: max_pos,
max_cars: None,
},
);
let mut elevator_entities = Vec::new();
for ec in &config.elevators {
let eid = Self::spawn_elevator_entity(
world,
ec,
default_line_eid,
stop_lookup,
&config.building.stops,
);
elevator_entities.push(eid);
}
let default_line_info =
LineInfo::new(default_line_eid, elevator_entities, all_stop_entities);
let group = ElevatorGroup::new(GroupId(0), "Default".into(), vec![default_line_info]);
// Legacy topology has exactly one group: GroupId(0). Honour a
// builder-provided dispatcher for that group; ignore any builder
// entry keyed on a different GroupId (it would have nothing to
// attach to). Pre-fix this used `into_iter().next()` which
// discarded the GroupId entirely and could attach a dispatcher
// intended for a different group to GroupId(0). (#288)
let mut dispatchers = BTreeMap::new();
let mut strategy_ids = BTreeMap::new();
let user_dispatcher = builder_dispatchers
.into_iter()
.find_map(|(gid, d)| if gid == GroupId(0) { Some(d) } else { None });
// Infer the snapshot identity from the dispatcher itself via
// `DispatchStrategy::builtin_id`. Pre-fix this was hard-coded to
// `BuiltinStrategy::Scan` regardless of the impl actually passed,
// so `Simulation::new(config, NearestCarDispatch::new())` would
// record `Scan` as the group's identity — and a snapshot round-
// trip would silently swap the running strategy back to Scan,
// breaking determinism. Built-ins override `builtin_id` to
// return their own variant; custom strategies can override it
// to return `BuiltinStrategy::Custom(name)` for snapshot fidelity.
// Strategies that don't override (returning `None`) still fall
// back to Scan, matching the previous behaviour for callers that
// never cared about round-trip identity.
let inferred_id = user_dispatcher
.as_ref()
.and_then(|d| d.builtin_id())
.unwrap_or(BuiltinStrategy::Scan);
if let Some(d) = user_dispatcher {
dispatchers.insert(GroupId(0), d);
} else {
dispatchers.insert(
GroupId(0),
Box::new(crate::dispatch::scan::ScanDispatch::new()) as Box<dyn DispatchStrategy>,
);
}
strategy_ids.insert(GroupId(0), inferred_id);
(vec![group], dispatchers, strategy_ids)
}
/// Build topology from explicit `LineConfig`/`GroupConfig` definitions.
#[allow(clippy::too_many_lines)]
fn build_explicit_topology(
world: &mut World,
config: &SimConfig,
line_configs: &[crate::config::LineConfig],
stop_lookup: &HashMap<StopId, EntityId>,
builder_dispatchers: BTreeMap<GroupId, Box<dyn DispatchStrategy>>,
) -> TopologyResult {
// Map line config id → (line EntityId, LineInfo). `BTreeMap`
// (not `HashMap`) so the auto-inferred-groups branch iterates
// `.values()` in deterministic key order — otherwise the
// resulting `LineInfo` sequence permutes across processes and
// leaks into snapshot bytes via `GroupSnapshot::lines`.
let mut line_map: BTreeMap<u32, (EntityId, LineInfo)> = BTreeMap::new();
for lc in line_configs {
// Resolve served stop entities.
let served_entities: Vec<EntityId> = lc
.serves
.iter()
.filter_map(|sid| stop_lookup.get(sid).copied())
.collect();
// Compute min/max from stops if not explicitly set.
let stop_positions: Vec<f64> = lc
.serves
.iter()
.filter_map(|sid| {
config
.building
.stops
.iter()
.find(|s| s.id == *sid)
.map(|s| s.position)
})
.collect();
let auto_min = stop_positions.iter().copied().fold(f64::INFINITY, f64::min);
let auto_max = stop_positions
.iter()
.copied()
.fold(f64::NEG_INFINITY, f64::max);
let min_pos = lc.min_position.unwrap_or(auto_min);
let max_pos = lc.max_position.unwrap_or(auto_max);
let line_eid = world.spawn();
// The group assignment will be set when we process GroupConfigs.
// Default to GroupId(0) initially.
world.set_line(
line_eid,
Line {
name: lc.name.clone(),
group: GroupId(0),
orientation: lc.orientation,
position: lc.position,
min_position: min_pos,
max_position: max_pos,
max_cars: lc.max_cars,
},
);
// Spawn elevators for this line.
let mut elevator_entities = Vec::new();
for ec in &lc.elevators {
let eid = Self::spawn_elevator_entity(
world,
ec,
line_eid,
stop_lookup,
&config.building.stops,
);
elevator_entities.push(eid);
}
let line_info = LineInfo::new(line_eid, elevator_entities, served_entities);
line_map.insert(lc.id, (line_eid, line_info));
}
// Build groups from GroupConfigs, or auto-infer a single group.
let group_configs = config.building.groups.as_deref();
let mut groups = Vec::new();
let mut dispatchers = BTreeMap::new();
let mut strategy_ids = BTreeMap::new();
if let Some(gcs) = group_configs {
for gc in gcs {
let group_id = GroupId(gc.id);
let mut group_lines = Vec::new();
for &lid in &gc.lines {
if let Some((line_eid, li)) = line_map.get(&lid) {
// Update the line's group assignment.
if let Some(line_comp) = world.line_mut(*line_eid) {
line_comp.group = group_id;
}
group_lines.push(li.clone());
}
}
let mut group = ElevatorGroup::new(group_id, gc.name.clone(), group_lines);
if let Some(mode) = gc.hall_call_mode {
group.set_hall_call_mode(mode);
}
if let Some(ticks) = gc.ack_latency_ticks {
group.set_ack_latency_ticks(ticks);
}
groups.push(group);
// GroupConfig strategy; builder overrides applied after this loop.
let dispatch: Box<dyn DispatchStrategy> = gc
.dispatch
.instantiate()
.unwrap_or_else(|| Box::new(crate::dispatch::scan::ScanDispatch::new()));
dispatchers.insert(group_id, dispatch);
strategy_ids.insert(group_id, gc.dispatch.clone());
}
} else {
// No explicit groups — create a single default group with all lines.
let group_id = GroupId(0);
let mut group_lines = Vec::new();
for (line_eid, li) in line_map.values() {
if let Some(line_comp) = world.line_mut(*line_eid) {
line_comp.group = group_id;
}
group_lines.push(li.clone());
}
let group = ElevatorGroup::new(group_id, "Default".into(), group_lines);
groups.push(group);
let dispatch: Box<dyn DispatchStrategy> =
Box::new(crate::dispatch::scan::ScanDispatch::new());
dispatchers.insert(group_id, dispatch);
strategy_ids.insert(group_id, BuiltinStrategy::Scan);
}
// Override with builder-provided dispatchers (they take precedence).
// Pre-fix this could mismatch `strategy_ids` against `dispatchers`
// when both config and builder specified a strategy for the same
// group (#287). The new precedence: builder wins for the dispatcher
// and, for snapshot fidelity, we prefer the dispatcher's own
// `builtin_id()` over any stale config-supplied id. Falling back
// to the config id when the dispatcher is unidentified matches
// the pre-fix behaviour for custom strategies that don't override
// `builtin_id`.
for (gid, d) in builder_dispatchers {
let inferred_id = d.builtin_id();
dispatchers.insert(gid, d);
match inferred_id {
Some(id) => {
strategy_ids.insert(gid, id);
}
None => {
strategy_ids
.entry(gid)
.or_insert_with(|| BuiltinStrategy::Custom("user-supplied".into()));
}
}
}
(groups, dispatchers, strategy_ids)
}
/// Restore a simulation from pre-built parts (used by snapshot restore).
#[allow(clippy::too_many_arguments)]
pub(crate) fn from_parts(
world: World,
tick: u64,
dt: f64,
groups: Vec<ElevatorGroup>,
stop_lookup: HashMap<StopId, EntityId>,
dispatchers: BTreeMap<GroupId, Box<dyn DispatchStrategy>>,
strategy_ids: BTreeMap<GroupId, crate::dispatch::BuiltinStrategy>,
metrics: Metrics,
ticks_per_second: f64,
) -> Self {
let mut rider_index = RiderIndex::default();
rider_index.rebuild(&world);
// Ensure the dispatch-visible tick rate matches the simulation
// tick rate after a snapshot restore; a snapshot that predates
// the `TickRate` resource leaves it absent and dispatch would
// otherwise fall back to the 60 Hz default even for a 30 Hz
// sim, silently halving ETD's door-cost scale.
let mut world = world;
world.insert_resource(crate::time::TickRate(ticks_per_second));
// Re-insert the traffic detector for the same forward-compat
// reason as `TickRate`: a snapshot taken before this resource
// existed wouldn't carry it, and `refresh_traffic_detector` in
// the metrics phase would silently no-op forever post-restore
// (greptile review of #361). `insert_resource` is
// last-writer-wins, so snapshots that already carry a
// detector keep their stored state.
if world
.resource::<crate::traffic_detector::TrafficDetector>()
.is_none()
{
world.insert_resource(crate::traffic_detector::TrafficDetector::default());
}
// Same forward-compat pattern for the destination log. An
// older snapshot would leave the detector unable to detect
// down-peak post-restore; a fresh empty log lets it resume
// classification after a few ticks of observed traffic.
if world
.resource::<crate::arrival_log::DestinationLog>()
.is_none()
{
world.insert_resource(crate::arrival_log::DestinationLog::default());
}
// Auto-register dispatch-internal extension types the sim itself
// owns, and immediately load their data from the pending
// resource. Without this, DCS sticky assignments
// (`AssignedCar`) evaporate across snapshot round-trip and
// `DestinationDispatch` re-computes every commitment from
// scratch — producing different decisions than the original
// sim and breaking tick-for-tick determinism.
//
// `deserialize_extensions` takes a `&` of the pending map and
// silently skips types that aren't registered, so the call is
// safe to make with user-owned extensions still in the map.
// The `PendingExtensions` resource stays in place for a later
// `load_extensions_with` call to materialize the caller's own
// types.
world.register_ext::<crate::dispatch::destination::AssignedCar>(
crate::dispatch::destination::ASSIGNED_CAR_KEY,
);
if let Some(pending) = world.resource::<crate::snapshot::PendingExtensions>() {
let data = pending.0.clone();
world.deserialize_extensions(&data);
}
Self {
world,
events: EventBus::default(),
pending_output: Vec::new(),
tick,
dt,
groups,
stop_lookup,
dispatchers,
strategy_ids,
repositioners: BTreeMap::new(),
reposition_ids: BTreeMap::new(),
metrics,
time: TimeAdapter::new(ticks_per_second),
hooks: PhaseHooks::default(),
elevator_ids_buf: Vec::new(),
reposition_buf: Vec::new(),
dispatch_scratch: crate::dispatch::DispatchScratch::default(),
topo_graph: Mutex::new(TopologyGraph::new()),
rider_index,
tick_in_progress: false,
}
}
/// Validate configuration before constructing the simulation.
pub(crate) fn validate_config(config: &SimConfig) -> Result<(), SimError> {
// Schema-version gate: reject forward-incompatible configs (a
// future build's RON would silently mis-deserialize fields a
// current build doesn't know about) and surface legacy
// pre-versioning configs (`schema_version = 0`) as an explicit
// upgrade prompt rather than a silent serde-default smear. See
// `docs/src/config-versioning.md` for the migration playbook.
if config.schema_version > crate::config::CURRENT_CONFIG_SCHEMA_VERSION {
return Err(SimError::InvalidConfig {
field: "schema_version",
reason: format!(
"config schema_version={} is newer than this build's CURRENT_CONFIG_SCHEMA_VERSION={}; upgrade elevator-core or downgrade the config",
config.schema_version,
crate::config::CURRENT_CONFIG_SCHEMA_VERSION,
),
});
}
if config.schema_version == 0 {
return Err(SimError::InvalidConfig {
field: "schema_version",
reason: format!(
"config schema_version=0 (pre-versioning legacy file) — set schema_version: {} explicitly after auditing field defaults; see docs/src/config-versioning.md",
crate::config::CURRENT_CONFIG_SCHEMA_VERSION,
),
});
}
if config.building.stops.is_empty() {
return Err(SimError::InvalidConfig {
field: "building.stops",
reason: "at least one stop is required".into(),
});
}
// Check for duplicate stop IDs and validate positions.
let mut seen_ids = HashSet::new();
for stop in &config.building.stops {
if !seen_ids.insert(stop.id) {
return Err(SimError::InvalidConfig {
field: "building.stops",
reason: format!("duplicate {}", stop.id),
});
}
if !stop.position.is_finite() {
return Err(SimError::InvalidConfig {
field: "building.stops.position",
reason: format!("{} has non-finite position {}", stop.id, stop.position),
});
}
}
let stop_ids: HashSet<StopId> = config.building.stops.iter().map(|s| s.id).collect();
if let Some(line_configs) = &config.building.lines {
// ── Explicit topology validation ──
Self::validate_explicit_topology(line_configs, &stop_ids, &config.building)?;
} else {
// ── Legacy flat elevator list validation ──
Self::validate_legacy_elevators(&config.elevators, &config.building)?;
}
if !config.simulation.ticks_per_second.is_finite()
|| config.simulation.ticks_per_second <= 0.0
{
return Err(SimError::InvalidConfig {
field: "simulation.ticks_per_second",
reason: format!(
"must be finite and positive, got {}",
config.simulation.ticks_per_second
),
});
}
Self::validate_passenger_spawning(&config.passenger_spawning)?;
Ok(())
}
/// Validate `PassengerSpawnConfig`. Without this, bad inputs reach
/// `PoissonSource::from_config` and panic later (NaN/negative weights
/// crash `random_range`/`Weight::from`; zero `mean_interval_ticks`
/// burst-fires every catch-up tick). (#272)
fn validate_passenger_spawning(
spawn: &crate::config::PassengerSpawnConfig,
) -> Result<(), SimError> {
let (lo, hi) = spawn.weight_range;
if !lo.is_finite() || !hi.is_finite() {
return Err(SimError::InvalidConfig {
field: "passenger_spawning.weight_range",
reason: format!("both endpoints must be finite, got ({lo}, {hi})"),
});
}
if lo < 0.0 || hi < 0.0 {
return Err(SimError::InvalidConfig {
field: "passenger_spawning.weight_range",
reason: format!("both endpoints must be non-negative, got ({lo}, {hi})"),
});
}
if lo > hi {
return Err(SimError::InvalidConfig {
field: "passenger_spawning.weight_range",
reason: format!("min must be <= max, got ({lo}, {hi})"),
});
}
if spawn.mean_interval_ticks == 0 {
return Err(SimError::InvalidConfig {
field: "passenger_spawning.mean_interval_ticks",
reason: "must be > 0; mean_interval_ticks=0 burst-fires \
every catch-up tick"
.into(),
});
}
Ok(())
}
/// Validate the legacy flat elevator list.
fn validate_legacy_elevators(
elevators: &[crate::config::ElevatorConfig],
building: &crate::config::BuildingConfig,
) -> Result<(), SimError> {
if elevators.is_empty() {
return Err(SimError::InvalidConfig {
field: "elevators",
reason: "at least one elevator is required".into(),
});
}
for elev in elevators {
Self::validate_elevator_config(elev, building)?;
}
Ok(())
}
/// Validate a single elevator config's physics and starting stop.
fn validate_elevator_config(
elev: &crate::config::ElevatorConfig,
building: &crate::config::BuildingConfig,
) -> Result<(), SimError> {
validate_elevator_physics(
elev.max_speed.value(),
elev.acceleration.value(),
elev.deceleration.value(),
elev.weight_capacity.value(),
elev.inspection_speed_factor,
elev.door_transition_ticks,
elev.door_open_ticks,
elev.bypass_load_up_pct,
elev.bypass_load_down_pct,
)?;
if !building.stops.iter().any(|s| s.id == elev.starting_stop) {
return Err(SimError::InvalidConfig {
field: "elevators.starting_stop",
reason: format!("references non-existent {}", elev.starting_stop),
});
}
Ok(())
}
/// Validate explicit line/group topology.
fn validate_explicit_topology(
line_configs: &[crate::config::LineConfig],
stop_ids: &HashSet<StopId>,
building: &crate::config::BuildingConfig,
) -> Result<(), SimError> {
// No duplicate line IDs.
let mut seen_line_ids = HashSet::new();
for lc in line_configs {
if !seen_line_ids.insert(lc.id) {
return Err(SimError::InvalidConfig {
field: "building.lines",
reason: format!("duplicate line id {}", lc.id),
});
}
}
// Every line's serves must reference existing stops and be non-empty.
for lc in line_configs {
if lc.serves.is_empty() {
return Err(SimError::InvalidConfig {
field: "building.lines.serves",
reason: format!("line {} has no stops", lc.id),
});
}
for sid in &lc.serves {
if !stop_ids.contains(sid) {
return Err(SimError::InvalidConfig {
field: "building.lines.serves",
reason: format!("line {} references non-existent {}", lc.id, sid),
});
}
}
// Validate elevators within each line.
for ec in &lc.elevators {
Self::validate_elevator_config(ec, building)?;
}
// Validate max_cars is not exceeded.
if let Some(max) = lc.max_cars
&& lc.elevators.len() > max
{
return Err(SimError::InvalidConfig {
field: "building.lines.max_cars",
reason: format!(
"line {} has {} elevators but max_cars is {max}",
lc.id,
lc.elevators.len()
),
});
}
}
// At least one line with at least one elevator.
let has_elevator = line_configs.iter().any(|lc| !lc.elevators.is_empty());
if !has_elevator {
return Err(SimError::InvalidConfig {
field: "building.lines",
reason: "at least one line must have at least one elevator".into(),
});
}
// No orphaned stops: every stop must be served by at least one line.
let served: HashSet<StopId> = line_configs
.iter()
.flat_map(|lc| lc.serves.iter().copied())
.collect();
for sid in stop_ids {
if !served.contains(sid) {
return Err(SimError::InvalidConfig {
field: "building.lines",
reason: format!("orphaned stop {sid} not served by any line"),
});
}
}
// Validate groups if present.
if let Some(group_configs) = &building.groups {
let line_id_set: HashSet<u32> = line_configs.iter().map(|lc| lc.id).collect();
let mut seen_group_ids = HashSet::new();
for gc in group_configs {
if !seen_group_ids.insert(gc.id) {
return Err(SimError::InvalidConfig {
field: "building.groups",
reason: format!("duplicate group id {}", gc.id),
});
}
for &lid in &gc.lines {
if !line_id_set.contains(&lid) {
return Err(SimError::InvalidConfig {
field: "building.groups.lines",
reason: format!(
"group {} references non-existent line id {}",
gc.id, lid
),
});
}
}
}
// Check for orphaned lines (not referenced by any group).
let referenced_line_ids: HashSet<u32> = group_configs
.iter()
.flat_map(|g| g.lines.iter().copied())
.collect();
for lc in line_configs {
if !referenced_line_ids.contains(&lc.id) {
return Err(SimError::InvalidConfig {
field: "building.lines",
reason: format!("line {} is not assigned to any group", lc.id),
});
}
}
}
Ok(())
}
// ── Dispatch management ──────────────────────────────────────────
/// Replace the dispatch strategy for a group.
///
/// Also synchronises `HallCallMode`: `Destination` for DCS, `Classic`
/// for other built-ins; `Custom` strategies leave the mode untouched.
///
/// The stored snapshot identity is taken from the strategy's own
/// [`DispatchStrategy::builtin_id`] when it returns `Some(..)`, so
/// built-in strategies always round-trip as themselves even if the
/// `id` argument drifts out of sync with the actual impl. Custom
/// strategies that don't override `builtin_id` fall back to the
/// caller-supplied `id`, preserving the prior API for registered
/// custom factories. Mirrors the pattern applied to
/// [`set_reposition`](Self::set_reposition) in #414.
pub fn set_dispatch(
&mut self,
group: GroupId,
strategy: Box<dyn DispatchStrategy>,
id: crate::dispatch::BuiltinStrategy,
) {
let resolved_id = strategy.builtin_id().unwrap_or(id);
let mode = match &resolved_id {
BuiltinStrategy::Destination => Some(crate::dispatch::HallCallMode::Destination),
BuiltinStrategy::Custom(_) => None,
BuiltinStrategy::Scan
| BuiltinStrategy::Look
| BuiltinStrategy::NearestCar
| BuiltinStrategy::Etd
| BuiltinStrategy::Rsr => Some(crate::dispatch::HallCallMode::Classic),
};
if let Some(mode) = mode
&& let Some(g) = self.groups.iter_mut().find(|g| g.id() == group)
{
g.set_hall_call_mode(mode);
}
self.dispatchers.insert(group, strategy);
self.strategy_ids.insert(group, resolved_id);
}
// ── Reposition management ─────────────────────────────────────────
/// Set the reposition strategy for a group.
///
/// Enables the reposition phase for this group. Idle elevators will
/// be repositioned according to the strategy after each dispatch phase.
///
/// The stored snapshot identity is taken from the strategy's own
/// [`RepositionStrategy::builtin_id`] when it returns `Some(..)`,
/// so built-in strategies always round-trip as themselves even if
/// the `id` argument drifts out of sync with the actual impl.
/// Custom strategies that don't override `builtin_id` fall back
/// to the caller-supplied `id`, preserving the prior API for
/// registered custom factories.
///
/// ## Retention
/// Widens [`ArrivalLogRetention`](crate::arrival_log::ArrivalLogRetention)
/// to the strategy's
/// [`min_arrival_log_window`](crate::dispatch::RepositionStrategy::min_arrival_log_window)
/// when that exceeds current retention, never narrows it. This is
/// monotonic by design — replacing a wide-window strategy with a
/// narrow one (or [`remove_reposition`](Self::remove_reposition))
/// leaves retention at the high-water mark rather than recomputing
/// across the remaining strategies, since shrinking would also
/// clobber any explicit
/// [`set_arrival_log_retention_ticks`](Self::set_arrival_log_retention_ticks)
/// the caller made afterwards. Long-running sims that hot-swap
/// strategies pay a memory cost equal to the largest historic
/// window; if that matters, call `set_arrival_log_retention_ticks`
/// explicitly after the swap.
pub fn set_reposition(
&mut self,
group: GroupId,
strategy: Box<dyn RepositionStrategy>,
id: BuiltinReposition,
) {
let resolved_id = strategy.builtin_id().unwrap_or(id);
let needed_window = strategy.min_arrival_log_window();
self.repositioners.insert(group, strategy);
self.reposition_ids.insert(group, resolved_id);
// Widen the arrival-log retention if the freshly installed
// strategy queries a window the pruner would otherwise truncate
// under it. Without this, `PredictiveParking::with_window_ticks`
// (or any custom strategy advertising a longer window) silently
// sees only the last `DEFAULT_ARRIVAL_WINDOW_TICKS` of arrivals.
if needed_window > 0
&& let Some(retention) = self
.world
.resource_mut::<crate::arrival_log::ArrivalLogRetention>()
&& needed_window > retention.0
{
retention.0 = needed_window;
}
}
/// Remove the reposition strategy for a group, disabling repositioning.
///
/// Does not narrow
/// [`ArrivalLogRetention`](crate::arrival_log::ArrivalLogRetention)
/// — see the retention note on
/// [`set_reposition`](Self::set_reposition) for why retention is
/// monotonic across strategy lifecycle changes. Call
/// [`set_arrival_log_retention_ticks`](Self::set_arrival_log_retention_ticks)
/// explicitly to shrink retention after removing a wide-window
/// strategy.
pub fn remove_reposition(&mut self, group: GroupId) {
self.repositioners.remove(&group);
self.reposition_ids.remove(&group);
}
/// Get the reposition strategy identifier for a group.
#[must_use]
pub fn reposition_id(&self, group: GroupId) -> Option<&BuiltinReposition> {
self.reposition_ids.get(&group)
}
// ── Hooks ────────────────────────────────────────────────────────
/// Register a hook to run before a simulation phase.
///
/// Hooks are called in registration order. The hook receives mutable
/// access to the world, allowing entity inspection or modification.
pub fn add_before_hook(
&mut self,
phase: Phase,
hook: impl Fn(&mut World) + Send + Sync + 'static,
) {
self.hooks.add_before(phase, Box::new(hook));
}
/// Register a hook to run after a simulation phase.
///
/// Hooks are called in registration order. The hook receives mutable
/// access to the world, allowing entity inspection or modification.
pub fn add_after_hook(
&mut self,
phase: Phase,
hook: impl Fn(&mut World) + Send + Sync + 'static,
) {
self.hooks.add_after(phase, Box::new(hook));
}
/// Register a hook to run before a phase for a specific group.
pub fn add_before_group_hook(
&mut self,
phase: Phase,
group: GroupId,
hook: impl Fn(&mut World) + Send + Sync + 'static,
) {
self.hooks.add_before_group(phase, group, Box::new(hook));
}
/// Register a hook to run after a phase for a specific group.
pub fn add_after_group_hook(
&mut self,
phase: Phase,
group: GroupId,
hook: impl Fn(&mut World) + Send + Sync + 'static,
) {
self.hooks.add_after_group(phase, group, Box::new(hook));
}
}