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
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
// Copyright 2025 LunaOS Contributors
// SPDX-License-Identifier: Apache-2.0

//! Alternate data stream operations
//!
//! Provides real ADS storage using a per-file stream registry.
//! Streams are stored in memory alongside the primary data cache.

use alloc::collections::BTreeMap;
use alloc::string::{String, ToString};
use alloc::vec;
use alloc::vec::Vec;
use lazy_static::lazy_static;
use spin::Mutex;

use super::types::*;
use crate::storage::zpl::ZPL;

/// Global stream registry: (object_id, stream_name) -> StreamData
lazy_static! {
    static ref STREAM_REGISTRY: Mutex<BTreeMap<(u64, String), StreamData>> =
        Mutex::new(BTreeMap::new());
}

/// Stream data storage
#[derive(Clone)]
struct StreamData {
    /// Stream metadata
    info: StreamInfo,
    /// Stream content
    data: Vec<u8>,
}

/// List all streams for a file.
///
/// Returns the primary stream (from znode) plus all alternate streams
/// from the stream registry.
pub fn list_streams(dataset: &str, object_id: u64) -> Result<Vec<StreamInfo>, StreamError> {
    let _ = dataset;

    let mut streams = Vec::new();

    // Get primary stream info from ZPL
    {
        let zpl = ZPL.lock();
        if let Some(znode) = zpl.get_znode(object_id) {
            let primary_size = znode.phys.size;
            let allocated = znode
                .data_cache
                .as_ref()
                .map(|d| d.len() as u64)
                .unwrap_or(primary_size);

            streams.push(StreamInfo {
                name: String::new(),
                stream_type: StreamType::Data,
                size: primary_size,
                allocated_size: allocated,
                created: znode.phys.crtime[0], // Creation time (seconds)
                modified: znode.phys.mtime[0], // Modification time (seconds)
                is_primary: true,
                attributes: StreamAttributes::default(),
            });
        } else {
            return Err(StreamError::FileNotFound(object_id));
        }
    }

    // Get alternate streams from registry
    {
        let registry = STREAM_REGISTRY.lock();
        for ((oid, name), stream_data) in registry.iter() {
            if *oid == object_id && !name.is_empty() {
                streams.push(stream_data.info.clone());
            }
        }
    }

    Ok(streams)
}

/// Check if a stream exists.
///
/// For primary stream (empty name), checks the znode exists.
/// For alternate streams, checks the stream registry.
pub fn stream_exists(
    dataset: &str,
    object_id: u64,
    stream_name: &str,
) -> Result<bool, StreamError> {
    let _ = dataset;

    // Primary stream exists if file exists
    if stream_name.is_empty() {
        let zpl = ZPL.lock();
        return Ok(zpl.get_znode(object_id).is_some());
    }

    // Check registry for alternate streams
    let registry = STREAM_REGISTRY.lock();
    Ok(registry.contains_key(&(object_id, stream_name.to_string())))
}

/// Get stream information.
pub fn get_stream_info(
    dataset: &str,
    object_id: u64,
    stream_name: &str,
) -> Result<StreamInfo, StreamError> {
    let _ = dataset;

    // Primary stream info comes from znode
    if stream_name.is_empty() {
        let zpl = ZPL.lock();
        let znode = zpl
            .get_znode(object_id)
            .ok_or(StreamError::FileNotFound(object_id))?;

        return Ok(StreamInfo {
            name: String::new(),
            stream_type: StreamType::Data,
            size: znode.phys.size,
            allocated_size: znode
                .data_cache
                .as_ref()
                .map(|d| d.len() as u64)
                .unwrap_or(0),
            created: znode.phys.crtime[0], // Creation time (seconds)
            modified: znode.phys.mtime[0], // Modification time (seconds)
            is_primary: true,
            attributes: StreamAttributes::default(),
        });
    }

    // Alternate stream info from registry
    let registry = STREAM_REGISTRY.lock();
    registry
        .get(&(object_id, stream_name.to_string()))
        .map(|sd| sd.info.clone())
        .ok_or_else(|| StreamError::StreamNotFound(stream_name.to_string()))
}

