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