vyre-foundation 0.7.2

Foundation layer: IR, type system, memory model, wire format. Zero application semantics. Part of the vyre GPU compiler.
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
use super::collectors::collect_buffer_targets;
use super::fuse::{
    fuse_programs, fuse_programs_vec, merge_programs_shared, upgrade_buffer_access,
};
use super::FusionError;
use crate::ir::{BufferAccess, BufferDecl, DataType, Expr, Ident, Node, Program};
use rustc_hash::FxHashSet;

#[test]
fn empty_batch_yields_empty_program() {
    let fused = fuse_programs(&[]).unwrap();
    assert!(fused.is_explicit_noop());
}

#[test]
fn single_program_passthrough() {
    let p = Program::wrapped(
        vec![BufferDecl::read("x", 0, DataType::U32)],
        [64, 1, 1],
        vec![Node::let_bind(
            "a",
            crate::ir::Expr::load("x", crate::ir::Expr::u32(0)),
        )],
    );
    let fused = fuse_programs(&[p.clone()]).unwrap();
    assert_eq!(fused.entry().len(), p.entry().len());
}

#[test]
fn single_program_vec_moves_without_clone() {
    let p = Program::wrapped(
        vec![BufferDecl::read("x", 0, DataType::U32)],
        [64, 1, 1],
        vec![Node::let_bind(
            "a",
            crate::ir::Expr::load("x", crate::ir::Expr::u32(0)),
        )],
    );
    let entry_len = p.entry().len();
    let fused = fuse_programs_vec(vec![p]).unwrap();
    assert_eq!(fused.entry().len(), entry_len);
}

#[test]
fn barrier_inserted_for_read_then_atomic() {
    let reader = Program::wrapped(
        vec![BufferDecl::read("state", 0, DataType::U32).with_count(1)],
        [1, 1, 1],
        vec![Node::let_bind(
            "snap",
            crate::ir::Expr::load("state", crate::ir::Expr::u32(0)),
        )],
    );
    let writer = Program::wrapped(
        vec![BufferDecl::read_write("state", 0, DataType::U32).with_count(1)],
        [1, 1, 1],
        vec![Node::let_bind(
            "old",
            crate::ir::Expr::atomic_add("state", crate::ir::Expr::u32(0), crate::ir::Expr::u32(1)),
        )],
    );

    let fused = fuse_programs(&[reader, writer]).unwrap();

    // The combined entry should have a Barrier between the two arms.
    // Because the top-level entry contains non-Region nodes (Barrier),
    // Program::wrapped inserts a root Region.  We need to look inside it.
    let body = match fused.entry() {
        [Node::Region { body, .. }] => body.as_ref(),
        entry => panic!("Fix: fused entry must be wrapped in a root Region, got {entry:?}"),
    };
    let barrier_positions: Vec<usize> = body
        .iter()
        .enumerate()
        .filter(|(_, n)| matches!(n, Node::Barrier { .. }))
        .map(|(i, _)| i)
        .collect();
    assert_eq!(
        barrier_positions.len(),
        1,
        "Fix: fusion must insert exactly one barrier between read and atomic arms"
    );
}

#[test]
fn divergent_invocation_gated_writer_upgrades_barrier_to_grid_sync() {
    let writer = Program::wrapped(
        vec![BufferDecl::read_write("state", 0, DataType::U32).with_count(1)],
        [128, 1, 1],
        vec![Node::if_then(
            crate::ir::Expr::eq(crate::ir::Expr::gid_x(), crate::ir::Expr::u32(0)),
            vec![Node::store(
                "state",
                crate::ir::Expr::u32(0),
                crate::ir::Expr::u32(7),
            )],
        )],
    );
    let reader = Program::wrapped(
        vec![BufferDecl::read("state", 0, DataType::U32).with_count(1)],
        [128, 1, 1],
        vec![Node::let_bind(
            "snap",
            crate::ir::Expr::load("state", crate::ir::Expr::u32(0)),
        )],
    );

    let fused = fuse_programs(&[writer, reader]).unwrap();
    let body = match fused.entry() {
        [Node::Region { body, .. }] => body.as_ref(),
        entry => panic!("Fix: fused entry must be wrapped in a root Region, got {entry:?}"),
    };
    let has_grid_sync = body.iter().any(|node| {
        matches!(
            node,
            Node::Barrier {
                ordering: crate::memory_model::MemoryOrdering::GridSync,
                ..
            }
        )
    });
    assert!(
        has_grid_sync,
        "Fix: invocation-gated cross-arm writes must use GridSync, not a workgroup-only barrier"
    );
}

