win-durable-ioring 0.3.2

A ring for Windows file I/O with durability scheduled into its work: writes are tagged with epochs, and durability through an epoch is requested and reported in the ring's own completion stream. The Windows driver for durable-ioring, built on windows-ioring-sys. No unsafe code.
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

// Copyright (c) 2026 Mike Grier
//! Markings and a failure's final record (DI-3.2.4.2) through a real instance, every entry checked
//! by the conformance oracle. A nullifier cannot be made here on demand -- its write would have to
//! be in flight when the failure is observed, which a test cannot hold it to -- so the core's
//! tests cover it.

use durable_ioring::DurableRing;
use durable_ioring::FailureId;
use durable_ioring::{
    DurabilityRequest, Entry, Failed, FailureCause, ImportScope, Marking, MarkingKind, Resolution,
};

use super::pushes::{GIVEN, Harness, given, instance, temp};

/// `ERROR_IO_DEVICE`, the failure the seam is armed with.
const IO_DEVICE: u32 = 1117;

type V = super::V;

fn next_failed(harness: &mut Harness) -> Failed<V> {
    match harness.next_entry() {
        Entry::Failed(failed) => failed,
        other => panic!("expected Failed, got {other:?}"),
    }
}

fn next_marked(harness: &mut Harness) -> (FailureId, Marking<V>) {
    match harness.next_entry() {
        Entry::Marked { failure, marking } => (failure, marking),
        other => panic!("expected Marked, got {other:?}"),
    }
}

#[test]
fn a_suspect_write_flushed_after_an_import_is_marked_covered_and_abandoning_carries_it() {
    let file = temp(&[0; 64]);
    let mut harness = Harness::new(instance(vec![given(GIVEN, &file)], Vec::new()));
    let write = harness.write(GIVEN, 0, b"covered", 2, 1);
    harness.next();
    harness
        .ring
        .import_failure(ImportScope::All)
        .expect("import");
    let failed = next_failed(&mut harness);
    assert_eq!(failed.suspect.writes()[0].op, write);

    assert_eq!(harness.seal(2), DurabilityRequest::Submitted);
    let (failure, marking) = next_marked(&mut harness);
    assert_eq!((failure, marking.write), (failed.id, write));
    assert_eq!(
        marking.kind,
        MarkingKind::Covered {
            flushed: true,
            provider: false
        }
    );
    assert!(
        matches!(harness.next_entry(), Entry::Blocked { by, .. } if by == failed.id),
        "covered, and still held: a marking changes nothing the mark depends on"
    );
    assert_eq!(
        harness.ring.failures()[0].markings,
        std::slice::from_ref(&marking)
    );

    harness
        .ring
        .resolve(vec![(failed.token, Resolution::Abandon)])
        .expect("abandon");
    match harness.next_entry() {
        Entry::Abandoned { markings, .. } => assert_eq!(markings, [marking]),
        other => panic!("expected Abandoned, got {other:?}"),
    }
    assert!(matches!(harness.next_entry(), Entry::Durable { .. }));
    harness.finish();
}

#[test]
fn a_heal_reports_its_record_with_the_markings_its_failure_gained() {
    let file = temp(&[0; 64]);
    let mut harness = Harness::new(instance(vec![given(GIVEN, &file)], Vec::new()));
    let sealed = harness.write(GIVEN, 0, b"first", 1, 1);
    let later = harness.write(GIVEN, 8, b"second", 2, 2);
    harness.next_n(2);
    harness.ring.fail_next_flush(GIVEN, IO_DEVICE);
    assert_eq!(harness.seal(1), DurabilityRequest::Submitted);
    let failed = next_failed(&mut harness);
    let suspects: Vec<_> = failed.suspect.writes().iter().map(|w| w.op).collect();
    assert_eq!(suspects, [sealed, later]);

    harness
        .ring
        .resolve(vec![(failed.token, Resolution::Heal)])
        .expect("heal");
    harness.oracle.healed(failed.id);
    assert_eq!(harness.seal(2), DurabilityRequest::Submitted);
    let (_, covered) = next_marked(&mut harness);
    assert_eq!(
        (covered.write, covered.kind.clone()),
        (
            later,
            MarkingKind::Covered {
                flushed: true,
                provider: false
            }
        ),
        "a healing failure goes on gaining markings"
    );
    match harness.next_entry() {
        Entry::Healed {
            failure, markings, ..
        } => {
            assert_eq!(failure, failed.id);
            assert_eq!(markings, [covered]);
        }
        other => panic!("expected Healed, got {other:?}"),
    }
    for id in [1, 2] {
        match harness.next_entry() {
            Entry::Durable { through } => assert_eq!(through, harness.epoch(id)),
            other => panic!("expected Durable through {id}, got {other:?}"),
        }
    }
    harness.finish();
}

#[test]
fn a_failed_flushs_code_reads_without_the_ring_crate() {
    let file = temp(&[0; 64]);
    let mut harness = Harness::new(instance(vec![given(GIVEN, &file)], Vec::new()));
    harness.write(GIVEN, 0, b"x", 1, 1);
    harness.next();
    harness.ring.fail_next_flush(GIVEN, IO_DEVICE);
    assert_eq!(harness.seal(1), DurabilityRequest::Submitted);
    match next_failed(&mut harness).cause {
        FailureCause::Commit { fault, .. } => {
            let code = fault
                .code
                .expect("a commit the ring answered carries a code");
            assert_eq!(crate::win32_code_of(code), Some(IO_DEVICE));
            assert_eq!(
                crate::error_code_of(&fault.error),
                Some(code),
                "read again from the report"
            );
        }
        other => panic!("expected a flush failure, got {other:?}"),
    }
    harness.finish();
}