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
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
// Copyright 2025 LunaOS Contributors
// SPDX-License-Identifier: Apache-2.0

//! Event emission and event log for filesystem notifications.
//!
//! This module handles emitting events and maintaining an event history.

use alloc::collections::VecDeque;
use alloc::string::{String, ToString};
use alloc::vec::Vec;

use lazy_static::lazy_static;
use spin::Mutex;

use super::types::{EventMask, EventType, FsEvent, NotifyError};
use super::watch::dispatch_to_watches;

// ═══════════════════════════════════════════════════════════════════════════════
// GLOBAL STATE
// ═══════════════════════════════════════════════════════════════════════════════

lazy_static! {
    /// Global event log.
    static ref EVENT_LOG: Mutex<EventLog> = Mutex::new(EventLog::new(10000));

    /// Pending events for polling.
    static ref PENDING_EVENTS: Mutex<VecDeque<FsEvent>> = Mutex::new(VecDeque::with_capacity(1000));

    /// Global event emission enabled flag.
    static ref EMIT_ENABLED: Mutex<bool> = Mutex::new(true);

    /// Debounce state.
    static ref DEBOUNCE_STATE: Mutex<DebounceState> = Mutex::new(DebounceState::new());
}

// ═══════════════════════════════════════════════════════════════════════════════
// EVENT LOG
// ═══════════════════════════════════════════════════════════════════════════════

/// Event log for maintaining event history.
pub struct EventLog {
    /// Stored events (circular buffer)
    events: VecDeque<FsEvent>,
    /// Maximum number of events to store
    max_size: usize,
    /// Total events received (may exceed max_size)
    total_events: u64,
    /// Events dropped due to overflow
    dropped_events: u64,
}

impl EventLog {
    /// Create a new event log with the given capacity.
    pub fn new(max_size: usize) -> Self {
        Self {
            events: VecDeque::with_capacity(max_size.min(10000)),
            max_size,
            total_events: 0,
            dropped_events: 0,
        }
    }

    /// Add an event to the log.
    pub fn push(&mut self, event: FsEvent) {
        self.total_events += 1;

        if self.events.len() >= self.max_size {
            self.events.pop_front();
            self.dropped_events += 1;
        }

        self.events.push_back(event);
    }

    /// Get the last N events.
    pub fn last(&self, n: usize) -> Vec<&FsEvent> {
        let start = self.events.len().saturating_sub(n);
        self.events.iter().skip(start).collect()
    }

    /// Get events since a given TXG.
    pub fn since_txg(&self, txg: u64) -> Vec<&FsEvent> {
        self.events.iter().filter(|e| e.txg > txg).collect()
    }

    /// Get events since a given timestamp.
    pub fn since_timestamp(&self, ts: u64) -> Vec<&FsEvent> {
        self.events.iter().filter(|e| e.timestamp > ts).collect()
    }

    /// Get events for a specific path.
    pub fn for_path(&self, dataset: &str, path: &str) -> Vec<&FsEvent> {
        self.events
            .iter()
            .filter(|e| e.dataset == dataset && e.path == path)
            .collect()
    }

    /// Get events matching a mask.
    pub fn matching(&self, mask: EventMask) -> Vec<&FsEvent> {
        self.events
            .iter()
            .filter(|e| mask.contains(e.event_type))
            .collect()
    }

    /// Get events in a path prefix.
    pub fn in_prefix(&self, dataset: &str, prefix: &str) -> Vec<&FsEvent> {
        self.events
            .iter()
            .filter(|e| e.dataset == dataset && e.path.starts_with(prefix))
            .collect()
    }

    /// Get statistics.
    pub fn stats(&self) -> EventLogStats {
        EventLogStats {
            stored_events: self.events.len(),
            max_size: self.max_size,
            total_events: self.total_events,
            dropped_events: self.dropped_events,
        }
    }

    /// Clear the log.
    pub fn clear(&mut self) {
        self.events.clear();
        // Keep stats
    }

