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