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
// Copyright 2025 LunaOS Contributors
// SPDX-License-Identifier: Apache-2.0

//! Delta computation and application.
//!
//! This module implements the core rsync-style algorithm:
//! 1. Generate signatures from source data
//! 2. Compute delta between signatures and target
//! 3. Apply delta to reconstruct target from source

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

use super::types::{
    BlockSignature, DEFAULT_BLOCK_SIZE, Delta, DeltaError, DeltaOp, DeltaResult, MAX_BLOCK_SIZE,
    MIN_BLOCK_SIZE, RollingChecksum, SignatureSet,
};

// ═══════════════════════════════════════════════════════════════════════════════
// STRONG CHECKSUM (BLAKE3-STYLE)
// ═══════════════════════════════════════════════════════════════════════════════

/// Compute a strong checksum for a block.
///
/// Uses a simple but effective hash for block verification.
/// In production, this would use BLAKE3 truncated to 128 bits.
fn strong_checksum(data: &[u8]) -> [u8; 16] {
    // Simple hash based on polynomial rolling
    // For production, use real BLAKE3
    let mut state: [u64; 4] = [
        0x6a09e667f3bcc908,
        0xbb67ae8584caa73b,
        0x3c6ef372fe94f82b,
        0xa54ff53a5f1d36f1,
    ];

    for chunk in data.chunks(8) {
        let mut val: u64 = 0;
        for (i, &byte) in chunk.iter().enumerate() {
            val |= (byte as u64) << (i * 8);
        }

        state[0] = state[0].wrapping_add(val);
        state[1] = state[1].wrapping_mul(state[0] | 1);
        state[2] ^= state[1].rotate_left(17);
        state[3] = state[3].wrapping_add(state[2]);
    }

    // Mix final state
    for _ in 0..4 {
        state[0] = state[0].wrapping_add(state[3]);
        state[1] ^= state[0].rotate_left(13);
        state[2] = state[2].wrapping_add(state[1]);
        state[3] = state[3].wrapping_mul(state[2] | 1);
    }

    let mut result = [0u8; 16];
    for (i, &s) in state.iter().take(2).enumerate() {
        let bytes = s.to_le_bytes();
        result[i * 8..(i + 1) * 8].copy_from_slice(&bytes);
    }
    result
}

/// Compute full file checksum.
pub fn file_checksum(data: &[u8]) -> [u64; 4] {
    let mut state: [u64; 4] = [
        0x243f6a8885a308d3,
        0x13198a2e03707344,
        0xa4093822299f31d0,
        0x082efa98ec4e6c89,
    ];

    for chunk in data.chunks(32) {
        for (i, byte_chunk) in chunk.chunks(8).enumerate() {
            let mut val: u64 = 0;
            for (j, &byte) in byte_chunk.iter().enumerate() {
                val |= (byte as u64) << (j * 8);
            }
            state[i % 4] = state[i % 4].wrapping_add(val);
        }

        state[0] ^= state[3].rotate_left(7);
        state[1] = state[1].wrapping_add(state[0]);
        state[2] ^= state[1].rotate_left(13);
        state[3] = state[3].wrapping_add(state[2]);
    }

    // Include length
    state[0] ^= data.len() as u64;

    // Final mixing
    for _ in 0..8 {
        state[0] = state[0].wrapping_add(state[3].rotate_left(5));
        state[1] ^= state[0];
        state[2] = state[2].wrapping_add(state[1].rotate_left(11));
        state[3] ^= state[2];
    }

    state
}

// ═══════════════════════════════════════════════════════════════════════════════
// SIGNATURE GENERATION
// ═══════════════════════════════════════════════════════════════════════════════

/// Generate block signatures for source data.
///
/// # Arguments
/// * `data` - Source file data
/// * `block_size` - Block size to use (default 4KB)
///
/// # Returns
/// SignatureSet containing all block signatures
pub fn generate_signatures(data: &[u8], block_size: usize) -> DeltaResult<SignatureSet> {
    // Validate block size
    if !(MIN_BLOCK_SIZE..=MAX_BLOCK_SIZE).contains(&block_size) {
        return Err(DeltaError::InvalidBlockSize(block_size));
    }

    let file_cksum = file_checksum(data);
    let mut set = SignatureSet::new(file_cksum, data.len() as u64, block_size as u32);

    let mut offset = 0u64;

    for (index, chunk) in data.chunks(block_size).enumerate() {
        let rolling = RollingChecksum::compute(chunk);
        let strong = strong_checksum(chunk);

        set.add_block(BlockSignature::new(
            index as u32,
            offset,
            chunk.len() as u32,
            rolling,
            strong,
        ));

        offset += chunk.len() as u64;
    }

    Ok(set)
}

