ZFS-MODULE-PARAMETERS(5)

NAME
zfs-module-parameters - ZFS module parameters

DESCRIPTION

Description of the different parameters to the ZFS module.

  Module parameters

l2arc_feed_again (int)
    Turbo L2ARC warmup

    Use 1 for yes (default) and 0 to disable.

l2arc_feed_min_ms (ulong)
    Min feed interval in milliseconds

    Default value: 200.

l2arc_feed_secs (ulong)
    Seconds between L2ARC writing

    Default value: 1.

l2arc_headroom (ulong)
    Number of max device writes to precache

    Default value: 2.

l2arc_headroom_boost (ulong)
    Compressed l2arc_headroom multiplier

    Default value: 200.

l2arc_nocompress (int)
    Skip compressing L2ARC buffers

    Use 1 for yes and 0 for no (default).

l2arc_noprefetch (int)
    Skip caching prefetched buffers

    Use 1 for yes (default) and 0 to disable.

l2arc_norw (int)
    No reads during writes

    Use 1 for yes and 0 for no (default).

l2arc_write_boost (ulong)
    Extra write bytes during device warmup

    Default value: 8,388,608.

l2arc_write_max (ulong)
    Max write bytes per interval

    Default value: 8,388,608.

metaslab_debug (int)
    Keep space maps in core to verify frees

    Use 1 for yes and 0 for no (default).

spa_config_path (charp)
    SPA config file

    Default value: /etc/zfs/zpool.cache.

spa_asize_inflation (int)
    Multiplication factor used to estimate actual disk consumption from the size of data being written. The default value is a worst case estimate, but lower values may be valid for a given pool depending on its configuration. Pool administrators who understand the factors involved may wish to specify a more realistic inflation factor, particularly if they operate close to quota or capacity limits.

    Default value: 24

zfetch_array_rd_sz (ulong)
    Number of bytes in a array_read

    Default value: 1,048,576.

zfetch_block_cap (uint)
    Max number of blocks to fetch at a time

    Default value: 256.

zfetch_max_streams (uint)
    Max number of streams per zfetch

    Default value: 8.

zfetch_min_sec_reap (uint)
    Min time before stream reclaim

    Default value: 2.

zfs_arc_grow_retry (int)
    Seconds before growing arc size

    Default value: 5.

zfs_arc_max (ulong)
    Max arc size

    Default value: 0.

zfs_arc_memory_throttle_disable (int)
    Disable memory throttle

    Use 1 for yes (default) and 0 to disable.

zfs_arc_meta_limit (ulong)
    Meta limit for arc size

    Default value: 0.

zfs_arc_meta_prune (int)
    Bytes of meta data to prune

    Default value: 1,048,576.

zfs_arc_min (ulong)
    Min arc size

    Default value: 100.

zfs_arc_min_prefetch_lifespan (int)
    Min life of prefetch block

    Default value: 100.

zfs_arc_p_aggressive_disable (int)
    Disable aggressive arc_p growth

    Use 1 for yes (default) and 0 to disable.

zfs_arc_p_dampener_disable (int)
    Disable arc_p adapt dampener

    Use 1 for yes (default) and 0 to disable.

zfs_arc_shrink_shift (int)
    log2(fraction of arc to reclaim)

    Default value: 5.

zfs_autoimport_disable (int)
    Disable pool import at module load

    Use 1 for yes and 0 for no (default).

zfs_dbuf_state_index (int)
    Calculate arc header index

    Default value: 0.

zfs_deadman_enabled (int)
    Enable deadman timer

    Use 1 for yes (default) and 0 to disable.

zfs_deadman_synctime_ms (ulong)
    Expiration time in milliseconds. This value has two meanings. First it is used to determine when the spa_deadman() logic should fire. By default the spa_deadman() will fire if spa_sync() has not completed in 1000 seconds. Secondly, the value determines if an I/O is considered "hung". Any I/O that has not completed in zfs_deadman_synctime_ms is considered "hung" resulting in a zevent being logged.

    Default value: 1,000,000.

zfs_dedup_prefetch (int)
    Enable prefetching dedup-ed blks

    Use 1 for yes (default) and 0 to disable.

zfs_delay_min_dirty_percent (int)
    Start to delay each transaction once there is this amount of dirty data, expressed as a percentage of zfs_dirty_data_max. This value should be >= zfs_vdev_async_write_active_max_dirty_percent. See the section "ZFS TRANSACTION DELAY".

    Default value: 60.

