1eda14cbcSMatt Macy /* 2eda14cbcSMatt Macy * CDDL HEADER START 3eda14cbcSMatt Macy * 4eda14cbcSMatt Macy * The contents of this file are subject to the terms of the 5eda14cbcSMatt Macy * Common Development and Distribution License (the "License"). 6eda14cbcSMatt Macy * You may not use this file except in compliance with the License. 7eda14cbcSMatt Macy * 8eda14cbcSMatt Macy * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9271171e0SMartin Matuska * or https://opensource.org/licenses/CDDL-1.0. 10eda14cbcSMatt Macy * See the License for the specific language governing permissions 11eda14cbcSMatt Macy * and limitations under the License. 12eda14cbcSMatt Macy * 13eda14cbcSMatt Macy * When distributing Covered Code, include this CDDL HEADER in each 14eda14cbcSMatt Macy * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15eda14cbcSMatt Macy * If applicable, add the following below this CDDL HEADER, with the 16eda14cbcSMatt Macy * fields enclosed by brackets "[]" replaced with your own identifying 17eda14cbcSMatt Macy * information: Portions Copyright [yyyy] [name of copyright owner] 18eda14cbcSMatt Macy * 19eda14cbcSMatt Macy * CDDL HEADER END 20eda14cbcSMatt Macy */ 21eda14cbcSMatt Macy /* 22eda14cbcSMatt Macy * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved. 23eda14cbcSMatt Macy * Copyright 2011 Nexenta Systems, Inc. All rights reserved. 24eda14cbcSMatt Macy * Copyright (c) 2012, 2018 by Delphix. All rights reserved. 25ee36e25aSMartin Matuska * Copyright (c) 2021, Colm Buckley <colm@tuatha.org> 26681ce946SMartin Matuska * Copyright (c) 2021, Klara Inc. 27eda14cbcSMatt Macy */ 28eda14cbcSMatt Macy 29eda14cbcSMatt Macy #include <sys/zio.h> 30eda14cbcSMatt Macy #include <sys/spa.h> 31eda14cbcSMatt Macy #include <sys/zfs_acl.h> 32eda14cbcSMatt Macy #include <sys/zfs_ioctl.h> 33eda14cbcSMatt Macy #include <sys/fs/zfs.h> 34eda14cbcSMatt Macy 35eda14cbcSMatt Macy #include "zfs_prop.h" 36eda14cbcSMatt Macy 37eda14cbcSMatt Macy #if !defined(_KERNEL) 38eda14cbcSMatt Macy #include <stdlib.h> 39eda14cbcSMatt Macy #include <string.h> 40eda14cbcSMatt Macy #include <ctype.h> 41eda14cbcSMatt Macy #endif 42eda14cbcSMatt Macy 43eda14cbcSMatt Macy static zprop_desc_t zpool_prop_table[ZPOOL_NUM_PROPS]; 44681ce946SMartin Matuska static zprop_desc_t vdev_prop_table[VDEV_NUM_PROPS]; 45eda14cbcSMatt Macy 46eda14cbcSMatt Macy zprop_desc_t * 47eda14cbcSMatt Macy zpool_prop_get_table(void) 48eda14cbcSMatt Macy { 49eda14cbcSMatt Macy return (zpool_prop_table); 50eda14cbcSMatt Macy } 51eda14cbcSMatt Macy 52eda14cbcSMatt Macy void 53eda14cbcSMatt Macy zpool_prop_init(void) 54eda14cbcSMatt Macy { 55e92ffd9bSMartin Matuska static const zprop_index_t boolean_table[] = { 56eda14cbcSMatt Macy { "off", 0}, 57eda14cbcSMatt Macy { "on", 1}, 58eda14cbcSMatt Macy { NULL } 59eda14cbcSMatt Macy }; 60eda14cbcSMatt Macy 61e92ffd9bSMartin Matuska static const zprop_index_t failuremode_table[] = { 62eda14cbcSMatt Macy { "wait", ZIO_FAILURE_MODE_WAIT }, 63eda14cbcSMatt Macy { "continue", ZIO_FAILURE_MODE_CONTINUE }, 64eda14cbcSMatt Macy { "panic", ZIO_FAILURE_MODE_PANIC }, 65eda14cbcSMatt Macy { NULL } 66eda14cbcSMatt Macy }; 67eda14cbcSMatt Macy 68e92ffd9bSMartin Matuska struct zfs_mod_supported_features *sfeatures = 69e92ffd9bSMartin Matuska zfs_mod_list_supported(ZFS_SYSFS_POOL_PROPERTIES); 70e92ffd9bSMartin Matuska 71eda14cbcSMatt Macy /* string properties */ 72eda14cbcSMatt Macy zprop_register_string(ZPOOL_PROP_ALTROOT, "altroot", NULL, PROP_DEFAULT, 73e92ffd9bSMartin Matuska ZFS_TYPE_POOL, "<path>", "ALTROOT", sfeatures); 74eda14cbcSMatt Macy zprop_register_string(ZPOOL_PROP_BOOTFS, "bootfs", NULL, PROP_DEFAULT, 75e92ffd9bSMartin Matuska ZFS_TYPE_POOL, "<filesystem>", "BOOTFS", sfeatures); 76eda14cbcSMatt Macy zprop_register_string(ZPOOL_PROP_CACHEFILE, "cachefile", NULL, 77e92ffd9bSMartin Matuska PROP_DEFAULT, ZFS_TYPE_POOL, "<file> | none", "CACHEFILE", 78e92ffd9bSMartin Matuska sfeatures); 79eda14cbcSMatt Macy zprop_register_string(ZPOOL_PROP_COMMENT, "comment", NULL, 80e92ffd9bSMartin Matuska PROP_DEFAULT, ZFS_TYPE_POOL, "<comment-string>", "COMMENT", 81e92ffd9bSMartin Matuska sfeatures); 82ee36e25aSMartin Matuska zprop_register_string(ZPOOL_PROP_COMPATIBILITY, "compatibility", 83ee36e25aSMartin Matuska "off", PROP_DEFAULT, ZFS_TYPE_POOL, 84e92ffd9bSMartin Matuska "<file[,file...]> | off | legacy", "COMPATIBILITY", sfeatures); 85eda14cbcSMatt Macy 86eda14cbcSMatt Macy /* readonly number properties */ 87eda14cbcSMatt Macy zprop_register_number(ZPOOL_PROP_SIZE, "size", 0, PROP_READONLY, 88c03c5b1cSMartin Matuska ZFS_TYPE_POOL, "<size>", "SIZE", B_FALSE, sfeatures); 89eda14cbcSMatt Macy zprop_register_number(ZPOOL_PROP_FREE, "free", 0, PROP_READONLY, 90c03c5b1cSMartin Matuska ZFS_TYPE_POOL, "<size>", "FREE", B_FALSE, sfeatures); 91eda14cbcSMatt Macy zprop_register_number(ZPOOL_PROP_FREEING, "freeing", 0, PROP_READONLY, 92c03c5b1cSMartin Matuska ZFS_TYPE_POOL, "<size>", "FREEING", B_FALSE, sfeatures); 93eda14cbcSMatt Macy zprop_register_number(ZPOOL_PROP_CHECKPOINT, "checkpoint", 0, 94c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_POOL, "<size>", "CKPOINT", B_FALSE, 95c03c5b1cSMartin Matuska sfeatures); 96eda14cbcSMatt Macy zprop_register_number(ZPOOL_PROP_LEAKED, "leaked", 0, PROP_READONLY, 97c03c5b1cSMartin Matuska ZFS_TYPE_POOL, "<size>", "LEAKED", B_FALSE, sfeatures); 98eda14cbcSMatt Macy zprop_register_number(ZPOOL_PROP_ALLOCATED, "allocated", 0, 99c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_POOL, "<size>", "ALLOC", B_FALSE, 100c03c5b1cSMartin Matuska sfeatures); 101eda14cbcSMatt Macy zprop_register_number(ZPOOL_PROP_EXPANDSZ, "expandsize", 0, 102c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_POOL, "<size>", "EXPANDSZ", B_FALSE, 103c03c5b1cSMartin Matuska sfeatures); 104eda14cbcSMatt Macy zprop_register_number(ZPOOL_PROP_FRAGMENTATION, "fragmentation", 0, 105c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_POOL, "<percent>", "FRAG", B_FALSE, 106c03c5b1cSMartin Matuska sfeatures); 107eda14cbcSMatt Macy zprop_register_number(ZPOOL_PROP_CAPACITY, "capacity", 0, PROP_READONLY, 108c03c5b1cSMartin Matuska ZFS_TYPE_POOL, "<size>", "CAP", B_FALSE, sfeatures); 109eda14cbcSMatt Macy zprop_register_number(ZPOOL_PROP_GUID, "guid", 0, PROP_READONLY, 110c03c5b1cSMartin Matuska ZFS_TYPE_POOL, "<guid>", "GUID", B_TRUE, sfeatures); 111eda14cbcSMatt Macy zprop_register_number(ZPOOL_PROP_LOAD_GUID, "load_guid", 0, 112e92ffd9bSMartin Matuska PROP_READONLY, ZFS_TYPE_POOL, "<load_guid>", "LOAD_GUID", 113c03c5b1cSMartin Matuska B_TRUE, sfeatures); 114eda14cbcSMatt Macy zprop_register_number(ZPOOL_PROP_HEALTH, "health", 0, PROP_READONLY, 115c03c5b1cSMartin Matuska ZFS_TYPE_POOL, "<state>", "HEALTH", B_FALSE, sfeatures); 116eda14cbcSMatt Macy zprop_register_number(ZPOOL_PROP_DEDUPRATIO, "dedupratio", 0, 117eda14cbcSMatt Macy PROP_READONLY, ZFS_TYPE_POOL, "<1.00x or higher if deduped>", 118c03c5b1cSMartin Matuska "DEDUP", B_FALSE, sfeatures); 119*2a58b312SMartin Matuska zprop_register_number(ZPOOL_PROP_BCLONEUSED, "bcloneused", 0, 120*2a58b312SMartin Matuska PROP_READONLY, ZFS_TYPE_POOL, "<size>", 121*2a58b312SMartin Matuska "BCLONE_USED", B_FALSE, sfeatures); 122*2a58b312SMartin Matuska zprop_register_number(ZPOOL_PROP_BCLONESAVED, "bclonesaved", 0, 123*2a58b312SMartin Matuska PROP_READONLY, ZFS_TYPE_POOL, "<size>", 124*2a58b312SMartin Matuska "BCLONE_SAVED", B_FALSE, sfeatures); 125*2a58b312SMartin Matuska zprop_register_number(ZPOOL_PROP_BCLONERATIO, "bcloneratio", 0, 126*2a58b312SMartin Matuska PROP_READONLY, ZFS_TYPE_POOL, "<1.00x or higher if cloned>", 127*2a58b312SMartin Matuska "BCLONE_RATIO", B_FALSE, sfeatures); 128eda14cbcSMatt Macy 129eda14cbcSMatt Macy /* default number properties */ 130eda14cbcSMatt Macy zprop_register_number(ZPOOL_PROP_VERSION, "version", SPA_VERSION, 131c03c5b1cSMartin Matuska PROP_DEFAULT, ZFS_TYPE_POOL, "<version>", "VERSION", B_FALSE, 132c03c5b1cSMartin Matuska sfeatures); 133eda14cbcSMatt Macy zprop_register_number(ZPOOL_PROP_ASHIFT, "ashift", 0, PROP_DEFAULT, 134c03c5b1cSMartin Matuska ZFS_TYPE_POOL, "<ashift, 9-16, or 0=default>", "ASHIFT", B_FALSE, 135c03c5b1cSMartin Matuska sfeatures); 136eda14cbcSMatt Macy 137eda14cbcSMatt Macy /* default index (boolean) properties */ 138eda14cbcSMatt Macy zprop_register_index(ZPOOL_PROP_DELEGATION, "delegation", 1, 139eda14cbcSMatt Macy PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "DELEGATION", 140e92ffd9bSMartin Matuska boolean_table, sfeatures); 141eda14cbcSMatt Macy zprop_register_index(ZPOOL_PROP_AUTOREPLACE, "autoreplace", 0, 142e92ffd9bSMartin Matuska PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "REPLACE", boolean_table, 143e92ffd9bSMartin Matuska sfeatures); 144eda14cbcSMatt Macy zprop_register_index(ZPOOL_PROP_LISTSNAPS, "listsnapshots", 0, 145eda14cbcSMatt Macy PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "LISTSNAPS", 146e92ffd9bSMartin Matuska boolean_table, sfeatures); 147eda14cbcSMatt Macy zprop_register_index(ZPOOL_PROP_AUTOEXPAND, "autoexpand", 0, 148e92ffd9bSMartin Matuska PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "EXPAND", boolean_table, 149e92ffd9bSMartin Matuska sfeatures); 150eda14cbcSMatt Macy zprop_register_index(ZPOOL_PROP_READONLY, "readonly", 0, 151e92ffd9bSMartin Matuska PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "RDONLY", boolean_table, 152e92ffd9bSMartin Matuska sfeatures); 153eda14cbcSMatt Macy zprop_register_index(ZPOOL_PROP_MULTIHOST, "multihost", 0, 154eda14cbcSMatt Macy PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "MULTIHOST", 155e92ffd9bSMartin Matuska boolean_table, sfeatures); 156eda14cbcSMatt Macy 157eda14cbcSMatt Macy /* default index properties */ 158eda14cbcSMatt Macy zprop_register_index(ZPOOL_PROP_FAILUREMODE, "failmode", 159eda14cbcSMatt Macy ZIO_FAILURE_MODE_WAIT, PROP_DEFAULT, ZFS_TYPE_POOL, 160e92ffd9bSMartin Matuska "wait | continue | panic", "FAILMODE", failuremode_table, 161e92ffd9bSMartin Matuska sfeatures); 162eda14cbcSMatt Macy zprop_register_index(ZPOOL_PROP_AUTOTRIM, "autotrim", 163eda14cbcSMatt Macy SPA_AUTOTRIM_DEFAULT, PROP_DEFAULT, ZFS_TYPE_POOL, 164e92ffd9bSMartin Matuska "on | off", "AUTOTRIM", boolean_table, sfeatures); 165eda14cbcSMatt Macy 166eda14cbcSMatt Macy /* hidden properties */ 167eda14cbcSMatt Macy zprop_register_hidden(ZPOOL_PROP_NAME, "name", PROP_TYPE_STRING, 168c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_POOL, "NAME", B_TRUE, sfeatures); 169eda14cbcSMatt Macy zprop_register_hidden(ZPOOL_PROP_MAXBLOCKSIZE, "maxblocksize", 170e92ffd9bSMartin Matuska PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_POOL, "MAXBLOCKSIZE", 171c03c5b1cSMartin Matuska B_FALSE, sfeatures); 172eda14cbcSMatt Macy zprop_register_hidden(ZPOOL_PROP_TNAME, "tname", PROP_TYPE_STRING, 173c03c5b1cSMartin Matuska PROP_ONETIME, ZFS_TYPE_POOL, "TNAME", B_TRUE, sfeatures); 174eda14cbcSMatt Macy zprop_register_hidden(ZPOOL_PROP_MAXDNODESIZE, "maxdnodesize", 175e92ffd9bSMartin Matuska PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_POOL, "MAXDNODESIZE", 176c03c5b1cSMartin Matuska B_FALSE, sfeatures); 177eda14cbcSMatt Macy zprop_register_hidden(ZPOOL_PROP_DEDUPDITTO, "dedupditto", 178e92ffd9bSMartin Matuska PROP_TYPE_NUMBER, PROP_DEFAULT, ZFS_TYPE_POOL, "DEDUPDITTO", 179c03c5b1cSMartin Matuska B_FALSE, sfeatures); 180e92ffd9bSMartin Matuska 181e92ffd9bSMartin Matuska zfs_mod_list_supported_free(sfeatures); 182eda14cbcSMatt Macy } 183eda14cbcSMatt Macy 184eda14cbcSMatt Macy /* 185eda14cbcSMatt Macy * Given a property name and its type, returns the corresponding property ID. 186eda14cbcSMatt Macy */ 187eda14cbcSMatt Macy zpool_prop_t 188eda14cbcSMatt Macy zpool_name_to_prop(const char *propname) 189eda14cbcSMatt Macy { 190eda14cbcSMatt Macy return (zprop_name_to_prop(propname, ZFS_TYPE_POOL)); 191eda14cbcSMatt Macy } 192eda14cbcSMatt Macy 193eda14cbcSMatt Macy /* 194eda14cbcSMatt Macy * Given a pool property ID, returns the corresponding name. 195eda14cbcSMatt Macy * Assuming the pool property ID is valid. 196eda14cbcSMatt Macy */ 197eda14cbcSMatt Macy const char * 198eda14cbcSMatt Macy zpool_prop_to_name(zpool_prop_t prop) 199eda14cbcSMatt Macy { 200eda14cbcSMatt Macy return (zpool_prop_table[prop].pd_name); 201eda14cbcSMatt Macy } 202eda14cbcSMatt Macy 203eda14cbcSMatt Macy zprop_type_t 204eda14cbcSMatt Macy zpool_prop_get_type(zpool_prop_t prop) 205eda14cbcSMatt Macy { 206eda14cbcSMatt Macy return (zpool_prop_table[prop].pd_proptype); 207eda14cbcSMatt Macy } 208eda14cbcSMatt Macy 209eda14cbcSMatt Macy boolean_t 210eda14cbcSMatt Macy zpool_prop_readonly(zpool_prop_t prop) 211eda14cbcSMatt Macy { 212eda14cbcSMatt Macy return (zpool_prop_table[prop].pd_attr == PROP_READONLY); 213eda14cbcSMatt Macy } 214eda14cbcSMatt Macy 215eda14cbcSMatt Macy boolean_t 216eda14cbcSMatt Macy zpool_prop_setonce(zpool_prop_t prop) 217eda14cbcSMatt Macy { 218eda14cbcSMatt Macy return (zpool_prop_table[prop].pd_attr == PROP_ONETIME); 219eda14cbcSMatt Macy } 220eda14cbcSMatt Macy 221eda14cbcSMatt Macy const char * 222eda14cbcSMatt Macy zpool_prop_default_string(zpool_prop_t prop) 223eda14cbcSMatt Macy { 224eda14cbcSMatt Macy return (zpool_prop_table[prop].pd_strdefault); 225eda14cbcSMatt Macy } 226eda14cbcSMatt Macy 227eda14cbcSMatt Macy uint64_t 228eda14cbcSMatt Macy zpool_prop_default_numeric(zpool_prop_t prop) 229eda14cbcSMatt Macy { 230eda14cbcSMatt Macy return (zpool_prop_table[prop].pd_numdefault); 231eda14cbcSMatt Macy } 232eda14cbcSMatt Macy 233eda14cbcSMatt Macy /* 234eda14cbcSMatt Macy * Returns true if this is a valid feature@ property. 235eda14cbcSMatt Macy */ 236eda14cbcSMatt Macy boolean_t 237eda14cbcSMatt Macy zpool_prop_feature(const char *name) 238eda14cbcSMatt Macy { 239eda14cbcSMatt Macy static const char *prefix = "feature@"; 240eda14cbcSMatt Macy return (strncmp(name, prefix, strlen(prefix)) == 0); 241eda14cbcSMatt Macy } 242eda14cbcSMatt Macy 243eda14cbcSMatt Macy /* 244eda14cbcSMatt Macy * Returns true if this is a valid unsupported@ property. 245eda14cbcSMatt Macy */ 246eda14cbcSMatt Macy boolean_t 247eda14cbcSMatt Macy zpool_prop_unsupported(const char *name) 248eda14cbcSMatt Macy { 249eda14cbcSMatt Macy static const char *prefix = "unsupported@"; 250eda14cbcSMatt Macy return (strncmp(name, prefix, strlen(prefix)) == 0); 251eda14cbcSMatt Macy } 252eda14cbcSMatt Macy 253eda14cbcSMatt Macy int 254eda14cbcSMatt Macy zpool_prop_string_to_index(zpool_prop_t prop, const char *string, 255eda14cbcSMatt Macy uint64_t *index) 256eda14cbcSMatt Macy { 257eda14cbcSMatt Macy return (zprop_string_to_index(prop, string, index, ZFS_TYPE_POOL)); 258eda14cbcSMatt Macy } 259eda14cbcSMatt Macy 260eda14cbcSMatt Macy int 261eda14cbcSMatt Macy zpool_prop_index_to_string(zpool_prop_t prop, uint64_t index, 262eda14cbcSMatt Macy const char **string) 263eda14cbcSMatt Macy { 264eda14cbcSMatt Macy return (zprop_index_to_string(prop, index, string, ZFS_TYPE_POOL)); 265eda14cbcSMatt Macy } 266eda14cbcSMatt Macy 267eda14cbcSMatt Macy uint64_t 268eda14cbcSMatt Macy zpool_prop_random_value(zpool_prop_t prop, uint64_t seed) 269eda14cbcSMatt Macy { 270eda14cbcSMatt Macy return (zprop_random_value(prop, seed, ZFS_TYPE_POOL)); 271eda14cbcSMatt Macy } 272eda14cbcSMatt Macy 273eda14cbcSMatt Macy #ifndef _KERNEL 274eda14cbcSMatt Macy #include <libzfs.h> 275eda14cbcSMatt Macy 276eda14cbcSMatt Macy const char * 277eda14cbcSMatt Macy zpool_prop_values(zpool_prop_t prop) 278eda14cbcSMatt Macy { 279eda14cbcSMatt Macy return (zpool_prop_table[prop].pd_values); 280eda14cbcSMatt Macy } 281eda14cbcSMatt Macy 282eda14cbcSMatt Macy const char * 283eda14cbcSMatt Macy zpool_prop_column_name(zpool_prop_t prop) 284eda14cbcSMatt Macy { 285eda14cbcSMatt Macy return (zpool_prop_table[prop].pd_colname); 286eda14cbcSMatt Macy } 287eda14cbcSMatt Macy 288eda14cbcSMatt Macy boolean_t 289eda14cbcSMatt Macy zpool_prop_align_right(zpool_prop_t prop) 290eda14cbcSMatt Macy { 291eda14cbcSMatt Macy return (zpool_prop_table[prop].pd_rightalign); 292eda14cbcSMatt Macy } 293eda14cbcSMatt Macy #endif 294eda14cbcSMatt Macy 295681ce946SMartin Matuska zprop_desc_t * 296681ce946SMartin Matuska vdev_prop_get_table(void) 297681ce946SMartin Matuska { 298681ce946SMartin Matuska return (vdev_prop_table); 299681ce946SMartin Matuska } 300681ce946SMartin Matuska 301681ce946SMartin Matuska void 302681ce946SMartin Matuska vdev_prop_init(void) 303681ce946SMartin Matuska { 304e92ffd9bSMartin Matuska static const zprop_index_t boolean_table[] = { 305681ce946SMartin Matuska { "off", 0}, 306681ce946SMartin Matuska { "on", 1}, 307681ce946SMartin Matuska { NULL } 308681ce946SMartin Matuska }; 309e92ffd9bSMartin Matuska static const zprop_index_t boolean_na_table[] = { 310681ce946SMartin Matuska { "off", 0}, 311681ce946SMartin Matuska { "on", 1}, 312681ce946SMartin Matuska { "-", 2}, /* ZPROP_BOOLEAN_NA */ 313681ce946SMartin Matuska { NULL } 314681ce946SMartin Matuska }; 315681ce946SMartin Matuska 316e92ffd9bSMartin Matuska struct zfs_mod_supported_features *sfeatures = 317e92ffd9bSMartin Matuska zfs_mod_list_supported(ZFS_SYSFS_VDEV_PROPERTIES); 318e92ffd9bSMartin Matuska 319681ce946SMartin Matuska /* string properties */ 320681ce946SMartin Matuska zprop_register_string(VDEV_PROP_COMMENT, "comment", NULL, 321e92ffd9bSMartin Matuska PROP_DEFAULT, ZFS_TYPE_VDEV, "<comment-string>", "COMMENT", 322e92ffd9bSMartin Matuska sfeatures); 323681ce946SMartin Matuska zprop_register_string(VDEV_PROP_PATH, "path", NULL, 324e92ffd9bSMartin Matuska PROP_DEFAULT, ZFS_TYPE_VDEV, "<device-path>", "PATH", sfeatures); 325681ce946SMartin Matuska zprop_register_string(VDEV_PROP_DEVID, "devid", NULL, 326e92ffd9bSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<devid>", "DEVID", sfeatures); 327681ce946SMartin Matuska zprop_register_string(VDEV_PROP_PHYS_PATH, "physpath", NULL, 328e92ffd9bSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<physpath>", "PHYSPATH", sfeatures); 329681ce946SMartin Matuska zprop_register_string(VDEV_PROP_ENC_PATH, "encpath", NULL, 330e92ffd9bSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<encpath>", "ENCPATH", sfeatures); 331681ce946SMartin Matuska zprop_register_string(VDEV_PROP_FRU, "fru", NULL, 332e92ffd9bSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<fru>", "FRU", sfeatures); 333681ce946SMartin Matuska zprop_register_string(VDEV_PROP_PARENT, "parent", NULL, 334e92ffd9bSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<parent>", "PARENT", sfeatures); 335681ce946SMartin Matuska zprop_register_string(VDEV_PROP_CHILDREN, "children", NULL, 336e92ffd9bSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<child[,...]>", "CHILDREN", 337e92ffd9bSMartin Matuska sfeatures); 338681ce946SMartin Matuska 339681ce946SMartin Matuska /* readonly number properties */ 340681ce946SMartin Matuska zprop_register_number(VDEV_PROP_SIZE, "size", 0, PROP_READONLY, 341c03c5b1cSMartin Matuska ZFS_TYPE_VDEV, "<size>", "SIZE", B_FALSE, sfeatures); 342681ce946SMartin Matuska zprop_register_number(VDEV_PROP_FREE, "free", 0, PROP_READONLY, 343c03c5b1cSMartin Matuska ZFS_TYPE_VDEV, "<size>", "FREE", B_FALSE, sfeatures); 344681ce946SMartin Matuska zprop_register_number(VDEV_PROP_ALLOCATED, "allocated", 0, 345c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<size>", "ALLOC", B_FALSE, 346c03c5b1cSMartin Matuska sfeatures); 347681ce946SMartin Matuska zprop_register_number(VDEV_PROP_EXPANDSZ, "expandsize", 0, 348c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<size>", "EXPANDSZ", B_FALSE, 349c03c5b1cSMartin Matuska sfeatures); 350681ce946SMartin Matuska zprop_register_number(VDEV_PROP_FRAGMENTATION, "fragmentation", 0, 351c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<percent>", "FRAG", B_FALSE, 352c03c5b1cSMartin Matuska sfeatures); 353681ce946SMartin Matuska zprop_register_number(VDEV_PROP_CAPACITY, "capacity", 0, PROP_READONLY, 354c03c5b1cSMartin Matuska ZFS_TYPE_VDEV, "<size>", "CAP", B_FALSE, sfeatures); 355681ce946SMartin Matuska zprop_register_number(VDEV_PROP_GUID, "guid", 0, PROP_READONLY, 356c03c5b1cSMartin Matuska ZFS_TYPE_VDEV, "<guid>", "GUID", B_TRUE, sfeatures); 357681ce946SMartin Matuska zprop_register_number(VDEV_PROP_STATE, "state", 0, PROP_READONLY, 358c03c5b1cSMartin Matuska ZFS_TYPE_VDEV, "<state>", "STATE", B_FALSE, sfeatures); 359681ce946SMartin Matuska zprop_register_number(VDEV_PROP_BOOTSIZE, "bootsize", 0, PROP_READONLY, 360c03c5b1cSMartin Matuska ZFS_TYPE_VDEV, "<size>", "BOOTSIZE", B_FALSE, sfeatures); 361681ce946SMartin Matuska zprop_register_number(VDEV_PROP_ASIZE, "asize", 0, PROP_READONLY, 362c03c5b1cSMartin Matuska ZFS_TYPE_VDEV, "<asize>", "ASIZE", B_FALSE, sfeatures); 363681ce946SMartin Matuska zprop_register_number(VDEV_PROP_PSIZE, "psize", 0, PROP_READONLY, 364c03c5b1cSMartin Matuska ZFS_TYPE_VDEV, "<psize>", "PSIZE", B_FALSE, sfeatures); 365681ce946SMartin Matuska zprop_register_number(VDEV_PROP_ASHIFT, "ashift", 0, PROP_READONLY, 366c03c5b1cSMartin Matuska ZFS_TYPE_VDEV, "<ashift>", "ASHIFT", B_FALSE, sfeatures); 367681ce946SMartin Matuska zprop_register_number(VDEV_PROP_PARITY, "parity", 0, PROP_READONLY, 368c03c5b1cSMartin Matuska ZFS_TYPE_VDEV, "<parity>", "PARITY", B_FALSE, sfeatures); 369681ce946SMartin Matuska zprop_register_number(VDEV_PROP_NUMCHILDREN, "numchildren", 0, 370e92ffd9bSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<number-of-children>", "NUMCHILD", 371c03c5b1cSMartin Matuska B_FALSE, sfeatures); 372681ce946SMartin Matuska zprop_register_number(VDEV_PROP_READ_ERRORS, "read_errors", 0, 373c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<errors>", "RDERR", B_FALSE, 374c03c5b1cSMartin Matuska sfeatures); 375681ce946SMartin Matuska zprop_register_number(VDEV_PROP_WRITE_ERRORS, "write_errors", 0, 376c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<errors>", "WRERR", B_FALSE, 377c03c5b1cSMartin Matuska sfeatures); 378681ce946SMartin Matuska zprop_register_number(VDEV_PROP_CHECKSUM_ERRORS, "checksum_errors", 0, 379c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<errors>", "CKERR", B_FALSE, 380c03c5b1cSMartin Matuska sfeatures); 381681ce946SMartin Matuska zprop_register_number(VDEV_PROP_INITIALIZE_ERRORS, 382681ce946SMartin Matuska "initialize_errors", 0, PROP_READONLY, ZFS_TYPE_VDEV, "<errors>", 383c03c5b1cSMartin Matuska "INITERR", B_FALSE, sfeatures); 384681ce946SMartin Matuska zprop_register_number(VDEV_PROP_OPS_NULL, "null_ops", 0, 385c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<operations>", "NULLOP", B_FALSE, 386c03c5b1cSMartin Matuska sfeatures); 387681ce946SMartin Matuska zprop_register_number(VDEV_PROP_OPS_READ, "read_ops", 0, 388c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<operations>", "READOP", B_FALSE, 389c03c5b1cSMartin Matuska sfeatures); 390681ce946SMartin Matuska zprop_register_number(VDEV_PROP_OPS_WRITE, "write_ops", 0, 391c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<operations>", "WRITEOP", B_FALSE, 392c03c5b1cSMartin Matuska sfeatures); 393681ce946SMartin Matuska zprop_register_number(VDEV_PROP_OPS_FREE, "free_ops", 0, 394c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<operations>", "FREEOP", B_FALSE, 395c03c5b1cSMartin Matuska sfeatures); 396681ce946SMartin Matuska zprop_register_number(VDEV_PROP_OPS_CLAIM, "claim_ops", 0, 397c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<operations>", "CLAIMOP", B_FALSE, 398c03c5b1cSMartin Matuska sfeatures); 399681ce946SMartin Matuska zprop_register_number(VDEV_PROP_OPS_TRIM, "trim_ops", 0, 400c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<operations>", "TRIMOP", B_FALSE, 401c03c5b1cSMartin Matuska sfeatures); 402681ce946SMartin Matuska zprop_register_number(VDEV_PROP_BYTES_NULL, "null_bytes", 0, 403c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<bytes>", "NULLBYTE", B_FALSE, 404c03c5b1cSMartin Matuska sfeatures); 405681ce946SMartin Matuska zprop_register_number(VDEV_PROP_BYTES_READ, "read_bytes", 0, 406c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<bytes>", "READBYTE", B_FALSE, 407c03c5b1cSMartin Matuska sfeatures); 408681ce946SMartin Matuska zprop_register_number(VDEV_PROP_BYTES_WRITE, "write_bytes", 0, 409c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<bytes>", "WRITEBYTE", B_FALSE, 410c03c5b1cSMartin Matuska sfeatures); 411681ce946SMartin Matuska zprop_register_number(VDEV_PROP_BYTES_FREE, "free_bytes", 0, 412c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<bytes>", "FREEBYTE", B_FALSE, 413c03c5b1cSMartin Matuska sfeatures); 414681ce946SMartin Matuska zprop_register_number(VDEV_PROP_BYTES_CLAIM, "claim_bytes", 0, 415c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<bytes>", "CLAIMBYTE", B_FALSE, 416c03c5b1cSMartin Matuska sfeatures); 417681ce946SMartin Matuska zprop_register_number(VDEV_PROP_BYTES_TRIM, "trim_bytes", 0, 418c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "<bytes>", "TRIMBYTE", B_FALSE, 419c03c5b1cSMartin Matuska sfeatures); 420681ce946SMartin Matuska 421681ce946SMartin Matuska /* default numeric properties */ 42215f0b8c3SMartin Matuska zprop_register_number(VDEV_PROP_CHECKSUM_N, "checksum_n", UINT64_MAX, 42315f0b8c3SMartin Matuska PROP_DEFAULT, ZFS_TYPE_VDEV, "<events>", "CKSUM_N", B_FALSE, 42415f0b8c3SMartin Matuska sfeatures); 42515f0b8c3SMartin Matuska zprop_register_number(VDEV_PROP_CHECKSUM_T, "checksum_t", UINT64_MAX, 42615f0b8c3SMartin Matuska PROP_DEFAULT, ZFS_TYPE_VDEV, "<seconds>", "CKSUM_T", B_FALSE, 42715f0b8c3SMartin Matuska sfeatures); 42815f0b8c3SMartin Matuska zprop_register_number(VDEV_PROP_IO_N, "io_n", UINT64_MAX, 42915f0b8c3SMartin Matuska PROP_DEFAULT, ZFS_TYPE_VDEV, "<events>", "IO_N", B_FALSE, 43015f0b8c3SMartin Matuska sfeatures); 43115f0b8c3SMartin Matuska zprop_register_number(VDEV_PROP_IO_T, "io_t", UINT64_MAX, 43215f0b8c3SMartin Matuska PROP_DEFAULT, ZFS_TYPE_VDEV, "<seconds>", "IO_T", B_FALSE, 43315f0b8c3SMartin Matuska sfeatures); 434681ce946SMartin Matuska 435681ce946SMartin Matuska /* default index (boolean) properties */ 436681ce946SMartin Matuska zprop_register_index(VDEV_PROP_REMOVING, "removing", 0, 437681ce946SMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "on | off", "REMOVING", 438e92ffd9bSMartin Matuska boolean_table, sfeatures); 439681ce946SMartin Matuska zprop_register_index(VDEV_PROP_ALLOCATING, "allocating", 1, 440681ce946SMartin Matuska PROP_DEFAULT, ZFS_TYPE_VDEV, "on | off", "ALLOCATING", 441e92ffd9bSMartin Matuska boolean_na_table, sfeatures); 442681ce946SMartin Matuska 443681ce946SMartin Matuska /* default index properties */ 444dbd5678dSMartin Matuska zprop_register_index(VDEV_PROP_FAILFAST, "failfast", B_TRUE, 445dbd5678dSMartin Matuska PROP_DEFAULT, ZFS_TYPE_VDEV, "on | off", "FAILFAST", boolean_table, 446dbd5678dSMartin Matuska sfeatures); 447681ce946SMartin Matuska 448681ce946SMartin Matuska /* hidden properties */ 449681ce946SMartin Matuska zprop_register_hidden(VDEV_PROP_NAME, "name", PROP_TYPE_STRING, 450c03c5b1cSMartin Matuska PROP_READONLY, ZFS_TYPE_VDEV, "NAME", B_TRUE, sfeatures); 451e92ffd9bSMartin Matuska 452e92ffd9bSMartin Matuska zfs_mod_list_supported_free(sfeatures); 453681ce946SMartin Matuska } 454681ce946SMartin Matuska 455681ce946SMartin Matuska /* 456681ce946SMartin Matuska * Given a property name and its type, returns the corresponding property ID. 457681ce946SMartin Matuska */ 458681ce946SMartin Matuska vdev_prop_t 459681ce946SMartin Matuska vdev_name_to_prop(const char *propname) 460681ce946SMartin Matuska { 461681ce946SMartin Matuska return (zprop_name_to_prop(propname, ZFS_TYPE_VDEV)); 462681ce946SMartin Matuska } 463681ce946SMartin Matuska 464681ce946SMartin Matuska /* 465681ce946SMartin Matuska * Returns true if this is a valid user-defined property (one with a ':'). 466681ce946SMartin Matuska */ 467681ce946SMartin Matuska boolean_t 468681ce946SMartin Matuska vdev_prop_user(const char *name) 469681ce946SMartin Matuska { 470681ce946SMartin Matuska int i; 471681ce946SMartin Matuska char c; 472681ce946SMartin Matuska boolean_t foundsep = B_FALSE; 473681ce946SMartin Matuska 474681ce946SMartin Matuska for (i = 0; i < strlen(name); i++) { 475681ce946SMartin Matuska c = name[i]; 476681ce946SMartin Matuska if (!zprop_valid_char(c)) 477681ce946SMartin Matuska return (B_FALSE); 478681ce946SMartin Matuska if (c == ':') 479681ce946SMartin Matuska foundsep = B_TRUE; 480681ce946SMartin Matuska } 481681ce946SMartin Matuska 482681ce946SMartin Matuska return (foundsep); 483681ce946SMartin Matuska } 484681ce946SMartin Matuska 485681ce946SMartin Matuska /* 486681ce946SMartin Matuska * Given a pool property ID, returns the corresponding name. 487681ce946SMartin Matuska * Assuming the pool property ID is valid. 488681ce946SMartin Matuska */ 489681ce946SMartin Matuska const char * 490681ce946SMartin Matuska vdev_prop_to_name(vdev_prop_t prop) 491681ce946SMartin Matuska { 492681ce946SMartin Matuska return (vdev_prop_table[prop].pd_name); 493681ce946SMartin Matuska } 494681ce946SMartin Matuska 495681ce946SMartin Matuska zprop_type_t 496681ce946SMartin Matuska vdev_prop_get_type(vdev_prop_t prop) 497681ce946SMartin Matuska { 498681ce946SMartin Matuska return (vdev_prop_table[prop].pd_proptype); 499681ce946SMartin Matuska } 500681ce946SMartin Matuska 501681ce946SMartin Matuska boolean_t 502681ce946SMartin Matuska vdev_prop_readonly(vdev_prop_t prop) 503681ce946SMartin Matuska { 504681ce946SMartin Matuska return (vdev_prop_table[prop].pd_attr == PROP_READONLY); 505681ce946SMartin Matuska } 506681ce946SMartin Matuska 507681ce946SMartin Matuska const char * 508681ce946SMartin Matuska vdev_prop_default_string(vdev_prop_t prop) 509681ce946SMartin Matuska { 510681ce946SMartin Matuska return (vdev_prop_table[prop].pd_strdefault); 511681ce946SMartin Matuska } 512681ce946SMartin Matuska 513681ce946SMartin Matuska uint64_t 514681ce946SMartin Matuska vdev_prop_default_numeric(vdev_prop_t prop) 515681ce946SMartin Matuska { 516681ce946SMartin Matuska return (vdev_prop_table[prop].pd_numdefault); 517681ce946SMartin Matuska } 518681ce946SMartin Matuska 519681ce946SMartin Matuska int 520681ce946SMartin Matuska vdev_prop_string_to_index(vdev_prop_t prop, const char *string, 521681ce946SMartin Matuska uint64_t *index) 522681ce946SMartin Matuska { 523681ce946SMartin Matuska return (zprop_string_to_index(prop, string, index, ZFS_TYPE_VDEV)); 524681ce946SMartin Matuska } 525681ce946SMartin Matuska 526681ce946SMartin Matuska int 527681ce946SMartin Matuska vdev_prop_index_to_string(vdev_prop_t prop, uint64_t index, 528681ce946SMartin Matuska const char **string) 529681ce946SMartin Matuska { 530681ce946SMartin Matuska return (zprop_index_to_string(prop, index, string, ZFS_TYPE_VDEV)); 531681ce946SMartin Matuska } 532681ce946SMartin Matuska 533681ce946SMartin Matuska /* 534681ce946SMartin Matuska * Returns true if this is a valid vdev property. 535681ce946SMartin Matuska */ 536681ce946SMartin Matuska boolean_t 537681ce946SMartin Matuska zpool_prop_vdev(const char *name) 538681ce946SMartin Matuska { 539681ce946SMartin Matuska return (vdev_name_to_prop(name) != VDEV_PROP_INVAL); 540681ce946SMartin Matuska } 541681ce946SMartin Matuska 542681ce946SMartin Matuska uint64_t 543681ce946SMartin Matuska vdev_prop_random_value(vdev_prop_t prop, uint64_t seed) 544681ce946SMartin Matuska { 545681ce946SMartin Matuska return (zprop_random_value(prop, seed, ZFS_TYPE_VDEV)); 546681ce946SMartin Matuska } 547681ce946SMartin Matuska 548681ce946SMartin Matuska #ifndef _KERNEL 549681ce946SMartin Matuska const char * 550681ce946SMartin Matuska vdev_prop_values(vdev_prop_t prop) 551681ce946SMartin Matuska { 552681ce946SMartin Matuska return (vdev_prop_table[prop].pd_values); 553681ce946SMartin Matuska } 554681ce946SMartin Matuska 555681ce946SMartin Matuska const char * 556681ce946SMartin Matuska vdev_prop_column_name(vdev_prop_t prop) 557681ce946SMartin Matuska { 558681ce946SMartin Matuska return (vdev_prop_table[prop].pd_colname); 559681ce946SMartin Matuska } 560681ce946SMartin Matuska 561681ce946SMartin Matuska boolean_t 562681ce946SMartin Matuska vdev_prop_align_right(vdev_prop_t prop) 563681ce946SMartin Matuska { 564681ce946SMartin Matuska return (vdev_prop_table[prop].pd_rightalign); 565681ce946SMartin Matuska } 566681ce946SMartin Matuska #endif 567681ce946SMartin Matuska 568eda14cbcSMatt Macy #if defined(_KERNEL) 569eda14cbcSMatt Macy /* zpool property functions */ 570eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_init); 571eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_get_type); 572eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_get_table); 573eda14cbcSMatt Macy 574681ce946SMartin Matuska /* vdev property functions */ 575681ce946SMartin Matuska EXPORT_SYMBOL(vdev_prop_init); 576681ce946SMartin Matuska EXPORT_SYMBOL(vdev_prop_get_type); 577681ce946SMartin Matuska EXPORT_SYMBOL(vdev_prop_get_table); 578681ce946SMartin Matuska 579eda14cbcSMatt Macy /* Pool property functions shared between libzfs and kernel. */ 580eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_name_to_prop); 581eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_to_name); 582eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_default_string); 583eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_default_numeric); 584eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_readonly); 585eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_feature); 586eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_unsupported); 587eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_index_to_string); 588eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_string_to_index); 589681ce946SMartin Matuska EXPORT_SYMBOL(zpool_prop_vdev); 590681ce946SMartin Matuska 591681ce946SMartin Matuska /* vdev property functions shared between libzfs and kernel. */ 592681ce946SMartin Matuska EXPORT_SYMBOL(vdev_name_to_prop); 593681ce946SMartin Matuska EXPORT_SYMBOL(vdev_prop_user); 594681ce946SMartin Matuska EXPORT_SYMBOL(vdev_prop_to_name); 595681ce946SMartin Matuska EXPORT_SYMBOL(vdev_prop_default_string); 596681ce946SMartin Matuska EXPORT_SYMBOL(vdev_prop_default_numeric); 597681ce946SMartin Matuska EXPORT_SYMBOL(vdev_prop_readonly); 598681ce946SMartin Matuska EXPORT_SYMBOL(vdev_prop_index_to_string); 599681ce946SMartin Matuska EXPORT_SYMBOL(vdev_prop_string_to_index); 600eda14cbcSMatt Macy #endif 601