1.\" 2.\" Copyright (c) 2013 by Turbo Fredriksson <turbo@bayour.com>. All rights reserved. 3.\" Copyright (c) 2019, 2021 by Delphix. All rights reserved. 4.\" Copyright (c) 2019 Datto Inc. 5.\" The contents of this file are subject to the terms of the Common Development 6.\" and Distribution License (the "License"). You may not use this file except 7.\" in compliance with the License. You can obtain a copy of the license at 8.\" usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. 9.\" 10.\" See the License for the specific language governing permissions and 11.\" limitations under the License. When distributing Covered Code, include this 12.\" CDDL HEADER in each file and include the License file at 13.\" usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this 14.\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your 15.\" own identifying information: 16.\" Portions Copyright [yyyy] [name of copyright owner] 17.\" 18.Dd June 1, 2021 19.Dt ZFS 4 20.Os 21. 22.Sh NAME 23.Nm zfs 24.Nd tuning of the ZFS kernel module 25. 26.Sh DESCRIPTION 27The ZFS module supports these parameters: 28.Bl -tag -width Ds 29.It Sy dbuf_cache_max_bytes Ns = Ns Sy ULONG_MAX Ns B Pq ulong 30Maximum size in bytes of the dbuf cache. 31The target size is determined by the MIN versus 32.No 1/2^ Ns Sy dbuf_cache_shift Pq 1/32nd 33of the target ARC size. 34The behavior of the dbuf cache and its associated settings 35can be observed via the 36.Pa /proc/spl/kstat/zfs/dbufstats 37kstat. 38. 39.It Sy dbuf_metadata_cache_max_bytes Ns = Ns Sy ULONG_MAX Ns B Pq ulong 40Maximum size in bytes of the metadata dbuf cache. 41The target size is determined by the MIN versus 42.No 1/2^ Ns Sy dbuf_metadata_cache_shift Pq 1/64th 43of the target ARC size. 44The behavior of the metadata dbuf cache and its associated settings 45can be observed via the 46.Pa /proc/spl/kstat/zfs/dbufstats 47kstat. 48. 49.It Sy dbuf_cache_hiwater_pct Ns = Ns Sy 10 Ns % Pq uint 50The percentage over 51.Sy dbuf_cache_max_bytes 52when dbufs must be evicted directly. 53. 54.It Sy dbuf_cache_lowater_pct Ns = Ns Sy 10 Ns % Pq uint 55The percentage below 56.Sy dbuf_cache_max_bytes 57when the evict thread stops evicting dbufs. 58. 59.It Sy dbuf_cache_shift Ns = Ns Sy 5 Pq int 60Set the size of the dbuf cache 61.Pq Sy dbuf_cache_max_bytes 62to a log2 fraction of the target ARC size. 63. 64.It Sy dbuf_metadata_cache_shift Ns = Ns Sy 6 Pq int 65Set the size of the dbuf metadata cache 66.Pq Sy dbuf_metadata_cache_max_bytes 67to a log2 fraction of the target ARC size. 68. 69.It Sy dmu_object_alloc_chunk_shift Ns = Ns Sy 7 Po 128 Pc Pq int 70dnode slots allocated in a single operation as a power of 2. 71The default value minimizes lock contention for the bulk operation performed. 72. 73.It Sy dmu_prefetch_max Ns = Ns Sy 134217728 Ns B Po 128MB Pc Pq int 74Limit the amount we can prefetch with one call to this amount in bytes. 75This helps to limit the amount of memory that can be used by prefetching. 76. 77.It Sy ignore_hole_birth Pq int 78Alias for 79.Sy send_holes_without_birth_time . 80. 81.It Sy l2arc_feed_again Ns = Ns Sy 1 Ns | Ns 0 Pq int 82Turbo L2ARC warm-up. 83When the L2ARC is cold the fill interval will be set as fast as possible. 84. 85.It Sy l2arc_feed_min_ms Ns = Ns Sy 200 Pq ulong 86Min feed interval in milliseconds. 87Requires 88.Sy l2arc_feed_again Ns = Ns Ar 1 89and only applicable in related situations. 90. 91.It Sy l2arc_feed_secs Ns = Ns Sy 1 Pq ulong 92Seconds between L2ARC writing. 93. 94.It Sy l2arc_headroom Ns = Ns Sy 2 Pq ulong 95How far through the ARC lists to search for L2ARC cacheable content, 96expressed as a multiplier of 97.Sy l2arc_write_max . 98ARC persistence across reboots can be achieved with persistent L2ARC 99by setting this parameter to 100.Sy 0 , 101allowing the full length of ARC lists to be searched for cacheable content. 102. 103.It Sy l2arc_headroom_boost Ns = Ns Sy 200 Ns % Pq ulong 104Scales 105.Sy l2arc_headroom 106by this percentage when L2ARC contents are being successfully compressed 107before writing. 108A value of 109.Sy 100 110disables this feature. 111. 112.It Sy l2arc_exclude_special Ns = Ns Sy 0 Ns | Ns 1 Pq int 113Controls whether buffers present on special vdevs are eligible for caching 114into L2ARC. 115If set to 1, exclude dbufs on special vdevs from being cached to L2ARC. 116. 117.It Sy l2arc_mfuonly Ns = Ns Sy 0 Ns | Ns 1 Pq int 118Controls whether only MFU metadata and data are cached from ARC into L2ARC. 119This may be desired to avoid wasting space on L2ARC when reading/writing large 120amounts of data that are not expected to be accessed more than once. 121.Pp 122The default is off, 123meaning both MRU and MFU data and metadata are cached. 124When turning off this feature, some MRU buffers will still be present 125in ARC and eventually cached on L2ARC. 126.No If Sy l2arc_noprefetch Ns = Ns Sy 0 , 127some prefetched buffers will be cached to L2ARC, and those might later 128transition to MRU, in which case the 129.Sy l2arc_mru_asize No arcstat will not be Sy 0 . 130.Pp 131Regardless of 132.Sy l2arc_noprefetch , 133some MFU buffers might be evicted from ARC, 134accessed later on as prefetches and transition to MRU as prefetches. 135If accessed again they are counted as MRU and the 136.Sy l2arc_mru_asize No arcstat will not be Sy 0 . 137.Pp 138The ARC status of L2ARC buffers when they were first cached in 139L2ARC can be seen in the 140.Sy l2arc_mru_asize , Sy l2arc_mfu_asize , No and Sy l2arc_prefetch_asize 141arcstats when importing the pool or onlining a cache 142device if persistent L2ARC is enabled. 143.Pp 144The 145.Sy evict_l2_eligible_mru 146arcstat does not take into account if this option is enabled as the information 147provided by the 148.Sy evict_l2_eligible_m[rf]u 149arcstats can be used to decide if toggling this option is appropriate 150for the current workload. 151. 152.It Sy l2arc_meta_percent Ns = Ns Sy 33 Ns % Pq int 153Percent of ARC size allowed for L2ARC-only headers. 154Since L2ARC buffers are not evicted on memory pressure, 155too many headers on a system with an irrationally large L2ARC 156can render it slow or unusable. 157This parameter limits L2ARC writes and rebuilds to achieve the target. 158. 159.It Sy l2arc_trim_ahead Ns = Ns Sy 0 Ns % Pq ulong 160Trims ahead of the current write size 161.Pq Sy l2arc_write_max 162on L2ARC devices by this percentage of write size if we have filled the device. 163If set to 164.Sy 100 165we TRIM twice the space required to accommodate upcoming writes. 166A minimum of 167.Sy 64MB 168will be trimmed. 169It also enables TRIM of the whole L2ARC device upon creation 170or addition to an existing pool or if the header of the device is 171invalid upon importing a pool or onlining a cache device. 172A value of 173.Sy 0 174disables TRIM on L2ARC altogether and is the default as it can put significant 175stress on the underlying storage devices. 176This will vary depending of how well the specific device handles these commands. 177. 178.It Sy l2arc_noprefetch Ns = Ns Sy 1 Ns | Ns 0 Pq int 179Do not write buffers to L2ARC if they were prefetched but not used by 180applications. 181In case there are prefetched buffers in L2ARC and this option 182is later set, we do not read the prefetched buffers from L2ARC. 183Unsetting this option is useful for caching sequential reads from the 184disks to L2ARC and serve those reads from L2ARC later on. 185This may be beneficial in case the L2ARC device is significantly faster 186in sequential reads than the disks of the pool. 187.Pp 188Use 189.Sy 1 190to disable and 191.Sy 0 192to enable caching/reading prefetches to/from L2ARC. 193. 194.It Sy l2arc_norw Ns = Ns Sy 0 Ns | Ns 1 Pq int 195No reads during writes. 196. 197.It Sy l2arc_write_boost Ns = Ns Sy 8388608 Ns B Po 8MB Pc Pq ulong 198Cold L2ARC devices will have 199.Sy l2arc_write_max 200increased by this amount while they remain cold. 201. 202.It Sy l2arc_write_max Ns = Ns Sy 8388608 Ns B Po 8MB Pc Pq ulong 203Max write bytes per interval. 204. 205.It Sy l2arc_rebuild_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int 206Rebuild the L2ARC when importing a pool (persistent L2ARC). 207This can be disabled if there are problems importing a pool 208or attaching an L2ARC device (e.g. the L2ARC device is slow 209in reading stored log metadata, or the metadata 210has become somehow fragmented/unusable). 211. 212.It Sy l2arc_rebuild_blocks_min_l2size Ns = Ns Sy 1073741824 Ns B Po 1GB Pc Pq ulong 213Mininum size of an L2ARC device required in order to write log blocks in it. 214The log blocks are used upon importing the pool to rebuild the persistent L2ARC. 215.Pp 216For L2ARC devices less than 1GB, the amount of data 217.Fn l2arc_evict 218evicts is significant compared to the amount of restored L2ARC data. 219In this case, do not write log blocks in L2ARC in order not to waste space. 220. 221.It Sy metaslab_aliquot Ns = Ns Sy 524288 Ns B Po 512kB Pc Pq ulong 222Metaslab granularity, in bytes. 223This is roughly similar to what would be referred to as the "stripe size" 224in traditional RAID arrays. 225In normal operation, ZFS will try to write this amount of data 226to a top-level vdev before moving on to the next one. 227. 228.It Sy metaslab_bias_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int 229Enable metaslab group biasing based on their vdevs' over- or under-utilization 230relative to the pool. 231. 232.It Sy metaslab_force_ganging Ns = Ns Sy 16777217 Ns B Ns B Po 16MB + 1B Pc Pq ulong 233Make some blocks above a certain size be gang blocks. 234This option is used by the test suite to facilitate testing. 235. 236.It Sy zfs_history_output_max Ns = Ns Sy 1048576 Ns B Ns B Po 1MB Pc Pq int 237When attempting to log an output nvlist of an ioctl in the on-disk history, 238the output will not be stored if it is larger than this size (in bytes). 239This must be less than 240.Sy DMU_MAX_ACCESS Pq 64MB . 241This applies primarily to 242.Fn zfs_ioc_channel_program Pq cf. Xr zfs-program 8 . 243. 244.It Sy zfs_keep_log_spacemaps_at_export Ns = Ns Sy 0 Ns | Ns 1 Pq int 245Prevent log spacemaps from being destroyed during pool exports and destroys. 246. 247.It Sy zfs_metaslab_segment_weight_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int 248Enable/disable segment-based metaslab selection. 249. 250.It Sy zfs_metaslab_switch_threshold Ns = Ns Sy 2 Pq int 251When using segment-based metaslab selection, continue allocating 252from the active metaslab until this option's 253worth of buckets have been exhausted. 254. 255.It Sy metaslab_debug_load Ns = Ns Sy 0 Ns | Ns 1 Pq int 256Load all metaslabs during pool import. 257. 258.It Sy metaslab_debug_unload Ns = Ns Sy 0 Ns | Ns 1 Pq int 259Prevent metaslabs from being unloaded. 260. 261.It Sy metaslab_fragmentation_factor_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int 262Enable use of the fragmentation metric in computing metaslab weights. 263. 264.It Sy metaslab_df_max_search Ns = Ns Sy 16777216 Ns B Po 16MB Pc Pq int 265Maximum distance to search forward from the last offset. 266Without this limit, fragmented pools can see 267.Em >100`000 268iterations and 269.Fn metaslab_block_picker 270becomes the performance limiting factor on high-performance storage. 271.Pp 272With the default setting of 273.Sy 16MB , 274we typically see less than 275.Em 500 276iterations, even with very fragmented 277.Sy ashift Ns = Ns Sy 9 278pools. 279The maximum number of iterations possible is 280.Sy metaslab_df_max_search / 2^(ashift+1) . 281With the default setting of 282.Sy 16MB 283this is 284.Em 16*1024 Pq with Sy ashift Ns = Ns Sy 9 285or 286.Em 2*1024 Pq with Sy ashift Ns = Ns Sy 12 . 287. 288.It Sy metaslab_df_use_largest_segment Ns = Ns Sy 0 Ns | Ns 1 Pq int 289If not searching forward (due to 290.Sy metaslab_df_max_search , metaslab_df_free_pct , 291.No or Sy metaslab_df_alloc_threshold ) , 292this tunable controls which segment is used. 293If set, we will use the largest free segment. 294If unset, we will use a segment of at least the requested size. 295. 296.It Sy zfs_metaslab_max_size_cache_sec Ns = Ns Sy 3600 Ns s Po 1h Pc Pq ulong 297When we unload a metaslab, we cache the size of the largest free chunk. 298We use that cached size to determine whether or not to load a metaslab 299for a given allocation. 300As more frees accumulate in that metaslab while it's unloaded, 301the cached max size becomes less and less accurate. 302After a number of seconds controlled by this tunable, 303we stop considering the cached max size and start 304considering only the histogram instead. 305. 306.It Sy zfs_metaslab_mem_limit Ns = Ns Sy 25 Ns % Pq int 307When we are loading a new metaslab, we check the amount of memory being used 308to store metaslab range trees. 309If it is over a threshold, we attempt to unload the least recently used metaslab 310to prevent the system from clogging all of its memory with range trees. 311This tunable sets the percentage of total system memory that is the threshold. 312. 313.It Sy zfs_metaslab_try_hard_before_gang Ns = Ns Sy 0 Ns | Ns 1 Pq int 314.Bl -item -compact 315.It 316If unset, we will first try normal allocation. 317.It 318If that fails then we will do a gang allocation. 319.It 320If that fails then we will do a "try hard" gang allocation. 321.It 322If that fails then we will have a multi-layer gang block. 323.El 324.Pp 325.Bl -item -compact 326.It 327If set, we will first try normal allocation. 328.It 329If that fails then we will do a "try hard" allocation. 330.It 331If that fails we will do a gang allocation. 332.It 333If that fails we will do a "try hard" gang allocation. 334.It 335If that fails then we will have a multi-layer gang block. 336.El 337. 338.It Sy zfs_metaslab_find_max_tries Ns = Ns Sy 100 Pq int 339When not trying hard, we only consider this number of the best metaslabs. 340This improves performance, especially when there are many metaslabs per vdev 341and the allocation can't actually be satisfied 342(so we would otherwise iterate all metaslabs). 343. 344.It Sy zfs_vdev_default_ms_count Ns = Ns Sy 200 Pq int 345When a vdev is added, target this number of metaslabs per top-level vdev. 346. 347.It Sy zfs_vdev_default_ms_shift Ns = Ns Sy 29 Po 512MB Pc Pq int 348Default limit for metaslab size. 349. 350.It Sy zfs_vdev_max_auto_ashift Ns = Ns Sy ASHIFT_MAX Po 16 Pc Pq ulong 351Maximum ashift used when optimizing for logical \[->] physical sector size on new 352top-level vdevs. 353. 354.It Sy zfs_vdev_min_auto_ashift Ns = Ns Sy ASHIFT_MIN Po 9 Pc Pq ulong 355Minimum ashift used when creating new top-level vdevs. 356. 357.It Sy zfs_vdev_min_ms_count Ns = Ns Sy 16 Pq int 358Minimum number of metaslabs to create in a top-level vdev. 359. 360.It Sy vdev_validate_skip Ns = Ns Sy 0 Ns | Ns 1 Pq int 361Skip label validation steps during pool import. 362Changing is not recommended unless you know what you're doing 363and are recovering a damaged label. 364. 365.It Sy zfs_vdev_ms_count_limit Ns = Ns Sy 131072 Po 128k Pc Pq int 366Practical upper limit of total metaslabs per top-level vdev. 367. 368.It Sy metaslab_preload_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int 369Enable metaslab group preloading. 370. 371.It Sy metaslab_lba_weighting_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int 372Give more weight to metaslabs with lower LBAs, 373assuming they have greater bandwidth, 374as is typically the case on a modern constant angular velocity disk drive. 375. 376.It Sy metaslab_unload_delay Ns = Ns Sy 32 Pq int 377After a metaslab is used, we keep it loaded for this many TXGs, to attempt to 378reduce unnecessary reloading. 379Note that both this many TXGs and 380.Sy metaslab_unload_delay_ms 381milliseconds must pass before unloading will occur. 382. 383.It Sy metaslab_unload_delay_ms Ns = Ns Sy 600000 Ns ms Po 10min Pc Pq int 384After a metaslab is used, we keep it loaded for this many milliseconds, 385to attempt to reduce unnecessary reloading. 386Note, that both this many milliseconds and 387.Sy metaslab_unload_delay 388TXGs must pass before unloading will occur. 389. 390.It Sy reference_history Ns = Ns Sy 3 Pq int 391Maximum reference holders being tracked when reference_tracking_enable is active. 392. 393.It Sy reference_tracking_enable Ns = Ns Sy 0 Ns | Ns 1 Pq int 394Track reference holders to 395.Sy refcount_t 396objects (debug builds only). 397. 398.It Sy send_holes_without_birth_time Ns = Ns Sy 1 Ns | Ns 0 Pq int 399When set, the 400.Sy hole_birth 401optimization will not be used, and all holes will always be sent during a 402.Nm zfs Cm send . 403This is useful if you suspect your datasets are affected by a bug in 404.Sy hole_birth . 405. 406.It Sy spa_config_path Ns = Ns Pa /etc/zfs/zpool.cache Pq charp 407SPA config file. 408. 409.It Sy spa_asize_inflation Ns = Ns Sy 24 Pq int 410Multiplication factor used to estimate actual disk consumption from the 411size of data being written. 412The default value is a worst case estimate, 413but lower values may be valid for a given pool depending on its configuration. 414Pool administrators who understand the factors involved 415may wish to specify a more realistic inflation factor, 416particularly if they operate close to quota or capacity limits. 417. 418.It Sy spa_load_print_vdev_tree Ns = Ns Sy 0 Ns | Ns 1 Pq int 419Whether to print the vdev tree in the debugging message buffer during pool import. 420. 421.It Sy spa_load_verify_data Ns = Ns Sy 1 Ns | Ns 0 Pq int 422Whether to traverse data blocks during an "extreme rewind" 423.Pq Fl X 424import. 425.Pp 426An extreme rewind import normally performs a full traversal of all 427blocks in the pool for verification. 428If this parameter is unset, the traversal skips non-metadata blocks. 429It can be toggled once the 430import has started to stop or start the traversal of non-metadata blocks. 431. 432.It Sy spa_load_verify_metadata Ns = Ns Sy 1 Ns | Ns 0 Pq int 433Whether to traverse blocks during an "extreme rewind" 434.Pq Fl X 435pool import. 436.Pp 437An extreme rewind import normally performs a full traversal of all 438blocks in the pool for verification. 439If this parameter is unset, the traversal is not performed. 440It can be toggled once the import has started to stop or start the traversal. 441. 442.It Sy spa_load_verify_shift Ns = Ns Sy 4 Po 1/16th Pc Pq int 443Sets the maximum number of bytes to consume during pool import to the log2 444fraction of the target ARC size. 445. 446.It Sy spa_slop_shift Ns = Ns Sy 5 Po 1/32nd Pc Pq int 447Normally, we don't allow the last 448.Sy 3.2% Pq Sy 1/2^spa_slop_shift 449of space in the pool to be consumed. 450This ensures that we don't run the pool completely out of space, 451due to unaccounted changes (e.g. to the MOS). 452It also limits the worst-case time to allocate space. 453If we have less than this amount of free space, 454most ZPL operations (e.g. write, create) will return 455.Sy ENOSPC . 456. 457.It Sy vdev_removal_max_span Ns = Ns Sy 32768 Ns B Po 32kB Pc Pq int 458During top-level vdev removal, chunks of data are copied from the vdev 459which may include free space in order to trade bandwidth for IOPS. 460This parameter determines the maximum span of free space, in bytes, 461which will be included as "unnecessary" data in a chunk of copied data. 462.Pp 463The default value here was chosen to align with 464.Sy zfs_vdev_read_gap_limit , 465which is a similar concept when doing 466regular reads (but there's no reason it has to be the same). 467. 468.It Sy vdev_file_logical_ashift Ns = Ns Sy 9 Po 512B Pc Pq ulong 469Logical ashift for file-based devices. 470. 471.It Sy vdev_file_physical_ashift Ns = Ns Sy 9 Po 512B Pc Pq ulong 472Physical ashift for file-based devices. 473. 474.It Sy zap_iterate_prefetch Ns = Ns Sy 1 Ns | Ns 0 Pq int 475If set, when we start iterating over a ZAP object, 476prefetch the entire object (all leaf blocks). 477However, this is limited by 478.Sy dmu_prefetch_max . 479. 480.It Sy zfetch_array_rd_sz Ns = Ns Sy 1048576 Ns B Po 1MB Pc Pq ulong 481If prefetching is enabled, disable prefetching for reads larger than this size. 482. 483.It Sy zfetch_max_distance Ns = Ns Sy 8388608 Ns B Po 8MB Pc Pq uint 484Max bytes to prefetch per stream. 485. 486.It Sy zfetch_max_idistance Ns = Ns Sy 67108864 Ns B Po 64MB Pc Pq uint 487Max bytes to prefetch indirects for per stream. 488. 489.It Sy zfetch_max_streams Ns = Ns Sy 8 Pq uint 490Max number of streams per zfetch (prefetch streams per file). 491. 492.It Sy zfetch_min_sec_reap Ns = Ns Sy 2 Pq uint 493Min time before an active prefetch stream can be reclaimed 494. 495.It Sy zfs_abd_scatter_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int 496Enables ARC from using scatter/gather lists and forces all allocations to be 497linear in kernel memory. 498Disabling can improve performance in some code paths 499at the expense of fragmented kernel memory. 500. 501.It Sy zfs_abd_scatter_max_order Ns = Ns Sy MAX_ORDER\-1 Pq uint 502Maximum number of consecutive memory pages allocated in a single block for 503scatter/gather lists. 504.Pp 505The value of 506.Sy MAX_ORDER 507depends on kernel configuration. 508. 509.It Sy zfs_abd_scatter_min_size Ns = Ns Sy 1536 Ns B Po 1.5kB Pc Pq uint 510This is the minimum allocation size that will use scatter (page-based) ABDs. 511Smaller allocations will use linear ABDs. 512. 513.It Sy zfs_arc_dnode_limit Ns = Ns Sy 0 Ns B Pq ulong 514When the number of bytes consumed by dnodes in the ARC exceeds this number of 515bytes, try to unpin some of it in response to demand for non-metadata. 516This value acts as a ceiling to the amount of dnode metadata, and defaults to 517.Sy 0 , 518which indicates that a percent which is based on 519.Sy zfs_arc_dnode_limit_percent 520of the ARC meta buffers that may be used for dnodes. 521.Pp 522Also see 523.Sy zfs_arc_meta_prune 524which serves a similar purpose but is used 525when the amount of metadata in the ARC exceeds 526.Sy zfs_arc_meta_limit 527rather than in response to overall demand for non-metadata. 528. 529.It Sy zfs_arc_dnode_limit_percent Ns = Ns Sy 10 Ns % Pq ulong 530Percentage that can be consumed by dnodes of ARC meta buffers. 531.Pp 532See also 533.Sy zfs_arc_dnode_limit , 534which serves a similar purpose but has a higher priority if nonzero. 535. 536.It Sy zfs_arc_dnode_reduce_percent Ns = Ns Sy 10 Ns % Pq ulong 537Percentage of ARC dnodes to try to scan in response to demand for non-metadata 538when the number of bytes consumed by dnodes exceeds 539.Sy zfs_arc_dnode_limit . 540. 541.It Sy zfs_arc_average_blocksize Ns = Ns Sy 8192 Ns B Po 8kB Pc Pq int 542The ARC's buffer hash table is sized based on the assumption of an average 543block size of this value. 544This works out to roughly 1MB of hash table per 1GB of physical memory 545with 8-byte pointers. 546For configurations with a known larger average block size, 547this value can be increased to reduce the memory footprint. 548. 549.It Sy zfs_arc_eviction_pct Ns = Ns Sy 200 Ns % Pq int 550When 551.Fn arc_is_overflowing , 552.Fn arc_get_data_impl 553waits for this percent of the requested amount of data to be evicted. 554For example, by default, for every 555.Em 2kB 556that's evicted, 557.Em 1kB 558of it may be "reused" by a new allocation. 559Since this is above 560.Sy 100 Ns % , 561it ensures that progress is made towards getting 562.Sy arc_size No under Sy arc_c . 563Since this is finite, it ensures that allocations can still happen, 564even during the potentially long time that 565.Sy arc_size No is more than Sy arc_c . 566. 567.It Sy zfs_arc_evict_batch_limit Ns = Ns Sy 10 Pq int 568Number ARC headers to evict per sub-list before proceeding to another sub-list. 569This batch-style operation prevents entire sub-lists from being evicted at once 570but comes at a cost of additional unlocking and locking. 571. 572.It Sy zfs_arc_grow_retry Ns = Ns Sy 0 Ns s Pq int 573If set to a non zero value, it will replace the 574.Sy arc_grow_retry 575value with this value. 576The 577.Sy arc_grow_retry 578.No value Pq default Sy 5 Ns s 579is the number of seconds the ARC will wait before 580trying to resume growth after a memory pressure event. 581. 582.It Sy zfs_arc_lotsfree_percent Ns = Ns Sy 10 Ns % Pq int 583Throttle I/O when free system memory drops below this percentage of total 584system memory. 585Setting this value to 586.Sy 0 587will disable the throttle. 588. 589.It Sy zfs_arc_max Ns = Ns Sy 0 Ns B Pq ulong 590Max size of ARC in bytes. 591If 592.Sy 0 , 593then the max size of ARC is determined by the amount of system memory installed. 594Under Linux, half of system memory will be used as the limit. 595Under 596.Fx , 597the larger of 598.Sy all_system_memory No \- Sy 1GB 599and 600.Sy 5/8 No \(mu Sy all_system_memory 601will be used as the limit. 602This value must be at least 603.Sy 67108864 Ns B Pq 64MB . 604.Pp 605This value can be changed dynamically, with some caveats. 606It cannot be set back to 607.Sy 0 608while running, and reducing it below the current ARC size will not cause 609the ARC to shrink without memory pressure to induce shrinking. 610. 611.It Sy zfs_arc_meta_adjust_restarts Ns = Ns Sy 4096 Pq ulong 612The number of restart passes to make while scanning the ARC attempting 613the free buffers in order to stay below the 614.Sy fs_arc_meta_limit . 615This value should not need to be tuned but is available to facilitate 616performance analysis. 617. 618.It Sy zfs_arc_meta_limit Ns = Ns Sy 0 Ns B Pq ulong 619The maximum allowed size in bytes that metadata buffers are allowed to 620consume in the ARC. 621When this limit is reached, metadata buffers will be reclaimed, 622even if the overall 623.Sy arc_c_max 624has not been reached. 625It defaults to 626.Sy 0 , 627which indicates that a percentage based on 628.Sy zfs_arc_meta_limit_percent 629of the ARC may be used for metadata. 630.Pp 631This value my be changed dynamically, except that must be set to an explicit value 632.Pq cannot be set back to Sy 0 . 633. 634.It Sy zfs_arc_meta_limit_percent Ns = Ns Sy 75 Ns % Pq ulong 635Percentage of ARC buffers that can be used for metadata. 636.Pp 637See also 638.Sy zfs_arc_meta_limit , 639which serves a similar purpose but has a higher priority if nonzero. 640. 641.It Sy zfs_arc_meta_min Ns = Ns Sy 0 Ns B Pq ulong 642The minimum allowed size in bytes that metadata buffers may consume in 643the ARC. 644. 645.It Sy zfs_arc_meta_prune Ns = Ns Sy 10000 Pq int 646The number of dentries and inodes to be scanned looking for entries 647which can be dropped. 648This may be required when the ARC reaches the 649.Sy zfs_arc_meta_limit 650because dentries and inodes can pin buffers in the ARC. 651Increasing this value will cause to dentry and inode caches 652to be pruned more aggressively. 653Setting this value to 654.Sy 0 655will disable pruning the inode and dentry caches. 656. 657.It Sy zfs_arc_meta_strategy Ns = Ns Sy 1 Ns | Ns 0 Pq int 658Define the strategy for ARC metadata buffer eviction (meta reclaim strategy): 659.Bl -tag -compact -offset 4n -width "0 (META_ONLY)" 660.It Sy 0 Pq META_ONLY 661evict only the ARC metadata buffers 662.It Sy 1 Pq BALANCED 663additional data buffers may be evicted if required 664to evict the required number of metadata buffers. 665.El 666. 667.It Sy zfs_arc_min Ns = Ns Sy 0 Ns B Pq ulong 668Min size of ARC in bytes. 669.No If set to Sy 0 , arc_c_min 670will default to consuming the larger of 671.Sy 32MB 672and 673.Sy all_system_memory No / Sy 32 . 674. 675.It Sy zfs_arc_min_prefetch_ms Ns = Ns Sy 0 Ns ms Ns Po Ns ≡ Ns 1s Pc Pq int 676Minimum time prefetched blocks are locked in the ARC. 677. 678.It Sy zfs_arc_min_prescient_prefetch_ms Ns = Ns Sy 0 Ns ms Ns Po Ns ≡ Ns 6s Pc Pq int 679Minimum time "prescient prefetched" blocks are locked in the ARC. 680These blocks are meant to be prefetched fairly aggressively ahead of 681the code that may use them. 682. 683.It Sy zfs_arc_prune_task_threads Ns = Ns Sy 1 Pq int 684Number of arc_prune threads. 685.Fx 686does not need more than one. 687Linux may theoretically use one per mount point up to number of CPUs, 688but that was not proven to be useful. 689. 690.It Sy zfs_max_missing_tvds Ns = Ns Sy 0 Pq int 691Number of missing top-level vdevs which will be allowed during 692pool import (only in read-only mode). 693. 694.It Sy zfs_max_nvlist_src_size Ns = Sy 0 Pq ulong 695Maximum size in bytes allowed to be passed as 696.Sy zc_nvlist_src_size 697for ioctls on 698.Pa /dev/zfs . 699This prevents a user from causing the kernel to allocate 700an excessive amount of memory. 701When the limit is exceeded, the ioctl fails with 702.Sy EINVAL 703and a description of the error is sent to the 704.Pa zfs-dbgmsg 705log. 706This parameter should not need to be touched under normal circumstances. 707If 708.Sy 0 , 709equivalent to a quarter of the user-wired memory limit under 710.Fx 711and to 712.Sy 134217728 Ns B Pq 128MB 713under Linux. 714. 715.It Sy zfs_multilist_num_sublists Ns = Ns Sy 0 Pq int 716To allow more fine-grained locking, each ARC state contains a series 717of lists for both data and metadata objects. 718Locking is performed at the level of these "sub-lists". 719This parameters controls the number of sub-lists per ARC state, 720and also applies to other uses of the multilist data structure. 721.Pp 722If 723.Sy 0 , 724equivalent to the greater of the number of online CPUs and 725.Sy 4 . 726. 727.It Sy zfs_arc_overflow_shift Ns = Ns Sy 8 Pq int 728The ARC size is considered to be overflowing if it exceeds the current 729ARC target size 730.Pq Sy arc_c 731by thresholds determined by this parameter. 732Exceeding by 733.Sy ( arc_c No >> Sy zfs_arc_overflow_shift ) No / Sy 2 734starts ARC reclamation process. 735If that appears insufficient, exceeding by 736.Sy ( arc_c No >> Sy zfs_arc_overflow_shift ) No \(mu Sy 1.5 737blocks new buffer allocation until the reclaim thread catches up. 738Started reclamation process continues till ARC size returns below the 739target size. 740.Pp 741The default value of 742.Sy 8 743causes the ARC to start reclamation if it exceeds the target size by 744.Em 0.2% 745of the target size, and block allocations by 746.Em 0.6% . 747. 748.It Sy zfs_arc_p_min_shift Ns = Ns Sy 0 Pq int 749If nonzero, this will update 750.Sy arc_p_min_shift Pq default Sy 4 751with the new value. 752.Sy arc_p_min_shift No is used as a shift of Sy arc_c 753when calculating the minumum 754.Sy arc_p No size. 755. 756.It Sy zfs_arc_p_dampener_disable Ns = Ns Sy 1 Ns | Ns 0 Pq int 757Disable 758.Sy arc_p 759adapt dampener, which reduces the maximum single adjustment to 760.Sy arc_p . 761. 762.It Sy zfs_arc_shrink_shift Ns = Ns Sy 0 Pq int 763If nonzero, this will update 764.Sy arc_shrink_shift Pq default Sy 7 765with the new value. 766. 767.It Sy zfs_arc_pc_percent Ns = Ns Sy 0 Ns % Po off Pc Pq uint 768Percent of pagecache to reclaim ARC to. 769.Pp 770This tunable allows the ZFS ARC to play more nicely 771with the kernel's LRU pagecache. 772It can guarantee that the ARC size won't collapse under scanning 773pressure on the pagecache, yet still allows the ARC to be reclaimed down to 774.Sy zfs_arc_min 775if necessary. 776This value is specified as percent of pagecache size (as measured by 777.Sy NR_FILE_PAGES ) , 778where that percent may exceed 779.Sy 100 . 780This 781only operates during memory pressure/reclaim. 782. 783.It Sy zfs_arc_shrinker_limit Ns = Ns Sy 10000 Pq int 784This is a limit on how many pages the ARC shrinker makes available for 785eviction in response to one page allocation attempt. 786Note that in practice, the kernel's shrinker can ask us to evict 787up to about four times this for one allocation attempt. 788.Pp 789The default limit of 790.Sy 10000 Pq in practice, Em 160MB No per allocation attempt with 4kB pages 791limits the amount of time spent attempting to reclaim ARC memory to 792less than 100ms per allocation attempt, 793even with a small average compressed block size of ~8kB. 794.Pp 795The parameter can be set to 0 (zero) to disable the limit, 796and only applies on Linux. 797. 798.It Sy zfs_arc_sys_free Ns = Ns Sy 0 Ns B Pq ulong 799The target number of bytes the ARC should leave as free memory on the system. 800If zero, equivalent to the bigger of 801.Sy 512kB No and Sy all_system_memory/64 . 802. 803.It Sy zfs_autoimport_disable Ns = Ns Sy 1 Ns | Ns 0 Pq int 804Disable pool import at module load by ignoring the cache file 805.Pq Sy spa_config_path . 806. 807.It Sy zfs_checksum_events_per_second Ns = Ns Sy 20 Ns /s Pq uint 808Rate limit checksum events to this many per second. 809Note that this should not be set below the ZED thresholds 810(currently 10 checksums over 10 seconds) 811or else the daemon may not trigger any action. 812. 813.It Sy zfs_commit_timeout_pct Ns = Ns Sy 5 Ns % Pq int 814This controls the amount of time that a ZIL block (lwb) will remain "open" 815when it isn't "full", and it has a thread waiting for it to be committed to 816stable storage. 817The timeout is scaled based on a percentage of the last lwb 818latency to avoid significantly impacting the latency of each individual 819transaction record (itx). 820. 821.It Sy zfs_condense_indirect_commit_entry_delay_ms Ns = Ns Sy 0 Ns ms Pq int 822Vdev indirection layer (used for device removal) sleeps for this many 823milliseconds during mapping generation. 824Intended for use with the test suite to throttle vdev removal speed. 825. 826.It Sy zfs_condense_indirect_obsolete_pct Ns = Ns Sy 25 Ns % Pq int 827Minimum percent of obsolete bytes in vdev mapping required to attempt to condense 828.Pq see Sy zfs_condense_indirect_vdevs_enable . 829Intended for use with the test suite 830to facilitate triggering condensing as needed. 831. 832.It Sy zfs_condense_indirect_vdevs_enable Ns = Ns Sy 1 Ns | Ns 0 Pq int 833Enable condensing indirect vdev mappings. 834When set, attempt to condense indirect vdev mappings 835if the mapping uses more than 836.Sy zfs_condense_min_mapping_bytes 837bytes of memory and if the obsolete space map object uses more than 838.Sy zfs_condense_max_obsolete_bytes 839bytes on-disk. 840The condensing process is an attempt to save memory by removing obsolete mappings. 841. 842.It Sy zfs_condense_max_obsolete_bytes Ns = Ns Sy 1073741824 Ns B Po 1GB Pc Pq ulong 843Only attempt to condense indirect vdev mappings if the on-disk size 844of the obsolete space map object is greater than this number of bytes 845.Pq see Sy zfs_condense_indirect_vdevs_enable . 846. 847.It Sy zfs_condense_min_mapping_bytes Ns = Ns Sy 131072 Ns B Po 128kB Pc Pq ulong 848Minimum size vdev mapping to attempt to condense 849.Pq see Sy zfs_condense_indirect_vdevs_enable . 850. 851.It Sy zfs_dbgmsg_enable Ns = Ns Sy 1 Ns | Ns 0 Pq int 852Internally ZFS keeps a small log to facilitate debugging. 853The log is enabled by default, and can be disabled by unsetting this option. 854The contents of the log can be accessed by reading 855.Pa /proc/spl/kstat/zfs/dbgmsg . 856Writing 857.Sy 0 858to the file clears the log. 859.Pp 860This setting does not influence debug prints due to 861.Sy zfs_flags . 862. 863.It Sy zfs_dbgmsg_maxsize Ns = Ns Sy 4194304 Ns B Po 4MB Pc Pq int 864Maximum size of the internal ZFS debug log. 865. 866.It Sy zfs_dbuf_state_index Ns = Ns Sy 0 Pq int 867Historically used for controlling what reporting was available under 868.Pa /proc/spl/kstat/zfs . 869No effect. 870. 871.It Sy zfs_deadman_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int 872When a pool sync operation takes longer than 873.Sy zfs_deadman_synctime_ms , 874or when an individual I/O operation takes longer than 875.Sy zfs_deadman_ziotime_ms , 876then the operation is considered to be "hung". 877If 878.Sy zfs_deadman_enabled 879is set, then the deadman behavior is invoked as described by 880.Sy zfs_deadman_failmode . 881By default, the deadman is enabled and set to 882.Sy wait 883which results in "hung" I/Os only being logged. 884The deadman is automatically disabled when a pool gets suspended. 885. 886.It Sy zfs_deadman_failmode Ns = Ns Sy wait Pq charp 887Controls the failure behavior when the deadman detects a "hung" I/O operation. 888Valid values are: 889.Bl -tag -compact -offset 4n -width "continue" 890.It Sy wait 891Wait for a "hung" operation to complete. 892For each "hung" operation a "deadman" event will be posted 893describing that operation. 894.It Sy continue 895Attempt to recover from a "hung" operation by re-dispatching it 896to the I/O pipeline if possible. 897.It Sy panic 898Panic the system. 899This can be used to facilitate automatic fail-over 900to a properly configured fail-over partner. 901.El 902. 903.It Sy zfs_deadman_checktime_ms Ns = Ns Sy 60000 Ns ms Po 1min Pc Pq int 904Check time in milliseconds. 905This defines the frequency at which we check for hung I/O requests 906and potentially invoke the 907.Sy zfs_deadman_failmode 908behavior. 909. 910.It Sy zfs_deadman_synctime_ms Ns = Ns Sy 600000 Ns ms Po 10min Pc Pq ulong 911Interval in milliseconds after which the deadman is triggered and also 912the interval after which a pool sync operation is considered to be "hung". 913Once this limit is exceeded the deadman will be invoked every 914.Sy zfs_deadman_checktime_ms 915milliseconds until the pool sync completes. 916. 917.It Sy zfs_deadman_ziotime_ms Ns = Ns Sy 300000 Ns ms Po 5min Pc Pq ulong 918Interval in milliseconds after which the deadman is triggered and an 919individual I/O operation is considered to be "hung". 920As long as the operation remains "hung", 921the deadman will be invoked every 922.Sy zfs_deadman_checktime_ms 923milliseconds until the operation completes. 924. 925.It Sy zfs_dedup_prefetch Ns = Ns Sy 0 Ns | Ns 1 Pq int 926Enable prefetching dedup-ed blocks which are going to be freed. 927. 928.It Sy zfs_delay_min_dirty_percent Ns = Ns Sy 60 Ns % Pq int 929Start to delay each transaction once there is this amount of dirty data, 930expressed as a percentage of 931.Sy zfs_dirty_data_max . 932This value should be at least 933.Sy zfs_vdev_async_write_active_max_dirty_percent . 934.No See Sx ZFS TRANSACTION DELAY . 935. 936.It Sy zfs_delay_scale Ns = Ns Sy 500000 Pq int 937This controls how quickly the transaction delay approaches infinity. 938Larger values cause longer delays for a given amount of dirty data. 939.Pp 940For the smoothest delay, this value should be about 1 billion divided 941by the maximum number of operations per second. 942This will smoothly handle between ten times and a tenth of this number. 943.No See Sx ZFS TRANSACTION DELAY . 944.Pp 945.Sy zfs_delay_scale No \(mu Sy zfs_dirty_data_max Em must No be smaller than Sy 2^64 . 946. 947.It Sy zfs_disable_ivset_guid_check Ns = Ns Sy 0 Ns | Ns 1 Pq int 948Disables requirement for IVset GUIDs to be present and match when doing a raw 949receive of encrypted datasets. 950Intended for users whose pools were created with 951OpenZFS pre-release versions and now have compatibility issues. 952. 953.It Sy zfs_key_max_salt_uses Ns = Ns Sy 400000000 Po 4*10^8 Pc Pq ulong 954Maximum number of uses of a single salt value before generating a new one for 955encrypted datasets. 956The default value is also the maximum. 957. 958.It Sy zfs_object_mutex_size Ns = Ns Sy 64 Pq uint 959Size of the znode hashtable used for holds. 960.Pp 961Due to the need to hold locks on objects that may not exist yet, kernel mutexes 962are not created per-object and instead a hashtable is used where collisions 963will result in objects waiting when there is not actually contention on the 964same object. 965. 966.It Sy zfs_slow_io_events_per_second Ns = Ns Sy 20 Ns /s Pq int 967Rate limit delay and deadman zevents (which report slow I/Os) to this many per 968second. 969. 970.It Sy zfs_unflushed_max_mem_amt Ns = Ns Sy 1073741824 Ns B Po 1GB Pc Pq ulong 971Upper-bound limit for unflushed metadata changes to be held by the 972log spacemap in memory, in bytes. 973. 974.It Sy zfs_unflushed_max_mem_ppm Ns = Ns Sy 1000 Ns ppm Po 0.1% Pc Pq ulong 975Part of overall system memory that ZFS allows to be used 976for unflushed metadata changes by the log spacemap, in millionths. 977. 978.It Sy zfs_unflushed_log_block_max Ns = Ns Sy 262144 Po 256k Pc Pq ulong 979Describes the maximum number of log spacemap blocks allowed for each pool. 980The default value means that the space in all the log spacemaps 981can add up to no more than 982.Sy 262144 983blocks (which means 984.Em 32GB 985of logical space before compression and ditto blocks, 986assuming that blocksize is 987.Em 128kB ) . 988.Pp 989This tunable is important because it involves a trade-off between import 990time after an unclean export and the frequency of flushing metaslabs. 991The higher this number is, the more log blocks we allow when the pool is 992active which means that we flush metaslabs less often and thus decrease 993the number of I/Os for spacemap updates per TXG. 994At the same time though, that means that in the event of an unclean export, 995there will be more log spacemap blocks for us to read, inducing overhead 996in the import time of the pool. 997The lower the number, the amount of flushing increases, destroying log 998blocks quicker as they become obsolete faster, which leaves less blocks 999to be read during import time after a crash. 1000.Pp 1001Each log spacemap block existing during pool import leads to approximately 1002one extra logical I/O issued. 1003This is the reason why this tunable is exposed in terms of blocks rather 1004than space used. 1005. 1006.It Sy zfs_unflushed_log_block_min Ns = Ns Sy 1000 Pq ulong 1007If the number of metaslabs is small and our incoming rate is high, 1008we could get into a situation that we are flushing all our metaslabs every TXG. 1009Thus we always allow at least this many log blocks. 1010. 1011.It Sy zfs_unflushed_log_block_pct Ns = Ns Sy 400 Ns % Pq ulong 1012Tunable used to determine the number of blocks that can be used for 1013the spacemap log, expressed as a percentage of the total number of 1014metaslabs in the pool. 1015. 1016.It Sy zfs_unlink_suspend_progress Ns = Ns Sy 0 Ns | Ns 1 Pq uint 1017When enabled, files will not be asynchronously removed from the list of pending 1018unlinks and the space they consume will be leaked. 1019Once this option has been disabled and the dataset is remounted, 1020the pending unlinks will be processed and the freed space returned to the pool. 1021This option is used by the test suite. 1022. 1023.It Sy zfs_delete_blocks Ns = Ns Sy 20480 Pq ulong 1024This is the used to define a large file for the purposes of deletion. 1025Files containing more than 1026.Sy zfs_delete_blocks 1027will be deleted asynchronously, while smaller files are deleted synchronously. 1028Decreasing this value will reduce the time spent in an 1029.Xr unlink 2 1030system call, at the expense of a longer delay before the freed space is available. 1031. 1032.It Sy zfs_dirty_data_max Ns = Pq int 1033Determines the dirty space limit in bytes. 1034Once this limit is exceeded, new writes are halted until space frees up. 1035This parameter takes precedence over 1036.Sy zfs_dirty_data_max_percent . 1037.No See Sx ZFS TRANSACTION DELAY . 1038.Pp 1039Defaults to 1040.Sy physical_ram/10 , 1041capped at 1042.Sy zfs_dirty_data_max_max . 1043. 1044.It Sy zfs_dirty_data_max_max Ns = Pq int 1045Maximum allowable value of 1046.Sy zfs_dirty_data_max , 1047expressed in bytes. 1048This limit is only enforced at module load time, and will be ignored if 1049.Sy zfs_dirty_data_max 1050is later changed. 1051This parameter takes precedence over 1052.Sy zfs_dirty_data_max_max_percent . 1053.No See Sx ZFS TRANSACTION DELAY . 1054.Pp 1055Defaults to 1056.Sy physical_ram/4 , 1057. 1058.It Sy zfs_dirty_data_max_max_percent Ns = Ns Sy 25 Ns % Pq int 1059Maximum allowable value of 1060.Sy zfs_dirty_data_max , 1061expressed as a percentage of physical RAM. 1062This limit is only enforced at module load time, and will be ignored if 1063.Sy zfs_dirty_data_max 1064is later changed. 1065The parameter 1066.Sy zfs_dirty_data_max_max 1067takes precedence over this one. 1068.No See Sx ZFS TRANSACTION DELAY . 1069. 1070.It Sy zfs_dirty_data_max_percent Ns = Ns Sy 10 Ns % Pq int 1071Determines the dirty space limit, expressed as a percentage of all memory. 1072Once this limit is exceeded, new writes are halted until space frees up. 1073The parameter 1074.Sy zfs_dirty_data_max 1075takes precedence over this one. 1076.No See Sx ZFS TRANSACTION DELAY . 1077.Pp 1078Subject to 1079.Sy zfs_dirty_data_max_max . 1080. 1081.It Sy zfs_dirty_data_sync_percent Ns = Ns Sy 20 Ns % Pq int 1082Start syncing out a transaction group if there's at least this much dirty data 1083.Pq as a percentage of Sy zfs_dirty_data_max . 1084This should be less than 1085.Sy zfs_vdev_async_write_active_min_dirty_percent . 1086. 1087.It Sy zfs_wrlog_data_max Ns = Pq int 1088The upper limit of write-transaction zil log data size in bytes. 1089Once it is reached, write operation is blocked, until log data is cleared out 1090after transaction group sync. Because of some overhead, it should be set 1091at least 2 times the size of 1092.Sy zfs_dirty_data_max 1093.No to prevent harming normal write throughput. 1094It also should be smaller than the size of the slog device if slog is present. 1095.Pp 1096Defaults to 1097.Sy zfs_dirty_data_max*2 1098. 1099.It Sy zfs_fallocate_reserve_percent Ns = Ns Sy 110 Ns % Pq uint 1100Since ZFS is a copy-on-write filesystem with snapshots, blocks cannot be 1101preallocated for a file in order to guarantee that later writes will not 1102run out of space. 1103Instead, 1104.Xr fallocate 2 1105space preallocation only checks that sufficient space is currently available 1106in the pool or the user's project quota allocation, 1107and then creates a sparse file of the requested size. 1108The requested space is multiplied by 1109.Sy zfs_fallocate_reserve_percent 1110to allow additional space for indirect blocks and other internal metadata. 1111Setting this to 1112.Sy 0 1113disables support for 1114.Xr fallocate 2 1115and causes it to return 1116.Sy EOPNOTSUPP . 1117. 1118.It Sy zfs_fletcher_4_impl Ns = Ns Sy fastest Pq string 1119Select a fletcher 4 implementation. 1120.Pp 1121Supported selectors are: 1122.Sy fastest , scalar , sse2 , ssse3 , avx2 , avx512f , avx512bw , 1123.No and Sy aarch64_neon . 1124All except 1125.Sy fastest No and Sy scalar 1126require instruction set extensions to be available, 1127and will only appear if ZFS detects that they are present at runtime. 1128If multiple implementations of fletcher 4 are available, the 1129.Sy fastest 1130will be chosen using a micro benchmark. 1131Selecting 1132.Sy scalar 1133results in the original CPU-based calculation being used. 1134Selecting any option other than 1135.Sy fastest No or Sy scalar 1136results in vector instructions 1137from the respective CPU instruction set being used. 1138. 1139.It Sy zfs_free_bpobj_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int 1140Enable/disable the processing of the free_bpobj object. 1141. 1142.It Sy zfs_async_block_max_blocks Ns = Ns Sy ULONG_MAX Po unlimited Pc Pq ulong 1143Maximum number of blocks freed in a single TXG. 1144. 1145.It Sy zfs_max_async_dedup_frees Ns = Ns Sy 100000 Po 10^5 Pc Pq ulong 1146Maximum number of dedup blocks freed in a single TXG. 1147. 1148.It Sy zfs_vdev_async_read_max_active Ns = Ns Sy 3 Pq int 1149Maximum asynchronous read I/O operations active to each device. 1150.No See Sx ZFS I/O SCHEDULER . 1151. 1152.It Sy zfs_vdev_async_read_min_active Ns = Ns Sy 1 Pq int 1153Minimum asynchronous read I/O operation active to each device. 1154.No See Sx ZFS I/O SCHEDULER . 1155. 1156.It Sy zfs_vdev_async_write_active_max_dirty_percent Ns = Ns Sy 60 Ns % Pq int 1157When the pool has more than this much dirty data, use 1158.Sy zfs_vdev_async_write_max_active 1159to limit active async writes. 1160If the dirty data is between the minimum and maximum, 1161the active I/O limit is linearly interpolated. 1162.No See Sx ZFS I/O SCHEDULER . 1163. 1164.It Sy zfs_vdev_async_write_active_min_dirty_percent Ns = Ns Sy 30 Ns % Pq int 1165When the pool has less than this much dirty data, use 1166.Sy zfs_vdev_async_write_min_active 1167to limit active async writes. 1168If the dirty data is between the minimum and maximum, 1169the active I/O limit is linearly 1170interpolated. 1171.No See Sx ZFS I/O SCHEDULER . 1172. 1173.It Sy zfs_vdev_async_write_max_active Ns = Ns Sy 30 Pq int 1174Maximum asynchronous write I/O operations active to each device. 1175.No See Sx ZFS I/O SCHEDULER . 1176. 1177.It Sy zfs_vdev_async_write_min_active Ns = Ns Sy 2 Pq int 1178Minimum asynchronous write I/O operations active to each device. 1179.No See Sx ZFS I/O SCHEDULER . 1180.Pp 1181Lower values are associated with better latency on rotational media but poorer 1182resilver performance. 1183The default value of 1184.Sy 2 1185was chosen as a compromise. 1186A value of 1187.Sy 3 1188has been shown to improve resilver performance further at a cost of 1189further increasing latency. 1190. 1191.It Sy zfs_vdev_initializing_max_active Ns = Ns Sy 1 Pq int 1192Maximum initializing I/O operations active to each device. 1193.No See Sx ZFS I/O SCHEDULER . 1194. 1195.It Sy zfs_vdev_initializing_min_active Ns = Ns Sy 1 Pq int 1196Minimum initializing I/O operations active to each device. 1197.No See Sx ZFS I/O SCHEDULER . 1198. 1199.It Sy zfs_vdev_max_active Ns = Ns Sy 1000 Pq int 1200The maximum number of I/O operations active to each device. 1201Ideally, this will be at least the sum of each queue's 1202.Sy max_active . 1203.No See Sx ZFS I/O SCHEDULER . 1204. 1205.It Sy zfs_vdev_rebuild_max_active Ns = Ns Sy 3 Pq int 1206Maximum sequential resilver I/O operations active to each device. 1207.No See Sx ZFS I/O SCHEDULER . 1208. 1209.It Sy zfs_vdev_rebuild_min_active Ns = Ns Sy 1 Pq int 1210Minimum sequential resilver I/O operations active to each device. 1211.No See Sx ZFS I/O SCHEDULER . 1212. 1213.It Sy zfs_vdev_removal_max_active Ns = Ns Sy 2 Pq int 1214Maximum removal I/O operations active to each device. 1215.No See Sx ZFS I/O SCHEDULER . 1216. 1217.It Sy zfs_vdev_removal_min_active Ns = Ns Sy 1 Pq int 1218Minimum removal I/O operations active to each device. 1219.No See Sx ZFS I/O SCHEDULER . 1220. 1221.It Sy zfs_vdev_scrub_max_active Ns = Ns Sy 2 Pq int 1222Maximum scrub I/O operations active to each device. 1223.No See Sx ZFS I/O SCHEDULER . 1224. 1225.It Sy zfs_vdev_scrub_min_active Ns = Ns Sy 1 Pq int 1226Minimum scrub I/O operations active to each device. 1227.No See Sx ZFS I/O SCHEDULER . 1228. 1229.It Sy zfs_vdev_sync_read_max_active Ns = Ns Sy 10 Pq int 1230Maximum synchronous read I/O operations active to each device. 1231.No See Sx ZFS I/O SCHEDULER . 1232. 1233.It Sy zfs_vdev_sync_read_min_active Ns = Ns Sy 10 Pq int 1234Minimum synchronous read I/O operations active to each device. 1235.No See Sx ZFS I/O SCHEDULER . 1236. 1237.It Sy zfs_vdev_sync_write_max_active Ns = Ns Sy 10 Pq int 1238Maximum synchronous write I/O operations active to each device. 1239.No See Sx ZFS I/O SCHEDULER . 1240. 1241.It Sy zfs_vdev_sync_write_min_active Ns = Ns Sy 10 Pq int 1242Minimum synchronous write I/O operations active to each device. 1243.No See Sx ZFS I/O SCHEDULER . 1244. 1245.It Sy zfs_vdev_trim_max_active Ns = Ns Sy 2 Pq int 1246Maximum trim/discard I/O operations active to each device. 1247.No See Sx ZFS I/O SCHEDULER . 1248. 1249.It Sy zfs_vdev_trim_min_active Ns = Ns Sy 1 Pq int 1250Minimum trim/discard I/O operations active to each device. 1251.No See Sx ZFS I/O SCHEDULER . 1252. 1253.It Sy zfs_vdev_nia_delay Ns = Ns Sy 5 Pq int 1254For non-interactive I/O (scrub, resilver, removal, initialize and rebuild), 1255the number of concurrently-active I/O operations is limited to 1256.Sy zfs_*_min_active , 1257unless the vdev is "idle". 1258When there are no interactive I/O operations active (synchronous or otherwise), 1259and 1260.Sy zfs_vdev_nia_delay 1261operations have completed since the last interactive operation, 1262then the vdev is considered to be "idle", 1263and the number of concurrently-active non-interactive operations is increased to 1264.Sy zfs_*_max_active . 1265.No See Sx ZFS I/O SCHEDULER . 1266. 1267.It Sy zfs_vdev_nia_credit Ns = Ns Sy 5 Pq int 1268Some HDDs tend to prioritize sequential I/O so strongly, that concurrent 1269random I/O latency reaches several seconds. 1270On some HDDs this happens even if sequential I/O operations 1271are submitted one at a time, and so setting 1272.Sy zfs_*_max_active Ns = Sy 1 1273does not help. 1274To prevent non-interactive I/O, like scrub, 1275from monopolizing the device, no more than 1276.Sy zfs_vdev_nia_credit operations can be sent 1277while there are outstanding incomplete interactive operations. 1278This enforced wait ensures the HDD services the interactive I/O 1279within a reasonable amount of time. 1280.No See Sx ZFS I/O SCHEDULER . 1281. 1282.It Sy zfs_vdev_queue_depth_pct Ns = Ns Sy 1000 Ns % Pq int 1283Maximum number of queued allocations per top-level vdev expressed as 1284a percentage of 1285.Sy zfs_vdev_async_write_max_active , 1286which allows the system to detect devices that are more capable 1287of handling allocations and to allocate more blocks to those devices. 1288This allows for dynamic allocation distribution when devices are imbalanced, 1289as fuller devices will tend to be slower than empty devices. 1290.Pp 1291Also see 1292.Sy zio_dva_throttle_enabled . 1293. 1294.It Sy zfs_expire_snapshot Ns = Ns Sy 300 Ns s Pq int 1295Time before expiring 1296.Pa .zfs/snapshot . 1297. 1298.It Sy zfs_admin_snapshot Ns = Ns Sy 0 Ns | Ns 1 Pq int 1299Allow the creation, removal, or renaming of entries in the 1300.Sy .zfs/snapshot 1301directory to cause the creation, destruction, or renaming of snapshots. 1302When enabled, this functionality works both locally and over NFS exports 1303which have the 1304.Em no_root_squash 1305option set. 1306. 1307.It Sy zfs_flags Ns = Ns Sy 0 Pq int 1308Set additional debugging flags. 1309The following flags may be bitwise-ored together: 1310.TS 1311box; 1312lbz r l l . 1313 Value Symbolic Name Description 1314_ 1315 1 ZFS_DEBUG_DPRINTF Enable dprintf entries in the debug log. 1316* 2 ZFS_DEBUG_DBUF_VERIFY Enable extra dbuf verifications. 1317* 4 ZFS_DEBUG_DNODE_VERIFY Enable extra dnode verifications. 1318 8 ZFS_DEBUG_SNAPNAMES Enable snapshot name verification. 1319 16 ZFS_DEBUG_MODIFY Check for illegally modified ARC buffers. 1320 64 ZFS_DEBUG_ZIO_FREE Enable verification of block frees. 1321 128 ZFS_DEBUG_HISTOGRAM_VERIFY Enable extra spacemap histogram verifications. 1322 256 ZFS_DEBUG_METASLAB_VERIFY Verify space accounting on disk matches in-memory \fBrange_trees\fP. 1323 512 ZFS_DEBUG_SET_ERROR Enable \fBSET_ERROR\fP and dprintf entries in the debug log. 1324 1024 ZFS_DEBUG_INDIRECT_REMAP Verify split blocks created by device removal. 1325 2048 ZFS_DEBUG_TRIM Verify TRIM ranges are always within the allocatable range tree. 1326 4096 ZFS_DEBUG_LOG_SPACEMAP Verify that the log summary is consistent with the spacemap log 1327 and enable \fBzfs_dbgmsgs\fP for metaslab loading and flushing. 1328.TE 1329.Sy \& * No Requires debug build. 1330. 1331.It Sy zfs_free_leak_on_eio Ns = Ns Sy 0 Ns | Ns 1 Pq int 1332If destroy encounters an 1333.Sy EIO 1334while reading metadata (e.g. indirect blocks), 1335space referenced by the missing metadata can not be freed. 1336Normally this causes the background destroy to become "stalled", 1337as it is unable to make forward progress. 1338While in this stalled state, all remaining space to free 1339from the error-encountering filesystem is "temporarily leaked". 1340Set this flag to cause it to ignore the 1341.Sy EIO , 1342permanently leak the space from indirect blocks that can not be read, 1343and continue to free everything else that it can. 1344.Pp 1345The default "stalling" behavior is useful if the storage partially 1346fails (i.e. some but not all I/O operations fail), and then later recovers. 1347In this case, we will be able to continue pool operations while it is 1348partially failed, and when it recovers, we can continue to free the 1349space, with no leaks. 1350Note, however, that this case is actually fairly rare. 1351.Pp 1352Typically pools either 1353.Bl -enum -compact -offset 4n -width "1." 1354.It 1355fail completely (but perhaps temporarily, 1356e.g. due to a top-level vdev going offline), or 1357.It 1358have localized, permanent errors (e.g. disk returns the wrong data 1359due to bit flip or firmware bug). 1360.El 1361In the former case, this setting does not matter because the 1362pool will be suspended and the sync thread will not be able to make 1363forward progress regardless. 1364In the latter, because the error is permanent, the best we can do 1365is leak the minimum amount of space, 1366which is what setting this flag will do. 1367It is therefore reasonable for this flag to normally be set, 1368but we chose the more conservative approach of not setting it, 1369so that there is no possibility of 1370leaking space in the "partial temporary" failure case. 1371. 1372.It Sy zfs_free_min_time_ms Ns = Ns Sy 1000 Ns ms Po 1s Pc Pq int 1373During a 1374.Nm zfs Cm destroy 1375operation using the 1376.Sy async_destroy 1377feature, 1378a minimum of this much time will be spent working on freeing blocks per TXG. 1379. 1380.It Sy zfs_obsolete_min_time_ms Ns = Ns Sy 500 Ns ms Pq int 1381Similar to 1382.Sy zfs_free_min_time_ms , 1383but for cleanup of old indirection records for removed vdevs. 1384. 1385.It Sy zfs_immediate_write_sz Ns = Ns Sy 32768 Ns B Po 32kB Pc Pq long 1386Largest data block to write to the ZIL. 1387Larger blocks will be treated as if the dataset being written to had the 1388.Sy logbias Ns = Ns Sy throughput 1389property set. 1390. 1391.It Sy zfs_initialize_value Ns = Ns Sy 16045690984833335022 Po 0xDEADBEEFDEADBEEE Pc Pq ulong 1392Pattern written to vdev free space by 1393.Xr zpool-initialize 8 . 1394. 1395.It Sy zfs_initialize_chunk_size Ns = Ns Sy 1048576 Ns B Po 1MB Pc Pq ulong 1396Size of writes used by 1397.Xr zpool-initialize 8 . 1398This option is used by the test suite. 1399. 1400.It Sy zfs_livelist_max_entries Ns = Ns Sy 500000 Po 5*10^5 Pc Pq ulong 1401The threshold size (in block pointers) at which we create a new sub-livelist. 1402Larger sublists are more costly from a memory perspective but the fewer 1403sublists there are, the lower the cost of insertion. 1404. 1405.It Sy zfs_livelist_min_percent_shared Ns = Ns Sy 75 Ns % Pq int 1406If the amount of shared space between a snapshot and its clone drops below 1407this threshold, the clone turns off the livelist and reverts to the old 1408deletion method. 1409This is in place because livelists no long give us a benefit 1410once a clone has been overwritten enough. 1411. 1412.It Sy zfs_livelist_condense_new_alloc Ns = Ns Sy 0 Pq int 1413Incremented each time an extra ALLOC blkptr is added to a livelist entry while 1414it is being condensed. 1415This option is used by the test suite to track race conditions. 1416. 1417.It Sy zfs_livelist_condense_sync_cancel Ns = Ns Sy 0 Pq int 1418Incremented each time livelist condensing is canceled while in 1419.Fn spa_livelist_condense_sync . 1420This option is used by the test suite to track race conditions. 1421. 1422.It Sy zfs_livelist_condense_sync_pause Ns = Ns Sy 0 Ns | Ns 1 Pq int 1423When set, the livelist condense process pauses indefinitely before 1424executing the synctask \(em 1425.Fn spa_livelist_condense_sync . 1426This option is used by the test suite to trigger race conditions. 1427. 1428.It Sy zfs_livelist_condense_zthr_cancel Ns = Ns Sy 0 Pq int 1429Incremented each time livelist condensing is canceled while in 1430.Fn spa_livelist_condense_cb . 1431This option is used by the test suite to track race conditions. 1432. 1433.It Sy zfs_livelist_condense_zthr_pause Ns = Ns Sy 0 Ns | Ns 1 Pq int 1434When set, the livelist condense process pauses indefinitely before 1435executing the open context condensing work in 1436.Fn spa_livelist_condense_cb . 1437This option is used by the test suite to trigger race conditions. 1438. 1439.It Sy zfs_lua_max_instrlimit Ns = Ns Sy 100000000 Po 10^8 Pc Pq ulong 1440The maximum execution time limit that can be set for a ZFS channel program, 1441specified as a number of Lua instructions. 1442. 1443.It Sy zfs_lua_max_memlimit Ns = Ns Sy 104857600 Po 100MB Pc Pq ulong 1444The maximum memory limit that can be set for a ZFS channel program, specified 1445in bytes. 1446. 1447.It Sy zfs_max_dataset_nesting Ns = Ns Sy 50 Pq int 1448The maximum depth of nested datasets. 1449This value can be tuned temporarily to 1450fix existing datasets that exceed the predefined limit. 1451. 1452.It Sy zfs_max_log_walking Ns = Ns Sy 5 Pq ulong 1453The number of past TXGs that the flushing algorithm of the log spacemap 1454feature uses to estimate incoming log blocks. 1455. 1456.It Sy zfs_max_logsm_summary_length Ns = Ns Sy 10 Pq ulong 1457Maximum number of rows allowed in the summary of the spacemap log. 1458. 1459.It Sy zfs_max_recordsize Ns = Ns Sy 1048576 Po 1MB Pc Pq int 1460We currently support block sizes from 1461.Em 512B No to Em 16MB . 1462The benefits of larger blocks, and thus larger I/O, 1463need to be weighed against the cost of COWing a giant block to modify one byte. 1464Additionally, very large blocks can have an impact on I/O latency, 1465and also potentially on the memory allocator. 1466Therefore, we do not allow the recordsize to be set larger than this tunable. 1467Larger blocks can be created by changing it, 1468and pools with larger blocks can always be imported and used, 1469regardless of this setting. 1470. 1471.It Sy zfs_allow_redacted_dataset_mount Ns = Ns Sy 0 Ns | Ns 1 Pq int 1472Allow datasets received with redacted send/receive to be mounted. 1473Normally disabled because these datasets may be missing key data. 1474. 1475.It Sy zfs_min_metaslabs_to_flush Ns = Ns Sy 1 Pq ulong 1476Minimum number of metaslabs to flush per dirty TXG. 1477. 1478.It Sy zfs_metaslab_fragmentation_threshold Ns = Ns Sy 70 Ns % Pq int 1479Allow metaslabs to keep their active state as long as their fragmentation 1480percentage is no more than this value. 1481An active metaslab that exceeds this threshold 1482will no longer keep its active status allowing better metaslabs to be selected. 1483. 1484.It Sy zfs_mg_fragmentation_threshold Ns = Ns Sy 95 Ns % Pq int 1485Metaslab groups are considered eligible for allocations if their 1486fragmentation metric (measured as a percentage) is less than or equal to 1487this value. 1488If a metaslab group exceeds this threshold then it will be 1489skipped unless all metaslab groups within the metaslab class have also 1490crossed this threshold. 1491. 1492.It Sy zfs_mg_noalloc_threshold Ns = Ns Sy 0 Ns % Pq int 1493Defines a threshold at which metaslab groups should be eligible for allocations. 1494The value is expressed as a percentage of free space 1495beyond which a metaslab group is always eligible for allocations. 1496If a metaslab group's free space is less than or equal to the 1497threshold, the allocator will avoid allocating to that group 1498unless all groups in the pool have reached the threshold. 1499Once all groups have reached the threshold, all groups are allowed to accept 1500allocations. 1501The default value of 1502.Sy 0 1503disables the feature and causes all metaslab groups to be eligible for allocations. 1504.Pp 1505This parameter allows one to deal with pools having heavily imbalanced 1506vdevs such as would be the case when a new vdev has been added. 1507Setting the threshold to a non-zero percentage will stop allocations 1508from being made to vdevs that aren't filled to the specified percentage 1509and allow lesser filled vdevs to acquire more allocations than they 1510otherwise would under the old 1511.Sy zfs_mg_alloc_failures 1512facility. 1513. 1514.It Sy zfs_ddt_data_is_special Ns = Ns Sy 1 Ns | Ns 0 Pq int 1515If enabled, ZFS will place DDT data into the special allocation class. 1516. 1517.It Sy zfs_user_indirect_is_special Ns = Ns Sy 1 Ns | Ns 0 Pq int 1518If enabled, ZFS will place user data indirect blocks 1519into the special allocation class. 1520. 1521.It Sy zfs_multihost_history Ns = Ns Sy 0 Pq int 1522Historical statistics for this many latest multihost updates will be available in 1523.Pa /proc/spl/kstat/zfs/ Ns Ao Ar pool Ac Ns Pa /multihost . 1524. 1525.It Sy zfs_multihost_interval Ns = Ns Sy 1000 Ns ms Po 1s Pc Pq ulong 1526Used to control the frequency of multihost writes which are performed when the 1527.Sy multihost 1528pool property is on. 1529This is one of the factors used to determine the 1530length of the activity check during import. 1531.Pp 1532The multihost write period is 1533.Sy zfs_multihost_interval No / Sy leaf-vdevs . 1534On average a multihost write will be issued for each leaf vdev 1535every 1536.Sy zfs_multihost_interval 1537milliseconds. 1538In practice, the observed period can vary with the I/O load 1539and this observed value is the delay which is stored in the uberblock. 1540. 1541.It Sy zfs_multihost_import_intervals Ns = Ns Sy 20 Pq uint 1542Used to control the duration of the activity test on import. 1543Smaller values of 1544.Sy zfs_multihost_import_intervals 1545will reduce the import time but increase 1546the risk of failing to detect an active pool. 1547The total activity check time is never allowed to drop below one second. 1548.Pp 1549On import the activity check waits a minimum amount of time determined by 1550.Sy zfs_multihost_interval No \(mu Sy zfs_multihost_import_intervals , 1551or the same product computed on the host which last had the pool imported, 1552whichever is greater. 1553The activity check time may be further extended if the value of MMP 1554delay found in the best uberblock indicates actual multihost updates happened 1555at longer intervals than 1556.Sy zfs_multihost_interval . 1557A minimum of 1558.Em 100ms 1559is enforced. 1560.Pp 1561.Sy 0 No is equivalent to Sy 1 . 1562. 1563.It Sy zfs_multihost_fail_intervals Ns = Ns Sy 10 Pq uint 1564Controls the behavior of the pool when multihost write failures or delays are 1565detected. 1566.Pp 1567When 1568.Sy 0 , 1569multihost write failures or delays are ignored. 1570The failures will still be reported to the ZED which depending on 1571its configuration may take action such as suspending the pool or offlining a 1572device. 1573.Pp 1574Otherwise, the pool will be suspended if 1575.Sy zfs_multihost_fail_intervals No \(mu Sy zfs_multihost_interval 1576milliseconds pass without a successful MMP write. 1577This guarantees the activity test will see MMP writes if the pool is imported. 1578.Sy 1 No is equivalent to Sy 2 ; 1579this is necessary to prevent the pool from being suspended 1580due to normal, small I/O latency variations. 1581. 1582.It Sy zfs_no_scrub_io Ns = Ns Sy 0 Ns | Ns 1 Pq int 1583Set to disable scrub I/O. 1584This results in scrubs not actually scrubbing data and 1585simply doing a metadata crawl of the pool instead. 1586. 1587.It Sy zfs_no_scrub_prefetch Ns = Ns Sy 0 Ns | Ns 1 Pq int 1588Set to disable block prefetching for scrubs. 1589. 1590.It Sy zfs_nocacheflush Ns = Ns Sy 0 Ns | Ns 1 Pq int 1591Disable cache flush operations on disks when writing. 1592Setting this will cause pool corruption on power loss 1593if a volatile out-of-order write cache is enabled. 1594. 1595.It Sy zfs_nopwrite_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int 1596Allow no-operation writes. 1597The occurrence of nopwrites will further depend on other pool properties 1598.Pq i.a. the checksumming and compression algorithms . 1599. 1600.It Sy zfs_dmu_offset_next_sync Ns = Ns Sy 1 Ns | Ns 0 Pq int 1601Enable forcing TXG sync to find holes. 1602When enabled forces ZFS to sync data when 1603.Sy SEEK_HOLE No or Sy SEEK_DATA 1604flags are used allowing holes in a file to be accurately reported. 1605When disabled holes will not be reported in recently dirtied files. 1606. 1607.It Sy zfs_pd_bytes_max Ns = Ns Sy 52428800 Ns B Po 50MB Pc Pq int 1608The number of bytes which should be prefetched during a pool traversal, like 1609.Nm zfs Cm send 1610or other data crawling operations. 1611. 1612.It Sy zfs_traverse_indirect_prefetch_limit Ns = Ns Sy 32 Pq int 1613The number of blocks pointed by indirect (non-L0) block which should be 1614prefetched during a pool traversal, like 1615.Nm zfs Cm send 1616or other data crawling operations. 1617. 1618.It Sy zfs_per_txg_dirty_frees_percent Ns = Ns Sy 5 Ns % Pq ulong 1619Control percentage of dirtied indirect blocks from frees allowed into one TXG. 1620After this threshold is crossed, additional frees will wait until the next TXG. 1621.Sy 0 No disables this throttle. 1622. 1623.It Sy zfs_prefetch_disable Ns = Ns Sy 0 Ns | Ns 1 Pq int 1624Disable predictive prefetch. 1625Note that it leaves "prescient" prefetch (for. e.g.\& 1626.Nm zfs Cm send ) 1627intact. 1628Unlike predictive prefetch, prescient prefetch never issues I/O 1629that ends up not being needed, so it can't hurt performance. 1630. 1631.It Sy zfs_qat_checksum_disable Ns = Ns Sy 0 Ns | Ns 1 Pq int 1632Disable QAT hardware acceleration for SHA256 checksums. 1633May be unset after the ZFS modules have been loaded to initialize the QAT 1634hardware as long as support is compiled in and the QAT driver is present. 1635. 1636.It Sy zfs_qat_compress_disable Ns = Ns Sy 0 Ns | Ns 1 Pq int 1637Disable QAT hardware acceleration for gzip compression. 1638May be unset after the ZFS modules have been loaded to initialize the QAT 1639hardware as long as support is compiled in and the QAT driver is present. 1640. 1641.It Sy zfs_qat_encrypt_disable Ns = Ns Sy 0 Ns | Ns 1 Pq int 1642Disable QAT hardware acceleration for AES-GCM encryption. 1643May be unset after the ZFS modules have been loaded to initialize the QAT 1644hardware as long as support is compiled in and the QAT driver is present. 1645. 1646.It Sy zfs_vnops_read_chunk_size Ns = Ns Sy 1048576 Ns B Po 1MB Pc Pq long 1647Bytes to read per chunk. 1648. 1649.It Sy zfs_read_history Ns = Ns Sy 0 Pq int 1650Historical statistics for this many latest reads will be available in 1651.Pa /proc/spl/kstat/zfs/ Ns Ao Ar pool Ac Ns Pa /reads . 1652. 1653.It Sy zfs_read_history_hits Ns = Ns Sy 0 Ns | Ns 1 Pq int 1654Include cache hits in read history 1655. 1656.It Sy zfs_rebuild_max_segment Ns = Ns Sy 1048576 Ns B Po 1MB Pc Pq ulong 1657Maximum read segment size to issue when sequentially resilvering a 1658top-level vdev. 1659. 1660.It Sy zfs_rebuild_scrub_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int 1661Automatically start a pool scrub when the last active sequential resilver 1662completes in order to verify the checksums of all blocks which have been 1663resilvered. 1664This is enabled by default and strongly recommended. 1665. 1666.It Sy zfs_rebuild_vdev_limit Ns = Ns Sy 33554432 Ns B Po 32MB Pc Pq ulong 1667Maximum amount of I/O that can be concurrently issued for a sequential 1668resilver per leaf device, given in bytes. 1669. 1670.It Sy zfs_reconstruct_indirect_combinations_max Ns = Ns Sy 4096 Pq int 1671If an indirect split block contains more than this many possible unique 1672combinations when being reconstructed, consider it too computationally 1673expensive to check them all. 1674Instead, try at most this many randomly selected 1675combinations each time the block is accessed. 1676This allows all segment copies to participate fairly 1677in the reconstruction when all combinations 1678cannot be checked and prevents repeated use of one bad copy. 1679. 1680.It Sy zfs_recover Ns = Ns Sy 0 Ns | Ns 1 Pq int 1681Set to attempt to recover from fatal errors. 1682This should only be used as a last resort, 1683as it typically results in leaked space, or worse. 1684. 1685.It Sy zfs_removal_ignore_errors Ns = Ns Sy 0 Ns | Ns 1 Pq int 1686Ignore hard IO errors during device removal. 1687When set, if a device encounters a hard IO error during the removal process 1688the removal will not be cancelled. 1689This can result in a normally recoverable block becoming permanently damaged 1690and is hence not recommended. 1691This should only be used as a last resort when the 1692pool cannot be returned to a healthy state prior to removing the device. 1693. 1694.It Sy zfs_removal_suspend_progress Ns = Ns Sy 0 Ns | Ns 1 Pq int 1695This is used by the test suite so that it can ensure that certain actions 1696happen while in the middle of a removal. 1697. 1698.It Sy zfs_remove_max_segment Ns = Ns Sy 16777216 Ns B Po 16MB Pc Pq int 1699The largest contiguous segment that we will attempt to allocate when removing 1700a device. 1701If there is a performance problem with attempting to allocate large blocks, 1702consider decreasing this. 1703The default value is also the maximum. 1704. 1705.It Sy zfs_resilver_disable_defer Ns = Ns Sy 0 Ns | Ns 1 Pq int 1706Ignore the 1707.Sy resilver_defer 1708feature, causing an operation that would start a resilver to 1709immediately restart the one in progress. 1710. 1711.It Sy zfs_resilver_min_time_ms Ns = Ns Sy 3000 Ns ms Po 3s Pc Pq int 1712Resilvers are processed by the sync thread. 1713While resilvering, it will spend at least this much time 1714working on a resilver between TXG flushes. 1715. 1716.It Sy zfs_scan_ignore_errors Ns = Ns Sy 0 Ns | Ns 1 Pq int 1717If set, remove the DTL (dirty time list) upon completion of a pool scan (scrub), 1718even if there were unrepairable errors. 1719Intended to be used during pool repair or recovery to 1720stop resilvering when the pool is next imported. 1721. 1722.It Sy zfs_scrub_min_time_ms Ns = Ns Sy 1000 Ns ms Po 1s Pc Pq int 1723Scrubs are processed by the sync thread. 1724While scrubbing, it will spend at least this much time 1725working on a scrub between TXG flushes. 1726. 1727.It Sy zfs_scan_checkpoint_intval Ns = Ns Sy 7200 Ns s Po 2h Pc Pq int 1728To preserve progress across reboots, the sequential scan algorithm periodically 1729needs to stop metadata scanning and issue all the verification I/O to disk. 1730The frequency of this flushing is determined by this tunable. 1731. 1732.It Sy zfs_scan_fill_weight Ns = Ns Sy 3 Pq int 1733This tunable affects how scrub and resilver I/O segments are ordered. 1734A higher number indicates that we care more about how filled in a segment is, 1735while a lower number indicates we care more about the size of the extent without 1736considering the gaps within a segment. 1737This value is only tunable upon module insertion. 1738Changing the value afterwards will have no effect on scrub or resilver performance. 1739. 1740.It Sy zfs_scan_issue_strategy Ns = Ns Sy 0 Pq int 1741Determines the order that data will be verified while scrubbing or resilvering: 1742.Bl -tag -compact -offset 4n -width "a" 1743.It Sy 1 1744Data will be verified as sequentially as possible, given the 1745amount of memory reserved for scrubbing 1746.Pq see Sy zfs_scan_mem_lim_fact . 1747This may improve scrub performance if the pool's data is very fragmented. 1748.It Sy 2 1749The largest mostly-contiguous chunk of found data will be verified first. 1750By deferring scrubbing of small segments, we may later find adjacent data 1751to coalesce and increase the segment size. 1752.It Sy 0 1753.No Use strategy Sy 1 No during normal verification 1754.No and strategy Sy 2 No while taking a checkpoint. 1755.El 1756. 1757.It Sy zfs_scan_legacy Ns = Ns Sy 0 Ns | Ns 1 Pq int 1758If unset, indicates that scrubs and resilvers will gather metadata in 1759memory before issuing sequential I/O. 1760Otherwise indicates that the legacy algorithm will be used, 1761where I/O is initiated as soon as it is discovered. 1762Unsetting will not affect scrubs or resilvers that are already in progress. 1763. 1764.It Sy zfs_scan_max_ext_gap Ns = Ns Sy 2097152 Ns B Po 2MB Pc Pq int 1765Sets the largest gap in bytes between scrub/resilver I/O operations 1766that will still be considered sequential for sorting purposes. 1767Changing this value will not 1768affect scrubs or resilvers that are already in progress. 1769. 1770.It Sy zfs_scan_mem_lim_fact Ns = Ns Sy 20 Ns ^-1 Pq int 1771Maximum fraction of RAM used for I/O sorting by sequential scan algorithm. 1772This tunable determines the hard limit for I/O sorting memory usage. 1773When the hard limit is reached we stop scanning metadata and start issuing 1774data verification I/O. 1775This is done until we get below the soft limit. 1776. 1777.It Sy zfs_scan_mem_lim_soft_fact Ns = Ns Sy 20 Ns ^-1 Pq int 1778The fraction of the hard limit used to determined the soft limit for I/O sorting 1779by the sequential scan algorithm. 1780When we cross this limit from below no action is taken. 1781When we cross this limit from above it is because we are issuing verification I/O. 1782In this case (unless the metadata scan is done) we stop issuing verification I/O 1783and start scanning metadata again until we get to the hard limit. 1784. 1785.It Sy zfs_scan_strict_mem_lim Ns = Ns Sy 0 Ns | Ns 1 Pq int 1786Enforce tight memory limits on pool scans when a sequential scan is in progress. 1787When disabled, the memory limit may be exceeded by fast disks. 1788. 1789.It Sy zfs_scan_suspend_progress Ns = Ns Sy 0 Ns | Ns 1 Pq int 1790Freezes a scrub/resilver in progress without actually pausing it. 1791Intended for testing/debugging. 1792. 1793.It Sy zfs_scan_vdev_limit Ns = Ns Sy 4194304 Ns B Po 4MB Pc Pq int 1794Maximum amount of data that can be concurrently issued at once for scrubs and 1795resilvers per leaf device, given in bytes. 1796. 1797.It Sy zfs_send_corrupt_data Ns = Ns Sy 0 Ns | Ns 1 Pq int 1798Allow sending of corrupt data (ignore read/checksum errors when sending). 1799. 1800.It Sy zfs_send_unmodified_spill_blocks Ns = Ns Sy 1 Ns | Ns 0 Pq int 1801Include unmodified spill blocks in the send stream. 1802Under certain circumstances, previous versions of ZFS could incorrectly 1803remove the spill block from an existing object. 1804Including unmodified copies of the spill blocks creates a backwards-compatible 1805stream which will recreate a spill block if it was incorrectly removed. 1806. 1807.It Sy zfs_send_no_prefetch_queue_ff Ns = Ns Sy 20 Ns ^\-1 Pq int 1808The fill fraction of the 1809.Nm zfs Cm send 1810internal queues. 1811The fill fraction controls the timing with which internal threads are woken up. 1812. 1813.It Sy zfs_send_no_prefetch_queue_length Ns = Ns Sy 1048576 Ns B Po 1MB Pc Pq int 1814The maximum number of bytes allowed in 1815.Nm zfs Cm send Ns 's 1816internal queues. 1817. 1818.It Sy zfs_send_queue_ff Ns = Ns Sy 20 Ns ^\-1 Pq int 1819The fill fraction of the 1820.Nm zfs Cm send 1821prefetch queue. 1822The fill fraction controls the timing with which internal threads are woken up. 1823. 1824.It Sy zfs_send_queue_length Ns = Ns Sy 16777216 Ns B Po 16MB Pc Pq int 1825The maximum number of bytes allowed that will be prefetched by 1826.Nm zfs Cm send . 1827This value must be at least twice the maximum block size in use. 1828. 1829.It Sy zfs_recv_queue_ff Ns = Ns Sy 20 Ns ^\-1 Pq int 1830The fill fraction of the 1831.Nm zfs Cm receive 1832queue. 1833The fill fraction controls the timing with which internal threads are woken up. 1834. 1835.It Sy zfs_recv_queue_length Ns = Ns Sy 16777216 Ns B Po 16MB Pc Pq int 1836The maximum number of bytes allowed in the 1837.Nm zfs Cm receive 1838queue. 1839This value must be at least twice the maximum block size in use. 1840. 1841.It Sy zfs_recv_write_batch_size Ns = Ns Sy 1048576 Ns B Po 1MB Pc Pq int 1842The maximum amount of data, in bytes, that 1843.Nm zfs Cm receive 1844will write in one DMU transaction. 1845This is the uncompressed size, even when receiving a compressed send stream. 1846This setting will not reduce the write size below a single block. 1847Capped at a maximum of 1848.Sy 32MB . 1849. 1850.It Sy zfs_override_estimate_recordsize Ns = Ns Sy 0 Ns | Ns 1 Pq ulong 1851Setting this variable overrides the default logic for estimating block 1852sizes when doing a 1853.Nm zfs Cm send . 1854The default heuristic is that the average block size 1855will be the current recordsize. 1856Override this value if most data in your dataset is not of that size 1857and you require accurate zfs send size estimates. 1858. 1859.It Sy zfs_sync_pass_deferred_free Ns = Ns Sy 2 Pq int 1860Flushing of data to disk is done in passes. 1861Defer frees starting in this pass. 1862. 1863.It Sy zfs_spa_discard_memory_limit Ns = Ns Sy 16777216 Ns B Po 16MB Pc Pq int 1864Maximum memory used for prefetching a checkpoint's space map on each 1865vdev while discarding the checkpoint. 1866. 1867.It Sy zfs_special_class_metadata_reserve_pct Ns = Ns Sy 25 Ns % Pq int 1868Only allow small data blocks to be allocated on the special and dedup vdev 1869types when the available free space percentage on these vdevs exceeds this value. 1870This ensures reserved space is available for pool metadata as the 1871special vdevs approach capacity. 1872. 1873.It Sy zfs_sync_pass_dont_compress Ns = Ns Sy 8 Pq int 1874Starting in this sync pass, disable compression (including of metadata). 1875With the default setting, in practice, we don't have this many sync passes, 1876so this has no effect. 1877.Pp 1878The original intent was that disabling compression would help the sync passes 1879to converge. 1880However, in practice, disabling compression increases 1881the average number of sync passes; because when we turn compression off, 1882many blocks' size will change, and thus we have to re-allocate 1883(not overwrite) them. 1884It also increases the number of 1885.Em 128kB 1886allocations (e.g. for indirect blocks and spacemaps) 1887because these will not be compressed. 1888The 1889.Em 128kB 1890allocations are especially detrimental to performance 1891on highly fragmented systems, which may have very few free segments of this size, 1892and may need to load new metaslabs to satisfy these allocations. 1893. 1894.It Sy zfs_sync_pass_rewrite Ns = Ns Sy 2 Pq int 1895Rewrite new block pointers starting in this pass. 1896. 1897.It Sy zfs_sync_taskq_batch_pct Ns = Ns Sy 75 Ns % Pq int 1898This controls the number of threads used by 1899.Sy dp_sync_taskq . 1900The default value of 1901.Sy 75% 1902will create a maximum of one thread per CPU. 1903. 1904.It Sy zfs_trim_extent_bytes_max Ns = Ns Sy 134217728 Ns B Po 128MB Pc Pq uint 1905Maximum size of TRIM command. 1906Larger ranges will be split into chunks no larger than this value before issuing. 1907. 1908.It Sy zfs_trim_extent_bytes_min Ns = Ns Sy 32768 Ns B Po 32kB Pc Pq uint 1909Minimum size of TRIM commands. 1910TRIM ranges smaller than this will be skipped, 1911unless they're part of a larger range which was chunked. 1912This is done because it's common for these small TRIMs 1913to negatively impact overall performance. 1914. 1915.It Sy zfs_trim_metaslab_skip Ns = Ns Sy 0 Ns | Ns 1 Pq uint 1916Skip uninitialized metaslabs during the TRIM process. 1917This option is useful for pools constructed from large thinly-provisioned devices 1918where TRIM operations are slow. 1919As a pool ages, an increasing fraction of the pool's metaslabs 1920will be initialized, progressively degrading the usefulness of this option. 1921This setting is stored when starting a manual TRIM and will 1922persist for the duration of the requested TRIM. 1923. 1924.It Sy zfs_trim_queue_limit Ns = Ns Sy 10 Pq uint 1925Maximum number of queued TRIMs outstanding per leaf vdev. 1926The number of concurrent TRIM commands issued to the device is controlled by 1927.Sy zfs_vdev_trim_min_active No and Sy zfs_vdev_trim_max_active . 1928. 1929.It Sy zfs_trim_txg_batch Ns = Ns Sy 32 Pq uint 1930The number of transaction groups' worth of frees which should be aggregated 1931before TRIM operations are issued to the device. 1932This setting represents a trade-off between issuing larger, 1933more efficient TRIM operations and the delay 1934before the recently trimmed space is available for use by the device. 1935.Pp 1936Increasing this value will allow frees to be aggregated for a longer time. 1937This will result is larger TRIM operations and potentially increased memory usage. 1938Decreasing this value will have the opposite effect. 1939The default of 1940.Sy 32 1941was determined to be a reasonable compromise. 1942. 1943.It Sy zfs_txg_history Ns = Ns Sy 0 Pq int 1944Historical statistics for this many latest TXGs will be available in 1945.Pa /proc/spl/kstat/zfs/ Ns Ao Ar pool Ac Ns Pa /TXGs . 1946. 1947.It Sy zfs_txg_timeout Ns = Ns Sy 5 Ns s Pq int 1948Flush dirty data to disk at least every this many seconds (maximum TXG duration). 1949. 1950.It Sy zfs_vdev_aggregate_trim Ns = Ns Sy 0 Ns | Ns 1 Pq int 1951Allow TRIM I/Os to be aggregated. 1952This is normally not helpful because the extents to be trimmed 1953will have been already been aggregated by the metaslab. 1954This option is provided for debugging and performance analysis. 1955. 1956.It Sy zfs_vdev_aggregation_limit Ns = Ns Sy 1048576 Ns B Po 1MB Pc Pq int 1957Max vdev I/O aggregation size. 1958. 1959.It Sy zfs_vdev_aggregation_limit_non_rotating Ns = Ns Sy 131072 Ns B Po 128kB Pc Pq int 1960Max vdev I/O aggregation size for non-rotating media. 1961. 1962.It Sy zfs_vdev_cache_bshift Ns = Ns Sy 16 Po 64kB Pc Pq int 1963Shift size to inflate reads to. 1964. 1965.It Sy zfs_vdev_cache_max Ns = Ns Sy 16384 Ns B Po 16kB Pc Pq int 1966Inflate reads smaller than this value to meet the 1967.Sy zfs_vdev_cache_bshift 1968size 1969.Pq default Sy 64kB . 1970. 1971.It Sy zfs_vdev_cache_size Ns = Ns Sy 0 Pq int 1972Total size of the per-disk cache in bytes. 1973.Pp 1974Currently this feature is disabled, as it has been found to not be helpful 1975for performance and in some cases harmful. 1976. 1977.It Sy zfs_vdev_mirror_rotating_inc Ns = Ns Sy 0 Pq int 1978A number by which the balancing algorithm increments the load calculation for 1979the purpose of selecting the least busy mirror member when an I/O operation 1980immediately follows its predecessor on rotational vdevs 1981for the purpose of making decisions based on load. 1982. 1983.It Sy zfs_vdev_mirror_rotating_seek_inc Ns = Ns Sy 5 Pq int 1984A number by which the balancing algorithm increments the load calculation for 1985the purpose of selecting the least busy mirror member when an I/O operation 1986lacks locality as defined by 1987.Sy zfs_vdev_mirror_rotating_seek_offset . 1988Operations within this that are not immediately following the previous operation 1989are incremented by half. 1990. 1991.It Sy zfs_vdev_mirror_rotating_seek_offset Ns = Ns Sy 1048576 Ns B Po 1MB Pc Pq int 1992The maximum distance for the last queued I/O operation in which 1993the balancing algorithm considers an operation to have locality. 1994.No See Sx ZFS I/O SCHEDULER . 1995. 1996.It Sy zfs_vdev_mirror_non_rotating_inc Ns = Ns Sy 0 Pq int 1997A number by which the balancing algorithm increments the load calculation for 1998the purpose of selecting the least busy mirror member on non-rotational vdevs 1999when I/O operations do not immediately follow one another. 2000. 2001.It Sy zfs_vdev_mirror_non_rotating_seek_inc Ns = Ns Sy 1 Pq int 2002A number by which the balancing algorithm increments the load calculation for 2003the purpose of selecting the least busy mirror member when an I/O operation lacks 2004locality as defined by the 2005.Sy zfs_vdev_mirror_rotating_seek_offset . 2006Operations within this that are not immediately following the previous operation 2007are incremented by half. 2008. 2009.It Sy zfs_vdev_read_gap_limit Ns = Ns Sy 32768 Ns B Po 32kB Pc Pq int 2010Aggregate read I/O operations if the on-disk gap between them is within this 2011threshold. 2012. 2013.It Sy zfs_vdev_write_gap_limit Ns = Ns Sy 4096 Ns B Po 4kB Pc Pq int 2014Aggregate write I/O operations if the on-disk gap between them is within this 2015threshold. 2016. 2017.It Sy zfs_vdev_raidz_impl Ns = Ns Sy fastest Pq string 2018Select the raidz parity implementation to use. 2019.Pp 2020Variants that don't depend on CPU-specific features 2021may be selected on module load, as they are supported on all systems. 2022The remaining options may only be set after the module is loaded, 2023as they are available only if the implementations are compiled in 2024and supported on the running system. 2025.Pp 2026Once the module is loaded, 2027.Pa /sys/module/zfs/parameters/zfs_vdev_raidz_impl 2028will show the available options, 2029with the currently selected one enclosed in square brackets. 2030.Pp 2031.TS 2032lb l l . 2033fastest selected by built-in benchmark 2034original original implementation 2035scalar scalar implementation 2036sse2 SSE2 instruction set 64-bit x86 2037ssse3 SSSE3 instruction set 64-bit x86 2038avx2 AVX2 instruction set 64-bit x86 2039avx512f AVX512F instruction set 64-bit x86 2040avx512bw AVX512F & AVX512BW instruction sets 64-bit x86 2041aarch64_neon NEON Aarch64/64-bit ARMv8 2042aarch64_neonx2 NEON with more unrolling Aarch64/64-bit ARMv8 2043powerpc_altivec Altivec PowerPC 2044.TE 2045. 2046.It Sy zfs_vdev_scheduler Pq charp 2047.Sy DEPRECATED . 2048Prints warning to kernel log for compatibility. 2049. 2050.It Sy zfs_zevent_len_max Ns = Ns Sy 512 Pq int 2051Max event queue length. 2052Events in the queue can be viewed with 2053.Xr zpool-events 8 . 2054. 2055.It Sy zfs_zevent_retain_max Ns = Ns Sy 2000 Pq int 2056Maximum recent zevent records to retain for duplicate checking. 2057Setting this to 2058.Sy 0 2059disables duplicate detection. 2060. 2061.It Sy zfs_zevent_retain_expire_secs Ns = Ns Sy 900 Ns s Po 15min Pc Pq int 2062Lifespan for a recent ereport that was retained for duplicate checking. 2063. 2064.It Sy zfs_zil_clean_taskq_maxalloc Ns = Ns Sy 1048576 Pq int 2065The maximum number of taskq entries that are allowed to be cached. 2066When this limit is exceeded transaction records (itxs) 2067will be cleaned synchronously. 2068. 2069.It Sy zfs_zil_clean_taskq_minalloc Ns = Ns Sy 1024 Pq int 2070The number of taskq entries that are pre-populated when the taskq is first 2071created and are immediately available for use. 2072. 2073.It Sy zfs_zil_clean_taskq_nthr_pct Ns = Ns Sy 100 Ns % Pq int 2074This controls the number of threads used by 2075.Sy dp_zil_clean_taskq . 2076The default value of 2077.Sy 100% 2078will create a maximum of one thread per cpu. 2079. 2080.It Sy zil_maxblocksize Ns = Ns Sy 131072 Ns B Po 128kB Pc Pq int 2081This sets the maximum block size used by the ZIL. 2082On very fragmented pools, lowering this 2083.Pq typically to Sy 36kB 2084can improve performance. 2085. 2086.It Sy zil_nocacheflush Ns = Ns Sy 0 Ns | Ns 1 Pq int 2087Disable the cache flush commands that are normally sent to disk by 2088the ZIL after an LWB write has completed. 2089Setting this will cause ZIL corruption on power loss 2090if a volatile out-of-order write cache is enabled. 2091. 2092.It Sy zil_replay_disable Ns = Ns Sy 0 Ns | Ns 1 Pq int 2093Disable intent logging replay. 2094Can be disabled for recovery from corrupted ZIL. 2095. 2096.It Sy zil_slog_bulk Ns = Ns Sy 786432 Ns B Po 768kB Pc Pq ulong 2097Limit SLOG write size per commit executed with synchronous priority. 2098Any writes above that will be executed with lower (asynchronous) priority 2099to limit potential SLOG device abuse by single active ZIL writer. 2100. 2101.It Sy zfs_embedded_slog_min_ms Ns = Ns Sy 64 Pq int 2102Usually, one metaslab from each normal-class vdev is dedicated for use by 2103the ZIL to log synchronous writes. 2104However, if there are fewer than 2105.Sy zfs_embedded_slog_min_ms 2106metaslabs in the vdev, this functionality is disabled. 2107This ensures that we don't set aside an unreasonable amount of space for the ZIL. 2108. 2109.It Sy zio_deadman_log_all Ns = Ns Sy 0 Ns | Ns 1 Pq int 2110If non-zero, the zio deadman will produce debugging messages 2111.Pq see Sy zfs_dbgmsg_enable 2112for all zios, rather than only for leaf zios possessing a vdev. 2113This is meant to be used by developers to gain 2114diagnostic information for hang conditions which don't involve a mutex 2115or other locking primitive: typically conditions in which a thread in 2116the zio pipeline is looping indefinitely. 2117. 2118.It Sy zio_slow_io_ms Ns = Ns Sy 30000 Ns ms Po 30s Pc Pq int 2119When an I/O operation takes more than this much time to complete, 2120it's marked as slow. 2121Each slow operation causes a delay zevent. 2122Slow I/O counters can be seen with 2123.Nm zpool Cm status Fl s . 2124. 2125.It Sy zio_dva_throttle_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int 2126Throttle block allocations in the I/O pipeline. 2127This allows for dynamic allocation distribution when devices are imbalanced. 2128When enabled, the maximum number of pending allocations per top-level vdev 2129is limited by 2130.Sy zfs_vdev_queue_depth_pct . 2131. 2132.It Sy zio_requeue_io_start_cut_in_line Ns = Ns Sy 0 Ns | Ns 1 Pq int 2133Prioritize requeued I/O. 2134. 2135.It Sy zio_taskq_batch_pct Ns = Ns Sy 80 Ns % Pq uint 2136Percentage of online CPUs which will run a worker thread for I/O. 2137These workers are responsible for I/O work such as compression and 2138checksum calculations. 2139Fractional number of CPUs will be rounded down. 2140.Pp 2141The default value of 2142.Sy 80% 2143was chosen to avoid using all CPUs which can result in 2144latency issues and inconsistent application performance, 2145especially when slower compression and/or checksumming is enabled. 2146. 2147.It Sy zio_taskq_batch_tpq Ns = Ns Sy 0 Pq uint 2148Number of worker threads per taskq. 2149Lower values improve I/O ordering and CPU utilization, 2150while higher reduces lock contention. 2151.Pp 2152If 2153.Sy 0 , 2154generate a system-dependent value close to 6 threads per taskq. 2155. 2156.It Sy zvol_inhibit_dev Ns = Ns Sy 0 Ns | Ns 1 Pq uint 2157Do not create zvol device nodes. 2158This may slightly improve startup time on 2159systems with a very large number of zvols. 2160. 2161.It Sy zvol_major Ns = Ns Sy 230 Pq uint 2162Major number for zvol block devices. 2163. 2164.It Sy zvol_max_discard_blocks Ns = Ns Sy 16384 Pq ulong 2165Discard (TRIM) operations done on zvols will be done in batches of this 2166many blocks, where block size is determined by the 2167.Sy volblocksize 2168property of a zvol. 2169. 2170.It Sy zvol_prefetch_bytes Ns = Ns Sy 131072 Ns B Po 128kB Pc Pq uint 2171When adding a zvol to the system, prefetch this many bytes 2172from the start and end of the volume. 2173Prefetching these regions of the volume is desirable, 2174because they are likely to be accessed immediately by 2175.Xr blkid 8 2176or the kernel partitioner. 2177. 2178.It Sy zvol_request_sync Ns = Ns Sy 0 Ns | Ns 1 Pq uint 2179When processing I/O requests for a zvol, submit them synchronously. 2180This effectively limits the queue depth to 2181.Em 1 2182for each I/O submitter. 2183When unset, requests are handled asynchronously by a thread pool. 2184The number of requests which can be handled concurrently is controlled by 2185.Sy zvol_threads . 2186. 2187.It Sy zvol_threads Ns = Ns Sy 32 Pq uint 2188Max number of threads which can handle zvol I/O requests concurrently. 2189. 2190.It Sy zvol_volmode Ns = Ns Sy 1 Pq uint 2191Defines zvol block devices behaviour when 2192.Sy volmode Ns = Ns Sy default : 2193.Bl -tag -compact -offset 4n -width "a" 2194.It Sy 1 2195.No equivalent to Sy full 2196.It Sy 2 2197.No equivalent to Sy dev 2198.It Sy 3 2199.No equivalent to Sy none 2200.El 2201.El 2202. 2203.Sh ZFS I/O SCHEDULER 2204ZFS issues I/O operations to leaf vdevs to satisfy and complete I/O operations. 2205The scheduler determines when and in what order those operations are issued. 2206The scheduler divides operations into five I/O classes, 2207prioritized in the following order: sync read, sync write, async read, 2208async write, and scrub/resilver. 2209Each queue defines the minimum and maximum number of concurrent operations 2210that may be issued to the device. 2211In addition, the device has an aggregate maximum, 2212.Sy zfs_vdev_max_active . 2213Note that the sum of the per-queue minima must not exceed the aggregate maximum. 2214If the sum of the per-queue maxima exceeds the aggregate maximum, 2215then the number of active operations may reach 2216.Sy zfs_vdev_max_active , 2217in which case no further operations will be issued, 2218regardless of whether all per-queue minima have been met. 2219.Pp 2220For many physical devices, throughput increases with the number of 2221concurrent operations, but latency typically suffers. 2222Furthermore, physical devices typically have a limit 2223at which more concurrent operations have no 2224effect on throughput or can actually cause it to decrease. 2225.Pp 2226The scheduler selects the next operation to issue by first looking for an 2227I/O class whose minimum has not been satisfied. 2228Once all are satisfied and the aggregate maximum has not been hit, 2229the scheduler looks for classes whose maximum has not been satisfied. 2230Iteration through the I/O classes is done in the order specified above. 2231No further operations are issued 2232if the aggregate maximum number of concurrent operations has been hit, 2233or if there are no operations queued for an I/O class that has not hit its maximum. 2234Every time an I/O operation is queued or an operation completes, 2235the scheduler looks for new operations to issue. 2236.Pp 2237In general, smaller 2238.Sy max_active Ns s 2239will lead to lower latency of synchronous operations. 2240Larger 2241.Sy max_active Ns s 2242may lead to higher overall throughput, depending on underlying storage. 2243.Pp 2244The ratio of the queues' 2245.Sy max_active Ns s 2246determines the balance of performance between reads, writes, and scrubs. 2247For example, increasing 2248.Sy zfs_vdev_scrub_max_active 2249will cause the scrub or resilver to complete more quickly, 2250but reads and writes to have higher latency and lower throughput. 2251.Pp 2252All I/O classes have a fixed maximum number of outstanding operations, 2253except for the async write class. 2254Asynchronous writes represent the data that is committed to stable storage 2255during the syncing stage for transaction groups. 2256Transaction groups enter the syncing state periodically, 2257so the number of queued async writes will quickly burst up 2258and then bleed down to zero. 2259Rather than servicing them as quickly as possible, 2260the I/O scheduler changes the maximum number of active async write operations 2261according to the amount of dirty data in the pool. 2262Since both throughput and latency typically increase with the number of 2263concurrent operations issued to physical devices, reducing the 2264burstiness in the number of concurrent operations also stabilizes the 2265response time of operations from other – and in particular synchronous – queues. 2266In broad strokes, the I/O scheduler will issue more concurrent operations 2267from the async write queue as there's more dirty data in the pool. 2268. 2269.Ss Async Writes 2270The number of concurrent operations issued for the async write I/O class 2271follows a piece-wise linear function defined by a few adjustable points: 2272.Bd -literal 2273 | o---------| <-- \fBzfs_vdev_async_write_max_active\fP 2274 ^ | /^ | 2275 | | / | | 2276active | / | | 2277 I/O | / | | 2278count | / | | 2279 | / | | 2280 |-------o | | <-- \fBzfs_vdev_async_write_min_active\fP 2281 0|_______^______|_________| 2282 0% | | 100% of \fBzfs_dirty_data_max\fP 2283 | | 2284 | `-- \fBzfs_vdev_async_write_active_max_dirty_percent\fP 2285 `--------- \fBzfs_vdev_async_write_active_min_dirty_percent\fP 2286.Ed 2287.Pp 2288Until the amount of dirty data exceeds a minimum percentage of the dirty 2289data allowed in the pool, the I/O scheduler will limit the number of 2290concurrent operations to the minimum. 2291As that threshold is crossed, the number of concurrent operations issued 2292increases linearly to the maximum at the specified maximum percentage 2293of the dirty data allowed in the pool. 2294.Pp 2295Ideally, the amount of dirty data on a busy pool will stay in the sloped 2296part of the function between 2297.Sy zfs_vdev_async_write_active_min_dirty_percent 2298and 2299.Sy zfs_vdev_async_write_active_max_dirty_percent . 2300If it exceeds the maximum percentage, 2301this indicates that the rate of incoming data is 2302greater than the rate that the backend storage can handle. 2303In this case, we must further throttle incoming writes, 2304as described in the next section. 2305. 2306.Sh ZFS TRANSACTION DELAY 2307We delay transactions when we've determined that the backend storage 2308isn't able to accommodate the rate of incoming writes. 2309.Pp 2310If there is already a transaction waiting, we delay relative to when 2311that transaction will finish waiting. 2312This way the calculated delay time 2313is independent of the number of threads concurrently executing transactions. 2314.Pp 2315If we are the only waiter, wait relative to when the transaction started, 2316rather than the current time. 2317This credits the transaction for "time already served", 2318e.g. reading indirect blocks. 2319.Pp 2320The minimum time for a transaction to take is calculated as 2321.D1 min_time = min( Ns Sy zfs_delay_scale No \(mu Po Sy dirty No \- Sy min Pc / Po Sy max No \- Sy dirty Pc , 100ms) 2322.Pp 2323The delay has two degrees of freedom that can be adjusted via tunables. 2324The percentage of dirty data at which we start to delay is defined by 2325.Sy zfs_delay_min_dirty_percent . 2326This should typically be at or above 2327.Sy zfs_vdev_async_write_active_max_dirty_percent , 2328so that we only start to delay after writing at full speed 2329has failed to keep up with the incoming write rate. 2330The scale of the curve is defined by 2331.Sy zfs_delay_scale . 2332Roughly speaking, this variable determines the amount of delay at the midpoint of the curve. 2333.Bd -literal 2334delay 2335 10ms +-------------------------------------------------------------*+ 2336 | *| 2337 9ms + *+ 2338 | *| 2339 8ms + *+ 2340 | * | 2341 7ms + * + 2342 | * | 2343 6ms + * + 2344 | * | 2345 5ms + * + 2346 | * | 2347 4ms + * + 2348 | * | 2349 3ms + * + 2350 | * | 2351 2ms + (midpoint) * + 2352 | | ** | 2353 1ms + v *** + 2354 | \fBzfs_delay_scale\fP ----------> ******** | 2355 0 +-------------------------------------*********----------------+ 2356 0% <- \fBzfs_dirty_data_max\fP -> 100% 2357.Ed 2358.Pp 2359Note, that since the delay is added to the outstanding time remaining on the 2360most recent transaction it's effectively the inverse of IOPS. 2361Here, the midpoint of 2362.Em 500us 2363translates to 2364.Em 2000 IOPS . 2365The shape of the curve 2366was chosen such that small changes in the amount of accumulated dirty data 2367in the first three quarters of the curve yield relatively small differences 2368in the amount of delay. 2369.Pp 2370The effects can be easier to understand when the amount of delay is 2371represented on a logarithmic scale: 2372.Bd -literal 2373delay 2374100ms +-------------------------------------------------------------++ 2375 + + 2376 | | 2377 + *+ 2378 10ms + *+ 2379 + ** + 2380 | (midpoint) ** | 2381 + | ** + 2382 1ms + v **** + 2383 + \fBzfs_delay_scale\fP ----------> ***** + 2384 | **** | 2385 + **** + 2386100us + ** + 2387 + * + 2388 | * | 2389 + * + 2390 10us + * + 2391 + + 2392 | | 2393 + + 2394 +--------------------------------------------------------------+ 2395 0% <- \fBzfs_dirty_data_max\fP -> 100% 2396.Ed 2397.Pp 2398Note here that only as the amount of dirty data approaches its limit does 2399the delay start to increase rapidly. 2400The goal of a properly tuned system should be to keep the amount of dirty data 2401out of that range by first ensuring that the appropriate limits are set 2402for the I/O scheduler to reach optimal throughput on the back-end storage, 2403and then by changing the value of 2404.Sy zfs_delay_scale 2405to increase the steepness of the curve. 2406