btrfs-cli 0.13.0

User-space command-line tool for inspecting and managing Btrfs filesystems
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

use crate::{
    RunContext, Runnable,
    util::{format_time_short, open_path},
};
use anyhow::{Context, Result};
use btrfs_uapi::replace::{ReplaceState, replace_status};
use clap::Parser;
use std::{
    io::Write, os::unix::io::AsFd, path::PathBuf, thread, time::Duration,
};

/// Print status of a running device replace operation.
///
/// Without -1 the status is printed continuously until the replace operation
/// finishes or is cancelled. With -1 the status is printed once and the
/// command exits.
#[derive(Parser, Debug)]
pub struct ReplaceStatusCommand {
    /// Print once instead of continuously until the replace finishes
    #[clap(short = '1', long)]
    pub once: bool,

    /// Path to a mounted btrfs filesystem
    pub mount_point: PathBuf,
}

impl Runnable for ReplaceStatusCommand {
    #[allow(clippy::cast_precision_loss)]
    fn run(&self, _ctx: &RunContext) -> Result<()> {
        let file = open_path(&self.mount_point)?;
        let fd = file.as_fd();

        loop {
            let status = replace_status(fd).with_context(|| {
                format!(
                    "failed to get replace status on '{}'",
                    self.mount_point.display()
                )
            })?;

            let line = match status.state {
                ReplaceState::NeverStarted => "Never started".to_string(),
                ReplaceState::Started => {
                    let pct = status.progress_1000 as f64 / 10.0;
                    format!(
                        "{pct:.1}% done, {} write errs, {} uncorr. read errs",
                        status.num_write_errors,
                        status.num_uncorrectable_read_errors,
                    )
                }
                ReplaceState::Finished => {
                    let started = status
                        .time_started
                        .map(|t| format_time_short(&t))
                        .unwrap_or_default();
                    let stopped = status
                        .time_stopped
                        .map(|t| format_time_short(&t))
                        .unwrap_or_default();
                    format!(
                        "Started on {started}, finished on {stopped}, \
                         {} write errs, {} uncorr. read errs",
                        status.num_write_errors,
                        status.num_uncorrectable_read_errors,
                    )
                }
                ReplaceState::Canceled => {
                    let started = status
                        .time_started
                        .map(|t| format_time_short(&t))
                        .unwrap_or_default();
                    let stopped = status
                        .time_stopped
                        .map(|t| format_time_short(&t))
                        .unwrap_or_default();
                    let pct = status.progress_1000 as f64 / 10.0;
                    format!(
                        "Started on {started}, canceled on {stopped} at {pct:.1}%, \
                         {} write errs, {} uncorr. read errs",
                        status.num_write_errors,
                        status.num_uncorrectable_read_errors,
                    )
                }
                ReplaceState::Suspended => {
                    let started = status
                        .time_started
                        .map(|t| format_time_short(&t))
                        .unwrap_or_default();
                    let stopped = status
                        .time_stopped
                        .map(|t| format_time_short(&t))
                        .unwrap_or_default();
                    let pct = status.progress_1000 as f64 / 10.0;
                    format!(
                        "Started on {started}, suspended on {stopped} at {pct:.1}%, \
                         {} write errs, {} uncorr. read errs",
                        status.num_write_errors,
                        status.num_uncorrectable_read_errors,
                    )
                }
            };

            print!("\r{line}");
            std::io::stdout().flush()?;

            // Terminal states or one-shot mode: print newline and exit.
            if self.once || status.state != ReplaceState::Started {
                println!();
                break;
            }

            thread::sleep(Duration::from_secs(1));
        }

        Ok(())
    }
}