lcpfs 2026.1.102

LCP File System - A ZFS-inspired copy-on-write filesystem for Rust
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
// Copyright 2025 LunaOS Contributors
// SPDX-License-Identifier: Apache-2.0

//! XDR (External Data Representation) encoding and decoding.
//!
//! This module provides XDR serialization for NFS protocol messages
//! as defined in RFC 4506.

use alloc::string::String;
use alloc::vec::Vec;

use super::error::{NfsError, NfsResult, NfsStatus};

// ═══════════════════════════════════════════════════════════════════════════════
// XDR READER
// ═══════════════════════════════════════════════════════════════════════════════

/// XDR data reader.
#[derive(Debug)]
pub struct XdrReader<'a> {
    /// Input buffer.
    data: &'a [u8],
    /// Current position.
    pos: usize,
}

impl<'a> XdrReader<'a> {
    /// Create a new reader.
    pub fn new(data: &'a [u8]) -> Self {
        Self { data, pos: 0 }
    }

    /// Get remaining bytes.
    pub fn remaining(&self) -> usize {
        self.data.len().saturating_sub(self.pos)
    }

    /// Check if there are enough bytes remaining.
    pub fn check_remaining(&self, n: usize) -> NfsResult<()> {
        if self.remaining() >= n {
            Ok(())
        } else {
            Err(NfsError::badxdr())
        }
    }

    /// Read raw bytes without padding.
    pub fn read_raw(&mut self, len: usize) -> NfsResult<&'a [u8]> {
        self.check_remaining(len)?;
        let slice = &self.data[self.pos..self.pos + len];
        self.pos += len;
        Ok(slice)
    }

    /// Skip padding to align to 4 bytes.
    fn skip_padding(&mut self, len: usize) -> NfsResult<()> {
        let pad = (4 - (len % 4)) % 4;
        if pad > 0 {
            self.check_remaining(pad)?;
            self.pos += pad;
        }
        Ok(())
    }

    /// Read a u32.
    pub fn read_u32(&mut self) -> NfsResult<u32> {
        self.check_remaining(4)?;
        let value = u32::from_be_bytes([
            self.data[self.pos],
            self.data[self.pos + 1],
            self.data[self.pos + 2],
            self.data[self.pos + 3],
        ]);
        self.pos += 4;
        Ok(value)
    }

    /// Read an i32.
    pub fn read_i32(&mut self) -> NfsResult<i32> {
        Ok(self.read_u32()? as i32)
    }

    /// Read a u64.
    pub fn read_u64(&mut self) -> NfsResult<u64> {
        let high = self.read_u32()? as u64;
        let low = self.read_u32()? as u64;
        Ok((high << 32) | low)
    }

    /// Read an i64.
    pub fn read_i64(&mut self) -> NfsResult<i64> {
        Ok(self.read_u64()? as i64)
    }

    /// Read a boolean.
    pub fn read_bool(&mut self) -> NfsResult<bool> {
        Ok(self.read_u32()? != 0)
    }

    /// Read opaque fixed-length data.
    pub fn read_opaque_fixed(&mut self, len: usize) -> NfsResult<Vec<u8>> {
        let data = self.read_raw(len)?.to_vec();
        self.skip_padding(len)?;
        Ok(data)
    }

    /// Read variable-length opaque data.
    pub fn read_opaque(&mut self) -> NfsResult<Vec<u8>> {
        let len = self.read_u32()? as usize;
        self.read_opaque_fixed(len)
    }

    /// Read variable-length opaque data with max length.
    pub fn read_opaque_max(&mut self, max_len: usize) -> NfsResult<Vec<u8>> {
        let len = self.read_u32()? as usize;
        if len > max_len {
            return Err(NfsError::badxdr());
        }
        self.read_opaque_fixed(len)
    }

    /// Read a string.
    pub fn read_string(&mut self) -> NfsResult<String> {
        let data = self.read_opaque()?;
        String::from_utf8(data).map_err(|_| NfsError::badxdr())
    }

    /// Read a string with max length.
    pub fn read_string_max(&mut self, max_len: usize) -> NfsResult<String> {
        let data = self.read_opaque_max(max_len)?;
        String::from_utf8(data).map_err(|_| NfsError::badxdr())
    }

    /// Read a fixed-size array of bytes.
    pub fn read_bytes<const N: usize>(&mut self) -> NfsResult<[u8; N]> {
        let data = self.read_raw(N)?;
        let mut arr = [0u8; N];
        arr.copy_from_slice(data);
        self.skip_padding(N)?;
        Ok(arr)
    }

    /// Read an optional value.
    pub fn read_optional<T, F>(&mut self, f: F) -> NfsResult<Option<T>>
    where
        F: FnOnce(&mut Self) -> NfsResult<T>,
    {
        if self.read_bool()? {
            Ok(Some(f(self)?))
        } else {
            Ok(None)
        }
    }

    /// Read an array of values.
    pub fn read_array<T, F>(&mut self, f: F) -> NfsResult<Vec<T>>
    where
        F: Fn(&mut Self) -> NfsResult<T>,
    {
        let count = self.read_u32()? as usize;
        let mut result = Vec::with_capacity(count);
        for _ in 0..count {
            result.push(f(self)?);
        }
        Ok(result)
    }

    /// Read an array with max length.
    pub fn read_array_max<T, F>(&mut self, max_len: usize, f: F) -> NfsResult<Vec<T>>
    where
        F: Fn(&mut Self) -> NfsResult<T>,
    {
        let count = self.read_u32()? as usize;
        if count > max_len {
            return Err(NfsError::badxdr());
        }
        let mut result = Vec::with_capacity(count);
        for _ in 0..count {
            result.push(f(self)?);
        }
        Ok(result)
    }

    /// Get current position.
    pub fn position(&self) -> usize {
        self.pos
    }

    /// Skip bytes.
    pub fn skip(&mut self, n: usize) -> NfsResult<()> {
        self.check_remaining(n)?;
        self.pos += n;
        Ok(())
    }
}

