nixl-sys 1.0.1

Low-level bindings to the nixl library
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

// SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: Apache-2.0

use nixl_sys::{BackendSyncable, SyncManager};
use std::cell::Cell;
use std::rc::Rc;

#[derive(Debug, PartialEq, Eq)]
enum TestError {
    SyncFailed,
}

#[derive(Debug, Clone)]
struct DummyBackend {
    sync_calls: Rc<Cell<u32>>,
}

#[derive(Debug, Clone)]
struct DummyData {
    value: Cell<i32>,
    data_calls: Rc<Cell<u32>>,
    should_fail: Cell<bool>,
}

impl DummyBackend {
    fn default() -> Self {
        Self {
            sync_calls: Rc::new(Cell::new(0)),
        }
    }
}

impl DummyData {
    fn default() -> Self {
        Self {
            value: Cell::new(0),
            data_calls: Rc::new(Cell::new(0)),
            should_fail: Cell::new(false),
        }
    }
}

impl BackendSyncable for DummyData {
    type Backend = DummyBackend;
    type Error = TestError;

    fn sync_to_backend(&self, backend: &Self::Backend) -> Result<(), Self::Error> {
        if self.should_fail.get() {
            return Err(TestError::SyncFailed);
        }
        self.data_calls.set(self.data_calls.get() + 1);
        backend
            .sync_calls
            .set(backend.sync_calls.get() + 1);
        Ok(())
    }
}

#[test]
fn sync_manager_first_access_triggers_single_sync() {
    let data = DummyData::default();
    let backend = DummyBackend::default();
    let data_calls = data.data_calls.clone();
    let backend_calls = backend.sync_calls.clone();
    let mgr = SyncManager::new(data, backend);

    // First access -> sync happens
    let _ = mgr.backend().unwrap().sync_calls.get();
    assert_eq!(data_calls.get(), 1);
    assert_eq!(backend_calls.get(), 1);

    // Second access without modification -> no sync
    let _ = mgr.backend().unwrap().sync_calls.get();
    assert_eq!(data_calls.get(), 1);
    assert_eq!(backend_calls.get(), 1);
}

#[test]
fn sync_manager_resyncs_after_modify() {
    let data = DummyData::default();
    let backend = DummyBackend::default();
    let data_calls = data.data_calls.clone();
    let backend_calls = backend.sync_calls.clone();
    let mut mgr = SyncManager::new(data, backend);

    // Ensure initial sync
    let _ = mgr.backend().unwrap();
    assert_eq!(data_calls.get(), 1);

    // Modify -> marks dirty
    mgr.data_mut().value.set(42);

    // Next access -> resync
    let _ = mgr.backend().unwrap();
    assert_eq!(data_calls.get(), 2);
    assert_eq!(backend_calls.get(), 2);
}

#[test]
fn sync_manager_backend_accessor_triggers_sync() {
    let data = DummyData::default();
    let backend = DummyBackend::default();
    let data_calls = data.data_calls.clone();
    let backend_calls = backend.sync_calls.clone();
    let mgr = SyncManager::new(data, backend);

    // Read-only data access should not sync
    let _ = mgr.data();
    assert_eq!(data_calls.get(), 0);
    assert_eq!(backend_calls.get(), 0);

    // Backend accessor should sync
    let _ = mgr.backend().unwrap();
    assert_eq!(data_calls.get(), 1);
    assert_eq!(backend_calls.get(), 1);
}

#[test]
fn sync_manager_error_is_propagated_and_retry_succeeds() {
    let data = DummyData::default();
    let backend = DummyBackend::default();
    let data_calls = data.data_calls.clone();
    let backend_calls = backend.sync_calls.clone();
    let mut mgr = SyncManager::new(data, backend);

    // Configure to fail on first sync
    mgr.data_mut().should_fail.set(true);

    // Attempting to access backend should error
    let err = mgr.backend().unwrap_err();
    assert_eq!(err, TestError::SyncFailed);
    // No successful sync occurred
    assert_eq!(data_calls.get(), 0);
    assert_eq!(backend_calls.get(), 0);

    // Clear failure and try again
    mgr.data_mut().should_fail.set(false);
    let _ = mgr.backend().unwrap();
    assert_eq!(data_calls.get(), 1);
    assert_eq!(backend_calls.get(), 1);
}