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 2016, Joyent, Inc.
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[] = {
172 { "2", 2 },
173 { "3", 3 },
174 { "4", 4 },
175 { "5", 5 },
176 { "current", ZPL_VERSION },
177 { NULL }
178 };
179
180 static zprop_index_t boolean_table[] = {
181 { "off", 0 },
182 { "on", 1 },
183 { NULL }
184 };
185
186 static zprop_index_t logbias_table[] = {
187 { "latency", ZFS_LOGBIAS_LATENCY },
188 { "throughput", ZFS_LOGBIAS_THROUGHPUT },
189 { NULL }
190 };
191
192 static zprop_index_t canmount_table[] = {
193 { "off", ZFS_CANMOUNT_OFF },
194 { "on", ZFS_CANMOUNT_ON },
195 { "noauto", ZFS_CANMOUNT_NOAUTO },
196 { NULL }
197 };
198
199 static zprop_index_t cache_table[] = {
200 { "none", ZFS_CACHE_NONE },
201 { "metadata", ZFS_CACHE_METADATA },
202 { "all", ZFS_CACHE_ALL },
203 { NULL }
204 };
205
206 static zprop_index_t sync_table[] = {
207 { "standard", ZFS_SYNC_STANDARD },
208 { "always", ZFS_SYNC_ALWAYS },
209 { "disabled", ZFS_SYNC_DISABLED },
210 { NULL }
211 };
212
213 static zprop_index_t redundant_metadata_table[] = {
214 { "all", ZFS_REDUNDANT_METADATA_ALL },
215 { "most", ZFS_REDUNDANT_METADATA_MOST },
216 { NULL }
217 };
218
219 /* inherit index properties */
220 zprop_register_index(ZFS_PROP_REDUNDANT_METADATA, "redundant_metadata",
221 ZFS_REDUNDANT_METADATA_ALL,
222 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
223 "all | most", "REDUND_MD",
224 redundant_metadata_table);
225 zprop_register_index(ZFS_PROP_SYNC, "sync", ZFS_SYNC_STANDARD,
226 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
227 "standard | always | disabled", "SYNC",
228 sync_table);
229 zprop_register_index(ZFS_PROP_CHECKSUM, "checksum",
230 ZIO_CHECKSUM_DEFAULT, PROP_INHERIT, ZFS_TYPE_FILESYSTEM |
231 ZFS_TYPE_VOLUME,
232 "on | off | fletcher2 | fletcher4 | sha256 | sha512 | "
233 "skein | edonr", "CHECKSUM", checksum_table);
234 zprop_register_index(ZFS_PROP_DEDUP, "dedup", ZIO_CHECKSUM_OFF,
235 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
236 "on | off | verify | sha256[,verify], sha512[,verify], "
237 "skein[,verify], edonr,verify", "DEDUP", dedup_table);
238 zprop_register_index(ZFS_PROP_COMPRESSION, "compression",
239 ZIO_COMPRESS_DEFAULT, PROP_INHERIT,
240 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
241 "on | off | lzjb | gzip | gzip-[1-9] | zle | lz4",
242 "COMPRESS", compress_table);
243 zprop_register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN,
244 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
245 "hidden | visible", "SNAPDIR", snapdir_table);
246 zprop_register_index(ZFS_PROP_ACLMODE, "aclmode", ZFS_ACL_DISCARD,
247 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
248 "discard | groupmask | passthrough | restricted", "ACLMODE",
249 acl_mode_table);
250 zprop_register_index(ZFS_PROP_ACLINHERIT, "aclinherit",
251 ZFS_ACL_RESTRICTED, PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
252 "discard | noallow | restricted | passthrough | passthrough-x",
253 "ACLINHERIT", acl_inherit_table);
254 zprop_register_index(ZFS_PROP_COPIES, "copies", 1, PROP_INHERIT,
255 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
256 "1 | 2 | 3", "COPIES", copies_table);
257 zprop_register_index(ZFS_PROP_PRIMARYCACHE, "primarycache",
258 ZFS_CACHE_ALL, PROP_INHERIT,
259 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
260 "all | none | metadata", "PRIMARYCACHE", cache_table);
261 zprop_register_index(ZFS_PROP_SECONDARYCACHE, "secondarycache",
262 ZFS_CACHE_ALL, PROP_INHERIT,
263 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
264 "all | none | metadata", "SECONDARYCACHE", cache_table);
265 zprop_register_index(ZFS_PROP_LOGBIAS, "logbias", ZFS_LOGBIAS_LATENCY,
266 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
267 "latency | throughput", "LOGBIAS", logbias_table);
268
269 /* inherit index (boolean) properties */
270 zprop_register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT,
271 ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table);
272 zprop_register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT,
273 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES",
274 boolean_table);
275 zprop_register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT,
276 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC",
277 boolean_table);
278 zprop_register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT,
279 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID",
280 boolean_table);
281 zprop_register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT,
282 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY",
283 boolean_table);
284 zprop_register_index(ZFS_PROP_ZONED, "zoned", 0, PROP_INHERIT,
285 ZFS_TYPE_FILESYSTEM, "on | off", "ZONED", boolean_table);
286 zprop_register_index(ZFS_PROP_XATTR, "xattr", 1, PROP_INHERIT,
287 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "XATTR",
288 boolean_table);
289 zprop_register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT,
290 ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN",
291 boolean_table);
292 zprop_register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT,
293 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND",
294 boolean_table);
295
296 /* default index properties */
297 zprop_register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT,
298 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
299 "1 | 2 | 3 | 4 | 5 | current", "VERSION", version_table);
300 zprop_register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON,
301 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto",
302 "CANMOUNT", canmount_table);
303
304 /* readonly index (boolean) properties */
305 zprop_register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY,
306 ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table);
307 zprop_register_index(ZFS_PROP_DEFER_DESTROY, "defer_destroy", 0,
308 PROP_READONLY, ZFS_TYPE_SNAPSHOT, "yes | no", "DEFER_DESTROY",
309 boolean_table);
310
311 /* set once index properties */
312 zprop_register_index(ZFS_PROP_NORMALIZE, "normalization", 0,
313 PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
314 "none | formC | formD | formKC | formKD", "NORMALIZATION",
315 normalize_table);
316 zprop_register_index(ZFS_PROP_CASE, "casesensitivity",
317 ZFS_CASE_SENSITIVE, PROP_ONETIME, ZFS_TYPE_FILESYSTEM |
318 ZFS_TYPE_SNAPSHOT,
319 "sensitive | insensitive | mixed", "CASE", case_table);
320
321 /* set once index (boolean) properties */
322 zprop_register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME,
323 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
324 "on | off", "UTF8ONLY", boolean_table);
325
326 /* string properties */
327 zprop_register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY,
328 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN");
329 zprop_register_string(ZFS_PROP_CLONES, "clones", NULL, PROP_READONLY,
330 ZFS_TYPE_SNAPSHOT, "<dataset>[,...]", "CLONES");
331 zprop_register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/",
332 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "<path> | legacy | none",
333 "MOUNTPOINT");
334 zprop_register_string(ZFS_PROP_SHARENFS, "sharenfs", "off",
335 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "on | off | share(1M) options",
336 "SHARENFS");
337 zprop_register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY,
338 ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK,
339 "filesystem | volume | snapshot | bookmark", "TYPE");
340 zprop_register_string(ZFS_PROP_SHARESMB, "sharesmb", "off",
341 PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
342 "on | off | sharemgr(1M) options", "SHARESMB");
343 zprop_register_string(ZFS_PROP_MLSLABEL, "mlslabel",
344 ZFS_MLSLABEL_DEFAULT, PROP_INHERIT, ZFS_TYPE_DATASET,
345 "<sensitivity label>", "MLSLABEL");
346 zprop_register_string(ZFS_PROP_RECEIVE_RESUME_TOKEN,
347 "receive_resume_token",
348 NULL, PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
349 "<string token>", "RESUMETOK");
350
351 /* readonly number properties */
352 zprop_register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY,
353 ZFS_TYPE_DATASET, "<size>", "USED");
354 zprop_register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY,
355 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL");
356 zprop_register_number(ZFS_PROP_REFERENCED, "referenced", 0,
357 PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "REFER");
358 zprop_register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0,
359 PROP_READONLY, ZFS_TYPE_DATASET,
360 "<1.00x or higher if compressed>", "RATIO");
361 zprop_register_number(ZFS_PROP_REFRATIO, "refcompressratio", 0,
362 PROP_READONLY, ZFS_TYPE_DATASET,
363 "<1.00x or higher if compressed>", "REFRATIO");
364 zprop_register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize",
365 ZVOL_DEFAULT_BLOCKSIZE, PROP_ONETIME,
366 ZFS_TYPE_VOLUME, "512 to 128k, power of 2", "VOLBLOCK");
367 zprop_register_number(ZFS_PROP_USEDSNAP, "usedbysnapshots", 0,
368 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
369 "USEDSNAP");
370 zprop_register_number(ZFS_PROP_USEDDS, "usedbydataset", 0,
371 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
372 "USEDDS");
373 zprop_register_number(ZFS_PROP_USEDCHILD, "usedbychildren", 0,
374 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
375 "USEDCHILD");
376 zprop_register_number(ZFS_PROP_USEDREFRESERV, "usedbyrefreservation", 0,
377 PROP_READONLY,
378 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDREFRESERV");
379 zprop_register_number(ZFS_PROP_USERREFS, "userrefs", 0, PROP_READONLY,
380 ZFS_TYPE_SNAPSHOT, "<count>", "USERREFS");
381 zprop_register_number(ZFS_PROP_WRITTEN, "written", 0, PROP_READONLY,
382 ZFS_TYPE_DATASET, "<size>", "WRITTEN");
383 zprop_register_number(ZFS_PROP_LOGICALUSED, "logicalused", 0,
384 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
385 "LUSED");
386 zprop_register_number(ZFS_PROP_LOGICALREFERENCED, "logicalreferenced",
387 0, PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "LREFER");
388 zprop_register_number(ZFS_PROP_FILESYSTEM_COUNT, "filesystem_count",
389 UINT64_MAX, PROP_READONLY, ZFS_TYPE_FILESYSTEM,
390 "<count>", "FSCOUNT");
391 zprop_register_number(ZFS_PROP_SNAPSHOT_COUNT, "snapshot_count",
392 UINT64_MAX, PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
393 "<count>", "SSCOUNT");
394
395 /* default number properties */
396 zprop_register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT,
397 ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA");
398 zprop_register_number(ZFS_PROP_RESERVATION, "reservation", 0,
399 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
400 "<size> | none", "RESERV");
401 zprop_register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT,
402 ZFS_TYPE_VOLUME, "<size>", "VOLSIZE");
403 zprop_register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT,
404 ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA");
405 zprop_register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0,
406 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
407 "<size> | none", "REFRESERV");
408 zprop_register_number(ZFS_PROP_FILESYSTEM_LIMIT, "filesystem_limit",
409 UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM,
410 "<count> | none", "FSLIMIT");
411 zprop_register_number(ZFS_PROP_SNAPSHOT_LIMIT, "snapshot_limit",
412 UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
413 "<count> | none", "SSLIMIT");
414
415 /* inherit number properties */
416 zprop_register_number(ZFS_PROP_RECORDSIZE, "recordsize",
417 SPA_OLD_MAXBLOCKSIZE, PROP_INHERIT,
418 ZFS_TYPE_FILESYSTEM, "512 to 1M, power of 2", "RECSIZE");
419
420 /* hidden properties */
421 zprop_register_hidden(ZFS_PROP_CREATETXG, "createtxg", PROP_TYPE_NUMBER,
422 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "CREATETXG");
423 zprop_register_hidden(ZFS_PROP_REMAPTXG, "remaptxg", PROP_TYPE_NUMBER,
424 PROP_READONLY, ZFS_TYPE_DATASET, "REMAPTXG");
425 zprop_register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER,
426 PROP_READONLY, ZFS_TYPE_SNAPSHOT, "NUMCLONES");
427 zprop_register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING,
428 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "NAME");
429 zprop_register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions",
430 PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS");
431 zprop_register_hidden(ZFS_PROP_STMF_SHAREINFO, "stmf_sbd_lu",
432 PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME,
433 "STMF_SBD_LU");
434 zprop_register_hidden(ZFS_PROP_GUID, "guid", PROP_TYPE_NUMBER,
435 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "GUID");
436 zprop_register_hidden(ZFS_PROP_USERACCOUNTING, "useraccounting",
437 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET,
438 "USERACCOUNTING");
439 zprop_register_hidden(ZFS_PROP_UNIQUE, "unique", PROP_TYPE_NUMBER,
440 PROP_READONLY, ZFS_TYPE_DATASET, "UNIQUE");
441 zprop_register_hidden(ZFS_PROP_OBJSETID, "objsetid", PROP_TYPE_NUMBER,
442 PROP_READONLY, ZFS_TYPE_DATASET, "OBJSETID");
443 zprop_register_hidden(ZFS_PROP_INCONSISTENT, "inconsistent",
444 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, "INCONSISTENT");
445 zprop_register_hidden(ZFS_PROP_PREV_SNAP, "prevsnap", PROP_TYPE_STRING,
446 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "PREVSNAP");
447
448 /* oddball properties */
449 zprop_register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0,
450 NULL, PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK,
451 "<date>", "CREATION", B_FALSE, B_TRUE, NULL);
452 }
453
454 boolean_t
455 zfs_prop_delegatable(zfs_prop_t prop)
456 {
457 zprop_desc_t *pd = &zfs_prop_table[prop];
458
459 /* The mlslabel property is never delegatable. */
460 if (prop == ZFS_PROP_MLSLABEL)
461 return (B_FALSE);
462
463 return (pd->pd_attr != PROP_READONLY);
464 }
465
466 /*
|
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[] = {
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 /*
|