ZFS-MODULE-PARAMETERS(5) | File Formats Manual | ZFS-MODULE-PARAMETERS(5) |
zfs-module-parameters - ZFS module parameters
Description of the different parameters to the ZFS module.
ignore_hole_birth (int)
Use 1 for on (default) and 0 for off.
l2arc_feed_again (int)
Use 1 for yes (default) and 0 to disable.
l2arc_feed_min_ms (ulong)
Default value: 200.
l2arc_feed_secs (ulong)
Default value: 1.
l2arc_headroom (ulong)
Default value: 2.
l2arc_headroom_boost (ulong)
Default value: 200.
l2arc_noprefetch (int)
Use 1 for yes (default) and 0 to disable.
l2arc_norw (int)
Use 1 for yes and 0 for no (default).
l2arc_write_boost (ulong)
Default value: 8,388,608.
l2arc_write_max (ulong)
Default value: 8,388,608.
metaslab_aliquot (ulong)
Default value: 524,288.
metaslab_bias_enabled (int)
Use 1 for yes (default) and 0 for no.
zfs_metaslab_segment_weight_enabled (int)
Use 1 for yes (default) and 0 for no.
zfs_metaslab_switch_threshold (int)
Default value: 2.
metaslab_debug_load (int)
Use 1 for yes and 0 for no (default).
metaslab_debug_unload (int)
Use 1 for yes and 0 for no (default).
metaslab_fragmentation_factor_enabled (int)
Use 1 for yes (default) and 0 for no.
metaslabs_per_vdev (int)
Default value: 200.
metaslab_preload_enabled (int)
Use 1 for yes (default) and 0 for no.
metaslab_lba_weighting_enabled (int)
Use 1 for yes (default) and 0 for no.
spa_config_path (charp)
Default value: /etc/zfs/zpool.cache.
spa_asize_inflation (int)
Default value: 24.
spa_load_verify_data (int)
An extreme rewind import normally performs a full traversal of all blocks in the pool for verification. If this parameter is set to 0, the traversal skips non-metadata blocks. It can be toggled once the import has started to stop or start the traversal of non-metadata blocks.
Default value: 1.
spa_load_verify_metadata (int)
An extreme rewind import normally performs a full traversal of all blocks in the pool for verification. If this parameter is set to 0, the traversal is not performed. It can be toggled once the import has started to stop or start the traversal.
Default value: 1.
spa_load_verify_maxinflight (int)
Default value: 10000.
spa_slop_shift (int)
Default value: 5.
zfetch_array_rd_sz (ulong)
Default value: 1,048,576.
zfetch_max_distance (uint)
Default value: 8,388,608.
zfetch_max_streams (uint)
Default value: 8.
zfetch_min_sec_reap (uint)
Default value: 2.
zfs_arc_dnode_limit (ulong)
See also zfs_arc_meta_prune which serves a similar purpose but is used when the amount of metadata in the ARC exceeds zfs_arc_meta_limit rather than in response to overall demand for non-metadata.
Default value: 0.
zfs_arc_dnode_limit_percent (ulong)
See also zfs_arc_dnode_limit which serves a similar purpose but has a higher priority if set to nonzero value.
Default value: 10.
zfs_arc_dnode_reduce_percent (ulong)
Default value: 10% of the number of dnodes in the ARC.
zfs_arc_average_blocksize (int)
Default value: 8192.
zfs_arc_evict_batch_limit (int)
Default value: 10.
zfs_arc_grow_retry (int)
Default value: 0.
zfs_arc_lotsfree_percent (int)
Default value: 10.
zfs_arc_max (ulong)
This value can be changed dynamically with some caveats. It cannot be set back to 0 while running and reducing it below the current ARC size will not cause the ARC to shrink without memory pressure to induce shrinking.
Default value: 0.
zfs_arc_meta_adjust_restarts (ulong)
Default value: 4096.
zfs_arc_meta_limit (ulong)
This value my be changed dynamically except that it cannot be set back to 0 for a specific percent of the ARC; it must be set to an explicit value.
Default value: 0.
zfs_arc_meta_limit_percent (ulong)
See also zfs_arc_meta_limit which serves a similar purpose but has a higher priority if set to nonzero value.
Default value: 75.
zfs_arc_meta_min (ulong)
Default value: 0.
zfs_arc_meta_prune (int)
Default value: 10,000.
zfs_arc_meta_strategy (int)
Default value: 1.
zfs_arc_min (ulong)
Default value: 0.
zfs_arc_min_prefetch_lifespan (int)
Default value: 0.
zfs_multilist_num_sublists (int)
Default value: 4 or the number of online CPUs, whichever is greater
zfs_arc_overflow_shift (int)
The default value of 8 causes the ARC to be considered to be overflowing if it exceeds the target size by 1/256th (0.3%) of the target size.
When the ARC is overflowing, new buffer allocations are stalled until the reclaim thread catches up and the overflow condition no longer exists.
Default value: 8.
zfs_arc_p_min_shift (int)
Default value: 0.
zfs_arc_p_dampener_disable (int)
Use 1 for yes (default) and 0 to disable.
zfs_arc_shrink_shift (int)
Default value: 0.
zfs_arc_pc_percent (uint)
This tunable allows ZFS arc to play more nicely with the kernel's LRU pagecache. It can guarantee that the arc size won't collapse under scanning pressure on the pagecache, yet still allows arc to be reclaimed down to zfs_arc_min if necessary. This value is specified as percent of pagecache size (as measured by NR_FILE_PAGES) where that percent may exceed 100. This only operates during memory pressure/reclaim.
Default value: 0 (disabled).
zfs_arc_sys_free (ulong)
Default value: 0.
zfs_autoimport_disable (int)
Use 1 for yes (default) and 0 for no.
zfs_checksums_per_second (int)
Default value: 20
zfs_commit_timeout_pct (int)
Default value: 5%.
zfs_dbgmsg_enable (int)
Default value: 0.
zfs_dbgmsg_maxsize (int)
Default value: 4M.
zfs_dbuf_state_index (int)
Default value: 0.
zfs_deadman_enabled (int)
Use 1 (default) to enable the slow IO check and 0 to disable.
zfs_deadman_checktime_ms (int)
Default value: 5,000.
zfs_deadman_synctime_ms (ulong)
See zfs_deadman_enabled.
Default value: 1,000,000.
zfs_dedup_prefetch (int)
Use 1 for yes and 0 to disable (default).
zfs_delay_min_dirty_percent (int)
Default value: 60.
zfs_delay_scale (int)
For the smoothest delay, this value should be about 1 billion divided by the maximum number of operations per second. This will smoothly handle between 10x and 1/10th this number.
See the section "ZFS TRANSACTION DELAY".
Note: zfs_delay_scale * zfs_dirty_data_max must be < 2^64.
Default value: 500,000.
zfs_delays_per_second (int)
Default value: 20
zfs_delete_blocks (ulong)
Default value: 20,480.
zfs_dirty_data_max (int)
Default value: 10 percent of all memory, capped at zfs_dirty_data_max_max.
zfs_dirty_data_max_max (int)
Default value: 25% of physical RAM.
zfs_dirty_data_max_max_percent (int)
Default value: 25.
zfs_dirty_data_max_percent (int)
Default value: 10%, subject to zfs_dirty_data_max_max.
zfs_dirty_data_sync (int)
Default value: 67,108,864.
zfs_fletcher_4_impl (string)
Supported selectors are: fastest, scalar, sse2, ssse3, avx2, avx512f, and aarch64_neon. All of the selectors except fastest and scalar require instruction set extensions to be available and will only appear if ZFS detects that they are present at runtime. If multiple implementations of fletcher 4 are available, the fastest will be chosen using a micro benchmark. Selecting scalar results in the original, CPU based calculation, being used. Selecting any option other than fastest and scalar results in vector instructions from the respective CPU instruction set being used.
Default value: fastest.
zfs_free_bpobj_enabled (int)
Default value: 1.
zfs_free_max_blocks (ulong)
Default value: 100,000.
zfs_vdev_async_read_max_active (int)
Default value: 3.
zfs_vdev_async_read_min_active (int)
Default value: 1.
zfs_vdev_async_write_active_max_dirty_percent (int)
Default value: 60.
zfs_vdev_async_write_active_min_dirty_percent (int)
Default value: 30.
zfs_vdev_async_write_max_active (int)
Default value: 10.
zfs_vdev_async_write_min_active (int)
Lower values are associated with better latency on rotational media but poorer resilver performance. The default value of 2 was chosen as a compromise. A value of 3 has been shown to improve resilver performance further at a cost of further increasing latency.
Default value: 2.
zfs_vdev_max_active (int)
Default value: 1,000.
zfs_vdev_scrub_max_active (int)
Default value: 2.
zfs_vdev_scrub_min_active (int)
Default value: 1.
zfs_vdev_sync_read_max_active (int)
Default value: 10.
zfs_vdev_sync_read_min_active (int)
Default value: 10.
zfs_vdev_sync_write_max_active (int)
Default value: 10.
zfs_vdev_sync_write_min_active (int)
Default value: 10.
zfs_vdev_queue_depth_pct (int)
See also zio_dva_throttle_enabled.
Default value: 1000.
zfs_disable_dup_eviction (int)
Use 1 for yes and 0 for no (default).
zfs_expire_snapshot (int)
Default value: 300.
zfs_admin_snapshot (int)
Use 1 for yes and 0 for no (default).
zfs_flags (int)
Value | Symbolic Name |
Description | |
1 | ZFS_DEBUG_DPRINTF |
Enable dprintf entries in the debug log. | |
2 | ZFS_DEBUG_DBUF_VERIFY * |
Enable extra dbuf verifications. | |
4 | ZFS_DEBUG_DNODE_VERIFY * |
Enable extra dnode verifications. | |
8 | ZFS_DEBUG_SNAPNAMES |
Enable snapshot name verification. | |
16 | ZFS_DEBUG_MODIFY |
Check for illegally modified ARC buffers. | |
32 | ZFS_DEBUG_SPA |
Enable spa_dbgmsg entries in the debug log. | |
64 | ZFS_DEBUG_ZIO_FREE |
Enable verification of block frees. | |
128 | ZFS_DEBUG_HISTOGRAM_VERIFY |
Enable extra spacemap histogram verifications. | |
256 | ZFS_DEBUG_METASLAB_VERIFY |
Verify space accounting on disk matches in-core range_trees. | |
512 | ZFS_DEBUG_SET_ERROR |
Enable SET_ERROR and dprintf entries in the debug log. |
* Requires debug build.
Default value: 0.
zfs_free_leak_on_eio (int)
The default, "stalling" behavior is useful if the storage partially fails (i.e. some but not all i/os fail), and then later recovers. In this case, we will be able to continue pool operations while it is partially failed, and when it recovers, we can continue to free the space, with no leaks. However, note that this case is actually fairly rare.
Typically pools either (a) fail completely (but perhaps temporarily, e.g. a top-level vdev going offline), or (b) have localized, permanent errors (e.g. disk returns the wrong data due to bit flip or firmware bug). In case (a), this setting does not matter because the pool will be suspended and the sync thread will not be able to make forward progress regardless. In case (b), because the error is permanent, the best we can do is leak the minimum amount of space, which is what setting this flag will do. Therefore, it is reasonable for this flag to normally be set, but we chose the more conservative approach of not setting it, so that there is no possibility of leaking space in the "partial temporary" failure case.
Default value: 0.
zfs_free_min_time_ms (int)
Default value: 1,000.
zfs_immediate_write_sz (long)
Default value: 32,768.
zfs_max_recordsize (int)
Default value: 1,048,576.
zfs_mdcomp_disable (int)
Use 1 for yes and 0 for no (default).
zfs_metaslab_fragmentation_threshold (int)
Default value: 70.
zfs_mg_fragmentation_threshold (int)
Default value: 85.
zfs_mg_noalloc_threshold (int)
This parameter allows one to deal with pools having heavily imbalanced vdevs such as would be the case when a new vdev has been added. Setting the threshold to a non-zero percentage will stop allocations from being made to vdevs that aren't filled to the specified percentage and allow lesser filled vdevs to acquire more allocations than they otherwise would under the old zfs_mg_alloc_failures facility.
Default value: 0.
zfs_multihost_history (int)
Default value: 0.
zfs_multihost_interval (ulong)
The multihost write period is zfs_multihost_interval / leaf-vdevs milliseconds. This means that on average a multihost write will be issued for each leaf vdev every zfs_multihost_interval milliseconds. In practice, the observed period can vary with the I/O load and this observed value is the delay which is stored in the uberblock.
On import the activity check waits a minimum amount of time determined by zfs_multihost_interval * zfs_multihost_import_intervals. The activity check time may be further extended if the value of mmp delay found in the best uberblock indicates actual multihost updates happened at longer intervals than zfs_multihost_interval. A minimum value of 100ms is enforced.
Default value: 1000.
zfs_multihost_import_intervals (uint)
Default value: 10.
zfs_multihost_fail_intervals (uint)
When zfs_multihost_fail_intervals = 0 then multihost write failures are ignored. The failures will still be reported to the ZED which depending on its configuration may take action such as suspending the pool or offlining a device.
When zfs_multihost_fail_intervals > 0 then sequential multihost write failures will cause the pool to be suspended. This occurs when zfs_multihost_fail_intervals * zfs_multihost_interval milliseconds have passed since the last successful multihost write. This guarantees the activity test will see multihost writes if the pool is imported.
Default value: 5.
zfs_no_scrub_io (int)
Use 1 for yes and 0 for no (default).
zfs_no_scrub_prefetch (int)
Use 1 for yes and 0 for no (default).
zfs_nocacheflush (int)
Use 1 for yes and 0 for no (default).
zfs_nopwrite_enabled (int)
Use 1 for yes (default) and 0 to disable.
zfs_dmu_offset_next_sync (int)
Use 1 for yes and 0 to disable (default).
zfs_pd_bytes_max (int)
Default value: 52,428,800.
zfs_per_txg_dirty_frees_percent (ulong)
Default value: 30 and 0 to disable.
zfs_prefetch_disable (int)
Use 1 for yes and 0 for no (default).
zfs_read_chunk_size (long)
Default value: 1,048,576.
zfs_read_history (int)
Default value: 0 (no data is kept).
zfs_read_history_hits (int)
Use 1 for yes and 0 for no (default).
zfs_recover (int)
Use 1 for yes and 0 for no (default).
zfs_resilver_delay (int)
Default value: 2.
zfs_resilver_min_time_ms (int)
Default value: 3,000.
zfs_scan_ignore_errors (int)
Default value: 0.
zfs_scan_idle (int)
Default value: 50.
zfs_scan_min_time_ms (int)
Default value: 1,000.
zfs_scrub_delay (int)
Default value: 4.
zfs_send_corrupt_data (int)
Use 1 for yes and 0 for no (default).
zfs_send_queue_length (int)
Default value: 16,777,216.
zfs_recv_queue_length (int)
The maximum number of bytes allowed in the zfs receive queue. This value must be at least twice the maximum block size in use.
Default value: 16,777,216.
zfs_sync_pass_deferred_free (int)
Default value: 2.
zfs_sync_pass_dont_compress (int)
Default value: 5.
zfs_sync_pass_rewrite (int)
Default value: 2.
zfs_top_maxinflight (int)
Default value: 32.
zfs_txg_history (int)
Default value: 0.
zfs_txg_timeout (int)
Default value: 5.
zfs_vdev_aggregation_limit (int)
Default value: 131,072.
zfs_vdev_cache_bshift (int)
Default value: 16 (effectively 65536).
zfs_vdev_cache_max (int)
Default value: 16384.
zfs_vdev_cache_size (int)
Currently this feature is disabled as it has been found to not be helpful for performance and in some cases harmful.
Default value: 0.
zfs_vdev_mirror_rotating_inc (int)
Default value: 0.
zfs_vdev_mirror_rotating_seek_inc (int)
Default value: 5.
zfs_vdev_mirror_rotating_seek_offset (int)
Default value: 1048576.
zfs_vdev_mirror_non_rotating_inc (int)
Default value: 0.
zfs_vdev_mirror_non_rotating_seek_inc (int)
Default value: 1.
zfs_vdev_read_gap_limit (int)
Default value: 32,768.
zfs_vdev_scheduler (charp)
Default value: noop.
zfs_vdev_write_gap_limit (int)
Default value: 4,096.
zfs_vdev_raidz_impl (string)
Options marked (always) below may be selected on module load as they are supported on all systems. The remaining options may only be set after the module is loaded, as they are available only if the implementations are compiled in and supported on the running system.
Once the module is loaded, the content of
/sys/module/zfs/parameters/zfs_vdev_raidz_impl will show available options
with the currently selected one enclosed in []. Possible options are:
fastest - (always) implementation selected using built-in benchmark
original - (always) original raidz implementation
scalar - (always) scalar raidz implementation
sse2 - implementation using SSE2 instruction set (64bit x86 only)
ssse3 - implementation using SSSE3 instruction set (64bit x86 only)
avx2 - implementation using AVX2 instruction set (64bit x86 only)
avx512f - implementation using AVX512F instruction set (64bit x86 only)
avx512bw - implementation using AVX512F & AVX512BW instruction sets
(64bit x86 only)
aarch64_neon - implementation using NEON (Aarch64/64 bit ARMv8 only)
aarch64_neonx2 - implementation using NEON with more unrolling (Aarch64/64
bit ARMv8 only)
Default value: fastest.
zfs_zevent_cols (int)
Default value: 80.
zfs_zevent_console (int)
Use 1 for yes and 0 for no (default).
zfs_zevent_len_max (int)
Default value: 0.
zil_replay_disable (int)
Use 1 for yes and 0 for no (default).
zil_slog_bulk (ulong)
Default value: 786,432.
zio_delay_max (int)
Default value: 30,000.
zio_dva_throttle_enabled (int)
Default value: 1.
zio_requeue_io_start_cut_in_line (int)
Default value: 0.
zio_taskq_batch_pct (uint)
The default value of 75 was chosen to avoid using all CPUs which can result in latency issues and inconsistent application performance, especially when high compression is enabled.
Default value: 75.
zvol_inhibit_dev (uint)
Use 1 for yes and 0 for no (default).
zvol_major (uint)
Default value: 230.
zvol_max_discard_blocks (ulong)
Default value: 16,384.
zvol_prefetch_bytes (uint)
Default value: 131,072.
zvol_request_sync (uint)
Default value: 0.
zvol_threads (uint)
Default value: 32.
zvol_volmode (uint)
Default value: 1.
zfs_qat_disable (int)
Use 1 for yes and 0 for no (default).
ZFS issues I/O operations to leaf vdevs to satisfy and complete I/Os. The I/O scheduler determines when and in what order those operations are issued. The I/O scheduler divides operations into five I/O classes prioritized in the following order: sync read, sync write, async read, async write, and scrub/resilver. Each queue defines the minimum and maximum number of concurrent operations that may be issued to the device. In addition, the device has an aggregate maximum, zfs_vdev_max_active. Note that the sum of the per-queue minimums must not exceed the aggregate maximum. If the sum of the per-queue maximums exceeds the aggregate maximum, then the number of active I/Os may reach zfs_vdev_max_active, in which case no further I/Os will be issued regardless of whether all per-queue minimums have been met.
For many physical devices, throughput increases with the number of concurrent operations, but latency typically suffers. Further, physical devices typically have a limit at which more concurrent operations have no effect on throughput or can actually cause it to decrease.
The scheduler selects the next operation to issue by first looking for an I/O class whose minimum has not been satisfied. Once all are satisfied and the aggregate maximum has not been hit, the scheduler looks for classes whose maximum has not been satisfied. Iteration through the I/O classes is done in the order specified above. No further operations are issued if the aggregate maximum number of concurrent operations has been hit or if there are no operations queued for an I/O class that has not hit its maximum. Every time an I/O is queued or an operation completes, the I/O scheduler looks for new operations to issue.
In general, smaller max_active's will lead to lower latency of synchronous operations. Larger max_active's may lead to higher overall throughput, depending on underlying storage.
The ratio of the queues' max_actives determines the balance of performance between reads, writes, and scrubs. E.g., increasing zfs_vdev_scrub_max_active will cause the scrub or resilver to complete more quickly, but reads and writes to have higher latency and lower throughput.
All I/O classes have a fixed maximum number of outstanding operations except for the async write class. Asynchronous writes represent the data that is committed to stable storage during the syncing stage for transaction groups. Transaction groups enter the syncing state periodically so the number of queued async writes will quickly burst up and then bleed down to zero. Rather than servicing them as quickly as possible, the I/O scheduler changes the maximum number of active async write I/Os according to the amount of dirty data in the pool. Since both throughput and latency typically increase with the number of concurrent operations issued to physical devices, reducing the burstiness in the number of concurrent operations also stabilizes the response time of operations from other -- and in particular synchronous -- queues. In broad strokes, the I/O scheduler will issue more concurrent operations from the async write queue as there's more dirty data in the pool.
Async Writes
The number of concurrent operations issued for the async write I/O class follows a piece-wise linear function defined by a few adjustable points.
Until the amount of dirty data exceeds a minimum percentage of the dirty data allowed in the pool, the I/O scheduler will limit the number of concurrent operations to the minimum. As that threshold is crossed, the number of concurrent operations issued increases linearly to the maximum at the specified maximum percentage of the dirty data allowed in the pool.
| o---------| <-- zfs_vdev_async_write_max_active
^ | /^ |
| | / | | active | / | |
I/O | / | | count | / | |
| / | |
|-------o | | <-- zfs_vdev_async_write_min_active
0|_______^______|_________|
0% | | 100% of zfs_dirty_data_max
| |
| `-- zfs_vdev_async_write_active_max_dirty_percent
`--------- zfs_vdev_async_write_active_min_dirty_percent
Ideally, the amount of dirty data on a busy pool will stay in the sloped part of the function between zfs_vdev_async_write_active_min_dirty_percent and zfs_vdev_async_write_active_max_dirty_percent. If it exceeds the maximum percentage, this indicates that the rate of incoming data is greater than the rate that the backend storage can handle. In this case, we must further throttle incoming writes, as described in the next section.
We delay transactions when we've determined that the backend storage isn't able to accommodate the rate of incoming writes.
If there is already a transaction waiting, we delay relative to when that transaction will finish waiting. This way the calculated delay time is independent of the number of threads concurrently executing transactions.
If we are the only waiter, wait relative to when the transaction started, rather than the current time. This credits the transaction for "time already served", e.g. reading indirect blocks.
The minimum time for a transaction to take is calculated as:
min_time = zfs_delay_scale * (dirty - min) / (max - dirty)
min_time is then capped at 100 milliseconds.
The delay has two degrees of freedom that can be adjusted via tunables. The percentage of dirty data at which we start to delay is defined by zfs_delay_min_dirty_percent. This should typically be at or above zfs_vdev_async_write_active_max_dirty_percent so that we only start to delay after writing at full speed has failed to keep up with the incoming write rate. The scale of the curve is defined by zfs_delay_scale. Roughly speaking, this variable determines the amount of delay at the midpoint of the curve.
delay
10ms +-------------------------------------------------------------*+
| *|
9ms + *+
| *|
8ms + *+
| * |
7ms + * +
| * |
6ms + * +
| * |
5ms + * +
| * |
4ms + * +
| * |
3ms + * +
| * |
2ms + (midpoint) * +
| | ** |
1ms + v *** +
| zfs_delay_scale ----------> ******** |
0 +-------------------------------------*********----------------+
0% <- zfs_dirty_data_max -> 100%
Note that since the delay is added to the outstanding time remaining on the most recent transaction, the delay is effectively the inverse of IOPS. Here the midpoint of 500us translates to 2000 IOPS. The shape of the curve was chosen such that small changes in the amount of accumulated dirty data in the first 3/4 of the curve yield relatively small differences in the amount of delay.
The effects can be easier to understand when the amount of delay is represented on a log scale:
delay 100ms +-------------------------------------------------------------++
+ +
| |
+ *+
10ms + *+
+ ** +
| (midpoint) ** |
+ | ** +
1ms + v **** +
+ zfs_delay_scale ----------> ***** +
| **** |
+ **** + 100us + ** +
+ * +
| * |
+ * +
10us + * +
+ +
| |
+ +
+--------------------------------------------------------------+
0% <- zfs_dirty_data_max -> 100%
Note here that only as the amount of dirty data approaches its limit does the delay start to increase rapidly. The goal of a properly tuned system should be to keep the amount of dirty data out of that range by first ensuring that the appropriate limits are set for the I/O scheduler to reach optimal throughput on the backend storage, and then by changing the value of zfs_delay_scale to increase the steepness of the curve.
October 28, 2017 |