zfs_delay_scale (int)
    This controls how quickly the transaction delay approaches infinity. Larger values cause longer delays for a given amount of dirty data.

    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_dirty_data_max (int)
    Determines the dirty space limit in bytes. Once this limit is exceeded, new writes are halted until space frees up. This parameter takes precedence over zfs_dirty_data_max_percent. See the section "ZFS TRANSACTION DELAY".

    Default value: 10 percent of all memory, capped at zfs_dirty_data_max_max.

zfs_dirty_data_max_max (int)
    Maximum allowable value of zfs_dirty_data_max, expressed in bytes. This limit is only enforced at module load time, and will be ignored if zfs_dirty_data_max is later changed. This parameter takes precedence over zfs_dirty_data_max_max_percent. See the section "ZFS TRANSACTION DELAY".

    Default value: 25% of physical RAM.

zfs_dirty_data_max_max_percent (int)
    Maximum allowable value of zfs_dirty_data_max, expressed as a percentage of physical RAM. This limit is only enforced at module load time, and will be ignored if zfs_dirty_data_max is later changed. The parameter zfs_dirty_data_max_max takes precedence over this one. See the section "ZFS TRANSACTION DELAY".

    Default value: 25

zfs_dirty_data_max_percent (int)
    Determines the dirty space limit, expressed as a percentage of all memory. Once this limit is exceeded, new writes are halted until space frees up. The parameter zfs_dirty_data_max takes precedence over this one. See the section "ZFS TRANSACTION DELAY".

    Default value: 10%, subject to zfs_dirty_data_max_max.

zfs_dirty_data_sync (int)
    Start syncing out a transaction group if there is at least this much dirty data.

    Default value: 67,108,864.

zfs_vdev_async_read_max_active (int)
    Maxium asynchronous read I/Os active to each device. See the section "ZFS I/O SCHEDULER".

    Default value: 3.

zfs_vdev_async_read_min_active (int)
    Minimum asynchronous read I/Os active to each device. See the section "ZFS I/O SCHEDULER".

    Default value: 1.

zfs_vdev_async_write_active_max_dirty_percent (int)
    When the pool has more than zfs_vdev_async_write_active_max_dirty_percent dirty data, use zfs_vdev_async_write_max_active to limit active async writes. If the dirty data is between min and max, the active I/O limit is linearly interpolated. See the section "ZFS I/O SCHEDULER".

    Default value: 60.

zfs_vdev_async_write_active_min_dirty_percent (int)
    When the pool has less than zfs_vdev_async_write_active_min_dirty_percent dirty data, use zfs_vdev_async_write_min_active to limit active async writes. If the dirty data is between min and max, the active I/O limit is linearly interpolated. See the section "ZFS I/O SCHEDULER".

    Default value: 30.

zfs_vdev_async_write_max_active (int)
    Maxium asynchronous write I/Os active to each device. See the section "ZFS I/O SCHEDULER".

    Default value: 10.

zfs_vdev_async_write_min_active (int)
    Minimum asynchronous write I/Os active to each device. See the section "ZFS I/O SCHEDULER".

    Default value: 1.

zfs_vdev_max_active (int)
    The maximum number of I/Os active to each device. Ideally, this will be >= the sum of each queue's max_active. It must be at least the sum of each queue's min_active. See the section "ZFS I/O SCHEDULER".

    Default value: 1,000.

zfs_vdev_scrub_max_active (int)
    Maxium scrub I/Os active to each device. See the section "ZFS I/O SCHEDULER".

    Default value: 2.

zfs_vdev_scrub_min_active (int)
    Minimum scrub I/Os active to each device. See the section "ZFS I/O SCHEDULER".

    Default value: 1.

zfs_vdev_sync_read_max_active (int)
    Maxium synchronous read I/Os active to each device. See the section "ZFS I/O SCHEDULER".

    Default value: 10.

zfs_vdev_sync_read_min_active (int)
    Minimum synchronous read I/Os active to each device. See the section "ZFS I/O SCHEDULER".

    Default value: 10.

zfs_vdev_sync_write_max_active (int)
    Maxium synchronous write I/Os active to each device. See the section "ZFS I/O SCHEDULER".

    Default value: 10.

zfs_vdev_sync_write_min_active (int)
    Minimum synchronous write I/Os active to each device. See the section "ZFS I/O SCHEDULER".

    Default value: 10.

zfs_disable_dup_eviction (int)
    Disable duplicate buffer eviction

    Use 1 for yes and 0 for no (default).

zfs_expire_snapshot (int)
    Seconds to expire .zfs/snapshot

    Default value: 300.

zfs_flags (int)
    Set additional debugging flags

    Default value: 1.

zfs_free_min_time_ms (int)
    Min millisecs to free per txg

    Default value: 1,000.

zfs_immediate_write_sz (long)
    Largest data block to write to zil

    Default value: 32,768.

