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