[pve-devel] [PATCH installer v4 5/6] common: add ZFS `arc_max` installer setup option
Christoph Heiss
c.heiss at proxmox.com
Tue Nov 7 13:20:53 CET 2023
Signed-off-by: Christoph Heiss <c.heiss at proxmox.com>
---
proxmox-installer-common/src/options.rs | 62 +++++++++++++++++++--
proxmox-installer-common/src/setup.rs | 2 +
proxmox-tui-installer/src/views/bootdisk.rs | 18 ++++--
3 files changed, 71 insertions(+), 11 deletions(-)
diff --git a/proxmox-installer-common/src/options.rs b/proxmox-installer-common/src/options.rs
index 185be2e..afd12cd 100644
--- a/proxmox-installer-common/src/options.rs
+++ b/proxmox-installer-common/src/options.rs
@@ -1,7 +1,9 @@
use std::net::{IpAddr, Ipv4Addr};
use std::{cmp, fmt};
-use crate::setup::{LocaleInfo, NetworkInfo, RuntimeInfo, SetupInfo};
+use crate::setup::{
+ LocaleInfo, NetworkInfo, ProductConfig, ProxmoxProduct, RuntimeInfo, SetupInfo,
+};
use crate::utils::{CidrAddress, Fqdn};
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
@@ -172,25 +174,48 @@ pub struct ZfsBootdiskOptions {
pub compress: ZfsCompressOption,
pub checksum: ZfsChecksumOption,
pub copies: usize,
+ pub arc_max: usize,
pub disk_size: f64,
pub selected_disks: Vec<usize>,
}
impl ZfsBootdiskOptions {
- /// This panics if the provided slice is empty.
- pub fn defaults_from(disks: &[Disk]) -> Self {
- let disk = &disks[0];
+ /// Panics if the disk list is empty.
+ pub fn defaults_from(runinfo: &RuntimeInfo, product_conf: &ProductConfig) -> Self {
+ let disk = &runinfo.disks[0];
Self {
ashift: 12,
compress: ZfsCompressOption::default(),
checksum: ZfsChecksumOption::default(),
copies: 1,
+ arc_max: default_zfs_arc_max(product_conf.product, runinfo.total_memory),
disk_size: disk.size,
- selected_disks: (0..disks.len()).collect(),
+ selected_disks: (0..runinfo.disks.len()).collect(),
}
}
}
+/// Calculates the default upper limit for the ZFS ARC size.
+/// See also <https://bugzilla.proxmox.com/show_bug.cgi?id=4829> and
+/// https://openzfs.github.io/openzfs-docs/Performance%20and%20Tuning/Module%20Parameters.html#zfs-arc-max
+///
+/// # Arguments
+/// * `product` - The product to be installed
+/// * `total_memory` - Total memory installed in the system, in MiB
+///
+/// # Returns
+/// The default ZFS maximum ARC size in MiB for this system.
+fn default_zfs_arc_max(product: ProxmoxProduct, total_memory: usize) -> usize {
+ if product != ProxmoxProduct::PVE {
+ // Use ZFS default for non-PVE
+ 0
+ } else {
+ ((total_memory as f64) / 10.)
+ .round()
+ .clamp(64., 16. * 1024.) as usize
+ }
+}
+
#[derive(Clone, Debug)]
pub enum AdvancedBootdiskOptions {
Lvm(LvmBootdiskOptions),
@@ -385,3 +410,30 @@ impl NetworkOptions {
})
}
}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn zfs_arc_limit() {
+ const TESTS: &[(usize, usize)] = &[
+ (16, 64), // at least 64 MiB
+ (1024, 102),
+ (4 * 1024, 410),
+ (8 * 1024, 819),
+ (150 * 1024, 15360),
+ (160 * 1024, 16384),
+ (1024 * 1024, 16384), // maximum of 16 GiB
+ ];
+
+ for (total_memory, expected) in TESTS {
+ assert_eq!(
+ default_zfs_arc_max(ProxmoxProduct::PVE, *total_memory),
+ *expected
+ );
+ assert_eq!(default_zfs_arc_max(ProxmoxProduct::PBS, *total_memory), 0);
+ assert_eq!(default_zfs_arc_max(ProxmoxProduct::PMG, *total_memory), 0);
+ }
+ }
+}
diff --git a/proxmox-installer-common/src/setup.rs b/proxmox-installer-common/src/setup.rs
index 42a9e68..28a58f3 100644
--- a/proxmox-installer-common/src/setup.rs
+++ b/proxmox-installer-common/src/setup.rs
@@ -149,6 +149,7 @@ pub struct InstallZfsOption {
#[serde(serialize_with = "serialize_as_display")]
checksum: ZfsChecksumOption,
copies: usize,
+ arc_max: usize,
}
impl From<ZfsBootdiskOptions> for InstallZfsOption {
@@ -158,6 +159,7 @@ impl From<ZfsBootdiskOptions> for InstallZfsOption {
compress: opts.compress,
checksum: opts.checksum,
copies: opts.copies,
+ arc_max: opts.arc_max,
}
}
}
diff --git a/proxmox-tui-installer/src/views/bootdisk.rs b/proxmox-tui-installer/src/views/bootdisk.rs
index 48ccee9..3b2242a 100644
--- a/proxmox-tui-installer/src/views/bootdisk.rs
+++ b/proxmox-tui-installer/src/views/bootdisk.rs
@@ -22,7 +22,7 @@ use proxmox_installer_common::{
AdvancedBootdiskOptions, BootdiskOptions, BtrfsBootdiskOptions, Disk, FsType,
LvmBootdiskOptions, ZfsBootdiskOptions, ZFS_CHECKSUM_OPTIONS, ZFS_COMPRESS_OPTIONS,
},
- setup::{BootType, ProductConfig, ProxmoxProduct},
+ setup::{BootType, ProductConfig, ProxmoxProduct, RuntimeInfo},
};
pub struct BootdiskOptionsView {
@@ -155,6 +155,7 @@ impl AdvancedBootdiskOptionsView {
fn fstype_on_submit(siv: &mut Cursive, disks: &[Disk], fstype: &FsType) {
let state = siv.user_data::<InstallerState>().unwrap();
+ let runinfo = state.runtime_info.clone();
let product_conf = state.setup_info.config.clone();
siv.call_on_name("advanced-bootdisk-options-dialog", |view: &mut Dialog| {
@@ -166,9 +167,10 @@ impl AdvancedBootdiskOptionsView {
FsType::Ext4 | FsType::Xfs => view.add_child(
LvmBootdiskOptionsView::new_with_defaults(&disks[0], &product_conf),
),
- FsType::Zfs(_) => {
- view.add_child(ZfsBootdiskOptionsView::new_with_defaults(disks))
- }
+ FsType::Zfs(_) => view.add_child(ZfsBootdiskOptionsView::new_with_defaults(
+ &runinfo,
+ &product_conf,
+ )),
FsType::Btrfs(_) => {
view.add_child(BtrfsBootdiskOptionsView::new_with_defaults(disks))
}
@@ -552,8 +554,11 @@ impl ZfsBootdiskOptionsView {
Self { view }
}
- fn new_with_defaults(disks: &[Disk]) -> Self {
- Self::new(disks, &ZfsBootdiskOptions::defaults_from(disks))
+ fn new_with_defaults(runinfo: &RuntimeInfo, product_conf: &ProductConfig) -> Self {
+ Self::new(
+ &runinfo.disks,
+ &ZfsBootdiskOptions::defaults_from(runinfo, product_conf),
+ )
}
fn get_values(&mut self) -> Option<(Vec<Disk>, ZfsBootdiskOptions)> {
@@ -573,6 +578,7 @@ impl ZfsBootdiskOptionsView {
compress,
checksum,
copies,
+ arc_max: 0, // use built-in ZFS default value
disk_size,
selected_disks,
},
--
2.42.0
More information about the pve-devel
mailing list