// ═══════════════════════════════════════════════════════════════════════════════
// XDR WRITER
// ═══════════════════════════════════════════════════════════════════════════════

/// XDR data writer.
#[derive(Debug, Default)]
pub struct XdrWriter {
    /// Output buffer.
    data: Vec<u8>,
}

impl XdrWriter {
    /// Create a new writer.
    pub fn new() -> Self {
        Self { data: Vec::new() }
    }

    /// Create a writer with capacity.
    pub fn with_capacity(capacity: usize) -> Self {
        Self {
            data: Vec::with_capacity(capacity),
        }
    }

    /// Get the written data.
    pub fn into_inner(self) -> Vec<u8> {
        self.data
    }

    /// Get current length.
    pub fn len(&self) -> usize {
        self.data.len()
    }

    /// Check if empty.
    pub fn is_empty(&self) -> bool {
        self.data.is_empty()
    }

    /// Get a reference to the data.
    pub fn as_slice(&self) -> &[u8] {
        &self.data
    }

    /// Write raw bytes.
    pub fn write_raw(&mut self, data: &[u8]) {
        self.data.extend_from_slice(data);
    }

    /// Write padding to align to 4 bytes.
    fn write_padding(&mut self, len: usize) {
        let pad = (4 - (len % 4)) % 4;
        for _ in 0..pad {
            self.data.push(0);
        }
    }

    /// Write a u32.
    pub fn write_u32(&mut self, value: u32) {
        self.data.extend_from_slice(&value.to_be_bytes());
    }

    /// Write an i32.
    pub fn write_i32(&mut self, value: i32) {
        self.write_u32(value as u32);
    }

    /// Write a u64.
    pub fn write_u64(&mut self, value: u64) {
        self.write_u32((value >> 32) as u32);
        self.write_u32(value as u32);
    }

    /// Write an i64.
    pub fn write_i64(&mut self, value: i64) {
        self.write_u64(value as u64);
    }

    /// Write a boolean.
    pub fn write_bool(&mut self, value: bool) {
        self.write_u32(if value { 1 } else { 0 });
    }

    /// Write fixed-length opaque data.
    pub fn write_opaque_fixed(&mut self, data: &[u8]) {
        self.write_raw(data);
        self.write_padding(data.len());
    }

    /// Write variable-length opaque data.
    pub fn write_opaque(&mut self, data: &[u8]) {
        self.write_u32(data.len() as u32);
        self.write_opaque_fixed(data);
    }

    /// Write a string.
    pub fn write_string(&mut self, s: &str) {
        self.write_opaque(s.as_bytes());
    }

    /// Write a fixed-size array of bytes.
    pub fn write_bytes<const N: usize>(&mut self, data: &[u8; N]) {
        self.write_raw(data);
        self.write_padding(N);
    }

    /// Write an optional value.
    pub fn write_optional<T, F>(&mut self, value: &Option<T>, f: F)
    where
        F: FnOnce(&mut Self, &T),
    {
        if let Some(v) = value {
            self.write_bool(true);
            f(self, v);
        } else {
            self.write_bool(false);
        }
    }

