zfs_prop.c revision 253819
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. 23247585Smm * Copyright (c) 2012 by Delphix. All rights reserved. 24246586Sdelphij * Copyright (c) 2013 by Saso Kiselkov. All rights reserved. 25168404Spjd */ 26168404Spjd 27219089Spjd/* Portions Copyright 2010 Robert Milkowski */ 28219089Spjd 29168404Spjd#include <sys/zio.h> 30168404Spjd#include <sys/spa.h> 31185029Spjd#include <sys/u8_textprep.h> 32168404Spjd#include <sys/zfs_acl.h> 33168404Spjd#include <sys/zfs_ioctl.h> 34185029Spjd#include <sys/zfs_znode.h> 35168404Spjd 36168404Spjd#include "zfs_prop.h" 37185029Spjd#include "zfs_deleg.h" 38168404Spjd 39168404Spjd#if defined(_KERNEL) 40168404Spjd#include <sys/systm.h> 41168404Spjd#else 42168404Spjd#include <stdlib.h> 43168404Spjd#include <string.h> 44168404Spjd#include <ctype.h> 45168404Spjd#endif 46168404Spjd 47185029Spjdstatic zprop_desc_t zfs_prop_table[ZFS_NUM_PROPS]; 48168404Spjd 49209962Smm/* Note this is indexed by zfs_userquota_prop_t, keep the order the same */ 50209962Smmconst char *zfs_userquota_prop_prefixes[] = { 51209962Smm "userused@", 52209962Smm "userquota@", 53209962Smm "groupused@", 54209962Smm "groupquota@" 55209962Smm}; 56209962Smm 57185029Spjdzprop_desc_t * 58185029Spjdzfs_prop_get_table(void) 59168404Spjd{ 60185029Spjd return (zfs_prop_table); 61168404Spjd} 62168404Spjd 63185029Spjdvoid 64185029Spjdzfs_prop_init(void) 65168404Spjd{ 66185029Spjd static zprop_index_t checksum_table[] = { 67185029Spjd { "on", ZIO_CHECKSUM_ON }, 68185029Spjd { "off", ZIO_CHECKSUM_OFF }, 69185029Spjd { "fletcher2", ZIO_CHECKSUM_FLETCHER_2 }, 70185029Spjd { "fletcher4", ZIO_CHECKSUM_FLETCHER_4 }, 71185029Spjd { "sha256", ZIO_CHECKSUM_SHA256 }, 72185029Spjd { NULL } 73185029Spjd }; 74168404Spjd 75219089Spjd static zprop_index_t dedup_table[] = { 76219089Spjd { "on", ZIO_CHECKSUM_ON }, 77219089Spjd { "off", ZIO_CHECKSUM_OFF }, 78219089Spjd { "verify", ZIO_CHECKSUM_ON | ZIO_CHECKSUM_VERIFY }, 79219089Spjd { "sha256", ZIO_CHECKSUM_SHA256 }, 80219089Spjd { "sha256,verify", 81219089Spjd ZIO_CHECKSUM_SHA256 | ZIO_CHECKSUM_VERIFY }, 82219089Spjd { NULL } 83219089Spjd }; 84219089Spjd 85185029Spjd static zprop_index_t compress_table[] = { 86185029Spjd { "on", ZIO_COMPRESS_ON }, 87185029Spjd { "off", ZIO_COMPRESS_OFF }, 88185029Spjd { "lzjb", ZIO_COMPRESS_LZJB }, 89185029Spjd { "gzip", ZIO_COMPRESS_GZIP_6 }, /* gzip default */ 90185029Spjd { "gzip-1", ZIO_COMPRESS_GZIP_1 }, 91185029Spjd { "gzip-2", ZIO_COMPRESS_GZIP_2 }, 92185029Spjd { "gzip-3", ZIO_COMPRESS_GZIP_3 }, 93185029Spjd { "gzip-4", ZIO_COMPRESS_GZIP_4 }, 94185029Spjd { "gzip-5", ZIO_COMPRESS_GZIP_5 }, 95185029Spjd { "gzip-6", ZIO_COMPRESS_GZIP_6 }, 96185029Spjd { "gzip-7", ZIO_COMPRESS_GZIP_7 }, 97185029Spjd { "gzip-8", ZIO_COMPRESS_GZIP_8 }, 98185029Spjd { "gzip-9", ZIO_COMPRESS_GZIP_9 }, 99219089Spjd { "zle", ZIO_COMPRESS_ZLE }, 100246586Sdelphij { "lz4", ZIO_COMPRESS_LZ4 }, 101185029Spjd { NULL } 102185029Spjd }; 103168404Spjd 104185029Spjd static zprop_index_t snapdir_table[] = { 105185029Spjd { "hidden", ZFS_SNAPDIR_HIDDEN }, 106185029Spjd { "visible", ZFS_SNAPDIR_VISIBLE }, 107185029Spjd { NULL } 108185029Spjd }; 109168404Spjd 110224174Smm static zprop_index_t acl_mode_table[] = { 111224174Smm { "discard", ZFS_ACL_DISCARD }, 112224174Smm { "groupmask", ZFS_ACL_GROUPMASK }, 113224174Smm { "passthrough", ZFS_ACL_PASSTHROUGH }, 114243560Smm { "restricted", ZFS_ACL_RESTRICTED }, 115224174Smm { NULL } 116224174Smm }; 117224174Smm 118185029Spjd static zprop_index_t acl_inherit_table[] = { 119185029Spjd { "discard", ZFS_ACL_DISCARD }, 120185029Spjd { "noallow", ZFS_ACL_NOALLOW }, 121185029Spjd { "restricted", ZFS_ACL_RESTRICTED }, 122185029Spjd { "passthrough", ZFS_ACL_PASSTHROUGH }, 123185029Spjd { "secure", ZFS_ACL_RESTRICTED }, /* bkwrd compatability */ 124201143Sdelphij { "passthrough-x", ZFS_ACL_PASSTHROUGH_X }, 125185029Spjd { NULL } 126185029Spjd }; 127168404Spjd 128185029Spjd static zprop_index_t case_table[] = { 129185029Spjd { "sensitive", ZFS_CASE_SENSITIVE }, 130185029Spjd { "insensitive", ZFS_CASE_INSENSITIVE }, 131185029Spjd { "mixed", ZFS_CASE_MIXED }, 132185029Spjd { NULL } 133185029Spjd }; 134168404Spjd 135185029Spjd static zprop_index_t copies_table[] = { 136185029Spjd { "1", 1 }, 137185029Spjd { "2", 2 }, 138185029Spjd { "3", 3 }, 139185029Spjd { NULL } 140185029Spjd }; 141168404Spjd 142185029Spjd /* 143185029Spjd * Use the unique flags we have to send to u8_strcmp() and/or 144185029Spjd * u8_textprep() to represent the various normalization property 145185029Spjd * values. 146185029Spjd */ 147185029Spjd static zprop_index_t normalize_table[] = { 148185029Spjd { "none", 0 }, 149185029Spjd { "formD", U8_TEXTPREP_NFD }, 150185029Spjd { "formKC", U8_TEXTPREP_NFKC }, 151185029Spjd { "formC", U8_TEXTPREP_NFC }, 152185029Spjd { "formKD", U8_TEXTPREP_NFKD }, 153185029Spjd { NULL } 154185029Spjd }; 155168404Spjd 156185029Spjd static zprop_index_t version_table[] = { 157185029Spjd { "1", 1 }, 158185029Spjd { "2", 2 }, 159185029Spjd { "3", 3 }, 160209962Smm { "4", 4 }, 161219089Spjd { "5", 5 }, 162185029Spjd { "current", ZPL_VERSION }, 163185029Spjd { NULL } 164185029Spjd }; 165168404Spjd 166185029Spjd static zprop_index_t boolean_table[] = { 167185029Spjd { "off", 0 }, 168185029Spjd { "on", 1 }, 169185029Spjd { NULL } 170185029Spjd }; 171168404Spjd 172219089Spjd static zprop_index_t logbias_table[] = { 173219089Spjd { "latency", ZFS_LOGBIAS_LATENCY }, 174219089Spjd { "throughput", ZFS_LOGBIAS_THROUGHPUT }, 175219089Spjd { NULL } 176219089Spjd }; 177219089Spjd 178185029Spjd static zprop_index_t canmount_table[] = { 179185029Spjd { "off", ZFS_CANMOUNT_OFF }, 180185029Spjd { "on", ZFS_CANMOUNT_ON }, 181185029Spjd { "noauto", ZFS_CANMOUNT_NOAUTO }, 182185029Spjd { NULL } 183185029Spjd }; 184168404Spjd 185185029Spjd static zprop_index_t cache_table[] = { 186185029Spjd { "none", ZFS_CACHE_NONE }, 187185029Spjd { "metadata", ZFS_CACHE_METADATA }, 188185029Spjd { "all", ZFS_CACHE_ALL }, 189185029Spjd { NULL } 190185029Spjd }; 191168404Spjd 192219089Spjd static zprop_index_t sync_table[] = { 193219089Spjd { "standard", ZFS_SYNC_STANDARD }, 194219089Spjd { "always", ZFS_SYNC_ALWAYS }, 195219089Spjd { "disabled", ZFS_SYNC_DISABLED }, 196219089Spjd { NULL } 197219089Spjd }; 198219089Spjd 199185029Spjd /* inherit index properties */ 200219089Spjd zprop_register_index(ZFS_PROP_SYNC, "sync", ZFS_SYNC_STANDARD, 201185029Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 202219089Spjd "standard | always | disabled", "SYNC", 203219089Spjd sync_table); 204219089Spjd zprop_register_index(ZFS_PROP_CHECKSUM, "checksum", 205219089Spjd ZIO_CHECKSUM_DEFAULT, PROP_INHERIT, ZFS_TYPE_FILESYSTEM | 206219089Spjd ZFS_TYPE_VOLUME, 207185029Spjd "on | off | fletcher2 | fletcher4 | sha256", "CHECKSUM", 208185029Spjd checksum_table); 209219089Spjd zprop_register_index(ZFS_PROP_DEDUP, "dedup", ZIO_CHECKSUM_OFF, 210219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 211219089Spjd "on | off | verify | sha256[,verify]", "DEDUP", 212219089Spjd dedup_table); 213219089Spjd zprop_register_index(ZFS_PROP_COMPRESSION, "compression", 214185029Spjd ZIO_COMPRESS_DEFAULT, PROP_INHERIT, 215185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 216246586Sdelphij "on | off | lzjb | gzip | gzip-[1-9] | zle | lz4", 217246586Sdelphij "COMPRESS", compress_table); 218219089Spjd zprop_register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN, 219185029Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 220185029Spjd "hidden | visible", "SNAPDIR", snapdir_table); 221224174Smm zprop_register_index(ZFS_PROP_ACLMODE, "aclmode", ZFS_ACL_DISCARD, 222224174Smm PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 223243560Smm "discard | groupmask | passthrough | restricted", "ACLMODE", 224243560Smm acl_mode_table); 225219089Spjd zprop_register_index(ZFS_PROP_ACLINHERIT, "aclinherit", 226219089Spjd ZFS_ACL_RESTRICTED, PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 227201143Sdelphij "discard | noallow | restricted | passthrough | passthrough-x", 228185029Spjd "ACLINHERIT", acl_inherit_table); 229219089Spjd zprop_register_index(ZFS_PROP_COPIES, "copies", 1, PROP_INHERIT, 230219089Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 231185029Spjd "1 | 2 | 3", "COPIES", copies_table); 232219089Spjd zprop_register_index(ZFS_PROP_PRIMARYCACHE, "primarycache", 233185029Spjd ZFS_CACHE_ALL, PROP_INHERIT, 234185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, 235185029Spjd "all | none | metadata", "PRIMARYCACHE", cache_table); 236219089Spjd zprop_register_index(ZFS_PROP_SECONDARYCACHE, "secondarycache", 237185029Spjd ZFS_CACHE_ALL, PROP_INHERIT, 238185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, 239185029Spjd "all | none | metadata", "SECONDARYCACHE", cache_table); 240219089Spjd zprop_register_index(ZFS_PROP_LOGBIAS, "logbias", ZFS_LOGBIAS_LATENCY, 241219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 242219089Spjd "latency | throughput", "LOGBIAS", logbias_table); 243168404Spjd 244185029Spjd /* inherit index (boolean) properties */ 245219089Spjd zprop_register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT, 246185029Spjd ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table); 247219089Spjd zprop_register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT, 248185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES", 249185029Spjd boolean_table); 250219089Spjd zprop_register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT, 251185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC", 252185029Spjd boolean_table); 253219089Spjd zprop_register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT, 254185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID", 255185029Spjd boolean_table); 256219089Spjd zprop_register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT, 257185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY", 258185029Spjd boolean_table); 259219089Spjd zprop_register_index(ZFS_PROP_ZONED, "jailed", 0, PROP_INHERIT, 260185029Spjd ZFS_TYPE_FILESYSTEM, "on | off", "JAILED", boolean_table); 261219089Spjd zprop_register_index(ZFS_PROP_XATTR, "xattr", 1, PROP_INHERIT, 262185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "XATTR", 263185029Spjd boolean_table); 264219089Spjd zprop_register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT, 265185029Spjd ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN", 266185029Spjd boolean_table); 267219089Spjd zprop_register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT, 268185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND", 269185029Spjd boolean_table); 270168404Spjd 271185029Spjd /* default index properties */ 272219089Spjd zprop_register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT, 273185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 274228103Smm "1 | 2 | 3 | 4 | 5 | current", "VERSION", version_table); 275219089Spjd zprop_register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON, 276185029Spjd PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto", 277185029Spjd "CANMOUNT", canmount_table); 278168404Spjd 279185029Spjd /* readonly index (boolean) properties */ 280219089Spjd zprop_register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY, 281185029Spjd ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table); 282219089Spjd zprop_register_index(ZFS_PROP_DEFER_DESTROY, "defer_destroy", 0, 283219089Spjd PROP_READONLY, ZFS_TYPE_SNAPSHOT, "yes | no", "DEFER_DESTROY", 284219089Spjd boolean_table); 285185029Spjd 286185029Spjd /* set once index properties */ 287219089Spjd zprop_register_index(ZFS_PROP_NORMALIZE, "normalization", 0, 288185029Spjd PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 289185029Spjd "none | formC | formD | formKC | formKD", "NORMALIZATION", 290185029Spjd normalize_table); 291219089Spjd zprop_register_index(ZFS_PROP_CASE, "casesensitivity", 292219089Spjd ZFS_CASE_SENSITIVE, PROP_ONETIME, ZFS_TYPE_FILESYSTEM | 293219089Spjd ZFS_TYPE_SNAPSHOT, 294185029Spjd "sensitive | insensitive | mixed", "CASE", case_table); 295185029Spjd 296185029Spjd /* set once index (boolean) properties */ 297219089Spjd zprop_register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME, 298185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 299185029Spjd "on | off", "UTF8ONLY", boolean_table); 300185029Spjd 301185029Spjd /* string properties */ 302219089Spjd zprop_register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY, 303185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN"); 304228103Smm zprop_register_string(ZFS_PROP_CLONES, "clones", NULL, PROP_READONLY, 305228103Smm ZFS_TYPE_SNAPSHOT, "<dataset>[,...]", "CLONES"); 306219089Spjd zprop_register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/", 307219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "<path> | legacy | none", 308219089Spjd "MOUNTPOINT"); 309219089Spjd zprop_register_string(ZFS_PROP_SHARENFS, "sharenfs", "off", 310219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "on | off | share(1M) options", 311219089Spjd "SHARENFS"); 312219089Spjd zprop_register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY, 313185029Spjd ZFS_TYPE_DATASET, "filesystem | volume | snapshot", "TYPE"); 314219089Spjd zprop_register_string(ZFS_PROP_SHARESMB, "sharesmb", "off", 315219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 316219089Spjd "on | off | sharemgr(1M) options", "SHARESMB"); 317219089Spjd zprop_register_string(ZFS_PROP_MLSLABEL, "mlslabel", 318219089Spjd ZFS_MLSLABEL_DEFAULT, PROP_INHERIT, ZFS_TYPE_DATASET, 319219089Spjd "<sensitivity label>", "MLSLABEL"); 320185029Spjd 321185029Spjd /* readonly number properties */ 322219089Spjd zprop_register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY, 323185029Spjd ZFS_TYPE_DATASET, "<size>", "USED"); 324219089Spjd zprop_register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY, 325185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL"); 326219089Spjd zprop_register_number(ZFS_PROP_REFERENCED, "referenced", 0, 327219089Spjd PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "REFER"); 328219089Spjd zprop_register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0, 329185029Spjd PROP_READONLY, ZFS_TYPE_DATASET, 330185029Spjd "<1.00x or higher if compressed>", "RATIO"); 331223623Smm zprop_register_number(ZFS_PROP_REFRATIO, "refcompressratio", 0, 332223623Smm PROP_READONLY, ZFS_TYPE_DATASET, 333223623Smm "<1.00x or higher if compressed>", "REFRATIO"); 334219089Spjd zprop_register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize", 335219089Spjd ZVOL_DEFAULT_BLOCKSIZE, PROP_ONETIME, 336185029Spjd ZFS_TYPE_VOLUME, "512 to 128k, power of 2", "VOLBLOCK"); 337219089Spjd zprop_register_number(ZFS_PROP_USEDSNAP, "usedbysnapshots", 0, 338219089Spjd PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 339219089Spjd "USEDSNAP"); 340219089Spjd zprop_register_number(ZFS_PROP_USEDDS, "usedbydataset", 0, 341219089Spjd PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 342219089Spjd "USEDDS"); 343219089Spjd zprop_register_number(ZFS_PROP_USEDCHILD, "usedbychildren", 0, 344219089Spjd PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 345219089Spjd "USEDCHILD"); 346219089Spjd zprop_register_number(ZFS_PROP_USEDREFRESERV, "usedbyrefreservation", 0, 347185029Spjd PROP_READONLY, 348185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDREFRESERV"); 349219089Spjd zprop_register_number(ZFS_PROP_USERREFS, "userrefs", 0, PROP_READONLY, 350219089Spjd ZFS_TYPE_SNAPSHOT, "<count>", "USERREFS"); 351228103Smm zprop_register_number(ZFS_PROP_WRITTEN, "written", 0, PROP_READONLY, 352228103Smm ZFS_TYPE_DATASET, "<size>", "WRITTEN"); 353247585Smm zprop_register_number(ZFS_PROP_LOGICALUSED, "logicalused", 0, 354247585Smm PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "LUSED"); 355247585Smm zprop_register_number(ZFS_PROP_LOGICALREFERENCED, "logicalreferenced", 356247585Smm 0, PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "LREFER"); 357185029Spjd 358185029Spjd /* default number properties */ 359219089Spjd zprop_register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT, 360185029Spjd ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA"); 361219089Spjd zprop_register_number(ZFS_PROP_RESERVATION, "reservation", 0, 362219089Spjd PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 363219089Spjd "<size> | none", "RESERV"); 364219089Spjd zprop_register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT, 365185029Spjd ZFS_TYPE_VOLUME, "<size>", "VOLSIZE"); 366219089Spjd zprop_register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT, 367185029Spjd ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA"); 368219089Spjd zprop_register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0, 369185029Spjd PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 370185029Spjd "<size> | none", "REFRESERV"); 371185029Spjd 372185029Spjd /* inherit number properties */ 373219089Spjd zprop_register_number(ZFS_PROP_RECORDSIZE, "recordsize", 374219089Spjd SPA_MAXBLOCKSIZE, PROP_INHERIT, 375185029Spjd ZFS_TYPE_FILESYSTEM, "512 to 128k, power of 2", "RECSIZE"); 376185029Spjd 377185029Spjd /* hidden properties */ 378219089Spjd zprop_register_hidden(ZFS_PROP_CREATETXG, "createtxg", PROP_TYPE_NUMBER, 379192240Skmacy PROP_READONLY, ZFS_TYPE_DATASET, "CREATETXG"); 380219089Spjd zprop_register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER, 381219089Spjd PROP_READONLY, ZFS_TYPE_SNAPSHOT, "NUMCLONES"); 382219089Spjd zprop_register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING, 383185029Spjd PROP_READONLY, ZFS_TYPE_DATASET, "NAME"); 384219089Spjd zprop_register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions", 385219089Spjd PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS"); 386219089Spjd zprop_register_hidden(ZFS_PROP_STMF_SHAREINFO, "stmf_sbd_lu", 387219089Spjd PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, 388219089Spjd "STMF_SBD_LU"); 389219089Spjd zprop_register_hidden(ZFS_PROP_GUID, "guid", PROP_TYPE_NUMBER, 390219089Spjd PROP_READONLY, ZFS_TYPE_DATASET, "GUID"); 391219089Spjd zprop_register_hidden(ZFS_PROP_USERACCOUNTING, "useraccounting", 392219089Spjd PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, 393219089Spjd "USERACCOUNTING"); 394219089Spjd zprop_register_hidden(ZFS_PROP_UNIQUE, "unique", PROP_TYPE_NUMBER, 395219089Spjd PROP_READONLY, ZFS_TYPE_DATASET, "UNIQUE"); 396219089Spjd zprop_register_hidden(ZFS_PROP_OBJSETID, "objsetid", PROP_TYPE_NUMBER, 397219089Spjd PROP_READONLY, ZFS_TYPE_DATASET, "OBJSETID"); 398253819Sdelphij zprop_register_hidden(ZFS_PROP_INCONSISTENT, "inconsistent", 399253819Sdelphij PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, "INCONSISTENT"); 400185029Spjd 401185029Spjd /* oddball properties */ 402219089Spjd zprop_register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0, 403219089Spjd NULL, PROP_READONLY, ZFS_TYPE_DATASET, 404185029Spjd "<date>", "CREATION", B_FALSE, B_TRUE, NULL); 405168404Spjd} 406168404Spjd 407185029Spjdboolean_t 408185029Spjdzfs_prop_delegatable(zfs_prop_t prop) 409168404Spjd{ 410185029Spjd zprop_desc_t *pd = &zfs_prop_table[prop]; 411219089Spjd 412219089Spjd /* The mlslabel property is never delegatable. */ 413219089Spjd if (prop == ZFS_PROP_MLSLABEL) 414219089Spjd return (B_FALSE); 415219089Spjd 416185029Spjd return (pd->pd_attr != PROP_READONLY); 417168404Spjd} 418168404Spjd 419168404Spjd/* 420168404Spjd * Given a zfs dataset property name, returns the corresponding property ID. 421168404Spjd */ 422168404Spjdzfs_prop_t 423168404Spjdzfs_name_to_prop(const char *propname) 424168404Spjd{ 425185029Spjd return (zprop_name_to_prop(propname, ZFS_TYPE_DATASET)); 426168404Spjd} 427168404Spjd 428168404Spjd/* 429168404Spjd * For user property names, we allow all lowercase alphanumeric characters, plus 430168404Spjd * a few useful punctuation characters. 431168404Spjd */ 432168404Spjdstatic int 433168404Spjdvalid_char(char c) 434168404Spjd{ 435168404Spjd return ((c >= 'a' && c <= 'z') || 436168404Spjd (c >= '0' && c <= '9') || 437168404Spjd c == '-' || c == '_' || c == '.' || c == ':'); 438168404Spjd} 439168404Spjd 440168404Spjd/* 441168404Spjd * Returns true if this is a valid user-defined property (one with a ':'). 442168404Spjd */ 443168404Spjdboolean_t 444168404Spjdzfs_prop_user(const char *name) 445168404Spjd{ 446168404Spjd int i; 447168404Spjd char c; 448168404Spjd boolean_t foundsep = B_FALSE; 449168404Spjd 450168404Spjd for (i = 0; i < strlen(name); i++) { 451168404Spjd c = name[i]; 452168404Spjd if (!valid_char(c)) 453168404Spjd return (B_FALSE); 454168404Spjd if (c == ':') 455168404Spjd foundsep = B_TRUE; 456168404Spjd } 457168404Spjd 458168404Spjd if (!foundsep) 459168404Spjd return (B_FALSE); 460168404Spjd 461168404Spjd return (B_TRUE); 462168404Spjd} 463168404Spjd 464168404Spjd/* 465209962Smm * Returns true if this is a valid userspace-type property (one with a '@'). 466209962Smm * Note that after the @, any character is valid (eg, another @, for SID 467209962Smm * user@domain). 468209962Smm */ 469209962Smmboolean_t 470209962Smmzfs_prop_userquota(const char *name) 471209962Smm{ 472209962Smm zfs_userquota_prop_t prop; 473209962Smm 474209962Smm for (prop = 0; prop < ZFS_NUM_USERQUOTA_PROPS; prop++) { 475209962Smm if (strncmp(name, zfs_userquota_prop_prefixes[prop], 476209962Smm strlen(zfs_userquota_prop_prefixes[prop])) == 0) { 477209962Smm return (B_TRUE); 478209962Smm } 479209962Smm } 480209962Smm 481209962Smm return (B_FALSE); 482209962Smm} 483209962Smm 484209962Smm/* 485228103Smm * Returns true if this is a valid written@ property. 486228103Smm * Note that after the @, any character is valid (eg, another @, for 487228103Smm * written@pool/fs@origin). 488228103Smm */ 489228103Smmboolean_t 490228103Smmzfs_prop_written(const char *name) 491228103Smm{ 492228103Smm static const char *prefix = "written@"; 493228103Smm return (strncmp(name, prefix, strlen(prefix)) == 0); 494228103Smm} 495228103Smm 496228103Smm/* 497185029Spjd * Tables of index types, plus functions to convert between the user view 498185029Spjd * (strings) and internal representation (uint64_t). 499168404Spjd */ 500185029Spjdint 501185029Spjdzfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index) 502168404Spjd{ 503185029Spjd return (zprop_string_to_index(prop, string, index, ZFS_TYPE_DATASET)); 504168404Spjd} 505168404Spjd 506185029Spjdint 507185029Spjdzfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string) 508168404Spjd{ 509185029Spjd return (zprop_index_to_string(prop, index, string, ZFS_TYPE_DATASET)); 510168404Spjd} 511168404Spjd 512219089Spjduint64_t 513219089Spjdzfs_prop_random_value(zfs_prop_t prop, uint64_t seed) 514219089Spjd{ 515219089Spjd return (zprop_random_value(prop, seed, ZFS_TYPE_DATASET)); 516219089Spjd} 517219089Spjd 518168404Spjd/* 519185029Spjd * Returns TRUE if the property applies to any of the given dataset types. 520168404Spjd */ 521185029Spjdboolean_t 522185029Spjdzfs_prop_valid_for_type(int prop, zfs_type_t types) 523168404Spjd{ 524185029Spjd return (zprop_valid_for_type(prop, types)); 525168404Spjd} 526168404Spjd 527185029Spjdzprop_type_t 528185029Spjdzfs_prop_get_type(zfs_prop_t prop) 529168404Spjd{ 530185029Spjd return (zfs_prop_table[prop].pd_proptype); 531168404Spjd} 532168404Spjd 533168404Spjd/* 534185029Spjd * Returns TRUE if the property is readonly. 535168404Spjd */ 536185029Spjdboolean_t 537185029Spjdzfs_prop_readonly(zfs_prop_t prop) 538168404Spjd{ 539185029Spjd return (zfs_prop_table[prop].pd_attr == PROP_READONLY || 540185029Spjd zfs_prop_table[prop].pd_attr == PROP_ONETIME); 541168404Spjd} 542168404Spjd 543168404Spjd/* 544185029Spjd * Returns TRUE if the property is only allowed to be set once. 545168404Spjd */ 546185029Spjdboolean_t 547185029Spjdzfs_prop_setonce(zfs_prop_t prop) 548168404Spjd{ 549185029Spjd return (zfs_prop_table[prop].pd_attr == PROP_ONETIME); 550168404Spjd} 551168404Spjd 552185029Spjdconst char * 553185029Spjdzfs_prop_default_string(zfs_prop_t prop) 554185029Spjd{ 555185029Spjd return (zfs_prop_table[prop].pd_strdefault); 556185029Spjd} 557168404Spjd 558185029Spjduint64_t 559185029Spjdzfs_prop_default_numeric(zfs_prop_t prop) 560168404Spjd{ 561185029Spjd return (zfs_prop_table[prop].pd_numdefault); 562168404Spjd} 563168404Spjd 564168404Spjd/* 565185029Spjd * Given a dataset property ID, returns the corresponding name. 566185029Spjd * Assuming the zfs dataset property ID is valid. 567168404Spjd */ 568185029Spjdconst char * 569185029Spjdzfs_prop_to_name(zfs_prop_t prop) 570168404Spjd{ 571185029Spjd return (zfs_prop_table[prop].pd_name); 572168404Spjd} 573168404Spjd 574185029Spjd/* 575185029Spjd * Returns TRUE if the property is inheritable. 576185029Spjd */ 577185029Spjdboolean_t 578185029Spjdzfs_prop_inheritable(zfs_prop_t prop) 579168404Spjd{ 580185029Spjd return (zfs_prop_table[prop].pd_attr == PROP_INHERIT || 581185029Spjd zfs_prop_table[prop].pd_attr == PROP_ONETIME); 582168404Spjd} 583168404Spjd 584168404Spjd#ifndef _KERNEL 585168404Spjd 586168404Spjd/* 587168404Spjd * Returns a string describing the set of acceptable values for the given 588168404Spjd * zfs property, or NULL if it cannot be set. 589168404Spjd */ 590168404Spjdconst char * 591168404Spjdzfs_prop_values(zfs_prop_t prop) 592168404Spjd{ 593168404Spjd return (zfs_prop_table[prop].pd_values); 594168404Spjd} 595168404Spjd 596168404Spjd/* 597168404Spjd * Returns TRUE if this property is a string type. Note that index types 598168404Spjd * (compression, checksum) are treated as strings in userland, even though they 599168404Spjd * are stored numerically on disk. 600168404Spjd */ 601168404Spjdint 602168404Spjdzfs_prop_is_string(zfs_prop_t prop) 603168404Spjd{ 604185029Spjd return (zfs_prop_table[prop].pd_proptype == PROP_TYPE_STRING || 605185029Spjd zfs_prop_table[prop].pd_proptype == PROP_TYPE_INDEX); 606168404Spjd} 607168404Spjd 608168404Spjd/* 609168404Spjd * Returns the column header for the given property. Used only in 610168404Spjd * 'zfs list -o', but centralized here with the other property information. 611168404Spjd */ 612168404Spjdconst char * 613168404Spjdzfs_prop_column_name(zfs_prop_t prop) 614168404Spjd{ 615168404Spjd return (zfs_prop_table[prop].pd_colname); 616168404Spjd} 617168404Spjd 618168404Spjd/* 619168404Spjd * Returns whether the given property should be displayed right-justified for 620168404Spjd * 'zfs list'. 621168404Spjd */ 622168404Spjdboolean_t 623168404Spjdzfs_prop_align_right(zfs_prop_t prop) 624168404Spjd{ 625168404Spjd return (zfs_prop_table[prop].pd_rightalign); 626168404Spjd} 627168404Spjd 628168404Spjd#endif 629