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