    /// Write an array of values.
    pub fn write_array<T, F>(&mut self, values: &[T], f: F)
    where
        F: Fn(&mut Self, &T),
    {
        self.write_u32(values.len() as u32);
        for v in values {
            f(self, v);
        }
    }

    /// Clear the buffer.
    pub fn clear(&mut self) {
        self.data.clear();
    }
}

// ═══════════════════════════════════════════════════════════════════════════════
// CONVENIENCE TRAITS
// ═══════════════════════════════════════════════════════════════════════════════

/// Trait for types that can be read from XDR.
pub trait XdrRead: Sized {
    /// Read from XDR.
    fn xdr_read(reader: &mut XdrReader) -> NfsResult<Self>;
}

/// Trait for types that can be written to XDR.
pub trait XdrWrite {
    /// Write to XDR.
    fn xdr_write(&self, writer: &mut XdrWriter);
}

// Implement for primitive types
impl XdrRead for u32 {
    fn xdr_read(reader: &mut XdrReader) -> NfsResult<Self> {
        reader.read_u32()
    }
}

impl XdrWrite for u32 {
    fn xdr_write(&self, writer: &mut XdrWriter) {
        writer.write_u32(*self);
    }
}

impl XdrRead for u64 {
    fn xdr_read(reader: &mut XdrReader) -> NfsResult<Self> {
        reader.read_u64()
    }
}

impl XdrWrite for u64 {
    fn xdr_write(&self, writer: &mut XdrWriter) {
        writer.write_u64(*self);
    }
}

impl XdrRead for bool {
    fn xdr_read(reader: &mut XdrReader) -> NfsResult<Self> {
        reader.read_bool()
    }
}

impl XdrWrite for bool {
    fn xdr_write(&self, writer: &mut XdrWriter) {
        writer.write_bool(*self);
    }
}

impl XdrRead for String {
    fn xdr_read(reader: &mut XdrReader) -> NfsResult<Self> {
        reader.read_string()
    }
}

impl XdrWrite for String {
    fn xdr_write(&self, writer: &mut XdrWriter) {
        writer.write_string(self);
    }
}

impl XdrWrite for str {
    fn xdr_write(&self, writer: &mut XdrWriter) {
        writer.write_string(self);
    }
}

impl XdrRead for Vec<u8> {
    fn xdr_read(reader: &mut XdrReader) -> NfsResult<Self> {
        reader.read_opaque()
    }
}

impl XdrWrite for Vec<u8> {
    fn xdr_write(&self, writer: &mut XdrWriter) {
        writer.write_opaque(self);
    }
}

impl XdrWrite for [u8] {
    fn xdr_write(&self, writer: &mut XdrWriter) {
        writer.write_opaque(self);
    }
}

// ═══════════════════════════════════════════════════════════════════════════════
// TESTS
// ═══════════════════════════════════════════════════════════════════════════════

#[cfg(test)]
mod tests {
    use super::*;
    use alloc::vec;

    #[test]
    fn test_u32_roundtrip() {
        let mut writer = XdrWriter::new();
        writer.write_u32(0x12345678);

        let mut reader = XdrReader::new(writer.as_slice());
        assert_eq!(reader.read_u32().unwrap(), 0x12345678);
    }

    #[test]
    fn test_u64_roundtrip() {
        let mut writer = XdrWriter::new();
        writer.write_u64(0x123456789ABCDEF0);

        let mut reader = XdrReader::new(writer.as_slice());
        assert_eq!(reader.read_u64().unwrap(), 0x123456789ABCDEF0);
    }

    #[test]
    fn test_bool_roundtrip() {
        let mut writer = XdrWriter::new();
        writer.write_bool(true);
        writer.write_bool(false);

        let mut reader = XdrReader::new(writer.as_slice());
        assert!(reader.read_bool().unwrap());
        assert!(!reader.read_bool().unwrap());
    }

    #[test]
    fn test_opaque_roundtrip() {
        let mut writer = XdrWriter::new();
        writer.write_opaque(b"hello world");

        let mut reader = XdrReader::new(writer.as_slice());
        let data = reader.read_opaque().unwrap();
        assert_eq!(data, b"hello world");
    }

    #[test]
    fn test_string_roundtrip() {
        let mut writer = XdrWriter::new();
        writer.write_string("test string");

        let mut reader = XdrReader::new(writer.as_slice());
        assert_eq!(reader.read_string().unwrap(), "test string");
    }

