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 2008 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];
47 zfs_prop_get_table(void)
49 return (zfs_prop_table);
55 static zprop_index_t checksum_table[] = {
56 { "on", ZIO_CHECKSUM_ON },
57 { "off", ZIO_CHECKSUM_OFF },
58 { "fletcher2", ZIO_CHECKSUM_FLETCHER_2 },
59 { "fletcher4", ZIO_CHECKSUM_FLETCHER_4 },
60 { "sha256", ZIO_CHECKSUM_SHA256 },
64 static zprop_index_t compress_table[] = {
65 { "on", ZIO_COMPRESS_ON },
66 { "off", ZIO_COMPRESS_OFF },
67 { "lzjb", ZIO_COMPRESS_LZJB },
68 { "gzip", ZIO_COMPRESS_GZIP_6 }, /* gzip default */
69 { "gzip-1", ZIO_COMPRESS_GZIP_1 },
70 { "gzip-2", ZIO_COMPRESS_GZIP_2 },
71 { "gzip-3", ZIO_COMPRESS_GZIP_3 },
72 { "gzip-4", ZIO_COMPRESS_GZIP_4 },
73 { "gzip-5", ZIO_COMPRESS_GZIP_5 },
74 { "gzip-6", ZIO_COMPRESS_GZIP_6 },
75 { "gzip-7", ZIO_COMPRESS_GZIP_7 },
76 { "gzip-8", ZIO_COMPRESS_GZIP_8 },
77 { "gzip-9", ZIO_COMPRESS_GZIP_9 },
81 static zprop_index_t snapdir_table[] = {
82 { "hidden", ZFS_SNAPDIR_HIDDEN },
83 { "visible", ZFS_SNAPDIR_VISIBLE },
87 static zprop_index_t acl_mode_table[] = {
88 { "discard", ZFS_ACL_DISCARD },
89 { "groupmask", ZFS_ACL_GROUPMASK },
90 { "passthrough", ZFS_ACL_PASSTHROUGH },
94 static zprop_index_t acl_inherit_table[] = {
95 { "discard", ZFS_ACL_DISCARD },
96 { "noallow", ZFS_ACL_NOALLOW },
97 { "restricted", ZFS_ACL_RESTRICTED },
98 { "passthrough", ZFS_ACL_PASSTHROUGH },
99 { "secure", ZFS_ACL_RESTRICTED }, /* bkwrd compatability */
103 static zprop_index_t case_table[] = {
104 { "sensitive", ZFS_CASE_SENSITIVE },
105 { "insensitive", ZFS_CASE_INSENSITIVE },
106 { "mixed", ZFS_CASE_MIXED },
110 static zprop_index_t copies_table[] = {
118 * Use the unique flags we have to send to u8_strcmp() and/or
119 * u8_textprep() to represent the various normalization property
122 static zprop_index_t normalize_table[] = {
124 { "formD", U8_TEXTPREP_NFD },
125 { "formKC", U8_TEXTPREP_NFKC },
126 { "formC", U8_TEXTPREP_NFC },
127 { "formKD", U8_TEXTPREP_NFKD },
131 static zprop_index_t version_table[] = {
135 { "current", ZPL_VERSION },
139 static zprop_index_t boolean_table[] = {
145 static zprop_index_t canmount_table[] = {
146 { "off", ZFS_CANMOUNT_OFF },
147 { "on", ZFS_CANMOUNT_ON },
148 { "noauto", ZFS_CANMOUNT_NOAUTO },
152 static zprop_index_t cache_table[] = {
153 { "none", ZFS_CACHE_NONE },
154 { "metadata", ZFS_CACHE_METADATA },
155 { "all", ZFS_CACHE_ALL },
159 /* inherit index properties */
160 register_index(ZFS_PROP_CHECKSUM, "checksum", ZIO_CHECKSUM_DEFAULT,
161 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
162 "on | off | fletcher2 | fletcher4 | sha256", "CHECKSUM",
164 register_index(ZFS_PROP_COMPRESSION, "compression",
165 ZIO_COMPRESS_DEFAULT, PROP_INHERIT,
166 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
167 "on | off | lzjb | gzip | gzip-[1-9]", "COMPRESS", compress_table);
168 register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN,
169 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
170 "hidden | visible", "SNAPDIR", snapdir_table);
171 register_index(ZFS_PROP_ACLMODE, "aclmode", ZFS_ACL_GROUPMASK,
172 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
173 "discard | groupmask | passthrough", "ACLMODE", acl_mode_table);
174 register_index(ZFS_PROP_ACLINHERIT, "aclinherit", ZFS_ACL_RESTRICTED,
175 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
176 "discard | noallow | restricted | passthrough",
177 "ACLINHERIT", acl_inherit_table);
178 register_index(ZFS_PROP_COPIES, "copies", 1,
179 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
180 "1 | 2 | 3", "COPIES", copies_table);
181 register_index(ZFS_PROP_PRIMARYCACHE, "primarycache",
182 ZFS_CACHE_ALL, PROP_INHERIT,
183 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
184 "all | none | metadata", "PRIMARYCACHE", cache_table);
185 register_index(ZFS_PROP_SECONDARYCACHE, "secondarycache",
186 ZFS_CACHE_ALL, PROP_INHERIT,
187 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
188 "all | none | metadata", "SECONDARYCACHE", cache_table);
190 /* inherit index (boolean) properties */
191 register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT,
192 ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table);
193 register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT,
194 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES",
196 register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT,
197 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC",
199 register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT,
200 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID",
202 register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT,
203 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY",
205 register_index(ZFS_PROP_ZONED, "jailed", 0, PROP_INHERIT,
206 ZFS_TYPE_FILESYSTEM, "on | off", "JAILED", boolean_table);
207 register_index(ZFS_PROP_XATTR, "xattr", 1, PROP_INHERIT,
208 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "XATTR",
210 register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT,
211 ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN",
213 register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT,
214 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND",
217 /* default index properties */
218 register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT,
219 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
220 "1 | 2 | 3 | current", "VERSION", version_table);
221 register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON,
222 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto",
223 "CANMOUNT", canmount_table);
225 /* readonly index (boolean) properties */
226 register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY,
227 ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table);
229 /* set once index properties */
230 register_index(ZFS_PROP_NORMALIZE, "normalization", 0,
231 PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
232 "none | formC | formD | formKC | formKD", "NORMALIZATION",
234 register_index(ZFS_PROP_CASE, "casesensitivity", ZFS_CASE_SENSITIVE,
235 PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
236 "sensitive | insensitive | mixed", "CASE", case_table);
238 /* set once index (boolean) properties */
239 register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME,
240 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
241 "on | off", "UTF8ONLY", boolean_table);
243 /* string properties */
244 register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY,
245 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN");
246 register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/", PROP_INHERIT,
247 ZFS_TYPE_FILESYSTEM, "<path> | legacy | none", "MOUNTPOINT");
248 register_string(ZFS_PROP_SHARENFS, "sharenfs", "off", PROP_INHERIT,
249 ZFS_TYPE_FILESYSTEM, "on | off | share(1M) options", "SHARENFS");
250 register_string(ZFS_PROP_SHAREISCSI, "shareiscsi", "off", PROP_INHERIT,
251 ZFS_TYPE_DATASET, "on | off | type=<type>", "SHAREISCSI");
252 register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY,
253 ZFS_TYPE_DATASET, "filesystem | volume | snapshot", "TYPE");
254 register_string(ZFS_PROP_SHARESMB, "sharesmb", "off", PROP_INHERIT,
255 ZFS_TYPE_FILESYSTEM, "on | off | sharemgr(1M) options", "SHARESMB");
257 /* readonly number properties */
258 register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY,
259 ZFS_TYPE_DATASET, "<size>", "USED");
260 register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY,
261 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL");
262 register_number(ZFS_PROP_REFERENCED, "referenced", 0, PROP_READONLY,
263 ZFS_TYPE_DATASET, "<size>", "REFER");
264 register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0,
265 PROP_READONLY, ZFS_TYPE_DATASET,
266 "<1.00x or higher if compressed>", "RATIO");
267 register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize", 8192,
269 ZFS_TYPE_VOLUME, "512 to 128k, power of 2", "VOLBLOCK");
270 register_number(ZFS_PROP_USEDSNAP, "usedbysnapshots", 0, PROP_READONLY,
271 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDSNAP");
272 register_number(ZFS_PROP_USEDDS, "usedbydataset", 0, PROP_READONLY,
273 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDDS");
274 register_number(ZFS_PROP_USEDCHILD, "usedbychildren", 0, PROP_READONLY,
275 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDCHILD");
276 register_number(ZFS_PROP_USEDREFRESERV, "usedbyrefreservation", 0,
278 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDREFRESERV");
280 /* default number properties */
281 register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT,
282 ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA");
283 register_number(ZFS_PROP_RESERVATION, "reservation", 0, PROP_DEFAULT,
284 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size> | none", "RESERV");
285 register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT,
286 ZFS_TYPE_VOLUME, "<size>", "VOLSIZE");
287 register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT,
288 ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA");
289 register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0,
290 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
291 "<size> | none", "REFRESERV");
293 /* inherit number properties */
294 register_number(ZFS_PROP_RECORDSIZE, "recordsize", SPA_MAXBLOCKSIZE,
296 ZFS_TYPE_FILESYSTEM, "512 to 128k, power of 2", "RECSIZE");
298 /* hidden properties */
299 register_hidden(ZFS_PROP_CREATETXG, "createtxg", PROP_TYPE_NUMBER,
300 PROP_READONLY, ZFS_TYPE_DATASET, "CREATETXG");
301 register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER,
302 PROP_READONLY, ZFS_TYPE_SNAPSHOT, NULL);
303 register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING,
304 PROP_READONLY, ZFS_TYPE_DATASET, "NAME");
305 register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions", PROP_TYPE_STRING,
306 PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS");
307 register_hidden(ZFS_PROP_GUID, "guid", PROP_TYPE_NUMBER, PROP_READONLY,
308 ZFS_TYPE_DATASET, "GUID");
310 /* oddball properties */
311 register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0, NULL,
312 PROP_READONLY, ZFS_TYPE_DATASET,
313 "<date>", "CREATION", B_FALSE, B_TRUE, NULL);
317 zfs_prop_delegatable(zfs_prop_t prop)
319 zprop_desc_t *pd = &zfs_prop_table[prop];
320 return (pd->pd_attr != PROP_READONLY);
324 * Given a zfs dataset property name, returns the corresponding property ID.
327 zfs_name_to_prop(const char *propname)
329 return (zprop_name_to_prop(propname, ZFS_TYPE_DATASET));
334 * For user property names, we allow all lowercase alphanumeric characters, plus
335 * a few useful punctuation characters.
340 return ((c >= 'a' && c <= 'z') ||
341 (c >= '0' && c <= '9') ||
342 c == '-' || c == '_' || c == '.' || c == ':');
346 * Returns true if this is a valid user-defined property (one with a ':').
349 zfs_prop_user(const char *name)
353 boolean_t foundsep = B_FALSE;
355 for (i = 0; i < strlen(name); i++) {
370 * Tables of index types, plus functions to convert between the user view
371 * (strings) and internal representation (uint64_t).
374 zfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index)
376 return (zprop_string_to_index(prop, string, index, ZFS_TYPE_DATASET));
380 zfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string)
382 return (zprop_index_to_string(prop, index, string, ZFS_TYPE_DATASET));
386 * Returns TRUE if the property applies to any of the given dataset types.
389 zfs_prop_valid_for_type(int prop, zfs_type_t types)
391 return (zprop_valid_for_type(prop, types));
395 zfs_prop_get_type(zfs_prop_t prop)
397 return (zfs_prop_table[prop].pd_proptype);
401 * Returns TRUE if the property is readonly.
404 zfs_prop_readonly(zfs_prop_t prop)
406 return (zfs_prop_table[prop].pd_attr == PROP_READONLY ||
407 zfs_prop_table[prop].pd_attr == PROP_ONETIME);
411 * Returns TRUE if the property is only allowed to be set once.
414 zfs_prop_setonce(zfs_prop_t prop)
416 return (zfs_prop_table[prop].pd_attr == PROP_ONETIME);
420 zfs_prop_default_string(zfs_prop_t prop)
422 return (zfs_prop_table[prop].pd_strdefault);
426 zfs_prop_default_numeric(zfs_prop_t prop)
428 return (zfs_prop_table[prop].pd_numdefault);
432 * Given a dataset property ID, returns the corresponding name.
433 * Assuming the zfs dataset property ID is valid.
436 zfs_prop_to_name(zfs_prop_t prop)
438 return (zfs_prop_table[prop].pd_name);
442 * Returns TRUE if the property is inheritable.
445 zfs_prop_inheritable(zfs_prop_t prop)
447 return (zfs_prop_table[prop].pd_attr == PROP_INHERIT ||
448 zfs_prop_table[prop].pd_attr == PROP_ONETIME);
454 * Returns a string describing the set of acceptable values for the given
455 * zfs property, or NULL if it cannot be set.
458 zfs_prop_values(zfs_prop_t prop)
460 return (zfs_prop_table[prop].pd_values);
464 * Returns TRUE if this property is a string type. Note that index types
465 * (compression, checksum) are treated as strings in userland, even though they
466 * are stored numerically on disk.
469 zfs_prop_is_string(zfs_prop_t prop)
471 return (zfs_prop_table[prop].pd_proptype == PROP_TYPE_STRING ||
472 zfs_prop_table[prop].pd_proptype == PROP_TYPE_INDEX);
476 * Returns the column header for the given property. Used only in
477 * 'zfs list -o', but centralized here with the other property information.
480 zfs_prop_column_name(zfs_prop_t prop)
482 return (zfs_prop_table[prop].pd_colname);
486 * Returns whether the given property should be displayed right-justified for
490 zfs_prop_align_right(zfs_prop_t prop)
492 return (zfs_prop_table[prop].pd_rightalign);