/// Generate signatures with default block size.
pub fn generate_signatures_default(data: &[u8]) -> DeltaResult<SignatureSet> {
    generate_signatures(data, DEFAULT_BLOCK_SIZE)
}

// ═══════════════════════════════════════════════════════════════════════════════
// DELTA COMPUTATION
// ═══════════════════════════════════════════════════════════════════════════════

/// Compute delta between source signatures and target data.
///
/// Uses rolling checksum to find matching blocks from source,
/// emitting copy operations for matches and insert operations for new data.
///
/// # Arguments
/// * `source_sigs` - Signatures from source file
/// * `target` - Target file data
///
/// # Returns
/// Delta containing operations to transform source into target
pub fn compute_delta(source_sigs: &SignatureSet, target: &[u8]) -> DeltaResult<Delta> {
    let block_size = source_sigs.block_size as usize;
    let target_checksum = file_checksum(target);

    let mut delta = Delta::new(
        source_sigs.file_checksum,
        target_checksum,
        source_sigs.file_size,
        target.len() as u64,
        source_sigs.block_size,
    );

    // Handle empty target
    if target.is_empty() {
        return Ok(delta);
    }

    // Handle small target (smaller than block size)
    if target.len() < block_size {
        delta.add_insert(target);
        return Ok(delta);
    }

    // Build lookup table: rolling checksum -> block signatures
    let mut rolling_lookup: BTreeMap<u32, Vec<&BlockSignature>> = BTreeMap::new();
    for block in &source_sigs.blocks {
        rolling_lookup.entry(block.rolling).or_default().push(block);
    }

    let mut pos = 0usize;
    let mut literal_start = 0usize;

    while pos + block_size <= target.len() {
        // Compute rolling checksum for current window
        let window = &target[pos..pos + block_size];
        let rolling = RollingChecksum::compute(window);

        let mut found_match = false;

        // Check for matching block
        if let Some(candidates) = rolling_lookup.get(&rolling) {
            let strong = strong_checksum(window);

            for block in candidates {
                if block.strong == strong && block.length as usize == block_size {
                    // Found a match!

                    // First, flush any pending literal data
                    if pos > literal_start {
                        delta.add_insert(&target[literal_start..pos]);
                    }

                    // Add copy operation
                    delta.add_copy(block.offset, block.length as u64);

                    // Move past the matched block
                    pos += block_size;
                    literal_start = pos;
                    found_match = true;
                    break;
                }
            }
        }

        if !found_match {
            // No match, move forward one byte
            pos += 1;
        }
    }

    // Flush remaining literal data (includes any trailing partial block)
    if literal_start < target.len() {
        delta.add_insert(&target[literal_start..]);
    }

    Ok(delta)
}

// ═══════════════════════════════════════════════════════════════════════════════
// DELTA APPLICATION
// ═══════════════════════════════════════════════════════════════════════════════

/// Apply delta to source data to produce target data.
///
/// # Arguments
/// * `source` - Original source data
/// * `delta` - Delta to apply
///
/// # Returns
/// Reconstructed target data
pub fn apply_delta(source: &[u8], delta: &Delta) -> DeltaResult<Vec<u8>> {
    // Verify source checksum
    let source_cksum = file_checksum(source);
    if source_cksum != delta.source_checksum {
        return Err(DeltaError::ChecksumMismatch {
            expected: delta.source_checksum,
            actual: source_cksum,
        });
    }

    let mut result = Vec::with_capacity(delta.target_size as usize);

    for op in &delta.ops {
        match op {
            DeltaOp::Copy { src_offset, length } => {
                let start = *src_offset as usize;
                let end = start + *length as usize;

                if end > source.len() {
                    return Err(DeltaError::ApplyFailed(String::from(
                        "copy extends past source end",
                    )));
                }

                result.extend_from_slice(&source[start..end]);
            }
            DeltaOp::Insert { data } => {
                result.extend_from_slice(data);
            }
        }
    }

    // Verify target checksum
    let result_cksum = file_checksum(&result);
    if result_cksum != delta.target_checksum {
        return Err(DeltaError::ChecksumMismatch {
            expected: delta.target_checksum,
            actual: result_cksum,
        });
    }

    Ok(result)
}

