1 /*
2 * CDDL HEADER START
3 *
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.
7 *
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.
12 *
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]
18 *
19 * CDDL HEADER END
20 */
21 /*
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, 2018 by Delphix. All rights reserved.
25 */
26
27 #include <sys/zio.h>
28 #include <sys/spa.h>
29 #include <sys/zfs_acl.h>
30 #include <sys/zfs_ioctl.h>
31 #include <sys/fs/zfs.h>
32
33 #include "zfs_prop.h"
34
35 #if !defined(_KERNEL)
36 #include <stdlib.h>
37 #include <string.h>
38 #include <ctype.h>
39 #endif
40
41 static zprop_desc_t zpool_prop_table[ZPOOL_NUM_PROPS];
42
43 zprop_desc_t *
zpool_prop_get_table(void)44 zpool_prop_get_table(void)
45 {
46 return (zpool_prop_table);
47 }
48
49 void
zpool_prop_init(void)50 zpool_prop_init(void)
51 {
52 static zprop_index_t boolean_table[] = {
53 { "off", 0},
54 { "on", 1},
55 { NULL }
56 };
57
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 },
62 { NULL }
63 };
64
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");
74
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_LOAD_GUID, "load_guid", 0,
97 PROP_READONLY, ZFS_TYPE_POOL, "<load_guid>", "LOAD_GUID");
98 zprop_register_number(ZPOOL_PROP_HEALTH, "health", 0, PROP_READONLY,
99 ZFS_TYPE_POOL, "<state>", "HEALTH");
100 zprop_register_number(ZPOOL_PROP_DEDUPRATIO, "dedupratio", 0,
101 PROP_READONLY, ZFS_TYPE_POOL, "<1.00x or higher if deduped>",
102 "DEDUP");
103
104 /* default number properties */
105 zprop_register_number(ZPOOL_PROP_VERSION, "version", SPA_VERSION,
106 PROP_DEFAULT, ZFS_TYPE_POOL, "<version>", "VERSION");
107 zprop_register_number(ZPOOL_PROP_ASHIFT, "ashift", 0, PROP_DEFAULT,
108 ZFS_TYPE_POOL, "<ashift, 9-16, or 0=default>", "ASHIFT");
109
110 /* default index (boolean) properties */
111 zprop_register_index(ZPOOL_PROP_DELEGATION, "delegation", 1,
112 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "DELEGATION",
113 boolean_table);
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",
118 boolean_table);
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",
125 boolean_table);
126
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);
131 zprop_register_index(ZPOOL_PROP_AUTOTRIM, "autotrim",
132 SPA_AUTOTRIM_DEFAULT, PROP_DEFAULT, ZFS_TYPE_POOL,
133 "on | off", "AUTOTRIM", boolean_table);
134
135 /* hidden properties */
136 zprop_register_hidden(ZPOOL_PROP_NAME, "name", PROP_TYPE_STRING,
137 PROP_READONLY, ZFS_TYPE_POOL, "NAME");
138 zprop_register_hidden(ZPOOL_PROP_MAXBLOCKSIZE, "maxblocksize",
139 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_POOL, "MAXBLOCKSIZE");
140 zprop_register_hidden(ZPOOL_PROP_TNAME, "tname", PROP_TYPE_STRING,
141 PROP_ONETIME, ZFS_TYPE_POOL, "TNAME");
142 zprop_register_hidden(ZPOOL_PROP_MAXDNODESIZE, "maxdnodesize",
143 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_POOL, "MAXDNODESIZE");
144 zprop_register_hidden(ZPOOL_PROP_DEDUPDITTO, "dedupditto",
145 PROP_TYPE_NUMBER, PROP_DEFAULT, ZFS_TYPE_POOL, "DEDUPDITTO");
146 }
147
148 /*
149 * Given a property name and its type, returns the corresponding property ID.
150 */
151 zpool_prop_t
zpool_name_to_prop(const char * propname)152 zpool_name_to_prop(const char *propname)
153 {
154 return (zprop_name_to_prop(propname, ZFS_TYPE_POOL));
155 }
156
157 /*
158 * Given a pool property ID, returns the corresponding name.
159 * Assuming the pool property ID is valid.
160 */
161 const char *
zpool_prop_to_name(zpool_prop_t prop)162 zpool_prop_to_name(zpool_prop_t prop)
163 {
164 return (zpool_prop_table[prop].pd_name);
165 }
166
167 zprop_type_t
zpool_prop_get_type(zpool_prop_t prop)168 zpool_prop_get_type(zpool_prop_t prop)
169 {
170 return (zpool_prop_table[prop].pd_proptype);
171 }
172
173 boolean_t
zpool_prop_readonly(zpool_prop_t prop)174 zpool_prop_readonly(zpool_prop_t prop)
175 {
176 return (zpool_prop_table[prop].pd_attr == PROP_READONLY);
177 }
178
179 boolean_t
zpool_prop_setonce(zpool_prop_t prop)180 zpool_prop_setonce(zpool_prop_t prop)
181 {
182 return (zpool_prop_table[prop].pd_attr == PROP_ONETIME);
183 }
184
185 const char *
zpool_prop_default_string(zpool_prop_t prop)186 zpool_prop_default_string(zpool_prop_t prop)
187 {
188 return (zpool_prop_table[prop].pd_strdefault);
189 }
190
191 uint64_t
zpool_prop_default_numeric(zpool_prop_t prop)192 zpool_prop_default_numeric(zpool_prop_t prop)
193 {
194 return (zpool_prop_table[prop].pd_numdefault);
195 }
196
197 /*
198 * Returns true if this is a valid feature@ property.
199 */
200 boolean_t
zpool_prop_feature(const char * name)201 zpool_prop_feature(const char *name)
202 {
203 static const char *prefix = "feature@";
204 return (strncmp(name, prefix, strlen(prefix)) == 0);
205 }
206
207 /*
208 * Returns true if this is a valid unsupported@ property.
209 */
210 boolean_t
zpool_prop_unsupported(const char * name)211 zpool_prop_unsupported(const char *name)
212 {
213 static const char *prefix = "unsupported@";
214 return (strncmp(name, prefix, strlen(prefix)) == 0);
215 }
216
217 int
zpool_prop_string_to_index(zpool_prop_t prop,const char * string,uint64_t * index)218 zpool_prop_string_to_index(zpool_prop_t prop, const char *string,
219 uint64_t *index)
220 {
221 return (zprop_string_to_index(prop, string, index, ZFS_TYPE_POOL));
222 }
223
224 int
zpool_prop_index_to_string(zpool_prop_t prop,uint64_t index,const char ** string)225 zpool_prop_index_to_string(zpool_prop_t prop, uint64_t index,
226 const char **string)
227 {
228 return (zprop_index_to_string(prop, index, string, ZFS_TYPE_POOL));
229 }
230
231 uint64_t
zpool_prop_random_value(zpool_prop_t prop,uint64_t seed)232 zpool_prop_random_value(zpool_prop_t prop, uint64_t seed)
233 {
234 return (zprop_random_value(prop, seed, ZFS_TYPE_POOL));
235 }
236
237 #ifndef _KERNEL
238 #include <libzfs.h>
239
240 const char *
zpool_prop_values(zpool_prop_t prop)241 zpool_prop_values(zpool_prop_t prop)
242 {
243 return (zpool_prop_table[prop].pd_values);
244 }
245
246 const char *
zpool_prop_column_name(zpool_prop_t prop)247 zpool_prop_column_name(zpool_prop_t prop)
248 {
249 return (zpool_prop_table[prop].pd_colname);
250 }
251
252 boolean_t
zpool_prop_align_right(zpool_prop_t prop)253 zpool_prop_align_right(zpool_prop_t prop)
254 {
255 return (zpool_prop_table[prop].pd_rightalign);
256 }
257 #endif
258
259 #if defined(_KERNEL)
260 /* zpool property functions */
261 EXPORT_SYMBOL(zpool_prop_init);
262 EXPORT_SYMBOL(zpool_prop_get_type);
263 EXPORT_SYMBOL(zpool_prop_get_table);
264
265 /* Pool property functions shared between libzfs and kernel. */
266 EXPORT_SYMBOL(zpool_name_to_prop);
267 EXPORT_SYMBOL(zpool_prop_to_name);
268 EXPORT_SYMBOL(zpool_prop_default_string);
269 EXPORT_SYMBOL(zpool_prop_default_numeric);
270 EXPORT_SYMBOL(zpool_prop_readonly);
271 EXPORT_SYMBOL(zpool_prop_feature);
272 EXPORT_SYMBOL(zpool_prop_unsupported);
273 EXPORT_SYMBOL(zpool_prop_index_to_string);
274 EXPORT_SYMBOL(zpool_prop_string_to_index);
275 #endif
276