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, 2014 by Delphix. All rights reserved.
24 * Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
27 /* Portions Copyright 2010 Robert Milkowski */
31 #include <sys/u8_textprep.h>
32 #include <sys/zfs_acl.h>
33 #include <sys/zfs_ioctl.h>
34 #include <sys/zfs_znode.h>
37 #include "zfs_deleg.h"
40 #include <sys/systm.h>
47 static zprop_desc_t zfs_prop_table[ZFS_NUM_PROPS];
49 /* Note this is indexed by zfs_userquota_prop_t, keep the order the same */
50 const char *zfs_userquota_prop_prefixes[] = {
58 zfs_prop_get_table(void)
60 return (zfs_prop_table);
66 static zprop_index_t checksum_table[] = {
67 { "on", ZIO_CHECKSUM_ON },
68 { "off", ZIO_CHECKSUM_OFF },
69 { "fletcher2", ZIO_CHECKSUM_FLETCHER_2 },
70 { "fletcher4", ZIO_CHECKSUM_FLETCHER_4 },
71 { "sha256", ZIO_CHECKSUM_SHA256 },
75 static zprop_index_t dedup_table[] = {
76 { "on", ZIO_CHECKSUM_ON },
77 { "off", ZIO_CHECKSUM_OFF },
78 { "verify", ZIO_CHECKSUM_ON | ZIO_CHECKSUM_VERIFY },
79 { "sha256", ZIO_CHECKSUM_SHA256 },
81 ZIO_CHECKSUM_SHA256 | ZIO_CHECKSUM_VERIFY },
85 static zprop_index_t compress_table[] = {
86 { "on", ZIO_COMPRESS_ON },
87 { "off", ZIO_COMPRESS_OFF },
88 { "lzjb", ZIO_COMPRESS_LZJB },
89 { "gzip", ZIO_COMPRESS_GZIP_6 }, /* gzip default */
90 { "gzip-1", ZIO_COMPRESS_GZIP_1 },
91 { "gzip-2", ZIO_COMPRESS_GZIP_2 },
92 { "gzip-3", ZIO_COMPRESS_GZIP_3 },
93 { "gzip-4", ZIO_COMPRESS_GZIP_4 },
94 { "gzip-5", ZIO_COMPRESS_GZIP_5 },
95 { "gzip-6", ZIO_COMPRESS_GZIP_6 },
96 { "gzip-7", ZIO_COMPRESS_GZIP_7 },
97 { "gzip-8", ZIO_COMPRESS_GZIP_8 },
98 { "gzip-9", ZIO_COMPRESS_GZIP_9 },
99 { "zle", ZIO_COMPRESS_ZLE },
100 { "lz4", ZIO_COMPRESS_LZ4 },
104 static zprop_index_t snapdir_table[] = {
105 { "hidden", ZFS_SNAPDIR_HIDDEN },
106 { "visible", ZFS_SNAPDIR_VISIBLE },
110 static zprop_index_t snapdev_table[] = {
111 { "hidden", ZFS_SNAPDEV_HIDDEN },
112 { "visible", ZFS_SNAPDEV_VISIBLE },
116 static zprop_index_t acltype_table[] = {
117 { "off", ZFS_ACLTYPE_OFF },
118 { "disabled", ZFS_ACLTYPE_OFF },
119 { "noacl", ZFS_ACLTYPE_OFF },
120 { "posixacl", ZFS_ACLTYPE_POSIXACL },
124 static zprop_index_t acl_inherit_table[] = {
125 { "discard", ZFS_ACL_DISCARD },
126 { "noallow", ZFS_ACL_NOALLOW },
127 { "restricted", ZFS_ACL_RESTRICTED },
128 { "passthrough", ZFS_ACL_PASSTHROUGH },
129 { "secure", ZFS_ACL_RESTRICTED }, /* bkwrd compatability */
130 { "passthrough-x", ZFS_ACL_PASSTHROUGH_X },
134 static zprop_index_t case_table[] = {
135 { "sensitive", ZFS_CASE_SENSITIVE },
136 { "insensitive", ZFS_CASE_INSENSITIVE },
137 { "mixed", ZFS_CASE_MIXED },
141 static zprop_index_t copies_table[] = {
149 * Use the unique flags we have to send to u8_strcmp() and/or
150 * u8_textprep() to represent the various normalization property
153 static zprop_index_t normalize_table[] = {
155 { "formD", U8_TEXTPREP_NFD },
156 { "formKC", U8_TEXTPREP_NFKC },
157 { "formC", U8_TEXTPREP_NFC },
158 { "formKD", U8_TEXTPREP_NFKD },
162 static zprop_index_t version_table[] = {
168 { "current", ZPL_VERSION },
172 static zprop_index_t boolean_table[] = {
178 static zprop_index_t logbias_table[] = {
179 { "latency", ZFS_LOGBIAS_LATENCY },
180 { "throughput", ZFS_LOGBIAS_THROUGHPUT },
184 static zprop_index_t canmount_table[] = {
185 { "off", ZFS_CANMOUNT_OFF },
186 { "on", ZFS_CANMOUNT_ON },
187 { "noauto", ZFS_CANMOUNT_NOAUTO },
191 static zprop_index_t cache_table[] = {
192 { "none", ZFS_CACHE_NONE },
193 { "metadata", ZFS_CACHE_METADATA },
194 { "all", ZFS_CACHE_ALL },
198 static zprop_index_t sync_table[] = {
199 { "standard", ZFS_SYNC_STANDARD },
200 { "always", ZFS_SYNC_ALWAYS },
201 { "disabled", ZFS_SYNC_DISABLED },
205 static zprop_index_t xattr_table[] = {
206 { "off", ZFS_XATTR_OFF },
207 { "on", ZFS_XATTR_DIR },
208 { "sa", ZFS_XATTR_SA },
209 { "dir", ZFS_XATTR_DIR },
213 static zprop_index_t redundant_metadata_table[] = {
214 { "all", ZFS_REDUNDANT_METADATA_ALL },
215 { "most", ZFS_REDUNDANT_METADATA_MOST },
219 /* inherit index properties */
220 zprop_register_index(ZFS_PROP_REDUNDANT_METADATA, "redundant_metadata",
221 ZFS_REDUNDANT_METADATA_ALL,
222 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
223 "all | most", "REDUND_MD",
224 redundant_metadata_table);
225 zprop_register_index(ZFS_PROP_SYNC, "sync", ZFS_SYNC_STANDARD,
226 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
227 "standard | always | disabled", "SYNC",
229 zprop_register_index(ZFS_PROP_CHECKSUM, "checksum",
230 ZIO_CHECKSUM_DEFAULT, PROP_INHERIT, ZFS_TYPE_FILESYSTEM |
232 "on | off | fletcher2 | fletcher4 | sha256", "CHECKSUM",
234 zprop_register_index(ZFS_PROP_DEDUP, "dedup", ZIO_CHECKSUM_OFF,
235 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
236 "on | off | verify | sha256[,verify]", "DEDUP",
238 zprop_register_index(ZFS_PROP_COMPRESSION, "compression",
239 ZIO_COMPRESS_DEFAULT, PROP_INHERIT,
240 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
241 "on | off | lzjb | gzip | gzip-[1-9] | zle | lz4", "COMPRESS",
243 zprop_register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN,
244 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
245 "hidden | visible", "SNAPDIR", snapdir_table);
246 zprop_register_index(ZFS_PROP_SNAPDEV, "snapdev", ZFS_SNAPDEV_HIDDEN,
247 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
248 "hidden | visible", "SNAPDEV", snapdev_table);
249 zprop_register_index(ZFS_PROP_ACLTYPE, "acltype", ZFS_ACLTYPE_OFF,
250 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
251 "noacl | posixacl", "ACLTYPE", acltype_table);
252 zprop_register_index(ZFS_PROP_ACLINHERIT, "aclinherit",
253 ZFS_ACL_RESTRICTED, PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
254 "discard | noallow | restricted | passthrough | passthrough-x",
255 "ACLINHERIT", acl_inherit_table);
256 zprop_register_index(ZFS_PROP_COPIES, "copies", 1, PROP_INHERIT,
257 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
258 "1 | 2 | 3", "COPIES", copies_table);
259 zprop_register_index(ZFS_PROP_PRIMARYCACHE, "primarycache",
260 ZFS_CACHE_ALL, PROP_INHERIT,
261 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
262 "all | none | metadata", "PRIMARYCACHE", cache_table);
263 zprop_register_index(ZFS_PROP_SECONDARYCACHE, "secondarycache",
264 ZFS_CACHE_ALL, PROP_INHERIT,
265 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
266 "all | none | metadata", "SECONDARYCACHE", cache_table);
267 zprop_register_index(ZFS_PROP_LOGBIAS, "logbias", ZFS_LOGBIAS_LATENCY,
268 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
269 "latency | throughput", "LOGBIAS", logbias_table);
270 zprop_register_index(ZFS_PROP_XATTR, "xattr", ZFS_XATTR_DIR,
271 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
272 "on | off | dir | sa", "XATTR", xattr_table);
274 /* inherit index (boolean) properties */
275 zprop_register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT,
276 ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table);
277 zprop_register_index(ZFS_PROP_RELATIME, "relatime", 0, PROP_INHERIT,
278 ZFS_TYPE_FILESYSTEM, "on | off", "RELATIME", boolean_table);
279 zprop_register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT,
280 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES",
282 zprop_register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT,
283 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC",
285 zprop_register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT,
286 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID",
288 zprop_register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT,
289 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY",
291 zprop_register_index(ZFS_PROP_ZONED, "zoned", 0, PROP_INHERIT,
292 ZFS_TYPE_FILESYSTEM, "on | off", "ZONED", boolean_table);
293 zprop_register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT,
294 ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN", boolean_table);
295 zprop_register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT,
296 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND",
299 /* default index properties */
300 zprop_register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT,
301 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
302 "1 | 2 | 3 | 4 | 5 | current", "VERSION", version_table);
303 zprop_register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON,
304 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto",
305 "CANMOUNT", canmount_table);
307 /* readonly index (boolean) properties */
308 zprop_register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY,
309 ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table);
310 zprop_register_index(ZFS_PROP_DEFER_DESTROY, "defer_destroy", 0,
311 PROP_READONLY, ZFS_TYPE_SNAPSHOT, "yes | no", "DEFER_DESTROY",
314 /* set once index properties */
315 zprop_register_index(ZFS_PROP_NORMALIZE, "normalization", 0,
316 PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
317 "none | formC | formD | formKC | formKD", "NORMALIZATION",
319 zprop_register_index(ZFS_PROP_CASE, "casesensitivity",
320 ZFS_CASE_SENSITIVE, PROP_ONETIME, ZFS_TYPE_FILESYSTEM |
322 "sensitive | insensitive | mixed", "CASE", case_table);
324 /* set once index (boolean) properties */
325 zprop_register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME,
326 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
327 "on | off", "UTF8ONLY", boolean_table);
329 /* string properties */
330 zprop_register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY,
331 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN");
332 zprop_register_string(ZFS_PROP_CLONES, "clones", NULL, PROP_READONLY,
333 ZFS_TYPE_SNAPSHOT, "<dataset>[,...]", "CLONES");
334 zprop_register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/",
335 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "<path> | legacy | none",
337 zprop_register_string(ZFS_PROP_SHARENFS, "sharenfs", "off",
338 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "on | off | share(1M) options",
340 zprop_register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY,
341 ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK,
342 "filesystem | volume | snapshot | bookmark", "TYPE");
343 zprop_register_string(ZFS_PROP_SHARESMB, "sharesmb", "off",
344 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
345 "on | off | sharemgr(1M) options", "SHARESMB");
346 zprop_register_string(ZFS_PROP_MLSLABEL, "mlslabel",
347 ZFS_MLSLABEL_DEFAULT, PROP_INHERIT, ZFS_TYPE_DATASET,
348 "<sensitivity label>", "MLSLABEL");
349 zprop_register_string(ZFS_PROP_SELINUX_CONTEXT, "context",
350 "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux context>",
352 zprop_register_string(ZFS_PROP_SELINUX_FSCONTEXT, "fscontext",
353 "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux fscontext>",
355 zprop_register_string(ZFS_PROP_SELINUX_DEFCONTEXT, "defcontext",
356 "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux defcontext>",
358 zprop_register_string(ZFS_PROP_SELINUX_ROOTCONTEXT, "rootcontext",
359 "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux rootcontext>",
362 /* readonly number properties */
363 zprop_register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY,
364 ZFS_TYPE_DATASET, "<size>", "USED");
365 zprop_register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY,
366 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL");
367 zprop_register_number(ZFS_PROP_REFERENCED, "referenced", 0,
368 PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "REFER");
369 zprop_register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0,
370 PROP_READONLY, ZFS_TYPE_DATASET,
371 "<1.00x or higher if compressed>", "RATIO");
372 zprop_register_number(ZFS_PROP_REFRATIO, "refcompressratio", 0,
373 PROP_READONLY, ZFS_TYPE_DATASET,
374 "<1.00x or higher if compressed>", "REFRATIO");
375 zprop_register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize",
376 ZVOL_DEFAULT_BLOCKSIZE, PROP_ONETIME,
377 ZFS_TYPE_VOLUME, "512 to 128k, power of 2", "VOLBLOCK");
378 zprop_register_number(ZFS_PROP_USEDSNAP, "usedbysnapshots", 0,
379 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
381 zprop_register_number(ZFS_PROP_USEDDS, "usedbydataset", 0,
382 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
384 zprop_register_number(ZFS_PROP_USEDCHILD, "usedbychildren", 0,
385 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
387 zprop_register_number(ZFS_PROP_USEDREFRESERV, "usedbyrefreservation", 0,
389 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDREFRESERV");
390 zprop_register_number(ZFS_PROP_USERREFS, "userrefs", 0, PROP_READONLY,
391 ZFS_TYPE_SNAPSHOT, "<count>", "USERREFS");
392 zprop_register_number(ZFS_PROP_WRITTEN, "written", 0, PROP_READONLY,
393 ZFS_TYPE_DATASET, "<size>", "WRITTEN");
394 zprop_register_number(ZFS_PROP_LOGICALUSED, "logicalused", 0,
395 PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "LUSED");
396 zprop_register_number(ZFS_PROP_LOGICALREFERENCED, "logicalreferenced",
397 0, PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "LREFER");
399 /* default number properties */
400 zprop_register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT,
401 ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA");
402 zprop_register_number(ZFS_PROP_RESERVATION, "reservation", 0,
403 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
404 "<size> | none", "RESERV");
405 zprop_register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT,
406 ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, "<size>", "VOLSIZE");
407 zprop_register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT,
408 ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA");
409 zprop_register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0,
410 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
411 "<size> | none", "REFRESERV");
413 /* inherit number properties */
414 zprop_register_number(ZFS_PROP_RECORDSIZE, "recordsize",
415 SPA_MAXBLOCKSIZE, PROP_INHERIT,
416 ZFS_TYPE_FILESYSTEM, "512 to 128k, power of 2", "RECSIZE");
418 /* hidden properties */
419 zprop_register_hidden(ZFS_PROP_CREATETXG, "createtxg", PROP_TYPE_NUMBER,
420 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "CREATETXG");
421 zprop_register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER,
422 PROP_READONLY, ZFS_TYPE_SNAPSHOT, "NUMCLONES");
423 zprop_register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING,
424 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "NAME");
425 zprop_register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions",
426 PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS");
427 zprop_register_hidden(ZFS_PROP_STMF_SHAREINFO, "stmf_sbd_lu",
428 PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME,
430 zprop_register_hidden(ZFS_PROP_GUID, "guid", PROP_TYPE_NUMBER,
431 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "GUID");
432 zprop_register_hidden(ZFS_PROP_USERACCOUNTING, "useraccounting",
433 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET,
435 zprop_register_hidden(ZFS_PROP_UNIQUE, "unique", PROP_TYPE_NUMBER,
436 PROP_READONLY, ZFS_TYPE_DATASET, "UNIQUE");
437 zprop_register_hidden(ZFS_PROP_OBJSETID, "objsetid", PROP_TYPE_NUMBER,
438 PROP_READONLY, ZFS_TYPE_DATASET, "OBJSETID");
439 zprop_register_hidden(ZFS_PROP_INCONSISTENT, "inconsistent",
440 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, "INCONSISTENT");
443 * Property to be removed once libbe is integrated
445 zprop_register_hidden(ZFS_PROP_PRIVATE, "priv_prop",
446 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_FILESYSTEM,
449 /* oddball properties */
450 zprop_register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0,
451 NULL, PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK,
452 "<date>", "CREATION", B_FALSE, B_TRUE, NULL);
456 zfs_prop_delegatable(zfs_prop_t prop)
458 zprop_desc_t *pd = &zfs_prop_table[prop];
460 /* The mlslabel property is never delegatable. */
461 if (prop == ZFS_PROP_MLSLABEL)
464 return (pd->pd_attr != PROP_READONLY);
468 * Given a zfs dataset property name, returns the corresponding property ID.
471 zfs_name_to_prop(const char *propname)
473 return (zprop_name_to_prop(propname, ZFS_TYPE_DATASET));
477 * For user property names, we allow all lowercase alphanumeric characters, plus
478 * a few useful punctuation characters.
483 return ((c >= 'a' && c <= 'z') ||
484 (c >= '0' && c <= '9') ||
485 c == '-' || c == '_' || c == '.' || c == ':');
489 * Returns true if this is a valid user-defined property (one with a ':').
492 zfs_prop_user(const char *name)
496 boolean_t foundsep = B_FALSE;
498 for (i = 0; i < strlen(name); i++) {
513 * Returns true if this is a valid userspace-type property (one with a '@').
514 * Note that after the @, any character is valid (eg, another @, for SID
518 zfs_prop_userquota(const char *name)
520 zfs_userquota_prop_t prop;
522 for (prop = 0; prop < ZFS_NUM_USERQUOTA_PROPS; prop++) {
523 if (strncmp(name, zfs_userquota_prop_prefixes[prop],
524 strlen(zfs_userquota_prop_prefixes[prop])) == 0) {
533 * Returns true if this is a valid written@ property.
534 * Note that after the @, any character is valid (eg, another @, for
535 * written@pool/fs@origin).
538 zfs_prop_written(const char *name)
540 static const char *prefix = "written@";
541 return (strncmp(name, prefix, strlen(prefix)) == 0);
545 * Tables of index types, plus functions to convert between the user view
546 * (strings) and internal representation (uint64_t).
549 zfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index)
551 return (zprop_string_to_index(prop, string, index, ZFS_TYPE_DATASET));
555 zfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string)
557 return (zprop_index_to_string(prop, index, string, ZFS_TYPE_DATASET));
561 zfs_prop_random_value(zfs_prop_t prop, uint64_t seed)
563 return (zprop_random_value(prop, seed, ZFS_TYPE_DATASET));
567 * Returns TRUE if the property applies to any of the given dataset types.
570 zfs_prop_valid_for_type(int prop, zfs_type_t types, boolean_t headcheck)
572 return (zprop_valid_for_type(prop, types, headcheck));
576 zfs_prop_get_type(zfs_prop_t prop)
578 return (zfs_prop_table[prop].pd_proptype);
582 * Returns TRUE if the property is readonly.
585 zfs_prop_readonly(zfs_prop_t prop)
587 return (zfs_prop_table[prop].pd_attr == PROP_READONLY ||
588 zfs_prop_table[prop].pd_attr == PROP_ONETIME);
592 * Returns TRUE if the property is only allowed to be set once.
595 zfs_prop_setonce(zfs_prop_t prop)
597 return (zfs_prop_table[prop].pd_attr == PROP_ONETIME);
601 zfs_prop_default_string(zfs_prop_t prop)
603 return (zfs_prop_table[prop].pd_strdefault);
607 zfs_prop_default_numeric(zfs_prop_t prop)
609 return (zfs_prop_table[prop].pd_numdefault);
613 * Given a dataset property ID, returns the corresponding name.
614 * Assuming the zfs dataset property ID is valid.
617 zfs_prop_to_name(zfs_prop_t prop)
619 return (zfs_prop_table[prop].pd_name);
623 * Returns TRUE if the property is inheritable.
626 zfs_prop_inheritable(zfs_prop_t prop)
628 return (zfs_prop_table[prop].pd_attr == PROP_INHERIT ||
629 zfs_prop_table[prop].pd_attr == PROP_ONETIME);
635 * Returns a string describing the set of acceptable values for the given
636 * zfs property, or NULL if it cannot be set.
639 zfs_prop_values(zfs_prop_t prop)
641 return (zfs_prop_table[prop].pd_values);
645 * Returns TRUE if this property is a string type. Note that index types
646 * (compression, checksum) are treated as strings in userland, even though they
647 * are stored numerically on disk.
650 zfs_prop_is_string(zfs_prop_t prop)
652 return (zfs_prop_table[prop].pd_proptype == PROP_TYPE_STRING ||
653 zfs_prop_table[prop].pd_proptype == PROP_TYPE_INDEX);
657 * Returns the column header for the given property. Used only in
658 * 'zfs list -o', but centralized here with the other property information.
661 zfs_prop_column_name(zfs_prop_t prop)
663 return (zfs_prop_table[prop].pd_colname);
667 * Returns whether the given property should be displayed right-justified for
671 zfs_prop_align_right(zfs_prop_t prop)
673 return (zfs_prop_table[prop].pd_rightalign);
678 #if defined(_KERNEL) && defined(HAVE_SPL)
680 static int zcommon_init(void) { return 0; }
681 static int zcommon_fini(void) { return 0; }
683 spl_module_init(zcommon_init);
684 spl_module_exit(zcommon_fini);
686 MODULE_DESCRIPTION("Generic ZFS support");
687 MODULE_AUTHOR(ZFS_META_AUTHOR);
688 MODULE_LICENSE(ZFS_META_LICENSE);
689 MODULE_VERSION(ZFS_META_VERSION "-" ZFS_META_RELEASE);
691 /* zfs dataset property functions */
692 EXPORT_SYMBOL(zfs_userquota_prop_prefixes);
693 EXPORT_SYMBOL(zfs_prop_init);
694 EXPORT_SYMBOL(zfs_prop_get_type);
695 EXPORT_SYMBOL(zfs_prop_get_table);
696 EXPORT_SYMBOL(zfs_prop_delegatable);
698 /* Dataset property functions shared between libzfs and kernel. */
699 EXPORT_SYMBOL(zfs_prop_default_string);
700 EXPORT_SYMBOL(zfs_prop_default_numeric);
701 EXPORT_SYMBOL(zfs_prop_readonly);
702 EXPORT_SYMBOL(zfs_prop_inheritable);
703 EXPORT_SYMBOL(zfs_prop_setonce);
704 EXPORT_SYMBOL(zfs_prop_to_name);
705 EXPORT_SYMBOL(zfs_name_to_prop);
706 EXPORT_SYMBOL(zfs_prop_user);
707 EXPORT_SYMBOL(zfs_prop_userquota);
708 EXPORT_SYMBOL(zfs_prop_index_to_string);
709 EXPORT_SYMBOL(zfs_prop_string_to_index);
710 EXPORT_SYMBOL(zfs_prop_valid_for_type);