]>
Commit | Line | Data |
---|---|---|
34dc7c2f BB |
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 | /* | |
572e2857 | 22 | * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved. |
d96eb2b1 | 23 | * Copyright 2011 Nexenta Systems, Inc. All rights reserved. |
a448a255 | 24 | * Copyright (c) 2012, 2018 by Delphix. All rights reserved. |
34dc7c2f BB |
25 | */ |
26 | ||
34dc7c2f BB |
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 | ||
93ce2b4c | 35 | #if !defined(_KERNEL) |
34dc7c2f BB |
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 * | |
44 | zpool_prop_get_table(void) | |
45 | { | |
46 | return (zpool_prop_table); | |
47 | } | |
48 | ||
49 | 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 */ | |
428870ff | 66 | zprop_register_string(ZPOOL_PROP_ALTROOT, "altroot", NULL, PROP_DEFAULT, |
34dc7c2f | 67 | ZFS_TYPE_POOL, "<path>", "ALTROOT"); |
428870ff | 68 | zprop_register_string(ZPOOL_PROP_BOOTFS, "bootfs", NULL, PROP_DEFAULT, |
34dc7c2f | 69 | ZFS_TYPE_POOL, "<filesystem>", "BOOTFS"); |
428870ff BB |
70 | zprop_register_string(ZPOOL_PROP_CACHEFILE, "cachefile", NULL, |
71 | PROP_DEFAULT, ZFS_TYPE_POOL, "<file> | none", "CACHEFILE"); | |
d96eb2b1 DM |
72 | zprop_register_string(ZPOOL_PROP_COMMENT, "comment", NULL, |
73 | PROP_DEFAULT, ZFS_TYPE_POOL, "<comment-string>", "COMMENT"); | |
34dc7c2f BB |
74 | |
75 | /* readonly number properties */ | |
428870ff | 76 | zprop_register_number(ZPOOL_PROP_SIZE, "size", 0, PROP_READONLY, |
34dc7c2f | 77 | ZFS_TYPE_POOL, "<size>", "SIZE"); |
428870ff BB |
78 | zprop_register_number(ZPOOL_PROP_FREE, "free", 0, PROP_READONLY, |
79 | ZFS_TYPE_POOL, "<size>", "FREE"); | |
9ae529ec CS |
80 | zprop_register_number(ZPOOL_PROP_FREEING, "freeing", 0, PROP_READONLY, |
81 | ZFS_TYPE_POOL, "<size>", "FREEING"); | |
d2734cce SD |
82 | zprop_register_number(ZPOOL_PROP_CHECKPOINT, "checkpoint", 0, |
83 | PROP_READONLY, ZFS_TYPE_POOL, "<size>", "CKPOINT"); | |
fbeddd60 MA |
84 | zprop_register_number(ZPOOL_PROP_LEAKED, "leaked", 0, PROP_READONLY, |
85 | ZFS_TYPE_POOL, "<size>", "LEAKED"); | |
428870ff BB |
86 | zprop_register_number(ZPOOL_PROP_ALLOCATED, "allocated", 0, |
87 | PROP_READONLY, ZFS_TYPE_POOL, "<size>", "ALLOC"); | |
1bd201e7 CS |
88 | zprop_register_number(ZPOOL_PROP_EXPANDSZ, "expandsize", 0, |
89 | PROP_READONLY, ZFS_TYPE_POOL, "<size>", "EXPANDSZ"); | |
f3a7f661 GW |
90 | zprop_register_number(ZPOOL_PROP_FRAGMENTATION, "fragmentation", 0, |
91 | PROP_READONLY, ZFS_TYPE_POOL, "<percent>", "FRAG"); | |
428870ff | 92 | zprop_register_number(ZPOOL_PROP_CAPACITY, "capacity", 0, PROP_READONLY, |
34dc7c2f | 93 | ZFS_TYPE_POOL, "<size>", "CAP"); |
428870ff | 94 | zprop_register_number(ZPOOL_PROP_GUID, "guid", 0, PROP_READONLY, |
34dc7c2f | 95 | ZFS_TYPE_POOL, "<guid>", "GUID"); |
a448a255 SD |
96 | zprop_register_number(ZPOOL_PROP_LOAD_GUID, "load_guid", 0, |
97 | PROP_READONLY, ZFS_TYPE_POOL, "<load_guid>", "LOAD_GUID"); | |
428870ff | 98 | zprop_register_number(ZPOOL_PROP_HEALTH, "health", 0, PROP_READONLY, |
34dc7c2f | 99 | ZFS_TYPE_POOL, "<state>", "HEALTH"); |
428870ff BB |
100 | zprop_register_number(ZPOOL_PROP_DEDUPRATIO, "dedupratio", 0, |
101 | PROP_READONLY, ZFS_TYPE_POOL, "<1.00x or higher if deduped>", | |
102 | "DEDUP"); | |
34dc7c2f BB |
103 | |
104 | /* default number properties */ | |
428870ff | 105 | zprop_register_number(ZPOOL_PROP_VERSION, "version", SPA_VERSION, |
34dc7c2f | 106 | PROP_DEFAULT, ZFS_TYPE_POOL, "<version>", "VERSION"); |
428870ff BB |
107 | zprop_register_number(ZPOOL_PROP_DEDUPDITTO, "dedupditto", 0, |
108 | PROP_DEFAULT, ZFS_TYPE_POOL, "<threshold (min 100)>", "DEDUPDITTO"); | |
dddef7d6 | 109 | zprop_register_number(ZPOOL_PROP_ASHIFT, "ashift", 0, PROP_DEFAULT, |
110 | ZFS_TYPE_POOL, "<ashift, 9-16, or 0=default>", "ASHIFT"); | |
34dc7c2f BB |
111 | |
112 | /* default index (boolean) properties */ | |
428870ff BB |
113 | zprop_register_index(ZPOOL_PROP_DELEGATION, "delegation", 1, |
114 | PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "DELEGATION", | |
115 | boolean_table); | |
116 | zprop_register_index(ZPOOL_PROP_AUTOREPLACE, "autoreplace", 0, | |
117 | PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "REPLACE", boolean_table); | |
118 | zprop_register_index(ZPOOL_PROP_LISTSNAPS, "listsnapshots", 0, | |
119 | PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "LISTSNAPS", | |
120 | boolean_table); | |
121 | zprop_register_index(ZPOOL_PROP_AUTOEXPAND, "autoexpand", 0, | |
122 | PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "EXPAND", boolean_table); | |
572e2857 BB |
123 | zprop_register_index(ZPOOL_PROP_READONLY, "readonly", 0, |
124 | PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "RDONLY", boolean_table); | |
379ca9cf OF |
125 | zprop_register_index(ZPOOL_PROP_MULTIHOST, "multihost", 0, |
126 | PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "MULTIHOST", | |
127 | boolean_table); | |
34dc7c2f BB |
128 | |
129 | /* default index properties */ | |
428870ff | 130 | zprop_register_index(ZPOOL_PROP_FAILUREMODE, "failmode", |
34dc7c2f BB |
131 | ZIO_FAILURE_MODE_WAIT, PROP_DEFAULT, ZFS_TYPE_POOL, |
132 | "wait | continue | panic", "FAILMODE", failuremode_table); | |
133 | ||
134 | /* hidden properties */ | |
428870ff | 135 | zprop_register_hidden(ZPOOL_PROP_NAME, "name", PROP_TYPE_STRING, |
34dc7c2f | 136 | PROP_READONLY, ZFS_TYPE_POOL, "NAME"); |
f1512ee6 MA |
137 | zprop_register_hidden(ZPOOL_PROP_MAXBLOCKSIZE, "maxblocksize", |
138 | PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_POOL, "MAXBLOCKSIZE"); | |
83e9986f RY |
139 | zprop_register_hidden(ZPOOL_PROP_TNAME, "tname", PROP_TYPE_STRING, |
140 | PROP_ONETIME, ZFS_TYPE_POOL, "TNAME"); | |
50c957f7 NB |
141 | zprop_register_hidden(ZPOOL_PROP_MAXDNODESIZE, "maxdnodesize", |
142 | PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_POOL, "MAXDNODESIZE"); | |
34dc7c2f BB |
143 | } |
144 | ||
145 | /* | |
146 | * Given a property name and its type, returns the corresponding property ID. | |
147 | */ | |
148 | zpool_prop_t | |
149 | zpool_name_to_prop(const char *propname) | |
150 | { | |
151 | return (zprop_name_to_prop(propname, ZFS_TYPE_POOL)); | |
152 | } | |
153 | ||
154 | /* | |
155 | * Given a pool property ID, returns the corresponding name. | |
156 | * Assuming the pool propety ID is valid. | |
157 | */ | |
158 | const char * | |
159 | zpool_prop_to_name(zpool_prop_t prop) | |
160 | { | |
161 | return (zpool_prop_table[prop].pd_name); | |
162 | } | |
163 | ||
164 | zprop_type_t | |
165 | zpool_prop_get_type(zpool_prop_t prop) | |
166 | { | |
167 | return (zpool_prop_table[prop].pd_proptype); | |
168 | } | |
169 | ||
170 | boolean_t | |
171 | zpool_prop_readonly(zpool_prop_t prop) | |
172 | { | |
173 | return (zpool_prop_table[prop].pd_attr == PROP_READONLY); | |
174 | } | |
175 | ||
edf60b86 CC |
176 | boolean_t |
177 | zpool_prop_setonce(zpool_prop_t prop) | |
178 | { | |
179 | return (zpool_prop_table[prop].pd_attr == PROP_ONETIME); | |
180 | } | |
181 | ||
34dc7c2f BB |
182 | const char * |
183 | zpool_prop_default_string(zpool_prop_t prop) | |
184 | { | |
185 | return (zpool_prop_table[prop].pd_strdefault); | |
186 | } | |
187 | ||
188 | uint64_t | |
189 | zpool_prop_default_numeric(zpool_prop_t prop) | |
190 | { | |
191 | return (zpool_prop_table[prop].pd_numdefault); | |
192 | } | |
193 | ||
9ae529ec CS |
194 | /* |
195 | * Returns true if this is a valid feature@ property. | |
196 | */ | |
197 | boolean_t | |
198 | zpool_prop_feature(const char *name) | |
199 | { | |
200 | static const char *prefix = "feature@"; | |
201 | return (strncmp(name, prefix, strlen(prefix)) == 0); | |
202 | } | |
203 | ||
204 | /* | |
205 | * Returns true if this is a valid unsupported@ property. | |
206 | */ | |
207 | boolean_t | |
208 | zpool_prop_unsupported(const char *name) | |
209 | { | |
210 | static const char *prefix = "unsupported@"; | |
211 | return (strncmp(name, prefix, strlen(prefix)) == 0); | |
212 | } | |
213 | ||
34dc7c2f BB |
214 | int |
215 | zpool_prop_string_to_index(zpool_prop_t prop, const char *string, | |
216 | uint64_t *index) | |
217 | { | |
218 | return (zprop_string_to_index(prop, string, index, ZFS_TYPE_POOL)); | |
219 | } | |
220 | ||
221 | int | |
222 | zpool_prop_index_to_string(zpool_prop_t prop, uint64_t index, | |
223 | const char **string) | |
224 | { | |
225 | return (zprop_index_to_string(prop, index, string, ZFS_TYPE_POOL)); | |
226 | } | |
227 | ||
428870ff BB |
228 | uint64_t |
229 | zpool_prop_random_value(zpool_prop_t prop, uint64_t seed) | |
230 | { | |
231 | return (zprop_random_value(prop, seed, ZFS_TYPE_POOL)); | |
232 | } | |
233 | ||
34dc7c2f BB |
234 | #ifndef _KERNEL |
235 | ||
236 | const char * | |
237 | zpool_prop_values(zpool_prop_t prop) | |
238 | { | |
239 | return (zpool_prop_table[prop].pd_values); | |
240 | } | |
241 | ||
242 | const char * | |
243 | zpool_prop_column_name(zpool_prop_t prop) | |
244 | { | |
245 | return (zpool_prop_table[prop].pd_colname); | |
246 | } | |
247 | ||
248 | boolean_t | |
249 | zpool_prop_align_right(zpool_prop_t prop) | |
250 | { | |
251 | return (zpool_prop_table[prop].pd_rightalign); | |
252 | } | |
253 | #endif | |
c28b2279 | 254 | |
93ce2b4c | 255 | #if defined(_KERNEL) |
c28b2279 BB |
256 | /* zpool property functions */ |
257 | EXPORT_SYMBOL(zpool_prop_init); | |
258 | EXPORT_SYMBOL(zpool_prop_get_type); | |
259 | EXPORT_SYMBOL(zpool_prop_get_table); | |
260 | ||
261 | /* Pool property functions shared between libzfs and kernel. */ | |
262 | EXPORT_SYMBOL(zpool_name_to_prop); | |
263 | EXPORT_SYMBOL(zpool_prop_to_name); | |
264 | EXPORT_SYMBOL(zpool_prop_default_string); | |
265 | EXPORT_SYMBOL(zpool_prop_default_numeric); | |
266 | EXPORT_SYMBOL(zpool_prop_readonly); | |
9ae529ec CS |
267 | EXPORT_SYMBOL(zpool_prop_feature); |
268 | EXPORT_SYMBOL(zpool_prop_unsupported); | |
c28b2279 BB |
269 | EXPORT_SYMBOL(zpool_prop_index_to_string); |
270 | EXPORT_SYMBOL(zpool_prop_string_to_index); | |
271 | #endif |