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