dynec 0.2.1

An opinionated ECS-like framework
Documentation
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
use std::cell::Cell;
use std::env;
use std::rc::Rc;
use std::sync::atomic::{self, AtomicUsize};
use std::sync::Arc;

use super::*;
use crate::entity::referrer;
use crate::test_util::{self, AntiSemaphore, TestArch};
use crate::world::offline;
use crate::{comp, system, tracer, world};

// Repeat concurrent tests to increase the chance of catching random bugs.
// However, do not rely on test repetitions to assert for behavior;
// use more synchronization where practical.
lazy_static::lazy_static! {
    static ref CONCURRENT_TEST_REPETITIONS: usize = (|| {
        if let Ok(count) = env::var("CONCURRENT_TEST_REPETITIONS") {
            if let Ok(count) = count.parse::<usize>() {
                return count;
            }
        }

        if env::var("RUST_LOG").is_ok() { 1 } else { 1000 }
    })();
}

/// `push_send_system` and `push_unsend_system` only check the `debug_name` field,
/// so other fields can be left empty.
fn dummy_spec(name: &str) -> system::Spec {
    system::Spec {
        debug_name:              name.to_string(),
        dependencies:            vec![],
        global_requests:         vec![],
        simple_requests:         vec![],
        isotope_requests:        vec![],
        entity_creator_requests: vec![],
    }
}

struct TestSystem<D: ?Sized + 'static>(String, Box<D>);
impl<D: ?Sized> referrer::Referrer for TestSystem<D> {
    fn visit_type(_arg: &mut referrer::VisitTypeArg) {}
    fn visit_mut<V: referrer::VisitMutArg>(&mut self, _arg: &mut V) {}
}
impl<D: ?Sized> system::Descriptor for TestSystem<D> {
    fn get_spec(&self) -> system::Spec { dummy_spec(self.0.as_str()) }
    fn visit_type(&self, _arg: &mut referrer::VisitTypeArg) {} // no types to visit
    fn visit_mut(&mut self) -> referrer::AsObject<'_> { referrer::AsObject::of(self) }
}
type SendSystem = TestSystem<dyn Fn() + Send>;
impl system::Sendable for SendSystem {
    fn run(
        &mut self,
        _globals: &world::SyncGlobals,
        _components: &world::Components,
        _ealloc_shard_map: &mut ealloc::ShardMap,
        _offline_buffer: &mut offline::BufferShard,
    ) {
        self.1();
    }

    fn as_descriptor_mut(&mut self) -> &mut dyn system::Descriptor { self }
}

type UnsendSystem = TestSystem<dyn Fn()>;
impl system::Unsendable for UnsendSystem {
    fn run(
        &mut self,
        _sync_globals: &world::SyncGlobals,
        _unsync_globals: &mut world::UnsyncGlobals,
        _components: &world::Components,
        _ealloc_shard_map: &mut ealloc::ShardMap,
        _offline_buffer: &mut offline::BufferShard,
    ) {
        self.1();
    }

    fn as_descriptor_mut(&mut self) -> &mut dyn system::Descriptor { self }
}

struct Global1;
struct Global2;

#[comp(dynec_as(crate), of = TestArch)]
struct Comp1;
#[comp(dynec_as(crate), of = TestArch)]
struct Comp2;

#[derive(Debug, PartialEq, Eq, Hash)]
struct TestPartition(u32);

/// Counts the number of times some node is unmarked as runnable.
#[derive(Default)]
struct UnmarkCounterTracer(AtomicUsize);
#[dynec_codegen::tracer(dynec_as())]
impl Tracer for UnmarkCounterTracer {
    fn unmark_runnable(&self, _node: scheduler::Node) {
        self.0.fetch_add(1, atomic::Ordering::SeqCst);
    }
}

/// Collects the maximum concurrency.
#[derive(Default)]
struct MaxConcurrencyTracer {
    current: AtomicUsize,
    max:     AtomicUsize,
}
#[dynec_codegen::tracer(dynec_as())]
impl Tracer for MaxConcurrencyTracer {
    fn start_run_sendable(
        &self,
        _thread: tracer::Thread,
        _node: scheduler::Node,
        _debug_name: &str,
        _system: &mut dyn system::Sendable,
    ) {
        let value = self.current.fetch_add(1, atomic::Ordering::SeqCst);
        self.max.fetch_max(value + 1, atomic::Ordering::SeqCst);
    }

