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