/// Create a new alternate data stream.
///
/// Creates an empty stream with the given name and type.
pub fn create_stream(
    dataset: &str,
    object_id: u64,
    stream_name: &str,
    stream_type: StreamType,
) -> Result<(), StreamError> {
    let _ = dataset;

    // Validate stream name
    validate_stream_name(stream_name)?;

    // Cannot create primary stream (it's implicit)
    if stream_name.is_empty() {
        return Err(StreamError::StreamExists(String::new()));
    }

    // Check if file exists
    {
        let zpl = ZPL.lock();
        if zpl.get_znode(object_id).is_none() {
            return Err(StreamError::FileNotFound(object_id));
        }
    }

    // Check if stream already exists
    let mut registry = STREAM_REGISTRY.lock();
    let key = (object_id, stream_name.to_string());

    if registry.contains_key(&key) {
        return Err(StreamError::StreamExists(stream_name.to_string()));
    }

    // Check stream count limit
    let stream_count = registry.keys().filter(|(oid, _)| *oid == object_id).count();

    if stream_count >= MAX_STREAMS_PER_FILE as usize {
        return Err(StreamError::TooManyStreams(MAX_STREAMS_PER_FILE));
    }

    // Create the stream
    let now = crate::time::now();
    let info = StreamInfo {
        name: stream_name.to_string(),
        stream_type,
        size: 0,
        allocated_size: 0,
        created: now,
        modified: now,
        is_primary: false,
        attributes: StreamAttributes::default(),
    };

    registry.insert(
        key,
        StreamData {
            info,
            data: Vec::new(),
        },
    );

    crate::lcpfs_println!(
        "[ STREAMS ] Created stream '{}' for object {}",
        stream_name,
        object_id
    );

    Ok(())
}

/// Delete an alternate data stream.
pub fn delete_stream(dataset: &str, object_id: u64, stream_name: &str) -> Result<(), StreamError> {
    let _ = dataset;

    // Cannot delete primary stream
    if stream_name.is_empty() {
        return Err(StreamError::CannotDeletePrimary);
    }

    // Remove from registry
    let mut registry = STREAM_REGISTRY.lock();
    let key = (object_id, stream_name.to_string());

    if registry.remove(&key).is_none() {
        return Err(StreamError::StreamNotFound(stream_name.to_string()));
    }

    crate::lcpfs_println!(
        "[ STREAMS ] Deleted stream '{}' from object {}",
        stream_name,
        object_id
    );

    Ok(())
}

/// Read data from a stream.
///
/// For primary stream, reads from znode's data_cache.
/// For alternate streams, reads from the stream registry.
pub fn read_stream(
    dataset: &str,
    object_id: u64,
    stream_name: &str,
    offset: u64,
    length: usize,
) -> Result<Vec<u8>, StreamError> {
    let _ = dataset;

    // Primary stream read from znode
    if stream_name.is_empty() {
        let zpl = ZPL.lock();
        let znode = zpl
            .get_znode(object_id)
            .ok_or(StreamError::FileNotFound(object_id))?;

        if let Some(ref data) = znode.data_cache {
            let start = offset as usize;
            if start >= data.len() {
                return Ok(Vec::new());
            }
            let end = (start + length).min(data.len());
            return Ok(data[start..end].to_vec());
        }

        return Ok(Vec::new());
    }

    // Alternate stream read from registry
    let registry = STREAM_REGISTRY.lock();
    let key = (object_id, stream_name.to_string());

    let stream_data = registry
        .get(&key)
        .ok_or_else(|| StreamError::StreamNotFound(stream_name.to_string()))?;

    let start = offset as usize;
    if start >= stream_data.data.len() {
        return Ok(Vec::new());
    }

    let end = (start + length).min(stream_data.data.len());
    Ok(stream_data.data[start..end].to_vec())
}

/// Write data to a stream.
///
/// For primary stream, writes to znode's data_cache.
/// For alternate streams, writes to the stream registry.
pub fn write_stream(
    dataset: &str,
    object_id: u64,
    stream_name: &str,
    offset: u64,
    data: &[u8],
) -> Result<usize, StreamError> {
    let _ = dataset;

    // Primary stream write to znode
    if stream_name.is_empty() {
        let mut zpl = ZPL.lock();
        let znode = zpl
            .get_znode_mut(object_id)
            .ok_or(StreamError::FileNotFound(object_id))?;

        let start = offset as usize;
        let end = start + data.len();

        // Extend cache if needed
        if znode.data_cache.is_none() {
            znode.data_cache = Some(Vec::new());
        }

        if let Some(ref mut cache) = znode.data_cache {
            if cache.len() < end {
                cache.resize(end, 0);
            }
            cache[start..end].copy_from_slice(data);

            // Update file size
            znode.phys.size = cache.len() as u64;
            znode.phys.mtime[0] = crate::time::now();
            znode.dirty = true;
        }

        return Ok(data.len());
    }

    // Alternate stream write to registry
    let mut registry = STREAM_REGISTRY.lock();
    let key = (object_id, stream_name.to_string());

    let stream_data = registry
        .get_mut(&key)
        .ok_or_else(|| StreamError::StreamNotFound(stream_name.to_string()))?;

    let start = offset as usize;
    let end = start + data.len();

    // Extend stream data if needed
    if stream_data.data.len() < end {
        stream_data.data.resize(end, 0);
    }

    stream_data.data[start..end].copy_from_slice(data);
    stream_data.info.size = stream_data.data.len() as u64;
    stream_data.info.allocated_size = stream_data.info.size;
    stream_data.info.modified = crate::time::now();

    Ok(data.len())
}

