byssus 0.1.0

Live, read-only filesystem attachments between isolated workspaces
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
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
//! Reconciliation of desired membership against state and the kernel.
//!
//! A pass is: [`observe`] → [`plan`] → report findings → [`execute`].

pub mod execute;
pub mod observe;
pub mod plan;

use std::collections::{BTreeMap, BTreeSet};
use std::fmt;

use crate::name::GroupId;
use crate::runtime::Runtime;
use crate::state::State;

use self::execute::{Execution, Executor, StateSink};
use self::observe::{Note, Observed};
use self::plan::{ConflictKind, Finding, Plan, PlanInput};

/// Why a reconciliation pass is running.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Trigger {
    /// Daemon startup.
    Startup,
    /// A membership directory changed.
    Inotify,
    /// Periodic resynchronization.
    Resync,
    /// Configuration reload.
    Reload,
    /// `byssus reconcile`.
    Cli,
}

impl fmt::Display for Trigger {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(match self {
            Self::Startup => "startup",
            Self::Inotify => "inotify",
            Self::Resync => "resync",
            Self::Reload => "reload",
            Self::Cli => "cli",
        })
    }
}

/// The outcome of a pass.
#[derive(Debug)]
pub struct Pass {
    /// What was observed.
    pub observed: Observed,
    /// What was planned.
    pub plan: Plan,
    /// What happened.
    pub execution: Execution,
}

/// Groups and group sets whose records must be left untouched (for example
/// because their membership directory was lost).
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct Degraded {
    /// Degraded groups.
    pub groups: BTreeSet<GroupId>,
    /// Degraded group sets.
    pub sets: BTreeSet<crate::name::Name>,
}

impl Degraded {
    /// Whether nothing is degraded.
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.groups.is_empty() && self.sets.is_empty()
    }
}

/// Discovers group sets' groups, then observes every group.
///
/// `after_discovery` runs between the two steps, so the daemon can watch newly
/// discovered group directories before their membership is read and no change
/// is missed.
pub fn discover_and_observe(
    runtime: &mut Runtime,
    state: &State,
    degraded: &Degraded,
    unique_supported: bool,
    after_discovery: &mut dyn FnMut(&Runtime),
) -> Observed {
    let discovery = runtime.discover(&degraded.sets);
    after_discovery(runtime);

    let mut frozen_sets = degraded.sets.clone();
    frozen_sets.extend(discovery.unavailable_sets.iter().cloned());
    let mut frozen = degraded.groups.clone();
    frozen.extend(discovery.unavailable.iter().cloned());
    frozen.extend(
        state
            .records()
            .filter(|r| {
                r.group.set().is_some_and(|set| frozen_sets.contains(set))
                    || discovery
                        .unavailable
                        .iter()
                        .any(|prefix| r.group.starts_with(prefix))
            })
            .map(|r| r.group.clone()),
    );

    let mut observed = observe::observe(runtime, state, &frozen, unique_supported);
    let mut notes = discovery.notes;
    notes.append(&mut observed.notes);
    observed.notes = notes;
    observed.scanned_sets = discovery.scanned_sets;
    observed
}

/// Settings for one reconciliation pass.
#[derive(Debug, Clone, Copy)]
pub struct PassOptions<'a> {
    /// Groups and sets whose records must be left untouched.
    pub degraded: &'a Degraded,
    /// Whether unique mount IDs are available.
    pub unique_supported: bool,
    /// Why the pass is running.
    pub trigger: Trigger,
}

/// Observes, plans, logs findings and executes one reconciliation pass.
///
/// `notes` remembers which observation notes were already logged, so a
/// persistent problem (such as a rejected membership file) is logged once
/// rather than on every pass.
pub fn run_pass<S: StateSink>(
    runtime: &mut Runtime,
    state: &mut State,
    sink: &S,
    options: PassOptions<'_>,
    notes: &mut NoteLog,
    after_discovery: &mut dyn FnMut(&Runtime),
) -> Pass {
    let PassOptions {
        degraded,
        unique_supported,
        trigger,
    } = options;
    let observed =
        discover_and_observe(runtime, state, degraded, unique_supported, after_discovery);
    notes.report(&observed, trigger);
    let plan = plan::plan(PlanInput {
        desired: &observed.desired,
        state,
        frozen_groups: &observed.frozen,
        observations: &observed.observations,
    });
    log_findings(&plan.findings, trigger);
    let execution = Executor {
        runtime,
        state,
        sink,
        unique_supported,
        trigger,
    }
    .execute(&plan);
    Pass {
        observed,
        plan,
        execution,
    }
}

/// A change in the set of active observation notes.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum NoteEvent<'a> {
    /// A note that is new, or whose detail changed.
    Raised(&'a Note),
    /// A previously reported note no longer applies.
    Cleared {
        /// Group.
        group: String,
        /// Entry name, or empty for a group-level note.
        subject: String,
    },
}

/// Tracks reported observation notes across passes so each is logged once.
#[derive(Debug, Default)]
pub struct NoteLog {
    active: BTreeMap<(String, String), String>,
}

