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