xref: /onnv-gate/usr/src/common/zfs/zfs_prop.c (revision 12294:2a74b443e6b1)
1789Sahrens /*
2789Sahrens  * CDDL HEADER START
3789Sahrens  *
4789Sahrens  * The contents of this file are subject to the terms of the
51638Slling  * Common Development and Distribution License (the "License").
61638Slling  * You may not use this file except in compliance with the License.
7789Sahrens  *
8789Sahrens  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9789Sahrens  * or http://www.opensolaris.org/os/licensing.
10789Sahrens  * See the License for the specific language governing permissions
11789Sahrens  * and limitations under the License.
12789Sahrens  *
13789Sahrens  * When distributing Covered Code, include this CDDL HEADER in each
14789Sahrens  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15789Sahrens  * If applicable, add the following below this CDDL HEADER, with the
16789Sahrens  * fields enclosed by brackets "[]" replaced with your own identifying
17789Sahrens  * information: Portions Copyright [yyyy] [name of copyright owner]
18789Sahrens  *
19789Sahrens  * CDDL HEADER END
20789Sahrens  */
21789Sahrens /*
2212164SMark.Shellenbaum@Sun.COM  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23789Sahrens  */
24789Sahrens 
25*12294SMark.Musante@Sun.COM /* Portions Copyright 2010 Robert Milkowski */
26*12294SMark.Musante@Sun.COM 
27789Sahrens #include <sys/zio.h>
28789Sahrens #include <sys/spa.h>
295498Stimh #include <sys/u8_textprep.h>
30789Sahrens #include <sys/zfs_acl.h>
31789Sahrens #include <sys/zfs_ioctl.h>
324577Sahrens #include <sys/zfs_znode.h>
33789Sahrens 
34789Sahrens #include "zfs_prop.h"
354543Smarks #include "zfs_deleg.h"
36789Sahrens 
37789Sahrens #if defined(_KERNEL)
38789Sahrens #include <sys/systm.h>
39789Sahrens #else
40789Sahrens #include <stdlib.h>
41789Sahrens #include <string.h>
42789Sahrens #include <ctype.h>
43789Sahrens #endif
44789Sahrens 
455094Slling static zprop_desc_t zfs_prop_table[ZFS_NUM_PROPS];
464787Sahrens 
479396SMatthew.Ahrens@Sun.COM /* Note this is indexed by zfs_userquota_prop_t, keep the order the same */
489396SMatthew.Ahrens@Sun.COM const char *zfs_userquota_prop_prefixes[] = {
499396SMatthew.Ahrens@Sun.COM 	"userused@",
509396SMatthew.Ahrens@Sun.COM 	"userquota@",
519396SMatthew.Ahrens@Sun.COM 	"groupused@",
529396SMatthew.Ahrens@Sun.COM 	"groupquota@"
539396SMatthew.Ahrens@Sun.COM };
549396SMatthew.Ahrens@Sun.COM 
555094Slling zprop_desc_t *
zfs_prop_get_table(void)565094Slling zfs_prop_get_table(void)
574787Sahrens {
585094Slling 	return (zfs_prop_table);
594787Sahrens }
604787Sahrens 
614787Sahrens void
zfs_prop_init(void)624787Sahrens zfs_prop_init(void)
634787Sahrens {
645094Slling 	static zprop_index_t checksum_table[] = {
654787Sahrens 		{ "on",		ZIO_CHECKSUM_ON },
664787Sahrens 		{ "off",	ZIO_CHECKSUM_OFF },
674787Sahrens 		{ "fletcher2",	ZIO_CHECKSUM_FLETCHER_2 },
684787Sahrens 		{ "fletcher4",	ZIO_CHECKSUM_FLETCHER_4 },
694787Sahrens 		{ "sha256",	ZIO_CHECKSUM_SHA256 },
704787Sahrens 		{ NULL }
714787Sahrens 	};
724787Sahrens 
7310922SJeff.Bonwick@Sun.COM 	static zprop_index_t dedup_table[] = {
7410922SJeff.Bonwick@Sun.COM 		{ "on",		ZIO_CHECKSUM_ON },
7510922SJeff.Bonwick@Sun.COM 		{ "off",	ZIO_CHECKSUM_OFF },
7610922SJeff.Bonwick@Sun.COM 		{ "verify",	ZIO_CHECKSUM_ON | ZIO_CHECKSUM_VERIFY },
7710922SJeff.Bonwick@Sun.COM 		{ "sha256",	ZIO_CHECKSUM_SHA256 },
7810922SJeff.Bonwick@Sun.COM 		{ "sha256,verify",
7910922SJeff.Bonwick@Sun.COM 				ZIO_CHECKSUM_SHA256 | ZIO_CHECKSUM_VERIFY },
8010922SJeff.Bonwick@Sun.COM 		{ NULL }
8110922SJeff.Bonwick@Sun.COM 	};
8210922SJeff.Bonwick@Sun.COM 
835094Slling 	static zprop_index_t compress_table[] = {
844787Sahrens 		{ "on",		ZIO_COMPRESS_ON },
854787Sahrens 		{ "off",	ZIO_COMPRESS_OFF },
864787Sahrens 		{ "lzjb",	ZIO_COMPRESS_LZJB },
874787Sahrens 		{ "gzip",	ZIO_COMPRESS_GZIP_6 },	/* gzip default */
884787Sahrens 		{ "gzip-1",	ZIO_COMPRESS_GZIP_1 },
894787Sahrens 		{ "gzip-2",	ZIO_COMPRESS_GZIP_2 },
904787Sahrens 		{ "gzip-3",	ZIO_COMPRESS_GZIP_3 },
914787Sahrens 		{ "gzip-4",	ZIO_COMPRESS_GZIP_4 },
924787Sahrens 		{ "gzip-5",	ZIO_COMPRESS_GZIP_5 },
934787Sahrens 		{ "gzip-6",	ZIO_COMPRESS_GZIP_6 },
944787Sahrens 		{ "gzip-7",	ZIO_COMPRESS_GZIP_7 },
954787Sahrens 		{ "gzip-8",	ZIO_COMPRESS_GZIP_8 },
964787Sahrens 		{ "gzip-9",	ZIO_COMPRESS_GZIP_9 },
9710922SJeff.Bonwick@Sun.COM 		{ "zle",	ZIO_COMPRESS_ZLE },
984787Sahrens 		{ NULL }
994787Sahrens 	};
1004787Sahrens 
1015094Slling 	static zprop_index_t snapdir_table[] = {
1024787Sahrens 		{ "hidden",	ZFS_SNAPDIR_HIDDEN },
1034787Sahrens 		{ "visible",	ZFS_SNAPDIR_VISIBLE },
1044787Sahrens 		{ NULL }
1054787Sahrens 	};
1064787Sahrens 
1075094Slling 	static zprop_index_t acl_inherit_table[] = {
1084787Sahrens 		{ "discard",	ZFS_ACL_DISCARD },
1094787Sahrens 		{ "noallow",	ZFS_ACL_NOALLOW },
1106385Smarks 		{ "restricted",	ZFS_ACL_RESTRICTED },
1114787Sahrens 		{ "passthrough", ZFS_ACL_PASSTHROUGH },
1126385Smarks 		{ "secure",	ZFS_ACL_RESTRICTED }, /* bkwrd compatability */
1138053SMark.Shellenbaum@Sun.COM 		{ "passthrough-x", ZFS_ACL_PASSTHROUGH_X },
1144787Sahrens 		{ NULL }
1154787Sahrens 	};
1164787Sahrens 
1175331Samw 	static zprop_index_t case_table[] = {
1185331Samw 		{ "sensitive",		ZFS_CASE_SENSITIVE },
1195331Samw 		{ "insensitive",	ZFS_CASE_INSENSITIVE },
1205331Samw 		{ "mixed",		ZFS_CASE_MIXED },
1215331Samw 		{ NULL }
1225331Samw 	};
1235331Samw 
1245094Slling 	static zprop_index_t copies_table[] = {
1254787Sahrens 		{ "1",		1 },
1264787Sahrens 		{ "2",		2 },
1274787Sahrens 		{ "3",		3 },
1284787Sahrens 		{ NULL }
1294787Sahrens 	};
1304787Sahrens 
1315498Stimh 	/*
1325498Stimh 	 * Use the unique flags we have to send to u8_strcmp() and/or
1335498Stimh 	 * u8_textprep() to represent the various normalization property
1345498Stimh 	 * values.
1355498Stimh 	 */
1365331Samw 	static zprop_index_t normalize_table[] = {
1375498Stimh 		{ "none",	0 },
1385498Stimh 		{ "formD",	U8_TEXTPREP_NFD },
1395498Stimh 		{ "formKC",	U8_TEXTPREP_NFKC },
1405498Stimh 		{ "formC",	U8_TEXTPREP_NFC },
1415498Stimh 		{ "formKD",	U8_TEXTPREP_NFKD },
1425331Samw 		{ NULL }
1435331Samw 	};
1445331Samw 
1455094Slling 	static zprop_index_t version_table[] = {
1464787Sahrens 		{ "1",		1 },
1474787Sahrens 		{ "2",		2 },
1485331Samw 		{ "3",		3 },
1499396SMatthew.Ahrens@Sun.COM 		{ "4",		4 },
15011935SMark.Shellenbaum@Sun.COM 		{ "5",		5 },
1514787Sahrens 		{ "current",	ZPL_VERSION },
1524787Sahrens 		{ NULL }
1534787Sahrens 	};
1544787Sahrens 
1555094Slling 	static zprop_index_t boolean_table[] = {
1564849Sahrens 		{ "off",	0 },
1574849Sahrens 		{ "on",		1 },
1584849Sahrens 		{ NULL }
1594849Sahrens 	};
1604849Sahrens 
16110310SNeil.Perrin@Sun.COM 	static zprop_index_t logbias_table[] = {
16210310SNeil.Perrin@Sun.COM 		{ "latency",	ZFS_LOGBIAS_LATENCY },
16310310SNeil.Perrin@Sun.COM 		{ "throughput",	ZFS_LOGBIAS_THROUGHPUT },
16410310SNeil.Perrin@Sun.COM 		{ NULL }
16510310SNeil.Perrin@Sun.COM 	};
16610310SNeil.Perrin@Sun.COM 
1676168Shs24103 	static zprop_index_t canmount_table[] = {
1686168Shs24103 		{ "off",	ZFS_CANMOUNT_OFF },
1696168Shs24103 		{ "on",		ZFS_CANMOUNT_ON },
1706168Shs24103 		{ "noauto",	ZFS_CANMOUNT_NOAUTO },
1716168Shs24103 		{ NULL }
1726168Shs24103 	};
1736168Shs24103 
1747237Sek110237 	static zprop_index_t cache_table[] = {
1757237Sek110237 		{ "none",	ZFS_CACHE_NONE },
1767237Sek110237 		{ "metadata",	ZFS_CACHE_METADATA },
1777237Sek110237 		{ "all",	ZFS_CACHE_ALL },
1787237Sek110237 		{ NULL }
1797237Sek110237 	};
1807237Sek110237 
181*12294SMark.Musante@Sun.COM 	static zprop_index_t sync_table[] = {
182*12294SMark.Musante@Sun.COM 		{ "standard",	ZFS_SYNC_STANDARD },
183*12294SMark.Musante@Sun.COM 		{ "always",	ZFS_SYNC_ALWAYS },
184*12294SMark.Musante@Sun.COM 		{ "disabled",	ZFS_SYNC_DISABLED },
185*12294SMark.Musante@Sun.COM 		{ NULL }
186*12294SMark.Musante@Sun.COM 	};
187*12294SMark.Musante@Sun.COM 
1884787Sahrens 	/* inherit index properties */
189*12294SMark.Musante@Sun.COM 	zprop_register_index(ZFS_PROP_SYNC, "sync", ZFS_SYNC_STANDARD,
190*12294SMark.Musante@Sun.COM 	    PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
191*12294SMark.Musante@Sun.COM 	    "standard | always | disabled", "SYNC",
192*12294SMark.Musante@Sun.COM 	    sync_table);
19311976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_CHECKSUM, "checksum",
19411976STom.Erickson@Sun.COM 	    ZIO_CHECKSUM_DEFAULT, PROP_INHERIT, ZFS_TYPE_FILESYSTEM |
19511976STom.Erickson@Sun.COM 	    ZFS_TYPE_VOLUME,
1964787Sahrens 	    "on | off | fletcher2 | fletcher4 | sha256", "CHECKSUM",
1974787Sahrens 	    checksum_table);
19811976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_DEDUP, "dedup", ZIO_CHECKSUM_OFF,
19910922SJeff.Bonwick@Sun.COM 	    PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
20011183SMatthew.Ahrens@Sun.COM 	    "on | off | verify | sha256[,verify]", "DEDUP",
20110922SJeff.Bonwick@Sun.COM 	    dedup_table);
20211976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_COMPRESSION, "compression",
2034849Sahrens 	    ZIO_COMPRESS_DEFAULT, PROP_INHERIT,
2044849Sahrens 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
20510922SJeff.Bonwick@Sun.COM 	    "on | off | lzjb | gzip | gzip-[1-9] | zle", "COMPRESS",
20610922SJeff.Bonwick@Sun.COM 	    compress_table);
20711976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN,
2084849Sahrens 	    PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
2094849Sahrens 	    "hidden | visible", "SNAPDIR", snapdir_table);
21011976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_ACLINHERIT, "aclinherit",
21111976STom.Erickson@Sun.COM 	    ZFS_ACL_RESTRICTED, PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
2128053SMark.Shellenbaum@Sun.COM 	    "discard | noallow | restricted | passthrough | passthrough-x",
2136385Smarks 	    "ACLINHERIT", acl_inherit_table);
21411976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_COPIES, "copies", 1, PROP_INHERIT,
21511976STom.Erickson@Sun.COM 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
2164787Sahrens 	    "1 | 2 | 3", "COPIES", copies_table);
21711976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_PRIMARYCACHE, "primarycache",
2187237Sek110237 	    ZFS_CACHE_ALL, PROP_INHERIT,
2197237Sek110237 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
2207237Sek110237 	    "all | none | metadata", "PRIMARYCACHE", cache_table);
22111976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_SECONDARYCACHE, "secondarycache",
2227237Sek110237 	    ZFS_CACHE_ALL, PROP_INHERIT,
2237237Sek110237 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
2247237Sek110237 	    "all | none | metadata", "SECONDARYCACHE", cache_table);
22511976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_LOGBIAS, "logbias", ZFS_LOGBIAS_LATENCY,
22610310SNeil.Perrin@Sun.COM 	    PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
22710310SNeil.Perrin@Sun.COM 	    "latency | throughput", "LOGBIAS", logbias_table);
2284849Sahrens 
2294849Sahrens 	/* inherit index (boolean) properties */
23011976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT,
2314849Sahrens 	    ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table);
23211976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT,
2334849Sahrens 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES",
2344849Sahrens 	    boolean_table);
23511976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT,
2364849Sahrens 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC",
2374849Sahrens 	    boolean_table);
23811976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT,
2394849Sahrens 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID",
2404849Sahrens 	    boolean_table);
24111976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT,
2424849Sahrens 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY",
2434849Sahrens 	    boolean_table);
24411976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_ZONED, "zoned", 0, PROP_INHERIT,
2454849Sahrens 	    ZFS_TYPE_FILESYSTEM, "on | off", "ZONED", boolean_table);
24611976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_XATTR, "xattr", 1, PROP_INHERIT,
2474849Sahrens 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "XATTR",
2484849Sahrens 	    boolean_table);
24911976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT,
2505331Samw 	    ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN",
2515331Samw 	    boolean_table);
25211976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT,
2535331Samw 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND",
2545331Samw 	    boolean_table);
2554849Sahrens 
2564849Sahrens 	/* default index properties */
25711976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT,
2582597Snd150628 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
2599396SMatthew.Ahrens@Sun.COM 	    "1 | 2 | 3 | 4 | current", "VERSION", version_table);
26011976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON,
2616168Shs24103 	    PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto",
2626168Shs24103 	    "CANMOUNT", canmount_table);
2634849Sahrens 
2644849Sahrens 	/* readonly index (boolean) properties */
26511976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY,
2665094Slling 	    ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table);
26711976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_DEFER_DESTROY, "defer_destroy", 0,
26810242Schris.kirby@sun.com 	    PROP_READONLY, ZFS_TYPE_SNAPSHOT, "yes | no", "DEFER_DESTROY",
26910242Schris.kirby@sun.com 	    boolean_table);
2704849Sahrens 
2715331Samw 	/* set once index properties */
27211976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_NORMALIZE, "normalization", 0,
2735331Samw 	    PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
2745331Samw 	    "none | formC | formD | formKC | formKD", "NORMALIZATION",
2755331Samw 	    normalize_table);
27611976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_CASE, "casesensitivity",
27711976STom.Erickson@Sun.COM 	    ZFS_CASE_SENSITIVE, PROP_ONETIME, ZFS_TYPE_FILESYSTEM |
27811976STom.Erickson@Sun.COM 	    ZFS_TYPE_SNAPSHOT,
2795331Samw 	    "sensitive | insensitive | mixed", "CASE", case_table);
2805331Samw 
2815331Samw 	/* set once index (boolean) properties */
28211976STom.Erickson@Sun.COM 	zprop_register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME,
2835331Samw 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
2845331Samw 	    "on | off", "UTF8ONLY", boolean_table);
2855331Samw 
2864787Sahrens 	/* string properties */
28711976STom.Erickson@Sun.COM 	zprop_register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY,
2884787Sahrens 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN");
28911976STom.Erickson@Sun.COM 	zprop_register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/",
29011976STom.Erickson@Sun.COM 	    PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "<path> | legacy | none",
29111976STom.Erickson@Sun.COM 	    "MOUNTPOINT");
29211976STom.Erickson@Sun.COM 	zprop_register_string(ZFS_PROP_SHARENFS, "sharenfs", "off",
29311976STom.Erickson@Sun.COM 	    PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "on | off | share(1M) options",
29411976STom.Erickson@Sun.COM 	    "SHARENFS");
29511976STom.Erickson@Sun.COM 	zprop_register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY,
2965094Slling 	    ZFS_TYPE_DATASET, "filesystem | volume | snapshot", "TYPE");
29711976STom.Erickson@Sun.COM 	zprop_register_string(ZFS_PROP_SHARESMB, "sharesmb", "off",
29811976STom.Erickson@Sun.COM 	    PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
29911976STom.Erickson@Sun.COM 	    "on | off | sharemgr(1M) options", "SHARESMB");
30011976STom.Erickson@Sun.COM 	zprop_register_string(ZFS_PROP_MLSLABEL, "mlslabel",
30111976STom.Erickson@Sun.COM 	    ZFS_MLSLABEL_DEFAULT, PROP_INHERIT, ZFS_TYPE_DATASET,
30211976STom.Erickson@Sun.COM 	    "<sensitivity label>", "MLSLABEL");
3034787Sahrens 
3044787Sahrens 	/* readonly number properties */
30511976STom.Erickson@Sun.COM 	zprop_register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY,
3065094Slling 	    ZFS_TYPE_DATASET, "<size>", "USED");
30711976STom.Erickson@Sun.COM 	zprop_register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY,
3085094Slling 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL");
30911976STom.Erickson@Sun.COM 	zprop_register_number(ZFS_PROP_REFERENCED, "referenced", 0,
31011976STom.Erickson@Sun.COM 	    PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "REFER");
31111976STom.Erickson@Sun.COM 	zprop_register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0,
3125094Slling 	    PROP_READONLY, ZFS_TYPE_DATASET,
3134787Sahrens 	    "<1.00x or higher if compressed>", "RATIO");
31411976STom.Erickson@Sun.COM 	zprop_register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize",
31511449SEric.Taylor@Sun.COM 	    ZVOL_DEFAULT_BLOCKSIZE, PROP_ONETIME,
3165331Samw 	    ZFS_TYPE_VOLUME, "512 to 128k, power of 2",	"VOLBLOCK");
31711976STom.Erickson@Sun.COM 	zprop_register_number(ZFS_PROP_USEDSNAP, "usedbysnapshots", 0,
31811976STom.Erickson@Sun.COM 	    PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
31911976STom.Erickson@Sun.COM 	    "USEDSNAP");
32011976STom.Erickson@Sun.COM 	zprop_register_number(ZFS_PROP_USEDDS, "usedbydataset", 0,
32111976STom.Erickson@Sun.COM 	    PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
32211976STom.Erickson@Sun.COM 	    "USEDDS");
32311976STom.Erickson@Sun.COM 	zprop_register_number(ZFS_PROP_USEDCHILD, "usedbychildren", 0,
32411976STom.Erickson@Sun.COM 	    PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
32511976STom.Erickson@Sun.COM 	    "USEDCHILD");
32611976STom.Erickson@Sun.COM 	zprop_register_number(ZFS_PROP_USEDREFRESERV, "usedbyrefreservation", 0,
3277390SMatthew.Ahrens@Sun.COM 	    PROP_READONLY,
3287390SMatthew.Ahrens@Sun.COM 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDREFRESERV");
32911976STom.Erickson@Sun.COM 	zprop_register_number(ZFS_PROP_USERREFS, "userrefs", 0, PROP_READONLY,
33010242Schris.kirby@sun.com 	    ZFS_TYPE_SNAPSHOT, "<count>", "USERREFS");
3314787Sahrens 
3324787Sahrens 	/* default number properties */
33311976STom.Erickson@Sun.COM 	zprop_register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT,
3344787Sahrens 	    ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA");
33511976STom.Erickson@Sun.COM 	zprop_register_number(ZFS_PROP_RESERVATION, "reservation", 0,
33611976STom.Erickson@Sun.COM 	    PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
33711976STom.Erickson@Sun.COM 	    "<size> | none", "RESERV");
33811976STom.Erickson@Sun.COM 	zprop_register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT,
3394787Sahrens 	    ZFS_TYPE_VOLUME, "<size>", "VOLSIZE");
34011976STom.Erickson@Sun.COM 	zprop_register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT,
3415378Sck153898 	    ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA");
34211976STom.Erickson@Sun.COM 	zprop_register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0,
3435378Sck153898 	    PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
3445378Sck153898 	    "<size> | none", "REFRESERV");
3454787Sahrens 
3464787Sahrens 	/* inherit number properties */
34711976STom.Erickson@Sun.COM 	zprop_register_number(ZFS_PROP_RECORDSIZE, "recordsize",
34811976STom.Erickson@Sun.COM 	    SPA_MAXBLOCKSIZE, PROP_INHERIT,
3494787Sahrens 	    ZFS_TYPE_FILESYSTEM, "512 to 128k, power of 2", "RECSIZE");
3504787Sahrens 
3514787Sahrens 	/* hidden properties */
35211976STom.Erickson@Sun.COM 	zprop_register_hidden(ZFS_PROP_CREATETXG, "createtxg", PROP_TYPE_NUMBER,
35310922SJeff.Bonwick@Sun.COM 	    PROP_READONLY, ZFS_TYPE_DATASET, "CREATETXG");
35411976STom.Erickson@Sun.COM 	zprop_register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER,
35510922SJeff.Bonwick@Sun.COM 	    PROP_READONLY, ZFS_TYPE_SNAPSHOT, "NUMCLONES");
35611976STom.Erickson@Sun.COM 	zprop_register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING,
3575094Slling 	    PROP_READONLY, ZFS_TYPE_DATASET, "NAME");
35811976STom.Erickson@Sun.COM 	zprop_register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions",
35911976STom.Erickson@Sun.COM 	    PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS");
36011976STom.Erickson@Sun.COM 	zprop_register_hidden(ZFS_PROP_STMF_SHAREINFO, "stmf_sbd_lu",
3619643SEric.Taylor@Sun.COM 	    PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME,
3629643SEric.Taylor@Sun.COM 	    "STMF_SBD_LU");
36311976STom.Erickson@Sun.COM 	zprop_register_hidden(ZFS_PROP_GUID, "guid", PROP_TYPE_NUMBER,
36411976STom.Erickson@Sun.COM 	    PROP_READONLY, ZFS_TYPE_DATASET, "GUID");
36511976STom.Erickson@Sun.COM 	zprop_register_hidden(ZFS_PROP_USERACCOUNTING, "useraccounting",
36610922SJeff.Bonwick@Sun.COM 	    PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET,
36710922SJeff.Bonwick@Sun.COM 	    "USERACCOUNTING");
36811976STom.Erickson@Sun.COM 	zprop_register_hidden(ZFS_PROP_UNIQUE, "unique", PROP_TYPE_NUMBER,
36910922SJeff.Bonwick@Sun.COM 	    PROP_READONLY, ZFS_TYPE_DATASET, "UNIQUE");
37011976STom.Erickson@Sun.COM 	zprop_register_hidden(ZFS_PROP_OBJSETID, "objsetid", PROP_TYPE_NUMBER,
37110575SEric.Schrock@Sun.COM 	    PROP_READONLY, ZFS_TYPE_DATASET, "OBJSETID");
3724787Sahrens 
37312164SMark.Shellenbaum@Sun.COM 	/*
37412164SMark.Shellenbaum@Sun.COM 	 * Property to be removed once libbe is integrated
37512164SMark.Shellenbaum@Sun.COM 	 */
37612164SMark.Shellenbaum@Sun.COM 	zprop_register_hidden(ZFS_PROP_PRIVATE, "priv_prop",
37712164SMark.Shellenbaum@Sun.COM 	    PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_FILESYSTEM,
37812164SMark.Shellenbaum@Sun.COM 	    "PRIV_PROP");
37912164SMark.Shellenbaum@Sun.COM 
3804787Sahrens 	/* oddball properties */
38111976STom.Erickson@Sun.COM 	zprop_register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0,
38211976STom.Erickson@Sun.COM 	    NULL, PROP_READONLY, ZFS_TYPE_DATASET,
3834787Sahrens 	    "<date>", "CREATION", B_FALSE, B_TRUE, NULL);
3844787Sahrens }
3854787Sahrens 
3863912Slling boolean_t
zfs_prop_delegatable(zfs_prop_t prop)3875094Slling zfs_prop_delegatable(zfs_prop_t prop)
3883912Slling {
3895094Slling 	zprop_desc_t *pd = &zfs_prop_table[prop];
39010972SRic.Aleshire@Sun.COM 
39110972SRic.Aleshire@Sun.COM 	/* The mlslabel property is never delegatable. */
39210972SRic.Aleshire@Sun.COM 	if (prop == ZFS_PROP_MLSLABEL)
39310972SRic.Aleshire@Sun.COM 		return (B_FALSE);
39410972SRic.Aleshire@Sun.COM 
3955094Slling 	return (pd->pd_attr != PROP_READONLY);
3963912Slling }
3973912Slling 
3983912Slling /*
3993912Slling  * Given a zfs dataset property name, returns the corresponding property ID.
400789Sahrens  */
401789Sahrens zfs_prop_t
zfs_name_to_prop(const char * propname)402789Sahrens zfs_name_to_prop(const char *propname)
403789Sahrens {
4045094Slling 	return (zprop_name_to_prop(propname, ZFS_TYPE_DATASET));
4053912Slling }
406789Sahrens 
407789Sahrens /*
4082676Seschrock  * For user property names, we allow all lowercase alphanumeric characters, plus
4092676Seschrock  * a few useful punctuation characters.
4102676Seschrock  */
4112676Seschrock static int
valid_char(char c)4122676Seschrock valid_char(char c)
4132676Seschrock {
4142676Seschrock 	return ((c >= 'a' && c <= 'z') ||
4152676Seschrock 	    (c >= '0' && c <= '9') ||
4162676Seschrock 	    c == '-' || c == '_' || c == '.' || c == ':');
4172676Seschrock }
4182676Seschrock 
4192676Seschrock /*
4202676Seschrock  * Returns true if this is a valid user-defined property (one with a ':').
4212676Seschrock  */
4222676Seschrock boolean_t
zfs_prop_user(const char * name)4232676Seschrock zfs_prop_user(const char *name)
4242676Seschrock {
4252676Seschrock 	int i;
4262676Seschrock 	char c;
4272676Seschrock 	boolean_t foundsep = B_FALSE;
4282676Seschrock 
4292676Seschrock 	for (i = 0; i < strlen(name); i++) {
4302676Seschrock 		c = name[i];
4312676Seschrock 		if (!valid_char(c))
4322676Seschrock 			return (B_FALSE);
4332676Seschrock 		if (c == ':')
4342676Seschrock 			foundsep = B_TRUE;
4352676Seschrock 	}
4362676Seschrock 
4372676Seschrock 	if (!foundsep)
4382676Seschrock 		return (B_FALSE);
4392676Seschrock 
4402676Seschrock 	return (B_TRUE);
4412676Seschrock }
4422676Seschrock 
4432676Seschrock /*
4449396SMatthew.Ahrens@Sun.COM  * Returns true if this is a valid userspace-type property (one with a '@').
4459396SMatthew.Ahrens@Sun.COM  * Note that after the @, any character is valid (eg, another @, for SID
4469396SMatthew.Ahrens@Sun.COM  * user@domain).
4479396SMatthew.Ahrens@Sun.COM  */
4489396SMatthew.Ahrens@Sun.COM boolean_t
zfs_prop_userquota(const char * name)4499396SMatthew.Ahrens@Sun.COM zfs_prop_userquota(const char *name)
4509396SMatthew.Ahrens@Sun.COM {
4519396SMatthew.Ahrens@Sun.COM 	zfs_userquota_prop_t prop;
4529396SMatthew.Ahrens@Sun.COM 
4539396SMatthew.Ahrens@Sun.COM 	for (prop = 0; prop < ZFS_NUM_USERQUOTA_PROPS; prop++) {
4549396SMatthew.Ahrens@Sun.COM 		if (strncmp(name, zfs_userquota_prop_prefixes[prop],
4559396SMatthew.Ahrens@Sun.COM 		    strlen(zfs_userquota_prop_prefixes[prop])) == 0) {
4569396SMatthew.Ahrens@Sun.COM 			return (B_TRUE);
4579396SMatthew.Ahrens@Sun.COM 		}
4589396SMatthew.Ahrens@Sun.COM 	}
4599396SMatthew.Ahrens@Sun.COM 
4609396SMatthew.Ahrens@Sun.COM 	return (B_FALSE);
4619396SMatthew.Ahrens@Sun.COM }
4629396SMatthew.Ahrens@Sun.COM 
4639396SMatthew.Ahrens@Sun.COM /*
4645094Slling  * Tables of index types, plus functions to convert between the user view
4655094Slling  * (strings) and internal representation (uint64_t).
4665094Slling  */
4675094Slling int
zfs_prop_string_to_index(zfs_prop_t prop,const char * string,uint64_t * index)4685094Slling zfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index)
4695094Slling {
4705094Slling 	return (zprop_string_to_index(prop, string, index, ZFS_TYPE_DATASET));
4715094Slling }
4725094Slling 
4735094Slling int
zfs_prop_index_to_string(zfs_prop_t prop,uint64_t index,const char ** string)4745094Slling zfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string)
4755094Slling {
4765094Slling 	return (zprop_index_to_string(prop, index, string, ZFS_TYPE_DATASET));
4775094Slling }
4785094Slling 
47910922SJeff.Bonwick@Sun.COM uint64_t
zfs_prop_random_value(zfs_prop_t prop,uint64_t seed)48010922SJeff.Bonwick@Sun.COM zfs_prop_random_value(zfs_prop_t prop, uint64_t seed)
48110922SJeff.Bonwick@Sun.COM {
48210922SJeff.Bonwick@Sun.COM 	return (zprop_random_value(prop, seed, ZFS_TYPE_DATASET));
48310922SJeff.Bonwick@Sun.COM }
48410922SJeff.Bonwick@Sun.COM 
4855094Slling /*
4865094Slling  * Returns TRUE if the property applies to any of the given dataset types.
487789Sahrens  */
4886690Sgw25295 boolean_t
zfs_prop_valid_for_type(int prop,zfs_type_t types)4895094Slling zfs_prop_valid_for_type(int prop, zfs_type_t types)
4905094Slling {
4915094Slling 	return (zprop_valid_for_type(prop, types));
4925094Slling }
4935094Slling 
4945094Slling zprop_type_t
zfs_prop_get_type(zfs_prop_t prop)4955094Slling zfs_prop_get_type(zfs_prop_t prop)
496789Sahrens {
4975094Slling 	return (zfs_prop_table[prop].pd_proptype);
4985094Slling }
4995094Slling 
5005094Slling /*
5015094Slling  * Returns TRUE if the property is readonly.
5025094Slling  */
5035094Slling boolean_t
zfs_prop_readonly(zfs_prop_t prop)5045094Slling zfs_prop_readonly(zfs_prop_t prop)
5055094Slling {
5065331Samw 	return (zfs_prop_table[prop].pd_attr == PROP_READONLY ||
5075331Samw 	    zfs_prop_table[prop].pd_attr == PROP_ONETIME);
5085331Samw }
5095331Samw 
5105331Samw /*
5115331Samw  * Returns TRUE if the property is only allowed to be set once.
5125331Samw  */
5135331Samw boolean_t
zfs_prop_setonce(zfs_prop_t prop)5145331Samw zfs_prop_setonce(zfs_prop_t prop)
5155331Samw {
5165331Samw 	return (zfs_prop_table[prop].pd_attr == PROP_ONETIME);
517789Sahrens }
518789Sahrens 
5194451Seschrock const char *
zfs_prop_default_string(zfs_prop_t prop)5205094Slling zfs_prop_default_string(zfs_prop_t prop)
5214451Seschrock {
5224451Seschrock 	return (zfs_prop_table[prop].pd_strdefault);
5234451Seschrock }
5244451Seschrock 
525789Sahrens uint64_t
zfs_prop_default_numeric(zfs_prop_t prop)526789Sahrens zfs_prop_default_numeric(zfs_prop_t prop)
527789Sahrens {
528789Sahrens 	return (zfs_prop_table[prop].pd_numdefault);
529789Sahrens }
530789Sahrens 
531789Sahrens /*
5323912Slling  * Given a dataset property ID, returns the corresponding name.
5334451Seschrock  * Assuming the zfs dataset property ID is valid.
534789Sahrens  */
535789Sahrens const char *
zfs_prop_to_name(zfs_prop_t prop)536789Sahrens zfs_prop_to_name(zfs_prop_t prop)
537789Sahrens {
538789Sahrens 	return (zfs_prop_table[prop].pd_name);
539789Sahrens }
540789Sahrens 
541789Sahrens /*
542789Sahrens  * Returns TRUE if the property is inheritable.
543789Sahrens  */
5445094Slling boolean_t
zfs_prop_inheritable(zfs_prop_t prop)545789Sahrens zfs_prop_inheritable(zfs_prop_t prop)
546789Sahrens {
5475331Samw 	return (zfs_prop_table[prop].pd_attr == PROP_INHERIT ||
5485331Samw 	    zfs_prop_table[prop].pd_attr == PROP_ONETIME);
5492676Seschrock }
5502676Seschrock 
5512717Seschrock #ifndef _KERNEL
5522717Seschrock 
553789Sahrens /*
5543912Slling  * Returns a string describing the set of acceptable values for the given
5553912Slling  * zfs property, or NULL if it cannot be set.
556789Sahrens  */
5573912Slling const char *
zfs_prop_values(zfs_prop_t prop)5583912Slling zfs_prop_values(zfs_prop_t prop)
559789Sahrens {
560789Sahrens 	return (zfs_prop_table[prop].pd_values);
561789Sahrens }
562789Sahrens 
563789Sahrens /*
564789Sahrens  * Returns TRUE if this property is a string type.  Note that index types
565789Sahrens  * (compression, checksum) are treated as strings in userland, even though they
566789Sahrens  * are stored numerically on disk.
567789Sahrens  */
568789Sahrens int
zfs_prop_is_string(zfs_prop_t prop)569789Sahrens zfs_prop_is_string(zfs_prop_t prop)
570789Sahrens {
5714787Sahrens 	return (zfs_prop_table[prop].pd_proptype == PROP_TYPE_STRING ||
5724787Sahrens 	    zfs_prop_table[prop].pd_proptype == PROP_TYPE_INDEX);
573789Sahrens }
574789Sahrens 
575789Sahrens /*
576789Sahrens  * Returns the column header for the given property.  Used only in
577789Sahrens  * 'zfs list -o', but centralized here with the other property information.
578789Sahrens  */
579789Sahrens const char *
zfs_prop_column_name(zfs_prop_t prop)580789Sahrens zfs_prop_column_name(zfs_prop_t prop)
581789Sahrens {
582789Sahrens 	return (zfs_prop_table[prop].pd_colname);
583789Sahrens }
584789Sahrens 
585789Sahrens /*
5862676Seschrock  * Returns whether the given property should be displayed right-justified for
5872676Seschrock  * 'zfs list'.
588789Sahrens  */
5892676Seschrock boolean_t
zfs_prop_align_right(zfs_prop_t prop)5902676Seschrock zfs_prop_align_right(zfs_prop_t prop)
591789Sahrens {
5922676Seschrock 	return (zfs_prop_table[prop].pd_rightalign);
593789Sahrens }
5945331Samw 
595789Sahrens #endif
596