    /// Set maximum size.
    pub fn set_max_size(&mut self, max_size: usize) {
        self.max_size = max_size;
        // Trim if necessary
        while self.events.len() > max_size {
            self.events.pop_front();
            self.dropped_events += 1;
        }
    }
}

/// Statistics about the event log.
#[derive(Debug, Clone)]
pub struct EventLogStats {
    /// Number of events currently stored
    pub stored_events: usize,
    /// Maximum capacity
    pub max_size: usize,
    /// Total events ever received
    pub total_events: u64,
    /// Events dropped due to overflow
    pub dropped_events: u64,
}

// ═══════════════════════════════════════════════════════════════════════════════
// DEBOUNCE STATE
// ═══════════════════════════════════════════════════════════════════════════════

/// State for event debouncing.
struct DebounceState {
    /// Last event per (dataset, path, event_type)
    last_events: hashbrown::HashMap<(String, String, EventType), u64>,
    /// Default debounce interval in microseconds
    default_interval_us: u64,
}

impl DebounceState {
    fn new() -> Self {
        Self {
            last_events: hashbrown::HashMap::new(),
            default_interval_us: 0, // No debouncing by default
        }
    }

    /// Check if an event should be debounced.
    fn should_debounce(&mut self, event: &FsEvent, interval_us: u64) -> bool {
        if interval_us == 0 {
            return false;
        }

        let key = (event.dataset.clone(), event.path.clone(), event.event_type);

        if let Some(&last_ts) = self.last_events.get(&key) {
            if event.timestamp.saturating_sub(last_ts) < interval_us {
                return true;
            }
        }

        self.last_events.insert(key, event.timestamp);
        false
    }

    /// Set default debounce interval.
    fn set_default_interval(&mut self, us: u64) {
        self.default_interval_us = us;
    }

    /// Clear debounce state.
    fn clear(&mut self) {
        self.last_events.clear();
    }
}

// ═══════════════════════════════════════════════════════════════════════════════
// EVENT EMISSION
// ═══════════════════════════════════════════════════════════════════════════════

/// Emit a filesystem event.
///
/// This is the main entry point for event emission. It:
/// 1. Logs the event to the history
/// 2. Dispatches to matching watches (callbacks)
/// 3. Adds to pending queue for polling
pub fn emit_event(event: FsEvent) {
    emit_event_with_debounce(event, 0)
}

/// Emit an event with debouncing.
pub fn emit_event_with_debounce(event: FsEvent, debounce_us: u64) {
    // Check if emission is enabled
    {
        let enabled = EMIT_ENABLED.lock();
        if !*enabled {
            return;
        }
    }

    // Check debouncing
    {
        let mut debounce = DEBOUNCE_STATE.lock();
        let interval = if debounce_us > 0 {
            debounce_us
        } else {
            debounce.default_interval_us
        };

        if debounce.should_debounce(&event, interval) {
            return;
        }
    }

    // Log the event
    {
        let mut log = EVENT_LOG.lock();
        log.push(event.clone());
    }

    // Add to pending queue
    {
        let mut pending = PENDING_EVENTS.lock();
        if pending.len() < 10000 {
            // Cap pending queue
            pending.push_back(event.clone());
        }
    }

    // Dispatch to watches
    dispatch_to_watches(&event);
}

/// Enable or disable event emission.
pub fn set_emit_enabled(enabled: bool) {
    let mut flag = EMIT_ENABLED.lock();
    *flag = enabled;
}

/// Check if emission is enabled.
pub fn is_emit_enabled() -> bool {
    let flag = EMIT_ENABLED.lock();
    *flag
}

/// Set the default debounce interval.
pub fn set_debounce_interval(us: u64) {
    let mut debounce = DEBOUNCE_STATE.lock();
    debounce.set_default_interval(us);
}

// ═══════════════════════════════════════════════════════════════════════════════
// POLLING
// ═══════════════════════════════════════════════════════════════════════════════

/// Poll for pending events (non-blocking).
///
/// Returns events and clears the pending queue.
pub fn poll_events() -> Vec<FsEvent> {
    let mut pending = PENDING_EVENTS.lock();
    pending.drain(..).collect()
}

