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