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.
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.
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]
22 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
27 #include <sys/zfs_acl.h>
28 #include <sys/zfs_ioctl.h>
29 #include <sys/fs/zfs.h>
34 #include <sys/systm.h>
41 static zprop_desc_t zpool_prop_table[ZPOOL_NUM_PROPS];
44 zpool_prop_get_table(void)
46 return (zpool_prop_table);
52 static zprop_index_t boolean_table[] = {
58 static zprop_index_t failuremode_table[] = {
59 { "wait", ZIO_FAILURE_MODE_WAIT },
60 { "continue", ZIO_FAILURE_MODE_CONTINUE },
61 { "panic", ZIO_FAILURE_MODE_PANIC },
65 /* string properties */
66 zprop_register_string(ZPOOL_PROP_ALTROOT, "altroot", NULL, PROP_DEFAULT,
67 ZFS_TYPE_POOL, "<path>", "ALTROOT");
68 zprop_register_string(ZPOOL_PROP_BOOTFS, "bootfs", NULL, PROP_DEFAULT,
69 ZFS_TYPE_POOL, "<filesystem>", "BOOTFS");
70 zprop_register_string(ZPOOL_PROP_CACHEFILE, "cachefile", NULL,
71 PROP_DEFAULT, ZFS_TYPE_POOL, "<file> | none", "CACHEFILE");
73 /* readonly number properties */
74 zprop_register_number(ZPOOL_PROP_SIZE, "size", 0, PROP_READONLY,
75 ZFS_TYPE_POOL, "<size>", "SIZE");
76 zprop_register_number(ZPOOL_PROP_FREE, "free", 0, PROP_READONLY,
77 ZFS_TYPE_POOL, "<size>", "FREE");
78 zprop_register_number(ZPOOL_PROP_ALLOCATED, "allocated", 0,
79 PROP_READONLY, ZFS_TYPE_POOL, "<size>", "ALLOC");
80 zprop_register_number(ZPOOL_PROP_CAPACITY, "capacity", 0, PROP_READONLY,
81 ZFS_TYPE_POOL, "<size>", "CAP");
82 zprop_register_number(ZPOOL_PROP_GUID, "guid", 0, PROP_READONLY,
83 ZFS_TYPE_POOL, "<guid>", "GUID");
84 zprop_register_number(ZPOOL_PROP_HEALTH, "health", 0, PROP_READONLY,
85 ZFS_TYPE_POOL, "<state>", "HEALTH");
86 zprop_register_number(ZPOOL_PROP_DEDUPRATIO, "dedupratio", 0,
87 PROP_READONLY, ZFS_TYPE_POOL, "<1.00x or higher if deduped>",
90 /* readonly onetime number properties */
91 zprop_register_number(ZPOOL_PROP_ASHIFT, "ashift", 0, PROP_ONETIME,
92 ZFS_TYPE_POOL, "<ashift, 9-17, or 0=default>", "ASHIFT");
94 /* default number properties */
95 zprop_register_number(ZPOOL_PROP_VERSION, "version", SPA_VERSION,
96 PROP_DEFAULT, ZFS_TYPE_POOL, "<version>", "VERSION");
97 zprop_register_number(ZPOOL_PROP_DEDUPDITTO, "dedupditto", 0,
98 PROP_DEFAULT, ZFS_TYPE_POOL, "<threshold (min 100)>", "DEDUPDITTO");
100 /* default index (boolean) properties */
101 zprop_register_index(ZPOOL_PROP_DELEGATION, "delegation", 1,
102 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "DELEGATION",
104 zprop_register_index(ZPOOL_PROP_AUTOREPLACE, "autoreplace", 0,
105 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "REPLACE", boolean_table);
106 zprop_register_index(ZPOOL_PROP_LISTSNAPS, "listsnapshots", 0,
107 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "LISTSNAPS",
109 zprop_register_index(ZPOOL_PROP_AUTOEXPAND, "autoexpand", 0,
110 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "EXPAND", boolean_table);
111 zprop_register_index(ZPOOL_PROP_READONLY, "readonly", 0,
112 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "RDONLY", boolean_table);
114 /* default index properties */
115 zprop_register_index(ZPOOL_PROP_FAILUREMODE, "failmode",
116 ZIO_FAILURE_MODE_WAIT, PROP_DEFAULT, ZFS_TYPE_POOL,
117 "wait | continue | panic", "FAILMODE", failuremode_table);
119 /* hidden properties */
120 zprop_register_hidden(ZPOOL_PROP_NAME, "name", PROP_TYPE_STRING,
121 PROP_READONLY, ZFS_TYPE_POOL, "NAME");
125 * Given a property name and its type, returns the corresponding property ID.
128 zpool_name_to_prop(const char *propname)
130 return (zprop_name_to_prop(propname, ZFS_TYPE_POOL));
134 * Given a pool property ID, returns the corresponding name.
135 * Assuming the pool propety ID is valid.
138 zpool_prop_to_name(zpool_prop_t prop)
140 return (zpool_prop_table[prop].pd_name);
144 zpool_prop_get_type(zpool_prop_t prop)
146 return (zpool_prop_table[prop].pd_proptype);
150 zpool_prop_readonly(zpool_prop_t prop)
152 return (zpool_prop_table[prop].pd_attr == PROP_READONLY);
156 zpool_prop_default_string(zpool_prop_t prop)
158 return (zpool_prop_table[prop].pd_strdefault);
162 zpool_prop_default_numeric(zpool_prop_t prop)
164 return (zpool_prop_table[prop].pd_numdefault);
168 zpool_prop_string_to_index(zpool_prop_t prop, const char *string,
171 return (zprop_string_to_index(prop, string, index, ZFS_TYPE_POOL));
175 zpool_prop_index_to_string(zpool_prop_t prop, uint64_t index,
178 return (zprop_index_to_string(prop, index, string, ZFS_TYPE_POOL));
182 zpool_prop_random_value(zpool_prop_t prop, uint64_t seed)
184 return (zprop_random_value(prop, seed, ZFS_TYPE_POOL));
190 zpool_prop_values(zpool_prop_t prop)
192 return (zpool_prop_table[prop].pd_values);
196 zpool_prop_column_name(zpool_prop_t prop)
198 return (zpool_prop_table[prop].pd_colname);
202 zpool_prop_align_right(zpool_prop_t prop)
204 return (zpool_prop_table[prop].pd_rightalign);
208 #if defined(_KERNEL) && defined(HAVE_SPL)
209 /* zpool property functions */
210 EXPORT_SYMBOL(zpool_prop_init);
211 EXPORT_SYMBOL(zpool_prop_get_type);
212 EXPORT_SYMBOL(zpool_prop_get_table);
214 /* Pool property functions shared between libzfs and kernel. */
215 EXPORT_SYMBOL(zpool_name_to_prop);
216 EXPORT_SYMBOL(zpool_prop_to_name);
217 EXPORT_SYMBOL(zpool_prop_default_string);
218 EXPORT_SYMBOL(zpool_prop_default_numeric);
219 EXPORT_SYMBOL(zpool_prop_readonly);
220 EXPORT_SYMBOL(zpool_prop_index_to_string);
221 EXPORT_SYMBOL(zpool_prop_string_to_index);