]> git.proxmox.com Git - mirror_zfs.git/blame - man/man5/zfs-module-parameters.5
Code improvement and bug fixes for QAT support
[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]
1b939560 17.TH ZFS-MODULE-PARAMETERS 5 "Feb 15, 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
1b939560
BB
1535.sp
1536.ne 2
1537.na
1538\fBzfs_vdev_trim_max_active\fR (int)
1539.ad
1540.RS 12n
1541Maximum trim/discard I/Os active to each device.
1542See the section "ZFS I/O SCHEDULER".
1543.sp
1544Default value: \fB2\fR.
1545.RE
1546
1547.sp
1548.ne 2
1549.na
1550\fBzfs_vdev_trim_min_active\fR (int)
1551.ad
1552.RS 12n
1553Minimum trim/discard I/Os active to each device.
1554See the section "ZFS I/O SCHEDULER".
1555.sp
1556Default value: \fB1\fR.
1557.RE
1558
3dfb57a3
DB
1559.sp
1560.ne 2
1561.na
1562\fBzfs_vdev_queue_depth_pct\fR (int)
1563.ad
1564.RS 12n
e815485f
TC
1565Maximum number of queued allocations per top-level vdev expressed as
1566a percentage of \fBzfs_vdev_async_write_max_active\fR which allows the
1567system to detect devices that are more capable of handling allocations
1568and to allocate more blocks to those devices. It allows for dynamic
1569allocation distribution when devices are imbalanced as fuller devices
1570will tend to be slower than empty devices.
1571
1572See also \fBzio_dva_throttle_enabled\fR.
3dfb57a3 1573.sp
be54a13c 1574Default value: \fB1000\fR%.
3dfb57a3
DB
1575.RE
1576
29714574
TF
1577.sp
1578.ne 2
1579.na
1580\fBzfs_expire_snapshot\fR (int)
1581.ad
1582.RS 12n
1583Seconds to expire .zfs/snapshot
1584.sp
1585Default value: \fB300\fR.
1586.RE
1587
0500e835
BB
1588.sp
1589.ne 2
1590.na
1591\fBzfs_admin_snapshot\fR (int)
1592.ad
1593.RS 12n
1594Allow the creation, removal, or renaming of entries in the .zfs/snapshot
1595directory to cause the creation, destruction, or renaming of snapshots.
1596When enabled this functionality works both locally and over NFS exports
1597which have the 'no_root_squash' option set. This functionality is disabled
1598by default.
1599.sp
1600Use \fB1\fR for yes and \fB0\fR for no (default).
1601.RE
1602
29714574
TF
1603.sp
1604.ne 2
1605.na
1606\fBzfs_flags\fR (int)
1607.ad
1608.RS 12n
33b6dbbc
NB
1609Set additional debugging flags. The following flags may be bitwise-or'd
1610together.
1611.sp
1612.TS
1613box;
1614rB lB
1615lB lB
1616r l.
1617Value Symbolic Name
1618 Description
1619_
16201 ZFS_DEBUG_DPRINTF
1621 Enable dprintf entries in the debug log.
1622_
16232 ZFS_DEBUG_DBUF_VERIFY *
1624 Enable extra dbuf verifications.
1625_
16264 ZFS_DEBUG_DNODE_VERIFY *
1627 Enable extra dnode verifications.
1628_
16298 ZFS_DEBUG_SNAPNAMES
1630 Enable snapshot name verification.
1631_
163216 ZFS_DEBUG_MODIFY
1633 Check for illegally modified ARC buffers.
1634_
33b6dbbc
NB
163564 ZFS_DEBUG_ZIO_FREE
1636 Enable verification of block frees.
1637_
1638128 ZFS_DEBUG_HISTOGRAM_VERIFY
1639 Enable extra spacemap histogram verifications.
8740cf4a
NB
1640_
1641256 ZFS_DEBUG_METASLAB_VERIFY
1642 Verify space accounting on disk matches in-core range_trees.
1643_
1644512 ZFS_DEBUG_SET_ERROR
1645 Enable SET_ERROR and dprintf entries in the debug log.
1b939560
BB
1646_
16471024 ZFS_DEBUG_INDIRECT_REMAP
1648 Verify split blocks created by device removal.
1649_
16502048 ZFS_DEBUG_TRIM
1651 Verify TRIM ranges are always within the allocatable range tree.
33b6dbbc
NB
1652.TE
1653.sp
1654* Requires debug build.
29714574 1655.sp
33b6dbbc 1656Default value: \fB0\fR.
29714574
TF
1657.RE
1658
fbeddd60
MA
1659.sp
1660.ne 2
1661.na
1662\fBzfs_free_leak_on_eio\fR (int)
1663.ad
1664.RS 12n
1665If destroy encounters an EIO while reading metadata (e.g. indirect
1666blocks), space referenced by the missing metadata can not be freed.
1667Normally this causes the background destroy to become "stalled", as
1668it is unable to make forward progress. While in this stalled state,
1669all remaining space to free from the error-encountering filesystem is
1670"temporarily leaked". Set this flag to cause it to ignore the EIO,
1671permanently leak the space from indirect blocks that can not be read,
1672and continue to free everything else that it can.
1673
1674The default, "stalling" behavior is useful if the storage partially
1675fails (i.e. some but not all i/os fail), and then later recovers. In
1676this case, we will be able to continue pool operations while it is
1677partially failed, and when it recovers, we can continue to free the
1678space, with no leaks. However, note that this case is actually
1679fairly rare.
1680
1681Typically pools either (a) fail completely (but perhaps temporarily,
1682e.g. a top-level vdev going offline), or (b) have localized,
1683permanent errors (e.g. disk returns the wrong data due to bit flip or
1684firmware bug). In case (a), this setting does not matter because the
1685pool will be suspended and the sync thread will not be able to make
1686forward progress regardless. In case (b), because the error is
1687permanent, the best we can do is leak the minimum amount of space,
1688which is what setting this flag will do. Therefore, it is reasonable
1689for this flag to normally be set, but we chose the more conservative
1690approach of not setting it, so that there is no possibility of
1691leaking space in the "partial temporary" failure case.
1692.sp
1693Default value: \fB0\fR.
1694.RE
1695
29714574
TF
1696.sp
1697.ne 2
1698.na
1699\fBzfs_free_min_time_ms\fR (int)
1700.ad
1701.RS 12n
6146e17e 1702During a \fBzfs destroy\fR operation using \fBfeature@async_destroy\fR a minimum
83426735 1703of this much time will be spent working on freeing blocks per txg.
29714574
TF
1704.sp
1705Default value: \fB1,000\fR.
1706.RE
1707
1708.sp
1709.ne 2
1710.na
1711\fBzfs_immediate_write_sz\fR (long)
1712.ad
1713.RS 12n
83426735 1714Largest data block to write to zil. Larger blocks will be treated as if the
6146e17e 1715dataset being written to had the property setting \fBlogbias=throughput\fR.
29714574
TF
1716.sp
1717Default value: \fB32,768\fR.
1718.RE
1719
619f0976
GW
1720.sp
1721.ne 2
1722.na
1723\fBzfs_initialize_value\fR (ulong)
1724.ad
1725.RS 12n
1726Pattern written to vdev free space by \fBzpool initialize\fR.
1727.sp
1728Default value: \fB16,045,690,984,833,335,022\fR (0xdeadbeefdeadbeee).
1729.RE
1730
917f475f
JG
1731.sp
1732.ne 2
1733.na
1734\fBzfs_lua_max_instrlimit\fR (ulong)
1735.ad
1736.RS 12n
1737The maximum execution time limit that can be set for a ZFS channel program,
1738specified as a number of Lua instructions.
1739.sp
1740Default value: \fB100,000,000\fR.
1741.RE
1742
1743.sp
1744.ne 2
1745.na
1746\fBzfs_lua_max_memlimit\fR (ulong)
1747.ad
1748.RS 12n
1749The maximum memory limit that can be set for a ZFS channel program, specified
1750in bytes.
1751.sp
1752Default value: \fB104,857,600\fR.
1753.RE
1754
a7ed98d8
SD
1755.sp
1756.ne 2
1757.na
1758\fBzfs_max_dataset_nesting\fR (int)
1759.ad
1760.RS 12n
1761The maximum depth of nested datasets. This value can be tuned temporarily to
1762fix existing datasets that exceed the predefined limit.
1763.sp
1764Default value: \fB50\fR.
1765.RE
1766
f1512ee6
MA
1767.sp
1768.ne 2
1769.na
1770\fBzfs_max_recordsize\fR (int)
1771.ad
1772.RS 12n
1773We currently support block sizes from 512 bytes to 16MB. The benefits of
ad796b8a 1774larger blocks, and thus larger I/O, need to be weighed against the cost of
f1512ee6
MA
1775COWing a giant block to modify one byte. Additionally, very large blocks
1776can have an impact on i/o latency, and also potentially on the memory
1777allocator. Therefore, we do not allow the recordsize to be set larger than
1778zfs_max_recordsize (default 1MB). Larger blocks can be created by changing
1779this tunable, and pools with larger blocks can always be imported and used,
1780regardless of this setting.
1781.sp
1782Default value: \fB1,048,576\fR.
1783.RE
1784
f3a7f661
GW
1785.sp
1786.ne 2
1787.na
1788\fBzfs_metaslab_fragmentation_threshold\fR (int)
1789.ad
1790.RS 12n
1791Allow metaslabs to keep their active state as long as their fragmentation
1792percentage is less than or equal to this value. An active metaslab that
1793exceeds this threshold will no longer keep its active status allowing
1794better metaslabs to be selected.
1795.sp
1796Default value: \fB70\fR.
1797.RE
1798
1799.sp
1800.ne 2
1801.na
1802\fBzfs_mg_fragmentation_threshold\fR (int)
1803.ad
1804.RS 12n
1805Metaslab groups are considered eligible for allocations if their
83426735 1806fragmentation metric (measured as a percentage) is less than or equal to
f3a7f661
GW
1807this value. If a metaslab group exceeds this threshold then it will be
1808skipped unless all metaslab groups within the metaslab class have also
1809crossed this threshold.
1810.sp
1811Default value: \fB85\fR.
1812.RE
1813
f4a4046b
TC
1814.sp
1815.ne 2
1816.na
1817\fBzfs_mg_noalloc_threshold\fR (int)
1818.ad
1819.RS 12n
1820Defines a threshold at which metaslab groups should be eligible for
1821allocations. The value is expressed as a percentage of free space
1822beyond which a metaslab group is always eligible for allocations.
1823If a metaslab group's free space is less than or equal to the
6b4e21c6 1824threshold, the allocator will avoid allocating to that group
f4a4046b
TC
1825unless all groups in the pool have reached the threshold. Once all
1826groups have reached the threshold, all groups are allowed to accept
1827allocations. The default value of 0 disables the feature and causes
1828all metaslab groups to be eligible for allocations.
1829
b58237e7 1830This parameter allows one to deal with pools having heavily imbalanced
f4a4046b
TC
1831vdevs such as would be the case when a new vdev has been added.
1832Setting the threshold to a non-zero percentage will stop allocations
1833from being made to vdevs that aren't filled to the specified percentage
1834and allow lesser filled vdevs to acquire more allocations than they
1835otherwise would under the old \fBzfs_mg_alloc_failures\fR facility.
1836.sp
1837Default value: \fB0\fR.
1838.RE
1839
cc99f275
DB
1840.sp
1841.ne 2
1842.na
1843\fBzfs_ddt_data_is_special\fR (int)
1844.ad
1845.RS 12n
1846If enabled, ZFS will place DDT data into the special allocation class.
1847.sp
1848Default value: \fB1\fR.
1849.RE
1850
1851.sp
1852.ne 2
1853.na
1854\fBzfs_user_indirect_is_special\fR (int)
1855.ad
1856.RS 12n
1857If enabled, ZFS will place user data (both file and zvol) indirect blocks
1858into the special allocation class.
1859.sp
1860Default value: \fB1\fR.
1861.RE
1862
379ca9cf
OF
1863.sp
1864.ne 2
1865.na
1866\fBzfs_multihost_history\fR (int)
1867.ad
1868.RS 12n
1869Historical statistics for the last N multihost updates will be available in
1870\fB/proc/spl/kstat/zfs/<pool>/multihost\fR
1871.sp
1872Default value: \fB0\fR.
1873.RE
1874
1875.sp
1876.ne 2
1877.na
1878\fBzfs_multihost_interval\fR (ulong)
1879.ad
1880.RS 12n
1881Used to control the frequency of multihost writes which are performed when the
060f0226
OF
1882\fBmultihost\fR pool property is on. This is one factor used to determine the
1883length of the activity check during import.
379ca9cf 1884.sp
060f0226
OF
1885The multihost write period is \fBzfs_multihost_interval / leaf-vdevs\fR
1886milliseconds. On average a multihost write will be issued for each leaf vdev
1887every \fBzfs_multihost_interval\fR milliseconds. In practice, the observed
1888period can vary with the I/O load and this observed value is the delay which is
1889stored in the uberblock.
379ca9cf
OF
1890.sp
1891Default value: \fB1000\fR.
1892.RE
1893
1894.sp
1895.ne 2
1896.na
1897\fBzfs_multihost_import_intervals\fR (uint)
1898.ad
1899.RS 12n
1900Used to control the duration of the activity test on import. Smaller values of
1901\fBzfs_multihost_import_intervals\fR will reduce the import time but increase
1902the risk of failing to detect an active pool. The total activity check time is
060f0226
OF
1903never allowed to drop below one second.
1904.sp
1905On import the activity check waits a minimum amount of time determined by
1906\fBzfs_multihost_interval * zfs_multihost_import_intervals\fR, or the same
1907product computed on the host which last had the pool imported (whichever is
1908greater). The activity check time may be further extended if the value of mmp
1909delay found in the best uberblock indicates actual multihost updates happened
1910at longer intervals than \fBzfs_multihost_interval\fR. A minimum value of
1911\fB100ms\fR is enforced.
1912.sp
1913A value of 0 is ignored and treated as if it was set to 1.
379ca9cf 1914.sp
db2af93d 1915Default value: \fB20\fR.
379ca9cf
OF
1916.RE
1917
1918.sp
1919.ne 2
1920.na
1921\fBzfs_multihost_fail_intervals\fR (uint)
1922.ad
1923.RS 12n
060f0226
OF
1924Controls the behavior of the pool when multihost write failures or delays are
1925detected.
379ca9cf 1926.sp
060f0226
OF
1927When \fBzfs_multihost_fail_intervals = 0\fR, multihost write failures or delays
1928are ignored. The failures will still be reported to the ZED which depending on
1929its configuration may take action such as suspending the pool or offlining a
1930device.
1931
379ca9cf 1932.sp
060f0226
OF
1933When \fBzfs_multihost_fail_intervals > 0\fR, the pool will be suspended if
1934\fBzfs_multihost_fail_intervals * zfs_multihost_interval\fR milliseconds pass
1935without a successful mmp write. This guarantees the activity test will see
1936mmp writes if the pool is imported. A value of 1 is ignored and treated as
1937if it was set to 2. This is necessary to prevent the pool from being suspended
1938due to normal, small I/O latency variations.
1939
379ca9cf 1940.sp
db2af93d 1941Default value: \fB10\fR.
379ca9cf
OF
1942.RE
1943
29714574
TF
1944.sp
1945.ne 2
1946.na
1947\fBzfs_no_scrub_io\fR (int)
1948.ad
1949.RS 12n
83426735
D
1950Set for no scrub I/O. This results in scrubs not actually scrubbing data and
1951simply doing a metadata crawl of the pool instead.
29714574
TF
1952.sp
1953Use \fB1\fR for yes and \fB0\fR for no (default).
1954.RE
1955
1956.sp
1957.ne 2
1958.na
1959\fBzfs_no_scrub_prefetch\fR (int)
1960.ad
1961.RS 12n
83426735 1962Set to disable block prefetching for scrubs.
29714574
TF
1963.sp
1964Use \fB1\fR for yes and \fB0\fR for no (default).
1965.RE
1966
29714574
TF
1967.sp
1968.ne 2
1969.na
1970\fBzfs_nocacheflush\fR (int)
1971.ad
1972.RS 12n
53b1f5ea
PS
1973Disable cache flush operations on disks when writing. Setting this will
1974cause pool corruption on power loss if a volatile out-of-order write cache
1975is enabled.
29714574
TF
1976.sp
1977Use \fB1\fR for yes and \fB0\fR for no (default).
1978.RE
1979
1980.sp
1981.ne 2
1982.na
1983\fBzfs_nopwrite_enabled\fR (int)
1984.ad
1985.RS 12n
1986Enable NOP writes
1987.sp
1988Use \fB1\fR for yes (default) and \fB0\fR to disable.
1989.RE
1990
66aca247
DB
1991.sp
1992.ne 2
1993.na
1994\fBzfs_dmu_offset_next_sync\fR (int)
1995.ad
1996.RS 12n
1997Enable forcing txg sync to find holes. When enabled forces ZFS to act
1998like prior versions when SEEK_HOLE or SEEK_DATA flags are used, which
1999when a dnode is dirty causes txg's to be synced so that this data can be
2000found.
2001.sp
2002Use \fB1\fR for yes and \fB0\fR to disable (default).
2003.RE
2004
29714574
TF
2005.sp
2006.ne 2
2007.na
b738bc5a 2008\fBzfs_pd_bytes_max\fR (int)
29714574
TF
2009.ad
2010.RS 12n
83426735 2011The number of bytes which should be prefetched during a pool traversal
6146e17e 2012(eg: \fBzfs send\fR or other data crawling operations)
29714574 2013.sp
74aa2ba2 2014Default value: \fB52,428,800\fR.
29714574
TF
2015.RE
2016
bef78122
DQ
2017.sp
2018.ne 2
2019.na
2020\fBzfs_per_txg_dirty_frees_percent \fR (ulong)
2021.ad
2022.RS 12n
65282ee9
AP
2023Tunable to control percentage of dirtied indirect blocks from frees allowed
2024into one TXG. After this threshold is crossed, additional frees will wait until
2025the next TXG.
bef78122
DQ
2026A value of zero will disable this throttle.
2027.sp
65282ee9 2028Default value: \fB5\fR, set to \fB0\fR to disable.
bef78122
DQ
2029.RE
2030
29714574
TF
2031.sp
2032.ne 2
2033.na
2034\fBzfs_prefetch_disable\fR (int)
2035.ad
2036.RS 12n
7f60329a
MA
2037This tunable disables predictive prefetch. Note that it leaves "prescient"
2038prefetch (e.g. prefetch for zfs send) intact. Unlike predictive prefetch,
2039prescient prefetch never issues i/os that end up not being needed, so it
2040can't hurt performance.
29714574
TF
2041.sp
2042Use \fB1\fR for yes and \fB0\fR for no (default).
2043.RE
2044
5090f727
CZ
2045.sp
2046.ne 2
2047.na
2048\fBzfs_qat_checksum_disable\fR (int)
2049.ad
2050.RS 12n
2051This tunable disables qat hardware acceleration for sha256 checksums. It
2052may be set after the zfs modules have been loaded to initialize the qat
2053hardware as long as support is compiled in and the qat driver is present.
2054.sp
2055Use \fB1\fR for yes and \fB0\fR for no (default).
2056.RE
2057
2058.sp
2059.ne 2
2060.na
2061\fBzfs_qat_compress_disable\fR (int)
2062.ad
2063.RS 12n
2064This tunable disables qat hardware acceleration for gzip compression. It
2065may be set after the zfs modules have been loaded to initialize the qat
2066hardware as long as support is compiled in and the qat driver is present.
2067.sp
2068Use \fB1\fR for yes and \fB0\fR for no (default).
2069.RE
2070
2071.sp
2072.ne 2
2073.na
2074\fBzfs_qat_encrypt_disable\fR (int)
2075.ad
2076.RS 12n
2077This tunable disables qat hardware acceleration for AES-GCM encryption. It
2078may be set after the zfs modules have been loaded to initialize the qat
2079hardware as long as support is compiled in and the qat driver is present.
2080.sp
2081Use \fB1\fR for yes and \fB0\fR for no (default).
2082.RE
2083
29714574
TF
2084.sp
2085.ne 2
2086.na
2087\fBzfs_read_chunk_size\fR (long)
2088.ad
2089.RS 12n
2090Bytes to read per chunk
2091.sp
2092Default value: \fB1,048,576\fR.
2093.RE
2094
2095.sp
2096.ne 2
2097.na
2098\fBzfs_read_history\fR (int)
2099.ad
2100.RS 12n
379ca9cf
OF
2101Historical statistics for the last N reads will be available in
2102\fB/proc/spl/kstat/zfs/<pool>/reads\fR
29714574 2103.sp
83426735 2104Default value: \fB0\fR (no data is kept).
29714574
TF
2105.RE
2106
2107.sp
2108.ne 2
2109.na
2110\fBzfs_read_history_hits\fR (int)
2111.ad
2112.RS 12n
2113Include cache hits in read history
2114.sp
2115Use \fB1\fR for yes and \fB0\fR for no (default).
2116.RE
2117
9e052db4
MA
2118.sp
2119.ne 2
2120.na
4589f3ae
BB
2121\fBzfs_reconstruct_indirect_combinations_max\fR (int)
2122.ad
2123.RS 12na
2124If an indirect split block contains more than this many possible unique
2125combinations when being reconstructed, consider it too computationally
2126expensive to check them all. Instead, try at most
2127\fBzfs_reconstruct_indirect_combinations_max\fR randomly-selected
2128combinations each time the block is accessed. This allows all segment
2129copies to participate fairly in the reconstruction when all combinations
2130cannot be checked and prevents repeated use of one bad copy.
2131.sp
64bdf63f 2132Default value: \fB4096\fR.
9e052db4
MA
2133.RE
2134
29714574
TF
2135.sp
2136.ne 2
2137.na
2138\fBzfs_recover\fR (int)
2139.ad
2140.RS 12n
2141Set to attempt to recover from fatal errors. This should only be used as a
2142last resort, as it typically results in leaked space, or worse.
2143.sp
2144Use \fB1\fR for yes and \fB0\fR for no (default).
2145.RE
2146
7c9a4292
BB
2147.sp
2148.ne 2
2149.na
2150\fBzfs_removal_ignore_errors\fR (int)
2151.ad
2152.RS 12n
2153.sp
2154Ignore hard IO errors during device removal. When set, if a device encounters
2155a hard IO error during the removal process the removal will not be cancelled.
2156This can result in a normally recoverable block becoming permanently damaged
2157and is not recommended. This should only be used as a last resort when the
2158pool cannot be returned to a healthy state prior to removing the device.
2159.sp
2160Default value: \fB0\fR.
2161.RE
2162
29714574
TF
2163.sp
2164.ne 2
2165.na
d4a72f23 2166\fBzfs_resilver_min_time_ms\fR (int)
29714574
TF
2167.ad
2168.RS 12n
d4a72f23
TC
2169Resilvers are processed by the sync thread. While resilvering it will spend
2170at least this much time working on a resilver between txg flushes.
29714574 2171.sp
d4a72f23 2172Default value: \fB3,000\fR.
29714574
TF
2173.RE
2174
02638a30
TC
2175.sp
2176.ne 2
2177.na
2178\fBzfs_scan_ignore_errors\fR (int)
2179.ad
2180.RS 12n
2181If set to a nonzero value, remove the DTL (dirty time list) upon
2182completion of a pool scan (scrub) even if there were unrepairable
2183errors. It is intended to be used during pool repair or recovery to
2184stop resilvering when the pool is next imported.
2185.sp
2186Default value: \fB0\fR.
2187.RE
2188
29714574
TF
2189.sp
2190.ne 2
2191.na
d4a72f23 2192\fBzfs_scrub_min_time_ms\fR (int)
29714574
TF
2193.ad
2194.RS 12n
d4a72f23
TC
2195Scrubs are processed by the sync thread. While scrubbing it will spend
2196at least this much time working on a scrub between txg flushes.
29714574 2197.sp
d4a72f23 2198Default value: \fB1,000\fR.
29714574
TF
2199.RE
2200
2201.sp
2202.ne 2
2203.na
d4a72f23 2204\fBzfs_scan_checkpoint_intval\fR (int)
29714574
TF
2205.ad
2206.RS 12n
d4a72f23
TC
2207To preserve progress across reboots the sequential scan algorithm periodically
2208needs to stop metadata scanning and issue all the verifications I/Os to disk.
2209The frequency of this flushing is determined by the
a8577bdb 2210\fBzfs_scan_checkpoint_intval\fR tunable.
29714574 2211.sp
d4a72f23 2212Default value: \fB7200\fR seconds (every 2 hours).
29714574
TF
2213.RE
2214
2215.sp
2216.ne 2
2217.na
d4a72f23 2218\fBzfs_scan_fill_weight\fR (int)
29714574
TF
2219.ad
2220.RS 12n
d4a72f23
TC
2221This tunable affects how scrub and resilver I/O segments are ordered. A higher
2222number indicates that we care more about how filled in a segment is, while a
2223lower number indicates we care more about the size of the extent without
2224considering the gaps within a segment. This value is only tunable upon module
2225insertion. Changing the value afterwards will have no affect on scrub or
2226resilver performance.
29714574 2227.sp
d4a72f23 2228Default value: \fB3\fR.
29714574
TF
2229.RE
2230
2231.sp
2232.ne 2
2233.na
d4a72f23 2234\fBzfs_scan_issue_strategy\fR (int)
29714574
TF
2235.ad
2236.RS 12n
d4a72f23
TC
2237Determines the order that data will be verified while scrubbing or resilvering.
2238If set to \fB1\fR, data will be verified as sequentially as possible, given the
2239amount of memory reserved for scrubbing (see \fBzfs_scan_mem_lim_fact\fR). This
2240may improve scrub performance if the pool's data is very fragmented. If set to
2241\fB2\fR, the largest mostly-contiguous chunk of found data will be verified
2242first. By deferring scrubbing of small segments, we may later find adjacent data
2243to coalesce and increase the segment size. If set to \fB0\fR, zfs will use
2244strategy \fB1\fR during normal verification and strategy \fB2\fR while taking a
2245checkpoint.
29714574 2246.sp
d4a72f23
TC
2247Default value: \fB0\fR.
2248.RE
2249
2250.sp
2251.ne 2
2252.na
2253\fBzfs_scan_legacy\fR (int)
2254.ad
2255.RS 12n
2256A value of 0 indicates that scrubs and resilvers will gather metadata in
2257memory before issuing sequential I/O. A value of 1 indicates that the legacy
2258algorithm will be used where I/O is initiated as soon as it is discovered.
2259Changing this value to 0 will not affect scrubs or resilvers that are already
2260in progress.
2261.sp
2262Default value: \fB0\fR.
2263.RE
2264
2265.sp
2266.ne 2
2267.na
2268\fBzfs_scan_max_ext_gap\fR (int)
2269.ad
2270.RS 12n
2271Indicates the largest gap in bytes between scrub / resilver I/Os that will still
2272be considered sequential for sorting purposes. Changing this value will not
2273affect scrubs or resilvers that are already in progress.
2274.sp
2275Default value: \fB2097152 (2 MB)\fR.
2276.RE
2277
2278.sp
2279.ne 2
2280.na
2281\fBzfs_scan_mem_lim_fact\fR (int)
2282.ad
2283.RS 12n
2284Maximum fraction of RAM used for I/O sorting by sequential scan algorithm.
2285This tunable determines the hard limit for I/O sorting memory usage.
2286When the hard limit is reached we stop scanning metadata and start issuing
2287data verification I/O. This is done until we get below the soft limit.
2288.sp
2289Default value: \fB20\fR which is 5% of RAM (1/20).
2290.RE
2291
2292.sp
2293.ne 2
2294.na
2295\fBzfs_scan_mem_lim_soft_fact\fR (int)
2296.ad
2297.RS 12n
2298The fraction of the hard limit used to determined the soft limit for I/O sorting
2299by the sequential scan algorithm. When we cross this limit from bellow no action
2300is taken. When we cross this limit from above it is because we are issuing
2301verification I/O. In this case (unless the metadata scan is done) we stop
2302issuing verification I/O and start scanning metadata again until we get to the
2303hard limit.
2304.sp
2305Default value: \fB20\fR which is 5% of the hard limit (1/20).
2306.RE
2307
2308.sp
2309.ne 2
2310.na
2311\fBzfs_scan_vdev_limit\fR (int)
2312.ad
2313.RS 12n
2314Maximum amount of data that can be concurrently issued at once for scrubs and
2315resilvers per leaf device, given in bytes.
2316.sp
2317Default value: \fB41943040\fR.
29714574
TF
2318.RE
2319
fd8febbd
TF
2320.sp
2321.ne 2
2322.na
2323\fBzfs_send_corrupt_data\fR (int)
2324.ad
2325.RS 12n
83426735 2326Allow sending of corrupt data (ignore read/checksum errors when sending data)
fd8febbd
TF
2327.sp
2328Use \fB1\fR for yes and \fB0\fR for no (default).
2329.RE
2330
3b0d9928
BB
2331.sp
2332.ne 2
2333.na
2334\fBzfs_send_queue_length\fR (int)
2335.ad
2336.RS 12n
2337The maximum number of bytes allowed in the \fBzfs send\fR queue. This value
2338must be at least twice the maximum block size in use.
2339.sp
2340Default value: \fB16,777,216\fR.
2341.RE
2342
2343.sp
2344.ne 2
2345.na
2346\fBzfs_recv_queue_length\fR (int)
2347.ad
2348.RS 12n
2349.sp
2350The maximum number of bytes allowed in the \fBzfs receive\fR queue. This value
2351must be at least twice the maximum block size in use.
2352.sp
2353Default value: \fB16,777,216\fR.
2354.RE
2355
29714574
TF
2356.sp
2357.ne 2
2358.na
2359\fBzfs_sync_pass_deferred_free\fR (int)
2360.ad
2361.RS 12n
83426735 2362Flushing of data to disk is done in passes. Defer frees starting in this pass
29714574
TF
2363.sp
2364Default value: \fB2\fR.
2365.RE
2366
d2734cce
SD
2367.sp
2368.ne 2
2369.na
2370\fBzfs_spa_discard_memory_limit\fR (int)
2371.ad
2372.RS 12n
2373Maximum memory used for prefetching a checkpoint's space map on each
2374vdev while discarding the checkpoint.
2375.sp
2376Default value: \fB16,777,216\fR.
2377.RE
2378
29714574
TF
2379.sp
2380.ne 2
2381.na
2382\fBzfs_sync_pass_dont_compress\fR (int)
2383.ad
2384.RS 12n
2385Don't compress starting in this pass
2386.sp
2387Default value: \fB5\fR.
2388.RE
2389
2390.sp
2391.ne 2
2392.na
2393\fBzfs_sync_pass_rewrite\fR (int)
2394.ad
2395.RS 12n
83426735 2396Rewrite new block pointers starting in this pass
29714574
TF
2397.sp
2398Default value: \fB2\fR.
2399.RE
2400
a032ac4b
BB
2401.sp
2402.ne 2
2403.na
2404\fBzfs_sync_taskq_batch_pct\fR (int)
2405.ad
2406.RS 12n
2407This controls the number of threads used by the dp_sync_taskq. The default
2408value of 75% will create a maximum of one thread per cpu.
2409.sp
be54a13c 2410Default value: \fB75\fR%.
a032ac4b
BB
2411.RE
2412
1b939560
BB
2413.sp
2414.ne 2
2415.na
2416\fBzfs_trim_extent_bytes_max\fR (unsigned int)
2417.ad
2418.RS 12n
2419Maximum size of TRIM command. Ranges larger than this will be split in to
2420chunks no larger than \fBzfs_trim_extent_bytes_max\fR bytes before being
2421issued to the device.
2422.sp
2423Default value: \fB134,217,728\fR.
2424.RE
2425
2426.sp
2427.ne 2
2428.na
2429\fBzfs_trim_extent_bytes_min\fR (unsigned int)
2430.ad
2431.RS 12n
2432Minimum size of TRIM commands. TRIM ranges smaller than this will be skipped
2433unless they're part of a larger range which was broken in to chunks. This is
2434done because it's common for these small TRIMs to negatively impact overall
2435performance. This value can be set to 0 to TRIM all unallocated space.
2436.sp
2437Default value: \fB32,768\fR.
2438.RE
2439
2440.sp
2441.ne 2
2442.na
2443\fBzfs_trim_metaslab_skip\fR (unsigned int)
2444.ad
2445.RS 12n
2446Skip uninitialized metaslabs during the TRIM process. This option is useful
2447for pools constructed from large thinly-provisioned devices where TRIM
2448operations are slow. As a pool ages an increasing fraction of the pools
2449metaslabs will be initialized progressively degrading the usefulness of
2450this option. This setting is stored when starting a manual TRIM and will
2451persist for the duration of the requested TRIM.
2452.sp
2453Default value: \fB0\fR.
2454.RE
2455
2456.sp
2457.ne 2
2458.na
2459\fBzfs_trim_queue_limit\fR (unsigned int)
2460.ad
2461.RS 12n
2462Maximum number of queued TRIMs outstanding per leaf vdev. The number of
2463concurrent TRIM commands issued to the device is controlled by the
2464\fBzfs_vdev_trim_min_active\fR and \fBzfs_vdev_trim_max_active\fR module
2465options.
2466.sp
2467Default value: \fB10\fR.
2468.RE
2469
2470.sp
2471.ne 2
2472.na
2473\fBzfs_trim_txg_batch\fR (unsigned int)
2474.ad
2475.RS 12n
2476The number of transaction groups worth of frees which should be aggregated
2477before TRIM operations are issued to the device. This setting represents a
2478trade-off between issuing larger, more efficient TRIM operations and the
2479delay before the recently trimmed space is available for use by the device.
2480.sp
2481Increasing this value will allow frees to be aggregated for a longer time.
2482This will result is larger TRIM operations and potentially increased memory
2483usage. Decreasing this value will have the opposite effect. The default
2484value of 32 was determined to be a reasonable compromise.
2485.sp
2486Default value: \fB32\fR.
2487.RE
2488
29714574
TF
2489.sp
2490.ne 2
2491.na
2492\fBzfs_txg_history\fR (int)
2493.ad
2494.RS 12n
379ca9cf
OF
2495Historical statistics for the last N txgs will be available in
2496\fB/proc/spl/kstat/zfs/<pool>/txgs\fR
29714574 2497.sp
ca85d690 2498Default value: \fB0\fR.
29714574
TF
2499.RE
2500
29714574
TF
2501.sp
2502.ne 2
2503.na
2504\fBzfs_txg_timeout\fR (int)
2505.ad
2506.RS 12n
83426735 2507Flush dirty data to disk at least every N seconds (maximum txg duration)
29714574
TF
2508.sp
2509Default value: \fB5\fR.
2510.RE
2511
1b939560
BB
2512.sp
2513.ne 2
2514.na
2515\fBzfs_vdev_aggregate_trim\fR (int)
2516.ad
2517.RS 12n
2518Allow TRIM I/Os to be aggregated. This is normally not helpful because
2519the extents to be trimmed will have been already been aggregated by the
2520metaslab. This option is provided for debugging and performance analysis.
2521.sp
2522Default value: \fB0\fR.
2523.RE
2524
29714574
TF
2525.sp
2526.ne 2
2527.na
2528\fBzfs_vdev_aggregation_limit\fR (int)
2529.ad
2530.RS 12n
2531Max vdev I/O aggregation size
2532.sp
1af240f3
AM
2533Default value: \fB1,048,576\fR.
2534.RE
2535
2536.sp
2537.ne 2
2538.na
2539\fBzfs_vdev_aggregation_limit_non_rotating\fR (int)
2540.ad
2541.RS 12n
2542Max vdev I/O aggregation size for non-rotating media
2543.sp
29714574
TF
2544Default value: \fB131,072\fR.
2545.RE
2546
2547.sp
2548.ne 2
2549.na
2550\fBzfs_vdev_cache_bshift\fR (int)
2551.ad
2552.RS 12n
2553Shift size to inflate reads too
2554.sp
83426735 2555Default value: \fB16\fR (effectively 65536).
29714574
TF
2556.RE
2557
2558.sp
2559.ne 2
2560.na
2561\fBzfs_vdev_cache_max\fR (int)
2562.ad
2563.RS 12n
ca85d690 2564Inflate reads smaller than this value to meet the \fBzfs_vdev_cache_bshift\fR
2565size (default 64k).
83426735
D
2566.sp
2567Default value: \fB16384\fR.
29714574
TF
2568.RE
2569
2570.sp
2571.ne 2
2572.na
2573\fBzfs_vdev_cache_size\fR (int)
2574.ad
2575.RS 12n
83426735
D
2576Total size of the per-disk cache in bytes.
2577.sp
2578Currently this feature is disabled as it has been found to not be helpful
2579for performance and in some cases harmful.
29714574
TF
2580.sp
2581Default value: \fB0\fR.
2582.RE
2583
29714574
TF
2584.sp
2585.ne 2
2586.na
9f500936 2587\fBzfs_vdev_mirror_rotating_inc\fR (int)
29714574
TF
2588.ad
2589.RS 12n
9f500936 2590A number by which the balancing algorithm increments the load calculation for
2591the purpose of selecting the least busy mirror member when an I/O immediately
2592follows its predecessor on rotational vdevs for the purpose of making decisions
2593based on load.
29714574 2594.sp
9f500936 2595Default value: \fB0\fR.
2596.RE
2597
2598.sp
2599.ne 2
2600.na
2601\fBzfs_vdev_mirror_rotating_seek_inc\fR (int)
2602.ad
2603.RS 12n
2604A number by which the balancing algorithm increments the load calculation for
2605the purpose of selecting the least busy mirror member when an I/O lacks
2606locality as defined by the zfs_vdev_mirror_rotating_seek_offset. I/Os within
2607this that are not immediately following the previous I/O are incremented by
2608half.
2609.sp
2610Default value: \fB5\fR.
2611.RE
2612
2613.sp
2614.ne 2
2615.na
2616\fBzfs_vdev_mirror_rotating_seek_offset\fR (int)
2617.ad
2618.RS 12n
2619The maximum distance for the last queued I/O in which the balancing algorithm
2620considers an I/O to have locality.
2621See the section "ZFS I/O SCHEDULER".
2622.sp
2623Default value: \fB1048576\fR.
2624.RE
2625
2626.sp
2627.ne 2
2628.na
2629\fBzfs_vdev_mirror_non_rotating_inc\fR (int)
2630.ad
2631.RS 12n
2632A number by which the balancing algorithm increments the load calculation for
2633the purpose of selecting the least busy mirror member on non-rotational vdevs
2634when I/Os do not immediately follow one another.
2635.sp
2636Default value: \fB0\fR.
2637.RE
2638
2639.sp
2640.ne 2
2641.na
2642\fBzfs_vdev_mirror_non_rotating_seek_inc\fR (int)
2643.ad
2644.RS 12n
2645A number by which the balancing algorithm increments the load calculation for
2646the purpose of selecting the least busy mirror member when an I/O lacks
2647locality as defined by the zfs_vdev_mirror_rotating_seek_offset. I/Os within
2648this that are not immediately following the previous I/O are incremented by
2649half.
2650.sp
2651Default value: \fB1\fR.
29714574
TF
2652.RE
2653
29714574
TF
2654.sp
2655.ne 2
2656.na
2657\fBzfs_vdev_read_gap_limit\fR (int)
2658.ad
2659.RS 12n
83426735
D
2660Aggregate read I/O operations if the gap on-disk between them is within this
2661threshold.
29714574
TF
2662.sp
2663Default value: \fB32,768\fR.
2664.RE
2665
2666.sp
2667.ne 2
2668.na
2669\fBzfs_vdev_scheduler\fR (charp)
2670.ad
2671.RS 12n
ca85d690 2672Set the Linux I/O scheduler on whole disk vdevs to this scheduler. Valid options
2673are noop, cfq, bfq & deadline
29714574
TF
2674.sp
2675Default value: \fBnoop\fR.
2676.RE
2677
29714574
TF
2678.sp
2679.ne 2
2680.na
2681\fBzfs_vdev_write_gap_limit\fR (int)
2682.ad
2683.RS 12n
2684Aggregate write I/O over gap
2685.sp
2686Default value: \fB4,096\fR.
2687.RE
2688
ab9f4b0b
GN
2689.sp
2690.ne 2
2691.na
2692\fBzfs_vdev_raidz_impl\fR (string)
2693.ad
2694.RS 12n
c9187d86 2695Parameter for selecting raidz parity implementation to use.
ab9f4b0b
GN
2696
2697Options marked (always) below may be selected on module load as they are
2698supported on all systems.
2699The remaining options may only be set after the module is loaded, as they
2700are available only if the implementations are compiled in and supported
2701on the running system.
2702
2703Once the module is loaded, the content of
2704/sys/module/zfs/parameters/zfs_vdev_raidz_impl will show available options
2705with the currently selected one enclosed in [].
2706Possible options are:
2707 fastest - (always) implementation selected using built-in benchmark
2708 original - (always) original raidz implementation
2709 scalar - (always) scalar raidz implementation
ae25d222
GN
2710 sse2 - implementation using SSE2 instruction set (64bit x86 only)
2711 ssse3 - implementation using SSSE3 instruction set (64bit x86 only)
ab9f4b0b 2712 avx2 - implementation using AVX2 instruction set (64bit x86 only)
7f547f85
RD
2713 avx512f - implementation using AVX512F instruction set (64bit x86 only)
2714 avx512bw - implementation using AVX512F & AVX512BW instruction sets (64bit x86 only)
62a65a65
RD
2715 aarch64_neon - implementation using NEON (Aarch64/64 bit ARMv8 only)
2716 aarch64_neonx2 - implementation using NEON with more unrolling (Aarch64/64 bit ARMv8 only)
ab9f4b0b
GN
2717.sp
2718Default value: \fBfastest\fR.
2719.RE
2720
29714574
TF
2721.sp
2722.ne 2
2723.na
2724\fBzfs_zevent_cols\fR (int)
2725.ad
2726.RS 12n
83426735 2727When zevents are logged to the console use this as the word wrap width.
29714574
TF
2728.sp
2729Default value: \fB80\fR.
2730.RE
2731
2732.sp
2733.ne 2
2734.na
2735\fBzfs_zevent_console\fR (int)
2736.ad
2737.RS 12n
2738Log events to the console
2739.sp
2740Use \fB1\fR for yes and \fB0\fR for no (default).
2741.RE
2742
2743.sp
2744.ne 2
2745.na
2746\fBzfs_zevent_len_max\fR (int)
2747.ad
2748.RS 12n
83426735
D
2749Max event queue length. A value of 0 will result in a calculated value which
2750increases with the number of CPUs in the system (minimum 64 events). Events
2751in the queue can be viewed with the \fBzpool events\fR command.
29714574
TF
2752.sp
2753Default value: \fB0\fR.
2754.RE
2755
a032ac4b
BB
2756.sp
2757.ne 2
2758.na
2759\fBzfs_zil_clean_taskq_maxalloc\fR (int)
2760.ad
2761.RS 12n
2762The maximum number of taskq entries that are allowed to be cached. When this
2fe61a7e 2763limit is exceeded transaction records (itxs) will be cleaned synchronously.
a032ac4b
BB
2764.sp
2765Default value: \fB1048576\fR.
2766.RE
2767
2768.sp
2769.ne 2
2770.na
2771\fBzfs_zil_clean_taskq_minalloc\fR (int)
2772.ad
2773.RS 12n
2774The number of taskq entries that are pre-populated when the taskq is first
2775created and are immediately available for use.
2776.sp
2777Default value: \fB1024\fR.
2778.RE
2779
2780.sp
2781.ne 2
2782.na
2783\fBzfs_zil_clean_taskq_nthr_pct\fR (int)
2784.ad
2785.RS 12n
2786This controls the number of threads used by the dp_zil_clean_taskq. The default
2787value of 100% will create a maximum of one thread per cpu.
2788.sp
be54a13c 2789Default value: \fB100\fR%.
a032ac4b
BB
2790.RE
2791
53b1f5ea
PS
2792.sp
2793.ne 2
2794.na
2795\fBzil_nocacheflush\fR (int)
2796.ad
2797.RS 12n
2798Disable the cache flush commands that are normally sent to the disk(s) by
2799the ZIL after an LWB write has completed. Setting this will cause ZIL
2800corruption on power loss if a volatile out-of-order write cache is enabled.
2801.sp
2802Use \fB1\fR for yes and \fB0\fR for no (default).
2803.RE
2804
29714574
TF
2805.sp
2806.ne 2
2807.na
2808\fBzil_replay_disable\fR (int)
2809.ad
2810.RS 12n
83426735
D
2811Disable intent logging replay. Can be disabled for recovery from corrupted
2812ZIL
29714574
TF
2813.sp
2814Use \fB1\fR for yes and \fB0\fR for no (default).
2815.RE
2816
2817.sp
2818.ne 2
2819.na
1b7c1e5c 2820\fBzil_slog_bulk\fR (ulong)
29714574
TF
2821.ad
2822.RS 12n
1b7c1e5c
GDN
2823Limit SLOG write size per commit executed with synchronous priority.
2824Any writes above that will be executed with lower (asynchronous) priority
2825to limit potential SLOG device abuse by single active ZIL writer.
29714574 2826.sp
1b7c1e5c 2827Default value: \fB786,432\fR.
29714574
TF
2828.RE
2829
638dd5f4
TC
2830.sp
2831.ne 2
2832.na
2833\fBzio_deadman_log_all\fR (int)
2834.ad
2835.RS 12n
2836If non-zero, the zio deadman will produce debugging messages (see
2837\fBzfs_dbgmsg_enable\fR) for all zios, rather than only for leaf
2838zios possessing a vdev. This is meant to be used by developers to gain
2839diagnostic information for hang conditions which don't involve a mutex
2840or other locking primitive; typically conditions in which a thread in
2841the zio pipeline is looping indefinitely.
2842.sp
2843Default value: \fB0\fR.
2844.RE
2845
c3bd3fb4
TC
2846.sp
2847.ne 2
2848.na
2849\fBzio_decompress_fail_fraction\fR (int)
2850.ad
2851.RS 12n
2852If non-zero, this value represents the denominator of the probability that zfs
2853should induce a decompression failure. For instance, for a 5% decompression
2854failure rate, this value should be set to 20.
2855.sp
2856Default value: \fB0\fR.
2857.RE
2858
29714574
TF
2859.sp
2860.ne 2
2861.na
ad796b8a 2862\fBzio_slow_io_ms\fR (int)
29714574
TF
2863.ad
2864.RS 12n
ad796b8a
TH
2865When an I/O operation takes more than \fBzio_slow_io_ms\fR milliseconds to
2866complete is marked as a slow I/O. Each slow I/O causes a delay zevent. Slow
2867I/O counters can be seen with "zpool status -s".
2868
29714574
TF
2869.sp
2870Default value: \fB30,000\fR.
2871.RE
2872
3dfb57a3
DB
2873.sp
2874.ne 2
2875.na
2876\fBzio_dva_throttle_enabled\fR (int)
2877.ad
2878.RS 12n
ad796b8a 2879Throttle block allocations in the I/O pipeline. This allows for
3dfb57a3 2880dynamic allocation distribution when devices are imbalanced.
e815485f
TC
2881When enabled, the maximum number of pending allocations per top-level vdev
2882is limited by \fBzfs_vdev_queue_depth_pct\fR.
3dfb57a3 2883.sp
27f2b90d 2884Default value: \fB1\fR.
3dfb57a3
DB
2885.RE
2886
29714574
TF
2887.sp
2888.ne 2
2889.na
2890\fBzio_requeue_io_start_cut_in_line\fR (int)
2891.ad
2892.RS 12n
2893Prioritize requeued I/O
2894.sp
2895Default value: \fB0\fR.
2896.RE
2897
dcb6bed1
D
2898.sp
2899.ne 2
2900.na
2901\fBzio_taskq_batch_pct\fR (uint)
2902.ad
2903.RS 12n
2904Percentage of online CPUs (or CPU cores, etc) which will run a worker thread
ad796b8a 2905for I/O. These workers are responsible for I/O work such as compression and
dcb6bed1
D
2906checksum calculations. Fractional number of CPUs will be rounded down.
2907.sp
2908The default value of 75 was chosen to avoid using all CPUs which can result in
2909latency issues and inconsistent application performance, especially when high
2910compression is enabled.
2911.sp
2912Default value: \fB75\fR.
2913.RE
2914
29714574
TF
2915.sp
2916.ne 2
2917.na
2918\fBzvol_inhibit_dev\fR (uint)
2919.ad
2920.RS 12n
83426735
D
2921Do not create zvol device nodes. This may slightly improve startup time on
2922systems with a very large number of zvols.
29714574
TF
2923.sp
2924Use \fB1\fR for yes and \fB0\fR for no (default).
2925.RE
2926
2927.sp
2928.ne 2
2929.na
2930\fBzvol_major\fR (uint)
2931.ad
2932.RS 12n
83426735 2933Major number for zvol block devices
29714574
TF
2934.sp
2935Default value: \fB230\fR.
2936.RE
2937
2938.sp
2939.ne 2
2940.na
2941\fBzvol_max_discard_blocks\fR (ulong)
2942.ad
2943.RS 12n
83426735
D
2944Discard (aka TRIM) operations done on zvols will be done in batches of this
2945many blocks, where block size is determined by the \fBvolblocksize\fR property
2946of a zvol.
29714574
TF
2947.sp
2948Default value: \fB16,384\fR.
2949.RE
2950
9965059a
BB
2951.sp
2952.ne 2
2953.na
2954\fBzvol_prefetch_bytes\fR (uint)
2955.ad
2956.RS 12n
2957When adding a zvol to the system prefetch \fBzvol_prefetch_bytes\fR
2958from the start and end of the volume. Prefetching these regions
2959of the volume is desirable because they are likely to be accessed
2960immediately by \fBblkid(8)\fR or by the kernel scanning for a partition
2961table.
2962.sp
2963Default value: \fB131,072\fR.
2964.RE
2965
692e55b8
CC
2966.sp
2967.ne 2
2968.na
2969\fBzvol_request_sync\fR (uint)
2970.ad
2971.RS 12n
2972When processing I/O requests for a zvol submit them synchronously. This
2973effectively limits the queue depth to 1 for each I/O submitter. When set
2974to 0 requests are handled asynchronously by a thread pool. The number of
2975requests which can be handled concurrently is controller by \fBzvol_threads\fR.
2976.sp
8fa5250f 2977Default value: \fB0\fR.
692e55b8
CC
2978.RE
2979
2980.sp
2981.ne 2
2982.na
2983\fBzvol_threads\fR (uint)
2984.ad
2985.RS 12n
2986Max number of threads which can handle zvol I/O requests concurrently.
2987.sp
2988Default value: \fB32\fR.
2989.RE
2990
cf8738d8 2991.sp
2992.ne 2
2993.na
2994\fBzvol_volmode\fR (uint)
2995.ad
2996.RS 12n
2997Defines zvol block devices behaviour when \fBvolmode\fR is set to \fBdefault\fR.
2998Valid values are \fB1\fR (full), \fB2\fR (dev) and \fB3\fR (none).
2999.sp
3000Default value: \fB1\fR.
3001.RE
3002
e8b96c60
MA
3003.SH ZFS I/O SCHEDULER
3004ZFS issues I/O operations to leaf vdevs to satisfy and complete I/Os.
3005The I/O scheduler determines when and in what order those operations are
3006issued. The I/O scheduler divides operations into five I/O classes
3007prioritized in the following order: sync read, sync write, async read,
3008async write, and scrub/resilver. Each queue defines the minimum and
3009maximum number of concurrent operations that may be issued to the
3010device. In addition, the device has an aggregate maximum,
3011\fBzfs_vdev_max_active\fR. Note that the sum of the per-queue minimums
3012must not exceed the aggregate maximum. If the sum of the per-queue
3013maximums exceeds the aggregate maximum, then the number of active I/Os
3014may reach \fBzfs_vdev_max_active\fR, in which case no further I/Os will
3015be issued regardless of whether all per-queue minimums have been met.
3016.sp
3017For many physical devices, throughput increases with the number of
3018concurrent operations, but latency typically suffers. Further, physical
3019devices typically have a limit at which more concurrent operations have no
3020effect on throughput or can actually cause it to decrease.
3021.sp
3022The scheduler selects the next operation to issue by first looking for an
3023I/O class whose minimum has not been satisfied. Once all are satisfied and
3024the aggregate maximum has not been hit, the scheduler looks for classes
3025whose maximum has not been satisfied. Iteration through the I/O classes is
3026done in the order specified above. No further operations are issued if the
3027aggregate maximum number of concurrent operations has been hit or if there
3028are no operations queued for an I/O class that has not hit its maximum.
3029Every time an I/O is queued or an operation completes, the I/O scheduler
3030looks for new operations to issue.
3031.sp
3032In general, smaller max_active's will lead to lower latency of synchronous
3033operations. Larger max_active's may lead to higher overall throughput,
3034depending on underlying storage.
3035.sp
3036The ratio of the queues' max_actives determines the balance of performance
3037between reads, writes, and scrubs. E.g., increasing
3038\fBzfs_vdev_scrub_max_active\fR will cause the scrub or resilver to complete
3039more quickly, but reads and writes to have higher latency and lower throughput.
3040.sp
3041All I/O classes have a fixed maximum number of outstanding operations
3042except for the async write class. Asynchronous writes represent the data
3043that is committed to stable storage during the syncing stage for
3044transaction groups. Transaction groups enter the syncing state
3045periodically so the number of queued async writes will quickly burst up
3046and then bleed down to zero. Rather than servicing them as quickly as
3047possible, the I/O scheduler changes the maximum number of active async
3048write I/Os according to the amount of dirty data in the pool. Since
3049both throughput and latency typically increase with the number of
3050concurrent operations issued to physical devices, reducing the
3051burstiness in the number of concurrent operations also stabilizes the
3052response time of operations from other -- and in particular synchronous
3053-- queues. In broad strokes, the I/O scheduler will issue more
3054concurrent operations from the async write queue as there's more dirty
3055data in the pool.
3056.sp
3057Async Writes
3058.sp
3059The number of concurrent operations issued for the async write I/O class
3060follows a piece-wise linear function defined by a few adjustable points.
3061.nf
3062
3063 | o---------| <-- zfs_vdev_async_write_max_active
3064 ^ | /^ |
3065 | | / | |
3066active | / | |
3067 I/O | / | |
3068count | / | |
3069 | / | |
3070 |-------o | | <-- zfs_vdev_async_write_min_active
3071 0|_______^______|_________|
3072 0% | | 100% of zfs_dirty_data_max
3073 | |
3074 | `-- zfs_vdev_async_write_active_max_dirty_percent
3075 `--------- zfs_vdev_async_write_active_min_dirty_percent
3076
3077.fi
3078Until the amount of dirty data exceeds a minimum percentage of the dirty
3079data allowed in the pool, the I/O scheduler will limit the number of
3080concurrent operations to the minimum. As that threshold is crossed, the
3081number of concurrent operations issued increases linearly to the maximum at
3082the specified maximum percentage of the dirty data allowed in the pool.
3083.sp
3084Ideally, the amount of dirty data on a busy pool will stay in the sloped
3085part of the function between \fBzfs_vdev_async_write_active_min_dirty_percent\fR
3086and \fBzfs_vdev_async_write_active_max_dirty_percent\fR. If it exceeds the
3087maximum percentage, this indicates that the rate of incoming data is
3088greater than the rate that the backend storage can handle. In this case, we
3089must further throttle incoming writes, as described in the next section.
3090
3091.SH ZFS TRANSACTION DELAY
3092We delay transactions when we've determined that the backend storage
3093isn't able to accommodate the rate of incoming writes.
3094.sp
3095If there is already a transaction waiting, we delay relative to when
3096that transaction will finish waiting. This way the calculated delay time
3097is independent of the number of threads concurrently executing
3098transactions.
3099.sp
3100If we are the only waiter, wait relative to when the transaction
3101started, rather than the current time. This credits the transaction for
3102"time already served", e.g. reading indirect blocks.
3103.sp
3104The minimum time for a transaction to take is calculated as:
3105.nf
3106 min_time = zfs_delay_scale * (dirty - min) / (max - dirty)
3107 min_time is then capped at 100 milliseconds.
3108.fi
3109.sp
3110The delay has two degrees of freedom that can be adjusted via tunables. The
3111percentage of dirty data at which we start to delay is defined by
3112\fBzfs_delay_min_dirty_percent\fR. This should typically be at or above
3113\fBzfs_vdev_async_write_active_max_dirty_percent\fR so that we only start to
3114delay after writing at full speed has failed to keep up with the incoming write
3115rate. The scale of the curve is defined by \fBzfs_delay_scale\fR. Roughly speaking,
3116this variable determines the amount of delay at the midpoint of the curve.
3117.sp
3118.nf
3119delay
3120 10ms +-------------------------------------------------------------*+
3121 | *|
3122 9ms + *+
3123 | *|
3124 8ms + *+
3125 | * |
3126 7ms + * +
3127 | * |
3128 6ms + * +
3129 | * |
3130 5ms + * +
3131 | * |
3132 4ms + * +
3133 | * |
3134 3ms + * +
3135 | * |
3136 2ms + (midpoint) * +
3137 | | ** |
3138 1ms + v *** +
3139 | zfs_delay_scale ----------> ******** |
3140 0 +-------------------------------------*********----------------+
3141 0% <- zfs_dirty_data_max -> 100%
3142.fi
3143.sp
3144Note that since the delay is added to the outstanding time remaining on the
3145most recent transaction, the delay is effectively the inverse of IOPS.
3146Here the midpoint of 500us translates to 2000 IOPS. The shape of the curve
3147was chosen such that small changes in the amount of accumulated dirty data
3148in the first 3/4 of the curve yield relatively small differences in the
3149amount of delay.
3150.sp
3151The effects can be easier to understand when the amount of delay is
3152represented on a log scale:
3153.sp
3154.nf
3155delay
3156100ms +-------------------------------------------------------------++
3157 + +
3158 | |
3159 + *+
3160 10ms + *+
3161 + ** +
3162 | (midpoint) ** |
3163 + | ** +
3164 1ms + v **** +
3165 + zfs_delay_scale ----------> ***** +
3166 | **** |
3167 + **** +
3168100us + ** +
3169 + * +
3170 | * |
3171 + * +
3172 10us + * +
3173 + +
3174 | |
3175 + +
3176 +--------------------------------------------------------------+
3177 0% <- zfs_dirty_data_max -> 100%
3178.fi
3179.sp
3180Note here that only as the amount of dirty data approaches its limit does
3181the delay start to increase rapidly. The goal of a properly tuned system
3182should be to keep the amount of dirty data out of that range by first
3183ensuring that the appropriate limits are set for the I/O scheduler to reach
3184optimal throughput on the backend storage, and then by changing the value
3185of \fBzfs_delay_scale\fR to increase the steepness of the curve.