    fn end_run_sendable(
        &self,
        (): (),
        _thread: tracer::Thread,
        _node: scheduler::Node,
        _debug_name: &str,
        _system: &mut dyn system::Sendable,
    ) {
        self.current.fetch_sub(1, atomic::Ordering::SeqCst);
    }

    fn start_run_unsendable(
        &self,
        _thread: tracer::Thread,
        _node: scheduler::Node,
        _debug_name: &str,
        _system: &mut dyn system::Unsendable,
    ) {
        let value = self.current.fetch_add(1, atomic::Ordering::SeqCst);
        self.max.fetch_max(value + 1, atomic::Ordering::SeqCst);
    }

    fn end_run_unsendable(
        &self,
        (): (),
        _thread: tracer::Thread,
        _node: scheduler::Node,
        _debug_name: &str,
        _system: &mut dyn system::Unsendable,
    ) {
        self.current.fetch_sub(1, atomic::Ordering::SeqCst);
    }
}

/// Counts the number of systems run.
#[derive(Default)]
struct RunCounterTracer {
    send:   AtomicUsize,
    unsend: AtomicUsize,
}
#[dynec_codegen::tracer(dynec_as())]
impl Tracer for RunCounterTracer {
    fn start_run_sendable(
        &self,
        _thread: tracer::Thread,
        _node: scheduler::Node,
        _debug_name: &str,
        _system: &mut dyn system::Sendable,
    ) {
        self.send.fetch_add(1, atomic::Ordering::SeqCst);
    }

    fn start_run_unsendable(
        &self,
        _thread: tracer::Thread,
        _node: scheduler::Node,
        _debug_name: &str,
        _system: &mut dyn system::Unsendable,
    ) {
        self.unsend.fetch_add(1, atomic::Ordering::SeqCst);
    }
}

/// Tracks the start order of systems.
#[derive(Default)]
struct StartOrderTracer(Mutex<Vec<Node>>);
#[dynec_codegen::tracer(dynec_as())]
impl Tracer for StartOrderTracer {
    fn start_run_sendable(
        &self,
        _thread: tracer::Thread,
        node: scheduler::Node,
        _debug_name: &str,
        _system: &mut dyn system::Sendable,
    ) {
        let mut vec = self.0.lock();
        vec.push(node);
    }
    fn start_run_unsendable(
        &self,
        _thread: tracer::Thread,
        node: scheduler::Node,
        _debug_name: &str,
        _system: &mut dyn system::Unsendable,
    ) {
        let mut vec = self.0.lock();
        vec.push(node);
    }
}

#[test]
fn test_empty() {
    for concurrency in 0..3 {
        bootstrap(concurrency, || (), |_builder, [], []| {}, || |_| (), |()| {});
    }
}

#[test]
fn test_global_exclusion() {
    bootstrap(
        2,
        || (UnmarkCounterTracer::default(), MaxConcurrencyTracer::default()),
        |builder, [sys1, sys2, sys3], []| {
            builder.use_resource(
                Node::SendSystem(sys1),
                ResourceType::Global(DbgTypeId::of::<Global1>()),
                ResourceAccess { mutable: true, discrim: None },
            );
            builder.use_resource(
                Node::SendSystem(sys2),
                ResourceType::Global(DbgTypeId::of::<Global1>()),
                ResourceAccess { mutable: true, discrim: None },
            );
            builder.use_resource(
                Node::SendSystem(sys3),
                ResourceType::Global(DbgTypeId::of::<Global1>()),
                ResourceAccess { mutable: false, discrim: None }, // mutable: false here
            );
        },
        || |_| (),
        |(uct, mct)| {
            let unmark_count = uct.0.into_inner();
            assert_eq!(
                unmark_count, 3,
                "Expected resource exclusion to unmark all other runnable nodes"
            );

            let max_concurrency = mct.max.into_inner();
            assert_eq!(max_concurrency, 1, "Expected resource exclusion to deny concurrency");
        },
    );
}

