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