xlog-prob 0.9.2

Probabilistic inference engines for XLOG
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
//! On-disk circuit artifact cache.
//!
//! Caches compiled circuit topology so d-DNNF compilation is skipped on warm starts.
//! Stores topology and metadata only -- weights change per query.

use std::fs;
use std::io::Write;
use std::path::{Path, PathBuf};

use xlog_core::{Result, XlogError};

use crate::xgcf::XgcfNodeType;

const MAGIC: u32 = 0x584C4743; // "XLGC"
const FORMAT_VERSION: u32 = 1;

/// Header size in bytes:
/// magic(4) + version(4) + cnf_hash(8) + config_hash(8) + random_vars_hash(8) +
/// sm(4) + num_nodes(4) + num_edges(4) + num_levels(4) + root(4) + max_var(4) +
/// has_free_var_mask(1) + padding(3) = 60
const HEADER_SIZE: usize = 60;

#[derive(Debug, Clone)]
pub(crate) struct CircuitCacheKey {
    pub cnf_hash: u64,
    pub config_hash: u64,
    pub random_vars_hash: u64,
    pub sm: u32,
}

#[derive(Debug)]
pub(crate) struct CircuitArtifact {
    pub num_nodes: u32,
    pub num_edges: u32,
    pub num_levels: u32,
    pub root: u32,
    pub max_var: u32,
    pub has_free_var_mask: bool,
    pub node_type: Vec<u8>,
    pub child_offsets: Vec<u32>,
    pub child_indices: Vec<u32>,
    pub lit: Vec<i32>,
    pub decision_var: Vec<u32>,
    pub decision_child_false: Vec<u32>,
    pub decision_child_true: Vec<u32>,
    pub level_nodes: Vec<u32>,
    pub level_offsets: Vec<u32>,
    pub free_var_mask: Vec<u8>,
}

/// Resolve the cache directory.
///
/// Priority: `XLOG_CIRCUIT_CACHE_DIR` env var > `XDG_CACHE_HOME`/xlog/circuits >
/// `HOME`/.cache/xlog/circuits.
pub(crate) fn cache_dir() -> PathBuf {
    if let Ok(dir) = std::env::var("XLOG_CIRCUIT_CACHE_DIR") {
        PathBuf::from(dir)
    } else if let Ok(xdg) = std::env::var("XDG_CACHE_HOME") {
        PathBuf::from(xdg).join("xlog").join("circuits")
    } else {
        PathBuf::from(std::env::var("HOME").unwrap_or_default())
            .join(".cache")
            .join("xlog")
            .join("circuits")
    }
}

fn artifact_filename(key: &CircuitCacheKey) -> String {
    format!(
        "{:016x}_{:016x}_{:016x}_{:08x}_{:08x}.bin",
        key.cnf_hash, key.config_hash, key.random_vars_hash, key.sm, FORMAT_VERSION,
    )
}

/// Write a circuit artifact to the on-disk cache.
///
/// Uses atomic rename (write to `.tmp`, then rename) so readers never see a partial file.
pub(crate) fn write_artifact(key: &CircuitCacheKey, artifact: &CircuitArtifact) -> Result<()> {
    write_artifact_to(&cache_dir(), key, artifact)
}

/// Read a circuit artifact from the on-disk cache.
///
/// Returns `Ok(None)` if the cache file does not exist or fails validation (stale entry).
/// Returns `Err` only on genuine IO errors after the file has been opened.
pub(crate) fn read_artifact(key: &CircuitCacheKey) -> Result<Option<CircuitArtifact>> {
    read_artifact_from(&cache_dir(), key)
}

// ---------------------------------------------------------------------------
// Internal implementations that accept an explicit directory (testable).
// ---------------------------------------------------------------------------

fn io_err(e: std::io::Error) -> XlogError {
    XlogError::Compilation(format!("circuit cache IO error: {}", e))
}