#[test]
fn test_different_global_exclusion() {
    bootstrap(
        2,
        || (UnmarkCounterTracer::default(), MaxConcurrencyTracer::default()),
        |builder, [sys1, sys2], []| {
            builder.use_resource(
                Node::SendSystem(sys1),
                ResourceType::Global(DbgTypeId::of::<Global1>()),
                ResourceAccess { mutable: true, discrim: None },
            );
            builder.use_resource(
                Node::SendSystem(sys2),
                ResourceType::Global(DbgTypeId::of::<Global2>()),
                ResourceAccess { mutable: true, discrim: None },
            );
        },
        || {
            let asem = AntiSemaphore::new(2);
            move |_| asem.wait()
        },
        |(uct, mct)| {
            let unmark_count = uct.0.into_inner();
            assert_eq!(unmark_count, 0, "Expected no resource exclusion on different globals");

            let max_concurrency = mct.max.into_inner();
            assert_eq!(max_concurrency, 2, "Expected 2 systems to run concurrently");
        },
    );
}

#[test]
fn test_global_share() {
    bootstrap(
        2,
        || (UnmarkCounterTracer::default(), MaxConcurrencyTracer::default()),
        |builder, [sys1, sys2, sys3, sys4], []| {
            for sys in [sys1, sys2, sys3, sys4] {
                builder.use_resource(
                    Node::SendSystem(sys),
                    ResourceType::Global(DbgTypeId::of::<Global1>()),
                    ResourceAccess { mutable: false, discrim: None },
                );
            }
        },
        || {
            let asem = AntiSemaphore::new(2);
            move |_| asem.wait()
        },
        |(uct, mct)| {
            let unmark_count = uct.0.into_inner();
            assert_eq!(unmark_count, 0, "Expected no exclusion");

            let max_concurrency = mct.max.into_inner();
            assert_eq!(max_concurrency, 2, "Expected 2 systems to run concurrently");
        },
    );
}

#[test]
fn test_simple_exclusion() {
    bootstrap(
        2,
        || (UnmarkCounterTracer::default(), MaxConcurrencyTracer::default()),
        |builder, [sys1, sys2, sys3], []| {
            builder.use_resource(
                Node::SendSystem(sys1),
                ResourceType::Simple {
                    arch: DbgTypeId::of::<TestArch>(),
                    comp: DbgTypeId::of::<Comp1>(),
                },
                ResourceAccess { mutable: true, discrim: None },
            );
            builder.use_resource(
                Node::SendSystem(sys2),
                ResourceType::Simple {
                    arch: DbgTypeId::of::<TestArch>(),
                    comp: DbgTypeId::of::<Comp1>(),
                },
                ResourceAccess { mutable: true, discrim: None },
            );
            builder.use_resource(
                Node::SendSystem(sys3),
                ResourceType::Simple {
                    arch: DbgTypeId::of::<TestArch>(),
                    comp: DbgTypeId::of::<Comp1>(),
                },
                ResourceAccess { mutable: false, discrim: None }, // mutable: false here
            );
        },
        || |_| (),
        |(uct, mct)| {
            let unmark_count = uct.0.into_inner();
            assert_eq!(
                unmark_count, 3,
                "Expected resource exclusion to unmark all other runnable nodes"
            );

            let max_concurrency = mct.max.into_inner();
            assert_eq!(max_concurrency, 1, "Expected resource exclusion to deny concurrency");
        },
    );
}