/// Poll for a single event (non-blocking).
pub fn poll_event() -> Option<FsEvent> {
    let mut pending = PENDING_EVENTS.lock();
    pending.pop_front()
}

/// Get the number of pending events.
pub fn pending_count() -> usize {
    let pending = PENDING_EVENTS.lock();
    pending.len()
}

/// Clear pending events.
pub fn clear_pending() {
    let mut pending = PENDING_EVENTS.lock();
    pending.clear();
}

/// Wait for events with a simple spin loop.
///
/// This is a basic implementation. In a real kernel, this would use
/// proper wait queues and condition variables.
pub fn wait_for_events(timeout_us: u64) -> Result<Vec<FsEvent>, NotifyError> {
    // Simple polling implementation
    let _start = 0u64; // Would use actual timestamp
    let _check_interval = 1000u64; // 1ms

    // First check for events
    let events = poll_events();
    if !events.is_empty() {
        return Ok(events);
    }

    // Check timeout
    // In a real implementation, we'd use actual time
    if timeout_us == 0 {
        return Err(NotifyError::NoEvents);
    }

    // Spin wait (would be a proper sleep in real implementation)
    for _ in 0..1000 {
        core::hint::spin_loop();
    }

    // Poll again after wait
    let events = poll_events();
    if !events.is_empty() {
        return Ok(events);
    }

    Err(NotifyError::Timeout)
}

// ═══════════════════════════════════════════════════════════════════════════════
// EVENT LOG ACCESS
// ═══════════════════════════════════════════════════════════════════════════════

/// Get the last N events from the log.
pub fn get_last_events(n: usize) -> Vec<FsEvent> {
    let log = EVENT_LOG.lock();
    log.last(n).into_iter().cloned().collect()
}

/// Get events since a TXG.
pub fn get_events_since_txg(txg: u64) -> Vec<FsEvent> {
    let log = EVENT_LOG.lock();
    log.since_txg(txg).into_iter().cloned().collect()
}

/// Get events since a timestamp.
pub fn get_events_since_timestamp(ts: u64) -> Vec<FsEvent> {
    let log = EVENT_LOG.lock();
    log.since_timestamp(ts).into_iter().cloned().collect()
}

/// Get events for a specific path.
pub fn get_events_for_path(dataset: &str, path: &str) -> Vec<FsEvent> {
    let log = EVENT_LOG.lock();
    log.for_path(dataset, path).into_iter().cloned().collect()
}

/// Get event log statistics.
pub fn get_event_log_stats() -> EventLogStats {
    let log = EVENT_LOG.lock();
    log.stats()
}

/// Set the event log maximum size.
pub fn set_event_log_max_size(max_size: usize) {
    let mut log = EVENT_LOG.lock();
    log.set_max_size(max_size);
}

/// Clear the event log.
pub fn clear_event_log() {
    let mut log = EVENT_LOG.lock();
    log.clear();
}

// ═══════════════════════════════════════════════════════════════════════════════
// CONVENIENCE EMITTERS
// ═══════════════════════════════════════════════════════════════════════════════

/// Emit a file create event.
pub fn emit_create(dataset: &str, path: &str, object_id: u64, txg: u64) {
    emit_event(
        FsEvent::new(EventType::Create, dataset, path)
            .with_object_id(object_id)
            .with_txg(txg),
    );
}

/// Emit a file modify event.
pub fn emit_modify(dataset: &str, path: &str, object_id: u64, size: u64, txg: u64) {
    emit_event(
        FsEvent::new(EventType::Modify, dataset, path)
            .with_object_id(object_id)
            .with_size(size)
            .with_txg(txg),
    );
}

/// Emit a file delete event.
pub fn emit_delete(dataset: &str, path: &str, object_id: u64, txg: u64) {
    emit_event(
        FsEvent::new(EventType::Delete, dataset, path)
            .with_object_id(object_id)
            .with_txg(txg),
    );
}

