module/zcommon/zfs_prop.c

   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  */
  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 #include "zfs_fletcher.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
  48 static 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 */
  51 const char *zfs_userquota_prop_prefixes[] = {
  52         "userused@",
  53         "userquota@",
  54         "groupused@",
  55         "groupquota@",
  56         "userobjused@",
  57         "userobjquota@",
  58         "groupobjused@",
  59         "groupobjquota@"
  60 };
  61
  62 zprop_desc_t *
  63 zfs_prop_get_table(void)
  64 {
  65         return (zfs_prop_table);
  66 }
  67
  68 void
  69 zfs_prop_init(void)
  70 {
  71         static zprop_index_t checksum_table[] = {
  72                 { "on",         ZIO_CHECKSUM_ON },
  73                 { "off",        ZIO_CHECKSUM_OFF },
  74                 { "fletcher2",  ZIO_CHECKSUM_FLETCHER_2 },
  75                 { "fletcher4",  ZIO_CHECKSUM_FLETCHER_4 },
  76                 { "sha256",     ZIO_CHECKSUM_SHA256 },
  77                 { "noparity",   ZIO_CHECKSUM_NOPARITY },
  78                 { "sha512",     ZIO_CHECKSUM_SHA512 },
  79                 { "skein",      ZIO_CHECKSUM_SKEIN },
  80                 { "edonr",      ZIO_CHECKSUM_EDONR },
  81                 { NULL }
  82         };
  83
  84         static zprop_index_t dedup_table[] = {
  85                 { "on",         ZIO_CHECKSUM_ON },
  86                 { "off",        ZIO_CHECKSUM_OFF },
  87                 { "verify",     ZIO_CHECKSUM_ON | ZIO_CHECKSUM_VERIFY },
  88                 { "sha256",     ZIO_CHECKSUM_SHA256 },
  89                 { "sha256,verify",
  90                                 ZIO_CHECKSUM_SHA256 | ZIO_CHECKSUM_VERIFY },
  91                 { "sha512",     ZIO_CHECKSUM_SHA512 },
  92                 { "sha512,verify",
  93                                 ZIO_CHECKSUM_SHA512 | ZIO_CHECKSUM_VERIFY },
  94                 { "skein",      ZIO_CHECKSUM_SKEIN },
  95                 { "skein,verify",
  96                                 ZIO_CHECKSUM_SKEIN | ZIO_CHECKSUM_VERIFY },
  97                 { "edonr,verify",
  98                                 ZIO_CHECKSUM_EDONR | ZIO_CHECKSUM_VERIFY },
  99                 { NULL }
 100         };
 101
 102         static zprop_index_t compress_table[] = {
 103                 { "on",         ZIO_COMPRESS_ON },
 104                 { "off",        ZIO_COMPRESS_OFF },
 105                 { "lzjb",       ZIO_COMPRESS_LZJB },
 106                 { "gzip",       ZIO_COMPRESS_GZIP_6 },  /* gzip default */
 107                 { "gzip-1",     ZIO_COMPRESS_GZIP_1 },
 108                 { "gzip-2",     ZIO_COMPRESS_GZIP_2 },
 109                 { "gzip-3",     ZIO_COMPRESS_GZIP_3 },
 110                 { "gzip-4",     ZIO_COMPRESS_GZIP_4 },
 111                 { "gzip-5",     ZIO_COMPRESS_GZIP_5 },
 112                 { "gzip-6",     ZIO_COMPRESS_GZIP_6 },
 113                 { "gzip-7",     ZIO_COMPRESS_GZIP_7 },
 114                 { "gzip-8",     ZIO_COMPRESS_GZIP_8 },
 115                 { "gzip-9",     ZIO_COMPRESS_GZIP_9 },
 116                 { "zle",        ZIO_COMPRESS_ZLE },
 117                 { "lz4",        ZIO_COMPRESS_LZ4 },
 118                 { NULL }
 119         };
 120
 121         static zprop_index_t snapdir_table[] = {
 122                 { "hidden",     ZFS_SNAPDIR_HIDDEN },
 123                 { "visible",    ZFS_SNAPDIR_VISIBLE },
 124                 { NULL }
 125         };
 126
 127         static zprop_index_t snapdev_table[] = {
 128                 { "hidden",     ZFS_SNAPDEV_HIDDEN },
 129                 { "visible",    ZFS_SNAPDEV_VISIBLE },
 130                 { NULL }
 131         };
 132
 133         static zprop_index_t acltype_table[] = {
 134                 { "off",        ZFS_ACLTYPE_OFF },
 135                 { "disabled",   ZFS_ACLTYPE_OFF },
 136                 { "noacl",      ZFS_ACLTYPE_OFF },
 137                 { "posixacl",   ZFS_ACLTYPE_POSIXACL },
 138                 { NULL }
 139         };
 140
 141         static zprop_index_t acl_inherit_table[] = {
 142                 { "discard",    ZFS_ACL_DISCARD },
 143                 { "noallow",    ZFS_ACL_NOALLOW },
 144                 { "restricted", ZFS_ACL_RESTRICTED },
 145                 { "passthrough", ZFS_ACL_PASSTHROUGH },
 146                 { "secure",     ZFS_ACL_RESTRICTED }, /* bkwrd compatability */
 147                 { "passthrough-x", ZFS_ACL_PASSTHROUGH_X },
 148                 { NULL }
 149         };
 150
 151         static zprop_index_t case_table[] = {
 152                 { "sensitive",          ZFS_CASE_SENSITIVE },
 153                 { "insensitive",        ZFS_CASE_INSENSITIVE },
 154                 { "mixed",              ZFS_CASE_MIXED },
 155                 { NULL }
 156         };
 157
 158         static zprop_index_t copies_table[] = {
 159                 { "1",          1 },
 160                 { "2",          2 },
 161                 { "3",          3 },
 162                 { NULL }
 163         };
 164
 165         /*
 166          * Use the unique flags we have to send to u8_strcmp() and/or
 167          * u8_textprep() to represent the various normalization property
 168          * values.
 169          */
 170         static zprop_index_t normalize_table[] = {
 171                 { "none",       0 },
 172                 { "formD",      U8_TEXTPREP_NFD },
 173                 { "formKC",     U8_TEXTPREP_NFKC },
 174                 { "formC",      U8_TEXTPREP_NFC },
 175                 { "formKD",     U8_TEXTPREP_NFKD },
 176                 { NULL }
 177         };
 178
 179         static zprop_index_t version_table[] = {
 180                 { "1",          1 },
 181                 { "2",          2 },
 182                 { "3",          3 },
 183                 { "4",          4 },
 184                 { "5",          5 },
 185                 { "current",    ZPL_VERSION },
 186                 { NULL }
 187         };
 188
 189         static zprop_index_t boolean_table[] = {
 190                 { "off",        0 },
 191                 { "on",         1 },
 192                 { NULL }
 193         };
 194
 195         static zprop_index_t logbias_table[] = {
 196                 { "latency",    ZFS_LOGBIAS_LATENCY },
 197                 { "throughput", ZFS_LOGBIAS_THROUGHPUT },
 198                 { NULL }
 199         };
 200
 201         static zprop_index_t canmount_table[] = {
 202                 { "off",        ZFS_CANMOUNT_OFF },
 203                 { "on",         ZFS_CANMOUNT_ON },
 204                 { "noauto",     ZFS_CANMOUNT_NOAUTO },
 205                 { NULL }
 206         };
 207
 208         static zprop_index_t cache_table[] = {
 209                 { "none",       ZFS_CACHE_NONE },
 210                 { "metadata",   ZFS_CACHE_METADATA },
 211                 { "all",        ZFS_CACHE_ALL },
 212                 { NULL }
 213         };
 214
 215         static zprop_index_t sync_table[] = {
 216                 { "standard",   ZFS_SYNC_STANDARD },
 217                 { "always",     ZFS_SYNC_ALWAYS },
 218                 { "disabled",   ZFS_SYNC_DISABLED },
 219                 { NULL }
 220         };
 221
 222         static zprop_index_t xattr_table[] = {
 223                 { "off",        ZFS_XATTR_OFF },
 224                 { "on",         ZFS_XATTR_DIR },
 225                 { "sa",         ZFS_XATTR_SA },
 226                 { "dir",        ZFS_XATTR_DIR },
 227                 { NULL }
 228         };
 229
 230         static zprop_index_t dnsize_table[] = {
 231                 { "legacy",     ZFS_DNSIZE_LEGACY },
 232                 { "auto",       ZFS_DNSIZE_AUTO },
 233                 { "1k",         ZFS_DNSIZE_1K },
 234                 { "2k",         ZFS_DNSIZE_2K },
 235                 { "4k",         ZFS_DNSIZE_4K },
 236                 { "8k",         ZFS_DNSIZE_8K },
 237                 { "16k",        ZFS_DNSIZE_16K },
 238                 { NULL }
 239         };
 240
 241         static zprop_index_t redundant_metadata_table[] = {
 242                 { "all",        ZFS_REDUNDANT_METADATA_ALL },
 243                 { "most",       ZFS_REDUNDANT_METADATA_MOST },
 244                 { NULL }
 245         };
 246
 247         /* inherit index properties */
 248         zprop_register_index(ZFS_PROP_REDUNDANT_METADATA, "redundant_metadata",
 249             ZFS_REDUNDANT_METADATA_ALL,
 250             PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
 251             "all | most", "REDUND_MD",
 252             redundant_metadata_table);
 253         zprop_register_index(ZFS_PROP_SYNC, "sync", ZFS_SYNC_STANDARD,
 254             PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
 255             "standard | always | disabled", "SYNC",
 256             sync_table);
 257         zprop_register_index(ZFS_PROP_CHECKSUM, "checksum",
 258             ZIO_CHECKSUM_DEFAULT, PROP_INHERIT, ZFS_TYPE_FILESYSTEM |
 259             ZFS_TYPE_VOLUME,
 260             "on | off | fletcher2 | fletcher4 | sha256 | sha512 | "
 261             "skein | edonr", "CHECKSUM", checksum_table);
 262         zprop_register_index(ZFS_PROP_DEDUP, "dedup", ZIO_CHECKSUM_OFF,
 263             PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
 264             "on | off | verify | sha256[,verify], sha512[,verify], "
 265             "skein[,verify], edonr,verify", "DEDUP", dedup_table);
 266         zprop_register_index(ZFS_PROP_COMPRESSION, "compression",
 267             ZIO_COMPRESS_DEFAULT, PROP_INHERIT,
 268             ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
 269             "on | off | lzjb | gzip | gzip-[1-9] | zle | lz4", "COMPRESS",
 270             compress_table);
 271         zprop_register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN,
 272             PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
 273             "hidden | visible", "SNAPDIR", snapdir_table);
 274         zprop_register_index(ZFS_PROP_SNAPDEV, "snapdev", ZFS_SNAPDEV_HIDDEN,
 275             PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
 276             "hidden | visible", "SNAPDEV", snapdev_table);
 277         zprop_register_index(ZFS_PROP_ACLTYPE, "acltype", ZFS_ACLTYPE_OFF,
 278             PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
 279             "noacl | posixacl", "ACLTYPE", acltype_table);
 280         zprop_register_index(ZFS_PROP_ACLINHERIT, "aclinherit",
 281             ZFS_ACL_RESTRICTED, PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
 282             "discard | noallow | restricted | passthrough | passthrough-x",
 283             "ACLINHERIT", acl_inherit_table);
 284         zprop_register_index(ZFS_PROP_COPIES, "copies", 1, PROP_INHERIT,
 285             ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
 286             "1 | 2 | 3", "COPIES", copies_table);
 287         zprop_register_index(ZFS_PROP_PRIMARYCACHE, "primarycache",
 288             ZFS_CACHE_ALL, PROP_INHERIT,
 289             ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
 290             "all | none | metadata", "PRIMARYCACHE", cache_table);
 291         zprop_register_index(ZFS_PROP_SECONDARYCACHE, "secondarycache",
 292             ZFS_CACHE_ALL, PROP_INHERIT,
 293             ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME,
 294             "all | none | metadata", "SECONDARYCACHE", cache_table);
 295         zprop_register_index(ZFS_PROP_LOGBIAS, "logbias", ZFS_LOGBIAS_LATENCY,
 296             PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
 297             "latency | throughput", "LOGBIAS", logbias_table);
 298         zprop_register_index(ZFS_PROP_XATTR, "xattr", ZFS_XATTR_DIR,
 299             PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
 300             "on | off | dir | sa", "XATTR", xattr_table);
 301         zprop_register_index(ZFS_PROP_DNODESIZE, "dnodesize",
 302             ZFS_DNSIZE_LEGACY, PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
 303             "legacy | auto | 1k | 2k | 4k | 8k | 16k", "DNSIZE", dnsize_table);
 304
 305         /* inherit index (boolean) properties */
 306         zprop_register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT,
 307             ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table);
 308         zprop_register_index(ZFS_PROP_RELATIME, "relatime", 0, PROP_INHERIT,
 309             ZFS_TYPE_FILESYSTEM, "on | off", "RELATIME", boolean_table);
 310         zprop_register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT,
 311             ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES",
 312             boolean_table);
 313         zprop_register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT,
 314             ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC",
 315             boolean_table);
 316         zprop_register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT,
 317             ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID",
 318             boolean_table);
 319         zprop_register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT,
 320             ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY",
 321             boolean_table);
 322         zprop_register_index(ZFS_PROP_ZONED, "zoned", 0, PROP_INHERIT,
 323             ZFS_TYPE_FILESYSTEM, "on | off", "ZONED", boolean_table);
 324         zprop_register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT,
 325             ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN", boolean_table);
 326         zprop_register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT,
 327             ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND",
 328             boolean_table);
 329         zprop_register_index(ZFS_PROP_OVERLAY, "overlay", 0, PROP_INHERIT,
 330             ZFS_TYPE_FILESYSTEM, "on | off", "OVERLAY", boolean_table);
 331
 332         /* default index properties */
 333         zprop_register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT,
 334             ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
 335             "1 | 2 | 3 | 4 | 5 | current", "VERSION", version_table);
 336         zprop_register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON,
 337             PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto",
 338             "CANMOUNT", canmount_table);
 339
 340         /* readonly index (boolean) properties */
 341         zprop_register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY,
 342             ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table);
 343         zprop_register_index(ZFS_PROP_DEFER_DESTROY, "defer_destroy", 0,
 344             PROP_READONLY, ZFS_TYPE_SNAPSHOT, "yes | no", "DEFER_DESTROY",
 345             boolean_table);
 346
 347         /* set once index properties */
 348         zprop_register_index(ZFS_PROP_NORMALIZE, "normalization", 0,
 349             PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
 350             "none | formC | formD | formKC | formKD", "NORMALIZATION",
 351             normalize_table);
 352         zprop_register_index(ZFS_PROP_CASE, "casesensitivity",
 353             ZFS_CASE_SENSITIVE, PROP_ONETIME, ZFS_TYPE_FILESYSTEM |
 354             ZFS_TYPE_SNAPSHOT,
 355             "sensitive | insensitive | mixed", "CASE", case_table);
 356
 357         /* set once index (boolean) properties */
 358         zprop_register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME,
 359             ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT,
 360             "on | off", "UTF8ONLY", boolean_table);
 361
 362         /* string properties */
 363         zprop_register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY,
 364             ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN");
 365         zprop_register_string(ZFS_PROP_CLONES, "clones", NULL, PROP_READONLY,
 366             ZFS_TYPE_SNAPSHOT, "<dataset>[,...]", "CLONES");
 367         zprop_register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/",
 368             PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "<path> | legacy | none",
 369             "MOUNTPOINT");
 370         zprop_register_string(ZFS_PROP_SHARENFS, "sharenfs", "off",
 371             PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "on | off | share(1M) options",
 372             "SHARENFS");
 373         zprop_register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY,
 374             ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK,
 375             "filesystem | volume | snapshot | bookmark", "TYPE");
 376         zprop_register_string(ZFS_PROP_SHARESMB, "sharesmb", "off",
 377             PROP_INHERIT, ZFS_TYPE_FILESYSTEM,
 378             "on | off | sharemgr(1M) options", "SHARESMB");
 379         zprop_register_string(ZFS_PROP_MLSLABEL, "mlslabel",
 380             ZFS_MLSLABEL_DEFAULT, PROP_INHERIT, ZFS_TYPE_DATASET,
 381             "<sensitivity label>", "MLSLABEL");
 382         zprop_register_string(ZFS_PROP_SELINUX_CONTEXT, "context",
 383             "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux context>",
 384             "CONTEXT");
 385         zprop_register_string(ZFS_PROP_SELINUX_FSCONTEXT, "fscontext",
 386             "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux fscontext>",
 387             "FSCONTEXT");
 388         zprop_register_string(ZFS_PROP_SELINUX_DEFCONTEXT, "defcontext",
 389             "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux defcontext>",
 390             "DEFCONTEXT");
 391         zprop_register_string(ZFS_PROP_SELINUX_ROOTCONTEXT, "rootcontext",
 392             "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux rootcontext>",
 393             "ROOTCONTEXT");
 394         zprop_register_string(ZFS_PROP_RECEIVE_RESUME_TOKEN,
 395             "receive_resume_token",
 396             NULL, PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
 397             "<string token>", "RESUMETOK");
 398
 399         /* readonly number properties */
 400         zprop_register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY,
 401             ZFS_TYPE_DATASET, "<size>", "USED");
 402         zprop_register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY,
 403             ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL");
 404         zprop_register_number(ZFS_PROP_REFERENCED, "referenced", 0,
 405             PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "REFER");
 406         zprop_register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0,
 407             PROP_READONLY, ZFS_TYPE_DATASET,
 408             "<1.00x or higher if compressed>", "RATIO");
 409         zprop_register_number(ZFS_PROP_REFRATIO, "refcompressratio", 0,
 410             PROP_READONLY, ZFS_TYPE_DATASET,
 411             "<1.00x or higher if compressed>", "REFRATIO");
 412         zprop_register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize",
 413             ZVOL_DEFAULT_BLOCKSIZE, PROP_ONETIME,
 414             ZFS_TYPE_VOLUME, "512 to 128k, power of 2", "VOLBLOCK");
 415         zprop_register_number(ZFS_PROP_USEDSNAP, "usedbysnapshots", 0,
 416             PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
 417             "USEDSNAP");
 418         zprop_register_number(ZFS_PROP_USEDDS, "usedbydataset", 0,
 419             PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
 420             "USEDDS");
 421         zprop_register_number(ZFS_PROP_USEDCHILD, "usedbychildren", 0,
 422             PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>",
 423             "USEDCHILD");
 424         zprop_register_number(ZFS_PROP_USEDREFRESERV, "usedbyrefreservation", 0,
 425             PROP_READONLY,
 426             ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDREFRESERV");
 427         zprop_register_number(ZFS_PROP_USERREFS, "userrefs", 0, PROP_READONLY,
 428             ZFS_TYPE_SNAPSHOT, "<count>", "USERREFS");
 429         zprop_register_number(ZFS_PROP_WRITTEN, "written", 0, PROP_READONLY,
 430             ZFS_TYPE_DATASET, "<size>", "WRITTEN");
 431         zprop_register_number(ZFS_PROP_LOGICALUSED, "logicalused", 0,
 432             PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "LUSED");
 433         zprop_register_number(ZFS_PROP_LOGICALREFERENCED, "logicalreferenced",
 434             0, PROP_READONLY, ZFS_TYPE_DATASET, "<size>", "LREFER");
 435
 436         /* default number properties */
 437         zprop_register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT,
 438             ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA");
 439         zprop_register_number(ZFS_PROP_RESERVATION, "reservation", 0,
 440             PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
 441             "<size> | none", "RESERV");
 442         zprop_register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT,
 443             ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, "<size>", "VOLSIZE");
 444         zprop_register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT,
 445             ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA");
 446         zprop_register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0,
 447             PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
 448             "<size> | none", "REFRESERV");
 449         zprop_register_number(ZFS_PROP_FILESYSTEM_LIMIT, "filesystem_limit",
 450             UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM,
 451             "<count> | none", "FSLIMIT");
 452         zprop_register_number(ZFS_PROP_SNAPSHOT_LIMIT, "snapshot_limit",
 453             UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
 454             "<count> | none", "SSLIMIT");
 455         zprop_register_number(ZFS_PROP_FILESYSTEM_COUNT, "filesystem_count",
 456             UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM,
 457             "<count>", "FSCOUNT");
 458         zprop_register_number(ZFS_PROP_SNAPSHOT_COUNT, "snapshot_count",
 459             UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME,
 460             "<count>", "SSCOUNT");
 461
 462         /* inherit number properties */
 463         zprop_register_number(ZFS_PROP_RECORDSIZE, "recordsize",
 464             SPA_OLD_MAXBLOCKSIZE, PROP_INHERIT,
 465             ZFS_TYPE_FILESYSTEM, "512 to 1M, power of 2", "RECSIZE");
 466
 467         /* hidden properties */
 468         zprop_register_hidden(ZFS_PROP_CREATETXG, "createtxg", PROP_TYPE_NUMBER,
 469             PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "CREATETXG");
 470         zprop_register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER,
 471             PROP_READONLY, ZFS_TYPE_SNAPSHOT, "NUMCLONES");
 472         zprop_register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING,
 473             PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "NAME");
 474         zprop_register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions",
 475             PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS");
 476         zprop_register_hidden(ZFS_PROP_STMF_SHAREINFO, "stmf_sbd_lu",
 477             PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME,
 478             "STMF_SBD_LU");
 479         zprop_register_hidden(ZFS_PROP_GUID, "guid", PROP_TYPE_NUMBER,
 480             PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "GUID");
 481         zprop_register_hidden(ZFS_PROP_USERACCOUNTING, "useraccounting",
 482             PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET,
 483             "USERACCOUNTING");
 484         zprop_register_hidden(ZFS_PROP_UNIQUE, "unique", PROP_TYPE_NUMBER,
 485             PROP_READONLY, ZFS_TYPE_DATASET, "UNIQUE");
 486         zprop_register_hidden(ZFS_PROP_OBJSETID, "objsetid", PROP_TYPE_NUMBER,
 487             PROP_READONLY, ZFS_TYPE_DATASET, "OBJSETID");
 488         zprop_register_hidden(ZFS_PROP_INCONSISTENT, "inconsistent",
 489             PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, "INCONSISTENT");
 490         zprop_register_hidden(ZFS_PROP_PREV_SNAP, "prevsnap", PROP_TYPE_STRING,
 491             PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "PREVSNAP");
 492
 493         /*
 494          * Property to be removed once libbe is integrated
 495          */
 496         zprop_register_hidden(ZFS_PROP_PRIVATE, "priv_prop",
 497             PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_FILESYSTEM,
 498             "PRIV_PROP");
 499
 500         /* oddball properties */
 501         zprop_register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0,
 502             NULL, PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK,
 503             "<date>", "CREATION", B_FALSE, B_TRUE, NULL);
 504 }
 505
 506 boolean_t
 507 zfs_prop_delegatable(zfs_prop_t prop)
 508 {
 509         zprop_desc_t *pd = &zfs_prop_table[prop];
 510
 511         /* The mlslabel property is never delegatable. */
 512         if (prop == ZFS_PROP_MLSLABEL)
 513                 return (B_FALSE);
 514
 515         return (pd->pd_attr != PROP_READONLY);
 516 }
 517
 518 /*
 519  * Given a zfs dataset property name, returns the corresponding property ID.
 520  */
 521 zfs_prop_t
 522 zfs_name_to_prop(const char *propname)
 523 {
 524         return (zprop_name_to_prop(propname, ZFS_TYPE_DATASET));
 525 }
 526
 527 /*
 528  * For user property names, we allow all lowercase alphanumeric characters, plus
 529  * a few useful punctuation characters.
 530  */
 531 static int
 532 valid_char(char c)
 533 {
 534         return ((c >= 'a' && c <= 'z') ||
 535             (c >= '0' && c <= '9') ||
 536             c == '-' || c == '_' || c == '.' || c == ':');
 537 }
 538
 539 /*
 540  * Returns true if this is a valid user-defined property (one with a ':').
 541  */
 542 boolean_t
 543 zfs_prop_user(const char *name)
 544 {
 545         int i;
 546         char c;
 547         boolean_t foundsep = B_FALSE;
 548
 549         for (i = 0; i < strlen(name); i++) {
 550                 c = name[i];
 551                 if (!valid_char(c))
 552                         return (B_FALSE);
 553                 if (c == ':')
 554                         foundsep = B_TRUE;
 555         }
 556
 557         if (!foundsep)
 558                 return (B_FALSE);
 559
 560         return (B_TRUE);
 561 }
 562
 563 /*
 564  * Returns true if this is a valid userspace-type property (one with a '@').
 565  * Note that after the @, any character is valid (eg, another @, for SID
 566  * user@domain).
 567  */
 568 boolean_t
 569 zfs_prop_userquota(const char *name)
 570 {
 571         zfs_userquota_prop_t prop;
 572
 573         for (prop = 0; prop < ZFS_NUM_USERQUOTA_PROPS; prop++) {
 574                 if (strncmp(name, zfs_userquota_prop_prefixes[prop],
 575                     strlen(zfs_userquota_prop_prefixes[prop])) == 0) {
 576                         return (B_TRUE);
 577                 }
 578         }
 579
 580         return (B_FALSE);
 581 }
 582
 583 /*
 584  * Returns true if this is a valid written@ property.
 585  * Note that after the @, any character is valid (eg, another @, for
 586  * written@pool/fs@origin).
 587  */
 588 boolean_t
 589 zfs_prop_written(const char *name)
 590 {
 591         static const char *prefix = "written@";
 592         return (strncmp(name, prefix, strlen(prefix)) == 0);
 593 }
 594
 595 /*
 596  * Tables of index types, plus functions to convert between the user view
 597  * (strings) and internal representation (uint64_t).
 598  */
 599 int
 600 zfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index)
 601 {
 602         return (zprop_string_to_index(prop, string, index, ZFS_TYPE_DATASET));
 603 }
 604
 605 int
 606 zfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string)
 607 {
 608         return (zprop_index_to_string(prop, index, string, ZFS_TYPE_DATASET));
 609 }
 610
 611 uint64_t
 612 zfs_prop_random_value(zfs_prop_t prop, uint64_t seed)
 613 {
 614         return (zprop_random_value(prop, seed, ZFS_TYPE_DATASET));
 615 }
 616
 617 /*
 618  * Returns TRUE if the property applies to any of the given dataset types.
 619  */
 620 boolean_t
 621 zfs_prop_valid_for_type(int prop, zfs_type_t types, boolean_t headcheck)
 622 {
 623         return (zprop_valid_for_type(prop, types, headcheck));
 624 }
 625
 626 zprop_type_t
 627 zfs_prop_get_type(zfs_prop_t prop)
 628 {
 629         return (zfs_prop_table[prop].pd_proptype);
 630 }
 631
 632 /*
 633  * Returns TRUE if the property is readonly.
 634  */
 635 boolean_t
 636 zfs_prop_readonly(zfs_prop_t prop)
 637 {
 638         return (zfs_prop_table[prop].pd_attr == PROP_READONLY ||
 639             zfs_prop_table[prop].pd_attr == PROP_ONETIME);
 640 }
 641
 642 /*
 643  * Returns TRUE if the property is only allowed to be set once.
 644  */
 645 boolean_t
 646 zfs_prop_setonce(zfs_prop_t prop)
 647 {
 648         return (zfs_prop_table[prop].pd_attr == PROP_ONETIME);
 649 }
 650
 651 const char *
 652 zfs_prop_default_string(zfs_prop_t prop)
 653 {
 654         return (zfs_prop_table[prop].pd_strdefault);
 655 }
 656
 657 uint64_t
 658 zfs_prop_default_numeric(zfs_prop_t prop)
 659 {
 660         return (zfs_prop_table[prop].pd_numdefault);
 661 }
 662
 663 /*
 664  * Given a dataset property ID, returns the corresponding name.
 665  * Assuming the zfs dataset property ID is valid.
 666  */
 667 const char *
 668 zfs_prop_to_name(zfs_prop_t prop)
 669 {
 670         return (zfs_prop_table[prop].pd_name);
 671 }
 672
 673 /*
 674  * Returns TRUE if the property is inheritable.
 675  */
 676 boolean_t
 677 zfs_prop_inheritable(zfs_prop_t prop)
 678 {
 679         return (zfs_prop_table[prop].pd_attr == PROP_INHERIT ||
 680             zfs_prop_table[prop].pd_attr == PROP_ONETIME);
 681 }
 682
 683 #ifndef _KERNEL
 684
 685 /*
 686  * Returns a string describing the set of acceptable values for the given
 687  * zfs property, or NULL if it cannot be set.
 688  */
 689 const char *
 690 zfs_prop_values(zfs_prop_t prop)
 691 {
 692         return (zfs_prop_table[prop].pd_values);
 693 }
 694
 695 /*
 696  * Returns TRUE if this property is a string type.  Note that index types
 697  * (compression, checksum) are treated as strings in userland, even though they
 698  * are stored numerically on disk.
 699  */
 700 int
 701 zfs_prop_is_string(zfs_prop_t prop)
 702 {
 703         return (zfs_prop_table[prop].pd_proptype == PROP_TYPE_STRING ||
 704             zfs_prop_table[prop].pd_proptype == PROP_TYPE_INDEX);
 705 }
 706
 707 /*
 708  * Returns the column header for the given property.  Used only in
 709  * 'zfs list -o', but centralized here with the other property information.
 710  */
 711 const char *
 712 zfs_prop_column_name(zfs_prop_t prop)
 713 {
 714         return (zfs_prop_table[prop].pd_colname);
 715 }
 716
 717 /*
 718  * Returns whether the given property should be displayed right-justified for
 719  * 'zfs list'.
 720  */
 721 boolean_t
 722 zfs_prop_align_right(zfs_prop_t prop)
 723 {
 724         return (zfs_prop_table[prop].pd_rightalign);
 725 }
 726
 727 #endif
 728
 729 #if defined(_KERNEL) && defined(HAVE_SPL)
 730 static int __init
 731 zcommon_init(void)
 732 {
 733         fletcher_4_init();
 734         return (0);
 735 }
 736
 737 static void __exit
 738 zcommon_fini(void)
 739 {
 740         fletcher_4_fini();
 741 }
 742
 743 module_init(zcommon_init);
 744 module_exit(zcommon_fini);
 745
 746 MODULE_DESCRIPTION("Generic ZFS support");
 747 MODULE_AUTHOR(ZFS_META_AUTHOR);
 748 MODULE_LICENSE(ZFS_META_LICENSE);
 749 MODULE_VERSION(ZFS_META_VERSION "-" ZFS_META_RELEASE);
 750
 751 /* zfs dataset property functions */
 752 EXPORT_SYMBOL(zfs_userquota_prop_prefixes);
 753 EXPORT_SYMBOL(zfs_prop_init);
 754 EXPORT_SYMBOL(zfs_prop_get_type);
 755 EXPORT_SYMBOL(zfs_prop_get_table);
 756 EXPORT_SYMBOL(zfs_prop_delegatable);
 757
 758 /* Dataset property functions shared between libzfs and kernel. */
 759 EXPORT_SYMBOL(zfs_prop_default_string);
 760 EXPORT_SYMBOL(zfs_prop_default_numeric);
 761 EXPORT_SYMBOL(zfs_prop_readonly);
 762 EXPORT_SYMBOL(zfs_prop_inheritable);
 763 EXPORT_SYMBOL(zfs_prop_setonce);
 764 EXPORT_SYMBOL(zfs_prop_to_name);
 765 EXPORT_SYMBOL(zfs_name_to_prop);
 766 EXPORT_SYMBOL(zfs_prop_user);
 767 EXPORT_SYMBOL(zfs_prop_userquota);
 768 EXPORT_SYMBOL(zfs_prop_index_to_string);
 769 EXPORT_SYMBOL(zfs_prop_string_to_index);
 770 EXPORT_SYMBOL(zfs_prop_valid_for_type);
 771
 772 #endif