// ═══════════════════════════════════════════════════════════════════════════════
// UTILITY FUNCTIONS
// ═══════════════════════════════════════════════════════════════════════════════

/// Compute optimal block size for given file size.
///
/// Smaller files use smaller blocks for better matching,
/// larger files use larger blocks for efficiency.
pub fn optimal_block_size(file_size: u64) -> usize {
    match file_size {
        0..=1024 => 128,              // <= 1KB: 128 byte blocks
        1025..=65536 => 512,          // <= 64KB: 512 byte blocks
        65537..=1048576 => 2048,      // <= 1MB: 2KB blocks
        1048577..=16777216 => 4096,   // <= 16MB: 4KB blocks
        16777217..=268435456 => 8192, // <= 256MB: 8KB blocks
        _ => 16384,                   // > 256MB: 16KB blocks
    }
}

/// Create a delta that represents a complete file insert.
///
/// Used when there's no source file or files are completely different.
pub fn create_full_insert_delta(data: &[u8]) -> Delta {
    let checksum = file_checksum(data);
    let mut delta = Delta::new(
        [0; 4],
        checksum,
        0,
        data.len() as u64,
        DEFAULT_BLOCK_SIZE as u32,
    );
    delta.add_insert(data);
    delta
}

/// Create an identity delta (source == target).
pub fn create_identity_delta(data: &[u8]) -> Delta {
    let checksum = file_checksum(data);
    let mut delta = Delta::new(
        checksum,
        checksum,
        data.len() as u64,
        data.len() as u64,
        DEFAULT_BLOCK_SIZE as u32,
    );
    delta.add_copy(0, data.len() as u64);
    delta
}

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

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

    #[test]
    fn test_strong_checksum() {
        let data1 = b"hello world";
        let data2 = b"hello worle";

        let cksum1 = strong_checksum(data1);
        let cksum2 = strong_checksum(data2);

        assert_ne!(cksum1, cksum2);

        // Same data should produce same checksum
        let cksum1_again = strong_checksum(data1);
        assert_eq!(cksum1, cksum1_again);
    }

    #[test]
    fn test_file_checksum() {
        let data1 = b"test data";
        let data2 = b"different";

        let cksum1 = file_checksum(data1);
        let cksum2 = file_checksum(data2);

        assert_ne!(cksum1, cksum2);
    }

    #[test]
    fn test_generate_signatures() {
        let data = vec![0u8; 8192];
        let sigs = generate_signatures(&data, 4096).unwrap();

        assert_eq!(sigs.block_count(), 2);
        assert_eq!(sigs.blocks[0].length, 4096);
        assert_eq!(sigs.blocks[1].length, 4096);
    }

    #[test]
    fn test_generate_signatures_small_file() {
        let data = b"small file";
        let sigs = generate_signatures(data, 4096).unwrap();

        assert_eq!(sigs.block_count(), 1);
        assert_eq!(sigs.blocks[0].length as usize, data.len());
    }

    #[test]
    fn test_invalid_block_size() {
        let data = b"test";

        assert!(generate_signatures(data, 100).is_err()); // Too small
        assert!(generate_signatures(data, 10_000_000).is_err()); // Too large
    }

    #[test]
    fn test_compute_delta_identical() {
        // Create data larger than block size
        let data: Vec<u8> = (0..1024).map(|i| (i % 256) as u8).collect();

        let sigs = generate_signatures(&data, 512).unwrap();
        let delta = compute_delta(&sigs, &data).unwrap();

        // Should be all copies for identical data
        assert!(delta.is_identity());
        assert_eq!(delta.copy_percentage(), 100.0);
    }

    #[test]
    fn test_compute_delta_completely_different() {
        let source: Vec<u8> = vec![0xAA; 1024];
        let target: Vec<u8> = vec![0xBB; 1024];

        let sigs = generate_signatures(&source, 512).unwrap();
        let delta = compute_delta(&sigs, &target).unwrap();

        // Should be all inserts since no blocks match
        assert!(delta.is_full_replace());
    }

    #[test]
    fn test_compute_delta_small_change() {
        // Create data with repeating blocks
        let mut source = Vec::new();
        for _ in 0..4 {
            source.extend_from_slice(&[0xAA; 512]);
        }

        // Modify last block
        let mut target = source.clone();
        target[1536..].fill(0xBB);

        let sigs = generate_signatures(&source, 512).unwrap();
        let delta = compute_delta(&sigs, &target).unwrap();

        // Should have some copies
        assert!(!delta.is_full_replace());
    }

    #[test]
    fn test_apply_delta_identical() {
        let data = b"test data for applying delta";

        let sigs = generate_signatures(data, 512).unwrap();
        let delta = compute_delta(&sigs, data).unwrap();
        let result = apply_delta(data, &delta).unwrap();

        assert_eq!(&result, data);
    }

    #[test]
    fn test_apply_delta_modified() {
        let source = b"original file content here";
        let target = b"modified file content here";

        let sigs = generate_signatures(source, 512).unwrap();
        let delta = compute_delta(&sigs, target).unwrap();
        let result = apply_delta(source, &delta).unwrap();

        assert_eq!(&result, target);
    }

    #[test]
    fn test_apply_delta_checksum_mismatch() {
        let source = b"original";
        let target = b"modified";

        let sigs = generate_signatures(source, 512).unwrap();
        let delta = compute_delta(&sigs, target).unwrap();

        // Try to apply with wrong source
        let wrong_source = b"different";
        let result = apply_delta(wrong_source, &delta);

        assert!(matches!(result, Err(DeltaError::ChecksumMismatch { .. })));
    }

    #[test]
    fn test_full_insert_delta() {
        let data = b"new file with no source";
        let delta = create_full_insert_delta(data);

        assert!(delta.is_full_replace());
        assert_eq!(delta.target_size, data.len() as u64);
    }

    #[test]
    fn test_identity_delta() {
        let data = b"file that hasn't changed";
        let delta = create_identity_delta(data);

        assert!(delta.is_identity());
        assert_eq!(delta.op_count(), 1);
    }

    #[test]
    fn test_optimal_block_size() {
        assert_eq!(optimal_block_size(500), 128);
        assert_eq!(optimal_block_size(50000), 512);
        assert_eq!(optimal_block_size(500000), 2048);
        assert_eq!(optimal_block_size(5000000), 4096);
        assert_eq!(optimal_block_size(50000000), 8192);
        assert_eq!(optimal_block_size(500000000), 16384);
    }

    #[test]
    fn test_roundtrip_various_sizes() {
        for size in [64, 256, 1024, 4096, 8192, 16384] {
            let mut source: Vec<u8> = (0..size).map(|i| (i % 256) as u8).collect();
            let mut target = source.clone();

            // Modify some bytes
            if size > 10 {
                target[5] = 0xFF;
                target[size - 5] = 0xAA;
            }

            let block_size = optimal_block_size(size as u64);
            let sigs = generate_signatures(&source, block_size.max(MIN_BLOCK_SIZE)).unwrap();
            let delta = compute_delta(&sigs, &target).unwrap();
            let result = apply_delta(&source, &delta).unwrap();

            assert_eq!(result, target, "Roundtrip failed for size {}", size);
        }
    }

    #[test]
    fn test_empty_files() {
        let empty: &[u8] = &[];
        let sigs = generate_signatures(empty, 512).unwrap();
        assert_eq!(sigs.block_count(), 0);

        let delta = compute_delta(&sigs, empty).unwrap();
        assert_eq!(delta.op_count(), 0);
    }

    #[test]
    fn test_append_scenario() {
        let source = b"original content";
        let target = b"original content with appended data";

        let sigs = generate_signatures(source, 512).unwrap();
        let delta = compute_delta(&sigs, target).unwrap();
        let result = apply_delta(source, &delta).unwrap();

        assert_eq!(&result, target);
    }

    #[test]
    fn test_prepend_scenario() {
        let source = b"original content";
        let target = b"prepended data original content";

        let sigs = generate_signatures(source, 512).unwrap();
        let delta = compute_delta(&sigs, target).unwrap();
        let result = apply_delta(source, &delta).unwrap();

        assert_eq!(&result, target);
    }
}