fn note_identity(note: &Note) -> ((String, String), String) {
    match note {
        Note::Rejected { group, rejection } => (
            (group.to_string(), rejection.display_name.clone()),
            rejection.reason.to_string(),
        ),
        Note::InterpolationFailed {
            group,
            name,
            field,
            error,
        } => (
            (group.to_string(), name.to_string()),
            format!("{field} template: {error}"),
        ),
        Note::MembershipDeleted { group } => ((group.to_string(), String::new()), "deleted".into()),
        Note::MembershipUnreadable { group, error } => {
            ((group.to_string(), String::new()), error.clone())
        }
        Note::SetEntryRejected { set, rejection } => (
            (set_label(set), rejection.display_name.clone()),
            rejection.reason.to_string(),
        ),
        Note::SetRootDeleted { set } => ((set_label(set), String::new()), "deleted".into()),
        Note::SetRootUnreadable { set, error } => ((set_label(set), String::new()), error.clone()),
    }
}

/// How a group set is named in logs and reports: `research/*`.
#[must_use]
pub fn set_label(set: &crate::name::Name) -> String {
    format!("{set}/*")
}

impl NoteLog {
    /// Updates the active set from a pass and returns what changed. Notes of
    /// groups that were not examined in this pass are left as they were.
    pub fn update<'a>(&mut self, observed: &'a Observed) -> Vec<NoteEvent<'a>> {
        let mut events = Vec::new();
        let mut current = BTreeMap::new();
        let mut examined: BTreeSet<String> =
            observed.members.keys().map(ToString::to_string).collect();
        examined.extend(observed.scanned_sets.iter().map(set_label));
        for note in &observed.notes {
            let (key, detail) = note_identity(note);
            examined.insert(key.0.clone());
            if self.active.get(&key) != Some(&detail) {
                events.push(NoteEvent::Raised(note));
            }
            current.insert(key, detail);
        }
        for (key, detail) in std::mem::take(&mut self.active) {
            if current.contains_key(&key) {
                continue;
            }
            if examined.contains(&key.0) {
                events.push(NoteEvent::Cleared {
                    group: key.0,
                    subject: key.1,
                });
            } else {
                current.insert(key, detail);
            }
        }
        self.active = current;
        events
    }

    /// Updates the active set and logs the changes, plus ignored hidden
    /// entries at debug level.
    pub fn report(&mut self, observed: &Observed, trigger: Trigger) {
        for event in self.update(observed) {
            match event {
                NoteEvent::Raised(note) => log_note(note, trigger),
                NoteEvent::Cleared { group, subject } if subject.is_empty() => tracing::info!(
                    op = "scan",
                    group = %group,
                    trigger = %trigger,
                    result = "ok",
                    msg = "membership directory readable again",
                ),
                NoteEvent::Cleared { group, subject } => tracing::info!(
                    op = "reject_cleared",
                    group = %group,
                    name = %subject,
                    trigger = %trigger,
                    msg = "membership entry is no longer rejected",
                ),
            }
        }
        for (group, names) in &observed.ignored {
            tracing::debug!(
                op = "ignore",
                group = %group,
                trigger = %trigger,
                count = names.len(),
                names = %names.join(","),
                msg = "hidden membership entries ignored",
            );
        }
    }
}

fn log_note(note: &Note, trigger: Trigger) {
    match note {
        Note::SetEntryRejected { set, rejection } => tracing::warn!(
            op = "reject",
            group = %set_label(set),
            name = %rejection.display_name,
            trigger = %trigger,
            reason = %rejection.reason,
        ),
        Note::SetRootDeleted { set } => tracing::error!(
            op = "degrade",
            group = %set_label(set),
            trigger = %trigger,
            msg = "group set membership root has been deleted; keeping existing mounts and making no changes to this set until configuration is reloaded",
        ),
        Note::SetRootUnreadable { set, error } => tracing::error!(
            op = "scan",
            group = %set_label(set),
            trigger = %trigger,
            result = "failed",
            error = %error,
            msg = "group set membership root unreadable; set left unchanged",
        ),
        Note::Rejected { group, rejection } => tracing::warn!(
            op = "reject",
            group = %group,
            name = %rejection.display_name,
            trigger = %trigger,
            reason = %rejection.reason,
        ),
        Note::InterpolationFailed {
            group,
            name,
            field,
            error,
        } => tracing::warn!(
            op = "reject",
            group = %group,
            name = %name,
            trigger = %trigger,
            reason = %format!("{field} template: {error}"),
        ),
        Note::MembershipDeleted { group } => tracing::error!(
            op = "degrade",
            group = %group,
            trigger = %trigger,
            msg = "membership directory has been deleted; keeping existing mounts and making no changes to this group until configuration is reloaded",
        ),
        Note::MembershipUnreadable { group, error } => tracing::error!(
            op = "scan",
            group = %group,
            trigger = %trigger,
            result = "failed",
            error = %error,
            msg = "membership directory unreadable; group left unchanged",
        ),
    }
}

