]>
Commit | Line | Data |
---|---|---|
2d815d95 | 1 | .\" |
29714574 | 2 | .\" Copyright (c) 2013 by Turbo Fredriksson <turbo@bayour.com>. All rights reserved. |
dd0b5c85 | 3 | .\" Copyright (c) 2019, 2021 by Delphix. All rights reserved. |
65282ee9 | 4 | .\" Copyright (c) 2019 Datto Inc. |
06a19602 | 5 | .\" Copyright (c) 2023, 2024 Klara, Inc. |
29714574 TF |
6 | .\" The contents of this file are subject to the terms of the Common Development |
7 | .\" and Distribution License (the "License"). You may not use this file except | |
8 | .\" in compliance with the License. You can obtain a copy of the license at | |
1d3ba0bf | 9 | .\" usr/src/OPENSOLARIS.LICENSE or https://opensource.org/licenses/CDDL-1.0. |
29714574 TF |
10 | .\" |
11 | .\" See the License for the specific language governing permissions and | |
12 | .\" limitations under the License. When distributing Covered Code, include this | |
13 | .\" CDDL HEADER in each file and include the License file at | |
14 | .\" usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this | |
15 | .\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your | |
16 | .\" own identifying information: | |
17 | .\" Portions Copyright [yyyy] [name of copyright owner] | |
2d815d95 | 18 | .\" |
06a19602 | 19 | .Dd January 9, 2024 |
2badb345 | 20 | .Dt ZFS 4 |
2d815d95 AZ |
21 | .Os |
22 | . | |
23 | .Sh NAME | |
2badb345 AZ |
24 | .Nm zfs |
25 | .Nd tuning of the ZFS kernel module | |
2d815d95 AZ |
26 | . |
27 | .Sh DESCRIPTION | |
2badb345 | 28 | The ZFS module supports these parameters: |
2d815d95 | 29 | .Bl -tag -width Ds |
ab8d9c17 | 30 | .It Sy dbuf_cache_max_bytes Ns = Ns Sy UINT64_MAX Ns B Pq u64 |
2d815d95 AZ |
31 | Maximum size in bytes of the dbuf cache. |
32 | The target size is determined by the MIN versus | |
33 | .No 1/2^ Ns Sy dbuf_cache_shift Pq 1/32nd | |
77f6826b | 34 | of the target ARC size. |
2d815d95 AZ |
35 | The behavior of the dbuf cache and its associated settings |
36 | can be observed via the | |
37 | .Pa /proc/spl/kstat/zfs/dbufstats | |
38 | kstat. | |
39 | . | |
ab8d9c17 | 40 | .It Sy dbuf_metadata_cache_max_bytes Ns = Ns Sy UINT64_MAX Ns B Pq u64 |
2d815d95 AZ |
41 | Maximum size in bytes of the metadata dbuf cache. |
42 | The target size is determined by the MIN versus | |
43 | .No 1/2^ Ns Sy dbuf_metadata_cache_shift Pq 1/64th | |
44 | of the target ARC size. | |
45 | The behavior of the metadata dbuf cache and its associated settings | |
46 | can be observed via the | |
47 | .Pa /proc/spl/kstat/zfs/dbufstats | |
48 | kstat. | |
49 | . | |
50 | .It Sy dbuf_cache_hiwater_pct Ns = Ns Sy 10 Ns % Pq uint | |
51 | The percentage over | |
52 | .Sy dbuf_cache_max_bytes | |
53 | when dbufs must be evicted directly. | |
54 | . | |
55 | .It Sy dbuf_cache_lowater_pct Ns = Ns Sy 10 Ns % Pq uint | |
56 | The percentage below | |
57 | .Sy dbuf_cache_max_bytes | |
58 | when the evict thread stops evicting dbufs. | |
59 | . | |
fdc2d303 | 60 | .It Sy dbuf_cache_shift Ns = Ns Sy 5 Pq uint |
2d815d95 AZ |
61 | Set the size of the dbuf cache |
62 | .Pq Sy dbuf_cache_max_bytes | |
63 | to a log2 fraction of the target ARC size. | |
64 | . | |
fdc2d303 | 65 | .It Sy dbuf_metadata_cache_shift Ns = Ns Sy 6 Pq uint |
2d815d95 AZ |
66 | Set the size of the dbuf metadata cache |
67 | .Pq Sy dbuf_metadata_cache_max_bytes | |
77f6826b | 68 | to a log2 fraction of the target ARC size. |
2d815d95 | 69 | . |
505df8d1 BB |
70 | .It Sy dbuf_mutex_cache_shift Ns = Ns Sy 0 Pq uint |
71 | Set the size of the mutex array for the dbuf cache. | |
72 | When set to | |
73 | .Sy 0 | |
74 | the array is dynamically sized based on total system memory. | |
75 | . | |
fdc2d303 | 76 | .It Sy dmu_object_alloc_chunk_shift Ns = Ns Sy 7 Po 128 Pc Pq uint |
2d815d95 AZ |
77 | dnode slots allocated in a single operation as a power of 2. |
78 | The default value minimizes lock contention for the bulk operation performed. | |
79 | . | |
fdc2d303 | 80 | .It Sy dmu_prefetch_max Ns = Ns Sy 134217728 Ns B Po 128 MiB Pc Pq uint |
2d815d95 | 81 | Limit the amount we can prefetch with one call to this amount in bytes. |
d9b4bf06 | 82 | This helps to limit the amount of memory that can be used by prefetching. |
2d815d95 AZ |
83 | . |
84 | .It Sy ignore_hole_birth Pq int | |
85 | Alias for | |
86 | .Sy send_holes_without_birth_time . | |
87 | . | |
88 | .It Sy l2arc_feed_again Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
89 | Turbo L2ARC warm-up. | |
90 | When the L2ARC is cold the fill interval will be set as fast as possible. | |
91 | . | |
ab8d9c17 | 92 | .It Sy l2arc_feed_min_ms Ns = Ns Sy 200 Pq u64 |
2d815d95 AZ |
93 | Min feed interval in milliseconds. |
94 | Requires | |
95 | .Sy l2arc_feed_again Ns = Ns Ar 1 | |
96 | and only applicable in related situations. | |
97 | . | |
ab8d9c17 | 98 | .It Sy l2arc_feed_secs Ns = Ns Sy 1 Pq u64 |
2d815d95 AZ |
99 | Seconds between L2ARC writing. |
100 | . | |
887a3c53 | 101 | .It Sy l2arc_headroom Ns = Ns Sy 8 Pq u64 |
2d815d95 AZ |
102 | How far through the ARC lists to search for L2ARC cacheable content, |
103 | expressed as a multiplier of | |
104 | .Sy l2arc_write_max . | |
105 | ARC persistence across reboots can be achieved with persistent L2ARC | |
106 | by setting this parameter to | |
107 | .Sy 0 , | |
108 | allowing the full length of ARC lists to be searched for cacheable content. | |
109 | . | |
ab8d9c17 | 110 | .It Sy l2arc_headroom_boost Ns = Ns Sy 200 Ns % Pq u64 |
2d815d95 AZ |
111 | Scales |
112 | .Sy l2arc_headroom | |
113 | by this percentage when L2ARC contents are being successfully compressed | |
114 | before writing. | |
115 | A value of | |
116 | .Sy 100 | |
117 | disables this feature. | |
118 | . | |
c9d62d13 | 119 | .It Sy l2arc_exclude_special Ns = Ns Sy 0 Ns | Ns 1 Pq int |
0175272f | 120 | Controls whether buffers present on special vdevs are eligible for caching |
c9d62d13 GA |
121 | into L2ARC. |
122 | If set to 1, exclude dbufs on special vdevs from being cached to L2ARC. | |
123 | . | |
2d815d95 | 124 | .It Sy l2arc_mfuonly Ns = Ns Sy 0 Ns | Ns 1 Pq int |
feb3a7ee GA |
125 | Controls whether only MFU metadata and data are cached from ARC into L2ARC. |
126 | This may be desired to avoid wasting space on L2ARC when reading/writing large | |
2d815d95 AZ |
127 | amounts of data that are not expected to be accessed more than once. |
128 | .Pp | |
129 | The default is off, | |
130 | meaning both MRU and MFU data and metadata are cached. | |
131 | When turning off this feature, some MRU buffers will still be present | |
132 | in ARC and eventually cached on L2ARC. | |
133 | .No If Sy l2arc_noprefetch Ns = Ns Sy 0 , | |
08532162 | 134 | some prefetched buffers will be cached to L2ARC, and those might later |
2d815d95 AZ |
135 | transition to MRU, in which case the |
136 | .Sy l2arc_mru_asize No arcstat will not be Sy 0 . | |
137 | .Pp | |
138 | Regardless of | |
139 | .Sy l2arc_noprefetch , | |
140 | some MFU buffers might be evicted from ARC, | |
141 | accessed later on as prefetches and transition to MRU as prefetches. | |
142 | If accessed again they are counted as MRU and the | |
143 | .Sy l2arc_mru_asize No arcstat will not be Sy 0 . | |
144 | .Pp | |
145 | The ARC status of L2ARC buffers when they were first cached in | |
146 | L2ARC can be seen in the | |
147 | .Sy l2arc_mru_asize , Sy l2arc_mfu_asize , No and Sy l2arc_prefetch_asize | |
148 | arcstats when importing the pool or onlining a cache | |
149 | device if persistent L2ARC is enabled. | |
150 | .Pp | |
151 | The | |
152 | .Sy evict_l2_eligible_mru | |
37b00fb0 | 153 | arcstat does not take into account if this option is enabled as the information |
2d815d95 AZ |
154 | provided by the |
155 | .Sy evict_l2_eligible_m[rf]u | |
156 | arcstats can be used to decide if toggling this option is appropriate | |
157 | for the current workload. | |
158 | . | |
fdc2d303 | 159 | .It Sy l2arc_meta_percent Ns = Ns Sy 33 Ns % Pq uint |
523e1295 | 160 | Percent of ARC size allowed for L2ARC-only headers. |
2d815d95 AZ |
161 | Since L2ARC buffers are not evicted on memory pressure, |
162 | too many headers on a system with an irrationally large L2ARC | |
163 | can render it slow or unusable. | |
164 | This parameter limits L2ARC writes and rebuilds to achieve the target. | |
165 | . | |
ab8d9c17 | 166 | .It Sy l2arc_trim_ahead Ns = Ns Sy 0 Ns % Pq u64 |
2d815d95 AZ |
167 | Trims ahead of the current write size |
168 | .Pq Sy l2arc_write_max | |
169 | on L2ARC devices by this percentage of write size if we have filled the device. | |
170 | If set to | |
171 | .Sy 100 | |
172 | we TRIM twice the space required to accommodate upcoming writes. | |
173 | A minimum of | |
a894ae75 | 174 | .Sy 64 MiB |
2d815d95 AZ |
175 | will be trimmed. |
176 | It also enables TRIM of the whole L2ARC device upon creation | |
177 | or addition to an existing pool or if the header of the device is | |
178 | invalid upon importing a pool or onlining a cache device. | |
179 | A value of | |
180 | .Sy 0 | |
b7654bd7 | 181 | disables TRIM on L2ARC altogether and is the default as it can put significant |
2d815d95 AZ |
182 | stress on the underlying storage devices. |
183 | This will vary depending of how well the specific device handles these commands. | |
184 | . | |
185 | .It Sy l2arc_noprefetch Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
83426735 | 186 | Do not write buffers to L2ARC if they were prefetched but not used by |
2d815d95 AZ |
187 | applications. |
188 | In case there are prefetched buffers in L2ARC and this option | |
189 | is later set, we do not read the prefetched buffers from L2ARC. | |
190 | Unsetting this option is useful for caching sequential reads from the | |
191 | disks to L2ARC and serve those reads from L2ARC later on. | |
192 | This may be beneficial in case the L2ARC device is significantly faster | |
193 | in sequential reads than the disks of the pool. | |
194 | .Pp | |
195 | Use | |
196 | .Sy 1 | |
197 | to disable and | |
198 | .Sy 0 | |
199 | to enable caching/reading prefetches to/from L2ARC. | |
200 | . | |
201 | .It Sy l2arc_norw Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
77f6826b | 202 | No reads during writes. |
2d815d95 | 203 | . |
887a3c53 | 204 | .It Sy l2arc_write_boost Ns = Ns Sy 33554432 Ns B Po 32 MiB Pc Pq u64 |
2d815d95 AZ |
205 | Cold L2ARC devices will have |
206 | .Sy l2arc_write_max | |
207 | increased by this amount while they remain cold. | |
208 | . | |
887a3c53 | 209 | .It Sy l2arc_write_max Ns = Ns Sy 33554432 Ns B Po 32 MiB Pc Pq u64 |
77f6826b | 210 | Max write bytes per interval. |
2d815d95 AZ |
211 | . |
212 | .It Sy l2arc_rebuild_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
213 | Rebuild the L2ARC when importing a pool (persistent L2ARC). | |
214 | This can be disabled if there are problems importing a pool | |
215 | or attaching an L2ARC device (e.g. the L2ARC device is slow | |
216 | in reading stored log metadata, or the metadata | |
77f6826b | 217 | has become somehow fragmented/unusable). |
2d815d95 | 218 | . |
ab8d9c17 | 219 | .It Sy l2arc_rebuild_blocks_min_l2size Ns = Ns Sy 1073741824 Ns B Po 1 GiB Pc Pq u64 |
2d815d95 AZ |
220 | Mininum size of an L2ARC device required in order to write log blocks in it. |
221 | The log blocks are used upon importing the pool to rebuild the persistent L2ARC. | |
222 | .Pp | |
a894ae75 | 223 | For L2ARC devices less than 1 GiB, the amount of data |
2d815d95 AZ |
224 | .Fn l2arc_evict |
225 | evicts is significant compared to the amount of restored L2ARC data. | |
226 | In this case, do not write log blocks in L2ARC in order not to waste space. | |
227 | . | |
ab8d9c17 | 228 | .It Sy metaslab_aliquot Ns = Ns Sy 1048576 Ns B Po 1 MiB Pc Pq u64 |
2d815d95 AZ |
229 | Metaslab granularity, in bytes. |
230 | This is roughly similar to what would be referred to as the "stripe size" | |
231 | in traditional RAID arrays. | |
c55b2932 AM |
232 | In normal operation, ZFS will try to write this amount of data to each disk |
233 | before moving on to the next top-level vdev. | |
2d815d95 AZ |
234 | . |
235 | .It Sy metaslab_bias_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
236 | Enable metaslab group biasing based on their vdevs' over- or under-utilization | |
f3a7f661 | 237 | relative to the pool. |
2d815d95 | 238 | . |
ab8d9c17 | 239 | .It Sy metaslab_force_ganging Ns = Ns Sy 16777217 Ns B Po 16 MiB + 1 B Pc Pq u64 |
2d815d95 AZ |
240 | Make some blocks above a certain size be gang blocks. |
241 | This option is used by the test suite to facilitate testing. | |
242 | . | |
46adb282 RN |
243 | .It Sy metaslab_force_ganging_pct Ns = Ns Sy 3 Ns % Pq uint |
244 | For blocks that could be forced to be a gang block (due to | |
245 | .Sy metaslab_force_ganging ) , | |
246 | force this many of them to be gang blocks. | |
247 | . | |
f68bde72 AM |
248 | .It Sy brt_zap_prefetch Ns = Ns Sy 1 Ns | Ns 0 Pq int |
249 | Controls prefetching BRT records for blocks which are going to be cloned. | |
250 | . | |
251 | .It Sy brt_zap_default_bs Ns = Ns Sy 12 Po 4 KiB Pc Pq int | |
252 | Default BRT ZAP data block size as a power of 2. Note that changing this after | |
253 | creating a BRT on the pool will not affect existing BRTs, only newly created | |
254 | ones. | |
255 | . | |
256 | .It Sy brt_zap_default_ibs Ns = Ns Sy 12 Po 4 KiB Pc Pq int | |
257 | Default BRT ZAP indirect block size as a power of 2. Note that changing this | |
258 | after creating a BRT on the pool will not affect existing BRTs, only newly | |
259 | created ones. | |
260 | . | |
261 | .It Sy ddt_zap_default_bs Ns = Ns Sy 15 Po 32 KiB Pc Pq int | |
2b10e325 RE |
262 | Default DDT ZAP data block size as a power of 2. Note that changing this after |
263 | creating a DDT on the pool will not affect existing DDTs, only newly created | |
264 | ones. | |
265 | . | |
f68bde72 | 266 | .It Sy ddt_zap_default_ibs Ns = Ns Sy 15 Po 32 KiB Pc Pq int |
2b10e325 RE |
267 | Default DDT ZAP indirect block size as a power of 2. Note that changing this |
268 | after creating a DDT on the pool will not affect existing DDTs, only newly | |
269 | created ones. | |
270 | . | |
926715b9 MP |
271 | .It Sy zfs_default_bs Ns = Ns Sy 9 Po 512 B Pc Pq int |
272 | Default dnode block size as a power of 2. | |
273 | . | |
274 | .It Sy zfs_default_ibs Ns = Ns Sy 17 Po 128 KiB Pc Pq int | |
275 | Default dnode indirect block size as a power of 2. | |
276 | . | |
ab8d9c17 | 277 | .It Sy zfs_history_output_max Ns = Ns Sy 1048576 Ns B Po 1 MiB Pc Pq u64 |
2d815d95 AZ |
278 | When attempting to log an output nvlist of an ioctl in the on-disk history, |
279 | the output will not be stored if it is larger than this size (in bytes). | |
280 | This must be less than | |
a894ae75 | 281 | .Sy DMU_MAX_ACCESS Pq 64 MiB . |
2d815d95 AZ |
282 | This applies primarily to |
283 | .Fn zfs_ioc_channel_program Pq cf. Xr zfs-program 8 . | |
284 | . | |
285 | .It Sy zfs_keep_log_spacemaps_at_export Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
93e28d66 | 286 | Prevent log spacemaps from being destroyed during pool exports and destroys. |
2d815d95 AZ |
287 | . |
288 | .It Sy zfs_metaslab_segment_weight_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
4e21fd06 | 289 | Enable/disable segment-based metaslab selection. |
2d815d95 AZ |
290 | . |
291 | .It Sy zfs_metaslab_switch_threshold Ns = Ns Sy 2 Pq int | |
4e21fd06 | 292 | When using segment-based metaslab selection, continue allocating |
2d815d95 | 293 | from the active metaslab until this option's |
4e21fd06 | 294 | worth of buckets have been exhausted. |
2d815d95 AZ |
295 | . |
296 | .It Sy metaslab_debug_load Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
aa7d06a9 | 297 | Load all metaslabs during pool import. |
2d815d95 AZ |
298 | . |
299 | .It Sy metaslab_debug_unload Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
aa7d06a9 | 300 | Prevent metaslabs from being unloaded. |
2d815d95 AZ |
301 | . |
302 | .It Sy metaslab_fragmentation_factor_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
f3a7f661 | 303 | Enable use of the fragmentation metric in computing metaslab weights. |
2d815d95 | 304 | . |
fdc2d303 | 305 | .It Sy metaslab_df_max_search Ns = Ns Sy 16777216 Ns B Po 16 MiB Pc Pq uint |
2d815d95 AZ |
306 | Maximum distance to search forward from the last offset. |
307 | Without this limit, fragmented pools can see | |
308 | .Em >100`000 | |
309 | iterations and | |
310 | .Fn metaslab_block_picker | |
d3230d76 | 311 | becomes the performance limiting factor on high-performance storage. |
2d815d95 AZ |
312 | .Pp |
313 | With the default setting of | |
a894ae75 | 314 | .Sy 16 MiB , |
2d815d95 AZ |
315 | we typically see less than |
316 | .Em 500 | |
317 | iterations, even with very fragmented | |
318 | .Sy ashift Ns = Ns Sy 9 | |
319 | pools. | |
320 | The maximum number of iterations possible is | |
321 | .Sy metaslab_df_max_search / 2^(ashift+1) . | |
322 | With the default setting of | |
a894ae75 | 323 | .Sy 16 MiB |
2d815d95 AZ |
324 | this is |
325 | .Em 16*1024 Pq with Sy ashift Ns = Ns Sy 9 | |
326 | or | |
327 | .Em 2*1024 Pq with Sy ashift Ns = Ns Sy 12 . | |
328 | . | |
329 | .It Sy metaslab_df_use_largest_segment Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
330 | If not searching forward (due to | |
331 | .Sy metaslab_df_max_search , metaslab_df_free_pct , | |
332 | .No or Sy metaslab_df_alloc_threshold ) , | |
333 | this tunable controls which segment is used. | |
334 | If set, we will use the largest free segment. | |
335 | If unset, we will use a segment of at least the requested size. | |
336 | . | |
ab8d9c17 | 337 | .It Sy zfs_metaslab_max_size_cache_sec Ns = Ns Sy 3600 Ns s Po 1 hour Pc Pq u64 |
2d815d95 AZ |
338 | When we unload a metaslab, we cache the size of the largest free chunk. |
339 | We use that cached size to determine whether or not to load a metaslab | |
340 | for a given allocation. | |
341 | As more frees accumulate in that metaslab while it's unloaded, | |
342 | the cached max size becomes less and less accurate. | |
343 | After a number of seconds controlled by this tunable, | |
344 | we stop considering the cached max size and start | |
c81f1790 | 345 | considering only the histogram instead. |
2d815d95 | 346 | . |
fdc2d303 | 347 | .It Sy zfs_metaslab_mem_limit Ns = Ns Sy 25 Ns % Pq uint |
f09fda50 | 348 | When we are loading a new metaslab, we check the amount of memory being used |
2d815d95 AZ |
349 | to store metaslab range trees. |
350 | If it is over a threshold, we attempt to unload the least recently used metaslab | |
351 | to prevent the system from clogging all of its memory with range trees. | |
352 | This tunable sets the percentage of total system memory that is the threshold. | |
353 | . | |
354 | .It Sy zfs_metaslab_try_hard_before_gang Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
355 | .Bl -item -compact | |
356 | .It | |
357 | If unset, we will first try normal allocation. | |
358 | .It | |
be5c6d96 | 359 | If that fails then we will do a gang allocation. |
2d815d95 | 360 | .It |
be5c6d96 | 361 | If that fails then we will do a "try hard" gang allocation. |
2d815d95 | 362 | .It |
be5c6d96 | 363 | If that fails then we will have a multi-layer gang block. |
2d815d95 AZ |
364 | .El |
365 | .Pp | |
366 | .Bl -item -compact | |
367 | .It | |
be5c6d96 | 368 | If set, we will first try normal allocation. |
2d815d95 | 369 | .It |
be5c6d96 | 370 | If that fails then we will do a "try hard" allocation. |
2d815d95 | 371 | .It |
be5c6d96 | 372 | If that fails we will do a gang allocation. |
2d815d95 | 373 | .It |
be5c6d96 | 374 | If that fails we will do a "try hard" gang allocation. |
2d815d95 | 375 | .It |
be5c6d96 | 376 | If that fails then we will have a multi-layer gang block. |
2d815d95 AZ |
377 | .El |
378 | . | |
fdc2d303 | 379 | .It Sy zfs_metaslab_find_max_tries Ns = Ns Sy 100 Pq uint |
be5c6d96 MA |
380 | When not trying hard, we only consider this number of the best metaslabs. |
381 | This improves performance, especially when there are many metaslabs per vdev | |
2d815d95 AZ |
382 | and the allocation can't actually be satisfied |
383 | (so we would otherwise iterate all metaslabs). | |
384 | . | |
fdc2d303 | 385 | .It Sy zfs_vdev_default_ms_count Ns = Ns Sy 200 Pq uint |
2d815d95 AZ |
386 | When a vdev is added, target this number of metaslabs per top-level vdev. |
387 | . | |
fdc2d303 | 388 | .It Sy zfs_vdev_default_ms_shift Ns = Ns Sy 29 Po 512 MiB Pc Pq uint |
ff73574c RN |
389 | Default lower limit for metaslab size. |
390 | . | |
391 | .It Sy zfs_vdev_max_ms_shift Ns = Ns Sy 34 Po 16 GiB Pc Pq uint | |
392 | Default upper limit for metaslab size. | |
2d815d95 | 393 | . |
ab8d9c17 | 394 | .It Sy zfs_vdev_max_auto_ashift Ns = Ns Sy 14 Pq uint |
b46be903 DS |
395 | Maximum ashift used when optimizing for logical \[->] physical sector size on |
396 | new | |
6fe3498c | 397 | top-level vdevs. |
37f6845c AM |
398 | May be increased up to |
399 | .Sy ASHIFT_MAX Po 16 Pc , | |
400 | but this may negatively impact pool space efficiency. | |
2d815d95 | 401 | . |
ab8d9c17 | 402 | .It Sy zfs_vdev_min_auto_ashift Ns = Ns Sy ASHIFT_MIN Po 9 Pc Pq uint |
6fe3498c | 403 | Minimum ashift used when creating new top-level vdevs. |
2d815d95 | 404 | . |
fdc2d303 | 405 | .It Sy zfs_vdev_min_ms_count Ns = Ns Sy 16 Pq uint |
d2734cce | 406 | Minimum number of metaslabs to create in a top-level vdev. |
2d815d95 AZ |
407 | . |
408 | .It Sy vdev_validate_skip Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
409 | Skip label validation steps during pool import. | |
410 | Changing is not recommended unless you know what you're doing | |
411 | and are recovering a damaged label. | |
412 | . | |
fdc2d303 | 413 | .It Sy zfs_vdev_ms_count_limit Ns = Ns Sy 131072 Po 128k Pc Pq uint |
e4e94ca3 | 414 | Practical upper limit of total metaslabs per top-level vdev. |
2d815d95 AZ |
415 | . |
416 | .It Sy metaslab_preload_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
f3a7f661 | 417 | Enable metaslab group preloading. |
2d815d95 | 418 | . |
342357cd AM |
419 | .It Sy metaslab_preload_limit Ns = Ns Sy 10 Pq uint |
420 | Maximum number of metaslabs per group to preload | |
421 | . | |
422 | .It Sy metaslab_preload_pct Ns = Ns Sy 50 Pq uint | |
423 | Percentage of CPUs to run a metaslab preload taskq | |
424 | . | |
2d815d95 AZ |
425 | .It Sy metaslab_lba_weighting_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int |
426 | Give more weight to metaslabs with lower LBAs, | |
427 | assuming they have greater bandwidth, | |
428 | as is typically the case on a modern constant angular velocity disk drive. | |
429 | . | |
fdc2d303 | 430 | .It Sy metaslab_unload_delay Ns = Ns Sy 32 Pq uint |
2d815d95 AZ |
431 | After a metaslab is used, we keep it loaded for this many TXGs, to attempt to |
432 | reduce unnecessary reloading. | |
433 | Note that both this many TXGs and | |
434 | .Sy metaslab_unload_delay_ms | |
435 | milliseconds must pass before unloading will occur. | |
436 | . | |
fdc2d303 | 437 | .It Sy metaslab_unload_delay_ms Ns = Ns Sy 600000 Ns ms Po 10 min Pc Pq uint |
2d815d95 AZ |
438 | After a metaslab is used, we keep it loaded for this many milliseconds, |
439 | to attempt to reduce unnecessary reloading. | |
440 | Note, that both this many milliseconds and | |
441 | .Sy metaslab_unload_delay | |
442 | TXGs must pass before unloading will occur. | |
443 | . | |
fdc2d303 | 444 | .It Sy reference_history Ns = Ns Sy 3 Pq uint |
b46be903 DS |
445 | Maximum reference holders being tracked when reference_tracking_enable is |
446 | active. | |
5caeef02 DB |
447 | .It Sy raidz_expand_max_copy_bytes Ns = Ns Sy 160MB Pq ulong |
448 | Max amount of memory to use for RAID-Z expansion I/O. | |
449 | This limits how much I/O can be outstanding at once. | |
450 | . | |
451 | .It Sy raidz_expand_max_reflow_bytes Ns = Ns Sy 0 Pq ulong | |
452 | For testing, pause RAID-Z expansion when reflow amount reaches this value. | |
453 | . | |
454 | .It Sy raidz_io_aggregate_rows Ns = Ns Sy 4 Pq ulong | |
455 | For expanded RAID-Z, aggregate reads that have more rows than this. | |
456 | . | |
457 | .It Sy reference_history Ns = Ns Sy 3 Pq int | |
458 | Maximum reference holders being tracked when reference_tracking_enable is | |
459 | active. | |
2d815d95 AZ |
460 | . |
461 | .It Sy reference_tracking_enable Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
462 | Track reference holders to | |
463 | .Sy refcount_t | |
464 | objects (debug builds only). | |
465 | . | |
466 | .It Sy send_holes_without_birth_time Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
467 | When set, the | |
468 | .Sy hole_birth | |
469 | optimization will not be used, and all holes will always be sent during a | |
470 | .Nm zfs Cm send . | |
471 | This is useful if you suspect your datasets are affected by a bug in | |
472 | .Sy hole_birth . | |
473 | . | |
474 | .It Sy spa_config_path Ns = Ns Pa /etc/zfs/zpool.cache Pq charp | |
475 | SPA config file. | |
476 | . | |
fdc2d303 | 477 | .It Sy spa_asize_inflation Ns = Ns Sy 24 Pq uint |
e8b96c60 | 478 | Multiplication factor used to estimate actual disk consumption from the |
2d815d95 AZ |
479 | size of data being written. |
480 | The default value is a worst case estimate, | |
481 | but lower values may be valid for a given pool depending on its configuration. | |
482 | Pool administrators who understand the factors involved | |
483 | may wish to specify a more realistic inflation factor, | |
484 | particularly if they operate close to quota or capacity limits. | |
485 | . | |
486 | .It Sy spa_load_print_vdev_tree Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
b46be903 DS |
487 | Whether to print the vdev tree in the debugging message buffer during pool |
488 | import. | |
2d815d95 AZ |
489 | . |
490 | .It Sy spa_load_verify_data Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
491 | Whether to traverse data blocks during an "extreme rewind" | |
492 | .Pq Fl X | |
493 | import. | |
494 | .Pp | |
dea377c0 | 495 | An extreme rewind import normally performs a full traversal of all |
2d815d95 AZ |
496 | blocks in the pool for verification. |
497 | If this parameter is unset, the traversal skips non-metadata blocks. | |
498 | It can be toggled once the | |
dea377c0 | 499 | import has started to stop or start the traversal of non-metadata blocks. |
2d815d95 AZ |
500 | . |
501 | .It Sy spa_load_verify_metadata Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
502 | Whether to traverse blocks during an "extreme rewind" | |
503 | .Pq Fl X | |
504 | pool import. | |
505 | .Pp | |
dea377c0 | 506 | An extreme rewind import normally performs a full traversal of all |
2d815d95 AZ |
507 | blocks in the pool for verification. |
508 | If this parameter is unset, the traversal is not performed. | |
509 | It can be toggled once the import has started to stop or start the traversal. | |
510 | . | |
fdc2d303 | 511 | .It Sy spa_load_verify_shift Ns = Ns Sy 4 Po 1/16th Pc Pq uint |
c8242a96 | 512 | Sets the maximum number of bytes to consume during pool import to the log2 |
77f6826b | 513 | fraction of the target ARC size. |
2d815d95 AZ |
514 | . |
515 | .It Sy spa_slop_shift Ns = Ns Sy 5 Po 1/32nd Pc Pq int | |
516 | Normally, we don't allow the last | |
517 | .Sy 3.2% Pq Sy 1/2^spa_slop_shift | |
518 | of space in the pool to be consumed. | |
519 | This ensures that we don't run the pool completely out of space, | |
520 | due to unaccounted changes (e.g. to the MOS). | |
521 | It also limits the worst-case time to allocate space. | |
522 | If we have less than this amount of free space, | |
523 | most ZPL operations (e.g. write, create) will return | |
524 | .Sy ENOSPC . | |
525 | . | |
3bd4df38 EN |
526 | .It Sy spa_num_allocators Ns = Ns Sy 4 Pq int |
527 | Determines the number of block alloctators to use per spa instance. | |
528 | Capped by the number of actual CPUs in the system. | |
529 | .Pp | |
530 | Note that setting this value too high could result in performance | |
531 | degredation and/or excess fragmentation. | |
532 | . | |
0409d332 GA |
533 | .It Sy spa_upgrade_errlog_limit Ns = Ns Sy 0 Pq uint |
534 | Limits the number of on-disk error log entries that will be converted to the | |
535 | new format when enabling the | |
536 | .Sy head_errlog | |
537 | feature. | |
538 | The default is to convert all log entries. | |
539 | . | |
fdc2d303 | 540 | .It Sy vdev_removal_max_span Ns = Ns Sy 32768 Ns B Po 32 KiB Pc Pq uint |
0dc2f70c MA |
541 | During top-level vdev removal, chunks of data are copied from the vdev |
542 | which may include free space in order to trade bandwidth for IOPS. | |
2d815d95 | 543 | This parameter determines the maximum span of free space, in bytes, |
0dc2f70c | 544 | which will be included as "unnecessary" data in a chunk of copied data. |
2d815d95 | 545 | .Pp |
0dc2f70c | 546 | The default value here was chosen to align with |
2d815d95 AZ |
547 | .Sy zfs_vdev_read_gap_limit , |
548 | which is a similar concept when doing | |
0dc2f70c | 549 | regular reads (but there's no reason it has to be the same). |
2d815d95 | 550 | . |
ab8d9c17 | 551 | .It Sy vdev_file_logical_ashift Ns = Ns Sy 9 Po 512 B Pc Pq u64 |
c494aa7f | 552 | Logical ashift for file-based devices. |
2d815d95 | 553 | . |
ab8d9c17 | 554 | .It Sy vdev_file_physical_ashift Ns = Ns Sy 9 Po 512 B Pc Pq u64 |
c494aa7f | 555 | Physical ashift for file-based devices. |
2d815d95 AZ |
556 | . |
557 | .It Sy zap_iterate_prefetch Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
558 | If set, when we start iterating over a ZAP object, | |
559 | prefetch the entire object (all leaf blocks). | |
560 | However, this is limited by | |
561 | .Sy dmu_prefetch_max . | |
562 | . | |
a4b21ead MP |
563 | .It Sy zap_micro_max_size Ns = Ns Sy 131072 Ns B Po 128 KiB Pc Pq int |
564 | Maximum micro ZAP size. | |
565 | A micro ZAP is upgraded to a fat ZAP, once it grows beyond the specified size. | |
566 | . | |
6aa8c21a AM |
567 | .It Sy zfetch_min_distance Ns = Ns Sy 4194304 Ns B Po 4 MiB Pc Pq uint |
568 | Min bytes to prefetch per stream. | |
569 | Prefetch distance starts from the demand access size and quickly grows to | |
570 | this value, doubling on each hit. | |
571 | After that it may grow further by 1/8 per hit, but only if some prefetch | |
572 | since last time haven't completed in time to satisfy demand request, i.e. | |
573 | prefetch depth didn't cover the read latency or the pool got saturated. | |
574 | . | |
575 | .It Sy zfetch_max_distance Ns = Ns Sy 67108864 Ns B Po 64 MiB Pc Pq uint | |
7dfc56d8 | 576 | Max bytes to prefetch per stream. |
2d815d95 | 577 | . |
a894ae75 | 578 | .It Sy zfetch_max_idistance Ns = Ns Sy 67108864 Ns B Po 64 MiB Pc Pq uint |
7dfc56d8 | 579 | Max bytes to prefetch indirects for per stream. |
2d815d95 AZ |
580 | . |
581 | .It Sy zfetch_max_streams Ns = Ns Sy 8 Pq uint | |
27b293be | 582 | Max number of streams per zfetch (prefetch streams per file). |
2d815d95 | 583 | . |
6aa8c21a AM |
584 | .It Sy zfetch_min_sec_reap Ns = Ns Sy 1 Pq uint |
585 | Min time before inactive prefetch stream can be reclaimed | |
586 | . | |
587 | .It Sy zfetch_max_sec_reap Ns = Ns Sy 2 Pq uint | |
588 | Max time before inactive prefetch stream can be deleted | |
2d815d95 AZ |
589 | . |
590 | .It Sy zfs_abd_scatter_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
67709516 | 591 | Enables ARC from using scatter/gather lists and forces all allocations to be |
2d815d95 AZ |
592 | linear in kernel memory. |
593 | Disabling can improve performance in some code paths | |
67709516 | 594 | at the expense of fragmented kernel memory. |
2d815d95 | 595 | . |
12bd322d | 596 | .It Sy zfs_abd_scatter_max_order Ns = Ns Sy MAX_ORDER\-1 Pq uint |
67709516 | 597 | Maximum number of consecutive memory pages allocated in a single block for |
2d815d95 AZ |
598 | scatter/gather lists. |
599 | .Pp | |
600 | The value of | |
601 | .Sy MAX_ORDER | |
602 | depends on kernel configuration. | |
603 | . | |
a894ae75 | 604 | .It Sy zfs_abd_scatter_min_size Ns = Ns Sy 1536 Ns B Po 1.5 KiB Pc Pq uint |
2d815d95 AZ |
605 | This is the minimum allocation size that will use scatter (page-based) ABDs. |
606 | Smaller allocations will use linear ABDs. | |
607 | . | |
ab8d9c17 | 608 | .It Sy zfs_arc_dnode_limit Ns = Ns Sy 0 Ns B Pq u64 |
25458cbe | 609 | When the number of bytes consumed by dnodes in the ARC exceeds this number of |
2d815d95 AZ |
610 | bytes, try to unpin some of it in response to demand for non-metadata. |
611 | This value acts as a ceiling to the amount of dnode metadata, and defaults to | |
612 | .Sy 0 , | |
613 | which indicates that a percent which is based on | |
614 | .Sy zfs_arc_dnode_limit_percent | |
615 | of the ARC meta buffers that may be used for dnodes. | |
ab8d9c17 | 616 | .It Sy zfs_arc_dnode_limit_percent Ns = Ns Sy 10 Ns % Pq u64 |
9907cc1c | 617 | Percentage that can be consumed by dnodes of ARC meta buffers. |
2d815d95 AZ |
618 | .Pp |
619 | See also | |
620 | .Sy zfs_arc_dnode_limit , | |
621 | which serves a similar purpose but has a higher priority if nonzero. | |
622 | . | |
ab8d9c17 | 623 | .It Sy zfs_arc_dnode_reduce_percent Ns = Ns Sy 10 Ns % Pq u64 |
25458cbe | 624 | Percentage of ARC dnodes to try to scan in response to demand for non-metadata |
2d815d95 AZ |
625 | when the number of bytes consumed by dnodes exceeds |
626 | .Sy zfs_arc_dnode_limit . | |
627 | . | |
fdc2d303 | 628 | .It Sy zfs_arc_average_blocksize Ns = Ns Sy 8192 Ns B Po 8 KiB Pc Pq uint |
49ddb315 | 629 | The ARC's buffer hash table is sized based on the assumption of an average |
2d815d95 | 630 | block size of this value. |
a894ae75 | 631 | This works out to roughly 1 MiB of hash table per 1 GiB of physical memory |
2d815d95 AZ |
632 | with 8-byte pointers. |
633 | For configurations with a known larger average block size, | |
634 | this value can be increased to reduce the memory footprint. | |
635 | . | |
fdc2d303 | 636 | .It Sy zfs_arc_eviction_pct Ns = Ns Sy 200 Ns % Pq uint |
2d815d95 AZ |
637 | When |
638 | .Fn arc_is_overflowing , | |
639 | .Fn arc_get_data_impl | |
640 | waits for this percent of the requested amount of data to be evicted. | |
641 | For example, by default, for every | |
a894ae75 | 642 | .Em 2 KiB |
2d815d95 | 643 | that's evicted, |
a894ae75 | 644 | .Em 1 KiB |
2d815d95 AZ |
645 | of it may be "reused" by a new allocation. |
646 | Since this is above | |
647 | .Sy 100 Ns % , | |
648 | it ensures that progress is made towards getting | |
649 | .Sy arc_size No under Sy arc_c . | |
650 | Since this is finite, it ensures that allocations can still happen, | |
651 | even during the potentially long time that | |
652 | .Sy arc_size No is more than Sy arc_c . | |
653 | . | |
fdc2d303 | 654 | .It Sy zfs_arc_evict_batch_limit Ns = Ns Sy 10 Pq uint |
8f343973 | 655 | Number ARC headers to evict per sub-list before proceeding to another sub-list. |
ca0bf58d PS |
656 | This batch-style operation prevents entire sub-lists from being evicted at once |
657 | but comes at a cost of additional unlocking and locking. | |
2d815d95 | 658 | . |
fdc2d303 | 659 | .It Sy zfs_arc_grow_retry Ns = Ns Sy 0 Ns s Pq uint |
2d815d95 AZ |
660 | If set to a non zero value, it will replace the |
661 | .Sy arc_grow_retry | |
662 | value with this value. | |
663 | The | |
664 | .Sy arc_grow_retry | |
665 | .No value Pq default Sy 5 Ns s | |
666 | is the number of seconds the ARC will wait before | |
ca85d690 | 667 | trying to resume growth after a memory pressure event. |
2d815d95 AZ |
668 | . |
669 | .It Sy zfs_arc_lotsfree_percent Ns = Ns Sy 10 Ns % Pq int | |
7e8bddd0 | 670 | Throttle I/O when free system memory drops below this percentage of total |
2d815d95 AZ |
671 | system memory. |
672 | Setting this value to | |
673 | .Sy 0 | |
674 | will disable the throttle. | |
675 | . | |
ab8d9c17 | 676 | .It Sy zfs_arc_max Ns = Ns Sy 0 Ns B Pq u64 |
2d815d95 AZ |
677 | Max size of ARC in bytes. |
678 | If | |
679 | .Sy 0 , | |
680 | then the max size of ARC is determined by the amount of system memory installed. | |
6a629f32 | 681 | The larger of |
a894ae75 | 682 | .Sy all_system_memory No \- Sy 1 GiB |
12bd322d AZ |
683 | and |
684 | .Sy 5/8 No \(mu Sy all_system_memory | |
2d815d95 AZ |
685 | will be used as the limit. |
686 | This value must be at least | |
a894ae75 | 687 | .Sy 67108864 Ns B Pq 64 MiB . |
2d815d95 AZ |
688 | .Pp |
689 | This value can be changed dynamically, with some caveats. | |
690 | It cannot be set back to | |
691 | .Sy 0 | |
692 | while running, and reducing it below the current ARC size will not cause | |
83426735 | 693 | the ARC to shrink without memory pressure to induce shrinking. |
2d815d95 | 694 | . |
a8d83e2a AM |
695 | .It Sy zfs_arc_meta_balance Ns = Ns Sy 500 Pq uint |
696 | Balance between metadata and data on ghost hits. | |
697 | Values above 100 increase metadata caching by proportionally reducing effect | |
698 | of ghost data hits on target data/metadata rate. | |
2d815d95 | 699 | . |
ab8d9c17 | 700 | .It Sy zfs_arc_min Ns = Ns Sy 0 Ns B Pq u64 |
2d815d95 AZ |
701 | Min size of ARC in bytes. |
702 | .No If set to Sy 0 , arc_c_min | |
703 | will default to consuming the larger of | |
a894ae75 | 704 | .Sy 32 MiB |
12bd322d AZ |
705 | and |
706 | .Sy all_system_memory No / Sy 32 . | |
2d815d95 | 707 | . |
fdc2d303 | 708 | .It Sy zfs_arc_min_prefetch_ms Ns = Ns Sy 0 Ns ms Ns Po Ns ≡ Ns 1s Pc Pq uint |
2d815d95 AZ |
709 | Minimum time prefetched blocks are locked in the ARC. |
710 | . | |
fdc2d303 | 711 | .It Sy zfs_arc_min_prescient_prefetch_ms Ns = Ns Sy 0 Ns ms Ns Po Ns ≡ Ns 6s Pc Pq uint |
2d815d95 AZ |
712 | Minimum time "prescient prefetched" blocks are locked in the ARC. |
713 | These blocks are meant to be prefetched fairly aggressively ahead of | |
714 | the code that may use them. | |
715 | . | |
462217d1 AM |
716 | .It Sy zfs_arc_prune_task_threads Ns = Ns Sy 1 Pq int |
717 | Number of arc_prune threads. | |
718 | .Fx | |
719 | does not need more than one. | |
720 | Linux may theoretically use one per mount point up to number of CPUs, | |
721 | but that was not proven to be useful. | |
722 | . | |
2d815d95 | 723 | .It Sy zfs_max_missing_tvds Ns = Ns Sy 0 Pq int |
6cb8e530 PZ |
724 | Number of missing top-level vdevs which will be allowed during |
725 | pool import (only in read-only mode). | |
2d815d95 | 726 | . |
ab8d9c17 | 727 | .It Sy zfs_max_nvlist_src_size Ns = Sy 0 Pq u64 |
2d815d95 AZ |
728 | Maximum size in bytes allowed to be passed as |
729 | .Sy zc_nvlist_src_size | |
730 | for ioctls on | |
731 | .Pa /dev/zfs . | |
732 | This prevents a user from causing the kernel to allocate | |
733 | an excessive amount of memory. | |
734 | When the limit is exceeded, the ioctl fails with | |
735 | .Sy EINVAL | |
736 | and a description of the error is sent to the | |
737 | .Pa zfs-dbgmsg | |
738 | log. | |
739 | This parameter should not need to be touched under normal circumstances. | |
740 | If | |
741 | .Sy 0 , | |
742 | equivalent to a quarter of the user-wired memory limit under | |
743 | .Fx | |
744 | and to | |
a894ae75 | 745 | .Sy 134217728 Ns B Pq 128 MiB |
2d815d95 AZ |
746 | under Linux. |
747 | . | |
fdc2d303 | 748 | .It Sy zfs_multilist_num_sublists Ns = Ns Sy 0 Pq uint |
ca0bf58d | 749 | To allow more fine-grained locking, each ARC state contains a series |
2d815d95 AZ |
750 | of lists for both data and metadata objects. |
751 | Locking is performed at the level of these "sub-lists". | |
752 | This parameters controls the number of sub-lists per ARC state, | |
753 | and also applies to other uses of the multilist data structure. | |
754 | .Pp | |
755 | If | |
756 | .Sy 0 , | |
757 | equivalent to the greater of the number of online CPUs and | |
758 | .Sy 4 . | |
759 | . | |
760 | .It Sy zfs_arc_overflow_shift Ns = Ns Sy 8 Pq int | |
ca0bf58d | 761 | The ARC size is considered to be overflowing if it exceeds the current |
2d815d95 AZ |
762 | ARC target size |
763 | .Pq Sy arc_c | |
f7de776d AM |
764 | by thresholds determined by this parameter. |
765 | Exceeding by | |
12bd322d | 766 | .Sy ( arc_c No >> Sy zfs_arc_overflow_shift ) No / Sy 2 |
f7de776d AM |
767 | starts ARC reclamation process. |
768 | If that appears insufficient, exceeding by | |
12bd322d | 769 | .Sy ( arc_c No >> Sy zfs_arc_overflow_shift ) No \(mu Sy 1.5 |
f7de776d AM |
770 | blocks new buffer allocation until the reclaim thread catches up. |
771 | Started reclamation process continues till ARC size returns below the | |
772 | target size. | |
2d815d95 AZ |
773 | .Pp |
774 | The default value of | |
775 | .Sy 8 | |
f7de776d AM |
776 | causes the ARC to start reclamation if it exceeds the target size by |
777 | .Em 0.2% | |
778 | of the target size, and block allocations by | |
779 | .Em 0.6% . | |
2d815d95 | 780 | . |
fdc2d303 | 781 | .It Sy zfs_arc_shrink_shift Ns = Ns Sy 0 Pq uint |
2d815d95 AZ |
782 | If nonzero, this will update |
783 | .Sy arc_shrink_shift Pq default Sy 7 | |
ca85d690 | 784 | with the new value. |
2d815d95 AZ |
785 | . |
786 | .It Sy zfs_arc_pc_percent Ns = Ns Sy 0 Ns % Po off Pc Pq uint | |
787 | Percent of pagecache to reclaim ARC to. | |
788 | .Pp | |
789 | This tunable allows the ZFS ARC to play more nicely | |
790 | with the kernel's LRU pagecache. | |
791 | It can guarantee that the ARC size won't collapse under scanning | |
792 | pressure on the pagecache, yet still allows the ARC to be reclaimed down to | |
793 | .Sy zfs_arc_min | |
794 | if necessary. | |
795 | This value is specified as percent of pagecache size (as measured by | |
796 | .Sy NR_FILE_PAGES ) , | |
797 | where that percent may exceed | |
798 | .Sy 100 . | |
799 | This | |
03b60eee | 800 | only operates during memory pressure/reclaim. |
2d815d95 AZ |
801 | . |
802 | .It Sy zfs_arc_shrinker_limit Ns = Ns Sy 10000 Pq int | |
3442c2a0 | 803 | This is a limit on how many pages the ARC shrinker makes available for |
2d815d95 AZ |
804 | eviction in response to one page allocation attempt. |
805 | Note that in practice, the kernel's shrinker can ask us to evict | |
806 | up to about four times this for one allocation attempt. | |
807 | .Pp | |
808 | The default limit of | |
a894ae75 | 809 | .Sy 10000 Pq in practice, Em 160 MiB No per allocation attempt with 4 KiB pages |
2d815d95 | 810 | limits the amount of time spent attempting to reclaim ARC memory to |
a894ae75 W |
811 | less than 100 ms per allocation attempt, |
812 | even with a small average compressed block size of ~8 KiB. | |
2d815d95 AZ |
813 | .Pp |
814 | The parameter can be set to 0 (zero) to disable the limit, | |
815 | and only applies on Linux. | |
816 | . | |
ab8d9c17 | 817 | .It Sy zfs_arc_sys_free Ns = Ns Sy 0 Ns B Pq u64 |
11f552fa | 818 | The target number of bytes the ARC should leave as free memory on the system. |
2d815d95 | 819 | If zero, equivalent to the bigger of |
a894ae75 | 820 | .Sy 512 KiB No and Sy all_system_memory/64 . |
2d815d95 AZ |
821 | . |
822 | .It Sy zfs_autoimport_disable Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
823 | Disable pool import at module load by ignoring the cache file | |
824 | .Pq Sy spa_config_path . | |
825 | . | |
826 | .It Sy zfs_checksum_events_per_second Ns = Ns Sy 20 Ns /s Pq uint | |
827 | Rate limit checksum events to this many per second. | |
828 | Note that this should not be set below the ZED thresholds | |
829 | (currently 10 checksums over 10 seconds) | |
830 | or else the daemon may not trigger any action. | |
831 | . | |
252f46be | 832 | .It Sy zfs_commit_timeout_pct Ns = Ns Sy 10 Ns % Pq uint |
2fe61a7e PS |
833 | This controls the amount of time that a ZIL block (lwb) will remain "open" |
834 | when it isn't "full", and it has a thread waiting for it to be committed to | |
2d815d95 AZ |
835 | stable storage. |
836 | The timeout is scaled based on a percentage of the last lwb | |
2fe61a7e PS |
837 | latency to avoid significantly impacting the latency of each individual |
838 | transaction record (itx). | |
2d815d95 AZ |
839 | . |
840 | .It Sy zfs_condense_indirect_commit_entry_delay_ms Ns = Ns Sy 0 Ns ms Pq int | |
67709516 | 841 | Vdev indirection layer (used for device removal) sleeps for this many |
2d815d95 AZ |
842 | milliseconds during mapping generation. |
843 | Intended for use with the test suite to throttle vdev removal speed. | |
844 | . | |
fdc2d303 | 845 | .It Sy zfs_condense_indirect_obsolete_pct Ns = Ns Sy 25 Ns % Pq uint |
b46be903 DS |
846 | Minimum percent of obsolete bytes in vdev mapping required to attempt to |
847 | condense | |
2d815d95 AZ |
848 | .Pq see Sy zfs_condense_indirect_vdevs_enable . |
849 | Intended for use with the test suite | |
850 | to facilitate triggering condensing as needed. | |
851 | . | |
852 | .It Sy zfs_condense_indirect_vdevs_enable Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
853 | Enable condensing indirect vdev mappings. | |
854 | When set, attempt to condense indirect vdev mappings | |
855 | if the mapping uses more than | |
856 | .Sy zfs_condense_min_mapping_bytes | |
857 | bytes of memory and if the obsolete space map object uses more than | |
858 | .Sy zfs_condense_max_obsolete_bytes | |
859 | bytes on-disk. | |
b46be903 DS |
860 | The condensing process is an attempt to save memory by removing obsolete |
861 | mappings. | |
2d815d95 | 862 | . |
ab8d9c17 | 863 | .It Sy zfs_condense_max_obsolete_bytes Ns = Ns Sy 1073741824 Ns B Po 1 GiB Pc Pq u64 |
0dc2f70c MA |
864 | Only attempt to condense indirect vdev mappings if the on-disk size |
865 | of the obsolete space map object is greater than this number of bytes | |
2d815d95 AZ |
866 | .Pq see Sy zfs_condense_indirect_vdevs_enable . |
867 | . | |
ab8d9c17 | 868 | .It Sy zfs_condense_min_mapping_bytes Ns = Ns Sy 131072 Ns B Po 128 KiB Pc Pq u64 |
2d815d95 AZ |
869 | Minimum size vdev mapping to attempt to condense |
870 | .Pq see Sy zfs_condense_indirect_vdevs_enable . | |
871 | . | |
872 | .It Sy zfs_dbgmsg_enable Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
873 | Internally ZFS keeps a small log to facilitate debugging. | |
874 | The log is enabled by default, and can be disabled by unsetting this option. | |
875 | The contents of the log can be accessed by reading | |
876 | .Pa /proc/spl/kstat/zfs/dbgmsg . | |
877 | Writing | |
878 | .Sy 0 | |
879 | to the file clears the log. | |
880 | .Pp | |
881 | This setting does not influence debug prints due to | |
882 | .Sy zfs_flags . | |
883 | . | |
fdc2d303 | 884 | .It Sy zfs_dbgmsg_maxsize Ns = Ns Sy 4194304 Ns B Po 4 MiB Pc Pq uint |
2d815d95 AZ |
885 | Maximum size of the internal ZFS debug log. |
886 | . | |
887 | .It Sy zfs_dbuf_state_index Ns = Ns Sy 0 Pq int | |
888 | Historically used for controlling what reporting was available under | |
889 | .Pa /proc/spl/kstat/zfs . | |
890 | No effect. | |
891 | . | |
892 | .It Sy zfs_deadman_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
893 | When a pool sync operation takes longer than | |
894 | .Sy zfs_deadman_synctime_ms , | |
895 | or when an individual I/O operation takes longer than | |
896 | .Sy zfs_deadman_ziotime_ms , | |
897 | then the operation is considered to be "hung". | |
898 | If | |
899 | .Sy zfs_deadman_enabled | |
900 | is set, then the deadman behavior is invoked as described by | |
901 | .Sy zfs_deadman_failmode . | |
902 | By default, the deadman is enabled and set to | |
903 | .Sy wait | |
a737b415 | 904 | which results in "hung" I/O operations only being logged. |
2d815d95 AZ |
905 | The deadman is automatically disabled when a pool gets suspended. |
906 | . | |
907 | .It Sy zfs_deadman_failmode Ns = Ns Sy wait Pq charp | |
908 | Controls the failure behavior when the deadman detects a "hung" I/O operation. | |
909 | Valid values are: | |
910 | .Bl -tag -compact -offset 4n -width "continue" | |
911 | .It Sy wait | |
912 | Wait for a "hung" operation to complete. | |
913 | For each "hung" operation a "deadman" event will be posted | |
914 | describing that operation. | |
915 | .It Sy continue | |
916 | Attempt to recover from a "hung" operation by re-dispatching it | |
8fb1ede1 | 917 | to the I/O pipeline if possible. |
2d815d95 AZ |
918 | .It Sy panic |
919 | Panic the system. | |
920 | This can be used to facilitate automatic fail-over | |
921 | to a properly configured fail-over partner. | |
922 | .El | |
923 | . | |
ab8d9c17 | 924 | .It Sy zfs_deadman_checktime_ms Ns = Ns Sy 60000 Ns ms Po 1 min Pc Pq u64 |
2d815d95 AZ |
925 | Check time in milliseconds. |
926 | This defines the frequency at which we check for hung I/O requests | |
927 | and potentially invoke the | |
928 | .Sy zfs_deadman_failmode | |
929 | behavior. | |
930 | . | |
ab8d9c17 | 931 | .It Sy zfs_deadman_synctime_ms Ns = Ns Sy 600000 Ns ms Po 10 min Pc Pq u64 |
b81a3ddc | 932 | Interval in milliseconds after which the deadman is triggered and also |
8fb1ede1 BB |
933 | the interval after which a pool sync operation is considered to be "hung". |
934 | Once this limit is exceeded the deadman will be invoked every | |
2d815d95 AZ |
935 | .Sy zfs_deadman_checktime_ms |
936 | milliseconds until the pool sync completes. | |
937 | . | |
ab8d9c17 | 938 | .It Sy zfs_deadman_ziotime_ms Ns = Ns Sy 300000 Ns ms Po 5 min Pc Pq u64 |
8fb1ede1 | 939 | Interval in milliseconds after which the deadman is triggered and an |
2d815d95 AZ |
940 | individual I/O operation is considered to be "hung". |
941 | As long as the operation remains "hung", | |
942 | the deadman will be invoked every | |
943 | .Sy zfs_deadman_checktime_ms | |
944 | milliseconds until the operation completes. | |
945 | . | |
946 | .It Sy zfs_dedup_prefetch Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
947 | Enable prefetching dedup-ed blocks which are going to be freed. | |
948 | . | |
fdc2d303 | 949 | .It Sy zfs_delay_min_dirty_percent Ns = Ns Sy 60 Ns % Pq uint |
e8b96c60 | 950 | Start to delay each transaction once there is this amount of dirty data, |
2d815d95 AZ |
951 | expressed as a percentage of |
952 | .Sy zfs_dirty_data_max . | |
953 | This value should be at least | |
954 | .Sy zfs_vdev_async_write_active_max_dirty_percent . | |
955 | .No See Sx ZFS TRANSACTION DELAY . | |
956 | . | |
957 | .It Sy zfs_delay_scale Ns = Ns Sy 500000 Pq int | |
e8b96c60 MA |
958 | This controls how quickly the transaction delay approaches infinity. |
959 | Larger values cause longer delays for a given amount of dirty data. | |
2d815d95 | 960 | .Pp |
e8b96c60 | 961 | For the smoothest delay, this value should be about 1 billion divided |
2d815d95 AZ |
962 | by the maximum number of operations per second. |
963 | This will smoothly handle between ten times and a tenth of this number. | |
964 | .No See Sx ZFS TRANSACTION DELAY . | |
965 | .Pp | |
12bd322d | 966 | .Sy zfs_delay_scale No \(mu Sy zfs_dirty_data_max Em must No be smaller than Sy 2^64 . |
2d815d95 AZ |
967 | . |
968 | .It Sy zfs_disable_ivset_guid_check Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
969 | Disables requirement for IVset GUIDs to be present and match when doing a raw | |
970 | receive of encrypted datasets. | |
971 | Intended for users whose pools were created with | |
d0249a4b | 972 | OpenZFS pre-release versions and now have compatibility issues. |
2d815d95 AZ |
973 | . |
974 | .It Sy zfs_key_max_salt_uses Ns = Ns Sy 400000000 Po 4*10^8 Pc Pq ulong | |
67709516 | 975 | Maximum number of uses of a single salt value before generating a new one for |
2d815d95 AZ |
976 | encrypted datasets. |
977 | The default value is also the maximum. | |
978 | . | |
979 | .It Sy zfs_object_mutex_size Ns = Ns Sy 64 Pq uint | |
67709516 | 980 | Size of the znode hashtable used for holds. |
2d815d95 | 981 | .Pp |
67709516 D |
982 | Due to the need to hold locks on objects that may not exist yet, kernel mutexes |
983 | are not created per-object and instead a hashtable is used where collisions | |
984 | will result in objects waiting when there is not actually contention on the | |
985 | same object. | |
2d815d95 AZ |
986 | . |
987 | .It Sy zfs_slow_io_events_per_second Ns = Ns Sy 20 Ns /s Pq int | |
b46be903 DS |
988 | Rate limit delay and deadman zevents (which report slow I/O operations) to this |
989 | many per | |
e778b048 | 990 | second. |
2d815d95 | 991 | . |
ab8d9c17 | 992 | .It Sy zfs_unflushed_max_mem_amt Ns = Ns Sy 1073741824 Ns B Po 1 GiB Pc Pq u64 |
93e28d66 | 993 | Upper-bound limit for unflushed metadata changes to be held by the |
2d815d95 AZ |
994 | log spacemap in memory, in bytes. |
995 | . | |
ab8d9c17 | 996 | .It Sy zfs_unflushed_max_mem_ppm Ns = Ns Sy 1000 Ns ppm Po 0.1% Pc Pq u64 |
2d815d95 AZ |
997 | Part of overall system memory that ZFS allows to be used |
998 | for unflushed metadata changes by the log spacemap, in millionths. | |
999 | . | |
ab8d9c17 | 1000 | .It Sy zfs_unflushed_log_block_max Ns = Ns Sy 131072 Po 128k Pc Pq u64 |
93e28d66 | 1001 | Describes the maximum number of log spacemap blocks allowed for each pool. |
2d815d95 AZ |
1002 | The default value means that the space in all the log spacemaps |
1003 | can add up to no more than | |
600a02b8 | 1004 | .Sy 131072 |
2d815d95 | 1005 | blocks (which means |
a894ae75 | 1006 | .Em 16 GiB |
2d815d95 AZ |
1007 | of logical space before compression and ditto blocks, |
1008 | assuming that blocksize is | |
a894ae75 | 1009 | .Em 128 KiB ) . |
2d815d95 | 1010 | .Pp |
93e28d66 SD |
1011 | This tunable is important because it involves a trade-off between import |
1012 | time after an unclean export and the frequency of flushing metaslabs. | |
1013 | The higher this number is, the more log blocks we allow when the pool is | |
1014 | active which means that we flush metaslabs less often and thus decrease | |
a737b415 | 1015 | the number of I/O operations for spacemap updates per TXG. |
93e28d66 SD |
1016 | At the same time though, that means that in the event of an unclean export, |
1017 | there will be more log spacemap blocks for us to read, inducing overhead | |
1018 | in the import time of the pool. | |
2d815d95 | 1019 | The lower the number, the amount of flushing increases, destroying log |
93e28d66 SD |
1020 | blocks quicker as they become obsolete faster, which leaves less blocks |
1021 | to be read during import time after a crash. | |
2d815d95 | 1022 | .Pp |
93e28d66 SD |
1023 | Each log spacemap block existing during pool import leads to approximately |
1024 | one extra logical I/O issued. | |
1025 | This is the reason why this tunable is exposed in terms of blocks rather | |
1026 | than space used. | |
2d815d95 | 1027 | . |
ab8d9c17 | 1028 | .It Sy zfs_unflushed_log_block_min Ns = Ns Sy 1000 Pq u64 |
2d815d95 AZ |
1029 | If the number of metaslabs is small and our incoming rate is high, |
1030 | we could get into a situation that we are flushing all our metaslabs every TXG. | |
93e28d66 | 1031 | Thus we always allow at least this many log blocks. |
2d815d95 | 1032 | . |
ab8d9c17 | 1033 | .It Sy zfs_unflushed_log_block_pct Ns = Ns Sy 400 Ns % Pq u64 |
93e28d66 SD |
1034 | Tunable used to determine the number of blocks that can be used for |
1035 | the spacemap log, expressed as a percentage of the total number of | |
600a02b8 AM |
1036 | unflushed metaslabs in the pool. |
1037 | . | |
ab8d9c17 | 1038 | .It Sy zfs_unflushed_log_txg_max Ns = Ns Sy 1000 Pq u64 |
600a02b8 AM |
1039 | Tunable limiting maximum time in TXGs any metaslab may remain unflushed. |
1040 | It effectively limits maximum number of unflushed per-TXG spacemap logs | |
1041 | that need to be read after unclean pool export. | |
2d815d95 AZ |
1042 | . |
1043 | .It Sy zfs_unlink_suspend_progress Ns = Ns Sy 0 Ns | Ns 1 Pq uint | |
dcec0a12 | 1044 | When enabled, files will not be asynchronously removed from the list of pending |
2d815d95 AZ |
1045 | unlinks and the space they consume will be leaked. |
1046 | Once this option has been disabled and the dataset is remounted, | |
1047 | the pending unlinks will be processed and the freed space returned to the pool. | |
1048 | This option is used by the test suite. | |
1049 | . | |
1050 | .It Sy zfs_delete_blocks Ns = Ns Sy 20480 Pq ulong | |
1051 | This is the used to define a large file for the purposes of deletion. | |
1052 | Files containing more than | |
1053 | .Sy zfs_delete_blocks | |
1054 | will be deleted asynchronously, while smaller files are deleted synchronously. | |
1055 | Decreasing this value will reduce the time spent in an | |
1056 | .Xr unlink 2 | |
b46be903 DS |
1057 | system call, at the expense of a longer delay before the freed space is |
1058 | available. | |
ab8d9c17 | 1059 | This only applies on Linux. |
2d815d95 AZ |
1060 | . |
1061 | .It Sy zfs_dirty_data_max Ns = Pq int | |
1062 | Determines the dirty space limit in bytes. | |
1063 | Once this limit is exceeded, new writes are halted until space frees up. | |
1064 | This parameter takes precedence over | |
1065 | .Sy zfs_dirty_data_max_percent . | |
1066 | .No See Sx ZFS TRANSACTION DELAY . | |
1067 | .Pp | |
1068 | Defaults to | |
1069 | .Sy physical_ram/10 , | |
1070 | capped at | |
1071 | .Sy zfs_dirty_data_max_max . | |
1072 | . | |
1073 | .It Sy zfs_dirty_data_max_max Ns = Pq int | |
1074 | Maximum allowable value of | |
1075 | .Sy zfs_dirty_data_max , | |
1076 | expressed in bytes. | |
1077 | This limit is only enforced at module load time, and will be ignored if | |
1078 | .Sy zfs_dirty_data_max | |
1079 | is later changed. | |
1080 | This parameter takes precedence over | |
1081 | .Sy zfs_dirty_data_max_max_percent . | |
1082 | .No See Sx ZFS TRANSACTION DELAY . | |
1083 | .Pp | |
1084 | Defaults to | |
a379083d GM |
1085 | .Sy min(physical_ram/4, 4GiB) , |
1086 | or | |
1087 | .Sy min(physical_ram/4, 1GiB) | |
1088 | for 32-bit systems. | |
2d815d95 | 1089 | . |
fdc2d303 | 1090 | .It Sy zfs_dirty_data_max_max_percent Ns = Ns Sy 25 Ns % Pq uint |
2d815d95 AZ |
1091 | Maximum allowable value of |
1092 | .Sy zfs_dirty_data_max , | |
1093 | expressed as a percentage of physical RAM. | |
e8b96c60 | 1094 | This limit is only enforced at module load time, and will be ignored if |
2d815d95 AZ |
1095 | .Sy zfs_dirty_data_max |
1096 | is later changed. | |
1097 | The parameter | |
1098 | .Sy zfs_dirty_data_max_max | |
1099 | takes precedence over this one. | |
1100 | .No See Sx ZFS TRANSACTION DELAY . | |
1101 | . | |
fdc2d303 | 1102 | .It Sy zfs_dirty_data_max_percent Ns = Ns Sy 10 Ns % Pq uint |
2d815d95 AZ |
1103 | Determines the dirty space limit, expressed as a percentage of all memory. |
1104 | Once this limit is exceeded, new writes are halted until space frees up. | |
1105 | The parameter | |
1106 | .Sy zfs_dirty_data_max | |
1107 | takes precedence over this one. | |
1108 | .No See Sx ZFS TRANSACTION DELAY . | |
1109 | .Pp | |
1110 | Subject to | |
1111 | .Sy zfs_dirty_data_max_max . | |
1112 | . | |
fdc2d303 | 1113 | .It Sy zfs_dirty_data_sync_percent Ns = Ns Sy 20 Ns % Pq uint |
dfbe2675 | 1114 | Start syncing out a transaction group if there's at least this much dirty data |
2d815d95 AZ |
1115 | .Pq as a percentage of Sy zfs_dirty_data_max . |
1116 | This should be less than | |
1117 | .Sy zfs_vdev_async_write_active_min_dirty_percent . | |
1118 | . | |
a7bd20e3 KJ |
1119 | .It Sy zfs_wrlog_data_max Ns = Pq int |
1120 | The upper limit of write-transaction zil log data size in bytes. | |
84d0a03f AM |
1121 | Write operations are throttled when approaching the limit until log data is |
1122 | cleared out after transaction group sync. | |
1123 | Because of some overhead, it should be set at least 2 times the size of | |
a7bd20e3 | 1124 | .Sy zfs_dirty_data_max |
b46be903 | 1125 | .No to prevent harming normal write throughput . |
a7bd20e3 KJ |
1126 | It also should be smaller than the size of the slog device if slog is present. |
1127 | .Pp | |
1128 | Defaults to | |
1129 | .Sy zfs_dirty_data_max*2 | |
1130 | . | |
2d815d95 | 1131 | .It Sy zfs_fallocate_reserve_percent Ns = Ns Sy 110 Ns % Pq uint |
f734301d AD |
1132 | Since ZFS is a copy-on-write filesystem with snapshots, blocks cannot be |
1133 | preallocated for a file in order to guarantee that later writes will not | |
2d815d95 AZ |
1134 | run out of space. |
1135 | Instead, | |
1136 | .Xr fallocate 2 | |
1137 | space preallocation only checks that sufficient space is currently available | |
1138 | in the pool or the user's project quota allocation, | |
1139 | and then creates a sparse file of the requested size. | |
1140 | The requested space is multiplied by | |
1141 | .Sy zfs_fallocate_reserve_percent | |
f734301d | 1142 | to allow additional space for indirect blocks and other internal metadata. |
2d815d95 AZ |
1143 | Setting this to |
1144 | .Sy 0 | |
1145 | disables support for | |
1146 | .Xr fallocate 2 | |
1147 | and causes it to return | |
1148 | .Sy EOPNOTSUPP . | |
1149 | . | |
1150 | .It Sy zfs_fletcher_4_impl Ns = Ns Sy fastest Pq string | |
1eeb4562 | 1151 | Select a fletcher 4 implementation. |
2d815d95 AZ |
1152 | .Pp |
1153 | Supported selectors are: | |
1154 | .Sy fastest , scalar , sse2 , ssse3 , avx2 , avx512f , avx512bw , | |
1155 | .No and Sy aarch64_neon . | |
1156 | All except | |
1157 | .Sy fastest No and Sy scalar | |
1158 | require instruction set extensions to be available, | |
1159 | and will only appear if ZFS detects that they are present at runtime. | |
1160 | If multiple implementations of fletcher 4 are available, the | |
1161 | .Sy fastest | |
1162 | will be chosen using a micro benchmark. | |
1163 | Selecting | |
1164 | .Sy scalar | |
1165 | results in the original CPU-based calculation being used. | |
1166 | Selecting any option other than | |
1167 | .Sy fastest No or Sy scalar | |
1168 | results in vector instructions | |
1169 | from the respective CPU instruction set being used. | |
1170 | . | |
03e9caae RE |
1171 | .It Sy zfs_bclone_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int |
1172 | Enable the experimental block cloning feature. | |
1173 | If this setting is 0, then even if feature@block_cloning is enabled, | |
1174 | attempts to clone blocks will act as though the feature is disabled. | |
1175 | . | |
6dccdf50 BB |
1176 | .It Sy zfs_bclone_wait_dirty Ns = Ns Sy 0 Ns | Ns 1 Pq int |
1177 | When set to 1 the FICLONE and FICLONERANGE ioctls wait for dirty data to be | |
1178 | written to disk. | |
1179 | This allows the clone operation to reliably succeed when a file is | |
1180 | modified and then immediately cloned. | |
1181 | For small files this may be slower than making a copy of the file. | |
1182 | Therefore, this setting defaults to 0 which causes a clone operation to | |
1183 | immediately fail when encountering a dirty block. | |
1184 | . | |
eeca9d27 TR |
1185 | .It Sy zfs_blake3_impl Ns = Ns Sy fastest Pq string |
1186 | Select a BLAKE3 implementation. | |
1187 | .Pp | |
1188 | Supported selectors are: | |
1189 | .Sy cycle , fastest , generic , sse2 , sse41 , avx2 , avx512 . | |
1190 | All except | |
1191 | .Sy cycle , fastest No and Sy generic | |
1192 | require instruction set extensions to be available, | |
1193 | and will only appear if ZFS detects that they are present at runtime. | |
1194 | If multiple implementations of BLAKE3 are available, the | |
1195 | .Sy fastest will be chosen using a micro benchmark. You can see the | |
1196 | benchmark results by reading this kstat file: | |
1197 | .Pa /proc/spl/kstat/zfs/chksum_bench . | |
1198 | . | |
2d815d95 | 1199 | .It Sy zfs_free_bpobj_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int |
ba5ad9a4 | 1200 | Enable/disable the processing of the free_bpobj object. |
2d815d95 | 1201 | . |
ab8d9c17 | 1202 | .It Sy zfs_async_block_max_blocks Ns = Ns Sy UINT64_MAX Po unlimited Pc Pq u64 |
2d815d95 AZ |
1203 | Maximum number of blocks freed in a single TXG. |
1204 | . | |
ab8d9c17 | 1205 | .It Sy zfs_max_async_dedup_frees Ns = Ns Sy 100000 Po 10^5 Pc Pq u64 |
2d815d95 AZ |
1206 | Maximum number of dedup blocks freed in a single TXG. |
1207 | . | |
fdc2d303 | 1208 | .It Sy zfs_vdev_async_read_max_active Ns = Ns Sy 3 Pq uint |
2d815d95 AZ |
1209 | Maximum asynchronous read I/O operations active to each device. |
1210 | .No See Sx ZFS I/O SCHEDULER . | |
1211 | . | |
fdc2d303 | 1212 | .It Sy zfs_vdev_async_read_min_active Ns = Ns Sy 1 Pq uint |
2d815d95 AZ |
1213 | Minimum asynchronous read I/O operation active to each device. |
1214 | .No See Sx ZFS I/O SCHEDULER . | |
1215 | . | |
fdc2d303 | 1216 | .It Sy zfs_vdev_async_write_active_max_dirty_percent Ns = Ns Sy 60 Ns % Pq uint |
2d815d95 AZ |
1217 | When the pool has more than this much dirty data, use |
1218 | .Sy zfs_vdev_async_write_max_active | |
1219 | to limit active async writes. | |
1220 | If the dirty data is between the minimum and maximum, | |
1221 | the active I/O limit is linearly interpolated. | |
1222 | .No See Sx ZFS I/O SCHEDULER . | |
1223 | . | |
fdc2d303 | 1224 | .It Sy zfs_vdev_async_write_active_min_dirty_percent Ns = Ns Sy 30 Ns % Pq uint |
2d815d95 AZ |
1225 | When the pool has less than this much dirty data, use |
1226 | .Sy zfs_vdev_async_write_min_active | |
1227 | to limit active async writes. | |
1228 | If the dirty data is between the minimum and maximum, | |
1229 | the active I/O limit is linearly | |
1230 | interpolated. | |
1231 | .No See Sx ZFS I/O SCHEDULER . | |
1232 | . | |
077fd55e | 1233 | .It Sy zfs_vdev_async_write_max_active Ns = Ns Sy 10 Pq uint |
2d815d95 AZ |
1234 | Maximum asynchronous write I/O operations active to each device. |
1235 | .No See Sx ZFS I/O SCHEDULER . | |
1236 | . | |
fdc2d303 | 1237 | .It Sy zfs_vdev_async_write_min_active Ns = Ns Sy 2 Pq uint |
2d815d95 AZ |
1238 | Minimum asynchronous write I/O operations active to each device. |
1239 | .No See Sx ZFS I/O SCHEDULER . | |
1240 | .Pp | |
06226b59 | 1241 | Lower values are associated with better latency on rotational media but poorer |
2d815d95 AZ |
1242 | resilver performance. |
1243 | The default value of | |
1244 | .Sy 2 | |
1245 | was chosen as a compromise. | |
1246 | A value of | |
1247 | .Sy 3 | |
1248 | has been shown to improve resilver performance further at a cost of | |
06226b59 | 1249 | further increasing latency. |
2d815d95 | 1250 | . |
fdc2d303 | 1251 | .It Sy zfs_vdev_initializing_max_active Ns = Ns Sy 1 Pq uint |
2d815d95 AZ |
1252 | Maximum initializing I/O operations active to each device. |
1253 | .No See Sx ZFS I/O SCHEDULER . | |
1254 | . | |
fdc2d303 | 1255 | .It Sy zfs_vdev_initializing_min_active Ns = Ns Sy 1 Pq uint |
2d815d95 AZ |
1256 | Minimum initializing I/O operations active to each device. |
1257 | .No See Sx ZFS I/O SCHEDULER . | |
1258 | . | |
fdc2d303 | 1259 | .It Sy zfs_vdev_max_active Ns = Ns Sy 1000 Pq uint |
2d815d95 AZ |
1260 | The maximum number of I/O operations active to each device. |
1261 | Ideally, this will be at least the sum of each queue's | |
1262 | .Sy max_active . | |
1263 | .No See Sx ZFS I/O SCHEDULER . | |
1264 | . | |
f66ffe68 SD |
1265 | .It Sy zfs_vdev_open_timeout_ms Ns = Ns Sy 1000 Pq uint |
1266 | Timeout value to wait before determining a device is missing | |
1267 | during import. | |
1268 | This is helpful for transient missing paths due | |
1269 | to links being briefly removed and recreated in response to | |
1270 | udev events. | |
1271 | . | |
fdc2d303 | 1272 | .It Sy zfs_vdev_rebuild_max_active Ns = Ns Sy 3 Pq uint |
2d815d95 AZ |
1273 | Maximum sequential resilver I/O operations active to each device. |
1274 | .No See Sx ZFS I/O SCHEDULER . | |
1275 | . | |
fdc2d303 | 1276 | .It Sy zfs_vdev_rebuild_min_active Ns = Ns Sy 1 Pq uint |
2d815d95 AZ |
1277 | Minimum sequential resilver I/O operations active to each device. |
1278 | .No See Sx ZFS I/O SCHEDULER . | |
1279 | . | |
fdc2d303 | 1280 | .It Sy zfs_vdev_removal_max_active Ns = Ns Sy 2 Pq uint |
2d815d95 AZ |
1281 | Maximum removal I/O operations active to each device. |
1282 | .No See Sx ZFS I/O SCHEDULER . | |
1283 | . | |
fdc2d303 | 1284 | .It Sy zfs_vdev_removal_min_active Ns = Ns Sy 1 Pq uint |
2d815d95 AZ |
1285 | Minimum removal I/O operations active to each device. |
1286 | .No See Sx ZFS I/O SCHEDULER . | |
1287 | . | |
fdc2d303 | 1288 | .It Sy zfs_vdev_scrub_max_active Ns = Ns Sy 2 Pq uint |
2d815d95 AZ |
1289 | Maximum scrub I/O operations active to each device. |
1290 | .No See Sx ZFS I/O SCHEDULER . | |
1291 | . | |
fdc2d303 | 1292 | .It Sy zfs_vdev_scrub_min_active Ns = Ns Sy 1 Pq uint |
2d815d95 AZ |
1293 | Minimum scrub I/O operations active to each device. |
1294 | .No See Sx ZFS I/O SCHEDULER . | |
1295 | . | |
fdc2d303 | 1296 | .It Sy zfs_vdev_sync_read_max_active Ns = Ns Sy 10 Pq uint |
2d815d95 AZ |
1297 | Maximum synchronous read I/O operations active to each device. |
1298 | .No See Sx ZFS I/O SCHEDULER . | |
1299 | . | |
fdc2d303 | 1300 | .It Sy zfs_vdev_sync_read_min_active Ns = Ns Sy 10 Pq uint |
2d815d95 AZ |
1301 | Minimum synchronous read I/O operations active to each device. |
1302 | .No See Sx ZFS I/O SCHEDULER . | |
1303 | . | |
fdc2d303 | 1304 | .It Sy zfs_vdev_sync_write_max_active Ns = Ns Sy 10 Pq uint |
2d815d95 AZ |
1305 | Maximum synchronous write I/O operations active to each device. |
1306 | .No See Sx ZFS I/O SCHEDULER . | |
1307 | . | |
fdc2d303 | 1308 | .It Sy zfs_vdev_sync_write_min_active Ns = Ns Sy 10 Pq uint |
2d815d95 AZ |
1309 | Minimum synchronous write I/O operations active to each device. |
1310 | .No See Sx ZFS I/O SCHEDULER . | |
1311 | . | |
fdc2d303 | 1312 | .It Sy zfs_vdev_trim_max_active Ns = Ns Sy 2 Pq uint |
2d815d95 AZ |
1313 | Maximum trim/discard I/O operations active to each device. |
1314 | .No See Sx ZFS I/O SCHEDULER . | |
1315 | . | |
fdc2d303 | 1316 | .It Sy zfs_vdev_trim_min_active Ns = Ns Sy 1 Pq uint |
2d815d95 AZ |
1317 | Minimum trim/discard I/O operations active to each device. |
1318 | .No See Sx ZFS I/O SCHEDULER . | |
1319 | . | |
fdc2d303 | 1320 | .It Sy zfs_vdev_nia_delay Ns = Ns Sy 5 Pq uint |
6f5aac3c | 1321 | For non-interactive I/O (scrub, resilver, removal, initialize and rebuild), |
2d815d95 AZ |
1322 | the number of concurrently-active I/O operations is limited to |
1323 | .Sy zfs_*_min_active , | |
1324 | unless the vdev is "idle". | |
0175272f | 1325 | When there are no interactive I/O operations active (synchronous or otherwise), |
2d815d95 AZ |
1326 | and |
1327 | .Sy zfs_vdev_nia_delay | |
1328 | operations have completed since the last interactive operation, | |
1329 | then the vdev is considered to be "idle", | |
1330 | and the number of concurrently-active non-interactive operations is increased to | |
1331 | .Sy zfs_*_max_active . | |
1332 | .No See Sx ZFS I/O SCHEDULER . | |
1333 | . | |
fdc2d303 | 1334 | .It Sy zfs_vdev_nia_credit Ns = Ns Sy 5 Pq uint |
2d815d95 AZ |
1335 | Some HDDs tend to prioritize sequential I/O so strongly, that concurrent |
1336 | random I/O latency reaches several seconds. | |
1337 | On some HDDs this happens even if sequential I/O operations | |
1338 | are submitted one at a time, and so setting | |
1339 | .Sy zfs_*_max_active Ns = Sy 1 | |
1340 | does not help. | |
1341 | To prevent non-interactive I/O, like scrub, | |
1342 | from monopolizing the device, no more than | |
1343 | .Sy zfs_vdev_nia_credit operations can be sent | |
1344 | while there are outstanding incomplete interactive operations. | |
1345 | This enforced wait ensures the HDD services the interactive I/O | |
6f5aac3c | 1346 | within a reasonable amount of time. |
2d815d95 AZ |
1347 | .No See Sx ZFS I/O SCHEDULER . |
1348 | . | |
fdc2d303 | 1349 | .It Sy zfs_vdev_queue_depth_pct Ns = Ns Sy 1000 Ns % Pq uint |
e815485f | 1350 | Maximum number of queued allocations per top-level vdev expressed as |
2d815d95 AZ |
1351 | a percentage of |
1352 | .Sy zfs_vdev_async_write_max_active , | |
1353 | which allows the system to detect devices that are more capable | |
1354 | of handling allocations and to allocate more blocks to those devices. | |
1355 | This allows for dynamic allocation distribution when devices are imbalanced, | |
1356 | as fuller devices will tend to be slower than empty devices. | |
1357 | .Pp | |
1358 | Also see | |
1359 | .Sy zio_dva_throttle_enabled . | |
1360 | . | |
ece7ab7e RN |
1361 | .It Sy zfs_vdev_def_queue_depth Ns = Ns Sy 32 Pq uint |
1362 | Default queue depth for each vdev IO allocator. | |
1363 | Higher values allow for better coalescing of sequential writes before sending | |
1364 | them to the disk, but can increase transaction commit times. | |
1365 | . | |
16f0fdad MZ |
1366 | .It Sy zfs_vdev_failfast_mask Ns = Ns Sy 1 Pq uint |
1367 | Defines if the driver should retire on a given error type. | |
1368 | The following options may be bitwise-ored together: | |
1369 | .TS | |
1370 | box; | |
1371 | lbz r l l . | |
1372 | Value Name Description | |
1373 | _ | |
1374 | 1 Device No driver retries on device errors | |
1375 | 2 Transport No driver retries on transport errors. | |
1376 | 4 Driver No driver retries on driver errors. | |
1377 | .TE | |
1378 | . | |
06a19602 RN |
1379 | .It Sy zfs_vdev_disk_max_segs Ns = Ns Sy 0 Pq uint |
1380 | Maximum number of segments to add to a BIO (min 4). | |
1381 | If this is higher than the maximum allowed by the device queue or the kernel | |
1382 | itself, it will be clamped. | |
1383 | Setting it to zero will cause the kernel's ideal size to be used. | |
1384 | This parameter only applies on Linux. | |
df2169d1 RN |
1385 | This parameter is ignored if |
1386 | .Sy zfs_vdev_disk_classic Ns = Ns Sy 1 . | |
1387 | . | |
1388 | .It Sy zfs_vdev_disk_classic Ns = Ns Sy 0 Ns | Ns 1 Pq uint | |
1389 | If set to 1, OpenZFS will submit IO to Linux using the method it used in 2.2 | |
1390 | and earlier. | |
1391 | This "classic" method has known issues with highly fragmented IO requests and | |
1392 | is slower on many workloads, but it has been in use for many years and is known | |
1393 | to be very stable. | |
1394 | If you set this parameter, please also open a bug report why you did so, | |
1395 | including the workload involved and any error messages. | |
1396 | .Pp | |
1397 | This parameter and the classic submission method will be removed once we have | |
1398 | total confidence in the new method. | |
1399 | .Pp | |
1400 | This parameter only applies on Linux, and can only be set at module load time. | |
06a19602 | 1401 | . |
2d815d95 AZ |
1402 | .It Sy zfs_expire_snapshot Ns = Ns Sy 300 Ns s Pq int |
1403 | Time before expiring | |
1404 | .Pa .zfs/snapshot . | |
1405 | . | |
1406 | .It Sy zfs_admin_snapshot Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
1407 | Allow the creation, removal, or renaming of entries in the | |
1408 | .Sy .zfs/snapshot | |
0500e835 | 1409 | directory to cause the creation, destruction, or renaming of snapshots. |
2d815d95 AZ |
1410 | When enabled, this functionality works both locally and over NFS exports |
1411 | which have the | |
1412 | .Em no_root_squash | |
1413 | option set. | |
1414 | . | |
1415 | .It Sy zfs_flags Ns = Ns Sy 0 Pq int | |
1416 | Set additional debugging flags. | |
1417 | The following flags may be bitwise-ored together: | |
33b6dbbc NB |
1418 | .TS |
1419 | box; | |
2d815d95 | 1420 | lbz r l l . |
16f0fdad | 1421 | Value Name Description |
33b6dbbc | 1422 | _ |
2d815d95 AZ |
1423 | 1 ZFS_DEBUG_DPRINTF Enable dprintf entries in the debug log. |
1424 | * 2 ZFS_DEBUG_DBUF_VERIFY Enable extra dbuf verifications. | |
1425 | * 4 ZFS_DEBUG_DNODE_VERIFY Enable extra dnode verifications. | |
1426 | 8 ZFS_DEBUG_SNAPNAMES Enable snapshot name verification. | |
bacf366f | 1427 | * 16 ZFS_DEBUG_MODIFY Check for illegally modified ARC buffers. |
2d815d95 AZ |
1428 | 64 ZFS_DEBUG_ZIO_FREE Enable verification of block frees. |
1429 | 128 ZFS_DEBUG_HISTOGRAM_VERIFY Enable extra spacemap histogram verifications. | |
1430 | 256 ZFS_DEBUG_METASLAB_VERIFY Verify space accounting on disk matches in-memory \fBrange_trees\fP. | |
1431 | 512 ZFS_DEBUG_SET_ERROR Enable \fBSET_ERROR\fP and dprintf entries in the debug log. | |
1432 | 1024 ZFS_DEBUG_INDIRECT_REMAP Verify split blocks created by device removal. | |
1433 | 2048 ZFS_DEBUG_TRIM Verify TRIM ranges are always within the allocatable range tree. | |
1434 | 4096 ZFS_DEBUG_LOG_SPACEMAP Verify that the log summary is consistent with the spacemap log | |
1435 | and enable \fBzfs_dbgmsgs\fP for metaslab loading and flushing. | |
33b6dbbc | 1436 | .TE |
b46be903 | 1437 | .Sy \& * No Requires debug build . |
2d815d95 | 1438 | . |
b24d1c77 RY |
1439 | .It Sy zfs_btree_verify_intensity Ns = Ns Sy 0 Pq uint |
1440 | Enables btree verification. | |
1441 | The following settings are culminative: | |
1442 | .TS | |
1443 | box; | |
1444 | lbz r l l . | |
1445 | Value Description | |
1446 | ||
1447 | 1 Verify height. | |
1448 | 2 Verify pointers from children to parent. | |
1449 | 3 Verify element counts. | |
1450 | 4 Verify element order. (expensive) | |
1451 | * 5 Verify unused memory is poisoned. (expensive) | |
1452 | .TE | |
b46be903 | 1453 | .Sy \& * No Requires debug build . |
b24d1c77 | 1454 | . |
2d815d95 AZ |
1455 | .It Sy zfs_free_leak_on_eio Ns = Ns Sy 0 Ns | Ns 1 Pq int |
1456 | If destroy encounters an | |
1457 | .Sy EIO | |
1458 | while reading metadata (e.g. indirect blocks), | |
1459 | space referenced by the missing metadata can not be freed. | |
1460 | Normally this causes the background destroy to become "stalled", | |
1461 | as it is unable to make forward progress. | |
1462 | While in this stalled state, all remaining space to free | |
1463 | from the error-encountering filesystem is "temporarily leaked". | |
1464 | Set this flag to cause it to ignore the | |
1465 | .Sy EIO , | |
fbeddd60 MA |
1466 | permanently leak the space from indirect blocks that can not be read, |
1467 | and continue to free everything else that it can. | |
2d815d95 AZ |
1468 | .Pp |
1469 | The default "stalling" behavior is useful if the storage partially | |
1470 | fails (i.e. some but not all I/O operations fail), and then later recovers. | |
1471 | In this case, we will be able to continue pool operations while it is | |
fbeddd60 | 1472 | partially failed, and when it recovers, we can continue to free the |
2d815d95 AZ |
1473 | space, with no leaks. |
1474 | Note, however, that this case is actually fairly rare. | |
1475 | .Pp | |
1476 | Typically pools either | |
1477 | .Bl -enum -compact -offset 4n -width "1." | |
1478 | .It | |
1479 | fail completely (but perhaps temporarily, | |
1480 | e.g. due to a top-level vdev going offline), or | |
1481 | .It | |
1482 | have localized, permanent errors (e.g. disk returns the wrong data | |
1483 | due to bit flip or firmware bug). | |
1484 | .El | |
1485 | In the former case, this setting does not matter because the | |
fbeddd60 | 1486 | pool will be suspended and the sync thread will not be able to make |
2d815d95 AZ |
1487 | forward progress regardless. |
1488 | In the latter, because the error is permanent, the best we can do | |
1489 | is leak the minimum amount of space, | |
1490 | which is what setting this flag will do. | |
1491 | It is therefore reasonable for this flag to normally be set, | |
1492 | but we chose the more conservative approach of not setting it, | |
1493 | so that there is no possibility of | |
fbeddd60 | 1494 | leaking space in the "partial temporary" failure case. |
2d815d95 | 1495 | . |
fdc2d303 | 1496 | .It Sy zfs_free_min_time_ms Ns = Ns Sy 1000 Ns ms Po 1s Pc Pq uint |
2d815d95 AZ |
1497 | During a |
1498 | .Nm zfs Cm destroy | |
1499 | operation using the | |
1500 | .Sy async_destroy | |
1501 | feature, | |
1502 | a minimum of this much time will be spent working on freeing blocks per TXG. | |
1503 | . | |
fdc2d303 | 1504 | .It Sy zfs_obsolete_min_time_ms Ns = Ns Sy 500 Ns ms Pq uint |
2d815d95 AZ |
1505 | Similar to |
1506 | .Sy zfs_free_min_time_ms , | |
1507 | but for cleanup of old indirection records for removed vdevs. | |
1508 | . | |
ab8d9c17 | 1509 | .It Sy zfs_immediate_write_sz Ns = Ns Sy 32768 Ns B Po 32 KiB Pc Pq s64 |
2d815d95 AZ |
1510 | Largest data block to write to the ZIL. |
1511 | Larger blocks will be treated as if the dataset being written to had the | |
1512 | .Sy logbias Ns = Ns Sy throughput | |
1513 | property set. | |
1514 | . | |
ab8d9c17 | 1515 | .It Sy zfs_initialize_value Ns = Ns Sy 16045690984833335022 Po 0xDEADBEEFDEADBEEE Pc Pq u64 |
2d815d95 AZ |
1516 | Pattern written to vdev free space by |
1517 | .Xr zpool-initialize 8 . | |
1518 | . | |
ab8d9c17 | 1519 | .It Sy zfs_initialize_chunk_size Ns = Ns Sy 1048576 Ns B Po 1 MiB Pc Pq u64 |
2d815d95 AZ |
1520 | Size of writes used by |
1521 | .Xr zpool-initialize 8 . | |
1522 | This option is used by the test suite. | |
1523 | . | |
ab8d9c17 | 1524 | .It Sy zfs_livelist_max_entries Ns = Ns Sy 500000 Po 5*10^5 Pc Pq u64 |
37f03da8 SH |
1525 | The threshold size (in block pointers) at which we create a new sub-livelist. |
1526 | Larger sublists are more costly from a memory perspective but the fewer | |
1527 | sublists there are, the lower the cost of insertion. | |
2d815d95 AZ |
1528 | . |
1529 | .It Sy zfs_livelist_min_percent_shared Ns = Ns Sy 75 Ns % Pq int | |
37f03da8 | 1530 | If the amount of shared space between a snapshot and its clone drops below |
2d815d95 AZ |
1531 | this threshold, the clone turns off the livelist and reverts to the old |
1532 | deletion method. | |
1533 | This is in place because livelists no long give us a benefit | |
1534 | once a clone has been overwritten enough. | |
1535 | . | |
1536 | .It Sy zfs_livelist_condense_new_alloc Ns = Ns Sy 0 Pq int | |
37f03da8 SH |
1537 | Incremented each time an extra ALLOC blkptr is added to a livelist entry while |
1538 | it is being condensed. | |
1539 | This option is used by the test suite to track race conditions. | |
2d815d95 AZ |
1540 | . |
1541 | .It Sy zfs_livelist_condense_sync_cancel Ns = Ns Sy 0 Pq int | |
37f03da8 | 1542 | Incremented each time livelist condensing is canceled while in |
2d815d95 | 1543 | .Fn spa_livelist_condense_sync . |
37f03da8 | 1544 | This option is used by the test suite to track race conditions. |
2d815d95 AZ |
1545 | . |
1546 | .It Sy zfs_livelist_condense_sync_pause Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
37f03da8 | 1547 | When set, the livelist condense process pauses indefinitely before |
12bd322d | 1548 | executing the synctask \(em |
2d815d95 | 1549 | .Fn spa_livelist_condense_sync . |
37f03da8 | 1550 | This option is used by the test suite to trigger race conditions. |
2d815d95 AZ |
1551 | . |
1552 | .It Sy zfs_livelist_condense_zthr_cancel Ns = Ns Sy 0 Pq int | |
37f03da8 | 1553 | Incremented each time livelist condensing is canceled while in |
2d815d95 | 1554 | .Fn spa_livelist_condense_cb . |
37f03da8 | 1555 | This option is used by the test suite to track race conditions. |
2d815d95 AZ |
1556 | . |
1557 | .It Sy zfs_livelist_condense_zthr_pause Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
37f03da8 | 1558 | When set, the livelist condense process pauses indefinitely before |
2d815d95 AZ |
1559 | executing the open context condensing work in |
1560 | .Fn spa_livelist_condense_cb . | |
37f03da8 | 1561 | This option is used by the test suite to trigger race conditions. |
2d815d95 | 1562 | . |
ab8d9c17 | 1563 | .It Sy zfs_lua_max_instrlimit Ns = Ns Sy 100000000 Po 10^8 Pc Pq u64 |
917f475f JG |
1564 | The maximum execution time limit that can be set for a ZFS channel program, |
1565 | specified as a number of Lua instructions. | |
2d815d95 | 1566 | . |
ab8d9c17 | 1567 | .It Sy zfs_lua_max_memlimit Ns = Ns Sy 104857600 Po 100 MiB Pc Pq u64 |
917f475f JG |
1568 | The maximum memory limit that can be set for a ZFS channel program, specified |
1569 | in bytes. | |
2d815d95 AZ |
1570 | . |
1571 | .It Sy zfs_max_dataset_nesting Ns = Ns Sy 50 Pq int | |
1572 | The maximum depth of nested datasets. | |
1573 | This value can be tuned temporarily to | |
a7ed98d8 | 1574 | fix existing datasets that exceed the predefined limit. |
2d815d95 | 1575 | . |
ab8d9c17 | 1576 | .It Sy zfs_max_log_walking Ns = Ns Sy 5 Pq u64 |
93e28d66 SD |
1577 | The number of past TXGs that the flushing algorithm of the log spacemap |
1578 | feature uses to estimate incoming log blocks. | |
2d815d95 | 1579 | . |
ab8d9c17 | 1580 | .It Sy zfs_max_logsm_summary_length Ns = Ns Sy 10 Pq u64 |
93e28d66 | 1581 | Maximum number of rows allowed in the summary of the spacemap log. |
2d815d95 | 1582 | . |
fdc2d303 | 1583 | .It Sy zfs_max_recordsize Ns = Ns Sy 16777216 Po 16 MiB Pc Pq uint |
2d815d95 | 1584 | We currently support block sizes from |
a894ae75 | 1585 | .Em 512 Po 512 B Pc No to Em 16777216 Po 16 MiB Pc . |
2d815d95 AZ |
1586 | The benefits of larger blocks, and thus larger I/O, |
1587 | need to be weighed against the cost of COWing a giant block to modify one byte. | |
1588 | Additionally, very large blocks can have an impact on I/O latency, | |
1589 | and also potentially on the memory allocator. | |
f2330bd1 RE |
1590 | Therefore, we formerly forbade creating blocks larger than 1M. |
1591 | Larger blocks could be created by changing it, | |
2d815d95 | 1592 | and pools with larger blocks can always be imported and used, |
f1512ee6 | 1593 | regardless of this setting. |
2d815d95 AZ |
1594 | . |
1595 | .It Sy zfs_allow_redacted_dataset_mount Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
1596 | Allow datasets received with redacted send/receive to be mounted. | |
1597 | Normally disabled because these datasets may be missing key data. | |
1598 | . | |
ab8d9c17 | 1599 | .It Sy zfs_min_metaslabs_to_flush Ns = Ns Sy 1 Pq u64 |
2d815d95 AZ |
1600 | Minimum number of metaslabs to flush per dirty TXG. |
1601 | . | |
fdc2d303 | 1602 | .It Sy zfs_metaslab_fragmentation_threshold Ns = Ns Sy 70 Ns % Pq uint |
f3a7f661 | 1603 | Allow metaslabs to keep their active state as long as their fragmentation |
2d815d95 AZ |
1604 | percentage is no more than this value. |
1605 | An active metaslab that exceeds this threshold | |
1606 | will no longer keep its active status allowing better metaslabs to be selected. | |
1607 | . | |
fdc2d303 | 1608 | .It Sy zfs_mg_fragmentation_threshold Ns = Ns Sy 95 Ns % Pq uint |
f3a7f661 | 1609 | Metaslab groups are considered eligible for allocations if their |
83426735 | 1610 | fragmentation metric (measured as a percentage) is less than or equal to |
2d815d95 AZ |
1611 | this value. |
1612 | If a metaslab group exceeds this threshold then it will be | |
f3a7f661 GW |
1613 | skipped unless all metaslab groups within the metaslab class have also |
1614 | crossed this threshold. | |
2d815d95 | 1615 | . |
fdc2d303 | 1616 | .It Sy zfs_mg_noalloc_threshold Ns = Ns Sy 0 Ns % Pq uint |
2d815d95 AZ |
1617 | Defines a threshold at which metaslab groups should be eligible for allocations. |
1618 | The value is expressed as a percentage of free space | |
f4a4046b TC |
1619 | beyond which a metaslab group is always eligible for allocations. |
1620 | If a metaslab group's free space is less than or equal to the | |
6b4e21c6 | 1621 | threshold, the allocator will avoid allocating to that group |
2d815d95 AZ |
1622 | unless all groups in the pool have reached the threshold. |
1623 | Once all groups have reached the threshold, all groups are allowed to accept | |
1624 | allocations. | |
1625 | The default value of | |
1626 | .Sy 0 | |
b46be903 DS |
1627 | disables the feature and causes all metaslab groups to be eligible for |
1628 | allocations. | |
2d815d95 | 1629 | .Pp |
b58237e7 | 1630 | This parameter allows one to deal with pools having heavily imbalanced |
f4a4046b TC |
1631 | vdevs such as would be the case when a new vdev has been added. |
1632 | Setting the threshold to a non-zero percentage will stop allocations | |
1633 | from being made to vdevs that aren't filled to the specified percentage | |
1634 | and allow lesser filled vdevs to acquire more allocations than they | |
2d815d95 AZ |
1635 | otherwise would under the old |
1636 | .Sy zfs_mg_alloc_failures | |
1637 | facility. | |
1638 | . | |
1639 | .It Sy zfs_ddt_data_is_special Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
cc99f275 | 1640 | If enabled, ZFS will place DDT data into the special allocation class. |
2d815d95 AZ |
1641 | . |
1642 | .It Sy zfs_user_indirect_is_special Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
1643 | If enabled, ZFS will place user data indirect blocks | |
cc99f275 | 1644 | into the special allocation class. |
2d815d95 | 1645 | . |
fdc2d303 | 1646 | .It Sy zfs_multihost_history Ns = Ns Sy 0 Pq uint |
b46be903 DS |
1647 | Historical statistics for this many latest multihost updates will be available |
1648 | in | |
2d815d95 AZ |
1649 | .Pa /proc/spl/kstat/zfs/ Ns Ao Ar pool Ac Ns Pa /multihost . |
1650 | . | |
ab8d9c17 | 1651 | .It Sy zfs_multihost_interval Ns = Ns Sy 1000 Ns ms Po 1 s Pc Pq u64 |
379ca9cf | 1652 | Used to control the frequency of multihost writes which are performed when the |
2d815d95 AZ |
1653 | .Sy multihost |
1654 | pool property is on. | |
1655 | This is one of the factors used to determine the | |
060f0226 | 1656 | length of the activity check during import. |
2d815d95 AZ |
1657 | .Pp |
1658 | The multihost write period is | |
12bd322d | 1659 | .Sy zfs_multihost_interval No / Sy leaf-vdevs . |
2d815d95 AZ |
1660 | On average a multihost write will be issued for each leaf vdev |
1661 | every | |
1662 | .Sy zfs_multihost_interval | |
1663 | milliseconds. | |
1664 | In practice, the observed period can vary with the I/O load | |
1665 | and this observed value is the delay which is stored in the uberblock. | |
1666 | . | |
1667 | .It Sy zfs_multihost_import_intervals Ns = Ns Sy 20 Pq uint | |
1668 | Used to control the duration of the activity test on import. | |
1669 | Smaller values of | |
1670 | .Sy zfs_multihost_import_intervals | |
1671 | will reduce the import time but increase | |
1672 | the risk of failing to detect an active pool. | |
1673 | The total activity check time is never allowed to drop below one second. | |
1674 | .Pp | |
060f0226 | 1675 | On import the activity check waits a minimum amount of time determined by |
12bd322d | 1676 | .Sy zfs_multihost_interval No \(mu Sy zfs_multihost_import_intervals , |
2d815d95 AZ |
1677 | or the same product computed on the host which last had the pool imported, |
1678 | whichever is greater. | |
1679 | The activity check time may be further extended if the value of MMP | |
060f0226 | 1680 | delay found in the best uberblock indicates actual multihost updates happened |
2d815d95 AZ |
1681 | at longer intervals than |
1682 | .Sy zfs_multihost_interval . | |
1683 | A minimum of | |
a894ae75 | 1684 | .Em 100 ms |
2d815d95 AZ |
1685 | is enforced. |
1686 | .Pp | |
1687 | .Sy 0 No is equivalent to Sy 1 . | |
1688 | . | |
1689 | .It Sy zfs_multihost_fail_intervals Ns = Ns Sy 10 Pq uint | |
060f0226 OF |
1690 | Controls the behavior of the pool when multihost write failures or delays are |
1691 | detected. | |
2d815d95 AZ |
1692 | .Pp |
1693 | When | |
1694 | .Sy 0 , | |
1695 | multihost write failures or delays are ignored. | |
1696 | The failures will still be reported to the ZED which depending on | |
060f0226 OF |
1697 | its configuration may take action such as suspending the pool or offlining a |
1698 | device. | |
2d815d95 AZ |
1699 | .Pp |
1700 | Otherwise, the pool will be suspended if | |
12bd322d | 1701 | .Sy zfs_multihost_fail_intervals No \(mu Sy zfs_multihost_interval |
2d815d95 AZ |
1702 | milliseconds pass without a successful MMP write. |
1703 | This guarantees the activity test will see MMP writes if the pool is imported. | |
1704 | .Sy 1 No is equivalent to Sy 2 ; | |
1705 | this is necessary to prevent the pool from being suspended | |
060f0226 | 1706 | due to normal, small I/O latency variations. |
2d815d95 AZ |
1707 | . |
1708 | .It Sy zfs_no_scrub_io Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
1709 | Set to disable scrub I/O. | |
1710 | This results in scrubs not actually scrubbing data and | |
83426735 | 1711 | simply doing a metadata crawl of the pool instead. |
2d815d95 AZ |
1712 | . |
1713 | .It Sy zfs_no_scrub_prefetch Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
83426735 | 1714 | Set to disable block prefetching for scrubs. |
2d815d95 AZ |
1715 | . |
1716 | .It Sy zfs_nocacheflush Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
1717 | Disable cache flush operations on disks when writing. | |
1718 | Setting this will cause pool corruption on power loss | |
1719 | if a volatile out-of-order write cache is enabled. | |
1720 | . | |
1721 | .It Sy zfs_nopwrite_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
1722 | Allow no-operation writes. | |
1723 | The occurrence of nopwrites will further depend on other pool properties | |
1724 | .Pq i.a. the checksumming and compression algorithms . | |
1725 | . | |
05b3eb6d | 1726 | .It Sy zfs_dmu_offset_next_sync Ns = Ns Sy 1 Ns | Ns 0 Pq int |
2d815d95 | 1727 | Enable forcing TXG sync to find holes. |
05b3eb6d | 1728 | When enabled forces ZFS to sync data when |
2d815d95 | 1729 | .Sy SEEK_HOLE No or Sy SEEK_DATA |
05b3eb6d BB |
1730 | flags are used allowing holes in a file to be accurately reported. |
1731 | When disabled holes will not be reported in recently dirtied files. | |
2d815d95 | 1732 | . |
a894ae75 | 1733 | .It Sy zfs_pd_bytes_max Ns = Ns Sy 52428800 Ns B Po 50 MiB Pc Pq int |
2d815d95 AZ |
1734 | The number of bytes which should be prefetched during a pool traversal, like |
1735 | .Nm zfs Cm send | |
1736 | or other data crawling operations. | |
1737 | . | |
fdc2d303 | 1738 | .It Sy zfs_traverse_indirect_prefetch_limit Ns = Ns Sy 32 Pq uint |
2d815d95 AZ |
1739 | The number of blocks pointed by indirect (non-L0) block which should be |
1740 | prefetched during a pool traversal, like | |
1741 | .Nm zfs Cm send | |
1742 | or other data crawling operations. | |
1743 | . | |
ab8d9c17 | 1744 | .It Sy zfs_per_txg_dirty_frees_percent Ns = Ns Sy 30 Ns % Pq u64 |
2d815d95 AZ |
1745 | Control percentage of dirtied indirect blocks from frees allowed into one TXG. |
1746 | After this threshold is crossed, additional frees will wait until the next TXG. | |
b46be903 | 1747 | .Sy 0 No disables this throttle . |
2d815d95 AZ |
1748 | . |
1749 | .It Sy zfs_prefetch_disable Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
1750 | Disable predictive prefetch. | |
2d232ca8 AZ |
1751 | Note that it leaves "prescient" prefetch |
1752 | .Pq for, e.g., Nm zfs Cm send | |
2d815d95 AZ |
1753 | intact. |
1754 | Unlike predictive prefetch, prescient prefetch never issues I/O | |
1755 | that ends up not being needed, so it can't hurt performance. | |
1756 | . | |
1757 | .It Sy zfs_qat_checksum_disable Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
1758 | Disable QAT hardware acceleration for SHA256 checksums. | |
1759 | May be unset after the ZFS modules have been loaded to initialize the QAT | |
1760 | hardware as long as support is compiled in and the QAT driver is present. | |
1761 | . | |
1762 | .It Sy zfs_qat_compress_disable Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
1763 | Disable QAT hardware acceleration for gzip compression. | |
1764 | May be unset after the ZFS modules have been loaded to initialize the QAT | |
1765 | hardware as long as support is compiled in and the QAT driver is present. | |
1766 | . | |
1767 | .It Sy zfs_qat_encrypt_disable Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
1768 | Disable QAT hardware acceleration for AES-GCM encryption. | |
1769 | May be unset after the ZFS modules have been loaded to initialize the QAT | |
1770 | hardware as long as support is compiled in and the QAT driver is present. | |
1771 | . | |
ab8d9c17 | 1772 | .It Sy zfs_vnops_read_chunk_size Ns = Ns Sy 1048576 Ns B Po 1 MiB Pc Pq u64 |
2d815d95 AZ |
1773 | Bytes to read per chunk. |
1774 | . | |
fdc2d303 | 1775 | .It Sy zfs_read_history Ns = Ns Sy 0 Pq uint |
2d815d95 AZ |
1776 | Historical statistics for this many latest reads will be available in |
1777 | .Pa /proc/spl/kstat/zfs/ Ns Ao Ar pool Ac Ns Pa /reads . | |
1778 | . | |
1779 | .It Sy zfs_read_history_hits Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
29714574 | 1780 | Include cache hits in read history |
2d815d95 | 1781 | . |
ab8d9c17 | 1782 | .It Sy zfs_rebuild_max_segment Ns = Ns Sy 1048576 Ns B Po 1 MiB Pc Pq u64 |
9a49d3f3 BB |
1783 | Maximum read segment size to issue when sequentially resilvering a |
1784 | top-level vdev. | |
2d815d95 AZ |
1785 | . |
1786 | .It Sy zfs_rebuild_scrub_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
b2255edc BB |
1787 | Automatically start a pool scrub when the last active sequential resilver |
1788 | completes in order to verify the checksums of all blocks which have been | |
2d815d95 AZ |
1789 | resilvered. |
1790 | This is enabled by default and strongly recommended. | |
1791 | . | |
973934b9 | 1792 | .It Sy zfs_rebuild_vdev_limit Ns = Ns Sy 67108864 Ns B Po 64 MiB Pc Pq u64 |
2d815d95 | 1793 | Maximum amount of I/O that can be concurrently issued for a sequential |
b2255edc | 1794 | resilver per leaf device, given in bytes. |
2d815d95 AZ |
1795 | . |
1796 | .It Sy zfs_reconstruct_indirect_combinations_max Ns = Ns Sy 4096 Pq int | |
4589f3ae BB |
1797 | If an indirect split block contains more than this many possible unique |
1798 | combinations when being reconstructed, consider it too computationally | |
2d815d95 AZ |
1799 | expensive to check them all. |
1800 | Instead, try at most this many randomly selected | |
1801 | combinations each time the block is accessed. | |
1802 | This allows all segment copies to participate fairly | |
1803 | in the reconstruction when all combinations | |
4589f3ae | 1804 | cannot be checked and prevents repeated use of one bad copy. |
2d815d95 AZ |
1805 | . |
1806 | .It Sy zfs_recover Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
1807 | Set to attempt to recover from fatal errors. | |
1808 | This should only be used as a last resort, | |
1809 | as it typically results in leaked space, or worse. | |
1810 | . | |
1811 | .It Sy zfs_removal_ignore_errors Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
a737b415 AZ |
1812 | Ignore hard I/O errors during device removal. |
1813 | When set, if a device encounters a hard I/O error during the removal process | |
2d815d95 | 1814 | the removal will not be cancelled. |
7c9a4292 | 1815 | This can result in a normally recoverable block becoming permanently damaged |
2d815d95 AZ |
1816 | and is hence not recommended. |
1817 | This should only be used as a last resort when the | |
7c9a4292 | 1818 | pool cannot be returned to a healthy state prior to removing the device. |
2d815d95 | 1819 | . |
fdc2d303 | 1820 | .It Sy zfs_removal_suspend_progress Ns = Ns Sy 0 Ns | Ns 1 Pq uint |
53dce5ac MA |
1821 | This is used by the test suite so that it can ensure that certain actions |
1822 | happen while in the middle of a removal. | |
2d815d95 | 1823 | . |
fdc2d303 | 1824 | .It Sy zfs_remove_max_segment Ns = Ns Sy 16777216 Ns B Po 16 MiB Pc Pq uint |
53dce5ac | 1825 | The largest contiguous segment that we will attempt to allocate when removing |
2d815d95 AZ |
1826 | a device. |
1827 | If there is a performance problem with attempting to allocate large blocks, | |
1828 | consider decreasing this. | |
1829 | The default value is also the maximum. | |
1830 | . | |
1831 | .It Sy zfs_resilver_disable_defer Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
1832 | Ignore the | |
1833 | .Sy resilver_defer | |
1834 | feature, causing an operation that would start a resilver to | |
1835 | immediately restart the one in progress. | |
1836 | . | |
fdc2d303 | 1837 | .It Sy zfs_resilver_min_time_ms Ns = Ns Sy 3000 Ns ms Po 3 s Pc Pq uint |
2d815d95 AZ |
1838 | Resilvers are processed by the sync thread. |
1839 | While resilvering, it will spend at least this much time | |
1840 | working on a resilver between TXG flushes. | |
1841 | . | |
1842 | .It Sy zfs_scan_ignore_errors Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
1843 | If set, remove the DTL (dirty time list) upon completion of a pool scan (scrub), | |
1844 | even if there were unrepairable errors. | |
1845 | Intended to be used during pool repair or recovery to | |
02638a30 | 1846 | stop resilvering when the pool is next imported. |
2d815d95 | 1847 | . |
5caeef02 DB |
1848 | .It Sy zfs_scrub_after_expand Ns = Ns Sy 1 Ns | Ns 0 Pq int |
1849 | Automatically start a pool scrub after a RAIDZ expansion completes | |
1850 | in order to verify the checksums of all blocks which have been | |
1851 | copied during the expansion. | |
1852 | This is enabled by default and strongly recommended. | |
1853 | . | |
fdc2d303 | 1854 | .It Sy zfs_scrub_min_time_ms Ns = Ns Sy 1000 Ns ms Po 1 s Pc Pq uint |
2d815d95 AZ |
1855 | Scrubs are processed by the sync thread. |
1856 | While scrubbing, it will spend at least this much time | |
1857 | working on a scrub between TXG flushes. | |
1858 | . | |
482eeef8 GA |
1859 | .It Sy zfs_scrub_error_blocks_per_txg Ns = Ns Sy 4096 Pq uint |
1860 | Error blocks to be scrubbed in one txg. | |
1861 | . | |
fdc2d303 | 1862 | .It Sy zfs_scan_checkpoint_intval Ns = Ns Sy 7200 Ns s Po 2 hour Pc Pq uint |
2d815d95 AZ |
1863 | To preserve progress across reboots, the sequential scan algorithm periodically |
1864 | needs to stop metadata scanning and issue all the verification I/O to disk. | |
1865 | The frequency of this flushing is determined by this tunable. | |
1866 | . | |
fdc2d303 | 1867 | .It Sy zfs_scan_fill_weight Ns = Ns Sy 3 Pq uint |
2d815d95 AZ |
1868 | This tunable affects how scrub and resilver I/O segments are ordered. |
1869 | A higher number indicates that we care more about how filled in a segment is, | |
1870 | while a lower number indicates we care more about the size of the extent without | |
1871 | considering the gaps within a segment. | |
1872 | This value is only tunable upon module insertion. | |
b46be903 DS |
1873 | Changing the value afterwards will have no effect on scrub or resilver |
1874 | performance. | |
2d815d95 | 1875 | . |
fdc2d303 | 1876 | .It Sy zfs_scan_issue_strategy Ns = Ns Sy 0 Pq uint |
2d815d95 AZ |
1877 | Determines the order that data will be verified while scrubbing or resilvering: |
1878 | .Bl -tag -compact -offset 4n -width "a" | |
1879 | .It Sy 1 | |
1880 | Data will be verified as sequentially as possible, given the | |
1881 | amount of memory reserved for scrubbing | |
1882 | .Pq see Sy zfs_scan_mem_lim_fact . | |
1883 | This may improve scrub performance if the pool's data is very fragmented. | |
1884 | .It Sy 2 | |
1885 | The largest mostly-contiguous chunk of found data will be verified first. | |
1886 | By deferring scrubbing of small segments, we may later find adjacent data | |
1887 | to coalesce and increase the segment size. | |
1888 | .It Sy 0 | |
1889 | .No Use strategy Sy 1 No during normal verification | |
b46be903 | 1890 | .No and strategy Sy 2 No while taking a checkpoint . |
2d815d95 AZ |
1891 | .El |
1892 | . | |
1893 | .It Sy zfs_scan_legacy Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
1894 | If unset, indicates that scrubs and resilvers will gather metadata in | |
1895 | memory before issuing sequential I/O. | |
1896 | Otherwise indicates that the legacy algorithm will be used, | |
1897 | where I/O is initiated as soon as it is discovered. | |
1898 | Unsetting will not affect scrubs or resilvers that are already in progress. | |
1899 | . | |
a894ae75 | 1900 | .It Sy zfs_scan_max_ext_gap Ns = Ns Sy 2097152 Ns B Po 2 MiB Pc Pq int |
2d815d95 AZ |
1901 | Sets the largest gap in bytes between scrub/resilver I/O operations |
1902 | that will still be considered sequential for sorting purposes. | |
1903 | Changing this value will not | |
d4a72f23 | 1904 | affect scrubs or resilvers that are already in progress. |
2d815d95 | 1905 | . |
fdc2d303 | 1906 | .It Sy zfs_scan_mem_lim_fact Ns = Ns Sy 20 Ns ^-1 Pq uint |
d4a72f23 TC |
1907 | Maximum fraction of RAM used for I/O sorting by sequential scan algorithm. |
1908 | This tunable determines the hard limit for I/O sorting memory usage. | |
1909 | When the hard limit is reached we stop scanning metadata and start issuing | |
2d815d95 AZ |
1910 | data verification I/O. |
1911 | This is done until we get below the soft limit. | |
1912 | . | |
fdc2d303 | 1913 | .It Sy zfs_scan_mem_lim_soft_fact Ns = Ns Sy 20 Ns ^-1 Pq uint |
d4a72f23 | 1914 | The fraction of the hard limit used to determined the soft limit for I/O sorting |
2d815d95 AZ |
1915 | by the sequential scan algorithm. |
1916 | When we cross this limit from below no action is taken. | |
b46be903 DS |
1917 | When we cross this limit from above it is because we are issuing verification |
1918 | I/O. | |
2d815d95 AZ |
1919 | In this case (unless the metadata scan is done) we stop issuing verification I/O |
1920 | and start scanning metadata again until we get to the hard limit. | |
1921 | . | |
c85ac731 BB |
1922 | .It Sy zfs_scan_report_txgs Ns = Ns Sy 0 Ns | Ns 1 Pq uint |
1923 | When reporting resilver throughput and estimated completion time use the | |
1924 | performance observed over roughly the last | |
1925 | .Sy zfs_scan_report_txgs | |
1926 | TXGs. | |
1927 | When set to zero performance is calculated over the time between checkpoints. | |
1928 | . | |
2d815d95 AZ |
1929 | .It Sy zfs_scan_strict_mem_lim Ns = Ns Sy 0 Ns | Ns 1 Pq int |
1930 | Enforce tight memory limits on pool scans when a sequential scan is in progress. | |
1931 | When disabled, the memory limit may be exceeded by fast disks. | |
1932 | . | |
1933 | .It Sy zfs_scan_suspend_progress Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
1934 | Freezes a scrub/resilver in progress without actually pausing it. | |
1935 | Intended for testing/debugging. | |
1936 | . | |
c0aea7cf | 1937 | .It Sy zfs_scan_vdev_limit Ns = Ns Sy 16777216 Ns B Po 16 MiB Pc Pq int |
d4a72f23 TC |
1938 | Maximum amount of data that can be concurrently issued at once for scrubs and |
1939 | resilvers per leaf device, given in bytes. | |
2d815d95 AZ |
1940 | . |
1941 | .It Sy zfs_send_corrupt_data Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
1942 | Allow sending of corrupt data (ignore read/checksum errors when sending). | |
1943 | . | |
1944 | .It Sy zfs_send_unmodified_spill_blocks Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
1945 | Include unmodified spill blocks in the send stream. | |
1946 | Under certain circumstances, previous versions of ZFS could incorrectly | |
1947 | remove the spill block from an existing object. | |
1948 | Including unmodified copies of the spill blocks creates a backwards-compatible | |
1949 | stream which will recreate a spill block if it was incorrectly removed. | |
1950 | . | |
fdc2d303 | 1951 | .It Sy zfs_send_no_prefetch_queue_ff Ns = Ns Sy 20 Ns ^\-1 Pq uint |
2d815d95 AZ |
1952 | The fill fraction of the |
1953 | .Nm zfs Cm send | |
1954 | internal queues. | |
1955 | The fill fraction controls the timing with which internal threads are woken up. | |
1956 | . | |
fdc2d303 | 1957 | .It Sy zfs_send_no_prefetch_queue_length Ns = Ns Sy 1048576 Ns B Po 1 MiB Pc Pq uint |
2d815d95 AZ |
1958 | The maximum number of bytes allowed in |
1959 | .Nm zfs Cm send Ns 's | |
1960 | internal queues. | |
1961 | . | |
fdc2d303 | 1962 | .It Sy zfs_send_queue_ff Ns = Ns Sy 20 Ns ^\-1 Pq uint |
2d815d95 AZ |
1963 | The fill fraction of the |
1964 | .Nm zfs Cm send | |
1965 | prefetch queue. | |
1966 | The fill fraction controls the timing with which internal threads are woken up. | |
1967 | . | |
fdc2d303 | 1968 | .It Sy zfs_send_queue_length Ns = Ns Sy 16777216 Ns B Po 16 MiB Pc Pq uint |
2d815d95 AZ |
1969 | The maximum number of bytes allowed that will be prefetched by |
1970 | .Nm zfs Cm send . | |
1971 | This value must be at least twice the maximum block size in use. | |
1972 | . | |
fdc2d303 | 1973 | .It Sy zfs_recv_queue_ff Ns = Ns Sy 20 Ns ^\-1 Pq uint |
2d815d95 AZ |
1974 | The fill fraction of the |
1975 | .Nm zfs Cm receive | |
1976 | queue. | |
1977 | The fill fraction controls the timing with which internal threads are woken up. | |
1978 | . | |
fdc2d303 | 1979 | .It Sy zfs_recv_queue_length Ns = Ns Sy 16777216 Ns B Po 16 MiB Pc Pq uint |
2d815d95 AZ |
1980 | The maximum number of bytes allowed in the |
1981 | .Nm zfs Cm receive | |
1982 | queue. | |
30af21b0 | 1983 | This value must be at least twice the maximum block size in use. |
2d815d95 | 1984 | . |
fdc2d303 | 1985 | .It Sy zfs_recv_write_batch_size Ns = Ns Sy 1048576 Ns B Po 1 MiB Pc Pq uint |
2d815d95 AZ |
1986 | The maximum amount of data, in bytes, that |
1987 | .Nm zfs Cm receive | |
1988 | will write in one DMU transaction. | |
1989 | This is the uncompressed size, even when receiving a compressed send stream. | |
1990 | This setting will not reduce the write size below a single block. | |
1991 | Capped at a maximum of | |
a894ae75 | 1992 | .Sy 32 MiB . |
2d815d95 | 1993 | . |
e8cf3a4f AP |
1994 | .It Sy zfs_recv_best_effort_corrective Ns = Ns Sy 0 Pq int |
1995 | When this variable is set to non-zero a corrective receive: | |
1996 | .Bl -enum -compact -offset 4n -width "1." | |
1997 | .It | |
1998 | Does not enforce the restriction of source & destination snapshot GUIDs | |
1999 | matching. | |
2000 | .It | |
2001 | If there is an error during healing, the healing receive is not | |
2002 | terminated instead it moves on to the next record. | |
2003 | .El | |
2004 | . | |
fdc2d303 | 2005 | .It Sy zfs_override_estimate_recordsize Ns = Ns Sy 0 Ns | Ns 1 Pq uint |
30af21b0 | 2006 | Setting this variable overrides the default logic for estimating block |
2d815d95 AZ |
2007 | sizes when doing a |
2008 | .Nm zfs Cm send . | |
2009 | The default heuristic is that the average block size | |
2010 | will be the current recordsize. | |
2011 | Override this value if most data in your dataset is not of that size | |
2012 | and you require accurate zfs send size estimates. | |
2013 | . | |
fdc2d303 | 2014 | .It Sy zfs_sync_pass_deferred_free Ns = Ns Sy 2 Pq uint |
2d815d95 AZ |
2015 | Flushing of data to disk is done in passes. |
2016 | Defer frees starting in this pass. | |
2017 | . | |
a894ae75 | 2018 | .It Sy zfs_spa_discard_memory_limit Ns = Ns Sy 16777216 Ns B Po 16 MiB Pc Pq int |
d2734cce SD |
2019 | Maximum memory used for prefetching a checkpoint's space map on each |
2020 | vdev while discarding the checkpoint. | |
2d815d95 | 2021 | . |
fdc2d303 | 2022 | .It Sy zfs_special_class_metadata_reserve_pct Ns = Ns Sy 25 Ns % Pq uint |
1f02ecc5 | 2023 | Only allow small data blocks to be allocated on the special and dedup vdev |
b46be903 DS |
2024 | types when the available free space percentage on these vdevs exceeds this |
2025 | value. | |
2d815d95 | 2026 | This ensures reserved space is available for pool metadata as the |
1f02ecc5 | 2027 | special vdevs approach capacity. |
2d815d95 | 2028 | . |
fdc2d303 | 2029 | .It Sy zfs_sync_pass_dont_compress Ns = Ns Sy 8 Pq uint |
2d815d95 | 2030 | Starting in this sync pass, disable compression (including of metadata). |
be89734a MA |
2031 | With the default setting, in practice, we don't have this many sync passes, |
2032 | so this has no effect. | |
2d815d95 | 2033 | .Pp |
be89734a | 2034 | The original intent was that disabling compression would help the sync passes |
2d815d95 AZ |
2035 | to converge. |
2036 | However, in practice, disabling compression increases | |
2037 | the average number of sync passes; because when we turn compression off, | |
2038 | many blocks' size will change, and thus we have to re-allocate | |
2039 | (not overwrite) them. | |
2040 | It also increases the number of | |
a894ae75 | 2041 | .Em 128 KiB |
2d815d95 AZ |
2042 | allocations (e.g. for indirect blocks and spacemaps) |
2043 | because these will not be compressed. | |
2044 | The | |
a894ae75 | 2045 | .Em 128 KiB |
2d815d95 | 2046 | allocations are especially detrimental to performance |
b46be903 DS |
2047 | on highly fragmented systems, which may have very few free segments of this |
2048 | size, | |
2d815d95 AZ |
2049 | and may need to load new metaslabs to satisfy these allocations. |
2050 | . | |
fdc2d303 | 2051 | .It Sy zfs_sync_pass_rewrite Ns = Ns Sy 2 Pq uint |
2d815d95 AZ |
2052 | Rewrite new block pointers starting in this pass. |
2053 | . | |
a894ae75 | 2054 | .It Sy zfs_trim_extent_bytes_max Ns = Ns Sy 134217728 Ns B Po 128 MiB Pc Pq uint |
2d815d95 | 2055 | Maximum size of TRIM command. |
b46be903 DS |
2056 | Larger ranges will be split into chunks no larger than this value before |
2057 | issuing. | |
2d815d95 | 2058 | . |
a894ae75 | 2059 | .It Sy zfs_trim_extent_bytes_min Ns = Ns Sy 32768 Ns B Po 32 KiB Pc Pq uint |
2d815d95 AZ |
2060 | Minimum size of TRIM commands. |
2061 | TRIM ranges smaller than this will be skipped, | |
2062 | unless they're part of a larger range which was chunked. | |
2063 | This is done because it's common for these small TRIMs | |
2064 | to negatively impact overall performance. | |
2065 | . | |
2066 | .It Sy zfs_trim_metaslab_skip Ns = Ns Sy 0 Ns | Ns 1 Pq uint | |
2067 | Skip uninitialized metaslabs during the TRIM process. | |
b46be903 DS |
2068 | This option is useful for pools constructed from large thinly-provisioned |
2069 | devices | |
2d815d95 AZ |
2070 | where TRIM operations are slow. |
2071 | As a pool ages, an increasing fraction of the pool's metaslabs | |
2072 | will be initialized, progressively degrading the usefulness of this option. | |
2073 | This setting is stored when starting a manual TRIM and will | |
1b939560 | 2074 | persist for the duration of the requested TRIM. |
2d815d95 AZ |
2075 | . |
2076 | .It Sy zfs_trim_queue_limit Ns = Ns Sy 10 Pq uint | |
2077 | Maximum number of queued TRIMs outstanding per leaf vdev. | |
2078 | The number of concurrent TRIM commands issued to the device is controlled by | |
2079 | .Sy zfs_vdev_trim_min_active No and Sy zfs_vdev_trim_max_active . | |
2080 | . | |
2081 | .It Sy zfs_trim_txg_batch Ns = Ns Sy 32 Pq uint | |
2082 | The number of transaction groups' worth of frees which should be aggregated | |
2083 | before TRIM operations are issued to the device. | |
2084 | This setting represents a trade-off between issuing larger, | |
2085 | more efficient TRIM operations and the delay | |
2086 | before the recently trimmed space is available for use by the device. | |
2087 | .Pp | |
1b939560 | 2088 | Increasing this value will allow frees to be aggregated for a longer time. |
b46be903 DS |
2089 | This will result is larger TRIM operations and potentially increased memory |
2090 | usage. | |
2d815d95 AZ |
2091 | Decreasing this value will have the opposite effect. |
2092 | The default of | |
2093 | .Sy 32 | |
2094 | was determined to be a reasonable compromise. | |
2095 | . | |
fdc2d303 | 2096 | .It Sy zfs_txg_history Ns = Ns Sy 0 Pq uint |
2d815d95 AZ |
2097 | Historical statistics for this many latest TXGs will be available in |
2098 | .Pa /proc/spl/kstat/zfs/ Ns Ao Ar pool Ac Ns Pa /TXGs . | |
2099 | . | |
fdc2d303 | 2100 | .It Sy zfs_txg_timeout Ns = Ns Sy 5 Ns s Pq uint |
b46be903 DS |
2101 | Flush dirty data to disk at least every this many seconds (maximum TXG |
2102 | duration). | |
2d815d95 | 2103 | . |
fdc2d303 | 2104 | .It Sy zfs_vdev_aggregation_limit Ns = Ns Sy 1048576 Ns B Po 1 MiB Pc Pq uint |
2d815d95 AZ |
2105 | Max vdev I/O aggregation size. |
2106 | . | |
fdc2d303 | 2107 | .It Sy zfs_vdev_aggregation_limit_non_rotating Ns = Ns Sy 131072 Ns B Po 128 KiB Pc Pq uint |
2d815d95 AZ |
2108 | Max vdev I/O aggregation size for non-rotating media. |
2109 | . | |
2d815d95 | 2110 | .It Sy zfs_vdev_mirror_rotating_inc Ns = Ns Sy 0 Pq int |
9f500936 | 2111 | A number by which the balancing algorithm increments the load calculation for |
2d815d95 AZ |
2112 | the purpose of selecting the least busy mirror member when an I/O operation |
2113 | immediately follows its predecessor on rotational vdevs | |
2114 | for the purpose of making decisions based on load. | |
2115 | . | |
2116 | .It Sy zfs_vdev_mirror_rotating_seek_inc Ns = Ns Sy 5 Pq int | |
9f500936 | 2117 | A number by which the balancing algorithm increments the load calculation for |
2d815d95 AZ |
2118 | the purpose of selecting the least busy mirror member when an I/O operation |
2119 | lacks locality as defined by | |
2120 | .Sy zfs_vdev_mirror_rotating_seek_offset . | |
2121 | Operations within this that are not immediately following the previous operation | |
2122 | are incremented by half. | |
2123 | . | |
a894ae75 | 2124 | .It Sy zfs_vdev_mirror_rotating_seek_offset Ns = Ns Sy 1048576 Ns B Po 1 MiB Pc Pq int |
2d815d95 AZ |
2125 | The maximum distance for the last queued I/O operation in which |
2126 | the balancing algorithm considers an operation to have locality. | |
2127 | .No See Sx ZFS I/O SCHEDULER . | |
2128 | . | |
2129 | .It Sy zfs_vdev_mirror_non_rotating_inc Ns = Ns Sy 0 Pq int | |
9f500936 | 2130 | A number by which the balancing algorithm increments the load calculation for |
2131 | the purpose of selecting the least busy mirror member on non-rotational vdevs | |
2d815d95 AZ |
2132 | when I/O operations do not immediately follow one another. |
2133 | . | |
2134 | .It Sy zfs_vdev_mirror_non_rotating_seek_inc Ns = Ns Sy 1 Pq int | |
9f500936 | 2135 | A number by which the balancing algorithm increments the load calculation for |
b46be903 DS |
2136 | the purpose of selecting the least busy mirror member when an I/O operation |
2137 | lacks | |
2d815d95 AZ |
2138 | locality as defined by the |
2139 | .Sy zfs_vdev_mirror_rotating_seek_offset . | |
2140 | Operations within this that are not immediately following the previous operation | |
2141 | are incremented by half. | |
2142 | . | |
fdc2d303 | 2143 | .It Sy zfs_vdev_read_gap_limit Ns = Ns Sy 32768 Ns B Po 32 KiB Pc Pq uint |
2d815d95 | 2144 | Aggregate read I/O operations if the on-disk gap between them is within this |
83426735 | 2145 | threshold. |
2d815d95 | 2146 | . |
fdc2d303 | 2147 | .It Sy zfs_vdev_write_gap_limit Ns = Ns Sy 4096 Ns B Po 4 KiB Pc Pq uint |
2d815d95 AZ |
2148 | Aggregate write I/O operations if the on-disk gap between them is within this |
2149 | threshold. | |
2150 | . | |
2151 | .It Sy zfs_vdev_raidz_impl Ns = Ns Sy fastest Pq string | |
2152 | Select the raidz parity implementation to use. | |
2153 | .Pp | |
2154 | Variants that don't depend on CPU-specific features | |
2155 | may be selected on module load, as they are supported on all systems. | |
2156 | The remaining options may only be set after the module is loaded, | |
2157 | as they are available only if the implementations are compiled in | |
2158 | and supported on the running system. | |
2159 | .Pp | |
2160 | Once the module is loaded, | |
2161 | .Pa /sys/module/zfs/parameters/zfs_vdev_raidz_impl | |
2162 | will show the available options, | |
2163 | with the currently selected one enclosed in square brackets. | |
2164 | .Pp | |
2165 | .TS | |
2166 | lb l l . | |
2167 | fastest selected by built-in benchmark | |
2168 | original original implementation | |
2169 | scalar scalar implementation | |
2170 | sse2 SSE2 instruction set 64-bit x86 | |
2171 | ssse3 SSSE3 instruction set 64-bit x86 | |
2172 | avx2 AVX2 instruction set 64-bit x86 | |
2173 | avx512f AVX512F instruction set 64-bit x86 | |
2174 | avx512bw AVX512F & AVX512BW instruction sets 64-bit x86 | |
2175 | aarch64_neon NEON Aarch64/64-bit ARMv8 | |
2176 | aarch64_neonx2 NEON with more unrolling Aarch64/64-bit ARMv8 | |
2177 | powerpc_altivec Altivec PowerPC | |
2178 | .TE | |
2179 | . | |
2180 | .It Sy zfs_vdev_scheduler Pq charp | |
2181 | .Sy DEPRECATED . | |
0f402668 | 2182 | Prints warning to kernel log for compatibility. |
2d815d95 | 2183 | . |
fdc2d303 | 2184 | .It Sy zfs_zevent_len_max Ns = Ns Sy 512 Pq uint |
032a213e | 2185 | Max event queue length. |
2d815d95 AZ |
2186 | Events in the queue can be viewed with |
2187 | .Xr zpool-events 8 . | |
2188 | . | |
2189 | .It Sy zfs_zevent_retain_max Ns = Ns Sy 2000 Pq int | |
2190 | Maximum recent zevent records to retain for duplicate checking. | |
2191 | Setting this to | |
2192 | .Sy 0 | |
2193 | disables duplicate detection. | |
2194 | . | |
a894ae75 | 2195 | .It Sy zfs_zevent_retain_expire_secs Ns = Ns Sy 900 Ns s Po 15 min Pc Pq int |
4f072827 | 2196 | Lifespan for a recent ereport that was retained for duplicate checking. |
2d815d95 AZ |
2197 | . |
2198 | .It Sy zfs_zil_clean_taskq_maxalloc Ns = Ns Sy 1048576 Pq int | |
2199 | The maximum number of taskq entries that are allowed to be cached. | |
2200 | When this limit is exceeded transaction records (itxs) | |
2201 | will be cleaned synchronously. | |
2202 | . | |
2203 | .It Sy zfs_zil_clean_taskq_minalloc Ns = Ns Sy 1024 Pq int | |
a032ac4b BB |
2204 | The number of taskq entries that are pre-populated when the taskq is first |
2205 | created and are immediately available for use. | |
2d815d95 AZ |
2206 | . |
2207 | .It Sy zfs_zil_clean_taskq_nthr_pct Ns = Ns Sy 100 Ns % Pq int | |
2208 | This controls the number of threads used by | |
2209 | .Sy dp_zil_clean_taskq . | |
2210 | The default value of | |
2211 | .Sy 100% | |
2212 | will create a maximum of one thread per cpu. | |
2213 | . | |
fdc2d303 | 2214 | .It Sy zil_maxblocksize Ns = Ns Sy 131072 Ns B Po 128 KiB Pc Pq uint |
2d815d95 AZ |
2215 | This sets the maximum block size used by the ZIL. |
2216 | On very fragmented pools, lowering this | |
a894ae75 | 2217 | .Pq typically to Sy 36 KiB |
2d815d95 AZ |
2218 | can improve performance. |
2219 | . | |
66b81b34 AM |
2220 | .It Sy zil_maxcopied Ns = Ns Sy 7680 Ns B Po 7.5 KiB Pc Pq uint |
2221 | This sets the maximum number of write bytes logged via WR_COPIED. | |
2222 | It tunes a tradeoff between additional memory copy and possibly worse log | |
2223 | space efficiency vs additional range lock/unlock. | |
2224 | . | |
2d815d95 AZ |
2225 | .It Sy zil_nocacheflush Ns = Ns Sy 0 Ns | Ns 1 Pq int |
2226 | Disable the cache flush commands that are normally sent to disk by | |
2227 | the ZIL after an LWB write has completed. | |
2228 | Setting this will cause ZIL corruption on power loss | |
2229 | if a volatile out-of-order write cache is enabled. | |
2230 | . | |
2231 | .It Sy zil_replay_disable Ns = Ns Sy 0 Ns | Ns 1 Pq int | |
2232 | Disable intent logging replay. | |
2233 | Can be disabled for recovery from corrupted ZIL. | |
2234 | . | |
c0e58995 | 2235 | .It Sy zil_slog_bulk Ns = Ns Sy 67108864 Ns B Po 64 MiB Pc Pq u64 |
1b7c1e5c GDN |
2236 | Limit SLOG write size per commit executed with synchronous priority. |
2237 | Any writes above that will be executed with lower (asynchronous) priority | |
2238 | to limit potential SLOG device abuse by single active ZIL writer. | |
2d815d95 | 2239 | . |
361a7e82 JP |
2240 | .It Sy zfs_zil_saxattr Ns = Ns Sy 1 Ns | Ns 0 Pq int |
2241 | Setting this tunable to zero disables ZIL logging of new | |
2242 | .Sy xattr Ns = Ns Sy sa | |
2243 | records if the | |
2244 | .Sy org.openzfs:zilsaxattr | |
2245 | feature is enabled on the pool. | |
2246 | This would only be necessary to work around bugs in the ZIL logging or replay | |
2247 | code for this record type. | |
2248 | The tunable has no effect if the feature is disabled. | |
2249 | . | |
fdc2d303 | 2250 | .It Sy zfs_embedded_slog_min_ms Ns = Ns Sy 64 Pq uint |
2d815d95 AZ |
2251 | Usually, one metaslab from each normal-class vdev is dedicated for use by |
2252 | the ZIL to log synchronous writes. | |
2253 | However, if there are fewer than | |
2254 | .Sy zfs_embedded_slog_min_ms | |
2255 | metaslabs in the vdev, this functionality is disabled. | |
b46be903 DS |
2256 | This ensures that we don't set aside an unreasonable amount of space for the |
2257 | ZIL. | |
2d815d95 | 2258 | . |
fdc2d303 | 2259 | .It Sy zstd_earlyabort_pass Ns = Ns Sy 1 Pq uint |
f375b23c RE |
2260 | Whether heuristic for detection of incompressible data with zstd levels >= 3 |
2261 | using LZ4 and zstd-1 passes is enabled. | |
2262 | . | |
fdc2d303 | 2263 | .It Sy zstd_abort_size Ns = Ns Sy 131072 Pq uint |
f375b23c RE |
2264 | Minimal uncompressed size (inclusive) of a record before the early abort |
2265 | heuristic will be attempted. | |
2266 | . | |
2d815d95 AZ |
2267 | .It Sy zio_deadman_log_all Ns = Ns Sy 0 Ns | Ns 1 Pq int |
2268 | If non-zero, the zio deadman will produce debugging messages | |
2269 | .Pq see Sy zfs_dbgmsg_enable | |
2270 | for all zios, rather than only for leaf zios possessing a vdev. | |
2271 | This is meant to be used by developers to gain | |
638dd5f4 | 2272 | diagnostic information for hang conditions which don't involve a mutex |
2d815d95 | 2273 | or other locking primitive: typically conditions in which a thread in |
638dd5f4 | 2274 | the zio pipeline is looping indefinitely. |
2d815d95 | 2275 | . |
a894ae75 | 2276 | .It Sy zio_slow_io_ms Ns = Ns Sy 30000 Ns ms Po 30 s Pc Pq int |
2d815d95 AZ |
2277 | When an I/O operation takes more than this much time to complete, |
2278 | it's marked as slow. | |
2279 | Each slow operation causes a delay zevent. | |
2280 | Slow I/O counters can be seen with | |
2281 | .Nm zpool Cm status Fl s . | |
2282 | . | |
2283 | .It Sy zio_dva_throttle_enabled Ns = Ns Sy 1 Ns | Ns 0 Pq int | |
2284 | Throttle block allocations in the I/O pipeline. | |
2285 | This allows for dynamic allocation distribution when devices are imbalanced. | |
e815485f | 2286 | When enabled, the maximum number of pending allocations per top-level vdev |
2d815d95 AZ |
2287 | is limited by |
2288 | .Sy zfs_vdev_queue_depth_pct . | |
2289 | . | |
5c006134 RM |
2290 | .It Sy zfs_xattr_compat Ns = Ns 0 Ns | Ns 1 Pq int |
2291 | Control the naming scheme used when setting new xattrs in the user namespace. | |
2292 | If | |
2293 | .Sy 0 | |
2294 | .Pq the default on Linux , | |
2295 | user namespace xattr names are prefixed with the namespace, to be backwards | |
2296 | compatible with previous versions of ZFS on Linux. | |
2297 | If | |
2298 | .Sy 1 | |
2299 | .Pq the default on Fx , | |
2300 | user namespace xattr names are not prefixed, to be backwards compatible with | |
2301 | previous versions of ZFS on illumos and | |
2302 | .Fx . | |
2303 | .Pp | |
2304 | Either naming scheme can be read on this and future versions of ZFS, regardless | |
2305 | of this tunable, but legacy ZFS on illumos or | |
2306 | .Fx | |
2307 | are unable to read user namespace xattrs written in the Linux format, and | |
2308 | legacy versions of ZFS on Linux are unable to read user namespace xattrs written | |
2309 | in the legacy ZFS format. | |
2310 | .Pp | |
2311 | An existing xattr with the alternate naming scheme is removed when overwriting | |
2312 | the xattr so as to not accumulate duplicates. | |
2313 | . | |
2d815d95 AZ |
2314 | .It Sy zio_requeue_io_start_cut_in_line Ns = Ns Sy 0 Ns | Ns 1 Pq int |
2315 | Prioritize requeued I/O. | |
2316 | . | |
2317 | .It Sy zio_taskq_batch_pct Ns = Ns Sy 80 Ns % Pq uint | |
2318 | Percentage of online CPUs which will run a worker thread for I/O. | |
2319 | These workers are responsible for I/O work such as compression and | |
2320 | checksum calculations. | |
2321 | Fractional number of CPUs will be rounded down. | |
2322 | .Pp | |
2323 | The default value of | |
2324 | .Sy 80% | |
2325 | was chosen to avoid using all CPUs which can result in | |
2326 | latency issues and inconsistent application performance, | |
2327 | especially when slower compression and/or checksumming is enabled. | |
2328 | . | |
2329 | .It Sy zio_taskq_batch_tpq Ns = Ns Sy 0 Pq uint | |
2330 | Number of worker threads per taskq. | |
2331 | Lower values improve I/O ordering and CPU utilization, | |
2332 | while higher reduces lock contention. | |
2333 | .Pp | |
2334 | If | |
2335 | .Sy 0 , | |
2336 | generate a system-dependent value close to 6 threads per taskq. | |
2337 | . | |
3bd4df38 EN |
2338 | .It Sy zio_taskq_wr_iss_ncpus Ns = Ns Sy 0 Pq uint |
2339 | Determines the number of CPUs to run write issue taskqs. | |
2340 | .Pp | |
2341 | When 0 (the default), the value to use is computed internally | |
2342 | as the number of actual CPUs in the system divided by the | |
2343 | .Sy spa_num_allocators | |
2344 | value. | |
2345 | . | |
6930ecbb RN |
2346 | .It Sy zio_taskq_read Ns = Ns Sy fixed,1,8 null scale null Pq charp |
2347 | Set the queue and thread configuration for the IO read queues. | |
2348 | This is an advanced debugging parameter. | |
2349 | Don't change this unless you understand what it does. | |
2350 | . | |
2351 | .It Sy zio_taskq_write Ns = Ns Sy sync fixed,1,5 scale fixed,1,5 Pq charp | |
2352 | Set the queue and thread configuration for the IO write queues. | |
2353 | This is an advanced debugging parameter. | |
2354 | Don't change this unless you understand what it does. | |
2355 | . | |
2d815d95 AZ |
2356 | .It Sy zvol_inhibit_dev Ns = Ns Sy 0 Ns | Ns 1 Pq uint |
2357 | Do not create zvol device nodes. | |
2358 | This may slightly improve startup time on | |
83426735 | 2359 | systems with a very large number of zvols. |
2d815d95 AZ |
2360 | . |
2361 | .It Sy zvol_major Ns = Ns Sy 230 Pq uint | |
2362 | Major number for zvol block devices. | |
2363 | . | |
ab8d9c17 | 2364 | .It Sy zvol_max_discard_blocks Ns = Ns Sy 16384 Pq long |
2d815d95 AZ |
2365 | Discard (TRIM) operations done on zvols will be done in batches of this |
2366 | many blocks, where block size is determined by the | |
2367 | .Sy volblocksize | |
2368 | property of a zvol. | |
2369 | . | |
a894ae75 | 2370 | .It Sy zvol_prefetch_bytes Ns = Ns Sy 131072 Ns B Po 128 KiB Pc Pq uint |
2d815d95 AZ |
2371 | When adding a zvol to the system, prefetch this many bytes |
2372 | from the start and end of the volume. | |
2373 | Prefetching these regions of the volume is desirable, | |
2374 | because they are likely to be accessed immediately by | |
2375 | .Xr blkid 8 | |
2376 | or the kernel partitioner. | |
2377 | . | |
2378 | .It Sy zvol_request_sync Ns = Ns Sy 0 Ns | Ns 1 Pq uint | |
2379 | When processing I/O requests for a zvol, submit them synchronously. | |
2380 | This effectively limits the queue depth to | |
2381 | .Em 1 | |
2382 | for each I/O submitter. | |
2383 | When unset, requests are handled asynchronously by a thread pool. | |
2384 | The number of requests which can be handled concurrently is controlled by | |
2385 | .Sy zvol_threads . | |
6f73d021 TH |
2386 | .Sy zvol_request_sync |
2387 | is ignored when running on a kernel that supports block multiqueue | |
2388 | .Pq Li blk-mq . | |
2d815d95 | 2389 | . |
6f73d021 TH |
2390 | .It Sy zvol_threads Ns = Ns Sy 0 Pq uint |
2391 | The number of system wide threads to use for processing zvol block IOs. | |
2392 | If | |
2393 | .Sy 0 | |
2394 | (the default) then internally set | |
2395 | .Sy zvol_threads | |
2396 | to the number of CPUs present or 32 (whichever is greater). | |
2397 | . | |
05c4710e TH |
2398 | .It Sy zvol_blk_mq_threads Ns = Ns Sy 0 Pq uint |
2399 | The number of threads per zvol to use for queuing IO requests. | |
2400 | This parameter will only appear if your kernel supports | |
2401 | .Li blk-mq | |
2402 | and is only read and assigned to a zvol at zvol load time. | |
2403 | If | |
2404 | .Sy 0 | |
2405 | (the default) then internally set | |
2406 | .Sy zvol_blk_mq_threads | |
2407 | to the number of CPUs present. | |
2408 | . | |
2409 | .It Sy zvol_use_blk_mq Ns = Ns Sy 0 Ns | Ns 1 Pq uint | |
2410 | Set to | |
2411 | .Sy 1 | |
2412 | to use the | |
2413 | .Li blk-mq | |
2414 | API for zvols. | |
2415 | Set to | |
2416 | .Sy 0 | |
2417 | (the default) to use the legacy zvol APIs. | |
2418 | This setting can give better or worse zvol performance depending on | |
2419 | the workload. | |
2420 | This parameter will only appear if your kernel supports | |
2421 | .Li blk-mq | |
2422 | and is only read and assigned to a zvol at zvol load time. | |
2423 | . | |
2424 | .It Sy zvol_blk_mq_blocks_per_thread Ns = Ns Sy 8 Pq uint | |
2425 | If | |
2426 | .Sy zvol_use_blk_mq | |
2427 | is enabled, then process this number of | |
2428 | .Sy volblocksize Ns -sized blocks per zvol thread. | |
2429 | This tunable can be use to favor better performance for zvol reads (lower | |
2430 | values) or writes (higher values). | |
2431 | If set to | |
2432 | .Sy 0 , | |
2433 | then the zvol layer will process the maximum number of blocks | |
2434 | per thread that it can. | |
2435 | This parameter will only appear if your kernel supports | |
2436 | .Li blk-mq | |
2437 | and is only applied at each zvol's load time. | |
2438 | . | |
2439 | .It Sy zvol_blk_mq_queue_depth Ns = Ns Sy 0 Pq uint | |
2440 | The queue_depth value for the zvol | |
2441 | .Li blk-mq | |
2442 | interface. | |
2443 | This parameter will only appear if your kernel supports | |
2444 | .Li blk-mq | |
2445 | and is only applied at each zvol's load time. | |
2446 | If | |
2447 | .Sy 0 | |
2448 | (the default) then use the kernel's default queue depth. | |
2449 | Values are clamped to the kernel's | |
2450 | .Dv BLKDEV_MIN_RQ | |
2451 | and | |
2452 | .Dv BLKDEV_MAX_RQ Ns / Ns Dv BLKDEV_DEFAULT_RQ | |
2453 | limits. | |
2454 | . | |
2d815d95 AZ |
2455 | .It Sy zvol_volmode Ns = Ns Sy 1 Pq uint |
2456 | Defines zvol block devices behaviour when | |
2457 | .Sy volmode Ns = Ns Sy default : | |
2458 | .Bl -tag -compact -offset 4n -width "a" | |
2459 | .It Sy 1 | |
2460 | .No equivalent to Sy full | |
2461 | .It Sy 2 | |
2462 | .No equivalent to Sy dev | |
2463 | .It Sy 3 | |
2464 | .No equivalent to Sy none | |
2465 | .El | |
945b4074 MZ |
2466 | . |
2467 | .It Sy zvol_enforce_quotas Ns = Ns Sy 0 Ns | Ns 1 Pq uint | |
2468 | Enable strict ZVOL quota enforcement. | |
2469 | The strict quota enforcement may have a performance impact. | |
2d815d95 AZ |
2470 | .El |
2471 | . | |
2472 | .Sh ZFS I/O SCHEDULER | |
2473 | ZFS issues I/O operations to leaf vdevs to satisfy and complete I/O operations. | |
2474 | The scheduler determines when and in what order those operations are issued. | |
2475 | The scheduler divides operations into five I/O classes, | |
e8b96c60 | 2476 | prioritized in the following order: sync read, sync write, async read, |
2d815d95 AZ |
2477 | async write, and scrub/resilver. |
2478 | Each queue defines the minimum and maximum number of concurrent operations | |
2479 | that may be issued to the device. | |
2480 | In addition, the device has an aggregate maximum, | |
2481 | .Sy zfs_vdev_max_active . | |
2482 | Note that the sum of the per-queue minima must not exceed the aggregate maximum. | |
2483 | If the sum of the per-queue maxima exceeds the aggregate maximum, | |
2484 | then the number of active operations may reach | |
2485 | .Sy zfs_vdev_max_active , | |
2486 | in which case no further operations will be issued, | |
2487 | regardless of whether all per-queue minima have been met. | |
2488 | .Pp | |
e8b96c60 | 2489 | For many physical devices, throughput increases with the number of |
2d815d95 AZ |
2490 | concurrent operations, but latency typically suffers. |
2491 | Furthermore, physical devices typically have a limit | |
2492 | at which more concurrent operations have no | |
e8b96c60 | 2493 | effect on throughput or can actually cause it to decrease. |
2d815d95 | 2494 | .Pp |
e8b96c60 | 2495 | The scheduler selects the next operation to issue by first looking for an |
2d815d95 AZ |
2496 | I/O class whose minimum has not been satisfied. |
2497 | Once all are satisfied and the aggregate maximum has not been hit, | |
2498 | the scheduler looks for classes whose maximum has not been satisfied. | |
2499 | Iteration through the I/O classes is done in the order specified above. | |
2500 | No further operations are issued | |
2501 | if the aggregate maximum number of concurrent operations has been hit, | |
b46be903 DS |
2502 | or if there are no operations queued for an I/O class that has not hit its |
2503 | maximum. | |
2d815d95 AZ |
2504 | Every time an I/O operation is queued or an operation completes, |
2505 | the scheduler looks for new operations to issue. | |
2506 | .Pp | |
2507 | In general, smaller | |
2508 | .Sy max_active Ns s | |
2509 | will lead to lower latency of synchronous operations. | |
2510 | Larger | |
2511 | .Sy max_active Ns s | |
2512 | may lead to higher overall throughput, depending on underlying storage. | |
2513 | .Pp | |
2514 | The ratio of the queues' | |
2515 | .Sy max_active Ns s | |
2516 | determines the balance of performance between reads, writes, and scrubs. | |
2517 | For example, increasing | |
2518 | .Sy zfs_vdev_scrub_max_active | |
2519 | will cause the scrub or resilver to complete more quickly, | |
2520 | but reads and writes to have higher latency and lower throughput. | |
2521 | .Pp | |
2522 | All I/O classes have a fixed maximum number of outstanding operations, | |
2523 | except for the async write class. | |
2524 | Asynchronous writes represent the data that is committed to stable storage | |
2525 | during the syncing stage for transaction groups. | |
2526 | Transaction groups enter the syncing state periodically, | |
2527 | so the number of queued async writes will quickly burst up | |
2528 | and then bleed down to zero. | |
2529 | Rather than servicing them as quickly as possible, | |
2530 | the I/O scheduler changes the maximum number of active async write operations | |
2531 | according to the amount of dirty data in the pool. | |
2532 | Since both throughput and latency typically increase with the number of | |
e8b96c60 | 2533 | concurrent operations issued to physical devices, reducing the |
b46be903 DS |
2534 | burstiness in the number of simultaneous operations also stabilizes the |
2535 | response time of operations from other queues, in particular synchronous ones. | |
2d815d95 | 2536 | In broad strokes, the I/O scheduler will issue more concurrent operations |
b46be903 | 2537 | from the async write queue as there is more dirty data in the pool. |
2d815d95 AZ |
2538 | . |
2539 | .Ss Async Writes | |
e8b96c60 | 2540 | The number of concurrent operations issued for the async write I/O class |
2d815d95 AZ |
2541 | follows a piece-wise linear function defined by a few adjustable points: |
2542 | .Bd -literal | |
2543 | | o---------| <-- \fBzfs_vdev_async_write_max_active\fP | |
e8b96c60 MA |
2544 | ^ | /^ | |
2545 | | | / | | | |
2546 | active | / | | | |
2547 | I/O | / | | | |
2548 | count | / | | | |
2549 | | / | | | |
2d815d95 | 2550 | |-------o | | <-- \fBzfs_vdev_async_write_min_active\fP |
e8b96c60 | 2551 | 0|_______^______|_________| |
2d815d95 | 2552 | 0% | | 100% of \fBzfs_dirty_data_max\fP |
e8b96c60 | 2553 | | | |
2d815d95 AZ |
2554 | | `-- \fBzfs_vdev_async_write_active_max_dirty_percent\fP |
2555 | `--------- \fBzfs_vdev_async_write_active_min_dirty_percent\fP | |
2556 | .Ed | |
2557 | .Pp | |
e8b96c60 MA |
2558 | Until the amount of dirty data exceeds a minimum percentage of the dirty |
2559 | data allowed in the pool, the I/O scheduler will limit the number of | |
2d815d95 AZ |
2560 | concurrent operations to the minimum. |
2561 | As that threshold is crossed, the number of concurrent operations issued | |
2562 | increases linearly to the maximum at the specified maximum percentage | |
2563 | of the dirty data allowed in the pool. | |
2564 | .Pp | |
e8b96c60 | 2565 | Ideally, the amount of dirty data on a busy pool will stay in the sloped |
2d815d95 AZ |
2566 | part of the function between |
2567 | .Sy zfs_vdev_async_write_active_min_dirty_percent | |
2568 | and | |
2569 | .Sy zfs_vdev_async_write_active_max_dirty_percent . | |
2570 | If it exceeds the maximum percentage, | |
2571 | this indicates that the rate of incoming data is | |
2572 | greater than the rate that the backend storage can handle. | |
2573 | In this case, we must further throttle incoming writes, | |
2574 | as described in the next section. | |
2575 | . | |
2576 | .Sh ZFS TRANSACTION DELAY | |
e8b96c60 MA |
2577 | We delay transactions when we've determined that the backend storage |
2578 | isn't able to accommodate the rate of incoming writes. | |
2d815d95 | 2579 | .Pp |
e8b96c60 | 2580 | If there is already a transaction waiting, we delay relative to when |
2d815d95 AZ |
2581 | that transaction will finish waiting. |
2582 | This way the calculated delay time | |
2583 | is independent of the number of threads concurrently executing transactions. | |
2584 | .Pp | |
2585 | If we are the only waiter, wait relative to when the transaction started, | |
2586 | rather than the current time. | |
2587 | This credits the transaction for "time already served", | |
2588 | e.g. reading indirect blocks. | |
2589 | .Pp | |
2590 | The minimum time for a transaction to take is calculated as | |
12bd322d | 2591 | .D1 min_time = min( Ns Sy zfs_delay_scale No \(mu Po Sy dirty No \- Sy min Pc / Po Sy max No \- Sy dirty Pc , 100ms) |
2d815d95 AZ |
2592 | .Pp |
2593 | The delay has two degrees of freedom that can be adjusted via tunables. | |
2594 | The percentage of dirty data at which we start to delay is defined by | |
2595 | .Sy zfs_delay_min_dirty_percent . | |
2596 | This should typically be at or above | |
2597 | .Sy zfs_vdev_async_write_active_max_dirty_percent , | |
2598 | so that we only start to delay after writing at full speed | |
2599 | has failed to keep up with the incoming write rate. | |
2600 | The scale of the curve is defined by | |
2601 | .Sy zfs_delay_scale . | |
b46be903 DS |
2602 | Roughly speaking, this variable determines the amount of delay at the midpoint |
2603 | of the curve. | |
2d815d95 | 2604 | .Bd -literal |
e8b96c60 MA |
2605 | delay |
2606 | 10ms +-------------------------------------------------------------*+ | |
2607 | | *| | |
2608 | 9ms + *+ | |
2609 | | *| | |
2610 | 8ms + *+ | |
2611 | | * | | |
2612 | 7ms + * + | |
2613 | | * | | |
2614 | 6ms + * + | |
2615 | | * | | |
2616 | 5ms + * + | |
2617 | | * | | |
2618 | 4ms + * + | |
2619 | | * | | |
2620 | 3ms + * + | |
2621 | | * | | |
2622 | 2ms + (midpoint) * + | |
2623 | | | ** | | |
2624 | 1ms + v *** + | |
2d815d95 | 2625 | | \fBzfs_delay_scale\fP ----------> ******** | |
e8b96c60 | 2626 | 0 +-------------------------------------*********----------------+ |
2d815d95 AZ |
2627 | 0% <- \fBzfs_dirty_data_max\fP -> 100% |
2628 | .Ed | |
2629 | .Pp | |
2630 | Note, that since the delay is added to the outstanding time remaining on the | |
2631 | most recent transaction it's effectively the inverse of IOPS. | |
2632 | Here, the midpoint of | |
a894ae75 | 2633 | .Em 500 us |
2d815d95 AZ |
2634 | translates to |
2635 | .Em 2000 IOPS . | |
2636 | The shape of the curve | |
e8b96c60 | 2637 | was chosen such that small changes in the amount of accumulated dirty data |
2d815d95 AZ |
2638 | in the first three quarters of the curve yield relatively small differences |
2639 | in the amount of delay. | |
2640 | .Pp | |
e8b96c60 | 2641 | The effects can be easier to understand when the amount of delay is |
2d815d95 AZ |
2642 | represented on a logarithmic scale: |
2643 | .Bd -literal | |
e8b96c60 MA |
2644 | delay |
2645 | 100ms +-------------------------------------------------------------++ | |
2646 | + + | |
2647 | | | | |
2648 | + *+ | |
2649 | 10ms + *+ | |
2650 | + ** + | |
2651 | | (midpoint) ** | | |
2652 | + | ** + | |
2653 | 1ms + v **** + | |
2d815d95 | 2654 | + \fBzfs_delay_scale\fP ----------> ***** + |
e8b96c60 MA |
2655 | | **** | |
2656 | + **** + | |
2657 | 100us + ** + | |
2658 | + * + | |
2659 | | * | | |
2660 | + * + | |
2661 | 10us + * + | |
2662 | + + | |
2663 | | | | |
2664 | + + | |
2665 | +--------------------------------------------------------------+ | |
2d815d95 AZ |
2666 | 0% <- \fBzfs_dirty_data_max\fP -> 100% |
2667 | .Ed | |
2668 | .Pp | |
e8b96c60 | 2669 | Note here that only as the amount of dirty data approaches its limit does |
2d815d95 AZ |
2670 | the delay start to increase rapidly. |
2671 | The goal of a properly tuned system should be to keep the amount of dirty data | |
2672 | out of that range by first ensuring that the appropriate limits are set | |
2673 | for the I/O scheduler to reach optimal throughput on the back-end storage, | |
2674 | and then by changing the value of | |
2675 | .Sy zfs_delay_scale | |
2676 | to increase the steepness of the curve. |