Deleted Added
full compact
zpool_prop.c (236839) zpool_prop.c (243674)
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 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 <sys/systm.h>
37#else
38#include <stdlib.h>
39#include <string.h>
40#include <ctype.h>
41#endif
42
43static zprop_desc_t zpool_prop_table[ZPOOL_NUM_PROPS];
44
45zprop_desc_t *
46zpool_prop_get_table(void)
47{
48 return (zpool_prop_table);
49}
50
51void
52zpool_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 */
68 zprop_register_string(ZPOOL_PROP_ALTROOT, "altroot", NULL, PROP_DEFAULT,
69 ZFS_TYPE_POOL, "<path>", "ALTROOT");
70 zprop_register_string(ZPOOL_PROP_BOOTFS, "bootfs", NULL, PROP_DEFAULT,
71 ZFS_TYPE_POOL, "<filesystem>", "BOOTFS");
72 zprop_register_string(ZPOOL_PROP_CACHEFILE, "cachefile", NULL,
73 PROP_DEFAULT, ZFS_TYPE_POOL, "<file> | none", "CACHEFILE");
74 zprop_register_string(ZPOOL_PROP_COMMENT, "comment", NULL,
75 PROP_DEFAULT, ZFS_TYPE_POOL, "<comment-string>", "COMMENT");
76
77 /* readonly number properties */
78 zprop_register_number(ZPOOL_PROP_SIZE, "size", 0, PROP_READONLY,
79 ZFS_TYPE_POOL, "<size>", "SIZE");
80 zprop_register_number(ZPOOL_PROP_FREE, "free", 0, PROP_READONLY,
81 ZFS_TYPE_POOL, "<size>", "FREE");
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 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 <sys/systm.h>
37#else
38#include <stdlib.h>
39#include <string.h>
40#include <ctype.h>
41#endif
42
43static zprop_desc_t zpool_prop_table[ZPOOL_NUM_PROPS];
44
45zprop_desc_t *
46zpool_prop_get_table(void)
47{
48 return (zpool_prop_table);
49}
50
51void
52zpool_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 */
68 zprop_register_string(ZPOOL_PROP_ALTROOT, "altroot", NULL, PROP_DEFAULT,
69 ZFS_TYPE_POOL, "<path>", "ALTROOT");
70 zprop_register_string(ZPOOL_PROP_BOOTFS, "bootfs", NULL, PROP_DEFAULT,
71 ZFS_TYPE_POOL, "<filesystem>", "BOOTFS");
72 zprop_register_string(ZPOOL_PROP_CACHEFILE, "cachefile", NULL,
73 PROP_DEFAULT, ZFS_TYPE_POOL, "<file> | none", "CACHEFILE");
74 zprop_register_string(ZPOOL_PROP_COMMENT, "comment", NULL,
75 PROP_DEFAULT, ZFS_TYPE_POOL, "<comment-string>", "COMMENT");
76
77 /* readonly number properties */
78 zprop_register_number(ZPOOL_PROP_SIZE, "size", 0, PROP_READONLY,
79 ZFS_TYPE_POOL, "<size>", "SIZE");
80 zprop_register_number(ZPOOL_PROP_FREE, "free", 0, PROP_READONLY,
81 ZFS_TYPE_POOL, "<size>", "FREE");
82 zprop_register_number(ZPOOL_PROP_FREEING, "freeing", 0, PROP_READONLY,
83 ZFS_TYPE_POOL, "<size>", "FREEING");
82 zprop_register_number(ZPOOL_PROP_ALLOCATED, "allocated", 0,
83 PROP_READONLY, ZFS_TYPE_POOL, "<size>", "ALLOC");
84 zprop_register_number(ZPOOL_PROP_EXPANDSZ, "expandsize", 0,
85 PROP_READONLY, ZFS_TYPE_POOL, "<size>", "EXPANDSZ");
86 zprop_register_number(ZPOOL_PROP_CAPACITY, "capacity", 0, PROP_READONLY,
87 ZFS_TYPE_POOL, "<size>", "CAP");
88 zprop_register_number(ZPOOL_PROP_GUID, "guid", 0, PROP_READONLY,
89 ZFS_TYPE_POOL, "<guid>", "GUID");
90 zprop_register_number(ZPOOL_PROP_HEALTH, "health", 0, PROP_READONLY,
91 ZFS_TYPE_POOL, "<state>", "HEALTH");
92 zprop_register_number(ZPOOL_PROP_DEDUPRATIO, "dedupratio", 0,
93 PROP_READONLY, ZFS_TYPE_POOL, "<1.00x or higher if deduped>",
94 "DEDUP");
95
96 /* default number properties */
97 zprop_register_number(ZPOOL_PROP_VERSION, "version", SPA_VERSION,
98 PROP_DEFAULT, ZFS_TYPE_POOL, "<version>", "VERSION");
99 zprop_register_number(ZPOOL_PROP_DEDUPDITTO, "dedupditto", 0,
100 PROP_DEFAULT, ZFS_TYPE_POOL, "<threshold (min 100)>", "DEDUPDITTO");
101
102 /* default index (boolean) properties */
103 zprop_register_index(ZPOOL_PROP_DELEGATION, "delegation", 1,
104 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "DELEGATION",
105 boolean_table);
106 zprop_register_index(ZPOOL_PROP_AUTOREPLACE, "autoreplace", 0,
107 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "REPLACE", boolean_table);
108 zprop_register_index(ZPOOL_PROP_LISTSNAPS, "listsnapshots", 0,
109 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "LISTSNAPS",
110 boolean_table);
111 zprop_register_index(ZPOOL_PROP_AUTOEXPAND, "autoexpand", 0,
112 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "EXPAND", boolean_table);
113 zprop_register_index(ZPOOL_PROP_READONLY, "readonly", 0,
114 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "RDONLY", boolean_table);
115
116 /* default index properties */
117 zprop_register_index(ZPOOL_PROP_FAILUREMODE, "failmode",
118 ZIO_FAILURE_MODE_WAIT, PROP_DEFAULT, ZFS_TYPE_POOL,
119 "wait | continue | panic", "FAILMODE", failuremode_table);
120
121 /* hidden properties */
122 zprop_register_hidden(ZPOOL_PROP_NAME, "name", PROP_TYPE_STRING,
123 PROP_READONLY, ZFS_TYPE_POOL, "NAME");
124}
125
126/*
127 * Given a property name and its type, returns the corresponding property ID.
128 */
129zpool_prop_t
130zpool_name_to_prop(const char *propname)
131{
132 return (zprop_name_to_prop(propname, ZFS_TYPE_POOL));
133}
134
135/*
136 * Given a pool property ID, returns the corresponding name.
137 * Assuming the pool propety ID is valid.
138 */
139const char *
140zpool_prop_to_name(zpool_prop_t prop)
141{
142 return (zpool_prop_table[prop].pd_name);
143}
144
145zprop_type_t
146zpool_prop_get_type(zpool_prop_t prop)
147{
148 return (zpool_prop_table[prop].pd_proptype);
149}
150
151boolean_t
152zpool_prop_readonly(zpool_prop_t prop)
153{
154 return (zpool_prop_table[prop].pd_attr == PROP_READONLY);
155}
156
157const char *
158zpool_prop_default_string(zpool_prop_t prop)
159{
160 return (zpool_prop_table[prop].pd_strdefault);
161}
162
163uint64_t
164zpool_prop_default_numeric(zpool_prop_t prop)
165{
166 return (zpool_prop_table[prop].pd_numdefault);
167}
168
84 zprop_register_number(ZPOOL_PROP_ALLOCATED, "allocated", 0,
85 PROP_READONLY, ZFS_TYPE_POOL, "<size>", "ALLOC");
86 zprop_register_number(ZPOOL_PROP_EXPANDSZ, "expandsize", 0,
87 PROP_READONLY, ZFS_TYPE_POOL, "<size>", "EXPANDSZ");
88 zprop_register_number(ZPOOL_PROP_CAPACITY, "capacity", 0, PROP_READONLY,
89 ZFS_TYPE_POOL, "<size>", "CAP");
90 zprop_register_number(ZPOOL_PROP_GUID, "guid", 0, PROP_READONLY,
91 ZFS_TYPE_POOL, "<guid>", "GUID");
92 zprop_register_number(ZPOOL_PROP_HEALTH, "health", 0, PROP_READONLY,
93 ZFS_TYPE_POOL, "<state>", "HEALTH");
94 zprop_register_number(ZPOOL_PROP_DEDUPRATIO, "dedupratio", 0,
95 PROP_READONLY, ZFS_TYPE_POOL, "<1.00x or higher if deduped>",
96 "DEDUP");
97
98 /* default number properties */
99 zprop_register_number(ZPOOL_PROP_VERSION, "version", SPA_VERSION,
100 PROP_DEFAULT, ZFS_TYPE_POOL, "<version>", "VERSION");
101 zprop_register_number(ZPOOL_PROP_DEDUPDITTO, "dedupditto", 0,
102 PROP_DEFAULT, ZFS_TYPE_POOL, "<threshold (min 100)>", "DEDUPDITTO");
103
104 /* default index (boolean) properties */
105 zprop_register_index(ZPOOL_PROP_DELEGATION, "delegation", 1,
106 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "DELEGATION",
107 boolean_table);
108 zprop_register_index(ZPOOL_PROP_AUTOREPLACE, "autoreplace", 0,
109 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "REPLACE", boolean_table);
110 zprop_register_index(ZPOOL_PROP_LISTSNAPS, "listsnapshots", 0,
111 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "LISTSNAPS",
112 boolean_table);
113 zprop_register_index(ZPOOL_PROP_AUTOEXPAND, "autoexpand", 0,
114 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "EXPAND", boolean_table);
115 zprop_register_index(ZPOOL_PROP_READONLY, "readonly", 0,
116 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "RDONLY", boolean_table);
117
118 /* default index properties */
119 zprop_register_index(ZPOOL_PROP_FAILUREMODE, "failmode",
120 ZIO_FAILURE_MODE_WAIT, PROP_DEFAULT, ZFS_TYPE_POOL,
121 "wait | continue | panic", "FAILMODE", failuremode_table);
122
123 /* hidden properties */
124 zprop_register_hidden(ZPOOL_PROP_NAME, "name", PROP_TYPE_STRING,
125 PROP_READONLY, ZFS_TYPE_POOL, "NAME");
126}
127
128/*
129 * Given a property name and its type, returns the corresponding property ID.
130 */
131zpool_prop_t
132zpool_name_to_prop(const char *propname)
133{
134 return (zprop_name_to_prop(propname, ZFS_TYPE_POOL));
135}
136
137/*
138 * Given a pool property ID, returns the corresponding name.
139 * Assuming the pool propety ID is valid.
140 */
141const char *
142zpool_prop_to_name(zpool_prop_t prop)
143{
144 return (zpool_prop_table[prop].pd_name);
145}
146
147zprop_type_t
148zpool_prop_get_type(zpool_prop_t prop)
149{
150 return (zpool_prop_table[prop].pd_proptype);
151}
152
153boolean_t
154zpool_prop_readonly(zpool_prop_t prop)
155{
156 return (zpool_prop_table[prop].pd_attr == PROP_READONLY);
157}
158
159const char *
160zpool_prop_default_string(zpool_prop_t prop)
161{
162 return (zpool_prop_table[prop].pd_strdefault);
163}
164
165uint64_t
166zpool_prop_default_numeric(zpool_prop_t prop)
167{
168 return (zpool_prop_table[prop].pd_numdefault);
169}
170
171/*
172 * Returns true if this is a valid feature@ property.
173 */
174boolean_t
175zpool_prop_feature(const char *name)
176{
177 static const char *prefix = "feature@";
178 return (strncmp(name, prefix, strlen(prefix)) == 0);
179}
180
181/*
182 * Returns true if this is a valid unsupported@ property.
183 */
184boolean_t
185zpool_prop_unsupported(const char *name)
186{
187 static const char *prefix = "unsupported@";
188 return (strncmp(name, prefix, strlen(prefix)) == 0);
189}
190
169int
170zpool_prop_string_to_index(zpool_prop_t prop, const char *string,
171 uint64_t *index)
172{
173 return (zprop_string_to_index(prop, string, index, ZFS_TYPE_POOL));
174}
175
176int
177zpool_prop_index_to_string(zpool_prop_t prop, uint64_t index,
178 const char **string)
179{
180 return (zprop_index_to_string(prop, index, string, ZFS_TYPE_POOL));
181}
182
183uint64_t
184zpool_prop_random_value(zpool_prop_t prop, uint64_t seed)
185{
186 return (zprop_random_value(prop, seed, ZFS_TYPE_POOL));
187}
188
189#ifndef _KERNEL
190
191const char *
192zpool_prop_values(zpool_prop_t prop)
193{
194 return (zpool_prop_table[prop].pd_values);
195}
196
197const char *
198zpool_prop_column_name(zpool_prop_t prop)
199{
200 return (zpool_prop_table[prop].pd_colname);
201}
202
203boolean_t
204zpool_prop_align_right(zpool_prop_t prop)
205{
206 return (zpool_prop_table[prop].pd_rightalign);
207}
208#endif
191int
192zpool_prop_string_to_index(zpool_prop_t prop, const char *string,
193 uint64_t *index)
194{
195 return (zprop_string_to_index(prop, string, index, ZFS_TYPE_POOL));
196}
197
198int
199zpool_prop_index_to_string(zpool_prop_t prop, uint64_t index,
200 const char **string)
201{
202 return (zprop_index_to_string(prop, index, string, ZFS_TYPE_POOL));
203}
204
205uint64_t
206zpool_prop_random_value(zpool_prop_t prop, uint64_t seed)
207{
208 return (zprop_random_value(prop, seed, ZFS_TYPE_POOL));
209}
210
211#ifndef _KERNEL
212
213const char *
214zpool_prop_values(zpool_prop_t prop)
215{
216 return (zpool_prop_table[prop].pd_values);
217}
218
219const char *
220zpool_prop_column_name(zpool_prop_t prop)
221{
222 return (zpool_prop_table[prop].pd_colname);
223}
224
225boolean_t
226zpool_prop_align_right(zpool_prop_t prop)
227{
228 return (zpool_prop_table[prop].pd_rightalign);
229}
230#endif