safer-ring 0.0.1

A safe Rust wrapper around io_uring with zero-cost abstractions and compile-time memory safety guarantees
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
//! Tests for registry functionality.

use super::*;
use std::pin::Pin;

/// Test basic registry creation and properties
mod basic_functionality {
    use super::*;

    #[test]
    fn new_registry_is_empty() {
        let registry = Registry::new();
        assert_eq!(registry.fd_count(), 0);
        assert_eq!(registry.buffer_count(), 0);
        assert_eq!(registry.fds_in_use_count(), 0);
        assert_eq!(registry.buffers_in_use_count(), 0);
    }

    #[test]
    fn default_registry_is_empty() {
        let registry = Registry::default();
        assert_eq!(registry.fd_count(), 0);
        assert_eq!(registry.buffer_count(), 0);
    }
}

/// Test file descriptor registration
mod fd_registration {
    use super::*;

    #[test]
    fn register_valid_fd() {
        let mut registry = Registry::new();
        let result = registry.register_fd(0);
        assert!(result.is_ok());

        let registered_fd = result.unwrap();
        assert_eq!(registered_fd.index(), 0);
        assert_eq!(registered_fd.raw_fd(), 0);
        assert_eq!(registry.fd_count(), 1);
    }

    #[test]
    fn register_multiple_fds() {
        let mut registry = Registry::new();

        let fd1 = registry.register_fd(0).unwrap();
        let fd2 = registry.register_fd(1).unwrap();
        let fd3 = registry.register_fd(2).unwrap();

        assert_eq!(fd1.index(), 0);
        assert_eq!(fd2.index(), 1);
        assert_eq!(fd3.index(), 2);
        assert_eq!(registry.fd_count(), 3);
    }

    #[test]
    fn register_negative_fd_fails() {
        let mut registry = Registry::new();
        let result = registry.register_fd(-1);
        assert!(result.is_err());

        match result.unwrap_err() {
            SaferRingError::Io(e) => {
                assert_eq!(e.kind(), std::io::ErrorKind::InvalidInput);
            }
            _ => panic!("Expected Io error"),
        }
    }

    #[test]
    fn is_fd_registered_works() {
        let mut registry = Registry::new();
        let registered_fd = registry.register_fd(5).unwrap();

        assert!(registry.is_fd_registered(&registered_fd));
        assert_eq!(registry.fd_count(), 1);
    }

    #[test]
    fn get_raw_fd_works() {
        let mut registry = Registry::new();
        let registered_fd = registry.register_fd(42).unwrap();

        let raw_fd = registry.get_raw_fd(&registered_fd).unwrap();
        assert_eq!(raw_fd, 42);
    }
}

/// Test buffer registration
mod buffer_registration {
    use super::*;

    #[test]
    fn register_valid_buffer() {
        let mut registry = Registry::new();
        let buffer = Pin::new(Box::new([0u8; 1024]));
        let size = buffer.len();

        let result = registry.register_buffer(buffer);
        assert!(result.is_ok());

        let registered_buffer = result.unwrap();
        assert_eq!(registered_buffer.index(), 0);
        assert_eq!(registered_buffer.size(), size);
        assert_eq!(registry.buffer_count(), 1);
    }

    #[test]
    fn register_multiple_buffers() {
        let mut registry = Registry::new();

        let buffer1 = Pin::new(Box::new([0u8; 512]));
        let buffer2 = Pin::new(Box::new([0u8; 1024]));
        let buffer3 = Pin::new(Box::new([0u8; 2048]));

        let reg1 = registry.register_buffer(buffer1).unwrap();
        let reg2 = registry.register_buffer(buffer2).unwrap();
        let reg3 = registry.register_buffer(buffer3).unwrap();

        assert_eq!(reg1.index(), 0);
        assert_eq!(reg1.size(), 512);
        assert_eq!(reg2.index(), 1);
        assert_eq!(reg2.size(), 1024);
        assert_eq!(reg3.index(), 2);
        assert_eq!(reg3.size(), 2048);
        assert_eq!(registry.buffer_count(), 3);
    }

    #[test]
    fn register_empty_buffer_fails() {
        let mut registry = Registry::new();
        let buffer = Pin::new(Box::new([]));

        let result = registry.register_buffer(buffer);
        assert!(result.is_err());

        match result.unwrap_err() {
            SaferRingError::Io(e) => {
                assert_eq!(e.kind(), std::io::ErrorKind::InvalidInput);
            }
            _ => panic!("Expected Io error"),
        }
    }

    #[test]
    fn is_buffer_registered_works() {
        let mut registry = Registry::new();
        let buffer = Pin::new(Box::new([0u8; 1024]));
        let registered_buffer = registry.register_buffer(buffer).unwrap();

        assert!(registry.is_buffer_registered(&registered_buffer));
        assert_eq!(registry.buffer_count(), 1);
    }

