4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
22 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
24 * Copyright (c) 2012, 2017 by Delphix. All rights reserved.
29 #include <sys/zfs_acl.h>
30 #include <sys/zfs_ioctl.h>
31 #include <sys/fs/zfs.h>
41 static zprop_desc_t zpool_prop_table[ZPOOL_NUM_PROPS];
44 zpool_prop_get_table(void)
46 return (zpool_prop_table);
52 static zprop_index_t boolean_table[] = {
58 static zprop_index_t failuremode_table[] = {
59 { "wait", ZIO_FAILURE_MODE_WAIT },
60 { "continue", ZIO_FAILURE_MODE_CONTINUE },
61 { "panic", ZIO_FAILURE_MODE_PANIC },
65 /* string properties */
66 zprop_register_string(ZPOOL_PROP_ALTROOT, "altroot", NULL, PROP_DEFAULT,
67 ZFS_TYPE_POOL, "<path>", "ALTROOT");
68 zprop_register_string(ZPOOL_PROP_BOOTFS, "bootfs", NULL, PROP_DEFAULT,
69 ZFS_TYPE_POOL, "<filesystem>", "BOOTFS");
70 zprop_register_string(ZPOOL_PROP_CACHEFILE, "cachefile", NULL,
71 PROP_DEFAULT, ZFS_TYPE_POOL, "<file> | none", "CACHEFILE");
72 zprop_register_string(ZPOOL_PROP_COMMENT, "comment", NULL,
73 PROP_DEFAULT, ZFS_TYPE_POOL, "<comment-string>", "COMMENT");
75 /* readonly number properties */
76 zprop_register_number(ZPOOL_PROP_SIZE, "size", 0, PROP_READONLY,
77 ZFS_TYPE_POOL, "<size>", "SIZE");
78 zprop_register_number(ZPOOL_PROP_FREE, "free", 0, PROP_READONLY,
79 ZFS_TYPE_POOL, "<size>", "FREE");
80 zprop_register_number(ZPOOL_PROP_FREEING, "freeing", 0, PROP_READONLY,
81 ZFS_TYPE_POOL, "<size>", "FREEING");
82 zprop_register_number(ZPOOL_PROP_CHECKPOINT, "checkpoint", 0,
83 PROP_READONLY, ZFS_TYPE_POOL, "<size>", "CKPOINT");
84 zprop_register_number(ZPOOL_PROP_LEAKED, "leaked", 0, PROP_READONLY,
85 ZFS_TYPE_POOL, "<size>", "LEAKED");
86 zprop_register_number(ZPOOL_PROP_ALLOCATED, "allocated", 0,
87 PROP_READONLY, ZFS_TYPE_POOL, "<size>", "ALLOC");
88 zprop_register_number(ZPOOL_PROP_EXPANDSZ, "expandsize", 0,
89 PROP_READONLY, ZFS_TYPE_POOL, "<size>", "EXPANDSZ");
90 zprop_register_number(ZPOOL_PROP_FRAGMENTATION, "fragmentation", 0,
91 PROP_READONLY, ZFS_TYPE_POOL, "<percent>", "FRAG");
92 zprop_register_number(ZPOOL_PROP_CAPACITY, "capacity", 0, PROP_READONLY,
93 ZFS_TYPE_POOL, "<size>", "CAP");
94 zprop_register_number(ZPOOL_PROP_GUID, "guid", 0, PROP_READONLY,
95 ZFS_TYPE_POOL, "<guid>", "GUID");
96 zprop_register_number(ZPOOL_PROP_HEALTH, "health", 0, PROP_READONLY,
97 ZFS_TYPE_POOL, "<state>", "HEALTH");
98 zprop_register_number(ZPOOL_PROP_DEDUPRATIO, "dedupratio", 0,
99 PROP_READONLY, ZFS_TYPE_POOL, "<1.00x or higher if deduped>",
102 /* default number properties */
103 zprop_register_number(ZPOOL_PROP_VERSION, "version", SPA_VERSION,
104 PROP_DEFAULT, ZFS_TYPE_POOL, "<version>", "VERSION");
105 zprop_register_number(ZPOOL_PROP_DEDUPDITTO, "dedupditto", 0,
106 PROP_DEFAULT, ZFS_TYPE_POOL, "<threshold (min 100)>", "DEDUPDITTO");
107 zprop_register_number(ZPOOL_PROP_ASHIFT, "ashift", 0, PROP_DEFAULT,
108 ZFS_TYPE_POOL, "<ashift, 9-16, or 0=default>", "ASHIFT");
110 /* default index (boolean) properties */
111 zprop_register_index(ZPOOL_PROP_DELEGATION, "delegation", 1,
112 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "DELEGATION",
114 zprop_register_index(ZPOOL_PROP_AUTOREPLACE, "autoreplace", 0,
115 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "REPLACE", boolean_table);
116 zprop_register_index(ZPOOL_PROP_LISTSNAPS, "listsnapshots", 0,
117 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "LISTSNAPS",
119 zprop_register_index(ZPOOL_PROP_AUTOEXPAND, "autoexpand", 0,
120 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "EXPAND", boolean_table);
121 zprop_register_index(ZPOOL_PROP_READONLY, "readonly", 0,
122 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "RDONLY", boolean_table);
123 zprop_register_index(ZPOOL_PROP_MULTIHOST, "multihost", 0,
124 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "MULTIHOST",
127 /* default index properties */
128 zprop_register_index(ZPOOL_PROP_FAILUREMODE, "failmode",
129 ZIO_FAILURE_MODE_WAIT, PROP_DEFAULT, ZFS_TYPE_POOL,
130 "wait | continue | panic", "FAILMODE", failuremode_table);
132 /* hidden properties */
133 zprop_register_hidden(ZPOOL_PROP_NAME, "name", PROP_TYPE_STRING,
134 PROP_READONLY, ZFS_TYPE_POOL, "NAME");
135 zprop_register_hidden(ZPOOL_PROP_MAXBLOCKSIZE, "maxblocksize",
136 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_POOL, "MAXBLOCKSIZE");
137 zprop_register_hidden(ZPOOL_PROP_TNAME, "tname", PROP_TYPE_STRING,
138 PROP_ONETIME, ZFS_TYPE_POOL, "TNAME");
139 zprop_register_hidden(ZPOOL_PROP_MAXDNODESIZE, "maxdnodesize",
140 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_POOL, "MAXDNODESIZE");
144 * Given a property name and its type, returns the corresponding property ID.
147 zpool_name_to_prop(const char *propname)
149 return (zprop_name_to_prop(propname, ZFS_TYPE_POOL));
153 * Given a pool property ID, returns the corresponding name.
154 * Assuming the pool propety ID is valid.
157 zpool_prop_to_name(zpool_prop_t prop)
159 return (zpool_prop_table[prop].pd_name);
163 zpool_prop_get_type(zpool_prop_t prop)
165 return (zpool_prop_table[prop].pd_proptype);
169 zpool_prop_readonly(zpool_prop_t prop)
171 return (zpool_prop_table[prop].pd_attr == PROP_READONLY);
175 zpool_prop_default_string(zpool_prop_t prop)
177 return (zpool_prop_table[prop].pd_strdefault);
181 zpool_prop_default_numeric(zpool_prop_t prop)
183 return (zpool_prop_table[prop].pd_numdefault);
187 * Returns true if this is a valid feature@ property.
190 zpool_prop_feature(const char *name)
192 static const char *prefix = "feature@";
193 return (strncmp(name, prefix, strlen(prefix)) == 0);
197 * Returns true if this is a valid unsupported@ property.
200 zpool_prop_unsupported(const char *name)
202 static const char *prefix = "unsupported@";
203 return (strncmp(name, prefix, strlen(prefix)) == 0);
207 zpool_prop_string_to_index(zpool_prop_t prop, const char *string,
210 return (zprop_string_to_index(prop, string, index, ZFS_TYPE_POOL));
214 zpool_prop_index_to_string(zpool_prop_t prop, uint64_t index,
217 return (zprop_index_to_string(prop, index, string, ZFS_TYPE_POOL));
221 zpool_prop_random_value(zpool_prop_t prop, uint64_t seed)
223 return (zprop_random_value(prop, seed, ZFS_TYPE_POOL));
229 zpool_prop_values(zpool_prop_t prop)
231 return (zpool_prop_table[prop].pd_values);
235 zpool_prop_column_name(zpool_prop_t prop)
237 return (zpool_prop_table[prop].pd_colname);
241 zpool_prop_align_right(zpool_prop_t prop)
243 return (zpool_prop_table[prop].pd_rightalign);
248 /* zpool property functions */
249 EXPORT_SYMBOL(zpool_prop_init);
250 EXPORT_SYMBOL(zpool_prop_get_type);
251 EXPORT_SYMBOL(zpool_prop_get_table);
253 /* Pool property functions shared between libzfs and kernel. */
254 EXPORT_SYMBOL(zpool_name_to_prop);
255 EXPORT_SYMBOL(zpool_prop_to_name);
256 EXPORT_SYMBOL(zpool_prop_default_string);
257 EXPORT_SYMBOL(zpool_prop_default_numeric);
258 EXPORT_SYMBOL(zpool_prop_readonly);
259 EXPORT_SYMBOL(zpool_prop_feature);
260 EXPORT_SYMBOL(zpool_prop_unsupported);
261 EXPORT_SYMBOL(zpool_prop_index_to_string);
262 EXPORT_SYMBOL(zpool_prop_string_to_index);