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