/// Read `count` little-endian u32 values from `data` starting at `offset`.
///
/// Unlike `bytemuck::cast_slice`, this does not require 4-byte alignment of the
/// source slice, which matters when the preceding u8 array (`node_type`) has a
/// length that is not a multiple of 4.
fn read_u32_vec(data: &[u8], offset: usize, count: usize) -> Vec<u32> {
    (0..count)
        .map(|i| {
            let s = offset + i * 4;
            u32::from_le_bytes([data[s], data[s + 1], data[s + 2], data[s + 3]])
        })
        .collect()
}

/// Read `count` little-endian i32 values from `data` starting at `offset`.
fn read_i32_vec(data: &[u8], offset: usize, count: usize) -> Vec<i32> {
    (0..count)
        .map(|i| {
            let s = offset + i * 4;
            i32::from_le_bytes([data[s], data[s + 1], data[s + 2], data[s + 3]])
        })
        .collect()
}

fn checked_bytes(elems: usize, bytes_per_elem: usize) -> Option<usize> {
    elems.checked_mul(bytes_per_elem)
}

fn checked_sum(parts: &[usize]) -> Option<usize> {
    parts
        .iter()
        .try_fold(0usize, |acc, part| acc.checked_add(*part))
}

fn valid_node_type(ty: u8) -> bool {
    ty <= XgcfNodeType::Decision as u8
}

fn artifact_topology_is_valid(artifact: &CircuitArtifact) -> bool {
    if artifact.num_nodes == 0 || artifact.num_levels == 0 || artifact.root >= artifact.num_nodes {
        return false;
    }

    let num_nodes = artifact.num_nodes as usize;
    let num_edges = artifact.num_edges as usize;
    let num_levels = artifact.num_levels as usize;
    let Ok(max_var) = usize::try_from(artifact.max_var) else {
        return false;
    };
    let Some(free_var_mask_len) = max_var.checked_add(1) else {
        return false;
    };

    if artifact.node_type.len() != num_nodes
        || artifact.child_offsets.len() != num_nodes + 1
        || artifact.child_indices.len() != num_edges
        || artifact.lit.len() != num_nodes
        || artifact.decision_var.len() != num_nodes
        || artifact.decision_child_false.len() != num_nodes
        || artifact.decision_child_true.len() != num_nodes
        || artifact.level_nodes.len() != num_nodes
        || artifact.level_offsets.len() != num_levels + 1
        || artifact.free_var_mask.len() != free_var_mask_len
    {
        return false;
    }

    if artifact.child_offsets.first().copied() != Some(0)
        || artifact.child_offsets.last().copied() != Some(artifact.num_edges)
    {
        return false;
    }
    let mut prev = 0u32;
    for &offset in &artifact.child_offsets {
        if offset < prev || offset > artifact.num_edges {
            return false;
        }
        prev = offset;
    }
    if artifact
        .child_indices
        .iter()
        .any(|&child| child >= artifact.num_nodes)
    {
        return false;
    }

    if artifact.level_offsets.first().copied() != Some(0)
        || artifact.level_offsets.last().copied() != Some(artifact.num_nodes)
    {
        return false;
    }
    let mut prev = 0u32;
    for &offset in &artifact.level_offsets {
        if offset < prev || offset > artifact.num_nodes {
            return false;
        }
        prev = offset;
    }
    if artifact
        .level_nodes
        .iter()
        .any(|&node| node >= artifact.num_nodes)
    {
        return false;
    }

    for idx in 0..num_nodes {
        let ty = artifact.node_type[idx];
        if !valid_node_type(ty) {
            return false;
        }
        match ty {
            t if t == XgcfNodeType::Lit as u8
                && artifact.lit[idx].unsigned_abs() > artifact.max_var =>
            {
                return false;
            }
            t if t == XgcfNodeType::Decision as u8 => {
                if artifact.decision_var[idx] > artifact.max_var {
                    return false;
                }
                if artifact.decision_child_false[idx] >= artifact.num_nodes
                    || artifact.decision_child_true[idx] >= artifact.num_nodes
                {
                    return false;
                }
            }
            _ => {}
        }
    }

    true
}

