xref: /freebsd/sys/contrib/openzfs/module/zcommon/zpool_prop.c (revision 271171e0d97b88ba2a7c3bf750c9672b484c1c13)
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
9*271171e0SMartin 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);
119eda14cbcSMatt Macy 
120eda14cbcSMatt Macy 	/* default number properties */
121eda14cbcSMatt Macy 	zprop_register_number(ZPOOL_PROP_VERSION, "version", SPA_VERSION,
122c03c5b1cSMartin Matuska 	    PROP_DEFAULT, ZFS_TYPE_POOL, "<version>", "VERSION", B_FALSE,
123c03c5b1cSMartin Matuska 	    sfeatures);
124eda14cbcSMatt Macy 	zprop_register_number(ZPOOL_PROP_ASHIFT, "ashift", 0, PROP_DEFAULT,
125c03c5b1cSMartin Matuska 	    ZFS_TYPE_POOL, "<ashift, 9-16, or 0=default>", "ASHIFT", B_FALSE,
126c03c5b1cSMartin Matuska 	    sfeatures);
127eda14cbcSMatt Macy 
128eda14cbcSMatt Macy 	/* default index (boolean) properties */
129eda14cbcSMatt Macy 	zprop_register_index(ZPOOL_PROP_DELEGATION, "delegation", 1,
130eda14cbcSMatt Macy 	    PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "DELEGATION",
131e92ffd9bSMartin Matuska 	    boolean_table, sfeatures);
132eda14cbcSMatt Macy 	zprop_register_index(ZPOOL_PROP_AUTOREPLACE, "autoreplace", 0,
133e92ffd9bSMartin Matuska 	    PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "REPLACE", boolean_table,
134e92ffd9bSMartin Matuska 	    sfeatures);
135eda14cbcSMatt Macy 	zprop_register_index(ZPOOL_PROP_LISTSNAPS, "listsnapshots", 0,
136eda14cbcSMatt Macy 	    PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "LISTSNAPS",
137e92ffd9bSMartin Matuska 	    boolean_table, sfeatures);
138eda14cbcSMatt Macy 	zprop_register_index(ZPOOL_PROP_AUTOEXPAND, "autoexpand", 0,
139e92ffd9bSMartin Matuska 	    PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "EXPAND", boolean_table,
140e92ffd9bSMartin Matuska 	    sfeatures);
141eda14cbcSMatt Macy 	zprop_register_index(ZPOOL_PROP_READONLY, "readonly", 0,
142e92ffd9bSMartin Matuska 	    PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "RDONLY", boolean_table,
143e92ffd9bSMartin Matuska 	    sfeatures);
144eda14cbcSMatt Macy 	zprop_register_index(ZPOOL_PROP_MULTIHOST, "multihost", 0,
145eda14cbcSMatt Macy 	    PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "MULTIHOST",
146e92ffd9bSMartin Matuska 	    boolean_table, sfeatures);
147eda14cbcSMatt Macy 
148eda14cbcSMatt Macy 	/* default index properties */
149eda14cbcSMatt Macy 	zprop_register_index(ZPOOL_PROP_FAILUREMODE, "failmode",
150eda14cbcSMatt Macy 	    ZIO_FAILURE_MODE_WAIT, PROP_DEFAULT, ZFS_TYPE_POOL,
151e92ffd9bSMartin Matuska 	    "wait | continue | panic", "FAILMODE", failuremode_table,
152e92ffd9bSMartin Matuska 	    sfeatures);
153eda14cbcSMatt Macy 	zprop_register_index(ZPOOL_PROP_AUTOTRIM, "autotrim",
154eda14cbcSMatt Macy 	    SPA_AUTOTRIM_DEFAULT, PROP_DEFAULT, ZFS_TYPE_POOL,
155e92ffd9bSMartin Matuska 	    "on | off", "AUTOTRIM", boolean_table, sfeatures);
156eda14cbcSMatt Macy 
157eda14cbcSMatt Macy 	/* hidden properties */
158eda14cbcSMatt Macy 	zprop_register_hidden(ZPOOL_PROP_NAME, "name", PROP_TYPE_STRING,
159c03c5b1cSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_POOL, "NAME", B_TRUE, sfeatures);
160eda14cbcSMatt Macy 	zprop_register_hidden(ZPOOL_PROP_MAXBLOCKSIZE, "maxblocksize",
161e92ffd9bSMartin Matuska 	    PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_POOL, "MAXBLOCKSIZE",
162c03c5b1cSMartin Matuska 	    B_FALSE, sfeatures);
163eda14cbcSMatt Macy 	zprop_register_hidden(ZPOOL_PROP_TNAME, "tname", PROP_TYPE_STRING,
164c03c5b1cSMartin Matuska 	    PROP_ONETIME, ZFS_TYPE_POOL, "TNAME", B_TRUE, sfeatures);
165eda14cbcSMatt Macy 	zprop_register_hidden(ZPOOL_PROP_MAXDNODESIZE, "maxdnodesize",
166e92ffd9bSMartin Matuska 	    PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_POOL, "MAXDNODESIZE",
167c03c5b1cSMartin Matuska 	    B_FALSE, sfeatures);
168eda14cbcSMatt Macy 	zprop_register_hidden(ZPOOL_PROP_DEDUPDITTO, "dedupditto",
169e92ffd9bSMartin Matuska 	    PROP_TYPE_NUMBER, PROP_DEFAULT, ZFS_TYPE_POOL, "DEDUPDITTO",
170c03c5b1cSMartin Matuska 	    B_FALSE, sfeatures);
171e92ffd9bSMartin Matuska 
172e92ffd9bSMartin Matuska 	zfs_mod_list_supported_free(sfeatures);
173eda14cbcSMatt Macy }
174eda14cbcSMatt Macy 
175eda14cbcSMatt Macy /*
176eda14cbcSMatt Macy  * Given a property name and its type, returns the corresponding property ID.
177eda14cbcSMatt Macy  */
178eda14cbcSMatt Macy zpool_prop_t
179eda14cbcSMatt Macy zpool_name_to_prop(const char *propname)
180eda14cbcSMatt Macy {
181eda14cbcSMatt Macy 	return (zprop_name_to_prop(propname, ZFS_TYPE_POOL));
182eda14cbcSMatt Macy }
183eda14cbcSMatt Macy 
184eda14cbcSMatt Macy /*
185eda14cbcSMatt Macy  * Given a pool property ID, returns the corresponding name.
186eda14cbcSMatt Macy  * Assuming the pool property ID is valid.
187eda14cbcSMatt Macy  */
188eda14cbcSMatt Macy const char *
189eda14cbcSMatt Macy zpool_prop_to_name(zpool_prop_t prop)
190eda14cbcSMatt Macy {
191eda14cbcSMatt Macy 	return (zpool_prop_table[prop].pd_name);
192eda14cbcSMatt Macy }
193eda14cbcSMatt Macy 
194eda14cbcSMatt Macy zprop_type_t
195eda14cbcSMatt Macy zpool_prop_get_type(zpool_prop_t prop)
196eda14cbcSMatt Macy {
197eda14cbcSMatt Macy 	return (zpool_prop_table[prop].pd_proptype);
198eda14cbcSMatt Macy }
199eda14cbcSMatt Macy 
200eda14cbcSMatt Macy boolean_t
201eda14cbcSMatt Macy zpool_prop_readonly(zpool_prop_t prop)
202eda14cbcSMatt Macy {
203eda14cbcSMatt Macy 	return (zpool_prop_table[prop].pd_attr == PROP_READONLY);
204eda14cbcSMatt Macy }
205eda14cbcSMatt Macy 
206eda14cbcSMatt Macy boolean_t
207eda14cbcSMatt Macy zpool_prop_setonce(zpool_prop_t prop)
208eda14cbcSMatt Macy {
209eda14cbcSMatt Macy 	return (zpool_prop_table[prop].pd_attr == PROP_ONETIME);
210eda14cbcSMatt Macy }
211eda14cbcSMatt Macy 
212eda14cbcSMatt Macy const char *
213eda14cbcSMatt Macy zpool_prop_default_string(zpool_prop_t prop)
214eda14cbcSMatt Macy {
215eda14cbcSMatt Macy 	return (zpool_prop_table[prop].pd_strdefault);
216eda14cbcSMatt Macy }
217eda14cbcSMatt Macy 
218eda14cbcSMatt Macy uint64_t
219eda14cbcSMatt Macy zpool_prop_default_numeric(zpool_prop_t prop)
220eda14cbcSMatt Macy {
221eda14cbcSMatt Macy 	return (zpool_prop_table[prop].pd_numdefault);
222eda14cbcSMatt Macy }
223eda14cbcSMatt Macy 
224eda14cbcSMatt Macy /*
225eda14cbcSMatt Macy  * Returns true if this is a valid feature@ property.
226eda14cbcSMatt Macy  */
227eda14cbcSMatt Macy boolean_t
228eda14cbcSMatt Macy zpool_prop_feature(const char *name)
229eda14cbcSMatt Macy {
230eda14cbcSMatt Macy 	static const char *prefix = "feature@";
231eda14cbcSMatt Macy 	return (strncmp(name, prefix, strlen(prefix)) == 0);
232eda14cbcSMatt Macy }
233eda14cbcSMatt Macy 
234eda14cbcSMatt Macy /*
235eda14cbcSMatt Macy  * Returns true if this is a valid unsupported@ property.
236eda14cbcSMatt Macy  */
237eda14cbcSMatt Macy boolean_t
238eda14cbcSMatt Macy zpool_prop_unsupported(const char *name)
239eda14cbcSMatt Macy {
240eda14cbcSMatt Macy 	static const char *prefix = "unsupported@";
241eda14cbcSMatt Macy 	return (strncmp(name, prefix, strlen(prefix)) == 0);
242eda14cbcSMatt Macy }
243eda14cbcSMatt Macy 
244eda14cbcSMatt Macy int
245eda14cbcSMatt Macy zpool_prop_string_to_index(zpool_prop_t prop, const char *string,
246eda14cbcSMatt Macy     uint64_t *index)
247eda14cbcSMatt Macy {
248eda14cbcSMatt Macy 	return (zprop_string_to_index(prop, string, index, ZFS_TYPE_POOL));
249eda14cbcSMatt Macy }
250eda14cbcSMatt Macy 
251eda14cbcSMatt Macy int
252eda14cbcSMatt Macy zpool_prop_index_to_string(zpool_prop_t prop, uint64_t index,
253eda14cbcSMatt Macy     const char **string)
254eda14cbcSMatt Macy {
255eda14cbcSMatt Macy 	return (zprop_index_to_string(prop, index, string, ZFS_TYPE_POOL));
256eda14cbcSMatt Macy }
257eda14cbcSMatt Macy 
258eda14cbcSMatt Macy uint64_t
259eda14cbcSMatt Macy zpool_prop_random_value(zpool_prop_t prop, uint64_t seed)
260eda14cbcSMatt Macy {
261eda14cbcSMatt Macy 	return (zprop_random_value(prop, seed, ZFS_TYPE_POOL));
262eda14cbcSMatt Macy }
263eda14cbcSMatt Macy 
264eda14cbcSMatt Macy #ifndef _KERNEL
265eda14cbcSMatt Macy #include <libzfs.h>
266eda14cbcSMatt Macy 
267eda14cbcSMatt Macy const char *
268eda14cbcSMatt Macy zpool_prop_values(zpool_prop_t prop)
269eda14cbcSMatt Macy {
270eda14cbcSMatt Macy 	return (zpool_prop_table[prop].pd_values);
271eda14cbcSMatt Macy }
272eda14cbcSMatt Macy 
273eda14cbcSMatt Macy const char *
274eda14cbcSMatt Macy zpool_prop_column_name(zpool_prop_t prop)
275eda14cbcSMatt Macy {
276eda14cbcSMatt Macy 	return (zpool_prop_table[prop].pd_colname);
277eda14cbcSMatt Macy }
278eda14cbcSMatt Macy 
279eda14cbcSMatt Macy boolean_t
280eda14cbcSMatt Macy zpool_prop_align_right(zpool_prop_t prop)
281eda14cbcSMatt Macy {
282eda14cbcSMatt Macy 	return (zpool_prop_table[prop].pd_rightalign);
283eda14cbcSMatt Macy }
284eda14cbcSMatt Macy #endif
285eda14cbcSMatt Macy 
286681ce946SMartin Matuska zprop_desc_t *
287681ce946SMartin Matuska vdev_prop_get_table(void)
288681ce946SMartin Matuska {
289681ce946SMartin Matuska 	return (vdev_prop_table);
290681ce946SMartin Matuska }
291681ce946SMartin Matuska 
292681ce946SMartin Matuska void
293681ce946SMartin Matuska vdev_prop_init(void)
294681ce946SMartin Matuska {
295e92ffd9bSMartin Matuska 	static const zprop_index_t boolean_table[] = {
296681ce946SMartin Matuska 		{ "off",	0},
297681ce946SMartin Matuska 		{ "on",		1},
298681ce946SMartin Matuska 		{ NULL }
299681ce946SMartin Matuska 	};
300e92ffd9bSMartin Matuska 	static const zprop_index_t boolean_na_table[] = {
301681ce946SMartin Matuska 		{ "off",	0},
302681ce946SMartin Matuska 		{ "on",		1},
303681ce946SMartin Matuska 		{ "-",		2},	/* ZPROP_BOOLEAN_NA */
304681ce946SMartin Matuska 		{ NULL }
305681ce946SMartin Matuska 	};
306681ce946SMartin Matuska 
307e92ffd9bSMartin Matuska 	struct zfs_mod_supported_features *sfeatures =
308e92ffd9bSMartin Matuska 	    zfs_mod_list_supported(ZFS_SYSFS_VDEV_PROPERTIES);
309e92ffd9bSMartin Matuska 
310681ce946SMartin Matuska 	/* string properties */
311681ce946SMartin Matuska 	zprop_register_string(VDEV_PROP_COMMENT, "comment", NULL,
312e92ffd9bSMartin Matuska 	    PROP_DEFAULT, ZFS_TYPE_VDEV, "<comment-string>", "COMMENT",
313e92ffd9bSMartin Matuska 	    sfeatures);
314681ce946SMartin Matuska 	zprop_register_string(VDEV_PROP_PATH, "path", NULL,
315e92ffd9bSMartin Matuska 	    PROP_DEFAULT, ZFS_TYPE_VDEV, "<device-path>", "PATH", sfeatures);
316681ce946SMartin Matuska 	zprop_register_string(VDEV_PROP_DEVID, "devid", NULL,
317e92ffd9bSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<devid>", "DEVID", sfeatures);
318681ce946SMartin Matuska 	zprop_register_string(VDEV_PROP_PHYS_PATH, "physpath", NULL,
319e92ffd9bSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<physpath>", "PHYSPATH", sfeatures);
320681ce946SMartin Matuska 	zprop_register_string(VDEV_PROP_ENC_PATH, "encpath", NULL,
321e92ffd9bSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<encpath>", "ENCPATH", sfeatures);
322681ce946SMartin Matuska 	zprop_register_string(VDEV_PROP_FRU, "fru", NULL,
323e92ffd9bSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<fru>", "FRU", sfeatures);
324681ce946SMartin Matuska 	zprop_register_string(VDEV_PROP_PARENT, "parent", NULL,
325e92ffd9bSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<parent>", "PARENT", sfeatures);
326681ce946SMartin Matuska 	zprop_register_string(VDEV_PROP_CHILDREN, "children", NULL,
327e92ffd9bSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<child[,...]>", "CHILDREN",
328e92ffd9bSMartin Matuska 	    sfeatures);
329681ce946SMartin Matuska 
330681ce946SMartin Matuska 	/* readonly number properties */
331681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_SIZE, "size", 0, PROP_READONLY,
332c03c5b1cSMartin Matuska 	    ZFS_TYPE_VDEV, "<size>", "SIZE", B_FALSE, sfeatures);
333681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_FREE, "free", 0, PROP_READONLY,
334c03c5b1cSMartin Matuska 	    ZFS_TYPE_VDEV, "<size>", "FREE", B_FALSE, sfeatures);
335681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_ALLOCATED, "allocated", 0,
336c03c5b1cSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<size>", "ALLOC", B_FALSE,
337c03c5b1cSMartin Matuska 	    sfeatures);
338681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_EXPANDSZ, "expandsize", 0,
339c03c5b1cSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<size>", "EXPANDSZ", B_FALSE,
340c03c5b1cSMartin Matuska 	    sfeatures);
341681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_FRAGMENTATION, "fragmentation", 0,
342c03c5b1cSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<percent>", "FRAG", B_FALSE,
343c03c5b1cSMartin Matuska 	    sfeatures);
344681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_CAPACITY, "capacity", 0, PROP_READONLY,
345c03c5b1cSMartin Matuska 	    ZFS_TYPE_VDEV, "<size>", "CAP", B_FALSE, sfeatures);
346681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_GUID, "guid", 0, PROP_READONLY,
347c03c5b1cSMartin Matuska 	    ZFS_TYPE_VDEV, "<guid>", "GUID", B_TRUE, sfeatures);
348681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_STATE, "state", 0, PROP_READONLY,
349c03c5b1cSMartin Matuska 	    ZFS_TYPE_VDEV, "<state>", "STATE", B_FALSE, sfeatures);
350681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_BOOTSIZE, "bootsize", 0, PROP_READONLY,
351c03c5b1cSMartin Matuska 	    ZFS_TYPE_VDEV, "<size>", "BOOTSIZE", B_FALSE, sfeatures);
352681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_ASIZE, "asize", 0, PROP_READONLY,
353c03c5b1cSMartin Matuska 	    ZFS_TYPE_VDEV, "<asize>", "ASIZE", B_FALSE, sfeatures);
354681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_PSIZE, "psize", 0, PROP_READONLY,
355c03c5b1cSMartin Matuska 	    ZFS_TYPE_VDEV, "<psize>", "PSIZE", B_FALSE, sfeatures);
356681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_ASHIFT, "ashift", 0, PROP_READONLY,
357c03c5b1cSMartin Matuska 	    ZFS_TYPE_VDEV, "<ashift>", "ASHIFT", B_FALSE, sfeatures);
358681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_PARITY, "parity", 0, PROP_READONLY,
359c03c5b1cSMartin Matuska 	    ZFS_TYPE_VDEV, "<parity>", "PARITY", B_FALSE, sfeatures);
360681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_NUMCHILDREN, "numchildren", 0,
361e92ffd9bSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<number-of-children>", "NUMCHILD",
362c03c5b1cSMartin Matuska 	    B_FALSE, sfeatures);
363681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_READ_ERRORS, "read_errors", 0,
364c03c5b1cSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<errors>", "RDERR", B_FALSE,
365c03c5b1cSMartin Matuska 	    sfeatures);
366681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_WRITE_ERRORS, "write_errors", 0,
367c03c5b1cSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<errors>", "WRERR", B_FALSE,
368c03c5b1cSMartin Matuska 	    sfeatures);
369681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_CHECKSUM_ERRORS, "checksum_errors", 0,
370c03c5b1cSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<errors>", "CKERR", B_FALSE,
371c03c5b1cSMartin Matuska 	    sfeatures);
372681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_INITIALIZE_ERRORS,
373681ce946SMartin Matuska 	    "initialize_errors", 0, PROP_READONLY, ZFS_TYPE_VDEV, "<errors>",
374c03c5b1cSMartin Matuska 	    "INITERR", B_FALSE, sfeatures);
375681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_OPS_NULL, "null_ops", 0,
376c03c5b1cSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<operations>", "NULLOP", B_FALSE,
377c03c5b1cSMartin Matuska 	    sfeatures);
378681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_OPS_READ, "read_ops", 0,
379c03c5b1cSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<operations>", "READOP", B_FALSE,
380c03c5b1cSMartin Matuska 	    sfeatures);
381681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_OPS_WRITE, "write_ops", 0,
382c03c5b1cSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<operations>", "WRITEOP", B_FALSE,
383c03c5b1cSMartin Matuska 	    sfeatures);
384681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_OPS_FREE, "free_ops", 0,
385c03c5b1cSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<operations>", "FREEOP", B_FALSE,
386c03c5b1cSMartin Matuska 	    sfeatures);
387681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_OPS_CLAIM, "claim_ops", 0,
388c03c5b1cSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<operations>", "CLAIMOP", B_FALSE,
389c03c5b1cSMartin Matuska 	    sfeatures);
390681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_OPS_TRIM, "trim_ops", 0,
391c03c5b1cSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<operations>", "TRIMOP", B_FALSE,
392c03c5b1cSMartin Matuska 	    sfeatures);
393681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_BYTES_NULL, "null_bytes", 0,
394c03c5b1cSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<bytes>", "NULLBYTE", B_FALSE,
395c03c5b1cSMartin Matuska 	    sfeatures);
396681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_BYTES_READ, "read_bytes", 0,
397c03c5b1cSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<bytes>", "READBYTE", B_FALSE,
398c03c5b1cSMartin Matuska 	    sfeatures);
399681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_BYTES_WRITE, "write_bytes", 0,
400c03c5b1cSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<bytes>", "WRITEBYTE", B_FALSE,
401c03c5b1cSMartin Matuska 	    sfeatures);
402681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_BYTES_FREE, "free_bytes", 0,
403c03c5b1cSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<bytes>", "FREEBYTE", B_FALSE,
404c03c5b1cSMartin Matuska 	    sfeatures);
405681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_BYTES_CLAIM, "claim_bytes", 0,
406c03c5b1cSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<bytes>", "CLAIMBYTE", B_FALSE,
407c03c5b1cSMartin Matuska 	    sfeatures);
408681ce946SMartin Matuska 	zprop_register_number(VDEV_PROP_BYTES_TRIM, "trim_bytes", 0,
409c03c5b1cSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "<bytes>", "TRIMBYTE", B_FALSE,
410c03c5b1cSMartin Matuska 	    sfeatures);
411681ce946SMartin Matuska 
412681ce946SMartin Matuska 	/* default numeric properties */
413681ce946SMartin Matuska 
414681ce946SMartin Matuska 	/* default index (boolean) properties */
415681ce946SMartin Matuska 	zprop_register_index(VDEV_PROP_REMOVING, "removing", 0,
416681ce946SMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "on | off", "REMOVING",
417e92ffd9bSMartin Matuska 	    boolean_table, sfeatures);
418681ce946SMartin Matuska 	zprop_register_index(VDEV_PROP_ALLOCATING, "allocating", 1,
419681ce946SMartin Matuska 	    PROP_DEFAULT, ZFS_TYPE_VDEV, "on | off", "ALLOCATING",
420e92ffd9bSMartin Matuska 	    boolean_na_table, sfeatures);
421681ce946SMartin Matuska 
422681ce946SMartin Matuska 	/* default index properties */
423681ce946SMartin Matuska 
424681ce946SMartin Matuska 	/* hidden properties */
425681ce946SMartin Matuska 	zprop_register_hidden(VDEV_PROP_NAME, "name", PROP_TYPE_STRING,
426c03c5b1cSMartin Matuska 	    PROP_READONLY, ZFS_TYPE_VDEV, "NAME", B_TRUE, sfeatures);
427e92ffd9bSMartin Matuska 
428e92ffd9bSMartin Matuska 	zfs_mod_list_supported_free(sfeatures);
429681ce946SMartin Matuska }
430681ce946SMartin Matuska 
431681ce946SMartin Matuska /*
432681ce946SMartin Matuska  * Given a property name and its type, returns the corresponding property ID.
433681ce946SMartin Matuska  */
434681ce946SMartin Matuska vdev_prop_t
435681ce946SMartin Matuska vdev_name_to_prop(const char *propname)
436681ce946SMartin Matuska {
437681ce946SMartin Matuska 	return (zprop_name_to_prop(propname, ZFS_TYPE_VDEV));
438681ce946SMartin Matuska }
439681ce946SMartin Matuska 
440681ce946SMartin Matuska /*
441681ce946SMartin Matuska  * Returns true if this is a valid user-defined property (one with a ':').
442681ce946SMartin Matuska  */
443681ce946SMartin Matuska boolean_t
444681ce946SMartin Matuska vdev_prop_user(const char *name)
445681ce946SMartin Matuska {
446681ce946SMartin Matuska 	int i;
447681ce946SMartin Matuska 	char c;
448681ce946SMartin Matuska 	boolean_t foundsep = B_FALSE;
449681ce946SMartin Matuska 
450681ce946SMartin Matuska 	for (i = 0; i < strlen(name); i++) {
451681ce946SMartin Matuska 		c = name[i];
452681ce946SMartin Matuska 		if (!zprop_valid_char(c))
453681ce946SMartin Matuska 			return (B_FALSE);
454681ce946SMartin Matuska 		if (c == ':')
455681ce946SMartin Matuska 			foundsep = B_TRUE;
456681ce946SMartin Matuska 	}
457681ce946SMartin Matuska 
458681ce946SMartin Matuska 	return (foundsep);
459681ce946SMartin Matuska }
460681ce946SMartin Matuska 
461681ce946SMartin Matuska /*
462681ce946SMartin Matuska  * Given a pool property ID, returns the corresponding name.
463681ce946SMartin Matuska  * Assuming the pool property ID is valid.
464681ce946SMartin Matuska  */
465681ce946SMartin Matuska const char *
466681ce946SMartin Matuska vdev_prop_to_name(vdev_prop_t prop)
467681ce946SMartin Matuska {
468681ce946SMartin Matuska 	return (vdev_prop_table[prop].pd_name);
469681ce946SMartin Matuska }
470681ce946SMartin Matuska 
471681ce946SMartin Matuska zprop_type_t
472681ce946SMartin Matuska vdev_prop_get_type(vdev_prop_t prop)
473681ce946SMartin Matuska {
474681ce946SMartin Matuska 	return (vdev_prop_table[prop].pd_proptype);
475681ce946SMartin Matuska }
476681ce946SMartin Matuska 
477681ce946SMartin Matuska boolean_t
478681ce946SMartin Matuska vdev_prop_readonly(vdev_prop_t prop)
479681ce946SMartin Matuska {
480681ce946SMartin Matuska 	return (vdev_prop_table[prop].pd_attr == PROP_READONLY);
481681ce946SMartin Matuska }
482681ce946SMartin Matuska 
483681ce946SMartin Matuska const char *
484681ce946SMartin Matuska vdev_prop_default_string(vdev_prop_t prop)
485681ce946SMartin Matuska {
486681ce946SMartin Matuska 	return (vdev_prop_table[prop].pd_strdefault);
487681ce946SMartin Matuska }
488681ce946SMartin Matuska 
489681ce946SMartin Matuska uint64_t
490681ce946SMartin Matuska vdev_prop_default_numeric(vdev_prop_t prop)
491681ce946SMartin Matuska {
492681ce946SMartin Matuska 	return (vdev_prop_table[prop].pd_numdefault);
493681ce946SMartin Matuska }
494681ce946SMartin Matuska 
495681ce946SMartin Matuska int
496681ce946SMartin Matuska vdev_prop_string_to_index(vdev_prop_t prop, const char *string,
497681ce946SMartin Matuska     uint64_t *index)
498681ce946SMartin Matuska {
499681ce946SMartin Matuska 	return (zprop_string_to_index(prop, string, index, ZFS_TYPE_VDEV));
500681ce946SMartin Matuska }
501681ce946SMartin Matuska 
502681ce946SMartin Matuska int
503681ce946SMartin Matuska vdev_prop_index_to_string(vdev_prop_t prop, uint64_t index,
504681ce946SMartin Matuska     const char **string)
505681ce946SMartin Matuska {
506681ce946SMartin Matuska 	return (zprop_index_to_string(prop, index, string, ZFS_TYPE_VDEV));
507681ce946SMartin Matuska }
508681ce946SMartin Matuska 
509681ce946SMartin Matuska /*
510681ce946SMartin Matuska  * Returns true if this is a valid vdev property.
511681ce946SMartin Matuska  */
512681ce946SMartin Matuska boolean_t
513681ce946SMartin Matuska zpool_prop_vdev(const char *name)
514681ce946SMartin Matuska {
515681ce946SMartin Matuska 	return (vdev_name_to_prop(name) != VDEV_PROP_INVAL);
516681ce946SMartin Matuska }
517681ce946SMartin Matuska 
518681ce946SMartin Matuska uint64_t
519681ce946SMartin Matuska vdev_prop_random_value(vdev_prop_t prop, uint64_t seed)
520681ce946SMartin Matuska {
521681ce946SMartin Matuska 	return (zprop_random_value(prop, seed, ZFS_TYPE_VDEV));
522681ce946SMartin Matuska }
523681ce946SMartin Matuska 
524681ce946SMartin Matuska #ifndef _KERNEL
525681ce946SMartin Matuska const char *
526681ce946SMartin Matuska vdev_prop_values(vdev_prop_t prop)
527681ce946SMartin Matuska {
528681ce946SMartin Matuska 	return (vdev_prop_table[prop].pd_values);
529681ce946SMartin Matuska }
530681ce946SMartin Matuska 
531681ce946SMartin Matuska const char *
532681ce946SMartin Matuska vdev_prop_column_name(vdev_prop_t prop)
533681ce946SMartin Matuska {
534681ce946SMartin Matuska 	return (vdev_prop_table[prop].pd_colname);
535681ce946SMartin Matuska }
536681ce946SMartin Matuska 
537681ce946SMartin Matuska boolean_t
538681ce946SMartin Matuska vdev_prop_align_right(vdev_prop_t prop)
539681ce946SMartin Matuska {
540681ce946SMartin Matuska 	return (vdev_prop_table[prop].pd_rightalign);
541681ce946SMartin Matuska }
542681ce946SMartin Matuska #endif
543681ce946SMartin Matuska 
544eda14cbcSMatt Macy #if defined(_KERNEL)
545eda14cbcSMatt Macy /* zpool property functions */
546eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_init);
547eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_get_type);
548eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_get_table);
549eda14cbcSMatt Macy 
550681ce946SMartin Matuska /* vdev property functions */
551681ce946SMartin Matuska EXPORT_SYMBOL(vdev_prop_init);
552681ce946SMartin Matuska EXPORT_SYMBOL(vdev_prop_get_type);
553681ce946SMartin Matuska EXPORT_SYMBOL(vdev_prop_get_table);
554681ce946SMartin Matuska 
555eda14cbcSMatt Macy /* Pool property functions shared between libzfs and kernel. */
556eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_name_to_prop);
557eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_to_name);
558eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_default_string);
559eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_default_numeric);
560eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_readonly);
561eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_feature);
562eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_unsupported);
563eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_index_to_string);
564eda14cbcSMatt Macy EXPORT_SYMBOL(zpool_prop_string_to_index);
565681ce946SMartin Matuska EXPORT_SYMBOL(zpool_prop_vdev);
566681ce946SMartin Matuska 
567681ce946SMartin Matuska /* vdev property functions shared between libzfs and kernel. */
568681ce946SMartin Matuska EXPORT_SYMBOL(vdev_name_to_prop);
569681ce946SMartin Matuska EXPORT_SYMBOL(vdev_prop_user);
570681ce946SMartin Matuska EXPORT_SYMBOL(vdev_prop_to_name);
571681ce946SMartin Matuska EXPORT_SYMBOL(vdev_prop_default_string);
572681ce946SMartin Matuska EXPORT_SYMBOL(vdev_prop_default_numeric);
573681ce946SMartin Matuska EXPORT_SYMBOL(vdev_prop_readonly);
574681ce946SMartin Matuska EXPORT_SYMBOL(vdev_prop_index_to_string);
575681ce946SMartin Matuska EXPORT_SYMBOL(vdev_prop_string_to_index);
576eda14cbcSMatt Macy #endif
577