/// Logs planning findings.
pub fn log_findings(findings: &[Finding], trigger: Trigger) {
    for finding in findings {
        match finding {
            Finding::Conflict { key, target, kind } => tracing::warn!(
                op = "conflict",
                group = %key.group,
                name = %key.name,
                target = %target,
                trigger = %trigger,
                reason = match kind {
                    ConflictKind::ForeignMount =>
                        "mount present at target but not recorded in state; not touching foreign mount",
                    ConflictKind::TargetReplaced =>
                        "mount at target is not the recorded mount; not touching it",
                },
            ),
            Finding::SourceUnavailable {
                key,
                source,
                reason,
            } => tracing::warn!(
                op = "skip",
                group = %key.group,
                name = %key.name,
                source = %source,
                trigger = %trigger,
                reason = %reason,
            ),
            Finding::TargetUnavailable {
                key,
                target,
                reason,
            } => tracing::warn!(
                op = "skip",
                group = %key.group,
                name = %key.name,
                target = %target,
                trigger = %trigger,
                reason = %format!("target cannot be inspected: {reason}"),
            ),
            Finding::TargetCollision {
                target,
                members,
                kept,
            } => tracing::warn!(
                op = "conflict",
                target = %target,
                trigger = %trigger,
                members = %members.iter().map(ToString::to_string).collect::<Vec<_>>().join(","),
                kept = %kept.as_ref().map_or_else(|| "none".to_owned(), ToString::to_string),
                reason = "several members resolve to the same target",
            ),
            Finding::RelocationBlocked { key, old_target } => tracing::warn!(
                op = "skip",
                group = %key.group,
                name = %key.name,
                target = %old_target,
                trigger = %trigger,
                reason = "member moved but its existing mount cannot be verified; not relocating",
            ),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::membership::{EntryKind, RejectReason, Rejection};

    fn name(s: &str) -> GroupId {
        GroupId::parse(s).unwrap()
    }

    fn rejected(group: &str, entry: &str, reason: RejectReason) -> Note {
        Note::Rejected {
            group: name(group),
            rejection: Rejection {
                display_name: entry.into(),
                reason,
            },
        }
    }

    fn observed(scanned: &[&str], notes: Vec<Note>) -> Observed {
        Observed {
            members: scanned.iter().map(|g| (name(g), BTreeSet::new())).collect(),
            notes,
            ..Observed::default()
        }
    }

    fn summarize(events: &[NoteEvent<'_>]) -> Vec<String> {
        events
            .iter()
            .map(|e| match e {
                NoteEvent::Raised(n) => format!("raised {}", note_identity(n).0.1),
                NoteEvent::Cleared { subject, .. } => format!("cleared {subject}"),
            })
            .collect()
    }

    #[test]
    fn persistent_notes_are_reported_once() {
        let mut log = NoteLog::default();
        let symlink = || {
            rejected(
                "g",
                "link",
                RejectReason::NotRegularFile(EntryKind::Symlink),
            )
        };

        let first = observed(&["g"], vec![symlink()]);
        assert_eq!(summarize(&log.update(&first)), ["raised link"]);
        let again = observed(&["g"], vec![symlink()]);
        assert!(log.update(&again).is_empty());

        // A changed reason is reported again.
        let changed = observed(
            &["g"],
            vec![rejected("g", "link", RejectReason::NotEmpty(3))],
        );
        assert_eq!(summarize(&log.update(&changed)), ["raised link"]);

        // Fixed: reported as cleared once.
        let fixed = observed(&["g"], vec![]);
        assert_eq!(summarize(&log.update(&fixed)), ["cleared link"]);
        assert!(log.update(&observed(&["g"], vec![])).is_empty());
    }

    #[test]
    fn unexamined_groups_keep_their_notes() {
        let mut log = NoteLog::default();
        let unreadable = || Note::MembershipUnreadable {
            group: name("g"),
            error: "EACCES".into(),
        };
        assert_eq!(log.update(&observed(&[], vec![unreadable()])).len(), 1);
        assert!(log.update(&observed(&[], vec![unreadable()])).is_empty());
        // Group not examined at all (e.g. degraded): nothing cleared.
        assert!(log.update(&observed(&[], vec![])).is_empty());
        // Scanned successfully again: cleared.
        assert_eq!(
            summarize(&log.update(&observed(&["g"], vec![]))),
            ["cleared "]
        );
    }

    #[test]
    fn set_entry_rejections_clear_when_the_set_is_rescanned() {
        let mut log = NoteLog::default();
        let set = crate::name::Name::new("research").unwrap();
        let rejected = Note::SetEntryRejected {
            set: set.clone(),
            rejection: Rejection {
                display_name: "file".into(),
                reason: RejectReason::NotDirectory(EntryKind::Regular { size: 0 }),
            },
        };
        let mut with = observed(&[], vec![rejected]);
        with.scanned_sets.insert(set.clone());
        assert_eq!(summarize(&log.update(&with)), ["raised file"]);
        let mut without = observed(&[], vec![]);
        without.scanned_sets.insert(set);
        assert_eq!(summarize(&log.update(&without)), ["cleared file"]);
    }
}