zfs_prop.c revision 265744
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. 23263407Sdelphij * Copyright (c) 2013 by Delphix. All rights reserved. 24246586Sdelphij * Copyright (c) 2013 by Saso Kiselkov. All rights reserved. 25255750Sdelphij * Copyright (c) 2013, Joyent, Inc. All rights reserved. 26168404Spjd */ 27168404Spjd 28219089Spjd/* Portions Copyright 2010 Robert Milkowski */ 29219089Spjd 30168404Spjd#include <sys/zio.h> 31168404Spjd#include <sys/spa.h> 32185029Spjd#include <sys/u8_textprep.h> 33168404Spjd#include <sys/zfs_acl.h> 34168404Spjd#include <sys/zfs_ioctl.h> 35185029Spjd#include <sys/zfs_znode.h> 36168404Spjd 37168404Spjd#include "zfs_prop.h" 38185029Spjd#include "zfs_deleg.h" 39168404Spjd 40168404Spjd#if defined(_KERNEL) 41168404Spjd#include <sys/systm.h> 42168404Spjd#else 43168404Spjd#include <stdlib.h> 44168404Spjd#include <string.h> 45168404Spjd#include <ctype.h> 46168404Spjd#endif 47168404Spjd 48185029Spjdstatic zprop_desc_t zfs_prop_table[ZFS_NUM_PROPS]; 49168404Spjd 50209962Smm/* Note this is indexed by zfs_userquota_prop_t, keep the order the same */ 51209962Smmconst char *zfs_userquota_prop_prefixes[] = { 52209962Smm "userused@", 53209962Smm "userquota@", 54209962Smm "groupused@", 55209962Smm "groupquota@" 56209962Smm}; 57209962Smm 58185029Spjdzprop_desc_t * 59185029Spjdzfs_prop_get_table(void) 60168404Spjd{ 61185029Spjd return (zfs_prop_table); 62168404Spjd} 63168404Spjd 64185029Spjdvoid 65185029Spjdzfs_prop_init(void) 66168404Spjd{ 67185029Spjd static zprop_index_t checksum_table[] = { 68185029Spjd { "on", ZIO_CHECKSUM_ON }, 69185029Spjd { "off", ZIO_CHECKSUM_OFF }, 70185029Spjd { "fletcher2", ZIO_CHECKSUM_FLETCHER_2 }, 71185029Spjd { "fletcher4", ZIO_CHECKSUM_FLETCHER_4 }, 72185029Spjd { "sha256", ZIO_CHECKSUM_SHA256 }, 73255750Sdelphij { "noparity", ZIO_CHECKSUM_NOPARITY }, 74185029Spjd { NULL } 75185029Spjd }; 76168404Spjd 77219089Spjd static zprop_index_t dedup_table[] = { 78219089Spjd { "on", ZIO_CHECKSUM_ON }, 79219089Spjd { "off", ZIO_CHECKSUM_OFF }, 80219089Spjd { "verify", ZIO_CHECKSUM_ON | ZIO_CHECKSUM_VERIFY }, 81219089Spjd { "sha256", ZIO_CHECKSUM_SHA256 }, 82219089Spjd { "sha256,verify", 83219089Spjd ZIO_CHECKSUM_SHA256 | ZIO_CHECKSUM_VERIFY }, 84219089Spjd { NULL } 85219089Spjd }; 86219089Spjd 87185029Spjd static zprop_index_t compress_table[] = { 88185029Spjd { "on", ZIO_COMPRESS_ON }, 89185029Spjd { "off", ZIO_COMPRESS_OFF }, 90185029Spjd { "lzjb", ZIO_COMPRESS_LZJB }, 91185029Spjd { "gzip", ZIO_COMPRESS_GZIP_6 }, /* gzip default */ 92185029Spjd { "gzip-1", ZIO_COMPRESS_GZIP_1 }, 93185029Spjd { "gzip-2", ZIO_COMPRESS_GZIP_2 }, 94185029Spjd { "gzip-3", ZIO_COMPRESS_GZIP_3 }, 95185029Spjd { "gzip-4", ZIO_COMPRESS_GZIP_4 }, 96185029Spjd { "gzip-5", ZIO_COMPRESS_GZIP_5 }, 97185029Spjd { "gzip-6", ZIO_COMPRESS_GZIP_6 }, 98185029Spjd { "gzip-7", ZIO_COMPRESS_GZIP_7 }, 99185029Spjd { "gzip-8", ZIO_COMPRESS_GZIP_8 }, 100185029Spjd { "gzip-9", ZIO_COMPRESS_GZIP_9 }, 101219089Spjd { "zle", ZIO_COMPRESS_ZLE }, 102246586Sdelphij { "lz4", ZIO_COMPRESS_LZ4 }, 103185029Spjd { NULL } 104185029Spjd }; 105168404Spjd 106185029Spjd static zprop_index_t snapdir_table[] = { 107185029Spjd { "hidden", ZFS_SNAPDIR_HIDDEN }, 108185029Spjd { "visible", ZFS_SNAPDIR_VISIBLE }, 109185029Spjd { NULL } 110185029Spjd }; 111168404Spjd 112224174Smm static zprop_index_t acl_mode_table[] = { 113224174Smm { "discard", ZFS_ACL_DISCARD }, 114224174Smm { "groupmask", ZFS_ACL_GROUPMASK }, 115224174Smm { "passthrough", ZFS_ACL_PASSTHROUGH }, 116243560Smm { "restricted", ZFS_ACL_RESTRICTED }, 117224174Smm { NULL } 118224174Smm }; 119224174Smm 120185029Spjd static zprop_index_t acl_inherit_table[] = { 121185029Spjd { "discard", ZFS_ACL_DISCARD }, 122185029Spjd { "noallow", ZFS_ACL_NOALLOW }, 123185029Spjd { "restricted", ZFS_ACL_RESTRICTED }, 124185029Spjd { "passthrough", ZFS_ACL_PASSTHROUGH }, 125185029Spjd { "secure", ZFS_ACL_RESTRICTED }, /* bkwrd compatability */ 126201143Sdelphij { "passthrough-x", ZFS_ACL_PASSTHROUGH_X }, 127185029Spjd { NULL } 128185029Spjd }; 129168404Spjd 130185029Spjd static zprop_index_t case_table[] = { 131185029Spjd { "sensitive", ZFS_CASE_SENSITIVE }, 132185029Spjd { "insensitive", ZFS_CASE_INSENSITIVE }, 133185029Spjd { "mixed", ZFS_CASE_MIXED }, 134185029Spjd { NULL } 135185029Spjd }; 136168404Spjd 137185029Spjd static zprop_index_t copies_table[] = { 138185029Spjd { "1", 1 }, 139185029Spjd { "2", 2 }, 140185029Spjd { "3", 3 }, 141185029Spjd { NULL } 142185029Spjd }; 143168404Spjd 144185029Spjd /* 145185029Spjd * Use the unique flags we have to send to u8_strcmp() and/or 146185029Spjd * u8_textprep() to represent the various normalization property 147185029Spjd * values. 148185029Spjd */ 149185029Spjd static zprop_index_t normalize_table[] = { 150185029Spjd { "none", 0 }, 151185029Spjd { "formD", U8_TEXTPREP_NFD }, 152185029Spjd { "formKC", U8_TEXTPREP_NFKC }, 153185029Spjd { "formC", U8_TEXTPREP_NFC }, 154185029Spjd { "formKD", U8_TEXTPREP_NFKD }, 155185029Spjd { NULL } 156185029Spjd }; 157168404Spjd 158185029Spjd static zprop_index_t version_table[] = { 159185029Spjd { "1", 1 }, 160185029Spjd { "2", 2 }, 161185029Spjd { "3", 3 }, 162209962Smm { "4", 4 }, 163219089Spjd { "5", 5 }, 164185029Spjd { "current", ZPL_VERSION }, 165185029Spjd { NULL } 166185029Spjd }; 167168404Spjd 168185029Spjd static zprop_index_t boolean_table[] = { 169185029Spjd { "off", 0 }, 170185029Spjd { "on", 1 }, 171185029Spjd { NULL } 172185029Spjd }; 173168404Spjd 174219089Spjd static zprop_index_t logbias_table[] = { 175219089Spjd { "latency", ZFS_LOGBIAS_LATENCY }, 176219089Spjd { "throughput", ZFS_LOGBIAS_THROUGHPUT }, 177219089Spjd { NULL } 178219089Spjd }; 179219089Spjd 180185029Spjd static zprop_index_t canmount_table[] = { 181185029Spjd { "off", ZFS_CANMOUNT_OFF }, 182185029Spjd { "on", ZFS_CANMOUNT_ON }, 183185029Spjd { "noauto", ZFS_CANMOUNT_NOAUTO }, 184185029Spjd { NULL } 185185029Spjd }; 186168404Spjd 187185029Spjd static zprop_index_t cache_table[] = { 188185029Spjd { "none", ZFS_CACHE_NONE }, 189185029Spjd { "metadata", ZFS_CACHE_METADATA }, 190185029Spjd { "all", ZFS_CACHE_ALL }, 191185029Spjd { NULL } 192185029Spjd }; 193168404Spjd 194219089Spjd static zprop_index_t sync_table[] = { 195219089Spjd { "standard", ZFS_SYNC_STANDARD }, 196219089Spjd { "always", ZFS_SYNC_ALWAYS }, 197219089Spjd { "disabled", ZFS_SYNC_DISABLED }, 198219089Spjd { NULL } 199219089Spjd }; 200219089Spjd 201265678Smav static zprop_index_t volmode_table[] = { 202265678Smav { "default", ZFS_VOLMODE_DEFAULT }, 203265678Smav { "geom", ZFS_VOLMODE_GEOM }, 204265678Smav { "dev", ZFS_VOLMODE_DEV }, 205265678Smav { "none", ZFS_VOLMODE_NONE }, 206265678Smav { NULL } 207265678Smav }; 208265678Smav 209185029Spjd /* inherit index properties */ 210219089Spjd zprop_register_index(ZFS_PROP_SYNC, "sync", ZFS_SYNC_STANDARD, 211185029Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 212219089Spjd "standard | always | disabled", "SYNC", 213219089Spjd sync_table); 214219089Spjd zprop_register_index(ZFS_PROP_CHECKSUM, "checksum", 215219089Spjd ZIO_CHECKSUM_DEFAULT, PROP_INHERIT, ZFS_TYPE_FILESYSTEM | 216219089Spjd ZFS_TYPE_VOLUME, 217185029Spjd "on | off | fletcher2 | fletcher4 | sha256", "CHECKSUM", 218185029Spjd checksum_table); 219219089Spjd zprop_register_index(ZFS_PROP_DEDUP, "dedup", ZIO_CHECKSUM_OFF, 220219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 221219089Spjd "on | off | verify | sha256[,verify]", "DEDUP", 222219089Spjd dedup_table); 223219089Spjd zprop_register_index(ZFS_PROP_COMPRESSION, "compression", 224185029Spjd ZIO_COMPRESS_DEFAULT, PROP_INHERIT, 225185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 226246586Sdelphij "on | off | lzjb | gzip | gzip-[1-9] | zle | lz4", 227246586Sdelphij "COMPRESS", compress_table); 228219089Spjd zprop_register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN, 229185029Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 230185029Spjd "hidden | visible", "SNAPDIR", snapdir_table); 231224174Smm zprop_register_index(ZFS_PROP_ACLMODE, "aclmode", ZFS_ACL_DISCARD, 232224174Smm PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 233243560Smm "discard | groupmask | passthrough | restricted", "ACLMODE", 234243560Smm acl_mode_table); 235219089Spjd zprop_register_index(ZFS_PROP_ACLINHERIT, "aclinherit", 236219089Spjd ZFS_ACL_RESTRICTED, PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 237201143Sdelphij "discard | noallow | restricted | passthrough | passthrough-x", 238185029Spjd "ACLINHERIT", acl_inherit_table); 239219089Spjd zprop_register_index(ZFS_PROP_COPIES, "copies", 1, PROP_INHERIT, 240219089Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 241185029Spjd "1 | 2 | 3", "COPIES", copies_table); 242219089Spjd zprop_register_index(ZFS_PROP_PRIMARYCACHE, "primarycache", 243185029Spjd ZFS_CACHE_ALL, PROP_INHERIT, 244185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, 245185029Spjd "all | none | metadata", "PRIMARYCACHE", cache_table); 246219089Spjd zprop_register_index(ZFS_PROP_SECONDARYCACHE, "secondarycache", 247185029Spjd ZFS_CACHE_ALL, PROP_INHERIT, 248185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, 249185029Spjd "all | none | metadata", "SECONDARYCACHE", cache_table); 250219089Spjd zprop_register_index(ZFS_PROP_LOGBIAS, "logbias", ZFS_LOGBIAS_LATENCY, 251219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 252219089Spjd "latency | throughput", "LOGBIAS", logbias_table); 253265678Smav zprop_register_index(ZFS_PROP_VOLMODE, "volmode", 254265678Smav ZFS_VOLMODE_DEFAULT, PROP_INHERIT, 255265678Smav ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, 256265678Smav "default | geom | dev | none", "VOLMODE", volmode_table); 257168404Spjd 258185029Spjd /* inherit index (boolean) properties */ 259219089Spjd zprop_register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT, 260185029Spjd ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table); 261219089Spjd zprop_register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT, 262185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES", 263185029Spjd boolean_table); 264219089Spjd zprop_register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT, 265185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC", 266185029Spjd boolean_table); 267219089Spjd zprop_register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT, 268185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID", 269185029Spjd boolean_table); 270219089Spjd zprop_register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT, 271185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY", 272185029Spjd boolean_table); 273219089Spjd zprop_register_index(ZFS_PROP_ZONED, "jailed", 0, PROP_INHERIT, 274185029Spjd ZFS_TYPE_FILESYSTEM, "on | off", "JAILED", boolean_table); 275219089Spjd zprop_register_index(ZFS_PROP_XATTR, "xattr", 1, PROP_INHERIT, 276185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "XATTR", 277185029Spjd boolean_table); 278219089Spjd zprop_register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT, 279185029Spjd ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN", 280185029Spjd boolean_table); 281219089Spjd zprop_register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT, 282185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND", 283185029Spjd boolean_table); 284168404Spjd 285185029Spjd /* default index properties */ 286219089Spjd zprop_register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT, 287185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 288228103Smm "1 | 2 | 3 | 4 | 5 | current", "VERSION", version_table); 289219089Spjd zprop_register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON, 290185029Spjd PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto", 291185029Spjd "CANMOUNT", canmount_table); 292168404Spjd 293185029Spjd /* readonly index (boolean) properties */ 294219089Spjd zprop_register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY, 295185029Spjd ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table); 296219089Spjd zprop_register_index(ZFS_PROP_DEFER_DESTROY, "defer_destroy", 0, 297219089Spjd PROP_READONLY, ZFS_TYPE_SNAPSHOT, "yes | no", "DEFER_DESTROY", 298219089Spjd boolean_table); 299185029Spjd 300185029Spjd /* set once index properties */ 301219089Spjd zprop_register_index(ZFS_PROP_NORMALIZE, "normalization", 0, 302185029Spjd PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 303185029Spjd "none | formC | formD | formKC | formKD", "NORMALIZATION", 304185029Spjd normalize_table); 305219089Spjd zprop_register_index(ZFS_PROP_CASE, "casesensitivity", 306219089Spjd ZFS_CASE_SENSITIVE, PROP_ONETIME, ZFS_TYPE_FILESYSTEM | 307219089Spjd ZFS_TYPE_SNAPSHOT, 308185029Spjd "sensitive | insensitive | mixed", "CASE", case_table); 309185029Spjd 310185029Spjd /* set once index (boolean) properties */ 311219089Spjd zprop_register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME, 312185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 313185029Spjd "on | off", "UTF8ONLY", boolean_table); 314185029Spjd 315185029Spjd /* string properties */ 316219089Spjd zprop_register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY, 317185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN"); 318228103Smm zprop_register_string(ZFS_PROP_CLONES, "clones", NULL, PROP_READONLY, 319228103Smm ZFS_TYPE_SNAPSHOT, "<dataset>[,...]", "CLONES"); 320219089Spjd zprop_register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/", 321219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "<path> | legacy | none", 322219089Spjd "MOUNTPOINT"); 323219089Spjd zprop_register_string(ZFS_PROP_SHARENFS, "sharenfs", "off", 324219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "on | off | share(1M) options", 325219089Spjd "SHARENFS"); 326219089Spjd zprop_register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY, 327263407Sdelphij ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, 328263407Sdelphij "filesystem | volume | snapshot | bookmark", "TYPE"); 329219089Spjd zprop_register_string(ZFS_PROP_SHARESMB, "sharesmb", "off", 330219089Spjd PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 331219089Spjd "on | off | sharemgr(1M) options", "SHARESMB"); 332219089Spjd zprop_register_string(ZFS_PROP_MLSLABEL, "mlslabel", 333219089Spjd ZFS_MLSLABEL_DEFAULT, PROP_INHERIT, ZFS_TYPE_DATASET, 334219089Spjd "<sensitivity label>", "MLSLABEL"); 335185029Spjd 336185029Spjd /* readonly number properties */ 337219089Spjd zprop_register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY, 338185029Spjd ZFS_TYPE_DATASET, "<size>", "USED"); 339219089Spjd zprop_register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY, 340185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL"); 341219089Spjd zprop_register_number(ZFS_PROP_REFERENCED, "referenced", 0, 342219089Spjd PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "REFER"); 343219089Spjd zprop_register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0, 344185029Spjd PROP_READONLY, ZFS_TYPE_DATASET, 345185029Spjd "<1.00x or higher if compressed>", "RATIO"); 346223623Smm zprop_register_number(ZFS_PROP_REFRATIO, "refcompressratio", 0, 347223623Smm PROP_READONLY, ZFS_TYPE_DATASET, 348223623Smm "<1.00x or higher if compressed>", "REFRATIO"); 349219089Spjd zprop_register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize", 350219089Spjd ZVOL_DEFAULT_BLOCKSIZE, PROP_ONETIME, 351185029Spjd ZFS_TYPE_VOLUME, "512 to 128k, power of 2", "VOLBLOCK"); 352219089Spjd zprop_register_number(ZFS_PROP_USEDSNAP, "usedbysnapshots", 0, 353219089Spjd PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 354219089Spjd "USEDSNAP"); 355219089Spjd zprop_register_number(ZFS_PROP_USEDDS, "usedbydataset", 0, 356219089Spjd PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 357219089Spjd "USEDDS"); 358219089Spjd zprop_register_number(ZFS_PROP_USEDCHILD, "usedbychildren", 0, 359219089Spjd PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 360219089Spjd "USEDCHILD"); 361219089Spjd zprop_register_number(ZFS_PROP_USEDREFRESERV, "usedbyrefreservation", 0, 362185029Spjd PROP_READONLY, 363185029Spjd ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDREFRESERV"); 364219089Spjd zprop_register_number(ZFS_PROP_USERREFS, "userrefs", 0, PROP_READONLY, 365219089Spjd ZFS_TYPE_SNAPSHOT, "<count>", "USERREFS"); 366228103Smm zprop_register_number(ZFS_PROP_WRITTEN, "written", 0, PROP_READONLY, 367228103Smm ZFS_TYPE_DATASET, "<size>", "WRITTEN"); 368247585Smm zprop_register_number(ZFS_PROP_LOGICALUSED, "logicalused", 0, 369247585Smm PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "LUSED"); 370247585Smm zprop_register_number(ZFS_PROP_LOGICALREFERENCED, "logicalreferenced", 371247585Smm 0, PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "LREFER"); 372185029Spjd 373185029Spjd /* default number properties */ 374219089Spjd zprop_register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT, 375185029Spjd ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA"); 376219089Spjd zprop_register_number(ZFS_PROP_RESERVATION, "reservation", 0, 377219089Spjd PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 378219089Spjd "<size> | none", "RESERV"); 379219089Spjd zprop_register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT, 380185029Spjd ZFS_TYPE_VOLUME, "<size>", "VOLSIZE"); 381219089Spjd zprop_register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT, 382185029Spjd ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA"); 383219089Spjd zprop_register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0, 384185029Spjd PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 385185029Spjd "<size> | none", "REFRESERV"); 386265744Sdelphij zprop_register_number(ZFS_PROP_FILESYSTEM_LIMIT, "filesystem_limit", 387265744Sdelphij UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, 388265744Sdelphij "<count> | none", "FSLIMIT"); 389265744Sdelphij zprop_register_number(ZFS_PROP_SNAPSHOT_LIMIT, "snapshot_limit", 390265744Sdelphij UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 391265744Sdelphij "<count> | none", "SSLIMIT"); 392265744Sdelphij zprop_register_number(ZFS_PROP_FILESYSTEM_COUNT, "filesystem_count", 393265744Sdelphij UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, 394265744Sdelphij "<count>", "FSCOUNT"); 395265744Sdelphij zprop_register_number(ZFS_PROP_SNAPSHOT_COUNT, "snapshot_count", 396265744Sdelphij UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 397265744Sdelphij "<count>", "SSCOUNT"); 398185029Spjd 399185029Spjd /* inherit number properties */ 400219089Spjd zprop_register_number(ZFS_PROP_RECORDSIZE, "recordsize", 401219089Spjd SPA_MAXBLOCKSIZE, PROP_INHERIT, 402185029Spjd ZFS_TYPE_FILESYSTEM, "512 to 128k, power of 2", "RECSIZE"); 403185029Spjd 404185029Spjd /* hidden properties */ 405219089Spjd zprop_register_hidden(ZFS_PROP_CREATETXG, "createtxg", PROP_TYPE_NUMBER, 406263407Sdelphij PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "CREATETXG"); 407219089Spjd zprop_register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER, 408219089Spjd PROP_READONLY, ZFS_TYPE_SNAPSHOT, "NUMCLONES"); 409219089Spjd zprop_register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING, 410263407Sdelphij PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "NAME"); 411219089Spjd zprop_register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions", 412219089Spjd PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS"); 413219089Spjd zprop_register_hidden(ZFS_PROP_STMF_SHAREINFO, "stmf_sbd_lu", 414219089Spjd PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, 415219089Spjd "STMF_SBD_LU"); 416219089Spjd zprop_register_hidden(ZFS_PROP_GUID, "guid", PROP_TYPE_NUMBER, 417263407Sdelphij PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "GUID"); 418219089Spjd zprop_register_hidden(ZFS_PROP_USERACCOUNTING, "useraccounting", 419219089Spjd PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, 420219089Spjd "USERACCOUNTING"); 421219089Spjd zprop_register_hidden(ZFS_PROP_UNIQUE, "unique", PROP_TYPE_NUMBER, 422219089Spjd PROP_READONLY, ZFS_TYPE_DATASET, "UNIQUE"); 423219089Spjd zprop_register_hidden(ZFS_PROP_OBJSETID, "objsetid", PROP_TYPE_NUMBER, 424219089Spjd PROP_READONLY, ZFS_TYPE_DATASET, "OBJSETID"); 425253819Sdelphij zprop_register_hidden(ZFS_PROP_INCONSISTENT, "inconsistent", 426253819Sdelphij PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, "INCONSISTENT"); 427185029Spjd 428185029Spjd /* oddball properties */ 429219089Spjd zprop_register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0, 430263407Sdelphij NULL, PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, 431185029Spjd "<date>", "CREATION", B_FALSE, B_TRUE, NULL); 432168404Spjd} 433168404Spjd 434185029Spjdboolean_t 435185029Spjdzfs_prop_delegatable(zfs_prop_t prop) 436168404Spjd{ 437185029Spjd zprop_desc_t *pd = &zfs_prop_table[prop]; 438219089Spjd 439219089Spjd /* The mlslabel property is never delegatable. */ 440219089Spjd if (prop == ZFS_PROP_MLSLABEL) 441219089Spjd return (B_FALSE); 442219089Spjd 443185029Spjd return (pd->pd_attr != PROP_READONLY); 444168404Spjd} 445168404Spjd 446168404Spjd/* 447168404Spjd * Given a zfs dataset property name, returns the corresponding property ID. 448168404Spjd */ 449168404Spjdzfs_prop_t 450168404Spjdzfs_name_to_prop(const char *propname) 451168404Spjd{ 452185029Spjd return (zprop_name_to_prop(propname, ZFS_TYPE_DATASET)); 453168404Spjd} 454168404Spjd 455168404Spjd/* 456168404Spjd * For user property names, we allow all lowercase alphanumeric characters, plus 457168404Spjd * a few useful punctuation characters. 458168404Spjd */ 459168404Spjdstatic int 460168404Spjdvalid_char(char c) 461168404Spjd{ 462168404Spjd return ((c >= 'a' && c <= 'z') || 463168404Spjd (c >= '0' && c <= '9') || 464168404Spjd c == '-' || c == '_' || c == '.' || c == ':'); 465168404Spjd} 466168404Spjd 467168404Spjd/* 468168404Spjd * Returns true if this is a valid user-defined property (one with a ':'). 469168404Spjd */ 470168404Spjdboolean_t 471168404Spjdzfs_prop_user(const char *name) 472168404Spjd{ 473168404Spjd int i; 474168404Spjd char c; 475168404Spjd boolean_t foundsep = B_FALSE; 476168404Spjd 477168404Spjd for (i = 0; i < strlen(name); i++) { 478168404Spjd c = name[i]; 479168404Spjd if (!valid_char(c)) 480168404Spjd return (B_FALSE); 481168404Spjd if (c == ':') 482168404Spjd foundsep = B_TRUE; 483168404Spjd } 484168404Spjd 485168404Spjd if (!foundsep) 486168404Spjd return (B_FALSE); 487168404Spjd 488168404Spjd return (B_TRUE); 489168404Spjd} 490168404Spjd 491168404Spjd/* 492209962Smm * Returns true if this is a valid userspace-type property (one with a '@'). 493209962Smm * Note that after the @, any character is valid (eg, another @, for SID 494209962Smm * user@domain). 495209962Smm */ 496209962Smmboolean_t 497209962Smmzfs_prop_userquota(const char *name) 498209962Smm{ 499209962Smm zfs_userquota_prop_t prop; 500209962Smm 501209962Smm for (prop = 0; prop < ZFS_NUM_USERQUOTA_PROPS; prop++) { 502209962Smm if (strncmp(name, zfs_userquota_prop_prefixes[prop], 503209962Smm strlen(zfs_userquota_prop_prefixes[prop])) == 0) { 504209962Smm return (B_TRUE); 505209962Smm } 506209962Smm } 507209962Smm 508209962Smm return (B_FALSE); 509209962Smm} 510209962Smm 511209962Smm/* 512228103Smm * Returns true if this is a valid written@ property. 513228103Smm * Note that after the @, any character is valid (eg, another @, for 514228103Smm * written@pool/fs@origin). 515228103Smm */ 516228103Smmboolean_t 517228103Smmzfs_prop_written(const char *name) 518228103Smm{ 519228103Smm static const char *prefix = "written@"; 520228103Smm return (strncmp(name, prefix, strlen(prefix)) == 0); 521228103Smm} 522228103Smm 523228103Smm/* 524185029Spjd * Tables of index types, plus functions to convert between the user view 525185029Spjd * (strings) and internal representation (uint64_t). 526168404Spjd */ 527185029Spjdint 528185029Spjdzfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index) 529168404Spjd{ 530185029Spjd return (zprop_string_to_index(prop, string, index, ZFS_TYPE_DATASET)); 531168404Spjd} 532168404Spjd 533185029Spjdint 534185029Spjdzfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string) 535168404Spjd{ 536185029Spjd return (zprop_index_to_string(prop, index, string, ZFS_TYPE_DATASET)); 537168404Spjd} 538168404Spjd 539219089Spjduint64_t 540219089Spjdzfs_prop_random_value(zfs_prop_t prop, uint64_t seed) 541219089Spjd{ 542219089Spjd return (zprop_random_value(prop, seed, ZFS_TYPE_DATASET)); 543219089Spjd} 544219089Spjd 545168404Spjd/* 546185029Spjd * Returns TRUE if the property applies to any of the given dataset types. 547168404Spjd */ 548185029Spjdboolean_t 549185029Spjdzfs_prop_valid_for_type(int prop, zfs_type_t types) 550168404Spjd{ 551185029Spjd return (zprop_valid_for_type(prop, types)); 552168404Spjd} 553168404Spjd 554185029Spjdzprop_type_t 555185029Spjdzfs_prop_get_type(zfs_prop_t prop) 556168404Spjd{ 557185029Spjd return (zfs_prop_table[prop].pd_proptype); 558168404Spjd} 559168404Spjd 560168404Spjd/* 561185029Spjd * Returns TRUE if the property is readonly. 562168404Spjd */ 563185029Spjdboolean_t 564185029Spjdzfs_prop_readonly(zfs_prop_t prop) 565168404Spjd{ 566185029Spjd return (zfs_prop_table[prop].pd_attr == PROP_READONLY || 567185029Spjd zfs_prop_table[prop].pd_attr == PROP_ONETIME); 568168404Spjd} 569168404Spjd 570168404Spjd/* 571185029Spjd * Returns TRUE if the property is only allowed to be set once. 572168404Spjd */ 573185029Spjdboolean_t 574185029Spjdzfs_prop_setonce(zfs_prop_t prop) 575168404Spjd{ 576185029Spjd return (zfs_prop_table[prop].pd_attr == PROP_ONETIME); 577168404Spjd} 578168404Spjd 579185029Spjdconst char * 580185029Spjdzfs_prop_default_string(zfs_prop_t prop) 581185029Spjd{ 582185029Spjd return (zfs_prop_table[prop].pd_strdefault); 583185029Spjd} 584168404Spjd 585185029Spjduint64_t 586185029Spjdzfs_prop_default_numeric(zfs_prop_t prop) 587168404Spjd{ 588185029Spjd return (zfs_prop_table[prop].pd_numdefault); 589168404Spjd} 590168404Spjd 591168404Spjd/* 592185029Spjd * Given a dataset property ID, returns the corresponding name. 593185029Spjd * Assuming the zfs dataset property ID is valid. 594168404Spjd */ 595185029Spjdconst char * 596185029Spjdzfs_prop_to_name(zfs_prop_t prop) 597168404Spjd{ 598185029Spjd return (zfs_prop_table[prop].pd_name); 599168404Spjd} 600168404Spjd 601185029Spjd/* 602185029Spjd * Returns TRUE if the property is inheritable. 603185029Spjd */ 604185029Spjdboolean_t 605185029Spjdzfs_prop_inheritable(zfs_prop_t prop) 606168404Spjd{ 607185029Spjd return (zfs_prop_table[prop].pd_attr == PROP_INHERIT || 608185029Spjd zfs_prop_table[prop].pd_attr == PROP_ONETIME); 609168404Spjd} 610168404Spjd 611168404Spjd#ifndef _KERNEL 612168404Spjd 613168404Spjd/* 614168404Spjd * Returns a string describing the set of acceptable values for the given 615168404Spjd * zfs property, or NULL if it cannot be set. 616168404Spjd */ 617168404Spjdconst char * 618168404Spjdzfs_prop_values(zfs_prop_t prop) 619168404Spjd{ 620168404Spjd return (zfs_prop_table[prop].pd_values); 621168404Spjd} 622168404Spjd 623168404Spjd/* 624168404Spjd * Returns TRUE if this property is a string type. Note that index types 625168404Spjd * (compression, checksum) are treated as strings in userland, even though they 626168404Spjd * are stored numerically on disk. 627168404Spjd */ 628168404Spjdint 629168404Spjdzfs_prop_is_string(zfs_prop_t prop) 630168404Spjd{ 631185029Spjd return (zfs_prop_table[prop].pd_proptype == PROP_TYPE_STRING || 632185029Spjd zfs_prop_table[prop].pd_proptype == PROP_TYPE_INDEX); 633168404Spjd} 634168404Spjd 635168404Spjd/* 636168404Spjd * Returns the column header for the given property. Used only in 637168404Spjd * 'zfs list -o', but centralized here with the other property information. 638168404Spjd */ 639168404Spjdconst char * 640168404Spjdzfs_prop_column_name(zfs_prop_t prop) 641168404Spjd{ 642168404Spjd return (zfs_prop_table[prop].pd_colname); 643168404Spjd} 644168404Spjd 645168404Spjd/* 646168404Spjd * Returns whether the given property should be displayed right-justified for 647168404Spjd * 'zfs list'. 648168404Spjd */ 649168404Spjdboolean_t 650168404Spjdzfs_prop_align_right(zfs_prop_t prop) 651168404Spjd{ 652168404Spjd return (zfs_prop_table[prop].pd_rightalign); 653168404Spjd} 654168404Spjd 655168404Spjd#endif 656