?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Add SIMD metadata in /proc on Linux follow up
[zfs.git] / module / zcommon / zfs_prop.c
blob618e863c59a8606b8039574eae40a8e030e7928e
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 *
75 zfs_prop_get_table(void)
76 {
77 return (zfs_prop_table);
78 }
79
80 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 static const zprop_index_t direct_table[] = {
400 { "disabled", ZFS_DIRECT_DISABLED },
401 { "standard", ZFS_DIRECT_STANDARD },
402 { "always", ZFS_DIRECT_ALWAYS },
403 { NULL }
404 };
405
406 struct zfs_mod_supported_features *sfeatures =
407 zfs_mod_list_supported(ZFS_SYSFS_DATASET_PROPERTIES);
408
409 /* inherit index properties */
410 zprop_register_index(ZFS_PROP_REDUNDANT_METADATA, "redundant_metadata",
411 ZFS_REDUNDANT_METADATA_ALL,
412 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
413 "all | most | some | none", "REDUND_MD",
414 redundant_metadata_table, sfeatures);
415 zprop_register_index(ZFS_PROP_SYNC, "sync", ZFS_SYNC_STANDARD,
416 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
417 "standard | always | disabled", "SYNC",
418 sync_table, sfeatures);
419 zprop_register_index(ZFS_PROP_CHECKSUM, "checksum",
420 ZIO_CHECKSUM_DEFAULT, PROP_INHERIT, ZFS_TYPE_FILESYSTEM |
421 ZFS_TYPE_VOLUME,
422 "on | off | fletcher2 | fletcher4 | sha256 | sha512 | skein"
423 " | edonr | blake3",
424 "CHECKSUM", checksum_table, sfeatures);
425 zprop_register_index(ZFS_PROP_DEDUP, "dedup", ZIO_CHECKSUM_OFF,
426 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
427 "on | off | verify | sha256[,verify] | sha512[,verify] | "
428 "skein[,verify] | edonr,verify | blake3[,verify]",
429 "DEDUP", dedup_table, sfeatures);
430 zprop_register_index(ZFS_PROP_COMPRESSION, "compression",
431 ZIO_COMPRESS_DEFAULT, PROP_INHERIT,
432 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
433 "on | off | lzjb | gzip | gzip-[1-9] | zle | lz4 | "
434 "zstd | zstd-[1-19] | "
435 "zstd-fast | zstd-fast-[1-10,20,30,40,50,60,70,80,90,100,500,1000]",
436 "COMPRESS", compress_table, sfeatures);
437 zprop_register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN,
438 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
439 "hidden | visible", "SNAPDIR", snapdir_table, sfeatures);
440 zprop_register_index(ZFS_PROP_SNAPDEV, "snapdev", ZFS_SNAPDEV_HIDDEN,
441 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
442 "hidden | visible", "SNAPDEV", snapdev_table, sfeatures);
443 zprop_register_index(ZFS_PROP_ACLMODE, "aclmode", ZFS_ACL_DISCARD,
444 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
445 "discard | groupmask | passthrough | restricted", "ACLMODE",
446 acl_mode_table, sfeatures);
447 zprop_register_index(ZFS_PROP_ACLTYPE, "acltype",
448 #ifdef __linux__
449 /* Linux doesn't natively support ZFS's NFSv4-style ACLs. */
450 ZFS_ACLTYPE_OFF,
451 #else
452 ZFS_ACLTYPE_NFSV4,
453 #endif
454 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
455 "off | nfsv4 | posix", "ACLTYPE", acltype_table, sfeatures);
456 zprop_register_index(ZFS_PROP_ACLINHERIT, "aclinherit",
457 ZFS_ACL_RESTRICTED, PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
458 "discard | noallow | restricted | passthrough | passthrough-x",
459 "ACLINHERIT", acl_inherit_table, sfeatures);
460 zprop_register_index(ZFS_PROP_COPIES, "copies", 1, PROP_INHERIT,
461 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
462 "1 | 2 | 3", "COPIES", copies_table, sfeatures);
463 zprop_register_index(ZFS_PROP_PRIMARYCACHE, "primarycache",
464 ZFS_CACHE_ALL, PROP_INHERIT,
465 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
466 "all | none | metadata", "PRIMARYCACHE", cache_table, sfeatures);
467 zprop_register_index(ZFS_PROP_SECONDARYCACHE, "secondarycache",
468 ZFS_CACHE_ALL, PROP_INHERIT,
469 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
470 "all | none | metadata", "SECONDARYCACHE", cache_table, sfeatures);
471 zprop_register_index(ZFS_PROP_PREFETCH, "prefetch",
472 ZFS_PREFETCH_ALL, PROP_INHERIT,
473 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
474 "none | metadata | all", "PREFETCH", prefetch_table, sfeatures);
475 zprop_register_index(ZFS_PROP_LOGBIAS, "logbias", ZFS_LOGBIAS_LATENCY,
476 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
477 "latency | throughput", "LOGBIAS", logbias_table, sfeatures);
478 zprop_register_index(ZFS_PROP_XATTR, "xattr", ZFS_XATTR_DIR,
479 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
480 "on | off | dir | sa", "XATTR", xattr_table, sfeatures);
481 zprop_register_index(ZFS_PROP_DNODESIZE, "dnodesize",
482 ZFS_DNSIZE_LEGACY, PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
483 "legacy | auto | 1k | 2k | 4k | 8k | 16k", "DNSIZE", dnsize_table,
484 sfeatures);
485 zprop_register_index(ZFS_PROP_VOLMODE, "volmode",
486 ZFS_VOLMODE_DEFAULT, PROP_INHERIT,
487 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
488 "default | full | geom | dev | none", "VOLMODE", volmode_table,
489 sfeatures);
490 zprop_register_index(ZFS_PROP_DIRECT, "direct",
491 ZFS_DIRECT_STANDARD, PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
492 "disabled | standard | always", "DIRECT", direct_table,
493 sfeatures);
494
495 /* inherit index (boolean) properties */
496 zprop_register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT,
497 ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table, sfeatures);
498 zprop_register_index(ZFS_PROP_RELATIME, "relatime", 1, PROP_INHERIT,
499 ZFS_TYPE_FILESYSTEM, "on | off", "RELATIME", boolean_table,
500 sfeatures);
501 zprop_register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT,
502 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES",
503 boolean_table, sfeatures);
504 zprop_register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT,
505 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC",
506 boolean_table, sfeatures);
507 zprop_register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT,
508 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID",
509 boolean_table, sfeatures);
510 zprop_register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT,
511 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY",
512 boolean_table, sfeatures);
513 #ifdef __FreeBSD__
514 zprop_register_index(ZFS_PROP_ZONED, "jailed", 0, PROP_INHERIT,
515 ZFS_TYPE_FILESYSTEM, "on | off", "JAILED", boolean_table,
516 sfeatures);
517 #else
518 zprop_register_index(ZFS_PROP_ZONED, "zoned", 0, PROP_INHERIT,
519 ZFS_TYPE_FILESYSTEM, "on | off", "ZONED", boolean_table, sfeatures);
520 #endif
521 zprop_register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT,
522 ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN", boolean_table, sfeatures);
523 zprop_register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT,
524 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND",
525 boolean_table, sfeatures);
526 zprop_register_index(ZFS_PROP_OVERLAY, "overlay", 1, PROP_INHERIT,
527 ZFS_TYPE_FILESYSTEM, "on | off", "OVERLAY", boolean_table,
528 sfeatures);
529
530 /* default index properties */
531 zprop_register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT,
532 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
533 "1 | 2 | 3 | 4 | 5 | current", "VERSION", version_table, sfeatures);
534 zprop_register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON,
535 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto",
536 "CANMOUNT", canmount_table, sfeatures);
537
538 /* readonly index properties */
539 zprop_register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY,
540 ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table,
541 sfeatures);
542 zprop_register_index(ZFS_PROP_DEFER_DESTROY, "defer_destroy", 0,
543 PROP_READONLY, ZFS_TYPE_SNAPSHOT, "yes | no", "DEFER_DESTROY",
544 boolean_table, sfeatures);
545 zprop_register_index(ZFS_PROP_KEYSTATUS, "keystatus",
546 ZFS_KEYSTATUS_NONE, PROP_READONLY, ZFS_TYPE_DATASET,
547 "none | unavailable | available",
548 "KEYSTATUS", keystatus_table, sfeatures);
549
550 /* set once index properties */
551 zprop_register_index(ZFS_PROP_NORMALIZE, "normalization", 0,
552 PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
553 "none | formC | formD | formKC | formKD", "NORMALIZATION",
554 normalize_table, sfeatures);
555 zprop_register_index(ZFS_PROP_CASE, "casesensitivity",
556 ZFS_CASE_SENSITIVE, PROP_ONETIME, ZFS_TYPE_FILESYSTEM |
557 ZFS_TYPE_SNAPSHOT,
558 "sensitive | insensitive | mixed", "CASE", case_table, sfeatures);
559 zprop_register_index(ZFS_PROP_KEYFORMAT, "keyformat",
560 ZFS_KEYFORMAT_NONE, PROP_ONETIME_DEFAULT,
561 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
562 "none | raw | hex | passphrase", "KEYFORMAT", keyformat_table,
563 sfeatures);
564 zprop_register_index(ZFS_PROP_ENCRYPTION, "encryption",
565 ZIO_CRYPT_DEFAULT, PROP_ONETIME, ZFS_TYPE_DATASET,
566 "on | off | aes-128-ccm | aes-192-ccm | aes-256-ccm | "
567 "aes-128-gcm | aes-192-gcm | aes-256-gcm", "ENCRYPTION",
568 crypto_table, sfeatures);
569
570 /* set once index (boolean) properties */
571 zprop_register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME,
572 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
573 "on | off", "UTF8ONLY", boolean_table, sfeatures);
574
575 /* string properties */
576 zprop_register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY,
577 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN",
578 sfeatures);
579 zprop_register_string(ZFS_PROP_CLONES, "clones", NULL, PROP_READONLY,
580 ZFS_TYPE_SNAPSHOT, "<dataset>[,...]", "CLONES", sfeatures);
581 zprop_register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/",
582 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "<path> | legacy | none",
583 "MOUNTPOINT", sfeatures);
584 zprop_register_string(ZFS_PROP_SHARENFS, "sharenfs", "off",
585 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "on | off | NFS share options",
586 "SHARENFS", sfeatures);
587 zprop_register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY,
588 ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK,
589 "filesystem | volume | snapshot | bookmark", "TYPE", sfeatures);
590 zprop_register_string(ZFS_PROP_SHARESMB, "sharesmb", "off",
591 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
592 "on | off | SMB share options", "SHARESMB", sfeatures);
593 zprop_register_string(ZFS_PROP_MLSLABEL, "mlslabel",
594 ZFS_MLSLABEL_DEFAULT, PROP_INHERIT, ZFS_TYPE_DATASET,
595 "<sensitivity label>", "MLSLABEL", sfeatures);
596 zprop_register_string(ZFS_PROP_SELINUX_CONTEXT, "context",
597 "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux context>",
598 "CONTEXT", sfeatures);
599 zprop_register_string(ZFS_PROP_SELINUX_FSCONTEXT, "fscontext",
600 "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux fscontext>",
601 "FSCONTEXT", sfeatures);
602 zprop_register_string(ZFS_PROP_SELINUX_DEFCONTEXT, "defcontext",
603 "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux defcontext>",
604 "DEFCONTEXT", sfeatures);
605 zprop_register_string(ZFS_PROP_SELINUX_ROOTCONTEXT, "rootcontext",
606 "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux rootcontext>",
607 "ROOTCONTEXT", sfeatures);
608 zprop_register_string(ZFS_PROP_RECEIVE_RESUME_TOKEN,
609 "receive_resume_token",
610 NULL, PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
611 "<string token>", "RESUMETOK", sfeatures);
612 zprop_register_string(ZFS_PROP_ENCRYPTION_ROOT, "encryptionroot", NULL,
613 PROP_READONLY, ZFS_TYPE_DATASET, "<filesystem | volume>",
614 "ENCROOT", sfeatures);
615 zprop_register_string(ZFS_PROP_KEYLOCATION, "keylocation",
616 "none", PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
617 "prompt | <file URI> | <https URL> | <http URL>", "KEYLOCATION",
618 sfeatures);
619 zprop_register_string(ZFS_PROP_REDACT_SNAPS,
620 "redact_snaps", NULL, PROP_READONLY,
621 ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "<snapshot>[,...]",
622 "RSNAPS", sfeatures);
623
624 /* readonly number properties */
625 zprop_register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY,
626 ZFS_TYPE_DATASET, "<size>", "USED", B_FALSE, sfeatures);
627 zprop_register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY,
628 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL",
629 B_FALSE, sfeatures);
630 zprop_register_number(ZFS_PROP_REFERENCED, "referenced", 0,
631 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "<size>",
632 "REFER", B_FALSE, sfeatures);
633 zprop_register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0,
634 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK,
635 "<1.00x or higher if compressed>", "RATIO", B_FALSE, sfeatures);
636 zprop_register_number(ZFS_PROP_REFRATIO, "refcompressratio", 0,
637 PROP_READONLY, ZFS_TYPE_DATASET,
638 "<1.00x or higher if compressed>", "REFRATIO", B_FALSE, sfeatures);
639 zprop_register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize",
640 ZVOL_DEFAULT_BLOCKSIZE, PROP_ONETIME,
641 ZFS_TYPE_VOLUME, "512 to 128k, power of 2", "VOLBLOCK", B_FALSE,
642 sfeatures);
643 zprop_register_index(ZFS_PROP_VOLTHREADING, "volthreading",
644 1, PROP_DEFAULT, ZFS_TYPE_VOLUME, "on | off", "zvol threading",
645 boolean_table, sfeatures);
646 zprop_register_number(ZFS_PROP_USEDSNAP, "usedbysnapshots", 0,
647 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
648 "USEDSNAP", B_FALSE, sfeatures);
649 zprop_register_number(ZFS_PROP_USEDDS, "usedbydataset", 0,
650 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
651 "USEDDS", B_FALSE, sfeatures);
652 zprop_register_number(ZFS_PROP_USEDCHILD, "usedbychildren", 0,
653 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
654 "USEDCHILD", B_FALSE, sfeatures);
655 zprop_register_number(ZFS_PROP_USEDREFRESERV, "usedbyrefreservation", 0,
656 PROP_READONLY,
657 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDREFRESERV",
658 B_FALSE, sfeatures);
659 zprop_register_number(ZFS_PROP_USERREFS, "userrefs", 0, PROP_READONLY,
660 ZFS_TYPE_SNAPSHOT, "<count>", "USERREFS", B_FALSE, sfeatures);
661 zprop_register_number(ZFS_PROP_WRITTEN, "written", 0, PROP_READONLY,
662 ZFS_TYPE_DATASET, "<size>", "WRITTEN", B_FALSE, sfeatures);
663 zprop_register_number(ZFS_PROP_LOGICALUSED, "logicalused", 0,
664 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
665 "LUSED", B_FALSE, sfeatures);
666 zprop_register_number(ZFS_PROP_LOGICALREFERENCED, "logicalreferenced",
667 0, PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "<size>",
668 "LREFER", B_FALSE, sfeatures);
669 zprop_register_number(ZFS_PROP_FILESYSTEM_COUNT, "filesystem_count",
670 UINT64_MAX, PROP_READONLY, ZFS_TYPE_FILESYSTEM,
671 "<count>", "FSCOUNT", B_FALSE, sfeatures);
672 zprop_register_number(ZFS_PROP_SNAPSHOT_COUNT, "snapshot_count",
673 UINT64_MAX, PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
674 "<count>", "SSCOUNT", B_FALSE, sfeatures);
675 zprop_register_number(ZFS_PROP_GUID, "guid", 0, PROP_READONLY,
676 ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "<uint64>", "GUID",
677 B_TRUE, sfeatures);
678 zprop_register_number(ZFS_PROP_CREATETXG, "createtxg", 0, PROP_READONLY,
679 ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "<uint64>", "CREATETXG",
680 B_TRUE, sfeatures);
681 zprop_register_number(ZFS_PROP_PBKDF2_ITERS, "pbkdf2iters",
682 0, PROP_ONETIME_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
683 "<iters>", "PBKDF2ITERS", B_TRUE, sfeatures);
684 zprop_register_number(ZFS_PROP_OBJSETID, "objsetid", 0,
685 PROP_READONLY, ZFS_TYPE_DATASET, "<uint64>", "OBJSETID", B_TRUE,
686 sfeatures);
687
688 /* default number properties */
689 zprop_register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT,
690 ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA", B_FALSE, sfeatures);
691 zprop_register_number(ZFS_PROP_RESERVATION, "reservation", 0,
692 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
693 "<size> | none", "RESERV", B_FALSE, sfeatures);
694 zprop_register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT,
695 ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, "<size>", "VOLSIZE",
696 B_FALSE, sfeatures);
697 zprop_register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT,
698 ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA", B_FALSE,
699 sfeatures);
700 zprop_register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0,
701 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
702 "<size> | none", "REFRESERV", B_FALSE, sfeatures);
703 zprop_register_number(ZFS_PROP_FILESYSTEM_LIMIT, "filesystem_limit",
704 UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM,
705 "<count> | none", "FSLIMIT", B_FALSE, sfeatures);
706 zprop_register_number(ZFS_PROP_SNAPSHOT_LIMIT, "snapshot_limit",
707 UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
708 "<count> | none", "SSLIMIT", B_FALSE, sfeatures);
709
710 /* inherit number properties */
711 zprop_register_number(ZFS_PROP_RECORDSIZE, "recordsize",
712 SPA_OLD_MAXBLOCKSIZE, PROP_INHERIT,
713 ZFS_TYPE_FILESYSTEM, "512 to 1M, power of 2", "RECSIZE", B_FALSE,
714 sfeatures);
715 zprop_register_number(ZFS_PROP_SPECIAL_SMALL_BLOCKS,
716 "special_small_blocks", 0, PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
717 "zero or 512 to 1M, power of 2", "SPECIAL_SMALL_BLOCKS", B_FALSE,
718 sfeatures);
719
720 /* hidden properties */
721 zprop_register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER,
722 PROP_READONLY, ZFS_TYPE_SNAPSHOT, "NUMCLONES", B_FALSE, sfeatures);
723 zprop_register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING,
724 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "NAME",
725 B_TRUE, sfeatures);
726 zprop_register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions",
727 PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS",
728 B_TRUE, sfeatures);
729 zprop_register_hidden(ZFS_PROP_STMF_SHAREINFO, "stmf_sbd_lu",
730 PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME,
731 "STMF_SBD_LU", B_TRUE, sfeatures);
732 zprop_register_hidden(ZFS_PROP_USERACCOUNTING, "useraccounting",
733 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET,
734 "USERACCOUNTING", B_FALSE, sfeatures);
735 zprop_register_hidden(ZFS_PROP_UNIQUE, "unique", PROP_TYPE_NUMBER,
736 PROP_READONLY, ZFS_TYPE_DATASET, "UNIQUE", B_FALSE, sfeatures);
737 zprop_register_hidden(ZFS_PROP_INCONSISTENT, "inconsistent",
738 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, "INCONSISTENT",
739 B_FALSE, sfeatures);
740 zprop_register_hidden(ZFS_PROP_IVSET_GUID, "ivsetguid",
741 PROP_TYPE_NUMBER, PROP_READONLY,
742 ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "IVSETGUID", B_TRUE,
743 sfeatures);
744 zprop_register_hidden(ZFS_PROP_PREV_SNAP, "prevsnap", PROP_TYPE_STRING,
745 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "PREVSNAP",
746 B_TRUE, sfeatures);
747 zprop_register_hidden(ZFS_PROP_PBKDF2_SALT, "pbkdf2salt",
748 PROP_TYPE_NUMBER, PROP_ONETIME_DEFAULT,
749 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "PBKDF2SALT", B_FALSE,
750 sfeatures);
751 zprop_register_hidden(ZFS_PROP_KEY_GUID, "keyguid", PROP_TYPE_NUMBER,
752 PROP_READONLY, ZFS_TYPE_DATASET, "KEYGUID", B_TRUE, sfeatures);
753 zprop_register_hidden(ZFS_PROP_REDACTED, "redacted", PROP_TYPE_NUMBER,
754 PROP_READONLY, ZFS_TYPE_DATASET, "REDACTED", B_FALSE, sfeatures);
755
756 /*
757 * Properties that are obsolete and not used. These are retained so
758 * that we don't have to change the values of the zfs_prop_t enum, or
759 * have NULL pointers in the zfs_prop_table[].
760 */
761 zprop_register_hidden(ZFS_PROP_REMAPTXG, "remaptxg", PROP_TYPE_NUMBER,
762 PROP_READONLY, ZFS_TYPE_DATASET, "REMAPTXG", B_FALSE, sfeatures);
763
764 /* oddball properties */
765 /* 'creation' is a number but displayed as human-readable => flex */
766 zprop_register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0,
767 NULL, PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK,
768 "<date>", "CREATION", B_FALSE, B_TRUE, B_TRUE, NULL, sfeatures);
769
770 zprop_register_impl(ZFS_PROP_SNAPSHOTS_CHANGED, "snapshots_changed",
771 PROP_TYPE_NUMBER, 0, NULL, PROP_READONLY, ZFS_TYPE_FILESYSTEM |
772 ZFS_TYPE_VOLUME, "<date>", "SNAPSHOTS_CHANGED", B_FALSE, B_TRUE,
773 B_TRUE, NULL, sfeatures);
774
775 zfs_mod_list_supported_free(sfeatures);
776 }
777
778 boolean_t
779 zfs_prop_delegatable(zfs_prop_t prop)
780 {
781 ASSERT3S(prop, >=, 0);
782 ASSERT3S(prop, <, ZFS_NUM_PROPS);
783 zprop_desc_t *pd = &zfs_prop_table[prop];
784
785 /* The mlslabel property is never delegatable. */
786 if (prop == ZFS_PROP_MLSLABEL)
787 return (B_FALSE);
788
789 return (pd->pd_attr != PROP_READONLY);
790 }
791
792 /*
793 * Given a zfs dataset property name, returns the corresponding property ID.
794 */
795 zfs_prop_t
796 zfs_name_to_prop(const char *propname)
797 {
798 return (zprop_name_to_prop(propname, ZFS_TYPE_DATASET));
799 }
800
801 /*
802 * Returns true if this is a valid user-defined property (one with a ':').
803 */
804 boolean_t
805 zfs_prop_user(const char *name)
806 {
807 int i;
808 char c;
809 boolean_t foundsep = B_FALSE;
810
811 for (i = 0; i < strlen(name); i++) {
812 c = name[i];
813 if (!zprop_valid_char(c))
814 return (B_FALSE);
815 if (c == ':')
816 foundsep = B_TRUE;
817 }
818
819 if (!foundsep)
820 return (B_FALSE);
821
822 return (B_TRUE);
823 }
824
825 /*
826 * Returns true if this is a valid userspace-type property (one with a '@').
827 * Note that after the @, any character is valid (eg, another @, for SID
828 * user@domain).
829 */
830 boolean_t
831 zfs_prop_userquota(const char *name)
832 {
833 zfs_userquota_prop_t prop;
834
835 for (prop = 0; prop < ZFS_NUM_USERQUOTA_PROPS; prop++) {
836 if (strncmp(name, zfs_userquota_prop_prefixes[prop],
837 strlen(zfs_userquota_prop_prefixes[prop])) == 0) {
838 return (B_TRUE);
839 }
840 }
841
842 return (B_FALSE);
843 }
844
845 /*
846 * Returns true if this is a valid written@ property.
847 * Note that after the @, any character is valid (eg, another @, for
848 * written@pool/fs@origin).
849 */
850 boolean_t
851 zfs_prop_written(const char *name)
852 {
853 static const char *prop_prefix = "written@";
854 static const char *book_prefix = "written#";
855 return (strncmp(name, prop_prefix, strlen(prop_prefix)) == 0 ||
856 strncmp(name, book_prefix, strlen(book_prefix)) == 0);
857 }
858
859 /*
860 * Tables of index types, plus functions to convert between the user view
861 * (strings) and internal representation (uint64_t).
862 */
863 int
864 zfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index)
865 {
866 return (zprop_string_to_index(prop, string, index, ZFS_TYPE_DATASET));
867 }
868
869 int
870 zfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string)
871 {
872 return (zprop_index_to_string(prop, index, string, ZFS_TYPE_DATASET));
873 }
874
875 uint64_t
876 zfs_prop_random_value(zfs_prop_t prop, uint64_t seed)
877 {
878 return (zprop_random_value(prop, seed, ZFS_TYPE_DATASET));
879 }
880
881 /*
882 * Returns TRUE if the property applies to any of the given dataset types.
883 */
884 boolean_t
885 zfs_prop_valid_for_type(int prop, zfs_type_t types, boolean_t headcheck)
886 {
887 return (zprop_valid_for_type(prop, types, headcheck));
888 }
889
890 zprop_type_t
891 zfs_prop_get_type(zfs_prop_t prop)
892 {
893 ASSERT3S(prop, >=, 0);
894 ASSERT3S(prop, <, ZFS_NUM_PROPS);
895 return (zfs_prop_table[prop].pd_proptype);
896 }
897
898 /*
899 * Returns TRUE if the property is readonly.
900 */
901 boolean_t
902 zfs_prop_readonly(zfs_prop_t prop)
903 {
904 ASSERT3S(prop, >=, 0);
905 ASSERT3S(prop, <, ZFS_NUM_PROPS);
906 return (zfs_prop_table[prop].pd_attr == PROP_READONLY ||
907 zfs_prop_table[prop].pd_attr == PROP_ONETIME ||
908 zfs_prop_table[prop].pd_attr == PROP_ONETIME_DEFAULT);
909 }
910
911 /*
912 * Returns TRUE if the property is visible (not hidden).
913 */
914 boolean_t
915 zfs_prop_visible(zfs_prop_t prop)
916 {
917 ASSERT3S(prop, >=, 0);
918 ASSERT3S(prop, <, ZFS_NUM_PROPS);
919 return (zfs_prop_table[prop].pd_visible &&
920 zfs_prop_table[prop].pd_zfs_mod_supported);
921 }
922
923 /*
924 * Returns TRUE if the property is only allowed to be set once.
925 */
926 boolean_t
927 zfs_prop_setonce(zfs_prop_t prop)
928 {
929 ASSERT3S(prop, >=, 0);
930 ASSERT3S(prop, <, ZFS_NUM_PROPS);
931 return (zfs_prop_table[prop].pd_attr == PROP_ONETIME ||
932 zfs_prop_table[prop].pd_attr == PROP_ONETIME_DEFAULT);
933 }
934
935 const char *
936 zfs_prop_default_string(zfs_prop_t prop)
937 {
938 ASSERT3S(prop, >=, 0);
939 ASSERT3S(prop, <, ZFS_NUM_PROPS);
940 return (zfs_prop_table[prop].pd_strdefault);
941 }
942
943 uint64_t
944 zfs_prop_default_numeric(zfs_prop_t prop)
945 {
946 ASSERT3S(prop, >=, 0);
947 ASSERT3S(prop, <, ZFS_NUM_PROPS);
948 return (zfs_prop_table[prop].pd_numdefault);
949 }
950
951 /*
952 * Given a dataset property ID, returns the corresponding name.
953 * Assuming the zfs dataset property ID is valid.
954 */
955 const char *
956 zfs_prop_to_name(zfs_prop_t prop)
957 {
958 ASSERT3S(prop, >=, 0);
959 ASSERT3S(prop, <, ZFS_NUM_PROPS);
960 return (zfs_prop_table[prop].pd_name);
961 }
962
963 /*
964 * Returns TRUE if the property is inheritable.
965 */
966 boolean_t
967 zfs_prop_inheritable(zfs_prop_t prop)
968 {
969 ASSERT3S(prop, >=, 0);
970 ASSERT3S(prop, <, ZFS_NUM_PROPS);
971 return (zfs_prop_table[prop].pd_attr == PROP_INHERIT ||
972 zfs_prop_table[prop].pd_attr == PROP_ONETIME);
973 }
974
975 /*
976 * Returns TRUE if property is one of the encryption properties that requires
977 * a loaded encryption key to modify.
978 */
979 boolean_t
980 zfs_prop_encryption_key_param(zfs_prop_t prop)
981 {
982 /*
983 * keylocation does not count as an encryption property. It can be
984 * changed at will without needing the master keys.
985 */
986 return (prop == ZFS_PROP_PBKDF2_SALT || prop == ZFS_PROP_PBKDF2_ITERS ||
987 prop == ZFS_PROP_KEYFORMAT);
988 }
989
990 /*
991 * Helper function used by both kernelspace and userspace to check the
992 * keylocation property. If encrypted is set, the keylocation must be valid
993 * for an encrypted dataset.
994 */
995 boolean_t
996 zfs_prop_valid_keylocation(const char *str, boolean_t encrypted)
997 {
998 if (strcmp("none", str) == 0)
999 return (!encrypted);
1000 else if (strcmp("prompt", str) == 0)
1001 return (B_TRUE);
1002 else if (strlen(str) > 8 && strncmp("file:///", str, 8) == 0)
1003 return (B_TRUE);
1004 else if (strlen(str) > 8 && strncmp("https://", str, 8) == 0)
1005 return (B_TRUE);
1006 else if (strlen(str) > 7 && strncmp("http://", str, 7) == 0)
1007 return (B_TRUE);
1008
1009 return (B_FALSE);
1010 }
1011
1012
1013 #ifndef _KERNEL
1014 #include <libzfs.h>
1015
1016 /*
1017 * Returns a string describing the set of acceptable values for the given
1018 * zfs property, or NULL if it cannot be set.
1019 */
1020 const char *
1021 zfs_prop_values(zfs_prop_t prop)
1022 {
1023 ASSERT3S(prop, >=, 0);
1024 ASSERT3S(prop, <, ZFS_NUM_PROPS);
1025 return (zfs_prop_table[prop].pd_values);
1026 }
1027
1028 /*
1029 * Returns TRUE if this property is a string type. Note that index types
1030 * (compression, checksum) are treated as strings in userland, even though they
1031 * are stored numerically on disk.
1032 */
1033 int
1034 zfs_prop_is_string(zfs_prop_t prop)
1035 {
1036 ASSERT3S(prop, >=, 0);
1037 ASSERT3S(prop, <, ZFS_NUM_PROPS);
1038 return (zfs_prop_table[prop].pd_proptype == PROP_TYPE_STRING ||
1039 zfs_prop_table[prop].pd_proptype == PROP_TYPE_INDEX);
1040 }
1041
1042 /*
1043 * Returns the column header for the given property. Used only in
1044 * 'zfs list -o', but centralized here with the other property information.
1045 */
1046 const char *
1047 zfs_prop_column_name(zfs_prop_t prop)
1048 {
1049 ASSERT3S(prop, >=, 0);
1050 ASSERT3S(prop, <, ZFS_NUM_PROPS);
1051 return (zfs_prop_table[prop].pd_colname);
1052 }
1053
1054 /*
1055 * Returns whether the given property should be displayed right-justified for
1056 * 'zfs list'.
1057 */
1058 boolean_t
1059 zfs_prop_align_right(zfs_prop_t prop)
1060 {
1061 ASSERT3S(prop, >=, 0);
1062 ASSERT3S(prop, <, ZFS_NUM_PROPS);
1063 return (zfs_prop_table[prop].pd_rightalign);
1064 }
1065
1066 #endif
1067
1068 #if defined(_KERNEL)
1069
1070 #if defined(HAVE_KERNEL_FPU_INTERNAL)
1071 uint8_t **zfs_kfpu_fpregs;
1072 EXPORT_SYMBOL(zfs_kfpu_fpregs);
1073 #endif /* defined(HAVE_KERNEL_FPU_INTERNAL) */
1074
1075 extern int __init zcommon_init(void);
1076 extern void zcommon_fini(void);
1077
1078 int __init
1079 zcommon_init(void)
1080 {
1081 int error = kfpu_init();
1082 if (error)
1083 return (error);
1084
1085 fletcher_4_init();
1086 simd_stat_init();
1087
1088 return (0);
1089 }
1090
1091 void
1092 zcommon_fini(void)
1093 {
1094 simd_stat_fini();
1095 fletcher_4_fini();
1096 kfpu_fini();
1097 }
1098
1099 #ifdef __FreeBSD__
1100 module_init_early(zcommon_init);
1101 module_exit(zcommon_fini);
1102 #endif
1103
1104 #endif
1105
1106 /* zfs dataset property functions */
1107 EXPORT_SYMBOL(zfs_userquota_prop_prefixes);
1108 EXPORT_SYMBOL(zfs_prop_init);
1109 EXPORT_SYMBOL(zfs_prop_get_type);
1110 EXPORT_SYMBOL(zfs_prop_get_table);
1111 EXPORT_SYMBOL(zfs_prop_delegatable);
1112 EXPORT_SYMBOL(zfs_prop_visible);
1113
1114 /* Dataset property functions shared between libzfs and kernel. */
1115 EXPORT_SYMBOL(zfs_prop_default_string);
1116 EXPORT_SYMBOL(zfs_prop_default_numeric);
1117 EXPORT_SYMBOL(zfs_prop_readonly);
1118 EXPORT_SYMBOL(zfs_prop_inheritable);
1119 EXPORT_SYMBOL(zfs_prop_encryption_key_param);
1120 EXPORT_SYMBOL(zfs_prop_valid_keylocation);
1121 EXPORT_SYMBOL(zfs_prop_setonce);
1122 EXPORT_SYMBOL(zfs_prop_to_name);
1123 EXPORT_SYMBOL(zfs_name_to_prop);
1124 EXPORT_SYMBOL(zfs_prop_user);
1125 EXPORT_SYMBOL(zfs_prop_userquota);
1126 EXPORT_SYMBOL(zfs_prop_index_to_string);
1127 EXPORT_SYMBOL(zfs_prop_string_to_index);
1128 EXPORT_SYMBOL(zfs_prop_valid_for_type);
1129 EXPORT_SYMBOL(zfs_prop_written);
OpenZFS on Linux and FreeBSD