    #[test]
    fn get_buffer_works() {
        let mut registry = Registry::new();
        let buffer = Pin::new(Box::new([42u8; 1024]));
        let registered_buffer = registry.register_buffer(buffer).unwrap();

        let buffer_ref = registry.get_buffer(&registered_buffer).unwrap();
        assert_eq!(buffer_ref.len(), 1024);
        assert_eq!(buffer_ref[0], 42);
    }
}

/// Test unregistration functionality
mod unregistration {
    use super::*;

    #[test]
    fn unregister_fd_success() {
        let mut registry = Registry::new();
        let registered_fd = registry.register_fd(5).unwrap();

        assert_eq!(registry.fd_count(), 1);
        assert!(registry.is_fd_registered(&registered_fd));

        let result = registry.unregister_fd(registered_fd);
        assert!(result.is_ok());
        assert_eq!(registry.fd_count(), 0);
    }

    #[test]
    fn unregister_buffer_success() {
        let mut registry = Registry::new();
        let buffer = Pin::new(Box::new([42u8; 1024]));
        let registered_buffer = registry.register_buffer(buffer).unwrap();

        assert_eq!(registry.buffer_count(), 1);
        assert!(registry.is_buffer_registered(&registered_buffer));

        let result = registry.unregister_buffer(registered_buffer);
        assert!(result.is_ok());

        let returned_buffer = result.unwrap();
        assert_eq!(returned_buffer.len(), 1024);
        assert_eq!(returned_buffer[0], 42);
        assert_eq!(registry.buffer_count(), 0);
    }

    #[test]
    fn unregister_fd_in_use_fails() {
        let mut registry = Registry::new();
        let registered_fd = registry.register_fd(5).unwrap();

        // Mark as in use
        registry.mark_fd_in_use(&registered_fd).unwrap();
        assert_eq!(registry.fds_in_use_count(), 1);

        // Try to unregister - should fail
        let result = registry.unregister_fd(registered_fd);
        assert!(result.is_err());

        match result.unwrap_err() {
            SaferRingError::BufferInFlight => {}
            _ => panic!("Expected BufferInFlight error"),
        }

        // Clean up for drop safety - mark as not in use
        // We need to recreate the RegisteredFd since it was consumed
        let registered_fd = RegisteredFd { index: 0, fd: 5 };
        registry.mark_fd_not_in_use(&registered_fd);
    }

    #[test]
    fn unregister_buffer_in_use_fails() {
        let mut registry = Registry::new();
        let buffer = Pin::new(Box::new([0u8; 1024]));
        let registered_buffer = registry.register_buffer(buffer).unwrap();

        // Mark as in use
        registry.mark_buffer_in_use(&registered_buffer).unwrap();
        assert_eq!(registry.buffers_in_use_count(), 1);

        // Try to unregister - should fail
        let result = registry.unregister_buffer(registered_buffer);
        assert!(result.is_err());

        match result.unwrap_err() {
            SaferRingError::BufferInFlight => {}
            _ => panic!("Expected BufferInFlight error"),
        }

        // Clean up for drop safety - mark as not in use
        // We need to recreate the RegisteredBuffer since it was consumed
        let registered_buffer = RegisteredBuffer {
            index: 0,
            size: 1024,
        };
        registry.mark_buffer_not_in_use(&registered_buffer);
    }

    #[test]
    fn unregister_nonexistent_fd_fails() {
        let mut registry = Registry::new();

        // Create a fake registered fd
        let fake_fd = RegisteredFd { index: 999, fd: 5 };

        let result = registry.unregister_fd(fake_fd);
        assert!(result.is_err());

        match result.unwrap_err() {
            SaferRingError::NotRegistered => {}
            _ => panic!("Expected NotRegistered error"),
        }
    }

    #[test]
    fn unregister_nonexistent_buffer_fails() {
        let mut registry = Registry::new();

        // Create a fake registered buffer
        let fake_buffer = RegisteredBuffer {
            index: 999,
            size: 1024,
        };

        let result = registry.unregister_buffer(fake_buffer);
        assert!(result.is_err());

        match result.unwrap_err() {
            SaferRingError::NotRegistered => {}
            _ => panic!("Expected NotRegistered error"),
        }
    }
}

/// Test usage tracking
mod usage_tracking {
    use super::*;

    #[test]
    fn mark_fd_in_use_works() {
        let mut registry = Registry::new();
        let registered_fd = registry.register_fd(5).unwrap();

        assert_eq!(registry.fds_in_use_count(), 0);

        registry.mark_fd_in_use(&registered_fd).unwrap();
        assert_eq!(registry.fds_in_use_count(), 1);

        registry.mark_fd_not_in_use(&registered_fd);
        assert_eq!(registry.fds_in_use_count(), 0);
    }

    #[test]
    fn mark_buffer_in_use_works() {
        let mut registry = Registry::new();
        let buffer = Pin::new(Box::new([0u8; 1024]));
        let registered_buffer = registry.register_buffer(buffer).unwrap();

        assert_eq!(registry.buffers_in_use_count(), 0);

        registry.mark_buffer_in_use(&registered_buffer).unwrap();
        assert_eq!(registry.buffers_in_use_count(), 1);

        registry.mark_buffer_not_in_use(&registered_buffer);
        assert_eq!(registry.buffers_in_use_count(), 0);
    }

