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