/// Truncate a stream to the specified length.
pub fn truncate_stream(
    dataset: &str,
    object_id: u64,
    stream_name: &str,
    length: u64,
) -> Result<(), StreamError> {
    let _ = dataset;

    // Primary stream truncate
    if stream_name.is_empty() {
        let mut zpl = ZPL.lock();
        let znode = zpl
            .get_znode_mut(object_id)
            .ok_or(StreamError::FileNotFound(object_id))?;

        if let Some(ref mut cache) = znode.data_cache {
            cache.truncate(length as usize);
        }

        znode.phys.size = length;
        znode.phys.mtime[0] = crate::time::now();
        znode.dirty = true;

        return Ok(());
    }

    // Alternate stream truncate
    let mut registry = STREAM_REGISTRY.lock();
    let key = (object_id, stream_name.to_string());

    let stream_data = registry
        .get_mut(&key)
        .ok_or_else(|| StreamError::StreamNotFound(stream_name.to_string()))?;

    stream_data.data.truncate(length as usize);
    stream_data.info.size = stream_data.data.len() as u64;
    stream_data.info.allocated_size = stream_data.info.size;
    stream_data.info.modified = crate::time::now();

    Ok(())
}

/// Rename an alternate stream.
pub fn rename_stream(
    dataset: &str,
    object_id: u64,
    old_name: &str,
    new_name: &str,
) -> Result<(), StreamError> {
    let _ = dataset;

    // Cannot rename primary stream
    if old_name.is_empty() {
        return Err(StreamError::CannotDeletePrimary);
    }

    // Validate new name
    validate_stream_name(new_name)?;

    let mut registry = STREAM_REGISTRY.lock();
    let old_key = (object_id, old_name.to_string());
    let new_key = (object_id, new_name.to_string());

    // Check source exists
    if !registry.contains_key(&old_key) {
        return Err(StreamError::StreamNotFound(old_name.to_string()));
    }

    // Check destination doesn't exist
    if registry.contains_key(&new_key) {
        return Err(StreamError::StreamExists(new_name.to_string()));
    }

    // Move the stream data
    if let Some(mut stream_data) = registry.remove(&old_key) {
        stream_data.info.name = new_name.to_string();
        stream_data.info.modified = crate::time::now();
        registry.insert(new_key, stream_data);
    }

    Ok(())
}

/// Copy a stream from one file to another.
///
/// Copies both the data and metadata of the stream.
pub fn copy_stream(
    src_dataset: &str,
    src_id: u64,
    src_stream: &str,
    dst_dataset: &str,
    dst_id: u64,
    dst_stream: &str,
) -> Result<u64, StreamError> {
    // Get source stream info and data
    let src_info = get_stream_info(src_dataset, src_id, src_stream)?;
    let src_data = read_stream(src_dataset, src_id, src_stream, 0, src_info.size as usize)?;

    // Create destination stream if needed (for non-primary streams)
    if !dst_stream.is_empty() && !stream_exists(dst_dataset, dst_id, dst_stream)? {
        create_stream(dst_dataset, dst_id, dst_stream, src_info.stream_type)?;
    }

    // Write data to destination
    let written = write_stream(dst_dataset, dst_id, dst_stream, 0, &src_data)?;

    Ok(written as u64)
}

/// Get total size of all streams for a file.
pub fn get_total_stream_size(dataset: &str, object_id: u64) -> Result<u64, StreamError> {
    let streams = list_streams(dataset, object_id)?;
    Ok(streams.iter().map(|s| s.size).sum())
}

/// Delete all streams when a file is deleted.
///
/// This should be called when the parent file is removed to clean up
/// orphaned alternate streams.
pub fn cleanup_file_streams(object_id: u64) {
    let mut registry = STREAM_REGISTRY.lock();

    // Collect keys to remove (can't modify while iterating)
    let keys_to_remove: Vec<_> = registry
        .keys()
        .filter(|(oid, _)| *oid == object_id)
        .cloned()
        .collect();

    for key in keys_to_remove {
        registry.remove(&key);
    }
}

