zfs_prop.c revision 223623
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 108185029Spjd static zprop_index_t acl_inherit_table[] = { 109185029Spjd { "discard", ZFS_ACL_DISCARD }, 110185029Spjd { "noallow", ZFS_ACL_NOALLOW }, 111185029Spjd { "restricted", ZFS_ACL_RESTRICTED }, 112185029Spjd { "passthrough", ZFS_ACL_PASSTHROUGH }, 113185029Spjd { "secure", ZFS_ACL_RESTRICTED }, /* bkwrd compatability */ 114201143Sdelphij { "passthrough-x", ZFS_ACL_PASSTHROUGH_X }, 115185029Spjd { NULL } 116185029Spjd }; 117168404Spjd 118185029Spjd static zprop_index_t case_table[] = { 119185029Spjd { "sensitive", ZFS_CASE_SENSITIVE }, 120185029Spjd { "insensitive", ZFS_CASE_INSENSITIVE }, 121185029Spjd { "mixed", ZFS_CASE_MIXED }, 122185029Spjd { NULL } 123185029Spjd }; 124168404Spjd 125185029Spjd static zprop_index_t copies_table[] = { 126185029Spjd { "1", 1 }, 127185029Spjd { "2", 2 }, 128185029Spjd { "3", 3 }, 129185029Spjd { NULL } 130185029Spjd }; 131168404Spjd 132185029Spjd /* 133185029Spjd * Use the unique flags we have to send to u8_strcmp() and/or 134185029Spjd * u8_textprep() to represent the various normalization property 135185029Spjd * values. 136185029Spjd */ 137185029Spjd static zprop_index_t normalize_table[] = { 138185029Spjd { "none", 0 }, 139185029Spjd { "formD", U8_TEXTPREP_NFD }, 140185029Spjd { "formKC", U8_TEXTPREP_NFKC }, 141185029Spjd { "formC", U8_TEXTPREP_NFC }, 142185029Spjd { "formKD", U8_TEXTPREP_NFKD }, 143185029Spjd { NULL } 144185029Spjd }; 145168404Spjd 146185029Spjd static zprop_index_t version_table[] = { 147185029Spjd { "1", 1 }, 148185029Spjd { "2", 2 }, 149185029Spjd { "3", 3 }, 150209962Smm { "4", 4 }, 151219089Spjd { "5", 5 }, 152185029Spjd { "current", ZPL_VERSION }, 153185029Spjd { NULL } 154185029Spjd }; 155168404Spjd 156185029Spjd static zprop_index_t boolean_table[] = { 157185029Spjd { "off", 0 }, 158185029Spjd { "on", 1 }, 159185029Spjd { NULL } 160185029Spjd }; 161168404Spjd 162219089Spjd static zprop_index_t logbias_table[] = { 163219089Spjd { "latency", ZFS_LOGBIAS_LATENCY }, 164219089Spjd { "throughput", ZFS_LOGBIAS_THROUGHPUT }, 165219089Spjd { NULL } 166219089Spjd }; 167219089Spjd 168185029Spjd static zprop_index_t canmount_table[] = { 169185029Spjd { "off", ZFS_CANMOUNT_OFF }, 170185029Spjd { "on", ZFS_CANMOUNT_ON }, 171185029Spjd { "noauto", ZFS_CANMOUNT_NOAUTO }, 172185029Spjd { NULL } 173185029Spjd }; 174168404Spjd 175185029Spjd static zprop_index_t cache_table[] = { 176185029Spjd { "none", ZFS_CACHE_NONE }, 177185029Spjd { "metadata", ZFS_CACHE_METADATA }, 178185029Spjd { "all", ZFS_CACHE_ALL }, 179185029Spjd { NULL } 180185029Spjd }; 181168404Spjd 182219089Spjd static zprop_index_t sync_table[] = { 183219089Spjd { "standard", ZFS_SYNC_STANDARD }, 184219089Spjd { "always", ZFS_SYNC_ALWAYS }, 185219089Spjd { "disabled", ZFS_SYNC_DISABLED }, 186219089Spjd { NULL } 187219089Spjd }; 188219089Spjd 189185029Spjd /* inherit index properties */ 190219089Spjd zprop_register_index(ZFS_PROP_SYNC, "sync", ZFS_SYNC_STANDARD, 191185029Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 192219089Spjd "standard | always | disabled", "SYNC", 193219089Spjd sync_table); 194219089Spjd zprop_register_index(ZFS_PROP_CHECKSUM, "checksum", 195219089Spjd ZIO_CHECKSUM_DEFAULT, PROP_INHERIT, ZFS_TYPE_FILESYSTEM | 196219089Spjd ZFS_TYPE_VOLUME, 197185029Spjd "on | off | fletcher2 | fletcher4 | sha256", "CHECKSUM", 198185029Spjd checksum_table); 199219089Spjd zprop_register_index(ZFS_PROP_DEDUP, "dedup", ZIO_CHECKSUM_OFF, 200219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 201219089Spjd "on | off | verify | sha256[,verify]", "DEDUP", 202219089Spjd dedup_table); 203219089Spjd zprop_register_index(ZFS_PROP_COMPRESSION, "compression", 204185029Spjd ZIO_COMPRESS_DEFAULT, PROP_INHERIT, 205185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 206219089Spjd "on | off | lzjb | gzip | gzip-[1-9] | zle", "COMPRESS", 207219089Spjd compress_table); 208219089Spjd zprop_register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN, 209185029Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 210185029Spjd "hidden | visible", "SNAPDIR", snapdir_table); 211219089Spjd zprop_register_index(ZFS_PROP_ACLINHERIT, "aclinherit", 212219089Spjd ZFS_ACL_RESTRICTED, PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 213201143Sdelphij "discard | noallow | restricted | passthrough | passthrough-x", 214185029Spjd "ACLINHERIT", acl_inherit_table); 215219089Spjd zprop_register_index(ZFS_PROP_COPIES, "copies", 1, PROP_INHERIT, 216219089Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 217185029Spjd "1 | 2 | 3", "COPIES", copies_table); 218219089Spjd zprop_register_index(ZFS_PROP_PRIMARYCACHE, "primarycache", 219185029Spjd ZFS_CACHE_ALL, PROP_INHERIT, 220185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, 221185029Spjd "all | none | metadata", "PRIMARYCACHE", cache_table); 222219089Spjd zprop_register_index(ZFS_PROP_SECONDARYCACHE, "secondarycache", 223185029Spjd ZFS_CACHE_ALL, PROP_INHERIT, 224185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, 225185029Spjd "all | none | metadata", "SECONDARYCACHE", cache_table); 226219089Spjd zprop_register_index(ZFS_PROP_LOGBIAS, "logbias", ZFS_LOGBIAS_LATENCY, 227219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 228219089Spjd "latency | throughput", "LOGBIAS", logbias_table); 229168404Spjd 230185029Spjd /* inherit index (boolean) properties */ 231219089Spjd zprop_register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT, 232185029Spjd ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table); 233219089Spjd zprop_register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT, 234185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES", 235185029Spjd boolean_table); 236219089Spjd zprop_register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT, 237185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC", 238185029Spjd boolean_table); 239219089Spjd zprop_register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT, 240185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID", 241185029Spjd boolean_table); 242219089Spjd zprop_register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT, 243185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY", 244185029Spjd boolean_table); 245219089Spjd zprop_register_index(ZFS_PROP_ZONED, "jailed", 0, PROP_INHERIT, 246185029Spjd ZFS_TYPE_FILESYSTEM, "on | off", "JAILED", boolean_table); 247219089Spjd zprop_register_index(ZFS_PROP_XATTR, "xattr", 1, PROP_INHERIT, 248185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "XATTR", 249185029Spjd boolean_table); 250219089Spjd zprop_register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT, 251185029Spjd ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN", 252185029Spjd boolean_table); 253219089Spjd zprop_register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT, 254185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND", 255185029Spjd boolean_table); 256168404Spjd 257185029Spjd /* default index properties */ 258219089Spjd zprop_register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT, 259185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 260209962Smm "1 | 2 | 3 | 4 | current", "VERSION", version_table); 261219089Spjd zprop_register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON, 262185029Spjd PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto", 263185029Spjd "CANMOUNT", canmount_table); 264168404Spjd 265185029Spjd /* readonly index (boolean) properties */ 266219089Spjd zprop_register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY, 267185029Spjd ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table); 268219089Spjd zprop_register_index(ZFS_PROP_DEFER_DESTROY, "defer_destroy", 0, 269219089Spjd PROP_READONLY, ZFS_TYPE_SNAPSHOT, "yes | no", "DEFER_DESTROY", 270219089Spjd boolean_table); 271185029Spjd 272185029Spjd /* set once index properties */ 273219089Spjd zprop_register_index(ZFS_PROP_NORMALIZE, "normalization", 0, 274185029Spjd PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 275185029Spjd "none | formC | formD | formKC | formKD", "NORMALIZATION", 276185029Spjd normalize_table); 277219089Spjd zprop_register_index(ZFS_PROP_CASE, "casesensitivity", 278219089Spjd ZFS_CASE_SENSITIVE, PROP_ONETIME, ZFS_TYPE_FILESYSTEM | 279219089Spjd ZFS_TYPE_SNAPSHOT, 280185029Spjd "sensitive | insensitive | mixed", "CASE", case_table); 281185029Spjd 282185029Spjd /* set once index (boolean) properties */ 283219089Spjd zprop_register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME, 284185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 285185029Spjd "on | off", "UTF8ONLY", boolean_table); 286185029Spjd 287185029Spjd /* string properties */ 288219089Spjd zprop_register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY, 289185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN"); 290219089Spjd zprop_register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/", 291219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "<path> | legacy | none", 292219089Spjd "MOUNTPOINT"); 293219089Spjd zprop_register_string(ZFS_PROP_SHARENFS, "sharenfs", "off", 294219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "on | off | share(1M) options", 295219089Spjd "SHARENFS"); 296219089Spjd zprop_register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY, 297185029Spjd ZFS_TYPE_DATASET, "filesystem | volume | snapshot", "TYPE"); 298219089Spjd zprop_register_string(ZFS_PROP_SHARESMB, "sharesmb", "off", 299219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 300219089Spjd "on | off | sharemgr(1M) options", "SHARESMB"); 301219089Spjd zprop_register_string(ZFS_PROP_MLSLABEL, "mlslabel", 302219089Spjd ZFS_MLSLABEL_DEFAULT, PROP_INHERIT, ZFS_TYPE_DATASET, 303219089Spjd "<sensitivity label>", "MLSLABEL"); 304185029Spjd 305185029Spjd /* readonly number properties */ 306219089Spjd zprop_register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY, 307185029Spjd ZFS_TYPE_DATASET, "<size>", "USED"); 308219089Spjd zprop_register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY, 309185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL"); 310219089Spjd zprop_register_number(ZFS_PROP_REFERENCED, "referenced", 0, 311219089Spjd PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "REFER"); 312219089Spjd zprop_register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0, 313185029Spjd PROP_READONLY, ZFS_TYPE_DATASET, 314185029Spjd "<1.00x or higher if compressed>", "RATIO"); 315223623Smm zprop_register_number(ZFS_PROP_REFRATIO, "refcompressratio", 0, 316223623Smm PROP_READONLY, ZFS_TYPE_DATASET, 317223623Smm "<1.00x or higher if compressed>", "REFRATIO"); 318219089Spjd zprop_register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize", 319219089Spjd ZVOL_DEFAULT_BLOCKSIZE, PROP_ONETIME, 320185029Spjd ZFS_TYPE_VOLUME, "512 to 128k, power of 2", "VOLBLOCK"); 321219089Spjd zprop_register_number(ZFS_PROP_USEDSNAP, "usedbysnapshots", 0, 322219089Spjd PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 323219089Spjd "USEDSNAP"); 324219089Spjd zprop_register_number(ZFS_PROP_USEDDS, "usedbydataset", 0, 325219089Spjd PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 326219089Spjd "USEDDS"); 327219089Spjd zprop_register_number(ZFS_PROP_USEDCHILD, "usedbychildren", 0, 328219089Spjd PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 329219089Spjd "USEDCHILD"); 330219089Spjd zprop_register_number(ZFS_PROP_USEDREFRESERV, "usedbyrefreservation", 0, 331185029Spjd PROP_READONLY, 332185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDREFRESERV"); 333219089Spjd zprop_register_number(ZFS_PROP_USERREFS, "userrefs", 0, PROP_READONLY, 334219089Spjd ZFS_TYPE_SNAPSHOT, "<count>", "USERREFS"); 335185029Spjd 336185029Spjd /* default number properties */ 337219089Spjd zprop_register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT, 338185029Spjd ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA"); 339219089Spjd zprop_register_number(ZFS_PROP_RESERVATION, "reservation", 0, 340219089Spjd PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 341219089Spjd "<size> | none", "RESERV"); 342219089Spjd zprop_register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT, 343185029Spjd ZFS_TYPE_VOLUME, "<size>", "VOLSIZE"); 344219089Spjd zprop_register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT, 345185029Spjd ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA"); 346219089Spjd zprop_register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0, 347185029Spjd PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 348185029Spjd "<size> | none", "REFRESERV"); 349185029Spjd 350185029Spjd /* inherit number properties */ 351219089Spjd zprop_register_number(ZFS_PROP_RECORDSIZE, "recordsize", 352219089Spjd SPA_MAXBLOCKSIZE, PROP_INHERIT, 353185029Spjd ZFS_TYPE_FILESYSTEM, "512 to 128k, power of 2", "RECSIZE"); 354185029Spjd 355185029Spjd /* hidden properties */ 356219089Spjd zprop_register_hidden(ZFS_PROP_CREATETXG, "createtxg", PROP_TYPE_NUMBER, 357192240Skmacy PROP_READONLY, ZFS_TYPE_DATASET, "CREATETXG"); 358219089Spjd zprop_register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER, 359219089Spjd PROP_READONLY, ZFS_TYPE_SNAPSHOT, "NUMCLONES"); 360219089Spjd zprop_register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING, 361185029Spjd PROP_READONLY, ZFS_TYPE_DATASET, "NAME"); 362219089Spjd zprop_register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions", 363219089Spjd PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS"); 364219089Spjd zprop_register_hidden(ZFS_PROP_STMF_SHAREINFO, "stmf_sbd_lu", 365219089Spjd PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, 366219089Spjd "STMF_SBD_LU"); 367219089Spjd zprop_register_hidden(ZFS_PROP_GUID, "guid", PROP_TYPE_NUMBER, 368219089Spjd PROP_READONLY, ZFS_TYPE_DATASET, "GUID"); 369219089Spjd zprop_register_hidden(ZFS_PROP_USERACCOUNTING, "useraccounting", 370219089Spjd PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, 371219089Spjd "USERACCOUNTING"); 372219089Spjd zprop_register_hidden(ZFS_PROP_UNIQUE, "unique", PROP_TYPE_NUMBER, 373219089Spjd PROP_READONLY, ZFS_TYPE_DATASET, "UNIQUE"); 374219089Spjd zprop_register_hidden(ZFS_PROP_OBJSETID, "objsetid", PROP_TYPE_NUMBER, 375219089Spjd PROP_READONLY, ZFS_TYPE_DATASET, "OBJSETID"); 376185029Spjd 377219089Spjd /* 378219089Spjd * Property to be removed once libbe is integrated 379219089Spjd */ 380219089Spjd zprop_register_hidden(ZFS_PROP_PRIVATE, "priv_prop", 381219089Spjd PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_FILESYSTEM, 382219089Spjd "PRIV_PROP"); 383219089Spjd 384185029Spjd /* oddball properties */ 385219089Spjd zprop_register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0, 386219089Spjd NULL, PROP_READONLY, ZFS_TYPE_DATASET, 387185029Spjd "<date>", "CREATION", B_FALSE, B_TRUE, NULL); 388168404Spjd} 389168404Spjd 390185029Spjdboolean_t 391185029Spjdzfs_prop_delegatable(zfs_prop_t prop) 392168404Spjd{ 393185029Spjd zprop_desc_t *pd = &zfs_prop_table[prop]; 394219089Spjd 395219089Spjd /* The mlslabel property is never delegatable. */ 396219089Spjd if (prop == ZFS_PROP_MLSLABEL) 397219089Spjd return (B_FALSE); 398219089Spjd 399185029Spjd return (pd->pd_attr != PROP_READONLY); 400168404Spjd} 401168404Spjd 402168404Spjd/* 403168404Spjd * Given a zfs dataset property name, returns the corresponding property ID. 404168404Spjd */ 405168404Spjdzfs_prop_t 406168404Spjdzfs_name_to_prop(const char *propname) 407168404Spjd{ 408185029Spjd return (zprop_name_to_prop(propname, ZFS_TYPE_DATASET)); 409168404Spjd} 410168404Spjd 411168404Spjd/* 412168404Spjd * For user property names, we allow all lowercase alphanumeric characters, plus 413168404Spjd * a few useful punctuation characters. 414168404Spjd */ 415168404Spjdstatic int 416168404Spjdvalid_char(char c) 417168404Spjd{ 418168404Spjd return ((c >= 'a' && c <= 'z') || 419168404Spjd (c >= '0' && c <= '9') || 420168404Spjd c == '-' || c == '_' || c == '.' || c == ':'); 421168404Spjd} 422168404Spjd 423168404Spjd/* 424168404Spjd * Returns true if this is a valid user-defined property (one with a ':'). 425168404Spjd */ 426168404Spjdboolean_t 427168404Spjdzfs_prop_user(const char *name) 428168404Spjd{ 429168404Spjd int i; 430168404Spjd char c; 431168404Spjd boolean_t foundsep = B_FALSE; 432168404Spjd 433168404Spjd for (i = 0; i < strlen(name); i++) { 434168404Spjd c = name[i]; 435168404Spjd if (!valid_char(c)) 436168404Spjd return (B_FALSE); 437168404Spjd if (c == ':') 438168404Spjd foundsep = B_TRUE; 439168404Spjd } 440168404Spjd 441168404Spjd if (!foundsep) 442168404Spjd return (B_FALSE); 443168404Spjd 444168404Spjd return (B_TRUE); 445168404Spjd} 446168404Spjd 447168404Spjd/* 448209962Smm * Returns true if this is a valid userspace-type property (one with a '@'). 449209962Smm * Note that after the @, any character is valid (eg, another @, for SID 450209962Smm * user@domain). 451209962Smm */ 452209962Smmboolean_t 453209962Smmzfs_prop_userquota(const char *name) 454209962Smm{ 455209962Smm zfs_userquota_prop_t prop; 456209962Smm 457209962Smm for (prop = 0; prop < ZFS_NUM_USERQUOTA_PROPS; prop++) { 458209962Smm if (strncmp(name, zfs_userquota_prop_prefixes[prop], 459209962Smm strlen(zfs_userquota_prop_prefixes[prop])) == 0) { 460209962Smm return (B_TRUE); 461209962Smm } 462209962Smm } 463209962Smm 464209962Smm return (B_FALSE); 465209962Smm} 466209962Smm 467209962Smm/* 468185029Spjd * Tables of index types, plus functions to convert between the user view 469185029Spjd * (strings) and internal representation (uint64_t). 470168404Spjd */ 471185029Spjdint 472185029Spjdzfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index) 473168404Spjd{ 474185029Spjd return (zprop_string_to_index(prop, string, index, ZFS_TYPE_DATASET)); 475168404Spjd} 476168404Spjd 477185029Spjdint 478185029Spjdzfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string) 479168404Spjd{ 480185029Spjd return (zprop_index_to_string(prop, index, string, ZFS_TYPE_DATASET)); 481168404Spjd} 482168404Spjd 483219089Spjduint64_t 484219089Spjdzfs_prop_random_value(zfs_prop_t prop, uint64_t seed) 485219089Spjd{ 486219089Spjd return (zprop_random_value(prop, seed, ZFS_TYPE_DATASET)); 487219089Spjd} 488219089Spjd 489168404Spjd/* 490185029Spjd * Returns TRUE if the property applies to any of the given dataset types. 491168404Spjd */ 492185029Spjdboolean_t 493185029Spjdzfs_prop_valid_for_type(int prop, zfs_type_t types) 494168404Spjd{ 495185029Spjd return (zprop_valid_for_type(prop, types)); 496168404Spjd} 497168404Spjd 498185029Spjdzprop_type_t 499185029Spjdzfs_prop_get_type(zfs_prop_t prop) 500168404Spjd{ 501185029Spjd return (zfs_prop_table[prop].pd_proptype); 502168404Spjd} 503168404Spjd 504168404Spjd/* 505185029Spjd * Returns TRUE if the property is readonly. 506168404Spjd */ 507185029Spjdboolean_t 508185029Spjdzfs_prop_readonly(zfs_prop_t prop) 509168404Spjd{ 510185029Spjd return (zfs_prop_table[prop].pd_attr == PROP_READONLY || 511185029Spjd zfs_prop_table[prop].pd_attr == PROP_ONETIME); 512168404Spjd} 513168404Spjd 514168404Spjd/* 515185029Spjd * Returns TRUE if the property is only allowed to be set once. 516168404Spjd */ 517185029Spjdboolean_t 518185029Spjdzfs_prop_setonce(zfs_prop_t prop) 519168404Spjd{ 520185029Spjd return (zfs_prop_table[prop].pd_attr == PROP_ONETIME); 521168404Spjd} 522168404Spjd 523185029Spjdconst char * 524185029Spjdzfs_prop_default_string(zfs_prop_t prop) 525185029Spjd{ 526185029Spjd return (zfs_prop_table[prop].pd_strdefault); 527185029Spjd} 528168404Spjd 529185029Spjduint64_t 530185029Spjdzfs_prop_default_numeric(zfs_prop_t prop) 531168404Spjd{ 532185029Spjd return (zfs_prop_table[prop].pd_numdefault); 533168404Spjd} 534168404Spjd 535168404Spjd/* 536185029Spjd * Given a dataset property ID, returns the corresponding name. 537185029Spjd * Assuming the zfs dataset property ID is valid. 538168404Spjd */ 539185029Spjdconst char * 540185029Spjdzfs_prop_to_name(zfs_prop_t prop) 541168404Spjd{ 542185029Spjd return (zfs_prop_table[prop].pd_name); 543168404Spjd} 544168404Spjd 545185029Spjd/* 546185029Spjd * Returns TRUE if the property is inheritable. 547185029Spjd */ 548185029Spjdboolean_t 549185029Spjdzfs_prop_inheritable(zfs_prop_t prop) 550168404Spjd{ 551185029Spjd return (zfs_prop_table[prop].pd_attr == PROP_INHERIT || 552185029Spjd zfs_prop_table[prop].pd_attr == PROP_ONETIME); 553168404Spjd} 554168404Spjd 555168404Spjd#ifndef _KERNEL 556168404Spjd 557168404Spjd/* 558168404Spjd * Returns a string describing the set of acceptable values for the given 559168404Spjd * zfs property, or NULL if it cannot be set. 560168404Spjd */ 561168404Spjdconst char * 562168404Spjdzfs_prop_values(zfs_prop_t prop) 563168404Spjd{ 564168404Spjd return (zfs_prop_table[prop].pd_values); 565168404Spjd} 566168404Spjd 567168404Spjd/* 568168404Spjd * Returns TRUE if this property is a string type. Note that index types 569168404Spjd * (compression, checksum) are treated as strings in userland, even though they 570168404Spjd * are stored numerically on disk. 571168404Spjd */ 572168404Spjdint 573168404Spjdzfs_prop_is_string(zfs_prop_t prop) 574168404Spjd{ 575185029Spjd return (zfs_prop_table[prop].pd_proptype == PROP_TYPE_STRING || 576185029Spjd zfs_prop_table[prop].pd_proptype == PROP_TYPE_INDEX); 577168404Spjd} 578168404Spjd 579168404Spjd/* 580168404Spjd * Returns the column header for the given property. Used only in 581168404Spjd * 'zfs list -o', but centralized here with the other property information. 582168404Spjd */ 583168404Spjdconst char * 584168404Spjdzfs_prop_column_name(zfs_prop_t prop) 585168404Spjd{ 586168404Spjd return (zfs_prop_table[prop].pd_colname); 587168404Spjd} 588168404Spjd 589168404Spjd/* 590168404Spjd * Returns whether the given property should be displayed right-justified for 591168404Spjd * 'zfs list'. 592168404Spjd */ 593168404Spjdboolean_t 594168404Spjdzfs_prop_align_right(zfs_prop_t prop) 595168404Spjd{ 596168404Spjd return (zfs_prop_table[prop].pd_rightalign); 597168404Spjd} 598168404Spjd 599168404Spjd#endif 600