#[test]
fn launch_indexed_writer_upgrades_raw_barrier_to_grid_sync() {
    let lane = crate::ir::Expr::var("lane");
    let block = crate::ir::Expr::var("block");
    let global = crate::ir::Expr::var("global");
    let writer = Program::wrapped(
        vec![BufferDecl::read_write("state", 0, DataType::U32).with_count(256)],
        [128, 1, 1],
        vec![
            Node::let_bind("lane", crate::ir::Expr::LocalId { axis: 0 }),
            Node::let_bind("block", crate::ir::Expr::WorkgroupId { axis: 0 }),
            Node::let_bind(
                "global",
                crate::ir::Expr::add(
                    crate::ir::Expr::mul(block.clone(), crate::ir::Expr::u32(128)),
                    lane.clone(),
                ),
            ),
            Node::store("state", global.clone(), global.clone()),
        ],
    );
    let reader = Program::wrapped(
        vec![BufferDecl::read("state", 0, DataType::U32).with_count(256)],
        [128, 1, 1],
        vec![
            Node::let_bind("lane", crate::ir::Expr::LocalId { axis: 0 }),
            Node::let_bind("block", crate::ir::Expr::WorkgroupId { axis: 0 }),
            Node::let_bind(
                "global",
                crate::ir::Expr::add(crate::ir::Expr::mul(block, crate::ir::Expr::u32(128)), lane),
            ),
            Node::let_bind("snap", crate::ir::Expr::load("state", global)),
        ],
    );

    let fused = fuse_programs(&[writer, reader]).unwrap();
    let body = match fused.entry() {
        [Node::Region { body, .. }] => body.as_ref(),
        entry => panic!("Fix: fused entry must be wrapped in a root Region, got {entry:?}"),
    };
    let has_grid_sync = body.iter().any(|node| {
        matches!(
            node,
            Node::Barrier {
                ordering: crate::memory_model::MemoryOrdering::GridSync,
                ..
            }
        )
    });

    assert!(
        has_grid_sync,
        "Fix: launch-indexed cross-arm writes must use GridSync so later arms cannot read another workgroup's stale output."
    );
}

#[test]
fn uniform_cross_arm_writer_uses_workgroup_barrier() {
    let writer = Program::wrapped(
        vec![BufferDecl::read_write("state", 0, DataType::U32).with_count(1)],
        [128, 1, 1],
        vec![Node::store(
            "state",
            crate::ir::Expr::u32(0),
            crate::ir::Expr::u32(7),
        )],
    );
    let reader = Program::wrapped(
        vec![BufferDecl::read("state", 0, DataType::U32).with_count(1)],
        [128, 1, 1],
        vec![Node::let_bind(
            "snap",
            crate::ir::Expr::load("state", crate::ir::Expr::u32(0)),
        )],
    );

    let fused = fuse_programs(&[writer, reader]).unwrap();
    let body = match fused.entry() {
        [Node::Region { body, .. }] => body.as_ref(),
        entry => panic!("Fix: fused entry must be wrapped in a root Region, got {entry:?}"),
    };
    let has_workgroup_barrier = body.iter().any(|node| {
        matches!(
            node,
            Node::Barrier {
                ordering: crate::memory_model::MemoryOrdering::SeqCst,
                ..
            }
        )
    });
    let has_grid_sync = body.iter().any(|node| {
        matches!(
            node,
            Node::Barrier {
                ordering: crate::memory_model::MemoryOrdering::GridSync,
                ..
            }
        )
    });

    assert!(
        has_workgroup_barrier,
        "Fix: uniform cross-arm writes must still get a workgroup memory barrier"
    );
    assert!(
        !has_grid_sync,
        "Fix: fusion must not force a global kernel split for uniform cross-arm writes"
    );
}

