]>
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. |
f3a7f661 | 24 | * Copyright (c) 2012, 2014 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 | ||
35 | #if defined(_KERNEL) | |
36 | #include <sys/systm.h> | |
37 | #else | |
38 | #include <stdlib.h> | |
39 | #include <string.h> | |
40 | #include <ctype.h> | |
41 | #endif | |
42 | ||
43 | static zprop_desc_t zpool_prop_table[ZPOOL_NUM_PROPS]; | |
44 | ||
45 | zprop_desc_t * | |
46 | zpool_prop_get_table(void) | |
47 | { | |
48 | return (zpool_prop_table); | |
49 | } | |
50 | ||
51 | void | |
52 | zpool_prop_init(void) | |
53 | { | |
54 | static zprop_index_t boolean_table[] = { | |
55 | { "off", 0}, | |
56 | { "on", 1}, | |
57 | { NULL } | |
58 | }; | |
59 | ||
60 | static zprop_index_t failuremode_table[] = { | |
61 | { "wait", ZIO_FAILURE_MODE_WAIT }, | |
62 | { "continue", ZIO_FAILURE_MODE_CONTINUE }, | |
63 | { "panic", ZIO_FAILURE_MODE_PANIC }, | |
64 | { NULL } | |
65 | }; | |
66 | ||
67 | /* string properties */ | |
428870ff | 68 | zprop_register_string(ZPOOL_PROP_ALTROOT, "altroot", NULL, PROP_DEFAULT, |
34dc7c2f | 69 | ZFS_TYPE_POOL, "<path>", "ALTROOT"); |
428870ff | 70 | zprop_register_string(ZPOOL_PROP_BOOTFS, "bootfs", NULL, PROP_DEFAULT, |
34dc7c2f | 71 | ZFS_TYPE_POOL, "<filesystem>", "BOOTFS"); |
428870ff BB |
72 | zprop_register_string(ZPOOL_PROP_CACHEFILE, "cachefile", NULL, |
73 | PROP_DEFAULT, ZFS_TYPE_POOL, "<file> | none", "CACHEFILE"); | |
d96eb2b1 DM |
74 | zprop_register_string(ZPOOL_PROP_COMMENT, "comment", NULL, |
75 | PROP_DEFAULT, ZFS_TYPE_POOL, "<comment-string>", "COMMENT"); | |
34dc7c2f BB |
76 | |
77 | /* readonly number properties */ | |
428870ff | 78 | zprop_register_number(ZPOOL_PROP_SIZE, "size", 0, PROP_READONLY, |
34dc7c2f | 79 | ZFS_TYPE_POOL, "<size>", "SIZE"); |
428870ff BB |
80 | zprop_register_number(ZPOOL_PROP_FREE, "free", 0, PROP_READONLY, |
81 | ZFS_TYPE_POOL, "<size>", "FREE"); | |
9ae529ec CS |
82 | zprop_register_number(ZPOOL_PROP_FREEING, "freeing", 0, PROP_READONLY, |
83 | ZFS_TYPE_POOL, "<size>", "FREEING"); | |
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"); |
428870ff | 96 | zprop_register_number(ZPOOL_PROP_HEALTH, "health", 0, PROP_READONLY, |
34dc7c2f | 97 | ZFS_TYPE_POOL, "<state>", "HEALTH"); |
428870ff BB |
98 | zprop_register_number(ZPOOL_PROP_DEDUPRATIO, "dedupratio", 0, |
99 | PROP_READONLY, ZFS_TYPE_POOL, "<1.00x or higher if deduped>", | |
100 | "DEDUP"); | |
34dc7c2f | 101 | |
df30f566 CK |
102 | /* readonly onetime number properties */ |
103 | zprop_register_number(ZPOOL_PROP_ASHIFT, "ashift", 0, PROP_ONETIME, | |
b41c9906 | 104 | ZFS_TYPE_POOL, "<ashift, 9-13, or 0=default>", "ASHIFT"); |
df30f566 | 105 | |
34dc7c2f | 106 | /* default number properties */ |
428870ff | 107 | zprop_register_number(ZPOOL_PROP_VERSION, "version", SPA_VERSION, |
34dc7c2f | 108 | PROP_DEFAULT, ZFS_TYPE_POOL, "<version>", "VERSION"); |
428870ff BB |
109 | zprop_register_number(ZPOOL_PROP_DEDUPDITTO, "dedupditto", 0, |
110 | PROP_DEFAULT, ZFS_TYPE_POOL, "<threshold (min 100)>", "DEDUPDITTO"); | |
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); | |
34dc7c2f BB |
125 | |
126 | /* default index properties */ | |
428870ff | 127 | zprop_register_index(ZPOOL_PROP_FAILUREMODE, "failmode", |
34dc7c2f BB |
128 | ZIO_FAILURE_MODE_WAIT, PROP_DEFAULT, ZFS_TYPE_POOL, |
129 | "wait | continue | panic", "FAILMODE", failuremode_table); | |
130 | ||
131 | /* hidden properties */ | |
428870ff | 132 | zprop_register_hidden(ZPOOL_PROP_NAME, "name", PROP_TYPE_STRING, |
34dc7c2f | 133 | PROP_READONLY, ZFS_TYPE_POOL, "NAME"); |
83e9986f RY |
134 | zprop_register_hidden(ZPOOL_PROP_TNAME, "tname", PROP_TYPE_STRING, |
135 | PROP_ONETIME, ZFS_TYPE_POOL, "TNAME"); | |
34dc7c2f BB |
136 | } |
137 | ||
138 | /* | |
139 | * Given a property name and its type, returns the corresponding property ID. | |
140 | */ | |
141 | zpool_prop_t | |
142 | zpool_name_to_prop(const char *propname) | |
143 | { | |
144 | return (zprop_name_to_prop(propname, ZFS_TYPE_POOL)); | |
145 | } | |
146 | ||
147 | /* | |
148 | * Given a pool property ID, returns the corresponding name. | |
149 | * Assuming the pool propety ID is valid. | |
150 | */ | |
151 | const char * | |
152 | zpool_prop_to_name(zpool_prop_t prop) | |
153 | { | |
154 | return (zpool_prop_table[prop].pd_name); | |
155 | } | |
156 | ||
157 | zprop_type_t | |
158 | zpool_prop_get_type(zpool_prop_t prop) | |
159 | { | |
160 | return (zpool_prop_table[prop].pd_proptype); | |
161 | } | |
162 | ||
163 | boolean_t | |
164 | zpool_prop_readonly(zpool_prop_t prop) | |
165 | { | |
166 | return (zpool_prop_table[prop].pd_attr == PROP_READONLY); | |
167 | } | |
168 | ||
169 | const char * | |
170 | zpool_prop_default_string(zpool_prop_t prop) | |
171 | { | |
172 | return (zpool_prop_table[prop].pd_strdefault); | |
173 | } | |
174 | ||
175 | uint64_t | |
176 | zpool_prop_default_numeric(zpool_prop_t prop) | |
177 | { | |
178 | return (zpool_prop_table[prop].pd_numdefault); | |
179 | } | |
180 | ||
9ae529ec CS |
181 | /* |
182 | * Returns true if this is a valid feature@ property. | |
183 | */ | |
184 | boolean_t | |
185 | zpool_prop_feature(const char *name) | |
186 | { | |
187 | static const char *prefix = "feature@"; | |
188 | return (strncmp(name, prefix, strlen(prefix)) == 0); | |
189 | } | |
190 | ||
191 | /* | |
192 | * Returns true if this is a valid unsupported@ property. | |
193 | */ | |
194 | boolean_t | |
195 | zpool_prop_unsupported(const char *name) | |
196 | { | |
197 | static const char *prefix = "unsupported@"; | |
198 | return (strncmp(name, prefix, strlen(prefix)) == 0); | |
199 | } | |
200 | ||
34dc7c2f BB |
201 | int |
202 | zpool_prop_string_to_index(zpool_prop_t prop, const char *string, | |
203 | uint64_t *index) | |
204 | { | |
205 | return (zprop_string_to_index(prop, string, index, ZFS_TYPE_POOL)); | |
206 | } | |
207 | ||
208 | int | |
209 | zpool_prop_index_to_string(zpool_prop_t prop, uint64_t index, | |
210 | const char **string) | |
211 | { | |
212 | return (zprop_index_to_string(prop, index, string, ZFS_TYPE_POOL)); | |
213 | } | |
214 | ||
428870ff BB |
215 | uint64_t |
216 | zpool_prop_random_value(zpool_prop_t prop, uint64_t seed) | |
217 | { | |
218 | return (zprop_random_value(prop, seed, ZFS_TYPE_POOL)); | |
219 | } | |
220 | ||
34dc7c2f BB |
221 | #ifndef _KERNEL |
222 | ||
223 | const char * | |
224 | zpool_prop_values(zpool_prop_t prop) | |
225 | { | |
226 | return (zpool_prop_table[prop].pd_values); | |
227 | } | |
228 | ||
229 | const char * | |
230 | zpool_prop_column_name(zpool_prop_t prop) | |
231 | { | |
232 | return (zpool_prop_table[prop].pd_colname); | |
233 | } | |
234 | ||
235 | boolean_t | |
236 | zpool_prop_align_right(zpool_prop_t prop) | |
237 | { | |
238 | return (zpool_prop_table[prop].pd_rightalign); | |
239 | } | |
240 | #endif | |
c28b2279 BB |
241 | |
242 | #if defined(_KERNEL) && defined(HAVE_SPL) | |
243 | /* zpool property functions */ | |
244 | EXPORT_SYMBOL(zpool_prop_init); | |
245 | EXPORT_SYMBOL(zpool_prop_get_type); | |
246 | EXPORT_SYMBOL(zpool_prop_get_table); | |
247 | ||
248 | /* Pool property functions shared between libzfs and kernel. */ | |
249 | EXPORT_SYMBOL(zpool_name_to_prop); | |
250 | EXPORT_SYMBOL(zpool_prop_to_name); | |
251 | EXPORT_SYMBOL(zpool_prop_default_string); | |
252 | EXPORT_SYMBOL(zpool_prop_default_numeric); | |
253 | EXPORT_SYMBOL(zpool_prop_readonly); | |
9ae529ec CS |
254 | EXPORT_SYMBOL(zpool_prop_feature); |
255 | EXPORT_SYMBOL(zpool_prop_unsupported); | |
c28b2279 BB |
256 | EXPORT_SYMBOL(zpool_prop_index_to_string); |
257 | EXPORT_SYMBOL(zpool_prop_string_to_index); | |
258 | #endif |