xref: /titanic_50/usr/src/common/zfs/zpool_prop.c (revision 83d7f9fe6bbb3e281a1ca55fdc5d1ec82ecc3e70)
1990b4856Slling /*
2990b4856Slling  * CDDL HEADER START
3990b4856Slling  *
4990b4856Slling  * The contents of this file are subject to the terms of the
5990b4856Slling  * Common Development and Distribution License (the "License").
6990b4856Slling  * You may not use this file except in compliance with the License.
7990b4856Slling  *
8990b4856Slling  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9990b4856Slling  * or http://www.opensolaris.org/os/licensing.
10990b4856Slling  * See the License for the specific language governing permissions
11990b4856Slling  * and limitations under the License.
12990b4856Slling  *
13990b4856Slling  * When distributing Covered Code, include this CDDL HEADER in each
14990b4856Slling  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15990b4856Slling  * If applicable, add the following below this CDDL HEADER, with the
16990b4856Slling  * fields enclosed by brackets "[]" replaced with your own identifying
17990b4856Slling  * information: Portions Copyright [yyyy] [name of copyright owner]
18990b4856Slling  *
19990b4856Slling  * CDDL HEADER END
20990b4856Slling  */
21990b4856Slling /*
22*83d7f9feSTom Erickson  * Copyright 2010 Sun Microsystems, Inc.  All rights reserved.
23990b4856Slling  * Use is subject to license terms.
24990b4856Slling  */
25990b4856Slling 
26990b4856Slling #include <sys/zio.h>
27990b4856Slling #include <sys/spa.h>
28990b4856Slling #include <sys/zfs_acl.h>
29990b4856Slling #include <sys/zfs_ioctl.h>
30990b4856Slling #include <sys/fs/zfs.h>
31990b4856Slling 
32990b4856Slling #include "zfs_prop.h"
33990b4856Slling 
34990b4856Slling #if defined(_KERNEL)
35990b4856Slling #include <sys/systm.h>
36990b4856Slling #else
37990b4856Slling #include <stdlib.h>
38990b4856Slling #include <string.h>
39990b4856Slling #include <ctype.h>
40990b4856Slling #endif
41990b4856Slling 
42990b4856Slling static zprop_desc_t zpool_prop_table[ZPOOL_NUM_PROPS];
43990b4856Slling 
44990b4856Slling zprop_desc_t *
45990b4856Slling zpool_prop_get_table(void)
46990b4856Slling {
47990b4856Slling 	return (zpool_prop_table);
48990b4856Slling }
49990b4856Slling 
50990b4856Slling void
51990b4856Slling zpool_prop_init(void)
52990b4856Slling {
53990b4856Slling 	static zprop_index_t boolean_table[] = {
54990b4856Slling 		{ "off",	0},
55990b4856Slling 		{ "on",		1},
56990b4856Slling 		{ NULL }
57990b4856Slling 	};
58990b4856Slling 
590a4e9518Sgw25295 	static zprop_index_t failuremode_table[] = {
600a4e9518Sgw25295 		{ "wait",	ZIO_FAILURE_MODE_WAIT },
610a4e9518Sgw25295 		{ "continue",	ZIO_FAILURE_MODE_CONTINUE },
620a4e9518Sgw25295 		{ "panic",	ZIO_FAILURE_MODE_PANIC },
630a4e9518Sgw25295 		{ NULL }
640a4e9518Sgw25295 	};
650a4e9518Sgw25295 
66990b4856Slling 	/* string properties */
67*83d7f9feSTom Erickson 	zprop_register_string(ZPOOL_PROP_ALTROOT, "altroot", NULL, PROP_DEFAULT,
68990b4856Slling 	    ZFS_TYPE_POOL, "<path>", "ALTROOT");
69*83d7f9feSTom Erickson 	zprop_register_string(ZPOOL_PROP_BOOTFS, "bootfs", NULL, PROP_DEFAULT,
70990b4856Slling 	    ZFS_TYPE_POOL, "<filesystem>", "BOOTFS");
71*83d7f9feSTom Erickson 	zprop_register_string(ZPOOL_PROP_CACHEFILE, "cachefile", NULL,
72*83d7f9feSTom Erickson 	    PROP_DEFAULT, ZFS_TYPE_POOL, "<file> | none", "CACHEFILE");
73990b4856Slling 
74990b4856Slling 	/* readonly number properties */
75*83d7f9feSTom Erickson 	zprop_register_number(ZPOOL_PROP_SIZE, "size", 0, PROP_READONLY,
76990b4856Slling 	    ZFS_TYPE_POOL, "<size>", "SIZE");
77*83d7f9feSTom Erickson 	zprop_register_number(ZPOOL_PROP_FREE, "free", 0, PROP_READONLY,
78485bbbf5SGeorge Wilson 	    ZFS_TYPE_POOL, "<size>", "FREE");
79*83d7f9feSTom Erickson 	zprop_register_number(ZPOOL_PROP_ALLOCATED, "allocated", 0,
80*83d7f9feSTom Erickson 	    PROP_READONLY, ZFS_TYPE_POOL, "<size>", "ALLOC");
81*83d7f9feSTom Erickson 	zprop_register_number(ZPOOL_PROP_CAPACITY, "capacity", 0, PROP_READONLY,
82990b4856Slling 	    ZFS_TYPE_POOL, "<size>", "CAP");
83*83d7f9feSTom Erickson 	zprop_register_number(ZPOOL_PROP_GUID, "guid", 0, PROP_READONLY,
84990b4856Slling 	    ZFS_TYPE_POOL, "<guid>", "GUID");
85*83d7f9feSTom Erickson 	zprop_register_number(ZPOOL_PROP_HEALTH, "health", 0, PROP_READONLY,
86990b4856Slling 	    ZFS_TYPE_POOL, "<state>", "HEALTH");
87*83d7f9feSTom Erickson 	zprop_register_number(ZPOOL_PROP_DEDUPRATIO, "dedupratio", 0,
88*83d7f9feSTom Erickson 	    PROP_READONLY, ZFS_TYPE_POOL, "<1.00x or higher if deduped>",
89*83d7f9feSTom Erickson 	    "DEDUP");
90990b4856Slling 
91990b4856Slling 	/* default number properties */
92*83d7f9feSTom Erickson 	zprop_register_number(ZPOOL_PROP_VERSION, "version", SPA_VERSION,
93990b4856Slling 	    PROP_DEFAULT, ZFS_TYPE_POOL, "<version>", "VERSION");
94*83d7f9feSTom Erickson 	zprop_register_number(ZPOOL_PROP_DEDUPDITTO, "dedupditto", 0,
95bbfd46c4SJeff Bonwick 	    PROP_DEFAULT, ZFS_TYPE_POOL, "<threshold (min 100)>", "DEDUPDITTO");
96990b4856Slling 
97990b4856Slling 	/* default index (boolean) properties */
98*83d7f9feSTom Erickson 	zprop_register_index(ZPOOL_PROP_DELEGATION, "delegation", 1,
99*83d7f9feSTom Erickson 	    PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "DELEGATION",
100*83d7f9feSTom Erickson 	    boolean_table);
101*83d7f9feSTom Erickson 	zprop_register_index(ZPOOL_PROP_AUTOREPLACE, "autoreplace", 0,
102*83d7f9feSTom Erickson 	    PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "REPLACE", boolean_table);
103*83d7f9feSTom Erickson 	zprop_register_index(ZPOOL_PROP_LISTSNAPS, "listsnapshots", 0,
104*83d7f9feSTom Erickson 	    PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "LISTSNAPS",
105*83d7f9feSTom Erickson 	    boolean_table);
106*83d7f9feSTom Erickson 	zprop_register_index(ZPOOL_PROP_AUTOEXPAND, "autoexpand", 0,
107*83d7f9feSTom Erickson 	    PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "EXPAND", boolean_table);
108990b4856Slling 
1090a4e9518Sgw25295 	/* default index properties */
110*83d7f9feSTom Erickson 	zprop_register_index(ZPOOL_PROP_FAILUREMODE, "failmode",
1110a4e9518Sgw25295 	    ZIO_FAILURE_MODE_WAIT, PROP_DEFAULT, ZFS_TYPE_POOL,
1120a4e9518Sgw25295 	    "wait | continue | panic", "FAILMODE", failuremode_table);
1130a4e9518Sgw25295 
114990b4856Slling 	/* hidden properties */
115*83d7f9feSTom Erickson 	zprop_register_hidden(ZPOOL_PROP_NAME, "name", PROP_TYPE_STRING,
116990b4856Slling 	    PROP_READONLY, ZFS_TYPE_POOL, "NAME");
117990b4856Slling }
118990b4856Slling 
119990b4856Slling /*
120990b4856Slling  * Given a property name and its type, returns the corresponding property ID.
121990b4856Slling  */
122990b4856Slling zpool_prop_t
123990b4856Slling zpool_name_to_prop(const char *propname)
124990b4856Slling {
125990b4856Slling 	return (zprop_name_to_prop(propname, ZFS_TYPE_POOL));
126990b4856Slling }
127990b4856Slling 
128990b4856Slling /*
129990b4856Slling  * Given a pool property ID, returns the corresponding name.
130990b4856Slling  * Assuming the pool propety ID is valid.
131990b4856Slling  */
132990b4856Slling const char *
133990b4856Slling zpool_prop_to_name(zpool_prop_t prop)
134990b4856Slling {
135990b4856Slling 	return (zpool_prop_table[prop].pd_name);
136990b4856Slling }
137990b4856Slling 
138990b4856Slling zprop_type_t
139990b4856Slling zpool_prop_get_type(zpool_prop_t prop)
140990b4856Slling {
141990b4856Slling 	return (zpool_prop_table[prop].pd_proptype);
142990b4856Slling }
143990b4856Slling 
144990b4856Slling boolean_t
145990b4856Slling zpool_prop_readonly(zpool_prop_t prop)
146990b4856Slling {
147990b4856Slling 	return (zpool_prop_table[prop].pd_attr == PROP_READONLY);
148990b4856Slling }
149990b4856Slling 
150990b4856Slling const char *
151990b4856Slling zpool_prop_default_string(zpool_prop_t prop)
152990b4856Slling {
153990b4856Slling 	return (zpool_prop_table[prop].pd_strdefault);
154990b4856Slling }
155990b4856Slling 
156990b4856Slling uint64_t
157990b4856Slling zpool_prop_default_numeric(zpool_prop_t prop)
158990b4856Slling {
159990b4856Slling 	return (zpool_prop_table[prop].pd_numdefault);
160990b4856Slling }
161990b4856Slling 
162990b4856Slling int
163990b4856Slling zpool_prop_string_to_index(zpool_prop_t prop, const char *string,
164990b4856Slling     uint64_t *index)
165990b4856Slling {
166990b4856Slling 	return (zprop_string_to_index(prop, string, index, ZFS_TYPE_POOL));
167990b4856Slling }
168990b4856Slling 
169990b4856Slling int
170990b4856Slling zpool_prop_index_to_string(zpool_prop_t prop, uint64_t index,
171990b4856Slling     const char **string)
172990b4856Slling {
173990b4856Slling 	return (zprop_index_to_string(prop, index, string, ZFS_TYPE_POOL));
174990b4856Slling }
175990b4856Slling 
176b24ab676SJeff Bonwick uint64_t
177b24ab676SJeff Bonwick zpool_prop_random_value(zpool_prop_t prop, uint64_t seed)
178b24ab676SJeff Bonwick {
179b24ab676SJeff Bonwick 	return (zprop_random_value(prop, seed, ZFS_TYPE_POOL));
180b24ab676SJeff Bonwick }
181b24ab676SJeff Bonwick 
182990b4856Slling #ifndef _KERNEL
183990b4856Slling 
184990b4856Slling const char *
185990b4856Slling zpool_prop_values(zpool_prop_t prop)
186990b4856Slling {
187990b4856Slling 	return (zpool_prop_table[prop].pd_values);
188990b4856Slling }
189990b4856Slling 
190990b4856Slling const char *
191990b4856Slling zpool_prop_column_name(zpool_prop_t prop)
192990b4856Slling {
193990b4856Slling 	return (zpool_prop_table[prop].pd_colname);
194990b4856Slling }
195990b4856Slling 
196990b4856Slling boolean_t
197990b4856Slling zpool_prop_align_right(zpool_prop_t prop)
198990b4856Slling {
199990b4856Slling 	return (zpool_prop_table[prop].pd_rightalign);
200990b4856Slling }
201990b4856Slling #endif
202