1 // SPDX-License-Identifier: CDDL-1.0
2 /*
3 * CDDL HEADER START
4 *
5 * The contents of this file are subject to the terms of the
6 * Common Development and Distribution License (the "License").
7 * You may not use this file except in compliance with the License.
8 *
9 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10 * or https://opensource.org/licenses/CDDL-1.0.
11 * See the License for the specific language governing permissions
12 * and limitations under the License.
13 *
14 * When distributing Covered Code, include this CDDL HEADER in each
15 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16 * If applicable, add the following below this CDDL HEADER, with the
17 * fields enclosed by brackets "[]" replaced with your own identifying
18 * information: Portions Copyright [yyyy] [name of copyright owner]
19 *
20 * CDDL HEADER END
21 */
22 /*
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
25 * Copyright (c) 2012, 2018 by Delphix. All rights reserved.
26 * Copyright (c) 2021, Colm Buckley <colm@tuatha.org>
27 * Copyright (c) 2021, 2023, Klara Inc.
28 */
29
30 #include <sys/zio.h>
31 #include <sys/spa.h>
32 #include <sys/zfs_acl.h>
33 #include <sys/zfs_ioctl.h>
34 #include <sys/fs/zfs.h>
35
36 #include "zfs_prop.h"
37
38 #if !defined(_KERNEL)
39 #include <stdlib.h>
40 #include <string.h>
41 #include <ctype.h>
42 #endif
43
44 static zprop_desc_t zpool_prop_table[ZPOOL_NUM_PROPS];
45 static zprop_desc_t vdev_prop_table[VDEV_NUM_PROPS];
46
47 zprop_desc_t *
zpool_prop_get_table(void)48 zpool_prop_get_table(void)
49 {
50 return (zpool_prop_table);
51 }
52
53 void
zpool_prop_init(void)54 zpool_prop_init(void)
55 {
56 static const zprop_index_t boolean_table[] = {
57 { "off", 0},
58 { "on", 1},
59 { NULL }
60 };
61
62 static const zprop_index_t failuremode_table[] = {
63 { "wait", ZIO_FAILURE_MODE_WAIT },
64 { "continue", ZIO_FAILURE_MODE_CONTINUE },
65 { "panic", ZIO_FAILURE_MODE_PANIC },
66 { NULL }
67 };
68
69 struct zfs_mod_supported_features *sfeatures =
70 zfs_mod_list_supported(ZFS_SYSFS_POOL_PROPERTIES);
71
72 /* string properties */
73 zprop_register_string(ZPOOL_PROP_ALTROOT, "altroot", NULL, PROP_DEFAULT,
74 ZFS_TYPE_POOL, "<path>", "ALTROOT", sfeatures);
75 zprop_register_string(ZPOOL_PROP_BOOTFS, "bootfs", NULL, PROP_DEFAULT,
76 ZFS_TYPE_POOL, "<filesystem>", "BOOTFS", sfeatures);
77 zprop_register_string(ZPOOL_PROP_CACHEFILE, "cachefile", NULL,
78 PROP_DEFAULT, ZFS_TYPE_POOL, "<file> | none", "CACHEFILE",
79 sfeatures);
80 zprop_register_string(ZPOOL_PROP_COMMENT, "comment", NULL,
81 PROP_DEFAULT, ZFS_TYPE_POOL, "<comment-string>", "COMMENT",
82 sfeatures);
83 zprop_register_string(ZPOOL_PROP_COMPATIBILITY, "compatibility",
84 "off", PROP_DEFAULT, ZFS_TYPE_POOL,
85 "<file[,file...]> | off | legacy", "COMPATIBILITY", sfeatures);
86
87 /* readonly number properties */
88 zprop_register_number(ZPOOL_PROP_SIZE, "size", 0, PROP_READONLY,
89 ZFS_TYPE_POOL, "<size>", "SIZE", B_FALSE, sfeatures);
90 zprop_register_number(ZPOOL_PROP_FREE, "free", 0, PROP_READONLY,
91 ZFS_TYPE_POOL, "<size>", "FREE", B_FALSE, sfeatures);
92 zprop_register_number(ZPOOL_PROP_FREEING, "freeing", 0, PROP_READONLY,
93 ZFS_TYPE_POOL, "<size>", "FREEING", B_FALSE, sfeatures);
94 zprop_register_number(ZPOOL_PROP_CHECKPOINT, "checkpoint", 0,
95 PROP_READONLY, ZFS_TYPE_POOL, "<size>", "CKPOINT", B_FALSE,
96 sfeatures);
97 zprop_register_number(ZPOOL_PROP_LEAKED, "leaked", 0, PROP_READONLY,
98 ZFS_TYPE_POOL, "<size>", "LEAKED", B_FALSE, sfeatures);
99 zprop_register_number(ZPOOL_PROP_ALLOCATED, "allocated", 0,
100 PROP_READONLY, ZFS_TYPE_POOL, "<size>", "ALLOC", B_FALSE,
101 sfeatures);
102 zprop_register_number(ZPOOL_PROP_EXPANDSZ, "expandsize", 0,
103 PROP_READONLY, ZFS_TYPE_POOL, "<size>", "EXPANDSZ", B_FALSE,
104 sfeatures);
105 zprop_register_number(ZPOOL_PROP_FRAGMENTATION, "fragmentation", 0,
106 PROP_READONLY, ZFS_TYPE_POOL, "<percent>", "FRAG", B_FALSE,
107 sfeatures);
108 zprop_register_number(ZPOOL_PROP_CAPACITY, "capacity", 0, PROP_READONLY,
109 ZFS_TYPE_POOL, "<percent>", "CAP", B_FALSE, sfeatures);
110 zprop_register_number(ZPOOL_PROP_GUID, "guid", 0, PROP_READONLY,
111 ZFS_TYPE_POOL, "<guid>", "GUID", B_TRUE, sfeatures);
112 zprop_register_number(ZPOOL_PROP_LOAD_GUID, "load_guid", 0,
113 PROP_READONLY, ZFS_TYPE_POOL, "<load_guid>", "LOAD_GUID",
114 B_TRUE, sfeatures);
115 zprop_register_number(ZPOOL_PROP_HEALTH, "health", 0, PROP_READONLY,
116 ZFS_TYPE_POOL, "<state>", "HEALTH", B_FALSE, sfeatures);
117 zprop_register_number(ZPOOL_PROP_DEDUPRATIO, "dedupratio", 0,
118 PROP_READONLY, ZFS_TYPE_POOL, "<1.00x or higher if deduped>",
119 "DEDUP", B_FALSE, sfeatures);
120 zprop_register_number(ZPOOL_PROP_DEDUPUSED, "dedupused", 0,
121 PROP_READONLY, ZFS_TYPE_POOL, "<size>",
122 "DEDUP_USED", B_FALSE, sfeatures);
123 zprop_register_number(ZPOOL_PROP_DEDUPSAVED, "dedupsaved", 0,
124 PROP_READONLY, ZFS_TYPE_POOL, "<size>",
125 "DEDUP_SAVED", B_FALSE, sfeatures);
126 zprop_register_number(ZPOOL_PROP_BCLONEUSED, "bcloneused", 0,
127 PROP_READONLY, ZFS_TYPE_POOL, "<size>",
128 "BCLONE_USED", B_FALSE, sfeatures);
129 zprop_register_number(ZPOOL_PROP_BCLONESAVED, "bclonesaved", 0,
130 PROP_READONLY, ZFS_TYPE_POOL, "<size>",
131 "BCLONE_SAVED", B_FALSE, sfeatures);
132 zprop_register_number(ZPOOL_PROP_BCLONERATIO, "bcloneratio", 0,
133 PROP_READONLY, ZFS_TYPE_POOL, "<1.00x or higher if cloned>",
134 "BCLONE_RATIO", B_FALSE, sfeatures);
135 zprop_register_number(ZPOOL_PROP_DEDUP_TABLE_SIZE, "dedup_table_size",
136 0, PROP_READONLY, ZFS_TYPE_POOL, "<size>", "DDTSIZE", B_FALSE,
137 sfeatures);
138 zprop_register_number(ZPOOL_PROP_LAST_SCRUBBED_TXG,
139 "last_scrubbed_txg", 0, PROP_READONLY, ZFS_TYPE_POOL, "<txg>",
140 "LAST_SCRUBBED_TXG", B_FALSE, sfeatures);
141
142 /* default number properties */
143 zprop_register_number(ZPOOL_PROP_VERSION, "version", SPA_VERSION,
144 PROP_DEFAULT, ZFS_TYPE_POOL, "<version>", "VERSION", B_FALSE,
145 sfeatures);
146 zprop_register_number(ZPOOL_PROP_ASHIFT, "ashift", 0, PROP_DEFAULT,
147 ZFS_TYPE_POOL, "<ashift, 9-16, or 0=default>", "ASHIFT", B_FALSE,
148 sfeatures);
149 zprop_register_number(ZPOOL_PROP_DEDUP_TABLE_QUOTA, "dedup_table_quota",
150 UINT64_MAX, PROP_DEFAULT, ZFS_TYPE_POOL, "<size>", "DDTQUOTA",
151 B_FALSE, sfeatures);
152
153 /* default index (boolean) properties */
154 zprop_register_index(ZPOOL_PROP_DELEGATION, "delegation", 1,
155 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "DELEGATION",
156 boolean_table, sfeatures);
157 zprop_register_index(ZPOOL_PROP_AUTOREPLACE, "autoreplace", 0,
158 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "REPLACE", boolean_table,
159 sfeatures);
160 zprop_register_index(ZPOOL_PROP_LISTSNAPS, "listsnapshots", 0,
161 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "LISTSNAPS",
162 boolean_table, sfeatures);
163 zprop_register_index(ZPOOL_PROP_AUTOEXPAND, "autoexpand", 0,
164 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "EXPAND", boolean_table,
165 sfeatures);
166 zprop_register_index(ZPOOL_PROP_READONLY, "readonly", 0,
167 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "RDONLY", boolean_table,
168 sfeatures);
169 zprop_register_index(ZPOOL_PROP_MULTIHOST, "multihost", 0,
170 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "MULTIHOST",
171 boolean_table, sfeatures);
172
173 /* default index properties */
174 zprop_register_index(ZPOOL_PROP_FAILUREMODE, "failmode",
175 ZIO_FAILURE_MODE_WAIT, PROP_DEFAULT, ZFS_TYPE_POOL,
176 "wait | continue | panic", "FAILMODE", failuremode_table,
177 sfeatures);
178 zprop_register_index(ZPOOL_PROP_AUTOTRIM, "autotrim",
179 SPA_AUTOTRIM_OFF, PROP_DEFAULT, ZFS_TYPE_POOL,
180 "on | off", "AUTOTRIM", boolean_table, sfeatures);
181
182 /* hidden properties */
183 zprop_register_hidden(ZPOOL_PROP_NAME, "name", PROP_TYPE_STRING,
184 PROP_READONLY, ZFS_TYPE_POOL, "NAME", B_TRUE, sfeatures);
185 zprop_register_hidden(ZPOOL_PROP_MAXBLOCKSIZE, "maxblocksize",
186 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_POOL, "MAXBLOCKSIZE",
187 B_FALSE, sfeatures);
188 zprop_register_hidden(ZPOOL_PROP_TNAME, "tname", PROP_TYPE_STRING,
189 PROP_ONETIME, ZFS_TYPE_POOL, "TNAME", B_TRUE, sfeatures);
190 zprop_register_hidden(ZPOOL_PROP_MAXDNODESIZE, "maxdnodesize",
191 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_POOL, "MAXDNODESIZE",
192 B_FALSE, sfeatures);
193 zprop_register_hidden(ZPOOL_PROP_DEDUPDITTO, "dedupditto",
194 PROP_TYPE_NUMBER, PROP_DEFAULT, ZFS_TYPE_POOL, "DEDUPDITTO",
195 B_FALSE, sfeatures);
196 zprop_register_hidden(ZPOOL_PROP_DEDUPCACHED,
197 ZPOOL_DEDUPCACHED_PROP_NAME, PROP_TYPE_NUMBER, PROP_READONLY,
198 ZFS_TYPE_POOL, "DEDUPCACHED", B_FALSE, sfeatures);
199
200 zfs_mod_list_supported_free(sfeatures);
201 }
202
203 /*
204 * Given a property name and its type, returns the corresponding property ID.
205 */
206 zpool_prop_t
zpool_name_to_prop(const char * propname)207 zpool_name_to_prop(const char *propname)
208 {
209 return (zprop_name_to_prop(propname, ZFS_TYPE_POOL));
210 }
211
212 /*
213 * Given a pool property ID, returns the corresponding name.
214 * Assuming the pool property ID is valid.
215 */
216 const char *
zpool_prop_to_name(zpool_prop_t prop)217 zpool_prop_to_name(zpool_prop_t prop)
218 {
219 return (zpool_prop_table[prop].pd_name);
220 }
221
222 zprop_type_t
zpool_prop_get_type(zpool_prop_t prop)223 zpool_prop_get_type(zpool_prop_t prop)
224 {
225 return (zpool_prop_table[prop].pd_proptype);
226 }
227
228 boolean_t
zpool_prop_readonly(zpool_prop_t prop)229 zpool_prop_readonly(zpool_prop_t prop)
230 {
231 return (zpool_prop_table[prop].pd_attr == PROP_READONLY);
232 }
233
234 boolean_t
zpool_prop_setonce(zpool_prop_t prop)235 zpool_prop_setonce(zpool_prop_t prop)
236 {
237 return (zpool_prop_table[prop].pd_attr == PROP_ONETIME);
238 }
239
240 const char *
zpool_prop_default_string(zpool_prop_t prop)241 zpool_prop_default_string(zpool_prop_t prop)
242 {
243 return (zpool_prop_table[prop].pd_strdefault);
244 }
245
246 uint64_t
zpool_prop_default_numeric(zpool_prop_t prop)247 zpool_prop_default_numeric(zpool_prop_t prop)
248 {
249 return (zpool_prop_table[prop].pd_numdefault);
250 }
251
252 /*
253 * Returns true if this is a valid feature@ property.
254 */
255 boolean_t
zpool_prop_feature(const char * name)256 zpool_prop_feature(const char *name)
257 {
258 static const char *prefix = "feature@";
259 return (strncmp(name, prefix, strlen(prefix)) == 0);
260 }
261
262 /*
263 * Returns true if this is a valid unsupported@ property.
264 */
265 boolean_t
zpool_prop_unsupported(const char * name)266 zpool_prop_unsupported(const char *name)
267 {
268 static const char *prefix = "unsupported@";
269 return (strncmp(name, prefix, strlen(prefix)) == 0);
270 }
271
272 int
zpool_prop_string_to_index(zpool_prop_t prop,const char * string,uint64_t * index)273 zpool_prop_string_to_index(zpool_prop_t prop, const char *string,
274 uint64_t *index)
275 {
276 return (zprop_string_to_index(prop, string, index, ZFS_TYPE_POOL));
277 }
278
279 int
zpool_prop_index_to_string(zpool_prop_t prop,uint64_t index,const char ** string)280 zpool_prop_index_to_string(zpool_prop_t prop, uint64_t index,
281 const char **string)
282 {
283 return (zprop_index_to_string(prop, index, string, ZFS_TYPE_POOL));
284 }
285
286 uint64_t
zpool_prop_random_value(zpool_prop_t prop,uint64_t seed)287 zpool_prop_random_value(zpool_prop_t prop, uint64_t seed)
288 {
289 return (zprop_random_value(prop, seed, ZFS_TYPE_POOL));
290 }
291
292 #ifndef _KERNEL
293 #include <libzfs.h>
294
295 const char *
zpool_prop_values(zpool_prop_t prop)296 zpool_prop_values(zpool_prop_t prop)
297 {
298 return (zpool_prop_table[prop].pd_values);
299 }
300
301 const char *
zpool_prop_column_name(zpool_prop_t prop)302 zpool_prop_column_name(zpool_prop_t prop)
303 {
304 return (zpool_prop_table[prop].pd_colname);
305 }
306
307 boolean_t
zpool_prop_align_right(zpool_prop_t prop)308 zpool_prop_align_right(zpool_prop_t prop)
309 {
310 return (zpool_prop_table[prop].pd_rightalign);
311 }
312 #endif
313
314 zprop_desc_t *
vdev_prop_get_table(void)315 vdev_prop_get_table(void)
316 {
317 return (vdev_prop_table);
318 }
319
320 void
vdev_prop_init(void)321 vdev_prop_init(void)
322 {
323 static const zprop_index_t boolean_table[] = {
324 { "off", 0},
325 { "on", 1},
326 { NULL }
327 };
328 static const zprop_index_t boolean_na_table[] = {
329 { "off", 0},
330 { "on", 1},
331 { "-", 2}, /* ZPROP_BOOLEAN_NA */
332 { NULL }
333 };
334
335 static const zprop_index_t vdevschedulertype_table[] = {
336 { "auto", VDEV_SCHEDULER_AUTO },
337 { "on", VDEV_SCHEDULER_ON },
338 { "off", VDEV_SCHEDULER_OFF },
339 { NULL }
340 };
341
342 struct zfs_mod_supported_features *sfeatures =
343 zfs_mod_list_supported(ZFS_SYSFS_VDEV_PROPERTIES);
344
345 /* string properties */
346 zprop_register_string(VDEV_PROP_COMMENT, "comment", NULL,
347 PROP_DEFAULT, ZFS_TYPE_VDEV, "<comment-string>", "COMMENT",
348 sfeatures);
349 zprop_register_string(VDEV_PROP_PATH, "path", NULL,
350 PROP_DEFAULT, ZFS_TYPE_VDEV, "<device-path>", "PATH", sfeatures);
351 zprop_register_string(VDEV_PROP_DEVID, "devid", NULL,
352 PROP_READONLY, ZFS_TYPE_VDEV, "<devid>", "DEVID", sfeatures);
353 zprop_register_string(VDEV_PROP_PHYS_PATH, "physpath", NULL,
354 PROP_READONLY, ZFS_TYPE_VDEV, "<physpath>", "PHYSPATH", sfeatures);
355 zprop_register_string(VDEV_PROP_ENC_PATH, "encpath", NULL,
356 PROP_READONLY, ZFS_TYPE_VDEV, "<encpath>", "ENCPATH", sfeatures);
357 zprop_register_string(VDEV_PROP_FRU, "fru", NULL,
358 PROP_READONLY, ZFS_TYPE_VDEV, "<fru>", "FRU", sfeatures);
359 zprop_register_string(VDEV_PROP_PARENT, "parent", NULL,
360 PROP_READONLY, ZFS_TYPE_VDEV, "<parent>", "PARENT", sfeatures);
361 zprop_register_string(VDEV_PROP_CHILDREN, "children", NULL,
362 PROP_READONLY, ZFS_TYPE_VDEV, "<child[,...]>", "CHILDREN",
363 sfeatures);
364
365 /* readonly number properties */
366 zprop_register_number(VDEV_PROP_SIZE, "size", 0, PROP_READONLY,
367 ZFS_TYPE_VDEV, "<size>", "SIZE", B_FALSE, sfeatures);
368 zprop_register_number(VDEV_PROP_FREE, "free", 0, PROP_READONLY,
369 ZFS_TYPE_VDEV, "<size>", "FREE", B_FALSE, sfeatures);
370 zprop_register_number(VDEV_PROP_ALLOCATED, "allocated", 0,
371 PROP_READONLY, ZFS_TYPE_VDEV, "<size>", "ALLOC", B_FALSE,
372 sfeatures);
373 zprop_register_number(VDEV_PROP_EXPANDSZ, "expandsize", 0,
374 PROP_READONLY, ZFS_TYPE_VDEV, "<size>", "EXPANDSZ", B_FALSE,
375 sfeatures);
376 zprop_register_number(VDEV_PROP_FRAGMENTATION, "fragmentation", 0,
377 PROP_READONLY, ZFS_TYPE_VDEV, "<percent>", "FRAG", B_FALSE,
378 sfeatures);
379 zprop_register_number(VDEV_PROP_CAPACITY, "capacity", 0, PROP_READONLY,
380 ZFS_TYPE_VDEV, "<size>", "CAP", B_FALSE, sfeatures);
381 zprop_register_number(VDEV_PROP_GUID, "guid", 0, PROP_READONLY,
382 ZFS_TYPE_VDEV, "<guid>", "GUID", B_TRUE, sfeatures);
383 zprop_register_number(VDEV_PROP_STATE, "state", 0, PROP_READONLY,
384 ZFS_TYPE_VDEV, "<state>", "STATE", B_FALSE, sfeatures);
385 zprop_register_number(VDEV_PROP_BOOTSIZE, "bootsize", 0, PROP_READONLY,
386 ZFS_TYPE_VDEV, "<size>", "BOOTSIZE", B_FALSE, sfeatures);
387 zprop_register_number(VDEV_PROP_ASIZE, "asize", 0, PROP_READONLY,
388 ZFS_TYPE_VDEV, "<asize>", "ASIZE", B_FALSE, sfeatures);
389 zprop_register_number(VDEV_PROP_PSIZE, "psize", 0, PROP_READONLY,
390 ZFS_TYPE_VDEV, "<psize>", "PSIZE", B_FALSE, sfeatures);
391 zprop_register_number(VDEV_PROP_ASHIFT, "ashift", 0, PROP_READONLY,
392 ZFS_TYPE_VDEV, "<ashift>", "ASHIFT", B_FALSE, sfeatures);
393 zprop_register_number(VDEV_PROP_PARITY, "parity", 0, PROP_READONLY,
394 ZFS_TYPE_VDEV, "<parity>", "PARITY", B_FALSE, sfeatures);
395 zprop_register_number(VDEV_PROP_NUMCHILDREN, "numchildren", 0,
396 PROP_READONLY, ZFS_TYPE_VDEV, "<number-of-children>", "NUMCHILD",
397 B_FALSE, sfeatures);
398 zprop_register_number(VDEV_PROP_READ_ERRORS, "read_errors", 0,
399 PROP_READONLY, ZFS_TYPE_VDEV, "<errors>", "RDERR", B_FALSE,
400 sfeatures);
401 zprop_register_number(VDEV_PROP_WRITE_ERRORS, "write_errors", 0,
402 PROP_READONLY, ZFS_TYPE_VDEV, "<errors>", "WRERR", B_FALSE,
403 sfeatures);
404 zprop_register_number(VDEV_PROP_CHECKSUM_ERRORS, "checksum_errors", 0,
405 PROP_READONLY, ZFS_TYPE_VDEV, "<errors>", "CKERR", B_FALSE,
406 sfeatures);
407 zprop_register_number(VDEV_PROP_INITIALIZE_ERRORS,
408 "initialize_errors", 0, PROP_READONLY, ZFS_TYPE_VDEV, "<errors>",
409 "INITERR", B_FALSE, sfeatures);
410 zprop_register_number(VDEV_PROP_TRIM_ERRORS, "trim_errors", 0,
411 PROP_READONLY, ZFS_TYPE_VDEV, "<errors>", "TRIMERR", B_FALSE,
412 sfeatures);
413 zprop_register_number(VDEV_PROP_SLOW_IOS, "slow_ios", 0,
414 PROP_READONLY, ZFS_TYPE_VDEV, "<slowios>", "SLOW", B_FALSE,
415 sfeatures);
416 zprop_register_number(VDEV_PROP_OPS_NULL, "null_ops", 0,
417 PROP_READONLY, ZFS_TYPE_VDEV, "<operations>", "NULLOP", B_FALSE,
418 sfeatures);
419 zprop_register_number(VDEV_PROP_OPS_READ, "read_ops", 0,
420 PROP_READONLY, ZFS_TYPE_VDEV, "<operations>", "READOP", B_FALSE,
421 sfeatures);
422 zprop_register_number(VDEV_PROP_OPS_WRITE, "write_ops", 0,
423 PROP_READONLY, ZFS_TYPE_VDEV, "<operations>", "WRITEOP", B_FALSE,
424 sfeatures);
425 zprop_register_number(VDEV_PROP_OPS_FREE, "free_ops", 0,
426 PROP_READONLY, ZFS_TYPE_VDEV, "<operations>", "FREEOP", B_FALSE,
427 sfeatures);
428 zprop_register_number(VDEV_PROP_OPS_CLAIM, "claim_ops", 0,
429 PROP_READONLY, ZFS_TYPE_VDEV, "<operations>", "CLAIMOP", B_FALSE,
430 sfeatures);
431 zprop_register_number(VDEV_PROP_OPS_TRIM, "trim_ops", 0,
432 PROP_READONLY, ZFS_TYPE_VDEV, "<operations>", "TRIMOP", B_FALSE,
433 sfeatures);
434 zprop_register_number(VDEV_PROP_BYTES_NULL, "null_bytes", 0,
435 PROP_READONLY, ZFS_TYPE_VDEV, "<bytes>", "NULLBYTE", B_FALSE,
436 sfeatures);
437 zprop_register_number(VDEV_PROP_BYTES_READ, "read_bytes", 0,
438 PROP_READONLY, ZFS_TYPE_VDEV, "<bytes>", "READBYTE", B_FALSE,
439 sfeatures);
440 zprop_register_number(VDEV_PROP_BYTES_WRITE, "write_bytes", 0,
441 PROP_READONLY, ZFS_TYPE_VDEV, "<bytes>", "WRITEBYTE", B_FALSE,
442 sfeatures);
443 zprop_register_number(VDEV_PROP_BYTES_FREE, "free_bytes", 0,
444 PROP_READONLY, ZFS_TYPE_VDEV, "<bytes>", "FREEBYTE", B_FALSE,
445 sfeatures);
446 zprop_register_number(VDEV_PROP_BYTES_CLAIM, "claim_bytes", 0,
447 PROP_READONLY, ZFS_TYPE_VDEV, "<bytes>", "CLAIMBYTE", B_FALSE,
448 sfeatures);
449 zprop_register_number(VDEV_PROP_BYTES_TRIM, "trim_bytes", 0,
450 PROP_READONLY, ZFS_TYPE_VDEV, "<bytes>", "TRIMBYTE", B_FALSE,
451 sfeatures);
452
453 /* default numeric properties */
454 zprop_register_number(VDEV_PROP_CHECKSUM_N, "checksum_n", UINT64_MAX,
455 PROP_DEFAULT, ZFS_TYPE_VDEV, "<events>", "CKSUM_N", B_FALSE,
456 sfeatures);
457 zprop_register_number(VDEV_PROP_CHECKSUM_T, "checksum_t", UINT64_MAX,
458 PROP_DEFAULT, ZFS_TYPE_VDEV, "<seconds>", "CKSUM_T", B_FALSE,
459 sfeatures);
460 zprop_register_number(VDEV_PROP_IO_N, "io_n", UINT64_MAX,
461 PROP_DEFAULT, ZFS_TYPE_VDEV, "<events>", "IO_N", B_FALSE,
462 sfeatures);
463 zprop_register_number(VDEV_PROP_IO_T, "io_t", UINT64_MAX,
464 PROP_DEFAULT, ZFS_TYPE_VDEV, "<seconds>", "IO_T", B_FALSE,
465 sfeatures);
466 zprop_register_number(VDEV_PROP_SLOW_IO_N, "slow_io_n", UINT64_MAX,
467 PROP_DEFAULT, ZFS_TYPE_VDEV, "<events>", "SLOW_IO_N", B_FALSE,
468 sfeatures);
469 zprop_register_number(VDEV_PROP_SLOW_IO_T, "slow_io_t", UINT64_MAX,
470 PROP_DEFAULT, ZFS_TYPE_VDEV, "<seconds>", "SLOW_IO_T", B_FALSE,
471 sfeatures);
472
473 /* default index (boolean) properties */
474 zprop_register_index(VDEV_PROP_REMOVING, "removing", 0,
475 PROP_READONLY, ZFS_TYPE_VDEV, "on | off", "REMOVING",
476 boolean_table, sfeatures);
477 zprop_register_index(VDEV_PROP_ALLOCATING, "allocating", 1,
478 PROP_DEFAULT, ZFS_TYPE_VDEV, "on | off", "ALLOCATING",
479 boolean_na_table, sfeatures);
480 zprop_register_index(VDEV_PROP_RAIDZ_EXPANDING, "raidz_expanding", 0,
481 PROP_READONLY, ZFS_TYPE_VDEV, "on | off", "RAIDZ_EXPANDING",
482 boolean_table, sfeatures);
483 zprop_register_index(VDEV_PROP_SIT_OUT, "sit_out", 0,
484 PROP_DEFAULT, ZFS_TYPE_VDEV, "on | off", "SIT_OUT", boolean_table,
485 sfeatures);
486 zprop_register_index(VDEV_PROP_TRIM_SUPPORT, "trim_support", 0,
487 PROP_READONLY, ZFS_TYPE_VDEV, "on | off", "TRIMSUP",
488 boolean_table, sfeatures);
489 zprop_register_index(VDEV_PROP_AUTOSIT, "autosit", 0,
490 PROP_DEFAULT, ZFS_TYPE_VDEV, "on | off", "AUTOSIT", boolean_table,
491 sfeatures);
492
493 /* default index properties */
494 zprop_register_index(VDEV_PROP_FAILFAST, "failfast", B_TRUE,
495 PROP_DEFAULT, ZFS_TYPE_VDEV, "on | off", "FAILFAST", boolean_table,
496 sfeatures);
497 zprop_register_index(VDEV_PROP_SLOW_IO_EVENTS, "slow_io_events",
498 B_TRUE, PROP_DEFAULT, ZFS_TYPE_VDEV, "on | off",
499 "SLOW_IO_EVENTS", boolean_table, sfeatures);
500 zprop_register_index(VDEV_PROP_SCHEDULER, "scheduler",
501 VDEV_SCHEDULER_AUTO, PROP_DEFAULT, ZFS_TYPE_VDEV,
502 "auto | on | off", "IO_SCHEDULER",
503 vdevschedulertype_table, sfeatures);
504
505 /* hidden properties */
506 zprop_register_hidden(VDEV_PROP_NAME, "name", PROP_TYPE_STRING,
507 PROP_READONLY, ZFS_TYPE_VDEV, "NAME", B_TRUE, sfeatures);
508
509 zfs_mod_list_supported_free(sfeatures);
510 }
511
512 /*
513 * Given a property name and its type, returns the corresponding property ID.
514 */
515 vdev_prop_t
vdev_name_to_prop(const char * propname)516 vdev_name_to_prop(const char *propname)
517 {
518 return (zprop_name_to_prop(propname, ZFS_TYPE_VDEV));
519 }
520
521 /*
522 * Returns true if this is a valid user-defined property (one with a ':').
523 */
524 boolean_t
vdev_prop_user(const char * name)525 vdev_prop_user(const char *name)
526 {
527 int i, len;
528 char c;
529 boolean_t foundsep = B_FALSE;
530
531 len = strlen(name);
532 for (i = 0; i < len; i++) {
533 c = name[i];
534 if (!zprop_valid_char(c))
535 return (B_FALSE);
536 if (c == ':')
537 foundsep = B_TRUE;
538 }
539
540 return (foundsep);
541 }
542
543 /*
544 * Given a pool property ID, returns the corresponding name.
545 * Assuming the pool property ID is valid.
546 */
547 const char *
vdev_prop_to_name(vdev_prop_t prop)548 vdev_prop_to_name(vdev_prop_t prop)
549 {
550 return (vdev_prop_table[prop].pd_name);
551 }
552
553 zprop_type_t
vdev_prop_get_type(vdev_prop_t prop)554 vdev_prop_get_type(vdev_prop_t prop)
555 {
556 return (vdev_prop_table[prop].pd_proptype);
557 }
558
559 boolean_t
vdev_prop_readonly(vdev_prop_t prop)560 vdev_prop_readonly(vdev_prop_t prop)
561 {
562 return (vdev_prop_table[prop].pd_attr == PROP_READONLY);
563 }
564
565 const char *
vdev_prop_default_string(vdev_prop_t prop)566 vdev_prop_default_string(vdev_prop_t prop)
567 {
568 return (vdev_prop_table[prop].pd_strdefault);
569 }
570
571 uint64_t
vdev_prop_default_numeric(vdev_prop_t prop)572 vdev_prop_default_numeric(vdev_prop_t prop)
573 {
574 return (vdev_prop_table[prop].pd_numdefault);
575 }
576
577 int
vdev_prop_string_to_index(vdev_prop_t prop,const char * string,uint64_t * index)578 vdev_prop_string_to_index(vdev_prop_t prop, const char *string,
579 uint64_t *index)
580 {
581 return (zprop_string_to_index(prop, string, index, ZFS_TYPE_VDEV));
582 }
583
584 int
vdev_prop_index_to_string(vdev_prop_t prop,uint64_t index,const char ** string)585 vdev_prop_index_to_string(vdev_prop_t prop, uint64_t index,
586 const char **string)
587 {
588 return (zprop_index_to_string(prop, index, string, ZFS_TYPE_VDEV));
589 }
590
591 /*
592 * Returns true if this is a valid vdev property.
593 */
594 boolean_t
zpool_prop_vdev(const char * name)595 zpool_prop_vdev(const char *name)
596 {
597 return (vdev_name_to_prop(name) != VDEV_PROP_INVAL);
598 }
599
600 uint64_t
vdev_prop_random_value(vdev_prop_t prop,uint64_t seed)601 vdev_prop_random_value(vdev_prop_t prop, uint64_t seed)
602 {
603 return (zprop_random_value(prop, seed, ZFS_TYPE_VDEV));
604 }
605
606 #ifndef _KERNEL
607 const char *
vdev_prop_values(vdev_prop_t prop)608 vdev_prop_values(vdev_prop_t prop)
609 {
610 return (vdev_prop_table[prop].pd_values);
611 }
612
613 const char *
vdev_prop_column_name(vdev_prop_t prop)614 vdev_prop_column_name(vdev_prop_t prop)
615 {
616 return (vdev_prop_table[prop].pd_colname);
617 }
618
619 boolean_t
vdev_prop_align_right(vdev_prop_t prop)620 vdev_prop_align_right(vdev_prop_t prop)
621 {
622 return (vdev_prop_table[prop].pd_rightalign);
623 }
624 #endif
625
626 #if defined(_KERNEL)
627 /* zpool property functions */
628 EXPORT_SYMBOL(zpool_prop_init);
629 EXPORT_SYMBOL(zpool_prop_get_type);
630 EXPORT_SYMBOL(zpool_prop_get_table);
631
632 /* vdev property functions */
633 EXPORT_SYMBOL(vdev_prop_init);
634 EXPORT_SYMBOL(vdev_prop_get_type);
635 EXPORT_SYMBOL(vdev_prop_get_table);
636
637 /* Pool property functions shared between libzfs and kernel. */
638 EXPORT_SYMBOL(zpool_name_to_prop);
639 EXPORT_SYMBOL(zpool_prop_to_name);
640 EXPORT_SYMBOL(zpool_prop_default_string);
641 EXPORT_SYMBOL(zpool_prop_default_numeric);
642 EXPORT_SYMBOL(zpool_prop_readonly);
643 EXPORT_SYMBOL(zpool_prop_feature);
644 EXPORT_SYMBOL(zpool_prop_unsupported);
645 EXPORT_SYMBOL(zpool_prop_index_to_string);
646 EXPORT_SYMBOL(zpool_prop_string_to_index);
647 EXPORT_SYMBOL(zpool_prop_vdev);
648
649 /* vdev property functions shared between libzfs and kernel. */
650 EXPORT_SYMBOL(vdev_name_to_prop);
651 EXPORT_SYMBOL(vdev_prop_user);
652 EXPORT_SYMBOL(vdev_prop_to_name);
653 EXPORT_SYMBOL(vdev_prop_default_string);
654 EXPORT_SYMBOL(vdev_prop_default_numeric);
655 EXPORT_SYMBOL(vdev_prop_readonly);
656 EXPORT_SYMBOL(vdev_prop_index_to_string);
657 EXPORT_SYMBOL(vdev_prop_string_to_index);
658 #endif
659