From: Shachar Sharon Date: Thu, 14 Aug 2025 14:01:16 +0000 (+0300) Subject: docs-xml/manpages: doc for 'vfs_aio_ratelimit' module X-Git-Tag: tdb-1.4.15~53 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=611b4d6de728d7919ec244fe90823510b209b608;p=thirdparty%2Fsamba.git docs-xml/manpages: doc for 'vfs_aio_ratelimit' module Documentation for newly introduced async-I/O rate-limiting module. Signed-off-by: Shachar Sharon Reviewed-by: Avan Thakkar Reviewed-by: Anoop C S Reviewed-by: Gunther Deschner Autobuild-User(master): Anoop C S Autobuild-Date(master): Sun Jan 18 07:23:19 UTC 2026 on atb-devel-224 --- diff --git a/docs-xml/manpages/vfs_aio_ratelimit.8.xml b/docs-xml/manpages/vfs_aio_ratelimit.8.xml new file mode 100644 index 00000000000..43d3e695c08 --- /dev/null +++ b/docs-xml/manpages/vfs_aio_ratelimit.8.xml @@ -0,0 +1,155 @@ + + + + + + vfs_aio_ratelimit + 8 + Samba + System Administration tools + &doc.version; + + + + vfs_aio_ratelimit + Implement async-I/O rate-limiting for Samba + + + + + vfs objects = aio_ratelimit + + + + + DESCRIPTION + + This VFS module is part of the + samba + 7 suite. + + The aio_ratelimit VFS module enables run-time + rate-limiting on specific shares by enforcing upper limit on async I/O + operations. An administrator may define this limit as operations + per-second or bytes-per-second. When one of those limits is exceeded, + a delay value (in milliseconds) is calculated based on current I/O load + and injected to async I/O operations, yielding an implicit throughput + ceiling. + + + + This module operates only on asynchronous VFS READ/WRITE operation. + + + This module is stackable. + + + + CONFIGURATION + + Straight forward use: + + + + /path/to/share + aio_ratelimit + + + + + + OPTIONS + + + + aio_ratelimit:read_iops_limit = count + + + Upper limit of READ operations-per-second before + injecting delays. Zero value implies no limit. + + Default: 0, Max: 1000000 + Example: aio_ratelimit:read_iops_limit = 1000 + + + + + aio_ratelimit:read_bw_limit = count + + + Upper limit of READ bandwidth (bytes-per-second) before + injecting delays. Zero value implies no limit. + + Default: 0, Max: 1T + Example: aio_ratelimit:read_bw_limit = 1000000 + + + + + aio_ratelimit:read_delay_max = seconds + + + Maximal allowed delay value, in seconds, for READ. + + Default: 30, Max: 300 + Example: aio_ratelimit:read_delay_max = 15 + + + + + + aio_ratelimit:write_iops_limit = count + + + Upper limit of WRITE operations-per-second before + injecting delays. Zero value implies no limit. + + Default: 0, Max: 1000000 + Example: aio_ratelimit:write_iops_limit = 1000 + + + + + aio_ratelimit:write_bw_limit = count + + + Upper limit of WRITE bandwidth (bytes-per-second) + before injecting delays. Zero value implies no limit. + + Default: 0, Max: 1T + Example: aio_ratelimit:write_bw_limit = 1000000 + + + + + aio_ratelimit:write_delay_max = seconds + + + Maximal allowed delay value, in seconds, for WRITE. + + Default: 30, Max: 300 + Example: aio_ratelimit:write_delay_max = 20 + + + + + + + + VERSION + + This man page is part of version &doc.version; of the Samba suite. + + + + + AUTHOR + + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + + + + diff --git a/docs-xml/wscript_build b/docs-xml/wscript_build index 42833a964c0..5d231ca1624 100644 --- a/docs-xml/wscript_build +++ b/docs-xml/wscript_build @@ -73,6 +73,7 @@ vfs_module_manpages = ['vfs_acl_tdb', 'vfs_acl_xattr', 'vfs_aio_fork', 'vfs_aio_pthread', + 'vfs_aio_ratelimit', 'vfs_io_uring', 'vfs_audit', 'vfs_btrfs',