]> git.proxmox.com Git - mirror_zfs.git/blame - man/man5/zfs-module-parameters.5
Update CONTRIBUTING to point users to IRC as well as mailing list
[mirror_zfs.git] / man / man5 / zfs-module-parameters.5
CommitLineData
29714574
TF
1'\" te
2.\" Copyright (c) 2013 by Turbo Fredriksson <turbo@bayour.com>. All rights reserved.
87c25d56 3.\" Copyright (c) 2019 by Delphix. All rights reserved.
65282ee9 4.\" Copyright (c) 2019 Datto Inc.
29714574
TF
5.\" The contents of this file are subject to the terms of the Common Development
6.\" and Distribution License (the "License"). You may not use this file except
7.\" in compliance with the License. You can obtain a copy of the license at
8.\" usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
9.\"
10.\" See the License for the specific language governing permissions and
11.\" limitations under the License. When distributing Covered Code, include this
12.\" CDDL HEADER in each file and include the License file at
13.\" usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this
14.\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your
15.\" own identifying information:
16.\" Portions Copyright [yyyy] [name of copyright owner]
65282ee9 17.TH ZFS-MODULE-PARAMETERS 5 "Feb 8, 2019"
29714574
TF
18.SH NAME
19zfs\-module\-parameters \- ZFS module parameters
20.SH DESCRIPTION
21.sp
22.LP
23Description of the different parameters to the ZFS module.
24
25.SS "Module parameters"
26.sp
27.LP
28
de4f8d5d
BB
29.sp
30.ne 2
31.na
32\fBdbuf_cache_max_bytes\fR (ulong)
33.ad
34.RS 12n
35Maximum size in bytes of the dbuf cache. When \fB0\fR this value will default
36to \fB1/2^dbuf_cache_shift\fR (1/32) of the target ARC size, otherwise the
37provided value in bytes will be used. The behavior of the dbuf cache and its
38associated settings can be observed via the \fB/proc/spl/kstat/zfs/dbufstats\fR
39kstat.
40.sp
41Default value: \fB0\fR.
42.RE
43
2e5dc449
MA
44.sp
45.ne 2
46.na
47\fBdbuf_metadata_cache_max_bytes\fR (ulong)
48.ad
49.RS 12n
50Maximum size in bytes of the metadata dbuf cache. When \fB0\fR this value will
51default to \fB1/2^dbuf_cache_shift\fR (1/16) of the target ARC size, otherwise
52the provided value in bytes will be used. The behavior of the metadata dbuf
53cache and its associated settings can be observed via the
54\fB/proc/spl/kstat/zfs/dbufstats\fR kstat.
55.sp
56Default value: \fB0\fR.
57.RE
58
de4f8d5d
BB
59.sp
60.ne 2
61.na
62\fBdbuf_cache_hiwater_pct\fR (uint)
63.ad
64.RS 12n
65The percentage over \fBdbuf_cache_max_bytes\fR when dbufs must be evicted
66directly.
67.sp
68Default value: \fB10\fR%.
69.RE
70
71.sp
72.ne 2
73.na
74\fBdbuf_cache_lowater_pct\fR (uint)
75.ad
76.RS 12n
77The percentage below \fBdbuf_cache_max_bytes\fR when the evict thread stops
78evicting dbufs.
79.sp
80Default value: \fB10\fR%.
81.RE
82
83.sp
84.ne 2
85.na
86\fBdbuf_cache_shift\fR (int)
87.ad
88.RS 12n
89Set the size of the dbuf cache, \fBdbuf_cache_max_bytes\fR, to a log2 fraction
90of the target arc size.
91.sp
92Default value: \fB5\fR.
93.RE
94
2e5dc449
MA
95.sp
96.ne 2
97.na
98\fBdbuf_metadata_cache_shift\fR (int)
99.ad
100.RS 12n
101Set the size of the dbuf metadata cache, \fBdbuf_metadata_cache_max_bytes\fR,
102to a log2 fraction of the target arc size.
103.sp
104Default value: \fB6\fR.
105.RE
106
6d836e6f
RE
107.sp
108.ne 2
109.na
110\fBignore_hole_birth\fR (int)
111.ad
112.RS 12n
113When set, the hole_birth optimization will not be used, and all holes will
114always be sent on zfs send. Useful if you suspect your datasets are affected
115by a bug in hole_birth.
116.sp
9ea9e0b9 117Use \fB1\fR for on (default) and \fB0\fR for off.
6d836e6f
RE
118.RE
119
29714574
TF
120.sp
121.ne 2
122.na
123\fBl2arc_feed_again\fR (int)
124.ad
125.RS 12n
83426735
D
126Turbo L2ARC warm-up. When the L2ARC is cold the fill interval will be set as
127fast as possible.
29714574
TF
128.sp
129Use \fB1\fR for yes (default) and \fB0\fR to disable.
130.RE
131
132.sp
133.ne 2
134.na
135\fBl2arc_feed_min_ms\fR (ulong)
136.ad
137.RS 12n
83426735
D
138Min feed interval in milliseconds. Requires \fBl2arc_feed_again=1\fR and only
139applicable in related situations.
29714574
TF
140.sp
141Default value: \fB200\fR.
142.RE
143
144.sp
145.ne 2
146.na
147\fBl2arc_feed_secs\fR (ulong)
148.ad
149.RS 12n
150Seconds between L2ARC writing
151.sp
152Default value: \fB1\fR.
153.RE
154
155.sp
156.ne 2
157.na
158\fBl2arc_headroom\fR (ulong)
159.ad
160.RS 12n
83426735
D
161How far through the ARC lists to search for L2ARC cacheable content, expressed
162as a multiplier of \fBl2arc_write_max\fR
29714574
TF
163.sp
164Default value: \fB2\fR.
165.RE
166
167.sp
168.ne 2
169.na
170\fBl2arc_headroom_boost\fR (ulong)
171.ad
172.RS 12n
83426735
D
173Scales \fBl2arc_headroom\fR by this percentage when L2ARC contents are being
174successfully compressed before writing. A value of 100 disables this feature.
29714574 175.sp
be54a13c 176Default value: \fB200\fR%.
29714574
TF
177.RE
178
29714574
TF
179.sp
180.ne 2
181.na
182\fBl2arc_noprefetch\fR (int)
183.ad
184.RS 12n
83426735
D
185Do not write buffers to L2ARC if they were prefetched but not used by
186applications
29714574
TF
187.sp
188Use \fB1\fR for yes (default) and \fB0\fR to disable.
189.RE
190
191.sp
192.ne 2
193.na
194\fBl2arc_norw\fR (int)
195.ad
196.RS 12n
197No reads during writes
198.sp
199Use \fB1\fR for yes and \fB0\fR for no (default).
200.RE
201
202.sp
203.ne 2
204.na
205\fBl2arc_write_boost\fR (ulong)
206.ad
207.RS 12n
603a1784 208Cold L2ARC devices will have \fBl2arc_write_max\fR increased by this amount
83426735 209while they remain cold.
29714574
TF
210.sp
211Default value: \fB8,388,608\fR.
212.RE
213
214.sp
215.ne 2
216.na
217\fBl2arc_write_max\fR (ulong)
218.ad
219.RS 12n
220Max write bytes per interval
221.sp
222Default value: \fB8,388,608\fR.
223.RE
224
99b14de4
ED
225.sp
226.ne 2
227.na
228\fBmetaslab_aliquot\fR (ulong)
229.ad
230.RS 12n
231Metaslab granularity, in bytes. This is roughly similar to what would be
232referred to as the "stripe size" in traditional RAID arrays. In normal
233operation, ZFS will try to write this amount of data to a top-level vdev
234before moving on to the next one.
235.sp
236Default value: \fB524,288\fR.
237.RE
238
f3a7f661
GW
239.sp
240.ne 2
241.na
242\fBmetaslab_bias_enabled\fR (int)
243.ad
244.RS 12n
245Enable metaslab group biasing based on its vdev's over- or under-utilization
246relative to the pool.
247.sp
248Use \fB1\fR for yes (default) and \fB0\fR for no.
249.RE
250
d830d479
MA
251.sp
252.ne 2
253.na
254\fBmetaslab_force_ganging\fR (ulong)
255.ad
256.RS 12n
257Make some blocks above a certain size be gang blocks. This option is used
258by the test suite to facilitate testing.
259.sp
260Default value: \fB16,777,217\fR.
261.RE
262
4e21fd06
DB
263.sp
264.ne 2
265.na
266\fBzfs_metaslab_segment_weight_enabled\fR (int)
267.ad
268.RS 12n
269Enable/disable segment-based metaslab selection.
270.sp
271Use \fB1\fR for yes (default) and \fB0\fR for no.
272.RE
273
274.sp
275.ne 2
276.na
277\fBzfs_metaslab_switch_threshold\fR (int)
278.ad
279.RS 12n
280When using segment-based metaslab selection, continue allocating
321204be 281from the active metaslab until \fBzfs_metaslab_switch_threshold\fR
4e21fd06
DB
282worth of buckets have been exhausted.
283.sp
284Default value: \fB2\fR.
285.RE
286
29714574
TF
287.sp
288.ne 2
289.na
aa7d06a9 290\fBmetaslab_debug_load\fR (int)
29714574
TF
291.ad
292.RS 12n
aa7d06a9
GW
293Load all metaslabs during pool import.
294.sp
295Use \fB1\fR for yes and \fB0\fR for no (default).
296.RE
297
298.sp
299.ne 2
300.na
301\fBmetaslab_debug_unload\fR (int)
302.ad
303.RS 12n
304Prevent metaslabs from being unloaded.
29714574
TF
305.sp
306Use \fB1\fR for yes and \fB0\fR for no (default).
307.RE
308
f3a7f661
GW
309.sp
310.ne 2
311.na
312\fBmetaslab_fragmentation_factor_enabled\fR (int)
313.ad
314.RS 12n
315Enable use of the fragmentation metric in computing metaslab weights.
316.sp
317Use \fB1\fR for yes (default) and \fB0\fR for no.
318.RE
319
b8bcca18
MA
320.sp
321.ne 2
322.na
c853f382 323\fBzfs_vdev_default_ms_count\fR (int)
b8bcca18
MA
324.ad
325.RS 12n
e4e94ca3 326When a vdev is added target this number of metaslabs per top-level vdev.
b8bcca18
MA
327.sp
328Default value: \fB200\fR.
329.RE
330
d2734cce
SD
331.sp
332.ne 2
333.na
c853f382 334\fBzfs_vdev_min_ms_count\fR (int)
d2734cce
SD
335.ad
336.RS 12n
337Minimum number of metaslabs to create in a top-level vdev.
338.sp
339Default value: \fB16\fR.
340.RE
341
e4e94ca3
DB
342.sp
343.ne 2
344.na
345\fBvdev_ms_count_limit\fR (int)
346.ad
347.RS 12n
348Practical upper limit of total metaslabs per top-level vdev.
349.sp
350Default value: \fB131,072\fR.
351.RE
352
f3a7f661
GW
353.sp
354.ne 2
355.na
356\fBmetaslab_preload_enabled\fR (int)
357.ad
358.RS 12n
359Enable metaslab group preloading.
360.sp
361Use \fB1\fR for yes (default) and \fB0\fR for no.
362.RE
363
364.sp
365.ne 2
366.na
367\fBmetaslab_lba_weighting_enabled\fR (int)
368.ad
369.RS 12n
370Give more weight to metaslabs with lower LBAs, assuming they have
371greater bandwidth as is typically the case on a modern constant
372angular velocity disk drive.
373.sp
374Use \fB1\fR for yes (default) and \fB0\fR for no.
375.RE
376
29714574
TF
377.sp
378.ne 2
379.na
380\fBspa_config_path\fR (charp)
381.ad
382.RS 12n
383SPA config file
384.sp
385Default value: \fB/etc/zfs/zpool.cache\fR.
386.RE
387
e8b96c60
MA
388.sp
389.ne 2
390.na
391\fBspa_asize_inflation\fR (int)
392.ad
393.RS 12n
394Multiplication factor used to estimate actual disk consumption from the
395size of data being written. The default value is a worst case estimate,
396but lower values may be valid for a given pool depending on its
397configuration. Pool administrators who understand the factors involved
398may wish to specify a more realistic inflation factor, particularly if
399they operate close to quota or capacity limits.
400.sp
83426735 401Default value: \fB24\fR.
e8b96c60
MA
402.RE
403
6cb8e530
PZ
404.sp
405.ne 2
406.na
407\fBspa_load_print_vdev_tree\fR (int)
408.ad
409.RS 12n
410Whether to print the vdev tree in the debugging message buffer during pool import.
411Use 0 to disable and 1 to enable.
412.sp
413Default value: \fB0\fR.
414.RE
415
dea377c0
MA
416.sp
417.ne 2
418.na
419\fBspa_load_verify_data\fR (int)
420.ad
421.RS 12n
422Whether to traverse data blocks during an "extreme rewind" (\fB-X\fR)
423import. Use 0 to disable and 1 to enable.
424
425An extreme rewind import normally performs a full traversal of all
426blocks in the pool for verification. If this parameter is set to 0,
427the traversal skips non-metadata blocks. It can be toggled once the
428import has started to stop or start the traversal of non-metadata blocks.
429.sp
83426735 430Default value: \fB1\fR.
dea377c0
MA
431.RE
432
433.sp
434.ne 2
435.na
436\fBspa_load_verify_metadata\fR (int)
437.ad
438.RS 12n
439Whether to traverse blocks during an "extreme rewind" (\fB-X\fR)
440pool import. Use 0 to disable and 1 to enable.
441
442An extreme rewind import normally performs a full traversal of all
1c012083 443blocks in the pool for verification. If this parameter is set to 0,
dea377c0
MA
444the traversal is not performed. It can be toggled once the import has
445started to stop or start the traversal.
446.sp
83426735 447Default value: \fB1\fR.
dea377c0
MA
448.RE
449
450.sp
451.ne 2
452.na
453\fBspa_load_verify_maxinflight\fR (int)
454.ad
455.RS 12n
456Maximum concurrent I/Os during the traversal performed during an "extreme
457rewind" (\fB-X\fR) pool import.
458.sp
83426735 459Default value: \fB10000\fR.
dea377c0
MA
460.RE
461
6cde6435
BB
462.sp
463.ne 2
464.na
465\fBspa_slop_shift\fR (int)
466.ad
467.RS 12n
468Normally, we don't allow the last 3.2% (1/(2^spa_slop_shift)) of space
469in the pool to be consumed. This ensures that we don't run the pool
470completely out of space, due to unaccounted changes (e.g. to the MOS).
471It also limits the worst-case time to allocate space. If we have
472less than this amount of free space, most ZPL operations (e.g. write,
473create) will return ENOSPC.
474.sp
83426735 475Default value: \fB5\fR.
6cde6435
BB
476.RE
477
0dc2f70c
MA
478.sp
479.ne 2
480.na
481\fBvdev_removal_max_span\fR (int)
482.ad
483.RS 12n
484During top-level vdev removal, chunks of data are copied from the vdev
485which may include free space in order to trade bandwidth for IOPS.
486This parameter determines the maximum span of free space (in bytes)
487which will be included as "unnecessary" data in a chunk of copied data.
488
489The default value here was chosen to align with
490\fBzfs_vdev_read_gap_limit\fR, which is a similar concept when doing
491regular reads (but there's no reason it has to be the same).
492.sp
493Default value: \fB32,768\fR.
494.RE
495
29714574
TF
496.sp
497.ne 2
498.na
499\fBzfetch_array_rd_sz\fR (ulong)
500.ad
501.RS 12n
27b293be 502If prefetching is enabled, disable prefetching for reads larger than this size.
29714574
TF
503.sp
504Default value: \fB1,048,576\fR.
505.RE
506
507.sp
508.ne 2
509.na
7f60329a 510\fBzfetch_max_distance\fR (uint)
29714574
TF
511.ad
512.RS 12n
7f60329a 513Max bytes to prefetch per stream (default 8MB).
29714574 514.sp
7f60329a 515Default value: \fB8,388,608\fR.
29714574
TF
516.RE
517
518.sp
519.ne 2
520.na
521\fBzfetch_max_streams\fR (uint)
522.ad
523.RS 12n
27b293be 524Max number of streams per zfetch (prefetch streams per file).
29714574
TF
525.sp
526Default value: \fB8\fR.
527.RE
528
529.sp
530.ne 2
531.na
532\fBzfetch_min_sec_reap\fR (uint)
533.ad
534.RS 12n
27b293be 535Min time before an active prefetch stream can be reclaimed
29714574
TF
536.sp
537Default value: \fB2\fR.
538.RE
539
87c25d56
MA
540.sp
541.ne 2
542.na
543\fBzfs_abd_scatter_min_size\fR (uint)
544.ad
545.RS 12n
546This is the minimum allocation size that will use scatter (page-based)
547ABD's. Smaller allocations will use linear ABD's.
548.sp
549Default value: \fB1536\fR (512B and 1KB allocations will be linear).
550.RE
551
25458cbe
TC
552.sp
553.ne 2
554.na
555\fBzfs_arc_dnode_limit\fR (ulong)
556.ad
557.RS 12n
558When the number of bytes consumed by dnodes in the ARC exceeds this number of
9907cc1c 559bytes, try to unpin some of it in response to demand for non-metadata. This
627791f3 560value acts as a ceiling to the amount of dnode metadata, and defaults to 0 which
9907cc1c
G
561indicates that a percent which is based on \fBzfs_arc_dnode_limit_percent\fR of
562the ARC meta buffers that may be used for dnodes.
25458cbe
TC
563
564See also \fBzfs_arc_meta_prune\fR which serves a similar purpose but is used
565when the amount of metadata in the ARC exceeds \fBzfs_arc_meta_limit\fR rather
566than in response to overall demand for non-metadata.
567
568.sp
9907cc1c
G
569Default value: \fB0\fR.
570.RE
571
572.sp
573.ne 2
574.na
575\fBzfs_arc_dnode_limit_percent\fR (ulong)
576.ad
577.RS 12n
578Percentage that can be consumed by dnodes of ARC meta buffers.
579.sp
580See also \fBzfs_arc_dnode_limit\fR which serves a similar purpose but has a
581higher priority if set to nonzero value.
582.sp
be54a13c 583Default value: \fB10\fR%.
25458cbe
TC
584.RE
585
586.sp
587.ne 2
588.na
589\fBzfs_arc_dnode_reduce_percent\fR (ulong)
590.ad
591.RS 12n
592Percentage of ARC dnodes to try to scan in response to demand for non-metadata
6146e17e 593when the number of bytes consumed by dnodes exceeds \fBzfs_arc_dnode_limit\fR.
25458cbe
TC
594
595.sp
be54a13c 596Default value: \fB10\fR% of the number of dnodes in the ARC.
25458cbe
TC
597.RE
598
49ddb315
MA
599.sp
600.ne 2
601.na
602\fBzfs_arc_average_blocksize\fR (int)
603.ad
604.RS 12n
605The ARC's buffer hash table is sized based on the assumption of an average
606block size of \fBzfs_arc_average_blocksize\fR (default 8K). This works out
607to roughly 1MB of hash table per 1GB of physical memory with 8-byte pointers.
608For configurations with a known larger average block size this value can be
609increased to reduce the memory footprint.
610
611.sp
612Default value: \fB8192\fR.
613.RE
614
ca0bf58d
PS
615.sp
616.ne 2
617.na
618\fBzfs_arc_evict_batch_limit\fR (int)
619.ad
620.RS 12n
8f343973 621Number ARC headers to evict per sub-list before proceeding to another sub-list.
ca0bf58d
PS
622This batch-style operation prevents entire sub-lists from being evicted at once
623but comes at a cost of additional unlocking and locking.
624.sp
625Default value: \fB10\fR.
626.RE
627
29714574
TF
628.sp
629.ne 2
630.na
631\fBzfs_arc_grow_retry\fR (int)
632.ad
633.RS 12n
ca85d690 634If set to a non zero value, it will replace the arc_grow_retry value with this value.
d4a72f23 635The arc_grow_retry value (default 5) is the number of seconds the ARC will wait before
ca85d690 636trying to resume growth after a memory pressure event.
29714574 637.sp
ca85d690 638Default value: \fB0\fR.
29714574
TF
639.RE
640
641.sp
642.ne 2
643.na
7e8bddd0 644\fBzfs_arc_lotsfree_percent\fR (int)
29714574
TF
645.ad
646.RS 12n
7e8bddd0
BB
647Throttle I/O when free system memory drops below this percentage of total
648system memory. Setting this value to 0 will disable the throttle.
29714574 649.sp
be54a13c 650Default value: \fB10\fR%.
29714574
TF
651.RE
652
653.sp
654.ne 2
655.na
7e8bddd0 656\fBzfs_arc_max\fR (ulong)
29714574
TF
657.ad
658.RS 12n
83426735
D
659Max arc size of ARC in bytes. If set to 0 then it will consume 1/2 of system
660RAM. This value must be at least 67108864 (64 megabytes).
661.sp
662This value can be changed dynamically with some caveats. It cannot be set back
663to 0 while running and reducing it below the current ARC size will not cause
664the ARC to shrink without memory pressure to induce shrinking.
29714574 665.sp
7e8bddd0 666Default value: \fB0\fR.
29714574
TF
667.RE
668
ca85d690 669.sp
670.ne 2
671.na
672\fBzfs_arc_meta_adjust_restarts\fR (ulong)
673.ad
674.RS 12n
675The number of restart passes to make while scanning the ARC attempting
676the free buffers in order to stay below the \fBzfs_arc_meta_limit\fR.
677This value should not need to be tuned but is available to facilitate
678performance analysis.
679.sp
680Default value: \fB4096\fR.
681.RE
682
29714574
TF
683.sp
684.ne 2
685.na
686\fBzfs_arc_meta_limit\fR (ulong)
687.ad
688.RS 12n
2cbb06b5
BB
689The maximum allowed size in bytes that meta data buffers are allowed to
690consume in the ARC. When this limit is reached meta data buffers will
691be reclaimed even if the overall arc_c_max has not been reached. This
9907cc1c
G
692value defaults to 0 which indicates that a percent which is based on
693\fBzfs_arc_meta_limit_percent\fR of the ARC may be used for meta data.
29714574 694.sp
83426735 695This value my be changed dynamically except that it cannot be set back to 0
9907cc1c 696for a specific percent of the ARC; it must be set to an explicit value.
83426735 697.sp
29714574
TF
698Default value: \fB0\fR.
699.RE
700
9907cc1c
G
701.sp
702.ne 2
703.na
704\fBzfs_arc_meta_limit_percent\fR (ulong)
705.ad
706.RS 12n
707Percentage of ARC buffers that can be used for meta data.
708
709See also \fBzfs_arc_meta_limit\fR which serves a similar purpose but has a
710higher priority if set to nonzero value.
711
712.sp
be54a13c 713Default value: \fB75\fR%.
9907cc1c
G
714.RE
715
ca0bf58d
PS
716.sp
717.ne 2
718.na
719\fBzfs_arc_meta_min\fR (ulong)
720.ad
721.RS 12n
722The minimum allowed size in bytes that meta data buffers may consume in
723the ARC. This value defaults to 0 which disables a floor on the amount
724of the ARC devoted meta data.
725.sp
726Default value: \fB0\fR.
727.RE
728
29714574
TF
729.sp
730.ne 2
731.na
732\fBzfs_arc_meta_prune\fR (int)
733.ad
734.RS 12n
2cbb06b5
BB
735The number of dentries and inodes to be scanned looking for entries
736which can be dropped. This may be required when the ARC reaches the
737\fBzfs_arc_meta_limit\fR because dentries and inodes can pin buffers
738in the ARC. Increasing this value will cause to dentry and inode caches
739to be pruned more aggressively. Setting this value to 0 will disable
740pruning the inode and dentry caches.
29714574 741.sp
2cbb06b5 742Default value: \fB10,000\fR.
29714574
TF
743.RE
744
bc888666
BB
745.sp
746.ne 2
747.na
ca85d690 748\fBzfs_arc_meta_strategy\fR (int)
bc888666
BB
749.ad
750.RS 12n
ca85d690 751Define the strategy for ARC meta data buffer eviction (meta reclaim strategy).
752A value of 0 (META_ONLY) will evict only the ARC meta data buffers.
d4a72f23 753A value of 1 (BALANCED) indicates that additional data buffers may be evicted if
ca85d690 754that is required to in order to evict the required number of meta data buffers.
bc888666 755.sp
ca85d690 756Default value: \fB1\fR.
bc888666
BB
757.RE
758
29714574
TF
759.sp
760.ne 2
761.na
762\fBzfs_arc_min\fR (ulong)
763.ad
764.RS 12n
ca85d690 765Min arc size of ARC in bytes. If set to 0 then arc_c_min will default to
766consuming the larger of 32M or 1/32 of total system memory.
29714574 767.sp
ca85d690 768Default value: \fB0\fR.
29714574
TF
769.RE
770
771.sp
772.ne 2
773.na
d4a72f23 774\fBzfs_arc_min_prefetch_ms\fR (int)
29714574
TF
775.ad
776.RS 12n
d4a72f23 777Minimum time prefetched blocks are locked in the ARC, specified in ms.
2b84817f 778A value of \fB0\fR will default to 1000 ms.
d4a72f23
TC
779.sp
780Default value: \fB0\fR.
781.RE
782
783.sp
784.ne 2
785.na
786\fBzfs_arc_min_prescient_prefetch_ms\fR (int)
787.ad
788.RS 12n
789Minimum time "prescient prefetched" blocks are locked in the ARC, specified
790in ms. These blocks are meant to be prefetched fairly aggresively ahead of
2b84817f 791the code that may use them. A value of \fB0\fR will default to 6000 ms.
29714574 792.sp
83426735 793Default value: \fB0\fR.
29714574
TF
794.RE
795
6cb8e530
PZ
796.sp
797.ne 2
798.na
799\fBzfs_max_missing_tvds\fR (int)
800.ad
801.RS 12n
802Number of missing top-level vdevs which will be allowed during
803pool import (only in read-only mode).
804.sp
805Default value: \fB0\fR
806.RE
807
ca0bf58d
PS
808.sp
809.ne 2
810.na
c30e58c4 811\fBzfs_multilist_num_sublists\fR (int)
ca0bf58d
PS
812.ad
813.RS 12n
814To allow more fine-grained locking, each ARC state contains a series
815of lists for both data and meta data objects. Locking is performed at
816the level of these "sub-lists". This parameters controls the number of
c30e58c4
MA
817sub-lists per ARC state, and also applies to other uses of the
818multilist data structure.
ca0bf58d 819.sp
c30e58c4 820Default value: \fB4\fR or the number of online CPUs, whichever is greater
ca0bf58d
PS
821.RE
822
823.sp
824.ne 2
825.na
826\fBzfs_arc_overflow_shift\fR (int)
827.ad
828.RS 12n
829The ARC size is considered to be overflowing if it exceeds the current
830ARC target size (arc_c) by a threshold determined by this parameter.
831The threshold is calculated as a fraction of arc_c using the formula
832"arc_c >> \fBzfs_arc_overflow_shift\fR".
833
834The default value of 8 causes the ARC to be considered to be overflowing
835if it exceeds the target size by 1/256th (0.3%) of the target size.
836
837When the ARC is overflowing, new buffer allocations are stalled until
838the reclaim thread catches up and the overflow condition no longer exists.
839.sp
840Default value: \fB8\fR.
841.RE
842
728d6ae9
BB
843.sp
844.ne 2
845.na
846
847\fBzfs_arc_p_min_shift\fR (int)
848.ad
849.RS 12n
ca85d690 850If set to a non zero value, this will update arc_p_min_shift (default 4)
851with the new value.
d4a72f23 852arc_p_min_shift is used to shift of arc_c for calculating both min and max
ca85d690 853max arc_p
728d6ae9 854.sp
ca85d690 855Default value: \fB0\fR.
728d6ae9
BB
856.RE
857
62422785
PS
858.sp
859.ne 2
860.na
861\fBzfs_arc_p_dampener_disable\fR (int)
862.ad
863.RS 12n
864Disable arc_p adapt dampener
865.sp
866Use \fB1\fR for yes (default) and \fB0\fR to disable.
867.RE
868
29714574
TF
869.sp
870.ne 2
871.na
872\fBzfs_arc_shrink_shift\fR (int)
873.ad
874.RS 12n
ca85d690 875If set to a non zero value, this will update arc_shrink_shift (default 7)
876with the new value.
29714574 877.sp
ca85d690 878Default value: \fB0\fR.
29714574
TF
879.RE
880
03b60eee
DB
881.sp
882.ne 2
883.na
884\fBzfs_arc_pc_percent\fR (uint)
885.ad
886.RS 12n
887Percent of pagecache to reclaim arc to
888
889This tunable allows ZFS arc to play more nicely with the kernel's LRU
890pagecache. It can guarantee that the arc size won't collapse under scanning
891pressure on the pagecache, yet still allows arc to be reclaimed down to
892zfs_arc_min if necessary. This value is specified as percent of pagecache
893size (as measured by NR_FILE_PAGES) where that percent may exceed 100. This
894only operates during memory pressure/reclaim.
895.sp
be54a13c 896Default value: \fB0\fR% (disabled).
03b60eee
DB
897.RE
898
11f552fa
BB
899.sp
900.ne 2
901.na
902\fBzfs_arc_sys_free\fR (ulong)
903.ad
904.RS 12n
905The target number of bytes the ARC should leave as free memory on the system.
906Defaults to the larger of 1/64 of physical memory or 512K. Setting this
907option to a non-zero value will override the default.
908.sp
909Default value: \fB0\fR.
910.RE
911
29714574
TF
912.sp
913.ne 2
914.na
915\fBzfs_autoimport_disable\fR (int)
916.ad
917.RS 12n
27b293be 918Disable pool import at module load by ignoring the cache file (typically \fB/etc/zfs/zpool.cache\fR).
29714574 919.sp
70081096 920Use \fB1\fR for yes (default) and \fB0\fR for no.
29714574
TF
921.RE
922
80d52c39
TH
923.sp
924.ne 2
925.na
926\fBzfs_checksums_per_second\fR (int)
927.ad
928.RS 12n
929Rate limit checksum events to this many per second. Note that this should
930not be set below the zed thresholds (currently 10 checksums over 10 sec)
931or else zed may not trigger any action.
932.sp
933Default value: 20
934.RE
935
2fe61a7e
PS
936.sp
937.ne 2
938.na
939\fBzfs_commit_timeout_pct\fR (int)
940.ad
941.RS 12n
942This controls the amount of time that a ZIL block (lwb) will remain "open"
943when it isn't "full", and it has a thread waiting for it to be committed to
944stable storage. The timeout is scaled based on a percentage of the last lwb
945latency to avoid significantly impacting the latency of each individual
946transaction record (itx).
947.sp
be54a13c 948Default value: \fB5\fR%.
2fe61a7e
PS
949.RE
950
0dc2f70c
MA
951.sp
952.ne 2
953.na
954\fBzfs_condense_indirect_vdevs_enable\fR (int)
955.ad
956.RS 12n
957Enable condensing indirect vdev mappings. When set to a non-zero value,
958attempt to condense indirect vdev mappings if the mapping uses more than
959\fBzfs_condense_min_mapping_bytes\fR bytes of memory and if the obsolete
960space map object uses more than \fBzfs_condense_max_obsolete_bytes\fR
961bytes on-disk. The condensing process is an attempt to save memory by
962removing obsolete mappings.
963.sp
964Default value: \fB1\fR.
965.RE
966
967.sp
968.ne 2
969.na
970\fBzfs_condense_max_obsolete_bytes\fR (ulong)
971.ad
972.RS 12n
973Only attempt to condense indirect vdev mappings if the on-disk size
974of the obsolete space map object is greater than this number of bytes
975(see \fBfBzfs_condense_indirect_vdevs_enable\fR).
976.sp
977Default value: \fB1,073,741,824\fR.
978.RE
979
980.sp
981.ne 2
982.na
983\fBzfs_condense_min_mapping_bytes\fR (ulong)
984.ad
985.RS 12n
986Minimum size vdev mapping to attempt to condense (see
987\fBzfs_condense_indirect_vdevs_enable\fR).
988.sp
989Default value: \fB131,072\fR.
990.RE
991
3b36f831
BB
992.sp
993.ne 2
994.na
995\fBzfs_dbgmsg_enable\fR (int)
996.ad
997.RS 12n
998Internally ZFS keeps a small log to facilitate debugging. By default the log
999is disabled, to enable it set this option to 1. The contents of the log can
1000be accessed by reading the /proc/spl/kstat/zfs/dbgmsg file. Writing 0 to
1001this proc file clears the log.
1002.sp
1003Default value: \fB0\fR.
1004.RE
1005
1006.sp
1007.ne 2
1008.na
1009\fBzfs_dbgmsg_maxsize\fR (int)
1010.ad
1011.RS 12n
1012The maximum size in bytes of the internal ZFS debug log.
1013.sp
1014Default value: \fB4M\fR.
1015.RE
1016
29714574
TF
1017.sp
1018.ne 2
1019.na
1020\fBzfs_dbuf_state_index\fR (int)
1021.ad
1022.RS 12n
83426735
D
1023This feature is currently unused. It is normally used for controlling what
1024reporting is available under /proc/spl/kstat/zfs.
29714574
TF
1025.sp
1026Default value: \fB0\fR.
1027.RE
1028
1029.sp
1030.ne 2
1031.na
1032\fBzfs_deadman_enabled\fR (int)
1033.ad
1034.RS 12n
b81a3ddc 1035When a pool sync operation takes longer than \fBzfs_deadman_synctime_ms\fR
8fb1ede1
BB
1036milliseconds, or when an individual I/O takes longer than
1037\fBzfs_deadman_ziotime_ms\fR milliseconds, then the operation is considered to
1038be "hung". If \fBzfs_deadman_enabled\fR is set then the deadman behavior is
1039invoked as described by the \fBzfs_deadman_failmode\fR module option.
1040By default the deadman is enabled and configured to \fBwait\fR which results
1041in "hung" I/Os only being logged. The deadman is automatically disabled
1042when a pool gets suspended.
29714574 1043.sp
8fb1ede1
BB
1044Default value: \fB1\fR.
1045.RE
1046
1047.sp
1048.ne 2
1049.na
1050\fBzfs_deadman_failmode\fR (charp)
1051.ad
1052.RS 12n
1053Controls the failure behavior when the deadman detects a "hung" I/O. Valid
1054values are \fBwait\fR, \fBcontinue\fR, and \fBpanic\fR.
1055.sp
1056\fBwait\fR - Wait for a "hung" I/O to complete. For each "hung" I/O a
1057"deadman" event will be posted describing that I/O.
1058.sp
1059\fBcontinue\fR - Attempt to recover from a "hung" I/O by re-dispatching it
1060to the I/O pipeline if possible.
1061.sp
1062\fBpanic\fR - Panic the system. This can be used to facilitate an automatic
1063fail-over to a properly configured fail-over partner.
1064.sp
1065Default value: \fBwait\fR.
b81a3ddc
TC
1066.RE
1067
1068.sp
1069.ne 2
1070.na
1071\fBzfs_deadman_checktime_ms\fR (int)
1072.ad
1073.RS 12n
8fb1ede1
BB
1074Check time in milliseconds. This defines the frequency at which we check
1075for hung I/O and potentially invoke the \fBzfs_deadman_failmode\fR behavior.
b81a3ddc 1076.sp
8fb1ede1 1077Default value: \fB60,000\fR.
29714574
TF
1078.RE
1079
1080.sp
1081.ne 2
1082.na
e8b96c60 1083\fBzfs_deadman_synctime_ms\fR (ulong)
29714574
TF
1084.ad
1085.RS 12n
b81a3ddc 1086Interval in milliseconds after which the deadman is triggered and also
8fb1ede1
BB
1087the interval after which a pool sync operation is considered to be "hung".
1088Once this limit is exceeded the deadman will be invoked every
1089\fBzfs_deadman_checktime_ms\fR milliseconds until the pool sync completes.
1090.sp
1091Default value: \fB600,000\fR.
1092.RE
b81a3ddc 1093
29714574 1094.sp
8fb1ede1
BB
1095.ne 2
1096.na
1097\fBzfs_deadman_ziotime_ms\fR (ulong)
1098.ad
1099.RS 12n
1100Interval in milliseconds after which the deadman is triggered and an
ad796b8a 1101individual I/O operation is considered to be "hung". As long as the I/O
8fb1ede1
BB
1102remains "hung" the deadman will be invoked every \fBzfs_deadman_checktime_ms\fR
1103milliseconds until the I/O completes.
1104.sp
1105Default value: \fB300,000\fR.
29714574
TF
1106.RE
1107
1108.sp
1109.ne 2
1110.na
1111\fBzfs_dedup_prefetch\fR (int)
1112.ad
1113.RS 12n
1114Enable prefetching dedup-ed blks
1115.sp
0dfc7324 1116Use \fB1\fR for yes and \fB0\fR to disable (default).
29714574
TF
1117.RE
1118
e8b96c60
MA
1119.sp
1120.ne 2
1121.na
1122\fBzfs_delay_min_dirty_percent\fR (int)
1123.ad
1124.RS 12n
1125Start to delay each transaction once there is this amount of dirty data,
1126expressed as a percentage of \fBzfs_dirty_data_max\fR.
1127This value should be >= zfs_vdev_async_write_active_max_dirty_percent.
1128See the section "ZFS TRANSACTION DELAY".
1129.sp
be54a13c 1130Default value: \fB60\fR%.
e8b96c60
MA
1131.RE
1132
1133.sp
1134.ne 2
1135.na
1136\fBzfs_delay_scale\fR (int)
1137.ad
1138.RS 12n
1139This controls how quickly the transaction delay approaches infinity.
1140Larger values cause longer delays for a given amount of dirty data.
1141.sp
1142For the smoothest delay, this value should be about 1 billion divided
1143by the maximum number of operations per second. This will smoothly
1144handle between 10x and 1/10th this number.
1145.sp
1146See the section "ZFS TRANSACTION DELAY".
1147.sp
1148Note: \fBzfs_delay_scale\fR * \fBzfs_dirty_data_max\fR must be < 2^64.
1149.sp
1150Default value: \fB500,000\fR.
1151.RE
1152
80d52c39
TH
1153.sp
1154.ne 2
1155.na
62ee31ad 1156\fBzfs_slow_io_events_per_second\fR (int)
80d52c39
TH
1157.ad
1158.RS 12n
ad796b8a 1159Rate limit delay zevents (which report slow I/Os) to this many per second.
80d52c39
TH
1160.sp
1161Default value: 20
1162.RE
1163
dcec0a12
AP
1164.sp
1165.ne 2
1166.na
1167\fBzfs_unlink_suspend_progress\fR (uint)
1168.ad
1169.RS 12n
1170When enabled, files will not be asynchronously removed from the list of pending
1171unlinks and the space they consume will be leaked. Once this option has been
1172disabled and the dataset is remounted, the pending unlinks will be processed
1173and the freed space returned to the pool.
1174This option is used by the test suite to facilitate testing.
1175.sp
1176Uses \fB0\fR (default) to allow progress and \fB1\fR to pause progress.
1177.RE
1178
a966c564
K
1179.sp
1180.ne 2
1181.na
1182\fBzfs_delete_blocks\fR (ulong)
1183.ad
1184.RS 12n
1185This is the used to define a large file for the purposes of delete. Files
1186containing more than \fBzfs_delete_blocks\fR will be deleted asynchronously
1187while smaller files are deleted synchronously. Decreasing this value will
1188reduce the time spent in an unlink(2) system call at the expense of a longer
1189delay before the freed space is available.
1190.sp
1191Default value: \fB20,480\fR.
1192.RE
1193
e8b96c60
MA
1194.sp
1195.ne 2
1196.na
1197\fBzfs_dirty_data_max\fR (int)
1198.ad
1199.RS 12n
1200Determines the dirty space limit in bytes. Once this limit is exceeded, new
1201writes are halted until space frees up. This parameter takes precedence
1202over \fBzfs_dirty_data_max_percent\fR.
1203See the section "ZFS TRANSACTION DELAY".
1204.sp
be54a13c 1205Default value: \fB10\fR% of physical RAM, capped at \fBzfs_dirty_data_max_max\fR.
e8b96c60
MA
1206.RE
1207
1208.sp
1209.ne 2
1210.na
1211\fBzfs_dirty_data_max_max\fR (int)
1212.ad
1213.RS 12n
1214Maximum allowable value of \fBzfs_dirty_data_max\fR, expressed in bytes.
1215This limit is only enforced at module load time, and will be ignored if
1216\fBzfs_dirty_data_max\fR is later changed. This parameter takes
1217precedence over \fBzfs_dirty_data_max_max_percent\fR. See the section
1218"ZFS TRANSACTION DELAY".
1219.sp
be54a13c 1220Default value: \fB25\fR% of physical RAM.
e8b96c60
MA
1221.RE
1222
1223.sp
1224.ne 2
1225.na
1226\fBzfs_dirty_data_max_max_percent\fR (int)
1227.ad
1228.RS 12n
1229Maximum allowable value of \fBzfs_dirty_data_max\fR, expressed as a
1230percentage of physical RAM. This limit is only enforced at module load
1231time, and will be ignored if \fBzfs_dirty_data_max\fR is later changed.
1232The parameter \fBzfs_dirty_data_max_max\fR takes precedence over this
1233one. See the section "ZFS TRANSACTION DELAY".
1234.sp
be54a13c 1235Default value: \fB25\fR%.
e8b96c60
MA
1236.RE
1237
1238.sp
1239.ne 2
1240.na
1241\fBzfs_dirty_data_max_percent\fR (int)
1242.ad
1243.RS 12n
1244Determines the dirty space limit, expressed as a percentage of all
1245memory. Once this limit is exceeded, new writes are halted until space frees
1246up. The parameter \fBzfs_dirty_data_max\fR takes precedence over this
1247one. See the section "ZFS TRANSACTION DELAY".
1248.sp
be54a13c 1249Default value: \fB10\fR%, subject to \fBzfs_dirty_data_max_max\fR.
e8b96c60
MA
1250.RE
1251
1252.sp
1253.ne 2
1254.na
dfbe2675 1255\fBzfs_dirty_data_sync_percent\fR (int)
e8b96c60
MA
1256.ad
1257.RS 12n
dfbe2675
MA
1258Start syncing out a transaction group if there's at least this much dirty data
1259as a percentage of \fBzfs_dirty_data_max\fR. This should be less than
1260\fBzfs_vdev_async_write_active_min_dirty_percent\fR.
e8b96c60 1261.sp
dfbe2675 1262Default value: \fB20\fR% of \fBzfs_dirty_data_max\fR.
e8b96c60
MA
1263.RE
1264
1eeb4562
JX
1265.sp
1266.ne 2
1267.na
1268\fBzfs_fletcher_4_impl\fR (string)
1269.ad
1270.RS 12n
1271Select a fletcher 4 implementation.
1272.sp
35a76a03 1273Supported selectors are: \fBfastest\fR, \fBscalar\fR, \fBsse2\fR, \fBssse3\fR,
24cdeaf1 1274\fBavx2\fR, \fBavx512f\fR, and \fBaarch64_neon\fR.
70b258fc
GN
1275All of the selectors except \fBfastest\fR and \fBscalar\fR require instruction
1276set extensions to be available and will only appear if ZFS detects that they are
1277present at runtime. If multiple implementations of fletcher 4 are available,
1278the \fBfastest\fR will be chosen using a micro benchmark. Selecting \fBscalar\fR
1279results in the original, CPU based calculation, being used. Selecting any option
1280other than \fBfastest\fR and \fBscalar\fR results in vector instructions from
1281the respective CPU instruction set being used.
1eeb4562
JX
1282.sp
1283Default value: \fBfastest\fR.
1284.RE
1285
ba5ad9a4
GW
1286.sp
1287.ne 2
1288.na
1289\fBzfs_free_bpobj_enabled\fR (int)
1290.ad
1291.RS 12n
1292Enable/disable the processing of the free_bpobj object.
1293.sp
1294Default value: \fB1\fR.
1295.RE
1296
36283ca2
MG
1297.sp
1298.ne 2
1299.na
a1d477c2 1300\fBzfs_async_block_max_blocks\fR (ulong)
36283ca2
MG
1301.ad
1302.RS 12n
1303Maximum number of blocks freed in a single txg.
1304.sp
1305Default value: \fB100,000\fR.
1306.RE
1307
ca0845d5
PD
1308.sp
1309.ne 2
1310.na
1311\fBzfs_override_estimate_recordsize\fR (ulong)
1312.ad
1313.RS 12n
1314Record size calculation override for zfs send estimates.
1315.sp
1316Default value: \fB0\fR.
1317.RE
1318
e8b96c60
MA
1319.sp
1320.ne 2
1321.na
1322\fBzfs_vdev_async_read_max_active\fR (int)
1323.ad
1324.RS 12n
83426735 1325Maximum asynchronous read I/Os active to each device.
e8b96c60
MA
1326See the section "ZFS I/O SCHEDULER".
1327.sp
1328Default value: \fB3\fR.
1329.RE
1330
1331.sp
1332.ne 2
1333.na
1334\fBzfs_vdev_async_read_min_active\fR (int)
1335.ad
1336.RS 12n
1337Minimum asynchronous read I/Os active to each device.
1338See the section "ZFS I/O SCHEDULER".
1339.sp
1340Default value: \fB1\fR.
1341.RE
1342
1343.sp
1344.ne 2
1345.na
1346\fBzfs_vdev_async_write_active_max_dirty_percent\fR (int)
1347.ad
1348.RS 12n
1349When the pool has more than
1350\fBzfs_vdev_async_write_active_max_dirty_percent\fR dirty data, use
1351\fBzfs_vdev_async_write_max_active\fR to limit active async writes. If
1352the dirty data is between min and max, the active I/O limit is linearly
1353interpolated. See the section "ZFS I/O SCHEDULER".
1354.sp
be54a13c 1355Default value: \fB60\fR%.
e8b96c60
MA
1356.RE
1357
1358.sp
1359.ne 2
1360.na
1361\fBzfs_vdev_async_write_active_min_dirty_percent\fR (int)
1362.ad
1363.RS 12n
1364When the pool has less than
1365\fBzfs_vdev_async_write_active_min_dirty_percent\fR dirty data, use
1366\fBzfs_vdev_async_write_min_active\fR to limit active async writes. If
1367the dirty data is between min and max, the active I/O limit is linearly
1368interpolated. See the section "ZFS I/O SCHEDULER".
1369.sp
be54a13c 1370Default value: \fB30\fR%.
e8b96c60
MA
1371.RE
1372
1373.sp
1374.ne 2
1375.na
1376\fBzfs_vdev_async_write_max_active\fR (int)
1377.ad
1378.RS 12n
83426735 1379Maximum asynchronous write I/Os active to each device.
e8b96c60
MA
1380See the section "ZFS I/O SCHEDULER".
1381.sp
1382Default value: \fB10\fR.
1383.RE
1384
1385.sp
1386.ne 2
1387.na
1388\fBzfs_vdev_async_write_min_active\fR (int)
1389.ad
1390.RS 12n
1391Minimum asynchronous write I/Os active to each device.
1392See the section "ZFS I/O SCHEDULER".
1393.sp
06226b59
D
1394Lower values are associated with better latency on rotational media but poorer
1395resilver performance. The default value of 2 was chosen as a compromise. A
1396value of 3 has been shown to improve resilver performance further at a cost of
1397further increasing latency.
1398.sp
1399Default value: \fB2\fR.
e8b96c60
MA
1400.RE
1401
619f0976
GW
1402.sp
1403.ne 2
1404.na
1405\fBzfs_vdev_initializing_max_active\fR (int)
1406.ad
1407.RS 12n
1408Maximum initializing I/Os active to each device.
1409See the section "ZFS I/O SCHEDULER".
1410.sp
1411Default value: \fB1\fR.
1412.RE
1413
1414.sp
1415.ne 2
1416.na
1417\fBzfs_vdev_initializing_min_active\fR (int)
1418.ad
1419.RS 12n
1420Minimum initializing I/Os active to each device.
1421See the section "ZFS I/O SCHEDULER".
1422.sp
1423Default value: \fB1\fR.
1424.RE
1425
e8b96c60
MA
1426.sp
1427.ne 2
1428.na
1429\fBzfs_vdev_max_active\fR (int)
1430.ad
1431.RS 12n
1432The maximum number of I/Os active to each device. Ideally, this will be >=
1433the sum of each queue's max_active. It must be at least the sum of each
1434queue's min_active. See the section "ZFS I/O SCHEDULER".
1435.sp
1436Default value: \fB1,000\fR.
1437.RE
1438
619f0976
GW
1439.sp
1440.ne 2
1441.na
1442\fBzfs_vdev_removal_max_active\fR (int)
1443.ad
1444.RS 12n
1445Maximum removal I/Os active to each device.
1446See the section "ZFS I/O SCHEDULER".
1447.sp
1448Default value: \fB2\fR.
1449.RE
1450
1451.sp
1452.ne 2
1453.na
1454\fBzfs_vdev_removal_min_active\fR (int)
1455.ad
1456.RS 12n
1457Minimum removal I/Os active to each device.
1458See the section "ZFS I/O SCHEDULER".
1459.sp
1460Default value: \fB1\fR.
1461.RE
1462
e8b96c60
MA
1463.sp
1464.ne 2
1465.na
1466\fBzfs_vdev_scrub_max_active\fR (int)
1467.ad
1468.RS 12n
83426735 1469Maximum scrub I/Os active to each device.
e8b96c60
MA
1470See the section "ZFS I/O SCHEDULER".
1471.sp
1472Default value: \fB2\fR.
1473.RE
1474
1475.sp
1476.ne 2
1477.na
1478\fBzfs_vdev_scrub_min_active\fR (int)
1479.ad
1480.RS 12n
1481Minimum scrub I/Os active to each device.
1482See the section "ZFS I/O SCHEDULER".
1483.sp
1484Default value: \fB1\fR.
1485.RE
1486
1487.sp
1488.ne 2
1489.na
1490\fBzfs_vdev_sync_read_max_active\fR (int)
1491.ad
1492.RS 12n
83426735 1493Maximum synchronous read I/Os active to each device.
e8b96c60
MA
1494See the section "ZFS I/O SCHEDULER".
1495.sp
1496Default value: \fB10\fR.
1497.RE
1498
1499.sp
1500.ne 2
1501.na
1502\fBzfs_vdev_sync_read_min_active\fR (int)
1503.ad
1504.RS 12n
1505Minimum synchronous read I/Os active to each device.
1506See the section "ZFS I/O SCHEDULER".
1507.sp
1508Default value: \fB10\fR.
1509.RE
1510
1511.sp
1512.ne 2
1513.na
1514\fBzfs_vdev_sync_write_max_active\fR (int)
1515.ad
1516.RS 12n
83426735 1517Maximum synchronous write I/Os active to each device.
e8b96c60
MA
1518See the section "ZFS I/O SCHEDULER".
1519.sp
1520Default value: \fB10\fR.
1521.RE
1522
1523.sp
1524.ne 2
1525.na
1526\fBzfs_vdev_sync_write_min_active\fR (int)
1527.ad
1528.RS 12n
1529Minimum synchronous write I/Os active to each device.
1530See the section "ZFS I/O SCHEDULER".
1531.sp
1532Default value: \fB10\fR.
1533.RE
1534
3dfb57a3
DB
1535.sp
1536.ne 2
1537.na
1538\fBzfs_vdev_queue_depth_pct\fR (int)
1539.ad
1540.RS 12n
e815485f
TC
1541Maximum number of queued allocations per top-level vdev expressed as
1542a percentage of \fBzfs_vdev_async_write_max_active\fR which allows the
1543system to detect devices that are more capable of handling allocations
1544and to allocate more blocks to those devices. It allows for dynamic
1545allocation distribution when devices are imbalanced as fuller devices
1546will tend to be slower than empty devices.
1547
1548See also \fBzio_dva_throttle_enabled\fR.
3dfb57a3 1549.sp
be54a13c 1550Default value: \fB1000\fR%.
3dfb57a3
DB
1551.RE
1552
29714574
TF
1553.sp
1554.ne 2
1555.na
1556\fBzfs_expire_snapshot\fR (int)
1557.ad
1558.RS 12n
1559Seconds to expire .zfs/snapshot
1560.sp
1561Default value: \fB300\fR.
1562.RE
1563
0500e835
BB
1564.sp
1565.ne 2
1566.na
1567\fBzfs_admin_snapshot\fR (int)
1568.ad
1569.RS 12n
1570Allow the creation, removal, or renaming of entries in the .zfs/snapshot
1571directory to cause the creation, destruction, or renaming of snapshots.
1572When enabled this functionality works both locally and over NFS exports
1573which have the 'no_root_squash' option set. This functionality is disabled
1574by default.
1575.sp
1576Use \fB1\fR for yes and \fB0\fR for no (default).
1577.RE
1578
29714574
TF
1579.sp
1580.ne 2
1581.na
1582\fBzfs_flags\fR (int)
1583.ad
1584.RS 12n
33b6dbbc
NB
1585Set additional debugging flags. The following flags may be bitwise-or'd
1586together.
1587.sp
1588.TS
1589box;
1590rB lB
1591lB lB
1592r l.
1593Value Symbolic Name
1594 Description
1595_
15961 ZFS_DEBUG_DPRINTF
1597 Enable dprintf entries in the debug log.
1598_
15992 ZFS_DEBUG_DBUF_VERIFY *
1600 Enable extra dbuf verifications.
1601_
16024 ZFS_DEBUG_DNODE_VERIFY *
1603 Enable extra dnode verifications.
1604_
16058 ZFS_DEBUG_SNAPNAMES
1606 Enable snapshot name verification.
1607_
160816 ZFS_DEBUG_MODIFY
1609 Check for illegally modified ARC buffers.
1610_
33b6dbbc
NB
161164 ZFS_DEBUG_ZIO_FREE
1612 Enable verification of block frees.
1613_
1614128 ZFS_DEBUG_HISTOGRAM_VERIFY
1615 Enable extra spacemap histogram verifications.
8740cf4a
NB
1616_
1617256 ZFS_DEBUG_METASLAB_VERIFY
1618 Verify space accounting on disk matches in-core range_trees.
1619_
1620512 ZFS_DEBUG_SET_ERROR
1621 Enable SET_ERROR and dprintf entries in the debug log.
33b6dbbc
NB
1622.TE
1623.sp
1624* Requires debug build.
29714574 1625.sp
33b6dbbc 1626Default value: \fB0\fR.
29714574
TF
1627.RE
1628
fbeddd60
MA
1629.sp
1630.ne 2
1631.na
1632\fBzfs_free_leak_on_eio\fR (int)
1633.ad
1634.RS 12n
1635If destroy encounters an EIO while reading metadata (e.g. indirect
1636blocks), space referenced by the missing metadata can not be freed.
1637Normally this causes the background destroy to become "stalled", as
1638it is unable to make forward progress. While in this stalled state,
1639all remaining space to free from the error-encountering filesystem is
1640"temporarily leaked". Set this flag to cause it to ignore the EIO,
1641permanently leak the space from indirect blocks that can not be read,
1642and continue to free everything else that it can.
1643
1644The default, "stalling" behavior is useful if the storage partially
1645fails (i.e. some but not all i/os fail), and then later recovers. In
1646this case, we will be able to continue pool operations while it is
1647partially failed, and when it recovers, we can continue to free the
1648space, with no leaks. However, note that this case is actually
1649fairly rare.
1650
1651Typically pools either (a) fail completely (but perhaps temporarily,
1652e.g. a top-level vdev going offline), or (b) have localized,
1653permanent errors (e.g. disk returns the wrong data due to bit flip or
1654firmware bug). In case (a), this setting does not matter because the
1655pool will be suspended and the sync thread will not be able to make
1656forward progress regardless. In case (b), because the error is
1657permanent, the best we can do is leak the minimum amount of space,
1658which is what setting this flag will do. Therefore, it is reasonable
1659for this flag to normally be set, but we chose the more conservative
1660approach of not setting it, so that there is no possibility of
1661leaking space in the "partial temporary" failure case.
1662.sp
1663Default value: \fB0\fR.
1664.RE
1665
29714574
TF
1666.sp
1667.ne 2
1668.na
1669\fBzfs_free_min_time_ms\fR (int)
1670.ad
1671.RS 12n
6146e17e 1672During a \fBzfs destroy\fR operation using \fBfeature@async_destroy\fR a minimum
83426735 1673of this much time will be spent working on freeing blocks per txg.
29714574
TF
1674.sp
1675Default value: \fB1,000\fR.
1676.RE
1677
1678.sp
1679.ne 2
1680.na
1681\fBzfs_immediate_write_sz\fR (long)
1682.ad
1683.RS 12n
83426735 1684Largest data block to write to zil. Larger blocks will be treated as if the
6146e17e 1685dataset being written to had the property setting \fBlogbias=throughput\fR.
29714574
TF
1686.sp
1687Default value: \fB32,768\fR.
1688.RE
1689
619f0976
GW
1690.sp
1691.ne 2
1692.na
1693\fBzfs_initialize_value\fR (ulong)
1694.ad
1695.RS 12n
1696Pattern written to vdev free space by \fBzpool initialize\fR.
1697.sp
1698Default value: \fB16,045,690,984,833,335,022\fR (0xdeadbeefdeadbeee).
1699.RE
1700
917f475f
JG
1701.sp
1702.ne 2
1703.na
1704\fBzfs_lua_max_instrlimit\fR (ulong)
1705.ad
1706.RS 12n
1707The maximum execution time limit that can be set for a ZFS channel program,
1708specified as a number of Lua instructions.
1709.sp
1710Default value: \fB100,000,000\fR.
1711.RE
1712
1713.sp
1714.ne 2
1715.na
1716\fBzfs_lua_max_memlimit\fR (ulong)
1717.ad
1718.RS 12n
1719The maximum memory limit that can be set for a ZFS channel program, specified
1720in bytes.
1721.sp
1722Default value: \fB104,857,600\fR.
1723.RE
1724
a7ed98d8
SD
1725.sp
1726.ne 2
1727.na
1728\fBzfs_max_dataset_nesting\fR (int)
1729.ad
1730.RS 12n
1731The maximum depth of nested datasets. This value can be tuned temporarily to
1732fix existing datasets that exceed the predefined limit.
1733.sp
1734Default value: \fB50\fR.
1735.RE
1736
f1512ee6
MA
1737.sp
1738.ne 2
1739.na
1740\fBzfs_max_recordsize\fR (int)
1741.ad
1742.RS 12n
1743We currently support block sizes from 512 bytes to 16MB. The benefits of
ad796b8a 1744larger blocks, and thus larger I/O, need to be weighed against the cost of
f1512ee6
MA
1745COWing a giant block to modify one byte. Additionally, very large blocks
1746can have an impact on i/o latency, and also potentially on the memory
1747allocator. Therefore, we do not allow the recordsize to be set larger than
1748zfs_max_recordsize (default 1MB). Larger blocks can be created by changing
1749this tunable, and pools with larger blocks can always be imported and used,
1750regardless of this setting.
1751.sp
1752Default value: \fB1,048,576\fR.
1753.RE
1754
f3a7f661
GW
1755.sp
1756.ne 2
1757.na
1758\fBzfs_metaslab_fragmentation_threshold\fR (int)
1759.ad
1760.RS 12n
1761Allow metaslabs to keep their active state as long as their fragmentation
1762percentage is less than or equal to this value. An active metaslab that
1763exceeds this threshold will no longer keep its active status allowing
1764better metaslabs to be selected.
1765.sp
1766Default value: \fB70\fR.
1767.RE
1768
1769.sp
1770.ne 2
1771.na
1772\fBzfs_mg_fragmentation_threshold\fR (int)
1773.ad
1774.RS 12n
1775Metaslab groups are considered eligible for allocations if their
83426735 1776fragmentation metric (measured as a percentage) is less than or equal to
f3a7f661
GW
1777this value. If a metaslab group exceeds this threshold then it will be
1778skipped unless all metaslab groups within the metaslab class have also
1779crossed this threshold.
1780.sp
1781Default value: \fB85\fR.
1782.RE
1783
f4a4046b
TC
1784.sp
1785.ne 2
1786.na
1787\fBzfs_mg_noalloc_threshold\fR (int)
1788.ad
1789.RS 12n
1790Defines a threshold at which metaslab groups should be eligible for
1791allocations. The value is expressed as a percentage of free space
1792beyond which a metaslab group is always eligible for allocations.
1793If a metaslab group's free space is less than or equal to the
6b4e21c6 1794threshold, the allocator will avoid allocating to that group
f4a4046b
TC
1795unless all groups in the pool have reached the threshold. Once all
1796groups have reached the threshold, all groups are allowed to accept
1797allocations. The default value of 0 disables the feature and causes
1798all metaslab groups to be eligible for allocations.
1799
b58237e7 1800This parameter allows one to deal with pools having heavily imbalanced
f4a4046b
TC
1801vdevs such as would be the case when a new vdev has been added.
1802Setting the threshold to a non-zero percentage will stop allocations
1803from being made to vdevs that aren't filled to the specified percentage
1804and allow lesser filled vdevs to acquire more allocations than they
1805otherwise would under the old \fBzfs_mg_alloc_failures\fR facility.
1806.sp
1807Default value: \fB0\fR.
1808.RE
1809
cc99f275
DB
1810.sp
1811.ne 2
1812.na
1813\fBzfs_ddt_data_is_special\fR (int)
1814.ad
1815.RS 12n
1816If enabled, ZFS will place DDT data into the special allocation class.
1817.sp
1818Default value: \fB1\fR.
1819.RE
1820
1821.sp
1822.ne 2
1823.na
1824\fBzfs_user_indirect_is_special\fR (int)
1825.ad
1826.RS 12n
1827If enabled, ZFS will place user data (both file and zvol) indirect blocks
1828into the special allocation class.
1829.sp
1830Default value: \fB1\fR.
1831.RE
1832
379ca9cf
OF
1833.sp
1834.ne 2
1835.na
1836\fBzfs_multihost_history\fR (int)
1837.ad
1838.RS 12n
1839Historical statistics for the last N multihost updates will be available in
1840\fB/proc/spl/kstat/zfs/<pool>/multihost\fR
1841.sp
1842Default value: \fB0\fR.
1843.RE
1844
1845.sp
1846.ne 2
1847.na
1848\fBzfs_multihost_interval\fR (ulong)
1849.ad
1850.RS 12n
1851Used to control the frequency of multihost writes which are performed when the
1852\fBmultihost\fR pool property is on. This is one factor used to determine
1853the length of the activity check during import.
1854.sp
1855The multihost write period is \fBzfs_multihost_interval / leaf-vdevs\fR milliseconds.
1856This means that on average a multihost write will be issued for each leaf vdev every
1857\fBzfs_multihost_interval\fR milliseconds. In practice, the observed period can
1858vary with the I/O load and this observed value is the delay which is stored in
1859the uberblock.
1860.sp
1861On import the activity check waits a minimum amount of time determined by
1862\fBzfs_multihost_interval * zfs_multihost_import_intervals\fR. The activity
1863check time may be further extended if the value of mmp delay found in the best
1864uberblock indicates actual multihost updates happened at longer intervals than
1865\fBzfs_multihost_interval\fR. A minimum value of \fB100ms\fR is enforced.
1866.sp
1867Default value: \fB1000\fR.
1868.RE
1869
1870.sp
1871.ne 2
1872.na
1873\fBzfs_multihost_import_intervals\fR (uint)
1874.ad
1875.RS 12n
1876Used to control the duration of the activity test on import. Smaller values of
1877\fBzfs_multihost_import_intervals\fR will reduce the import time but increase
1878the risk of failing to detect an active pool. The total activity check time is
1879never allowed to drop below one second. A value of 0 is ignored and treated as
1880if it was set to 1
1881.sp
db2af93d 1882Default value: \fB20\fR.
379ca9cf
OF
1883.RE
1884
1885.sp
1886.ne 2
1887.na
1888\fBzfs_multihost_fail_intervals\fR (uint)
1889.ad
1890.RS 12n
1891Controls the behavior of the pool when multihost write failures are detected.
1892.sp
1893When \fBzfs_multihost_fail_intervals = 0\fR then multihost write failures are ignored.
1894The failures will still be reported to the ZED which depending on its
1895configuration may take action such as suspending the pool or offlining a device.
1896.sp
1897When \fBzfs_multihost_fail_intervals > 0\fR then sequential multihost write failures
1898will cause the pool to be suspended. This occurs when
1899\fBzfs_multihost_fail_intervals * zfs_multihost_interval\fR milliseconds have
1900passed since the last successful multihost write. This guarantees the activity test
1901will see multihost writes if the pool is imported.
1902.sp
db2af93d 1903Default value: \fB10\fR.
379ca9cf
OF
1904.RE
1905
29714574
TF
1906.sp
1907.ne 2
1908.na
1909\fBzfs_no_scrub_io\fR (int)
1910.ad
1911.RS 12n
83426735
D
1912Set for no scrub I/O. This results in scrubs not actually scrubbing data and
1913simply doing a metadata crawl of the pool instead.
29714574
TF
1914.sp
1915Use \fB1\fR for yes and \fB0\fR for no (default).
1916.RE
1917
1918.sp
1919.ne 2
1920.na
1921\fBzfs_no_scrub_prefetch\fR (int)
1922.ad
1923.RS 12n
83426735 1924Set to disable block prefetching for scrubs.
29714574
TF
1925.sp
1926Use \fB1\fR for yes and \fB0\fR for no (default).
1927.RE
1928
29714574
TF
1929.sp
1930.ne 2
1931.na
1932\fBzfs_nocacheflush\fR (int)
1933.ad
1934.RS 12n
53b1f5ea
PS
1935Disable cache flush operations on disks when writing. Setting this will
1936cause pool corruption on power loss if a volatile out-of-order write cache
1937is enabled.
29714574
TF
1938.sp
1939Use \fB1\fR for yes and \fB0\fR for no (default).
1940.RE
1941
1942.sp
1943.ne 2
1944.na
1945\fBzfs_nopwrite_enabled\fR (int)
1946.ad
1947.RS 12n
1948Enable NOP writes
1949.sp
1950Use \fB1\fR for yes (default) and \fB0\fR to disable.
1951.RE
1952
66aca247
DB
1953.sp
1954.ne 2
1955.na
1956\fBzfs_dmu_offset_next_sync\fR (int)
1957.ad
1958.RS 12n
1959Enable forcing txg sync to find holes. When enabled forces ZFS to act
1960like prior versions when SEEK_HOLE or SEEK_DATA flags are used, which
1961when a dnode is dirty causes txg's to be synced so that this data can be
1962found.
1963.sp
1964Use \fB1\fR for yes and \fB0\fR to disable (default).
1965.RE
1966
29714574
TF
1967.sp
1968.ne 2
1969.na
b738bc5a 1970\fBzfs_pd_bytes_max\fR (int)
29714574
TF
1971.ad
1972.RS 12n
83426735 1973The number of bytes which should be prefetched during a pool traversal
6146e17e 1974(eg: \fBzfs send\fR or other data crawling operations)
29714574 1975.sp
74aa2ba2 1976Default value: \fB52,428,800\fR.
29714574
TF
1977.RE
1978
bef78122
DQ
1979.sp
1980.ne 2
1981.na
1982\fBzfs_per_txg_dirty_frees_percent \fR (ulong)
1983.ad
1984.RS 12n
65282ee9
AP
1985Tunable to control percentage of dirtied indirect blocks from frees allowed
1986into one TXG. After this threshold is crossed, additional frees will wait until
1987the next TXG.
bef78122
DQ
1988A value of zero will disable this throttle.
1989.sp
65282ee9 1990Default value: \fB5\fR, set to \fB0\fR to disable.
bef78122
DQ
1991.RE
1992
29714574
TF
1993.sp
1994.ne 2
1995.na
1996\fBzfs_prefetch_disable\fR (int)
1997.ad
1998.RS 12n
7f60329a
MA
1999This tunable disables predictive prefetch. Note that it leaves "prescient"
2000prefetch (e.g. prefetch for zfs send) intact. Unlike predictive prefetch,
2001prescient prefetch never issues i/os that end up not being needed, so it
2002can't hurt performance.
29714574
TF
2003.sp
2004Use \fB1\fR for yes and \fB0\fR for no (default).
2005.RE
2006
2007.sp
2008.ne 2
2009.na
2010\fBzfs_read_chunk_size\fR (long)
2011.ad
2012.RS 12n
2013Bytes to read per chunk
2014.sp
2015Default value: \fB1,048,576\fR.
2016.RE
2017
2018.sp
2019.ne 2
2020.na
2021\fBzfs_read_history\fR (int)
2022.ad
2023.RS 12n
379ca9cf
OF
2024Historical statistics for the last N reads will be available in
2025\fB/proc/spl/kstat/zfs/<pool>/reads\fR
29714574 2026.sp
83426735 2027Default value: \fB0\fR (no data is kept).
29714574
TF
2028.RE
2029
2030.sp
2031.ne 2
2032.na
2033\fBzfs_read_history_hits\fR (int)
2034.ad
2035.RS 12n
2036Include cache hits in read history
2037.sp
2038Use \fB1\fR for yes and \fB0\fR for no (default).
2039.RE
2040
9e052db4
MA
2041.sp
2042.ne 2
2043.na
4589f3ae
BB
2044\fBzfs_reconstruct_indirect_combinations_max\fR (int)
2045.ad
2046.RS 12na
2047If an indirect split block contains more than this many possible unique
2048combinations when being reconstructed, consider it too computationally
2049expensive to check them all. Instead, try at most
2050\fBzfs_reconstruct_indirect_combinations_max\fR randomly-selected
2051combinations each time the block is accessed. This allows all segment
2052copies to participate fairly in the reconstruction when all combinations
2053cannot be checked and prevents repeated use of one bad copy.
2054.sp
64bdf63f 2055Default value: \fB4096\fR.
9e052db4
MA
2056.RE
2057
29714574
TF
2058.sp
2059.ne 2
2060.na
2061\fBzfs_recover\fR (int)
2062.ad
2063.RS 12n
2064Set to attempt to recover from fatal errors. This should only be used as a
2065last resort, as it typically results in leaked space, or worse.
2066.sp
2067Use \fB1\fR for yes and \fB0\fR for no (default).
2068.RE
2069
7c9a4292
BB
2070.sp
2071.ne 2
2072.na
2073\fBzfs_removal_ignore_errors\fR (int)
2074.ad
2075.RS 12n
2076.sp
2077Ignore hard IO errors during device removal. When set, if a device encounters
2078a hard IO error during the removal process the removal will not be cancelled.
2079This can result in a normally recoverable block becoming permanently damaged
2080and is not recommended. This should only be used as a last resort when the
2081pool cannot be returned to a healthy state prior to removing the device.
2082.sp
2083Default value: \fB0\fR.
2084.RE
2085
29714574
TF
2086.sp
2087.ne 2
2088.na
d4a72f23 2089\fBzfs_resilver_min_time_ms\fR (int)
29714574
TF
2090.ad
2091.RS 12n
d4a72f23
TC
2092Resilvers are processed by the sync thread. While resilvering it will spend
2093at least this much time working on a resilver between txg flushes.
29714574 2094.sp
d4a72f23 2095Default value: \fB3,000\fR.
29714574
TF
2096.RE
2097
02638a30
TC
2098.sp
2099.ne 2
2100.na
2101\fBzfs_scan_ignore_errors\fR (int)
2102.ad
2103.RS 12n
2104If set to a nonzero value, remove the DTL (dirty time list) upon
2105completion of a pool scan (scrub) even if there were unrepairable
2106errors. It is intended to be used during pool repair or recovery to
2107stop resilvering when the pool is next imported.
2108.sp
2109Default value: \fB0\fR.
2110.RE
2111
29714574
TF
2112.sp
2113.ne 2
2114.na
d4a72f23 2115\fBzfs_scrub_min_time_ms\fR (int)
29714574
TF
2116.ad
2117.RS 12n
d4a72f23
TC
2118Scrubs are processed by the sync thread. While scrubbing it will spend
2119at least this much time working on a scrub between txg flushes.
29714574 2120.sp
d4a72f23 2121Default value: \fB1,000\fR.
29714574
TF
2122.RE
2123
2124.sp
2125.ne 2
2126.na
d4a72f23 2127\fBzfs_scan_checkpoint_intval\fR (int)
29714574
TF
2128.ad
2129.RS 12n
d4a72f23
TC
2130To preserve progress across reboots the sequential scan algorithm periodically
2131needs to stop metadata scanning and issue all the verifications I/Os to disk.
2132The frequency of this flushing is determined by the
a8577bdb 2133\fBzfs_scan_checkpoint_intval\fR tunable.
29714574 2134.sp
d4a72f23 2135Default value: \fB7200\fR seconds (every 2 hours).
29714574
TF
2136.RE
2137
2138.sp
2139.ne 2
2140.na
d4a72f23 2141\fBzfs_scan_fill_weight\fR (int)
29714574
TF
2142.ad
2143.RS 12n
d4a72f23
TC
2144This tunable affects how scrub and resilver I/O segments are ordered. A higher
2145number indicates that we care more about how filled in a segment is, while a
2146lower number indicates we care more about the size of the extent without
2147considering the gaps within a segment. This value is only tunable upon module
2148insertion. Changing the value afterwards will have no affect on scrub or
2149resilver performance.
29714574 2150.sp
d4a72f23 2151Default value: \fB3\fR.
29714574
TF
2152.RE
2153
2154.sp
2155.ne 2
2156.na
d4a72f23 2157\fBzfs_scan_issue_strategy\fR (int)
29714574
TF
2158.ad
2159.RS 12n
d4a72f23
TC
2160Determines the order that data will be verified while scrubbing or resilvering.
2161If set to \fB1\fR, data will be verified as sequentially as possible, given the
2162amount of memory reserved for scrubbing (see \fBzfs_scan_mem_lim_fact\fR). This
2163may improve scrub performance if the pool's data is very fragmented. If set to
2164\fB2\fR, the largest mostly-contiguous chunk of found data will be verified
2165first. By deferring scrubbing of small segments, we may later find adjacent data
2166to coalesce and increase the segment size. If set to \fB0\fR, zfs will use
2167strategy \fB1\fR during normal verification and strategy \fB2\fR while taking a
2168checkpoint.
29714574 2169.sp
d4a72f23
TC
2170Default value: \fB0\fR.
2171.RE
2172
2173.sp
2174.ne 2
2175.na
2176\fBzfs_scan_legacy\fR (int)
2177.ad
2178.RS 12n
2179A value of 0 indicates that scrubs and resilvers will gather metadata in
2180memory before issuing sequential I/O. A value of 1 indicates that the legacy
2181algorithm will be used where I/O is initiated as soon as it is discovered.
2182Changing this value to 0 will not affect scrubs or resilvers that are already
2183in progress.
2184.sp
2185Default value: \fB0\fR.
2186.RE
2187
2188.sp
2189.ne 2
2190.na
2191\fBzfs_scan_max_ext_gap\fR (int)
2192.ad
2193.RS 12n
2194Indicates the largest gap in bytes between scrub / resilver I/Os that will still
2195be considered sequential for sorting purposes. Changing this value will not
2196affect scrubs or resilvers that are already in progress.
2197.sp
2198Default value: \fB2097152 (2 MB)\fR.
2199.RE
2200
2201.sp
2202.ne 2
2203.na
2204\fBzfs_scan_mem_lim_fact\fR (int)
2205.ad
2206.RS 12n
2207Maximum fraction of RAM used for I/O sorting by sequential scan algorithm.
2208This tunable determines the hard limit for I/O sorting memory usage.
2209When the hard limit is reached we stop scanning metadata and start issuing
2210data verification I/O. This is done until we get below the soft limit.
2211.sp
2212Default value: \fB20\fR which is 5% of RAM (1/20).
2213.RE
2214
2215.sp
2216.ne 2
2217.na
2218\fBzfs_scan_mem_lim_soft_fact\fR (int)
2219.ad
2220.RS 12n
2221The fraction of the hard limit used to determined the soft limit for I/O sorting
2222by the sequential scan algorithm. When we cross this limit from bellow no action
2223is taken. When we cross this limit from above it is because we are issuing
2224verification I/O. In this case (unless the metadata scan is done) we stop
2225issuing verification I/O and start scanning metadata again until we get to the
2226hard limit.
2227.sp
2228Default value: \fB20\fR which is 5% of the hard limit (1/20).
2229.RE
2230
2231.sp
2232.ne 2
2233.na
2234\fBzfs_scan_vdev_limit\fR (int)
2235.ad
2236.RS 12n
2237Maximum amount of data that can be concurrently issued at once for scrubs and
2238resilvers per leaf device, given in bytes.
2239.sp
2240Default value: \fB41943040\fR.
29714574
TF
2241.RE
2242
fd8febbd
TF
2243.sp
2244.ne 2
2245.na
2246\fBzfs_send_corrupt_data\fR (int)
2247.ad
2248.RS 12n
83426735 2249Allow sending of corrupt data (ignore read/checksum errors when sending data)
fd8febbd
TF
2250.sp
2251Use \fB1\fR for yes and \fB0\fR for no (default).
2252.RE
2253
3b0d9928
BB
2254.sp
2255.ne 2
2256.na
2257\fBzfs_send_queue_length\fR (int)
2258.ad
2259.RS 12n
2260The maximum number of bytes allowed in the \fBzfs send\fR queue. This value
2261must be at least twice the maximum block size in use.
2262.sp
2263Default value: \fB16,777,216\fR.
2264.RE
2265
2266.sp
2267.ne 2
2268.na
2269\fBzfs_recv_queue_length\fR (int)
2270.ad
2271.RS 12n
2272.sp
2273The maximum number of bytes allowed in the \fBzfs receive\fR queue. This value
2274must be at least twice the maximum block size in use.
2275.sp
2276Default value: \fB16,777,216\fR.
2277.RE
2278
29714574
TF
2279.sp
2280.ne 2
2281.na
2282\fBzfs_sync_pass_deferred_free\fR (int)
2283.ad
2284.RS 12n
83426735 2285Flushing of data to disk is done in passes. Defer frees starting in this pass
29714574
TF
2286.sp
2287Default value: \fB2\fR.
2288.RE
2289
d2734cce
SD
2290.sp
2291.ne 2
2292.na
2293\fBzfs_spa_discard_memory_limit\fR (int)
2294.ad
2295.RS 12n
2296Maximum memory used for prefetching a checkpoint's space map on each
2297vdev while discarding the checkpoint.
2298.sp
2299Default value: \fB16,777,216\fR.
2300.RE
2301
29714574
TF
2302.sp
2303.ne 2
2304.na
2305\fBzfs_sync_pass_dont_compress\fR (int)
2306.ad
2307.RS 12n
2308Don't compress starting in this pass
2309.sp
2310Default value: \fB5\fR.
2311.RE
2312
2313.sp
2314.ne 2
2315.na
2316\fBzfs_sync_pass_rewrite\fR (int)
2317.ad
2318.RS 12n
83426735 2319Rewrite new block pointers starting in this pass
29714574
TF
2320.sp
2321Default value: \fB2\fR.
2322.RE
2323
a032ac4b
BB
2324.sp
2325.ne 2
2326.na
2327\fBzfs_sync_taskq_batch_pct\fR (int)
2328.ad
2329.RS 12n
2330This controls the number of threads used by the dp_sync_taskq. The default
2331value of 75% will create a maximum of one thread per cpu.
2332.sp
be54a13c 2333Default value: \fB75\fR%.
a032ac4b
BB
2334.RE
2335
29714574
TF
2336.sp
2337.ne 2
2338.na
2339\fBzfs_txg_history\fR (int)
2340.ad
2341.RS 12n
379ca9cf
OF
2342Historical statistics for the last N txgs will be available in
2343\fB/proc/spl/kstat/zfs/<pool>/txgs\fR
29714574 2344.sp
ca85d690 2345Default value: \fB0\fR.
29714574
TF
2346.RE
2347
29714574
TF
2348.sp
2349.ne 2
2350.na
2351\fBzfs_txg_timeout\fR (int)
2352.ad
2353.RS 12n
83426735 2354Flush dirty data to disk at least every N seconds (maximum txg duration)
29714574
TF
2355.sp
2356Default value: \fB5\fR.
2357.RE
2358
2359.sp
2360.ne 2
2361.na
2362\fBzfs_vdev_aggregation_limit\fR (int)
2363.ad
2364.RS 12n
2365Max vdev I/O aggregation size
2366.sp
2367Default value: \fB131,072\fR.
2368.RE
2369
2370.sp
2371.ne 2
2372.na
2373\fBzfs_vdev_cache_bshift\fR (int)
2374.ad
2375.RS 12n
2376Shift size to inflate reads too
2377.sp
83426735 2378Default value: \fB16\fR (effectively 65536).
29714574
TF
2379.RE
2380
2381.sp
2382.ne 2
2383.na
2384\fBzfs_vdev_cache_max\fR (int)
2385.ad
2386.RS 12n
ca85d690 2387Inflate reads smaller than this value to meet the \fBzfs_vdev_cache_bshift\fR
2388size (default 64k).
83426735
D
2389.sp
2390Default value: \fB16384\fR.
29714574
TF
2391.RE
2392
2393.sp
2394.ne 2
2395.na
2396\fBzfs_vdev_cache_size\fR (int)
2397.ad
2398.RS 12n
83426735
D
2399Total size of the per-disk cache in bytes.
2400.sp
2401Currently this feature is disabled as it has been found to not be helpful
2402for performance and in some cases harmful.
29714574
TF
2403.sp
2404Default value: \fB0\fR.
2405.RE
2406
29714574
TF
2407.sp
2408.ne 2
2409.na
9f500936 2410\fBzfs_vdev_mirror_rotating_inc\fR (int)
29714574
TF
2411.ad
2412.RS 12n
9f500936 2413A number by which the balancing algorithm increments the load calculation for
2414the purpose of selecting the least busy mirror member when an I/O immediately
2415follows its predecessor on rotational vdevs for the purpose of making decisions
2416based on load.
29714574 2417.sp
9f500936 2418Default value: \fB0\fR.
2419.RE
2420
2421.sp
2422.ne 2
2423.na
2424\fBzfs_vdev_mirror_rotating_seek_inc\fR (int)
2425.ad
2426.RS 12n
2427A number by which the balancing algorithm increments the load calculation for
2428the purpose of selecting the least busy mirror member when an I/O lacks
2429locality as defined by the zfs_vdev_mirror_rotating_seek_offset. I/Os within
2430this that are not immediately following the previous I/O are incremented by
2431half.
2432.sp
2433Default value: \fB5\fR.
2434.RE
2435
2436.sp
2437.ne 2
2438.na
2439\fBzfs_vdev_mirror_rotating_seek_offset\fR (int)
2440.ad
2441.RS 12n
2442The maximum distance for the last queued I/O in which the balancing algorithm
2443considers an I/O to have locality.
2444See the section "ZFS I/O SCHEDULER".
2445.sp
2446Default value: \fB1048576\fR.
2447.RE
2448
2449.sp
2450.ne 2
2451.na
2452\fBzfs_vdev_mirror_non_rotating_inc\fR (int)
2453.ad
2454.RS 12n
2455A number by which the balancing algorithm increments the load calculation for
2456the purpose of selecting the least busy mirror member on non-rotational vdevs
2457when I/Os do not immediately follow one another.
2458.sp
2459Default value: \fB0\fR.
2460.RE
2461
2462.sp
2463.ne 2
2464.na
2465\fBzfs_vdev_mirror_non_rotating_seek_inc\fR (int)
2466.ad
2467.RS 12n
2468A number by which the balancing algorithm increments the load calculation for
2469the purpose of selecting the least busy mirror member when an I/O lacks
2470locality as defined by the zfs_vdev_mirror_rotating_seek_offset. I/Os within
2471this that are not immediately following the previous I/O are incremented by
2472half.
2473.sp
2474Default value: \fB1\fR.
29714574
TF
2475.RE
2476
29714574
TF
2477.sp
2478.ne 2
2479.na
2480\fBzfs_vdev_read_gap_limit\fR (int)
2481.ad
2482.RS 12n
83426735
D
2483Aggregate read I/O operations if the gap on-disk between them is within this
2484threshold.
29714574
TF
2485.sp
2486Default value: \fB32,768\fR.
2487.RE
2488
2489.sp
2490.ne 2
2491.na
2492\fBzfs_vdev_scheduler\fR (charp)
2493.ad
2494.RS 12n
ca85d690 2495Set the Linux I/O scheduler on whole disk vdevs to this scheduler. Valid options
2496are noop, cfq, bfq & deadline
29714574
TF
2497.sp
2498Default value: \fBnoop\fR.
2499.RE
2500
29714574
TF
2501.sp
2502.ne 2
2503.na
2504\fBzfs_vdev_write_gap_limit\fR (int)
2505.ad
2506.RS 12n
2507Aggregate write I/O over gap
2508.sp
2509Default value: \fB4,096\fR.
2510.RE
2511
ab9f4b0b
GN
2512.sp
2513.ne 2
2514.na
2515\fBzfs_vdev_raidz_impl\fR (string)
2516.ad
2517.RS 12n
c9187d86 2518Parameter for selecting raidz parity implementation to use.
ab9f4b0b
GN
2519
2520Options marked (always) below may be selected on module load as they are
2521supported on all systems.
2522The remaining options may only be set after the module is loaded, as they
2523are available only if the implementations are compiled in and supported
2524on the running system.
2525
2526Once the module is loaded, the content of
2527/sys/module/zfs/parameters/zfs_vdev_raidz_impl will show available options
2528with the currently selected one enclosed in [].
2529Possible options are:
2530 fastest - (always) implementation selected using built-in benchmark
2531 original - (always) original raidz implementation
2532 scalar - (always) scalar raidz implementation
ae25d222
GN
2533 sse2 - implementation using SSE2 instruction set (64bit x86 only)
2534 ssse3 - implementation using SSSE3 instruction set (64bit x86 only)
ab9f4b0b 2535 avx2 - implementation using AVX2 instruction set (64bit x86 only)
7f547f85
RD
2536 avx512f - implementation using AVX512F instruction set (64bit x86 only)
2537 avx512bw - implementation using AVX512F & AVX512BW instruction sets (64bit x86 only)
62a65a65
RD
2538 aarch64_neon - implementation using NEON (Aarch64/64 bit ARMv8 only)
2539 aarch64_neonx2 - implementation using NEON with more unrolling (Aarch64/64 bit ARMv8 only)
ab9f4b0b
GN
2540.sp
2541Default value: \fBfastest\fR.
2542.RE
2543
29714574
TF
2544.sp
2545.ne 2
2546.na
2547\fBzfs_zevent_cols\fR (int)
2548.ad
2549.RS 12n
83426735 2550When zevents are logged to the console use this as the word wrap width.
29714574
TF
2551.sp
2552Default value: \fB80\fR.
2553.RE
2554
2555.sp
2556.ne 2
2557.na
2558\fBzfs_zevent_console\fR (int)
2559.ad
2560.RS 12n
2561Log events to the console
2562.sp
2563Use \fB1\fR for yes and \fB0\fR for no (default).
2564.RE
2565
2566.sp
2567.ne 2
2568.na
2569\fBzfs_zevent_len_max\fR (int)
2570.ad
2571.RS 12n
83426735
D
2572Max event queue length. A value of 0 will result in a calculated value which
2573increases with the number of CPUs in the system (minimum 64 events). Events
2574in the queue can be viewed with the \fBzpool events\fR command.
29714574
TF
2575.sp
2576Default value: \fB0\fR.
2577.RE
2578
a032ac4b
BB
2579.sp
2580.ne 2
2581.na
2582\fBzfs_zil_clean_taskq_maxalloc\fR (int)
2583.ad
2584.RS 12n
2585The maximum number of taskq entries that are allowed to be cached. When this
2fe61a7e 2586limit is exceeded transaction records (itxs) will be cleaned synchronously.
a032ac4b
BB
2587.sp
2588Default value: \fB1048576\fR.
2589.RE
2590
2591.sp
2592.ne 2
2593.na
2594\fBzfs_zil_clean_taskq_minalloc\fR (int)
2595.ad
2596.RS 12n
2597The number of taskq entries that are pre-populated when the taskq is first
2598created and are immediately available for use.
2599.sp
2600Default value: \fB1024\fR.
2601.RE
2602
2603.sp
2604.ne 2
2605.na
2606\fBzfs_zil_clean_taskq_nthr_pct\fR (int)
2607.ad
2608.RS 12n
2609This controls the number of threads used by the dp_zil_clean_taskq. The default
2610value of 100% will create a maximum of one thread per cpu.
2611.sp
be54a13c 2612Default value: \fB100\fR%.
a032ac4b
BB
2613.RE
2614
53b1f5ea
PS
2615.sp
2616.ne 2
2617.na
2618\fBzil_nocacheflush\fR (int)
2619.ad
2620.RS 12n
2621Disable the cache flush commands that are normally sent to the disk(s) by
2622the ZIL after an LWB write has completed. Setting this will cause ZIL
2623corruption on power loss if a volatile out-of-order write cache is enabled.
2624.sp
2625Use \fB1\fR for yes and \fB0\fR for no (default).
2626.RE
2627
29714574
TF
2628.sp
2629.ne 2
2630.na
2631\fBzil_replay_disable\fR (int)
2632.ad
2633.RS 12n
83426735
D
2634Disable intent logging replay. Can be disabled for recovery from corrupted
2635ZIL
29714574
TF
2636.sp
2637Use \fB1\fR for yes and \fB0\fR for no (default).
2638.RE
2639
2640.sp
2641.ne 2
2642.na
1b7c1e5c 2643\fBzil_slog_bulk\fR (ulong)
29714574
TF
2644.ad
2645.RS 12n
1b7c1e5c
GDN
2646Limit SLOG write size per commit executed with synchronous priority.
2647Any writes above that will be executed with lower (asynchronous) priority
2648to limit potential SLOG device abuse by single active ZIL writer.
29714574 2649.sp
1b7c1e5c 2650Default value: \fB786,432\fR.
29714574
TF
2651.RE
2652
638dd5f4
TC
2653.sp
2654.ne 2
2655.na
2656\fBzio_deadman_log_all\fR (int)
2657.ad
2658.RS 12n
2659If non-zero, the zio deadman will produce debugging messages (see
2660\fBzfs_dbgmsg_enable\fR) for all zios, rather than only for leaf
2661zios possessing a vdev. This is meant to be used by developers to gain
2662diagnostic information for hang conditions which don't involve a mutex
2663or other locking primitive; typically conditions in which a thread in
2664the zio pipeline is looping indefinitely.
2665.sp
2666Default value: \fB0\fR.
2667.RE
2668
c3bd3fb4
TC
2669.sp
2670.ne 2
2671.na
2672\fBzio_decompress_fail_fraction\fR (int)
2673.ad
2674.RS 12n
2675If non-zero, this value represents the denominator of the probability that zfs
2676should induce a decompression failure. For instance, for a 5% decompression
2677failure rate, this value should be set to 20.
2678.sp
2679Default value: \fB0\fR.
2680.RE
2681
29714574
TF
2682.sp
2683.ne 2
2684.na
ad796b8a 2685\fBzio_slow_io_ms\fR (int)
29714574
TF
2686.ad
2687.RS 12n
ad796b8a
TH
2688When an I/O operation takes more than \fBzio_slow_io_ms\fR milliseconds to
2689complete is marked as a slow I/O. Each slow I/O causes a delay zevent. Slow
2690I/O counters can be seen with "zpool status -s".
2691
29714574
TF
2692.sp
2693Default value: \fB30,000\fR.
2694.RE
2695
3dfb57a3
DB
2696.sp
2697.ne 2
2698.na
2699\fBzio_dva_throttle_enabled\fR (int)
2700.ad
2701.RS 12n
ad796b8a 2702Throttle block allocations in the I/O pipeline. This allows for
3dfb57a3 2703dynamic allocation distribution when devices are imbalanced.
e815485f
TC
2704When enabled, the maximum number of pending allocations per top-level vdev
2705is limited by \fBzfs_vdev_queue_depth_pct\fR.
3dfb57a3 2706.sp
27f2b90d 2707Default value: \fB1\fR.
3dfb57a3
DB
2708.RE
2709
29714574
TF
2710.sp
2711.ne 2
2712.na
2713\fBzio_requeue_io_start_cut_in_line\fR (int)
2714.ad
2715.RS 12n
2716Prioritize requeued I/O
2717.sp
2718Default value: \fB0\fR.
2719.RE
2720
dcb6bed1
D
2721.sp
2722.ne 2
2723.na
2724\fBzio_taskq_batch_pct\fR (uint)
2725.ad
2726.RS 12n
2727Percentage of online CPUs (or CPU cores, etc) which will run a worker thread
ad796b8a 2728for I/O. These workers are responsible for I/O work such as compression and
dcb6bed1
D
2729checksum calculations. Fractional number of CPUs will be rounded down.
2730.sp
2731The default value of 75 was chosen to avoid using all CPUs which can result in
2732latency issues and inconsistent application performance, especially when high
2733compression is enabled.
2734.sp
2735Default value: \fB75\fR.
2736.RE
2737
29714574
TF
2738.sp
2739.ne 2
2740.na
2741\fBzvol_inhibit_dev\fR (uint)
2742.ad
2743.RS 12n
83426735
D
2744Do not create zvol device nodes. This may slightly improve startup time on
2745systems with a very large number of zvols.
29714574
TF
2746.sp
2747Use \fB1\fR for yes and \fB0\fR for no (default).
2748.RE
2749
2750.sp
2751.ne 2
2752.na
2753\fBzvol_major\fR (uint)
2754.ad
2755.RS 12n
83426735 2756Major number for zvol block devices
29714574
TF
2757.sp
2758Default value: \fB230\fR.
2759.RE
2760
2761.sp
2762.ne 2
2763.na
2764\fBzvol_max_discard_blocks\fR (ulong)
2765.ad
2766.RS 12n
83426735
D
2767Discard (aka TRIM) operations done on zvols will be done in batches of this
2768many blocks, where block size is determined by the \fBvolblocksize\fR property
2769of a zvol.
29714574
TF
2770.sp
2771Default value: \fB16,384\fR.
2772.RE
2773
9965059a
BB
2774.sp
2775.ne 2
2776.na
2777\fBzvol_prefetch_bytes\fR (uint)
2778.ad
2779.RS 12n
2780When adding a zvol to the system prefetch \fBzvol_prefetch_bytes\fR
2781from the start and end of the volume. Prefetching these regions
2782of the volume is desirable because they are likely to be accessed
2783immediately by \fBblkid(8)\fR or by the kernel scanning for a partition
2784table.
2785.sp
2786Default value: \fB131,072\fR.
2787.RE
2788
692e55b8
CC
2789.sp
2790.ne 2
2791.na
2792\fBzvol_request_sync\fR (uint)
2793.ad
2794.RS 12n
2795When processing I/O requests for a zvol submit them synchronously. This
2796effectively limits the queue depth to 1 for each I/O submitter. When set
2797to 0 requests are handled asynchronously by a thread pool. The number of
2798requests which can be handled concurrently is controller by \fBzvol_threads\fR.
2799.sp
8fa5250f 2800Default value: \fB0\fR.
692e55b8
CC
2801.RE
2802
2803.sp
2804.ne 2
2805.na
2806\fBzvol_threads\fR (uint)
2807.ad
2808.RS 12n
2809Max number of threads which can handle zvol I/O requests concurrently.
2810.sp
2811Default value: \fB32\fR.
2812.RE
2813
cf8738d8 2814.sp
2815.ne 2
2816.na
2817\fBzvol_volmode\fR (uint)
2818.ad
2819.RS 12n
2820Defines zvol block devices behaviour when \fBvolmode\fR is set to \fBdefault\fR.
2821Valid values are \fB1\fR (full), \fB2\fR (dev) and \fB3\fR (none).
2822.sp
2823Default value: \fB1\fR.
2824.RE
2825
39ccc909 2826.sp
2827.ne 2
2828.na
2829\fBzfs_qat_disable\fR (int)
2830.ad
2831.RS 12n
cf637391
TC
2832This tunable disables qat hardware acceleration for gzip compression and.
2833AES-GCM encryption. It is available only if qat acceleration is compiled in
2834and the qat driver is present.
39ccc909 2835.sp
2836Use \fB1\fR for yes and \fB0\fR for no (default).
2837.RE
2838
e8b96c60
MA
2839.SH ZFS I/O SCHEDULER
2840ZFS issues I/O operations to leaf vdevs to satisfy and complete I/Os.
2841The I/O scheduler determines when and in what order those operations are
2842issued. The I/O scheduler divides operations into five I/O classes
2843prioritized in the following order: sync read, sync write, async read,
2844async write, and scrub/resilver. Each queue defines the minimum and
2845maximum number of concurrent operations that may be issued to the
2846device. In addition, the device has an aggregate maximum,
2847\fBzfs_vdev_max_active\fR. Note that the sum of the per-queue minimums
2848must not exceed the aggregate maximum. If the sum of the per-queue
2849maximums exceeds the aggregate maximum, then the number of active I/Os
2850may reach \fBzfs_vdev_max_active\fR, in which case no further I/Os will
2851be issued regardless of whether all per-queue minimums have been met.
2852.sp
2853For many physical devices, throughput increases with the number of
2854concurrent operations, but latency typically suffers. Further, physical
2855devices typically have a limit at which more concurrent operations have no
2856effect on throughput or can actually cause it to decrease.
2857.sp
2858The scheduler selects the next operation to issue by first looking for an
2859I/O class whose minimum has not been satisfied. Once all are satisfied and
2860the aggregate maximum has not been hit, the scheduler looks for classes
2861whose maximum has not been satisfied. Iteration through the I/O classes is
2862done in the order specified above. No further operations are issued if the
2863aggregate maximum number of concurrent operations has been hit or if there
2864are no operations queued for an I/O class that has not hit its maximum.
2865Every time an I/O is queued or an operation completes, the I/O scheduler
2866looks for new operations to issue.
2867.sp
2868In general, smaller max_active's will lead to lower latency of synchronous
2869operations. Larger max_active's may lead to higher overall throughput,
2870depending on underlying storage.
2871.sp
2872The ratio of the queues' max_actives determines the balance of performance
2873between reads, writes, and scrubs. E.g., increasing
2874\fBzfs_vdev_scrub_max_active\fR will cause the scrub or resilver to complete
2875more quickly, but reads and writes to have higher latency and lower throughput.
2876.sp
2877All I/O classes have a fixed maximum number of outstanding operations
2878except for the async write class. Asynchronous writes represent the data
2879that is committed to stable storage during the syncing stage for
2880transaction groups. Transaction groups enter the syncing state
2881periodically so the number of queued async writes will quickly burst up
2882and then bleed down to zero. Rather than servicing them as quickly as
2883possible, the I/O scheduler changes the maximum number of active async
2884write I/Os according to the amount of dirty data in the pool. Since
2885both throughput and latency typically increase with the number of
2886concurrent operations issued to physical devices, reducing the
2887burstiness in the number of concurrent operations also stabilizes the
2888response time of operations from other -- and in particular synchronous
2889-- queues. In broad strokes, the I/O scheduler will issue more
2890concurrent operations from the async write queue as there's more dirty
2891data in the pool.
2892.sp
2893Async Writes
2894.sp
2895The number of concurrent operations issued for the async write I/O class
2896follows a piece-wise linear function defined by a few adjustable points.
2897.nf
2898
2899 | o---------| <-- zfs_vdev_async_write_max_active
2900 ^ | /^ |
2901 | | / | |
2902active | / | |
2903 I/O | / | |
2904count | / | |
2905 | / | |
2906 |-------o | | <-- zfs_vdev_async_write_min_active
2907 0|_______^______|_________|
2908 0% | | 100% of zfs_dirty_data_max
2909 | |
2910 | `-- zfs_vdev_async_write_active_max_dirty_percent
2911 `--------- zfs_vdev_async_write_active_min_dirty_percent
2912
2913.fi
2914Until the amount of dirty data exceeds a minimum percentage of the dirty
2915data allowed in the pool, the I/O scheduler will limit the number of
2916concurrent operations to the minimum. As that threshold is crossed, the
2917number of concurrent operations issued increases linearly to the maximum at
2918the specified maximum percentage of the dirty data allowed in the pool.
2919.sp
2920Ideally, the amount of dirty data on a busy pool will stay in the sloped
2921part of the function between \fBzfs_vdev_async_write_active_min_dirty_percent\fR
2922and \fBzfs_vdev_async_write_active_max_dirty_percent\fR. If it exceeds the
2923maximum percentage, this indicates that the rate of incoming data is
2924greater than the rate that the backend storage can handle. In this case, we
2925must further throttle incoming writes, as described in the next section.
2926
2927.SH ZFS TRANSACTION DELAY
2928We delay transactions when we've determined that the backend storage
2929isn't able to accommodate the rate of incoming writes.
2930.sp
2931If there is already a transaction waiting, we delay relative to when
2932that transaction will finish waiting. This way the calculated delay time
2933is independent of the number of threads concurrently executing
2934transactions.
2935.sp
2936If we are the only waiter, wait relative to when the transaction
2937started, rather than the current time. This credits the transaction for
2938"time already served", e.g. reading indirect blocks.
2939.sp
2940The minimum time for a transaction to take is calculated as:
2941.nf
2942 min_time = zfs_delay_scale * (dirty - min) / (max - dirty)
2943 min_time is then capped at 100 milliseconds.
2944.fi
2945.sp
2946The delay has two degrees of freedom that can be adjusted via tunables. The
2947percentage of dirty data at which we start to delay is defined by
2948\fBzfs_delay_min_dirty_percent\fR. This should typically be at or above
2949\fBzfs_vdev_async_write_active_max_dirty_percent\fR so that we only start to
2950delay after writing at full speed has failed to keep up with the incoming write
2951rate. The scale of the curve is defined by \fBzfs_delay_scale\fR. Roughly speaking,
2952this variable determines the amount of delay at the midpoint of the curve.
2953.sp
2954.nf
2955delay
2956 10ms +-------------------------------------------------------------*+
2957 | *|
2958 9ms + *+
2959 | *|
2960 8ms + *+
2961 | * |
2962 7ms + * +
2963 | * |
2964 6ms + * +
2965 | * |
2966 5ms + * +
2967 | * |
2968 4ms + * +
2969 | * |
2970 3ms + * +
2971 | * |
2972 2ms + (midpoint) * +
2973 | | ** |
2974 1ms + v *** +
2975 | zfs_delay_scale ----------> ******** |
2976 0 +-------------------------------------*********----------------+
2977 0% <- zfs_dirty_data_max -> 100%
2978.fi
2979.sp
2980Note that since the delay is added to the outstanding time remaining on the
2981most recent transaction, the delay is effectively the inverse of IOPS.
2982Here the midpoint of 500us translates to 2000 IOPS. The shape of the curve
2983was chosen such that small changes in the amount of accumulated dirty data
2984in the first 3/4 of the curve yield relatively small differences in the
2985amount of delay.
2986.sp
2987The effects can be easier to understand when the amount of delay is
2988represented on a log scale:
2989.sp
2990.nf
2991delay
2992100ms +-------------------------------------------------------------++
2993 + +
2994 | |
2995 + *+
2996 10ms + *+
2997 + ** +
2998 | (midpoint) ** |
2999 + | ** +
3000 1ms + v **** +
3001 + zfs_delay_scale ----------> ***** +
3002 | **** |
3003 + **** +
3004100us + ** +
3005 + * +
3006 | * |
3007 + * +
3008 10us + * +
3009 + +
3010 | |
3011 + +
3012 +--------------------------------------------------------------+
3013 0% <- zfs_dirty_data_max -> 100%
3014.fi
3015.sp
3016Note here that only as the amount of dirty data approaches its limit does
3017the delay start to increase rapidly. The goal of a properly tuned system
3018should be to keep the amount of dirty data out of that range by first
3019ensuring that the appropriate limits are set for the I/O scheduler to reach
3020optimal throughput on the backend storage, and then by changing the value
3021of \fBzfs_delay_scale\fR to increase the steepness of the curve.