zfs_prop.c revision 224174
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 }, 112224174Smm { NULL } 113224174Smm }; 114224174Smm 115185029Spjd static zprop_index_t acl_inherit_table[] = { 116185029Spjd { "discard", ZFS_ACL_DISCARD }, 117185029Spjd { "noallow", ZFS_ACL_NOALLOW }, 118185029Spjd { "restricted", ZFS_ACL_RESTRICTED }, 119185029Spjd { "passthrough", ZFS_ACL_PASSTHROUGH }, 120185029Spjd { "secure", ZFS_ACL_RESTRICTED }, /* bkwrd compatability */ 121201143Sdelphij { "passthrough-x", ZFS_ACL_PASSTHROUGH_X }, 122185029Spjd { NULL } 123185029Spjd }; 124168404Spjd 125185029Spjd static zprop_index_t case_table[] = { 126185029Spjd { "sensitive", ZFS_CASE_SENSITIVE }, 127185029Spjd { "insensitive", ZFS_CASE_INSENSITIVE }, 128185029Spjd { "mixed", ZFS_CASE_MIXED }, 129185029Spjd { NULL } 130185029Spjd }; 131168404Spjd 132185029Spjd static zprop_index_t copies_table[] = { 133185029Spjd { "1", 1 }, 134185029Spjd { "2", 2 }, 135185029Spjd { "3", 3 }, 136185029Spjd { NULL } 137185029Spjd }; 138168404Spjd 139185029Spjd /* 140185029Spjd * Use the unique flags we have to send to u8_strcmp() and/or 141185029Spjd * u8_textprep() to represent the various normalization property 142185029Spjd * values. 143185029Spjd */ 144185029Spjd static zprop_index_t normalize_table[] = { 145185029Spjd { "none", 0 }, 146185029Spjd { "formD", U8_TEXTPREP_NFD }, 147185029Spjd { "formKC", U8_TEXTPREP_NFKC }, 148185029Spjd { "formC", U8_TEXTPREP_NFC }, 149185029Spjd { "formKD", U8_TEXTPREP_NFKD }, 150185029Spjd { NULL } 151185029Spjd }; 152168404Spjd 153185029Spjd static zprop_index_t version_table[] = { 154185029Spjd { "1", 1 }, 155185029Spjd { "2", 2 }, 156185029Spjd { "3", 3 }, 157209962Smm { "4", 4 }, 158219089Spjd { "5", 5 }, 159185029Spjd { "current", ZPL_VERSION }, 160185029Spjd { NULL } 161185029Spjd }; 162168404Spjd 163185029Spjd static zprop_index_t boolean_table[] = { 164185029Spjd { "off", 0 }, 165185029Spjd { "on", 1 }, 166185029Spjd { NULL } 167185029Spjd }; 168168404Spjd 169219089Spjd static zprop_index_t logbias_table[] = { 170219089Spjd { "latency", ZFS_LOGBIAS_LATENCY }, 171219089Spjd { "throughput", ZFS_LOGBIAS_THROUGHPUT }, 172219089Spjd { NULL } 173219089Spjd }; 174219089Spjd 175185029Spjd static zprop_index_t canmount_table[] = { 176185029Spjd { "off", ZFS_CANMOUNT_OFF }, 177185029Spjd { "on", ZFS_CANMOUNT_ON }, 178185029Spjd { "noauto", ZFS_CANMOUNT_NOAUTO }, 179185029Spjd { NULL } 180185029Spjd }; 181168404Spjd 182185029Spjd static zprop_index_t cache_table[] = { 183185029Spjd { "none", ZFS_CACHE_NONE }, 184185029Spjd { "metadata", ZFS_CACHE_METADATA }, 185185029Spjd { "all", ZFS_CACHE_ALL }, 186185029Spjd { NULL } 187185029Spjd }; 188168404Spjd 189219089Spjd static zprop_index_t sync_table[] = { 190219089Spjd { "standard", ZFS_SYNC_STANDARD }, 191219089Spjd { "always", ZFS_SYNC_ALWAYS }, 192219089Spjd { "disabled", ZFS_SYNC_DISABLED }, 193219089Spjd { NULL } 194219089Spjd }; 195219089Spjd 196185029Spjd /* inherit index properties */ 197219089Spjd zprop_register_index(ZFS_PROP_SYNC, "sync", ZFS_SYNC_STANDARD, 198185029Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 199219089Spjd "standard | always | disabled", "SYNC", 200219089Spjd sync_table); 201219089Spjd zprop_register_index(ZFS_PROP_CHECKSUM, "checksum", 202219089Spjd ZIO_CHECKSUM_DEFAULT, PROP_INHERIT, ZFS_TYPE_FILESYSTEM | 203219089Spjd ZFS_TYPE_VOLUME, 204185029Spjd "on | off | fletcher2 | fletcher4 | sha256", "CHECKSUM", 205185029Spjd checksum_table); 206219089Spjd zprop_register_index(ZFS_PROP_DEDUP, "dedup", ZIO_CHECKSUM_OFF, 207219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 208219089Spjd "on | off | verify | sha256[,verify]", "DEDUP", 209219089Spjd dedup_table); 210219089Spjd zprop_register_index(ZFS_PROP_COMPRESSION, "compression", 211185029Spjd ZIO_COMPRESS_DEFAULT, PROP_INHERIT, 212185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 213219089Spjd "on | off | lzjb | gzip | gzip-[1-9] | zle", "COMPRESS", 214219089Spjd compress_table); 215219089Spjd zprop_register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN, 216185029Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 217185029Spjd "hidden | visible", "SNAPDIR", snapdir_table); 218224174Smm zprop_register_index(ZFS_PROP_ACLMODE, "aclmode", ZFS_ACL_DISCARD, 219224174Smm PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 220224174Smm "discard | groupmask | passthrough", "ACLMODE", acl_mode_table); 221219089Spjd zprop_register_index(ZFS_PROP_ACLINHERIT, "aclinherit", 222219089Spjd ZFS_ACL_RESTRICTED, PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 223201143Sdelphij "discard | noallow | restricted | passthrough | passthrough-x", 224185029Spjd "ACLINHERIT", acl_inherit_table); 225219089Spjd zprop_register_index(ZFS_PROP_COPIES, "copies", 1, PROP_INHERIT, 226219089Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 227185029Spjd "1 | 2 | 3", "COPIES", copies_table); 228219089Spjd zprop_register_index(ZFS_PROP_PRIMARYCACHE, "primarycache", 229185029Spjd ZFS_CACHE_ALL, PROP_INHERIT, 230185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, 231185029Spjd "all | none | metadata", "PRIMARYCACHE", cache_table); 232219089Spjd zprop_register_index(ZFS_PROP_SECONDARYCACHE, "secondarycache", 233185029Spjd ZFS_CACHE_ALL, PROP_INHERIT, 234185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, 235185029Spjd "all | none | metadata", "SECONDARYCACHE", cache_table); 236219089Spjd zprop_register_index(ZFS_PROP_LOGBIAS, "logbias", ZFS_LOGBIAS_LATENCY, 237219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 238219089Spjd "latency | throughput", "LOGBIAS", logbias_table); 239168404Spjd 240185029Spjd /* inherit index (boolean) properties */ 241219089Spjd zprop_register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT, 242185029Spjd ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table); 243219089Spjd zprop_register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT, 244185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES", 245185029Spjd boolean_table); 246219089Spjd zprop_register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT, 247185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC", 248185029Spjd boolean_table); 249219089Spjd zprop_register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT, 250185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID", 251185029Spjd boolean_table); 252219089Spjd zprop_register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT, 253185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY", 254185029Spjd boolean_table); 255219089Spjd zprop_register_index(ZFS_PROP_ZONED, "jailed", 0, PROP_INHERIT, 256185029Spjd ZFS_TYPE_FILESYSTEM, "on | off", "JAILED", boolean_table); 257219089Spjd zprop_register_index(ZFS_PROP_XATTR, "xattr", 1, PROP_INHERIT, 258185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "XATTR", 259185029Spjd boolean_table); 260219089Spjd zprop_register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT, 261185029Spjd ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN", 262185029Spjd boolean_table); 263219089Spjd zprop_register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT, 264185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND", 265185029Spjd boolean_table); 266168404Spjd 267185029Spjd /* default index properties */ 268219089Spjd zprop_register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT, 269185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 270209962Smm "1 | 2 | 3 | 4 | current", "VERSION", version_table); 271219089Spjd zprop_register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON, 272185029Spjd PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto", 273185029Spjd "CANMOUNT", canmount_table); 274168404Spjd 275185029Spjd /* readonly index (boolean) properties */ 276219089Spjd zprop_register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY, 277185029Spjd ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table); 278219089Spjd zprop_register_index(ZFS_PROP_DEFER_DESTROY, "defer_destroy", 0, 279219089Spjd PROP_READONLY, ZFS_TYPE_SNAPSHOT, "yes | no", "DEFER_DESTROY", 280219089Spjd boolean_table); 281185029Spjd 282185029Spjd /* set once index properties */ 283219089Spjd zprop_register_index(ZFS_PROP_NORMALIZE, "normalization", 0, 284185029Spjd PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 285185029Spjd "none | formC | formD | formKC | formKD", "NORMALIZATION", 286185029Spjd normalize_table); 287219089Spjd zprop_register_index(ZFS_PROP_CASE, "casesensitivity", 288219089Spjd ZFS_CASE_SENSITIVE, PROP_ONETIME, ZFS_TYPE_FILESYSTEM | 289219089Spjd ZFS_TYPE_SNAPSHOT, 290185029Spjd "sensitive | insensitive | mixed", "CASE", case_table); 291185029Spjd 292185029Spjd /* set once index (boolean) properties */ 293219089Spjd zprop_register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME, 294185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 295185029Spjd "on | off", "UTF8ONLY", boolean_table); 296185029Spjd 297185029Spjd /* string properties */ 298219089Spjd zprop_register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY, 299185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN"); 300219089Spjd zprop_register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/", 301219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "<path> | legacy | none", 302219089Spjd "MOUNTPOINT"); 303219089Spjd zprop_register_string(ZFS_PROP_SHARENFS, "sharenfs", "off", 304219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "on | off | share(1M) options", 305219089Spjd "SHARENFS"); 306219089Spjd zprop_register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY, 307185029Spjd ZFS_TYPE_DATASET, "filesystem | volume | snapshot", "TYPE"); 308219089Spjd zprop_register_string(ZFS_PROP_SHARESMB, "sharesmb", "off", 309219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 310219089Spjd "on | off | sharemgr(1M) options", "SHARESMB"); 311219089Spjd zprop_register_string(ZFS_PROP_MLSLABEL, "mlslabel", 312219089Spjd ZFS_MLSLABEL_DEFAULT, PROP_INHERIT, ZFS_TYPE_DATASET, 313219089Spjd "<sensitivity label>", "MLSLABEL"); 314185029Spjd 315185029Spjd /* readonly number properties */ 316219089Spjd zprop_register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY, 317185029Spjd ZFS_TYPE_DATASET, "<size>", "USED"); 318219089Spjd zprop_register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY, 319185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL"); 320219089Spjd zprop_register_number(ZFS_PROP_REFERENCED, "referenced", 0, 321219089Spjd PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "REFER"); 322219089Spjd zprop_register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0, 323185029Spjd PROP_READONLY, ZFS_TYPE_DATASET, 324185029Spjd "<1.00x or higher if compressed>", "RATIO"); 325223623Smm zprop_register_number(ZFS_PROP_REFRATIO, "refcompressratio", 0, 326223623Smm PROP_READONLY, ZFS_TYPE_DATASET, 327223623Smm "<1.00x or higher if compressed>", "REFRATIO"); 328219089Spjd zprop_register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize", 329219089Spjd ZVOL_DEFAULT_BLOCKSIZE, PROP_ONETIME, 330185029Spjd ZFS_TYPE_VOLUME, "512 to 128k, power of 2", "VOLBLOCK"); 331219089Spjd zprop_register_number(ZFS_PROP_USEDSNAP, "usedbysnapshots", 0, 332219089Spjd PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 333219089Spjd "USEDSNAP"); 334219089Spjd zprop_register_number(ZFS_PROP_USEDDS, "usedbydataset", 0, 335219089Spjd PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 336219089Spjd "USEDDS"); 337219089Spjd zprop_register_number(ZFS_PROP_USEDCHILD, "usedbychildren", 0, 338219089Spjd PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 339219089Spjd "USEDCHILD"); 340219089Spjd zprop_register_number(ZFS_PROP_USEDREFRESERV, "usedbyrefreservation", 0, 341185029Spjd PROP_READONLY, 342185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDREFRESERV"); 343219089Spjd zprop_register_number(ZFS_PROP_USERREFS, "userrefs", 0, PROP_READONLY, 344219089Spjd ZFS_TYPE_SNAPSHOT, "<count>", "USERREFS"); 345185029Spjd 346185029Spjd /* default number properties */ 347219089Spjd zprop_register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT, 348185029Spjd ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA"); 349219089Spjd zprop_register_number(ZFS_PROP_RESERVATION, "reservation", 0, 350219089Spjd PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 351219089Spjd "<size> | none", "RESERV"); 352219089Spjd zprop_register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT, 353185029Spjd ZFS_TYPE_VOLUME, "<size>", "VOLSIZE"); 354219089Spjd zprop_register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT, 355185029Spjd ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA"); 356219089Spjd zprop_register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0, 357185029Spjd PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 358185029Spjd "<size> | none", "REFRESERV"); 359185029Spjd 360185029Spjd /* inherit number properties */ 361219089Spjd zprop_register_number(ZFS_PROP_RECORDSIZE, "recordsize", 362219089Spjd SPA_MAXBLOCKSIZE, PROP_INHERIT, 363185029Spjd ZFS_TYPE_FILESYSTEM, "512 to 128k, power of 2", "RECSIZE"); 364185029Spjd 365185029Spjd /* hidden properties */ 366219089Spjd zprop_register_hidden(ZFS_PROP_CREATETXG, "createtxg", PROP_TYPE_NUMBER, 367192240Skmacy PROP_READONLY, ZFS_TYPE_DATASET, "CREATETXG"); 368219089Spjd zprop_register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER, 369219089Spjd PROP_READONLY, ZFS_TYPE_SNAPSHOT, "NUMCLONES"); 370219089Spjd zprop_register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING, 371185029Spjd PROP_READONLY, ZFS_TYPE_DATASET, "NAME"); 372219089Spjd zprop_register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions", 373219089Spjd PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS"); 374219089Spjd zprop_register_hidden(ZFS_PROP_STMF_SHAREINFO, "stmf_sbd_lu", 375219089Spjd PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, 376219089Spjd "STMF_SBD_LU"); 377219089Spjd zprop_register_hidden(ZFS_PROP_GUID, "guid", PROP_TYPE_NUMBER, 378219089Spjd PROP_READONLY, ZFS_TYPE_DATASET, "GUID"); 379219089Spjd zprop_register_hidden(ZFS_PROP_USERACCOUNTING, "useraccounting", 380219089Spjd PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, 381219089Spjd "USERACCOUNTING"); 382219089Spjd zprop_register_hidden(ZFS_PROP_UNIQUE, "unique", PROP_TYPE_NUMBER, 383219089Spjd PROP_READONLY, ZFS_TYPE_DATASET, "UNIQUE"); 384219089Spjd zprop_register_hidden(ZFS_PROP_OBJSETID, "objsetid", PROP_TYPE_NUMBER, 385219089Spjd PROP_READONLY, ZFS_TYPE_DATASET, "OBJSETID"); 386185029Spjd 387185029Spjd /* oddball properties */ 388219089Spjd zprop_register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0, 389219089Spjd NULL, PROP_READONLY, ZFS_TYPE_DATASET, 390185029Spjd "<date>", "CREATION", B_FALSE, B_TRUE, NULL); 391168404Spjd} 392168404Spjd 393185029Spjdboolean_t 394185029Spjdzfs_prop_delegatable(zfs_prop_t prop) 395168404Spjd{ 396185029Spjd zprop_desc_t *pd = &zfs_prop_table[prop]; 397219089Spjd 398219089Spjd /* The mlslabel property is never delegatable. */ 399219089Spjd if (prop == ZFS_PROP_MLSLABEL) 400219089Spjd return (B_FALSE); 401219089Spjd 402185029Spjd return (pd->pd_attr != PROP_READONLY); 403168404Spjd} 404168404Spjd 405168404Spjd/* 406168404Spjd * Given a zfs dataset property name, returns the corresponding property ID. 407168404Spjd */ 408168404Spjdzfs_prop_t 409168404Spjdzfs_name_to_prop(const char *propname) 410168404Spjd{ 411185029Spjd return (zprop_name_to_prop(propname, ZFS_TYPE_DATASET)); 412168404Spjd} 413168404Spjd 414168404Spjd/* 415168404Spjd * For user property names, we allow all lowercase alphanumeric characters, plus 416168404Spjd * a few useful punctuation characters. 417168404Spjd */ 418168404Spjdstatic int 419168404Spjdvalid_char(char c) 420168404Spjd{ 421168404Spjd return ((c >= 'a' && c <= 'z') || 422168404Spjd (c >= '0' && c <= '9') || 423168404Spjd c == '-' || c == '_' || c == '.' || c == ':'); 424168404Spjd} 425168404Spjd 426168404Spjd/* 427168404Spjd * Returns true if this is a valid user-defined property (one with a ':'). 428168404Spjd */ 429168404Spjdboolean_t 430168404Spjdzfs_prop_user(const char *name) 431168404Spjd{ 432168404Spjd int i; 433168404Spjd char c; 434168404Spjd boolean_t foundsep = B_FALSE; 435168404Spjd 436168404Spjd for (i = 0; i < strlen(name); i++) { 437168404Spjd c = name[i]; 438168404Spjd if (!valid_char(c)) 439168404Spjd return (B_FALSE); 440168404Spjd if (c == ':') 441168404Spjd foundsep = B_TRUE; 442168404Spjd } 443168404Spjd 444168404Spjd if (!foundsep) 445168404Spjd return (B_FALSE); 446168404Spjd 447168404Spjd return (B_TRUE); 448168404Spjd} 449168404Spjd 450168404Spjd/* 451209962Smm * Returns true if this is a valid userspace-type property (one with a '@'). 452209962Smm * Note that after the @, any character is valid (eg, another @, for SID 453209962Smm * user@domain). 454209962Smm */ 455209962Smmboolean_t 456209962Smmzfs_prop_userquota(const char *name) 457209962Smm{ 458209962Smm zfs_userquota_prop_t prop; 459209962Smm 460209962Smm for (prop = 0; prop < ZFS_NUM_USERQUOTA_PROPS; prop++) { 461209962Smm if (strncmp(name, zfs_userquota_prop_prefixes[prop], 462209962Smm strlen(zfs_userquota_prop_prefixes[prop])) == 0) { 463209962Smm return (B_TRUE); 464209962Smm } 465209962Smm } 466209962Smm 467209962Smm return (B_FALSE); 468209962Smm} 469209962Smm 470209962Smm/* 471185029Spjd * Tables of index types, plus functions to convert between the user view 472185029Spjd * (strings) and internal representation (uint64_t). 473168404Spjd */ 474185029Spjdint 475185029Spjdzfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index) 476168404Spjd{ 477185029Spjd return (zprop_string_to_index(prop, string, index, ZFS_TYPE_DATASET)); 478168404Spjd} 479168404Spjd 480185029Spjdint 481185029Spjdzfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string) 482168404Spjd{ 483185029Spjd return (zprop_index_to_string(prop, index, string, ZFS_TYPE_DATASET)); 484168404Spjd} 485168404Spjd 486219089Spjduint64_t 487219089Spjdzfs_prop_random_value(zfs_prop_t prop, uint64_t seed) 488219089Spjd{ 489219089Spjd return (zprop_random_value(prop, seed, ZFS_TYPE_DATASET)); 490219089Spjd} 491219089Spjd 492168404Spjd/* 493185029Spjd * Returns TRUE if the property applies to any of the given dataset types. 494168404Spjd */ 495185029Spjdboolean_t 496185029Spjdzfs_prop_valid_for_type(int prop, zfs_type_t types) 497168404Spjd{ 498185029Spjd return (zprop_valid_for_type(prop, types)); 499168404Spjd} 500168404Spjd 501185029Spjdzprop_type_t 502185029Spjdzfs_prop_get_type(zfs_prop_t prop) 503168404Spjd{ 504185029Spjd return (zfs_prop_table[prop].pd_proptype); 505168404Spjd} 506168404Spjd 507168404Spjd/* 508185029Spjd * Returns TRUE if the property is readonly. 509168404Spjd */ 510185029Spjdboolean_t 511185029Spjdzfs_prop_readonly(zfs_prop_t prop) 512168404Spjd{ 513185029Spjd return (zfs_prop_table[prop].pd_attr == PROP_READONLY || 514185029Spjd zfs_prop_table[prop].pd_attr == PROP_ONETIME); 515168404Spjd} 516168404Spjd 517168404Spjd/* 518185029Spjd * Returns TRUE if the property is only allowed to be set once. 519168404Spjd */ 520185029Spjdboolean_t 521185029Spjdzfs_prop_setonce(zfs_prop_t prop) 522168404Spjd{ 523185029Spjd return (zfs_prop_table[prop].pd_attr == PROP_ONETIME); 524168404Spjd} 525168404Spjd 526185029Spjdconst char * 527185029Spjdzfs_prop_default_string(zfs_prop_t prop) 528185029Spjd{ 529185029Spjd return (zfs_prop_table[prop].pd_strdefault); 530185029Spjd} 531168404Spjd 532185029Spjduint64_t 533185029Spjdzfs_prop_default_numeric(zfs_prop_t prop) 534168404Spjd{ 535185029Spjd return (zfs_prop_table[prop].pd_numdefault); 536168404Spjd} 537168404Spjd 538168404Spjd/* 539185029Spjd * Given a dataset property ID, returns the corresponding name. 540185029Spjd * Assuming the zfs dataset property ID is valid. 541168404Spjd */ 542185029Spjdconst char * 543185029Spjdzfs_prop_to_name(zfs_prop_t prop) 544168404Spjd{ 545185029Spjd return (zfs_prop_table[prop].pd_name); 546168404Spjd} 547168404Spjd 548185029Spjd/* 549185029Spjd * Returns TRUE if the property is inheritable. 550185029Spjd */ 551185029Spjdboolean_t 552185029Spjdzfs_prop_inheritable(zfs_prop_t prop) 553168404Spjd{ 554185029Spjd return (zfs_prop_table[prop].pd_attr == PROP_INHERIT || 555185029Spjd zfs_prop_table[prop].pd_attr == PROP_ONETIME); 556168404Spjd} 557168404Spjd 558168404Spjd#ifndef _KERNEL 559168404Spjd 560168404Spjd/* 561168404Spjd * Returns a string describing the set of acceptable values for the given 562168404Spjd * zfs property, or NULL if it cannot be set. 563168404Spjd */ 564168404Spjdconst char * 565168404Spjdzfs_prop_values(zfs_prop_t prop) 566168404Spjd{ 567168404Spjd return (zfs_prop_table[prop].pd_values); 568168404Spjd} 569168404Spjd 570168404Spjd/* 571168404Spjd * Returns TRUE if this property is a string type. Note that index types 572168404Spjd * (compression, checksum) are treated as strings in userland, even though they 573168404Spjd * are stored numerically on disk. 574168404Spjd */ 575168404Spjdint 576168404Spjdzfs_prop_is_string(zfs_prop_t prop) 577168404Spjd{ 578185029Spjd return (zfs_prop_table[prop].pd_proptype == PROP_TYPE_STRING || 579185029Spjd zfs_prop_table[prop].pd_proptype == PROP_TYPE_INDEX); 580168404Spjd} 581168404Spjd 582168404Spjd/* 583168404Spjd * Returns the column header for the given property. Used only in 584168404Spjd * 'zfs list -o', but centralized here with the other property information. 585168404Spjd */ 586168404Spjdconst char * 587168404Spjdzfs_prop_column_name(zfs_prop_t prop) 588168404Spjd{ 589168404Spjd return (zfs_prop_table[prop].pd_colname); 590168404Spjd} 591168404Spjd 592168404Spjd/* 593168404Spjd * Returns whether the given property should be displayed right-justified for 594168404Spjd * 'zfs list'. 595168404Spjd */ 596168404Spjdboolean_t 597168404Spjdzfs_prop_align_right(zfs_prop_t prop) 598168404Spjd{ 599168404Spjd return (zfs_prop_table[prop].pd_rightalign); 600168404Spjd} 601168404Spjd 602168404Spjd#endif 603