zpool_prop.c revision 269773 
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, 2014 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");
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_HEALTH, "health", 0, PROP_READONLY,
97	    ZFS_TYPE_POOL, "<state>", "HEALTH");
98	zprop_register_number(ZPOOL_PROP_DEDUPRATIO, "dedupratio", 0,
99	    PROP_READONLY, ZFS_TYPE_POOL, "<1.00x or higher if deduped>",
100	    "DEDUP");
101
102	/* default number properties */
103	zprop_register_number(ZPOOL_PROP_VERSION, "version", SPA_VERSION,
104	    PROP_DEFAULT, ZFS_TYPE_POOL, "<version>", "VERSION");
105	zprop_register_number(ZPOOL_PROP_DEDUPDITTO, "dedupditto", 0,
106	    PROP_DEFAULT, ZFS_TYPE_POOL, "<threshold (min 100)>", "DEDUPDITTO");
107
108	/* default index (boolean) properties */
109	zprop_register_index(ZPOOL_PROP_DELEGATION, "delegation", 1,
110	    PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "DELEGATION",
111	    boolean_table);
112	zprop_register_index(ZPOOL_PROP_AUTOREPLACE, "autoreplace", 0,
113	    PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "REPLACE", boolean_table);
114	zprop_register_index(ZPOOL_PROP_LISTSNAPS, "listsnapshots", 0,
115	    PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "LISTSNAPS",
116	    boolean_table);
117	zprop_register_index(ZPOOL_PROP_AUTOEXPAND, "autoexpand", 0,
118	    PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "EXPAND", boolean_table);
119	zprop_register_index(ZPOOL_PROP_READONLY, "readonly", 0,
120	    PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "RDONLY", boolean_table);
121
122	/* default index properties */
123	zprop_register_index(ZPOOL_PROP_FAILUREMODE, "failmode",
124	    ZIO_FAILURE_MODE_WAIT, PROP_DEFAULT, ZFS_TYPE_POOL,
125	    "wait | continue | panic", "FAILMODE", failuremode_table);
126
127	/* hidden properties */
128	zprop_register_hidden(ZPOOL_PROP_NAME, "name", PROP_TYPE_STRING,
129	    PROP_READONLY, ZFS_TYPE_POOL, "NAME");
130}
131
132/*
133 * Given a property name and its type, returns the corresponding property ID.
134 */
135zpool_prop_t
136zpool_name_to_prop(const char *propname)
137{
138	return (zprop_name_to_prop(propname, ZFS_TYPE_POOL));
139}
140
141/*
142 * Given a pool property ID, returns the corresponding name.
143 * Assuming the pool propety ID is valid.
144 */
145const char *
146zpool_prop_to_name(zpool_prop_t prop)
147{
148	return (zpool_prop_table[prop].pd_name);
149}
150
151zprop_type_t
152zpool_prop_get_type(zpool_prop_t prop)
153{
154	return (zpool_prop_table[prop].pd_proptype);
155}
156
157boolean_t
158zpool_prop_readonly(zpool_prop_t prop)
159{
160	return (zpool_prop_table[prop].pd_attr == PROP_READONLY);
161}
162
163const char *
164zpool_prop_default_string(zpool_prop_t prop)
165{
166	return (zpool_prop_table[prop].pd_strdefault);
167}
168
169uint64_t
170zpool_prop_default_numeric(zpool_prop_t prop)
171{
172	return (zpool_prop_table[prop].pd_numdefault);
173}
174
175/*
176 * Returns true if this is a valid feature@ property.
177 */
178boolean_t
179zpool_prop_feature(const char *name)
180{
181	static const char *prefix = "feature@";
182	return (strncmp(name, prefix, strlen(prefix)) == 0);
183}
184
185/*
186 * Returns true if this is a valid unsupported@ property.
187 */
188boolean_t
189zpool_prop_unsupported(const char *name)
190{
191	static const char *prefix = "unsupported@";
192	return (strncmp(name, prefix, strlen(prefix)) == 0);
193}
194
195int
196zpool_prop_string_to_index(zpool_prop_t prop, const char *string,
197    uint64_t *index)
198{
199	return (zprop_string_to_index(prop, string, index, ZFS_TYPE_POOL));
200}
201
202int
203zpool_prop_index_to_string(zpool_prop_t prop, uint64_t index,
204    const char **string)
205{
206	return (zprop_index_to_string(prop, index, string, ZFS_TYPE_POOL));
207}
208
209uint64_t
210zpool_prop_random_value(zpool_prop_t prop, uint64_t seed)
211{
212	return (zprop_random_value(prop, seed, ZFS_TYPE_POOL));
213}
214
215#ifndef _KERNEL
216
217const char *
218zpool_prop_values(zpool_prop_t prop)
219{
220	return (zpool_prop_table[prop].pd_values);
221}
222
223const char *
224zpool_prop_column_name(zpool_prop_t prop)
225{
226	return (zpool_prop_table[prop].pd_colname);
227}
228
229boolean_t
230zpool_prop_align_right(zpool_prop_t prop)
231{
232	return (zpool_prop_table[prop].pd_rightalign);
233}
234#endif
235