/// Emit a file rename event.
pub fn emit_rename(dataset: &str, old_path: &str, new_path: &str, object_id: u64, txg: u64) {
    emit_event(
        FsEvent::new(EventType::Rename, dataset, new_path)
            .with_old_path(old_path)
            .with_object_id(object_id)
            .with_txg(txg),
    );
}

/// Emit a directory create event.
pub fn emit_dir_create(dataset: &str, path: &str, object_id: u64, txg: u64) {
    emit_event(
        FsEvent::new(EventType::DirCreate, dataset, path)
            .with_object_id(object_id)
            .with_txg(txg),
    );
}

/// Emit a directory delete event.
pub fn emit_dir_delete(dataset: &str, path: &str, object_id: u64, txg: u64) {
    emit_event(
        FsEvent::new(EventType::DirDelete, dataset, path)
            .with_object_id(object_id)
            .with_txg(txg),
    );
}

/// Emit an attribute change event.
pub fn emit_attrib(dataset: &str, path: &str, object_id: u64, txg: u64) {
    emit_event(
        FsEvent::new(EventType::Attrib, dataset, path)
            .with_object_id(object_id)
            .with_txg(txg),
    );
}

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

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

    fn setup() {
        // Clear state before each test
        clear_pending();
        clear_event_log();
        set_emit_enabled(true);
        set_debounce_interval(0);
    }

    #[test]
    fn test_event_log_push() {
        let mut log = EventLog::new(10);

        for i in 0..5 {
            log.push(FsEvent::new(
                EventType::Create,
                "tank",
                &alloc::format!("/file{}", i),
            ));
        }

        assert_eq!(log.events.len(), 5);
        assert_eq!(log.total_events, 5);
    }

    #[test]
    fn test_event_log_overflow() {
        let mut log = EventLog::new(3);

        for i in 0..5 {
            log.push(FsEvent::new(
                EventType::Create,
                "tank",
                &alloc::format!("/file{}", i),
            ));
        }

        assert_eq!(log.events.len(), 3);
        assert_eq!(log.total_events, 5);
        assert_eq!(log.dropped_events, 2);
    }

    #[test]
    fn test_event_log_last() {
        let mut log = EventLog::new(10);

        for i in 0..5 {
            log.push(
                FsEvent::new(EventType::Create, "tank", &alloc::format!("/file{}", i))
                    .with_txg(i as u64),
            );
        }

        let last = log.last(2);
        assert_eq!(last.len(), 2);
        assert_eq!(last[0].txg, 3);
        assert_eq!(last[1].txg, 4);
    }

    #[test]
    fn test_event_log_since_txg() {
        let mut log = EventLog::new(10);

        for i in 0..5 {
            log.push(
                FsEvent::new(EventType::Create, "tank", &alloc::format!("/file{}", i))
                    .with_txg(i as u64),
            );
        }

        let since = log.since_txg(2);
        assert_eq!(since.len(), 2); // txg 3 and 4
    }

    #[test]
    fn test_emit_event() {
        // Note: Tests run in parallel with shared global state.
        // Clear pending events and use unique dataset name.
        clear_pending();
        set_emit_enabled(true);
        set_debounce_interval(0);

        let unique_ds = "emit_event_test_unique_98765";
        emit_event(FsEvent::new(EventType::Create, unique_ds, "/file.txt"));

        // Verify at least 1 event was added
        assert!(
            pending_count() >= 1,
            "Expected at least 1 pending event after emit"
        );

        let events = poll_events();
        let our_events: Vec<_> = events.iter().filter(|e| e.dataset == unique_ds).collect();
        assert_eq!(
            our_events.len(),
            1,
            "Expected exactly 1 event for our dataset"
        );
        assert_eq!(our_events[0].event_type, EventType::Create);
        assert_eq!(our_events[0].path, "/file.txt");
    }

    #[test]
    fn test_emit_disabled() {
        setup();

        // Disable and emit with unique dataset
        set_emit_enabled(false);
        let ds = "emit_disabled_unique_67890";

        emit_event(FsEvent::new(EventType::Create, ds, "/file.txt"));

        // Re-enable first to allow pending poll to work
        set_emit_enabled(true);

        // Check our event is NOT in the queue
        let events = poll_events();
        let our_events: Vec<_> = events.into_iter().filter(|e| e.dataset == ds).collect();
        assert_eq!(
            our_events.len(),
            0,
            "Event should not have been emitted when disabled"
        );
    }

    #[test]
    fn test_convenience_emitters() {
        // Note: Tests run in parallel with shared global state.
        // Test that each convenience emitter function works by verifying
        // that emit is enabled and the functions don't panic.
        set_emit_enabled(true);
        set_debounce_interval(0);

        // Use a unique dataset to identify our events
        let ds = "conv_emit_isolated_xyzzy42";

        // Emit events (these may be interleaved with other test events)
        // The key assertion is that these functions don't panic
        emit_create(ds, "/conv_file1.txt", 1001, 88880001);
        emit_modify(ds, "/conv_file2.txt", 1002, 1024, 88880002);
        emit_delete(ds, "/conv_file3.txt", 1003, 88880003);
        emit_rename(ds, "/conv_old.txt", "/conv_new.txt", 1004, 88880004);

        // Check that we can find at least some of our events
        // (may be in pending or log depending on parallel test timing)
        let pending_count = {
            let pending = PENDING_EVENTS.lock();
            pending.iter().filter(|e| e.dataset == ds).count()
        };

        let logged_count = {
            let logged = EVENT_LOG.lock();
            logged.events.iter().filter(|e| e.dataset == ds).count()
        };

        // Combined check: our events should be somewhere in the system
        let total = pending_count + logged_count;
        assert!(
            total >= 1,
            "Expected at least 1 event in pending or log, found {} (pending={}, log={})",
            total,
            pending_count,
            logged_count
        );
    }

    #[test]
    fn test_debounce() {
        let mut state = DebounceState::new();

        let event1 = FsEvent::new(EventType::Modify, "tank", "/file.txt").with_timestamp(1000);

        // First event should not be debounced
        assert!(!state.should_debounce(&event1, 500));

        // Event within interval should be debounced
        let event2 = FsEvent::new(EventType::Modify, "tank", "/file.txt").with_timestamp(1200);
        assert!(state.should_debounce(&event2, 500));

        // Event after interval should not be debounced
        let event3 = FsEvent::new(EventType::Modify, "tank", "/file.txt").with_timestamp(1600);
        assert!(!state.should_debounce(&event3, 500));
    }

    #[test]
    fn test_poll_event() {
        setup();

        // Use unique dataset
        emit_event(FsEvent::new(EventType::Create, "poll_test", "/file1.txt"));
        emit_event(FsEvent::new(EventType::Create, "poll_test", "/file2.txt"));

        // Poll all events and filter to ours
        let events = poll_events();
        let our_events: Vec<_> = events
            .into_iter()
            .filter(|e| e.dataset == "poll_test")
            .collect();

        assert_eq!(our_events.len(), 2);
        assert_eq!(our_events[0].path, "/file1.txt");
        assert_eq!(our_events[1].path, "/file2.txt");
    }

    #[test]
    fn test_event_log_stats() {
        // Note: Tests run in parallel with shared global state.
        // We test relative changes rather than absolute counts.
        set_emit_enabled(true);
        set_debounce_interval(0);

        // Get baseline (don't clear - other tests may be running)
        let before_stats = get_event_log_stats();

        // Use unique source to identify our events
        let unique_source = "log_stats_test_unique";
        for i in 0..5 {
            emit_event(FsEvent::new(
                EventType::Create,
                unique_source,
                &alloc::format!("/file{}", i),
            ));
        }

        let stats = get_event_log_stats();
        // total_events should always increase (monotonic counter)
        assert!(
            stats.total_events >= before_stats.total_events + 5,
            "Expected at least {} total events, got {}",
            before_stats.total_events + 5,
            stats.total_events
        );
        // stored_events may be less than expected due to parallel clear calls,
        // but it should be non-zero
        assert!(
            stats.stored_events > 0,
            "Expected at least some stored events"
        );
    }
}