/// Parse a path with stream component
pub fn parse_stream_path(path: &str) -> ParsedStreamPath {
    // Split on colon, but handle Windows drive letters
    let (file_path, stream_part) = if path.len() > 2 && path.as_bytes()[1] == b':' {
        // Windows path with drive letter (e.g., "C:\file.txt:stream")
        let rest = &path[2..];
        if let Some(colon_pos) = rest.find(':') {
            let file = &path[..colon_pos + 2];
            let stream = &rest[colon_pos + 1..];
            (file, Some(stream))
        } else {
            (path, None)
        }
    } else if let Some(colon_pos) = path.find(':') {
        (&path[..colon_pos], Some(&path[colon_pos + 1..]))
    } else {
        (path, None)
    };

    // Parse stream type if specified (e.g., "stream_name:$DATA")
    let (stream_name, stream_type) = if let Some(stream) = stream_part {
        if let Some(type_pos) = stream.rfind(':') {
            let name = &stream[..type_pos];
            let type_str = &stream[type_pos + 1..];
            let stype = match type_str.to_uppercase().as_str() {
                "$DATA" => Some(StreamType::Data),
                "$EA" => Some(StreamType::ExtendedAttribute),
                _ => None,
            };
            (Some(name.to_string()), stype)
        } else {
            (Some(stream.to_string()), None)
        }
    } else {
        (None, None)
    };

    ParsedStreamPath {
        file_path: file_path.to_string(),
        stream_name,
        stream_type,
    }
}

/// Build a path with stream component
pub fn build_stream_path(file_path: &str, stream_name: &str) -> String {
    if stream_name.is_empty() {
        file_path.to_string()
    } else {
        alloc::format!("{}:{}", file_path, stream_name)
    }
}

/// Copy all streams from one file to another
pub fn copy_all_streams(
    src_dataset: &str,
    src_id: u64,
    dst_dataset: &str,
    dst_id: u64,
    include_primary: bool,
) -> Result<u64, StreamError> {
    let streams = list_streams(src_dataset, src_id)?;
    let mut total_copied = 0u64;

    for stream in streams {
        // Skip primary stream if not requested
        if stream.is_primary && !include_primary {
            continue;
        }

        let copied = copy_stream(
            src_dataset,
            src_id,
            &stream.name,
            dst_dataset,
            dst_id,
            &stream.name,
        )?;

        total_copied += copied;
    }

    Ok(total_copied)
}

/// Delete all alternate streams (preserves primary)
pub fn delete_all_streams(dataset: &str, object_id: u64) -> Result<u64, StreamError> {
    let streams = list_streams(dataset, object_id)?;
    let mut deleted = 0u64;

    for stream in streams {
        if !stream.is_primary {
            delete_stream(dataset, object_id, &stream.name)?;
            deleted += 1;
        }
    }

    Ok(deleted)
}

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

    #[test]
    fn test_parse_stream_path_simple() {
        let parsed = parse_stream_path("/data/file.txt:metadata");
        assert_eq!(parsed.file_path, "/data/file.txt");
        assert_eq!(parsed.stream_name.as_deref(), Some("metadata"));
    }

    #[test]
    fn test_parse_stream_path_no_stream() {
        let parsed = parse_stream_path("/data/file.txt");
        assert_eq!(parsed.file_path, "/data/file.txt");
        assert!(parsed.stream_name.is_none());
    }

    #[test]
    fn test_parse_stream_path_windows() {
        let parsed = parse_stream_path("C:\\data\\file.txt:metadata");
        assert_eq!(parsed.file_path, "C:\\data\\file.txt");
        assert_eq!(parsed.stream_name.as_deref(), Some("metadata"));
    }

    #[test]
    fn test_build_stream_path() {
        assert_eq!(
            build_stream_path("/data/file.txt", "metadata"),
            "/data/file.txt:metadata"
        );
        assert_eq!(build_stream_path("/data/file.txt", ""), "/data/file.txt");
    }

    #[test]
    fn test_list_streams() {
        // Use root directory (ID 2) which is always present in ZPL
        let zpl = crate::storage::zpl::ZPL.lock();
        let root_id = zpl.root_id();
        drop(zpl);

        let streams = list_streams("test", root_id).unwrap();
        assert!(!streams.is_empty());
        assert!(streams[0].is_primary);
    }
}