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