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