concinnity-core 0.18.69

Runtime vocabulary for the Concinnity engine: GPU layouts, ECS components, registry, CPU kernels
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
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
// src/render_graph/compile.rs
//
// Frozen `CompiledGraph` produced by `GraphBuilder::compile`. The compile
// pass:
//
//   1. Validates exactly one pass declares `presents()`.
//   2. Validates every declared read has a producer (write) in the graph.
//   3. Topologically sorts passes by read-after-write + write-after-write
//      edges. Cycles are an error.
//   4. Derives a `barriers_before` list per pass from the per-resource
//      state machine (Undefined → Read → Write transitions).
//   5. Computes a `[first, last]` pass-index lifetime per resource, which
//      [`super::alias`] uses to overlap non-overlapping lifetimes in
//      physical memory.
//
// The graph allocates no GPU resources and interprets no barriers per
// backend. This module only produces the data the backend executor consumes.

use alloc::collections::BinaryHeap;
use alloc::vec;
use alloc::vec::Vec;
use core::cmp::Reverse;
use hashbrown::HashMap;

use super::builder::{GraphBuilder, ResourceVersion};
use super::passes::PassId;
use super::types::{
    BarrierOp, BufferDesc, GraphResourceClass, PassKind, PassRange, ReadStages, ResourceId,
    ResourceOrigin, ResourceState, TextureDesc,
};

// Compiler error. Returned by [`GraphBuilder::compile`]; the call site
// typically panics (these are programmer errors, not runtime conditions).
#[derive(Debug, Clone, PartialEq)]
pub enum GraphError {
    // No pass declared `presents()`. Every graph must terminate at the
    // swapchain write.
    MissingPresenter,
    // More than one pass declared `presents()`. The graph compiler does
    // not pick one for you.
    MultiplePresenters(usize),
    // A pass declared `read_*(handle)` but no pass writes that exact
    // `(resource, version)` pair. Most commonly this happens when a
    // caller forgets to thread the post-write handle from a prior pass
    // (used the pre-write `h` instead of the `h1` returned by
    // `write_texture`).
    MissingProducer {
        pass: PassId,
        resource_label: &'static str,
        version: u32,
    },
    // The read / write graph has a cycle: toposort visited fewer
    // passes than declared.
    Cycle,
}

impl core::fmt::Display for GraphError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            GraphError::MissingPresenter => {
                write!(
                    f,
                    "no pass declared presents(); the graph has no terminal node"
                )
            }
            GraphError::MultiplePresenters(n) => {
                write!(f, "{} passes declared presents(); only one is allowed", n)
            }
            GraphError::MissingProducer {
                pass,
                resource_label,
                version,
            } => write!(
                f,
                "pass {:?} reads {} v{} but no pass writes that version",
                pass, resource_label, version
            ),
            GraphError::Cycle => write!(f, "cycle in render-graph read/write edges"),
        }
    }
}

impl core::error::Error for GraphError {}

/// One pass in execution order. Carries the declared reads / writes, the
/// barriers the executor must emit before running this pass, and the
/// `PassKind` + `PassId` the backend dispatches on.
#[derive(Debug, Clone)]
pub struct CompiledPass {
    /// The pass's stable identity.
    pub id: PassId,
    /// Whether the executor encodes a render or a compute pass.
    pub kind: PassKind,
    /// Resource versions this pass reads.
    pub reads: Vec<ResourceVersion>,
    /// Resource versions this pass writes.
    pub writes: Vec<ResourceVersion>,
    /// Whether this pass writes the swapchain image.
    pub presents: bool,
    /// Barriers the executor emits before the pass.
    pub barriers_before: Vec<BarrierOp>,
}

/// One resource in the compiled graph. Carries the lifetime interval
/// (in compiled-pass-index space) and the origin distinction the
/// aliaser will care about.
#[derive(Debug, Clone)]
pub struct CompiledResource {
    /// The resource's stable label, the executor's join key.
    pub label: &'static str,
    /// Whether the resource is imported or graph-declared.
    pub origin: ResourceOrigin,
    /// The pass range over which the resource must stay live.
    pub lifetime: PassRange,
    /// Texture shape (format / size / sample count / layers), `None` for a
    /// buffer. The aliasing planner uses it to size each transient resource;
    /// the backend will use it to allocate the realised resource.
    pub tex_desc: Option<TextureDesc>,
    // Buffer shape (size / usage), `None` for a texture. Carried so a backend can
    // derive the resource's barrier class from its declared usage.
    pub(crate) buf_desc: Option<BufferDesc>,
}

impl CompiledResource {
    /// The barrier class this resource's declared usage puts it in. The graph is
    /// the single source of truth for it: a backend executor resolves a label to
    /// its GPU object but never restates what kind of resource it is, so the
    /// executors cannot disagree. `None` for a resource carrying neither desc.
    pub fn class(&self) -> Option<GraphResourceClass> {
        if let Some(desc) = self.tex_desc {
            return Some(GraphResourceClass::for_texture_usage(desc.usage));
        }
        self.buf_desc
            .map(|desc| GraphResourceClass::for_buffer_usage(desc.usage))
    }
}

/// Frozen graph the per-backend executor consumes. Passes are in
/// execution order; barriers are pre-derived; resource lifetimes are
/// ready for a future aliaser.
#[derive(Debug, Clone)]
pub struct CompiledGraph {
    /// Passes in execution order.
    pub passes: Vec<CompiledPass>,
    /// Resources, indexed by [`ResourceId`].
    pub resources: Vec<CompiledResource>,
}

