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