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