fn write_artifact_to(dir: &Path, key: &CircuitCacheKey, artifact: &CircuitArtifact) -> Result<()> {
    fs::create_dir_all(dir).map_err(io_err)?;

    let path = dir.join(artifact_filename(key));
    let tmp = path.with_extension("tmp");
    let mut f = fs::File::create(&tmp).map_err(io_err)?;

    // Write header
    f.write_all(&MAGIC.to_le_bytes()).map_err(io_err)?;
    f.write_all(&FORMAT_VERSION.to_le_bytes()).map_err(io_err)?;
    f.write_all(&key.cnf_hash.to_le_bytes()).map_err(io_err)?;
    f.write_all(&key.config_hash.to_le_bytes())
        .map_err(io_err)?;
    f.write_all(&key.random_vars_hash.to_le_bytes())
        .map_err(io_err)?;
    f.write_all(&key.sm.to_le_bytes()).map_err(io_err)?;
    f.write_all(&artifact.num_nodes.to_le_bytes())
        .map_err(io_err)?;
    f.write_all(&artifact.num_edges.to_le_bytes())
        .map_err(io_err)?;
    f.write_all(&artifact.num_levels.to_le_bytes())
        .map_err(io_err)?;
    f.write_all(&artifact.root.to_le_bytes()).map_err(io_err)?;
    f.write_all(&artifact.max_var.to_le_bytes())
        .map_err(io_err)?;
    f.write_all(&[artifact.has_free_var_mask as u8])
        .map_err(io_err)?;
    f.write_all(&[0u8; 3]).map_err(io_err)?; // padding

    // Write arrays as raw bytes
    f.write_all(&artifact.node_type).map_err(io_err)?;
    f.write_all(bytemuck::cast_slice(&artifact.child_offsets))
        .map_err(io_err)?;
    f.write_all(bytemuck::cast_slice(&artifact.child_indices))
        .map_err(io_err)?;
    f.write_all(bytemuck::cast_slice(&artifact.lit))
        .map_err(io_err)?;
    f.write_all(bytemuck::cast_slice(&artifact.decision_var))
        .map_err(io_err)?;
    f.write_all(bytemuck::cast_slice(&artifact.decision_child_false))
        .map_err(io_err)?;
    f.write_all(bytemuck::cast_slice(&artifact.decision_child_true))
        .map_err(io_err)?;
    f.write_all(bytemuck::cast_slice(&artifact.level_nodes))
        .map_err(io_err)?;
    f.write_all(bytemuck::cast_slice(&artifact.level_offsets))
        .map_err(io_err)?;
    f.write_all(&artifact.free_var_mask).map_err(io_err)?;

    drop(f);
    fs::rename(&tmp, &path).map_err(io_err)?;

    evict_if_needed_in(dir)?;
    Ok(())
}

fn read_artifact_from(dir: &Path, key: &CircuitCacheKey) -> Result<Option<CircuitArtifact>> {
    let path = dir.join(artifact_filename(key));

    let data = match fs::read(&path) {
        Ok(d) => d,
        Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok(None),
        Err(e) => {
            return Err(XlogError::Compilation(format!(
                "Failed to read cache file: {}",
                e
            )))
        }
    };

    parse_artifact(&data, key)
}

