2 .\" Copyright (c) 2013 by Turbo Fredriksson <turbo@bayour.com>. All rights reserved.
3 .\" The contents of this file are subject to the terms of the Common Development
4 .\" and Distribution License (the "License"). You may not use this file except
5 .\" in compliance with the License. You can obtain a copy of the license at
6 .\" usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
8 .\" See the License for the specific language governing permissions and
9 .\" limitations under the License. When distributing Covered Code, include this
10 .\" CDDL HEADER in each file and include the License file at
11 .\" usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this
12 .\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your
13 .\" own identifying information:
14 .\" Portions Copyright [yyyy] [name of copyright owner]
15 .TH ZFS-MODULE-PARAMETERS 5 "Nov 16, 2013"
17 zfs\-module\-parameters \- ZFS module parameters
21 Description of the different parameters to the ZFS module.
23 .SS "Module parameters"
30 \fBignore_hole_birth\fR (int)
33 When set, the hole_birth optimization will not be used, and all holes will
34 always be sent on zfs send. Useful if you suspect your datasets are affected
35 by a bug in hole_birth.
37 Use \fB1\fR for on (default) and \fB0\fR for off.
43 \fBl2arc_feed_again\fR (int)
46 Turbo L2ARC warm-up. When the L2ARC is cold the fill interval will be set as
49 Use \fB1\fR for yes (default) and \fB0\fR to disable.
55 \fBl2arc_feed_min_ms\fR (ulong)
58 Min feed interval in milliseconds. Requires \fBl2arc_feed_again=1\fR and only
59 applicable in related situations.
61 Default value: \fB200\fR.
67 \fBl2arc_feed_secs\fR (ulong)
70 Seconds between L2ARC writing
72 Default value: \fB1\fR.
78 \fBl2arc_headroom\fR (ulong)
81 How far through the ARC lists to search for L2ARC cacheable content, expressed
82 as a multiplier of \fBl2arc_write_max\fR
84 Default value: \fB2\fR.
90 \fBl2arc_headroom_boost\fR (ulong)
93 Scales \fBl2arc_headroom\fR by this percentage when L2ARC contents are being
94 successfully compressed before writing. A value of 100 disables this feature.
96 Default value: \fB200\fR.
102 \fBl2arc_nocompress\fR (int)
105 Skip compressing L2ARC buffers
107 Use \fB1\fR for yes and \fB0\fR for no (default).
113 \fBl2arc_noprefetch\fR (int)
116 Do not write buffers to L2ARC if they were prefetched but not used by
119 Use \fB1\fR for yes (default) and \fB0\fR to disable.
125 \fBl2arc_norw\fR (int)
128 No reads during writes
130 Use \fB1\fR for yes and \fB0\fR for no (default).
136 \fBl2arc_write_boost\fR (ulong)
139 Cold L2ARC devices will have \fBl2arc_write_nax\fR increased by this amount
140 while they remain cold.
142 Default value: \fB8,388,608\fR.
148 \fBl2arc_write_max\fR (ulong)
151 Max write bytes per interval
153 Default value: \fB8,388,608\fR.
159 \fBmetaslab_aliquot\fR (ulong)
162 Metaslab granularity, in bytes. This is roughly similar to what would be
163 referred to as the "stripe size" in traditional RAID arrays. In normal
164 operation, ZFS will try to write this amount of data to a top-level vdev
165 before moving on to the next one.
167 Default value: \fB524,288\fR.
173 \fBmetaslab_bias_enabled\fR (int)
176 Enable metaslab group biasing based on its vdev's over- or under-utilization
177 relative to the pool.
179 Use \fB1\fR for yes (default) and \fB0\fR for no.
185 \fBmetaslab_debug_load\fR (int)
188 Load all metaslabs during pool import.
190 Use \fB1\fR for yes and \fB0\fR for no (default).
196 \fBmetaslab_debug_unload\fR (int)
199 Prevent metaslabs from being unloaded.
201 Use \fB1\fR for yes and \fB0\fR for no (default).
207 \fBmetaslab_fragmentation_factor_enabled\fR (int)
210 Enable use of the fragmentation metric in computing metaslab weights.
212 Use \fB1\fR for yes (default) and \fB0\fR for no.
218 \fBmetaslabs_per_vdev\fR (int)
221 When a vdev is added, it will be divided into approximately (but no more than) this number of metaslabs.
223 Default value: \fB200\fR.
229 \fBmetaslab_preload_enabled\fR (int)
232 Enable metaslab group preloading.
234 Use \fB1\fR for yes (default) and \fB0\fR for no.
240 \fBmetaslab_lba_weighting_enabled\fR (int)
243 Give more weight to metaslabs with lower LBAs, assuming they have
244 greater bandwidth as is typically the case on a modern constant
245 angular velocity disk drive.
247 Use \fB1\fR for yes (default) and \fB0\fR for no.
253 \fBspa_config_path\fR (charp)
258 Default value: \fB/etc/zfs/zpool.cache\fR.
264 \fBspa_asize_inflation\fR (int)
267 Multiplication factor used to estimate actual disk consumption from the
268 size of data being written. The default value is a worst case estimate,
269 but lower values may be valid for a given pool depending on its
270 configuration. Pool administrators who understand the factors involved
271 may wish to specify a more realistic inflation factor, particularly if
272 they operate close to quota or capacity limits.
274 Default value: \fB24\fR.
280 \fBspa_load_verify_data\fR (int)
283 Whether to traverse data blocks during an "extreme rewind" (\fB-X\fR)
284 import. Use 0 to disable and 1 to enable.
286 An extreme rewind import normally performs a full traversal of all
287 blocks in the pool for verification. If this parameter is set to 0,
288 the traversal skips non-metadata blocks. It can be toggled once the
289 import has started to stop or start the traversal of non-metadata blocks.
291 Default value: \fB1\fR.
297 \fBspa_load_verify_metadata\fR (int)
300 Whether to traverse blocks during an "extreme rewind" (\fB-X\fR)
301 pool import. Use 0 to disable and 1 to enable.
303 An extreme rewind import normally performs a full traversal of all
304 blocks in the pool for verification. If this parameter is set to 0,
305 the traversal is not performed. It can be toggled once the import has
306 started to stop or start the traversal.
308 Default value: \fB1\fR.
314 \fBspa_load_verify_maxinflight\fR (int)
317 Maximum concurrent I/Os during the traversal performed during an "extreme
318 rewind" (\fB-X\fR) pool import.
320 Default value: \fB10000\fR.
326 \fBspa_slop_shift\fR (int)
329 Normally, we don't allow the last 3.2% (1/(2^spa_slop_shift)) of space
330 in the pool to be consumed. This ensures that we don't run the pool
331 completely out of space, due to unaccounted changes (e.g. to the MOS).
332 It also limits the worst-case time to allocate space. If we have
333 less than this amount of free space, most ZPL operations (e.g. write,
334 create) will return ENOSPC.
336 Default value: \fB5\fR.
342 \fBzfetch_array_rd_sz\fR (ulong)
345 If prefetching is enabled, disable prefetching for reads larger than this size.
347 Default value: \fB1,048,576\fR.
353 \fBzfetch_max_distance\fR (uint)
356 Max bytes to prefetch per stream (default 8MB).
358 Default value: \fB8,388,608\fR.
364 \fBzfetch_max_streams\fR (uint)
367 Max number of streams per zfetch (prefetch streams per file).
369 Default value: \fB8\fR.
375 \fBzfetch_min_sec_reap\fR (uint)
378 Min time before an active prefetch stream can be reclaimed
380 Default value: \fB2\fR.
386 \fBzfs_arc_dnode_limit\fR (ulong)
389 When the number of bytes consumed by dnodes in the ARC exceeds this number of
390 bytes, try to unpin some of it in response to demand for non-metadata. This
391 value acts as a floor to the amount of dnode metadata, and defaults to 0 which
392 indicates that a percent which is based on \fBzfs_arc_dnode_limit_percent\fR of
393 the ARC meta buffers that may be used for dnodes.
395 See also \fBzfs_arc_meta_prune\fR which serves a similar purpose but is used
396 when the amount of metadata in the ARC exceeds \fBzfs_arc_meta_limit\fR rather
397 than in response to overall demand for non-metadata.
400 Default value: \fB0\fR.
406 \fBzfs_arc_dnode_limit_percent\fR (ulong)
409 Percentage that can be consumed by dnodes of ARC meta buffers.
411 See also \fBzfs_arc_dnode_limit\fR which serves a similar purpose but has a
412 higher priority if set to nonzero value.
414 Default value: \fB10\fR.
420 \fBzfs_arc_dnode_reduce_percent\fR (ulong)
423 Percentage of ARC dnodes to try to scan in response to demand for non-metadata
424 when the number of bytes consumed by dnodes exceeds \fBzfs_arc_dnode_limit\fR.
427 Default value: \fB10% of the number of dnodes in the ARC\fR.
433 \fBzfs_arc_average_blocksize\fR (int)
436 The ARC's buffer hash table is sized based on the assumption of an average
437 block size of \fBzfs_arc_average_blocksize\fR (default 8K). This works out
438 to roughly 1MB of hash table per 1GB of physical memory with 8-byte pointers.
439 For configurations with a known larger average block size this value can be
440 increased to reduce the memory footprint.
443 Default value: \fB8192\fR.
449 \fBzfs_arc_evict_batch_limit\fR (int)
452 Number ARC headers to evict per sub-list before proceeding to another sub-list.
453 This batch-style operation prevents entire sub-lists from being evicted at once
454 but comes at a cost of additional unlocking and locking.
456 Default value: \fB10\fR.
462 \fBzfs_arc_grow_retry\fR (int)
465 After a memory pressure event the ARC will wait this many seconds before trying
468 Default value: \fB5\fR.
474 \fBzfs_arc_lotsfree_percent\fR (int)
477 Throttle I/O when free system memory drops below this percentage of total
478 system memory. Setting this value to 0 will disable the throttle.
480 Default value: \fB10\fR.
486 \fBzfs_arc_max\fR (ulong)
489 Max arc size of ARC in bytes. If set to 0 then it will consume 1/2 of system
490 RAM. This value must be at least 67108864 (64 megabytes).
492 This value can be changed dynamically with some caveats. It cannot be set back
493 to 0 while running and reducing it below the current ARC size will not cause
494 the ARC to shrink without memory pressure to induce shrinking.
496 Default value: \fB0\fR.
502 \fBzfs_arc_meta_limit\fR (ulong)
505 The maximum allowed size in bytes that meta data buffers are allowed to
506 consume in the ARC. When this limit is reached meta data buffers will
507 be reclaimed even if the overall arc_c_max has not been reached. This
508 value defaults to 0 which indicates that a percent which is based on
509 \fBzfs_arc_meta_limit_percent\fR of the ARC may be used for meta data.
511 This value my be changed dynamically except that it cannot be set back to 0
512 for a specific percent of the ARC; it must be set to an explicit value.
514 Default value: \fB0\fR.
520 \fBzfs_arc_meta_limit_percent\fR (ulong)
523 Percentage of ARC buffers that can be used for meta data.
525 See also \fBzfs_arc_meta_limit\fR which serves a similar purpose but has a
526 higher priority if set to nonzero value.
529 Default value: \fB75\fR.
535 \fBzfs_arc_meta_min\fR (ulong)
538 The minimum allowed size in bytes that meta data buffers may consume in
539 the ARC. This value defaults to 0 which disables a floor on the amount
540 of the ARC devoted meta data.
542 Default value: \fB0\fR.
548 \fBzfs_arc_meta_prune\fR (int)
551 The number of dentries and inodes to be scanned looking for entries
552 which can be dropped. This may be required when the ARC reaches the
553 \fBzfs_arc_meta_limit\fR because dentries and inodes can pin buffers
554 in the ARC. Increasing this value will cause to dentry and inode caches
555 to be pruned more aggressively. Setting this value to 0 will disable
556 pruning the inode and dentry caches.
558 Default value: \fB10,000\fR.
564 \fBzfs_arc_meta_adjust_restarts\fR (ulong)
567 The number of restart passes to make while scanning the ARC attempting
568 the free buffers in order to stay below the \fBzfs_arc_meta_limit\fR.
569 This value should not need to be tuned but is available to facilitate
570 performance analysis.
572 Default value: \fB4096\fR.
578 \fBzfs_arc_min\fR (ulong)
583 Default value: \fB100\fR.
589 \fBzfs_arc_min_prefetch_lifespan\fR (int)
592 Minimum time prefetched blocks are locked in the ARC, specified in jiffies.
593 A value of 0 will default to 1 second.
595 Default value: \fB0\fR.
601 \fBzfs_arc_num_sublists_per_state\fR (int)
604 To allow more fine-grained locking, each ARC state contains a series
605 of lists for both data and meta data objects. Locking is performed at
606 the level of these "sub-lists". This parameters controls the number of
607 sub-lists per ARC state.
609 Default value: \fB1\fR or the number of online CPUs, whichever is greater
615 \fBzfs_arc_overflow_shift\fR (int)
618 The ARC size is considered to be overflowing if it exceeds the current
619 ARC target size (arc_c) by a threshold determined by this parameter.
620 The threshold is calculated as a fraction of arc_c using the formula
621 "arc_c >> \fBzfs_arc_overflow_shift\fR".
623 The default value of 8 causes the ARC to be considered to be overflowing
624 if it exceeds the target size by 1/256th (0.3%) of the target size.
626 When the ARC is overflowing, new buffer allocations are stalled until
627 the reclaim thread catches up and the overflow condition no longer exists.
629 Default value: \fB8\fR.
636 \fBzfs_arc_p_min_shift\fR (int)
639 arc_c shift to calc min/max arc_p
641 Default value: \fB4\fR.
647 \fBzfs_arc_p_aggressive_disable\fR (int)
650 Disable aggressive arc_p growth
652 Use \fB1\fR for yes (default) and \fB0\fR to disable.
658 \fBzfs_arc_p_dampener_disable\fR (int)
661 Disable arc_p adapt dampener
663 Use \fB1\fR for yes (default) and \fB0\fR to disable.
669 \fBzfs_arc_shrink_shift\fR (int)
672 log2(fraction of arc to reclaim)
674 Default value: \fB5\fR.
680 \fBzfs_arc_sys_free\fR (ulong)
683 The target number of bytes the ARC should leave as free memory on the system.
684 Defaults to the larger of 1/64 of physical memory or 512K. Setting this
685 option to a non-zero value will override the default.
687 Default value: \fB0\fR.
693 \fBzfs_autoimport_disable\fR (int)
696 Disable pool import at module load by ignoring the cache file (typically \fB/etc/zfs/zpool.cache\fR).
698 Use \fB1\fR for yes (default) and \fB0\fR for no.
704 \fBzfs_dbgmsg_enable\fR (int)
707 Internally ZFS keeps a small log to facilitate debugging. By default the log
708 is disabled, to enable it set this option to 1. The contents of the log can
709 be accessed by reading the /proc/spl/kstat/zfs/dbgmsg file. Writing 0 to
710 this proc file clears the log.
712 Default value: \fB0\fR.
718 \fBzfs_dbgmsg_maxsize\fR (int)
721 The maximum size in bytes of the internal ZFS debug log.
723 Default value: \fB4M\fR.
729 \fBzfs_dbuf_state_index\fR (int)
732 This feature is currently unused. It is normally used for controlling what
733 reporting is available under /proc/spl/kstat/zfs.
735 Default value: \fB0\fR.
741 \fBzfs_deadman_enabled\fR (int)
744 Enable deadman timer. See description below.
746 Use \fB1\fR for yes (default) and \fB0\fR to disable.
752 \fBzfs_deadman_synctime_ms\fR (ulong)
755 Expiration time in milliseconds. This value has two meanings. First it is
756 used to determine when the spa_deadman() logic should fire. By default the
757 spa_deadman() will fire if spa_sync() has not completed in 1000 seconds.
758 Secondly, the value determines if an I/O is considered "hung". Any I/O that
759 has not completed in zfs_deadman_synctime_ms is considered "hung" resulting
760 in a zevent being logged.
762 Default value: \fB1,000,000\fR.
768 \fBzfs_dedup_prefetch\fR (int)
771 Enable prefetching dedup-ed blks
773 Use \fB1\fR for yes and \fB0\fR to disable (default).
779 \fBzfs_delay_min_dirty_percent\fR (int)
782 Start to delay each transaction once there is this amount of dirty data,
783 expressed as a percentage of \fBzfs_dirty_data_max\fR.
784 This value should be >= zfs_vdev_async_write_active_max_dirty_percent.
785 See the section "ZFS TRANSACTION DELAY".
787 Default value: \fB60\fR.
793 \fBzfs_delay_scale\fR (int)
796 This controls how quickly the transaction delay approaches infinity.
797 Larger values cause longer delays for a given amount of dirty data.
799 For the smoothest delay, this value should be about 1 billion divided
800 by the maximum number of operations per second. This will smoothly
801 handle between 10x and 1/10th this number.
803 See the section "ZFS TRANSACTION DELAY".
805 Note: \fBzfs_delay_scale\fR * \fBzfs_dirty_data_max\fR must be < 2^64.
807 Default value: \fB500,000\fR.
813 \fBzfs_delete_blocks\fR (ulong)
816 This is the used to define a large file for the purposes of delete. Files
817 containing more than \fBzfs_delete_blocks\fR will be deleted asynchronously
818 while smaller files are deleted synchronously. Decreasing this value will
819 reduce the time spent in an unlink(2) system call at the expense of a longer
820 delay before the freed space is available.
822 Default value: \fB20,480\fR.
828 \fBzfs_dirty_data_max\fR (int)
831 Determines the dirty space limit in bytes. Once this limit is exceeded, new
832 writes are halted until space frees up. This parameter takes precedence
833 over \fBzfs_dirty_data_max_percent\fR.
834 See the section "ZFS TRANSACTION DELAY".
836 Default value: 10 percent of all memory, capped at \fBzfs_dirty_data_max_max\fR.
842 \fBzfs_dirty_data_max_max\fR (int)
845 Maximum allowable value of \fBzfs_dirty_data_max\fR, expressed in bytes.
846 This limit is only enforced at module load time, and will be ignored if
847 \fBzfs_dirty_data_max\fR is later changed. This parameter takes
848 precedence over \fBzfs_dirty_data_max_max_percent\fR. See the section
849 "ZFS TRANSACTION DELAY".
851 Default value: 25% of physical RAM.
857 \fBzfs_dirty_data_max_max_percent\fR (int)
860 Maximum allowable value of \fBzfs_dirty_data_max\fR, expressed as a
861 percentage of physical RAM. This limit is only enforced at module load
862 time, and will be ignored if \fBzfs_dirty_data_max\fR is later changed.
863 The parameter \fBzfs_dirty_data_max_max\fR takes precedence over this
864 one. See the section "ZFS TRANSACTION DELAY".
866 Default value: \fN25\fR.
872 \fBzfs_dirty_data_max_percent\fR (int)
875 Determines the dirty space limit, expressed as a percentage of all
876 memory. Once this limit is exceeded, new writes are halted until space frees
877 up. The parameter \fBzfs_dirty_data_max\fR takes precedence over this
878 one. See the section "ZFS TRANSACTION DELAY".
880 Default value: 10%, subject to \fBzfs_dirty_data_max_max\fR.
886 \fBzfs_dirty_data_sync\fR (int)
889 Start syncing out a transaction group if there is at least this much dirty data.
891 Default value: \fB67,108,864\fR.
897 \fBzfs_fletcher_4_impl\fR (string)
900 Select a fletcher 4 implementation.
902 Supported selectors are: \fBfastest\fR, \fBscalar\fR, \fBsse2\fR, \fBssse3\fR,
903 \fBavx2\fR, \fBavx512f\fR, and \fBaarch64_neon\fR.
904 All of the selectors except \fBfastest\fR and \fBscalar\fR require instruction
905 set extensions to be available and will only appear if ZFS detects that they are
906 present at runtime. If multiple implementations of fletcher 4 are available,
907 the \fBfastest\fR will be chosen using a micro benchmark. Selecting \fBscalar\fR
908 results in the original, CPU based calculation, being used. Selecting any option
909 other than \fBfastest\fR and \fBscalar\fR results in vector instructions from
910 the respective CPU instruction set being used.
912 Default value: \fBfastest\fR.
918 \fBzfs_free_bpobj_enabled\fR (int)
921 Enable/disable the processing of the free_bpobj object.
923 Default value: \fB1\fR.
929 \fBzfs_free_max_blocks\fR (ulong)
932 Maximum number of blocks freed in a single txg.
934 Default value: \fB100,000\fR.
940 \fBzfs_vdev_async_read_max_active\fR (int)
943 Maximum asynchronous read I/Os active to each device.
944 See the section "ZFS I/O SCHEDULER".
946 Default value: \fB3\fR.
952 \fBzfs_vdev_async_read_min_active\fR (int)
955 Minimum asynchronous read I/Os active to each device.
956 See the section "ZFS I/O SCHEDULER".
958 Default value: \fB1\fR.
964 \fBzfs_vdev_async_write_active_max_dirty_percent\fR (int)
967 When the pool has more than
968 \fBzfs_vdev_async_write_active_max_dirty_percent\fR dirty data, use
969 \fBzfs_vdev_async_write_max_active\fR to limit active async writes. If
970 the dirty data is between min and max, the active I/O limit is linearly
971 interpolated. See the section "ZFS I/O SCHEDULER".
973 Default value: \fB60\fR.
979 \fBzfs_vdev_async_write_active_min_dirty_percent\fR (int)
982 When the pool has less than
983 \fBzfs_vdev_async_write_active_min_dirty_percent\fR dirty data, use
984 \fBzfs_vdev_async_write_min_active\fR to limit active async writes. If
985 the dirty data is between min and max, the active I/O limit is linearly
986 interpolated. See the section "ZFS I/O SCHEDULER".
988 Default value: \fB30\fR.
994 \fBzfs_vdev_async_write_max_active\fR (int)
997 Maximum asynchronous write I/Os active to each device.
998 See the section "ZFS I/O SCHEDULER".
1000 Default value: \fB10\fR.
1006 \fBzfs_vdev_async_write_min_active\fR (int)
1009 Minimum asynchronous write I/Os active to each device.
1010 See the section "ZFS I/O SCHEDULER".
1012 Default value: \fB1\fR.
1018 \fBzfs_vdev_max_active\fR (int)
1021 The maximum number of I/Os active to each device. Ideally, this will be >=
1022 the sum of each queue's max_active. It must be at least the sum of each
1023 queue's min_active. See the section "ZFS I/O SCHEDULER".
1025 Default value: \fB1,000\fR.
1031 \fBzfs_vdev_scrub_max_active\fR (int)
1034 Maximum scrub I/Os active to each device.
1035 See the section "ZFS I/O SCHEDULER".
1037 Default value: \fB2\fR.
1043 \fBzfs_vdev_scrub_min_active\fR (int)
1046 Minimum scrub I/Os active to each device.
1047 See the section "ZFS I/O SCHEDULER".
1049 Default value: \fB1\fR.
1055 \fBzfs_vdev_sync_read_max_active\fR (int)
1058 Maximum synchronous read I/Os active to each device.
1059 See the section "ZFS I/O SCHEDULER".
1061 Default value: \fB10\fR.
1067 \fBzfs_vdev_sync_read_min_active\fR (int)
1070 Minimum synchronous read I/Os active to each device.
1071 See the section "ZFS I/O SCHEDULER".
1073 Default value: \fB10\fR.
1079 \fBzfs_vdev_sync_write_max_active\fR (int)
1082 Maximum synchronous write I/Os active to each device.
1083 See the section "ZFS I/O SCHEDULER".
1085 Default value: \fB10\fR.
1091 \fBzfs_vdev_sync_write_min_active\fR (int)
1094 Minimum synchronous write I/Os active to each device.
1095 See the section "ZFS I/O SCHEDULER".
1097 Default value: \fB10\fR.
1103 \fBzfs_vdev_queue_depth_pct\fR (int)
1106 The queue depth percentage for each top-level virtual device.
1107 Used in conjunction with zfs_vdev_async_max_active.
1109 Default value: \fB1000\fR.
1115 \fBzfs_disable_dup_eviction\fR (int)
1118 Disable duplicate buffer eviction
1120 Use \fB1\fR for yes and \fB0\fR for no (default).
1126 \fBzfs_expire_snapshot\fR (int)
1129 Seconds to expire .zfs/snapshot
1131 Default value: \fB300\fR.
1137 \fBzfs_admin_snapshot\fR (int)
1140 Allow the creation, removal, or renaming of entries in the .zfs/snapshot
1141 directory to cause the creation, destruction, or renaming of snapshots.
1142 When enabled this functionality works both locally and over NFS exports
1143 which have the 'no_root_squash' option set. This functionality is disabled
1146 Use \fB1\fR for yes and \fB0\fR for no (default).
1152 \fBzfs_flags\fR (int)
1155 Set additional debugging flags. The following flags may be bitwise-or'd
1167 Enable dprintf entries in the debug log.
1169 2 ZFS_DEBUG_DBUF_VERIFY *
1170 Enable extra dbuf verifications.
1172 4 ZFS_DEBUG_DNODE_VERIFY *
1173 Enable extra dnode verifications.
1175 8 ZFS_DEBUG_SNAPNAMES
1176 Enable snapshot name verification.
1179 Check for illegally modified ARC buffers.
1182 Enable spa_dbgmsg entries in the debug log.
1184 64 ZFS_DEBUG_ZIO_FREE
1185 Enable verification of block frees.
1187 128 ZFS_DEBUG_HISTOGRAM_VERIFY
1188 Enable extra spacemap histogram verifications.
1191 * Requires debug build.
1193 Default value: \fB0\fR.
1199 \fBzfs_free_leak_on_eio\fR (int)
1202 If destroy encounters an EIO while reading metadata (e.g. indirect
1203 blocks), space referenced by the missing metadata can not be freed.
1204 Normally this causes the background destroy to become "stalled", as
1205 it is unable to make forward progress. While in this stalled state,
1206 all remaining space to free from the error-encountering filesystem is
1207 "temporarily leaked". Set this flag to cause it to ignore the EIO,
1208 permanently leak the space from indirect blocks that can not be read,
1209 and continue to free everything else that it can.
1211 The default, "stalling" behavior is useful if the storage partially
1212 fails (i.e. some but not all i/os fail), and then later recovers. In
1213 this case, we will be able to continue pool operations while it is
1214 partially failed, and when it recovers, we can continue to free the
1215 space, with no leaks. However, note that this case is actually
1218 Typically pools either (a) fail completely (but perhaps temporarily,
1219 e.g. a top-level vdev going offline), or (b) have localized,
1220 permanent errors (e.g. disk returns the wrong data due to bit flip or
1221 firmware bug). In case (a), this setting does not matter because the
1222 pool will be suspended and the sync thread will not be able to make
1223 forward progress regardless. In case (b), because the error is
1224 permanent, the best we can do is leak the minimum amount of space,
1225 which is what setting this flag will do. Therefore, it is reasonable
1226 for this flag to normally be set, but we chose the more conservative
1227 approach of not setting it, so that there is no possibility of
1228 leaking space in the "partial temporary" failure case.
1230 Default value: \fB0\fR.
1236 \fBzfs_free_min_time_ms\fR (int)
1239 During a \fBzfs destroy\fR operation using \fBfeature@async_destroy\fR a minimum
1240 of this much time will be spent working on freeing blocks per txg.
1242 Default value: \fB1,000\fR.
1248 \fBzfs_immediate_write_sz\fR (long)
1251 Largest data block to write to zil. Larger blocks will be treated as if the
1252 dataset being written to had the property setting \fBlogbias=throughput\fR.
1254 Default value: \fB32,768\fR.
1260 \fBzfs_max_recordsize\fR (int)
1263 We currently support block sizes from 512 bytes to 16MB. The benefits of
1264 larger blocks, and thus larger IO, need to be weighed against the cost of
1265 COWing a giant block to modify one byte. Additionally, very large blocks
1266 can have an impact on i/o latency, and also potentially on the memory
1267 allocator. Therefore, we do not allow the recordsize to be set larger than
1268 zfs_max_recordsize (default 1MB). Larger blocks can be created by changing
1269 this tunable, and pools with larger blocks can always be imported and used,
1270 regardless of this setting.
1272 Default value: \fB1,048,576\fR.
1278 \fBzfs_mdcomp_disable\fR (int)
1281 Disable meta data compression
1283 Use \fB1\fR for yes and \fB0\fR for no (default).
1289 \fBzfs_metaslab_fragmentation_threshold\fR (int)
1292 Allow metaslabs to keep their active state as long as their fragmentation
1293 percentage is less than or equal to this value. An active metaslab that
1294 exceeds this threshold will no longer keep its active status allowing
1295 better metaslabs to be selected.
1297 Default value: \fB70\fR.
1303 \fBzfs_mg_fragmentation_threshold\fR (int)
1306 Metaslab groups are considered eligible for allocations if their
1307 fragmentation metric (measured as a percentage) is less than or equal to
1308 this value. If a metaslab group exceeds this threshold then it will be
1309 skipped unless all metaslab groups within the metaslab class have also
1310 crossed this threshold.
1312 Default value: \fB85\fR.
1318 \fBzfs_mg_noalloc_threshold\fR (int)
1321 Defines a threshold at which metaslab groups should be eligible for
1322 allocations. The value is expressed as a percentage of free space
1323 beyond which a metaslab group is always eligible for allocations.
1324 If a metaslab group's free space is less than or equal to the
1325 threshold, the allocator will avoid allocating to that group
1326 unless all groups in the pool have reached the threshold. Once all
1327 groups have reached the threshold, all groups are allowed to accept
1328 allocations. The default value of 0 disables the feature and causes
1329 all metaslab groups to be eligible for allocations.
1331 This parameter allows to deal with pools having heavily imbalanced
1332 vdevs such as would be the case when a new vdev has been added.
1333 Setting the threshold to a non-zero percentage will stop allocations
1334 from being made to vdevs that aren't filled to the specified percentage
1335 and allow lesser filled vdevs to acquire more allocations than they
1336 otherwise would under the old \fBzfs_mg_alloc_failures\fR facility.
1338 Default value: \fB0\fR.
1344 \fBzfs_no_scrub_io\fR (int)
1347 Set for no scrub I/O. This results in scrubs not actually scrubbing data and
1348 simply doing a metadata crawl of the pool instead.
1350 Use \fB1\fR for yes and \fB0\fR for no (default).
1356 \fBzfs_no_scrub_prefetch\fR (int)
1359 Set to disable block prefetching for scrubs.
1361 Use \fB1\fR for yes and \fB0\fR for no (default).
1367 \fBzfs_nocacheflush\fR (int)
1370 Disable cache flush operations on disks when writing. Beware, this may cause
1371 corruption if disks re-order writes.
1373 Use \fB1\fR for yes and \fB0\fR for no (default).
1379 \fBzfs_nopwrite_enabled\fR (int)
1384 Use \fB1\fR for yes (default) and \fB0\fR to disable.
1390 \fBzfs_pd_bytes_max\fR (int)
1393 The number of bytes which should be prefetched during a pool traversal
1394 (eg: \fBzfs send\fR or other data crawling operations)
1396 Default value: \fB52,428,800\fR.
1402 \fBzfs_prefetch_disable\fR (int)
1405 This tunable disables predictive prefetch. Note that it leaves "prescient"
1406 prefetch (e.g. prefetch for zfs send) intact. Unlike predictive prefetch,
1407 prescient prefetch never issues i/os that end up not being needed, so it
1408 can't hurt performance.
1410 Use \fB1\fR for yes and \fB0\fR for no (default).
1416 \fBzfs_read_chunk_size\fR (long)
1419 Bytes to read per chunk
1421 Default value: \fB1,048,576\fR.
1427 \fBzfs_read_history\fR (int)
1430 Historic statistics for the last N reads will be available in
1431 \fR/proc/spl/kstat/zfs/POOLNAME/reads\fB
1433 Default value: \fB0\fR (no data is kept).
1439 \fBzfs_read_history_hits\fR (int)
1442 Include cache hits in read history
1444 Use \fB1\fR for yes and \fB0\fR for no (default).
1450 \fBzfs_recover\fR (int)
1453 Set to attempt to recover from fatal errors. This should only be used as a
1454 last resort, as it typically results in leaked space, or worse.
1456 Use \fB1\fR for yes and \fB0\fR for no (default).
1462 \fBzfs_resilver_delay\fR (int)
1465 Number of ticks to delay prior to issuing a resilver I/O operation when
1466 a non-resilver or non-scrub I/O operation has occurred within the past
1467 \fBzfs_scan_idle\fR ticks.
1469 Default value: \fB2\fR.
1475 \fBzfs_resilver_min_time_ms\fR (int)
1478 Resilvers are processed by the sync thread. While resilvering it will spend
1479 at least this much time working on a resilver between txg flushes.
1481 Default value: \fB3,000\fR.
1487 \fBzfs_scan_idle\fR (int)
1490 Idle window in clock ticks. During a scrub or a resilver, if
1491 a non-scrub or non-resilver I/O operation has occurred during this
1492 window, the next scrub or resilver operation is delayed by, respectively
1493 \fBzfs_scrub_delay\fR or \fBzfs_resilver_delay\fR ticks.
1495 Default value: \fB50\fR.
1501 \fBzfs_scan_min_time_ms\fR (int)
1504 Scrubs are processed by the sync thread. While scrubbing it will spend
1505 at least this much time working on a scrub between txg flushes.
1507 Default value: \fB1,000\fR.
1513 \fBzfs_scrub_delay\fR (int)
1516 Number of ticks to delay prior to issuing a scrub I/O operation when
1517 a non-scrub or non-resilver I/O operation has occurred within the past
1518 \fBzfs_scan_idle\fR ticks.
1520 Default value: \fB4\fR.
1526 \fBzfs_send_corrupt_data\fR (int)
1529 Allow sending of corrupt data (ignore read/checksum errors when sending data)
1531 Use \fB1\fR for yes and \fB0\fR for no (default).
1537 \fBzfs_sync_pass_deferred_free\fR (int)
1540 Flushing of data to disk is done in passes. Defer frees starting in this pass
1542 Default value: \fB2\fR.
1548 \fBzfs_sync_pass_dont_compress\fR (int)
1551 Don't compress starting in this pass
1553 Default value: \fB5\fR.
1559 \fBzfs_sync_pass_rewrite\fR (int)
1562 Rewrite new block pointers starting in this pass
1564 Default value: \fB2\fR.
1570 \fBzfs_top_maxinflight\fR (int)
1573 Max concurrent I/Os per top-level vdev (mirrors or raidz arrays) allowed during
1574 scrub or resilver operations.
1576 Default value: \fB32\fR.
1582 \fBzfs_txg_history\fR (int)
1585 Historic statistics for the last N txgs will be available in
1586 \fR/proc/spl/kstat/zfs/POOLNAME/txgs\fB
1588 Default value: \fB0\fR.
1594 \fBzfs_txg_timeout\fR (int)
1597 Flush dirty data to disk at least every N seconds (maximum txg duration)
1599 Default value: \fB5\fR.
1605 \fBzfs_vdev_aggregation_limit\fR (int)
1608 Max vdev I/O aggregation size
1610 Default value: \fB131,072\fR.
1616 \fBzfs_vdev_cache_bshift\fR (int)
1619 Shift size to inflate reads too
1621 Default value: \fB16\fR (effectively 65536).
1627 \fBzfs_vdev_cache_max\fR (int)
1630 Inflate reads small than this value to meet the \fBzfs_vdev_cache_bshift\fR
1633 Default value: \fB16384\fR.
1639 \fBzfs_vdev_cache_size\fR (int)
1642 Total size of the per-disk cache in bytes.
1644 Currently this feature is disabled as it has been found to not be helpful
1645 for performance and in some cases harmful.
1647 Default value: \fB0\fR.
1653 \fBzfs_vdev_mirror_rotating_inc\fR (int)
1656 A number by which the balancing algorithm increments the load calculation for
1657 the purpose of selecting the least busy mirror member when an I/O immediately
1658 follows its predecessor on rotational vdevs for the purpose of making decisions
1661 Default value: \fB0\fR.
1667 \fBzfs_vdev_mirror_rotating_seek_inc\fR (int)
1670 A number by which the balancing algorithm increments the load calculation for
1671 the purpose of selecting the least busy mirror member when an I/O lacks
1672 locality as defined by the zfs_vdev_mirror_rotating_seek_offset. I/Os within
1673 this that are not immediately following the previous I/O are incremented by
1676 Default value: \fB5\fR.
1682 \fBzfs_vdev_mirror_rotating_seek_offset\fR (int)
1685 The maximum distance for the last queued I/O in which the balancing algorithm
1686 considers an I/O to have locality.
1687 See the section "ZFS I/O SCHEDULER".
1689 Default value: \fB1048576\fR.
1695 \fBzfs_vdev_mirror_non_rotating_inc\fR (int)
1698 A number by which the balancing algorithm increments the load calculation for
1699 the purpose of selecting the least busy mirror member on non-rotational vdevs
1700 when I/Os do not immediately follow one another.
1702 Default value: \fB0\fR.
1708 \fBzfs_vdev_mirror_non_rotating_seek_inc\fR (int)
1711 A number by which the balancing algorithm increments the load calculation for
1712 the purpose of selecting the least busy mirror member when an I/O lacks
1713 locality as defined by the zfs_vdev_mirror_rotating_seek_offset. I/Os within
1714 this that are not immediately following the previous I/O are incremented by
1717 Default value: \fB1\fR.
1723 \fBzfs_vdev_read_gap_limit\fR (int)
1726 Aggregate read I/O operations if the gap on-disk between them is within this
1729 Default value: \fB32,768\fR.
1735 \fBzfs_vdev_scheduler\fR (charp)
1738 Set the Linux I/O scheduler on whole disk vdevs to this scheduler
1740 Default value: \fBnoop\fR.
1746 \fBzfs_vdev_write_gap_limit\fR (int)
1749 Aggregate write I/O over gap
1751 Default value: \fB4,096\fR.
1757 \fBzfs_vdev_raidz_impl\fR (string)
1760 Parameter for selecting raidz parity implementation to use.
1762 Options marked (always) below may be selected on module load as they are
1763 supported on all systems.
1764 The remaining options may only be set after the module is loaded, as they
1765 are available only if the implementations are compiled in and supported
1766 on the running system.
1768 Once the module is loaded, the content of
1769 /sys/module/zfs/parameters/zfs_vdev_raidz_impl will show available options
1770 with the currently selected one enclosed in [].
1771 Possible options are:
1772 fastest - (always) implementation selected using built-in benchmark
1773 original - (always) original raidz implementation
1774 scalar - (always) scalar raidz implementation
1775 sse2 - implementation using SSE2 instruction set (64bit x86 only)
1776 ssse3 - implementation using SSSE3 instruction set (64bit x86 only)
1777 avx2 - implementation using AVX2 instruction set (64bit x86 only)
1778 avx512f - implementation using AVX512F instruction set (64bit x86 only)
1779 avx512bw - implementation using AVX512F & AVX512BW instruction sets (64bit x86 only)
1780 aarch64_neon - implementation using NEON (Aarch64/64 bit ARMv8 only)
1781 aarch64_neonx2 - implementation using NEON with more unrolling (Aarch64/64 bit ARMv8 only)
1783 Default value: \fBfastest\fR.
1789 \fBzfs_zevent_cols\fR (int)
1792 When zevents are logged to the console use this as the word wrap width.
1794 Default value: \fB80\fR.
1800 \fBzfs_zevent_console\fR (int)
1803 Log events to the console
1805 Use \fB1\fR for yes and \fB0\fR for no (default).
1811 \fBzfs_zevent_len_max\fR (int)
1814 Max event queue length. A value of 0 will result in a calculated value which
1815 increases with the number of CPUs in the system (minimum 64 events). Events
1816 in the queue can be viewed with the \fBzpool events\fR command.
1818 Default value: \fB0\fR.
1824 \fBzil_replay_disable\fR (int)
1827 Disable intent logging replay. Can be disabled for recovery from corrupted
1830 Use \fB1\fR for yes and \fB0\fR for no (default).
1836 \fBzil_slog_limit\fR (ulong)
1839 Max commit bytes to separate log device
1841 Default value: \fB1,048,576\fR.
1847 \fBzio_delay_max\fR (int)
1850 A zevent will be logged if a ZIO operation takes more than N milliseconds to
1851 complete. Note that this is only a logging facility, not a timeout on
1854 Default value: \fB30,000\fR.
1860 \fBzio_dva_throttle_enabled\fR (int)
1863 Throttle block allocations in the ZIO pipeline. This allows for
1864 dynamic allocation distribution when devices are imbalanced.
1866 Default value: \fB0\fR.
1872 \fBzio_requeue_io_start_cut_in_line\fR (int)
1875 Prioritize requeued I/O
1877 Default value: \fB0\fR.
1883 \fBzio_taskq_batch_pct\fR (uint)
1886 Percentage of online CPUs (or CPU cores, etc) which will run a worker thread
1887 for IO. These workers are responsible for IO work such as compression and
1888 checksum calculations. Fractional number of CPUs will be rounded down.
1890 The default value of 75 was chosen to avoid using all CPUs which can result in
1891 latency issues and inconsistent application performance, especially when high
1892 compression is enabled.
1894 Default value: \fB75\fR.
1900 \fBzvol_inhibit_dev\fR (uint)
1903 Do not create zvol device nodes. This may slightly improve startup time on
1904 systems with a very large number of zvols.
1906 Use \fB1\fR for yes and \fB0\fR for no (default).
1912 \fBzvol_major\fR (uint)
1915 Major number for zvol block devices
1917 Default value: \fB230\fR.
1923 \fBzvol_max_discard_blocks\fR (ulong)
1926 Discard (aka TRIM) operations done on zvols will be done in batches of this
1927 many blocks, where block size is determined by the \fBvolblocksize\fR property
1930 Default value: \fB16,384\fR.
1936 \fBzvol_prefetch_bytes\fR (uint)
1939 When adding a zvol to the system prefetch \fBzvol_prefetch_bytes\fR
1940 from the start and end of the volume. Prefetching these regions
1941 of the volume is desirable because they are likely to be accessed
1942 immediately by \fBblkid(8)\fR or by the kernel scanning for a partition
1945 Default value: \fB131,072\fR.
1948 .SH ZFS I/O SCHEDULER
1949 ZFS issues I/O operations to leaf vdevs to satisfy and complete I/Os.
1950 The I/O scheduler determines when and in what order those operations are
1951 issued. The I/O scheduler divides operations into five I/O classes
1952 prioritized in the following order: sync read, sync write, async read,
1953 async write, and scrub/resilver. Each queue defines the minimum and
1954 maximum number of concurrent operations that may be issued to the
1955 device. In addition, the device has an aggregate maximum,
1956 \fBzfs_vdev_max_active\fR. Note that the sum of the per-queue minimums
1957 must not exceed the aggregate maximum. If the sum of the per-queue
1958 maximums exceeds the aggregate maximum, then the number of active I/Os
1959 may reach \fBzfs_vdev_max_active\fR, in which case no further I/Os will
1960 be issued regardless of whether all per-queue minimums have been met.
1962 For many physical devices, throughput increases with the number of
1963 concurrent operations, but latency typically suffers. Further, physical
1964 devices typically have a limit at which more concurrent operations have no
1965 effect on throughput or can actually cause it to decrease.
1967 The scheduler selects the next operation to issue by first looking for an
1968 I/O class whose minimum has not been satisfied. Once all are satisfied and
1969 the aggregate maximum has not been hit, the scheduler looks for classes
1970 whose maximum has not been satisfied. Iteration through the I/O classes is
1971 done in the order specified above. No further operations are issued if the
1972 aggregate maximum number of concurrent operations has been hit or if there
1973 are no operations queued for an I/O class that has not hit its maximum.
1974 Every time an I/O is queued or an operation completes, the I/O scheduler
1975 looks for new operations to issue.
1977 In general, smaller max_active's will lead to lower latency of synchronous
1978 operations. Larger max_active's may lead to higher overall throughput,
1979 depending on underlying storage.
1981 The ratio of the queues' max_actives determines the balance of performance
1982 between reads, writes, and scrubs. E.g., increasing
1983 \fBzfs_vdev_scrub_max_active\fR will cause the scrub or resilver to complete
1984 more quickly, but reads and writes to have higher latency and lower throughput.
1986 All I/O classes have a fixed maximum number of outstanding operations
1987 except for the async write class. Asynchronous writes represent the data
1988 that is committed to stable storage during the syncing stage for
1989 transaction groups. Transaction groups enter the syncing state
1990 periodically so the number of queued async writes will quickly burst up
1991 and then bleed down to zero. Rather than servicing them as quickly as
1992 possible, the I/O scheduler changes the maximum number of active async
1993 write I/Os according to the amount of dirty data in the pool. Since
1994 both throughput and latency typically increase with the number of
1995 concurrent operations issued to physical devices, reducing the
1996 burstiness in the number of concurrent operations also stabilizes the
1997 response time of operations from other -- and in particular synchronous
1998 -- queues. In broad strokes, the I/O scheduler will issue more
1999 concurrent operations from the async write queue as there's more dirty
2004 The number of concurrent operations issued for the async write I/O class
2005 follows a piece-wise linear function defined by a few adjustable points.
2008 | o---------| <-- zfs_vdev_async_write_max_active
2015 |-------o | | <-- zfs_vdev_async_write_min_active
2016 0|_______^______|_________|
2017 0% | | 100% of zfs_dirty_data_max
2019 | `-- zfs_vdev_async_write_active_max_dirty_percent
2020 `--------- zfs_vdev_async_write_active_min_dirty_percent
2023 Until the amount of dirty data exceeds a minimum percentage of the dirty
2024 data allowed in the pool, the I/O scheduler will limit the number of
2025 concurrent operations to the minimum. As that threshold is crossed, the
2026 number of concurrent operations issued increases linearly to the maximum at
2027 the specified maximum percentage of the dirty data allowed in the pool.
2029 Ideally, the amount of dirty data on a busy pool will stay in the sloped
2030 part of the function between \fBzfs_vdev_async_write_active_min_dirty_percent\fR
2031 and \fBzfs_vdev_async_write_active_max_dirty_percent\fR. If it exceeds the
2032 maximum percentage, this indicates that the rate of incoming data is
2033 greater than the rate that the backend storage can handle. In this case, we
2034 must further throttle incoming writes, as described in the next section.
2036 .SH ZFS TRANSACTION DELAY
2037 We delay transactions when we've determined that the backend storage
2038 isn't able to accommodate the rate of incoming writes.
2040 If there is already a transaction waiting, we delay relative to when
2041 that transaction will finish waiting. This way the calculated delay time
2042 is independent of the number of threads concurrently executing
2045 If we are the only waiter, wait relative to when the transaction
2046 started, rather than the current time. This credits the transaction for
2047 "time already served", e.g. reading indirect blocks.
2049 The minimum time for a transaction to take is calculated as:
2051 min_time = zfs_delay_scale * (dirty - min) / (max - dirty)
2052 min_time is then capped at 100 milliseconds.
2055 The delay has two degrees of freedom that can be adjusted via tunables. The
2056 percentage of dirty data at which we start to delay is defined by
2057 \fBzfs_delay_min_dirty_percent\fR. This should typically be at or above
2058 \fBzfs_vdev_async_write_active_max_dirty_percent\fR so that we only start to
2059 delay after writing at full speed has failed to keep up with the incoming write
2060 rate. The scale of the curve is defined by \fBzfs_delay_scale\fR. Roughly speaking,
2061 this variable determines the amount of delay at the midpoint of the curve.
2065 10ms +-------------------------------------------------------------*+
2081 2ms + (midpoint) * +
2084 | zfs_delay_scale ----------> ******** |
2085 0 +-------------------------------------*********----------------+
2086 0% <- zfs_dirty_data_max -> 100%
2089 Note that since the delay is added to the outstanding time remaining on the
2090 most recent transaction, the delay is effectively the inverse of IOPS.
2091 Here the midpoint of 500us translates to 2000 IOPS. The shape of the curve
2092 was chosen such that small changes in the amount of accumulated dirty data
2093 in the first 3/4 of the curve yield relatively small differences in the
2096 The effects can be easier to understand when the amount of delay is
2097 represented on a log scale:
2101 100ms +-------------------------------------------------------------++
2110 + zfs_delay_scale ----------> ***** +
2121 +--------------------------------------------------------------+
2122 0% <- zfs_dirty_data_max -> 100%
2125 Note here that only as the amount of dirty data approaches its limit does
2126 the delay start to increase rapidly. The goal of a properly tuned system
2127 should be to keep the amount of dirty data out of that range by first
2128 ensuring that the appropriate limits are set for the I/O scheduler to reach
2129 optimal throughput on the backend storage, and then by changing the value
2130 of \fBzfs_delay_scale\fR to increase the steepness of the curve.
projects / mirror_zfs.git / blob