]> git.proxmox.com Git - mirror_zfs.git/blame - man/man5/zfs-module-parameters.5
OpenZFS 6410 - teach zdb to perform object lookups by path
[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.
3.\" The contents of this file are subject to the terms of the Common Development
4.\" and Distribution License (the "License"). You may not use this file except
5.\" in compliance with the License. You can obtain a copy of the license at
6.\" usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
7.\"
8.\" See the License for the specific language governing permissions and
9.\" limitations under the License. When distributing Covered Code, include this
10.\" CDDL HEADER in each file and include the License file at
11.\" usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this
12.\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your
13.\" own identifying information:
14.\" Portions Copyright [yyyy] [name of copyright owner]
15.TH ZFS-MODULE-PARAMETERS 5 "Nov 16, 2013"
16.SH NAME
17zfs\-module\-parameters \- ZFS module parameters
18.SH DESCRIPTION
19.sp
20.LP
21Description of the different parameters to the ZFS module.
22
23.SS "Module parameters"
24.sp
25.LP
26
6d836e6f
RE
27.sp
28.ne 2
29.na
30\fBignore_hole_birth\fR (int)
31.ad
32.RS 12n
33When set, the hole_birth optimization will not be used, and all holes will
34always be sent on zfs send. Useful if you suspect your datasets are affected
35by a bug in hole_birth.
36.sp
9ea9e0b9 37Use \fB1\fR for on (default) and \fB0\fR for off.
6d836e6f
RE
38.RE
39
29714574
TF
40.sp
41.ne 2
42.na
43\fBl2arc_feed_again\fR (int)
44.ad
45.RS 12n
83426735
D
46Turbo L2ARC warm-up. When the L2ARC is cold the fill interval will be set as
47fast as possible.
29714574
TF
48.sp
49Use \fB1\fR for yes (default) and \fB0\fR to disable.
50.RE
51
52.sp
53.ne 2
54.na
55\fBl2arc_feed_min_ms\fR (ulong)
56.ad
57.RS 12n
83426735
D
58Min feed interval in milliseconds. Requires \fBl2arc_feed_again=1\fR and only
59applicable in related situations.
29714574
TF
60.sp
61Default value: \fB200\fR.
62.RE
63
64.sp
65.ne 2
66.na
67\fBl2arc_feed_secs\fR (ulong)
68.ad
69.RS 12n
70Seconds between L2ARC writing
71.sp
72Default value: \fB1\fR.
73.RE
74
75.sp
76.ne 2
77.na
78\fBl2arc_headroom\fR (ulong)
79.ad
80.RS 12n
83426735
D
81How far through the ARC lists to search for L2ARC cacheable content, expressed
82as a multiplier of \fBl2arc_write_max\fR
29714574
TF
83.sp
84Default value: \fB2\fR.
85.RE
86
87.sp
88.ne 2
89.na
90\fBl2arc_headroom_boost\fR (ulong)
91.ad
92.RS 12n
83426735
D
93Scales \fBl2arc_headroom\fR by this percentage when L2ARC contents are being
94successfully compressed before writing. A value of 100 disables this feature.
29714574
TF
95.sp
96Default value: \fB200\fR.
97.RE
98
99.sp
100.ne 2
101.na
102\fBl2arc_nocompress\fR (int)
103.ad
104.RS 12n
105Skip compressing L2ARC buffers
106.sp
107Use \fB1\fR for yes and \fB0\fR for no (default).
108.RE
109
110.sp
111.ne 2
112.na
113\fBl2arc_noprefetch\fR (int)
114.ad
115.RS 12n
83426735
D
116Do not write buffers to L2ARC if they were prefetched but not used by
117applications
29714574
TF
118.sp
119Use \fB1\fR for yes (default) and \fB0\fR to disable.
120.RE
121
122.sp
123.ne 2
124.na
125\fBl2arc_norw\fR (int)
126.ad
127.RS 12n
128No reads during writes
129.sp
130Use \fB1\fR for yes and \fB0\fR for no (default).
131.RE
132
133.sp
134.ne 2
135.na
136\fBl2arc_write_boost\fR (ulong)
137.ad
138.RS 12n
83426735
D
139Cold L2ARC devices will have \fBl2arc_write_nax\fR increased by this amount
140while they remain cold.
29714574
TF
141.sp
142Default value: \fB8,388,608\fR.
143.RE
144
145.sp
146.ne 2
147.na
148\fBl2arc_write_max\fR (ulong)
149.ad
150.RS 12n
151Max write bytes per interval
152.sp
153Default value: \fB8,388,608\fR.
154.RE
155
99b14de4
ED
156.sp
157.ne 2
158.na
159\fBmetaslab_aliquot\fR (ulong)
160.ad
161.RS 12n
162Metaslab granularity, in bytes. This is roughly similar to what would be
163referred to as the "stripe size" in traditional RAID arrays. In normal
164operation, ZFS will try to write this amount of data to a top-level vdev
165before moving on to the next one.
166.sp
167Default value: \fB524,288\fR.
168.RE
169
f3a7f661
GW
170.sp
171.ne 2
172.na
173\fBmetaslab_bias_enabled\fR (int)
174.ad
175.RS 12n
176Enable metaslab group biasing based on its vdev's over- or under-utilization
177relative to the pool.
178.sp
179Use \fB1\fR for yes (default) and \fB0\fR for no.
180.RE
181
4e21fd06
DB
182.sp
183.ne 2
184.na
185\fBzfs_metaslab_segment_weight_enabled\fR (int)
186.ad
187.RS 12n
188Enable/disable segment-based metaslab selection.
189.sp
190Use \fB1\fR for yes (default) and \fB0\fR for no.
191.RE
192
193.sp
194.ne 2
195.na
196\fBzfs_metaslab_switch_threshold\fR (int)
197.ad
198.RS 12n
199When using segment-based metaslab selection, continue allocating
200from the active metaslab until \fBlzfs_metaslab_switch_threshold\fR
201worth of buckets have been exhausted.
202.sp
203Default value: \fB2\fR.
204.RE
205
29714574
TF
206.sp
207.ne 2
208.na
aa7d06a9 209\fBmetaslab_debug_load\fR (int)
29714574
TF
210.ad
211.RS 12n
aa7d06a9
GW
212Load all metaslabs during pool import.
213.sp
214Use \fB1\fR for yes and \fB0\fR for no (default).
215.RE
216
217.sp
218.ne 2
219.na
220\fBmetaslab_debug_unload\fR (int)
221.ad
222.RS 12n
223Prevent metaslabs from being unloaded.
29714574
TF
224.sp
225Use \fB1\fR for yes and \fB0\fR for no (default).
226.RE
227
f3a7f661
GW
228.sp
229.ne 2
230.na
231\fBmetaslab_fragmentation_factor_enabled\fR (int)
232.ad
233.RS 12n
234Enable use of the fragmentation metric in computing metaslab weights.
235.sp
236Use \fB1\fR for yes (default) and \fB0\fR for no.
237.RE
238
b8bcca18
MA
239.sp
240.ne 2
241.na
242\fBmetaslabs_per_vdev\fR (int)
243.ad
244.RS 12n
245When a vdev is added, it will be divided into approximately (but no more than) this number of metaslabs.
246.sp
247Default value: \fB200\fR.
248.RE
249
f3a7f661
GW
250.sp
251.ne 2
252.na
253\fBmetaslab_preload_enabled\fR (int)
254.ad
255.RS 12n
256Enable metaslab group preloading.
257.sp
258Use \fB1\fR for yes (default) and \fB0\fR for no.
259.RE
260
261.sp
262.ne 2
263.na
264\fBmetaslab_lba_weighting_enabled\fR (int)
265.ad
266.RS 12n
267Give more weight to metaslabs with lower LBAs, assuming they have
268greater bandwidth as is typically the case on a modern constant
269angular velocity disk drive.
270.sp
271Use \fB1\fR for yes (default) and \fB0\fR for no.
272.RE
273
29714574
TF
274.sp
275.ne 2
276.na
277\fBspa_config_path\fR (charp)
278.ad
279.RS 12n
280SPA config file
281.sp
282Default value: \fB/etc/zfs/zpool.cache\fR.
283.RE
284
e8b96c60
MA
285.sp
286.ne 2
287.na
288\fBspa_asize_inflation\fR (int)
289.ad
290.RS 12n
291Multiplication factor used to estimate actual disk consumption from the
292size of data being written. The default value is a worst case estimate,
293but lower values may be valid for a given pool depending on its
294configuration. Pool administrators who understand the factors involved
295may wish to specify a more realistic inflation factor, particularly if
296they operate close to quota or capacity limits.
297.sp
83426735 298Default value: \fB24\fR.
e8b96c60
MA
299.RE
300
dea377c0
MA
301.sp
302.ne 2
303.na
304\fBspa_load_verify_data\fR (int)
305.ad
306.RS 12n
307Whether to traverse data blocks during an "extreme rewind" (\fB-X\fR)
308import. Use 0 to disable and 1 to enable.
309
310An extreme rewind import normally performs a full traversal of all
311blocks in the pool for verification. If this parameter is set to 0,
312the traversal skips non-metadata blocks. It can be toggled once the
313import has started to stop or start the traversal of non-metadata blocks.
314.sp
83426735 315Default value: \fB1\fR.
dea377c0
MA
316.RE
317
318.sp
319.ne 2
320.na
321\fBspa_load_verify_metadata\fR (int)
322.ad
323.RS 12n
324Whether to traverse blocks during an "extreme rewind" (\fB-X\fR)
325pool import. Use 0 to disable and 1 to enable.
326
327An extreme rewind import normally performs a full traversal of all
1c012083 328blocks in the pool for verification. If this parameter is set to 0,
dea377c0
MA
329the traversal is not performed. It can be toggled once the import has
330started to stop or start the traversal.
331.sp
83426735 332Default value: \fB1\fR.
dea377c0
MA
333.RE
334
335.sp
336.ne 2
337.na
338\fBspa_load_verify_maxinflight\fR (int)
339.ad
340.RS 12n
341Maximum concurrent I/Os during the traversal performed during an "extreme
342rewind" (\fB-X\fR) pool import.
343.sp
83426735 344Default value: \fB10000\fR.
dea377c0
MA
345.RE
346
6cde6435
BB
347.sp
348.ne 2
349.na
350\fBspa_slop_shift\fR (int)
351.ad
352.RS 12n
353Normally, we don't allow the last 3.2% (1/(2^spa_slop_shift)) of space
354in the pool to be consumed. This ensures that we don't run the pool
355completely out of space, due to unaccounted changes (e.g. to the MOS).
356It also limits the worst-case time to allocate space. If we have
357less than this amount of free space, most ZPL operations (e.g. write,
358create) will return ENOSPC.
359.sp
83426735 360Default value: \fB5\fR.
6cde6435
BB
361.RE
362
29714574
TF
363.sp
364.ne 2
365.na
366\fBzfetch_array_rd_sz\fR (ulong)
367.ad
368.RS 12n
27b293be 369If prefetching is enabled, disable prefetching for reads larger than this size.
29714574
TF
370.sp
371Default value: \fB1,048,576\fR.
372.RE
373
374.sp
375.ne 2
376.na
7f60329a 377\fBzfetch_max_distance\fR (uint)
29714574
TF
378.ad
379.RS 12n
7f60329a 380Max bytes to prefetch per stream (default 8MB).
29714574 381.sp
7f60329a 382Default value: \fB8,388,608\fR.
29714574
TF
383.RE
384
385.sp
386.ne 2
387.na
388\fBzfetch_max_streams\fR (uint)
389.ad
390.RS 12n
27b293be 391Max number of streams per zfetch (prefetch streams per file).
29714574
TF
392.sp
393Default value: \fB8\fR.
394.RE
395
396.sp
397.ne 2
398.na
399\fBzfetch_min_sec_reap\fR (uint)
400.ad
401.RS 12n
27b293be 402Min time before an active prefetch stream can be reclaimed
29714574
TF
403.sp
404Default value: \fB2\fR.
405.RE
406
25458cbe
TC
407.sp
408.ne 2
409.na
410\fBzfs_arc_dnode_limit\fR (ulong)
411.ad
412.RS 12n
413When the number of bytes consumed by dnodes in the ARC exceeds this number of
9907cc1c
G
414bytes, try to unpin some of it in response to demand for non-metadata. This
415value acts as a floor to the amount of dnode metadata, and defaults to 0 which
416indicates that a percent which is based on \fBzfs_arc_dnode_limit_percent\fR of
417the ARC meta buffers that may be used for dnodes.
25458cbe
TC
418
419See also \fBzfs_arc_meta_prune\fR which serves a similar purpose but is used
420when the amount of metadata in the ARC exceeds \fBzfs_arc_meta_limit\fR rather
421than in response to overall demand for non-metadata.
422
423.sp
9907cc1c
G
424Default value: \fB0\fR.
425.RE
426
427.sp
428.ne 2
429.na
430\fBzfs_arc_dnode_limit_percent\fR (ulong)
431.ad
432.RS 12n
433Percentage that can be consumed by dnodes of ARC meta buffers.
434.sp
435See also \fBzfs_arc_dnode_limit\fR which serves a similar purpose but has a
436higher priority if set to nonzero value.
437.sp
438Default value: \fB10\fR.
25458cbe
TC
439.RE
440
441.sp
442.ne 2
443.na
444\fBzfs_arc_dnode_reduce_percent\fR (ulong)
445.ad
446.RS 12n
447Percentage of ARC dnodes to try to scan in response to demand for non-metadata
6146e17e 448when the number of bytes consumed by dnodes exceeds \fBzfs_arc_dnode_limit\fR.
25458cbe
TC
449
450.sp
451Default value: \fB10% of the number of dnodes in the ARC\fR.
452.RE
453
49ddb315
MA
454.sp
455.ne 2
456.na
457\fBzfs_arc_average_blocksize\fR (int)
458.ad
459.RS 12n
460The ARC's buffer hash table is sized based on the assumption of an average
461block size of \fBzfs_arc_average_blocksize\fR (default 8K). This works out
462to roughly 1MB of hash table per 1GB of physical memory with 8-byte pointers.
463For configurations with a known larger average block size this value can be
464increased to reduce the memory footprint.
465
466.sp
467Default value: \fB8192\fR.
468.RE
469
ca0bf58d
PS
470.sp
471.ne 2
472.na
473\fBzfs_arc_evict_batch_limit\fR (int)
474.ad
475.RS 12n
8f343973 476Number ARC headers to evict per sub-list before proceeding to another sub-list.
ca0bf58d
PS
477This batch-style operation prevents entire sub-lists from being evicted at once
478but comes at a cost of additional unlocking and locking.
479.sp
480Default value: \fB10\fR.
481.RE
482
29714574
TF
483.sp
484.ne 2
485.na
486\fBzfs_arc_grow_retry\fR (int)
487.ad
488.RS 12n
83426735
D
489After a memory pressure event the ARC will wait this many seconds before trying
490to resume growth
29714574
TF
491.sp
492Default value: \fB5\fR.
493.RE
494
495.sp
496.ne 2
497.na
7e8bddd0 498\fBzfs_arc_lotsfree_percent\fR (int)
29714574
TF
499.ad
500.RS 12n
7e8bddd0
BB
501Throttle I/O when free system memory drops below this percentage of total
502system memory. Setting this value to 0 will disable the throttle.
29714574 503.sp
7e8bddd0 504Default value: \fB10\fR.
29714574
TF
505.RE
506
507.sp
508.ne 2
509.na
7e8bddd0 510\fBzfs_arc_max\fR (ulong)
29714574
TF
511.ad
512.RS 12n
83426735
D
513Max arc size of ARC in bytes. If set to 0 then it will consume 1/2 of system
514RAM. This value must be at least 67108864 (64 megabytes).
515.sp
516This value can be changed dynamically with some caveats. It cannot be set back
517to 0 while running and reducing it below the current ARC size will not cause
518the ARC to shrink without memory pressure to induce shrinking.
29714574 519.sp
7e8bddd0 520Default value: \fB0\fR.
29714574
TF
521.RE
522
523.sp
524.ne 2
525.na
526\fBzfs_arc_meta_limit\fR (ulong)
527.ad
528.RS 12n
2cbb06b5
BB
529The maximum allowed size in bytes that meta data buffers are allowed to
530consume in the ARC. When this limit is reached meta data buffers will
531be reclaimed even if the overall arc_c_max has not been reached. This
9907cc1c
G
532value defaults to 0 which indicates that a percent which is based on
533\fBzfs_arc_meta_limit_percent\fR of the ARC may be used for meta data.
29714574 534.sp
83426735 535This value my be changed dynamically except that it cannot be set back to 0
9907cc1c 536for a specific percent of the ARC; it must be set to an explicit value.
83426735 537.sp
29714574
TF
538Default value: \fB0\fR.
539.RE
540
9907cc1c
G
541.sp
542.ne 2
543.na
544\fBzfs_arc_meta_limit_percent\fR (ulong)
545.ad
546.RS 12n
547Percentage of ARC buffers that can be used for meta data.
548
549See also \fBzfs_arc_meta_limit\fR which serves a similar purpose but has a
550higher priority if set to nonzero value.
551
552.sp
553Default value: \fB75\fR.
554.RE
555
ca0bf58d
PS
556.sp
557.ne 2
558.na
559\fBzfs_arc_meta_min\fR (ulong)
560.ad
561.RS 12n
562The minimum allowed size in bytes that meta data buffers may consume in
563the ARC. This value defaults to 0 which disables a floor on the amount
564of the ARC devoted meta data.
565.sp
566Default value: \fB0\fR.
567.RE
568
29714574
TF
569.sp
570.ne 2
571.na
572\fBzfs_arc_meta_prune\fR (int)
573.ad
574.RS 12n
2cbb06b5
BB
575The number of dentries and inodes to be scanned looking for entries
576which can be dropped. This may be required when the ARC reaches the
577\fBzfs_arc_meta_limit\fR because dentries and inodes can pin buffers
578in the ARC. Increasing this value will cause to dentry and inode caches
579to be pruned more aggressively. Setting this value to 0 will disable
580pruning the inode and dentry caches.
29714574 581.sp
2cbb06b5 582Default value: \fB10,000\fR.
29714574
TF
583.RE
584
bc888666
BB
585.sp
586.ne 2
587.na
588\fBzfs_arc_meta_adjust_restarts\fR (ulong)
589.ad
590.RS 12n
591The number of restart passes to make while scanning the ARC attempting
592the free buffers in order to stay below the \fBzfs_arc_meta_limit\fR.
593This value should not need to be tuned but is available to facilitate
594performance analysis.
595.sp
596Default value: \fB4096\fR.
597.RE
598
29714574
TF
599.sp
600.ne 2
601.na
602\fBzfs_arc_min\fR (ulong)
603.ad
604.RS 12n
605Min arc size
606.sp
607Default value: \fB100\fR.
608.RE
609
610.sp
611.ne 2
612.na
613\fBzfs_arc_min_prefetch_lifespan\fR (int)
614.ad
615.RS 12n
83426735
D
616Minimum time prefetched blocks are locked in the ARC, specified in jiffies.
617A value of 0 will default to 1 second.
29714574 618.sp
83426735 619Default value: \fB0\fR.
29714574
TF
620.RE
621
ca0bf58d
PS
622.sp
623.ne 2
624.na
c30e58c4 625\fBzfs_multilist_num_sublists\fR (int)
ca0bf58d
PS
626.ad
627.RS 12n
628To allow more fine-grained locking, each ARC state contains a series
629of lists for both data and meta data objects. Locking is performed at
630the level of these "sub-lists". This parameters controls the number of
c30e58c4
MA
631sub-lists per ARC state, and also applies to other uses of the
632multilist data structure.
ca0bf58d 633.sp
c30e58c4 634Default value: \fB4\fR or the number of online CPUs, whichever is greater
ca0bf58d
PS
635.RE
636
637.sp
638.ne 2
639.na
640\fBzfs_arc_overflow_shift\fR (int)
641.ad
642.RS 12n
643The ARC size is considered to be overflowing if it exceeds the current
644ARC target size (arc_c) by a threshold determined by this parameter.
645The threshold is calculated as a fraction of arc_c using the formula
646"arc_c >> \fBzfs_arc_overflow_shift\fR".
647
648The default value of 8 causes the ARC to be considered to be overflowing
649if it exceeds the target size by 1/256th (0.3%) of the target size.
650
651When the ARC is overflowing, new buffer allocations are stalled until
652the reclaim thread catches up and the overflow condition no longer exists.
653.sp
654Default value: \fB8\fR.
655.RE
656
728d6ae9
BB
657.sp
658.ne 2
659.na
660
661\fBzfs_arc_p_min_shift\fR (int)
662.ad
663.RS 12n
664arc_c shift to calc min/max arc_p
665.sp
666Default value: \fB4\fR.
667.RE
668
89c8cac4
PS
669.sp
670.ne 2
671.na
672\fBzfs_arc_p_aggressive_disable\fR (int)
673.ad
674.RS 12n
675Disable aggressive arc_p growth
676.sp
677Use \fB1\fR for yes (default) and \fB0\fR to disable.
678.RE
679
62422785
PS
680.sp
681.ne 2
682.na
683\fBzfs_arc_p_dampener_disable\fR (int)
684.ad
685.RS 12n
686Disable arc_p adapt dampener
687.sp
688Use \fB1\fR for yes (default) and \fB0\fR to disable.
689.RE
690
29714574
TF
691.sp
692.ne 2
693.na
694\fBzfs_arc_shrink_shift\fR (int)
695.ad
696.RS 12n
697log2(fraction of arc to reclaim)
698.sp
699Default value: \fB5\fR.
700.RE
701
11f552fa
BB
702.sp
703.ne 2
704.na
705\fBzfs_arc_sys_free\fR (ulong)
706.ad
707.RS 12n
708The target number of bytes the ARC should leave as free memory on the system.
709Defaults to the larger of 1/64 of physical memory or 512K. Setting this
710option to a non-zero value will override the default.
711.sp
712Default value: \fB0\fR.
713.RE
714
29714574
TF
715.sp
716.ne 2
717.na
718\fBzfs_autoimport_disable\fR (int)
719.ad
720.RS 12n
27b293be 721Disable pool import at module load by ignoring the cache file (typically \fB/etc/zfs/zpool.cache\fR).
29714574 722.sp
70081096 723Use \fB1\fR for yes (default) and \fB0\fR for no.
29714574
TF
724.RE
725
3b36f831
BB
726.sp
727.ne 2
728.na
729\fBzfs_dbgmsg_enable\fR (int)
730.ad
731.RS 12n
732Internally ZFS keeps a small log to facilitate debugging. By default the log
733is disabled, to enable it set this option to 1. The contents of the log can
734be accessed by reading the /proc/spl/kstat/zfs/dbgmsg file. Writing 0 to
735this proc file clears the log.
736.sp
737Default value: \fB0\fR.
738.RE
739
740.sp
741.ne 2
742.na
743\fBzfs_dbgmsg_maxsize\fR (int)
744.ad
745.RS 12n
746The maximum size in bytes of the internal ZFS debug log.
747.sp
748Default value: \fB4M\fR.
749.RE
750
29714574
TF
751.sp
752.ne 2
753.na
754\fBzfs_dbuf_state_index\fR (int)
755.ad
756.RS 12n
83426735
D
757This feature is currently unused. It is normally used for controlling what
758reporting is available under /proc/spl/kstat/zfs.
29714574
TF
759.sp
760Default value: \fB0\fR.
761.RE
762
763.sp
764.ne 2
765.na
766\fBzfs_deadman_enabled\fR (int)
767.ad
768.RS 12n
b81a3ddc
TC
769When a pool sync operation takes longer than \fBzfs_deadman_synctime_ms\fR
770milliseconds, a "slow spa_sync" message is logged to the debug log
771(see \fBzfs_dbgmsg_enable\fR). If \fBzfs_deadman_enabled\fR is set,
772all pending IO operations are also checked and if any haven't completed
773within \fBzfs_deadman_synctime_ms\fR milliseconds, a "SLOW IO" message
774is logged to the debug log and a "delay" system event with the details of
775the hung IO is posted.
29714574 776.sp
b81a3ddc
TC
777Use \fB1\fR (default) to enable the slow IO check and \fB0\fR to disable.
778.RE
779
780.sp
781.ne 2
782.na
783\fBzfs_deadman_checktime_ms\fR (int)
784.ad
785.RS 12n
786Once a pool sync operation has taken longer than
787\fBzfs_deadman_synctime_ms\fR milliseconds, continue to check for slow
788operations every \fBzfs_deadman_checktime_ms\fR milliseconds.
789.sp
790Default value: \fB5,000\fR.
29714574
TF
791.RE
792
793.sp
794.ne 2
795.na
e8b96c60 796\fBzfs_deadman_synctime_ms\fR (ulong)
29714574
TF
797.ad
798.RS 12n
b81a3ddc
TC
799Interval in milliseconds after which the deadman is triggered and also
800the interval after which an IO operation is considered to be "hung"
801if \fBzfs_deadman_enabled\fR is set.
802
803See \fBzfs_deadman_enabled\fR.
29714574 804.sp
e8b96c60 805Default value: \fB1,000,000\fR.
29714574
TF
806.RE
807
808.sp
809.ne 2
810.na
811\fBzfs_dedup_prefetch\fR (int)
812.ad
813.RS 12n
814Enable prefetching dedup-ed blks
815.sp
0dfc7324 816Use \fB1\fR for yes and \fB0\fR to disable (default).
29714574
TF
817.RE
818
e8b96c60
MA
819.sp
820.ne 2
821.na
822\fBzfs_delay_min_dirty_percent\fR (int)
823.ad
824.RS 12n
825Start to delay each transaction once there is this amount of dirty data,
826expressed as a percentage of \fBzfs_dirty_data_max\fR.
827This value should be >= zfs_vdev_async_write_active_max_dirty_percent.
828See the section "ZFS TRANSACTION DELAY".
829.sp
830Default value: \fB60\fR.
831.RE
832
833.sp
834.ne 2
835.na
836\fBzfs_delay_scale\fR (int)
837.ad
838.RS 12n
839This controls how quickly the transaction delay approaches infinity.
840Larger values cause longer delays for a given amount of dirty data.
841.sp
842For the smoothest delay, this value should be about 1 billion divided
843by the maximum number of operations per second. This will smoothly
844handle between 10x and 1/10th this number.
845.sp
846See the section "ZFS TRANSACTION DELAY".
847.sp
848Note: \fBzfs_delay_scale\fR * \fBzfs_dirty_data_max\fR must be < 2^64.
849.sp
850Default value: \fB500,000\fR.
851.RE
852
a966c564
K
853.sp
854.ne 2
855.na
856\fBzfs_delete_blocks\fR (ulong)
857.ad
858.RS 12n
859This is the used to define a large file for the purposes of delete. Files
860containing more than \fBzfs_delete_blocks\fR will be deleted asynchronously
861while smaller files are deleted synchronously. Decreasing this value will
862reduce the time spent in an unlink(2) system call at the expense of a longer
863delay before the freed space is available.
864.sp
865Default value: \fB20,480\fR.
866.RE
867
e8b96c60
MA
868.sp
869.ne 2
870.na
871\fBzfs_dirty_data_max\fR (int)
872.ad
873.RS 12n
874Determines the dirty space limit in bytes. Once this limit is exceeded, new
875writes are halted until space frees up. This parameter takes precedence
876over \fBzfs_dirty_data_max_percent\fR.
877See the section "ZFS TRANSACTION DELAY".
878.sp
879Default value: 10 percent of all memory, capped at \fBzfs_dirty_data_max_max\fR.
880.RE
881
882.sp
883.ne 2
884.na
885\fBzfs_dirty_data_max_max\fR (int)
886.ad
887.RS 12n
888Maximum allowable value of \fBzfs_dirty_data_max\fR, expressed in bytes.
889This limit is only enforced at module load time, and will be ignored if
890\fBzfs_dirty_data_max\fR is later changed. This parameter takes
891precedence over \fBzfs_dirty_data_max_max_percent\fR. See the section
892"ZFS TRANSACTION DELAY".
893.sp
894Default value: 25% of physical RAM.
895.RE
896
897.sp
898.ne 2
899.na
900\fBzfs_dirty_data_max_max_percent\fR (int)
901.ad
902.RS 12n
903Maximum allowable value of \fBzfs_dirty_data_max\fR, expressed as a
904percentage of physical RAM. This limit is only enforced at module load
905time, and will be ignored if \fBzfs_dirty_data_max\fR is later changed.
906The parameter \fBzfs_dirty_data_max_max\fR takes precedence over this
907one. See the section "ZFS TRANSACTION DELAY".
908.sp
9ef3906a 909Default value: \fB25\fR.
e8b96c60
MA
910.RE
911
912.sp
913.ne 2
914.na
915\fBzfs_dirty_data_max_percent\fR (int)
916.ad
917.RS 12n
918Determines the dirty space limit, expressed as a percentage of all
919memory. Once this limit is exceeded, new writes are halted until space frees
920up. The parameter \fBzfs_dirty_data_max\fR takes precedence over this
921one. See the section "ZFS TRANSACTION DELAY".
922.sp
923Default value: 10%, subject to \fBzfs_dirty_data_max_max\fR.
924.RE
925
926.sp
927.ne 2
928.na
929\fBzfs_dirty_data_sync\fR (int)
930.ad
931.RS 12n
932Start syncing out a transaction group if there is at least this much dirty data.
933.sp
934Default value: \fB67,108,864\fR.
935.RE
936
1eeb4562
JX
937.sp
938.ne 2
939.na
940\fBzfs_fletcher_4_impl\fR (string)
941.ad
942.RS 12n
943Select a fletcher 4 implementation.
944.sp
35a76a03 945Supported selectors are: \fBfastest\fR, \fBscalar\fR, \fBsse2\fR, \fBssse3\fR,
24cdeaf1 946\fBavx2\fR, \fBavx512f\fR, and \fBaarch64_neon\fR.
70b258fc
GN
947All of the selectors except \fBfastest\fR and \fBscalar\fR require instruction
948set extensions to be available and will only appear if ZFS detects that they are
949present at runtime. If multiple implementations of fletcher 4 are available,
950the \fBfastest\fR will be chosen using a micro benchmark. Selecting \fBscalar\fR
951results in the original, CPU based calculation, being used. Selecting any option
952other than \fBfastest\fR and \fBscalar\fR results in vector instructions from
953the respective CPU instruction set being used.
1eeb4562
JX
954.sp
955Default value: \fBfastest\fR.
956.RE
957
ba5ad9a4
GW
958.sp
959.ne 2
960.na
961\fBzfs_free_bpobj_enabled\fR (int)
962.ad
963.RS 12n
964Enable/disable the processing of the free_bpobj object.
965.sp
966Default value: \fB1\fR.
967.RE
968
36283ca2
MG
969.sp
970.ne 2
971.na
972\fBzfs_free_max_blocks\fR (ulong)
973.ad
974.RS 12n
975Maximum number of blocks freed in a single txg.
976.sp
977Default value: \fB100,000\fR.
978.RE
979
e8b96c60
MA
980.sp
981.ne 2
982.na
983\fBzfs_vdev_async_read_max_active\fR (int)
984.ad
985.RS 12n
83426735 986Maximum asynchronous read I/Os active to each device.
e8b96c60
MA
987See the section "ZFS I/O SCHEDULER".
988.sp
989Default value: \fB3\fR.
990.RE
991
992.sp
993.ne 2
994.na
995\fBzfs_vdev_async_read_min_active\fR (int)
996.ad
997.RS 12n
998Minimum asynchronous read I/Os active to each device.
999See the section "ZFS I/O SCHEDULER".
1000.sp
1001Default value: \fB1\fR.
1002.RE
1003
1004.sp
1005.ne 2
1006.na
1007\fBzfs_vdev_async_write_active_max_dirty_percent\fR (int)
1008.ad
1009.RS 12n
1010When the pool has more than
1011\fBzfs_vdev_async_write_active_max_dirty_percent\fR dirty data, use
1012\fBzfs_vdev_async_write_max_active\fR to limit active async writes. If
1013the dirty data is between min and max, the active I/O limit is linearly
1014interpolated. See the section "ZFS I/O SCHEDULER".
1015.sp
1016Default value: \fB60\fR.
1017.RE
1018
1019.sp
1020.ne 2
1021.na
1022\fBzfs_vdev_async_write_active_min_dirty_percent\fR (int)
1023.ad
1024.RS 12n
1025When the pool has less than
1026\fBzfs_vdev_async_write_active_min_dirty_percent\fR dirty data, use
1027\fBzfs_vdev_async_write_min_active\fR to limit active async writes. If
1028the dirty data is between min and max, the active I/O limit is linearly
1029interpolated. See the section "ZFS I/O SCHEDULER".
1030.sp
1031Default value: \fB30\fR.
1032.RE
1033
1034.sp
1035.ne 2
1036.na
1037\fBzfs_vdev_async_write_max_active\fR (int)
1038.ad
1039.RS 12n
83426735 1040Maximum asynchronous write I/Os active to each device.
e8b96c60
MA
1041See the section "ZFS I/O SCHEDULER".
1042.sp
1043Default value: \fB10\fR.
1044.RE
1045
1046.sp
1047.ne 2
1048.na
1049\fBzfs_vdev_async_write_min_active\fR (int)
1050.ad
1051.RS 12n
1052Minimum asynchronous write I/Os active to each device.
1053See the section "ZFS I/O SCHEDULER".
1054.sp
1055Default value: \fB1\fR.
1056.RE
1057
1058.sp
1059.ne 2
1060.na
1061\fBzfs_vdev_max_active\fR (int)
1062.ad
1063.RS 12n
1064The maximum number of I/Os active to each device. Ideally, this will be >=
1065the sum of each queue's max_active. It must be at least the sum of each
1066queue's min_active. See the section "ZFS I/O SCHEDULER".
1067.sp
1068Default value: \fB1,000\fR.
1069.RE
1070
1071.sp
1072.ne 2
1073.na
1074\fBzfs_vdev_scrub_max_active\fR (int)
1075.ad
1076.RS 12n
83426735 1077Maximum scrub I/Os active to each device.
e8b96c60
MA
1078See the section "ZFS I/O SCHEDULER".
1079.sp
1080Default value: \fB2\fR.
1081.RE
1082
1083.sp
1084.ne 2
1085.na
1086\fBzfs_vdev_scrub_min_active\fR (int)
1087.ad
1088.RS 12n
1089Minimum scrub I/Os active to each device.
1090See the section "ZFS I/O SCHEDULER".
1091.sp
1092Default value: \fB1\fR.
1093.RE
1094
1095.sp
1096.ne 2
1097.na
1098\fBzfs_vdev_sync_read_max_active\fR (int)
1099.ad
1100.RS 12n
83426735 1101Maximum synchronous read I/Os active to each device.
e8b96c60
MA
1102See the section "ZFS I/O SCHEDULER".
1103.sp
1104Default value: \fB10\fR.
1105.RE
1106
1107.sp
1108.ne 2
1109.na
1110\fBzfs_vdev_sync_read_min_active\fR (int)
1111.ad
1112.RS 12n
1113Minimum synchronous read I/Os active to each device.
1114See the section "ZFS I/O SCHEDULER".
1115.sp
1116Default value: \fB10\fR.
1117.RE
1118
1119.sp
1120.ne 2
1121.na
1122\fBzfs_vdev_sync_write_max_active\fR (int)
1123.ad
1124.RS 12n
83426735 1125Maximum synchronous write I/Os active to each device.
e8b96c60
MA
1126See the section "ZFS I/O SCHEDULER".
1127.sp
1128Default value: \fB10\fR.
1129.RE
1130
1131.sp
1132.ne 2
1133.na
1134\fBzfs_vdev_sync_write_min_active\fR (int)
1135.ad
1136.RS 12n
1137Minimum synchronous write I/Os active to each device.
1138See the section "ZFS I/O SCHEDULER".
1139.sp
1140Default value: \fB10\fR.
1141.RE
1142
3dfb57a3
DB
1143.sp
1144.ne 2
1145.na
1146\fBzfs_vdev_queue_depth_pct\fR (int)
1147.ad
1148.RS 12n
1149The queue depth percentage for each top-level virtual device.
1150Used in conjunction with zfs_vdev_async_max_active.
1151.sp
1152Default value: \fB1000\fR.
1153.RE
1154
29714574
TF
1155.sp
1156.ne 2
1157.na
1158\fBzfs_disable_dup_eviction\fR (int)
1159.ad
1160.RS 12n
1161Disable duplicate buffer eviction
1162.sp
1163Use \fB1\fR for yes and \fB0\fR for no (default).
1164.RE
1165
1166.sp
1167.ne 2
1168.na
1169\fBzfs_expire_snapshot\fR (int)
1170.ad
1171.RS 12n
1172Seconds to expire .zfs/snapshot
1173.sp
1174Default value: \fB300\fR.
1175.RE
1176
0500e835
BB
1177.sp
1178.ne 2
1179.na
1180\fBzfs_admin_snapshot\fR (int)
1181.ad
1182.RS 12n
1183Allow the creation, removal, or renaming of entries in the .zfs/snapshot
1184directory to cause the creation, destruction, or renaming of snapshots.
1185When enabled this functionality works both locally and over NFS exports
1186which have the 'no_root_squash' option set. This functionality is disabled
1187by default.
1188.sp
1189Use \fB1\fR for yes and \fB0\fR for no (default).
1190.RE
1191
29714574
TF
1192.sp
1193.ne 2
1194.na
1195\fBzfs_flags\fR (int)
1196.ad
1197.RS 12n
33b6dbbc
NB
1198Set additional debugging flags. The following flags may be bitwise-or'd
1199together.
1200.sp
1201.TS
1202box;
1203rB lB
1204lB lB
1205r l.
1206Value Symbolic Name
1207 Description
1208_
12091 ZFS_DEBUG_DPRINTF
1210 Enable dprintf entries in the debug log.
1211_
12122 ZFS_DEBUG_DBUF_VERIFY *
1213 Enable extra dbuf verifications.
1214_
12154 ZFS_DEBUG_DNODE_VERIFY *
1216 Enable extra dnode verifications.
1217_
12188 ZFS_DEBUG_SNAPNAMES
1219 Enable snapshot name verification.
1220_
122116 ZFS_DEBUG_MODIFY
1222 Check for illegally modified ARC buffers.
1223_
122432 ZFS_DEBUG_SPA
1225 Enable spa_dbgmsg entries in the debug log.
1226_
122764 ZFS_DEBUG_ZIO_FREE
1228 Enable verification of block frees.
1229_
1230128 ZFS_DEBUG_HISTOGRAM_VERIFY
1231 Enable extra spacemap histogram verifications.
1232.TE
1233.sp
1234* Requires debug build.
29714574 1235.sp
33b6dbbc 1236Default value: \fB0\fR.
29714574
TF
1237.RE
1238
fbeddd60
MA
1239.sp
1240.ne 2
1241.na
1242\fBzfs_free_leak_on_eio\fR (int)
1243.ad
1244.RS 12n
1245If destroy encounters an EIO while reading metadata (e.g. indirect
1246blocks), space referenced by the missing metadata can not be freed.
1247Normally this causes the background destroy to become "stalled", as
1248it is unable to make forward progress. While in this stalled state,
1249all remaining space to free from the error-encountering filesystem is
1250"temporarily leaked". Set this flag to cause it to ignore the EIO,
1251permanently leak the space from indirect blocks that can not be read,
1252and continue to free everything else that it can.
1253
1254The default, "stalling" behavior is useful if the storage partially
1255fails (i.e. some but not all i/os fail), and then later recovers. In
1256this case, we will be able to continue pool operations while it is
1257partially failed, and when it recovers, we can continue to free the
1258space, with no leaks. However, note that this case is actually
1259fairly rare.
1260
1261Typically pools either (a) fail completely (but perhaps temporarily,
1262e.g. a top-level vdev going offline), or (b) have localized,
1263permanent errors (e.g. disk returns the wrong data due to bit flip or
1264firmware bug). In case (a), this setting does not matter because the
1265pool will be suspended and the sync thread will not be able to make
1266forward progress regardless. In case (b), because the error is
1267permanent, the best we can do is leak the minimum amount of space,
1268which is what setting this flag will do. Therefore, it is reasonable
1269for this flag to normally be set, but we chose the more conservative
1270approach of not setting it, so that there is no possibility of
1271leaking space in the "partial temporary" failure case.
1272.sp
1273Default value: \fB0\fR.
1274.RE
1275
29714574
TF
1276.sp
1277.ne 2
1278.na
1279\fBzfs_free_min_time_ms\fR (int)
1280.ad
1281.RS 12n
6146e17e 1282During a \fBzfs destroy\fR operation using \fBfeature@async_destroy\fR a minimum
83426735 1283of this much time will be spent working on freeing blocks per txg.
29714574
TF
1284.sp
1285Default value: \fB1,000\fR.
1286.RE
1287
1288.sp
1289.ne 2
1290.na
1291\fBzfs_immediate_write_sz\fR (long)
1292.ad
1293.RS 12n
83426735 1294Largest data block to write to zil. Larger blocks will be treated as if the
6146e17e 1295dataset being written to had the property setting \fBlogbias=throughput\fR.
29714574
TF
1296.sp
1297Default value: \fB32,768\fR.
1298.RE
1299
f1512ee6
MA
1300.sp
1301.ne 2
1302.na
1303\fBzfs_max_recordsize\fR (int)
1304.ad
1305.RS 12n
1306We currently support block sizes from 512 bytes to 16MB. The benefits of
1307larger blocks, and thus larger IO, need to be weighed against the cost of
1308COWing a giant block to modify one byte. Additionally, very large blocks
1309can have an impact on i/o latency, and also potentially on the memory
1310allocator. Therefore, we do not allow the recordsize to be set larger than
1311zfs_max_recordsize (default 1MB). Larger blocks can be created by changing
1312this tunable, and pools with larger blocks can always be imported and used,
1313regardless of this setting.
1314.sp
1315Default value: \fB1,048,576\fR.
1316.RE
1317
29714574
TF
1318.sp
1319.ne 2
1320.na
1321\fBzfs_mdcomp_disable\fR (int)
1322.ad
1323.RS 12n
1324Disable meta data compression
1325.sp
1326Use \fB1\fR for yes and \fB0\fR for no (default).
1327.RE
1328
f3a7f661
GW
1329.sp
1330.ne 2
1331.na
1332\fBzfs_metaslab_fragmentation_threshold\fR (int)
1333.ad
1334.RS 12n
1335Allow metaslabs to keep their active state as long as their fragmentation
1336percentage is less than or equal to this value. An active metaslab that
1337exceeds this threshold will no longer keep its active status allowing
1338better metaslabs to be selected.
1339.sp
1340Default value: \fB70\fR.
1341.RE
1342
1343.sp
1344.ne 2
1345.na
1346\fBzfs_mg_fragmentation_threshold\fR (int)
1347.ad
1348.RS 12n
1349Metaslab groups are considered eligible for allocations if their
83426735 1350fragmentation metric (measured as a percentage) is less than or equal to
f3a7f661
GW
1351this value. If a metaslab group exceeds this threshold then it will be
1352skipped unless all metaslab groups within the metaslab class have also
1353crossed this threshold.
1354.sp
1355Default value: \fB85\fR.
1356.RE
1357
f4a4046b
TC
1358.sp
1359.ne 2
1360.na
1361\fBzfs_mg_noalloc_threshold\fR (int)
1362.ad
1363.RS 12n
1364Defines a threshold at which metaslab groups should be eligible for
1365allocations. The value is expressed as a percentage of free space
1366beyond which a metaslab group is always eligible for allocations.
1367If a metaslab group's free space is less than or equal to the
6b4e21c6 1368threshold, the allocator will avoid allocating to that group
f4a4046b
TC
1369unless all groups in the pool have reached the threshold. Once all
1370groups have reached the threshold, all groups are allowed to accept
1371allocations. The default value of 0 disables the feature and causes
1372all metaslab groups to be eligible for allocations.
1373
1374This parameter allows to deal with pools having heavily imbalanced
1375vdevs such as would be the case when a new vdev has been added.
1376Setting the threshold to a non-zero percentage will stop allocations
1377from being made to vdevs that aren't filled to the specified percentage
1378and allow lesser filled vdevs to acquire more allocations than they
1379otherwise would under the old \fBzfs_mg_alloc_failures\fR facility.
1380.sp
1381Default value: \fB0\fR.
1382.RE
1383
29714574
TF
1384.sp
1385.ne 2
1386.na
1387\fBzfs_no_scrub_io\fR (int)
1388.ad
1389.RS 12n
83426735
D
1390Set for no scrub I/O. This results in scrubs not actually scrubbing data and
1391simply doing a metadata crawl of the pool instead.
29714574
TF
1392.sp
1393Use \fB1\fR for yes and \fB0\fR for no (default).
1394.RE
1395
1396.sp
1397.ne 2
1398.na
1399\fBzfs_no_scrub_prefetch\fR (int)
1400.ad
1401.RS 12n
83426735 1402Set to disable block prefetching for scrubs.
29714574
TF
1403.sp
1404Use \fB1\fR for yes and \fB0\fR for no (default).
1405.RE
1406
29714574
TF
1407.sp
1408.ne 2
1409.na
1410\fBzfs_nocacheflush\fR (int)
1411.ad
1412.RS 12n
83426735
D
1413Disable cache flush operations on disks when writing. Beware, this may cause
1414corruption if disks re-order writes.
29714574
TF
1415.sp
1416Use \fB1\fR for yes and \fB0\fR for no (default).
1417.RE
1418
1419.sp
1420.ne 2
1421.na
1422\fBzfs_nopwrite_enabled\fR (int)
1423.ad
1424.RS 12n
1425Enable NOP writes
1426.sp
1427Use \fB1\fR for yes (default) and \fB0\fR to disable.
1428.RE
1429
1430.sp
1431.ne 2
1432.na
b738bc5a 1433\fBzfs_pd_bytes_max\fR (int)
29714574
TF
1434.ad
1435.RS 12n
83426735 1436The number of bytes which should be prefetched during a pool traversal
6146e17e 1437(eg: \fBzfs send\fR or other data crawling operations)
29714574 1438.sp
74aa2ba2 1439Default value: \fB52,428,800\fR.
29714574
TF
1440.RE
1441
bef78122
DQ
1442.sp
1443.ne 2
1444.na
1445\fBzfs_per_txg_dirty_frees_percent \fR (ulong)
1446.ad
1447.RS 12n
1448Tunable to control percentage of dirtied blocks from frees in one TXG.
1449After this threshold is crossed, additional dirty blocks from frees
1450wait until the next TXG.
1451A value of zero will disable this throttle.
1452.sp
1453Default value: \fB30\fR and \fB0\fR to disable.
1454.RE
1455
1456
1457
29714574
TF
1458.sp
1459.ne 2
1460.na
1461\fBzfs_prefetch_disable\fR (int)
1462.ad
1463.RS 12n
7f60329a
MA
1464This tunable disables predictive prefetch. Note that it leaves "prescient"
1465prefetch (e.g. prefetch for zfs send) intact. Unlike predictive prefetch,
1466prescient prefetch never issues i/os that end up not being needed, so it
1467can't hurt performance.
29714574
TF
1468.sp
1469Use \fB1\fR for yes and \fB0\fR for no (default).
1470.RE
1471
1472.sp
1473.ne 2
1474.na
1475\fBzfs_read_chunk_size\fR (long)
1476.ad
1477.RS 12n
1478Bytes to read per chunk
1479.sp
1480Default value: \fB1,048,576\fR.
1481.RE
1482
1483.sp
1484.ne 2
1485.na
1486\fBzfs_read_history\fR (int)
1487.ad
1488.RS 12n
83426735
D
1489Historic statistics for the last N reads will be available in
1490\fR/proc/spl/kstat/zfs/POOLNAME/reads\fB
29714574 1491.sp
83426735 1492Default value: \fB0\fR (no data is kept).
29714574
TF
1493.RE
1494
1495.sp
1496.ne 2
1497.na
1498\fBzfs_read_history_hits\fR (int)
1499.ad
1500.RS 12n
1501Include cache hits in read history
1502.sp
1503Use \fB1\fR for yes and \fB0\fR for no (default).
1504.RE
1505
1506.sp
1507.ne 2
1508.na
1509\fBzfs_recover\fR (int)
1510.ad
1511.RS 12n
1512Set to attempt to recover from fatal errors. This should only be used as a
1513last resort, as it typically results in leaked space, or worse.
1514.sp
1515Use \fB1\fR for yes and \fB0\fR for no (default).
1516.RE
1517
1518.sp
1519.ne 2
1520.na
1521\fBzfs_resilver_delay\fR (int)
1522.ad
1523.RS 12n
27b293be
TC
1524Number of ticks to delay prior to issuing a resilver I/O operation when
1525a non-resilver or non-scrub I/O operation has occurred within the past
1526\fBzfs_scan_idle\fR ticks.
29714574
TF
1527.sp
1528Default value: \fB2\fR.
1529.RE
1530
1531.sp
1532.ne 2
1533.na
1534\fBzfs_resilver_min_time_ms\fR (int)
1535.ad
1536.RS 12n
83426735
D
1537Resilvers are processed by the sync thread. While resilvering it will spend
1538at least this much time working on a resilver between txg flushes.
29714574
TF
1539.sp
1540Default value: \fB3,000\fR.
1541.RE
1542
1543.sp
1544.ne 2
1545.na
1546\fBzfs_scan_idle\fR (int)
1547.ad
1548.RS 12n
27b293be
TC
1549Idle window in clock ticks. During a scrub or a resilver, if
1550a non-scrub or non-resilver I/O operation has occurred during this
1551window, the next scrub or resilver operation is delayed by, respectively
1552\fBzfs_scrub_delay\fR or \fBzfs_resilver_delay\fR ticks.
29714574
TF
1553.sp
1554Default value: \fB50\fR.
1555.RE
1556
1557.sp
1558.ne 2
1559.na
1560\fBzfs_scan_min_time_ms\fR (int)
1561.ad
1562.RS 12n
83426735
D
1563Scrubs are processed by the sync thread. While scrubbing it will spend
1564at least this much time working on a scrub between txg flushes.
29714574
TF
1565.sp
1566Default value: \fB1,000\fR.
1567.RE
1568
1569.sp
1570.ne 2
1571.na
1572\fBzfs_scrub_delay\fR (int)
1573.ad
1574.RS 12n
27b293be
TC
1575Number of ticks to delay prior to issuing a scrub I/O operation when
1576a non-scrub or non-resilver I/O operation has occurred within the past
1577\fBzfs_scan_idle\fR ticks.
29714574
TF
1578.sp
1579Default value: \fB4\fR.
1580.RE
1581
fd8febbd
TF
1582.sp
1583.ne 2
1584.na
1585\fBzfs_send_corrupt_data\fR (int)
1586.ad
1587.RS 12n
83426735 1588Allow sending of corrupt data (ignore read/checksum errors when sending data)
fd8febbd
TF
1589.sp
1590Use \fB1\fR for yes and \fB0\fR for no (default).
1591.RE
1592
29714574
TF
1593.sp
1594.ne 2
1595.na
1596\fBzfs_sync_pass_deferred_free\fR (int)
1597.ad
1598.RS 12n
83426735 1599Flushing of data to disk is done in passes. Defer frees starting in this pass
29714574
TF
1600.sp
1601Default value: \fB2\fR.
1602.RE
1603
1604.sp
1605.ne 2
1606.na
1607\fBzfs_sync_pass_dont_compress\fR (int)
1608.ad
1609.RS 12n
1610Don't compress starting in this pass
1611.sp
1612Default value: \fB5\fR.
1613.RE
1614
1615.sp
1616.ne 2
1617.na
1618\fBzfs_sync_pass_rewrite\fR (int)
1619.ad
1620.RS 12n
83426735 1621Rewrite new block pointers starting in this pass
29714574
TF
1622.sp
1623Default value: \fB2\fR.
1624.RE
1625
1626.sp
1627.ne 2
1628.na
1629\fBzfs_top_maxinflight\fR (int)
1630.ad
1631.RS 12n
83426735
D
1632Max concurrent I/Os per top-level vdev (mirrors or raidz arrays) allowed during
1633scrub or resilver operations.
29714574
TF
1634.sp
1635Default value: \fB32\fR.
1636.RE
1637
1638.sp
1639.ne 2
1640.na
1641\fBzfs_txg_history\fR (int)
1642.ad
1643.RS 12n
83426735
D
1644Historic statistics for the last N txgs will be available in
1645\fR/proc/spl/kstat/zfs/POOLNAME/txgs\fB
29714574
TF
1646.sp
1647Default value: \fB0\fR.
1648.RE
1649
29714574
TF
1650.sp
1651.ne 2
1652.na
1653\fBzfs_txg_timeout\fR (int)
1654.ad
1655.RS 12n
83426735 1656Flush dirty data to disk at least every N seconds (maximum txg duration)
29714574
TF
1657.sp
1658Default value: \fB5\fR.
1659.RE
1660
1661.sp
1662.ne 2
1663.na
1664\fBzfs_vdev_aggregation_limit\fR (int)
1665.ad
1666.RS 12n
1667Max vdev I/O aggregation size
1668.sp
1669Default value: \fB131,072\fR.
1670.RE
1671
1672.sp
1673.ne 2
1674.na
1675\fBzfs_vdev_cache_bshift\fR (int)
1676.ad
1677.RS 12n
1678Shift size to inflate reads too
1679.sp
83426735 1680Default value: \fB16\fR (effectively 65536).
29714574
TF
1681.RE
1682
1683.sp
1684.ne 2
1685.na
1686\fBzfs_vdev_cache_max\fR (int)
1687.ad
1688.RS 12n
83426735
D
1689Inflate reads small than this value to meet the \fBzfs_vdev_cache_bshift\fR
1690size.
1691.sp
1692Default value: \fB16384\fR.
29714574
TF
1693.RE
1694
1695.sp
1696.ne 2
1697.na
1698\fBzfs_vdev_cache_size\fR (int)
1699.ad
1700.RS 12n
83426735
D
1701Total size of the per-disk cache in bytes.
1702.sp
1703Currently this feature is disabled as it has been found to not be helpful
1704for performance and in some cases harmful.
29714574
TF
1705.sp
1706Default value: \fB0\fR.
1707.RE
1708
29714574
TF
1709.sp
1710.ne 2
1711.na
9f500936 1712\fBzfs_vdev_mirror_rotating_inc\fR (int)
29714574
TF
1713.ad
1714.RS 12n
9f500936 1715A number by which the balancing algorithm increments the load calculation for
1716the purpose of selecting the least busy mirror member when an I/O immediately
1717follows its predecessor on rotational vdevs for the purpose of making decisions
1718based on load.
29714574 1719.sp
9f500936 1720Default value: \fB0\fR.
1721.RE
1722
1723.sp
1724.ne 2
1725.na
1726\fBzfs_vdev_mirror_rotating_seek_inc\fR (int)
1727.ad
1728.RS 12n
1729A number by which the balancing algorithm increments the load calculation for
1730the purpose of selecting the least busy mirror member when an I/O lacks
1731locality as defined by the zfs_vdev_mirror_rotating_seek_offset. I/Os within
1732this that are not immediately following the previous I/O are incremented by
1733half.
1734.sp
1735Default value: \fB5\fR.
1736.RE
1737
1738.sp
1739.ne 2
1740.na
1741\fBzfs_vdev_mirror_rotating_seek_offset\fR (int)
1742.ad
1743.RS 12n
1744The maximum distance for the last queued I/O in which the balancing algorithm
1745considers an I/O to have locality.
1746See the section "ZFS I/O SCHEDULER".
1747.sp
1748Default value: \fB1048576\fR.
1749.RE
1750
1751.sp
1752.ne 2
1753.na
1754\fBzfs_vdev_mirror_non_rotating_inc\fR (int)
1755.ad
1756.RS 12n
1757A number by which the balancing algorithm increments the load calculation for
1758the purpose of selecting the least busy mirror member on non-rotational vdevs
1759when I/Os do not immediately follow one another.
1760.sp
1761Default value: \fB0\fR.
1762.RE
1763
1764.sp
1765.ne 2
1766.na
1767\fBzfs_vdev_mirror_non_rotating_seek_inc\fR (int)
1768.ad
1769.RS 12n
1770A number by which the balancing algorithm increments the load calculation for
1771the purpose of selecting the least busy mirror member when an I/O lacks
1772locality as defined by the zfs_vdev_mirror_rotating_seek_offset. I/Os within
1773this that are not immediately following the previous I/O are incremented by
1774half.
1775.sp
1776Default value: \fB1\fR.
29714574
TF
1777.RE
1778
29714574
TF
1779.sp
1780.ne 2
1781.na
1782\fBzfs_vdev_read_gap_limit\fR (int)
1783.ad
1784.RS 12n
83426735
D
1785Aggregate read I/O operations if the gap on-disk between them is within this
1786threshold.
29714574
TF
1787.sp
1788Default value: \fB32,768\fR.
1789.RE
1790
1791.sp
1792.ne 2
1793.na
1794\fBzfs_vdev_scheduler\fR (charp)
1795.ad
1796.RS 12n
83426735 1797Set the Linux I/O scheduler on whole disk vdevs to this scheduler
29714574
TF
1798.sp
1799Default value: \fBnoop\fR.
1800.RE
1801
29714574
TF
1802.sp
1803.ne 2
1804.na
1805\fBzfs_vdev_write_gap_limit\fR (int)
1806.ad
1807.RS 12n
1808Aggregate write I/O over gap
1809.sp
1810Default value: \fB4,096\fR.
1811.RE
1812
ab9f4b0b
GN
1813.sp
1814.ne 2
1815.na
1816\fBzfs_vdev_raidz_impl\fR (string)
1817.ad
1818.RS 12n
c9187d86 1819Parameter for selecting raidz parity implementation to use.
ab9f4b0b
GN
1820
1821Options marked (always) below may be selected on module load as they are
1822supported on all systems.
1823The remaining options may only be set after the module is loaded, as they
1824are available only if the implementations are compiled in and supported
1825on the running system.
1826
1827Once the module is loaded, the content of
1828/sys/module/zfs/parameters/zfs_vdev_raidz_impl will show available options
1829with the currently selected one enclosed in [].
1830Possible options are:
1831 fastest - (always) implementation selected using built-in benchmark
1832 original - (always) original raidz implementation
1833 scalar - (always) scalar raidz implementation
ae25d222
GN
1834 sse2 - implementation using SSE2 instruction set (64bit x86 only)
1835 ssse3 - implementation using SSSE3 instruction set (64bit x86 only)
ab9f4b0b 1836 avx2 - implementation using AVX2 instruction set (64bit x86 only)
7f547f85
RD
1837 avx512f - implementation using AVX512F instruction set (64bit x86 only)
1838 avx512bw - implementation using AVX512F & AVX512BW instruction sets (64bit x86 only)
62a65a65
RD
1839 aarch64_neon - implementation using NEON (Aarch64/64 bit ARMv8 only)
1840 aarch64_neonx2 - implementation using NEON with more unrolling (Aarch64/64 bit ARMv8 only)
ab9f4b0b
GN
1841.sp
1842Default value: \fBfastest\fR.
1843.RE
1844
29714574
TF
1845.sp
1846.ne 2
1847.na
1848\fBzfs_zevent_cols\fR (int)
1849.ad
1850.RS 12n
83426735 1851When zevents are logged to the console use this as the word wrap width.
29714574
TF
1852.sp
1853Default value: \fB80\fR.
1854.RE
1855
1856.sp
1857.ne 2
1858.na
1859\fBzfs_zevent_console\fR (int)
1860.ad
1861.RS 12n
1862Log events to the console
1863.sp
1864Use \fB1\fR for yes and \fB0\fR for no (default).
1865.RE
1866
1867.sp
1868.ne 2
1869.na
1870\fBzfs_zevent_len_max\fR (int)
1871.ad
1872.RS 12n
83426735
D
1873Max event queue length. A value of 0 will result in a calculated value which
1874increases with the number of CPUs in the system (minimum 64 events). Events
1875in the queue can be viewed with the \fBzpool events\fR command.
29714574
TF
1876.sp
1877Default value: \fB0\fR.
1878.RE
1879
1880.sp
1881.ne 2
1882.na
1883\fBzil_replay_disable\fR (int)
1884.ad
1885.RS 12n
83426735
D
1886Disable intent logging replay. Can be disabled for recovery from corrupted
1887ZIL
29714574
TF
1888.sp
1889Use \fB1\fR for yes and \fB0\fR for no (default).
1890.RE
1891
1892.sp
1893.ne 2
1894.na
1895\fBzil_slog_limit\fR (ulong)
1896.ad
1897.RS 12n
1898Max commit bytes to separate log device
1899.sp
1900Default value: \fB1,048,576\fR.
1901.RE
1902
29714574
TF
1903.sp
1904.ne 2
1905.na
1906\fBzio_delay_max\fR (int)
1907.ad
1908.RS 12n
83426735 1909A zevent will be logged if a ZIO operation takes more than N milliseconds to
ab9f4b0b 1910complete. Note that this is only a logging facility, not a timeout on
83426735 1911operations.
29714574
TF
1912.sp
1913Default value: \fB30,000\fR.
1914.RE
1915
3dfb57a3
DB
1916.sp
1917.ne 2
1918.na
1919\fBzio_dva_throttle_enabled\fR (int)
1920.ad
1921.RS 12n
1922Throttle block allocations in the ZIO pipeline. This allows for
1923dynamic allocation distribution when devices are imbalanced.
1924.sp
27f2b90d 1925Default value: \fB1\fR.
3dfb57a3
DB
1926.RE
1927
29714574
TF
1928.sp
1929.ne 2
1930.na
1931\fBzio_requeue_io_start_cut_in_line\fR (int)
1932.ad
1933.RS 12n
1934Prioritize requeued I/O
1935.sp
1936Default value: \fB0\fR.
1937.RE
1938
dcb6bed1
D
1939.sp
1940.ne 2
1941.na
1942\fBzio_taskq_batch_pct\fR (uint)
1943.ad
1944.RS 12n
1945Percentage of online CPUs (or CPU cores, etc) which will run a worker thread
1946for IO. These workers are responsible for IO work such as compression and
1947checksum calculations. Fractional number of CPUs will be rounded down.
1948.sp
1949The default value of 75 was chosen to avoid using all CPUs which can result in
1950latency issues and inconsistent application performance, especially when high
1951compression is enabled.
1952.sp
1953Default value: \fB75\fR.
1954.RE
1955
29714574
TF
1956.sp
1957.ne 2
1958.na
1959\fBzvol_inhibit_dev\fR (uint)
1960.ad
1961.RS 12n
83426735
D
1962Do not create zvol device nodes. This may slightly improve startup time on
1963systems with a very large number of zvols.
29714574
TF
1964.sp
1965Use \fB1\fR for yes and \fB0\fR for no (default).
1966.RE
1967
1968.sp
1969.ne 2
1970.na
1971\fBzvol_major\fR (uint)
1972.ad
1973.RS 12n
83426735 1974Major number for zvol block devices
29714574
TF
1975.sp
1976Default value: \fB230\fR.
1977.RE
1978
1979.sp
1980.ne 2
1981.na
1982\fBzvol_max_discard_blocks\fR (ulong)
1983.ad
1984.RS 12n
83426735
D
1985Discard (aka TRIM) operations done on zvols will be done in batches of this
1986many blocks, where block size is determined by the \fBvolblocksize\fR property
1987of a zvol.
29714574
TF
1988.sp
1989Default value: \fB16,384\fR.
1990.RE
1991
9965059a
BB
1992.sp
1993.ne 2
1994.na
1995\fBzvol_prefetch_bytes\fR (uint)
1996.ad
1997.RS 12n
1998When adding a zvol to the system prefetch \fBzvol_prefetch_bytes\fR
1999from the start and end of the volume. Prefetching these regions
2000of the volume is desirable because they are likely to be accessed
2001immediately by \fBblkid(8)\fR or by the kernel scanning for a partition
2002table.
2003.sp
2004Default value: \fB131,072\fR.
2005.RE
2006
39ccc909 2007.sp
2008.ne 2
2009.na
2010\fBzfs_qat_disable\fR (int)
2011.ad
2012.RS 12n
2013This tunable disables qat hardware acceleration for gzip compression.
2014It is available only if qat acceleration is compiled in and qat driver
2015is present.
2016.sp
2017Use \fB1\fR for yes and \fB0\fR for no (default).
2018.RE
2019
e8b96c60
MA
2020.SH ZFS I/O SCHEDULER
2021ZFS issues I/O operations to leaf vdevs to satisfy and complete I/Os.
2022The I/O scheduler determines when and in what order those operations are
2023issued. The I/O scheduler divides operations into five I/O classes
2024prioritized in the following order: sync read, sync write, async read,
2025async write, and scrub/resilver. Each queue defines the minimum and
2026maximum number of concurrent operations that may be issued to the
2027device. In addition, the device has an aggregate maximum,
2028\fBzfs_vdev_max_active\fR. Note that the sum of the per-queue minimums
2029must not exceed the aggregate maximum. If the sum of the per-queue
2030maximums exceeds the aggregate maximum, then the number of active I/Os
2031may reach \fBzfs_vdev_max_active\fR, in which case no further I/Os will
2032be issued regardless of whether all per-queue minimums have been met.
2033.sp
2034For many physical devices, throughput increases with the number of
2035concurrent operations, but latency typically suffers. Further, physical
2036devices typically have a limit at which more concurrent operations have no
2037effect on throughput or can actually cause it to decrease.
2038.sp
2039The scheduler selects the next operation to issue by first looking for an
2040I/O class whose minimum has not been satisfied. Once all are satisfied and
2041the aggregate maximum has not been hit, the scheduler looks for classes
2042whose maximum has not been satisfied. Iteration through the I/O classes is
2043done in the order specified above. No further operations are issued if the
2044aggregate maximum number of concurrent operations has been hit or if there
2045are no operations queued for an I/O class that has not hit its maximum.
2046Every time an I/O is queued or an operation completes, the I/O scheduler
2047looks for new operations to issue.
2048.sp
2049In general, smaller max_active's will lead to lower latency of synchronous
2050operations. Larger max_active's may lead to higher overall throughput,
2051depending on underlying storage.
2052.sp
2053The ratio of the queues' max_actives determines the balance of performance
2054between reads, writes, and scrubs. E.g., increasing
2055\fBzfs_vdev_scrub_max_active\fR will cause the scrub or resilver to complete
2056more quickly, but reads and writes to have higher latency and lower throughput.
2057.sp
2058All I/O classes have a fixed maximum number of outstanding operations
2059except for the async write class. Asynchronous writes represent the data
2060that is committed to stable storage during the syncing stage for
2061transaction groups. Transaction groups enter the syncing state
2062periodically so the number of queued async writes will quickly burst up
2063and then bleed down to zero. Rather than servicing them as quickly as
2064possible, the I/O scheduler changes the maximum number of active async
2065write I/Os according to the amount of dirty data in the pool. Since
2066both throughput and latency typically increase with the number of
2067concurrent operations issued to physical devices, reducing the
2068burstiness in the number of concurrent operations also stabilizes the
2069response time of operations from other -- and in particular synchronous
2070-- queues. In broad strokes, the I/O scheduler will issue more
2071concurrent operations from the async write queue as there's more dirty
2072data in the pool.
2073.sp
2074Async Writes
2075.sp
2076The number of concurrent operations issued for the async write I/O class
2077follows a piece-wise linear function defined by a few adjustable points.
2078.nf
2079
2080 | o---------| <-- zfs_vdev_async_write_max_active
2081 ^ | /^ |
2082 | | / | |
2083active | / | |
2084 I/O | / | |
2085count | / | |
2086 | / | |
2087 |-------o | | <-- zfs_vdev_async_write_min_active
2088 0|_______^______|_________|
2089 0% | | 100% of zfs_dirty_data_max
2090 | |
2091 | `-- zfs_vdev_async_write_active_max_dirty_percent
2092 `--------- zfs_vdev_async_write_active_min_dirty_percent
2093
2094.fi
2095Until the amount of dirty data exceeds a minimum percentage of the dirty
2096data allowed in the pool, the I/O scheduler will limit the number of
2097concurrent operations to the minimum. As that threshold is crossed, the
2098number of concurrent operations issued increases linearly to the maximum at
2099the specified maximum percentage of the dirty data allowed in the pool.
2100.sp
2101Ideally, the amount of dirty data on a busy pool will stay in the sloped
2102part of the function between \fBzfs_vdev_async_write_active_min_dirty_percent\fR
2103and \fBzfs_vdev_async_write_active_max_dirty_percent\fR. If it exceeds the
2104maximum percentage, this indicates that the rate of incoming data is
2105greater than the rate that the backend storage can handle. In this case, we
2106must further throttle incoming writes, as described in the next section.
2107
2108.SH ZFS TRANSACTION DELAY
2109We delay transactions when we've determined that the backend storage
2110isn't able to accommodate the rate of incoming writes.
2111.sp
2112If there is already a transaction waiting, we delay relative to when
2113that transaction will finish waiting. This way the calculated delay time
2114is independent of the number of threads concurrently executing
2115transactions.
2116.sp
2117If we are the only waiter, wait relative to when the transaction
2118started, rather than the current time. This credits the transaction for
2119"time already served", e.g. reading indirect blocks.
2120.sp
2121The minimum time for a transaction to take is calculated as:
2122.nf
2123 min_time = zfs_delay_scale * (dirty - min) / (max - dirty)
2124 min_time is then capped at 100 milliseconds.
2125.fi
2126.sp
2127The delay has two degrees of freedom that can be adjusted via tunables. The
2128percentage of dirty data at which we start to delay is defined by
2129\fBzfs_delay_min_dirty_percent\fR. This should typically be at or above
2130\fBzfs_vdev_async_write_active_max_dirty_percent\fR so that we only start to
2131delay after writing at full speed has failed to keep up with the incoming write
2132rate. The scale of the curve is defined by \fBzfs_delay_scale\fR. Roughly speaking,
2133this variable determines the amount of delay at the midpoint of the curve.
2134.sp
2135.nf
2136delay
2137 10ms +-------------------------------------------------------------*+
2138 | *|
2139 9ms + *+
2140 | *|
2141 8ms + *+
2142 | * |
2143 7ms + * +
2144 | * |
2145 6ms + * +
2146 | * |
2147 5ms + * +
2148 | * |
2149 4ms + * +
2150 | * |
2151 3ms + * +
2152 | * |
2153 2ms + (midpoint) * +
2154 | | ** |
2155 1ms + v *** +
2156 | zfs_delay_scale ----------> ******** |
2157 0 +-------------------------------------*********----------------+
2158 0% <- zfs_dirty_data_max -> 100%
2159.fi
2160.sp
2161Note that since the delay is added to the outstanding time remaining on the
2162most recent transaction, the delay is effectively the inverse of IOPS.
2163Here the midpoint of 500us translates to 2000 IOPS. The shape of the curve
2164was chosen such that small changes in the amount of accumulated dirty data
2165in the first 3/4 of the curve yield relatively small differences in the
2166amount of delay.
2167.sp
2168The effects can be easier to understand when the amount of delay is
2169represented on a log scale:
2170.sp
2171.nf
2172delay
2173100ms +-------------------------------------------------------------++
2174 + +
2175 | |
2176 + *+
2177 10ms + *+
2178 + ** +
2179 | (midpoint) ** |
2180 + | ** +
2181 1ms + v **** +
2182 + zfs_delay_scale ----------> ***** +
2183 | **** |
2184 + **** +
2185100us + ** +
2186 + * +
2187 | * |
2188 + * +
2189 10us + * +
2190 + +
2191 | |
2192 + +
2193 +--------------------------------------------------------------+
2194 0% <- zfs_dirty_data_max -> 100%
2195.fi
2196.sp
2197Note here that only as the amount of dirty data approaches its limit does
2198the delay start to increase rapidly. The goal of a properly tuned system
2199should be to keep the amount of dirty data out of that range by first
2200ensuring that the appropriate limits are set for the I/O scheduler to reach
2201optimal throughput on the backend storage, and then by changing the value
2202of \fBzfs_delay_scale\fR to increase the steepness of the curve.