#[test]
fn self_composing_parser_rejected() {
    let parser = Program::wrapped(
        vec![BufferDecl::read("in", 0, DataType::U32)],
        [1, 1, 1],
        vec![Node::Return],
    )
    .with_entry_op_id("vyre-libs::parsing::test_parser")
    .with_non_composable_with_self(true);

    let result = fuse_programs(&[parser.clone(), parser]);
    assert!(
        matches!(result, Err(FusionError::SelfAliasing(_))),
        "Fix: fusing two copies of a non-composable parser must fail"
    );
}

#[test]
fn duplicate_buffer_dedup_upgrades_access() {
    let a = Program::wrapped(
        vec![BufferDecl::read("x", 0, DataType::U32)],
        [1, 1, 1],
        vec![Node::Return],
    );
    let b = Program::wrapped(
        vec![BufferDecl::read_write("x", 0, DataType::U32)],
        [1, 1, 1],
        vec![Node::Return],
    );

    let fused = fuse_programs(&[a, b]).unwrap();
    assert_eq!(fused.buffers().len(), 1);
    assert_eq!(fused.buffers()[0].access(), BufferAccess::ReadWrite);
}

#[test]
fn multi_arm_regions_flatten_into_one_executable_body() {
    let a = Program::wrapped(
        vec![BufferDecl::output("a_out", 0, DataType::U32).with_count(1)],
        [1, 1, 1],
        vec![Node::store(
            "a_out",
            crate::ir::Expr::u32(0),
            crate::ir::Expr::u32(1),
        )],
    );
    let b = Program::wrapped(
        vec![BufferDecl::output("b_out", 0, DataType::U32).with_count(1)],
        [1, 1, 1],
        vec![Node::store(
            "b_out",
            crate::ir::Expr::u32(0),
            crate::ir::Expr::u32(2),
        )],
    );

    let fused = fuse_programs(&[a, b]).unwrap();
    let body = match fused.entry() {
        [Node::Region { body, .. }] => body.as_ref(),
        entry => panic!("Fix: fused multi-arm programs must have one root Region, got {entry:?}"),
    };
    let stores = body.iter().map(count_stores).sum::<usize>();
    assert_eq!(
        stores, 2,
        "Fix: fusion must flatten top-level arm Regions into executable arm blocks"
    );
}

/// A value produced in one arm (`let __cmp_5 = load(flag,0)`) and consumed in
/// another (`store(out,0, Var(__cmp_5))`) must keep ONE name and ONE scope
/// after an intra-rule shared-namespace merge, so the merged program validates
/// clean. This is the `csrf_missing_token` "reference to undeclared variable"
/// miscompile distilled to its core: isolated fusion alpha-renames the two
/// arms apart, breaking the decl→use link; shared merge keeps it.
#[test]
fn shared_merge_keeps_cross_arm_value_linked_and_valid() {
    let producer = Program::wrapped(
        vec![BufferDecl::read_write("flag", 0, DataType::U32).with_count(1)],
        [1, 1, 1],
        vec![Node::let_bind(
            "__cmp_5",
            crate::ir::Expr::load("flag", crate::ir::Expr::u32(0)),
        )],
    );
    let consumer = Program::wrapped(
        vec![BufferDecl::output("out", 0, DataType::U32).with_count(1)],
        [1, 1, 1],
        vec![Node::store(
            "out",
            crate::ir::Expr::u32(0),
            crate::ir::Expr::var("__cmp_5"),
        )],
    );

    let merged = merge_programs_shared(&[producer.clone(), consumer.clone()])
        .expect("shared merge of producer+consumer composes");
    let errors = crate::validate::validate(&merged);
    let undeclared: Vec<_> = errors
        .iter()
        .filter(|e| e.message().contains("undeclared variable"))
        .collect();
    assert!(
        undeclared.is_empty(),
        "shared merge must keep `__cmp_5` declared-then-used in one scope; got {:?}",
        undeclared.iter().map(|e| e.message()).collect::<Vec<_>>()
    );

    // Contrast: isolated fusion alpha-renames the arms apart, so the consumer's
    // `Var(__cmp_5)` becomes `__vyre_fuse_a1_…` with no surviving decl, the
    // exact miscompile shared merge exists to avoid. This pins WHY the shared
    // path is required for intra-rule composition.
    let isolated = fuse_programs(&[producer, consumer]).expect("isolated fusion composes");
    let isolated_undeclared = crate::validate::validate(&isolated)
        .into_iter()
        .any(|e| e.message().contains("undeclared variable"));
    assert!(
        isolated_undeclared,
        "isolated fusion is expected to desync the cross-arm value (renames arms apart); \
         if this no longer holds, the shared-vs-isolated distinction has changed"
    );
}

