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.
26 #pragma ident "@(#)zfs_prop.c 1.32 08/04/08 SMI"
30 #include <sys/u8_textprep.h>
31 #include <sys/zfs_acl.h>
32 #include <sys/zfs_ioctl.h>
33 #include <sys/zfs_znode.h>
36 #include "zfs_deleg.h"
39 #include <sys/systm.h>
46 static zprop_desc_t zfs_prop_table[ZFS_NUM_PROPS];
49 zfs_prop_get_table(void)
51 return (zfs_prop_table);
57 static zprop_index_t checksum_table[] = {
58 { "on", ZIO_CHECKSUM_ON },
59 { "off", ZIO_CHECKSUM_OFF },
60 { "fletcher2", ZIO_CHECKSUM_FLETCHER_2 },
61 { "fletcher4", ZIO_CHECKSUM_FLETCHER_4 },
62 { "sha256", ZIO_CHECKSUM_SHA256 },
66 static zprop_index_t compress_table[] = {
67 { "on", ZIO_COMPRESS_ON },
68 { "off", ZIO_COMPRESS_OFF },
69 { "lzjb", ZIO_COMPRESS_LZJB },
70 { "gzip", ZIO_COMPRESS_GZIP_6 }, /* gzip default */
71 { "gzip-1", ZIO_COMPRESS_GZIP_1 },
72 { "gzip-2", ZIO_COMPRESS_GZIP_2 },
73 { "gzip-3", ZIO_COMPRESS_GZIP_3 },
74 { "gzip-4", ZIO_COMPRESS_GZIP_4 },
75 { "gzip-5", ZIO_COMPRESS_GZIP_5 },
76 { "gzip-6", ZIO_COMPRESS_GZIP_6 },
77 { "gzip-7", ZIO_COMPRESS_GZIP_7 },
78 { "gzip-8", ZIO_COMPRESS_GZIP_8 },
79 { "gzip-9", ZIO_COMPRESS_GZIP_9 },
83 static zprop_index_t snapdir_table[] = {
84 { "hidden", ZFS_SNAPDIR_HIDDEN },
85 { "visible", ZFS_SNAPDIR_VISIBLE },
89 static zprop_index_t acl_mode_table[] = {
90 { "discard", ZFS_ACL_DISCARD },
91 { "groupmask", ZFS_ACL_GROUPMASK },
92 { "passthrough", ZFS_ACL_PASSTHROUGH },
96 static zprop_index_t acl_inherit_table[] = {
97 { "discard", ZFS_ACL_DISCARD },
98 { "noallow", ZFS_ACL_NOALLOW },
99 { "restricted", ZFS_ACL_RESTRICTED },
100 { "passthrough", ZFS_ACL_PASSTHROUGH },
101 { "secure", ZFS_ACL_RESTRICTED }, /* bkwrd compatability */
105 static zprop_index_t case_table[] = {
106 { "sensitive", ZFS_CASE_SENSITIVE },
107 { "insensitive", ZFS_CASE_INSENSITIVE },
108 { "mixed", ZFS_CASE_MIXED },
112 static zprop_index_t copies_table[] = {
120 * Use the unique flags we have to send to u8_strcmp() and/or
121 * u8_textprep() to represent the various normalization property
124 static zprop_index_t normalize_table[] = {
126 { "formD", U8_TEXTPREP_NFD },
127 { "formKC", U8_TEXTPREP_NFKC },
128 { "formC", U8_TEXTPREP_NFC },
129 { "formKD", U8_TEXTPREP_NFKD },
133 static zprop_index_t version_table[] = {
137 { "current", ZPL_VERSION },
141 static zprop_index_t boolean_table[] = {
147 static zprop_index_t canmount_table[] = {
148 { "off", ZFS_CANMOUNT_OFF },
149 { "on", ZFS_CANMOUNT_ON },
150 { "noauto", ZFS_CANMOUNT_NOAUTO },
154 /* inherit index properties */
155 register_index(ZFS_PROP_CHECKSUM, "checksum", ZIO_CHECKSUM_DEFAULT,
156 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
157 "on | off | fletcher2 | fletcher4 | sha256", "CHECKSUM",
159 register_index(ZFS_PROP_COMPRESSION, "compression",
160 ZIO_COMPRESS_DEFAULT, PROP_INHERIT,
161 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
162 "on | off | lzjb | gzip | gzip-[1-9]", "COMPRESS", compress_table);
163 register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN,
164 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
165 "hidden | visible", "SNAPDIR", snapdir_table);
166 register_index(ZFS_PROP_ACLMODE, "aclmode", ZFS_ACL_GROUPMASK,
167 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
168 "discard | groupmask | passthrough", "ACLMODE", acl_mode_table);
169 register_index(ZFS_PROP_ACLINHERIT, "aclinherit", ZFS_ACL_RESTRICTED,
170 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
171 "discard | noallow | restricted | passthrough",
172 "ACLINHERIT", acl_inherit_table);
173 register_index(ZFS_PROP_COPIES, "copies", 1,
174 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
175 "1 | 2 | 3", "COPIES", copies_table);
177 /* inherit index (boolean) properties */
178 register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT,
179 ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table);
180 register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT,
181 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES",
183 register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT,
184 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC",
186 register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT,
187 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID",
189 register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT,
190 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY",
192 register_index(ZFS_PROP_ZONED, "zoned", 0, PROP_INHERIT,
193 ZFS_TYPE_FILESYSTEM, "on | off", "ZONED", boolean_table);
194 register_index(ZFS_PROP_XATTR, "xattr", 1, PROP_INHERIT,
195 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "XATTR",
197 register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT,
198 ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN",
200 register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT,
201 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND",
204 /* default index properties */
205 register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT,
206 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
207 "1 | 2 | 3 | current", "VERSION", version_table);
208 register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON,
209 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto",
210 "CANMOUNT", canmount_table);
212 /* readonly index (boolean) properties */
213 register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY,
214 ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table);
216 /* set once index properties */
217 register_index(ZFS_PROP_NORMALIZE, "normalization", 0,
218 PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
219 "none | formC | formD | formKC | formKD", "NORMALIZATION",
221 register_index(ZFS_PROP_CASE, "casesensitivity", ZFS_CASE_SENSITIVE,
222 PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
223 "sensitive | insensitive | mixed", "CASE", case_table);
225 /* set once index (boolean) properties */
226 register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME,
227 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
228 "on | off", "UTF8ONLY", boolean_table);
230 /* string properties */
231 register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY,
232 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN");
233 register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/", PROP_INHERIT,
234 ZFS_TYPE_FILESYSTEM, "<path> | legacy | none", "MOUNTPOINT");
235 register_string(ZFS_PROP_SHARENFS, "sharenfs", "off", PROP_INHERIT,
236 ZFS_TYPE_FILESYSTEM, "on | off | share(1M) options", "SHARENFS");
237 register_string(ZFS_PROP_SHAREISCSI, "shareiscsi", "off", PROP_INHERIT,
238 ZFS_TYPE_DATASET, "on | off | type=<type>", "SHAREISCSI");
239 register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY,
240 ZFS_TYPE_DATASET, "filesystem | volume | snapshot", "TYPE");
241 register_string(ZFS_PROP_SHARESMB, "sharesmb", "off", PROP_INHERIT,
242 ZFS_TYPE_FILESYSTEM, "on | off | sharemgr(1M) options", "SHARESMB");
244 /* readonly number properties */
245 register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY,
246 ZFS_TYPE_DATASET, "<size>", "USED");
247 register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY,
248 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL");
249 register_number(ZFS_PROP_REFERENCED, "referenced", 0, PROP_READONLY,
250 ZFS_TYPE_DATASET, "<size>", "REFER");
251 register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0,
252 PROP_READONLY, ZFS_TYPE_DATASET,
253 "<1.00x or higher if compressed>", "RATIO");
254 register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize", 8192,
256 ZFS_TYPE_VOLUME, "512 to 128k, power of 2", "VOLBLOCK");
258 /* default number properties */
259 register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT,
260 ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA");
261 register_number(ZFS_PROP_RESERVATION, "reservation", 0, PROP_DEFAULT,
262 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size> | none", "RESERV");
263 register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT,
264 ZFS_TYPE_VOLUME, "<size>", "VOLSIZE");
265 register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT,
266 ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA");
267 register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0,
268 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
269 "<size> | none", "REFRESERV");
271 /* inherit number properties */
272 register_number(ZFS_PROP_RECORDSIZE, "recordsize", SPA_MAXBLOCKSIZE,
274 ZFS_TYPE_FILESYSTEM, "512 to 128k, power of 2", "RECSIZE");
276 /* hidden properties */
277 register_hidden(ZFS_PROP_CREATETXG, "createtxg", PROP_TYPE_NUMBER,
278 PROP_READONLY, ZFS_TYPE_DATASET, NULL);
279 register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER,
280 PROP_READONLY, ZFS_TYPE_SNAPSHOT, NULL);
281 register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING,
282 PROP_READONLY, ZFS_TYPE_DATASET, "NAME");
283 register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions", PROP_TYPE_STRING,
284 PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS");
286 /* oddball properties */
287 register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0, NULL,
288 PROP_READONLY, ZFS_TYPE_DATASET,
289 "<date>", "CREATION", B_FALSE, B_TRUE, NULL);
293 zfs_prop_delegatable(zfs_prop_t prop)
295 zprop_desc_t *pd = &zfs_prop_table[prop];
296 return (pd->pd_attr != PROP_READONLY);
300 * Given a zfs dataset property name, returns the corresponding property ID.
303 zfs_name_to_prop(const char *propname)
305 return (zprop_name_to_prop(propname, ZFS_TYPE_DATASET));
310 * For user property names, we allow all lowercase alphanumeric characters, plus
311 * a few useful punctuation characters.
316 return ((c >= 'a' && c <= 'z') ||
317 (c >= '0' && c <= '9') ||
318 c == '-' || c == '_' || c == '.' || c == ':');
322 * Returns true if this is a valid user-defined property (one with a ':').
325 zfs_prop_user(const char *name)
329 boolean_t foundsep = B_FALSE;
331 for (i = 0; i < strlen(name); i++) {
346 * Tables of index types, plus functions to convert between the user view
347 * (strings) and internal representation (uint64_t).
350 zfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index)
352 return (zprop_string_to_index(prop, string, index, ZFS_TYPE_DATASET));
356 zfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string)
358 return (zprop_index_to_string(prop, index, string, ZFS_TYPE_DATASET));
362 * Returns TRUE if the property applies to any of the given dataset types.
365 zfs_prop_valid_for_type(int prop, zfs_type_t types)
367 return (zprop_valid_for_type(prop, types));
371 zfs_prop_get_type(zfs_prop_t prop)
373 return (zfs_prop_table[prop].pd_proptype);
377 * Returns TRUE if the property is readonly.
380 zfs_prop_readonly(zfs_prop_t prop)
382 return (zfs_prop_table[prop].pd_attr == PROP_READONLY ||
383 zfs_prop_table[prop].pd_attr == PROP_ONETIME);
387 * Returns TRUE if the property is only allowed to be set once.
390 zfs_prop_setonce(zfs_prop_t prop)
392 return (zfs_prop_table[prop].pd_attr == PROP_ONETIME);
396 zfs_prop_default_string(zfs_prop_t prop)
398 return (zfs_prop_table[prop].pd_strdefault);
402 zfs_prop_default_numeric(zfs_prop_t prop)
404 return (zfs_prop_table[prop].pd_numdefault);
408 * Given a dataset property ID, returns the corresponding name.
409 * Assuming the zfs dataset property ID is valid.
412 zfs_prop_to_name(zfs_prop_t prop)
414 return (zfs_prop_table[prop].pd_name);
418 * Returns TRUE if the property is inheritable.
421 zfs_prop_inheritable(zfs_prop_t prop)
423 return (zfs_prop_table[prop].pd_attr == PROP_INHERIT ||
424 zfs_prop_table[prop].pd_attr == PROP_ONETIME);
430 * Returns a string describing the set of acceptable values for the given
431 * zfs property, or NULL if it cannot be set.
434 zfs_prop_values(zfs_prop_t prop)
436 return (zfs_prop_table[prop].pd_values);
440 * Returns TRUE if this property is a string type. Note that index types
441 * (compression, checksum) are treated as strings in userland, even though they
442 * are stored numerically on disk.
445 zfs_prop_is_string(zfs_prop_t prop)
447 return (zfs_prop_table[prop].pd_proptype == PROP_TYPE_STRING ||
448 zfs_prop_table[prop].pd_proptype == PROP_TYPE_INDEX);
452 * Returns the column header for the given property. Used only in
453 * 'zfs list -o', but centralized here with the other property information.
456 zfs_prop_column_name(zfs_prop_t prop)
458 return (zfs_prop_table[prop].pd_colname);
462 * Returns whether the given property should be displayed right-justified for
466 zfs_prop_align_right(zfs_prop_t prop)
468 return (zfs_prop_table[prop].pd_rightalign);