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