    #[test]
    fn mark_nonexistent_fd_in_use_fails() {
        let mut registry = Registry::new();

        let fake_fd = RegisteredFd { index: 999, fd: 5 };

        let result = registry.mark_fd_in_use(&fake_fd);
        assert!(result.is_err());

        match result.unwrap_err() {
            SaferRingError::NotRegistered => {}
            _ => panic!("Expected NotRegistered error"),
        }
    }

    #[test]
    fn mark_nonexistent_buffer_in_use_fails() {
        let mut registry = Registry::new();

        let fake_buffer = RegisteredBuffer {
            index: 999,
            size: 1024,
        };

        let result = registry.mark_buffer_in_use(&fake_buffer);
        assert!(result.is_err());

        match result.unwrap_err() {
            SaferRingError::NotRegistered => {}
            _ => panic!("Expected NotRegistered error"),
        }
    }
}

/// Test slot reuse after unregistration
mod slot_reuse {
    use super::*;

    #[test]
    fn fd_slot_reuse_works() {
        let mut registry = Registry::new();

        // Register and unregister an fd
        let fd1 = registry.register_fd(5).unwrap();
        assert_eq!(fd1.index(), 0);
        registry.unregister_fd(fd1).unwrap();

        // Register another fd - should reuse the slot
        let fd2 = registry.register_fd(10).unwrap();
        assert_eq!(fd2.index(), 0);
        assert_eq!(fd2.raw_fd(), 10);
    }

    #[test]
    fn buffer_slot_reuse_works() {
        let mut registry = Registry::new();

        // Register and unregister a buffer
        let buffer1 = Pin::new(Box::new([1u8; 512]));
        let reg1 = registry.register_buffer(buffer1).unwrap();
        assert_eq!(reg1.index(), 0);
        let _returned = registry.unregister_buffer(reg1).unwrap();

        // Register another buffer - should reuse the slot
        let buffer2 = Pin::new(Box::new([2u8; 1024]));
        let reg2 = registry.register_buffer(buffer2).unwrap();
        assert_eq!(reg2.index(), 0);
        assert_eq!(reg2.size(), 1024);
    }

    #[test]
    fn mixed_registration_and_slot_reuse() {
        let mut registry = Registry::new();

        // Register multiple resources
        let fd1 = registry.register_fd(1).unwrap();
        let fd2 = registry.register_fd(2).unwrap();
        let buffer1 = Pin::new(Box::new([0u8; 512]));
        let reg1 = registry.register_buffer(buffer1).unwrap();

        assert_eq!(fd1.index(), 0);
        assert_eq!(fd2.index(), 1);
        assert_eq!(reg1.index(), 0);

        // Unregister the first fd
        registry.unregister_fd(fd1).unwrap();

        // Register a new fd - should reuse slot 0
        let fd3 = registry.register_fd(3).unwrap();
        assert_eq!(fd3.index(), 0);
        assert_eq!(fd3.raw_fd(), 3);

        // Other resources should be unaffected
        assert!(registry.is_fd_registered(&fd2));
        assert!(registry.is_buffer_registered(&reg1));
    }
}

/// Test registry lifecycle and safety
mod lifecycle_safety {
    use super::*;

    #[test]
    #[should_panic(expected = "Registry dropped with resources in use")]
    fn drop_with_fds_in_use_panics() {
        let mut registry = Registry::new();
        let registered_fd = registry.register_fd(5).unwrap();
        registry.mark_fd_in_use(&registered_fd).unwrap();

        // Registry should panic on drop because fd is in use
        drop(registry);
    }

    #[test]
    #[should_panic(expected = "Registry dropped with resources in use")]
    fn drop_with_buffers_in_use_panics() {
        let mut registry = Registry::new();
        let buffer = Pin::new(Box::new([0u8; 1024]));
        let registered_buffer = registry.register_buffer(buffer).unwrap();
        registry.mark_buffer_in_use(&registered_buffer).unwrap();

        // Registry should panic on drop because buffer is in use
        drop(registry);
    }

    #[test]
    fn drop_with_no_resources_in_use_succeeds() {
        let mut registry = Registry::new();
        let registered_fd = registry.register_fd(5).unwrap();
        let buffer = Pin::new(Box::new([0u8; 1024]));
        let registered_buffer = registry.register_buffer(buffer).unwrap();

        // Mark as in use then mark as not in use
        registry.mark_fd_in_use(&registered_fd).unwrap();
        registry.mark_buffer_in_use(&registered_buffer).unwrap();
        registry.mark_fd_not_in_use(&registered_fd);
        registry.mark_buffer_not_in_use(&registered_buffer);

        // Should drop successfully
        drop(registry);
    }
}

/// Test compile-time safety properties
mod compile_time_safety {
    // Unused imports removed

    // RegisteredFd and RegisteredBuffer are now Send/Sync for better ergonomics
    // The safety is maintained through the registry's lifetime management
}