1 /*
2 * CDDL HEADER START
3 *
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.
7 *
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.
12 *
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]
18 *
19 * CDDL HEADER END
20 */
21 /*
22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright (c) 2013 by Delphix. All rights reserved.
24 * Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
25 * Copyright (c) 2013, Joyent, Inc. All rights reserved.
26 */
27
28 /* Portions Copyright 2010 Robert Milkowski */
29
30 #include <sys/zio.h>
31 #include <sys/spa.h>
32 #include <sys/u8_textprep.h>
33 #include <sys/zfs_acl.h>
34 #include <sys/zfs_ioctl.h>
35 #include <sys/zfs_znode.h>
36
37 #include "zfs_prop.h"
38 #include "zfs_deleg.h"
39
40 #if defined(_KERNEL)
41 #include <sys/systm.h>
42 #else
43 #include <stdlib.h>
44 #include <string.h>
45 #include <ctype.h>
46 #endif
47
48 static zprop_desc_t zfs_prop_table[ZFS_NUM_PROPS];
49
50 /* Note this is indexed by zfs_userquota_prop_t, keep the order the same */
51 const char *zfs_userquota_prop_prefixes[] = {
52 "userused@",
53 "userquota@",
54 "groupused@",
55 "groupquota@"
56 };
57
58 zprop_desc_t *
zfs_prop_get_table(void)59 zfs_prop_get_table(void)
60 {
61 return (zfs_prop_table);
62 }
63
64 void
zfs_prop_init(void)65 zfs_prop_init(void)
66 {
67 static zprop_index_t checksum_table[] = {
68 { "on", ZIO_CHECKSUM_ON },
69 { "off", ZIO_CHECKSUM_OFF },
70 { "fletcher2", ZIO_CHECKSUM_FLETCHER_2 },
71 { "fletcher4", ZIO_CHECKSUM_FLETCHER_4 },
72 { "sha256", ZIO_CHECKSUM_SHA256 },
73 { "noparity", ZIO_CHECKSUM_NOPARITY },
74 { NULL }
75 };
76
77 static zprop_index_t dedup_table[] = {
78 { "on", ZIO_CHECKSUM_ON },
79 { "off", ZIO_CHECKSUM_OFF },
80 { "verify", ZIO_CHECKSUM_ON | ZIO_CHECKSUM_VERIFY },
81 { "sha256", ZIO_CHECKSUM_SHA256 },
82 { "sha256,verify",
83 ZIO_CHECKSUM_SHA256 | ZIO_CHECKSUM_VERIFY },
84 { NULL }
85 };
86
87 static zprop_index_t compress_table[] = {
88 { "on", ZIO_COMPRESS_ON },
89 { "off", ZIO_COMPRESS_OFF },
90 { "lzjb", ZIO_COMPRESS_LZJB },
91 { "gzip", ZIO_COMPRESS_GZIP_6 }, /* gzip default */
92 { "gzip-1", ZIO_COMPRESS_GZIP_1 },
93 { "gzip-2", ZIO_COMPRESS_GZIP_2 },
94 { "gzip-3", ZIO_COMPRESS_GZIP_3 },
95 { "gzip-4", ZIO_COMPRESS_GZIP_4 },
96 { "gzip-5", ZIO_COMPRESS_GZIP_5 },
97 { "gzip-6", ZIO_COMPRESS_GZIP_6 },
98 { "gzip-7", ZIO_COMPRESS_GZIP_7 },
99 { "gzip-8", ZIO_COMPRESS_GZIP_8 },
100 { "gzip-9", ZIO_COMPRESS_GZIP_9 },
101 { "zle", ZIO_COMPRESS_ZLE },
102 { "lz4", ZIO_COMPRESS_LZ4 },
103 { NULL }
104 };
105
106 static zprop_index_t snapdir_table[] = {
107 { "hidden", ZFS_SNAPDIR_HIDDEN },
108 { "visible", ZFS_SNAPDIR_VISIBLE },
109 { NULL }
110 };
111
112 static zprop_index_t acl_mode_table[] = {
113 { "discard", ZFS_ACL_DISCARD },
114 { "groupmask", ZFS_ACL_GROUPMASK },
115 { "passthrough", ZFS_ACL_PASSTHROUGH },
116 { "restricted", ZFS_ACL_RESTRICTED },
117 { NULL }
118 };
119
120 static zprop_index_t acl_inherit_table[] = {
121 { "discard", ZFS_ACL_DISCARD },
122 { "noallow", ZFS_ACL_NOALLOW },
123 { "restricted", ZFS_ACL_RESTRICTED },
124 { "passthrough", ZFS_ACL_PASSTHROUGH },
125 { "secure", ZFS_ACL_RESTRICTED }, /* bkwrd compatability */
126 { "passthrough-x", ZFS_ACL_PASSTHROUGH_X },
127 { NULL }
128 };
129
130 static zprop_index_t case_table[] = {
131 { "sensitive", ZFS_CASE_SENSITIVE },
132 { "insensitive", ZFS_CASE_INSENSITIVE },
133 { "mixed", ZFS_CASE_MIXED },
134 { NULL }
135 };
136
137 static zprop_index_t copies_table[] = {
138 { "1", 1 },
139 { "2", 2 },
140 { "3", 3 },
141 { NULL }
142 };
143
144 /*
145 * Use the unique flags we have to send to u8_strcmp() and/or
146 * u8_textprep() to represent the various normalization property
147 * values.
148 */
149 static zprop_index_t normalize_table[] = {
150 { "none", 0 },
151 { "formD", U8_TEXTPREP_NFD },
152 { "formKC", U8_TEXTPREP_NFKC },
153 { "formC", U8_TEXTPREP_NFC },
154 { "formKD", U8_TEXTPREP_NFKD },
155 { NULL }
156 };
157
158 static zprop_index_t version_table[] = {
159 { "1", 1 },
160 { "2", 2 },
161 { "3", 3 },
162 { "4", 4 },
163 { "5", 5 },
164 { "current", ZPL_VERSION },
165 { NULL }
166 };
167
168 static zprop_index_t boolean_table[] = {
169 { "off", 0 },
170 { "on", 1 },
171 { NULL }
172 };
173
174 static zprop_index_t logbias_table[] = {
175 { "latency", ZFS_LOGBIAS_LATENCY },
176 { "throughput", ZFS_LOGBIAS_THROUGHPUT },
177 { NULL }
178 };
179
180 static zprop_index_t canmount_table[] = {
181 { "off", ZFS_CANMOUNT_OFF },
182 { "on", ZFS_CANMOUNT_ON },
183 { "noauto", ZFS_CANMOUNT_NOAUTO },
184 { NULL }
185 };
186
187 static zprop_index_t cache_table[] = {
188 { "none", ZFS_CACHE_NONE },
189 { "metadata", ZFS_CACHE_METADATA },
190 { "all", ZFS_CACHE_ALL },
191 { NULL }
192 };
193
194 static zprop_index_t sync_table[] = {
195 { "standard", ZFS_SYNC_STANDARD },
196 { "always", ZFS_SYNC_ALWAYS },
197 { "disabled", ZFS_SYNC_DISABLED },
198 { NULL }
199 };
200
201 /* inherit index properties */
202 zprop_register_index(ZFS_PROP_SYNC, "sync", ZFS_SYNC_STANDARD,
203 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
204 "standard | always | disabled", "SYNC",
205 sync_table);
206 zprop_register_index(ZFS_PROP_CHECKSUM, "checksum",
207 ZIO_CHECKSUM_DEFAULT, PROP_INHERIT, ZFS_TYPE_FILESYSTEM |
208 ZFS_TYPE_VOLUME,
209 "on | off | fletcher2 | fletcher4 | sha256", "CHECKSUM",
210 checksum_table);
211 zprop_register_index(ZFS_PROP_DEDUP, "dedup", ZIO_CHECKSUM_OFF,
212 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
213 "on | off | verify | sha256[,verify]", "DEDUP",
214 dedup_table);
215 zprop_register_index(ZFS_PROP_COMPRESSION, "compression",
216 ZIO_COMPRESS_DEFAULT, PROP_INHERIT,
217 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
218 "on | off | lzjb | gzip | gzip-[1-9] | zle | lz4",
219 "COMPRESS", compress_table);
220 zprop_register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN,
221 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
222 "hidden | visible", "SNAPDIR", snapdir_table);
223 zprop_register_index(ZFS_PROP_ACLMODE, "aclmode", ZFS_ACL_DISCARD,
224 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
225 "discard | groupmask | passthrough | restricted", "ACLMODE",
226 acl_mode_table);
227 zprop_register_index(ZFS_PROP_ACLINHERIT, "aclinherit",
228 ZFS_ACL_RESTRICTED, PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
229 "discard | noallow | restricted | passthrough | passthrough-x",
230 "ACLINHERIT", acl_inherit_table);
231 zprop_register_index(ZFS_PROP_COPIES, "copies", 1, PROP_INHERIT,
232 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
233 "1 | 2 | 3", "COPIES", copies_table);
234 zprop_register_index(ZFS_PROP_PRIMARYCACHE, "primarycache",
235 ZFS_CACHE_ALL, PROP_INHERIT,
236 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
237 "all | none | metadata", "PRIMARYCACHE", cache_table);
238 zprop_register_index(ZFS_PROP_SECONDARYCACHE, "secondarycache",
239 ZFS_CACHE_ALL, PROP_INHERIT,
240 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
241 "all | none | metadata", "SECONDARYCACHE", cache_table);
242 zprop_register_index(ZFS_PROP_LOGBIAS, "logbias", ZFS_LOGBIAS_LATENCY,
243 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
244 "latency | throughput", "LOGBIAS", logbias_table);
245
246 /* inherit index (boolean) properties */
247 zprop_register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT,
248 ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table);
249 zprop_register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT,
250 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES",
251 boolean_table);
252 zprop_register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT,
253 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC",
254 boolean_table);
255 zprop_register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT,
256 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID",
257 boolean_table);
258 zprop_register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT,
259 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY",
260 boolean_table);
261 zprop_register_index(ZFS_PROP_ZONED, "jailed", 0, PROP_INHERIT,
262 ZFS_TYPE_FILESYSTEM, "on | off", "JAILED", boolean_table);
263 zprop_register_index(ZFS_PROP_XATTR, "xattr", 1, PROP_INHERIT,
264 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "XATTR",
265 boolean_table);
266 zprop_register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT,
267 ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN",
268 boolean_table);
269 zprop_register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT,
270 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND",
271 boolean_table);
272
273 /* default index properties */
274 zprop_register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT,
275 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
276 "1 | 2 | 3 | 4 | 5 | current", "VERSION", version_table);
277 zprop_register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON,
278 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto",
279 "CANMOUNT", canmount_table);
280
281 /* readonly index (boolean) properties */
282 zprop_register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY,
283 ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table);
284 zprop_register_index(ZFS_PROP_DEFER_DESTROY, "defer_destroy", 0,
285 PROP_READONLY, ZFS_TYPE_SNAPSHOT, "yes | no", "DEFER_DESTROY",
286 boolean_table);
287
288 /* set once index properties */
289 zprop_register_index(ZFS_PROP_NORMALIZE, "normalization", 0,
290 PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
291 "none | formC | formD | formKC | formKD", "NORMALIZATION",
292 normalize_table);
293 zprop_register_index(ZFS_PROP_CASE, "casesensitivity",
294 ZFS_CASE_SENSITIVE, PROP_ONETIME, ZFS_TYPE_FILESYSTEM |
295 ZFS_TYPE_SNAPSHOT,
296 "sensitive | insensitive | mixed", "CASE", case_table);
297
298 /* set once index (boolean) properties */
299 zprop_register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME,
300 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
301 "on | off", "UTF8ONLY", boolean_table);
302
303 /* string properties */
304 zprop_register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY,
305 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN");
306 zprop_register_string(ZFS_PROP_CLONES, "clones", NULL, PROP_READONLY,
307 ZFS_TYPE_SNAPSHOT, "<dataset>[,...]", "CLONES");
308 zprop_register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/",
309 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "<path> | legacy | none",
310 "MOUNTPOINT");
311 zprop_register_string(ZFS_PROP_SHARENFS, "sharenfs", "off",
312 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "on | off | share(1M) options",
313 "SHARENFS");
314 zprop_register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY,
315 ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK,
316 "filesystem | volume | snapshot | bookmark", "TYPE");
317 zprop_register_string(ZFS_PROP_SHARESMB, "sharesmb", "off",
318 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
319 "on | off | sharemgr(1M) options", "SHARESMB");
320 zprop_register_string(ZFS_PROP_MLSLABEL, "mlslabel",
321 ZFS_MLSLABEL_DEFAULT, PROP_INHERIT, ZFS_TYPE_DATASET,
322 "<sensitivity label>", "MLSLABEL");
323
324 /* readonly number properties */
325 zprop_register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY,
326 ZFS_TYPE_DATASET, "<size>", "USED");
327 zprop_register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY,
328 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL");
329 zprop_register_number(ZFS_PROP_REFERENCED, "referenced", 0,
330 PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "REFER");
331 zprop_register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0,
332 PROP_READONLY, ZFS_TYPE_DATASET,
333 "<1.00x or higher if compressed>", "RATIO");
334 zprop_register_number(ZFS_PROP_REFRATIO, "refcompressratio", 0,
335 PROP_READONLY, ZFS_TYPE_DATASET,
336 "<1.00x or higher if compressed>", "REFRATIO");
337 zprop_register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize",
338 ZVOL_DEFAULT_BLOCKSIZE, PROP_ONETIME,
339 ZFS_TYPE_VOLUME, "512 to 128k, power of 2", "VOLBLOCK");
340 zprop_register_number(ZFS_PROP_USEDSNAP, "usedbysnapshots", 0,
341 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
342 "USEDSNAP");
343 zprop_register_number(ZFS_PROP_USEDDS, "usedbydataset", 0,
344 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
345 "USEDDS");
346 zprop_register_number(ZFS_PROP_USEDCHILD, "usedbychildren", 0,
347 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
348 "USEDCHILD");
349 zprop_register_number(ZFS_PROP_USEDREFRESERV, "usedbyrefreservation", 0,
350 PROP_READONLY,
351 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDREFRESERV");
352 zprop_register_number(ZFS_PROP_USERREFS, "userrefs", 0, PROP_READONLY,
353 ZFS_TYPE_SNAPSHOT, "<count>", "USERREFS");
354 zprop_register_number(ZFS_PROP_WRITTEN, "written", 0, PROP_READONLY,
355 ZFS_TYPE_DATASET, "<size>", "WRITTEN");
356 zprop_register_number(ZFS_PROP_LOGICALUSED, "logicalused", 0,
357 PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "LUSED");
358 zprop_register_number(ZFS_PROP_LOGICALREFERENCED, "logicalreferenced",
359 0, PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "LREFER");
360
361 /* default number properties */
362 zprop_register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT,
363 ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA");
364 zprop_register_number(ZFS_PROP_RESERVATION, "reservation", 0,
365 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
366 "<size> | none", "RESERV");
367 zprop_register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT,
368 ZFS_TYPE_VOLUME, "<size>", "VOLSIZE");
369 zprop_register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT,
370 ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA");
371 zprop_register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0,
372 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
373 "<size> | none", "REFRESERV");
374 zprop_register_number(ZFS_PROP_FILESYSTEM_LIMIT, "filesystem_limit",
375 UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM,
376 "<count> | none", "FSLIMIT");
377 zprop_register_number(ZFS_PROP_SNAPSHOT_LIMIT, "snapshot_limit",
378 UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
379 "<count> | none", "SSLIMIT");
380 zprop_register_number(ZFS_PROP_FILESYSTEM_COUNT, "filesystem_count",
381 UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM,
382 "<count>", "FSCOUNT");
383 zprop_register_number(ZFS_PROP_SNAPSHOT_COUNT, "snapshot_count",
384 UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
385 "<count>", "SSCOUNT");
386
387 /* inherit number properties */
388 zprop_register_number(ZFS_PROP_RECORDSIZE, "recordsize",
389 SPA_MAXBLOCKSIZE, PROP_INHERIT,
390 ZFS_TYPE_FILESYSTEM, "512 to 128k, power of 2", "RECSIZE");
391
392 /* hidden properties */
393 zprop_register_hidden(ZFS_PROP_CREATETXG, "createtxg", PROP_TYPE_NUMBER,
394 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "CREATETXG");
395 zprop_register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER,
396 PROP_READONLY, ZFS_TYPE_SNAPSHOT, "NUMCLONES");
397 zprop_register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING,
398 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "NAME");
399 zprop_register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions",
400 PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS");
401 zprop_register_hidden(ZFS_PROP_STMF_SHAREINFO, "stmf_sbd_lu",
402 PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME,
403 "STMF_SBD_LU");
404 zprop_register_hidden(ZFS_PROP_GUID, "guid", PROP_TYPE_NUMBER,
405 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "GUID");
406 zprop_register_hidden(ZFS_PROP_USERACCOUNTING, "useraccounting",
407 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET,
408 "USERACCOUNTING");
409 zprop_register_hidden(ZFS_PROP_UNIQUE, "unique", PROP_TYPE_NUMBER,
410 PROP_READONLY, ZFS_TYPE_DATASET, "UNIQUE");
411 zprop_register_hidden(ZFS_PROP_OBJSETID, "objsetid", PROP_TYPE_NUMBER,
412 PROP_READONLY, ZFS_TYPE_DATASET, "OBJSETID");
413 zprop_register_hidden(ZFS_PROP_INCONSISTENT, "inconsistent",
414 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, "INCONSISTENT");
415
416 /* oddball properties */
417 zprop_register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0,
418 NULL, PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK,
419 "<date>", "CREATION", B_FALSE, B_TRUE, NULL);
420 }
421
422 boolean_t
zfs_prop_delegatable(zfs_prop_t prop)423 zfs_prop_delegatable(zfs_prop_t prop)
424 {
425 zprop_desc_t *pd = &zfs_prop_table[prop];
426
427 /* The mlslabel property is never delegatable. */
428 if (prop == ZFS_PROP_MLSLABEL)
429 return (B_FALSE);
430
431 return (pd->pd_attr != PROP_READONLY);
432 }
433
434 /*
435 * Given a zfs dataset property name, returns the corresponding property ID.
436 */
437 zfs_prop_t
zfs_name_to_prop(const char * propname)438 zfs_name_to_prop(const char *propname)
439 {
440 return (zprop_name_to_prop(propname, ZFS_TYPE_DATASET));
441 }
442
443 /*
444 * For user property names, we allow all lowercase alphanumeric characters, plus
445 * a few useful punctuation characters.
446 */
447 static int
valid_char(char c)448 valid_char(char c)
449 {
450 return ((c >= 'a' && c <= 'z') ||
451 (c >= '0' && c <= '9') ||
452 c == '-' || c == '_' || c == '.' || c == ':');
453 }
454
455 /*
456 * Returns true if this is a valid user-defined property (one with a ':').
457 */
458 boolean_t
zfs_prop_user(const char * name)459 zfs_prop_user(const char *name)
460 {
461 int i;
462 char c;
463 boolean_t foundsep = B_FALSE;
464
465 for (i = 0; i < strlen(name); i++) {
466 c = name[i];
467 if (!valid_char(c))
468 return (B_FALSE);
469 if (c == ':')
470 foundsep = B_TRUE;
471 }
472
473 if (!foundsep)
474 return (B_FALSE);
475
476 return (B_TRUE);
477 }
478
479 /*
480 * Returns true if this is a valid userspace-type property (one with a '@').
481 * Note that after the @, any character is valid (eg, another @, for SID
482 * user@domain).
483 */
484 boolean_t
zfs_prop_userquota(const char * name)485 zfs_prop_userquota(const char *name)
486 {
487 zfs_userquota_prop_t prop;
488
489 for (prop = 0; prop < ZFS_NUM_USERQUOTA_PROPS; prop++) {
490 if (strncmp(name, zfs_userquota_prop_prefixes[prop],
491 strlen(zfs_userquota_prop_prefixes[prop])) == 0) {
492 return (B_TRUE);
493 }
494 }
495
496 return (B_FALSE);
497 }
498
499 /*
500 * Returns true if this is a valid written@ property.
501 * Note that after the @, any character is valid (eg, another @, for
502 * written@pool/fs@origin).
503 */
504 boolean_t
zfs_prop_written(const char * name)505 zfs_prop_written(const char *name)
506 {
507 static const char *prefix = "written@";
508 return (strncmp(name, prefix, strlen(prefix)) == 0);
509 }
510
511 /*
512 * Tables of index types, plus functions to convert between the user view
513 * (strings) and internal representation (uint64_t).
514 */
515 int
zfs_prop_string_to_index(zfs_prop_t prop,const char * string,uint64_t * index)516 zfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index)
517 {
518 return (zprop_string_to_index(prop, string, index, ZFS_TYPE_DATASET));
519 }
520
521 int
zfs_prop_index_to_string(zfs_prop_t prop,uint64_t index,const char ** string)522 zfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string)
523 {
524 return (zprop_index_to_string(prop, index, string, ZFS_TYPE_DATASET));
525 }
526
527 uint64_t
zfs_prop_random_value(zfs_prop_t prop,uint64_t seed)528 zfs_prop_random_value(zfs_prop_t prop, uint64_t seed)
529 {
530 return (zprop_random_value(prop, seed, ZFS_TYPE_DATASET));
531 }
532
533 /*
534 * Returns TRUE if the property applies to any of the given dataset types.
535 */
536 boolean_t
zfs_prop_valid_for_type(int prop,zfs_type_t types)537 zfs_prop_valid_for_type(int prop, zfs_type_t types)
538 {
539 return (zprop_valid_for_type(prop, types));
540 }
541
542 zprop_type_t
zfs_prop_get_type(zfs_prop_t prop)543 zfs_prop_get_type(zfs_prop_t prop)
544 {
545 return (zfs_prop_table[prop].pd_proptype);
546 }
547
548 /*
549 * Returns TRUE if the property is readonly.
550 */
551 boolean_t
zfs_prop_readonly(zfs_prop_t prop)552 zfs_prop_readonly(zfs_prop_t prop)
553 {
554 return (zfs_prop_table[prop].pd_attr == PROP_READONLY ||
555 zfs_prop_table[prop].pd_attr == PROP_ONETIME);
556 }
557
558 /*
559 * Returns TRUE if the property is only allowed to be set once.
560 */
561 boolean_t
zfs_prop_setonce(zfs_prop_t prop)562 zfs_prop_setonce(zfs_prop_t prop)
563 {
564 return (zfs_prop_table[prop].pd_attr == PROP_ONETIME);
565 }
566
567 const char *
zfs_prop_default_string(zfs_prop_t prop)568 zfs_prop_default_string(zfs_prop_t prop)
569 {
570 return (zfs_prop_table[prop].pd_strdefault);
571 }
572
573 uint64_t
zfs_prop_default_numeric(zfs_prop_t prop)574 zfs_prop_default_numeric(zfs_prop_t prop)
575 {
576 return (zfs_prop_table[prop].pd_numdefault);
577 }
578
579 /*
580 * Given a dataset property ID, returns the corresponding name.
581 * Assuming the zfs dataset property ID is valid.
582 */
583 const char *
zfs_prop_to_name(zfs_prop_t prop)584 zfs_prop_to_name(zfs_prop_t prop)
585 {
586 return (zfs_prop_table[prop].pd_name);
587 }
588
589 /*
590 * Returns TRUE if the property is inheritable.
591 */
592 boolean_t
zfs_prop_inheritable(zfs_prop_t prop)593 zfs_prop_inheritable(zfs_prop_t prop)
594 {
595 return (zfs_prop_table[prop].pd_attr == PROP_INHERIT ||
596 zfs_prop_table[prop].pd_attr == PROP_ONETIME);
597 }
598
599 #ifndef _KERNEL
600
601 /*
602 * Returns a string describing the set of acceptable values for the given
603 * zfs property, or NULL if it cannot be set.
604 */
605 const char *
zfs_prop_values(zfs_prop_t prop)606 zfs_prop_values(zfs_prop_t prop)
607 {
608 return (zfs_prop_table[prop].pd_values);
609 }
610
611 /*
612 * Returns TRUE if this property is a string type. Note that index types
613 * (compression, checksum) are treated as strings in userland, even though they
614 * are stored numerically on disk.
615 */
616 int
zfs_prop_is_string(zfs_prop_t prop)617 zfs_prop_is_string(zfs_prop_t prop)
618 {
619 return (zfs_prop_table[prop].pd_proptype == PROP_TYPE_STRING ||
620 zfs_prop_table[prop].pd_proptype == PROP_TYPE_INDEX);
621 }
622
623 /*
624 * Returns the column header for the given property. Used only in
625 * 'zfs list -o', but centralized here with the other property information.
626 */
627 const char *
zfs_prop_column_name(zfs_prop_t prop)628 zfs_prop_column_name(zfs_prop_t prop)
629 {
630 return (zfs_prop_table[prop].pd_colname);
631 }
632
633 /*
634 * Returns whether the given property should be displayed right-justified for
635 * 'zfs list'.
636 */
637 boolean_t
zfs_prop_align_right(zfs_prop_t prop)638 zfs_prop_align_right(zfs_prop_t prop)
639 {
640 return (zfs_prop_table[prop].pd_rightalign);
641 }
642
643 #endif
644