zfs_prop.c revision 243560
1168404Spjd/* 2168404Spjd * CDDL HEADER START 3168404Spjd * 4168404Spjd * The contents of this file are subject to the terms of the 5168404Spjd * Common Development and Distribution License (the "License"). 6168404Spjd * You may not use this file except in compliance with the License. 7168404Spjd * 8168404Spjd * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9168404Spjd * or http://www.opensolaris.org/os/licensing. 10168404Spjd * See the License for the specific language governing permissions 11168404Spjd * and limitations under the License. 12168404Spjd * 13168404Spjd * When distributing Covered Code, include this CDDL HEADER in each 14168404Spjd * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15168404Spjd * If applicable, add the following below this CDDL HEADER, with the 16168404Spjd * fields enclosed by brackets "[]" replaced with your own identifying 17168404Spjd * information: Portions Copyright [yyyy] [name of copyright owner] 18168404Spjd * 19168404Spjd * CDDL HEADER END 20168404Spjd */ 21168404Spjd/* 22219089Spjd * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 23223623Smm * Copyright (c) 2011 by Delphix. All rights reserved. 24168404Spjd */ 25168404Spjd 26219089Spjd/* Portions Copyright 2010 Robert Milkowski */ 27219089Spjd 28168404Spjd#include <sys/zio.h> 29168404Spjd#include <sys/spa.h> 30185029Spjd#include <sys/u8_textprep.h> 31168404Spjd#include <sys/zfs_acl.h> 32168404Spjd#include <sys/zfs_ioctl.h> 33185029Spjd#include <sys/zfs_znode.h> 34168404Spjd 35168404Spjd#include "zfs_prop.h" 36185029Spjd#include "zfs_deleg.h" 37168404Spjd 38168404Spjd#if defined(_KERNEL) 39168404Spjd#include <sys/systm.h> 40168404Spjd#else 41168404Spjd#include <stdlib.h> 42168404Spjd#include <string.h> 43168404Spjd#include <ctype.h> 44168404Spjd#endif 45168404Spjd 46185029Spjdstatic zprop_desc_t zfs_prop_table[ZFS_NUM_PROPS]; 47168404Spjd 48209962Smm/* Note this is indexed by zfs_userquota_prop_t, keep the order the same */ 49209962Smmconst char *zfs_userquota_prop_prefixes[] = { 50209962Smm "userused@", 51209962Smm "userquota@", 52209962Smm "groupused@", 53209962Smm "groupquota@" 54209962Smm}; 55209962Smm 56185029Spjdzprop_desc_t * 57185029Spjdzfs_prop_get_table(void) 58168404Spjd{ 59185029Spjd return (zfs_prop_table); 60168404Spjd} 61168404Spjd 62185029Spjdvoid 63185029Spjdzfs_prop_init(void) 64168404Spjd{ 65185029Spjd static zprop_index_t checksum_table[] = { 66185029Spjd { "on", ZIO_CHECKSUM_ON }, 67185029Spjd { "off", ZIO_CHECKSUM_OFF }, 68185029Spjd { "fletcher2", ZIO_CHECKSUM_FLETCHER_2 }, 69185029Spjd { "fletcher4", ZIO_CHECKSUM_FLETCHER_4 }, 70185029Spjd { "sha256", ZIO_CHECKSUM_SHA256 }, 71185029Spjd { NULL } 72185029Spjd }; 73168404Spjd 74219089Spjd static zprop_index_t dedup_table[] = { 75219089Spjd { "on", ZIO_CHECKSUM_ON }, 76219089Spjd { "off", ZIO_CHECKSUM_OFF }, 77219089Spjd { "verify", ZIO_CHECKSUM_ON | ZIO_CHECKSUM_VERIFY }, 78219089Spjd { "sha256", ZIO_CHECKSUM_SHA256 }, 79219089Spjd { "sha256,verify", 80219089Spjd ZIO_CHECKSUM_SHA256 | ZIO_CHECKSUM_VERIFY }, 81219089Spjd { NULL } 82219089Spjd }; 83219089Spjd 84185029Spjd static zprop_index_t compress_table[] = { 85185029Spjd { "on", ZIO_COMPRESS_ON }, 86185029Spjd { "off", ZIO_COMPRESS_OFF }, 87185029Spjd { "lzjb", ZIO_COMPRESS_LZJB }, 88185029Spjd { "gzip", ZIO_COMPRESS_GZIP_6 }, /* gzip default */ 89185029Spjd { "gzip-1", ZIO_COMPRESS_GZIP_1 }, 90185029Spjd { "gzip-2", ZIO_COMPRESS_GZIP_2 }, 91185029Spjd { "gzip-3", ZIO_COMPRESS_GZIP_3 }, 92185029Spjd { "gzip-4", ZIO_COMPRESS_GZIP_4 }, 93185029Spjd { "gzip-5", ZIO_COMPRESS_GZIP_5 }, 94185029Spjd { "gzip-6", ZIO_COMPRESS_GZIP_6 }, 95185029Spjd { "gzip-7", ZIO_COMPRESS_GZIP_7 }, 96185029Spjd { "gzip-8", ZIO_COMPRESS_GZIP_8 }, 97185029Spjd { "gzip-9", ZIO_COMPRESS_GZIP_9 }, 98219089Spjd { "zle", ZIO_COMPRESS_ZLE }, 99185029Spjd { NULL } 100185029Spjd }; 101168404Spjd 102185029Spjd static zprop_index_t snapdir_table[] = { 103185029Spjd { "hidden", ZFS_SNAPDIR_HIDDEN }, 104185029Spjd { "visible", ZFS_SNAPDIR_VISIBLE }, 105185029Spjd { NULL } 106185029Spjd }; 107168404Spjd 108224174Smm static zprop_index_t acl_mode_table[] = { 109224174Smm { "discard", ZFS_ACL_DISCARD }, 110224174Smm { "groupmask", ZFS_ACL_GROUPMASK }, 111224174Smm { "passthrough", ZFS_ACL_PASSTHROUGH }, 112243560Smm { "restricted", ZFS_ACL_RESTRICTED }, 113224174Smm { NULL } 114224174Smm }; 115224174Smm 116185029Spjd static zprop_index_t acl_inherit_table[] = { 117185029Spjd { "discard", ZFS_ACL_DISCARD }, 118185029Spjd { "noallow", ZFS_ACL_NOALLOW }, 119185029Spjd { "restricted", ZFS_ACL_RESTRICTED }, 120185029Spjd { "passthrough", ZFS_ACL_PASSTHROUGH }, 121185029Spjd { "secure", ZFS_ACL_RESTRICTED }, /* bkwrd compatability */ 122201143Sdelphij { "passthrough-x", ZFS_ACL_PASSTHROUGH_X }, 123185029Spjd { NULL } 124185029Spjd }; 125168404Spjd 126185029Spjd static zprop_index_t case_table[] = { 127185029Spjd { "sensitive", ZFS_CASE_SENSITIVE }, 128185029Spjd { "insensitive", ZFS_CASE_INSENSITIVE }, 129185029Spjd { "mixed", ZFS_CASE_MIXED }, 130185029Spjd { NULL } 131185029Spjd }; 132168404Spjd 133185029Spjd static zprop_index_t copies_table[] = { 134185029Spjd { "1", 1 }, 135185029Spjd { "2", 2 }, 136185029Spjd { "3", 3 }, 137185029Spjd { NULL } 138185029Spjd }; 139168404Spjd 140185029Spjd /* 141185029Spjd * Use the unique flags we have to send to u8_strcmp() and/or 142185029Spjd * u8_textprep() to represent the various normalization property 143185029Spjd * values. 144185029Spjd */ 145185029Spjd static zprop_index_t normalize_table[] = { 146185029Spjd { "none", 0 }, 147185029Spjd { "formD", U8_TEXTPREP_NFD }, 148185029Spjd { "formKC", U8_TEXTPREP_NFKC }, 149185029Spjd { "formC", U8_TEXTPREP_NFC }, 150185029Spjd { "formKD", U8_TEXTPREP_NFKD }, 151185029Spjd { NULL } 152185029Spjd }; 153168404Spjd 154185029Spjd static zprop_index_t version_table[] = { 155185029Spjd { "1", 1 }, 156185029Spjd { "2", 2 }, 157185029Spjd { "3", 3 }, 158209962Smm { "4", 4 }, 159219089Spjd { "5", 5 }, 160185029Spjd { "current", ZPL_VERSION }, 161185029Spjd { NULL } 162185029Spjd }; 163168404Spjd 164185029Spjd static zprop_index_t boolean_table[] = { 165185029Spjd { "off", 0 }, 166185029Spjd { "on", 1 }, 167185029Spjd { NULL } 168185029Spjd }; 169168404Spjd 170219089Spjd static zprop_index_t logbias_table[] = { 171219089Spjd { "latency", ZFS_LOGBIAS_LATENCY }, 172219089Spjd { "throughput", ZFS_LOGBIAS_THROUGHPUT }, 173219089Spjd { NULL } 174219089Spjd }; 175219089Spjd 176185029Spjd static zprop_index_t canmount_table[] = { 177185029Spjd { "off", ZFS_CANMOUNT_OFF }, 178185029Spjd { "on", ZFS_CANMOUNT_ON }, 179185029Spjd { "noauto", ZFS_CANMOUNT_NOAUTO }, 180185029Spjd { NULL } 181185029Spjd }; 182168404Spjd 183185029Spjd static zprop_index_t cache_table[] = { 184185029Spjd { "none", ZFS_CACHE_NONE }, 185185029Spjd { "metadata", ZFS_CACHE_METADATA }, 186185029Spjd { "all", ZFS_CACHE_ALL }, 187185029Spjd { NULL } 188185029Spjd }; 189168404Spjd 190219089Spjd static zprop_index_t sync_table[] = { 191219089Spjd { "standard", ZFS_SYNC_STANDARD }, 192219089Spjd { "always", ZFS_SYNC_ALWAYS }, 193219089Spjd { "disabled", ZFS_SYNC_DISABLED }, 194219089Spjd { NULL } 195219089Spjd }; 196219089Spjd 197185029Spjd /* inherit index properties */ 198219089Spjd zprop_register_index(ZFS_PROP_SYNC, "sync", ZFS_SYNC_STANDARD, 199185029Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 200219089Spjd "standard | always | disabled", "SYNC", 201219089Spjd sync_table); 202219089Spjd zprop_register_index(ZFS_PROP_CHECKSUM, "checksum", 203219089Spjd ZIO_CHECKSUM_DEFAULT, PROP_INHERIT, ZFS_TYPE_FILESYSTEM | 204219089Spjd ZFS_TYPE_VOLUME, 205185029Spjd "on | off | fletcher2 | fletcher4 | sha256", "CHECKSUM", 206185029Spjd checksum_table); 207219089Spjd zprop_register_index(ZFS_PROP_DEDUP, "dedup", ZIO_CHECKSUM_OFF, 208219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 209219089Spjd "on | off | verify | sha256[,verify]", "DEDUP", 210219089Spjd dedup_table); 211219089Spjd zprop_register_index(ZFS_PROP_COMPRESSION, "compression", 212185029Spjd ZIO_COMPRESS_DEFAULT, PROP_INHERIT, 213185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 214219089Spjd "on | off | lzjb | gzip | gzip-[1-9] | zle", "COMPRESS", 215219089Spjd compress_table); 216219089Spjd zprop_register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN, 217185029Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 218185029Spjd "hidden | visible", "SNAPDIR", snapdir_table); 219224174Smm zprop_register_index(ZFS_PROP_ACLMODE, "aclmode", ZFS_ACL_DISCARD, 220224174Smm PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 221243560Smm "discard | groupmask | passthrough | restricted", "ACLMODE", 222243560Smm acl_mode_table); 223219089Spjd zprop_register_index(ZFS_PROP_ACLINHERIT, "aclinherit", 224219089Spjd ZFS_ACL_RESTRICTED, PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 225201143Sdelphij "discard | noallow | restricted | passthrough | passthrough-x", 226185029Spjd "ACLINHERIT", acl_inherit_table); 227219089Spjd zprop_register_index(ZFS_PROP_COPIES, "copies", 1, PROP_INHERIT, 228219089Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 229185029Spjd "1 | 2 | 3", "COPIES", copies_table); 230219089Spjd zprop_register_index(ZFS_PROP_PRIMARYCACHE, "primarycache", 231185029Spjd ZFS_CACHE_ALL, PROP_INHERIT, 232185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, 233185029Spjd "all | none | metadata", "PRIMARYCACHE", cache_table); 234219089Spjd zprop_register_index(ZFS_PROP_SECONDARYCACHE, "secondarycache", 235185029Spjd ZFS_CACHE_ALL, PROP_INHERIT, 236185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, 237185029Spjd "all | none | metadata", "SECONDARYCACHE", cache_table); 238219089Spjd zprop_register_index(ZFS_PROP_LOGBIAS, "logbias", ZFS_LOGBIAS_LATENCY, 239219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 240219089Spjd "latency | throughput", "LOGBIAS", logbias_table); 241168404Spjd 242185029Spjd /* inherit index (boolean) properties */ 243219089Spjd zprop_register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT, 244185029Spjd ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table); 245219089Spjd zprop_register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT, 246185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES", 247185029Spjd boolean_table); 248219089Spjd zprop_register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT, 249185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC", 250185029Spjd boolean_table); 251219089Spjd zprop_register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT, 252185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID", 253185029Spjd boolean_table); 254219089Spjd zprop_register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT, 255185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY", 256185029Spjd boolean_table); 257219089Spjd zprop_register_index(ZFS_PROP_ZONED, "jailed", 0, PROP_INHERIT, 258185029Spjd ZFS_TYPE_FILESYSTEM, "on | off", "JAILED", boolean_table); 259219089Spjd zprop_register_index(ZFS_PROP_XATTR, "xattr", 1, PROP_INHERIT, 260185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "XATTR", 261185029Spjd boolean_table); 262219089Spjd zprop_register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT, 263185029Spjd ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN", 264185029Spjd boolean_table); 265219089Spjd zprop_register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT, 266185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND", 267185029Spjd boolean_table); 268168404Spjd 269185029Spjd /* default index properties */ 270219089Spjd zprop_register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT, 271185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 272228103Smm "1 | 2 | 3 | 4 | 5 | current", "VERSION", version_table); 273219089Spjd zprop_register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON, 274185029Spjd PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto", 275185029Spjd "CANMOUNT", canmount_table); 276168404Spjd 277185029Spjd /* readonly index (boolean) properties */ 278219089Spjd zprop_register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY, 279185029Spjd ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table); 280219089Spjd zprop_register_index(ZFS_PROP_DEFER_DESTROY, "defer_destroy", 0, 281219089Spjd PROP_READONLY, ZFS_TYPE_SNAPSHOT, "yes | no", "DEFER_DESTROY", 282219089Spjd boolean_table); 283185029Spjd 284185029Spjd /* set once index properties */ 285219089Spjd zprop_register_index(ZFS_PROP_NORMALIZE, "normalization", 0, 286185029Spjd PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 287185029Spjd "none | formC | formD | formKC | formKD", "NORMALIZATION", 288185029Spjd normalize_table); 289219089Spjd zprop_register_index(ZFS_PROP_CASE, "casesensitivity", 290219089Spjd ZFS_CASE_SENSITIVE, PROP_ONETIME, ZFS_TYPE_FILESYSTEM | 291219089Spjd ZFS_TYPE_SNAPSHOT, 292185029Spjd "sensitive | insensitive | mixed", "CASE", case_table); 293185029Spjd 294185029Spjd /* set once index (boolean) properties */ 295219089Spjd zprop_register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME, 296185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 297185029Spjd "on | off", "UTF8ONLY", boolean_table); 298185029Spjd 299185029Spjd /* string properties */ 300219089Spjd zprop_register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY, 301185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN"); 302228103Smm zprop_register_string(ZFS_PROP_CLONES, "clones", NULL, PROP_READONLY, 303228103Smm ZFS_TYPE_SNAPSHOT, "<dataset>[,...]", "CLONES"); 304219089Spjd zprop_register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/", 305219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "<path> | legacy | none", 306219089Spjd "MOUNTPOINT"); 307219089Spjd zprop_register_string(ZFS_PROP_SHARENFS, "sharenfs", "off", 308219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "on | off | share(1M) options", 309219089Spjd "SHARENFS"); 310219089Spjd zprop_register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY, 311185029Spjd ZFS_TYPE_DATASET, "filesystem | volume | snapshot", "TYPE"); 312219089Spjd zprop_register_string(ZFS_PROP_SHARESMB, "sharesmb", "off", 313219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 314219089Spjd "on | off | sharemgr(1M) options", "SHARESMB"); 315219089Spjd zprop_register_string(ZFS_PROP_MLSLABEL, "mlslabel", 316219089Spjd ZFS_MLSLABEL_DEFAULT, PROP_INHERIT, ZFS_TYPE_DATASET, 317219089Spjd "<sensitivity label>", "MLSLABEL"); 318185029Spjd 319185029Spjd /* readonly number properties */ 320219089Spjd zprop_register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY, 321185029Spjd ZFS_TYPE_DATASET, "<size>", "USED"); 322219089Spjd zprop_register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY, 323185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL"); 324219089Spjd zprop_register_number(ZFS_PROP_REFERENCED, "referenced", 0, 325219089Spjd PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "REFER"); 326219089Spjd zprop_register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0, 327185029Spjd PROP_READONLY, ZFS_TYPE_DATASET, 328185029Spjd "<1.00x or higher if compressed>", "RATIO"); 329223623Smm zprop_register_number(ZFS_PROP_REFRATIO, "refcompressratio", 0, 330223623Smm PROP_READONLY, ZFS_TYPE_DATASET, 331223623Smm "<1.00x or higher if compressed>", "REFRATIO"); 332219089Spjd zprop_register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize", 333219089Spjd ZVOL_DEFAULT_BLOCKSIZE, PROP_ONETIME, 334185029Spjd ZFS_TYPE_VOLUME, "512 to 128k, power of 2", "VOLBLOCK"); 335219089Spjd zprop_register_number(ZFS_PROP_USEDSNAP, "usedbysnapshots", 0, 336219089Spjd PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 337219089Spjd "USEDSNAP"); 338219089Spjd zprop_register_number(ZFS_PROP_USEDDS, "usedbydataset", 0, 339219089Spjd PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 340219089Spjd "USEDDS"); 341219089Spjd zprop_register_number(ZFS_PROP_USEDCHILD, "usedbychildren", 0, 342219089Spjd PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 343219089Spjd "USEDCHILD"); 344219089Spjd zprop_register_number(ZFS_PROP_USEDREFRESERV, "usedbyrefreservation", 0, 345185029Spjd PROP_READONLY, 346185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDREFRESERV"); 347219089Spjd zprop_register_number(ZFS_PROP_USERREFS, "userrefs", 0, PROP_READONLY, 348219089Spjd ZFS_TYPE_SNAPSHOT, "<count>", "USERREFS"); 349228103Smm zprop_register_number(ZFS_PROP_WRITTEN, "written", 0, PROP_READONLY, 350228103Smm ZFS_TYPE_DATASET, "<size>", "WRITTEN"); 351185029Spjd 352185029Spjd /* default number properties */ 353219089Spjd zprop_register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT, 354185029Spjd ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA"); 355219089Spjd zprop_register_number(ZFS_PROP_RESERVATION, "reservation", 0, 356219089Spjd PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 357219089Spjd "<size> | none", "RESERV"); 358219089Spjd zprop_register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT, 359185029Spjd ZFS_TYPE_VOLUME, "<size>", "VOLSIZE"); 360219089Spjd zprop_register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT, 361185029Spjd ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA"); 362219089Spjd zprop_register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0, 363185029Spjd PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 364185029Spjd "<size> | none", "REFRESERV"); 365185029Spjd 366185029Spjd /* inherit number properties */ 367219089Spjd zprop_register_number(ZFS_PROP_RECORDSIZE, "recordsize", 368219089Spjd SPA_MAXBLOCKSIZE, PROP_INHERIT, 369185029Spjd ZFS_TYPE_FILESYSTEM, "512 to 128k, power of 2", "RECSIZE"); 370185029Spjd 371185029Spjd /* hidden properties */ 372219089Spjd zprop_register_hidden(ZFS_PROP_CREATETXG, "createtxg", PROP_TYPE_NUMBER, 373192240Skmacy PROP_READONLY, ZFS_TYPE_DATASET, "CREATETXG"); 374219089Spjd zprop_register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER, 375219089Spjd PROP_READONLY, ZFS_TYPE_SNAPSHOT, "NUMCLONES"); 376219089Spjd zprop_register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING, 377185029Spjd PROP_READONLY, ZFS_TYPE_DATASET, "NAME"); 378219089Spjd zprop_register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions", 379219089Spjd PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS"); 380219089Spjd zprop_register_hidden(ZFS_PROP_STMF_SHAREINFO, "stmf_sbd_lu", 381219089Spjd PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, 382219089Spjd "STMF_SBD_LU"); 383219089Spjd zprop_register_hidden(ZFS_PROP_GUID, "guid", PROP_TYPE_NUMBER, 384219089Spjd PROP_READONLY, ZFS_TYPE_DATASET, "GUID"); 385219089Spjd zprop_register_hidden(ZFS_PROP_USERACCOUNTING, "useraccounting", 386219089Spjd PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, 387219089Spjd "USERACCOUNTING"); 388219089Spjd zprop_register_hidden(ZFS_PROP_UNIQUE, "unique", PROP_TYPE_NUMBER, 389219089Spjd PROP_READONLY, ZFS_TYPE_DATASET, "UNIQUE"); 390219089Spjd zprop_register_hidden(ZFS_PROP_OBJSETID, "objsetid", PROP_TYPE_NUMBER, 391219089Spjd PROP_READONLY, ZFS_TYPE_DATASET, "OBJSETID"); 392185029Spjd 393185029Spjd /* oddball properties */ 394219089Spjd zprop_register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0, 395219089Spjd NULL, PROP_READONLY, ZFS_TYPE_DATASET, 396185029Spjd "<date>", "CREATION", B_FALSE, B_TRUE, NULL); 397168404Spjd} 398168404Spjd 399185029Spjdboolean_t 400185029Spjdzfs_prop_delegatable(zfs_prop_t prop) 401168404Spjd{ 402185029Spjd zprop_desc_t *pd = &zfs_prop_table[prop]; 403219089Spjd 404219089Spjd /* The mlslabel property is never delegatable. */ 405219089Spjd if (prop == ZFS_PROP_MLSLABEL) 406219089Spjd return (B_FALSE); 407219089Spjd 408185029Spjd return (pd->pd_attr != PROP_READONLY); 409168404Spjd} 410168404Spjd 411168404Spjd/* 412168404Spjd * Given a zfs dataset property name, returns the corresponding property ID. 413168404Spjd */ 414168404Spjdzfs_prop_t 415168404Spjdzfs_name_to_prop(const char *propname) 416168404Spjd{ 417185029Spjd return (zprop_name_to_prop(propname, ZFS_TYPE_DATASET)); 418168404Spjd} 419168404Spjd 420168404Spjd/* 421168404Spjd * For user property names, we allow all lowercase alphanumeric characters, plus 422168404Spjd * a few useful punctuation characters. 423168404Spjd */ 424168404Spjdstatic int 425168404Spjdvalid_char(char c) 426168404Spjd{ 427168404Spjd return ((c >= 'a' && c <= 'z') || 428168404Spjd (c >= '0' && c <= '9') || 429168404Spjd c == '-' || c == '_' || c == '.' || c == ':'); 430168404Spjd} 431168404Spjd 432168404Spjd/* 433168404Spjd * Returns true if this is a valid user-defined property (one with a ':'). 434168404Spjd */ 435168404Spjdboolean_t 436168404Spjdzfs_prop_user(const char *name) 437168404Spjd{ 438168404Spjd int i; 439168404Spjd char c; 440168404Spjd boolean_t foundsep = B_FALSE; 441168404Spjd 442168404Spjd for (i = 0; i < strlen(name); i++) { 443168404Spjd c = name[i]; 444168404Spjd if (!valid_char(c)) 445168404Spjd return (B_FALSE); 446168404Spjd if (c == ':') 447168404Spjd foundsep = B_TRUE; 448168404Spjd } 449168404Spjd 450168404Spjd if (!foundsep) 451168404Spjd return (B_FALSE); 452168404Spjd 453168404Spjd return (B_TRUE); 454168404Spjd} 455168404Spjd 456168404Spjd/* 457209962Smm * Returns true if this is a valid userspace-type property (one with a '@'). 458209962Smm * Note that after the @, any character is valid (eg, another @, for SID 459209962Smm * user@domain). 460209962Smm */ 461209962Smmboolean_t 462209962Smmzfs_prop_userquota(const char *name) 463209962Smm{ 464209962Smm zfs_userquota_prop_t prop; 465209962Smm 466209962Smm for (prop = 0; prop < ZFS_NUM_USERQUOTA_PROPS; prop++) { 467209962Smm if (strncmp(name, zfs_userquota_prop_prefixes[prop], 468209962Smm strlen(zfs_userquota_prop_prefixes[prop])) == 0) { 469209962Smm return (B_TRUE); 470209962Smm } 471209962Smm } 472209962Smm 473209962Smm return (B_FALSE); 474209962Smm} 475209962Smm 476209962Smm/* 477228103Smm * Returns true if this is a valid written@ property. 478228103Smm * Note that after the @, any character is valid (eg, another @, for 479228103Smm * written@pool/fs@origin). 480228103Smm */ 481228103Smmboolean_t 482228103Smmzfs_prop_written(const char *name) 483228103Smm{ 484228103Smm static const char *prefix = "written@"; 485228103Smm return (strncmp(name, prefix, strlen(prefix)) == 0); 486228103Smm} 487228103Smm 488228103Smm/* 489185029Spjd * Tables of index types, plus functions to convert between the user view 490185029Spjd * (strings) and internal representation (uint64_t). 491168404Spjd */ 492185029Spjdint 493185029Spjdzfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index) 494168404Spjd{ 495185029Spjd return (zprop_string_to_index(prop, string, index, ZFS_TYPE_DATASET)); 496168404Spjd} 497168404Spjd 498185029Spjdint 499185029Spjdzfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string) 500168404Spjd{ 501185029Spjd return (zprop_index_to_string(prop, index, string, ZFS_TYPE_DATASET)); 502168404Spjd} 503168404Spjd 504219089Spjduint64_t 505219089Spjdzfs_prop_random_value(zfs_prop_t prop, uint64_t seed) 506219089Spjd{ 507219089Spjd return (zprop_random_value(prop, seed, ZFS_TYPE_DATASET)); 508219089Spjd} 509219089Spjd 510168404Spjd/* 511185029Spjd * Returns TRUE if the property applies to any of the given dataset types. 512168404Spjd */ 513185029Spjdboolean_t 514185029Spjdzfs_prop_valid_for_type(int prop, zfs_type_t types) 515168404Spjd{ 516185029Spjd return (zprop_valid_for_type(prop, types)); 517168404Spjd} 518168404Spjd 519185029Spjdzprop_type_t 520185029Spjdzfs_prop_get_type(zfs_prop_t prop) 521168404Spjd{ 522185029Spjd return (zfs_prop_table[prop].pd_proptype); 523168404Spjd} 524168404Spjd 525168404Spjd/* 526185029Spjd * Returns TRUE if the property is readonly. 527168404Spjd */ 528185029Spjdboolean_t 529185029Spjdzfs_prop_readonly(zfs_prop_t prop) 530168404Spjd{ 531185029Spjd return (zfs_prop_table[prop].pd_attr == PROP_READONLY || 532185029Spjd zfs_prop_table[prop].pd_attr == PROP_ONETIME); 533168404Spjd} 534168404Spjd 535168404Spjd/* 536185029Spjd * Returns TRUE if the property is only allowed to be set once. 537168404Spjd */ 538185029Spjdboolean_t 539185029Spjdzfs_prop_setonce(zfs_prop_t prop) 540168404Spjd{ 541185029Spjd return (zfs_prop_table[prop].pd_attr == PROP_ONETIME); 542168404Spjd} 543168404Spjd 544185029Spjdconst char * 545185029Spjdzfs_prop_default_string(zfs_prop_t prop) 546185029Spjd{ 547185029Spjd return (zfs_prop_table[prop].pd_strdefault); 548185029Spjd} 549168404Spjd 550185029Spjduint64_t 551185029Spjdzfs_prop_default_numeric(zfs_prop_t prop) 552168404Spjd{ 553185029Spjd return (zfs_prop_table[prop].pd_numdefault); 554168404Spjd} 555168404Spjd 556168404Spjd/* 557185029Spjd * Given a dataset property ID, returns the corresponding name. 558185029Spjd * Assuming the zfs dataset property ID is valid. 559168404Spjd */ 560185029Spjdconst char * 561185029Spjdzfs_prop_to_name(zfs_prop_t prop) 562168404Spjd{ 563185029Spjd return (zfs_prop_table[prop].pd_name); 564168404Spjd} 565168404Spjd 566185029Spjd/* 567185029Spjd * Returns TRUE if the property is inheritable. 568185029Spjd */ 569185029Spjdboolean_t 570185029Spjdzfs_prop_inheritable(zfs_prop_t prop) 571168404Spjd{ 572185029Spjd return (zfs_prop_table[prop].pd_attr == PROP_INHERIT || 573185029Spjd zfs_prop_table[prop].pd_attr == PROP_ONETIME); 574168404Spjd} 575168404Spjd 576168404Spjd#ifndef _KERNEL 577168404Spjd 578168404Spjd/* 579168404Spjd * Returns a string describing the set of acceptable values for the given 580168404Spjd * zfs property, or NULL if it cannot be set. 581168404Spjd */ 582168404Spjdconst char * 583168404Spjdzfs_prop_values(zfs_prop_t prop) 584168404Spjd{ 585168404Spjd return (zfs_prop_table[prop].pd_values); 586168404Spjd} 587168404Spjd 588168404Spjd/* 589168404Spjd * Returns TRUE if this property is a string type. Note that index types 590168404Spjd * (compression, checksum) are treated as strings in userland, even though they 591168404Spjd * are stored numerically on disk. 592168404Spjd */ 593168404Spjdint 594168404Spjdzfs_prop_is_string(zfs_prop_t prop) 595168404Spjd{ 596185029Spjd return (zfs_prop_table[prop].pd_proptype == PROP_TYPE_STRING || 597185029Spjd zfs_prop_table[prop].pd_proptype == PROP_TYPE_INDEX); 598168404Spjd} 599168404Spjd 600168404Spjd/* 601168404Spjd * Returns the column header for the given property. Used only in 602168404Spjd * 'zfs list -o', but centralized here with the other property information. 603168404Spjd */ 604168404Spjdconst char * 605168404Spjdzfs_prop_column_name(zfs_prop_t prop) 606168404Spjd{ 607168404Spjd return (zfs_prop_table[prop].pd_colname); 608168404Spjd} 609168404Spjd 610168404Spjd/* 611168404Spjd * Returns whether the given property should be displayed right-justified for 612168404Spjd * 'zfs list'. 613168404Spjd */ 614168404Spjdboolean_t 615168404Spjdzfs_prop_align_right(zfs_prop_t prop) 616168404Spjd{ 617168404Spjd return (zfs_prop_table[prop].pd_rightalign); 618168404Spjd} 619168404Spjd 620168404Spjd#endif 621