btrfs-cli 0.13.0

use super::{filters::parse_filters, open_path};
use crate::{RunContext, Runnable};
use anyhow::{Context, Result};
use btrfs_uapi::balance::{BalanceFlags, balance};
use clap::Parser;
use nix::errno::Errno;
use std::{os::unix::io::AsFd, path::PathBuf, thread, time::Duration};

type Filters = String;

/// Balance chunks across the devices
///
/// Balance and/or convert (change allocation profile of) chunks that
/// passed all filters in a comma-separated list of filters for a
/// particular chunk type.  If filter list is not given balance all
/// chunks of that type.  In case none of the -d, -m or -s options is
/// given balance all chunks in a filesystem. This is potentially
/// long operation and the user is warned before this start, with
/// a delay to stop it.
#[derive(Parser, Debug)]
#[allow(clippy::struct_excessive_bools)]
pub struct BalanceStartCommand {
    /// Act on data chunks with optional filters
    #[clap(long, short)]
    pub data_filters: Option<Filters>,
    /// Act on metadata chunks with optional filters
    #[clap(long, short)]
    pub metadata_filters: Option<Filters>,
    /// Act on system chunks (requires force) with optional filters
    #[clap(long, short, requires = "force")]
    pub system_filters: Option<Filters>,

    /// Force a reduction of metadata integrity, or skip timeout when converting to RAID56 profiles
    #[clap(long, short)]
    pub force: bool,

    /// Do not print warning and do not delay start
    #[clap(long)]
    pub full_balance: bool,

    /// Run the balance as a background process
    #[clap(long, short, alias = "bg")]
    pub background: bool,

    /// Wait if there's another exclusive operation running, otherwise continue
    #[clap(long)]
    pub enqueue: bool,

    pub path: PathBuf,
}

impl Runnable for BalanceStartCommand {
    fn run(&self, _ctx: &RunContext) -> Result<()> {
        // TODO: background mode (requires daemonizing the process)
        if self.background {
            anyhow::bail!("--background is not yet implemented");
        }

        let has_filters = self.data_filters.is_some()
            || self.metadata_filters.is_some()
            || self.system_filters.is_some();

        let mut flags = BalanceFlags::empty();

        let data_args = match &self.data_filters {
            Some(f) => {
                flags |= BalanceFlags::DATA;
                Some(parse_filters(f).context("invalid data filter")?)
            }
            None => None,
        };

        // When metadata is balanced, system is always included with the same
        // args, matching the behaviour of the C tool.
        let meta_args = match &self.metadata_filters {
            Some(f) => {
                flags |= BalanceFlags::METADATA | BalanceFlags::SYSTEM;
                Some(parse_filters(f).context("invalid metadata filter")?)
            }
            None => None,
        };

        // System args: explicitly requested, OR copied from meta if meta was
        // given but system was not explicitly specified (see C reference).
        let sys_args = match &self.system_filters {
            Some(f) => {
                flags |= BalanceFlags::SYSTEM;
                Some(parse_filters(f).context("invalid system filter")?)
            }
            None => meta_args.clone(),
        };

        if !has_filters {
            // No type filters specified — relocate everything.
            flags |= BalanceFlags::DATA
                | BalanceFlags::METADATA
                | BalanceFlags::SYSTEM;
        }

        if self.force {
            flags |= BalanceFlags::FORCE;
        }

        // Warn the user about a full (unfiltered) balance and give them a
        // chance to abort, unless --full-balance was passed.
        if !has_filters && !self.full_balance {
            eprintln!("WARNING:\n");
            eprintln!(
                "\tFull balance without filters requested. This operation is very"
            );
            eprintln!(
                "\tintense and takes potentially very long. It is recommended to"
            );
            eprintln!(
                "\tuse the balance filters to narrow down the scope of balance."
            );
            eprintln!(
                "\tUse 'btrfs balance start --full-balance' to skip this warning."
            );
            eprintln!(
                "\tThe operation will start in 10 seconds. Use Ctrl-C to stop it."
            );
            thread::sleep(Duration::from_secs(10));
            eprintln!("\nStarting balance without any filters.");
        }

        let file = open_path(&self.path)?;

        match balance(file.as_fd(), flags, data_args, meta_args, sys_args) {
            Ok(progress) => {
                println!(
                    "Done, had to relocate {} out of {} chunks",
                    progress.completed, progress.considered
                );
                Ok(())
            }
            Err(Errno::ECANCELED) => {
                // The kernel sets ECANCELED when the balance was paused or
                // cancelled mid-run; this is not an error from the user's
                // perspective.
                eprintln!("Balance was paused or cancelled by user.");
                Ok(())
            }
            Err(e) => Err(e).with_context(|| {
                format!("error during balancing '{}'", self.path.display())
            }),
        }
    }
}