xref: /titanic_51/usr/src/common/zfs/zfs_prop.c (revision a3c49ce110f325a563c245bedc4d533adddb7211)
1fa9e4066Sahrens /*
2fa9e4066Sahrens  * CDDL HEADER START
3fa9e4066Sahrens  *
4fa9e4066Sahrens  * The contents of this file are subject to the terms of the
5906d120cSlling  * Common Development and Distribution License (the "License").
6906d120cSlling  * You may not use this file except in compliance with the License.
7fa9e4066Sahrens  *
8fa9e4066Sahrens  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9fa9e4066Sahrens  * or http://www.opensolaris.org/os/licensing.
10fa9e4066Sahrens  * See the License for the specific language governing permissions
11fa9e4066Sahrens  * and limitations under the License.
12fa9e4066Sahrens  *
13fa9e4066Sahrens  * When distributing Covered Code, include this CDDL HEADER in each
14fa9e4066Sahrens  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15fa9e4066Sahrens  * If applicable, add the following below this CDDL HEADER, with the
16fa9e4066Sahrens  * fields enclosed by brackets "[]" replaced with your own identifying
17fa9e4066Sahrens  * information: Portions Copyright [yyyy] [name of copyright owner]
18fa9e4066Sahrens  *
19fa9e4066Sahrens  * CDDL HEADER END
20fa9e4066Sahrens  */
21fa9e4066Sahrens /*
2227dd1e87SMark Shellenbaum  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23fa9e4066Sahrens  */
24fa9e4066Sahrens 
2555da60b9SMark J Musante /* Portions Copyright 2010 Robert Milkowski */
2655da60b9SMark J Musante 
27fa9e4066Sahrens #include <sys/zio.h>
28fa9e4066Sahrens #include <sys/spa.h>
29de8267e0Stimh #include <sys/u8_textprep.h>
30fa9e4066Sahrens #include <sys/zfs_acl.h>
31fa9e4066Sahrens #include <sys/zfs_ioctl.h>
32e7437265Sahrens #include <sys/zfs_znode.h>
33fa9e4066Sahrens 
34fa9e4066Sahrens #include "zfs_prop.h"
35ecd6cf80Smarks #include "zfs_deleg.h"
36fa9e4066Sahrens 
37fa9e4066Sahrens #if defined(_KERNEL)
38fa9e4066Sahrens #include <sys/systm.h>
39fa9e4066Sahrens #else
40fa9e4066Sahrens #include <stdlib.h>
41fa9e4066Sahrens #include <string.h>
42fa9e4066Sahrens #include <ctype.h>
43fa9e4066Sahrens #endif
44fa9e4066Sahrens 
45990b4856Slling static zprop_desc_t zfs_prop_table[ZFS_NUM_PROPS];
46fa9e4066Sahrens 
4714843421SMatthew Ahrens /* Note this is indexed by zfs_userquota_prop_t, keep the order the same */
4814843421SMatthew Ahrens const char *zfs_userquota_prop_prefixes[] = {
4914843421SMatthew Ahrens 	"userused@",
5014843421SMatthew Ahrens 	"userquota@",
5114843421SMatthew Ahrens 	"groupused@",
5214843421SMatthew Ahrens 	"groupquota@"
5314843421SMatthew Ahrens };
5414843421SMatthew Ahrens 
55990b4856Slling zprop_desc_t *
56990b4856Slling zfs_prop_get_table(void)
5791ebeef5Sahrens {
58990b4856Slling 	return (zfs_prop_table);
5991ebeef5Sahrens }
6091ebeef5Sahrens 
6191ebeef5Sahrens void
6291ebeef5Sahrens zfs_prop_init(void)
6391ebeef5Sahrens {
64990b4856Slling 	static zprop_index_t checksum_table[] = {
6591ebeef5Sahrens 		{ "on",		ZIO_CHECKSUM_ON },
6691ebeef5Sahrens 		{ "off",	ZIO_CHECKSUM_OFF },
6791ebeef5Sahrens 		{ "fletcher2",	ZIO_CHECKSUM_FLETCHER_2 },
6891ebeef5Sahrens 		{ "fletcher4",	ZIO_CHECKSUM_FLETCHER_4 },
6991ebeef5Sahrens 		{ "sha256",	ZIO_CHECKSUM_SHA256 },
7091ebeef5Sahrens 		{ NULL }
71fa9e4066Sahrens 	};
72fa9e4066Sahrens 
73b24ab676SJeff Bonwick 	static zprop_index_t dedup_table[] = {
74b24ab676SJeff Bonwick 		{ "on",		ZIO_CHECKSUM_ON },
75b24ab676SJeff Bonwick 		{ "off",	ZIO_CHECKSUM_OFF },
76b24ab676SJeff Bonwick 		{ "verify",	ZIO_CHECKSUM_ON | ZIO_CHECKSUM_VERIFY },
77b24ab676SJeff Bonwick 		{ "sha256",	ZIO_CHECKSUM_SHA256 },
78b24ab676SJeff Bonwick 		{ "sha256,verify",
79b24ab676SJeff Bonwick 				ZIO_CHECKSUM_SHA256 | ZIO_CHECKSUM_VERIFY },
80b24ab676SJeff Bonwick 		{ NULL }
81b24ab676SJeff Bonwick 	};
82b24ab676SJeff Bonwick 
83990b4856Slling 	static zprop_index_t compress_table[] = {
8491ebeef5Sahrens 		{ "on",		ZIO_COMPRESS_ON },
8591ebeef5Sahrens 		{ "off",	ZIO_COMPRESS_OFF },
8691ebeef5Sahrens 		{ "lzjb",	ZIO_COMPRESS_LZJB },
8791ebeef5Sahrens 		{ "gzip",	ZIO_COMPRESS_GZIP_6 },	/* gzip default */
8891ebeef5Sahrens 		{ "gzip-1",	ZIO_COMPRESS_GZIP_1 },
8991ebeef5Sahrens 		{ "gzip-2",	ZIO_COMPRESS_GZIP_2 },
9091ebeef5Sahrens 		{ "gzip-3",	ZIO_COMPRESS_GZIP_3 },
9191ebeef5Sahrens 		{ "gzip-4",	ZIO_COMPRESS_GZIP_4 },
9291ebeef5Sahrens 		{ "gzip-5",	ZIO_COMPRESS_GZIP_5 },
9391ebeef5Sahrens 		{ "gzip-6",	ZIO_COMPRESS_GZIP_6 },
9491ebeef5Sahrens 		{ "gzip-7",	ZIO_COMPRESS_GZIP_7 },
9591ebeef5Sahrens 		{ "gzip-8",	ZIO_COMPRESS_GZIP_8 },
9691ebeef5Sahrens 		{ "gzip-9",	ZIO_COMPRESS_GZIP_9 },
97b24ab676SJeff Bonwick 		{ "zle",	ZIO_COMPRESS_ZLE },
9891ebeef5Sahrens 		{ NULL }
9991ebeef5Sahrens 	};
10091ebeef5Sahrens 
101990b4856Slling 	static zprop_index_t snapdir_table[] = {
10291ebeef5Sahrens 		{ "hidden",	ZFS_SNAPDIR_HIDDEN },
10391ebeef5Sahrens 		{ "visible",	ZFS_SNAPDIR_VISIBLE },
10491ebeef5Sahrens 		{ NULL }
10591ebeef5Sahrens 	};
10691ebeef5Sahrens 
107*a3c49ce1SAlbert Lee 	static zprop_index_t acl_mode_table[] = {
108*a3c49ce1SAlbert Lee 		{ "discard",	ZFS_ACL_DISCARD },
109*a3c49ce1SAlbert Lee 		{ "groupmask",	ZFS_ACL_GROUPMASK },
110*a3c49ce1SAlbert Lee 		{ "passthrough", ZFS_ACL_PASSTHROUGH },
111*a3c49ce1SAlbert Lee 		{ NULL }
112*a3c49ce1SAlbert Lee 	};
113*a3c49ce1SAlbert Lee 
114990b4856Slling 	static zprop_index_t acl_inherit_table[] = {
11591ebeef5Sahrens 		{ "discard",	ZFS_ACL_DISCARD },
11691ebeef5Sahrens 		{ "noallow",	ZFS_ACL_NOALLOW },
117b3d141f8Smarks 		{ "restricted",	ZFS_ACL_RESTRICTED },
11891ebeef5Sahrens 		{ "passthrough", ZFS_ACL_PASSTHROUGH },
119b3d141f8Smarks 		{ "secure",	ZFS_ACL_RESTRICTED }, /* bkwrd compatability */
120d0f3f37eSMark Shellenbaum 		{ "passthrough-x", ZFS_ACL_PASSTHROUGH_X },
12191ebeef5Sahrens 		{ NULL }
12291ebeef5Sahrens 	};
12391ebeef5Sahrens 
124da6c28aaSamw 	static zprop_index_t case_table[] = {
125da6c28aaSamw 		{ "sensitive",		ZFS_CASE_SENSITIVE },
126da6c28aaSamw 		{ "insensitive",	ZFS_CASE_INSENSITIVE },
127da6c28aaSamw 		{ "mixed",		ZFS_CASE_MIXED },
128da6c28aaSamw 		{ NULL }
129da6c28aaSamw 	};
130da6c28aaSamw 
131990b4856Slling 	static zprop_index_t copies_table[] = {
13291ebeef5Sahrens 		{ "1",		1 },
13391ebeef5Sahrens 		{ "2",		2 },
13491ebeef5Sahrens 		{ "3",		3 },
13591ebeef5Sahrens 		{ NULL }
13691ebeef5Sahrens 	};
13791ebeef5Sahrens 
138de8267e0Stimh 	/*
139de8267e0Stimh 	 * Use the unique flags we have to send to u8_strcmp() and/or
140de8267e0Stimh 	 * u8_textprep() to represent the various normalization property
141de8267e0Stimh 	 * values.
142de8267e0Stimh 	 */
143da6c28aaSamw 	static zprop_index_t normalize_table[] = {
144de8267e0Stimh 		{ "none",	0 },
145de8267e0Stimh 		{ "formD",	U8_TEXTPREP_NFD },
146de8267e0Stimh 		{ "formKC",	U8_TEXTPREP_NFKC },
147de8267e0Stimh 		{ "formC",	U8_TEXTPREP_NFC },
148de8267e0Stimh 		{ "formKD",	U8_TEXTPREP_NFKD },
149da6c28aaSamw 		{ NULL }
150da6c28aaSamw 	};
151da6c28aaSamw 
152990b4856Slling 	static zprop_index_t version_table[] = {
15391ebeef5Sahrens 		{ "1",		1 },
15491ebeef5Sahrens 		{ "2",		2 },
155da6c28aaSamw 		{ "3",		3 },
15614843421SMatthew Ahrens 		{ "4",		4 },
1570a586ceaSMark Shellenbaum 		{ "5",		5 },
15891ebeef5Sahrens 		{ "current",	ZPL_VERSION },
15991ebeef5Sahrens 		{ NULL }
16091ebeef5Sahrens 	};
16191ebeef5Sahrens 
162990b4856Slling 	static zprop_index_t boolean_table[] = {
163e45ce728Sahrens 		{ "off",	0 },
164e45ce728Sahrens 		{ "on",		1 },
165e45ce728Sahrens 		{ NULL }
166e45ce728Sahrens 	};
167e45ce728Sahrens 
168e09fa4daSNeil Perrin 	static zprop_index_t logbias_table[] = {
169e09fa4daSNeil Perrin 		{ "latency",	ZFS_LOGBIAS_LATENCY },
170e09fa4daSNeil Perrin 		{ "throughput",	ZFS_LOGBIAS_THROUGHPUT },
171e09fa4daSNeil Perrin 		{ NULL }
172e09fa4daSNeil Perrin 	};
173e09fa4daSNeil Perrin 
174a227b7f4Shs24103 	static zprop_index_t canmount_table[] = {
175a227b7f4Shs24103 		{ "off",	ZFS_CANMOUNT_OFF },
176a227b7f4Shs24103 		{ "on",		ZFS_CANMOUNT_ON },
177a227b7f4Shs24103 		{ "noauto",	ZFS_CANMOUNT_NOAUTO },
178a227b7f4Shs24103 		{ NULL }
179a227b7f4Shs24103 	};
180a227b7f4Shs24103 
1813baa08fcSek110237 	static zprop_index_t cache_table[] = {
1823baa08fcSek110237 		{ "none",	ZFS_CACHE_NONE },
1833baa08fcSek110237 		{ "metadata",	ZFS_CACHE_METADATA },
1843baa08fcSek110237 		{ "all",	ZFS_CACHE_ALL },
1853baa08fcSek110237 		{ NULL }
1863baa08fcSek110237 	};
1873baa08fcSek110237 
18855da60b9SMark J Musante 	static zprop_index_t sync_table[] = {
18955da60b9SMark J Musante 		{ "standard",	ZFS_SYNC_STANDARD },
19055da60b9SMark J Musante 		{ "always",	ZFS_SYNC_ALWAYS },
19155da60b9SMark J Musante 		{ "disabled",	ZFS_SYNC_DISABLED },
19255da60b9SMark J Musante 		{ NULL }
19355da60b9SMark J Musante 	};
19455da60b9SMark J Musante 
19591ebeef5Sahrens 	/* inherit index properties */
19655da60b9SMark J Musante 	zprop_register_index(ZFS_PROP_SYNC, "sync", ZFS_SYNC_STANDARD,
19755da60b9SMark J Musante 	    PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
19855da60b9SMark J Musante 	    "standard | always | disabled", "SYNC",
19955da60b9SMark J Musante 	    sync_table);
20083d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_CHECKSUM, "checksum",
20183d7f9feSTom Erickson 	    ZIO_CHECKSUM_DEFAULT, PROP_INHERIT, ZFS_TYPE_FILESYSTEM |
20283d7f9feSTom Erickson 	    ZFS_TYPE_VOLUME,
20391ebeef5Sahrens 	    "on | off | fletcher2 | fletcher4 | sha256", "CHECKSUM",
20491ebeef5Sahrens 	    checksum_table);
20583d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_DEDUP, "dedup", ZIO_CHECKSUM_OFF,
206b24ab676SJeff Bonwick 	    PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
207b1033ae2SMatthew Ahrens 	    "on | off | verify | sha256[,verify]", "DEDUP",
208b24ab676SJeff Bonwick 	    dedup_table);
20983d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_COMPRESSION, "compression",
210e45ce728Sahrens 	    ZIO_COMPRESS_DEFAULT, PROP_INHERIT,
211e45ce728Sahrens 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
212b24ab676SJeff Bonwick 	    "on | off | lzjb | gzip | gzip-[1-9] | zle", "COMPRESS",
213b24ab676SJeff Bonwick 	    compress_table);
21483d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN,
215e45ce728Sahrens 	    PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
216e45ce728Sahrens 	    "hidden | visible", "SNAPDIR", snapdir_table);
217*a3c49ce1SAlbert Lee 	zprop_register_index(ZFS_PROP_ACLMODE, "aclmode", ZFS_ACL_DISCARD,
218*a3c49ce1SAlbert Lee 	    PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
219*a3c49ce1SAlbert Lee 	    "discard | groupmask | passthrough", "ACLMODE", acl_mode_table);
22083d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_ACLINHERIT, "aclinherit",
22183d7f9feSTom Erickson 	    ZFS_ACL_RESTRICTED, PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
222d0f3f37eSMark Shellenbaum 	    "discard | noallow | restricted | passthrough | passthrough-x",
223b3d141f8Smarks 	    "ACLINHERIT", acl_inherit_table);
22483d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_COPIES, "copies", 1, PROP_INHERIT,
22583d7f9feSTom Erickson 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
22691ebeef5Sahrens 	    "1 | 2 | 3", "COPIES", copies_table);
22783d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_PRIMARYCACHE, "primarycache",
2283baa08fcSek110237 	    ZFS_CACHE_ALL, PROP_INHERIT,
2293baa08fcSek110237 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
2303baa08fcSek110237 	    "all | none | metadata", "PRIMARYCACHE", cache_table);
23183d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_SECONDARYCACHE, "secondarycache",
2323baa08fcSek110237 	    ZFS_CACHE_ALL, PROP_INHERIT,
2333baa08fcSek110237 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
2343baa08fcSek110237 	    "all | none | metadata", "SECONDARYCACHE", cache_table);
23583d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_LOGBIAS, "logbias", ZFS_LOGBIAS_LATENCY,
236e09fa4daSNeil Perrin 	    PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
237e09fa4daSNeil Perrin 	    "latency | throughput", "LOGBIAS", logbias_table);
238e45ce728Sahrens 
239e45ce728Sahrens 	/* inherit index (boolean) properties */
24083d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT,
241e45ce728Sahrens 	    ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table);
24283d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT,
243e45ce728Sahrens 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES",
244e45ce728Sahrens 	    boolean_table);
24583d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT,
246e45ce728Sahrens 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC",
247e45ce728Sahrens 	    boolean_table);
24883d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT,
249e45ce728Sahrens 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID",
250e45ce728Sahrens 	    boolean_table);
25183d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT,
252e45ce728Sahrens 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY",
253e45ce728Sahrens 	    boolean_table);
25483d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_ZONED, "zoned", 0, PROP_INHERIT,
255e45ce728Sahrens 	    ZFS_TYPE_FILESYSTEM, "on | off", "ZONED", boolean_table);
25683d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_XATTR, "xattr", 1, PROP_INHERIT,
257e45ce728Sahrens 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "XATTR",
258e45ce728Sahrens 	    boolean_table);
25983d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT,
260da6c28aaSamw 	    ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN",
261da6c28aaSamw 	    boolean_table);
26283d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT,
263da6c28aaSamw 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND",
264da6c28aaSamw 	    boolean_table);
265e45ce728Sahrens 
266e45ce728Sahrens 	/* default index properties */
26783d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT,
26891ebeef5Sahrens 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
26914843421SMatthew Ahrens 	    "1 | 2 | 3 | 4 | current", "VERSION", version_table);
27083d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON,
271a227b7f4Shs24103 	    PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto",
272a227b7f4Shs24103 	    "CANMOUNT", canmount_table);
273e45ce728Sahrens 
274e45ce728Sahrens 	/* readonly index (boolean) properties */
27583d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY,
276990b4856Slling 	    ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table);
27783d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_DEFER_DESTROY, "defer_destroy", 0,
278842727c2SChris Kirby 	    PROP_READONLY, ZFS_TYPE_SNAPSHOT, "yes | no", "DEFER_DESTROY",
279842727c2SChris Kirby 	    boolean_table);
280e45ce728Sahrens 
281da6c28aaSamw 	/* set once index properties */
28283d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_NORMALIZE, "normalization", 0,
283da6c28aaSamw 	    PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
284da6c28aaSamw 	    "none | formC | formD | formKC | formKD", "NORMALIZATION",
285da6c28aaSamw 	    normalize_table);
28683d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_CASE, "casesensitivity",
28783d7f9feSTom Erickson 	    ZFS_CASE_SENSITIVE, PROP_ONETIME, ZFS_TYPE_FILESYSTEM |
28883d7f9feSTom Erickson 	    ZFS_TYPE_SNAPSHOT,
289da6c28aaSamw 	    "sensitive | insensitive | mixed", "CASE", case_table);
290da6c28aaSamw 
291da6c28aaSamw 	/* set once index (boolean) properties */
29283d7f9feSTom Erickson 	zprop_register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME,
293da6c28aaSamw 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
294da6c28aaSamw 	    "on | off", "UTF8ONLY", boolean_table);
295da6c28aaSamw 
29691ebeef5Sahrens 	/* string properties */
29783d7f9feSTom Erickson 	zprop_register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY,
29891ebeef5Sahrens 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN");
29983d7f9feSTom Erickson 	zprop_register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/",
30083d7f9feSTom Erickson 	    PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "<path> | legacy | none",
30183d7f9feSTom Erickson 	    "MOUNTPOINT");
30283d7f9feSTom Erickson 	zprop_register_string(ZFS_PROP_SHARENFS, "sharenfs", "off",
30383d7f9feSTom Erickson 	    PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "on | off | share(1M) options",
30483d7f9feSTom Erickson 	    "SHARENFS");
30583d7f9feSTom Erickson 	zprop_register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY,
306990b4856Slling 	    ZFS_TYPE_DATASET, "filesystem | volume | snapshot", "TYPE");
30783d7f9feSTom Erickson 	zprop_register_string(ZFS_PROP_SHARESMB, "sharesmb", "off",
30883d7f9feSTom Erickson 	    PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
30983d7f9feSTom Erickson 	    "on | off | sharemgr(1M) options", "SHARESMB");
31083d7f9feSTom Erickson 	zprop_register_string(ZFS_PROP_MLSLABEL, "mlslabel",
31183d7f9feSTom Erickson 	    ZFS_MLSLABEL_DEFAULT, PROP_INHERIT, ZFS_TYPE_DATASET,
31283d7f9feSTom Erickson 	    "<sensitivity label>", "MLSLABEL");
31391ebeef5Sahrens 
31491ebeef5Sahrens 	/* readonly number properties */
31583d7f9feSTom Erickson 	zprop_register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY,
316990b4856Slling 	    ZFS_TYPE_DATASET, "<size>", "USED");
31783d7f9feSTom Erickson 	zprop_register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY,
318990b4856Slling 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL");
31983d7f9feSTom Erickson 	zprop_register_number(ZFS_PROP_REFERENCED, "referenced", 0,
32083d7f9feSTom Erickson 	    PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "REFER");
32183d7f9feSTom Erickson 	zprop_register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0,
322990b4856Slling 	    PROP_READONLY, ZFS_TYPE_DATASET,
32391ebeef5Sahrens 	    "<1.00x or higher if compressed>", "RATIO");
32483d7f9feSTom Erickson 	zprop_register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize",
325c1449561SEric Taylor 	    ZVOL_DEFAULT_BLOCKSIZE, PROP_ONETIME,
326da6c28aaSamw 	    ZFS_TYPE_VOLUME, "512 to 128k, power of 2",	"VOLBLOCK");
32783d7f9feSTom Erickson 	zprop_register_number(ZFS_PROP_USEDSNAP, "usedbysnapshots", 0,
32883d7f9feSTom Erickson 	    PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
32983d7f9feSTom Erickson 	    "USEDSNAP");
33083d7f9feSTom Erickson 	zprop_register_number(ZFS_PROP_USEDDS, "usedbydataset", 0,
33183d7f9feSTom Erickson 	    PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
33283d7f9feSTom Erickson 	    "USEDDS");
33383d7f9feSTom Erickson 	zprop_register_number(ZFS_PROP_USEDCHILD, "usedbychildren", 0,
33483d7f9feSTom Erickson 	    PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
33583d7f9feSTom Erickson 	    "USEDCHILD");
33683d7f9feSTom Erickson 	zprop_register_number(ZFS_PROP_USEDREFRESERV, "usedbyrefreservation", 0,
33774e7dc98SMatthew Ahrens 	    PROP_READONLY,
33874e7dc98SMatthew Ahrens 	    ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDREFRESERV");
33983d7f9feSTom Erickson 	zprop_register_number(ZFS_PROP_USERREFS, "userrefs", 0, PROP_READONLY,
340842727c2SChris Kirby 	    ZFS_TYPE_SNAPSHOT, "<count>", "USERREFS");
34191ebeef5Sahrens 
34291ebeef5Sahrens 	/* default number properties */
34383d7f9feSTom Erickson 	zprop_register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT,
34491ebeef5Sahrens 	    ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA");
34583d7f9feSTom Erickson 	zprop_register_number(ZFS_PROP_RESERVATION, "reservation", 0,
34683d7f9feSTom Erickson 	    PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
34783d7f9feSTom Erickson 	    "<size> | none", "RESERV");
34883d7f9feSTom Erickson 	zprop_register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT,
34991ebeef5Sahrens 	    ZFS_TYPE_VOLUME, "<size>", "VOLSIZE");
35083d7f9feSTom Erickson 	zprop_register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT,
351a9799022Sck153898 	    ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA");
35283d7f9feSTom Erickson 	zprop_register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0,
353a9799022Sck153898 	    PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
354a9799022Sck153898 	    "<size> | none", "REFRESERV");
35591ebeef5Sahrens 
35691ebeef5Sahrens 	/* inherit number properties */
35783d7f9feSTom Erickson 	zprop_register_number(ZFS_PROP_RECORDSIZE, "recordsize",
35883d7f9feSTom Erickson 	    SPA_MAXBLOCKSIZE, PROP_INHERIT,
35991ebeef5Sahrens 	    ZFS_TYPE_FILESYSTEM, "512 to 128k, power of 2", "RECSIZE");
36091ebeef5Sahrens 
36191ebeef5Sahrens 	/* hidden properties */
36283d7f9feSTom Erickson 	zprop_register_hidden(ZFS_PROP_CREATETXG, "createtxg", PROP_TYPE_NUMBER,
363b24ab676SJeff Bonwick 	    PROP_READONLY, ZFS_TYPE_DATASET, "CREATETXG");
36483d7f9feSTom Erickson 	zprop_register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER,
365b24ab676SJeff Bonwick 	    PROP_READONLY, ZFS_TYPE_SNAPSHOT, "NUMCLONES");
36683d7f9feSTom Erickson 	zprop_register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING,
367990b4856Slling 	    PROP_READONLY, ZFS_TYPE_DATASET, "NAME");
36883d7f9feSTom Erickson 	zprop_register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions",
36983d7f9feSTom Erickson 	    PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS");
37083d7f9feSTom Erickson 	zprop_register_hidden(ZFS_PROP_STMF_SHAREINFO, "stmf_sbd_lu",
371478ed9adSEric Taylor 	    PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME,
372478ed9adSEric Taylor 	    "STMF_SBD_LU");
37383d7f9feSTom Erickson 	zprop_register_hidden(ZFS_PROP_GUID, "guid", PROP_TYPE_NUMBER,
37483d7f9feSTom Erickson 	    PROP_READONLY, ZFS_TYPE_DATASET, "GUID");
37583d7f9feSTom Erickson 	zprop_register_hidden(ZFS_PROP_USERACCOUNTING, "useraccounting",
376b24ab676SJeff Bonwick 	    PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET,
377b24ab676SJeff Bonwick 	    "USERACCOUNTING");
37883d7f9feSTom Erickson 	zprop_register_hidden(ZFS_PROP_UNIQUE, "unique", PROP_TYPE_NUMBER,
379b24ab676SJeff Bonwick 	    PROP_READONLY, ZFS_TYPE_DATASET, "UNIQUE");
38083d7f9feSTom Erickson 	zprop_register_hidden(ZFS_PROP_OBJSETID, "objsetid", PROP_TYPE_NUMBER,
3811d713200SEric Schrock 	    PROP_READONLY, ZFS_TYPE_DATASET, "OBJSETID");
38291ebeef5Sahrens 
38391ebeef5Sahrens 	/* oddball properties */
38483d7f9feSTom Erickson 	zprop_register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0,
38583d7f9feSTom Erickson 	    NULL, PROP_READONLY, ZFS_TYPE_DATASET,
38691ebeef5Sahrens 	    "<date>", "CREATION", B_FALSE, B_TRUE, NULL);
38791ebeef5Sahrens }
38891ebeef5Sahrens 
389b1b8ab34Slling boolean_t
390990b4856Slling zfs_prop_delegatable(zfs_prop_t prop)
391b1b8ab34Slling {
392990b4856Slling 	zprop_desc_t *pd = &zfs_prop_table[prop];
3934201a95eSRic Aleshire 
3944201a95eSRic Aleshire 	/* The mlslabel property is never delegatable. */
3954201a95eSRic Aleshire 	if (prop == ZFS_PROP_MLSLABEL)
3964201a95eSRic Aleshire 		return (B_FALSE);
3974201a95eSRic Aleshire 
398990b4856Slling 	return (pd->pd_attr != PROP_READONLY);
399b1b8ab34Slling }
400b1b8ab34Slling 
401b1b8ab34Slling /*
402b1b8ab34Slling  * Given a zfs dataset property name, returns the corresponding property ID.
403fa9e4066Sahrens  */
404fa9e4066Sahrens zfs_prop_t
405fa9e4066Sahrens zfs_name_to_prop(const char *propname)
406fa9e4066Sahrens {
407990b4856Slling 	return (zprop_name_to_prop(propname, ZFS_TYPE_DATASET));
408b1b8ab34Slling }
409fa9e4066Sahrens 
410fa9e4066Sahrens /*
411e9dbad6fSeschrock  * For user property names, we allow all lowercase alphanumeric characters, plus
412e9dbad6fSeschrock  * a few useful punctuation characters.
413e9dbad6fSeschrock  */
414e9dbad6fSeschrock static int
415e9dbad6fSeschrock valid_char(char c)
416e9dbad6fSeschrock {
417e9dbad6fSeschrock 	return ((c >= 'a' && c <= 'z') ||
418e9dbad6fSeschrock 	    (c >= '0' && c <= '9') ||
419e9dbad6fSeschrock 	    c == '-' || c == '_' || c == '.' || c == ':');
420e9dbad6fSeschrock }
421e9dbad6fSeschrock 
422e9dbad6fSeschrock /*
423e9dbad6fSeschrock  * Returns true if this is a valid user-defined property (one with a ':').
424e9dbad6fSeschrock  */
425e9dbad6fSeschrock boolean_t
426e9dbad6fSeschrock zfs_prop_user(const char *name)
427e9dbad6fSeschrock {
428e9dbad6fSeschrock 	int i;
429e9dbad6fSeschrock 	char c;
430e9dbad6fSeschrock 	boolean_t foundsep = B_FALSE;
431e9dbad6fSeschrock 
432e9dbad6fSeschrock 	for (i = 0; i < strlen(name); i++) {
433e9dbad6fSeschrock 		c = name[i];
434e9dbad6fSeschrock 		if (!valid_char(c))
435e9dbad6fSeschrock 			return (B_FALSE);
436e9dbad6fSeschrock 		if (c == ':')
437e9dbad6fSeschrock 			foundsep = B_TRUE;
438e9dbad6fSeschrock 	}
439e9dbad6fSeschrock 
440e9dbad6fSeschrock 	if (!foundsep)
441e9dbad6fSeschrock 		return (B_FALSE);
442e9dbad6fSeschrock 
443e9dbad6fSeschrock 	return (B_TRUE);
444e9dbad6fSeschrock }
445e9dbad6fSeschrock 
446e9dbad6fSeschrock /*
44714843421SMatthew Ahrens  * Returns true if this is a valid userspace-type property (one with a '@').
44814843421SMatthew Ahrens  * Note that after the @, any character is valid (eg, another @, for SID
44914843421SMatthew Ahrens  * user@domain).
45014843421SMatthew Ahrens  */
45114843421SMatthew Ahrens boolean_t
45214843421SMatthew Ahrens zfs_prop_userquota(const char *name)
45314843421SMatthew Ahrens {
45414843421SMatthew Ahrens 	zfs_userquota_prop_t prop;
45514843421SMatthew Ahrens 
45614843421SMatthew Ahrens 	for (prop = 0; prop < ZFS_NUM_USERQUOTA_PROPS; prop++) {
45714843421SMatthew Ahrens 		if (strncmp(name, zfs_userquota_prop_prefixes[prop],
45814843421SMatthew Ahrens 		    strlen(zfs_userquota_prop_prefixes[prop])) == 0) {
45914843421SMatthew Ahrens 			return (B_TRUE);
46014843421SMatthew Ahrens 		}
46114843421SMatthew Ahrens 	}
46214843421SMatthew Ahrens 
46314843421SMatthew Ahrens 	return (B_FALSE);
46414843421SMatthew Ahrens }
46514843421SMatthew Ahrens 
46614843421SMatthew Ahrens /*
467990b4856Slling  * Tables of index types, plus functions to convert between the user view
468990b4856Slling  * (strings) and internal representation (uint64_t).
469fa9e4066Sahrens  */
470990b4856Slling int
471990b4856Slling zfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index)
472fa9e4066Sahrens {
473990b4856Slling 	return (zprop_string_to_index(prop, string, index, ZFS_TYPE_DATASET));
474990b4856Slling }
475990b4856Slling 
476990b4856Slling int
477990b4856Slling zfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string)
478990b4856Slling {
479990b4856Slling 	return (zprop_index_to_string(prop, index, string, ZFS_TYPE_DATASET));
480990b4856Slling }
481990b4856Slling 
482b24ab676SJeff Bonwick uint64_t
483b24ab676SJeff Bonwick zfs_prop_random_value(zfs_prop_t prop, uint64_t seed)
484b24ab676SJeff Bonwick {
485b24ab676SJeff Bonwick 	return (zprop_random_value(prop, seed, ZFS_TYPE_DATASET));
486b24ab676SJeff Bonwick }
487b24ab676SJeff Bonwick 
488990b4856Slling /*
489990b4856Slling  * Returns TRUE if the property applies to any of the given dataset types.
490990b4856Slling  */
4914853e976Sgw25295 boolean_t
492990b4856Slling zfs_prop_valid_for_type(int prop, zfs_type_t types)
493990b4856Slling {
494990b4856Slling 	return (zprop_valid_for_type(prop, types));
495990b4856Slling }
496990b4856Slling 
497990b4856Slling zprop_type_t
498990b4856Slling zfs_prop_get_type(zfs_prop_t prop)
499990b4856Slling {
500990b4856Slling 	return (zfs_prop_table[prop].pd_proptype);
501990b4856Slling }
502990b4856Slling 
503990b4856Slling /*
504990b4856Slling  * Returns TRUE if the property is readonly.
505990b4856Slling  */
506990b4856Slling boolean_t
507990b4856Slling zfs_prop_readonly(zfs_prop_t prop)
508990b4856Slling {
509da6c28aaSamw 	return (zfs_prop_table[prop].pd_attr == PROP_READONLY ||
510da6c28aaSamw 	    zfs_prop_table[prop].pd_attr == PROP_ONETIME);
511da6c28aaSamw }
512da6c28aaSamw 
513da6c28aaSamw /*
514da6c28aaSamw  * Returns TRUE if the property is only allowed to be set once.
515da6c28aaSamw  */
516da6c28aaSamw boolean_t
517da6c28aaSamw zfs_prop_setonce(zfs_prop_t prop)
518da6c28aaSamw {
519da6c28aaSamw 	return (zfs_prop_table[prop].pd_attr == PROP_ONETIME);
520fa9e4066Sahrens }
521fa9e4066Sahrens 
5223d7072f8Seschrock const char *
523990b4856Slling zfs_prop_default_string(zfs_prop_t prop)
5243d7072f8Seschrock {
5253d7072f8Seschrock 	return (zfs_prop_table[prop].pd_strdefault);
5263d7072f8Seschrock }
5273d7072f8Seschrock 
528fa9e4066Sahrens uint64_t
529fa9e4066Sahrens zfs_prop_default_numeric(zfs_prop_t prop)
530fa9e4066Sahrens {
531fa9e4066Sahrens 	return (zfs_prop_table[prop].pd_numdefault);
532fa9e4066Sahrens }
533fa9e4066Sahrens 
534fa9e4066Sahrens /*
535b1b8ab34Slling  * Given a dataset property ID, returns the corresponding name.
5363d7072f8Seschrock  * Assuming the zfs dataset property ID is valid.
537fa9e4066Sahrens  */
538fa9e4066Sahrens const char *
539fa9e4066Sahrens zfs_prop_to_name(zfs_prop_t prop)
540fa9e4066Sahrens {
541fa9e4066Sahrens 	return (zfs_prop_table[prop].pd_name);
542fa9e4066Sahrens }
543fa9e4066Sahrens 
544fa9e4066Sahrens /*
545fa9e4066Sahrens  * Returns TRUE if the property is inheritable.
546fa9e4066Sahrens  */
547990b4856Slling boolean_t
548fa9e4066Sahrens zfs_prop_inheritable(zfs_prop_t prop)
549fa9e4066Sahrens {
550da6c28aaSamw 	return (zfs_prop_table[prop].pd_attr == PROP_INHERIT ||
551da6c28aaSamw 	    zfs_prop_table[prop].pd_attr == PROP_ONETIME);
552e9dbad6fSeschrock }
553e9dbad6fSeschrock 
554acd76fe5Seschrock #ifndef _KERNEL
555acd76fe5Seschrock 
556fa9e4066Sahrens /*
557fa9e4066Sahrens  * Returns a string describing the set of acceptable values for the given
558b1b8ab34Slling  * zfs property, or NULL if it cannot be set.
559fa9e4066Sahrens  */
560fa9e4066Sahrens const char *
561fa9e4066Sahrens zfs_prop_values(zfs_prop_t prop)
562fa9e4066Sahrens {
563fa9e4066Sahrens 	return (zfs_prop_table[prop].pd_values);
564fa9e4066Sahrens }
565fa9e4066Sahrens 
566fa9e4066Sahrens /*
567fa9e4066Sahrens  * Returns TRUE if this property is a string type.  Note that index types
568fa9e4066Sahrens  * (compression, checksum) are treated as strings in userland, even though they
569fa9e4066Sahrens  * are stored numerically on disk.
570fa9e4066Sahrens  */
571fa9e4066Sahrens int
572fa9e4066Sahrens zfs_prop_is_string(zfs_prop_t prop)
573fa9e4066Sahrens {
57491ebeef5Sahrens 	return (zfs_prop_table[prop].pd_proptype == PROP_TYPE_STRING ||
57591ebeef5Sahrens 	    zfs_prop_table[prop].pd_proptype == PROP_TYPE_INDEX);
576fa9e4066Sahrens }
577fa9e4066Sahrens 
578fa9e4066Sahrens /*
579fa9e4066Sahrens  * Returns the column header for the given property.  Used only in
580fa9e4066Sahrens  * 'zfs list -o', but centralized here with the other property information.
581fa9e4066Sahrens  */
582fa9e4066Sahrens const char *
583fa9e4066Sahrens zfs_prop_column_name(zfs_prop_t prop)
584fa9e4066Sahrens {
585fa9e4066Sahrens 	return (zfs_prop_table[prop].pd_colname);
586fa9e4066Sahrens }
587fa9e4066Sahrens 
588fa9e4066Sahrens /*
589e9dbad6fSeschrock  * Returns whether the given property should be displayed right-justified for
590e9dbad6fSeschrock  * 'zfs list'.
591fa9e4066Sahrens  */
592e9dbad6fSeschrock boolean_t
593e9dbad6fSeschrock zfs_prop_align_right(zfs_prop_t prop)
594fa9e4066Sahrens {
595e9dbad6fSeschrock 	return (zfs_prop_table[prop].pd_rightalign);
596fa9e4066Sahrens }
597da6c28aaSamw 
598fa9e4066Sahrens #endif
599