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.
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.
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]
22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright (c) 2011, 2015 by Delphix. All rights reserved.
24 * Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
25 * Copyright 2016, Joyent, Inc.
28 /* Portions Copyright 2010 Robert Milkowski */
32 #include <sys/u8_textprep.h>
33 #include <sys/zfs_acl.h>
34 #include <sys/zfs_ioctl.h>
35 #include <sys/zfs_znode.h>
36 #include <sys/dsl_crypt.h>
39 #include "zfs_deleg.h"
40 #include "zfs_fletcher.h"
43 #include <sys/systm.h>
50 static zprop_desc_t zfs_prop_table
[ZFS_NUM_PROPS
];
52 /* Note this is indexed by zfs_userquota_prop_t, keep the order the same */
53 const char *zfs_userquota_prop_prefixes
[] = {
69 zfs_prop_get_table(void)
71 return (zfs_prop_table
);
77 static zprop_index_t checksum_table
[] = {
78 { "on", ZIO_CHECKSUM_ON
},
79 { "off", ZIO_CHECKSUM_OFF
},
80 { "fletcher2", ZIO_CHECKSUM_FLETCHER_2
},
81 { "fletcher4", ZIO_CHECKSUM_FLETCHER_4
},
82 { "sha256", ZIO_CHECKSUM_SHA256
},
83 { "noparity", ZIO_CHECKSUM_NOPARITY
},
84 { "sha512", ZIO_CHECKSUM_SHA512
},
85 { "skein", ZIO_CHECKSUM_SKEIN
},
86 { "edonr", ZIO_CHECKSUM_EDONR
},
90 static zprop_index_t dedup_table
[] = {
91 { "on", ZIO_CHECKSUM_ON
},
92 { "off", ZIO_CHECKSUM_OFF
},
93 { "verify", ZIO_CHECKSUM_ON
| ZIO_CHECKSUM_VERIFY
},
94 { "sha256", ZIO_CHECKSUM_SHA256
},
96 ZIO_CHECKSUM_SHA256
| ZIO_CHECKSUM_VERIFY
},
97 { "sha512", ZIO_CHECKSUM_SHA512
},
99 ZIO_CHECKSUM_SHA512
| ZIO_CHECKSUM_VERIFY
},
100 { "skein", ZIO_CHECKSUM_SKEIN
},
102 ZIO_CHECKSUM_SKEIN
| ZIO_CHECKSUM_VERIFY
},
104 ZIO_CHECKSUM_EDONR
| ZIO_CHECKSUM_VERIFY
},
108 static zprop_index_t compress_table
[] = {
109 { "on", ZIO_COMPRESS_ON
},
110 { "off", ZIO_COMPRESS_OFF
},
111 { "lzjb", ZIO_COMPRESS_LZJB
},
112 { "gzip", ZIO_COMPRESS_GZIP_6
}, /* gzip default */
113 { "gzip-1", ZIO_COMPRESS_GZIP_1
},
114 { "gzip-2", ZIO_COMPRESS_GZIP_2
},
115 { "gzip-3", ZIO_COMPRESS_GZIP_3
},
116 { "gzip-4", ZIO_COMPRESS_GZIP_4
},
117 { "gzip-5", ZIO_COMPRESS_GZIP_5
},
118 { "gzip-6", ZIO_COMPRESS_GZIP_6
},
119 { "gzip-7", ZIO_COMPRESS_GZIP_7
},
120 { "gzip-8", ZIO_COMPRESS_GZIP_8
},
121 { "gzip-9", ZIO_COMPRESS_GZIP_9
},
122 { "zle", ZIO_COMPRESS_ZLE
},
123 { "lz4", ZIO_COMPRESS_LZ4
},
127 static zprop_index_t crypto_table
[] = {
128 { "on", ZIO_CRYPT_ON
},
129 { "off", ZIO_CRYPT_OFF
},
130 { "aes-128-ccm", ZIO_CRYPT_AES_128_CCM
},
131 { "aes-192-ccm", ZIO_CRYPT_AES_192_CCM
},
132 { "aes-256-ccm", ZIO_CRYPT_AES_256_CCM
},
133 { "aes-128-gcm", ZIO_CRYPT_AES_128_GCM
},
134 { "aes-192-gcm", ZIO_CRYPT_AES_192_GCM
},
135 { "aes-256-gcm", ZIO_CRYPT_AES_256_GCM
},
139 static zprop_index_t keyformat_table
[] = {
140 { "none", ZFS_KEYFORMAT_NONE
},
141 { "raw", ZFS_KEYFORMAT_RAW
},
142 { "hex", ZFS_KEYFORMAT_HEX
},
143 { "passphrase", ZFS_KEYFORMAT_PASSPHRASE
},
147 static zprop_index_t snapdir_table
[] = {
148 { "hidden", ZFS_SNAPDIR_HIDDEN
},
149 { "visible", ZFS_SNAPDIR_VISIBLE
},
153 static zprop_index_t snapdev_table
[] = {
154 { "hidden", ZFS_SNAPDEV_HIDDEN
},
155 { "visible", ZFS_SNAPDEV_VISIBLE
},
159 static zprop_index_t acltype_table
[] = {
160 { "off", ZFS_ACLTYPE_OFF
},
161 { "disabled", ZFS_ACLTYPE_OFF
},
162 { "noacl", ZFS_ACLTYPE_OFF
},
163 { "posixacl", ZFS_ACLTYPE_POSIXACL
},
167 static zprop_index_t acl_inherit_table
[] = {
168 { "discard", ZFS_ACL_DISCARD
},
169 { "noallow", ZFS_ACL_NOALLOW
},
170 { "restricted", ZFS_ACL_RESTRICTED
},
171 { "passthrough", ZFS_ACL_PASSTHROUGH
},
172 { "secure", ZFS_ACL_RESTRICTED
}, /* bkwrd compatibility */
173 { "passthrough-x", ZFS_ACL_PASSTHROUGH_X
},
177 static zprop_index_t case_table
[] = {
178 { "sensitive", ZFS_CASE_SENSITIVE
},
179 { "insensitive", ZFS_CASE_INSENSITIVE
},
180 { "mixed", ZFS_CASE_MIXED
},
184 static zprop_index_t copies_table
[] = {
192 * Use the unique flags we have to send to u8_strcmp() and/or
193 * u8_textprep() to represent the various normalization property
196 static zprop_index_t normalize_table
[] = {
198 { "formD", U8_TEXTPREP_NFD
},
199 { "formKC", U8_TEXTPREP_NFKC
},
200 { "formC", U8_TEXTPREP_NFC
},
201 { "formKD", U8_TEXTPREP_NFKD
},
205 static zprop_index_t version_table
[] = {
211 { "current", ZPL_VERSION
},
215 static zprop_index_t boolean_table
[] = {
221 static zprop_index_t keystatus_table
[] = {
222 { "none", ZFS_KEYSTATUS_NONE
},
223 { "unavailable", ZFS_KEYSTATUS_UNAVAILABLE
},
224 { "available", ZFS_KEYSTATUS_AVAILABLE
},
228 static zprop_index_t logbias_table
[] = {
229 { "latency", ZFS_LOGBIAS_LATENCY
},
230 { "throughput", ZFS_LOGBIAS_THROUGHPUT
},
234 static zprop_index_t canmount_table
[] = {
235 { "off", ZFS_CANMOUNT_OFF
},
236 { "on", ZFS_CANMOUNT_ON
},
237 { "noauto", ZFS_CANMOUNT_NOAUTO
},
241 static zprop_index_t cache_table
[] = {
242 { "none", ZFS_CACHE_NONE
},
243 { "metadata", ZFS_CACHE_METADATA
},
244 { "all", ZFS_CACHE_ALL
},
248 static zprop_index_t sync_table
[] = {
249 { "standard", ZFS_SYNC_STANDARD
},
250 { "always", ZFS_SYNC_ALWAYS
},
251 { "disabled", ZFS_SYNC_DISABLED
},
255 static zprop_index_t xattr_table
[] = {
256 { "off", ZFS_XATTR_OFF
},
257 { "on", ZFS_XATTR_DIR
},
258 { "sa", ZFS_XATTR_SA
},
259 { "dir", ZFS_XATTR_DIR
},
263 static zprop_index_t dnsize_table
[] = {
264 { "legacy", ZFS_DNSIZE_LEGACY
},
265 { "auto", ZFS_DNSIZE_AUTO
},
266 { "1k", ZFS_DNSIZE_1K
},
267 { "2k", ZFS_DNSIZE_2K
},
268 { "4k", ZFS_DNSIZE_4K
},
269 { "8k", ZFS_DNSIZE_8K
},
270 { "16k", ZFS_DNSIZE_16K
},
274 static zprop_index_t redundant_metadata_table
[] = {
275 { "all", ZFS_REDUNDANT_METADATA_ALL
},
276 { "most", ZFS_REDUNDANT_METADATA_MOST
},
280 static zprop_index_t volmode_table
[] = {
281 { "default", ZFS_VOLMODE_DEFAULT
},
282 { "full", ZFS_VOLMODE_GEOM
},
283 { "geom", ZFS_VOLMODE_GEOM
},
284 { "dev", ZFS_VOLMODE_DEV
},
285 { "none", ZFS_VOLMODE_NONE
},
289 /* inherit index properties */
290 zprop_register_index(ZFS_PROP_REDUNDANT_METADATA
, "redundant_metadata",
291 ZFS_REDUNDANT_METADATA_ALL
,
292 PROP_INHERIT
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
,
293 "all | most", "REDUND_MD",
294 redundant_metadata_table
);
295 zprop_register_index(ZFS_PROP_SYNC
, "sync", ZFS_SYNC_STANDARD
,
296 PROP_INHERIT
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
,
297 "standard | always | disabled", "SYNC",
299 zprop_register_index(ZFS_PROP_CHECKSUM
, "checksum",
300 ZIO_CHECKSUM_DEFAULT
, PROP_INHERIT
, ZFS_TYPE_FILESYSTEM
|
302 "on | off | fletcher2 | fletcher4 | sha256 | sha512 | "
303 "skein | edonr", "CHECKSUM", checksum_table
);
304 zprop_register_index(ZFS_PROP_DEDUP
, "dedup", ZIO_CHECKSUM_OFF
,
305 PROP_INHERIT
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
,
306 "on | off | verify | sha256[,verify], sha512[,verify], "
307 "skein[,verify], edonr,verify", "DEDUP", dedup_table
);
308 zprop_register_index(ZFS_PROP_COMPRESSION
, "compression",
309 ZIO_COMPRESS_DEFAULT
, PROP_INHERIT
,
310 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
,
311 "on | off | lzjb | gzip | gzip-[1-9] | zle | lz4", "COMPRESS",
313 zprop_register_index(ZFS_PROP_SNAPDIR
, "snapdir", ZFS_SNAPDIR_HIDDEN
,
314 PROP_INHERIT
, ZFS_TYPE_FILESYSTEM
,
315 "hidden | visible", "SNAPDIR", snapdir_table
);
316 zprop_register_index(ZFS_PROP_SNAPDEV
, "snapdev", ZFS_SNAPDEV_HIDDEN
,
317 PROP_INHERIT
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
,
318 "hidden | visible", "SNAPDEV", snapdev_table
);
319 zprop_register_index(ZFS_PROP_ACLTYPE
, "acltype", ZFS_ACLTYPE_OFF
,
320 PROP_INHERIT
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_SNAPSHOT
,
321 "noacl | posixacl", "ACLTYPE", acltype_table
);
322 zprop_register_index(ZFS_PROP_ACLINHERIT
, "aclinherit",
323 ZFS_ACL_RESTRICTED
, PROP_INHERIT
, ZFS_TYPE_FILESYSTEM
,
324 "discard | noallow | restricted | passthrough | passthrough-x",
325 "ACLINHERIT", acl_inherit_table
);
326 zprop_register_index(ZFS_PROP_COPIES
, "copies", 1, PROP_INHERIT
,
327 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
,
328 "1 | 2 | 3", "COPIES", copies_table
);
329 zprop_register_index(ZFS_PROP_PRIMARYCACHE
, "primarycache",
330 ZFS_CACHE_ALL
, PROP_INHERIT
,
331 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_SNAPSHOT
| ZFS_TYPE_VOLUME
,
332 "all | none | metadata", "PRIMARYCACHE", cache_table
);
333 zprop_register_index(ZFS_PROP_SECONDARYCACHE
, "secondarycache",
334 ZFS_CACHE_ALL
, PROP_INHERIT
,
335 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_SNAPSHOT
| ZFS_TYPE_VOLUME
,
336 "all | none | metadata", "SECONDARYCACHE", cache_table
);
337 zprop_register_index(ZFS_PROP_LOGBIAS
, "logbias", ZFS_LOGBIAS_LATENCY
,
338 PROP_INHERIT
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
,
339 "latency | throughput", "LOGBIAS", logbias_table
);
340 zprop_register_index(ZFS_PROP_XATTR
, "xattr", ZFS_XATTR_DIR
,
341 PROP_INHERIT
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_SNAPSHOT
,
342 "on | off | dir | sa", "XATTR", xattr_table
);
343 zprop_register_index(ZFS_PROP_DNODESIZE
, "dnodesize",
344 ZFS_DNSIZE_LEGACY
, PROP_INHERIT
, ZFS_TYPE_FILESYSTEM
,
345 "legacy | auto | 1k | 2k | 4k | 8k | 16k", "DNSIZE", dnsize_table
);
346 zprop_register_index(ZFS_PROP_VOLMODE
, "volmode",
347 ZFS_VOLMODE_DEFAULT
, PROP_INHERIT
,
348 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
,
349 "default | full | geom | dev | none", "VOLMODE", volmode_table
);
351 /* inherit index (boolean) properties */
352 zprop_register_index(ZFS_PROP_ATIME
, "atime", 1, PROP_INHERIT
,
353 ZFS_TYPE_FILESYSTEM
, "on | off", "ATIME", boolean_table
);
354 zprop_register_index(ZFS_PROP_RELATIME
, "relatime", 0, PROP_INHERIT
,
355 ZFS_TYPE_FILESYSTEM
, "on | off", "RELATIME", boolean_table
);
356 zprop_register_index(ZFS_PROP_DEVICES
, "devices", 1, PROP_INHERIT
,
357 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_SNAPSHOT
, "on | off", "DEVICES",
359 zprop_register_index(ZFS_PROP_EXEC
, "exec", 1, PROP_INHERIT
,
360 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_SNAPSHOT
, "on | off", "EXEC",
362 zprop_register_index(ZFS_PROP_SETUID
, "setuid", 1, PROP_INHERIT
,
363 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_SNAPSHOT
, "on | off", "SETUID",
365 zprop_register_index(ZFS_PROP_READONLY
, "readonly", 0, PROP_INHERIT
,
366 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
, "on | off", "RDONLY",
368 zprop_register_index(ZFS_PROP_ZONED
, "zoned", 0, PROP_INHERIT
,
369 ZFS_TYPE_FILESYSTEM
, "on | off", "ZONED", boolean_table
);
370 zprop_register_index(ZFS_PROP_VSCAN
, "vscan", 0, PROP_INHERIT
,
371 ZFS_TYPE_FILESYSTEM
, "on | off", "VSCAN", boolean_table
);
372 zprop_register_index(ZFS_PROP_NBMAND
, "nbmand", 0, PROP_INHERIT
,
373 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_SNAPSHOT
, "on | off", "NBMAND",
375 zprop_register_index(ZFS_PROP_OVERLAY
, "overlay", 0, PROP_INHERIT
,
376 ZFS_TYPE_FILESYSTEM
, "on | off", "OVERLAY", boolean_table
);
378 /* default index properties */
379 zprop_register_index(ZFS_PROP_VERSION
, "version", 0, PROP_DEFAULT
,
380 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_SNAPSHOT
,
381 "1 | 2 | 3 | 4 | 5 | current", "VERSION", version_table
);
382 zprop_register_index(ZFS_PROP_CANMOUNT
, "canmount", ZFS_CANMOUNT_ON
,
383 PROP_DEFAULT
, ZFS_TYPE_FILESYSTEM
, "on | off | noauto",
384 "CANMOUNT", canmount_table
);
386 /* readonly index properties */
387 zprop_register_index(ZFS_PROP_MOUNTED
, "mounted", 0, PROP_READONLY
,
388 ZFS_TYPE_FILESYSTEM
, "yes | no", "MOUNTED", boolean_table
);
389 zprop_register_index(ZFS_PROP_DEFER_DESTROY
, "defer_destroy", 0,
390 PROP_READONLY
, ZFS_TYPE_SNAPSHOT
, "yes | no", "DEFER_DESTROY",
392 zprop_register_index(ZFS_PROP_KEYSTATUS
, "keystatus",
393 ZFS_KEYSTATUS_NONE
, PROP_READONLY
, ZFS_TYPE_DATASET
,
394 "none | unavailable | available",
395 "KEYSTATUS", keystatus_table
);
397 /* set once index properties */
398 zprop_register_index(ZFS_PROP_NORMALIZE
, "normalization", 0,
399 PROP_ONETIME
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_SNAPSHOT
,
400 "none | formC | formD | formKC | formKD", "NORMALIZATION",
402 zprop_register_index(ZFS_PROP_CASE
, "casesensitivity",
403 ZFS_CASE_SENSITIVE
, PROP_ONETIME
, ZFS_TYPE_FILESYSTEM
|
405 "sensitive | insensitive | mixed", "CASE", case_table
);
406 zprop_register_index(ZFS_PROP_KEYFORMAT
, "keyformat",
407 ZFS_KEYFORMAT_NONE
, PROP_ONETIME_DEFAULT
,
408 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
,
409 "none | raw | hex | passphrase", "KEYFORMAT", keyformat_table
);
410 zprop_register_index(ZFS_PROP_ENCRYPTION
, "encryption",
411 ZIO_CRYPT_DEFAULT
, PROP_ONETIME
, ZFS_TYPE_DATASET
,
412 "on | off | aes-128-ccm | aes-192-ccm | aes-256-ccm | "
413 "aes-128-gcm | aes-192-gcm | aes-256-gcm", "ENCRYPTION",
416 /* set once index (boolean) properties */
417 zprop_register_index(ZFS_PROP_UTF8ONLY
, "utf8only", 0, PROP_ONETIME
,
418 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_SNAPSHOT
,
419 "on | off", "UTF8ONLY", boolean_table
);
421 /* string properties */
422 zprop_register_string(ZFS_PROP_ORIGIN
, "origin", NULL
, PROP_READONLY
,
423 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
, "<snapshot>", "ORIGIN");
424 zprop_register_string(ZFS_PROP_CLONES
, "clones", NULL
, PROP_READONLY
,
425 ZFS_TYPE_SNAPSHOT
, "<dataset>[,...]", "CLONES");
426 zprop_register_string(ZFS_PROP_MOUNTPOINT
, "mountpoint", "/",
427 PROP_INHERIT
, ZFS_TYPE_FILESYSTEM
, "<path> | legacy | none",
429 zprop_register_string(ZFS_PROP_SHARENFS
, "sharenfs", "off",
430 PROP_INHERIT
, ZFS_TYPE_FILESYSTEM
, "on | off | share(1M) options",
432 zprop_register_string(ZFS_PROP_TYPE
, "type", NULL
, PROP_READONLY
,
433 ZFS_TYPE_DATASET
| ZFS_TYPE_BOOKMARK
,
434 "filesystem | volume | snapshot | bookmark", "TYPE");
435 zprop_register_string(ZFS_PROP_SHARESMB
, "sharesmb", "off",
436 PROP_INHERIT
, ZFS_TYPE_FILESYSTEM
,
437 "on | off | sharemgr(1M) options", "SHARESMB");
438 zprop_register_string(ZFS_PROP_MLSLABEL
, "mlslabel",
439 ZFS_MLSLABEL_DEFAULT
, PROP_INHERIT
, ZFS_TYPE_DATASET
,
440 "<sensitivity label>", "MLSLABEL");
441 zprop_register_string(ZFS_PROP_SELINUX_CONTEXT
, "context",
442 "none", PROP_DEFAULT
, ZFS_TYPE_DATASET
, "<selinux context>",
444 zprop_register_string(ZFS_PROP_SELINUX_FSCONTEXT
, "fscontext",
445 "none", PROP_DEFAULT
, ZFS_TYPE_DATASET
, "<selinux fscontext>",
447 zprop_register_string(ZFS_PROP_SELINUX_DEFCONTEXT
, "defcontext",
448 "none", PROP_DEFAULT
, ZFS_TYPE_DATASET
, "<selinux defcontext>",
450 zprop_register_string(ZFS_PROP_SELINUX_ROOTCONTEXT
, "rootcontext",
451 "none", PROP_DEFAULT
, ZFS_TYPE_DATASET
, "<selinux rootcontext>",
453 zprop_register_string(ZFS_PROP_RECEIVE_RESUME_TOKEN
,
454 "receive_resume_token",
455 NULL
, PROP_READONLY
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
,
456 "<string token>", "RESUMETOK");
457 zprop_register_string(ZFS_PROP_ENCRYPTION_ROOT
, "encryptionroot", NULL
,
458 PROP_READONLY
, ZFS_TYPE_DATASET
, "<filesystem | volume>",
460 zprop_register_string(ZFS_PROP_KEYLOCATION
, "keylocation",
461 "none", PROP_DEFAULT
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
,
462 "prompt | <file URI>", "KEYLOCATION");
464 /* readonly number properties */
465 zprop_register_number(ZFS_PROP_USED
, "used", 0, PROP_READONLY
,
466 ZFS_TYPE_DATASET
, "<size>", "USED");
467 zprop_register_number(ZFS_PROP_AVAILABLE
, "available", 0, PROP_READONLY
,
468 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
, "<size>", "AVAIL");
469 zprop_register_number(ZFS_PROP_REFERENCED
, "referenced", 0,
470 PROP_READONLY
, ZFS_TYPE_DATASET
, "<size>", "REFER");
471 zprop_register_number(ZFS_PROP_COMPRESSRATIO
, "compressratio", 0,
472 PROP_READONLY
, ZFS_TYPE_DATASET
,
473 "<1.00x or higher if compressed>", "RATIO");
474 zprop_register_number(ZFS_PROP_REFRATIO
, "refcompressratio", 0,
475 PROP_READONLY
, ZFS_TYPE_DATASET
,
476 "<1.00x or higher if compressed>", "REFRATIO");
477 zprop_register_number(ZFS_PROP_VOLBLOCKSIZE
, "volblocksize",
478 ZVOL_DEFAULT_BLOCKSIZE
, PROP_ONETIME
,
479 ZFS_TYPE_VOLUME
, "512 to 128k, power of 2", "VOLBLOCK");
480 zprop_register_number(ZFS_PROP_USEDSNAP
, "usedbysnapshots", 0,
481 PROP_READONLY
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
, "<size>",
483 zprop_register_number(ZFS_PROP_USEDDS
, "usedbydataset", 0,
484 PROP_READONLY
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
, "<size>",
486 zprop_register_number(ZFS_PROP_USEDCHILD
, "usedbychildren", 0,
487 PROP_READONLY
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
, "<size>",
489 zprop_register_number(ZFS_PROP_USEDREFRESERV
, "usedbyrefreservation", 0,
491 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
, "<size>", "USEDREFRESERV");
492 zprop_register_number(ZFS_PROP_USERREFS
, "userrefs", 0, PROP_READONLY
,
493 ZFS_TYPE_SNAPSHOT
, "<count>", "USERREFS");
494 zprop_register_number(ZFS_PROP_WRITTEN
, "written", 0, PROP_READONLY
,
495 ZFS_TYPE_DATASET
, "<size>", "WRITTEN");
496 zprop_register_number(ZFS_PROP_LOGICALUSED
, "logicalused", 0,
497 PROP_READONLY
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
, "<size>",
499 zprop_register_number(ZFS_PROP_LOGICALREFERENCED
, "logicalreferenced",
500 0, PROP_READONLY
, ZFS_TYPE_DATASET
, "<size>", "LREFER");
501 zprop_register_number(ZFS_PROP_FILESYSTEM_COUNT
, "filesystem_count",
502 UINT64_MAX
, PROP_READONLY
, ZFS_TYPE_FILESYSTEM
,
503 "<count>", "FSCOUNT");
504 zprop_register_number(ZFS_PROP_SNAPSHOT_COUNT
, "snapshot_count",
505 UINT64_MAX
, PROP_READONLY
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
,
506 "<count>", "SSCOUNT");
507 zprop_register_number(ZFS_PROP_GUID
, "guid", 0, PROP_READONLY
,
508 ZFS_TYPE_DATASET
| ZFS_TYPE_BOOKMARK
, "<uint64>", "GUID");
509 zprop_register_number(ZFS_PROP_CREATETXG
, "createtxg", 0, PROP_READONLY
,
510 ZFS_TYPE_DATASET
| ZFS_TYPE_BOOKMARK
, "<uint64>", "CREATETXG");
511 zprop_register_hidden(ZFS_PROP_REMAPTXG
, "remaptxg", PROP_TYPE_NUMBER
,
512 PROP_READONLY
, ZFS_TYPE_DATASET
, "REMAPTXG");
513 zprop_register_number(ZFS_PROP_PBKDF2_ITERS
, "pbkdf2iters",
514 0, PROP_ONETIME_DEFAULT
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
,
515 "<iters>", "PBKDF2ITERS");
517 /* default number properties */
518 zprop_register_number(ZFS_PROP_QUOTA
, "quota", 0, PROP_DEFAULT
,
519 ZFS_TYPE_FILESYSTEM
, "<size> | none", "QUOTA");
520 zprop_register_number(ZFS_PROP_RESERVATION
, "reservation", 0,
521 PROP_DEFAULT
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
,
522 "<size> | none", "RESERV");
523 zprop_register_number(ZFS_PROP_VOLSIZE
, "volsize", 0, PROP_DEFAULT
,
524 ZFS_TYPE_SNAPSHOT
| ZFS_TYPE_VOLUME
, "<size>", "VOLSIZE");
525 zprop_register_number(ZFS_PROP_REFQUOTA
, "refquota", 0, PROP_DEFAULT
,
526 ZFS_TYPE_FILESYSTEM
, "<size> | none", "REFQUOTA");
527 zprop_register_number(ZFS_PROP_REFRESERVATION
, "refreservation", 0,
528 PROP_DEFAULT
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
,
529 "<size> | none", "REFRESERV");
530 zprop_register_number(ZFS_PROP_FILESYSTEM_LIMIT
, "filesystem_limit",
531 UINT64_MAX
, PROP_DEFAULT
, ZFS_TYPE_FILESYSTEM
,
532 "<count> | none", "FSLIMIT");
533 zprop_register_number(ZFS_PROP_SNAPSHOT_LIMIT
, "snapshot_limit",
534 UINT64_MAX
, PROP_DEFAULT
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
,
535 "<count> | none", "SSLIMIT");
537 /* inherit number properties */
538 zprop_register_number(ZFS_PROP_RECORDSIZE
, "recordsize",
539 SPA_OLD_MAXBLOCKSIZE
, PROP_INHERIT
,
540 ZFS_TYPE_FILESYSTEM
, "512 to 1M, power of 2", "RECSIZE");
542 /* hidden properties */
543 zprop_register_hidden(ZFS_PROP_NUMCLONES
, "numclones", PROP_TYPE_NUMBER
,
544 PROP_READONLY
, ZFS_TYPE_SNAPSHOT
, "NUMCLONES");
545 zprop_register_hidden(ZFS_PROP_NAME
, "name", PROP_TYPE_STRING
,
546 PROP_READONLY
, ZFS_TYPE_DATASET
| ZFS_TYPE_BOOKMARK
, "NAME");
547 zprop_register_hidden(ZFS_PROP_ISCSIOPTIONS
, "iscsioptions",
548 PROP_TYPE_STRING
, PROP_INHERIT
, ZFS_TYPE_VOLUME
, "ISCSIOPTIONS");
549 zprop_register_hidden(ZFS_PROP_STMF_SHAREINFO
, "stmf_sbd_lu",
550 PROP_TYPE_STRING
, PROP_INHERIT
, ZFS_TYPE_VOLUME
,
552 zprop_register_hidden(ZFS_PROP_USERACCOUNTING
, "useraccounting",
553 PROP_TYPE_NUMBER
, PROP_READONLY
, ZFS_TYPE_DATASET
,
555 zprop_register_hidden(ZFS_PROP_UNIQUE
, "unique", PROP_TYPE_NUMBER
,
556 PROP_READONLY
, ZFS_TYPE_DATASET
, "UNIQUE");
557 zprop_register_hidden(ZFS_PROP_OBJSETID
, "objsetid", PROP_TYPE_NUMBER
,
558 PROP_READONLY
, ZFS_TYPE_DATASET
, "OBJSETID");
559 zprop_register_hidden(ZFS_PROP_INCONSISTENT
, "inconsistent",
560 PROP_TYPE_NUMBER
, PROP_READONLY
, ZFS_TYPE_DATASET
, "INCONSISTENT");
561 zprop_register_hidden(ZFS_PROP_PREV_SNAP
, "prevsnap", PROP_TYPE_STRING
,
562 PROP_READONLY
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
, "PREVSNAP");
563 zprop_register_hidden(ZFS_PROP_PBKDF2_SALT
, "pbkdf2salt",
564 PROP_TYPE_NUMBER
, PROP_ONETIME_DEFAULT
,
565 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
, "PBKDF2SALT");
566 zprop_register_hidden(ZFS_PROP_KEY_GUID
, "keyguid", PROP_TYPE_NUMBER
,
567 PROP_READONLY
, ZFS_TYPE_DATASET
, "KEYGUID");
570 * Property to be removed once libbe is integrated
572 zprop_register_hidden(ZFS_PROP_PRIVATE
, "priv_prop",
573 PROP_TYPE_NUMBER
, PROP_READONLY
, ZFS_TYPE_FILESYSTEM
,
576 /* oddball properties */
577 zprop_register_impl(ZFS_PROP_CREATION
, "creation", PROP_TYPE_NUMBER
, 0,
578 NULL
, PROP_READONLY
, ZFS_TYPE_DATASET
| ZFS_TYPE_BOOKMARK
,
579 "<date>", "CREATION", B_FALSE
, B_TRUE
, NULL
);
583 zfs_prop_delegatable(zfs_prop_t prop
)
585 zprop_desc_t
*pd
= &zfs_prop_table
[prop
];
587 /* The mlslabel property is never delegatable. */
588 if (prop
== ZFS_PROP_MLSLABEL
)
591 return (pd
->pd_attr
!= PROP_READONLY
);
595 * Given a zfs dataset property name, returns the corresponding property ID.
598 zfs_name_to_prop(const char *propname
)
600 return (zprop_name_to_prop(propname
, ZFS_TYPE_DATASET
));
604 * For user property names, we allow all lowercase alphanumeric characters, plus
605 * a few useful punctuation characters.
610 return ((c
>= 'a' && c
<= 'z') ||
611 (c
>= '0' && c
<= '9') ||
612 c
== '-' || c
== '_' || c
== '.' || c
== ':');
616 * Returns true if this is a valid user-defined property (one with a ':').
619 zfs_prop_user(const char *name
)
623 boolean_t foundsep
= B_FALSE
;
625 for (i
= 0; i
< strlen(name
); i
++) {
640 * Returns true if this is a valid userspace-type property (one with a '@').
641 * Note that after the @, any character is valid (eg, another @, for SID
645 zfs_prop_userquota(const char *name
)
647 zfs_userquota_prop_t prop
;
649 for (prop
= 0; prop
< ZFS_NUM_USERQUOTA_PROPS
; prop
++) {
650 if (strncmp(name
, zfs_userquota_prop_prefixes
[prop
],
651 strlen(zfs_userquota_prop_prefixes
[prop
])) == 0) {
660 * Returns true if this is a valid written@ property.
661 * Note that after the @, any character is valid (eg, another @, for
662 * written@pool/fs@origin).
665 zfs_prop_written(const char *name
)
667 static const char *prefix
= "written@";
668 return (strncmp(name
, prefix
, strlen(prefix
)) == 0);
672 * Tables of index types, plus functions to convert between the user view
673 * (strings) and internal representation (uint64_t).
676 zfs_prop_string_to_index(zfs_prop_t prop
, const char *string
, uint64_t *index
)
678 return (zprop_string_to_index(prop
, string
, index
, ZFS_TYPE_DATASET
));
682 zfs_prop_index_to_string(zfs_prop_t prop
, uint64_t index
, const char **string
)
684 return (zprop_index_to_string(prop
, index
, string
, ZFS_TYPE_DATASET
));
688 zfs_prop_random_value(zfs_prop_t prop
, uint64_t seed
)
690 return (zprop_random_value(prop
, seed
, ZFS_TYPE_DATASET
));
694 * Returns TRUE if the property applies to any of the given dataset types.
697 zfs_prop_valid_for_type(int prop
, zfs_type_t types
, boolean_t headcheck
)
699 return (zprop_valid_for_type(prop
, types
, headcheck
));
703 zfs_prop_get_type(zfs_prop_t prop
)
705 return (zfs_prop_table
[prop
].pd_proptype
);
709 * Returns TRUE if the property is readonly.
712 zfs_prop_readonly(zfs_prop_t prop
)
714 return (zfs_prop_table
[prop
].pd_attr
== PROP_READONLY
||
715 zfs_prop_table
[prop
].pd_attr
== PROP_ONETIME
||
716 zfs_prop_table
[prop
].pd_attr
== PROP_ONETIME_DEFAULT
);
720 * Returns TRUE if the property is visible (not hidden).
723 zfs_prop_visible(zfs_prop_t prop
)
725 return (zfs_prop_table
[prop
].pd_visible
);
729 * Returns TRUE if the property is only allowed to be set once.
732 zfs_prop_setonce(zfs_prop_t prop
)
734 return (zfs_prop_table
[prop
].pd_attr
== PROP_ONETIME
||
735 zfs_prop_table
[prop
].pd_attr
== PROP_ONETIME_DEFAULT
);
739 zfs_prop_default_string(zfs_prop_t prop
)
741 return (zfs_prop_table
[prop
].pd_strdefault
);
745 zfs_prop_default_numeric(zfs_prop_t prop
)
747 return (zfs_prop_table
[prop
].pd_numdefault
);
751 * Given a dataset property ID, returns the corresponding name.
752 * Assuming the zfs dataset property ID is valid.
755 zfs_prop_to_name(zfs_prop_t prop
)
757 return (zfs_prop_table
[prop
].pd_name
);
761 * Returns TRUE if the property is inheritable.
764 zfs_prop_inheritable(zfs_prop_t prop
)
766 return (zfs_prop_table
[prop
].pd_attr
== PROP_INHERIT
||
767 zfs_prop_table
[prop
].pd_attr
== PROP_ONETIME
);
771 * Returns TRUE if property is one of the encryption properties that requires
772 * a loaded encryption key to modify.
775 zfs_prop_encryption_key_param(zfs_prop_t prop
)
778 * keylocation does not count as an encryption property. It can be
779 * changed at will without needing the master keys.
781 return (prop
== ZFS_PROP_PBKDF2_SALT
|| prop
== ZFS_PROP_PBKDF2_ITERS
||
782 prop
== ZFS_PROP_KEYFORMAT
);
786 * Helper function used by both kernelspace and userspace to check the
787 * keylocation property. If encrypted is set, the keylocation must be valid
788 * for an encrypted dataset.
791 zfs_prop_valid_keylocation(const char *str
, boolean_t encrypted
)
793 if (strcmp("none", str
) == 0)
795 else if (strcmp("prompt", str
) == 0)
797 else if (strlen(str
) > 8 && strncmp("file:///", str
, 8) == 0)
807 * Returns a string describing the set of acceptable values for the given
808 * zfs property, or NULL if it cannot be set.
811 zfs_prop_values(zfs_prop_t prop
)
813 return (zfs_prop_table
[prop
].pd_values
);
817 * Returns TRUE if this property is a string type. Note that index types
818 * (compression, checksum) are treated as strings in userland, even though they
819 * are stored numerically on disk.
822 zfs_prop_is_string(zfs_prop_t prop
)
824 return (zfs_prop_table
[prop
].pd_proptype
== PROP_TYPE_STRING
||
825 zfs_prop_table
[prop
].pd_proptype
== PROP_TYPE_INDEX
);
829 * Returns the column header for the given property. Used only in
830 * 'zfs list -o', but centralized here with the other property information.
833 zfs_prop_column_name(zfs_prop_t prop
)
835 return (zfs_prop_table
[prop
].pd_colname
);
839 * Returns whether the given property should be displayed right-justified for
843 zfs_prop_align_right(zfs_prop_t prop
)
845 return (zfs_prop_table
[prop
].pd_rightalign
);
850 #if defined(_KERNEL) && defined(HAVE_SPL)
864 module_init(zcommon_init
);
865 module_exit(zcommon_fini
);
867 MODULE_DESCRIPTION("Generic ZFS support");
868 MODULE_AUTHOR(ZFS_META_AUTHOR
);
869 MODULE_LICENSE(ZFS_META_LICENSE
);
870 MODULE_VERSION(ZFS_META_VERSION
"-" ZFS_META_RELEASE
);
872 /* zfs dataset property functions */
873 EXPORT_SYMBOL(zfs_userquota_prop_prefixes
);
874 EXPORT_SYMBOL(zfs_prop_init
);
875 EXPORT_SYMBOL(zfs_prop_get_type
);
876 EXPORT_SYMBOL(zfs_prop_get_table
);
877 EXPORT_SYMBOL(zfs_prop_delegatable
);
878 EXPORT_SYMBOL(zfs_prop_visible
);
880 /* Dataset property functions shared between libzfs and kernel. */
881 EXPORT_SYMBOL(zfs_prop_default_string
);
882 EXPORT_SYMBOL(zfs_prop_default_numeric
);
883 EXPORT_SYMBOL(zfs_prop_readonly
);
884 EXPORT_SYMBOL(zfs_prop_inheritable
);
885 EXPORT_SYMBOL(zfs_prop_encryption_key_param
);
886 EXPORT_SYMBOL(zfs_prop_valid_keylocation
);
887 EXPORT_SYMBOL(zfs_prop_setonce
);
888 EXPORT_SYMBOL(zfs_prop_to_name
);
889 EXPORT_SYMBOL(zfs_name_to_prop
);
890 EXPORT_SYMBOL(zfs_prop_user
);
891 EXPORT_SYMBOL(zfs_prop_userquota
);
892 EXPORT_SYMBOL(zfs_prop_index_to_string
);
893 EXPORT_SYMBOL(zfs_prop_string_to_index
);
894 EXPORT_SYMBOL(zfs_prop_valid_for_type
);
895 EXPORT_SYMBOL(zfs_prop_written
);