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 2009 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
28 #include <sys/u8_textprep.h>
29 #include <sys/zfs_acl.h>
30 #include <sys/zfs_ioctl.h>
31 #include <sys/zfs_znode.h>
34 #include "zfs_deleg.h"
37 #include <sys/systm.h>
44 static zprop_desc_t zfs_prop_table[ZFS_NUM_PROPS];
46 /* Note this is indexed by zfs_userquota_prop_t, keep the order the same */
47 const char *zfs_userquota_prop_prefixes[] = {
55 zfs_prop_get_table(void)
57 return (zfs_prop_table);
63 static zprop_index_t checksum_table[] = {
64 { "on", ZIO_CHECKSUM_ON },
65 { "off", ZIO_CHECKSUM_OFF },
66 { "fletcher2", ZIO_CHECKSUM_FLETCHER_2 },
67 { "fletcher4", ZIO_CHECKSUM_FLETCHER_4 },
68 { "sha256", ZIO_CHECKSUM_SHA256 },
72 static zprop_index_t compress_table[] = {
73 { "on", ZIO_COMPRESS_ON },
74 { "off", ZIO_COMPRESS_OFF },
75 { "lzjb", ZIO_COMPRESS_LZJB },
76 { "gzip", ZIO_COMPRESS_GZIP_6 }, /* gzip default */
77 { "gzip-1", ZIO_COMPRESS_GZIP_1 },
78 { "gzip-2", ZIO_COMPRESS_GZIP_2 },
79 { "gzip-3", ZIO_COMPRESS_GZIP_3 },
80 { "gzip-4", ZIO_COMPRESS_GZIP_4 },
81 { "gzip-5", ZIO_COMPRESS_GZIP_5 },
82 { "gzip-6", ZIO_COMPRESS_GZIP_6 },
83 { "gzip-7", ZIO_COMPRESS_GZIP_7 },
84 { "gzip-8", ZIO_COMPRESS_GZIP_8 },
85 { "gzip-9", ZIO_COMPRESS_GZIP_9 },
89 static zprop_index_t snapdir_table[] = {
90 { "hidden", ZFS_SNAPDIR_HIDDEN },
91 { "visible", ZFS_SNAPDIR_VISIBLE },
95 static zprop_index_t acl_mode_table[] = {
96 { "discard", ZFS_ACL_DISCARD },
97 { "groupmask", ZFS_ACL_GROUPMASK },
98 { "passthrough", ZFS_ACL_PASSTHROUGH },
102 static zprop_index_t acl_inherit_table[] = {
103 { "discard", ZFS_ACL_DISCARD },
104 { "noallow", ZFS_ACL_NOALLOW },
105 { "restricted", ZFS_ACL_RESTRICTED },
106 { "passthrough", ZFS_ACL_PASSTHROUGH },
107 { "secure", ZFS_ACL_RESTRICTED }, /* bkwrd compatability */
108 { "passthrough-x", ZFS_ACL_PASSTHROUGH_X },
112 static zprop_index_t case_table[] = {
113 { "sensitive", ZFS_CASE_SENSITIVE },
114 { "insensitive", ZFS_CASE_INSENSITIVE },
115 { "mixed", ZFS_CASE_MIXED },
119 static zprop_index_t copies_table[] = {
127 * Use the unique flags we have to send to u8_strcmp() and/or
128 * u8_textprep() to represent the various normalization property
131 static zprop_index_t normalize_table[] = {
133 { "formD", U8_TEXTPREP_NFD },
134 { "formKC", U8_TEXTPREP_NFKC },
135 { "formC", U8_TEXTPREP_NFC },
136 { "formKD", U8_TEXTPREP_NFKD },
140 static zprop_index_t version_table[] = {
145 { "current", ZPL_VERSION },
149 static zprop_index_t boolean_table[] = {
155 static zprop_index_t canmount_table[] = {
156 { "off", ZFS_CANMOUNT_OFF },
157 { "on", ZFS_CANMOUNT_ON },
158 { "noauto", ZFS_CANMOUNT_NOAUTO },
162 static zprop_index_t cache_table[] = {
163 { "none", ZFS_CACHE_NONE },
164 { "metadata", ZFS_CACHE_METADATA },
165 { "all", ZFS_CACHE_ALL },
169 /* inherit index properties */
170 register_index(ZFS_PROP_CHECKSUM, "checksum", ZIO_CHECKSUM_DEFAULT,
171 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
172 "on | off | fletcher2 | fletcher4 | sha256", "CHECKSUM",
174 register_index(ZFS_PROP_COMPRESSION, "compression",
175 ZIO_COMPRESS_DEFAULT, PROP_INHERIT,
176 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
177 "on | off | lzjb | gzip | gzip-[1-9]", "COMPRESS", compress_table);
178 register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN,
179 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
180 "hidden | visible", "SNAPDIR", snapdir_table);
181 register_index(ZFS_PROP_ACLMODE, "aclmode", ZFS_ACL_GROUPMASK,
182 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
183 "discard | groupmask | passthrough", "ACLMODE", acl_mode_table);
184 register_index(ZFS_PROP_ACLINHERIT, "aclinherit", ZFS_ACL_RESTRICTED,
185 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
186 "discard | noallow | restricted | passthrough | passthrough-x",
187 "ACLINHERIT", acl_inherit_table);
188 register_index(ZFS_PROP_COPIES, "copies", 1,
189 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
190 "1 | 2 | 3", "COPIES", copies_table);
191 register_index(ZFS_PROP_PRIMARYCACHE, "primarycache",
192 ZFS_CACHE_ALL, PROP_INHERIT,
193 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
194 "all | none | metadata", "PRIMARYCACHE", cache_table);
195 register_index(ZFS_PROP_SECONDARYCACHE, "secondarycache",
196 ZFS_CACHE_ALL, PROP_INHERIT,
197 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
198 "all | none | metadata", "SECONDARYCACHE", cache_table);
200 /* inherit index (boolean) properties */
201 register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT,
202 ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table);
203 register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT,
204 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES",
206 register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT,
207 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC",
209 register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT,
210 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID",
212 register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT,
213 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY",
215 register_index(ZFS_PROP_ZONED, "zoned", 0, PROP_INHERIT,
216 ZFS_TYPE_FILESYSTEM, "on | off", "ZONED", boolean_table);
217 register_index(ZFS_PROP_XATTR, "xattr", 1, PROP_INHERIT,
218 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "XATTR",
220 register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT,
221 ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN",
223 register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT,
224 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND",
227 /* default index properties */
228 register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT,
229 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
230 "1 | 2 | 3 | 4 | current", "VERSION", version_table);
231 register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON,
232 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto",
233 "CANMOUNT", canmount_table);
235 /* readonly index (boolean) properties */
236 register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY,
237 ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table);
238 register_index(ZFS_PROP_DEFER_DESTROY, "defer_destroy", 0,
239 PROP_READONLY, ZFS_TYPE_SNAPSHOT, "yes | no", "DEFER_DESTROY",
242 /* set once index properties */
243 register_index(ZFS_PROP_NORMALIZE, "normalization", 0,
244 PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
245 "none | formC | formD | formKC | formKD", "NORMALIZATION",
247 register_index(ZFS_PROP_CASE, "casesensitivity", ZFS_CASE_SENSITIVE,
248 PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
249 "sensitive | insensitive | mixed", "CASE", case_table);
251 /* set once index (boolean) properties */
252 register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME,
253 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
254 "on | off", "UTF8ONLY", boolean_table);
256 /* string properties */
257 register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY,
258 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN");
259 register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/", PROP_INHERIT,
260 ZFS_TYPE_FILESYSTEM, "<path> | legacy | none", "MOUNTPOINT");
261 register_string(ZFS_PROP_SHARENFS, "sharenfs", "off", PROP_INHERIT,
262 ZFS_TYPE_FILESYSTEM, "on | off | share(1M) options", "SHARENFS");
263 register_string(ZFS_PROP_SHAREISCSI, "shareiscsi", "off", PROP_INHERIT,
264 ZFS_TYPE_DATASET, "on | off | type=<type>", "SHAREISCSI");
265 register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY,
266 ZFS_TYPE_DATASET, "filesystem | volume | snapshot", "TYPE");
267 register_string(ZFS_PROP_SHARESMB, "sharesmb", "off", PROP_INHERIT,
268 ZFS_TYPE_FILESYSTEM, "on | off | sharemgr(1M) options", "SHARESMB");
270 /* readonly number properties */
271 register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY,
272 ZFS_TYPE_DATASET, "<size>", "USED");
273 register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY,
274 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL");
275 register_number(ZFS_PROP_REFERENCED, "referenced", 0, PROP_READONLY,
276 ZFS_TYPE_DATASET, "<size>", "REFER");
277 register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0,
278 PROP_READONLY, ZFS_TYPE_DATASET,
279 "<1.00x or higher if compressed>", "RATIO");
280 register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize", 8192,
282 ZFS_TYPE_VOLUME, "512 to 128k, power of 2", "VOLBLOCK");
283 register_number(ZFS_PROP_USEDSNAP, "usedbysnapshots", 0, PROP_READONLY,
284 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDSNAP");
285 register_number(ZFS_PROP_USEDDS, "usedbydataset", 0, PROP_READONLY,
286 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDDS");
287 register_number(ZFS_PROP_USEDCHILD, "usedbychildren", 0, PROP_READONLY,
288 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDCHILD");
289 register_number(ZFS_PROP_USEDREFRESERV, "usedbyrefreservation", 0,
291 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDREFRESERV");
292 register_number(ZFS_PROP_USERREFS, "userrefs", 0, PROP_READONLY,
293 ZFS_TYPE_SNAPSHOT, "<count>", "USERREFS");
295 /* default number properties */
296 register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT,
297 ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA");
298 register_number(ZFS_PROP_RESERVATION, "reservation", 0, PROP_DEFAULT,
299 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size> | none", "RESERV");
300 register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT,
301 ZFS_TYPE_VOLUME, "<size>", "VOLSIZE");
302 register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT,
303 ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA");
304 register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0,
305 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
306 "<size> | none", "REFRESERV");
308 /* inherit number properties */
309 register_number(ZFS_PROP_RECORDSIZE, "recordsize", SPA_MAXBLOCKSIZE,
311 ZFS_TYPE_FILESYSTEM, "512 to 128k, power of 2", "RECSIZE");
313 /* hidden properties */
314 register_hidden(ZFS_PROP_CREATETXG, "createtxg", PROP_TYPE_NUMBER,
315 PROP_READONLY, ZFS_TYPE_DATASET, NULL);
316 register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER,
317 PROP_READONLY, ZFS_TYPE_SNAPSHOT, NULL);
318 register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING,
319 PROP_READONLY, ZFS_TYPE_DATASET, "NAME");
320 register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions", PROP_TYPE_STRING,
321 PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS");
322 register_hidden(ZFS_PROP_STMF_SHAREINFO, "stmf_sbd_lu",
323 PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME,
325 register_hidden(ZFS_PROP_GUID, "guid", PROP_TYPE_NUMBER, PROP_READONLY,
326 ZFS_TYPE_DATASET, "GUID");
327 register_hidden(ZFS_PROP_USERACCOUNTING, "useraccounting",
328 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, NULL);
330 /* oddball properties */
331 register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0, NULL,
332 PROP_READONLY, ZFS_TYPE_DATASET,
333 "<date>", "CREATION", B_FALSE, B_TRUE, NULL);
337 zfs_prop_delegatable(zfs_prop_t prop)
339 zprop_desc_t *pd = &zfs_prop_table[prop];
340 return (pd->pd_attr != PROP_READONLY);
344 * Given a zfs dataset property name, returns the corresponding property ID.
347 zfs_name_to_prop(const char *propname)
349 return (zprop_name_to_prop(propname, ZFS_TYPE_DATASET));
353 * For user property names, we allow all lowercase alphanumeric characters, plus
354 * a few useful punctuation characters.
359 return ((c >= 'a' && c <= 'z') ||
360 (c >= '0' && c <= '9') ||
361 c == '-' || c == '_' || c == '.' || c == ':');
365 * Returns true if this is a valid user-defined property (one with a ':').
368 zfs_prop_user(const char *name)
372 boolean_t foundsep = B_FALSE;
374 for (i = 0; i < strlen(name); i++) {
389 * Returns true if this is a valid userspace-type property (one with a '@').
390 * Note that after the @, any character is valid (eg, another @, for SID
394 zfs_prop_userquota(const char *name)
396 zfs_userquota_prop_t prop;
398 for (prop = 0; prop < ZFS_NUM_USERQUOTA_PROPS; prop++) {
399 if (strncmp(name, zfs_userquota_prop_prefixes[prop],
400 strlen(zfs_userquota_prop_prefixes[prop])) == 0) {
409 * Tables of index types, plus functions to convert between the user view
410 * (strings) and internal representation (uint64_t).
413 zfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index)
415 return (zprop_string_to_index(prop, string, index, ZFS_TYPE_DATASET));
419 zfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string)
421 return (zprop_index_to_string(prop, index, string, ZFS_TYPE_DATASET));
425 * Returns TRUE if the property applies to any of the given dataset types.
428 zfs_prop_valid_for_type(int prop, zfs_type_t types)
430 return (zprop_valid_for_type(prop, types));
434 zfs_prop_get_type(zfs_prop_t prop)
436 return (zfs_prop_table[prop].pd_proptype);
440 * Returns TRUE if the property is readonly.
443 zfs_prop_readonly(zfs_prop_t prop)
445 return (zfs_prop_table[prop].pd_attr == PROP_READONLY ||
446 zfs_prop_table[prop].pd_attr == PROP_ONETIME);
450 * Returns TRUE if the property is only allowed to be set once.
453 zfs_prop_setonce(zfs_prop_t prop)
455 return (zfs_prop_table[prop].pd_attr == PROP_ONETIME);
459 zfs_prop_default_string(zfs_prop_t prop)
461 return (zfs_prop_table[prop].pd_strdefault);
465 zfs_prop_default_numeric(zfs_prop_t prop)
467 return (zfs_prop_table[prop].pd_numdefault);
471 * Given a dataset property ID, returns the corresponding name.
472 * Assuming the zfs dataset property ID is valid.
475 zfs_prop_to_name(zfs_prop_t prop)
477 return (zfs_prop_table[prop].pd_name);
481 * Returns TRUE if the property is inheritable.
484 zfs_prop_inheritable(zfs_prop_t prop)
486 return (zfs_prop_table[prop].pd_attr == PROP_INHERIT ||
487 zfs_prop_table[prop].pd_attr == PROP_ONETIME);
493 * Returns a string describing the set of acceptable values for the given
494 * zfs property, or NULL if it cannot be set.
497 zfs_prop_values(zfs_prop_t prop)
499 return (zfs_prop_table[prop].pd_values);
503 * Returns TRUE if this property is a string type. Note that index types
504 * (compression, checksum) are treated as strings in userland, even though they
505 * are stored numerically on disk.
508 zfs_prop_is_string(zfs_prop_t prop)
510 return (zfs_prop_table[prop].pd_proptype == PROP_TYPE_STRING ||
511 zfs_prop_table[prop].pd_proptype == PROP_TYPE_INDEX);
515 * Returns the column header for the given property. Used only in
516 * 'zfs list -o', but centralized here with the other property information.
519 zfs_prop_column_name(zfs_prop_t prop)
521 return (zfs_prop_table[prop].pd_colname);
525 * Returns whether the given property should be displayed right-justified for
529 zfs_prop_align_right(zfs_prop_t prop)
531 return (zfs_prop_table[prop].pd_rightalign);