impl CompiledGraph {
    // Restrict a pass's `barriers_before` to the resources whose label is in
    // `allow`, pairing each kept barrier with that label. A backend executor
    // uses this to drive native transitions for the subset of resources that
    // have moved off hand-written inline barriers, while every other resource
    // keeps its existing inline / render-pass-driven path. The label is the
    // stable join key the backend resolves to its GPU object.
    #[cfg(test)]
    pub(crate) fn pass_barriers_for(
        &self,
        pass: &CompiledPass,
        allow: &[&str],
    ) -> Vec<(&'static str, BarrierOp)> {
        pass.barriers_before
            .iter()
            .filter_map(|op| {
                let label = self.resources[op.resource_index()].label;
                allow.contains(&label).then_some((label, *op))
            })
            .collect()
    }
}

impl GraphBuilder {
    // Topologically sort, validate, and derive per-pass barriers.
    // Returns the frozen graph the executor consumes. The graph must
    // declare exactly one `presents()` pass: the terminal swapchain
    // write that ends the frame.
    pub(crate) fn compile(self) -> Result<CompiledGraph, GraphError> {
        let GraphBuilder {
            resources,
            mut passes,
        } = self;
        let n_passes = passes.len();
        let n_resources = resources.len();

        // Step 1: presenter validation
        let presenters: Vec<usize> = passes
            .iter()
            .enumerate()
            .filter(|(_, p)| p.presents)
            .map(|(i, _)| i)
            .collect();
        match presenters.len() {
            0 => return Err(GraphError::MissingPresenter),
            1 => {}
            n => return Err(GraphError::MultiplePresenters(n)),
        }

        // Step 2: build (resource, version) -> writer-pass lookup
        let mut writer_of: HashMap<(ResourceId, u32), usize> = HashMap::new();
        for (i, pass) in passes.iter().enumerate() {
            for w in &pass.writes {
                // Each (resource, version) pair has exactly one writer
                // by construction (write_texture bumps the version, so
                // two passes can't claim the same one).
                writer_of.insert((w.resource, w.version), i);
            }
        }

        // Step 3: validate every read has a producer
        // An imported resource at version 0 has an *implicit* producer
        // (the engine that owns the GPU object). Reads of (imported, v0)
        // are therefore always legal even though no graph pass writes
        // them. Reads of (transient, v0) and reads at any version > 0
        // still need a real producer in the same graph.
        for pass in passes.iter() {
            for r in &pass.reads {
                if writer_of.contains_key(&(r.resource, r.version)) {
                    continue;
                }
                let decl = &resources[r.resource.index()];
                let implicit_producer = r.version == 0 && decl.origin() == ResourceOrigin::Imported;
                if !implicit_producer {
                    return Err(GraphError::MissingProducer {
                        pass: pass.id,
                        resource_label: decl.label(),
                        version: r.version,
                    });
                }
            }
        }

        // Step 4: build dependency edges and run Kahn's toposort
        // edges[i] = list of passes that depend on i (must run after i).
        let mut edges: Vec<Vec<usize>> = vec![Vec::new(); n_passes];
        let mut in_degree: Vec<usize> = vec![0; n_passes];
        let add_edge =
            |from: usize, to: usize, edges: &mut [Vec<usize>], in_degree: &mut [usize]| {
                if from != to {
                    edges[from].push(to);
                    in_degree[to] += 1;
                }
            };

        // Build a (resource, version) → [reader pass_idxs] lookup so the
        // WAR step below can find prior readers without rescanning every
        // pass per write.
        let mut readers_of: HashMap<(ResourceId, u32), Vec<usize>> = HashMap::new();
        for (i, pass) in passes.iter().enumerate() {
            for r in &pass.reads {
                readers_of
                    .entry((r.resource, r.version))
                    .or_default()
                    .push(i);
            }
        }

        for (pass_idx, pass) in passes.iter().enumerate() {
            // Read-after-write: each read of (resource, version) requires
            // the pass that wrote (resource, version) to precede us.
            for r in &pass.reads {
                if let Some(&w) = writer_of.get(&(r.resource, r.version)) {
                    add_edge(w, pass_idx, &mut edges, &mut in_degree);
                }
            }
            // Write-after-write: a write that produced version V depends
            // on the pass that produced version V-1 (the prior content
            // matters for blend-style writes; for plain overwrites it
            // doesn't but the ordering is still correct).
            for w in &pass.writes {
                if w.version > 1
                    && let Some(&prev_writer) = writer_of.get(&(w.resource, w.version - 1))
                {
                    add_edge(prev_writer, pass_idx, &mut edges, &mut in_degree);
                }
            }
            // Write-after-read: a write that produces version V requires
            // every reader of version V-1 to precede us. Without this,
            // a reader of the pre-write version could otherwise be
            // re-ordered after the writer, sampling stale-from-the-other-
            // direction data. In the Metal frame this fires on
            // AutoExposure (reads `hdr_resolve_v1` produced by Main)
            // pinning before Decals / Fog / ParticlesDraw (which bump
            // hdr_resolve to v2+). Self-edges are filtered by add_edge.
            for w in &pass.writes {
                if w.version > 0
                    && let Some(readers) = readers_of.get(&(w.resource, w.version - 1))
                {
                    for &reader in readers {
                        add_edge(reader, pass_idx, &mut edges, &mut in_degree);
                    }
                }
            }
        }

        // Stable order: when two passes are both ready, pick the one
        // declared first. A min-heap on the original pass index achieves
        // this without rescanning the ready set.
        let mut ready: BinaryHeap<Reverse<usize>> = (0..n_passes)
            .filter(|&i| in_degree[i] == 0)
            .map(Reverse)
            .collect();
        let mut order: Vec<usize> = Vec::with_capacity(n_passes);
        while let Some(Reverse(idx)) = ready.pop() {
            order.push(idx);
            for &neighbor in &edges[idx] {
                in_degree[neighbor] -= 1;
                if in_degree[neighbor] == 0 {
                    ready.push(Reverse(neighbor));
                }
            }
        }
        if order.len() != n_passes {
            return Err(GraphError::Cycle);
        }

        // Step 5: realise compiled passes in execution order
        let mut compiled_passes: Vec<CompiledPass> = order
            .iter()
            .map(|&orig_idx| {
                // `order` is a permutation, so each pass is realised exactly
                // once and nothing reads the declaration after this.
                let decl = &mut passes[orig_idx];
                CompiledPass {
                    id: decl.id,
                    kind: decl.kind,
                    reads: core::mem::take(&mut decl.reads),
                    writes: core::mem::take(&mut decl.writes),
                    presents: decl.presents,
                    barriers_before: Vec::new(),
                }
            })
            .collect();

        // Step 6: derive per-pass barriers
        derive_barriers(&mut compiled_passes, n_resources);

        // Step 7: compute resource lifetimes
        let mut lifetimes: Vec<Option<PassRange>> = vec![None; n_resources];
        for (sorted_idx, pass) in compiled_passes.iter().enumerate() {
            for v in pass.writes.iter().chain(pass.reads.iter()) {
                let i = v.resource.index();
                let merged = match lifetimes[i] {
                    None => PassRange {
                        first: sorted_idx,
                        last: sorted_idx,
                    },
                    Some(PassRange { first, .. }) => PassRange {
                        first,
                        last: sorted_idx,
                    },
                };
                lifetimes[i] = Some(merged);
            }
        }

        let compiled_resources: Vec<CompiledResource> = resources
            .into_iter()
            .enumerate()
            .map(|(i, decl)| {
                // A resource that's declared but never touched gets a
                // degenerate `[0, 0]` lifetime; the executor can treat
                // it as a leak warning later.
                let lifetime = lifetimes[i].unwrap_or(PassRange { first: 0, last: 0 });
                CompiledResource {
                    label: decl.label(),
                    origin: decl.origin(),
                    lifetime,
                    tex_desc: decl.texture_desc(),
                    buf_desc: decl.buffer_desc(),
                }
            })
            .collect();

        Ok(CompiledGraph {
            passes: compiled_passes,
            resources: compiled_resources,
        })
    }
}

