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