From 528654453971b9f4fb0886b32df7dfa14e169fd4 Mon Sep 17 00:00:00 2001 From: Daniel Hofstetter Date: Sun, 22 May 2022 16:54:51 +0200 Subject: [PATCH] df: fix rounding behavior in humanreadable mode Fixes #3422 --- Cargo.lock | 1 - src/uu/df/Cargo.toml | 1 - src/uu/df/src/blocks.rs | 205 ++++++++++++++++++++-------------------- src/uu/df/src/table.rs | 37 ++------ 4 files changed, 113 insertions(+), 131 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 5a978a6ba14..a5e05e5859e 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2245,7 +2245,6 @@ name = "uu_df" version = "0.0.13" dependencies = [ "clap 3.1.18", - "number_prefix", "unicode-width", "uucore", ] diff --git a/src/uu/df/Cargo.toml b/src/uu/df/Cargo.toml index 1020b71bb46..2f7bd244938 100644 --- a/src/uu/df/Cargo.toml +++ b/src/uu/df/Cargo.toml @@ -16,7 +16,6 @@ path = "src/df.rs" [dependencies] clap = { version = "3.1", features = ["wrap_help", "cargo"] } -number_prefix = "0.4" uucore = { version=">=0.0.11", package="uucore", path="../../uucore", features=["libc", "fsext"] } unicode-width = "0.1.9" diff --git a/src/uu/df/src/blocks.rs b/src/uu/df/src/blocks.rs index 88190b5c187..43b04aeb04f 100644 --- a/src/uu/df/src/blocks.rs +++ b/src/uu/df/src/blocks.rs @@ -26,9 +26,7 @@ const IEC_BASES: [u128; 10] = [ 1_237_940_039_285_380_274_899_124_224, ]; -/// Suffixes for the first nine multi-byte unit suffixes. -const SUFFIXES: [char; 9] = ['B', 'K', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y']; - +/// The first ten powers of 1000. const SI_BASES: [u128; 10] = [ 1, 1_000, @@ -42,84 +40,67 @@ const SI_BASES: [u128; 10] = [ 1_000_000_000_000_000_000_000_000_000, ]; -// we use "kB" instead of "KB" because of GNU df -const SI_SUFFIXES: [&str; 9] = ["B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"]; +/// A SuffixType determines whether the suffixes are 1000 or 1024 based, and whether they are +/// intended for HumanReadable mode or not. +pub(crate) enum SuffixType { + IEC, + SI, + HumanReadableIEC, + HumanReadableSI, +} -/// Convert a multiple of 1024 into a string like "12K" or "34M". -/// -/// # Examples -/// -/// Powers of 1024 become "1K", "1M", "1G", etc. -/// -/// ```rust,ignore -/// assert_eq!(to_magnitude_and_suffix_1024(1024).unwrap(), "1K"); -/// assert_eq!(to_magnitude_and_suffix_1024(1024 * 1024).unwrap(), "1M"); -/// assert_eq!(to_magnitude_and_suffix_1024(1024 * 1024 * 1024).unwrap(), "1G"); -/// ``` -/// -/// Multiples of those powers affect the magnitude part of the -/// returned string: -/// -/// ```rust,ignore -/// assert_eq!(to_magnitude_and_suffix_1024(123 * 1024).unwrap(), "123K"); -/// assert_eq!(to_magnitude_and_suffix_1024(456 * 1024 * 1024).unwrap(), "456M"); -/// assert_eq!(to_magnitude_and_suffix_1024(789 * 1024 * 1024 * 1024).unwrap(), "789G"); -/// ``` -fn to_magnitude_and_suffix_1024(n: u128) -> Result { - // Find the smallest power of 1024 that is larger than `n`. That - // number indicates which units and suffix to use. - for i in 0..IEC_BASES.len() - 1 { - if n < IEC_BASES[i + 1] { - return Ok(format!("{}{}", n / IEC_BASES[i], SUFFIXES[i])); +impl SuffixType { + /// The first ten powers of 1024 and 1000, respectively. + fn bases(&self) -> [u128; 10] { + match self { + Self::IEC | Self::HumanReadableIEC => IEC_BASES, + Self::SI | Self::HumanReadableSI => SI_BASES, + } + } + + /// Suffixes for the first nine multi-byte unit suffixes. + fn suffixes(&self) -> [&'static str; 9] { + match self { + // we use "kB" instead of "KB", same as GNU df + Self::SI => ["B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"], + Self::IEC => ["B", "K", "M", "G", "T", "P", "E", "Z", "Y"], + Self::HumanReadableSI => ["", "k", "M", "G", "T", "P", "E", "Z", "Y"], + Self::HumanReadableIEC => ["", "K", "M", "G", "T", "P", "E", "Z", "Y"], } } - Err(()) } -/// Convert a number into a string like "12kB" or "34MB". -/// -/// Powers of 1000 become "1kB", "1MB", "1GB", etc. +/// Convert a number into a magnitude and a multi-byte unit suffix. /// /// The returned string has a maximum length of 5 chars, for example: "1.1kB", "999kB", "1MB". -fn to_magnitude_and_suffix_not_powers_of_1024(n: u128) -> Result { +pub(crate) fn to_magnitude_and_suffix(n: u128, suffix_type: SuffixType) -> String { + let bases = suffix_type.bases(); + let suffixes = suffix_type.suffixes(); let mut i = 0; - while SI_BASES[i + 1] - SI_BASES[i] < n && i < SI_SUFFIXES.len() { + while bases[i + 1] - bases[i] < n && i < suffixes.len() { i += 1; } - let quot = n / SI_BASES[i]; - let rem = n % SI_BASES[i]; - let suffix = SI_SUFFIXES[i]; + let quot = n / bases[i]; + let rem = n % bases[i]; + let suffix = suffixes[i]; if rem == 0 { - Ok(format!("{}{}", quot, suffix)) + format!("{}{}", quot, suffix) } else { - let tenths_place = rem / (SI_BASES[i] / 10); + let tenths_place = rem / (bases[i] / 10); - if rem % (SI_BASES[i] / 10) == 0 { - Ok(format!("{}.{}{}", quot, tenths_place, suffix)) + if rem % (bases[i] / 10) == 0 { + format!("{}.{}{}", quot, tenths_place, suffix) } else if tenths_place + 1 == 10 || quot >= 10 { - Ok(format!("{}{}", quot + 1, suffix)) + format!("{}{}", quot + 1, suffix) } else { - Ok(format!("{}.{}{}", quot, tenths_place + 1, suffix)) + format!("{}.{}{}", quot, tenths_place + 1, suffix) } } } -/// Convert a number into a magnitude and a multi-byte unit suffix. -/// -/// # Errors -/// -/// If the number is too large to represent. -fn to_magnitude_and_suffix(n: u128) -> Result { - if n % 1024 == 0 && n % 1000 != 0 { - to_magnitude_and_suffix_1024(n) - } else { - to_magnitude_and_suffix_not_powers_of_1024(n) - } -} - /// A mode to use in condensing the display of a large number of bytes. pub(crate) enum SizeFormat { HumanReadable(HumanReadable), @@ -207,10 +188,15 @@ pub(crate) fn block_size_from_matches(matches: &ArgMatches) -> Result fmt::Result { match self { - Self::Bytes(n) => match to_magnitude_and_suffix(*n as u128) { - Ok(s) => write!(f, "{}", s), - Err(_) => Err(fmt::Error), - }, + Self::Bytes(n) => { + let s = if n % 1024 == 0 && n % 1000 != 0 { + to_magnitude_and_suffix(*n as u128, SuffixType::IEC) + } else { + to_magnitude_and_suffix(*n as u128, SuffixType::SI) + }; + + write!(f, "{}", s) + } } } } @@ -220,56 +206,64 @@ mod tests { use std::env; - use crate::blocks::{to_magnitude_and_suffix, BlockSize}; + use crate::blocks::{to_magnitude_and_suffix, BlockSize, SuffixType}; #[test] fn test_to_magnitude_and_suffix_powers_of_1024() { - assert_eq!(to_magnitude_and_suffix(1024).unwrap(), "1K"); - assert_eq!(to_magnitude_and_suffix(2048).unwrap(), "2K"); - assert_eq!(to_magnitude_and_suffix(4096).unwrap(), "4K"); - assert_eq!(to_magnitude_and_suffix(1024 * 1024).unwrap(), "1M"); - assert_eq!(to_magnitude_and_suffix(2 * 1024 * 1024).unwrap(), "2M"); - assert_eq!(to_magnitude_and_suffix(1024 * 1024 * 1024).unwrap(), "1G"); + assert_eq!(to_magnitude_and_suffix(1024, SuffixType::IEC), "1K"); + assert_eq!(to_magnitude_and_suffix(2048, SuffixType::IEC), "2K"); + assert_eq!(to_magnitude_and_suffix(4096, SuffixType::IEC), "4K"); + assert_eq!(to_magnitude_and_suffix(1024 * 1024, SuffixType::IEC), "1M"); + assert_eq!( + to_magnitude_and_suffix(2 * 1024 * 1024, SuffixType::IEC), + "2M" + ); assert_eq!( - to_magnitude_and_suffix(34 * 1024 * 1024 * 1024).unwrap(), + to_magnitude_and_suffix(1024 * 1024 * 1024, SuffixType::IEC), + "1G" + ); + assert_eq!( + to_magnitude_and_suffix(34 * 1024 * 1024 * 1024, SuffixType::IEC), "34G" ); } #[test] fn test_to_magnitude_and_suffix_not_powers_of_1024() { - assert_eq!(to_magnitude_and_suffix(1).unwrap(), "1B"); - assert_eq!(to_magnitude_and_suffix(999).unwrap(), "999B"); - - assert_eq!(to_magnitude_and_suffix(1000).unwrap(), "1kB"); - assert_eq!(to_magnitude_and_suffix(1001).unwrap(), "1.1kB"); - assert_eq!(to_magnitude_and_suffix(1023).unwrap(), "1.1kB"); - assert_eq!(to_magnitude_and_suffix(1025).unwrap(), "1.1kB"); - assert_eq!(to_magnitude_and_suffix(10_001).unwrap(), "11kB"); - assert_eq!(to_magnitude_and_suffix(999_000).unwrap(), "999kB"); - - assert_eq!(to_magnitude_and_suffix(999_001).unwrap(), "1MB"); - assert_eq!(to_magnitude_and_suffix(999_999).unwrap(), "1MB"); - assert_eq!(to_magnitude_and_suffix(1_000_000).unwrap(), "1MB"); - assert_eq!(to_magnitude_and_suffix(1_000_001).unwrap(), "1.1MB"); - assert_eq!(to_magnitude_and_suffix(1_100_000).unwrap(), "1.1MB"); - assert_eq!(to_magnitude_and_suffix(1_100_001).unwrap(), "1.2MB"); - assert_eq!(to_magnitude_and_suffix(1_900_000).unwrap(), "1.9MB"); - assert_eq!(to_magnitude_and_suffix(1_900_001).unwrap(), "2MB"); - assert_eq!(to_magnitude_and_suffix(9_900_000).unwrap(), "9.9MB"); - assert_eq!(to_magnitude_and_suffix(9_900_001).unwrap(), "10MB"); - assert_eq!(to_magnitude_and_suffix(999_000_000).unwrap(), "999MB"); - - assert_eq!(to_magnitude_and_suffix(999_000_001).unwrap(), "1GB"); - assert_eq!(to_magnitude_and_suffix(1_000_000_000).unwrap(), "1GB"); - assert_eq!(to_magnitude_and_suffix(1_000_000_001).unwrap(), "1.1GB"); - } + assert_eq!(to_magnitude_and_suffix(1, SuffixType::SI), "1B"); + assert_eq!(to_magnitude_and_suffix(999, SuffixType::SI), "999B"); + + assert_eq!(to_magnitude_and_suffix(1000, SuffixType::SI), "1kB"); + assert_eq!(to_magnitude_and_suffix(1001, SuffixType::SI), "1.1kB"); + assert_eq!(to_magnitude_and_suffix(1023, SuffixType::SI), "1.1kB"); + assert_eq!(to_magnitude_and_suffix(1025, SuffixType::SI), "1.1kB"); + assert_eq!(to_magnitude_and_suffix(10_001, SuffixType::SI), "11kB"); + assert_eq!(to_magnitude_and_suffix(999_000, SuffixType::SI), "999kB"); + + assert_eq!(to_magnitude_and_suffix(999_001, SuffixType::SI), "1MB"); + assert_eq!(to_magnitude_and_suffix(999_999, SuffixType::SI), "1MB"); + assert_eq!(to_magnitude_and_suffix(1_000_000, SuffixType::SI), "1MB"); + assert_eq!(to_magnitude_and_suffix(1_000_001, SuffixType::SI), "1.1MB"); + assert_eq!(to_magnitude_and_suffix(1_100_000, SuffixType::SI), "1.1MB"); + assert_eq!(to_magnitude_and_suffix(1_100_001, SuffixType::SI), "1.2MB"); + assert_eq!(to_magnitude_and_suffix(1_900_000, SuffixType::SI), "1.9MB"); + assert_eq!(to_magnitude_and_suffix(1_900_001, SuffixType::SI), "2MB"); + assert_eq!(to_magnitude_and_suffix(9_900_000, SuffixType::SI), "9.9MB"); + assert_eq!(to_magnitude_and_suffix(9_900_001, SuffixType::SI), "10MB"); + assert_eq!( + to_magnitude_and_suffix(999_000_000, SuffixType::SI), + "999MB" + ); - #[test] - fn test_to_magnitude_and_suffix_multiples_of_1000_and_1024() { - assert_eq!(to_magnitude_and_suffix(128_000).unwrap(), "128kB"); - assert_eq!(to_magnitude_and_suffix(1000 * 1024).unwrap(), "1.1MB"); - assert_eq!(to_magnitude_and_suffix(1_000_000_000_000).unwrap(), "1TB"); + assert_eq!(to_magnitude_and_suffix(999_000_001, SuffixType::SI), "1GB"); + assert_eq!( + to_magnitude_and_suffix(1_000_000_000, SuffixType::SI), + "1GB" + ); + assert_eq!( + to_magnitude_and_suffix(1_000_000_001, SuffixType::SI), + "1.1GB" + ); } #[test] @@ -279,6 +273,13 @@ mod tests { assert_eq!(format!("{}", BlockSize::Bytes(3 * 1024 * 1024)), "3M"); } + #[test] + fn test_block_size_display_multiples_of_1000_and_1024() { + assert_eq!(format!("{}", BlockSize::Bytes(128_000)), "128kB"); + assert_eq!(format!("{}", BlockSize::Bytes(1000 * 1024)), "1.1MB"); + assert_eq!(format!("{}", BlockSize::Bytes(1_000_000_000_000)), "1TB"); + } + #[test] fn test_default_block_size() { assert_eq!(BlockSize::Bytes(1024), BlockSize::default()); diff --git a/src/uu/df/src/table.rs b/src/uu/df/src/table.rs index fac2ca66395..c4a10c5e150 100644 --- a/src/uu/df/src/table.rs +++ b/src/uu/df/src/table.rs @@ -7,10 +7,9 @@ //! //! A table ([`Table`]) comprises a header row ([`Header`]) and a //! collection of data rows ([`Row`]), one per filesystem. -use number_prefix::NumberPrefix; use unicode_width::UnicodeWidthStr; -use crate::blocks::{HumanReadable, SizeFormat}; +use crate::blocks::{to_magnitude_and_suffix, HumanReadable, SizeFormat, SuffixType}; use crate::columns::{Alignment, Column}; use crate::filesystem::Filesystem; use crate::{BlockSize, Options}; @@ -215,13 +214,13 @@ impl<'a> RowFormatter<'a> { /// Get a human readable string giving the scaled version of the input number. fn scaled_human_readable(&self, size: u64, human_readable: HumanReadable) -> String { - let number_prefix = match human_readable { - HumanReadable::Decimal => NumberPrefix::decimal(size as f64), - HumanReadable::Binary => NumberPrefix::binary(size as f64), - }; - match number_prefix { - NumberPrefix::Standalone(bytes) => bytes.to_string(), - NumberPrefix::Prefixed(prefix, bytes) => format!("{:.1}{}", bytes, prefix.symbol()), + match human_readable { + HumanReadable::Decimal => { + to_magnitude_and_suffix(size.into(), SuffixType::HumanReadableSI) + } + HumanReadable::Binary => { + to_magnitude_and_suffix(size.into(), SuffixType::HumanReadableIEC) + } } } @@ -734,15 +733,7 @@ mod tests { let fmt = RowFormatter::new(&row, &options); assert_eq!( fmt.get_values(), - vec!( - "my_device", - "my_type", - "4.0k", - "1.0k", - "3.0k", - "25%", - "my_mount" - ) + vec!("my_device", "my_type", "4k", "1k", "3k", "25%", "my_mount") ); } @@ -768,15 +759,7 @@ mod tests { let fmt = RowFormatter::new(&row, &options); assert_eq!( fmt.get_values(), - vec!( - "my_device", - "my_type", - "4.0Ki", - "1.0Ki", - "3.0Ki", - "25%", - "my_mount" - ) + vec!("my_device", "my_type", "4K", "1K", "3K", "25%", "my_mount") ); }