/// Parse a circuit artifact from raw file bytes, validating header and key.
fn parse_artifact(data: &[u8], key: &CircuitCacheKey) -> Result<Option<CircuitArtifact>> {
    // 1. Check minimum header size
    if data.len() < HEADER_SIZE {
        return Ok(None);
    }

    let mut cursor = 0usize;

    macro_rules! read_u32 {
        () => {{
            let val = u32::from_le_bytes([
                data[cursor],
                data[cursor + 1],
                data[cursor + 2],
                data[cursor + 3],
            ]);
            cursor += 4;
            val
        }};
    }

    macro_rules! read_u64 {
        () => {{
            let val = u64::from_le_bytes([
                data[cursor],
                data[cursor + 1],
                data[cursor + 2],
                data[cursor + 3],
                data[cursor + 4],
                data[cursor + 5],
                data[cursor + 6],
                data[cursor + 7],
            ]);
            cursor += 8;
            val
        }};
    }

    // 2. Validate magic
    let magic = read_u32!();
    if magic != MAGIC {
        return Ok(None);
    }

    // 3. Validate format version
    let version = read_u32!();
    if version != FORMAT_VERSION {
        return Ok(None);
    }

    // 4. Validate key fields
    let cnf_hash = read_u64!();
    let config_hash = read_u64!();
    let random_vars_hash = read_u64!();
    let sm = read_u32!();

    if cnf_hash != key.cnf_hash
        || config_hash != key.config_hash
        || random_vars_hash != key.random_vars_hash
        || sm != key.sm
    {
        return Ok(None);
    }

    // 5. Parse metadata from header
    let num_nodes = read_u32!();
    let num_edges = read_u32!();
    let num_levels = read_u32!();
    let root = read_u32!();
    let max_var = read_u32!();
    let has_free_var_mask = data[cursor] != 0;
    cursor += 1;
    cursor += 3; // skip padding

    debug_assert_eq!(cursor, HEADER_SIZE);

    if num_nodes == 0 || num_levels == 0 || root >= num_nodes {
        return Ok(None);
    }

    // 6. Calculate expected array sizes with checked arithmetic. The disk cache is
    // untrusted process state; malformed metadata must be treated as a stale entry.
    let Ok(num_nodes_usize) = usize::try_from(num_nodes) else {
        return Ok(None);
    };
    let Ok(num_edges_usize) = usize::try_from(num_edges) else {
        return Ok(None);
    };
    let Ok(num_levels_usize) = usize::try_from(num_levels) else {
        return Ok(None);
    };
    let Ok(max_var_usize) = usize::try_from(max_var) else {
        return Ok(None);
    };

    let Some(child_offsets_elems) = num_nodes_usize.checked_add(1) else {
        return Ok(None);
    };
    let Some(level_offsets_elems) = num_levels_usize.checked_add(1) else {
        return Ok(None);
    };
    let Some(free_var_mask_bytes) = max_var_usize.checked_add(1) else {
        return Ok(None);
    };

    let node_type_bytes = num_nodes_usize;
    let Some(child_offsets_bytes) = checked_bytes(child_offsets_elems, 4) else {
        return Ok(None);
    };
    let Some(child_indices_bytes) = checked_bytes(num_edges_usize, 4) else {
        return Ok(None);
    };
    let Some(lit_bytes) = checked_bytes(num_nodes_usize, 4) else {
        return Ok(None);
    };
    let Some(decision_var_bytes) = checked_bytes(num_nodes_usize, 4) else {
        return Ok(None);
    };
    let Some(decision_child_false_bytes) = checked_bytes(num_nodes_usize, 4) else {
        return Ok(None);
    };
    let Some(decision_child_true_bytes) = checked_bytes(num_nodes_usize, 4) else {
        return Ok(None);
    };
    let Some(level_nodes_bytes) = checked_bytes(num_nodes_usize, 4) else {
        return Ok(None);
    };
    let Some(level_offsets_bytes) = checked_bytes(level_offsets_elems, 4) else {
        return Ok(None);
    };

    let Some(expected_total) = checked_sum(&[
        HEADER_SIZE,
        node_type_bytes,
        child_offsets_bytes,
        child_indices_bytes,
        lit_bytes,
        decision_var_bytes,
        decision_child_false_bytes,
        decision_child_true_bytes,
        level_nodes_bytes,
        level_offsets_bytes,
        free_var_mask_bytes,
    ]) else {
        return Ok(None);
    };

    if data.len() < expected_total {
        return Ok(None);
    }

    // 7. Parse arrays from raw bytes.
    //
    // We use from_le_bytes helpers instead of bytemuck::cast_slice because
    // the cursor may not be 4-byte aligned after reading the u8 node_type
    // array (e.g. when num_nodes is not a multiple of 4).
    let node_type = data[cursor..cursor + node_type_bytes].to_vec();
    cursor += node_type_bytes;

    let child_offsets = read_u32_vec(data, cursor, child_offsets_elems);
    cursor += child_offsets_bytes;

    let child_indices = read_u32_vec(data, cursor, num_edges_usize);
    cursor += child_indices_bytes;

    let lit = read_i32_vec(data, cursor, num_nodes_usize);
    cursor += lit_bytes;

    let decision_var = read_u32_vec(data, cursor, num_nodes_usize);
    cursor += decision_var_bytes;

    let decision_child_false = read_u32_vec(data, cursor, num_nodes_usize);
    cursor += decision_child_false_bytes;

    let decision_child_true = read_u32_vec(data, cursor, num_nodes_usize);
    cursor += decision_child_true_bytes;

    let level_nodes = read_u32_vec(data, cursor, num_nodes_usize);
    cursor += level_nodes_bytes;

    let level_offsets = read_u32_vec(data, cursor, level_offsets_elems);
    cursor += level_offsets_bytes;

    let free_var_mask = data[cursor..cursor + free_var_mask_bytes].to_vec();
    // cursor += free_var_mask_bytes; // not needed after last read

    let artifact = CircuitArtifact {
        num_nodes,
        num_edges,
        num_levels,
        root,
        max_var,
        has_free_var_mask,
        node_type,
        child_offsets,
        child_indices,
        lit,
        decision_var,
        decision_child_false,
        decision_child_true,
        level_nodes,
        level_offsets,
        free_var_mask,
    };

    if !artifact_topology_is_valid(&artifact) {
        return Ok(None);
    }

    Ok(Some(artifact))
}

