]>
Commit | Line | Data |
---|---|---|
9ae529ec | 1 | '\" te |
d2734cce | 2 | .\" Copyright (c) 2013, 2017 by Delphix. All rights reserved. |
9759c60f | 3 | .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved. |
788eb90c | 4 | .\" Copyright (c) 2014, Joyent, Inc. All rights reserved. |
9ae529ec CS |
5 | .\" The contents of this file are subject to the terms of the Common Development |
6 | .\" and Distribution License (the "License"). You may not use this file except | |
7 | .\" in compliance with the License. You can obtain a copy of the license at | |
8 | .\" usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. | |
9 | .\" | |
10 | .\" See the License for the specific language governing permissions and | |
11 | .\" limitations under the License. When distributing Covered Code, include this | |
12 | .\" CDDL HEADER in each file and include the License file at | |
13 | .\" usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this | |
14 | .\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your | |
15 | .\" own identifying information: | |
16 | .\" Portions Copyright [yyyy] [name of copyright owner] | |
5fadb7fb | 17 | .TH ZPOOL-FEATURES 5 "Jun 8, 2018" |
9ae529ec CS |
18 | .SH NAME |
19 | zpool\-features \- ZFS pool feature descriptions | |
20 | .SH DESCRIPTION | |
21 | .sp | |
22 | .LP | |
23 | ZFS pool on\-disk format versions are specified via "features" which replace | |
24 | the old on\-disk format numbers (the last supported on\-disk format number is | |
b9b24bb4 | 25 | 28). To enable a feature on a pool use the \fBupgrade\fR subcommand of the |
9042ca0e | 26 | zpool(8) command, or set the \fBfeature@\fR\fIfeature_name\fR property |
b9b24bb4 | 27 | to \fBenabled\fR. |
9ae529ec CS |
28 | .sp |
29 | .LP | |
30 | The pool format does not affect file system version compatibility or the ability | |
31 | to send file systems between pools. | |
32 | .sp | |
33 | .LP | |
34 | Since most features can be enabled independently of each other the on\-disk | |
35 | format of the pool is specified by the set of all features marked as | |
36 | \fBactive\fR on the pool. If the pool was created by another software version | |
37 | this set may include unsupported features. | |
38 | .SS "Identifying features" | |
39 | .sp | |
40 | .LP | |
393363c5 RL |
41 | Every feature has a GUID of the form \fIcom.example:feature_name\fR. The |
42 | reverse DNS name ensures that the feature's GUID is unique across all ZFS | |
9ae529ec | 43 | implementations. When unsupported features are encountered on a pool they will |
393363c5 | 44 | be identified by their GUIDs. Refer to the documentation for the ZFS |
9ae529ec CS |
45 | implementation that created the pool for information about those features. |
46 | .sp | |
47 | .LP | |
48 | Each supported feature also has a short name. By convention a feature's short | |
393363c5 | 49 | name is the portion of its GUID which follows the ':' (e.g. |
9ae529ec CS |
50 | \fIcom.example:feature_name\fR would have the short name \fIfeature_name\fR), |
51 | however a feature's short name may differ across ZFS implementations if | |
52 | following the convention would result in name conflicts. | |
53 | .SS "Feature states" | |
54 | .sp | |
55 | .LP | |
56 | Features can be in one of three states: | |
57 | .sp | |
58 | .ne 2 | |
59 | .na | |
60 | \fB\fBactive\fR\fR | |
61 | .ad | |
62 | .RS 12n | |
63 | This feature's on\-disk format changes are in effect on the pool. Support for | |
64 | this feature is required to import the pool in read\-write mode. If this | |
65 | feature is not read-only compatible, support is also required to import the pool | |
66 | in read\-only mode (see "Read\-only compatibility"). | |
67 | .RE | |
68 | ||
69 | .sp | |
70 | .ne 2 | |
71 | .na | |
72 | \fB\fBenabled\fR\fR | |
73 | .ad | |
74 | .RS 12n | |
75 | An administrator has marked this feature as enabled on the pool, but the | |
76 | feature's on\-disk format changes have not been made yet. The pool can still be | |
77 | imported by software that does not support this feature, but changes may be made | |
78 | to the on\-disk format at any time which will move the feature to the | |
79 | \fBactive\fR state. Some features may support returning to the \fBenabled\fR | |
80 | state after becoming \fBactive\fR. See feature\-specific documentation for | |
81 | details. | |
82 | .RE | |
83 | ||
84 | .sp | |
85 | .ne 2 | |
86 | .na | |
87 | \fBdisabled\fR | |
88 | .ad | |
89 | .RS 12n | |
90 | This feature's on\-disk format changes have not been made and will not be made | |
91 | unless an administrator moves the feature to the \fBenabled\fR state. Features | |
92 | cannot be disabled once they have been enabled. | |
93 | .RE | |
94 | ||
95 | .sp | |
96 | .LP | |
97 | The state of supported features is exposed through pool properties of the form | |
98 | \fIfeature@short_name\fR. | |
99 | .SS "Read\-only compatibility" | |
100 | .sp | |
101 | .LP | |
102 | Some features may make on\-disk format changes that do not interfere with other | |
103 | software's ability to read from the pool. These features are referred to as | |
104 | "read\-only compatible". If all unsupported features on a pool are read\-only | |
105 | compatible, the pool can be imported in read\-only mode by setting the | |
9042ca0e | 106 | \fBreadonly\fR property during import (see zpool(8) for details on |
9ae529ec CS |
107 | importing pools). |
108 | .SS "Unsupported features" | |
109 | .sp | |
110 | .LP | |
111 | For each unsupported feature enabled on an imported pool a pool property | |
393363c5 | 112 | named \fIunsupported@feature_name\fR will indicate why the import was allowed |
9ae529ec CS |
113 | despite the unsupported feature. Possible values for this property are: |
114 | ||
115 | .sp | |
116 | .ne 2 | |
117 | .na | |
118 | \fB\fBinactive\fR\fR | |
119 | .ad | |
120 | .RS 12n | |
121 | The feature is in the \fBenabled\fR state and therefore the pool's on\-disk | |
122 | format is still compatible with software that does not support this feature. | |
123 | .RE | |
124 | ||
125 | .sp | |
126 | .ne 2 | |
127 | .na | |
128 | \fB\fBreadonly\fR\fR | |
129 | .ad | |
130 | .RS 12n | |
131 | The feature is read\-only compatible and the pool has been imported in | |
132 | read\-only mode. | |
133 | .RE | |
134 | ||
135 | .SS "Feature dependencies" | |
136 | .sp | |
137 | .LP | |
138 | Some features depend on other features being enabled in order to function | |
139 | properly. Enabling a feature will automatically enable any features it | |
140 | depends on. | |
141 | .SH FEATURES | |
142 | .sp | |
143 | .LP | |
144 | The following features are supported on this system: | |
145 | .sp | |
146 | .ne 2 | |
147 | .na | |
148 | \fB\fBasync_destroy\fR\fR | |
149 | .ad | |
150 | .RS 4n | |
151 | .TS | |
152 | l l . | |
153 | GUID com.delphix:async_destroy | |
154 | READ\-ONLY COMPATIBLE yes | |
155 | DEPENDENCIES none | |
156 | .TE | |
157 | ||
158 | Destroying a file system requires traversing all of its data in order to | |
159 | return its used space to the pool. Without \fBasync_destroy\fR the file system | |
160 | is not fully removed until all space has been reclaimed. If the destroy | |
161 | operation is interrupted by a reboot or power outage the next attempt to open | |
162 | the pool will need to complete the destroy operation synchronously. | |
163 | ||
164 | When \fBasync_destroy\fR is enabled the file system's data will be reclaimed | |
165 | by a background process, allowing the destroy operation to complete without | |
166 | traversing the entire file system. The background process is able to resume | |
167 | interrupted destroys after the pool has been opened, eliminating the need | |
168 | to finish interrupted destroys as part of the open operation. The amount | |
169 | of space remaining to be reclaimed by the background process is available | |
170 | through the \fBfreeing\fR property. | |
171 | ||
172 | This feature is only \fBactive\fR while \fBfreeing\fR is non\-zero. | |
173 | .RE | |
753c3839 MA |
174 | |
175 | .sp | |
176 | .ne 2 | |
177 | .na | |
178 | \fB\fBempty_bpobj\fR\fR | |
179 | .ad | |
180 | .RS 4n | |
181 | .TS | |
182 | l l . | |
183 | GUID com.delphix:empty_bpobj | |
184 | READ\-ONLY COMPATIBLE yes | |
185 | DEPENDENCIES none | |
186 | .TE | |
187 | ||
188 | This feature increases the performance of creating and using a large | |
189 | number of snapshots of a single filesystem or volume, and also reduces | |
190 | the disk space required. | |
191 | ||
192 | When there are many snapshots, each snapshot uses many Block Pointer | |
193 | Objects (bpobj's) to track blocks associated with that snapshot. | |
194 | However, in common use cases, most of these bpobj's are empty. This | |
195 | feature allows us to create each bpobj on-demand, thus eliminating the | |
196 | empty bpobjs. | |
197 | ||
198 | This feature is \fBactive\fR while there are any filesystems, volumes, | |
199 | or snapshots which were created after enabling this feature. | |
200 | .RE | |
201 | ||
788eb90c JJ |
202 | .sp |
203 | .ne 2 | |
204 | .na | |
205 | \fB\fBfilesystem_limits\fR\fR | |
206 | .ad | |
207 | .RS 4n | |
208 | .TS | |
209 | l l . | |
210 | GUID com.joyent:filesystem_limits | |
211 | READ\-ONLY COMPATIBLE yes | |
212 | DEPENDENCIES extensible_dataset | |
213 | .TE | |
214 | ||
215 | This feature enables filesystem and snapshot limits. These limits can be used | |
216 | to control how many filesystems and/or snapshots can be created at the point in | |
217 | the tree on which the limits are set. | |
218 | ||
219 | This feature is \fBactive\fR once either of the limit properties has been | |
220 | set on a dataset. Once activated the feature is never deactivated. | |
221 | .RE | |
222 | ||
9759c60f ED |
223 | .sp |
224 | .ne 2 | |
225 | .na | |
226 | \fB\fBlz4_compress\fR\fR | |
227 | .ad | |
228 | .RS 4n | |
229 | .TS | |
230 | l l . | |
231 | GUID org.illumos:lz4_compress | |
232 | READ\-ONLY COMPATIBLE no | |
233 | DEPENDENCIES none | |
234 | .TE | |
235 | ||
236 | \fBlz4\fR is a high-performance real-time compression algorithm that | |
237 | features significantly faster compression and decompression as well as a | |
238 | higher compression ratio than the older \fBlzjb\fR compression. | |
239 | Typically, \fBlz4\fR compression is approximately 50% faster on | |
240 | compressible data and 200% faster on incompressible data than | |
241 | \fBlzjb\fR. It is also approximately 80% faster on decompression, while | |
242 | giving approximately 10% better compression ratio. | |
243 | ||
244 | When the \fBlz4_compress\fR feature is set to \fBenabled\fR, the | |
245 | administrator can turn on \fBlz4\fR compression on any dataset on the | |
9042ca0e | 246 | pool using the zfs(8) command. Please note that doing so will |
9759c60f | 247 | immediately activate the \fBlz4_compress\fR feature on the underlying |
9042ca0e | 248 | pool using the zfs(8) command. Also, all newly written metadata |
62bdd5eb DL |
249 | will be compressed with \fBlz4\fR algorithm. Since this feature is not |
250 | read-only compatible, this operation will render the pool unimportable | |
5fadb7fb TS |
251 | on systems without support for the \fBlz4_compress\fR feature. |
252 | ||
253 | Booting off of \fBlz4\fR-compressed root pools is supported. | |
62bdd5eb DL |
254 | |
255 | This feature becomes \fBactive\fR as soon as it is enabled and will | |
256 | never return to being \fBenabled\fB. | |
93cf2076 GW |
257 | .RE |
258 | ||
259 | .sp | |
260 | .ne 2 | |
261 | .na | |
262 | \fB\fBspacemap_histogram\fR\fR | |
263 | .ad | |
264 | .RS 4n | |
265 | .TS | |
266 | l l . | |
267 | GUID com.delphix:spacemap_histogram | |
268 | READ\-ONLY COMPATIBLE yes | |
269 | DEPENDENCIES none | |
270 | .TE | |
271 | ||
272 | This features allows ZFS to maintain more information about how free space | |
273 | is organized within the pool. If this feature is \fBenabled\fR, ZFS will | |
274 | set this feature to \fBactive\fR when a new space map object is created or | |
275 | an existing space map is upgraded to the new format. Once the feature is | |
276 | \fBactive\fR, it will remain in that state until the pool is destroyed. | |
9759c60f ED |
277 | |
278 | .RE | |
279 | ||
42db43e9 GDN |
280 | .sp |
281 | .ne 2 | |
282 | .na | |
283 | \fB\fBmulti_vdev_crash_dump\fR\fR | |
284 | .ad | |
285 | .RS 4n | |
286 | .TS | |
287 | l l . | |
4d256e89 RL |
288 | GUID com.joyent:multi_vdev_crash_dump |
289 | READ\-ONLY COMPATIBLE no | |
290 | DEPENDENCIES none | |
42db43e9 GDN |
291 | .TE |
292 | ||
293 | This feature allows a dump device to be configured with a pool comprised | |
294 | of multiple vdevs. Those vdevs may be arranged in any mirrored or raidz | |
295 | configuration. | |
296 | ||
297 | When the \fBmulti_vdev_crash_dump\fR feature is set to \fBenabled\fR, | |
298 | the administrator can use the \fBdumpadm\fR(1M) command to configure a | |
299 | dump device on a pool comprised of multiple vdevs. | |
300 | ||
301 | Under Linux this feature is registered for compatibility but not used. | |
302 | New pools created under Linux will have the feature \fBenabled\fR but | |
303 | will never transition to \fB\fBactive\fR. This functionality is not | |
304 | required in order to support crash dumps under Linux. Existing pools | |
305 | where this feature is \fB\fBactive\fR can be imported. | |
306 | .RE | |
307 | ||
fa86b5db MA |
308 | .sp |
309 | .ne 2 | |
310 | .na | |
311 | \fB\fBextensible_dataset\fR\fR | |
312 | .ad | |
313 | .RS 4n | |
314 | .TS | |
315 | l l . | |
316 | GUID com.delphix:extensible_dataset | |
317 | READ\-ONLY COMPATIBLE no | |
318 | DEPENDENCIES none | |
319 | .TE | |
320 | ||
321 | This feature allows more flexible use of internal ZFS data structures, | |
322 | and exists for other features to depend on. | |
323 | ||
324 | This feature will be \fBactive\fR when the first dependent feature uses it, | |
325 | and will be returned to the \fBenabled\fR state when all datasets that use | |
326 | this feature are destroyed. | |
327 | ||
328 | .RE | |
329 | ||
da536844 MA |
330 | .sp |
331 | .ne 2 | |
332 | .na | |
333 | \fB\fBbookmarks\fR\fR | |
334 | .ad | |
335 | .RS 4n | |
336 | .TS | |
337 | l l . | |
338 | GUID com.delphix:bookmarks | |
339 | READ\-ONLY COMPATIBLE yes | |
340 | DEPENDENCIES extensible_dataset | |
341 | .TE | |
342 | ||
343 | This feature enables use of the \fBzfs bookmark\fR subcommand. | |
344 | ||
345 | This feature is \fBactive\fR while any bookmarks exist in the pool. | |
346 | All bookmarks in the pool can be listed by running | |
347 | \fBzfs list -t bookmark -r \fIpoolname\fR\fR. | |
348 | ||
349 | .RE | |
350 | ||
b0bc7a84 MG |
351 | .sp |
352 | .ne 2 | |
353 | .na | |
354 | \fB\fBenabled_txg\fR\fR | |
355 | .ad | |
356 | .RS 4n | |
357 | .TS | |
358 | l l . | |
359 | GUID com.delphix:enabled_txg | |
360 | READ\-ONLY COMPATIBLE yes | |
361 | DEPENDENCIES none | |
362 | .TE | |
363 | ||
364 | Once this feature is enabled ZFS records the transaction group number | |
365 | in which new features are enabled. This has no user-visible impact, | |
366 | but other features may depend on this feature. | |
367 | ||
368 | This feature becomes \fBactive\fR as soon as it is enabled and will | |
369 | never return to being \fBenabled\fB. | |
370 | ||
371 | .RE | |
372 | ||
373 | .sp | |
374 | .ne 2 | |
375 | .na | |
376 | \fB\fBhole_birth\fR\fR | |
377 | .ad | |
378 | .RS 4n | |
379 | .TS | |
380 | l l . | |
381 | GUID com.delphix:hole_birth | |
382 | READ\-ONLY COMPATIBLE no | |
383 | DEPENDENCIES enabled_txg | |
384 | .TE | |
385 | ||
063edd7f RL |
386 | This feature has/had bugs, the result of which is that, if you do a |
387 | \fBzfs send -i\fR (or \fB-R\fR, since it uses \fB-i\fR) from an affected | |
388 | dataset, the receiver will not see any checksum or other errors, but the | |
389 | resulting destination snapshot will not match the source. Its use by | |
390 | \fBzfs send -i\fR has been disabled by default. See the | |
391 | \fBsend_holes_without_birth_time\fR module parameter in | |
392 | zfs-module-parameters(5). | |
393 | ||
9042ca0e | 394 | This feature improves performance of incremental sends (\fBzfs send -i\fR) |
b0bc7a84 MG |
395 | and receives for objects with many holes. The most common case of |
396 | hole-filled objects is zvols. | |
397 | ||
398 | An incremental send stream from snapshot \fBA\fR to snapshot \fBB\fR | |
399 | contains information about every block that changed between \fBA\fR and | |
400 | \fBB\fR. Blocks which did not change between those snapshots can be | |
401 | identified and omitted from the stream using a piece of metadata called | |
402 | the 'block birth time', but birth times are not recorded for holes (blocks | |
403 | filled only with zeroes). Since holes created after \fBA\fR cannot be | |
404 | distinguished from holes created before \fBA\fR, information about every | |
405 | hole in the entire filesystem or zvol is included in the send stream. | |
406 | ||
407 | For workloads where holes are rare this is not a problem. However, when | |
408 | incrementally replicating filesystems or zvols with many holes (for | |
409 | example a zvol formatted with another filesystem) a lot of time will | |
410 | be spent sending and receiving unnecessary information about holes that | |
411 | already exist on the receiving side. | |
412 | ||
413 | Once the \fBhole_birth\fR feature has been enabled the block birth times | |
414 | of all new holes will be recorded. Incremental sends between snapshots | |
415 | created after this feature is enabled will use this new metadata to avoid | |
416 | sending information about holes that already exist on the receiving side. | |
417 | ||
418 | This feature becomes \fBactive\fR as soon as it is enabled and will | |
419 | never return to being \fBenabled\fB. | |
420 | ||
421 | .RE | |
422 | ||
9b67f605 MA |
423 | .sp |
424 | .ne 2 | |
425 | .na | |
426 | \fB\fBembedded_data\fR\fR | |
427 | .ad | |
428 | .RS 4n | |
429 | .TS | |
430 | l l . | |
431 | GUID com.delphix:embedded_data | |
432 | READ\-ONLY COMPATIBLE no | |
433 | DEPENDENCIES none | |
434 | .TE | |
435 | ||
436 | This feature improves the performance and compression ratio of | |
437 | highly-compressible blocks. Blocks whose contents can compress to 112 bytes | |
438 | or smaller can take advantage of this feature. | |
439 | ||
440 | When this feature is enabled, the contents of highly-compressible blocks are | |
441 | stored in the block "pointer" itself (a misnomer in this case, as it contains | |
6b4e21c6 | 442 | the compressed data, rather than a pointer to its location on disk). Thus |
9b67f605 MA |
443 | the space of the block (one sector, typically 512 bytes or 4KB) is saved, |
444 | and no additional i/o is needed to read and write the data block. | |
445 | ||
446 | This feature becomes \fBactive\fR as soon as it is enabled and will | |
447 | never return to being \fBenabled\fR. | |
448 | ||
449 | .RE | |
a1d477c2 MA |
450 | .sp |
451 | .ne 2 | |
452 | .na | |
453 | \fB\fBdevice_removal\fR\fR | |
454 | .ad | |
455 | .RS 4n | |
456 | .TS | |
457 | l l . | |
458 | GUID com.delphix:device_removal | |
459 | READ\-ONLY COMPATIBLE no | |
460 | DEPENDENCIES none | |
461 | .TE | |
462 | ||
9042ca0e | 463 | This feature enables the \fBzpool remove\fR subcommand to remove top-level |
a1d477c2 MA |
464 | vdevs, evacuating them to reduce the total size of the pool. |
465 | ||
9042ca0e | 466 | This feature becomes \fBactive\fR when the \fBzpool remove\fR subcommand is used |
a1d477c2 MA |
467 | on a top-level vdev, and will never return to being \fBenabled\fR. |
468 | ||
469 | .RE | |
470 | .sp | |
471 | .ne 2 | |
472 | .na | |
473 | \fB\fBobsolete_counts\fR\fR | |
474 | .ad | |
475 | .RS 4n | |
476 | .TS | |
477 | l l . | |
478 | GUID com.delphix:obsolete_counts | |
479 | READ\-ONLY COMPATIBLE yes | |
480 | DEPENDENCIES device_removal | |
481 | .TE | |
b0bc7a84 | 482 | |
a1d477c2 MA |
483 | This feature is an enhancement of device_removal, which will over time |
484 | reduce the memory used to track removed devices. When indirect blocks | |
485 | are freed or remapped, we note that their part of the indirect mapping | |
6e91a72f | 486 | is "obsolete", i.e. no longer needed. |
a1d477c2 | 487 | |
9042ca0e | 488 | This feature becomes \fBactive\fR when the \fBzpool remove\fR subcommand is |
a1d477c2 MA |
489 | used on a top-level vdev, and will never return to being \fBenabled\fR. |
490 | ||
491 | .RE | |
f1512ee6 MA |
492 | .sp |
493 | .ne 2 | |
494 | .na | |
d2734cce SD |
495 | \fB\fBzpool_checkpoint\fR\fR |
496 | .ad | |
497 | .RS 4n | |
498 | .TS | |
499 | l l . | |
500 | GUID com.delphix:zpool_checkpoint | |
501 | READ\-ONLY COMPATIBLE yes | |
502 | DEPENDENCIES none | |
503 | .TE | |
504 | ||
9042ca0e | 505 | This feature enables the \fBzpool checkpoint\fR subcommand that can |
d2734cce SD |
506 | checkpoint the state of the pool at the time it was issued and later |
507 | rewind back to it or discard it. | |
508 | ||
9042ca0e | 509 | This feature becomes \fBactive\fR when the \fBzpool checkpoint\fR subcommand |
d2734cce SD |
510 | is used to checkpoint the pool. |
511 | The feature will only return back to being \fBenabled\fR when the pool | |
512 | is rewound or the checkpoint has been discarded. | |
3be1eb29 | 513 | |
4d044c4c SD |
514 | .RE |
515 | .sp | |
516 | .ne 2 | |
517 | .na | |
518 | \fB\fBspacemap_v2\fR\fR | |
519 | .ad | |
520 | .RS 4n | |
521 | .TS | |
522 | l l . | |
523 | GUID com.delphix:spacemap_v2 | |
524 | READ\-ONLY COMPATIBLE yes | |
525 | DEPENDENCIES none | |
526 | .TE | |
527 | ||
528 | This feature enables the use of the new space map encoding which | |
529 | consists of two words (instead of one) whenever it is advantageous. | |
530 | The new encoding allows space maps to represent large regions of | |
531 | space more efficiently on-disk while also increasing their maximum | |
532 | addressable offset. | |
533 | ||
534 | This feature becomes \fBactive\fR once it is \fBenabled\fR, and never | |
535 | returns back to being \fBenabled\fR. | |
536 | ||
3be1eb29 TC |
537 | .RE |
538 | .sp | |
539 | .ne 2 | |
540 | .na | |
f1512ee6 MA |
541 | \fB\fBlarge_blocks\fR\fR |
542 | .ad | |
543 | .RS 4n | |
544 | .TS | |
545 | l l . | |
e1822912 | 546 | GUID org.open-zfs:large_blocks |
f1512ee6 MA |
547 | READ\-ONLY COMPATIBLE no |
548 | DEPENDENCIES extensible_dataset | |
549 | .TE | |
550 | ||
551 | The \fBlarge_block\fR feature allows the record size on a dataset to be | |
552 | set larger than 128KB. | |
553 | ||
405ec516 | 554 | This feature becomes \fBactive\fR once a dataset contains a file with |
555 | a block size larger than 128KB, and will return to being \fBenabled\fR once all | |
f1512ee6 MA |
556 | filesystems that have ever had their recordsize larger than 128KB are destroyed. |
557 | .RE | |
558 | ||
50c957f7 NB |
559 | .sp |
560 | .ne 2 | |
561 | .na | |
562 | \fB\fBlarge_dnode\fR\fR | |
563 | .ad | |
564 | .RS 4n | |
565 | .TS | |
566 | l l . | |
567 | GUID org.zfsonlinux:large_dnode | |
568 | READ\-ONLY COMPATIBLE no | |
569 | DEPENDENCIES extensible_dataset | |
570 | .TE | |
571 | ||
572 | The \fBlarge_dnode\fR feature allows the size of dnodes in a dataset to be | |
573 | set larger than 512B. | |
574 | ||
575 | This feature becomes \fBactive\fR once a dataset contains an object with | |
576 | a dnode larger than 512B, which occurs as a result of setting the | |
577 | \fBdnodesize\fR dataset property to a value other than \fBlegacy\fR. The | |
578 | feature will return to being \fBenabled\fR once all filesystems that | |
579 | have ever contained a dnode larger than 512B are destroyed. Large dnodes | |
580 | allow more data to be stored in the bonus buffer, thus potentially | |
581 | improving performance by avoiding the use of spill blocks. | |
582 | .RE | |
583 | ||
3c67d83a TH |
584 | \fB\fBsha512\fR\fR |
585 | .ad | |
586 | .RS 4n | |
587 | .TS | |
588 | l l . | |
589 | GUID org.illumos:sha512 | |
590 | READ\-ONLY COMPATIBLE no | |
125a406e | 591 | DEPENDENCIES extensible_dataset |
3c67d83a TH |
592 | .TE |
593 | ||
594 | This feature enables the use of the SHA-512/256 truncated hash algorithm | |
595 | (FIPS 180-4) for checksum and dedup. The native 64-bit arithmetic of | |
596 | SHA-512 provides an approximate 50% performance boost over SHA-256 on | |
597 | 64-bit hardware and is thus a good minimum-change replacement candidate | |
598 | for systems where hash performance is important, but these systems | |
599 | cannot for whatever reason utilize the faster \fBskein\fR and | |
600 | \fBedonr\fR algorithms. | |
601 | ||
602 | When the \fBsha512\fR feature is set to \fBenabled\fR, the administrator | |
9042ca0e RL |
603 | can turn on the \fBsha512\fR checksum on any dataset using |
604 | \fBzfs set checksum=sha512\fR. See zfs(8). This feature becomes | |
3c67d83a TH |
605 | \fBactive\fR once a \fBchecksum\fR property has been set to \fBsha512\fR, |
606 | and will return to being \fBenabled\fR once all filesystems that have | |
607 | ever had their checksum set to \fBsha512\fR are destroyed. | |
608 | ||
6c0f78f8 RL |
609 | The \fBsha512\fR feature is not supported by GRUB and must not be used on |
610 | the pool if GRUB needs to access the pool (e.g. for /boot). | |
3c67d83a TH |
611 | |
612 | .RE | |
613 | ||
614 | .sp | |
615 | .ne 2 | |
616 | .na | |
617 | \fB\fBskein\fR\fR | |
618 | .ad | |
619 | .RS 4n | |
620 | .TS | |
621 | l l . | |
622 | GUID org.illumos:skein | |
623 | READ\-ONLY COMPATIBLE no | |
125a406e | 624 | DEPENDENCIES extensible_dataset |
3c67d83a TH |
625 | .TE |
626 | ||
627 | This feature enables the use of the Skein hash algorithm for checksum | |
628 | and dedup. Skein is a high-performance secure hash algorithm that was a | |
629 | finalist in the NIST SHA-3 competition. It provides a very high security | |
630 | margin and high performance on 64-bit hardware (80% faster than | |
631 | SHA-256). This implementation also utilizes the new salted checksumming | |
632 | functionality in ZFS, which means that the checksum is pre-seeded with a | |
633 | secret 256-bit random key (stored on the pool) before being fed the data | |
634 | block to be checksummed. Thus the produced checksums are unique to a | |
635 | given pool, preventing hash collision attacks on systems with dedup. | |
636 | ||
637 | When the \fBskein\fR feature is set to \fBenabled\fR, the administrator | |
9042ca0e RL |
638 | can turn on the \fBskein\fR checksum on any dataset using |
639 | \fBzfs set checksum=skein\fR. See zfs(8). This feature becomes | |
3c67d83a TH |
640 | \fBactive\fR once a \fBchecksum\fR property has been set to \fBskein\fR, |
641 | and will return to being \fBenabled\fR once all filesystems that have | |
642 | ever had their checksum set to \fBskein\fR are destroyed. | |
643 | ||
6c0f78f8 RL |
644 | The \fBskein\fR feature is not supported by GRUB and must not be used on |
645 | the pool if GRUB needs to access the pool (e.g. for /boot). | |
3c67d83a TH |
646 | |
647 | .RE | |
648 | ||
649 | .sp | |
650 | .ne 2 | |
651 | .na | |
652 | \fB\fBedonr\fR\fR | |
653 | .ad | |
654 | .RS 4n | |
655 | .TS | |
656 | l l . | |
657 | GUID org.illumos:edonr | |
658 | READ\-ONLY COMPATIBLE no | |
125a406e | 659 | DEPENDENCIES extensible_dataset |
3c67d83a TH |
660 | .TE |
661 | ||
662 | This feature enables the use of the Edon-R hash algorithm for checksum, | |
663 | including for nopwrite (if compression is also enabled, an overwrite of | |
664 | a block whose checksum matches the data being written will be ignored). | |
7886aa8a RL |
665 | In an abundance of caution, Edon-R requires verification when used with |
666 | dedup: \fBzfs set dedup=edonr,verify\fR. See \fBzfs\fR(8). | |
3c67d83a TH |
667 | |
668 | Edon-R is a very high-performance hash algorithm that was part | |
669 | of the NIST SHA-3 competition. It provides extremely high hash | |
670 | performance (over 350% faster than SHA-256), but was not selected | |
671 | because of its unsuitability as a general purpose secure hash algorithm. | |
672 | This implementation utilizes the new salted checksumming functionality | |
673 | in ZFS, which means that the checksum is pre-seeded with a secret | |
674 | 256-bit random key (stored on the pool) before being fed the data block | |
675 | to be checksummed. Thus the produced checksums are unique to a given | |
676 | pool. | |
677 | ||
678 | When the \fBedonr\fR feature is set to \fBenabled\fR, the administrator | |
679 | can turn on the \fBedonr\fR checksum on any dataset using the | |
9042ca0e | 680 | \fBzfs set checksum=edonr\fR. See zfs(8). This feature becomes |
3c67d83a TH |
681 | \fBactive\fR once a \fBchecksum\fR property has been set to \fBedonr\fR, |
682 | and will return to being \fBenabled\fR once all filesystems that have | |
683 | ever had their checksum set to \fBedonr\fR are destroyed. | |
684 | ||
6c0f78f8 RL |
685 | The \fBedonr\fR feature is not supported by GRUB and must not be used on |
686 | the pool if GRUB needs to access the pool (e.g. for /boot). | |
3c67d83a | 687 | |
9ff13dbe BB |
688 | .RE |
689 | ||
1de321e6 JX |
690 | .sp |
691 | .ne 2 | |
692 | .na | |
693 | \fB\fBuserobj_accounting\fR\fR | |
694 | .ad | |
695 | .RS 4n | |
696 | .TS | |
697 | l l . | |
698 | GUID org.zfsonlinux:userobj_accounting | |
699 | READ\-ONLY COMPATIBLE yes | |
700 | DEPENDENCIES extensible_dataset | |
701 | .TE | |
702 | ||
703 | This feature allows administrators to account the object usage information | |
704 | by user and group. | |
705 | ||
706 | This feature becomes \fBactive\fR as soon as it is enabled and will never | |
707 | return to being \fBenabled\fR. Each filesystem will be upgraded automatically | |
708 | when remounted, or when new files are created under that filesystem. | |
709 | The upgrade can also be started manually on filesystems by running | |
710 | `zfs set version=current <pool/fs>`. The upgrade process runs in the background | |
711 | and may take a while to complete for filesystems containing a large number of | |
712 | files. | |
713 | ||
714 | .RE | |
715 | ||
579ce7c5 TC |
716 | .sp |
717 | .ne 2 | |
718 | .na | |
719 | \fB\fBbookmark_v2\fR\fR | |
720 | .ad | |
721 | .RS 4n | |
722 | .TS | |
723 | l l . | |
724 | GUID com.datto:bookmark_v2 | |
725 | READ\-ONLY COMPATIBLE no | |
e1fbe771 | 726 | DEPENDENCIES bookmark, extensible_dataset |
579ce7c5 TC |
727 | .TE |
728 | ||
729 | This feature enables the creation and management of larger bookmarks which are | |
730 | needed for other features in ZFS. | |
731 | ||
732 | This feature becomes \fBactive\fR when a v2 bookmark is created and will be | |
733 | returned to the \fBenabled\fR state when all v2 bookmarks are destroyed. | |
734 | ||
735 | .RE | |
736 | ||
b5256303 TC |
737 | .sp |
738 | .ne 2 | |
739 | .na | |
740 | \fB\fBencryption\fR\fR | |
741 | .ad | |
742 | .RS 4n | |
743 | .TS | |
744 | l l . | |
745 | GUID com.datto:encryption | |
746 | READ\-ONLY COMPATIBLE no | |
e1fbe771 | 747 | DEPENDENCIES bookmark_v2, extensible_dataset |
b5256303 TC |
748 | .TE |
749 | ||
750 | This feature enables the creation and management of natively encrypted datasets. | |
751 | ||
752 | This feature becomes \fBactive\fR when an encrypted dataset is created and will | |
753 | be returned to the \fBenabled\fR state when all datasets that use this feature | |
754 | are destroyed. | |
755 | ||
756 | .RE | |
757 | ||
9c5167d1 NF |
758 | .sp |
759 | .ne 2 | |
760 | .na | |
761 | \fB\fBproject_quota\fR\fR | |
762 | .ad | |
763 | .RS 4n | |
764 | .TS | |
765 | l l . | |
766 | GUID org.zfsonlinux:project_quota | |
767 | READ\-ONLY COMPATIBLE yes | |
768 | DEPENDENCIES extensible_dataset | |
769 | .TE | |
770 | ||
771 | This feature allows administrators to account the spaces and objects usage | |
772 | information against the project identifier (ID). | |
773 | ||
774 | The project ID is new object-based attribute. When upgrading an existing | |
775 | filesystem, object without project ID attribute will be assigned a zero | |
776 | project ID. After this feature is enabled, newly created object will inherit | |
777 | its parent directory's project ID if the parent inherit flag is set (via | |
778 | \fBchattr +/-P\fR or \fBzfs project [-s|-C]\fR). Otherwise, the new object's | |
779 | project ID will be set as zero. An object's project ID can be changed at | |
780 | anytime by the owner (or privileged user) via \fBchattr -p $prjid\fR or | |
781 | \fBzfs project -p $prjid\fR. | |
782 | ||
783 | This feature will become \fBactive\fR as soon as it is enabled and will never | |
784 | return to being \fBdisabled\fR. Each filesystem will be upgraded automatically | |
785 | when remounted or when new file is created under that filesystem. The upgrade | |
786 | can also be triggered on filesystems via `zfs set version=current <pool/fs>`. | |
787 | The upgrade process runs in the background and may take a while to complete | |
788 | for the filesystems containing a large number of files. | |
789 | ||
80a91e74 TC |
790 | .RE |
791 | .sp | |
792 | .ne 2 | |
793 | .na | |
794 | \fB\fBresilver_defer\fR\fR | |
795 | .ad | |
796 | .RS 4n | |
797 | .TS | |
798 | l l . | |
799 | GUID com.datto:resilver_defer | |
800 | READ\-ONLY COMPATIBLE yes | |
801 | DEPENDENCIES none | |
802 | .TE | |
803 | ||
804 | This feature allows zfs to postpone new resilvers if an existing one is already | |
805 | in progress. Without this feature, any new resilvers will cause the currently | |
806 | running one to be immediately restarted from the beginning. | |
807 | ||
612c4930 RL |
808 | This feature becomes \fBactive\fR once a resilver has been deferred, and |
809 | returns to being \fBenabled\fR when the deferred resilver begins. | |
80a91e74 | 810 | |
9c5167d1 NF |
811 | .RE |
812 | ||
cc99f275 DB |
813 | .sp |
814 | .ne 2 | |
815 | .na | |
816 | \fB\fBallocation_classes\fR\fR | |
817 | .ad | |
818 | .RS 4n | |
819 | .TS | |
820 | l l . | |
81155b29 | 821 | GUID org.zfsonlinux:allocation_classes |
cc99f275 DB |
822 | READ\-ONLY COMPATIBLE yes |
823 | DEPENDENCIES none | |
824 | .TE | |
825 | ||
826 | This feature enables support for separate allocation classes. | |
827 | ||
828 | This feature becomes \fBactive\fR when a dedicated allocation class vdev | |
9042ca0e RL |
829 | (dedup or special) is created with the \fBzpool create\fR or \fBzpool add\fR |
830 | subcommands. With device removal, it can be returned to the \fBenabled\fR | |
831 | state if all the dedicated allocation class vdevs are removed. | |
cc99f275 DB |
832 | |
833 | .RE | |
834 | ||
9ae529ec | 835 | .SH "SEE ALSO" |
9042ca0e | 836 | zpool(8) |