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, 2018 by Delphix. All rights reserved. 24 * Copyright (c) 2013 by Saso Kiselkov. All rights reserved. 25 * Copyright 2016, Joyent, Inc. 26 * Copyright (c) 2019, Klara Inc. 27 * Copyright (c) 2019, Allan Jude 28 */ 29 30 /* Portions Copyright 2010 Robert Milkowski */ 31 32 #include <sys/zio.h> 33 #include <sys/spa.h> 34 #include <sys/u8_textprep.h> 35 #include <sys/zfs_acl.h> 36 #include <sys/zfs_ioctl.h> 37 #include <sys/zfs_znode.h> 38 #include <sys/dsl_crypt.h> 39 40 #include "zfs_prop.h" 41 #include "zfs_deleg.h" 42 #include "zfs_fletcher.h" 43 44 #if !defined(_KERNEL) 45 #include <stdlib.h> 46 #include <string.h> 47 #include <ctype.h> 48 #endif 49 50 static zprop_desc_t zfs_prop_table[ZFS_NUM_PROPS]; 51 52 /* Note this is indexed by zfs_userquota_prop_t, keep the order the same */ 53 const char *zfs_userquota_prop_prefixes[] = { 54 "userused@", 55 "userquota@", 56 "groupused@", 57 "groupquota@", 58 "userobjused@", 59 "userobjquota@", 60 "groupobjused@", 61 "groupobjquota@", 62 "projectused@", 63 "projectquota@", 64 "projectobjused@", 65 "projectobjquota@" 66 }; 67 68 zprop_desc_t * 69 zfs_prop_get_table(void) 70 { 71 return (zfs_prop_table); 72 } 73 74 void 75 zfs_prop_init(void) 76 { 77 static zprop_index_t checksum_table[] = { 78 { "on", ZIO_CHECKSUM_ON }, 79 { "off", ZIO_CHECKSUM_OFF }, 80 { "fletcher2", ZIO_CHECKSUM_FLETCHER_2 }, 81 { "fletcher4", ZIO_CHECKSUM_FLETCHER_4 }, 82 { "sha256", ZIO_CHECKSUM_SHA256 }, 83 { "noparity", ZIO_CHECKSUM_NOPARITY }, 84 { "sha512", ZIO_CHECKSUM_SHA512 }, 85 { "skein", ZIO_CHECKSUM_SKEIN }, 86 #if !defined(__FreeBSD__) 87 88 { "edonr", ZIO_CHECKSUM_EDONR }, 89 #endif 90 { NULL } 91 }; 92 93 static zprop_index_t dedup_table[] = { 94 { "on", ZIO_CHECKSUM_ON }, 95 { "off", ZIO_CHECKSUM_OFF }, 96 { "verify", ZIO_CHECKSUM_ON | ZIO_CHECKSUM_VERIFY }, 97 { "sha256", ZIO_CHECKSUM_SHA256 }, 98 { "sha256,verify", 99 ZIO_CHECKSUM_SHA256 | ZIO_CHECKSUM_VERIFY }, 100 { "sha512", ZIO_CHECKSUM_SHA512 }, 101 { "sha512,verify", 102 ZIO_CHECKSUM_SHA512 | ZIO_CHECKSUM_VERIFY }, 103 { "skein", ZIO_CHECKSUM_SKEIN }, 104 { "skein,verify", 105 ZIO_CHECKSUM_SKEIN | ZIO_CHECKSUM_VERIFY }, 106 #if !defined(__FreeBSD__) 107 108 { "edonr,verify", 109 ZIO_CHECKSUM_EDONR | ZIO_CHECKSUM_VERIFY }, 110 #endif 111 { NULL } 112 }; 113 114 static zprop_index_t compress_table[] = { 115 { "on", ZIO_COMPRESS_ON }, 116 { "off", ZIO_COMPRESS_OFF }, 117 { "lzjb", ZIO_COMPRESS_LZJB }, 118 { "gzip", ZIO_COMPRESS_GZIP_6 }, /* gzip default */ 119 { "gzip-1", ZIO_COMPRESS_GZIP_1 }, 120 { "gzip-2", ZIO_COMPRESS_GZIP_2 }, 121 { "gzip-3", ZIO_COMPRESS_GZIP_3 }, 122 { "gzip-4", ZIO_COMPRESS_GZIP_4 }, 123 { "gzip-5", ZIO_COMPRESS_GZIP_5 }, 124 { "gzip-6", ZIO_COMPRESS_GZIP_6 }, 125 { "gzip-7", ZIO_COMPRESS_GZIP_7 }, 126 { "gzip-8", ZIO_COMPRESS_GZIP_8 }, 127 { "gzip-9", ZIO_COMPRESS_GZIP_9 }, 128 { "zle", ZIO_COMPRESS_ZLE }, 129 { "lz4", ZIO_COMPRESS_LZ4 }, 130 { "zstd", ZIO_COMPRESS_ZSTD }, 131 { "zstd-fast", 132 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_DEFAULT) }, 133 134 /* 135 * ZSTD 1-19 are synthetic. We store the compression level in a 136 * separate hidden property to avoid wasting a large amount of 137 * space in the ZIO_COMPRESS enum. 138 * 139 * The compression level is also stored within the header of the 140 * compressed block since we may need it for later recompression 141 * to avoid checksum errors (L2ARC). 142 * 143 * Note that the level here is defined as bit shifted mask on 144 * top of the method. 145 */ 146 { "zstd-1", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_1) }, 147 { "zstd-2", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_2) }, 148 { "zstd-3", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_3) }, 149 { "zstd-4", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_4) }, 150 { "zstd-5", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_5) }, 151 { "zstd-6", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_6) }, 152 { "zstd-7", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_7) }, 153 { "zstd-8", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_8) }, 154 { "zstd-9", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_9) }, 155 { "zstd-10", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_10) }, 156 { "zstd-11", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_11) }, 157 { "zstd-12", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_12) }, 158 { "zstd-13", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_13) }, 159 { "zstd-14", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_14) }, 160 { "zstd-15", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_15) }, 161 { "zstd-16", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_16) }, 162 { "zstd-17", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_17) }, 163 { "zstd-18", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_18) }, 164 { "zstd-19", ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_19) }, 165 166 /* 167 * The ZSTD-Fast levels are also synthetic. 168 */ 169 { "zstd-fast-1", 170 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_1) }, 171 { "zstd-fast-2", 172 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_2) }, 173 { "zstd-fast-3", 174 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_3) }, 175 { "zstd-fast-4", 176 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_4) }, 177 { "zstd-fast-5", 178 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_5) }, 179 { "zstd-fast-6", 180 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_6) }, 181 { "zstd-fast-7", 182 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_7) }, 183 { "zstd-fast-8", 184 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_8) }, 185 { "zstd-fast-9", 186 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_9) }, 187 { "zstd-fast-10", 188 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_10) }, 189 { "zstd-fast-20", 190 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_20) }, 191 { "zstd-fast-30", 192 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_30) }, 193 { "zstd-fast-40", 194 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_40) }, 195 { "zstd-fast-50", 196 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_50) }, 197 { "zstd-fast-60", 198 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_60) }, 199 { "zstd-fast-70", 200 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_70) }, 201 { "zstd-fast-80", 202 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_80) }, 203 { "zstd-fast-90", 204 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_90) }, 205 { "zstd-fast-100", 206 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_100) }, 207 { "zstd-fast-500", 208 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_500) }, 209 { "zstd-fast-1000", 210 ZIO_COMPLEVEL_ZSTD(ZIO_ZSTD_LEVEL_FAST_1000) }, 211 { NULL } 212 }; 213 214 static zprop_index_t crypto_table[] = { 215 { "on", ZIO_CRYPT_ON }, 216 { "off", ZIO_CRYPT_OFF }, 217 { "aes-128-ccm", ZIO_CRYPT_AES_128_CCM }, 218 { "aes-192-ccm", ZIO_CRYPT_AES_192_CCM }, 219 { "aes-256-ccm", ZIO_CRYPT_AES_256_CCM }, 220 { "aes-128-gcm", ZIO_CRYPT_AES_128_GCM }, 221 { "aes-192-gcm", ZIO_CRYPT_AES_192_GCM }, 222 { "aes-256-gcm", ZIO_CRYPT_AES_256_GCM }, 223 { NULL } 224 }; 225 226 static zprop_index_t keyformat_table[] = { 227 { "none", ZFS_KEYFORMAT_NONE }, 228 { "raw", ZFS_KEYFORMAT_RAW }, 229 { "hex", ZFS_KEYFORMAT_HEX }, 230 { "passphrase", ZFS_KEYFORMAT_PASSPHRASE }, 231 { NULL } 232 }; 233 234 static zprop_index_t snapdir_table[] = { 235 { "hidden", ZFS_SNAPDIR_HIDDEN }, 236 { "visible", ZFS_SNAPDIR_VISIBLE }, 237 { NULL } 238 }; 239 240 static zprop_index_t snapdev_table[] = { 241 { "hidden", ZFS_SNAPDEV_HIDDEN }, 242 { "visible", ZFS_SNAPDEV_VISIBLE }, 243 { NULL } 244 }; 245 246 static zprop_index_t acl_mode_table[] = { 247 { "discard", ZFS_ACL_DISCARD }, 248 { "groupmask", ZFS_ACL_GROUPMASK }, 249 { "passthrough", ZFS_ACL_PASSTHROUGH }, 250 { "restricted", ZFS_ACL_RESTRICTED }, 251 { NULL } 252 }; 253 254 static zprop_index_t acltype_table[] = { 255 { "off", ZFS_ACLTYPE_OFF }, 256 { "disabled", ZFS_ACLTYPE_OFF }, 257 { "noacl", ZFS_ACLTYPE_OFF }, 258 { "posixacl", ZFS_ACLTYPE_POSIXACL }, 259 { NULL } 260 }; 261 262 static zprop_index_t acl_inherit_table[] = { 263 { "discard", ZFS_ACL_DISCARD }, 264 { "noallow", ZFS_ACL_NOALLOW }, 265 { "restricted", ZFS_ACL_RESTRICTED }, 266 { "passthrough", ZFS_ACL_PASSTHROUGH }, 267 { "secure", ZFS_ACL_RESTRICTED }, /* bkwrd compatibility */ 268 { "passthrough-x", ZFS_ACL_PASSTHROUGH_X }, 269 { NULL } 270 }; 271 272 static zprop_index_t case_table[] = { 273 { "sensitive", ZFS_CASE_SENSITIVE }, 274 { "insensitive", ZFS_CASE_INSENSITIVE }, 275 { "mixed", ZFS_CASE_MIXED }, 276 { NULL } 277 }; 278 279 static zprop_index_t copies_table[] = { 280 { "1", 1 }, 281 { "2", 2 }, 282 { "3", 3 }, 283 { NULL } 284 }; 285 286 /* 287 * Use the unique flags we have to send to u8_strcmp() and/or 288 * u8_textprep() to represent the various normalization property 289 * values. 290 */ 291 static zprop_index_t normalize_table[] = { 292 { "none", 0 }, 293 { "formD", U8_TEXTPREP_NFD }, 294 { "formKC", U8_TEXTPREP_NFKC }, 295 { "formC", U8_TEXTPREP_NFC }, 296 { "formKD", U8_TEXTPREP_NFKD }, 297 { NULL } 298 }; 299 300 static zprop_index_t version_table[] = { 301 { "1", 1 }, 302 { "2", 2 }, 303 { "3", 3 }, 304 { "4", 4 }, 305 { "5", 5 }, 306 { "current", ZPL_VERSION }, 307 { NULL } 308 }; 309 310 static zprop_index_t boolean_table[] = { 311 { "off", 0 }, 312 { "on", 1 }, 313 { NULL } 314 }; 315 316 static zprop_index_t keystatus_table[] = { 317 { "none", ZFS_KEYSTATUS_NONE}, 318 { "unavailable", ZFS_KEYSTATUS_UNAVAILABLE}, 319 { "available", ZFS_KEYSTATUS_AVAILABLE}, 320 { NULL } 321 }; 322 323 static zprop_index_t logbias_table[] = { 324 { "latency", ZFS_LOGBIAS_LATENCY }, 325 { "throughput", ZFS_LOGBIAS_THROUGHPUT }, 326 { NULL } 327 }; 328 329 static zprop_index_t canmount_table[] = { 330 { "off", ZFS_CANMOUNT_OFF }, 331 { "on", ZFS_CANMOUNT_ON }, 332 { "noauto", ZFS_CANMOUNT_NOAUTO }, 333 { NULL } 334 }; 335 336 static zprop_index_t cache_table[] = { 337 { "none", ZFS_CACHE_NONE }, 338 { "metadata", ZFS_CACHE_METADATA }, 339 { "all", ZFS_CACHE_ALL }, 340 { NULL } 341 }; 342 343 static zprop_index_t sync_table[] = { 344 { "standard", ZFS_SYNC_STANDARD }, 345 { "always", ZFS_SYNC_ALWAYS }, 346 { "disabled", ZFS_SYNC_DISABLED }, 347 { NULL } 348 }; 349 350 static zprop_index_t xattr_table[] = { 351 { "off", ZFS_XATTR_OFF }, 352 { "on", ZFS_XATTR_DIR }, 353 { "sa", ZFS_XATTR_SA }, 354 { "dir", ZFS_XATTR_DIR }, 355 { NULL } 356 }; 357 358 static zprop_index_t dnsize_table[] = { 359 { "legacy", ZFS_DNSIZE_LEGACY }, 360 { "auto", ZFS_DNSIZE_AUTO }, 361 { "1k", ZFS_DNSIZE_1K }, 362 { "2k", ZFS_DNSIZE_2K }, 363 { "4k", ZFS_DNSIZE_4K }, 364 { "8k", ZFS_DNSIZE_8K }, 365 { "16k", ZFS_DNSIZE_16K }, 366 { NULL } 367 }; 368 369 static zprop_index_t redundant_metadata_table[] = { 370 { "all", ZFS_REDUNDANT_METADATA_ALL }, 371 { "most", ZFS_REDUNDANT_METADATA_MOST }, 372 { NULL } 373 }; 374 375 static zprop_index_t volmode_table[] = { 376 { "default", ZFS_VOLMODE_DEFAULT }, 377 { "full", ZFS_VOLMODE_GEOM }, 378 { "geom", ZFS_VOLMODE_GEOM }, 379 { "dev", ZFS_VOLMODE_DEV }, 380 { "none", ZFS_VOLMODE_NONE }, 381 { NULL } 382 }; 383 384 /* inherit index properties */ 385 zprop_register_index(ZFS_PROP_REDUNDANT_METADATA, "redundant_metadata", 386 ZFS_REDUNDANT_METADATA_ALL, 387 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 388 "all | most", "REDUND_MD", 389 redundant_metadata_table); 390 zprop_register_index(ZFS_PROP_SYNC, "sync", ZFS_SYNC_STANDARD, 391 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 392 "standard | always | disabled", "SYNC", 393 sync_table); 394 zprop_register_index(ZFS_PROP_CHECKSUM, "checksum", 395 ZIO_CHECKSUM_DEFAULT, PROP_INHERIT, ZFS_TYPE_FILESYSTEM | 396 ZFS_TYPE_VOLUME, 397 #if !defined(__FreeBSD__) 398 "on | off | fletcher2 | fletcher4 | sha256 | sha512 | skein" 399 " | edonr", 400 #else 401 "on | off | fletcher2 | fletcher4 | sha256 | sha512 | skein", 402 #endif 403 "CHECKSUM", checksum_table); 404 zprop_register_index(ZFS_PROP_DEDUP, "dedup", ZIO_CHECKSUM_OFF, 405 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 406 "on | off | verify | sha256[,verify] | sha512[,verify] | " 407 #if !defined(__FreeBSD__) 408 "skein[,verify] | edonr,verify", 409 #else 410 "skein[,verify]", 411 #endif 412 "DEDUP", dedup_table); 413 zprop_register_index(ZFS_PROP_COMPRESSION, "compression", 414 ZIO_COMPRESS_DEFAULT, PROP_INHERIT, 415 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 416 "on | off | lzjb | gzip | gzip-[1-9] | zle | lz4 | " 417 "zstd | zstd-[1-19] | " 418 "zstd-fast-[1-10,20,30,40,50,60,70,80,90,100,500,1000]", 419 "COMPRESS", compress_table); 420 zprop_register_index(ZFS_PROP_SNAPDIR, "snapdir", ZFS_SNAPDIR_HIDDEN, 421 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 422 "hidden | visible", "SNAPDIR", snapdir_table); 423 zprop_register_index(ZFS_PROP_SNAPDEV, "snapdev", ZFS_SNAPDEV_HIDDEN, 424 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 425 "hidden | visible", "SNAPDEV", snapdev_table); 426 zprop_register_index(ZFS_PROP_ACLMODE, "aclmode", ZFS_ACL_DISCARD, 427 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 428 "discard | groupmask | passthrough | restricted", "ACLMODE", 429 acl_mode_table); 430 #ifndef __FreeBSD__ 431 zprop_register_index(ZFS_PROP_ACLTYPE, "acltype", ZFS_ACLTYPE_OFF, 432 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 433 "noacl | posixacl", "ACLTYPE", acltype_table); 434 #endif 435 zprop_register_index(ZFS_PROP_ACLINHERIT, "aclinherit", 436 ZFS_ACL_RESTRICTED, PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 437 "discard | noallow | restricted | passthrough | passthrough-x", 438 "ACLINHERIT", acl_inherit_table); 439 zprop_register_index(ZFS_PROP_COPIES, "copies", 1, PROP_INHERIT, 440 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 441 "1 | 2 | 3", "COPIES", copies_table); 442 zprop_register_index(ZFS_PROP_PRIMARYCACHE, "primarycache", 443 ZFS_CACHE_ALL, PROP_INHERIT, 444 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, 445 "all | none | metadata", "PRIMARYCACHE", cache_table); 446 zprop_register_index(ZFS_PROP_SECONDARYCACHE, "secondarycache", 447 ZFS_CACHE_ALL, PROP_INHERIT, 448 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, 449 "all | none | metadata", "SECONDARYCACHE", cache_table); 450 zprop_register_index(ZFS_PROP_LOGBIAS, "logbias", ZFS_LOGBIAS_LATENCY, 451 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 452 "latency | throughput", "LOGBIAS", logbias_table); 453 zprop_register_index(ZFS_PROP_XATTR, "xattr", ZFS_XATTR_DIR, 454 PROP_INHERIT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 455 "on | off | dir | sa", "XATTR", xattr_table); 456 zprop_register_index(ZFS_PROP_DNODESIZE, "dnodesize", 457 ZFS_DNSIZE_LEGACY, PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 458 "legacy | auto | 1k | 2k | 4k | 8k | 16k", "DNSIZE", dnsize_table); 459 zprop_register_index(ZFS_PROP_VOLMODE, "volmode", 460 ZFS_VOLMODE_DEFAULT, PROP_INHERIT, 461 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 462 "default | full | geom | dev | none", "VOLMODE", volmode_table); 463 464 /* inherit index (boolean) properties */ 465 zprop_register_index(ZFS_PROP_ATIME, "atime", 1, PROP_INHERIT, 466 ZFS_TYPE_FILESYSTEM, "on | off", "ATIME", boolean_table); 467 zprop_register_index(ZFS_PROP_RELATIME, "relatime", 0, PROP_INHERIT, 468 ZFS_TYPE_FILESYSTEM, "on | off", "RELATIME", boolean_table); 469 zprop_register_index(ZFS_PROP_DEVICES, "devices", 1, PROP_INHERIT, 470 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "DEVICES", 471 boolean_table); 472 zprop_register_index(ZFS_PROP_EXEC, "exec", 1, PROP_INHERIT, 473 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "EXEC", 474 boolean_table); 475 zprop_register_index(ZFS_PROP_SETUID, "setuid", 1, PROP_INHERIT, 476 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID", 477 boolean_table); 478 zprop_register_index(ZFS_PROP_READONLY, "readonly", 0, PROP_INHERIT, 479 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "on | off", "RDONLY", 480 boolean_table); 481 #ifdef __FreeBSD__ 482 zprop_register_index(ZFS_PROP_ZONED, "jailed", 0, PROP_INHERIT, 483 ZFS_TYPE_FILESYSTEM, "on | off", "JAILED", boolean_table); 484 #else 485 zprop_register_index(ZFS_PROP_ZONED, "zoned", 0, PROP_INHERIT, 486 ZFS_TYPE_FILESYSTEM, "on | off", "ZONED", boolean_table); 487 #endif 488 zprop_register_index(ZFS_PROP_VSCAN, "vscan", 0, PROP_INHERIT, 489 ZFS_TYPE_FILESYSTEM, "on | off", "VSCAN", boolean_table); 490 zprop_register_index(ZFS_PROP_NBMAND, "nbmand", 0, PROP_INHERIT, 491 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "NBMAND", 492 boolean_table); 493 zprop_register_index(ZFS_PROP_OVERLAY, "overlay", 1, PROP_INHERIT, 494 ZFS_TYPE_FILESYSTEM, "on | off", "OVERLAY", boolean_table); 495 496 /* default index properties */ 497 zprop_register_index(ZFS_PROP_VERSION, "version", 0, PROP_DEFAULT, 498 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 499 "1 | 2 | 3 | 4 | 5 | current", "VERSION", version_table); 500 zprop_register_index(ZFS_PROP_CANMOUNT, "canmount", ZFS_CANMOUNT_ON, 501 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, "on | off | noauto", 502 "CANMOUNT", canmount_table); 503 504 /* readonly index properties */ 505 zprop_register_index(ZFS_PROP_MOUNTED, "mounted", 0, PROP_READONLY, 506 ZFS_TYPE_FILESYSTEM, "yes | no", "MOUNTED", boolean_table); 507 zprop_register_index(ZFS_PROP_DEFER_DESTROY, "defer_destroy", 0, 508 PROP_READONLY, ZFS_TYPE_SNAPSHOT, "yes | no", "DEFER_DESTROY", 509 boolean_table); 510 zprop_register_index(ZFS_PROP_KEYSTATUS, "keystatus", 511 ZFS_KEYSTATUS_NONE, PROP_READONLY, ZFS_TYPE_DATASET, 512 "none | unavailable | available", 513 "KEYSTATUS", keystatus_table); 514 515 /* set once index properties */ 516 zprop_register_index(ZFS_PROP_NORMALIZE, "normalization", 0, 517 PROP_ONETIME, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 518 "none | formC | formD | formKC | formKD", "NORMALIZATION", 519 normalize_table); 520 zprop_register_index(ZFS_PROP_CASE, "casesensitivity", 521 ZFS_CASE_SENSITIVE, PROP_ONETIME, ZFS_TYPE_FILESYSTEM | 522 ZFS_TYPE_SNAPSHOT, 523 "sensitive | insensitive | mixed", "CASE", case_table); 524 zprop_register_index(ZFS_PROP_KEYFORMAT, "keyformat", 525 ZFS_KEYFORMAT_NONE, PROP_ONETIME_DEFAULT, 526 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 527 "none | raw | hex | passphrase", "KEYFORMAT", keyformat_table); 528 zprop_register_index(ZFS_PROP_ENCRYPTION, "encryption", 529 ZIO_CRYPT_DEFAULT, PROP_ONETIME, ZFS_TYPE_DATASET, 530 "on | off | aes-128-ccm | aes-192-ccm | aes-256-ccm | " 531 "aes-128-gcm | aes-192-gcm | aes-256-gcm", "ENCRYPTION", 532 crypto_table); 533 534 /* set once index (boolean) properties */ 535 zprop_register_index(ZFS_PROP_UTF8ONLY, "utf8only", 0, PROP_ONETIME, 536 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 537 "on | off", "UTF8ONLY", boolean_table); 538 539 /* string properties */ 540 zprop_register_string(ZFS_PROP_ORIGIN, "origin", NULL, PROP_READONLY, 541 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN"); 542 zprop_register_string(ZFS_PROP_CLONES, "clones", NULL, PROP_READONLY, 543 ZFS_TYPE_SNAPSHOT, "<dataset>[,...]", "CLONES"); 544 zprop_register_string(ZFS_PROP_MOUNTPOINT, "mountpoint", "/", 545 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "<path> | legacy | none", 546 "MOUNTPOINT"); 547 zprop_register_string(ZFS_PROP_SHARENFS, "sharenfs", "off", 548 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, "on | off | share(1M) options", 549 "SHARENFS"); 550 zprop_register_string(ZFS_PROP_TYPE, "type", NULL, PROP_READONLY, 551 ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, 552 "filesystem | volume | snapshot | bookmark", "TYPE"); 553 zprop_register_string(ZFS_PROP_SHARESMB, "sharesmb", "off", 554 PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 555 "on | off | sharemgr(1M) options", "SHARESMB"); 556 zprop_register_string(ZFS_PROP_MLSLABEL, "mlslabel", 557 ZFS_MLSLABEL_DEFAULT, PROP_INHERIT, ZFS_TYPE_DATASET, 558 "<sensitivity label>", "MLSLABEL"); 559 zprop_register_string(ZFS_PROP_SELINUX_CONTEXT, "context", 560 "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux context>", 561 "CONTEXT"); 562 zprop_register_string(ZFS_PROP_SELINUX_FSCONTEXT, "fscontext", 563 "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux fscontext>", 564 "FSCONTEXT"); 565 zprop_register_string(ZFS_PROP_SELINUX_DEFCONTEXT, "defcontext", 566 "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux defcontext>", 567 "DEFCONTEXT"); 568 zprop_register_string(ZFS_PROP_SELINUX_ROOTCONTEXT, "rootcontext", 569 "none", PROP_DEFAULT, ZFS_TYPE_DATASET, "<selinux rootcontext>", 570 "ROOTCONTEXT"); 571 zprop_register_string(ZFS_PROP_RECEIVE_RESUME_TOKEN, 572 "receive_resume_token", 573 NULL, PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 574 "<string token>", "RESUMETOK"); 575 zprop_register_string(ZFS_PROP_ENCRYPTION_ROOT, "encryptionroot", NULL, 576 PROP_READONLY, ZFS_TYPE_DATASET, "<filesystem | volume>", 577 "ENCROOT"); 578 zprop_register_string(ZFS_PROP_KEYLOCATION, "keylocation", 579 "none", PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 580 "prompt | <file URI>", "KEYLOCATION"); 581 zprop_register_string(ZFS_PROP_REDACT_SNAPS, 582 "redact_snaps", NULL, PROP_READONLY, 583 ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "<snapshot>[,...]", 584 "RSNAPS"); 585 586 /* readonly number properties */ 587 zprop_register_number(ZFS_PROP_USED, "used", 0, PROP_READONLY, 588 ZFS_TYPE_DATASET, "<size>", "USED"); 589 zprop_register_number(ZFS_PROP_AVAILABLE, "available", 0, PROP_READONLY, 590 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL"); 591 zprop_register_number(ZFS_PROP_REFERENCED, "referenced", 0, 592 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "<size>", 593 "REFER"); 594 zprop_register_number(ZFS_PROP_COMPRESSRATIO, "compressratio", 0, 595 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, 596 "<1.00x or higher if compressed>", "RATIO"); 597 zprop_register_number(ZFS_PROP_REFRATIO, "refcompressratio", 0, 598 PROP_READONLY, ZFS_TYPE_DATASET, 599 "<1.00x or higher if compressed>", "REFRATIO"); 600 zprop_register_number(ZFS_PROP_VOLBLOCKSIZE, "volblocksize", 601 ZVOL_DEFAULT_BLOCKSIZE, PROP_ONETIME, 602 ZFS_TYPE_VOLUME, "512 to 128k, power of 2", "VOLBLOCK"); 603 zprop_register_number(ZFS_PROP_USEDSNAP, "usedbysnapshots", 0, 604 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 605 "USEDSNAP"); 606 zprop_register_number(ZFS_PROP_USEDDS, "usedbydataset", 0, 607 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 608 "USEDDS"); 609 zprop_register_number(ZFS_PROP_USEDCHILD, "usedbychildren", 0, 610 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 611 "USEDCHILD"); 612 zprop_register_number(ZFS_PROP_USEDREFRESERV, "usedbyrefreservation", 0, 613 PROP_READONLY, 614 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "USEDREFRESERV"); 615 zprop_register_number(ZFS_PROP_USERREFS, "userrefs", 0, PROP_READONLY, 616 ZFS_TYPE_SNAPSHOT, "<count>", "USERREFS"); 617 zprop_register_number(ZFS_PROP_WRITTEN, "written", 0, PROP_READONLY, 618 ZFS_TYPE_DATASET, "<size>", "WRITTEN"); 619 zprop_register_number(ZFS_PROP_LOGICALUSED, "logicalused", 0, 620 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", 621 "LUSED"); 622 zprop_register_number(ZFS_PROP_LOGICALREFERENCED, "logicalreferenced", 623 0, PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "<size>", 624 "LREFER"); 625 zprop_register_number(ZFS_PROP_FILESYSTEM_COUNT, "filesystem_count", 626 UINT64_MAX, PROP_READONLY, ZFS_TYPE_FILESYSTEM, 627 "<count>", "FSCOUNT"); 628 zprop_register_number(ZFS_PROP_SNAPSHOT_COUNT, "snapshot_count", 629 UINT64_MAX, PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 630 "<count>", "SSCOUNT"); 631 zprop_register_number(ZFS_PROP_GUID, "guid", 0, PROP_READONLY, 632 ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "<uint64>", "GUID"); 633 zprop_register_number(ZFS_PROP_CREATETXG, "createtxg", 0, PROP_READONLY, 634 ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "<uint64>", "CREATETXG"); 635 zprop_register_number(ZFS_PROP_PBKDF2_ITERS, "pbkdf2iters", 636 0, PROP_ONETIME_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 637 "<iters>", "PBKDF2ITERS"); 638 zprop_register_number(ZFS_PROP_OBJSETID, "objsetid", 0, 639 PROP_READONLY, ZFS_TYPE_DATASET, "<uint64>", "OBJSETID"); 640 641 /* default number properties */ 642 zprop_register_number(ZFS_PROP_QUOTA, "quota", 0, PROP_DEFAULT, 643 ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA"); 644 zprop_register_number(ZFS_PROP_RESERVATION, "reservation", 0, 645 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 646 "<size> | none", "RESERV"); 647 zprop_register_number(ZFS_PROP_VOLSIZE, "volsize", 0, PROP_DEFAULT, 648 ZFS_TYPE_SNAPSHOT | ZFS_TYPE_VOLUME, "<size>", "VOLSIZE"); 649 zprop_register_number(ZFS_PROP_REFQUOTA, "refquota", 0, PROP_DEFAULT, 650 ZFS_TYPE_FILESYSTEM, "<size> | none", "REFQUOTA"); 651 zprop_register_number(ZFS_PROP_REFRESERVATION, "refreservation", 0, 652 PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 653 "<size> | none", "REFRESERV"); 654 zprop_register_number(ZFS_PROP_FILESYSTEM_LIMIT, "filesystem_limit", 655 UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM, 656 "<count> | none", "FSLIMIT"); 657 zprop_register_number(ZFS_PROP_SNAPSHOT_LIMIT, "snapshot_limit", 658 UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 659 "<count> | none", "SSLIMIT"); 660 661 /* inherit number properties */ 662 zprop_register_number(ZFS_PROP_RECORDSIZE, "recordsize", 663 SPA_OLD_MAXBLOCKSIZE, PROP_INHERIT, 664 ZFS_TYPE_FILESYSTEM, "512 to 1M, power of 2", "RECSIZE"); 665 zprop_register_number(ZFS_PROP_SPECIAL_SMALL_BLOCKS, 666 "special_small_blocks", 0, PROP_INHERIT, ZFS_TYPE_FILESYSTEM, 667 "zero or 512 to 1M, power of 2", "SPECIAL_SMALL_BLOCKS"); 668 669 /* hidden properties */ 670 zprop_register_hidden(ZFS_PROP_NUMCLONES, "numclones", PROP_TYPE_NUMBER, 671 PROP_READONLY, ZFS_TYPE_SNAPSHOT, "NUMCLONES"); 672 zprop_register_hidden(ZFS_PROP_NAME, "name", PROP_TYPE_STRING, 673 PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "NAME"); 674 zprop_register_hidden(ZFS_PROP_ISCSIOPTIONS, "iscsioptions", 675 PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, "ISCSIOPTIONS"); 676 zprop_register_hidden(ZFS_PROP_STMF_SHAREINFO, "stmf_sbd_lu", 677 PROP_TYPE_STRING, PROP_INHERIT, ZFS_TYPE_VOLUME, 678 "STMF_SBD_LU"); 679 zprop_register_hidden(ZFS_PROP_USERACCOUNTING, "useraccounting", 680 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, 681 "USERACCOUNTING"); 682 zprop_register_hidden(ZFS_PROP_UNIQUE, "unique", PROP_TYPE_NUMBER, 683 PROP_READONLY, ZFS_TYPE_DATASET, "UNIQUE"); 684 zprop_register_hidden(ZFS_PROP_INCONSISTENT, "inconsistent", 685 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_DATASET, "INCONSISTENT"); 686 zprop_register_hidden(ZFS_PROP_IVSET_GUID, "ivsetguid", 687 PROP_TYPE_NUMBER, PROP_READONLY, 688 ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, "IVSETGUID"); 689 zprop_register_hidden(ZFS_PROP_PREV_SNAP, "prevsnap", PROP_TYPE_STRING, 690 PROP_READONLY, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "PREVSNAP"); 691 zprop_register_hidden(ZFS_PROP_PBKDF2_SALT, "pbkdf2salt", 692 PROP_TYPE_NUMBER, PROP_ONETIME_DEFAULT, 693 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "PBKDF2SALT"); 694 zprop_register_hidden(ZFS_PROP_KEY_GUID, "keyguid", PROP_TYPE_NUMBER, 695 PROP_READONLY, ZFS_TYPE_DATASET, "KEYGUID"); 696 zprop_register_hidden(ZFS_PROP_REDACTED, "redacted", PROP_TYPE_NUMBER, 697 PROP_READONLY, ZFS_TYPE_DATASET, "REDACTED"); 698 699 /* 700 * Properties that are obsolete and not used. These are retained so 701 * that we don't have to change the values of the zfs_prop_t enum, or 702 * have NULL pointers in the zfs_prop_table[]. 703 */ 704 #ifdef __FreeBSD__ 705 zprop_register_impl(ZFS_PROP_ACLTYPE, "acltype", PROP_TYPE_INDEX, 706 ZFS_ACLTYPE_OFF, NULL, PROP_INHERIT, 707 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 708 "noacl | posixacl", "ACLTYPE", B_FALSE, B_FALSE, acltype_table); 709 #endif 710 zprop_register_hidden(ZFS_PROP_REMAPTXG, "remaptxg", PROP_TYPE_NUMBER, 711 PROP_READONLY, ZFS_TYPE_DATASET, "REMAPTXG"); 712 713 /* oddball properties */ 714 zprop_register_impl(ZFS_PROP_CREATION, "creation", PROP_TYPE_NUMBER, 0, 715 NULL, PROP_READONLY, ZFS_TYPE_DATASET | ZFS_TYPE_BOOKMARK, 716 "<date>", "CREATION", B_FALSE, B_TRUE, NULL); 717 } 718 719 boolean_t 720 zfs_prop_delegatable(zfs_prop_t prop) 721 { 722 zprop_desc_t *pd = &zfs_prop_table[prop]; 723 724 /* The mlslabel property is never delegatable. */ 725 if (prop == ZFS_PROP_MLSLABEL) 726 return (B_FALSE); 727 728 return (pd->pd_attr != PROP_READONLY); 729 } 730 731 /* 732 * Given a zfs dataset property name, returns the corresponding property ID. 733 */ 734 zfs_prop_t 735 zfs_name_to_prop(const char *propname) 736 { 737 return (zprop_name_to_prop(propname, ZFS_TYPE_DATASET)); 738 } 739 740 /* 741 * For user property names, we allow all lowercase alphanumeric characters, plus 742 * a few useful punctuation characters. 743 */ 744 static int 745 valid_char(char c) 746 { 747 return ((c >= 'a' && c <= 'z') || 748 (c >= '0' && c <= '9') || 749 c == '-' || c == '_' || c == '.' || c == ':'); 750 } 751 752 /* 753 * Returns true if this is a valid user-defined property (one with a ':'). 754 */ 755 boolean_t 756 zfs_prop_user(const char *name) 757 { 758 int i; 759 char c; 760 boolean_t foundsep = B_FALSE; 761 762 for (i = 0; i < strlen(name); i++) { 763 c = name[i]; 764 if (!valid_char(c)) 765 return (B_FALSE); 766 if (c == ':') 767 foundsep = B_TRUE; 768 } 769 770 if (!foundsep) 771 return (B_FALSE); 772 773 return (B_TRUE); 774 } 775 776 /* 777 * Returns true if this is a valid userspace-type property (one with a '@'). 778 * Note that after the @, any character is valid (eg, another @, for SID 779 * user@domain). 780 */ 781 boolean_t 782 zfs_prop_userquota(const char *name) 783 { 784 zfs_userquota_prop_t prop; 785 786 for (prop = 0; prop < ZFS_NUM_USERQUOTA_PROPS; prop++) { 787 if (strncmp(name, zfs_userquota_prop_prefixes[prop], 788 strlen(zfs_userquota_prop_prefixes[prop])) == 0) { 789 return (B_TRUE); 790 } 791 } 792 793 return (B_FALSE); 794 } 795 796 /* 797 * Returns true if this is a valid written@ property. 798 * Note that after the @, any character is valid (eg, another @, for 799 * written@pool/fs@origin). 800 */ 801 boolean_t 802 zfs_prop_written(const char *name) 803 { 804 static const char *prop_prefix = "written@"; 805 static const char *book_prefix = "written#"; 806 return (strncmp(name, prop_prefix, strlen(prop_prefix)) == 0 || 807 strncmp(name, book_prefix, strlen(book_prefix)) == 0); 808 } 809 810 /* 811 * Tables of index types, plus functions to convert between the user view 812 * (strings) and internal representation (uint64_t). 813 */ 814 int 815 zfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index) 816 { 817 return (zprop_string_to_index(prop, string, index, ZFS_TYPE_DATASET)); 818 } 819 820 int 821 zfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string) 822 { 823 return (zprop_index_to_string(prop, index, string, ZFS_TYPE_DATASET)); 824 } 825 826 uint64_t 827 zfs_prop_random_value(zfs_prop_t prop, uint64_t seed) 828 { 829 return (zprop_random_value(prop, seed, ZFS_TYPE_DATASET)); 830 } 831 832 /* 833 * Returns TRUE if the property applies to any of the given dataset types. 834 */ 835 boolean_t 836 zfs_prop_valid_for_type(int prop, zfs_type_t types, boolean_t headcheck) 837 { 838 return (zprop_valid_for_type(prop, types, headcheck)); 839 } 840 841 zprop_type_t 842 zfs_prop_get_type(zfs_prop_t prop) 843 { 844 return (zfs_prop_table[prop].pd_proptype); 845 } 846 847 /* 848 * Returns TRUE if the property is readonly. 849 */ 850 boolean_t 851 zfs_prop_readonly(zfs_prop_t prop) 852 { 853 return (zfs_prop_table[prop].pd_attr == PROP_READONLY || 854 zfs_prop_table[prop].pd_attr == PROP_ONETIME || 855 zfs_prop_table[prop].pd_attr == PROP_ONETIME_DEFAULT); 856 } 857 858 /* 859 * Returns TRUE if the property is visible (not hidden). 860 */ 861 boolean_t 862 zfs_prop_visible(zfs_prop_t prop) 863 { 864 return (zfs_prop_table[prop].pd_visible && 865 zfs_prop_table[prop].pd_zfs_mod_supported); 866 } 867 868 /* 869 * Returns TRUE if the property is only allowed to be set once. 870 */ 871 boolean_t 872 zfs_prop_setonce(zfs_prop_t prop) 873 { 874 return (zfs_prop_table[prop].pd_attr == PROP_ONETIME || 875 zfs_prop_table[prop].pd_attr == PROP_ONETIME_DEFAULT); 876 } 877 878 const char * 879 zfs_prop_default_string(zfs_prop_t prop) 880 { 881 return (zfs_prop_table[prop].pd_strdefault); 882 } 883 884 uint64_t 885 zfs_prop_default_numeric(zfs_prop_t prop) 886 { 887 return (zfs_prop_table[prop].pd_numdefault); 888 } 889 890 /* 891 * Given a dataset property ID, returns the corresponding name. 892 * Assuming the zfs dataset property ID is valid. 893 */ 894 const char * 895 zfs_prop_to_name(zfs_prop_t prop) 896 { 897 return (zfs_prop_table[prop].pd_name); 898 } 899 900 /* 901 * Returns TRUE if the property is inheritable. 902 */ 903 boolean_t 904 zfs_prop_inheritable(zfs_prop_t prop) 905 { 906 return (zfs_prop_table[prop].pd_attr == PROP_INHERIT || 907 zfs_prop_table[prop].pd_attr == PROP_ONETIME); 908 } 909 910 /* 911 * Returns TRUE if property is one of the encryption properties that requires 912 * a loaded encryption key to modify. 913 */ 914 boolean_t 915 zfs_prop_encryption_key_param(zfs_prop_t prop) 916 { 917 /* 918 * keylocation does not count as an encryption property. It can be 919 * changed at will without needing the master keys. 920 */ 921 return (prop == ZFS_PROP_PBKDF2_SALT || prop == ZFS_PROP_PBKDF2_ITERS || 922 prop == ZFS_PROP_KEYFORMAT); 923 } 924 925 /* 926 * Helper function used by both kernelspace and userspace to check the 927 * keylocation property. If encrypted is set, the keylocation must be valid 928 * for an encrypted dataset. 929 */ 930 boolean_t 931 zfs_prop_valid_keylocation(const char *str, boolean_t encrypted) 932 { 933 if (strcmp("none", str) == 0) 934 return (!encrypted); 935 else if (strcmp("prompt", str) == 0) 936 return (B_TRUE); 937 else if (strlen(str) > 8 && strncmp("file:///", str, 8) == 0) 938 return (B_TRUE); 939 940 return (B_FALSE); 941 } 942 943 944 #ifndef _KERNEL 945 #include <libzfs.h> 946 947 /* 948 * Returns a string describing the set of acceptable values for the given 949 * zfs property, or NULL if it cannot be set. 950 */ 951 const char * 952 zfs_prop_values(zfs_prop_t prop) 953 { 954 return (zfs_prop_table[prop].pd_values); 955 } 956 957 /* 958 * Returns TRUE if this property is a string type. Note that index types 959 * (compression, checksum) are treated as strings in userland, even though they 960 * are stored numerically on disk. 961 */ 962 int 963 zfs_prop_is_string(zfs_prop_t prop) 964 { 965 return (zfs_prop_table[prop].pd_proptype == PROP_TYPE_STRING || 966 zfs_prop_table[prop].pd_proptype == PROP_TYPE_INDEX); 967 } 968 969 /* 970 * Returns the column header for the given property. Used only in 971 * 'zfs list -o', but centralized here with the other property information. 972 */ 973 const char * 974 zfs_prop_column_name(zfs_prop_t prop) 975 { 976 return (zfs_prop_table[prop].pd_colname); 977 } 978 979 /* 980 * Returns whether the given property should be displayed right-justified for 981 * 'zfs list'. 982 */ 983 boolean_t 984 zfs_prop_align_right(zfs_prop_t prop) 985 { 986 return (zfs_prop_table[prop].pd_rightalign); 987 } 988 989 #endif 990 991 #if defined(_KERNEL) 992 993 #include <sys/simd.h> 994 995 #if defined(HAVE_KERNEL_FPU_INTERNAL) 996 union fpregs_state **zfs_kfpu_fpregs; 997 EXPORT_SYMBOL(zfs_kfpu_fpregs); 998 #endif /* HAVE_KERNEL_FPU_INTERNAL */ 999 1000 static int __init 1001 zcommon_init(void) 1002 { 1003 int error = kfpu_init(); 1004 if (error) 1005 return (error); 1006 1007 fletcher_4_init(); 1008 1009 return (0); 1010 } 1011 1012 static void __exit 1013 zcommon_fini(void) 1014 { 1015 fletcher_4_fini(); 1016 kfpu_fini(); 1017 } 1018 1019 module_init(zcommon_init); 1020 module_exit(zcommon_fini); 1021 1022 #endif 1023 1024 ZFS_MODULE_DESCRIPTION("Generic ZFS support"); 1025 ZFS_MODULE_AUTHOR(ZFS_META_AUTHOR); 1026 ZFS_MODULE_LICENSE(ZFS_META_LICENSE); 1027 ZFS_MODULE_VERSION(ZFS_META_VERSION "-" ZFS_META_RELEASE); 1028 1029 /* zfs dataset property functions */ 1030 EXPORT_SYMBOL(zfs_userquota_prop_prefixes); 1031 EXPORT_SYMBOL(zfs_prop_init); 1032 EXPORT_SYMBOL(zfs_prop_get_type); 1033 EXPORT_SYMBOL(zfs_prop_get_table); 1034 EXPORT_SYMBOL(zfs_prop_delegatable); 1035 EXPORT_SYMBOL(zfs_prop_visible); 1036 1037 /* Dataset property functions shared between libzfs and kernel. */ 1038 EXPORT_SYMBOL(zfs_prop_default_string); 1039 EXPORT_SYMBOL(zfs_prop_default_numeric); 1040 EXPORT_SYMBOL(zfs_prop_readonly); 1041 EXPORT_SYMBOL(zfs_prop_inheritable); 1042 EXPORT_SYMBOL(zfs_prop_encryption_key_param); 1043 EXPORT_SYMBOL(zfs_prop_valid_keylocation); 1044 EXPORT_SYMBOL(zfs_prop_setonce); 1045 EXPORT_SYMBOL(zfs_prop_to_name); 1046 EXPORT_SYMBOL(zfs_name_to_prop); 1047 EXPORT_SYMBOL(zfs_prop_user); 1048 EXPORT_SYMBOL(zfs_prop_userquota); 1049 EXPORT_SYMBOL(zfs_prop_index_to_string); 1050 EXPORT_SYMBOL(zfs_prop_string_to_index); 1051 EXPORT_SYMBOL(zfs_prop_valid_for_type); 1052 EXPORT_SYMBOL(zfs_prop_written); 1053