/// Evict oldest cache entries when total cache size exceeds the limit.
///
/// Default limit is 512 MB, configurable via `XLOG_CIRCUIT_CACHE_MAX_MB`.
fn evict_if_needed_in(dir: &Path) -> Result<()> {
    let max_mb: u64 = std::env::var("XLOG_CIRCUIT_CACHE_MAX_MB")
        .ok()
        .and_then(|v| v.parse().ok())
        .unwrap_or(512);
    evict_if_needed_in_with_limit(dir, max_mb)
}

fn evict_if_needed_in_with_limit(dir: &Path, max_mb: u64) -> Result<()> {
    let max_bytes = max_mb * 1024 * 1024;

    let entries = match fs::read_dir(dir) {
        Ok(e) => e,
        Err(_) => return Ok(()), // directory gone or unreadable, nothing to evict
    };

    // Collect .bin files with their size and mtime.
    let mut files: Vec<(PathBuf, u64, std::time::SystemTime)> = Vec::new();
    let mut total_size: u64 = 0;

    for entry in entries {
        let entry = match entry {
            Ok(e) => e,
            Err(_) => continue,
        };
        let path = entry.path();
        if path.extension().and_then(|e| e.to_str()) != Some("bin") {
            continue;
        }
        let meta = match entry.metadata() {
            Ok(m) => m,
            Err(_) => continue,
        };
        if !meta.is_file() {
            continue;
        }
        let size = meta.len();
        let mtime = meta.modified().unwrap_or(std::time::UNIX_EPOCH);
        total_size += size;
        files.push((path, size, mtime));
    }

    if total_size <= max_bytes {
        return Ok(());
    }

    // Sort by mtime ascending (oldest first)
    files.sort_by_key(|&(_, _, mtime)| mtime);

    for (path, size, _) in &files {
        if total_size <= max_bytes {
            break;
        }
        // Best-effort: ignore errors when removing individual files during eviction.
        if fs::remove_file(path).is_ok() {
            total_size = total_size.saturating_sub(*size);
        }
    }

    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::sync::atomic::{AtomicU64, Ordering};

    // Use a unique directory per test to avoid interference between parallel tests.
    static TEST_COUNTER: AtomicU64 = AtomicU64::new(0);

    fn test_cache_dir() -> PathBuf {
        let id = TEST_COUNTER.fetch_add(1, Ordering::SeqCst);
        let pid = std::process::id();
        let dir = std::env::temp_dir()
            .join("xlog_disk_cache_test")
            .join(format!("{}_{}", pid, id));
        fs::create_dir_all(&dir).expect("create test cache dir");
        dir
    }

    fn make_key(cnf_hash: u64) -> CircuitCacheKey {
        CircuitCacheKey {
            cnf_hash,
            config_hash: 0xDEADBEEF,
            random_vars_hash: 0xCAFEBABE,
            sm: 89,
        }
    }

    fn make_artifact() -> CircuitArtifact {
        // A small circuit: 4 nodes, 3 edges, 2 levels, max_var=2
        CircuitArtifact {
            num_nodes: 4,
            num_edges: 3,
            num_levels: 2,
            root: 0,
            max_var: 2,
            has_free_var_mask: true,
            node_type: vec![1, 2, 3, 4],
            child_offsets: vec![0, 1, 2, 3, 3], // num_nodes + 1 = 5
            child_indices: vec![1, 2, 3],       // num_edges = 3
            lit: vec![0, 1, -1, 2],             // num_nodes = 4
            decision_var: vec![0, 1, 2, 0],
            decision_child_false: vec![0, 2, 3, 0],
            decision_child_true: vec![0, 1, 3, 0],
            level_nodes: vec![0, 1, 2, 3], // num_nodes = 4
            level_offsets: vec![0, 1, 4],  // num_levels + 1 = 3
            free_var_mask: vec![0, 1, 0],  // max_var + 1 = 3
        }
    }

    #[test]
    fn test_roundtrip() {
        let dir = test_cache_dir();

        let key = make_key(0x1234);
        let artifact = make_artifact();

        write_artifact_to(&dir, &key, &artifact).expect("write should succeed");

        let loaded = read_artifact_from(&dir, &key)
            .expect("read should not error")
            .expect("read should return Some");

        assert_eq!(loaded.num_nodes, artifact.num_nodes);
        assert_eq!(loaded.num_edges, artifact.num_edges);
        assert_eq!(loaded.num_levels, artifact.num_levels);
        assert_eq!(loaded.root, artifact.root);
        assert_eq!(loaded.max_var, artifact.max_var);
        assert_eq!(loaded.has_free_var_mask, artifact.has_free_var_mask);
        assert_eq!(loaded.node_type, artifact.node_type);
        assert_eq!(loaded.child_offsets, artifact.child_offsets);
        assert_eq!(loaded.child_indices, artifact.child_indices);
        assert_eq!(loaded.lit, artifact.lit);
        assert_eq!(loaded.decision_var, artifact.decision_var);
        assert_eq!(loaded.decision_child_false, artifact.decision_child_false);
        assert_eq!(loaded.decision_child_true, artifact.decision_child_true);
        assert_eq!(loaded.level_nodes, artifact.level_nodes);
        assert_eq!(loaded.level_offsets, artifact.level_offsets);
        assert_eq!(loaded.free_var_mask, artifact.free_var_mask);

        let _ = fs::remove_dir_all(&dir);
    }

    /// Regression test: num_nodes=5 is not a multiple of 4, so the u32
    /// arrays after node_type start at a non-4-byte-aligned offset.
    /// The old bytemuck::cast_slice read path would panic here.
    #[test]
    fn test_roundtrip_unaligned_num_nodes() {
        let dir = test_cache_dir();

        let key = make_key(0x5555);
        // 5 nodes, 4 edges, 3 levels, max_var=3
        let artifact = CircuitArtifact {
            num_nodes: 5,
            num_edges: 4,
            num_levels: 3,
            root: 0,
            max_var: 3,
            has_free_var_mask: false,
            node_type: vec![1, 2, 3, 4, 5],
            child_offsets: vec![0, 1, 2, 3, 4, 4], // num_nodes + 1 = 6
            child_indices: vec![1, 2, 3, 4],       // num_edges = 4
            lit: vec![0, 1, -1, 2, -2],            // num_nodes = 5
            decision_var: vec![0, 1, 2, 3, 0],
            decision_child_false: vec![0, 2, 3, 4, 0],
            decision_child_true: vec![0, 1, 3, 4, 0],
            level_nodes: vec![0, 1, 2, 3, 4], // num_nodes = 5
            level_offsets: vec![0, 1, 3, 5],  // num_levels + 1 = 4
            free_var_mask: vec![0, 1, 0, 1],  // max_var + 1 = 4
        };

        write_artifact_to(&dir, &key, &artifact).expect("write should succeed");

        let loaded = read_artifact_from(&dir, &key)
            .expect("read should not error")
            .expect("read should return Some");

        assert_eq!(loaded.num_nodes, artifact.num_nodes);
        assert_eq!(loaded.num_edges, artifact.num_edges);
        assert_eq!(loaded.num_levels, artifact.num_levels);
        assert_eq!(loaded.root, artifact.root);
        assert_eq!(loaded.max_var, artifact.max_var);
        assert_eq!(loaded.has_free_var_mask, artifact.has_free_var_mask);
        assert_eq!(loaded.node_type, artifact.node_type);
        assert_eq!(loaded.child_offsets, artifact.child_offsets);
        assert_eq!(loaded.child_indices, artifact.child_indices);
        assert_eq!(loaded.lit, artifact.lit);
        assert_eq!(loaded.decision_var, artifact.decision_var);
        assert_eq!(loaded.decision_child_false, artifact.decision_child_false);
        assert_eq!(loaded.decision_child_true, artifact.decision_child_true);
        assert_eq!(loaded.level_nodes, artifact.level_nodes);
        assert_eq!(loaded.level_offsets, artifact.level_offsets);
        assert_eq!(loaded.free_var_mask, artifact.free_var_mask);

        let _ = fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_mismatched_key_returns_none() {
        let dir = test_cache_dir();

        let key = make_key(0xAAAA);
        let artifact = make_artifact();

        write_artifact_to(&dir, &key, &artifact).expect("write should succeed");

        // Different cnf_hash => different file path, so returns None (file not found)
        let different_key = make_key(0xBBBB);
        let result = read_artifact_from(&dir, &different_key).expect("read should not error");
        assert!(result.is_none(), "mismatched key should return None");

        let _ = fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_missing_file_returns_none() {
        let dir = test_cache_dir();

        let key = make_key(0x9999);
        let result = read_artifact_from(&dir, &key).expect("read should not error");
        assert!(result.is_none(), "missing file should return None");

        let _ = fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_truncated_file_returns_none() {
        let dir = test_cache_dir();

        let key = make_key(0x7777);
        let artifact = make_artifact();
        write_artifact_to(&dir, &key, &artifact).expect("write should succeed");

        // Truncate the file to half its header
        let path = dir.join(artifact_filename(&key));
        let data = fs::read(&path).unwrap();
        fs::write(&path, &data[..HEADER_SIZE / 2]).unwrap();

        let result = read_artifact_from(&dir, &key).expect("read should not error");
        assert!(result.is_none(), "truncated file should return None");

        let _ = fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_corrupted_magic_returns_none() {
        let dir = test_cache_dir();

        let key = make_key(0x6666);
        let artifact = make_artifact();
        write_artifact_to(&dir, &key, &artifact).expect("write should succeed");

        // Corrupt the magic bytes
        let path = dir.join(artifact_filename(&key));
        let mut data = fs::read(&path).unwrap();
        data[0] = 0xFF;
        data[1] = 0xFF;
        fs::write(&path, &data).unwrap();

        let result = read_artifact_from(&dir, &key).expect("read should not error");
        assert!(result.is_none(), "corrupted magic should return None");

        let _ = fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_eviction() {
        let dir = test_cache_dir();

        let key1 = make_key(0x1111);
        let key2 = make_key(0x2222);
        let artifact = make_artifact();

        // Write two artifacts without eviction (using the internal write_artifact_to
        // which calls evict_if_needed_in with the default 512MB limit).
        write_artifact_to(&dir, &key1, &artifact).expect("write 1 should succeed");
        write_artifact_to(&dir, &key2, &artifact).expect("write 2 should succeed");

        // Both should be readable
        assert!(read_artifact_from(&dir, &key1).unwrap().is_some());
        assert!(read_artifact_from(&dir, &key2).unwrap().is_some());

        // Now force eviction with 0 MB limit
        evict_if_needed_in_with_limit(&dir, 0).expect("eviction should succeed");

        // All files should have been evicted
        let r1 = read_artifact_from(&dir, &key1).unwrap();
        let r2 = read_artifact_from(&dir, &key2).unwrap();
        assert!(r1.is_none(), "key1 should have been evicted");
        assert!(r2.is_none(), "key2 should have been evicted");

        let _ = fs::remove_dir_all(&dir);
    }
}