zfs_prop.c revision 276081
1/* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21/* 22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 23 * Copyright (c) 2011, 2014 by Delphix. All rights reserved. 24 * Copyright (c) 2013 by Saso Kiselkov. All rights reserved. 25 * Copyright (c) 2013, Joyent, Inc. All rights reserved. 26 */ 27 28/* Portions Copyright 2010 Robert Milkowski */ 29 30#include <sys/zio.h> 31#include <sys/spa.h> 32#include <sys/u8_textprep.h> 33#include <sys/zfs_acl.h> 34#include <sys/zfs_ioctl.h> 35#include <sys/zfs_znode.h> 36 37#include "zfs_prop.h" 38#include "zfs_deleg.h" 39 40#if defined(_KERNEL) 41#include <sys/systm.h> 42#else 43#include <stdlib.h> 44#include <string.h> 45#include <ctype.h> 46#endif 47 48static zprop_desc_t zfs_prop_table[ZFS_NUM_PROPS]; 49 50/* Note this is indexed by zfs_userquota_prop_t, keep the order the same */ 51const char *zfs_userquota_prop_prefixes[] = { 52 "userused@", 53 "userquota@", 54 "groupused@", 55 "groupquota@" 56}; 57 58zprop_desc_t * 59zfs_prop_get_table(void) 60{ 61 return (zfs_prop_table); 62} 63 64void 65zfs_prop_init(void) 66{ 67 static zprop_index_t checksum_table[] = { 68 { "on", ZIO_CHECKSUM_ON }, 69 { "off", ZIO_CHECKSUM_OFF }, 70 { "fletcher2", ZIO_CHECKSUM_FLETCHER_2 }, 71 { "fletcher4", ZIO_CHECKSUM_FLETCHER_4 }, 72 { "sha256", ZIO_CHECKSUM_SHA256 }, 73 { "noparity", ZIO_CHECKSUM_NOPARITY }, 74 { NULL } 75 }; 76 77 static zprop_index_t dedup_table[] = { 78 { "on", ZIO_CHECKSUM_ON }, 79 { "off", ZIO_CHECKSUM_OFF }, 80 { "verify", ZIO_CHECKSUM_ON | ZIO_CHECKSUM_VERIFY }, 81 { "sha256", ZIO_CHECKSUM_SHA256 }, 82 { "sha256,verify", 83 ZIO_CHECKSUM_SHA256 | ZIO_CHECKSUM_VERIFY }, 84 { NULL } 85 }; 86 87 static zprop_index_t compress_table[] = { 88 { "on", ZIO_COMPRESS_ON }, 89 { "off", ZIO_COMPRESS_OFF }, 90 { "lzjb", ZIO_COMPRESS_LZJB }, 91 { "gzip", ZIO_COMPRESS_GZIP_6 }, /* gzip default */ 92 { "gzip-1", ZIO_COMPRESS_GZIP_1 }, 93 { "gzip-2", ZIO_COMPRESS_GZIP_2 }, 94 { "gzip-3", ZIO_COMPRESS_GZIP_3 }, 95 { "gzip-4", ZIO_COMPRESS_GZIP_4 }, 96 { "gzip-5", ZIO_COMPRESS_GZIP_5 }, 97 { "gzip-6", ZIO_COMPRESS_GZIP_6 }, 98 { "gzip-7", ZIO_COMPRESS_GZIP_7 }, 99 { "gzip-8", ZIO_COMPRESS_GZIP_8 }, 100 { "gzip-9", ZIO_COMPRESS_GZIP_9 }, 101 { "zle", ZIO_COMPRESS_ZLE }, 102 { "lz4", ZIO_COMPRESS_LZ4 }, 103 { NULL } 104 }; 105 106 static zprop_index_t snapdir_table[] = { 107 { "hidden", ZFS_SNAPDIR_HIDDEN }, 108 { "visible", ZFS_SNAPDIR_VISIBLE }, 109 { NULL } 110 }; 111 112 static zprop_index_t acl_mode_table[] = { 113 { "discard", ZFS_ACL_DISCARD }, 114 { "groupmask", ZFS_ACL_GROUPMASK }, 115 { "passthrough", ZFS_ACL_PASSTHROUGH }, 116 { "restricted", ZFS_ACL_RESTRICTED }, 117 { NULL } 118 }; 119 120 static zprop_index_t acl_inherit_table[] = { 121 { "discard", ZFS_ACL_DISCARD }, 122 { "noallow", ZFS_ACL_NOALLOW }, 123 { "restricted", ZFS_ACL_RESTRICTED }, 124 { "passthrough", ZFS_ACL_PASSTHROUGH }, 125 { "secure", ZFS_ACL_RESTRICTED }, /* bkwrd compatability */ 126 { "passthrough-x", ZFS_ACL_PASSTHROUGH_X }, 127 { NULL } 128 }; 129 130 static zprop_index_t case_table[] = { 131 { "sensitive", ZFS_CASE_SENSITIVE }, 132 { "insensitive", ZFS_CASE_INSENSITIVE }, 133 { "mixed", ZFS_CASE_MIXED }, 134 { NULL } 135 }; 136 137 static zprop_index_t copies_table[] = { 138 { "1", 1 }, 139 { "2", 2 }, 140 { "3", 3 }, 141 { NULL } 142 }; 143 144 /* 145 * Use the unique flags we have to send to u8_strcmp() and/or 146 * u8_textprep() to represent the various normalization property 147 * values. 148 */ 149 static zprop_index_t normalize_table[] = { 150 { "none", 0 }, 151 { "formD", U8_TEXTPREP_NFD }, 152 { "formKC", U8_TEXTPREP_NFKC }, 153 { "formC", U8_TEXTPREP_NFC }, 154 { "formKD", U8_TEXTPREP_NFKD }, 155 { NULL } 156 }; 157 158 static zprop_index_t version_table[] = { 159 { "1", 1 }, 160 { "2", 2 }, 161 { "3", 3 }, 162 { "4", 4 }, 163 { "5", 5 }, 164 { "current", ZPL_VERSION }, 165 { NULL } 166 }; 167 168 static zprop_index_t boolean_table[] = { 169 { "off", 0 }, 170 { "on", 1 }, 171 { NULL } 172 }; 173 174 static zprop_index_t logbias_table[] = { 175 { "latency", ZFS_LOGBIAS_LATENCY }, 176 { "throughput", ZFS_LOGBIAS_THROUGHPUT }, 177 { NULL } 178 }; 179 180 static zprop_index_t canmount_table[] = { 181 { "off", ZFS_CANMOUNT_OFF }, 182 { "on", ZFS_CANMOUNT_ON }, 183 { "noauto", ZFS_CANMOUNT_NOAUTO }, 184 { NULL } 185 }; 186 187 static zprop_index_t cache_table[] = { 188 { "none", ZFS_CACHE_NONE }, 189 { "metadata", ZFS_CACHE_METADATA }, 190 { "all", ZFS_CACHE_ALL }, 191 { NULL } 192 }; 193 194 static zprop_index_t sync_table[] = { 195 { "standard", ZFS_SYNC_STANDARD }, 196 { "always", ZFS_SYNC_ALWAYS }, 197 { "disabled", ZFS_SYNC_DISABLED }, 198 { NULL } 199 }; 200 201 static zprop_index_t volmode_table[] = { 202 { "default", ZFS_VOLMODE_DEFAULT }, 203 { "geom", ZFS_VOLMODE_GEOM }, 204 { "dev", ZFS_VOLMODE_DEV }, 205 { "none", ZFS_VOLMODE_NONE }, 206 { NULL } 207 }; 208 209 static zprop_index_t redundant_metadata_table[] = { 210 { "all", ZFS_REDUNDANT_METADATA_ALL }, 211 { "most", ZFS_REDUNDANT_METADATA_MOST }, 212 { NULL } 213 }; 214 215 /* inherit index properties */ 216 zprop_register_index(ZFS_PROP_REDUNDANT_METADATA, "redundant_metadata", 217 ZFS_REDUNDANT_METADATA_ALL, 218 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 219 "all | most", "REDUND_MD", 220 redundant_metadata_table); 221 zprop_register_index(ZFS_PROP_SYNC, "sync", ZFS_SYNC_STANDARD, 222 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 223 "standard | always | disabled", "SYNC", 224 sync_table); 225 zprop_register_index(ZFS_PROP_CHECKSUM, "checksum", 226 ZIO_CHECKSUM_DEFAULT, PROP_INHERIT, ZFS_TYPE_FILESYSTEM | 227 ZFS_TYPE_VOLUME, 228 "on | off | fletcher2 | fletcher4 | sha256", "CHECKSUM", 229 checksum_table); 230 zprop_register_index(ZFS_PROP_DEDUP, "dedup", ZIO_CHECKSUM_OFF, 231 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 232 "on | off | verify | sha256[,verify]", "DEDUP", 233 dedup_table); 234 zprop_register_index(ZFS_PROP_COMPRESSION, "compression", 235 ZIO_COMPRESS_DEFAULT, PROP_INHERIT, 236 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 237 "on | off | lzjb | gzip | gzip-[1-9] | zle | lz4", 238 "COMPRESS", compress_table); 239 zprop_register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN, 240 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 241 "hidden | visible", "SNAPDIR", snapdir_table); 242 zprop_register_index(ZFS_PROP_ACLMODE, "aclmode", ZFS_ACL_DISCARD, 243 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 244 "discard | groupmask | passthrough | restricted", "ACLMODE", 245 acl_mode_table); 246 zprop_register_index(ZFS_PROP_ACLINHERIT, "aclinherit", 247 ZFS_ACL_RESTRICTED, PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 248 "discard | noallow | restricted | passthrough | passthrough-x", 249 "ACLINHERIT", acl_inherit_table); 250 zprop_register_index(ZFS_PROP_COPIES, "copies", 1, PROP_INHERIT, 251 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 252 "1 | 2 | 3", "COPIES", copies_table); 253 zprop_register_index(ZFS_PROP_PRIMARYCACHE, "primarycache", 254 ZFS_CACHE_ALL, PROP_INHERIT, 255 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, 256 "all | none | metadata", "PRIMARYCACHE", cache_table); 257 zprop_register_index(ZFS_PROP_SECONDARYCACHE, "secondarycache", 258 ZFS_CACHE_ALL, PROP_INHERIT, 259 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, 260 "all | none | metadata", "SECONDARYCACHE", cache_table); 261 zprop_register_index(ZFS_PROP_LOGBIAS, "logbias", ZFS_LOGBIAS_LATENCY, 262 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 263 "latency | throughput", "LOGBIAS", logbias_table); 264 zprop_register_index(ZFS_PROP_VOLMODE, "volmode", 265 ZFS_VOLMODE_DEFAULT, PROP_INHERIT, 266 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, 267 "default | geom | dev | none", "VOLMODE", volmode_table); 268 269 /* inherit index (boolean) properties */ 270 zprop_register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT, 271 ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table); 272 zprop_register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT, 273 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES", 274 boolean_table); 275 zprop_register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT, 276 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC", 277 boolean_table); 278 zprop_register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT, 279 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID", 280 boolean_table); 281 zprop_register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT, 282 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY", 283 boolean_table); 284 zprop_register_index(ZFS_PROP_ZONED, "jailed", 0, PROP_INHERIT, 285 ZFS_TYPE_FILESYSTEM, "on | off", "JAILED", boolean_table); 286 zprop_register_index(ZFS_PROP_XATTR, "xattr", 1, PROP_INHERIT, 287 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "XATTR", 288 boolean_table); 289 zprop_register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT, 290 ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN", 291 boolean_table); 292 zprop_register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT, 293 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND", 294 boolean_table); 295 296 /* default index properties */ 297 zprop_register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT, 298 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 299 "1 | 2 | 3 | 4 | 5 | current", "VERSION", version_table); 300 zprop_register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON, 301 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto", 302 "CANMOUNT", canmount_table); 303 304 /* readonly index (boolean) properties */ 305 zprop_register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY, 306 ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table); 307 zprop_register_index(ZFS_PROP_DEFER_DESTROY, "defer_destroy", 0, 308 PROP_READONLY, ZFS_TYPE_SNAPSHOT, "yes | no", "DEFER_DESTROY", 309 boolean_table); 310 311 /* set once index properties */ 312 zprop_register_index(ZFS_PROP_NORMALIZE, "normalization", 0, 313 PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 314 "none | formC | formD | formKC | formKD", "NORMALIZATION", 315 normalize_table); 316 zprop_register_index(ZFS_PROP_CASE, "casesensitivity", 317 ZFS_CASE_SENSITIVE, PROP_ONETIME, ZFS_TYPE_FILESYSTEM | 318 ZFS_TYPE_SNAPSHOT, 319 "sensitive | insensitive | mixed", "CASE", case_table); 320 321 /* set once index (boolean) properties */ 322 zprop_register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME, 323 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 324 "on | off", "UTF8ONLY", boolean_table); 325 326 /* string properties */ 327 zprop_register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY, 328 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN"); 329 zprop_register_string(ZFS_PROP_CLONES, "clones", NULL, PROP_READONLY, 330 ZFS_TYPE_SNAPSHOT, "<dataset>[,...]", "CLONES"); 331 zprop_register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/", 332 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "<path> | legacy | none", 333 "MOUNTPOINT"); 334 zprop_register_string(ZFS_PROP_SHARENFS, "sharenfs", "off", 335 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "on | off | share(1M) options", 336 "SHARENFS"); 337 zprop_register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY, 338 ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, 339 "filesystem | volume | snapshot | bookmark", "TYPE"); 340 zprop_register_string(ZFS_PROP_SHARESMB, "sharesmb", "off", 341 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 342 "on | off | sharemgr(1M) options", "SHARESMB"); 343 zprop_register_string(ZFS_PROP_MLSLABEL, "mlslabel", 344 ZFS_MLSLABEL_DEFAULT, PROP_INHERIT, ZFS_TYPE_DATASET, 345 "<sensitivity label>", "MLSLABEL"); 346 347 /* readonly number properties */ 348 zprop_register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY, 349 ZFS_TYPE_DATASET, "<size>", "USED"); 350 zprop_register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY, 351 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL"); 352 zprop_register_number(ZFS_PROP_REFERENCED, "referenced", 0, 353 PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "REFER"); 354 zprop_register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0, 355 PROP_READONLY, ZFS_TYPE_DATASET, 356 "<1.00x or higher if compressed>", "RATIO"); 357 zprop_register_number(ZFS_PROP_REFRATIO, "refcompressratio", 0, 358 PROP_READONLY, ZFS_TYPE_DATASET, 359 "<1.00x or higher if compressed>", "REFRATIO"); 360 zprop_register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize", 361 ZVOL_DEFAULT_BLOCKSIZE, PROP_ONETIME, 362 ZFS_TYPE_VOLUME, "512 to 128k, power of 2", "VOLBLOCK"); 363 zprop_register_number(ZFS_PROP_USEDSNAP, "usedbysnapshots", 0, 364 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 365 "USEDSNAP"); 366 zprop_register_number(ZFS_PROP_USEDDS, "usedbydataset", 0, 367 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 368 "USEDDS"); 369 zprop_register_number(ZFS_PROP_USEDCHILD, "usedbychildren", 0, 370 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 371 "USEDCHILD"); 372 zprop_register_number(ZFS_PROP_USEDREFRESERV, "usedbyrefreservation", 0, 373 PROP_READONLY, 374 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDREFRESERV"); 375 zprop_register_number(ZFS_PROP_USERREFS, "userrefs", 0, PROP_READONLY, 376 ZFS_TYPE_SNAPSHOT, "<count>", "USERREFS"); 377 zprop_register_number(ZFS_PROP_WRITTEN, "written", 0, PROP_READONLY, 378 ZFS_TYPE_DATASET, "<size>", "WRITTEN"); 379 zprop_register_number(ZFS_PROP_LOGICALUSED, "logicalused", 0, 380 PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "LUSED"); 381 zprop_register_number(ZFS_PROP_LOGICALREFERENCED, "logicalreferenced", 382 0, PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "LREFER"); 383 384 /* default number properties */ 385 zprop_register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT, 386 ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA"); 387 zprop_register_number(ZFS_PROP_RESERVATION, "reservation", 0, 388 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 389 "<size> | none", "RESERV"); 390 zprop_register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT, 391 ZFS_TYPE_VOLUME, "<size>", "VOLSIZE"); 392 zprop_register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT, 393 ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA"); 394 zprop_register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0, 395 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 396 "<size> | none", "REFRESERV"); 397 zprop_register_number(ZFS_PROP_FILESYSTEM_LIMIT, "filesystem_limit", 398 UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, 399 "<count> | none", "FSLIMIT"); 400 zprop_register_number(ZFS_PROP_SNAPSHOT_LIMIT, "snapshot_limit", 401 UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 402 "<count> | none", "SSLIMIT"); 403 zprop_register_number(ZFS_PROP_FILESYSTEM_COUNT, "filesystem_count", 404 UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, 405 "<count>", "FSCOUNT"); 406 zprop_register_number(ZFS_PROP_SNAPSHOT_COUNT, "snapshot_count", 407 UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 408 "<count>", "SSCOUNT"); 409 410 /* inherit number properties */ 411 zprop_register_number(ZFS_PROP_RECORDSIZE, "recordsize", 412 SPA_OLD_MAXBLOCKSIZE, PROP_INHERIT, 413 ZFS_TYPE_FILESYSTEM, "512 to 1M, power of 2", "RECSIZE"); 414 415 /* hidden properties */ 416 zprop_register_hidden(ZFS_PROP_CREATETXG, "createtxg", PROP_TYPE_NUMBER, 417 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "CREATETXG"); 418 zprop_register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER, 419 PROP_READONLY, ZFS_TYPE_SNAPSHOT, "NUMCLONES"); 420 zprop_register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING, 421 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "NAME"); 422 zprop_register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions", 423 PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS"); 424 zprop_register_hidden(ZFS_PROP_STMF_SHAREINFO, "stmf_sbd_lu", 425 PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, 426 "STMF_SBD_LU"); 427 zprop_register_hidden(ZFS_PROP_GUID, "guid", PROP_TYPE_NUMBER, 428 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "GUID"); 429 zprop_register_hidden(ZFS_PROP_USERACCOUNTING, "useraccounting", 430 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, 431 "USERACCOUNTING"); 432 zprop_register_hidden(ZFS_PROP_UNIQUE, "unique", PROP_TYPE_NUMBER, 433 PROP_READONLY, ZFS_TYPE_DATASET, "UNIQUE"); 434 zprop_register_hidden(ZFS_PROP_OBJSETID, "objsetid", PROP_TYPE_NUMBER, 435 PROP_READONLY, ZFS_TYPE_DATASET, "OBJSETID"); 436 zprop_register_hidden(ZFS_PROP_INCONSISTENT, "inconsistent", 437 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, "INCONSISTENT"); 438 zprop_register_hidden(ZFS_PROP_PREV_SNAP, "prevsnap", PROP_TYPE_STRING, 439 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "PREVSNAP"); 440 441 /* oddball properties */ 442 zprop_register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0, 443 NULL, PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, 444 "<date>", "CREATION", B_FALSE, B_TRUE, NULL); 445} 446 447boolean_t 448zfs_prop_delegatable(zfs_prop_t prop) 449{ 450 zprop_desc_t *pd = &zfs_prop_table[prop]; 451 452 /* The mlslabel property is never delegatable. */ 453 if (prop == ZFS_PROP_MLSLABEL) 454 return (B_FALSE); 455 456 return (pd->pd_attr != PROP_READONLY); 457} 458 459/* 460 * Given a zfs dataset property name, returns the corresponding property ID. 461 */ 462zfs_prop_t 463zfs_name_to_prop(const char *propname) 464{ 465 return (zprop_name_to_prop(propname, ZFS_TYPE_DATASET)); 466} 467 468/* 469 * For user property names, we allow all lowercase alphanumeric characters, plus 470 * a few useful punctuation characters. 471 */ 472static int 473valid_char(char c) 474{ 475 return ((c >= 'a' && c <= 'z') || 476 (c >= '0' && c <= '9') || 477 c == '-' || c == '_' || c == '.' || c == ':'); 478} 479 480/* 481 * Returns true if this is a valid user-defined property (one with a ':'). 482 */ 483boolean_t 484zfs_prop_user(const char *name) 485{ 486 int i; 487 char c; 488 boolean_t foundsep = B_FALSE; 489 490 for (i = 0; i < strlen(name); i++) { 491 c = name[i]; 492 if (!valid_char(c)) 493 return (B_FALSE); 494 if (c == ':') 495 foundsep = B_TRUE; 496 } 497 498 if (!foundsep) 499 return (B_FALSE); 500 501 return (B_TRUE); 502} 503 504/* 505 * Returns true if this is a valid userspace-type property (one with a '@'). 506 * Note that after the @, any character is valid (eg, another @, for SID 507 * user@domain). 508 */ 509boolean_t 510zfs_prop_userquota(const char *name) 511{ 512 zfs_userquota_prop_t prop; 513 514 for (prop = 0; prop < ZFS_NUM_USERQUOTA_PROPS; prop++) { 515 if (strncmp(name, zfs_userquota_prop_prefixes[prop], 516 strlen(zfs_userquota_prop_prefixes[prop])) == 0) { 517 return (B_TRUE); 518 } 519 } 520 521 return (B_FALSE); 522} 523 524/* 525 * Returns true if this is a valid written@ property. 526 * Note that after the @, any character is valid (eg, another @, for 527 * written@pool/fs@origin). 528 */ 529boolean_t 530zfs_prop_written(const char *name) 531{ 532 static const char *prefix = "written@"; 533 return (strncmp(name, prefix, strlen(prefix)) == 0); 534} 535 536/* 537 * Tables of index types, plus functions to convert between the user view 538 * (strings) and internal representation (uint64_t). 539 */ 540int 541zfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index) 542{ 543 return (zprop_string_to_index(prop, string, index, ZFS_TYPE_DATASET)); 544} 545 546int 547zfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string) 548{ 549 return (zprop_index_to_string(prop, index, string, ZFS_TYPE_DATASET)); 550} 551 552uint64_t 553zfs_prop_random_value(zfs_prop_t prop, uint64_t seed) 554{ 555 return (zprop_random_value(prop, seed, ZFS_TYPE_DATASET)); 556} 557 558/* 559 * Returns TRUE if the property applies to any of the given dataset types. 560 */ 561boolean_t 562zfs_prop_valid_for_type(int prop, zfs_type_t types) 563{ 564 return (zprop_valid_for_type(prop, types)); 565} 566 567zprop_type_t 568zfs_prop_get_type(zfs_prop_t prop) 569{ 570 return (zfs_prop_table[prop].pd_proptype); 571} 572 573/* 574 * Returns TRUE if the property is readonly. 575 */ 576boolean_t 577zfs_prop_readonly(zfs_prop_t prop) 578{ 579 return (zfs_prop_table[prop].pd_attr == PROP_READONLY || 580 zfs_prop_table[prop].pd_attr == PROP_ONETIME); 581} 582 583/* 584 * Returns TRUE if the property is only allowed to be set once. 585 */ 586boolean_t 587zfs_prop_setonce(zfs_prop_t prop) 588{ 589 return (zfs_prop_table[prop].pd_attr == PROP_ONETIME); 590} 591 592const char * 593zfs_prop_default_string(zfs_prop_t prop) 594{ 595 return (zfs_prop_table[prop].pd_strdefault); 596} 597 598uint64_t 599zfs_prop_default_numeric(zfs_prop_t prop) 600{ 601 return (zfs_prop_table[prop].pd_numdefault); 602} 603 604/* 605 * Given a dataset property ID, returns the corresponding name. 606 * Assuming the zfs dataset property ID is valid. 607 */ 608const char * 609zfs_prop_to_name(zfs_prop_t prop) 610{ 611 return (zfs_prop_table[prop].pd_name); 612} 613 614/* 615 * Returns TRUE if the property is inheritable. 616 */ 617boolean_t 618zfs_prop_inheritable(zfs_prop_t prop) 619{ 620 return (zfs_prop_table[prop].pd_attr == PROP_INHERIT || 621 zfs_prop_table[prop].pd_attr == PROP_ONETIME); 622} 623 624#ifndef _KERNEL 625 626/* 627 * Returns a string describing the set of acceptable values for the given 628 * zfs property, or NULL if it cannot be set. 629 */ 630const char * 631zfs_prop_values(zfs_prop_t prop) 632{ 633 return (zfs_prop_table[prop].pd_values); 634} 635 636/* 637 * Returns TRUE if this property is a string type. Note that index types 638 * (compression, checksum) are treated as strings in userland, even though they 639 * are stored numerically on disk. 640 */ 641int 642zfs_prop_is_string(zfs_prop_t prop) 643{ 644 return (zfs_prop_table[prop].pd_proptype == PROP_TYPE_STRING || 645 zfs_prop_table[prop].pd_proptype == PROP_TYPE_INDEX); 646} 647 648/* 649 * Returns the column header for the given property. Used only in 650 * 'zfs list -o', but centralized here with the other property information. 651 */ 652const char * 653zfs_prop_column_name(zfs_prop_t prop) 654{ 655 return (zfs_prop_table[prop].pd_colname); 656} 657 658/* 659 * Returns whether the given property should be displayed right-justified for 660 * 'zfs list'. 661 */ 662boolean_t 663zfs_prop_align_right(zfs_prop_t prop) 664{ 665 return (zfs_prop_table[prop].pd_rightalign); 666} 667 668#endif 669