// Derive each pass's `barriers_before` from the per-resource state machine
// (Undefined -> Read -> Write). Emit a `BarrierOp` whenever a resource's
// effective access (Write if the pass writes it, else Read) differs from its
// prior state.
//
// Effective-access rule: a pass that writes a resource leaves it in `Write`
// state regardless of whether it also reads it (blend-style read-modify-write
// is handled by the backend's render-pass setup, not by an intra-pass
// barrier).
//
// Read-stage union: a `* -> Read` barrier carries the stage union of the WHOLE
// following read-run (every pass that reads this version before the next
// writer), and a `Read -> Write` barrier carries the prior run's union. This is
// why the work is done per resource rather than per pass: a write read by a
// compute consumer and a fragment consumer needs ONE producer barrier that
// makes the write visible to both stages, so the deriver must see the whole run
// before emitting that first barrier. A per-consumer read-to-read barrier would
// not carry the producing write and so would not synchronise the second stage.
fn derive_barriers(passes: &mut [CompiledPass], n_resources: usize) {
    // Per-pass effective access to one resource: a write (which wins over any
    // read the same pass declares) or a read in the pass's shader stage.
    #[derive(Copy, Clone)]
    enum Eff {
        Write,
        Read(ReadStages),
    }

    // Build each resource's timeline: its (pass index, effective access) pairs
    // in pass order. The outer loop is ascending pass index and each pass
    // contributes at most one entry per resource, so every timeline stays
    // sorted by pass index without an explicit sort.
    let mut timeline: Vec<Vec<(usize, Eff)>> = (0..n_resources).map(|_| Vec::new()).collect();
    for (i, pass) in passes.iter().enumerate() {
        let stage = ReadStages::for_pass_kind(pass.kind);
        let mut access: HashMap<ResourceId, Eff> = HashMap::new();
        for r in &pass.reads {
            access.entry(r.resource).or_insert(Eff::Read(stage));
        }
        for w in &pass.writes {
            access.insert(w.resource, Eff::Write);
        }
        // Push in resource-index order so each pass's `barriers_before` ends up
        // sorted by resource index (the outer resource loop below is ascending),
        // matching the deterministic order the executor expects.
        let mut touched: Vec<(ResourceId, Eff)> = access.into_iter().collect();
        touched.sort_by_key(|(r, _)| r.0);
        for (res, eff) in touched {
            timeline[res.index()].push((i, eff));
        }
    }

    // Walk each resource's timeline, tracking its running state and the current
    // read-run's stage union, emitting a barrier on each state change.
    for (r_idx, entries) in timeline.iter().enumerate() {
        let resource = ResourceId(r_idx as u32);
        let mut state = ResourceState::Undefined;
        let mut run_stages = ReadStages::empty();

        for (k, &(pass_idx, eff)) in entries.iter().enumerate() {
            match eff {
                Eff::Write => {
                    // Emitted for every write, including a write that follows a
                    // write. Each pass contributes at most one timeline entry per
                    // resource, so back-to-back `Write` entries are always
                    // different passes, and their ordering is not implied by
                    // anything else: on the read-modify-write chains (hdr_resolve
                    // through the decoration passes) each pass records into its own
                    // command buffer, and command buffers in one submission may
                    // overlap in execution. The resulting `Write -> Write` op is a
                    // pure execution + memory dependency with no state change,
                    // which each backend translates by its own rules.
                    let read_stages = if state == ResourceState::Read {
                        // A `Read -> Write` carries the prior run's union: the
                        // write must wait on every reader.
                        run_stages
                    } else {
                        // `Undefined -> Write` and `Write -> Write` have no Read
                        // side.
                        ReadStages::empty()
                    };
                    passes[pass_idx].barriers_before.push(BarrierOp {
                        resource,
                        from: state,
                        to: ResourceState::Write,
                        read_stages,
                    });
                    state = ResourceState::Write;
                    run_stages = ReadStages::empty();
                }
                Eff::Read(_) => {
                    if state != ResourceState::Read {
                        // First read of a new run: union the contiguous run's
                        // stages so the one producer barrier covers them all.
                        let mut run = ReadStages::empty();
                        for &(_, e) in entries[k..].iter() {
                            match e {
                                Eff::Read(s) => run = run.union(s),
                                Eff::Write => break,
                            }
                        }
                        passes[pass_idx].barriers_before.push(BarrierOp {
                            resource,
                            from: state,
                            to: ResourceState::Read,
                            read_stages: run,
                        });
                        state = ResourceState::Read;
                        run_stages = run;
                    }
                    // Continuation read: the run's barrier already carries this
                    // stage (unioned above), so emit nothing.
                }
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::super::types::{BufferUsage, PixelFormat, TextureDesc, TextureSize, TextureUsage};
    use super::*;
    use crate::render::render_graph::builder::GraphBuilder;
    use crate::render::render_graph::passes::PassId;
    use crate::render::render_graph::types::{BufferDesc, PassKind};

    fn tex() -> TextureDesc {
        TextureDesc::texture_2d(
            TextureSize::Drawable,
            TextureSize::Drawable,
            PixelFormat::Rgba16Float,
            TextureUsage::SHADER_READ | TextureUsage::RENDER_TARGET,
        )
    }

    fn buf() -> BufferDesc {
        BufferDesc {
            size_bytes: None,
            usage: BufferUsage::STORAGE,
        }
    }

    #[test]
    fn linear_chain_toposorts_in_declared_order() {
        // A writes T -> B reads T writes U -> C reads U presents.
        let mut b = GraphBuilder::new();
        let t = b.create_texture("t", tex());
        let u = b.create_texture("u", tex());

        let t1 = b
            .add_pass(PassId::Shadow, PassKind::Render)
            .write_texture(t);
        let u1 = {
            let mut p = b.add_pass(PassId::Main, PassKind::Render);
            p.read_texture(t1);
            p.write_texture(u)
        };
        b.add_pass(PassId::Composite, PassKind::Render)
            .read_texture(u1)
            .presents();

        let g = b.compile().expect("graph compiles");
        let order: Vec<PassId> = g.passes.iter().map(|p| p.id).collect();
        assert_eq!(order, vec![PassId::Shadow, PassId::Main, PassId::Composite]);
    }

    #[test]
    fn diamond_toposorts_with_stable_tiebreak() {
        // A writes T; B reads T writes U; C reads T writes V; D reads U+V presents.
        // B and C are both ready after A; declared first wins, so the
        // order is [A, B, C, D].
        let mut b = GraphBuilder::new();
        let t = b.create_texture("t", tex());
        let u = b.create_texture("u", tex());
        let v = b.create_texture("v", tex());

        let t1 = b
            .add_pass(PassId::Shadow, PassKind::Render)
            .write_texture(t);
        let u1 = {
            let mut p = b.add_pass(PassId::Main, PassKind::Render);
            p.read_texture(t1);
            p.write_texture(u)
        };
        let v1 = {
            let mut p = b.add_pass(PassId::SsaoKernel, PassKind::Render);
            p.read_texture(t1);
            p.write_texture(v)
        };
        b.add_pass(PassId::Composite, PassKind::Render)
            .read_texture(u1)
            .read_texture(v1)
            .presents();

        let g = b.compile().expect("graph compiles");
        let order: Vec<PassId> = g.passes.iter().map(|p| p.id).collect();
        // Shadow must precede both Main and SsaoKernel (they read its
        // output); Composite must come last (it reads both their
        // outputs). The stable tie-break picks Main over SsaoKernel
        // because Main was declared first.
        assert_eq!(
            order,
            vec![
                PassId::Shadow,
                PassId::Main,
                PassId::SsaoKernel,
                PassId::Composite,
            ]
        );
    }

    #[test]
    fn read_modify_write_chain_orders_correctly() {
        // A writes hdr v1; B reads v1 writes v2 (decals); C reads v2 writes v3
        // (fog); D reads v3 presents. The version-bump-implies-edge rule
        // forces strict serial order.
        let mut b = GraphBuilder::new();
        let hdr = b.create_texture("hdr", tex());

        let v1 = b
            .add_pass(PassId::Main, PassKind::Render)
            .write_texture(hdr);
        let v2 = {
            let mut p = b.add_pass(PassId::Decals, PassKind::Render);
            p.read_texture(v1);
            p.write_texture(v1)
        };
        let v3 = {
            let mut p = b.add_pass(PassId::Fog, PassKind::Render);
            p.read_texture(v2);
            p.write_texture(v2)
        };
        b.add_pass(PassId::Composite, PassKind::Render)
            .read_texture(v3)
            .presents();

        let g = b.compile().expect("graph compiles");
        let order: Vec<PassId> = g.passes.iter().map(|p| p.id).collect();
        assert_eq!(
            order,
            vec![PassId::Main, PassId::Decals, PassId::Fog, PassId::Composite,]
        );
    }

    #[test]
    fn war_exposes_cross_rmw_cycle() {
        // Two passes RMW different resources, each reading the other's
        // pre-write version: Decals reads y_v1 + writes x_v1 → x_v2;
        // SsaoBlur reads x_v1 + writes y_v1 → y_v2. With WAR enforced,
        // each write needs the *other* pass to have completed its read
        // first, giving SsaoBlur → Decals (Decals's write of x_v2
        // depends on SsaoBlur reading x_v1) AND Decals → SsaoBlur
        // (SsaoBlur's write of y_v2 depends on Decals reading y_v1).
        // That's a cycle, and it's a real one: there's no valid serial
        // order for this pattern.
        let mut b = GraphBuilder::new();
        let x = b.create_texture("x", tex());
        let y = b.create_texture("y", tex());

        let x1 = b.add_pass(PassId::Main, PassKind::Render).write_texture(x);
        let y1 = b.add_pass(PassId::Fog, PassKind::Render).write_texture(y);

        let _x2 = {
            let mut p = b.add_pass(PassId::Decals, PassKind::Render);
            p.read_texture(y1);
            p.write_texture(x1)
        };
        let _y2 = {
            let mut p = b.add_pass(PassId::SsaoBlur, PassKind::Render);
            p.read_texture(x1);
            p.write_texture(y1)
        };
        b.add_pass(PassId::Composite, PassKind::Render).presents();

        match b.compile() {
            Err(GraphError::Cycle) => {}
            other => panic!("expected Cycle, got {:?}", other),
        }
    }

    #[test]
    fn mutual_write_cycle_errors() {
        // A writes X v1 reads Y v2; B writes Y v1 reads X v2; C writes X v2;
        // D writes Y v2. C and D depend on A and B respectively (WAW on the
        // version bump). A reads Y v2 → depends on D. B reads X v2 → depends
        // on C. So: A -> C, B -> D, A -> D, B -> C, D -> A, C -> B. Cycle.
        let mut b = GraphBuilder::new();
        let x = b.create_texture("x", tex());
        let y = b.create_texture("y", tex());

        // First writes establish v1 for both.
        let x1 = b.add_pass(PassId::Main, PassKind::Render).write_texture(x);
        let y1 = b.add_pass(PassId::Fog, PassKind::Render).write_texture(y);

        // Second writes claim v2 for both, declaring the cross-dependency.
        // Decals reads y v2 (will exist), writes x v2.
        // SsaoBlur reads x v2 (will exist), writes y v2.
        // Each "reads v2" requires the other pass to have written v2 first.
        // Mutual.
        {
            let mut p = b.add_pass(PassId::Decals, PassKind::Render);
            // Read of v2 of y; producer is SsaoBlur (pass index 3).
            p.read_texture(super::super::types::TextureHandle {
                resource: y1.resource,
                version: 2,
            });
            p.write_texture(x1);
        }
        {
            let mut p = b.add_pass(PassId::SsaoBlur, PassKind::Render);
            p.read_texture(super::super::types::TextureHandle {
                resource: x1.resource,
                version: 2,
            });
            p.write_texture(y1);
        }
        b.add_pass(PassId::Composite, PassKind::Render).presents();

        match b.compile() {
            Err(GraphError::Cycle) => {}
            other => panic!("expected Cycle, got {:?}", other),
        }
    }

    #[test]
    fn war_edges_pin_reader_before_writer() {
        // Main writes hdr_resolve v1. AutoExposure reads v1. Decals
        // writes v1 → v2. Without WAR edges, toposort could place
        // Decals before AutoExposure (Decals → Main → AutoExposure has
        // no edge constraint either way). WAR forces AutoExposure to
        // precede Decals because Decals's write of v2 depends on all
        // readers of v1 completing first.
        //
        // Declaration order in this test deliberately puts Decals
        // BEFORE AutoExposure so the toposort can't rely on it. Only
        // the WAR edge gets us the right order.
        let mut b = GraphBuilder::new();
        let hdr = b.create_texture("hdr_resolve", tex());

        let hdr_v1 = b
            .add_pass(PassId::Main, PassKind::Render)
            .write_texture(hdr);

        // Decals declared before AutoExposure on purpose; the WAR edge
        // from AutoExposure to Decals must override declaration order.
        let _hdr_v2 = b
            .add_pass(PassId::Decals, PassKind::Render)
            .write_texture(hdr_v1);

        b.add_pass(PassId::AutoExposure, PassKind::Compute)
            .read_texture(hdr_v1);

        b.add_pass(PassId::Composite, PassKind::Render).presents();

        let g = b.compile().expect("compiles");
        let order: Vec<PassId> = g.passes.iter().map(|p| p.id).collect();
        // Main first, then AutoExposure (WAR-pinned before Decals),
        // then Decals, then Composite.
        assert_eq!(
            order,
            vec![
                PassId::Main,
                PassId::AutoExposure,
                PassId::Decals,
                PassId::Composite,
            ]
        );
    }

    #[test]
    fn imported_v0_read_does_not_error() {
        // The engine owns imported resources, so reading them at version
        // 0 (their initial / engine-produced version) is always legal,
        // even when no graph pass writes them. Mirrors how the Main pass
        // reads env_irradiance / env_prefilter cubemaps the engine
        // uploaded at init.
        let mut b = GraphBuilder::new();
        let env = b.import_texture("env", tex());
        let scene = b.create_texture("scene", tex());
        {
            let mut p = b.add_pass(PassId::Main, PassKind::Render);
            p.read_texture(env);
            p.write_texture(scene);
        }
        b.add_pass(PassId::Composite, PassKind::Render)
            .read_texture(super::super::types::TextureHandle {
                resource: scene.resource,
                version: 1,
            })
            .presents();

        let g = b.compile().expect("imported v0 read should compile");
        let order: Vec<PassId> = g.passes.iter().map(|p| p.id).collect();
        assert_eq!(order, vec![PassId::Main, PassId::Composite]);
    }

    #[test]
    fn transient_v0_read_still_errors() {
        // The imported-v0 escape hatch only covers imported resources.
        // A transient declared via create_texture and then read without
        // a write is a real bug: the engine has no implicit producer.
        let mut b = GraphBuilder::new();
        let t = b.create_texture("scratch", tex());
        b.add_pass(PassId::Composite, PassKind::Render)
            .read_texture(t)
            .presents();
        match b.compile() {
            Err(GraphError::MissingProducer {
                pass: PassId::Composite,
                resource_label: "scratch",
                version: 0,
            }) => {}
            other => panic!("expected MissingProducer for transient v0, got {:?}", other),
        }
    }

    #[test]
    fn missing_producer_errors() {
        // Read of a resource version that was never written.
        let mut b = GraphBuilder::new();
        let t = b.create_texture("t", tex());

        // Skip the write; directly synthesise a handle at version 1
        // (which write_texture would have returned).
        let phantom = super::super::types::TextureHandle {
            resource: t.resource,
            version: 1,
        };
        b.add_pass(PassId::Composite, PassKind::Render)
            .read_texture(phantom)
            .presents();

        match b.compile() {
            Err(GraphError::MissingProducer {
                pass: PassId::Composite,
                resource_label: "t",
                version: 1,
            }) => {}
            other => panic!("expected MissingProducer, got {:?}", other),
        }
    }

    #[test]
    fn no_presenter_errors() {
        let mut b = GraphBuilder::new();
        let t = b.create_texture("t", tex());
        b.add_pass(PassId::Main, PassKind::Render).write_texture(t);
        // No presents()!
        match b.compile() {
            Err(GraphError::MissingPresenter) => {}
            other => panic!("expected MissingPresenter, got {:?}", other),
        }
    }

    #[test]
    fn multiple_presenters_errors() {
        let mut b = GraphBuilder::new();
        let t = b.create_texture("t", tex());
        {
            let mut p = b.add_pass(PassId::Main, PassKind::Render);
            p.presents();
            let _ = p.write_texture(t);
        }
        b.add_pass(PassId::Composite, PassKind::Render).presents();
        match b.compile() {
            Err(GraphError::MultiplePresenters(2)) => {}
            other => panic!("expected MultiplePresenters(2), got {:?}", other),
        }
    }

    #[test]
    fn barriers_emit_on_state_transitions() {
        // Main writes T -> Composite reads T. The barrier on Composite
        // should be Undefined→...→Write (Main's effective state is
        // Write because it writes) and then Write→Read (Composite reads).
        let mut b = GraphBuilder::new();
        let t = b.create_texture("t", tex());
        let t1 = b.add_pass(PassId::Main, PassKind::Render).write_texture(t);
        b.add_pass(PassId::Composite, PassKind::Render)
            .read_texture(t1)
            .presents();

        let g = b.compile().expect("compiles");
        // Pass 0 (Main): T transitions Undefined -> Write, one barrier.
        assert_eq!(g.passes[0].barriers_before.len(), 1);
        assert_eq!(
            g.passes[0].barriers_before[0].from,
            ResourceState::Undefined
        );
        assert_eq!(g.passes[0].barriers_before[0].to, ResourceState::Write);
        // Pass 1 (Composite): T transitions Write -> Read, one barrier.
        assert_eq!(g.passes[1].barriers_before.len(), 1);
        assert_eq!(g.passes[1].barriers_before[0].from, ResourceState::Write);
        assert_eq!(g.passes[1].barriers_before[0].to, ResourceState::Read);
    }

    #[test]
    fn pass_barriers_for_filters_by_label() {
        // Main writes "keep" + "skip"; Composite reads both. The allowlist
        // ["keep"] must select only "keep"'s barrier on each pass, dropping
        // "skip"'s entirely.
        let mut b = GraphBuilder::new();
        let keep = b.create_texture("keep", tex());
        let skip = b.create_texture("skip", tex());
        let (keep1, skip1) = {
            let mut p = b.add_pass(PassId::Main, PassKind::Render);
            (p.write_texture(keep), p.write_texture(skip))
        };
        b.add_pass(PassId::Composite, PassKind::Render)
            .read_texture(keep1)
            .read_texture(skip1)
            .presents();

        let g = b.compile().expect("compiles");
        // Main writes both: two barriers total, one kept by the allowlist.
        let main = &g.passes[0];
        let kept = g.pass_barriers_for(main, &["keep"]);
        assert_eq!(kept.len(), 1);
        assert_eq!(kept[0].0, "keep");
        assert_eq!(kept[0].1.source_state(), ResourceState::Undefined);
        assert_eq!(kept[0].1.to_state(), ResourceState::Write);
        // Composite reads both: "keep" transitions Write -> Read.
        let composite = &g.passes[1];
        let kept = g.pass_barriers_for(composite, &["keep"]);
        assert_eq!(kept.len(), 1);
        assert_eq!(kept[0].1.source_state(), ResourceState::Write);
        assert_eq!(kept[0].1.to_state(), ResourceState::Read);
        // An empty allowlist keeps nothing; an unknown label keeps nothing.
        assert!(g.pass_barriers_for(main, &[]).is_empty());
        assert!(g.pass_barriers_for(main, &["nope"]).is_empty());
    }

    #[test]
    fn consecutive_reads_coalesce_no_barriers() {
        // A writes T. B reads T. C reads T. D reads T presents.
        // Barriers: A=W, B=W->R, C=R->R (none), D=R->R (none).
        let mut b = GraphBuilder::new();
        let t = b.create_texture("t", tex());
        let t1 = b.add_pass(PassId::Main, PassKind::Render).write_texture(t);
        b.add_pass(PassId::Decals, PassKind::Render)
            .read_texture(t1);
        b.add_pass(PassId::Fog, PassKind::Render).read_texture(t1);
        b.add_pass(PassId::Composite, PassKind::Render)
            .read_texture(t1)
            .presents();

        let g = b.compile().expect("compiles");
        // pass[0] = Main: 1 barrier (Undefined -> Write)
        assert_eq!(g.passes[0].barriers_before.len(), 1);
        // pass[1] = Decals: 1 barrier (Write -> Read)
        assert_eq!(g.passes[1].barriers_before.len(), 1);
        // pass[2] = Fog: 0 barriers (already Read)
        assert_eq!(g.passes[2].barriers_before.len(), 0);
        // pass[3] = Composite: 0 barriers
        assert_eq!(g.passes[3].barriers_before.len(), 0);
    }

    #[test]
    fn lifetime_intervals_span_first_write_to_last_read() {
        // Main(0) writes T; Decals(1) reads T; Fog(2) ignores T; Composite(3) reads T.
        // T lifetime: [0, 3].
        let mut b = GraphBuilder::new();
        let t = b.create_texture("t", tex());
        let unrelated = b.create_texture("u", tex());

        let t1 = b.add_pass(PassId::Main, PassKind::Render).write_texture(t);
        b.add_pass(PassId::Decals, PassKind::Render)
            .read_texture(t1);
        b.add_pass(PassId::Fog, PassKind::Render)
            .write_texture(unrelated);
        b.add_pass(PassId::Composite, PassKind::Render)
            .read_texture(t1)
            .presents();

        let g = b.compile().expect("compiles");
        let t_idx = t.resource.index();
        let u_idx = unrelated.resource.index();
        assert_eq!(g.resources[t_idx].lifetime.first, 0);
        assert_eq!(g.resources[t_idx].lifetime.last, 3);
        assert_eq!(g.resources[u_idx].lifetime.first, 2);
        assert_eq!(g.resources[u_idx].lifetime.last, 2);
    }

    #[test]
    fn buffer_dep_edges_work_too() {
        // GPU-cull-style: cull writes draw_args (buffer), main reads it.
        let mut b = GraphBuilder::new();
        let draw_args = b.create_buffer("draw_args", buf());
        let scene = b.create_texture("scene", tex());

        let args1 = b
            .add_pass(PassId::Cull, PassKind::Compute)
            .write_buffer(draw_args);
        let scene1 = {
            let mut p = b.add_pass(PassId::Main, PassKind::Render);
            p.read_buffer(args1);
            p.write_texture(scene)
        };
        b.add_pass(PassId::Composite, PassKind::Render)
            .read_texture(scene1)
            .presents();

        let g = b.compile().expect("compiles");
        let order: Vec<PassId> = g.passes.iter().map(|p| p.id).collect();
        assert_eq!(order, vec![PassId::Cull, PassId::Main, PassId::Composite]);
    }

    fn find(g: &CompiledGraph, id: PassId) -> &CompiledPass {
        g.passes.iter().find(|p| p.id == id).expect("pass present")
    }

    #[test]
    fn mixed_stage_read_run_unions_consumer_stages() {
        // Main writes hdr; AutoExposure (compute) and Composite (render) read
        // it. The single producer barrier on the first reader must carry BOTH
        // stages so the write is made visible to the compute and the fragment
        // consumer; the second reader coalesces (no barrier).
        let mut b = GraphBuilder::new();
        let hdr = b.create_texture("hdr", tex());
        let hdr_v1 = b
            .add_pass(PassId::Main, PassKind::Render)
            .write_texture(hdr);
        b.add_pass(PassId::AutoExposure, PassKind::Compute)
            .read_texture(hdr_v1);
        b.add_pass(PassId::Composite, PassKind::Render)
            .read_texture(hdr_v1)
            .presents();

        let g = b.compile().expect("compiles");
        // AutoExposure is the first reader: one Write -> Read barrier carrying
        // the whole run's stage union.
        let ae = find(&g, PassId::AutoExposure);
        assert_eq!(ae.barriers_before.len(), 1);
        assert_eq!(ae.barriers_before[0].source_state(), ResourceState::Write);
        assert_eq!(ae.barriers_before[0].to_state(), ResourceState::Read);
        let rs = ae.barriers_before[0].read_stages();
        assert!(rs.contains(ReadStages::COMPUTE));
        assert!(rs.contains(ReadStages::FRAGMENT));
        // Composite coalesces into the run: no hdr barrier.
        assert_eq!(find(&g, PassId::Composite).barriers_before.len(), 0);
    }

    #[test]
    fn fragment_read_carries_only_fragment_stage() {
        // A lone render-pass consumer carries FRAGMENT only (the common case;
        // the existing migrated resources all look like this).
        let mut b = GraphBuilder::new();
        let t = b.create_texture("t", tex());
        let t1 = b.add_pass(PassId::Main, PassKind::Render).write_texture(t);
        b.add_pass(PassId::Composite, PassKind::Render)
            .read_texture(t1)
            .presents();

        let g = b.compile().expect("compiles");
        let comp = find(&g, PassId::Composite);
        assert_eq!(comp.barriers_before.len(), 1);
        let rs = comp.barriers_before[0].read_stages();
        assert!(rs.contains(ReadStages::FRAGMENT));
        assert!(!rs.contains(ReadStages::COMPUTE));
    }

    #[test]
    fn compute_read_carries_only_compute_stage() {
        // Cull (compute) writes draw_args; AutoExposure (compute) reads it.
        // The reader's barrier carries COMPUTE only. A render presenter writes
        // an unrelated target so the graph is well-formed.
        let mut b = GraphBuilder::new();
        let args = b.create_buffer("draw_args", buf());
        let scene = b.create_texture("scene", tex());
        let args1 = b
            .add_pass(PassId::Cull, PassKind::Compute)
            .write_buffer(args);
        b.add_pass(PassId::AutoExposure, PassKind::Compute)
            .read_buffer(args1);
        {
            let mut p = b.add_pass(PassId::Composite, PassKind::Render);
            let _ = p.write_texture(scene);
            p.presents();
        }

        let g = b.compile().expect("compiles");
        let ae = find(&g, PassId::AutoExposure);
        assert_eq!(ae.barriers_before.len(), 1);
        let rs = ae.barriers_before[0].read_stages();
        assert!(rs.contains(ReadStages::COMPUTE));
        assert!(!rs.contains(ReadStages::FRAGMENT));
    }

    #[test]
    fn war_barrier_carries_prior_read_run_stage_union() {
        // Main writes hdr v1; AutoExposure (compute) and Fog (render) read v1;
        // SsaoBlur writes v1 -> v2 (write only). SsaoBlur's WAR barrier must
        // wait on BOTH readers, so it carries the prior run's union.
        let mut b = GraphBuilder::new();
        let hdr = b.create_texture("hdr", tex());
        let v1 = b
            .add_pass(PassId::Main, PassKind::Render)
            .write_texture(hdr);
        b.add_pass(PassId::AutoExposure, PassKind::Compute)
            .read_texture(v1);
        b.add_pass(PassId::Fog, PassKind::Render).read_texture(v1);
        let v2 = b
            .add_pass(PassId::SsaoBlur, PassKind::Render)
            .write_texture(v1);
        b.add_pass(PassId::Composite, PassKind::Render)
            .read_texture(v2)
            .presents();

        let g = b.compile().expect("compiles");
        let blur = find(&g, PassId::SsaoBlur);
        assert_eq!(blur.barriers_before.len(), 1);
        assert_eq!(blur.barriers_before[0].source_state(), ResourceState::Read);
        assert_eq!(blur.barriers_before[0].to_state(), ResourceState::Write);
        let rs = blur.barriers_before[0].read_stages();
        assert!(rs.contains(ReadStages::COMPUTE));
        assert!(rs.contains(ReadStages::FRAGMENT));
    }

    #[test]
    fn producer_write_barrier_has_empty_read_stages() {
        // A write-only producer transition (Undefined -> Write) has no Read
        // side, so its stage mask is empty.
        let mut b = GraphBuilder::new();
        let t = b.create_texture("t", tex());
        let t1 = b.add_pass(PassId::Main, PassKind::Render).write_texture(t);
        b.add_pass(PassId::Composite, PassKind::Render)
            .read_texture(t1)
            .presents();

        let g = b.compile().expect("compiles");
        let main = find(&g, PassId::Main);
        assert_eq!(main.barriers_before.len(), 1);
        assert_eq!(main.barriers_before[0].to_state(), ResourceState::Write);
        assert!(main.barriers_before[0].read_stages().is_empty());
    }
}