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 2006 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #pragma ident "%Z%%M% %I% %E% SMI" 27 28 /* 29 * Master property table. 30 * 31 * This table keeps track of all the properties supported by ZFS, and their 32 * various attributes. Not all of these are needed by the kernel, and several 33 * are only used by a single libzfs client. But having them here centralizes 34 * all property information in one location. 35 * 36 * name The human-readable string representing this property 37 * proptype Basic type (string, boolean, number) 38 * default Default value for the property. Sadly, C only allows 39 * you to initialize the first member of a union, so we 40 * have two default members for each property. 41 * attr Attributes (readonly, inheritable) for the property 42 * types Valid dataset types to which this applies 43 * values String describing acceptable values for the property 44 * colname The column header for 'zfs list' 45 * colfmt The column formatting for 'zfs list' 46 * 47 * This table must match the order of property types in libzfs.h. 48 */ 49 50 #include <sys/zio.h> 51 #include <sys/spa.h> 52 #include <sys/zfs_acl.h> 53 #include <sys/zfs_ioctl.h> 54 55 #include "zfs_prop.h" 56 57 #if defined(_KERNEL) 58 #include <sys/systm.h> 59 #else 60 #include <stdlib.h> 61 #include <string.h> 62 #include <ctype.h> 63 #endif 64 65 typedef enum { 66 prop_default, 67 prop_readonly, 68 prop_inherit 69 } prop_attr_t; 70 71 typedef struct { 72 const char *pd_name; 73 zfs_proptype_t pd_proptype; 74 uint64_t pd_numdefault; 75 const char *pd_strdefault; 76 prop_attr_t pd_attr; 77 int pd_types; 78 const char *pd_values; 79 const char *pd_colname; 80 boolean_t pd_rightalign; 81 } prop_desc_t; 82 83 static prop_desc_t zfs_prop_table[ZFS_NPROP_ALL] = { 84 { "type", prop_type_string, 0, NULL, prop_readonly, 85 ZFS_TYPE_ANY, "filesystem | volume | snapshot", "TYPE", B_TRUE }, 86 { "creation", prop_type_number, 0, NULL, prop_readonly, 87 ZFS_TYPE_ANY, "<date>", "CREATION", B_FALSE }, 88 { "used", prop_type_number, 0, NULL, prop_readonly, 89 ZFS_TYPE_ANY, "<size>", "USED", B_TRUE }, 90 { "available", prop_type_number, 0, NULL, prop_readonly, 91 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<size>", "AVAIL", B_TRUE }, 92 { "referenced", prop_type_number, 0, NULL, prop_readonly, 93 ZFS_TYPE_ANY, 94 "<size>", "REFER", B_TRUE }, 95 { "compressratio", prop_type_number, 0, NULL, prop_readonly, 96 ZFS_TYPE_ANY, "<1.00x or higher if compressed>", "RATIO", B_TRUE }, 97 { "mounted", prop_type_boolean, 0, NULL, prop_readonly, 98 ZFS_TYPE_FILESYSTEM, "yes | no | -", "MOUNTED", B_TRUE }, 99 { "origin", prop_type_string, 0, NULL, prop_readonly, 100 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, "<snapshot>", "ORIGIN", 101 B_FALSE }, 102 { "quota", prop_type_number, 0, NULL, prop_default, 103 ZFS_TYPE_FILESYSTEM, "<size> | none", "QUOTA", B_TRUE }, 104 { "reservation", prop_type_number, 0, NULL, prop_default, 105 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 106 "<size> | none", "RESERV", B_TRUE }, 107 { "volsize", prop_type_number, 0, NULL, prop_default, 108 ZFS_TYPE_VOLUME, "<size>", "VOLSIZE", B_TRUE }, 109 { "volblocksize", prop_type_number, 8192, NULL, prop_readonly, 110 ZFS_TYPE_VOLUME, "512 to 128k, power of 2", "VOLBLOCK", B_TRUE }, 111 { "recordsize", prop_type_number, SPA_MAXBLOCKSIZE, NULL, 112 prop_inherit, 113 ZFS_TYPE_FILESYSTEM, 114 "512 to 128k, power of 2", "RECSIZE", B_TRUE }, 115 { "mountpoint", prop_type_string, 0, "/", prop_inherit, 116 ZFS_TYPE_FILESYSTEM, 117 "<path> | legacy | none", "MOUNTPOINT", B_FALSE }, 118 { "sharenfs", prop_type_string, 0, "off", prop_inherit, 119 ZFS_TYPE_FILESYSTEM, 120 "on | off | share(1M) options", "SHARENFS", B_FALSE }, 121 { "checksum", prop_type_index, ZIO_CHECKSUM_DEFAULT, "on", 122 prop_inherit, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 123 "on | off | fletcher2 | fletcher4 | sha256", "CHECKSUM", B_TRUE }, 124 { "compression", prop_type_index, ZIO_COMPRESS_DEFAULT, "off", 125 prop_inherit, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 126 "on | off | lzjb", "COMPRESS", B_TRUE }, 127 { "atime", prop_type_boolean, 1, NULL, prop_inherit, 128 ZFS_TYPE_FILESYSTEM, 129 "on | off", "ATIME", B_TRUE }, 130 { "devices", prop_type_boolean, 1, NULL, prop_inherit, 131 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 132 "on | off", "DEVICES", B_TRUE }, 133 { "exec", prop_type_boolean, 1, NULL, prop_inherit, 134 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, 135 "on | off", "EXEC", B_TRUE }, 136 { "setuid", prop_type_boolean, 1, NULL, prop_inherit, 137 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT, "on | off", "SETUID", 138 B_TRUE }, 139 { "readonly", prop_type_boolean, 0, NULL, prop_inherit, 140 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 141 "on | off", "RDONLY", B_TRUE }, 142 { "zoned", prop_type_boolean, 0, NULL, prop_inherit, 143 ZFS_TYPE_FILESYSTEM, 144 "on | off", "ZONED", B_TRUE }, 145 { "snapdir", prop_type_index, ZFS_SNAPDIR_HIDDEN, "hidden", 146 prop_inherit, 147 ZFS_TYPE_FILESYSTEM, 148 "hidden | visible", "SNAPDIR", B_TRUE }, 149 { "aclmode", prop_type_index, ZFS_ACL_GROUPMASK, "groupmask", 150 prop_inherit, ZFS_TYPE_FILESYSTEM, 151 "discard | groupmask | passthrough", "ACLMODE", B_TRUE }, 152 { "aclinherit", prop_type_index, ZFS_ACL_SECURE, "secure", 153 prop_inherit, ZFS_TYPE_FILESYSTEM, 154 "discard | noallow | secure | passthrough", "ACLINHERIT", B_TRUE }, 155 { "canmount", prop_type_boolean, 1, NULL, prop_default, 156 ZFS_TYPE_FILESYSTEM, 157 "on | off", "CANMOUNT", B_TRUE }, 158 { "createtxg", prop_type_number, 0, NULL, prop_readonly, 159 ZFS_TYPE_ANY, NULL, NULL, NULL}, 160 { "name", prop_type_string, 0, NULL, prop_readonly, 161 ZFS_TYPE_ANY, 162 NULL, "NAME", B_FALSE }, 163 }; 164 165 zfs_proptype_t 166 zfs_prop_get_type(zfs_prop_t prop) 167 { 168 return (zfs_prop_table[prop].pd_proptype); 169 } 170 171 static boolean_t 172 propname_match(const char *p, zfs_prop_t prop, size_t len) 173 { 174 const char *propname = zfs_prop_table[prop].pd_name; 175 #ifndef _KERNEL 176 const char *colname = zfs_prop_table[prop].pd_colname; 177 int c; 178 #endif 179 180 #ifndef _KERNEL 181 if (colname == NULL) 182 return (B_FALSE); 183 #endif 184 185 if (len == strlen(propname) && 186 strncmp(p, propname, len) == 0) 187 return (B_TRUE); 188 189 #ifndef _KERNEL 190 if (len != strlen(colname)) 191 return (B_FALSE); 192 193 for (c = 0; c < len; c++) 194 if (p[c] != tolower(colname[c])) 195 break; 196 197 return (colname[c] == '\0'); 198 #else 199 return (B_FALSE); 200 #endif 201 } 202 203 204 /* 205 * Given a property name, returns the corresponding property ID. 206 */ 207 zfs_prop_t 208 zfs_name_to_prop(const char *propname) 209 { 210 int i; 211 212 for (i = 0; i < ZFS_NPROP_ALL; i++) { 213 if (propname_match(propname, i, strlen(propname))) 214 return (i); 215 } 216 217 return (ZFS_PROP_INVAL); 218 } 219 220 /* 221 * For user property names, we allow all lowercase alphanumeric characters, plus 222 * a few useful punctuation characters. 223 */ 224 static int 225 valid_char(char c) 226 { 227 return ((c >= 'a' && c <= 'z') || 228 (c >= '0' && c <= '9') || 229 c == '-' || c == '_' || c == '.' || c == ':'); 230 } 231 232 /* 233 * Returns true if this is a valid user-defined property (one with a ':'). 234 */ 235 boolean_t 236 zfs_prop_user(const char *name) 237 { 238 int i; 239 char c; 240 boolean_t foundsep = B_FALSE; 241 242 for (i = 0; i < strlen(name); i++) { 243 c = name[i]; 244 if (!valid_char(c)) 245 return (B_FALSE); 246 if (c == ':') 247 foundsep = B_TRUE; 248 } 249 250 if (!foundsep) 251 return (B_FALSE); 252 253 return (B_TRUE); 254 } 255 256 /* 257 * Return the default value for the given property. 258 */ 259 const char * 260 zfs_prop_default_string(zfs_prop_t prop) 261 { 262 return (zfs_prop_table[prop].pd_strdefault); 263 } 264 265 uint64_t 266 zfs_prop_default_numeric(zfs_prop_t prop) 267 { 268 return (zfs_prop_table[prop].pd_numdefault); 269 } 270 271 /* 272 * Returns TRUE if the property is readonly. 273 */ 274 int 275 zfs_prop_readonly(zfs_prop_t prop) 276 { 277 return (zfs_prop_table[prop].pd_attr == prop_readonly); 278 } 279 280 /* 281 * Given a property ID, returns the corresponding name. 282 */ 283 const char * 284 zfs_prop_to_name(zfs_prop_t prop) 285 { 286 return (zfs_prop_table[prop].pd_name); 287 } 288 289 /* 290 * Returns TRUE if the property is inheritable. 291 */ 292 int 293 zfs_prop_inheritable(zfs_prop_t prop) 294 { 295 return (zfs_prop_table[prop].pd_attr == prop_inherit); 296 } 297 298 #ifndef _KERNEL 299 300 typedef struct zfs_index { 301 const char *name; 302 uint64_t index; 303 } zfs_index_t; 304 305 static zfs_index_t checksum_table[] = { 306 { "on", ZIO_CHECKSUM_ON }, 307 { "off", ZIO_CHECKSUM_OFF }, 308 { "fletcher2", ZIO_CHECKSUM_FLETCHER_2 }, 309 { "fletcher4", ZIO_CHECKSUM_FLETCHER_4 }, 310 { "sha256", ZIO_CHECKSUM_SHA256 }, 311 { NULL } 312 }; 313 314 static zfs_index_t compress_table[] = { 315 { "on", ZIO_COMPRESS_ON }, 316 { "off", ZIO_COMPRESS_OFF }, 317 { "lzjb", ZIO_COMPRESS_LZJB }, 318 { NULL } 319 }; 320 321 static zfs_index_t snapdir_table[] = { 322 { "hidden", ZFS_SNAPDIR_HIDDEN }, 323 { "visible", ZFS_SNAPDIR_VISIBLE }, 324 { NULL } 325 }; 326 327 static zfs_index_t acl_mode_table[] = { 328 { "discard", ZFS_ACL_DISCARD }, 329 { "groupmask", ZFS_ACL_GROUPMASK }, 330 { "passthrough", ZFS_ACL_PASSTHROUGH }, 331 { NULL } 332 }; 333 334 static zfs_index_t acl_inherit_table[] = { 335 { "discard", ZFS_ACL_DISCARD }, 336 { "noallow", ZFS_ACL_NOALLOW }, 337 { "secure", ZFS_ACL_SECURE }, 338 { "passthrough", ZFS_ACL_PASSTHROUGH }, 339 { NULL } 340 }; 341 342 static zfs_index_t * 343 zfs_prop_index_table(zfs_prop_t prop) 344 { 345 switch (prop) { 346 case ZFS_PROP_CHECKSUM: 347 return (checksum_table); 348 break; 349 case ZFS_PROP_COMPRESSION: 350 return (compress_table); 351 break; 352 case ZFS_PROP_SNAPDIR: 353 return (snapdir_table); 354 break; 355 case ZFS_PROP_ACLMODE: 356 return (acl_mode_table); 357 break; 358 case ZFS_PROP_ACLINHERIT: 359 return (acl_inherit_table); 360 break; 361 default: 362 return (NULL); 363 } 364 } 365 366 367 /* 368 * Tables of index types, plus functions to convert between the user view 369 * (strings) and internal representation (uint64_t). 370 */ 371 int 372 zfs_prop_string_to_index(zfs_prop_t prop, const char *string, uint64_t *index) 373 { 374 zfs_index_t *table; 375 int i; 376 377 if ((table = zfs_prop_index_table(prop)) == NULL) 378 return (-1); 379 380 for (i = 0; table[i].name != NULL; i++) { 381 if (strcmp(string, table[i].name) == 0) { 382 *index = table[i].index; 383 return (0); 384 } 385 } 386 387 return (-1); 388 } 389 390 int 391 zfs_prop_index_to_string(zfs_prop_t prop, uint64_t index, const char **string) 392 { 393 zfs_index_t *table; 394 int i; 395 396 if ((table = zfs_prop_index_table(prop)) == NULL) 397 return (-1); 398 399 for (i = 0; table[i].name != NULL; i++) { 400 if (table[i].index == index) { 401 *string = table[i].name; 402 return (0); 403 } 404 } 405 406 return (-1); 407 } 408 409 /* 410 * Returns TRUE if the property applies to the given dataset types. 411 */ 412 int 413 zfs_prop_valid_for_type(zfs_prop_t prop, int types) 414 { 415 return ((zfs_prop_table[prop].pd_types & types) != 0); 416 } 417 418 /* 419 * Returns a string describing the set of acceptable values for the given 420 * property, or NULL if it cannot be set. 421 */ 422 const char * 423 zfs_prop_values(zfs_prop_t prop) 424 { 425 return (zfs_prop_table[prop].pd_values); 426 } 427 428 /* 429 * Returns TRUE if this property is a string type. Note that index types 430 * (compression, checksum) are treated as strings in userland, even though they 431 * are stored numerically on disk. 432 */ 433 int 434 zfs_prop_is_string(zfs_prop_t prop) 435 { 436 return (zfs_prop_table[prop].pd_proptype == prop_type_string || 437 zfs_prop_table[prop].pd_proptype == prop_type_index); 438 } 439 440 /* 441 * Returns the column header for the given property. Used only in 442 * 'zfs list -o', but centralized here with the other property information. 443 */ 444 const char * 445 zfs_prop_column_name(zfs_prop_t prop) 446 { 447 return (zfs_prop_table[prop].pd_colname); 448 } 449 450 /* 451 * Returns whether the given property should be displayed right-justified for 452 * 'zfs list'. 453 */ 454 boolean_t 455 zfs_prop_align_right(zfs_prop_t prop) 456 { 457 return (zfs_prop_table[prop].pd_rightalign); 458 } 459 460 /* 461 * Determines the minimum width for the column, and indicates whether it's fixed 462 * or not. Only string columns are non-fixed. 463 */ 464 size_t 465 zfs_prop_width(zfs_prop_t prop, boolean_t *fixed) 466 { 467 prop_desc_t *pd = &zfs_prop_table[prop]; 468 zfs_index_t *idx; 469 size_t ret; 470 int i; 471 472 *fixed = B_TRUE; 473 474 /* 475 * Start with the width of the column name. 476 */ 477 ret = strlen(pd->pd_colname); 478 479 /* 480 * For fixed-width values, make sure the width is large enough to hold 481 * any possible value. 482 */ 483 switch (pd->pd_proptype) { 484 case prop_type_number: 485 /* 486 * The maximum length of a human-readable number is 5 characters 487 * ("20.4M", for example). 488 */ 489 if (ret < 5) 490 ret = 5; 491 /* 492 * 'creation' is handled specially because it's a number 493 * internally, but displayed as a date string. 494 */ 495 if (prop == ZFS_PROP_CREATION) 496 *fixed = B_FALSE; 497 break; 498 case prop_type_boolean: 499 /* 500 * The maximum length of a boolean value is 3 characters, for 501 * "off". 502 */ 503 if (ret < 3) 504 ret = 3; 505 break; 506 case prop_type_index: 507 idx = zfs_prop_index_table(prop); 508 for (i = 0; idx[i].name != NULL; i++) { 509 if (strlen(idx[i].name) > ret) 510 ret = strlen(idx[i].name); 511 } 512 break; 513 514 case prop_type_string: 515 *fixed = B_FALSE; 516 break; 517 } 518 519 return (ret); 520 } 521 522 #endif 523