#[test]
fn test_different_simple_exclusion() {
    bootstrap(
        2,
        || (UnmarkCounterTracer::default(), MaxConcurrencyTracer::default()),
        |builder, [sys1, sys2], []| {
            builder.use_resource(
                Node::SendSystem(sys1),
                ResourceType::Simple {
                    arch: DbgTypeId::of::<TestArch>(),
                    comp: DbgTypeId::of::<Comp1>(),
                },
                ResourceAccess { mutable: true, discrim: None },
            );
            builder.use_resource(
                Node::SendSystem(sys2),
                ResourceType::Simple {
                    arch: DbgTypeId::of::<TestArch>(),
                    comp: DbgTypeId::of::<Comp2>(),
                },
                ResourceAccess { mutable: true, discrim: None },
            );
        },
        || {
            let asem = AntiSemaphore::new(2);
            move |_| asem.wait()
        },
        |(uct, mct)| {
            let unmark_count = uct.0.into_inner();
            assert_eq!(unmark_count, 0, "Expected no resource exclusion on different components");

            let max_concurrency = mct.max.into_inner();
            assert_eq!(max_concurrency, 2, "Expected 2 systems to run concurrently");
        },
    );
}

#[test]
fn test_simple_share() {
    bootstrap(
        2,
        || (UnmarkCounterTracer::default(), MaxConcurrencyTracer::default()),
        |builder, [sys1, sys2, sys3, sys4], []| {
            for sys in [sys1, sys2, sys3, sys4] {
                builder.use_resource(
                    Node::SendSystem(sys),
                    ResourceType::Simple {
                        arch: DbgTypeId::of::<TestArch>(),
                        comp: DbgTypeId::of::<Comp1>(),
                    },
                    ResourceAccess { mutable: false, discrim: None },
                );
            }
        },
        || {
            let asem = AntiSemaphore::new(2);
            move |_| asem.wait()
        },
        |(uct, mct)| {
            let unmark_count = uct.0.into_inner();
            assert_eq!(unmark_count, 0, "Expected no exclusion");

            let max_concurrency = mct.max.into_inner();
            assert_eq!(max_concurrency, 2, "Expected 2 systems to run concurrently");
        },
    );
}

#[test]
fn test_isotope_exclusion() {
    bootstrap(
        2,
        || (UnmarkCounterTracer::default(), MaxConcurrencyTracer::default()),
        |builder, [sys1, sys2, sys3], []| {
            builder.use_resource(
                Node::SendSystem(sys1),
                ResourceType::Isotope {
                    arch: DbgTypeId::of::<TestArch>(),
                    comp: DbgTypeId::of::<Comp1>(),
                },
                ResourceAccess { mutable: true, discrim: None },
            );
            builder.use_resource(
                Node::SendSystem(sys2),
                ResourceType::Isotope {
                    arch: DbgTypeId::of::<TestArch>(),
                    comp: DbgTypeId::of::<Comp1>(),
                },
                ResourceAccess { mutable: true, discrim: None },
            );
            builder.use_resource(
                Node::SendSystem(sys3),
                ResourceType::Isotope {
                    arch: DbgTypeId::of::<TestArch>(),
                    comp: DbgTypeId::of::<Comp1>(),
                },
                ResourceAccess { mutable: false, discrim: None }, // mutable: false here
            );
        },
        || |_| (),
        |(uct, mct)| {
            let unmark_count = uct.0.into_inner();
            assert_eq!(
                unmark_count, 3,
                "Expected resource exclusion to unmark all other runnable nodes"
            );

            let max_concurrency = mct.max.into_inner();
            assert_eq!(max_concurrency, 1, "Expected resource exclusion to deny concurrency");
        },
    );
}

#[test]
fn test_intersecting_isotope_exclusion() {
    bootstrap(
        3,
        || (UnmarkCounterTracer::default(), MaxConcurrencyTracer::default()),
        |builder, [sys1, sys2, sys3], []| {
            builder.use_resource(
                Node::SendSystem(sys1),
                ResourceType::Isotope {
                    arch: DbgTypeId::of::<TestArch>(),
                    comp: DbgTypeId::of::<Comp1>(),
                },
                ResourceAccess { mutable: true, discrim: Some(vec![1, 2]) },
            );
            builder.use_resource(
                Node::SendSystem(sys2),
                ResourceType::Isotope {
                    arch: DbgTypeId::of::<TestArch>(),
                    comp: DbgTypeId::of::<Comp1>(),
                },
                ResourceAccess { mutable: true, discrim: Some(vec![2, 3]) },
            );
            builder.use_resource(
                Node::SendSystem(sys3),
                ResourceType::Isotope {
                    arch: DbgTypeId::of::<TestArch>(),
                    comp: DbgTypeId::of::<Comp1>(),
                },
                ResourceAccess { mutable: false, discrim: Some(vec![3, 4]) }, // mutable: false here
            );
        },
        || {
            let asem = AntiSemaphore::new(2);
            move |node| {
                if matches!(node, Node::SendSystem(SendSystemIndex(0 | 2))) {
                    asem.wait();
                }
            }
        },
        |(uct, mct)| {
            let unmark_count = uct.0.into_inner();
            assert_eq!(
                unmark_count, 1,
                "Expected resource exclusion to unmark only exclusive nodes"
            );

            let max_concurrency = mct.max.into_inner();
            assert_eq!(
                max_concurrency, 2,
                "Expected [1, 2] and [3, 4] systems to run concurrently"
            );
        },
    );
}

