public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Shan Shaji <s.shaji@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [PATCH proxmox v3 3/3] pbs-api-types: zfs: define schema for recordsize
Date: Wed, 12 Aug 2026 16:40:29 +0200	[thread overview]
Message-ID: <20260812144029.129970-4-s.shaji@proxmox.com> (raw)
In-Reply-To: <20260812144029.129970-1-s.shaji@proxmox.com>

add schema and verifcation function for recordsize to check against
allowed zfs constraints. Without the verification function the dataset
will be created using the default 128k recordsize.

Reviewed-by: Nicolas Frey <n.frey@proxmox.com>
Tested-by: Nicolas Frey <n.frey@proxmox.com>
Signed-off-by: Shan Shaji <s.shaji@proxmox.com>
---

 changes since v2:
 * style nit: use let-else instead of  if let-else.

 pbs-api-types/src/zfs.rs | 68 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 68 insertions(+)

diff --git a/pbs-api-types/src/zfs.rs b/pbs-api-types/src/zfs.rs
index 2cfbd403..b2e1baf6 100644
--- a/pbs-api-types/src/zfs.rs
+++ b/pbs-api-types/src/zfs.rs
@@ -1,3 +1,4 @@
+use anyhow::{Error, bail};
 use serde::{Deserialize, Serialize};
 
 #[cfg(feature = "enum-fallback")]
@@ -6,6 +7,7 @@ use proxmox_schema::*;
 
 const_regex! {
     pub ZPOOL_NAME_REGEX = r"^[a-zA-Z][a-z0-9A-Z\-_.:]+$";
+    ZFS_RECORD_SIZE_REGEX = r"^(?i)([1-9][0-9]*)([km])?$";
 }
 
 pub const ZFS_ASHIFT_SCHEMA: Schema = IntegerSchema::new("Pool sector size exponent.")
@@ -18,6 +20,39 @@ pub const ZPOOL_NAME_SCHEMA: Schema = StringSchema::new("ZFS Pool Name")
     .format(&ApiStringFormat::Pattern(&ZPOOL_NAME_REGEX))
     .schema();
 
+fn verify_zfs_recordsize(value: &str) -> Result<(), Error> {
+    let Some(caps) = ZFS_RECORD_SIZE_REGEX.captures(value) else {
+        bail!("Invalid format. Use numbers with optional k or m suffix (e.g., 16k).")
+    };
+
+    let range_error = "Value must be a power of 2 between 512 and 16m";
+
+    let Ok(number) = caps[1].parse::<u32>() else {
+        bail!(range_error);
+    };
+
+    let multiplier = match caps.get(2).map(|v| v.as_str()) {
+        Some(suffix) if suffix.eq_ignore_ascii_case("k") => 1024,
+        Some(suffix) if suffix.eq_ignore_ascii_case("m") => 1024 * 1024,
+        _ => 1,
+    };
+
+    let bytes = number
+        .checked_mul(multiplier)
+        .filter(|&b| b.is_power_of_two() && (512..=16 * 1024 * 1024).contains(&b));
+
+    if bytes.is_none() {
+        bail!(range_error);
+    }
+
+    Ok(())
+}
+
+pub const ZFS_RECORD_SIZE_SCHEMA: Schema =
+    StringSchema::new("ZFS Recordsize. Use numbers with optional k or m suffix (e.g., 128k).")
+        .format(&ApiStringFormat::VerifyFn(verify_zfs_recordsize))
+        .schema();
+
 #[api(default: "On")]
 #[derive(Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize)]
 #[serde(rename_all = "lowercase")]
@@ -84,3 +119,36 @@ pub struct ZpoolListItem {
     /// ZFS deduplication ratio
     pub dedup: f64,
 }
+
+#[cfg(test)]
+mod tests {
+
+    use super::verify_zfs_recordsize;
+
+    #[test]
+    fn test_zfs_record_size_verify_fn() {
+        let format_error = "Invalid format. Use numbers with optional k or m suffix (e.g., 16k).";
+        let range_error = "Value must be a power of 2 between 512 and 16m";
+
+        let valid_inputs = ["512", "1024", "16m", "16384k", "16777216"];
+        for input in valid_inputs {
+            assert!(verify_zfs_recordsize(input).is_ok());
+        }
+
+        let range_error_inputs = ["31m", "256", "31m", "32m", "4294967297"];
+        for input in range_error_inputs {
+            assert_eq!(
+                verify_zfs_recordsize(input).unwrap_err().to_string(),
+                range_error
+            );
+        }
+
+        let format_error_inputs = ["0", "k12", "16g", "1.5m", "-512", "0512"];
+        for input in format_error_inputs {
+            assert_eq!(
+                verify_zfs_recordsize(input).unwrap_err().to_string(),
+                format_error
+            );
+        }
+    }
+}
-- 
2.47.3





      parent reply	other threads:[~2026-08-12 14:40 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-08-12 14:40 [PATCH proxmox{-backup,} v3 0/3] partially fix #6933: add option to specify zfs recordsize Shan Shaji
2026-08-12 14:40 ` [PATCH proxmox-backup v3 1/3] partially fix #6933: ui: storage: " Shan Shaji
2026-08-12 14:40 ` [PATCH proxmox-backup v3 2/3] partially fix #6933: bin: add option to specify ZFS recordsize Shan Shaji
2026-08-12 14:40 ` Shan Shaji [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260812144029.129970-4-s.shaji@proxmox.com \
    --to=s.shaji@proxmox.com \
    --cc=pbs-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal