1fa9e4066Sahrens /* 2fa9e4066Sahrens * CDDL HEADER START 3fa9e4066Sahrens * 4fa9e4066Sahrens * The contents of this file are subject to the terms of the 5906d120cSlling * Common Development and Distribution License (the "License"). 6906d120cSlling * You may not use this file except in compliance with the License. 7fa9e4066Sahrens * 8fa9e4066Sahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9fa9e4066Sahrens * or http://www.opensolaris.org/os/licensing. 10fa9e4066Sahrens * See the License for the specific language governing permissions 11fa9e4066Sahrens * and limitations under the License. 12fa9e4066Sahrens * 13fa9e4066Sahrens * When distributing Covered Code, include this CDDL HEADER in each 14fa9e4066Sahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15fa9e4066Sahrens * If applicable, add the following below this CDDL HEADER, with the 16fa9e4066Sahrens * fields enclosed by brackets "[]" replaced with your own identifying 17fa9e4066Sahrens * information: Portions Copyright [yyyy] [name of copyright owner] 18fa9e4066Sahrens * 19fa9e4066Sahrens * CDDL HEADER END 20fa9e4066Sahrens */ 21fa9e4066Sahrens /* 2227dd1e87SMark Shellenbaum * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 2378f17100SMatthew Ahrens * Copyright (c) 2013 by Delphix. All rights reserved. 24a6f561b4SSašo Kiselkov * Copyright (c) 2013 by Saso Kiselkov. All rights reserved. 25810e43b2SBill Pijewski * Copyright (c) 2013, Joyent, Inc. All rights reserved. 26fa9e4066Sahrens */ 27fa9e4066Sahrens 2855da60b9SMark J Musante /* Portions Copyright 2010 Robert Milkowski */ 2955da60b9SMark J Musante 30fa9e4066Sahrens #include <sys/zio.h> 31fa9e4066Sahrens #include <sys/spa.h> 32de8267e0Stimh #include <sys/u8_textprep.h> 33fa9e4066Sahrens #include <sys/zfs_acl.h> 34fa9e4066Sahrens #include <sys/zfs_ioctl.h> 35e7437265Sahrens #include <sys/zfs_znode.h> 36fa9e4066Sahrens 37fa9e4066Sahrens #include "zfs_prop.h" 38ecd6cf80Smarks #include "zfs_deleg.h" 39fa9e4066Sahrens 40fa9e4066Sahrens #if defined(_KERNEL) 41fa9e4066Sahrens #include <sys/systm.h> 42fa9e4066Sahrens #else 43fa9e4066Sahrens #include <stdlib.h> 44fa9e4066Sahrens #include <string.h> 45fa9e4066Sahrens #include <ctype.h> 46fa9e4066Sahrens #endif 47fa9e4066Sahrens 48990b4856Slling static zprop_desc_t zfs_prop_table[ZFS_NUM_PROPS]; 4991ebeef5Sahrens 5014843421SMatthew Ahrens /* Note this is indexed by zfs_userquota_prop_t, keep the order the same */ 5114843421SMatthew Ahrens const char *zfs_userquota_prop_prefixes[] = { 5214843421SMatthew Ahrens "userused@", 5314843421SMatthew Ahrens "userquota@", 5414843421SMatthew Ahrens "groupused@", 5514843421SMatthew Ahrens "groupquota@" 5614843421SMatthew Ahrens }; 5714843421SMatthew Ahrens 58990b4856Slling zprop_desc_t * 59990b4856Slling zfs_prop_get_table(void) 6091ebeef5Sahrens { 61990b4856Slling return (zfs_prop_table); 6291ebeef5Sahrens } 6391ebeef5Sahrens 6491ebeef5Sahrens void 6591ebeef5Sahrens zfs_prop_init(void) 6691ebeef5Sahrens { 67990b4856Slling static zprop_index_t checksum_table[] = { 6891ebeef5Sahrens { "on", ZIO_CHECKSUM_ON }, 6991ebeef5Sahrens { "off", ZIO_CHECKSUM_OFF }, 7091ebeef5Sahrens { "fletcher2", ZIO_CHECKSUM_FLETCHER_2 }, 7191ebeef5Sahrens { "fletcher4", ZIO_CHECKSUM_FLETCHER_4 }, 7291ebeef5Sahrens { "sha256", ZIO_CHECKSUM_SHA256 }, 73810e43b2SBill Pijewski { "noparity", ZIO_CHECKSUM_NOPARITY }, 7491ebeef5Sahrens { NULL } 7591ebeef5Sahrens }; 7691ebeef5Sahrens 77b24ab676SJeff Bonwick static zprop_index_t dedup_table[] = { 78b24ab676SJeff Bonwick { "on", ZIO_CHECKSUM_ON }, 79b24ab676SJeff Bonwick { "off", ZIO_CHECKSUM_OFF }, 80b24ab676SJeff Bonwick { "verify", ZIO_CHECKSUM_ON | ZIO_CHECKSUM_VERIFY }, 81b24ab676SJeff Bonwick { "sha256", ZIO_CHECKSUM_SHA256 }, 82b24ab676SJeff Bonwick { "sha256,verify", 83b24ab676SJeff Bonwick ZIO_CHECKSUM_SHA256 | ZIO_CHECKSUM_VERIFY }, 84b24ab676SJeff Bonwick { NULL } 85b24ab676SJeff Bonwick }; 86b24ab676SJeff Bonwick 87990b4856Slling static zprop_index_t compress_table[] = { 8891ebeef5Sahrens { "on", ZIO_COMPRESS_ON }, 8991ebeef5Sahrens { "off", ZIO_COMPRESS_OFF }, 9091ebeef5Sahrens { "lzjb", ZIO_COMPRESS_LZJB }, 9191ebeef5Sahrens { "gzip", ZIO_COMPRESS_GZIP_6 }, /* gzip default */ 9291ebeef5Sahrens { "gzip-1", ZIO_COMPRESS_GZIP_1 }, 9391ebeef5Sahrens { "gzip-2", ZIO_COMPRESS_GZIP_2 }, 9491ebeef5Sahrens { "gzip-3", ZIO_COMPRESS_GZIP_3 }, 9591ebeef5Sahrens { "gzip-4", ZIO_COMPRESS_GZIP_4 }, 9691ebeef5Sahrens { "gzip-5", ZIO_COMPRESS_GZIP_5 }, 9791ebeef5Sahrens { "gzip-6", ZIO_COMPRESS_GZIP_6 }, 9891ebeef5Sahrens { "gzip-7", ZIO_COMPRESS_GZIP_7 }, 9991ebeef5Sahrens { "gzip-8", ZIO_COMPRESS_GZIP_8 }, 10091ebeef5Sahrens { "gzip-9", ZIO_COMPRESS_GZIP_9 }, 101b24ab676SJeff Bonwick { "zle", ZIO_COMPRESS_ZLE }, 102a6f561b4SSašo Kiselkov { "lz4", ZIO_COMPRESS_LZ4 }, 10391ebeef5Sahrens { NULL } 10491ebeef5Sahrens }; 10591ebeef5Sahrens 106990b4856Slling static zprop_index_t snapdir_table[] = { 10791ebeef5Sahrens { "hidden", ZFS_SNAPDIR_HIDDEN }, 10891ebeef5Sahrens { "visible", ZFS_SNAPDIR_VISIBLE }, 10991ebeef5Sahrens { NULL } 11091ebeef5Sahrens }; 11191ebeef5Sahrens 112a3c49ce1SAlbert Lee static zprop_index_t acl_mode_table[] = { 113a3c49ce1SAlbert Lee { "discard", ZFS_ACL_DISCARD }, 114a3c49ce1SAlbert Lee { "groupmask", ZFS_ACL_GROUPMASK }, 115a3c49ce1SAlbert Lee { "passthrough", ZFS_ACL_PASSTHROUGH }, 11671dbfc28SPaul B. Henson { "restricted", ZFS_ACL_RESTRICTED }, 117a3c49ce1SAlbert Lee { NULL } 118a3c49ce1SAlbert Lee }; 119a3c49ce1SAlbert Lee 120990b4856Slling static zprop_index_t acl_inherit_table[] = { 12191ebeef5Sahrens { "discard", ZFS_ACL_DISCARD }, 12291ebeef5Sahrens { "noallow", ZFS_ACL_NOALLOW }, 123b3d141f8Smarks { "restricted", ZFS_ACL_RESTRICTED }, 12491ebeef5Sahrens { "passthrough", ZFS_ACL_PASSTHROUGH }, 125b3d141f8Smarks { "secure", ZFS_ACL_RESTRICTED }, /* bkwrd compatability */ 126d0f3f37eSMark Shellenbaum { "passthrough-x", ZFS_ACL_PASSTHROUGH_X }, 12791ebeef5Sahrens { NULL } 12891ebeef5Sahrens }; 12991ebeef5Sahrens 130da6c28aaSamw static zprop_index_t case_table[] = { 131da6c28aaSamw { "sensitive", ZFS_CASE_SENSITIVE }, 132da6c28aaSamw { "insensitive", ZFS_CASE_INSENSITIVE }, 133da6c28aaSamw { "mixed", ZFS_CASE_MIXED }, 134da6c28aaSamw { NULL } 135da6c28aaSamw }; 136da6c28aaSamw 137990b4856Slling static zprop_index_t copies_table[] = { 13891ebeef5Sahrens { "1", 1 }, 13991ebeef5Sahrens { "2", 2 }, 14091ebeef5Sahrens { "3", 3 }, 14191ebeef5Sahrens { NULL } 14291ebeef5Sahrens }; 14391ebeef5Sahrens 144de8267e0Stimh /* 145de8267e0Stimh * Use the unique flags we have to send to u8_strcmp() and/or 146de8267e0Stimh * u8_textprep() to represent the various normalization property 147de8267e0Stimh * values. 148de8267e0Stimh */ 149da6c28aaSamw static zprop_index_t normalize_table[] = { 150de8267e0Stimh { "none", 0 }, 151de8267e0Stimh { "formD", U8_TEXTPREP_NFD }, 152de8267e0Stimh { "formKC", U8_TEXTPREP_NFKC }, 153de8267e0Stimh { "formC", U8_TEXTPREP_NFC }, 154de8267e0Stimh { "formKD", U8_TEXTPREP_NFKD }, 155da6c28aaSamw { NULL } 156da6c28aaSamw }; 157da6c28aaSamw 158990b4856Slling static zprop_index_t version_table[] = { 15991ebeef5Sahrens { "1", 1 }, 16091ebeef5Sahrens { "2", 2 }, 161da6c28aaSamw { "3", 3 }, 16214843421SMatthew Ahrens { "4", 4 }, 1630a586ceaSMark Shellenbaum { "5", 5 }, 16491ebeef5Sahrens { "current", ZPL_VERSION }, 16591ebeef5Sahrens { NULL } 16691ebeef5Sahrens }; 16791ebeef5Sahrens 168990b4856Slling static zprop_index_t boolean_table[] = { 169e45ce728Sahrens { "off", 0 }, 170e45ce728Sahrens { "on", 1 }, 171e45ce728Sahrens { NULL } 172e45ce728Sahrens }; 173e45ce728Sahrens 174e09fa4daSNeil Perrin static zprop_index_t logbias_table[] = { 175e09fa4daSNeil Perrin { "latency", ZFS_LOGBIAS_LATENCY }, 176e09fa4daSNeil Perrin { "throughput", ZFS_LOGBIAS_THROUGHPUT }, 177e09fa4daSNeil Perrin { NULL } 178e09fa4daSNeil Perrin }; 179e09fa4daSNeil Perrin 180a227b7f4Shs static zprop_index_t canmount_table[] = { 181a227b7f4Shs { "off", ZFS_CANMOUNT_OFF }, 182a227b7f4Shs { "on", ZFS_CANMOUNT_ON }, 183a227b7f4Shs { "noauto", ZFS_CANMOUNT_NOAUTO }, 184a227b7f4Shs { NULL } 185a227b7f4Shs }; 186a227b7f4Shs 1873baa08fcSek static zprop_index_t cache_table[] = { 1883baa08fcSek { "none", ZFS_CACHE_NONE }, 1893baa08fcSek { "metadata", ZFS_CACHE_METADATA }, 1903baa08fcSek { "all", ZFS_CACHE_ALL }, 1913baa08fcSek { NULL } 1923baa08fcSek }; 1933baa08fcSek 19455da60b9SMark J Musante static zprop_index_t sync_table[] = { 19555da60b9SMark J Musante { "standard", ZFS_SYNC_STANDARD }, 19655da60b9SMark J Musante { "always", ZFS_SYNC_ALWAYS }, 19755da60b9SMark J Musante { "disabled", ZFS_SYNC_DISABLED }, 19855da60b9SMark J Musante { NULL } 19955da60b9SMark J Musante }; 20055da60b9SMark J Musante 20191ebeef5Sahrens /* inherit index properties */ 20255da60b9SMark J Musante zprop_register_index(ZFS_PROP_SYNC, "sync", ZFS_SYNC_STANDARD, 20355da60b9SMark J Musante PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 20455da60b9SMark J Musante "standard | always | disabled", "SYNC", 20555da60b9SMark J Musante sync_table); 20683d7f9feSTom Erickson zprop_register_index(ZFS_PROP_CHECKSUM, "checksum", 20783d7f9feSTom Erickson ZIO_CHECKSUM_DEFAULT, PROP_INHERIT, ZFS_TYPE_FILESYSTEM | 20883d7f9feSTom Erickson ZFS_TYPE_VOLUME, 20991ebeef5Sahrens "on | off | fletcher2 | fletcher4 | sha256", "CHECKSUM", 21091ebeef5Sahrens checksum_table); 21183d7f9feSTom Erickson zprop_register_index(ZFS_PROP_DEDUP, "dedup", ZIO_CHECKSUM_OFF, 212b24ab676SJeff Bonwick PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 213b1033ae2SMatthew Ahrens "on | off | verify | sha256[,verify]", "DEDUP", 214b24ab676SJeff Bonwick dedup_table); 21583d7f9feSTom Erickson zprop_register_index(ZFS_PROP_COMPRESSION, "compression", 216e45ce728Sahrens ZIO_COMPRESS_DEFAULT, PROP_INHERIT, 217e45ce728Sahrens ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 218a6f561b4SSašo Kiselkov "on | off | lzjb | gzip | gzip-[1-9] | zle | lz4", 219a6f561b4SSašo Kiselkov "COMPRESS", compress_table); 22083d7f9feSTom Erickson zprop_register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN, 221e45ce728Sahrens PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 222e45ce728Sahrens "hidden | visible", "SNAPDIR", snapdir_table); 223a3c49ce1SAlbert Lee zprop_register_index(ZFS_PROP_ACLMODE, "aclmode", ZFS_ACL_DISCARD, 224a3c49ce1SAlbert Lee PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 22571dbfc28SPaul B. Henson "discard | groupmask | passthrough | restricted", "ACLMODE", 22671dbfc28SPaul B. Henson acl_mode_table); 22783d7f9feSTom Erickson zprop_register_index(ZFS_PROP_ACLINHERIT, "aclinherit", 22883d7f9feSTom Erickson ZFS_ACL_RESTRICTED, PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 229d0f3f37eSMark Shellenbaum "discard | noallow | restricted | passthrough | passthrough-x", 230b3d141f8Smarks "ACLINHERIT", acl_inherit_table); 23183d7f9feSTom Erickson zprop_register_index(ZFS_PROP_COPIES, "copies", 1, PROP_INHERIT, 23283d7f9feSTom Erickson ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 23391ebeef5Sahrens "1 | 2 | 3", "COPIES", copies_table); 23483d7f9feSTom Erickson zprop_register_index(ZFS_PROP_PRIMARYCACHE, "primarycache", 2353baa08fcSek ZFS_CACHE_ALL, PROP_INHERIT, 2363baa08fcSek ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, 2373baa08fcSek "all | none | metadata", "PRIMARYCACHE", cache_table); 23883d7f9feSTom Erickson zprop_register_index(ZFS_PROP_SECONDARYCACHE, "secondarycache", 2393baa08fcSek ZFS_CACHE_ALL, PROP_INHERIT, 2403baa08fcSek ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, 2413baa08fcSek "all | none | metadata", "SECONDARYCACHE", cache_table); 24283d7f9feSTom Erickson zprop_register_index(ZFS_PROP_LOGBIAS, "logbias", ZFS_LOGBIAS_LATENCY, 243e09fa4daSNeil Perrin PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 244e09fa4daSNeil Perrin "latency | throughput", "LOGBIAS", logbias_table); 245e45ce728Sahrens 246e45ce728Sahrens /* inherit index (boolean) properties */ 24783d7f9feSTom Erickson zprop_register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT, 248e45ce728Sahrens ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table); 24983d7f9feSTom Erickson zprop_register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT, 250e45ce728Sahrens ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES", 251e45ce728Sahrens boolean_table); 25283d7f9feSTom Erickson zprop_register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT, 253e45ce728Sahrens ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC", 254e45ce728Sahrens boolean_table); 25583d7f9feSTom Erickson zprop_register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT, 256e45ce728Sahrens ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID", 257e45ce728Sahrens boolean_table); 25883d7f9feSTom Erickson zprop_register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT, 259e45ce728Sahrens ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY", 260e45ce728Sahrens boolean_table); 26183d7f9feSTom Erickson zprop_register_index(ZFS_PROP_ZONED, "zoned", 0, PROP_INHERIT, 262e45ce728Sahrens ZFS_TYPE_FILESYSTEM, "on | off", "ZONED", boolean_table); 26383d7f9feSTom Erickson zprop_register_index(ZFS_PROP_XATTR, "xattr", 1, PROP_INHERIT, 264e45ce728Sahrens ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "XATTR", 265e45ce728Sahrens boolean_table); 26683d7f9feSTom Erickson zprop_register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT, 267da6c28aaSamw ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN", 268da6c28aaSamw boolean_table); 26983d7f9feSTom Erickson zprop_register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT, 270da6c28aaSamw ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND", 271da6c28aaSamw boolean_table); 272e45ce728Sahrens 273e45ce728Sahrens /* default index properties */ 27483d7f9feSTom Erickson zprop_register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT, 2757b55fa8eSck ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 27619b94df9SMatthew Ahrens "1 | 2 | 3 | 4 | 5 | current", "VERSION", version_table); 27783d7f9feSTom Erickson zprop_register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON, 278a227b7f4Shs PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto", 279a227b7f4Shs "CANMOUNT", canmount_table); 280e45ce728Sahrens 281e45ce728Sahrens /* readonly index (boolean) properties */ 28283d7f9feSTom Erickson zprop_register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY, 283990b4856Slling ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table); 28483d7f9feSTom Erickson zprop_register_index(ZFS_PROP_DEFER_DESTROY, "defer_destroy", 0, 285842727c2SChris Kirby PROP_READONLY, ZFS_TYPE_SNAPSHOT, "yes | no", "DEFER_DESTROY", 286842727c2SChris Kirby boolean_table); 287e45ce728Sahrens 288da6c28aaSamw /* set once index properties */ 28983d7f9feSTom Erickson zprop_register_index(ZFS_PROP_NORMALIZE, "normalization", 0, 290da6c28aaSamw PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 291da6c28aaSamw "none | formC | formD | formKC | formKD", "NORMALIZATION", 292da6c28aaSamw normalize_table); 29383d7f9feSTom Erickson zprop_register_index(ZFS_PROP_CASE, "casesensitivity", 29483d7f9feSTom Erickson ZFS_CASE_SENSITIVE, PROP_ONETIME, ZFS_TYPE_FILESYSTEM | 29583d7f9feSTom Erickson ZFS_TYPE_SNAPSHOT, 296da6c28aaSamw "sensitive | insensitive | mixed", "CASE", case_table); 297da6c28aaSamw 298da6c28aaSamw /* set once index (boolean) properties */ 29983d7f9feSTom Erickson zprop_register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME, 300da6c28aaSamw ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 301da6c28aaSamw "on | off", "UTF8ONLY", boolean_table); 302da6c28aaSamw 30391ebeef5Sahrens /* string properties */ 30483d7f9feSTom Erickson zprop_register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY, 30591ebeef5Sahrens ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN"); 30619b94df9SMatthew Ahrens zprop_register_string(ZFS_PROP_CLONES, "clones", NULL, PROP_READONLY, 30719b94df9SMatthew Ahrens ZFS_TYPE_SNAPSHOT, "<dataset>[,...]", "CLONES"); 30883d7f9feSTom Erickson zprop_register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/", 30983d7f9feSTom Erickson PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "<path> | legacy | none", 31083d7f9feSTom Erickson "MOUNTPOINT"); 31183d7f9feSTom Erickson zprop_register_string(ZFS_PROP_SHARENFS, "sharenfs", "off", 31283d7f9feSTom Erickson PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "on | off | share(1M) options", 31383d7f9feSTom Erickson "SHARENFS"); 31483d7f9feSTom Erickson zprop_register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY, 31578f17100SMatthew Ahrens ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, 31678f17100SMatthew Ahrens "filesystem | volume | snapshot | bookmark", "TYPE"); 31783d7f9feSTom Erickson zprop_register_string(ZFS_PROP_SHARESMB, "sharesmb", "off", 31883d7f9feSTom Erickson PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 31983d7f9feSTom Erickson "on | off | sharemgr(1M) options", "SHARESMB"); 32083d7f9feSTom Erickson zprop_register_string(ZFS_PROP_MLSLABEL, "mlslabel", 32183d7f9feSTom Erickson ZFS_MLSLABEL_DEFAULT, PROP_INHERIT, ZFS_TYPE_DATASET, 32283d7f9feSTom Erickson "<sensitivity label>", "MLSLABEL"); 32391ebeef5Sahrens 32491ebeef5Sahrens /* readonly number properties */ 32583d7f9feSTom Erickson zprop_register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY, 326990b4856Slling ZFS_TYPE_DATASET, "<size>", "USED"); 32783d7f9feSTom Erickson zprop_register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY, 328990b4856Slling ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL"); 32983d7f9feSTom Erickson zprop_register_number(ZFS_PROP_REFERENCED, "referenced", 0, 33083d7f9feSTom Erickson PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "REFER"); 33183d7f9feSTom Erickson zprop_register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0, 332990b4856Slling PROP_READONLY, ZFS_TYPE_DATASET, 33391ebeef5Sahrens "<1.00x or higher if compressed>", "RATIO"); 334187d6ac0SMatt Ahrens zprop_register_number(ZFS_PROP_REFRATIO, "refcompressratio", 0, 335187d6ac0SMatt Ahrens PROP_READONLY, ZFS_TYPE_DATASET, 336187d6ac0SMatt Ahrens "<1.00x or higher if compressed>", "REFRATIO"); 33783d7f9feSTom Erickson zprop_register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize", 338c1449561SEric Taylor ZVOL_DEFAULT_BLOCKSIZE, PROP_ONETIME, 339da6c28aaSamw ZFS_TYPE_VOLUME, "512 to 128k, power of 2", "VOLBLOCK"); 34083d7f9feSTom Erickson zprop_register_number(ZFS_PROP_USEDSNAP, "usedbysnapshots", 0, 34183d7f9feSTom Erickson PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 34283d7f9feSTom Erickson "USEDSNAP"); 34383d7f9feSTom Erickson zprop_register_number(ZFS_PROP_USEDDS, "usedbydataset", 0, 34483d7f9feSTom Erickson PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 34583d7f9feSTom Erickson "USEDDS"); 34683d7f9feSTom Erickson zprop_register_number(ZFS_PROP_USEDCHILD, "usedbychildren", 0, 34783d7f9feSTom Erickson PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 34883d7f9feSTom Erickson "USEDCHILD"); 34983d7f9feSTom Erickson zprop_register_number(ZFS_PROP_USEDREFRESERV, "usedbyrefreservation", 0, 35074e7dc98SMatthew Ahrens PROP_READONLY, 35174e7dc98SMatthew Ahrens ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDREFRESERV"); 35283d7f9feSTom Erickson zprop_register_number(ZFS_PROP_USERREFS, "userrefs", 0, PROP_READONLY, 353842727c2SChris Kirby ZFS_TYPE_SNAPSHOT, "<count>", "USERREFS"); 35419b94df9SMatthew Ahrens zprop_register_number(ZFS_PROP_WRITTEN, "written", 0, PROP_READONLY, 35519b94df9SMatthew Ahrens ZFS_TYPE_DATASET, "<size>", "WRITTEN"); 35677372cb0SMatthew Ahrens zprop_register_number(ZFS_PROP_LOGICALUSED, "logicalused", 0, 35777372cb0SMatthew Ahrens PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "LUSED"); 35877372cb0SMatthew Ahrens zprop_register_number(ZFS_PROP_LOGICALREFERENCED, "logicalreferenced", 35977372cb0SMatthew Ahrens 0, PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "LREFER"); 36091ebeef5Sahrens 36191ebeef5Sahrens /* default number properties */ 36283d7f9feSTom Erickson zprop_register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT, 36391ebeef5Sahrens ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA"); 36483d7f9feSTom Erickson zprop_register_number(ZFS_PROP_RESERVATION, "reservation", 0, 36583d7f9feSTom Erickson PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 36683d7f9feSTom Erickson "<size> | none", "RESERV"); 36783d7f9feSTom Erickson zprop_register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT, 36891ebeef5Sahrens ZFS_TYPE_VOLUME, "<size>", "VOLSIZE"); 36983d7f9feSTom Erickson zprop_register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT, 370a9799022Sck ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA"); 37183d7f9feSTom Erickson zprop_register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0, 372a9799022Sck PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 373a9799022Sck "<size> | none", "REFRESERV"); 374*a2afb611SJerry Jelinek zprop_register_number(ZFS_PROP_FILESYSTEM_LIMIT, "filesystem_limit", 375*a2afb611SJerry Jelinek UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, 376*a2afb611SJerry Jelinek "<count> | none", "FSLIMIT"); 377*a2afb611SJerry Jelinek zprop_register_number(ZFS_PROP_SNAPSHOT_LIMIT, "snapshot_limit", 378*a2afb611SJerry Jelinek UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 379*a2afb611SJerry Jelinek "<count> | none", "SSLIMIT"); 380*a2afb611SJerry Jelinek zprop_register_number(ZFS_PROP_FILESYSTEM_COUNT, "filesystem_count", 381*a2afb611SJerry Jelinek UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, 382*a2afb611SJerry Jelinek "<count>", "FSCOUNT"); 383*a2afb611SJerry Jelinek zprop_register_number(ZFS_PROP_SNAPSHOT_COUNT, "snapshot_count", 384*a2afb611SJerry Jelinek UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 385*a2afb611SJerry Jelinek "<count>", "SSCOUNT"); 38691ebeef5Sahrens 38791ebeef5Sahrens /* inherit number properties */ 38883d7f9feSTom Erickson zprop_register_number(ZFS_PROP_RECORDSIZE, "recordsize", 38983d7f9feSTom Erickson SPA_MAXBLOCKSIZE, PROP_INHERIT, 39091ebeef5Sahrens ZFS_TYPE_FILESYSTEM, "512 to 128k, power of 2", "RECSIZE"); 39191ebeef5Sahrens 39291ebeef5Sahrens /* hidden properties */ 39383d7f9feSTom Erickson zprop_register_hidden(ZFS_PROP_CREATETXG, "createtxg", PROP_TYPE_NUMBER, 39478f17100SMatthew Ahrens PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "CREATETXG"); 39583d7f9feSTom Erickson zprop_register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER, 396b24ab676SJeff Bonwick PROP_READONLY, ZFS_TYPE_SNAPSHOT, "NUMCLONES"); 39783d7f9feSTom Erickson zprop_register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING, 39878f17100SMatthew Ahrens PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "NAME"); 39983d7f9feSTom Erickson zprop_register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions", 40083d7f9feSTom Erickson PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS"); 40183d7f9feSTom Erickson zprop_register_hidden(ZFS_PROP_STMF_SHAREINFO, "stmf_sbd_lu", 402478ed9adSEric Taylor PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, 403478ed9adSEric Taylor "STMF_SBD_LU"); 40483d7f9feSTom Erickson zprop_register_hidden(ZFS_PROP_GUID, "guid", PROP_TYPE_NUMBER, 40578f17100SMatthew Ahrens PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "GUID"); 40683d7f9feSTom Erickson zprop_register_hidden(ZFS_PROP_USERACCOUNTING, "useraccounting", 407b24ab676SJeff Bonwick PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, 408b24ab676SJeff Bonwick "USERACCOUNTING"); 40983d7f9feSTom Erickson zprop_register_hidden(ZFS_PROP_UNIQUE, "unique", PROP_TYPE_NUMBER, 410b24ab676SJeff Bonwick PROP_READONLY, ZFS_TYPE_DATASET, "UNIQUE"); 41183d7f9feSTom Erickson zprop_register_hidden(ZFS_PROP_OBJSETID, "objsetid", PROP_TYPE_NUMBER, 4121d713200SEric Schrock PROP_READONLY, ZFS_TYPE_DATASET, "OBJSETID"); 413ca48f36fSKeith M Wesolowski zprop_register_hidden(ZFS_PROP_INCONSISTENT, "inconsistent", 414ca48f36fSKeith M Wesolowski PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, "INCONSISTENT"); 41591ebeef5Sahrens 41691ebeef5Sahrens /* oddball properties */ 41783d7f9feSTom Erickson zprop_register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0, 41878f17100SMatthew Ahrens NULL, PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, 41991ebeef5Sahrens "<date>", "CREATION", B_FALSE, B_TRUE, NULL); 42091ebeef5Sahrens } 42191ebeef5Sahrens 422b1b8ab34Slling boolean_t 423990b4856Slling zfs_prop_delegatable(zfs_prop_t prop) 424fa9e4066Sahrens { 425990b4856Slling zprop_desc_t *pd = &zfs_prop_table[prop]; 4264201a95eSRic Aleshire 4274201a95eSRic Aleshire /* The mlslabel property is never delegatable. */ 4284201a95eSRic Aleshire if (prop == ZFS_PROP_MLSLABEL) 4294201a95eSRic Aleshire return (B_FALSE); 4304201a95eSRic Aleshire 431990b4856Slling return (pd->pd_attr != PROP_READONLY); 432fa9e4066Sahrens } 433fa9e4066Sahrens 434b1b8ab34Slling /* 435b1b8ab34Slling * Given a zfs dataset property name, returns the corresponding property ID. 436b1b8ab34Slling */ 437b1b8ab34Slling zfs_prop_t 438b1b8ab34Slling zfs_name_to_prop(const char *propname) 439b1b8ab34Slling { 440990b4856Slling return (zprop_name_to_prop(propname, ZFS_TYPE_DATASET)); 441b1b8ab34Slling } 442b1b8ab34Slling 443e9dbad6fSeschrock /* 444e9dbad6fSeschrock * For user property names, we allow all lowercase alphanumeric characters, plus 445e9dbad6fSeschrock * a few useful punctuation characters. 446e9dbad6fSeschrock */ 447e9dbad6fSeschrock static int 448e9dbad6fSeschrock valid_char(char c) 449e9dbad6fSeschrock { 450e9dbad6fSeschrock return ((c >= 'a' && c <= 'z') || 451e9dbad6fSeschrock (c >= '0' && c <= '9') || 452e9dbad6fSeschrock c == '-' || c == '_' || c == '.' || c == ':'); 453e9dbad6fSeschrock } 454e9dbad6fSeschrock 455e9dbad6fSeschrock /* 456e9dbad6fSeschrock * Returns true if this is a valid user-defined property (one with a ':'). 457e9dbad6fSeschrock */ 458e9dbad6fSeschrock boolean_t 459e9dbad6fSeschrock zfs_prop_user(const char *name) 460e9dbad6fSeschrock { 461e9dbad6fSeschrock int i; 462e9dbad6fSeschrock char c; 463e9dbad6fSeschrock boolean_t foundsep = B_FALSE; 464e9dbad6fSeschrock 465e9dbad6fSeschrock for (i = 0; i < strlen(name); i++) { 466e9dbad6fSeschrock c = name[i]; 467e9dbad6fSeschrock if (!valid_char(c)) 468e9dbad6fSeschrock return (B_FALSE); 469e9dbad6fSeschrock if (c == ':') 470e9dbad6fSeschrock foundsep = B_TRUE; 471e9dbad6fSeschrock } 472e9dbad6fSeschrock 473e9dbad6fSeschrock if (!foundsep) 474e9dbad6fSeschrock return (B_FALSE); 475e9dbad6fSeschrock 476e9dbad6fSeschrock return (B_TRUE); 477e9dbad6fSeschrock } 478e9dbad6fSeschrock 47914843421SMatthew Ahrens /* 48014843421SMatthew Ahrens * Returns true if this is a valid userspace-type property (one with a '@'). 48114843421SMatthew Ahrens * Note that after the @, any character is valid (eg, another @, for SID 48214843421SMatthew Ahrens * user@domain). 48314843421SMatthew Ahrens */ 48414843421SMatthew Ahrens boolean_t 48514843421SMatthew Ahrens zfs_prop_userquota(const char *name) 48614843421SMatthew Ahrens { 48714843421SMatthew Ahrens zfs_userquota_prop_t prop; 48814843421SMatthew Ahrens 48914843421SMatthew Ahrens for (prop = 0; prop < ZFS_NUM_USERQUOTA_PROPS; prop++) { 49014843421SMatthew Ahrens if (strncmp(name, zfs_userquota_prop_prefixes[prop], 49114843421SMatthew Ahrens strlen(zfs_userquota_prop_prefixes[prop])) == 0) { 49214843421SMatthew Ahrens return (B_TRUE); 49314843421SMatthew Ahrens } 49414843421SMatthew Ahrens } 49514843421SMatthew Ahrens 49614843421SMatthew Ahrens return (B_FALSE); 49714843421SMatthew Ahrens } 49814843421SMatthew Ahrens 49919b94df9SMatthew Ahrens /* 50019b94df9SMatthew Ahrens * Returns true if this is a valid written@ property. 50119b94df9SMatthew Ahrens * Note that after the @, any character is valid (eg, another @, for 50219b94df9SMatthew Ahrens * written@pool/fs@origin). 50319b94df9SMatthew Ahrens */ 50419b94df9SMatthew Ahrens boolean_t 50519b94df9SMatthew Ahrens zfs_prop_written(const char *name) 50619b94df9SMatthew Ahrens { 50719b94df9SMatthew Ahrens static const char *prefix = "written@"; 50819b94df9SMatthew Ahrens return (strncmp(name, prefix, strlen(prefix)) == 0); 50919b94df9SMatthew Ahrens } 51019b94df9SMatthew Ahrens 511fa9e4066Sahrens /* 512990b4856Slling * Tables of index types, plus functions to convert between the user view 513990b4856Slling * (strings) and internal representation (uint64_t). 514fa9e4066Sahrens */ 515990b4856Slling int 516990b4856Slling zfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index) 517fa9e4066Sahrens { 518990b4856Slling return (zprop_string_to_index(prop, string, index, ZFS_TYPE_DATASET)); 519fa9e4066Sahrens } 520fa9e4066Sahrens 521990b4856Slling int 522990b4856Slling zfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string) 5233d7072f8Seschrock { 524990b4856Slling return (zprop_index_to_string(prop, index, string, ZFS_TYPE_DATASET)); 5253d7072f8Seschrock } 5263d7072f8Seschrock 527b24ab676SJeff Bonwick uint64_t 528b24ab676SJeff Bonwick zfs_prop_random_value(zfs_prop_t prop, uint64_t seed) 529b24ab676SJeff Bonwick { 530b24ab676SJeff Bonwick return (zprop_random_value(prop, seed, ZFS_TYPE_DATASET)); 531b24ab676SJeff Bonwick } 532b24ab676SJeff Bonwick 533990b4856Slling /* 534990b4856Slling * Returns TRUE if the property applies to any of the given dataset types. 535990b4856Slling */ 5364853e976Sgw boolean_t 537990b4856Slling zfs_prop_valid_for_type(int prop, zfs_type_t types) 538fa9e4066Sahrens { 539990b4856Slling return (zprop_valid_for_type(prop, types)); 540fa9e4066Sahrens } 541fa9e4066Sahrens 542990b4856Slling zprop_type_t 543990b4856Slling zfs_prop_get_type(zfs_prop_t prop) 5443d7072f8Seschrock { 545990b4856Slling return (zfs_prop_table[prop].pd_proptype); 5463d7072f8Seschrock } 5473d7072f8Seschrock 548fa9e4066Sahrens /* 549fa9e4066Sahrens * Returns TRUE if the property is readonly. 550fa9e4066Sahrens */ 551990b4856Slling boolean_t 552fa9e4066Sahrens zfs_prop_readonly(zfs_prop_t prop) 553fa9e4066Sahrens { 554da6c28aaSamw return (zfs_prop_table[prop].pd_attr == PROP_READONLY || 555da6c28aaSamw zfs_prop_table[prop].pd_attr == PROP_ONETIME); 556da6c28aaSamw } 557da6c28aaSamw 558da6c28aaSamw /* 559da6c28aaSamw * Returns TRUE if the property is only allowed to be set once. 560da6c28aaSamw */ 561da6c28aaSamw boolean_t 562da6c28aaSamw zfs_prop_setonce(zfs_prop_t prop) 563da6c28aaSamw { 564da6c28aaSamw return (zfs_prop_table[prop].pd_attr == PROP_ONETIME); 565fa9e4066Sahrens } 566fa9e4066Sahrens 567fa9e4066Sahrens const char * 568990b4856Slling zfs_prop_default_string(zfs_prop_t prop) 569fa9e4066Sahrens { 570990b4856Slling return (zfs_prop_table[prop].pd_strdefault); 571990b4856Slling } 572990b4856Slling 573990b4856Slling uint64_t 574990b4856Slling zfs_prop_default_numeric(zfs_prop_t prop) 575990b4856Slling { 576990b4856Slling return (zfs_prop_table[prop].pd_numdefault); 577fa9e4066Sahrens } 578fa9e4066Sahrens 579b1b8ab34Slling /* 580990b4856Slling * Given a dataset property ID, returns the corresponding name. 581990b4856Slling * Assuming the zfs dataset property ID is valid. 582b1b8ab34Slling */ 583b1b8ab34Slling const char * 584990b4856Slling zfs_prop_to_name(zfs_prop_t prop) 585b1b8ab34Slling { 586b1b8ab34Slling return (zfs_prop_table[prop].pd_name); 587b1b8ab34Slling } 588b1b8ab34Slling 589fa9e4066Sahrens /* 590fa9e4066Sahrens * Returns TRUE if the property is inheritable. 591fa9e4066Sahrens */ 592990b4856Slling boolean_t 593fa9e4066Sahrens zfs_prop_inheritable(zfs_prop_t prop) 594fa9e4066Sahrens { 595da6c28aaSamw return (zfs_prop_table[prop].pd_attr == PROP_INHERIT || 596da6c28aaSamw zfs_prop_table[prop].pd_attr == PROP_ONETIME); 597e9dbad6fSeschrock } 598e9dbad6fSeschrock 599acd76fe5Seschrock #ifndef _KERNEL 600acd76fe5Seschrock 601fa9e4066Sahrens /* 602b1b8ab34Slling * Returns a string describing the set of acceptable values for the given 603b1b8ab34Slling * zfs property, or NULL if it cannot be set. 604fa9e4066Sahrens */ 605b1b8ab34Slling const char * 606b1b8ab34Slling zfs_prop_values(zfs_prop_t prop) 607fa9e4066Sahrens { 608fa9e4066Sahrens return (zfs_prop_table[prop].pd_values); 609fa9e4066Sahrens } 610fa9e4066Sahrens 611fa9e4066Sahrens /* 612fa9e4066Sahrens * Returns TRUE if this property is a string type. Note that index types 613fa9e4066Sahrens * (compression, checksum) are treated as strings in userland, even though they 614fa9e4066Sahrens * are stored numerically on disk. 615fa9e4066Sahrens */ 616fa9e4066Sahrens int 617fa9e4066Sahrens zfs_prop_is_string(zfs_prop_t prop) 618fa9e4066Sahrens { 61991ebeef5Sahrens return (zfs_prop_table[prop].pd_proptype == PROP_TYPE_STRING || 62091ebeef5Sahrens zfs_prop_table[prop].pd_proptype == PROP_TYPE_INDEX); 621fa9e4066Sahrens } 622fa9e4066Sahrens 623fa9e4066Sahrens /* 624fa9e4066Sahrens * Returns the column header for the given property. Used only in 625fa9e4066Sahrens * 'zfs list -o', but centralized here with the other property information. 626fa9e4066Sahrens */ 627fa9e4066Sahrens const char * 628fa9e4066Sahrens zfs_prop_column_name(zfs_prop_t prop) 629fa9e4066Sahrens { 630fa9e4066Sahrens return (zfs_prop_table[prop].pd_colname); 631fa9e4066Sahrens } 632fa9e4066Sahrens 633fa9e4066Sahrens /* 634e9dbad6fSeschrock * Returns whether the given property should be displayed right-justified for 635e9dbad6fSeschrock * 'zfs list'. 636fa9e4066Sahrens */ 637e9dbad6fSeschrock boolean_t 638e9dbad6fSeschrock zfs_prop_align_right(zfs_prop_t prop) 639fa9e4066Sahrens { 640e9dbad6fSeschrock return (zfs_prop_table[prop].pd_rightalign); 641fa9e4066Sahrens } 642da6c28aaSamw 643fa9e4066Sahrens #endif 644