#[test]
fn test_different_isotope_exclusion() {
    bootstrap(
        2,
        || (UnmarkCounterTracer::default(), MaxConcurrencyTracer::default()),
        |builder, [sys1, sys2], []| {
            builder.use_resource(
                Node::SendSystem(sys1),
                ResourceType::Isotope {
                    arch: DbgTypeId::of::<TestArch>(),
                    comp: DbgTypeId::of::<Comp1>(),
                },
                ResourceAccess { mutable: true, discrim: None },
            );
            builder.use_resource(
                Node::SendSystem(sys2),
                ResourceType::Isotope {
                    arch: DbgTypeId::of::<TestArch>(),
                    comp: DbgTypeId::of::<Comp2>(),
                },
                ResourceAccess { mutable: true, discrim: None },
            );
        },
        || {
            let asem = AntiSemaphore::new(2);
            move |_| asem.wait()
        },
        |(uct, mct)| {
            let unmark_count = uct.0.into_inner();
            assert_eq!(unmark_count, 0, "Expected no resource exclusion on different components");

            let max_concurrency = mct.max.into_inner();
            assert_eq!(max_concurrency, 2, "Expected 2 systems to run concurrently");
        },
    );
}

#[test]
fn test_isotope_share() {
    bootstrap(
        2,
        || (UnmarkCounterTracer::default(), MaxConcurrencyTracer::default()),
        |builder, [sys1, sys2, sys3, sys4], []| {
            for sys in [sys1, sys2, sys3, sys4] {
                builder.use_resource(
                    Node::SendSystem(sys),
                    ResourceType::Isotope {
                        arch: DbgTypeId::of::<TestArch>(),
                        comp: DbgTypeId::of::<Comp1>(),
                    },
                    ResourceAccess { mutable: false, discrim: None },
                );
            }
        },
        || {
            let asem = AntiSemaphore::new(2);
            move |_| asem.wait()
        },
        |(uct, mct)| {
            let unmark_count = uct.0.into_inner();
            assert_eq!(unmark_count, 0, "Expected no exclusion");

            let max_concurrency = mct.max.into_inner();
            assert_eq!(max_concurrency, 2, "Expected 2 systems to run concurrently");
        },
    );
}

#[test]
fn test_partition() {
    bootstrap(
        2,
        || (StartOrderTracer::default(),),
        |builder, [sys1, sys2], []| {
            builder.add_dependencies(
                vec![system::spec::Dependency::After(Box::new(TestPartition(0)))],
                Node::SendSystem(sys1),
            );
            builder.add_dependencies(
                vec![system::spec::Dependency::Before(Box::new(TestPartition(0)))],
                Node::SendSystem(sys2),
            );
        },
        || |_| (),
        |(StartOrderTracer(order),)| {
            assert_eq!(
                &order.into_inner()[..],
                &[Node::SendSystem(SendSystemIndex(1)), Node::SendSystem(SendSystemIndex(0))]
            );
        },
    );
}