    #[test]
    fn test_padding() {
        // Test that padding is correct
        let mut writer = XdrWriter::new();
        writer.write_opaque(b"x"); // 1 byte + 3 padding
        writer.write_opaque(b"xx"); // 2 bytes + 2 padding
        writer.write_opaque(b"xxx"); // 3 bytes + 1 padding
        writer.write_opaque(b"xxxx"); // 4 bytes + 0 padding

        // Length should be: 4 + (1+3) + 4 + (2+2) + 4 + (3+1) + 4 + 4 = 32
        assert_eq!(writer.len(), 32);

        let mut reader = XdrReader::new(writer.as_slice());
        assert_eq!(reader.read_opaque().unwrap().len(), 1);
        assert_eq!(reader.read_opaque().unwrap().len(), 2);
        assert_eq!(reader.read_opaque().unwrap().len(), 3);
        assert_eq!(reader.read_opaque().unwrap().len(), 4);
    }

    #[test]
    fn test_optional() {
        let mut writer = XdrWriter::new();
        writer.write_optional(&Some(42u32), |w, v| w.write_u32(*v));
        writer.write_optional::<u32, _>(&None, |w, v| w.write_u32(*v));

        let mut reader = XdrReader::new(writer.as_slice());
        let opt1: Option<u32> = reader.read_optional(|r| r.read_u32()).unwrap();
        let opt2: Option<u32> = reader.read_optional(|r| r.read_u32()).unwrap();

        assert_eq!(opt1, Some(42));
        assert_eq!(opt2, None);
    }

    #[test]
    fn test_array() {
        let values = vec![1u32, 2, 3, 4, 5];

        let mut writer = XdrWriter::new();
        writer.write_array(&values, |w, v| w.write_u32(*v));

        let mut reader = XdrReader::new(writer.as_slice());
        let result: Vec<u32> = reader.read_array(|r| r.read_u32()).unwrap();

        assert_eq!(result, values);
    }

    #[test]
    fn test_fixed_bytes() {
        let mut writer = XdrWriter::new();
        writer.write_bytes(&[1u8, 2, 3, 4, 5, 6, 7, 8]);

        let mut reader = XdrReader::new(writer.as_slice());
        let bytes: [u8; 8] = reader.read_bytes().unwrap();
        assert_eq!(bytes, [1, 2, 3, 4, 5, 6, 7, 8]);
    }

    #[test]
    fn test_reader_remaining() {
        let data = [0u8; 20];
        let mut reader = XdrReader::new(&data);

        assert_eq!(reader.remaining(), 20);
        reader.read_u32().unwrap();
        assert_eq!(reader.remaining(), 16);
    }

    #[test]
    fn test_reader_eof() {
        let data = [0u8; 2];
        let mut reader = XdrReader::new(&data);

        let result = reader.read_u32();
        assert!(result.is_err());
    }

    #[test]
    fn test_max_length_checks() {
        let mut writer = XdrWriter::new();
        writer.write_string("hello");

        let mut reader = XdrReader::new(writer.as_slice());
        let result = reader.read_string_max(3); // max 3, but string is 5
        assert!(result.is_err());

        let mut reader = XdrReader::new(writer.as_slice());
        let result = reader.read_string_max(10); // max 10, string is 5
        assert!(result.is_ok());
    }

    #[test]
    fn test_xdr_traits() {
        let mut writer = XdrWriter::new();
        42u32.xdr_write(&mut writer);
        "test".xdr_write(&mut writer);

        let mut reader = XdrReader::new(writer.as_slice());
        assert_eq!(u32::xdr_read(&mut reader).unwrap(), 42);
        assert_eq!(String::xdr_read(&mut reader).unwrap(), "test");
    }

    #[test]
    fn test_negative_i32() {
        let mut writer = XdrWriter::new();
        writer.write_i32(-1);
        writer.write_i32(-12345);

        let mut reader = XdrReader::new(writer.as_slice());
        assert_eq!(reader.read_i32().unwrap(), -1);
        assert_eq!(reader.read_i32().unwrap(), -12345);
    }

    #[test]
    fn test_skip() {
        let data = [1, 2, 3, 4, 5, 6, 7, 8];
        let mut reader = XdrReader::new(&data);

        reader.skip(4).unwrap();
        assert_eq!(reader.position(), 4);

        let result = reader.skip(10);
        assert!(result.is_err());
    }

    #[test]
    fn test_writer_clear() {
        let mut writer = XdrWriter::new();
        writer.write_u32(123);
        assert!(!writer.is_empty());

        writer.clear();
        assert!(writer.is_empty());
    }
}