1 // SPDX-License-Identifier: CDDL-1.0
2 /*
3 * This file and its contents are supplied under the terms of the
4 * Common Development and Distribution License ("CDDL"), version 1.0.
5 * You may only use this file in accordance with the terms of version
6 * 1.0 of the CDDL.
7 *
8 * A full copy of the text of the CDDL should have accompanied this
9 * source. A copy of the CDDL is also available via the Internet at
10 * https://opensource.org/license/CDDL-1.0.
11 */
12 /*
13 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
14 * Copyright (c) 2011, 2018 by Delphix. All rights reserved.
15 * Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
16 * Copyright 2016, Joyent, Inc.
17 * Copyright (c) 2019, Klara Inc.
18 * Copyright (c) 2019, Allan Jude
19 * Copyright (c) 2022 Hewlett Packard Enterprise Development LP.
20 */
21
22 /* Portions Copyright 2010 Robert Milkowski */
23
24 #if defined(_KERNEL)
25 #include <sys/simd.h>
26 #endif
27
28 #include <sys/zio.h>
29 #include <sys/spa.h>
30 #include <sys/u8_textprep.h>
31 #include <sys/zfs_acl.h>
32 #include <sys/zfs_ioctl.h>
33 #include <sys/zfs_znode.h>
34 #include <sys/dsl_crypt.h>
35 #include <sys/simd.h>
36
37 #include "zfs_prop.h"
38 #include "zfs_deleg.h"
39 #include "zfs_fletcher.h"
40
41 #if !defined(_KERNEL)
42 #include <stdlib.h>
43 #include <string.h>
44 #include <ctype.h>
45 #endif
46
47 static zprop_desc_t zfs_prop_table[ZFS_NUM_PROPS];
48
49 /* Note this is indexed by zfs_userquota_prop_t, keep the order the same */
50 const char *const zfs_userquota_prop_prefixes[] = {
51 "userused@",
52 "userquota@",
53 "groupused@",
54 "groupquota@",
55 "userobjused@",
56 "userobjquota@",
57 "groupobjused@",
58 "groupobjquota@",
59 "projectused@",
60 "projectquota@",
61 "projectobjused@",
62 "projectobjquota@"
63 };
64
65 zprop_desc_t *
zfs_prop_get_table(void)66 zfs_prop_get_table(void)
67 {
68 return (zfs_prop_table);
69 }
70
71 void
zfs_prop_init(void)72 zfs_prop_init(void)
73 {
74 static const zprop_index_t checksum_table[] = {
75 { "on", ZIO_CHECKSUM_ON },
76 { "off", ZIO_CHECKSUM_OFF },
77 { "fletcher2", ZIO_CHECKSUM_FLETCHER_2 },
78 { "fletcher4", ZIO_CHECKSUM_FLETCHER_4 },
79 { "sha256", ZIO_CHECKSUM_SHA256 },
80 { "noparity", ZIO_CHECKSUM_NOPARITY },
81 { "sha512", ZIO_CHECKSUM_SHA512 },
82 { "skein", ZIO_CHECKSUM_SKEIN },
83 { "edonr", ZIO_CHECKSUM_EDONR },
84 { "blake3", ZIO_CHECKSUM_BLAKE3 },
85 { NULL }
86 };
87
88 static const zprop_index_t dedup_table[] = {
89 { "on", ZIO_CHECKSUM_ON },
90 { "off", ZIO_CHECKSUM_OFF },
91 { "verify", ZIO_CHECKSUM_ON | ZIO_CHECKSUM_VERIFY },
92 { "sha256", ZIO_CHECKSUM_SHA256 },
93 { "sha256,verify",
94 ZIO_CHECKSUM_SHA256 | ZIO_CHECKSUM_VERIFY },
95 { "sha512", ZIO_CHECKSUM_SHA512 },
96 { "sha512,verify",
97 ZIO_CHECKSUM_SHA512 | ZIO_CHECKSUM_VERIFY },
98 { "skein", ZIO_CHECKSUM_SKEIN },
99 { "skein,verify",
100 ZIO_CHECKSUM_SKEIN | ZIO_CHECKSUM_VERIFY },
101 { "edonr,verify",
102 ZIO_CHECKSUM_EDONR | ZIO_CHECKSUM_VERIFY },
103 { "blake3", ZIO_CHECKSUM_BLAKE3 },
104 { "blake3,verify",
105 ZIO_CHECKSUM_BLAKE3 | ZIO_CHECKSUM_VERIFY },
106 { NULL }
107 };
108
109 static const zprop_index_t compress_table[] = {
110 { "on", ZIO_COMPRESS_ON },
111 { "off", ZIO_COMPRESS_OFF },
112 { "lzjb", ZIO_COMPRESS_LZJB },
113 { "gzip", ZIO_COMPRESS_GZIP_6 }, /* gzip default */
114 { "gzip-1", ZIO_COMPRESS_GZIP_1 },
115 { "gzip-2", ZIO_COMPRESS_GZIP_2 },
116 { "gzip-3", ZIO_COMPRESS_GZIP_3 },
117 { "gzip-4", ZIO_COMPRESS_GZIP_4 },
118 { "gzip-5", ZIO_COMPRESS_GZIP_5 },
119 { "gzip-6", ZIO_COMPRESS_GZIP_6 },
120 { "gzip-7", ZIO_COMPRESS_GZIP_7 },
121 { "gzip-8", ZIO_COMPRESS_GZIP_8 },
122 { "gzip-9", ZIO_COMPRESS_GZIP_9 },
123 { "zle", ZIO_COMPRESS_ZLE },
124 { "lz4", ZIO_COMPRESS_LZ4 },
125 { "zstd", ZIO_COMPRESS_ZSTD },
126 { "zstd-fast",
127 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_DEFAULT) },
128
129 /*
130 * ZSTD 1-19 are synthetic. We store the compression level in a
131 * separate hidden property to avoid wasting a large amount of
132 * space in the ZIO_COMPRESS enum.
133 *
134 * The compression level is also stored within the header of the
135 * compressed block since we may need it for later recompression
136 * to avoid checksum errors (L2ARC).
137 *
138 * Note that the level here is defined as bit shifted mask on
139 * top of the method.
140 */
141 { "zstd-1", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_1) },
142 { "zstd-2", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_2) },
143 { "zstd-3", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_3) },
144 { "zstd-4", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_4) },
145 { "zstd-5", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_5) },
146 { "zstd-6", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_6) },
147 { "zstd-7", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_7) },
148 { "zstd-8", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_8) },
149 { "zstd-9", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_9) },
150 { "zstd-10", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_10) },
151 { "zstd-11", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_11) },
152 { "zstd-12", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_12) },
153 { "zstd-13", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_13) },
154 { "zstd-14", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_14) },
155 { "zstd-15", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_15) },
156 { "zstd-16", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_16) },
157 { "zstd-17", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_17) },
158 { "zstd-18", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_18) },
159 { "zstd-19", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_19) },
160
161 /*
162 * The ZSTD-Fast levels are also synthetic.
163 */
164 { "zstd-fast-1",
165 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_1) },
166 { "zstd-fast-2",
167 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_2) },
168 { "zstd-fast-3",
169 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_3) },
170 { "zstd-fast-4",
171 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_4) },
172 { "zstd-fast-5",
173 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_5) },
174 { "zstd-fast-6",
175 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_6) },
176 { "zstd-fast-7",
177 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_7) },
178 { "zstd-fast-8",
179 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_8) },
180 { "zstd-fast-9",
181 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_9) },
182 { "zstd-fast-10",
183 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_10) },
184 { "zstd-fast-20",
185 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_20) },
186 { "zstd-fast-30",
187 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_30) },
188 { "zstd-fast-40",
189 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_40) },
190 { "zstd-fast-50",
191 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_50) },
192 { "zstd-fast-60",
193 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_60) },
194 { "zstd-fast-70",
195 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_70) },
196 { "zstd-fast-80",
197 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_80) },
198 { "zstd-fast-90",
199 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_90) },
200 { "zstd-fast-100",
201 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_100) },
202 { "zstd-fast-500",
203 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_500) },
204 { "zstd-fast-1000",
205 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_1000) },
206 { NULL }
207 };
208
209 static const zprop_index_t crypto_table[] = {
210 { "on", ZIO_CRYPT_ON },
211 { "off", ZIO_CRYPT_OFF },
212 { "aes-128-ccm", ZIO_CRYPT_AES_128_CCM },
213 { "aes-192-ccm", ZIO_CRYPT_AES_192_CCM },
214 { "aes-256-ccm", ZIO_CRYPT_AES_256_CCM },
215 { "aes-128-gcm", ZIO_CRYPT_AES_128_GCM },
216 { "aes-192-gcm", ZIO_CRYPT_AES_192_GCM },
217 { "aes-256-gcm", ZIO_CRYPT_AES_256_GCM },
218 { NULL }
219 };
220
221 static const zprop_index_t keyformat_table[] = {
222 { "none", ZFS_KEYFORMAT_NONE },
223 { "raw", ZFS_KEYFORMAT_RAW },
224 { "hex", ZFS_KEYFORMAT_HEX },
225 { "passphrase", ZFS_KEYFORMAT_PASSPHRASE },
226 { NULL }
227 };
228
229 static const zprop_index_t snapdir_table[] = {
230 { "hidden", ZFS_SNAPDIR_HIDDEN },
231 { "visible", ZFS_SNAPDIR_VISIBLE },
232 { "disabled", ZFS_SNAPDIR_DISABLED },
233 { NULL }
234 };
235
236 static const zprop_index_t snapdev_table[] = {
237 { "hidden", ZFS_SNAPDEV_HIDDEN },
238 { "visible", ZFS_SNAPDEV_VISIBLE },
239 { NULL }
240 };
241
242 static const zprop_index_t acl_mode_table[] = {
243 { "discard", ZFS_ACL_DISCARD },
244 { "groupmask", ZFS_ACL_GROUPMASK },
245 { "passthrough", ZFS_ACL_PASSTHROUGH },
246 { "restricted", ZFS_ACL_RESTRICTED },
247 { NULL }
248 };
249
250 static const zprop_index_t acltype_table[] = {
251 { "off", ZFS_ACLTYPE_OFF },
252 { "posix", ZFS_ACLTYPE_POSIX },
253 { "nfsv4", ZFS_ACLTYPE_NFSV4 },
254 { "disabled", ZFS_ACLTYPE_OFF }, /* bkwrd compatibility */
255 { "noacl", ZFS_ACLTYPE_OFF }, /* bkwrd compatibility */
256 { "posixacl", ZFS_ACLTYPE_POSIX }, /* bkwrd compatibility */
257 { NULL }
258 };
259
260 static const zprop_index_t acl_inherit_table[] = {
261 { "discard", ZFS_ACL_DISCARD },
262 { "noallow", ZFS_ACL_NOALLOW },
263 { "restricted", ZFS_ACL_RESTRICTED },
264 { "passthrough", ZFS_ACL_PASSTHROUGH },
265 { "secure", ZFS_ACL_RESTRICTED }, /* bkwrd compatibility */
266 { "passthrough-x", ZFS_ACL_PASSTHROUGH_X },
267 { NULL }
268 };
269
270 static const zprop_index_t case_table[] = {
271 { "sensitive", ZFS_CASE_SENSITIVE },
272 { "insensitive", ZFS_CASE_INSENSITIVE },
273 { "mixed", ZFS_CASE_MIXED },
274 { NULL }
275 };
276
277 static const zprop_index_t copies_table[] = {
278 { "1", 1 },
279 { "2", 2 },
280 { "3", 3 },
281 { NULL }
282 };
283
284 /*
285 * Use the unique flags we have to send to u8_strcmp() and/or
286 * u8_textprep() to represent the various normalization property
287 * values.
288 */
289 static const zprop_index_t normalize_table[] = {
290 { "none", 0 },
291 { "formD", U8_TEXTPREP_NFD },
292 { "formKC", U8_TEXTPREP_NFKC },
293 { "formC", U8_TEXTPREP_NFC },
294 { "formKD", U8_TEXTPREP_NFKD },
295 { NULL }
296 };
297
298 static const zprop_index_t version_table[] = {
299 { "1", 1 },
300 { "2", 2 },
301 { "3", 3 },
302 { "4", 4 },
303 { "5", 5 },
304 { "current", ZPL_VERSION },
305 { NULL }
306 };
307
308 static const zprop_index_t boolean_table[] = {
309 { "off", 0 },
310 { "on", 1 },
311 { NULL }
312 };
313
314 static const zprop_index_t keystatus_table[] = {
315 { "none", ZFS_KEYSTATUS_NONE},
316 { "unavailable", ZFS_KEYSTATUS_UNAVAILABLE},
317 { "available", ZFS_KEYSTATUS_AVAILABLE},
318 { NULL }
319 };
320
321 static const zprop_index_t logbias_table[] = {
322 { "latency", ZFS_LOGBIAS_LATENCY },
323 { "throughput", ZFS_LOGBIAS_THROUGHPUT },
324 { NULL }
325 };
326
327 static const zprop_index_t canmount_table[] = {
328 { "off", ZFS_CANMOUNT_OFF },
329 { "on", ZFS_CANMOUNT_ON },
330 { "noauto", ZFS_CANMOUNT_NOAUTO },
331 { NULL }
332 };
333
334 static const zprop_index_t cache_table[] = {
335 { "none", ZFS_CACHE_NONE },
336 { "metadata", ZFS_CACHE_METADATA },
337 { "all", ZFS_CACHE_ALL },
338 { NULL }
339 };
340
341 static const zprop_index_t prefetch_table[] = {
342 { "none", ZFS_PREFETCH_NONE },
343 { "metadata", ZFS_PREFETCH_METADATA },
344 { "all", ZFS_PREFETCH_ALL },
345 { NULL }
346 };
347
348 static const zprop_index_t sync_table[] = {
349 { "standard", ZFS_SYNC_STANDARD },
350 { "always", ZFS_SYNC_ALWAYS },
351 { "disabled", ZFS_SYNC_DISABLED },
352 { NULL }
353 };
354
355 static const zprop_index_t xattr_table[] = {
356 { "off", ZFS_XATTR_OFF },
357 { "sa", ZFS_XATTR_SA },
358 { "on", ZFS_XATTR_SA },
359 { "dir", ZFS_XATTR_DIR },
360 { NULL }
361 };
362
363 static const zprop_index_t dnsize_table[] = {
364 { "legacy", ZFS_DNSIZE_LEGACY },
365 { "auto", ZFS_DNSIZE_AUTO },
366 { "1k", ZFS_DNSIZE_1K },
367 { "2k", ZFS_DNSIZE_2K },
368 { "4k", ZFS_DNSIZE_4K },
369 { "8k", ZFS_DNSIZE_8K },
370 { "16k", ZFS_DNSIZE_16K },
371 { NULL }
372 };
373
374 static const zprop_index_t redundant_metadata_table[] = {
375 { "all", ZFS_REDUNDANT_METADATA_ALL },
376 { "most", ZFS_REDUNDANT_METADATA_MOST },
377 { "some", ZFS_REDUNDANT_METADATA_SOME },
378 { "none", ZFS_REDUNDANT_METADATA_NONE },
379 { NULL }
380 };
381
382 static const zprop_index_t volmode_table[] = {
383 { "default", ZFS_VOLMODE_DEFAULT },
384 { "full", ZFS_VOLMODE_GEOM },
385 { "geom", ZFS_VOLMODE_GEOM },
386 { "dev", ZFS_VOLMODE_DEV },
387 { "none", ZFS_VOLMODE_NONE },
388 { NULL }
389 };
390
391 static const zprop_index_t direct_table[] = {
392 { "disabled", ZFS_DIRECT_DISABLED },
393 { "standard", ZFS_DIRECT_STANDARD },
394 { "always", ZFS_DIRECT_ALWAYS },
395 { NULL }
396 };
397
398 struct zfs_mod_supported_features *sfeatures =
399 zfs_mod_list_supported(ZFS_SYSFS_DATASET_PROPERTIES);
400
401 /* inherit index properties */
402 zprop_register_index(ZFS_PROP_REDUNDANT_METADATA, "redundant_metadata",
403 ZFS_REDUNDANT_METADATA_ALL,
404 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
405 "all | most | some | none", "REDUND_MD",
406 redundant_metadata_table, sfeatures);
407 zprop_register_index(ZFS_PROP_SYNC, "sync", ZFS_SYNC_STANDARD,
408 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
409 "standard | always | disabled", "SYNC",
410 sync_table, sfeatures);
411 zprop_register_index(ZFS_PROP_CHECKSUM, "checksum",
412 ZIO_CHECKSUM_DEFAULT, PROP_INHERIT, ZFS_TYPE_FILESYSTEM |
413 ZFS_TYPE_VOLUME,
414 "on | off | fletcher2 | fletcher4 | sha256 | sha512 | skein"
415 " | edonr | blake3",
416 "CHECKSUM", checksum_table, sfeatures);
417 zprop_register_index(ZFS_PROP_DEDUP, "dedup", ZIO_CHECKSUM_OFF,
418 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
419 "on | off | verify | sha256[,verify] | sha512[,verify] | "
420 "skein[,verify] | edonr,verify | blake3[,verify]",
421 "DEDUP", dedup_table, sfeatures);
422 zprop_register_index(ZFS_PROP_COMPRESSION, "compression",
423 ZIO_COMPRESS_DEFAULT, PROP_INHERIT,
424 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
425 "on | off | lzjb | gzip | gzip-[1-9] | zle | lz4 | "
426 "zstd | zstd-[1-19] | "
427 "zstd-fast | zstd-fast-[1-10,20,30,40,50,60,70,80,90,100,500,1000]",
428 "COMPRESS", compress_table, sfeatures);
429 zprop_register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN,
430 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
431 "disabled | hidden | visible", "SNAPDIR", snapdir_table, sfeatures);
432 zprop_register_index(ZFS_PROP_SNAPDEV, "snapdev", ZFS_SNAPDEV_HIDDEN,
433 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
434 "hidden | visible", "SNAPDEV", snapdev_table, sfeatures);
435 zprop_register_index(ZFS_PROP_ACLMODE, "aclmode", ZFS_ACL_DISCARD,
436 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
437 "discard | groupmask | passthrough | restricted", "ACLMODE",
438 acl_mode_table, sfeatures);
439 zprop_register_index(ZFS_PROP_ACLTYPE, "acltype",
440 #ifdef __linux__
441 /* Linux doesn't natively support ZFS's NFSv4-style ACLs. */
442 ZFS_ACLTYPE_OFF,
443 #else
444 ZFS_ACLTYPE_NFSV4,
445 #endif
446 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
447 "off | nfsv4 | posix", "ACLTYPE", acltype_table, sfeatures);
448 zprop_register_index(ZFS_PROP_ACLINHERIT, "aclinherit",
449 ZFS_ACL_RESTRICTED, PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
450 "discard | noallow | restricted | passthrough | passthrough-x",
451 "ACLINHERIT", acl_inherit_table, sfeatures);
452 zprop_register_index(ZFS_PROP_COPIES, "copies", 1, PROP_INHERIT,
453 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
454 "1 | 2 | 3", "COPIES", copies_table, sfeatures);
455 zprop_register_index(ZFS_PROP_PRIMARYCACHE, "primarycache",
456 ZFS_CACHE_ALL, PROP_INHERIT,
457 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
458 "all | none | metadata", "PRIMARYCACHE", cache_table, sfeatures);
459 zprop_register_index(ZFS_PROP_SECONDARYCACHE, "secondarycache",
460 ZFS_CACHE_ALL, PROP_INHERIT,
461 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
462 "all | none | metadata", "SECONDARYCACHE", cache_table, sfeatures);
463 zprop_register_index(ZFS_PROP_PREFETCH, "prefetch",
464 ZFS_PREFETCH_ALL, PROP_INHERIT,
465 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
466 "none | metadata | all", "PREFETCH", prefetch_table, sfeatures);
467 zprop_register_index(ZFS_PROP_LOGBIAS, "logbias", ZFS_LOGBIAS_LATENCY,
468 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
469 "latency | throughput", "LOGBIAS", logbias_table, sfeatures);
470 zprop_register_index(ZFS_PROP_XATTR, "xattr", ZFS_XATTR_SA,
471 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
472 "on | off | dir | sa", "XATTR", xattr_table, sfeatures);
473 zprop_register_index(ZFS_PROP_DNODESIZE, "dnodesize",
474 ZFS_DNSIZE_LEGACY, PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
475 "legacy | auto | 1k | 2k | 4k | 8k | 16k", "DNSIZE", dnsize_table,
476 sfeatures);
477 zprop_register_index(ZFS_PROP_VOLMODE, "volmode",
478 ZFS_VOLMODE_DEFAULT, PROP_INHERIT,
479 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
480 "default | full | geom | dev | none", "VOLMODE", volmode_table,
481 sfeatures);
482 zprop_register_index(ZFS_PROP_DIRECT, "direct",
483 ZFS_DIRECT_STANDARD, PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
484 "disabled | standard | always", "DIRECT", direct_table,
485 sfeatures);
486
487 /* inherit index (boolean) properties */
488 zprop_register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT,
489 ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table, sfeatures);
490 zprop_register_index(ZFS_PROP_RELATIME, "relatime",
491 #ifdef __FreeBSD__
492 0, /* FreeBSD does not natively support relatime. */
493 #else
494 1,
495 #endif
496 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "on | off", "RELATIME",
497 boolean_table, sfeatures);
498 zprop_register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT,
499 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES",
500 boolean_table, sfeatures);
501 zprop_register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT,
502 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC",
503 boolean_table, sfeatures);
504 zprop_register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT,
505 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID",
506 boolean_table, sfeatures);
507 zprop_register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT,
508 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY",
509 boolean_table, sfeatures);
510 #ifdef __FreeBSD__
511 zprop_register_index(ZFS_PROP_ZONED, "jailed", 0, PROP_INHERIT,
512 ZFS_TYPE_FILESYSTEM, "on | off", "JAILED", boolean_table,
513 sfeatures);
514 #else
515 zprop_register_index(ZFS_PROP_ZONED, "zoned", 0, PROP_INHERIT,
516 ZFS_TYPE_FILESYSTEM, "on | off", "ZONED", boolean_table, sfeatures);
517 #endif
518 /* UID-based zoning for rootless containers */
519 zprop_register_number(ZFS_PROP_ZONED_UID, "zoned_uid", 0,
520 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "<uid> | none", "ZONED_UID",
521 B_FALSE, sfeatures);
522 zprop_register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT,
523 ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN", boolean_table, sfeatures);
524 zprop_register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT,
525 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND",
526 boolean_table, sfeatures);
527 zprop_register_index(ZFS_PROP_OVERLAY, "overlay", 1, PROP_INHERIT,
528 ZFS_TYPE_FILESYSTEM, "on | off", "OVERLAY", boolean_table,
529 sfeatures);
530
531 /* default index properties */
532 zprop_register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT,
533 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
534 "1 | 2 | 3 | 4 | 5 | current", "VERSION", version_table, sfeatures);
535 zprop_register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON,
536 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto",
537 "CANMOUNT", canmount_table, sfeatures);
538
539 /* readonly index properties */
540 zprop_register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY,
541 ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table,
542 sfeatures);
543 zprop_register_index(ZFS_PROP_DEFER_DESTROY, "defer_destroy", 0,
544 PROP_READONLY, ZFS_TYPE_SNAPSHOT, "yes | no", "DEFER_DESTROY",
545 boolean_table, sfeatures);
546 zprop_register_index(ZFS_PROP_KEYSTATUS, "keystatus",
547 ZFS_KEYSTATUS_NONE, PROP_READONLY, ZFS_TYPE_DATASET,
548 "none | unavailable | available",
549 "KEYSTATUS", keystatus_table, sfeatures);
550
551 /* set once index properties */
552 zprop_register_index(ZFS_PROP_NORMALIZE, "normalization", 0,
553 PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
554 "none | formC | formD | formKC | formKD", "NORMALIZATION",
555 normalize_table, sfeatures);
556 zprop_register_index(ZFS_PROP_CASE, "casesensitivity",
557 ZFS_CASE_SENSITIVE, PROP_ONETIME, ZFS_TYPE_FILESYSTEM |
558 ZFS_TYPE_SNAPSHOT,
559 "sensitive | insensitive | mixed", "CASE", case_table, sfeatures);
560 zprop_register_index(ZFS_PROP_KEYFORMAT, "keyformat",
561 ZFS_KEYFORMAT_NONE, PROP_ONETIME_DEFAULT,
562 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
563 "none | raw | hex | passphrase", "KEYFORMAT", keyformat_table,
564 sfeatures);
565 zprop_register_index(ZFS_PROP_ENCRYPTION, "encryption",
566 ZIO_CRYPT_DEFAULT, PROP_ONETIME, ZFS_TYPE_DATASET,
567 "on | off | aes-128-ccm | aes-192-ccm | aes-256-ccm | "
568 "aes-128-gcm | aes-192-gcm | aes-256-gcm", "ENCRYPTION",
569 crypto_table, sfeatures);
570
571 /* set once index (boolean) properties */
572 zprop_register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME,
573 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
574 "on | off", "UTF8ONLY", boolean_table, sfeatures);
575
576 /* string properties */
577 zprop_register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY,
578 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN",
579 sfeatures);
580 zprop_register_string(ZFS_PROP_CLONES, "clones", NULL, PROP_READONLY,
581 ZFS_TYPE_SNAPSHOT, "<dataset>[,...]", "CLONES", sfeatures);
582 zprop_register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/",
583 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "<path> | legacy | none",
584 "MOUNTPOINT", sfeatures);
585 zprop_register_string(ZFS_PROP_SHARENFS, "sharenfs", "off",
586 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "on | off | NFS share options",
587 "SHARENFS", sfeatures);
588 zprop_register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY,
589 ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK,
590 "filesystem | volume | snapshot | bookmark", "TYPE", sfeatures);
591 zprop_register_string(ZFS_PROP_SHARESMB, "sharesmb", "off",
592 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
593 "on | off | SMB share options", "SHARESMB", sfeatures);
594 zprop_register_string(ZFS_PROP_MLSLABEL, "mlslabel",
595 ZFS_MLSLABEL_DEFAULT, PROP_INHERIT, ZFS_TYPE_DATASET,
596 "<sensitivity label>", "MLSLABEL", sfeatures);
597 zprop_register_string(ZFS_PROP_SELINUX_CONTEXT, "context",
598 "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux context>",
599 "CONTEXT", sfeatures);
600 zprop_register_string(ZFS_PROP_SELINUX_FSCONTEXT, "fscontext",
601 "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux fscontext>",
602 "FSCONTEXT", sfeatures);
603 zprop_register_string(ZFS_PROP_SELINUX_DEFCONTEXT, "defcontext",
604 "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux defcontext>",
605 "DEFCONTEXT", sfeatures);
606 zprop_register_string(ZFS_PROP_SELINUX_ROOTCONTEXT, "rootcontext",
607 "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux rootcontext>",
608 "ROOTCONTEXT", sfeatures);
609 zprop_register_string(ZFS_PROP_RECEIVE_RESUME_TOKEN,
610 "receive_resume_token",
611 NULL, PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
612 "<string token>", "RESUMETOK", sfeatures);
613 zprop_register_string(ZFS_PROP_ENCRYPTION_ROOT, "encryptionroot", NULL,
614 PROP_READONLY, ZFS_TYPE_DATASET, "<filesystem | volume>",
615 "ENCROOT", sfeatures);
616 zprop_register_string(ZFS_PROP_KEYLOCATION, "keylocation",
617 "none", PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
618 "prompt | <file URI> | <https URL> | <http URL>", "KEYLOCATION",
619 sfeatures);
620 zprop_register_string(ZFS_PROP_REDACT_SNAPS,
621 "redact_snaps", NULL, PROP_READONLY,
622 ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "<snapshot>[,...]",
623 "RSNAPS", sfeatures);
624
625 /* readonly number properties */
626 zprop_register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY,
627 ZFS_TYPE_DATASET, "<size>", "USED", B_FALSE, sfeatures);
628 zprop_register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY,
629 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL",
630 B_FALSE, sfeatures);
631 zprop_register_number(ZFS_PROP_REFERENCED, "referenced", 0,
632 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "<size>",
633 "REFER", B_FALSE, sfeatures);
634 zprop_register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0,
635 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK,
636 "<1.00x or higher if compressed>", "RATIO", B_FALSE, sfeatures);
637 zprop_register_number(ZFS_PROP_REFRATIO, "refcompressratio", 0,
638 PROP_READONLY, ZFS_TYPE_DATASET,
639 "<1.00x or higher if compressed>", "REFRATIO", B_FALSE, sfeatures);
640 zprop_register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize",
641 ZVOL_DEFAULT_BLOCKSIZE, PROP_ONETIME,
642 ZFS_TYPE_VOLUME, "512 to 16M, power of 2", "VOLBLOCK", B_FALSE,
643 sfeatures);
644 zprop_register_index(ZFS_PROP_VOLTHREADING, "volthreading",
645 1, PROP_DEFAULT, ZFS_TYPE_VOLUME, "on | off",
646 "VOLTHREAD", boolean_table, sfeatures);
647 zprop_register_number(ZFS_PROP_USEDSNAP, "usedbysnapshots", 0,
648 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
649 "USEDSNAP", B_FALSE, sfeatures);
650 zprop_register_number(ZFS_PROP_USEDDS, "usedbydataset", 0,
651 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
652 "USEDDS", B_FALSE, sfeatures);
653 zprop_register_number(ZFS_PROP_USEDCHILD, "usedbychildren", 0,
654 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
655 "USEDCHILD", B_FALSE, sfeatures);
656 zprop_register_number(ZFS_PROP_USEDREFRESERV, "usedbyrefreservation", 0,
657 PROP_READONLY,
658 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDREFRESERV",
659 B_FALSE, sfeatures);
660 zprop_register_number(ZFS_PROP_USERREFS, "userrefs", 0, PROP_READONLY,
661 ZFS_TYPE_SNAPSHOT, "<count>", "USERREFS", B_FALSE, sfeatures);
662 zprop_register_number(ZFS_PROP_WRITTEN, "written", 0, PROP_READONLY,
663 ZFS_TYPE_DATASET, "<size>", "WRITTEN", B_FALSE, sfeatures);
664 zprop_register_number(ZFS_PROP_LOGICALUSED, "logicalused", 0,
665 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
666 "LUSED", B_FALSE, sfeatures);
667 zprop_register_number(ZFS_PROP_LOGICALREFERENCED, "logicalreferenced",
668 0, PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "<size>",
669 "LREFER", B_FALSE, sfeatures);
670 zprop_register_number(ZFS_PROP_FILESYSTEM_COUNT, "filesystem_count",
671 UINT64_MAX, PROP_READONLY, ZFS_TYPE_FILESYSTEM,
672 "<count>", "FSCOUNT", B_FALSE, sfeatures);
673 zprop_register_number(ZFS_PROP_SNAPSHOT_COUNT, "snapshot_count",
674 UINT64_MAX, PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
675 "<count>", "SSCOUNT", B_FALSE, sfeatures);
676 zprop_register_number(ZFS_PROP_GUID, "guid", 0, PROP_READONLY,
677 ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "<uint64>", "GUID",
678 B_TRUE, sfeatures);
679 zprop_register_number(ZFS_PROP_CREATETXG, "createtxg", 0, PROP_READONLY,
680 ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "<uint64>", "CREATETXG",
681 B_TRUE, sfeatures);
682 zprop_register_number(ZFS_PROP_PBKDF2_ITERS, "pbkdf2iters",
683 0, PROP_ONETIME_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
684 "<iters>", "PBKDF2ITERS", B_TRUE, sfeatures);
685 zprop_register_number(ZFS_PROP_OBJSETID, "objsetid", 0,
686 PROP_READONLY, ZFS_TYPE_DATASET, "<uint64>", "OBJSETID", B_TRUE,
687 sfeatures);
688
689 /* default number properties */
690 zprop_register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT,
691 ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA", B_FALSE, sfeatures);
692 zprop_register_number(ZFS_PROP_RESERVATION, "reservation", 0,
693 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
694 "<size> | none", "RESERV", B_FALSE, sfeatures);
695 zprop_register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT,
696 ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, "<size>", "VOLSIZE",
697 B_FALSE, sfeatures);
698 zprop_register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT,
699 ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA", B_FALSE,
700 sfeatures);
701 zprop_register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0,
702 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
703 "<size> | none", "REFRESERV", B_FALSE, sfeatures);
704 zprop_register_number(ZFS_PROP_FILESYSTEM_LIMIT, "filesystem_limit",
705 UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM,
706 "<count> | none", "FSLIMIT", B_FALSE, sfeatures);
707 zprop_register_number(ZFS_PROP_SNAPSHOT_LIMIT, "snapshot_limit",
708 UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
709 "<count> | none", "SSLIMIT", B_FALSE, sfeatures);
710 zprop_register_number(ZFS_PROP_DEFAULTUSERQUOTA, "defaultuserquota", 0,
711 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
712 "<size> | none", "DEFAULTUSERQUOTA", B_FALSE, sfeatures);
713 zprop_register_number(ZFS_PROP_DEFAULTGROUPQUOTA, "defaultgroupquota",
714 0, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
715 "<size> | none", "DEFAULTGROUPQUOTA", B_FALSE, sfeatures);
716 zprop_register_number(ZFS_PROP_DEFAULTPROJECTQUOTA,
717 "defaultprojectquota", 0, PROP_DEFAULT,
718 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "<size> | none",
719 "DEFAULTPROJECTQUOTA", B_FALSE, sfeatures);
720 zprop_register_number(ZFS_PROP_DEFAULTUSEROBJQUOTA,
721 "defaultuserobjquota", 0, PROP_DEFAULT,
722 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "<size> | none",
723 "DEFAULTUSEROBJQUOTA", B_FALSE, sfeatures);
724 zprop_register_number(ZFS_PROP_DEFAULTGROUPOBJQUOTA,
725 "defaultgroupobjquota", 0, PROP_DEFAULT,
726 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "<size> | none",
727 "DEFAULTGROUPOBJQUOTA", B_FALSE, sfeatures);
728 zprop_register_number(ZFS_PROP_DEFAULTPROJECTOBJQUOTA,
729 "defaultprojectobjquota", 0, PROP_DEFAULT,
730 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "<size> | none",
731 "DEFAULTPROJECTOBJQUOTA", B_FALSE, sfeatures);
732
733 /* inherit number properties */
734 zprop_register_number(ZFS_PROP_RECORDSIZE, "recordsize",
735 SPA_OLD_MAXBLOCKSIZE, PROP_INHERIT,
736 ZFS_TYPE_FILESYSTEM, "512 to 16M, power of 2",
737 "RECSIZE", B_FALSE, sfeatures);
738 zprop_register_number(ZFS_PROP_SPECIAL_SMALL_BLOCKS,
739 "special_small_blocks", 0, PROP_INHERIT,
740 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "0 to 16M",
741 "SPECIAL_SMALL_BLOCKS", B_FALSE, sfeatures);
742
743 /* hidden properties */
744 zprop_register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER,
745 PROP_READONLY, ZFS_TYPE_SNAPSHOT, "NUMCLONES", B_FALSE, sfeatures);
746 zprop_register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING,
747 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "NAME",
748 B_TRUE, sfeatures);
749 zprop_register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions",
750 PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS",
751 B_TRUE, sfeatures);
752 zprop_register_hidden(ZFS_PROP_STMF_SHAREINFO, "stmf_sbd_lu",
753 PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME,
754 "STMF_SBD_LU", B_TRUE, sfeatures);
755 zprop_register_hidden(ZFS_PROP_USERACCOUNTING, "useraccounting",
756 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET,
757 "USERACCOUNTING", B_FALSE, sfeatures);
758 zprop_register_hidden(ZFS_PROP_UNIQUE, "unique", PROP_TYPE_NUMBER,
759 PROP_READONLY, ZFS_TYPE_DATASET, "UNIQUE", B_FALSE, sfeatures);
760 zprop_register_hidden(ZFS_PROP_INCONSISTENT, "inconsistent",
761 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, "INCONSISTENT",
762 B_FALSE, sfeatures);
763 zprop_register_hidden(ZFS_PROP_IVSET_GUID, "ivsetguid",
764 PROP_TYPE_NUMBER, PROP_READONLY,
765 ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "IVSETGUID", B_TRUE,
766 sfeatures);
767 zprop_register_hidden(ZFS_PROP_PREV_SNAP, "prevsnap", PROP_TYPE_STRING,
768 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "PREVSNAP",
769 B_TRUE, sfeatures);
770 zprop_register_hidden(ZFS_PROP_PBKDF2_SALT, "pbkdf2salt",
771 PROP_TYPE_NUMBER, PROP_ONETIME_DEFAULT,
772 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "PBKDF2SALT", B_FALSE,
773 sfeatures);
774 zprop_register_hidden(ZFS_PROP_KEY_GUID, "keyguid", PROP_TYPE_NUMBER,
775 PROP_READONLY, ZFS_TYPE_DATASET, "KEYGUID", B_TRUE, sfeatures);
776 zprop_register_hidden(ZFS_PROP_REDACTED, "redacted", PROP_TYPE_NUMBER,
777 PROP_READONLY, ZFS_TYPE_DATASET, "REDACTED", B_FALSE, sfeatures);
778
779 /*
780 * Properties that are obsolete and not used. These are retained so
781 * that we don't have to change the values of the zfs_prop_t enum, or
782 * have NULL pointers in the zfs_prop_table[].
783 */
784 zprop_register_hidden(ZFS_PROP_REMAPTXG, "remaptxg", PROP_TYPE_NUMBER,
785 PROP_READONLY, ZFS_TYPE_DATASET, "REMAPTXG", B_FALSE, sfeatures);
786
787 /* oddball properties */
788 /* 'creation' is a number but displayed as human-readable => flex */
789 zprop_register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0,
790 NULL, PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK,
791 "<date>", "CREATION", B_FALSE, B_TRUE, B_TRUE, NULL, sfeatures);
792
793 zprop_register_impl(ZFS_PROP_SNAPSHOTS_CHANGED, "snapshots_changed",
794 PROP_TYPE_NUMBER, 0, NULL, PROP_READONLY, ZFS_TYPE_FILESYSTEM |
795 ZFS_TYPE_VOLUME, "<date>", "SNAPSHOTS_CHANGED", B_FALSE, B_TRUE,
796 B_TRUE, NULL, sfeatures);
797
798 zprop_register_impl(ZFS_PROP_SNAPSHOTS_CHANGED_NSECS,
799 "snapshots_changed_nsecs", PROP_TYPE_NUMBER, 0, NULL,
800 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<nsec>",
801 "SNAPSHOTS_CHANGED_NSECS", B_FALSE, B_TRUE, B_TRUE, NULL,
802 sfeatures);
803
804 zprop_register_index(ZFS_PROP_LONGNAME, "longname", 0, PROP_INHERIT,
805 ZFS_TYPE_FILESYSTEM, "on | off", "LONGNAME", boolean_table,
806 sfeatures);
807
808 zfs_mod_list_supported_free(sfeatures);
809 }
810
811 boolean_t
zfs_prop_delegatable(zfs_prop_t prop)812 zfs_prop_delegatable(zfs_prop_t prop)
813 {
814 ASSERT3S(prop, >=, 0);
815 ASSERT3S(prop, <, ZFS_NUM_PROPS);
816 zprop_desc_t *pd = &zfs_prop_table[prop];
817
818 /* The mlslabel property is never delegatable. */
819 if (prop == ZFS_PROP_MLSLABEL)
820 return (B_FALSE);
821
822 return (pd->pd_attr != PROP_READONLY);
823 }
824
825 /*
826 * Given a zfs dataset property name, returns the corresponding property ID.
827 */
828 zfs_prop_t
zfs_name_to_prop(const char * propname)829 zfs_name_to_prop(const char *propname)
830 {
831 return (zprop_name_to_prop(propname, ZFS_TYPE_DATASET));
832 }
833
834 /*
835 * Returns true if this is a valid user-defined property (one with a ':').
836 */
837 boolean_t
zfs_prop_user(const char * name)838 zfs_prop_user(const char *name)
839 {
840 int i, len;
841 char c;
842 boolean_t foundsep = B_FALSE;
843
844 len = strlen(name);
845 for (i = 0; i < len; i++) {
846 c = name[i];
847 if (!zprop_valid_char(c))
848 return (B_FALSE);
849 if (c == ':')
850 foundsep = B_TRUE;
851 }
852
853 if (!foundsep)
854 return (B_FALSE);
855
856 return (B_TRUE);
857 }
858
859 /*
860 * Returns true if this is a valid userspace-type property (one with a '@').
861 * Note that after the @, any character is valid (eg, another @, for SID
862 * user@domain).
863 */
864 boolean_t
zfs_prop_userquota(const char * name)865 zfs_prop_userquota(const char *name)
866 {
867 zfs_userquota_prop_t prop;
868
869 for (prop = 0; prop < ZFS_NUM_USERQUOTA_PROPS; prop++) {
870 if (strncmp(name, zfs_userquota_prop_prefixes[prop],
871 strlen(zfs_userquota_prop_prefixes[prop])) == 0) {
872 return (B_TRUE);
873 }
874 }
875
876 return (B_FALSE);
877 }
878
879 /*
880 * Returns true if this is a valid written@ property.
881 * Note that after the @, any character is valid (eg, another @, for
882 * written@pool/fs@origin).
883 */
884 boolean_t
zfs_prop_written(const char * name)885 zfs_prop_written(const char *name)
886 {
887 static const char *prop_prefix = "written@";
888 static const char *book_prefix = "written#";
889 return (strncmp(name, prop_prefix, strlen(prop_prefix)) == 0 ||
890 strncmp(name, book_prefix, strlen(book_prefix)) == 0);
891 }
892
893 /*
894 * Tables of index types, plus functions to convert between the user view
895 * (strings) and internal representation (uint64_t).
896 */
897 int
zfs_prop_string_to_index(zfs_prop_t prop,const char * string,uint64_t * index)898 zfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index)
899 {
900 return (zprop_string_to_index(prop, string, index, ZFS_TYPE_DATASET));
901 }
902
903 int
zfs_prop_index_to_string(zfs_prop_t prop,uint64_t index,const char ** string)904 zfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string)
905 {
906 return (zprop_index_to_string(prop, index, string, ZFS_TYPE_DATASET));
907 }
908
909 uint64_t
zfs_prop_random_value(zfs_prop_t prop,uint64_t seed)910 zfs_prop_random_value(zfs_prop_t prop, uint64_t seed)
911 {
912 return (zprop_random_value(prop, seed, ZFS_TYPE_DATASET));
913 }
914
915 /*
916 * Returns TRUE if the property applies to any of the given dataset types.
917 */
918 boolean_t
zfs_prop_valid_for_type(int prop,zfs_type_t types,boolean_t headcheck)919 zfs_prop_valid_for_type(int prop, zfs_type_t types, boolean_t headcheck)
920 {
921 return (zprop_valid_for_type(prop, types, headcheck));
922 }
923
924 zprop_type_t
zfs_prop_get_type(zfs_prop_t prop)925 zfs_prop_get_type(zfs_prop_t prop)
926 {
927 ASSERT3S(prop, >=, 0);
928 ASSERT3S(prop, <, ZFS_NUM_PROPS);
929 return (zfs_prop_table[prop].pd_proptype);
930 }
931
932 /*
933 * Returns TRUE if the property is readonly.
934 */
935 boolean_t
zfs_prop_readonly(zfs_prop_t prop)936 zfs_prop_readonly(zfs_prop_t prop)
937 {
938 ASSERT3S(prop, >=, 0);
939 ASSERT3S(prop, <, ZFS_NUM_PROPS);
940 return (zfs_prop_table[prop].pd_attr == PROP_READONLY ||
941 zfs_prop_table[prop].pd_attr == PROP_ONETIME ||
942 zfs_prop_table[prop].pd_attr == PROP_ONETIME_DEFAULT);
943 }
944
945 /*
946 * Returns TRUE if the property is visible (not hidden).
947 */
948 boolean_t
zfs_prop_visible(zfs_prop_t prop)949 zfs_prop_visible(zfs_prop_t prop)
950 {
951 ASSERT3S(prop, >=, 0);
952 ASSERT3S(prop, <, ZFS_NUM_PROPS);
953 return (zfs_prop_table[prop].pd_visible &&
954 zfs_prop_table[prop].pd_zfs_mod_supported);
955 }
956
957 /*
958 * Returns TRUE if the property is only allowed to be set once.
959 */
960 boolean_t
zfs_prop_setonce(zfs_prop_t prop)961 zfs_prop_setonce(zfs_prop_t prop)
962 {
963 ASSERT3S(prop, >=, 0);
964 ASSERT3S(prop, <, ZFS_NUM_PROPS);
965 return (zfs_prop_table[prop].pd_attr == PROP_ONETIME ||
966 zfs_prop_table[prop].pd_attr == PROP_ONETIME_DEFAULT);
967 }
968
969 const char *
zfs_prop_default_string(zfs_prop_t prop)970 zfs_prop_default_string(zfs_prop_t prop)
971 {
972 ASSERT3S(prop, >=, 0);
973 ASSERT3S(prop, <, ZFS_NUM_PROPS);
974 return (zfs_prop_table[prop].pd_strdefault);
975 }
976
977 uint64_t
zfs_prop_default_numeric(zfs_prop_t prop)978 zfs_prop_default_numeric(zfs_prop_t prop)
979 {
980 ASSERT3S(prop, >=, 0);
981 ASSERT3S(prop, <, ZFS_NUM_PROPS);
982 return (zfs_prop_table[prop].pd_numdefault);
983 }
984
985 /*
986 * Given a dataset property ID, returns the corresponding name.
987 * Assuming the zfs dataset property ID is valid.
988 */
989 const char *
zfs_prop_to_name(zfs_prop_t prop)990 zfs_prop_to_name(zfs_prop_t prop)
991 {
992 ASSERT3S(prop, >=, 0);
993 ASSERT3S(prop, <, ZFS_NUM_PROPS);
994 return (zfs_prop_table[prop].pd_name);
995 }
996
997 /*
998 * Returns TRUE if the property is inheritable.
999 */
1000 boolean_t
zfs_prop_inheritable(zfs_prop_t prop)1001 zfs_prop_inheritable(zfs_prop_t prop)
1002 {
1003 ASSERT3S(prop, >=, 0);
1004 ASSERT3S(prop, <, ZFS_NUM_PROPS);
1005 return (zfs_prop_table[prop].pd_attr == PROP_INHERIT ||
1006 zfs_prop_table[prop].pd_attr == PROP_ONETIME);
1007 }
1008
1009 /*
1010 * Returns TRUE if property is one of the encryption properties that requires
1011 * a loaded encryption key to modify.
1012 */
1013 boolean_t
zfs_prop_encryption_key_param(zfs_prop_t prop)1014 zfs_prop_encryption_key_param(zfs_prop_t prop)
1015 {
1016 /*
1017 * keylocation does not count as an encryption property. It can be
1018 * changed at will without needing the master keys.
1019 */
1020 return (prop == ZFS_PROP_PBKDF2_SALT || prop == ZFS_PROP_PBKDF2_ITERS ||
1021 prop == ZFS_PROP_KEYFORMAT);
1022 }
1023
1024 /*
1025 * Helper function used by both kernelspace and userspace to check the
1026 * keylocation property. If encrypted is set, the keylocation must be valid
1027 * for an encrypted dataset.
1028 */
1029 boolean_t
zfs_prop_valid_keylocation(const char * str,boolean_t encrypted)1030 zfs_prop_valid_keylocation(const char *str, boolean_t encrypted)
1031 {
1032 if (strcmp("none", str) == 0)
1033 return (!encrypted);
1034 else if (strcmp("prompt", str) == 0)
1035 return (B_TRUE);
1036 else if (strlen(str) > 8 && strncmp("file:///", str, 8) == 0)
1037 return (B_TRUE);
1038 else if (strlen(str) > 8 && strncmp("https://", str, 8) == 0)
1039 return (B_TRUE);
1040 else if (strlen(str) > 7 && strncmp("http://", str, 7) == 0)
1041 return (B_TRUE);
1042
1043 return (B_FALSE);
1044 }
1045
1046
1047 #ifndef _KERNEL
1048 #include <libzfs.h>
1049
1050 /*
1051 * Returns a string describing the set of acceptable values for the given
1052 * zfs property, or NULL if it cannot be set.
1053 */
1054 const char *
zfs_prop_values(zfs_prop_t prop)1055 zfs_prop_values(zfs_prop_t prop)
1056 {
1057 ASSERT3S(prop, >=, 0);
1058 ASSERT3S(prop, <, ZFS_NUM_PROPS);
1059 return (zfs_prop_table[prop].pd_values);
1060 }
1061
1062 /*
1063 * Returns TRUE if this property is a string type. Note that index types
1064 * (compression, checksum) are treated as strings in userland, even though they
1065 * are stored numerically on disk.
1066 */
1067 int
zfs_prop_is_string(zfs_prop_t prop)1068 zfs_prop_is_string(zfs_prop_t prop)
1069 {
1070 ASSERT3S(prop, >=, 0);
1071 ASSERT3S(prop, <, ZFS_NUM_PROPS);
1072 return (zfs_prop_table[prop].pd_proptype == PROP_TYPE_STRING ||
1073 zfs_prop_table[prop].pd_proptype == PROP_TYPE_INDEX);
1074 }
1075
1076 /*
1077 * Returns the column header for the given property. Used only in
1078 * 'zfs list -o', but centralized here with the other property information.
1079 */
1080 const char *
zfs_prop_column_name(zfs_prop_t prop)1081 zfs_prop_column_name(zfs_prop_t prop)
1082 {
1083 ASSERT3S(prop, >=, 0);
1084 ASSERT3S(prop, <, ZFS_NUM_PROPS);
1085 return (zfs_prop_table[prop].pd_colname);
1086 }
1087
1088 /*
1089 * Returns whether the given property should be displayed right-justified for
1090 * 'zfs list'.
1091 */
1092 boolean_t
zfs_prop_align_right(zfs_prop_t prop)1093 zfs_prop_align_right(zfs_prop_t prop)
1094 {
1095 ASSERT3S(prop, >=, 0);
1096 ASSERT3S(prop, <, ZFS_NUM_PROPS);
1097 return (zfs_prop_table[prop].pd_rightalign);
1098 }
1099
1100 #endif
1101
1102 #if defined(_KERNEL)
1103
1104 #if defined(HAVE_KERNEL_FPU_INTERNAL)
1105 uint8_t **zfs_kfpu_fpregs;
1106 EXPORT_SYMBOL(zfs_kfpu_fpregs);
1107 #endif /* defined(HAVE_KERNEL_FPU_INTERNAL) */
1108
1109 extern int __init zcommon_init(void);
1110 extern void zcommon_fini(void);
1111
1112 int __init
zcommon_init(void)1113 zcommon_init(void)
1114 {
1115 int error = kfpu_init();
1116 if (error)
1117 return (error);
1118
1119 fletcher_4_init();
1120 simd_stat_init();
1121
1122 return (0);
1123 }
1124
1125 void
zcommon_fini(void)1126 zcommon_fini(void)
1127 {
1128 simd_stat_fini();
1129 fletcher_4_fini();
1130 kfpu_fini();
1131 }
1132
1133 #ifdef __FreeBSD__
1134 module_init_early(zcommon_init);
1135 module_exit(zcommon_fini);
1136 #endif
1137
1138 #endif
1139
1140 /* zfs dataset property functions */
1141 EXPORT_SYMBOL(zfs_userquota_prop_prefixes);
1142 EXPORT_SYMBOL(zfs_prop_init);
1143 EXPORT_SYMBOL(zfs_prop_get_type);
1144 EXPORT_SYMBOL(zfs_prop_get_table);
1145 EXPORT_SYMBOL(zfs_prop_delegatable);
1146 EXPORT_SYMBOL(zfs_prop_visible);
1147
1148 /* Dataset property functions shared between libzfs and kernel. */
1149 EXPORT_SYMBOL(zfs_prop_default_string);
1150 EXPORT_SYMBOL(zfs_prop_default_numeric);
1151 EXPORT_SYMBOL(zfs_prop_readonly);
1152 EXPORT_SYMBOL(zfs_prop_inheritable);
1153 EXPORT_SYMBOL(zfs_prop_encryption_key_param);
1154 EXPORT_SYMBOL(zfs_prop_valid_keylocation);
1155 EXPORT_SYMBOL(zfs_prop_setonce);
1156 EXPORT_SYMBOL(zfs_prop_to_name);
1157 EXPORT_SYMBOL(zfs_name_to_prop);
1158 EXPORT_SYMBOL(zfs_prop_user);
1159 EXPORT_SYMBOL(zfs_prop_userquota);
1160 EXPORT_SYMBOL(zfs_prop_index_to_string);
1161 EXPORT_SYMBOL(zfs_prop_string_to_index);
1162 EXPORT_SYMBOL(zfs_prop_valid_for_type);
1163 EXPORT_SYMBOL(zfs_prop_written);
1164