xref: /titanic_52/usr/src/common/zfs/zpool_prop.c (revision b9bd317cda1afb3a01f4812de73e8cec888cbbd7)
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 2007 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #pragma ident	"%Z%%M%	%I%	%E% SMI"
27 
28 #include <sys/zio.h>
29 #include <sys/spa.h>
30 #include <sys/zfs_acl.h>
31 #include <sys/zfs_ioctl.h>
32 #include <sys/fs/zfs.h>
33 
34 #include "zfs_prop.h"
35 
36 #if defined(_KERNEL)
37 #include <sys/systm.h>
38 #else
39 #include <stdlib.h>
40 #include <string.h>
41 #include <ctype.h>
42 #endif
43 
44 static zprop_desc_t zpool_prop_table[ZPOOL_NUM_PROPS];
45 
46 zprop_desc_t *
47 zpool_prop_get_table(void)
48 {
49 	return (zpool_prop_table);
50 }
51 
52 void
53 zpool_prop_init(void)
54 {
55 	static zprop_index_t boolean_table[] = {
56 		{ "off",	0},
57 		{ "on",		1},
58 		{ NULL }
59 	};
60 
61 	static zprop_index_t failuremode_table[] = {
62 		{ "wait",	ZIO_FAILURE_MODE_WAIT },
63 		{ "continue",	ZIO_FAILURE_MODE_CONTINUE },
64 		{ "panic",	ZIO_FAILURE_MODE_PANIC },
65 		{ NULL }
66 	};
67 
68 	/* string properties */
69 	register_string(ZPOOL_PROP_ALTROOT, "altroot", NULL, PROP_DEFAULT,
70 	    ZFS_TYPE_POOL, "<path>", "ALTROOT");
71 	register_string(ZPOOL_PROP_BOOTFS, "bootfs", NULL, PROP_DEFAULT,
72 	    ZFS_TYPE_POOL, "<filesystem>", "BOOTFS");
73 	register_string(ZPOOL_PROP_CACHEFILE, "cachefile", NULL, PROP_DEFAULT,
74 	    ZFS_TYPE_POOL, "<file> | none", "CACHEFILE");
75 
76 	/* readonly number properties */
77 	register_number(ZPOOL_PROP_SIZE, "size", 0, PROP_READONLY,
78 	    ZFS_TYPE_POOL, "<size>", "SIZE");
79 	register_number(ZPOOL_PROP_USED, "used", 0, PROP_READONLY,
80 	    ZFS_TYPE_POOL, "<size>", "USED");
81 	register_number(ZPOOL_PROP_AVAILABLE, "available", 0, PROP_READONLY,
82 	    ZFS_TYPE_POOL, "<size>", "AVAIL");
83 	register_number(ZPOOL_PROP_CAPACITY, "capacity", 0, PROP_READONLY,
84 	    ZFS_TYPE_POOL, "<size>", "CAP");
85 	register_number(ZPOOL_PROP_GUID, "guid", 0, PROP_READONLY,
86 	    ZFS_TYPE_POOL, "<guid>", "GUID");
87 	register_number(ZPOOL_PROP_HEALTH, "health", 0, PROP_READONLY,
88 	    ZFS_TYPE_POOL, "<state>", "HEALTH");
89 
90 	/* default number properties */
91 	register_number(ZPOOL_PROP_VERSION, "version", SPA_VERSION,
92 	    PROP_DEFAULT, ZFS_TYPE_POOL, "<version>", "VERSION");
93 
94 	/* default index (boolean) properties */
95 	register_index(ZPOOL_PROP_DELEGATION, "delegation", 1, PROP_DEFAULT,
96 	    ZFS_TYPE_POOL, "on | off", "DELEGATION", boolean_table);
97 	register_index(ZPOOL_PROP_AUTOREPLACE, "autoreplace", 0, PROP_DEFAULT,
98 	    ZFS_TYPE_POOL, "on | off", "REPLACE", boolean_table);
99 
100 	/* default index properties */
101 	register_index(ZPOOL_PROP_FAILUREMODE, "failmode",
102 	    ZIO_FAILURE_MODE_WAIT, PROP_DEFAULT, ZFS_TYPE_POOL,
103 	    "wait | continue | panic", "FAILMODE", failuremode_table);
104 
105 	/* hidden properties */
106 	register_hidden(ZPOOL_PROP_NAME, "name", PROP_TYPE_STRING,
107 	    PROP_READONLY, ZFS_TYPE_POOL, "NAME");
108 }
109 
110 /*
111  * Given a property name and its type, returns the corresponding property ID.
112  */
113 zpool_prop_t
114 zpool_name_to_prop(const char *propname)
115 {
116 	return (zprop_name_to_prop(propname, ZFS_TYPE_POOL));
117 }
118 
119 /*
120  * Given a pool property ID, returns the corresponding name.
121  * Assuming the pool propety ID is valid.
122  */
123 const char *
124 zpool_prop_to_name(zpool_prop_t prop)
125 {
126 	return (zpool_prop_table[prop].pd_name);
127 }
128 
129 zprop_type_t
130 zpool_prop_get_type(zpool_prop_t prop)
131 {
132 	return (zpool_prop_table[prop].pd_proptype);
133 }
134 
135 boolean_t
136 zpool_prop_readonly(zpool_prop_t prop)
137 {
138 	return (zpool_prop_table[prop].pd_attr == PROP_READONLY);
139 }
140 
141 const char *
142 zpool_prop_default_string(zpool_prop_t prop)
143 {
144 	return (zpool_prop_table[prop].pd_strdefault);
145 }
146 
147 uint64_t
148 zpool_prop_default_numeric(zpool_prop_t prop)
149 {
150 	return (zpool_prop_table[prop].pd_numdefault);
151 }
152 
153 int
154 zpool_prop_string_to_index(zpool_prop_t prop, const char *string,
155     uint64_t *index)
156 {
157 	return (zprop_string_to_index(prop, string, index, ZFS_TYPE_POOL));
158 }
159 
160 int
161 zpool_prop_index_to_string(zpool_prop_t prop, uint64_t index,
162     const char **string)
163 {
164 	return (zprop_index_to_string(prop, index, string, ZFS_TYPE_POOL));
165 }
166 
167 #ifndef _KERNEL
168 
169 const char *
170 zpool_prop_values(zpool_prop_t prop)
171 {
172 	return (zpool_prop_table[prop].pd_values);
173 }
174 
175 const char *
176 zpool_prop_column_name(zpool_prop_t prop)
177 {
178 	return (zpool_prop_table[prop].pd_colname);
179 }
180 
181 boolean_t
182 zpool_prop_align_right(zpool_prop_t prop)
183 {
184 	return (zpool_prop_table[prop].pd_rightalign);
185 }
186 #endif
187