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. 23187d6ac0SMatt Ahrens * Copyright (c) 2011 by Delphix. All rights reserved. 24fa9e4066Sahrens */ 25fa9e4066Sahrens 2655da60b9SMark J Musante /* Portions Copyright 2010 Robert Milkowski */ 2755da60b9SMark J Musante 28fa9e4066Sahrens #include <sys/zio.h> 29fa9e4066Sahrens #include <sys/spa.h> 30de8267e0Stimh #include <sys/u8_textprep.h> 31fa9e4066Sahrens #include <sys/zfs_acl.h> 32fa9e4066Sahrens #include <sys/zfs_ioctl.h> 33e7437265Sahrens #include <sys/zfs_znode.h> 34fa9e4066Sahrens 35fa9e4066Sahrens #include "zfs_prop.h" 36ecd6cf80Smarks #include "zfs_deleg.h" 37fa9e4066Sahrens 38fa9e4066Sahrens #if defined(_KERNEL) 39fa9e4066Sahrens #include <sys/systm.h> 40fa9e4066Sahrens #else 41fa9e4066Sahrens #include <stdlib.h> 42fa9e4066Sahrens #include <string.h> 43fa9e4066Sahrens #include <ctype.h> 44fa9e4066Sahrens #endif 45fa9e4066Sahrens 46990b4856Slling static zprop_desc_t zfs_prop_table[ZFS_NUM_PROPS]; 4791ebeef5Sahrens 4814843421SMatthew Ahrens /* Note this is indexed by zfs_userquota_prop_t, keep the order the same */ 4914843421SMatthew Ahrens const char *zfs_userquota_prop_prefixes[] = { 5014843421SMatthew Ahrens "userused@", 5114843421SMatthew Ahrens "userquota@", 5214843421SMatthew Ahrens "groupused@", 5314843421SMatthew Ahrens "groupquota@" 5414843421SMatthew Ahrens }; 5514843421SMatthew Ahrens 56990b4856Slling zprop_desc_t * 57990b4856Slling zfs_prop_get_table(void) 5891ebeef5Sahrens { 59990b4856Slling return (zfs_prop_table); 6091ebeef5Sahrens } 6191ebeef5Sahrens 6291ebeef5Sahrens void 6391ebeef5Sahrens zfs_prop_init(void) 6491ebeef5Sahrens { 65990b4856Slling static zprop_index_t checksum_table[] = { 6691ebeef5Sahrens { "on", ZIO_CHECKSUM_ON }, 6791ebeef5Sahrens { "off", ZIO_CHECKSUM_OFF }, 6891ebeef5Sahrens { "fletcher2", ZIO_CHECKSUM_FLETCHER_2 }, 6991ebeef5Sahrens { "fletcher4", ZIO_CHECKSUM_FLETCHER_4 }, 7091ebeef5Sahrens { "sha256", ZIO_CHECKSUM_SHA256 }, 7191ebeef5Sahrens { NULL } 7291ebeef5Sahrens }; 7391ebeef5Sahrens 74b24ab676SJeff Bonwick static zprop_index_t dedup_table[] = { 75b24ab676SJeff Bonwick { "on", ZIO_CHECKSUM_ON }, 76b24ab676SJeff Bonwick { "off", ZIO_CHECKSUM_OFF }, 77b24ab676SJeff Bonwick { "verify", ZIO_CHECKSUM_ON | ZIO_CHECKSUM_VERIFY }, 78b24ab676SJeff Bonwick { "sha256", ZIO_CHECKSUM_SHA256 }, 79b24ab676SJeff Bonwick { "sha256,verify", 80b24ab676SJeff Bonwick ZIO_CHECKSUM_SHA256 | ZIO_CHECKSUM_VERIFY }, 81b24ab676SJeff Bonwick { NULL } 82b24ab676SJeff Bonwick }; 83b24ab676SJeff Bonwick 84990b4856Slling static zprop_index_t compress_table[] = { 8591ebeef5Sahrens { "on", ZIO_COMPRESS_ON }, 8691ebeef5Sahrens { "off", ZIO_COMPRESS_OFF }, 8791ebeef5Sahrens { "lzjb", ZIO_COMPRESS_LZJB }, 8891ebeef5Sahrens { "gzip", ZIO_COMPRESS_GZIP_6 }, /* gzip default */ 8991ebeef5Sahrens { "gzip-1", ZIO_COMPRESS_GZIP_1 }, 9091ebeef5Sahrens { "gzip-2", ZIO_COMPRESS_GZIP_2 }, 9191ebeef5Sahrens { "gzip-3", ZIO_COMPRESS_GZIP_3 }, 9291ebeef5Sahrens { "gzip-4", ZIO_COMPRESS_GZIP_4 }, 9391ebeef5Sahrens { "gzip-5", ZIO_COMPRESS_GZIP_5 }, 9491ebeef5Sahrens { "gzip-6", ZIO_COMPRESS_GZIP_6 }, 9591ebeef5Sahrens { "gzip-7", ZIO_COMPRESS_GZIP_7 }, 9691ebeef5Sahrens { "gzip-8", ZIO_COMPRESS_GZIP_8 }, 9791ebeef5Sahrens { "gzip-9", ZIO_COMPRESS_GZIP_9 }, 98b24ab676SJeff Bonwick { "zle", ZIO_COMPRESS_ZLE }, 9991ebeef5Sahrens { NULL } 10091ebeef5Sahrens }; 10191ebeef5Sahrens 102990b4856Slling static zprop_index_t snapdir_table[] = { 10391ebeef5Sahrens { "hidden", ZFS_SNAPDIR_HIDDEN }, 10491ebeef5Sahrens { "visible", ZFS_SNAPDIR_VISIBLE }, 10591ebeef5Sahrens { NULL } 10691ebeef5Sahrens }; 10791ebeef5Sahrens 108a3c49ce1SAlbert Lee static zprop_index_t acl_mode_table[] = { 109a3c49ce1SAlbert Lee { "discard", ZFS_ACL_DISCARD }, 110a3c49ce1SAlbert Lee { "groupmask", ZFS_ACL_GROUPMASK }, 111a3c49ce1SAlbert Lee { "passthrough", ZFS_ACL_PASSTHROUGH }, 112*71dbfc28SPaul B. Henson { "restricted", ZFS_ACL_RESTRICTED }, 113a3c49ce1SAlbert Lee { NULL } 114a3c49ce1SAlbert Lee }; 115a3c49ce1SAlbert Lee 116990b4856Slling static zprop_index_t acl_inherit_table[] = { 11791ebeef5Sahrens { "discard", ZFS_ACL_DISCARD }, 11891ebeef5Sahrens { "noallow", ZFS_ACL_NOALLOW }, 119b3d141f8Smarks { "restricted", ZFS_ACL_RESTRICTED }, 12091ebeef5Sahrens { "passthrough", ZFS_ACL_PASSTHROUGH }, 121b3d141f8Smarks { "secure", ZFS_ACL_RESTRICTED }, /* bkwrd compatability */ 122d0f3f37eSMark Shellenbaum { "passthrough-x", ZFS_ACL_PASSTHROUGH_X }, 12391ebeef5Sahrens { NULL } 12491ebeef5Sahrens }; 12591ebeef5Sahrens 126da6c28aaSamw static zprop_index_t case_table[] = { 127da6c28aaSamw { "sensitive", ZFS_CASE_SENSITIVE }, 128da6c28aaSamw { "insensitive", ZFS_CASE_INSENSITIVE }, 129da6c28aaSamw { "mixed", ZFS_CASE_MIXED }, 130da6c28aaSamw { NULL } 131da6c28aaSamw }; 132da6c28aaSamw 133990b4856Slling static zprop_index_t copies_table[] = { 13491ebeef5Sahrens { "1", 1 }, 13591ebeef5Sahrens { "2", 2 }, 13691ebeef5Sahrens { "3", 3 }, 13791ebeef5Sahrens { NULL } 13891ebeef5Sahrens }; 13991ebeef5Sahrens 140de8267e0Stimh /* 141de8267e0Stimh * Use the unique flags we have to send to u8_strcmp() and/or 142de8267e0Stimh * u8_textprep() to represent the various normalization property 143de8267e0Stimh * values. 144de8267e0Stimh */ 145da6c28aaSamw static zprop_index_t normalize_table[] = { 146de8267e0Stimh { "none", 0 }, 147de8267e0Stimh { "formD", U8_TEXTPREP_NFD }, 148de8267e0Stimh { "formKC", U8_TEXTPREP_NFKC }, 149de8267e0Stimh { "formC", U8_TEXTPREP_NFC }, 150de8267e0Stimh { "formKD", U8_TEXTPREP_NFKD }, 151da6c28aaSamw { NULL } 152da6c28aaSamw }; 153da6c28aaSamw 154990b4856Slling static zprop_index_t version_table[] = { 15591ebeef5Sahrens { "1", 1 }, 15691ebeef5Sahrens { "2", 2 }, 157da6c28aaSamw { "3", 3 }, 15814843421SMatthew Ahrens { "4", 4 }, 1590a586ceaSMark Shellenbaum { "5", 5 }, 16091ebeef5Sahrens { "current", ZPL_VERSION }, 16191ebeef5Sahrens { NULL } 16291ebeef5Sahrens }; 16391ebeef5Sahrens 164990b4856Slling static zprop_index_t boolean_table[] = { 165e45ce728Sahrens { "off", 0 }, 166e45ce728Sahrens { "on", 1 }, 167e45ce728Sahrens { NULL } 168e45ce728Sahrens }; 169e45ce728Sahrens 170e09fa4daSNeil Perrin static zprop_index_t logbias_table[] = { 171e09fa4daSNeil Perrin { "latency", ZFS_LOGBIAS_LATENCY }, 172e09fa4daSNeil Perrin { "throughput", ZFS_LOGBIAS_THROUGHPUT }, 173e09fa4daSNeil Perrin { NULL } 174e09fa4daSNeil Perrin }; 175e09fa4daSNeil Perrin 176a227b7f4Shs static zprop_index_t canmount_table[] = { 177a227b7f4Shs { "off", ZFS_CANMOUNT_OFF }, 178a227b7f4Shs { "on", ZFS_CANMOUNT_ON }, 179a227b7f4Shs { "noauto", ZFS_CANMOUNT_NOAUTO }, 180a227b7f4Shs { NULL } 181a227b7f4Shs }; 182a227b7f4Shs 1833baa08fcSek static zprop_index_t cache_table[] = { 1843baa08fcSek { "none", ZFS_CACHE_NONE }, 1853baa08fcSek { "metadata", ZFS_CACHE_METADATA }, 1863baa08fcSek { "all", ZFS_CACHE_ALL }, 1873baa08fcSek { NULL } 1883baa08fcSek }; 1893baa08fcSek 19055da60b9SMark J Musante static zprop_index_t sync_table[] = { 19155da60b9SMark J Musante { "standard", ZFS_SYNC_STANDARD }, 19255da60b9SMark J Musante { "always", ZFS_SYNC_ALWAYS }, 19355da60b9SMark J Musante { "disabled", ZFS_SYNC_DISABLED }, 19455da60b9SMark J Musante { NULL } 19555da60b9SMark J Musante }; 19655da60b9SMark J Musante 19791ebeef5Sahrens /* inherit index properties */ 19855da60b9SMark J Musante zprop_register_index(ZFS_PROP_SYNC, "sync", ZFS_SYNC_STANDARD, 19955da60b9SMark J Musante PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 20055da60b9SMark J Musante "standard | always | disabled", "SYNC", 20155da60b9SMark J Musante sync_table); 20283d7f9feSTom Erickson zprop_register_index(ZFS_PROP_CHECKSUM, "checksum", 20383d7f9feSTom Erickson ZIO_CHECKSUM_DEFAULT, PROP_INHERIT, ZFS_TYPE_FILESYSTEM | 20483d7f9feSTom Erickson ZFS_TYPE_VOLUME, 20591ebeef5Sahrens "on | off | fletcher2 | fletcher4 | sha256", "CHECKSUM", 20691ebeef5Sahrens checksum_table); 20783d7f9feSTom Erickson zprop_register_index(ZFS_PROP_DEDUP, "dedup", ZIO_CHECKSUM_OFF, 208b24ab676SJeff Bonwick PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 209b1033ae2SMatthew Ahrens "on | off | verify | sha256[,verify]", "DEDUP", 210b24ab676SJeff Bonwick dedup_table); 21183d7f9feSTom Erickson zprop_register_index(ZFS_PROP_COMPRESSION, "compression", 212e45ce728Sahrens ZIO_COMPRESS_DEFAULT, PROP_INHERIT, 213e45ce728Sahrens ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 214b24ab676SJeff Bonwick "on | off | lzjb | gzip | gzip-[1-9] | zle", "COMPRESS", 215b24ab676SJeff Bonwick compress_table); 21683d7f9feSTom Erickson zprop_register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN, 217e45ce728Sahrens PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 218e45ce728Sahrens "hidden | visible", "SNAPDIR", snapdir_table); 219a3c49ce1SAlbert Lee zprop_register_index(ZFS_PROP_ACLMODE, "aclmode", ZFS_ACL_DISCARD, 220a3c49ce1SAlbert Lee PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 221*71dbfc28SPaul B. Henson "discard | groupmask | passthrough | restricted", "ACLMODE", 222*71dbfc28SPaul B. Henson acl_mode_table); 22383d7f9feSTom Erickson zprop_register_index(ZFS_PROP_ACLINHERIT, "aclinherit", 22483d7f9feSTom Erickson ZFS_ACL_RESTRICTED, PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 225d0f3f37eSMark Shellenbaum "discard | noallow | restricted | passthrough | passthrough-x", 226b3d141f8Smarks "ACLINHERIT", acl_inherit_table); 22783d7f9feSTom Erickson zprop_register_index(ZFS_PROP_COPIES, "copies", 1, PROP_INHERIT, 22883d7f9feSTom Erickson ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 22991ebeef5Sahrens "1 | 2 | 3", "COPIES", copies_table); 23083d7f9feSTom Erickson zprop_register_index(ZFS_PROP_PRIMARYCACHE, "primarycache", 2313baa08fcSek ZFS_CACHE_ALL, PROP_INHERIT, 2323baa08fcSek ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, 2333baa08fcSek "all | none | metadata", "PRIMARYCACHE", cache_table); 23483d7f9feSTom Erickson zprop_register_index(ZFS_PROP_SECONDARYCACHE, "secondarycache", 2353baa08fcSek ZFS_CACHE_ALL, PROP_INHERIT, 2363baa08fcSek ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, 2373baa08fcSek "all | none | metadata", "SECONDARYCACHE", cache_table); 23883d7f9feSTom Erickson zprop_register_index(ZFS_PROP_LOGBIAS, "logbias", ZFS_LOGBIAS_LATENCY, 239e09fa4daSNeil Perrin PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 240e09fa4daSNeil Perrin "latency | throughput", "LOGBIAS", logbias_table); 241e45ce728Sahrens 242e45ce728Sahrens /* inherit index (boolean) properties */ 24383d7f9feSTom Erickson zprop_register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT, 244e45ce728Sahrens ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table); 24583d7f9feSTom Erickson zprop_register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT, 246e45ce728Sahrens ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES", 247e45ce728Sahrens boolean_table); 24883d7f9feSTom Erickson zprop_register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT, 249e45ce728Sahrens ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC", 250e45ce728Sahrens boolean_table); 25183d7f9feSTom Erickson zprop_register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT, 252e45ce728Sahrens ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID", 253e45ce728Sahrens boolean_table); 25483d7f9feSTom Erickson zprop_register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT, 255e45ce728Sahrens ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY", 256e45ce728Sahrens boolean_table); 25783d7f9feSTom Erickson zprop_register_index(ZFS_PROP_ZONED, "zoned", 0, PROP_INHERIT, 258e45ce728Sahrens ZFS_TYPE_FILESYSTEM, "on | off", "ZONED", boolean_table); 25983d7f9feSTom Erickson zprop_register_index(ZFS_PROP_XATTR, "xattr", 1, PROP_INHERIT, 260e45ce728Sahrens ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "XATTR", 261e45ce728Sahrens boolean_table); 26283d7f9feSTom Erickson zprop_register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT, 263da6c28aaSamw ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN", 264da6c28aaSamw boolean_table); 26583d7f9feSTom Erickson zprop_register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT, 266da6c28aaSamw ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND", 267da6c28aaSamw boolean_table); 268e45ce728Sahrens 269e45ce728Sahrens /* default index properties */ 27083d7f9feSTom Erickson zprop_register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT, 2717b55fa8eSck ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 27219b94df9SMatthew Ahrens "1 | 2 | 3 | 4 | 5 | current", "VERSION", version_table); 27383d7f9feSTom Erickson zprop_register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON, 274a227b7f4Shs PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto", 275a227b7f4Shs "CANMOUNT", canmount_table); 276e45ce728Sahrens 277e45ce728Sahrens /* readonly index (boolean) properties */ 27883d7f9feSTom Erickson zprop_register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY, 279990b4856Slling ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table); 28083d7f9feSTom Erickson zprop_register_index(ZFS_PROP_DEFER_DESTROY, "defer_destroy", 0, 281842727c2SChris Kirby PROP_READONLY, ZFS_TYPE_SNAPSHOT, "yes | no", "DEFER_DESTROY", 282842727c2SChris Kirby boolean_table); 283e45ce728Sahrens 284da6c28aaSamw /* set once index properties */ 28583d7f9feSTom Erickson zprop_register_index(ZFS_PROP_NORMALIZE, "normalization", 0, 286da6c28aaSamw PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 287da6c28aaSamw "none | formC | formD | formKC | formKD", "NORMALIZATION", 288da6c28aaSamw normalize_table); 28983d7f9feSTom Erickson zprop_register_index(ZFS_PROP_CASE, "casesensitivity", 29083d7f9feSTom Erickson ZFS_CASE_SENSITIVE, PROP_ONETIME, ZFS_TYPE_FILESYSTEM | 29183d7f9feSTom Erickson ZFS_TYPE_SNAPSHOT, 292da6c28aaSamw "sensitive | insensitive | mixed", "CASE", case_table); 293da6c28aaSamw 294da6c28aaSamw /* set once index (boolean) properties */ 29583d7f9feSTom Erickson zprop_register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME, 296da6c28aaSamw ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 297da6c28aaSamw "on | off", "UTF8ONLY", boolean_table); 298da6c28aaSamw 29991ebeef5Sahrens /* string properties */ 30083d7f9feSTom Erickson zprop_register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY, 30191ebeef5Sahrens ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN"); 30219b94df9SMatthew Ahrens zprop_register_string(ZFS_PROP_CLONES, "clones", NULL, PROP_READONLY, 30319b94df9SMatthew Ahrens ZFS_TYPE_SNAPSHOT, "<dataset>[,...]", "CLONES"); 30483d7f9feSTom Erickson zprop_register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/", 30583d7f9feSTom Erickson PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "<path> | legacy | none", 30683d7f9feSTom Erickson "MOUNTPOINT"); 30783d7f9feSTom Erickson zprop_register_string(ZFS_PROP_SHARENFS, "sharenfs", "off", 30883d7f9feSTom Erickson PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "on | off | share(1M) options", 30983d7f9feSTom Erickson "SHARENFS"); 31083d7f9feSTom Erickson zprop_register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY, 311990b4856Slling ZFS_TYPE_DATASET, "filesystem | volume | snapshot", "TYPE"); 31283d7f9feSTom Erickson zprop_register_string(ZFS_PROP_SHARESMB, "sharesmb", "off", 31383d7f9feSTom Erickson PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 31483d7f9feSTom Erickson "on | off | sharemgr(1M) options", "SHARESMB"); 31583d7f9feSTom Erickson zprop_register_string(ZFS_PROP_MLSLABEL, "mlslabel", 31683d7f9feSTom Erickson ZFS_MLSLABEL_DEFAULT, PROP_INHERIT, ZFS_TYPE_DATASET, 31783d7f9feSTom Erickson "<sensitivity label>", "MLSLABEL"); 31891ebeef5Sahrens 31991ebeef5Sahrens /* readonly number properties */ 32083d7f9feSTom Erickson zprop_register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY, 321990b4856Slling ZFS_TYPE_DATASET, "<size>", "USED"); 32283d7f9feSTom Erickson zprop_register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY, 323990b4856Slling ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL"); 32483d7f9feSTom Erickson zprop_register_number(ZFS_PROP_REFERENCED, "referenced", 0, 32583d7f9feSTom Erickson PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "REFER"); 32683d7f9feSTom Erickson zprop_register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0, 327990b4856Slling PROP_READONLY, ZFS_TYPE_DATASET, 32891ebeef5Sahrens "<1.00x or higher if compressed>", "RATIO"); 329187d6ac0SMatt Ahrens zprop_register_number(ZFS_PROP_REFRATIO, "refcompressratio", 0, 330187d6ac0SMatt Ahrens PROP_READONLY, ZFS_TYPE_DATASET, 331187d6ac0SMatt Ahrens "<1.00x or higher if compressed>", "REFRATIO"); 33283d7f9feSTom Erickson zprop_register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize", 333c1449561SEric Taylor ZVOL_DEFAULT_BLOCKSIZE, PROP_ONETIME, 334da6c28aaSamw ZFS_TYPE_VOLUME, "512 to 128k, power of 2", "VOLBLOCK"); 33583d7f9feSTom Erickson zprop_register_number(ZFS_PROP_USEDSNAP, "usedbysnapshots", 0, 33683d7f9feSTom Erickson PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 33783d7f9feSTom Erickson "USEDSNAP"); 33883d7f9feSTom Erickson zprop_register_number(ZFS_PROP_USEDDS, "usedbydataset", 0, 33983d7f9feSTom Erickson PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 34083d7f9feSTom Erickson "USEDDS"); 34183d7f9feSTom Erickson zprop_register_number(ZFS_PROP_USEDCHILD, "usedbychildren", 0, 34283d7f9feSTom Erickson PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 34383d7f9feSTom Erickson "USEDCHILD"); 34483d7f9feSTom Erickson zprop_register_number(ZFS_PROP_USEDREFRESERV, "usedbyrefreservation", 0, 34574e7dc98SMatthew Ahrens PROP_READONLY, 34674e7dc98SMatthew Ahrens ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDREFRESERV"); 34783d7f9feSTom Erickson zprop_register_number(ZFS_PROP_USERREFS, "userrefs", 0, PROP_READONLY, 348842727c2SChris Kirby ZFS_TYPE_SNAPSHOT, "<count>", "USERREFS"); 34919b94df9SMatthew Ahrens zprop_register_number(ZFS_PROP_WRITTEN, "written", 0, PROP_READONLY, 35019b94df9SMatthew Ahrens ZFS_TYPE_DATASET, "<size>", "WRITTEN"); 35191ebeef5Sahrens 35291ebeef5Sahrens /* default number properties */ 35383d7f9feSTom Erickson zprop_register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT, 35491ebeef5Sahrens ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA"); 35583d7f9feSTom Erickson zprop_register_number(ZFS_PROP_RESERVATION, "reservation", 0, 35683d7f9feSTom Erickson PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 35783d7f9feSTom Erickson "<size> | none", "RESERV"); 35883d7f9feSTom Erickson zprop_register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT, 35991ebeef5Sahrens ZFS_TYPE_VOLUME, "<size>", "VOLSIZE"); 36083d7f9feSTom Erickson zprop_register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT, 361a9799022Sck ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA"); 36283d7f9feSTom Erickson zprop_register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0, 363a9799022Sck PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 364a9799022Sck "<size> | none", "REFRESERV"); 36591ebeef5Sahrens 36691ebeef5Sahrens /* inherit number properties */ 36783d7f9feSTom Erickson zprop_register_number(ZFS_PROP_RECORDSIZE, "recordsize", 36883d7f9feSTom Erickson SPA_MAXBLOCKSIZE, PROP_INHERIT, 36991ebeef5Sahrens ZFS_TYPE_FILESYSTEM, "512 to 128k, power of 2", "RECSIZE"); 37091ebeef5Sahrens 37191ebeef5Sahrens /* hidden properties */ 37283d7f9feSTom Erickson zprop_register_hidden(ZFS_PROP_CREATETXG, "createtxg", PROP_TYPE_NUMBER, 373b24ab676SJeff Bonwick PROP_READONLY, ZFS_TYPE_DATASET, "CREATETXG"); 37483d7f9feSTom Erickson zprop_register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER, 375b24ab676SJeff Bonwick PROP_READONLY, ZFS_TYPE_SNAPSHOT, "NUMCLONES"); 37683d7f9feSTom Erickson zprop_register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING, 377990b4856Slling PROP_READONLY, ZFS_TYPE_DATASET, "NAME"); 37883d7f9feSTom Erickson zprop_register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions", 37983d7f9feSTom Erickson PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS"); 38083d7f9feSTom Erickson zprop_register_hidden(ZFS_PROP_STMF_SHAREINFO, "stmf_sbd_lu", 381478ed9adSEric Taylor PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, 382478ed9adSEric Taylor "STMF_SBD_LU"); 38383d7f9feSTom Erickson zprop_register_hidden(ZFS_PROP_GUID, "guid", PROP_TYPE_NUMBER, 38483d7f9feSTom Erickson PROP_READONLY, ZFS_TYPE_DATASET, "GUID"); 38583d7f9feSTom Erickson zprop_register_hidden(ZFS_PROP_USERACCOUNTING, "useraccounting", 386b24ab676SJeff Bonwick PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, 387b24ab676SJeff Bonwick "USERACCOUNTING"); 38883d7f9feSTom Erickson zprop_register_hidden(ZFS_PROP_UNIQUE, "unique", PROP_TYPE_NUMBER, 389b24ab676SJeff Bonwick PROP_READONLY, ZFS_TYPE_DATASET, "UNIQUE"); 39083d7f9feSTom Erickson zprop_register_hidden(ZFS_PROP_OBJSETID, "objsetid", PROP_TYPE_NUMBER, 3911d713200SEric Schrock PROP_READONLY, ZFS_TYPE_DATASET, "OBJSETID"); 39291ebeef5Sahrens 39391ebeef5Sahrens /* oddball properties */ 39483d7f9feSTom Erickson zprop_register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0, 39583d7f9feSTom Erickson NULL, PROP_READONLY, ZFS_TYPE_DATASET, 39691ebeef5Sahrens "<date>", "CREATION", B_FALSE, B_TRUE, NULL); 39791ebeef5Sahrens } 39891ebeef5Sahrens 399b1b8ab34Slling boolean_t 400990b4856Slling zfs_prop_delegatable(zfs_prop_t prop) 401fa9e4066Sahrens { 402990b4856Slling zprop_desc_t *pd = &zfs_prop_table[prop]; 4034201a95eSRic Aleshire 4044201a95eSRic Aleshire /* The mlslabel property is never delegatable. */ 4054201a95eSRic Aleshire if (prop == ZFS_PROP_MLSLABEL) 4064201a95eSRic Aleshire return (B_FALSE); 4074201a95eSRic Aleshire 408990b4856Slling return (pd->pd_attr != PROP_READONLY); 409fa9e4066Sahrens } 410fa9e4066Sahrens 411b1b8ab34Slling /* 412b1b8ab34Slling * Given a zfs dataset property name, returns the corresponding property ID. 413b1b8ab34Slling */ 414b1b8ab34Slling zfs_prop_t 415b1b8ab34Slling zfs_name_to_prop(const char *propname) 416b1b8ab34Slling { 417990b4856Slling return (zprop_name_to_prop(propname, ZFS_TYPE_DATASET)); 418b1b8ab34Slling } 419b1b8ab34Slling 420e9dbad6fSeschrock /* 421e9dbad6fSeschrock * For user property names, we allow all lowercase alphanumeric characters, plus 422e9dbad6fSeschrock * a few useful punctuation characters. 423e9dbad6fSeschrock */ 424e9dbad6fSeschrock static int 425e9dbad6fSeschrock valid_char(char c) 426e9dbad6fSeschrock { 427e9dbad6fSeschrock return ((c >= 'a' && c <= 'z') || 428e9dbad6fSeschrock (c >= '0' && c <= '9') || 429e9dbad6fSeschrock c == '-' || c == '_' || c == '.' || c == ':'); 430e9dbad6fSeschrock } 431e9dbad6fSeschrock 432e9dbad6fSeschrock /* 433e9dbad6fSeschrock * Returns true if this is a valid user-defined property (one with a ':'). 434e9dbad6fSeschrock */ 435e9dbad6fSeschrock boolean_t 436e9dbad6fSeschrock zfs_prop_user(const char *name) 437e9dbad6fSeschrock { 438e9dbad6fSeschrock int i; 439e9dbad6fSeschrock char c; 440e9dbad6fSeschrock boolean_t foundsep = B_FALSE; 441e9dbad6fSeschrock 442e9dbad6fSeschrock for (i = 0; i < strlen(name); i++) { 443e9dbad6fSeschrock c = name[i]; 444e9dbad6fSeschrock if (!valid_char(c)) 445e9dbad6fSeschrock return (B_FALSE); 446e9dbad6fSeschrock if (c == ':') 447e9dbad6fSeschrock foundsep = B_TRUE; 448e9dbad6fSeschrock } 449e9dbad6fSeschrock 450e9dbad6fSeschrock if (!foundsep) 451e9dbad6fSeschrock return (B_FALSE); 452e9dbad6fSeschrock 453e9dbad6fSeschrock return (B_TRUE); 454e9dbad6fSeschrock } 455e9dbad6fSeschrock 45614843421SMatthew Ahrens /* 45714843421SMatthew Ahrens * Returns true if this is a valid userspace-type property (one with a '@'). 45814843421SMatthew Ahrens * Note that after the @, any character is valid (eg, another @, for SID 45914843421SMatthew Ahrens * user@domain). 46014843421SMatthew Ahrens */ 46114843421SMatthew Ahrens boolean_t 46214843421SMatthew Ahrens zfs_prop_userquota(const char *name) 46314843421SMatthew Ahrens { 46414843421SMatthew Ahrens zfs_userquota_prop_t prop; 46514843421SMatthew Ahrens 46614843421SMatthew Ahrens for (prop = 0; prop < ZFS_NUM_USERQUOTA_PROPS; prop++) { 46714843421SMatthew Ahrens if (strncmp(name, zfs_userquota_prop_prefixes[prop], 46814843421SMatthew Ahrens strlen(zfs_userquota_prop_prefixes[prop])) == 0) { 46914843421SMatthew Ahrens return (B_TRUE); 47014843421SMatthew Ahrens } 47114843421SMatthew Ahrens } 47214843421SMatthew Ahrens 47314843421SMatthew Ahrens return (B_FALSE); 47414843421SMatthew Ahrens } 47514843421SMatthew Ahrens 47619b94df9SMatthew Ahrens /* 47719b94df9SMatthew Ahrens * Returns true if this is a valid written@ property. 47819b94df9SMatthew Ahrens * Note that after the @, any character is valid (eg, another @, for 47919b94df9SMatthew Ahrens * written@pool/fs@origin). 48019b94df9SMatthew Ahrens */ 48119b94df9SMatthew Ahrens boolean_t 48219b94df9SMatthew Ahrens zfs_prop_written(const char *name) 48319b94df9SMatthew Ahrens { 48419b94df9SMatthew Ahrens static const char *prefix = "written@"; 48519b94df9SMatthew Ahrens return (strncmp(name, prefix, strlen(prefix)) == 0); 48619b94df9SMatthew Ahrens } 48719b94df9SMatthew Ahrens 488fa9e4066Sahrens /* 489990b4856Slling * Tables of index types, plus functions to convert between the user view 490990b4856Slling * (strings) and internal representation (uint64_t). 491fa9e4066Sahrens */ 492990b4856Slling int 493990b4856Slling zfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index) 494fa9e4066Sahrens { 495990b4856Slling return (zprop_string_to_index(prop, string, index, ZFS_TYPE_DATASET)); 496fa9e4066Sahrens } 497fa9e4066Sahrens 498990b4856Slling int 499990b4856Slling zfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string) 5003d7072f8Seschrock { 501990b4856Slling return (zprop_index_to_string(prop, index, string, ZFS_TYPE_DATASET)); 5023d7072f8Seschrock } 5033d7072f8Seschrock 504b24ab676SJeff Bonwick uint64_t 505b24ab676SJeff Bonwick zfs_prop_random_value(zfs_prop_t prop, uint64_t seed) 506b24ab676SJeff Bonwick { 507b24ab676SJeff Bonwick return (zprop_random_value(prop, seed, ZFS_TYPE_DATASET)); 508b24ab676SJeff Bonwick } 509b24ab676SJeff Bonwick 510990b4856Slling /* 511990b4856Slling * Returns TRUE if the property applies to any of the given dataset types. 512990b4856Slling */ 5134853e976Sgw boolean_t 514990b4856Slling zfs_prop_valid_for_type(int prop, zfs_type_t types) 515fa9e4066Sahrens { 516990b4856Slling return (zprop_valid_for_type(prop, types)); 517fa9e4066Sahrens } 518fa9e4066Sahrens 519990b4856Slling zprop_type_t 520990b4856Slling zfs_prop_get_type(zfs_prop_t prop) 5213d7072f8Seschrock { 522990b4856Slling return (zfs_prop_table[prop].pd_proptype); 5233d7072f8Seschrock } 5243d7072f8Seschrock 525fa9e4066Sahrens /* 526fa9e4066Sahrens * Returns TRUE if the property is readonly. 527fa9e4066Sahrens */ 528990b4856Slling boolean_t 529fa9e4066Sahrens zfs_prop_readonly(zfs_prop_t prop) 530fa9e4066Sahrens { 531da6c28aaSamw return (zfs_prop_table[prop].pd_attr == PROP_READONLY || 532da6c28aaSamw zfs_prop_table[prop].pd_attr == PROP_ONETIME); 533da6c28aaSamw } 534da6c28aaSamw 535da6c28aaSamw /* 536da6c28aaSamw * Returns TRUE if the property is only allowed to be set once. 537da6c28aaSamw */ 538da6c28aaSamw boolean_t 539da6c28aaSamw zfs_prop_setonce(zfs_prop_t prop) 540da6c28aaSamw { 541da6c28aaSamw return (zfs_prop_table[prop].pd_attr == PROP_ONETIME); 542fa9e4066Sahrens } 543fa9e4066Sahrens 544fa9e4066Sahrens const char * 545990b4856Slling zfs_prop_default_string(zfs_prop_t prop) 546fa9e4066Sahrens { 547990b4856Slling return (zfs_prop_table[prop].pd_strdefault); 548990b4856Slling } 549990b4856Slling 550990b4856Slling uint64_t 551990b4856Slling zfs_prop_default_numeric(zfs_prop_t prop) 552990b4856Slling { 553990b4856Slling return (zfs_prop_table[prop].pd_numdefault); 554fa9e4066Sahrens } 555fa9e4066Sahrens 556b1b8ab34Slling /* 557990b4856Slling * Given a dataset property ID, returns the corresponding name. 558990b4856Slling * Assuming the zfs dataset property ID is valid. 559b1b8ab34Slling */ 560b1b8ab34Slling const char * 561990b4856Slling zfs_prop_to_name(zfs_prop_t prop) 562b1b8ab34Slling { 563b1b8ab34Slling return (zfs_prop_table[prop].pd_name); 564b1b8ab34Slling } 565b1b8ab34Slling 566fa9e4066Sahrens /* 567fa9e4066Sahrens * Returns TRUE if the property is inheritable. 568fa9e4066Sahrens */ 569990b4856Slling boolean_t 570fa9e4066Sahrens zfs_prop_inheritable(zfs_prop_t prop) 571fa9e4066Sahrens { 572da6c28aaSamw return (zfs_prop_table[prop].pd_attr == PROP_INHERIT || 573da6c28aaSamw zfs_prop_table[prop].pd_attr == PROP_ONETIME); 574e9dbad6fSeschrock } 575e9dbad6fSeschrock 576acd76fe5Seschrock #ifndef _KERNEL 577acd76fe5Seschrock 578fa9e4066Sahrens /* 579b1b8ab34Slling * Returns a string describing the set of acceptable values for the given 580b1b8ab34Slling * zfs property, or NULL if it cannot be set. 581fa9e4066Sahrens */ 582b1b8ab34Slling const char * 583b1b8ab34Slling zfs_prop_values(zfs_prop_t prop) 584fa9e4066Sahrens { 585fa9e4066Sahrens return (zfs_prop_table[prop].pd_values); 586fa9e4066Sahrens } 587fa9e4066Sahrens 588fa9e4066Sahrens /* 589fa9e4066Sahrens * Returns TRUE if this property is a string type. Note that index types 590fa9e4066Sahrens * (compression, checksum) are treated as strings in userland, even though they 591fa9e4066Sahrens * are stored numerically on disk. 592fa9e4066Sahrens */ 593fa9e4066Sahrens int 594fa9e4066Sahrens zfs_prop_is_string(zfs_prop_t prop) 595fa9e4066Sahrens { 59691ebeef5Sahrens return (zfs_prop_table[prop].pd_proptype == PROP_TYPE_STRING || 59791ebeef5Sahrens zfs_prop_table[prop].pd_proptype == PROP_TYPE_INDEX); 598fa9e4066Sahrens } 599fa9e4066Sahrens 600fa9e4066Sahrens /* 601fa9e4066Sahrens * Returns the column header for the given property. Used only in 602fa9e4066Sahrens * 'zfs list -o', but centralized here with the other property information. 603fa9e4066Sahrens */ 604fa9e4066Sahrens const char * 605fa9e4066Sahrens zfs_prop_column_name(zfs_prop_t prop) 606fa9e4066Sahrens { 607fa9e4066Sahrens return (zfs_prop_table[prop].pd_colname); 608fa9e4066Sahrens } 609fa9e4066Sahrens 610fa9e4066Sahrens /* 611e9dbad6fSeschrock * Returns whether the given property should be displayed right-justified for 612e9dbad6fSeschrock * 'zfs list'. 613fa9e4066Sahrens */ 614e9dbad6fSeschrock boolean_t 615e9dbad6fSeschrock zfs_prop_align_right(zfs_prop_t prop) 616fa9e4066Sahrens { 617e9dbad6fSeschrock return (zfs_prop_table[prop].pd_rightalign); 618fa9e4066Sahrens } 619da6c28aaSamw 620fa9e4066Sahrens #endif 621