#[test]
fn test_duplicate_partition() {
    bootstrap(
        2,
        || (StartOrderTracer::default(),),
        |builder, [sys1, sys2], []| {
            builder.add_dependencies(
                vec![
                    system::spec::Dependency::After(Box::new(TestPartition(0))),
                    system::spec::Dependency::After(Box::new(TestPartition(0))),
                ],
                Node::SendSystem(sys1),
            );
            builder.add_dependencies(
                vec![
                    system::spec::Dependency::Before(Box::new(TestPartition(0))),
                    system::spec::Dependency::Before(Box::new(TestPartition(0))),
                ],
                Node::SendSystem(sys2),
            );
        },
        || |_| (),
        |(StartOrderTracer(order),)| {
            assert_eq!(
                &order.into_inner()[..],
                &[Node::SendSystem(SendSystemIndex(1)), Node::SendSystem(SendSystemIndex(0))]
            );
        },
    );
}

#[test]
#[should_panic = "Scheduled systems have a cyclic dependency: thread-safe system #0 (SendSystem \
                  #0) -> partition #0 (TestPartition(0)) -> thread-safe system #0 (SendSystem #0)"]
fn test_conflicting_partition() {
    bootstrap(
        2,
        || (),
        |builder, [sys1], []| {
            builder.add_dependencies(
                vec![
                    system::spec::Dependency::After(Box::new(TestPartition(0))),
                    system::spec::Dependency::Before(Box::new(TestPartition(0))),
                ],
                Node::SendSystem(sys1),
            );
        },
        || |_| (),
        |()| {},
    );
}

// Make sure that thread-local systems have the same exclusion rules as thread-safe systems.
#[test]
fn test_thread_local_exclusion() {
    bootstrap(
        1,
        || (UnmarkCounterTracer::default(), MaxConcurrencyTracer::default()),
        |builder, [sys1], [sys2]| {
            builder.use_resource(
                Node::SendSystem(sys1),
                ResourceType::Isotope {
                    arch: DbgTypeId::of::<TestArch>(),
                    comp: DbgTypeId::of::<Comp1>(),
                },
                ResourceAccess { mutable: true, discrim: Some(vec![1, 2]) },
            );
            builder.use_resource(
                Node::UnsendSystem(sys2),
                ResourceType::Isotope {
                    arch: DbgTypeId::of::<TestArch>(),
                    comp: DbgTypeId::of::<Comp1>(),
                },
                ResourceAccess { mutable: true, discrim: Some(vec![2, 3]) },
            );
        },
        || |_| {},
        |(uct, mct)| {
            let unmark_count = uct.0.into_inner();
            assert_eq!(
                unmark_count, 1,
                "Expected thread-local and thread-safe systems to still conform to resource \
                 exclusion"
            );

            let max_concurrency = mct.max.into_inner();
            assert_eq!(max_concurrency, 1, "Expected 2 systems to run concurrently");
        },
    );
}

#[test]
fn test_zero_concurrency_single_send() {
    bootstrap(
        0,
        || (MaxConcurrencyTracer::default(),),
        |_builder, [_sys], []| {},
        || |_| {},
        |(mct,)| {
            let max_concurrency = mct.max.into_inner();
            assert_eq!(max_concurrency, 1, "Expected single send system to run");
        },
    );
}

#[test]
fn test_zero_concurrency_single_unsend() {
    bootstrap(
        0,
        || (MaxConcurrencyTracer::default(),),
        |_builder, [], [_sys]| {},
        || |_| {},
        |(mct,)| {
            let max_concurrency = mct.max.into_inner();
            assert_eq!(max_concurrency, 1, "Expected single unsend system to run");
        },
    );
}

#[test]
#[should_panic = "system panic"]
fn test_send_panic() {
    bootstrap(3, || (), |_builder, [_], []| {}, || |_| panic!("system panic"), |_| {})
}

#[test]
#[should_panic = "system panic"]
fn test_unsend_panic() {
    bootstrap(3, || (), |_builder, [], [_]| {}, || |_| panic!("system panic"), |_| {})
}