zfs_mdcomp_disable (int)
    Disable meta data compression

    Use 1 for yes and 0 for no (default).

zfs_no_scrub_io (int)
    Set for no scrub I/O

    Use 1 for yes and 0 for no (default).

zfs_no_scrub_prefetch (int)
    Set for no scrub prefetching

    Use 1 for yes and 0 for no (default).

zfs_nocacheflush (int)
    Disable cache flushes

    Use 1 for yes and 0 for no (default).

zfs_nopwrite_enabled (int)
    Enable NOP writes

    Use 1 for yes (default) and 0 to disable.

zfs_pd_blks_max (int)
    Max number of blocks to prefetch

    Default value: 100.

zfs_prefetch_disable (int)
    Disable all ZFS prefetching

    Use 1 for yes and 0 for no (default).

zfs_read_chunk_size (long)
    Bytes to read per chunk

    Default value: 1,048,576.

zfs_read_history (int)
    Historic statistics for the last N reads

    Default value: 0.

zfs_read_history_hits (int)
    Include cache hits in read history

    Use 1 for yes and 0 for no (default).

zfs_recover (int)
    Set to attempt to recover from fatal errors. This should only be used as a last resort, as it typically results in leaked space, or worse.

    Use 1 for yes and 0 for no (default).

zfs_resilver_delay (int)
    Number of ticks to delay resilver

    Default value: 2.

zfs_resilver_min_time_ms (int)
    Min millisecs to resilver per txg

    Default value: 3,000.

zfs_scan_idle (int)
    Idle window in clock ticks

    Default value: 50.

zfs_scan_min_time_ms (int)
    Min millisecs to scrub per txg

    Default value: 1,000.

zfs_scrub_delay (int)
    Number of ticks to delay scrub

    Default value: 4.

zfs_send_corrupt_data (int)
    Allow to send corrupt data (ignore read/checksum errors when sending data)

    Use 1 for yes and 0 for no (default).

zfs_sync_pass_deferred_free (int)
    Defer frees starting in this pass

    Default value: 2.

zfs_sync_pass_dont_compress (int)
    Don't compress starting in this pass

    Default value: 5.

zfs_sync_pass_rewrite (int)
    Rewrite new bps starting in this pass

    Default value: 2.

zfs_top_maxinflight (int)
    Max I/Os per top-level

    Default value: 32.

zfs_txg_history (int)
    Historic statistics for the last N txgs

    Default value: 0.

zfs_txg_timeout (int)
    Max seconds worth of delta per txg

    Default value: 5.

zfs_vdev_aggregation_limit (int)
    Max vdev I/O aggregation size

    Default value: 131,072.

zfs_vdev_cache_bshift (int)
    Shift size to inflate reads too

    Default value: 16.

zfs_vdev_cache_max (int)
    Inflate reads small than max

zfs_vdev_cache_size (int)
    Total size of the per-disk cache

    Default value: 0.

zfs_vdev_mirror_switch_us (int)
    Switch mirrors every N usecs

    Default value: 10,000.

zfs_vdev_read_gap_limit (int)
    Aggregate read I/O over gap

    Default value: 32,768.

zfs_vdev_scheduler (charp)
    I/O scheduler

    Default value: noop.

zfs_vdev_write_gap_limit (int)
    Aggregate write I/O over gap

    Default value: 4,096.

zfs_zevent_cols (int)
    Max event column width

    Default value: 80.

zfs_zevent_console (int)
    Log events to the console

    Use 1 for yes and 0 for no (default).

zfs_zevent_len_max (int)
    Max event queue length

    Default value: 0.

zil_replay_disable (int)
    Disable intent logging replay

    Use 1 for yes and 0 for no (default).

zil_slog_limit (ulong)
    Max commit bytes to separate log device

    Default value: 1,048,576.

zio_bulk_flags (int)
    Additional flags to pass to bulk buffers

    Default value: 0.

zio_delay_max (int)
    Max zio millisec delay before posting event

    Default value: 30,000.

zio_injection_enabled (int)
    Enable fault injection

    Use 1 for yes and 0 for no (default).

zio_requeue_io_start_cut_in_line (int)
    Prioritize requeued I/O

    Default value: 0.

zvol_inhibit_dev (uint)
    Do not create zvol device nodes

    Use 1 for yes and 0 for no (default).

zvol_major (uint)
    Major number for zvol device

    Default value: 230.

zvol_max_discard_blocks (ulong)
    Max number of blocks to discard at once

    Default value: 16,384.

zvol_threads (uint)
    Number of threads for zvol device

    Default value: 32.

ZFS I/O SCHEDULER
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.
       |              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
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.

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.

ZFS TRANSACTION DELAY
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.