fn count_stores(node: &Node) -> usize {
    match node {
        Node::Store { .. } => 1,
        Node::Block(nodes) => nodes.iter().map(count_stores).sum(),
        Node::Region { body, .. } => body.iter().map(count_stores).sum(),
        Node::If {
            then, otherwise, ..
        } => then.iter().chain(otherwise.iter()).map(count_stores).sum(),
        Node::Loop { body, .. } => body.iter().map(count_stores).sum(),
        _ => 0,
    }
}

#[test]
fn upgrade_write_only_read_only_to_read_write() {
    let mut buffer = BufferDecl::storage("tmp", 0, BufferAccess::WriteOnly, DataType::U32);

    upgrade_buffer_access(&mut buffer, &BufferAccess::ReadOnly);

    assert_eq!(buffer.access(), BufferAccess::ReadWrite);
    assert_eq!(buffer.kind(), crate::ir::MemoryKind::Global);
}

fn collect_targets(node: &Node) -> (FxHashSet<Ident>, FxHashSet<Ident>, FxHashSet<Ident>) {
    let mut loads = FxHashSet::default();
    let mut stores = FxHashSet::default();
    let mut atomics = FxHashSet::default();
    collect_buffer_targets(node, &mut loads, &mut stores, &mut atomics);
    (loads, stores, atomics)
}

/// An `AsyncStore` reads `source` and writes `destination` (vyre-reference
/// `eval_async_store` reads source then writes destination). The fusion
/// cross-arm RAW/WAR barrier pass keys off `collect_buffer_targets`, so
/// both must be recorded, otherwise a later arm reads a buffer an earlier
/// arm async-wrote with no barrier between them (a stale-read miscompile).
#[test]
fn collect_buffer_targets_records_async_store_source_read_and_destination_write() {
    let node = Node::AsyncStore {
        source: Ident::from("staged"),
        destination: Ident::from("out"),
        offset: Box::new(Expr::u32(0)),
        size: Box::new(Expr::u32(16)),
        tag: Ident::from("t0"),
    };
    let (loads, stores, _atomics) = collect_targets(&node);
    assert!(
        loads.contains(&Ident::from("staged")),
        "AsyncStore source must be recorded as a buffer read; got loads={loads:?}"
    );
    assert!(
        stores.contains(&Ident::from("out")),
        "AsyncStore destination must be recorded as a buffer write; got stores={stores:?}"
    );
}

/// Symmetric to the store case: an `AsyncLoad` reads `source` and writes
/// `destination`.
#[test]
fn collect_buffer_targets_records_async_load_source_read_and_destination_write() {
    let node = Node::AsyncLoad {
        source: Ident::from("global_in"),
        destination: Ident::from("shared_tile"),
        offset: Box::new(Expr::u32(0)),
        size: Box::new(Expr::u32(16)),
        tag: Ident::from("t1"),
    };
    let (loads, stores, _atomics) = collect_targets(&node);
    assert!(
        loads.contains(&Ident::from("global_in")),
        "AsyncLoad source must be recorded as a buffer read; got loads={loads:?}"
    );
    assert!(
        stores.contains(&Ident::from("shared_tile")),
        "AsyncLoad destination must be recorded as a buffer write; got stores={stores:?}"
    );
}

/// `IndirectDispatch` reads its `count_buffer` to derive launch geometry;
/// the hazard detector must see that read so a write of the count buffer in
/// an earlier arm forces a barrier before the dispatch consumes it.
#[test]
fn collect_buffer_targets_records_indirect_dispatch_count_buffer_read() {
    let node = Node::IndirectDispatch {
        count_buffer: Ident::from("counts"),
        count_offset: 0,
    };
    let (loads, _stores, _atomics) = collect_targets(&node);
    assert!(
        loads.contains(&Ident::from("counts")),
        "IndirectDispatch count_buffer must be recorded as a buffer read; got loads={loads:?}"
    );
}