/// Bootstraps a test function for the scheduler.
///
/// This function performs the following:
/// - Initialize the logger if it is missing.
/// - Repeat the test for [`CONCURRENT_TEST_REPETITIONS`] iterations.
/// - Schedules `S` thread-safe systems and `U` thread-unsafe systems to the scheduler,
///   calling `make_run` for every iteration to create a shared runner for all systems.
///   This means any values declared in the first layer of the `make_run` closure
///   are going to be shared among all systems in the same iteration,
///   while values declared in the second layer are local to a specific system run.
///   The inner closure receives the system node ID.
/// - Runs `customize` to setup system requests.
///   The second and third parameters of `customize` are arrays,
///   the respective lengths of which specify
///   the number of thread-safe and thread-unsafe systems to schedule.
///   The function is called with the node IDs of the corresponding systems.
///   Therefore, by writing the second and third parameters as array patterns,
///   the sizes `S` and `U` can be automatically inferred.
/// - Builds a new scheduler from the information above.
/// - Executes the built scheduler with a TRACE-level tracer,
///   along with the tuple of schedulers returned by `make_tracers`.
/// - Calls `verify` with the tuple of tracers to verify that the test has succeeded.
fn bootstrap<const S: usize, const U: usize, T, C, R, V>(
    concurrency: usize,
    make_tracers: fn() -> T,
    customize: C,
    make_run: fn() -> R,
    verify: V,
) where
    C: Fn(&mut Builder, [SendSystemIndex; S], [UnsendSystemIndex; U]),
    R: Fn(Node) + Send + Sync + 'static,
    V: Fn(T),
    tracer::Aggregate<T>: Tracer,
{
    test_util::init();

    for i in 0..*CONCURRENT_TEST_REPETITIONS {
        log::trace!("Repeat test round {i}");

        let mut builder = Builder::new(concurrency);

        let run = Arc::new(make_run());

        let send_nodes: [SendSystemIndex; S] = (0..S)
            .map(|i| {
                let node_box = Arc::new(Mutex::new(None::<Node>));
                let (node, _spec) = builder.push_send_system(Box::new(TestSystem(
                    format!("SendSystem #{}", i),
                    Box::new({
                        let run = Arc::clone(&run);
                        let node_box = Arc::clone(&node_box);
                        move || {
                            let node_guard = node_box.try_lock().expect("node_box contention");
                            let &node = node_guard.as_ref().expect("node_box not populated");
                            run(node)
                        }
                    }) as Box<dyn Fn() + Send>,
                )));
                {
                    let mut node_guard = node_box.try_lock().expect("node_box contention");
                    *node_guard = Some(node);
                }
                match node {
                    Node::SendSystem(index) => index,
                    _ => unreachable!(),
                }
            })
            .collect::<Vec<_>>()
            .try_into()
            .expect("S == S");
        let unsend_nodes: [UnsendSystemIndex; U] = (0..U)
            .map(|i| {
                let node_box = Rc::new(Cell::new(None::<Node>));
                let (node, _spec) = builder.push_unsend_system(Box::new(TestSystem(
                    format!("UnsendSystem #{}", i),
                    Box::new({
                        let run = Arc::clone(&run);
                        let node_box = Rc::clone(&node_box);
                        move || {
                            let node = node_box.get();
                            let node = node.expect("node_box not populated");
                            run(node)
                        }
                    }) as Box<dyn Fn()>,
                )
                    as UnsendSystem));
                node_box.set(Some(node));
                match node {
                    Node::UnsendSystem(index) => index,
                    _ => unreachable!(),
                }
            })
            .collect::<Vec<_>>()
            .try_into()
            .expect("U == U");

        customize(&mut builder, send_nodes, unsend_nodes);

        let mut scheduler = builder.build();

        let tracer = tracer::Aggregate((
            tracer::Log(log::Level::Trace),
            RunCounterTracer::default(),
            tracer::Aggregate(make_tracers()),
        ));

        scheduler.execute(
            &tracer,
            &mut world::Components::empty(),
            &mut world::SyncGlobals::empty(),
            &mut world::UnsyncGlobals::empty(),
            &mut rctrack::MaybeStoreMap::default(),
            &mut ealloc::Map::default(),
        );

        let tracer::Aggregate((_, rct, tracer::Aggregate(tracers))) = tracer;

        assert_eq!(rct.send.load(atomic::Ordering::SeqCst), S);
        assert_eq!(rct.unsend.load(atomic::Ordering::SeqCst), U);

        verify(tracers);
    }
}