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 2009 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
28 #include <sys/zfs_acl.h>
29 #include <sys/zfs_ioctl.h>
30 #include <sys/fs/zfs.h>
35 #include <sys/systm.h>
42 static zprop_desc_t zpool_prop_table[ZPOOL_NUM_PROPS];
45 zpool_prop_get_table(void)
47 return (zpool_prop_table);
53 static zprop_index_t boolean_table[] = {
59 static zprop_index_t failuremode_table[] = {
60 { "wait", ZIO_FAILURE_MODE_WAIT },
61 { "continue", ZIO_FAILURE_MODE_CONTINUE },
62 { "panic", ZIO_FAILURE_MODE_PANIC },
66 /* string properties */
67 register_string(ZPOOL_PROP_ALTROOT, "altroot", NULL, PROP_DEFAULT,
68 ZFS_TYPE_POOL, "<path>", "ALTROOT");
69 register_string(ZPOOL_PROP_BOOTFS, "bootfs", NULL, PROP_DEFAULT,
70 ZFS_TYPE_POOL, "<filesystem>", "BOOTFS");
71 register_string(ZPOOL_PROP_CACHEFILE, "cachefile", NULL, PROP_DEFAULT,
72 ZFS_TYPE_POOL, "<file> | none", "CACHEFILE");
74 /* readonly number properties */
75 register_number(ZPOOL_PROP_SIZE, "size", 0, PROP_READONLY,
76 ZFS_TYPE_POOL, "<size>", "SIZE");
77 register_number(ZPOOL_PROP_USED, "used", 0, PROP_READONLY,
78 ZFS_TYPE_POOL, "<size>", "USED");
79 register_number(ZPOOL_PROP_AVAILABLE, "available", 0, PROP_READONLY,
80 ZFS_TYPE_POOL, "<size>", "AVAIL");
81 register_number(ZPOOL_PROP_CAPACITY, "capacity", 0, PROP_READONLY,
82 ZFS_TYPE_POOL, "<size>", "CAP");
83 register_number(ZPOOL_PROP_GUID, "guid", 0, PROP_READONLY,
84 ZFS_TYPE_POOL, "<guid>", "GUID");
85 register_number(ZPOOL_PROP_HEALTH, "health", 0, PROP_READONLY,
86 ZFS_TYPE_POOL, "<state>", "HEALTH");
88 /* default number properties */
89 register_number(ZPOOL_PROP_VERSION, "version", SPA_VERSION,
90 PROP_DEFAULT, ZFS_TYPE_POOL, "<version>", "VERSION");
92 /* default index (boolean) properties */
93 register_index(ZPOOL_PROP_DELEGATION, "delegation", 1, PROP_DEFAULT,
94 ZFS_TYPE_POOL, "on | off", "DELEGATION", boolean_table);
95 register_index(ZPOOL_PROP_AUTOREPLACE, "autoreplace", 0, PROP_DEFAULT,
96 ZFS_TYPE_POOL, "on | off", "REPLACE", boolean_table);
97 register_index(ZPOOL_PROP_LISTSNAPS, "listsnapshots", 0, PROP_DEFAULT,
98 ZFS_TYPE_POOL, "on | off", "LISTSNAPS", boolean_table);
99 register_index(ZPOOL_PROP_AUTOEXPAND, "autoexpand", 0, PROP_DEFAULT,
100 ZFS_TYPE_POOL, "on | off", "EXPAND", boolean_table);
102 /* default index properties */
103 register_index(ZPOOL_PROP_FAILUREMODE, "failmode",
104 ZIO_FAILURE_MODE_WAIT, PROP_DEFAULT, ZFS_TYPE_POOL,
105 "wait | continue | panic", "FAILMODE", failuremode_table);
107 /* hidden properties */
108 register_hidden(ZPOOL_PROP_NAME, "name", PROP_TYPE_STRING,
109 PROP_READONLY, ZFS_TYPE_POOL, "NAME");
113 * Given a property name and its type, returns the corresponding property ID.
116 zpool_name_to_prop(const char *propname)
118 return (zprop_name_to_prop(propname, ZFS_TYPE_POOL));
122 * Given a pool property ID, returns the corresponding name.
123 * Assuming the pool propety ID is valid.
126 zpool_prop_to_name(zpool_prop_t prop)
128 return (zpool_prop_table[prop].pd_name);
132 zpool_prop_get_type(zpool_prop_t prop)
134 return (zpool_prop_table[prop].pd_proptype);
138 zpool_prop_readonly(zpool_prop_t prop)
140 return (zpool_prop_table[prop].pd_attr == PROP_READONLY);
144 zpool_prop_default_string(zpool_prop_t prop)
146 return (zpool_prop_table[prop].pd_strdefault);
150 zpool_prop_default_numeric(zpool_prop_t prop)
152 return (zpool_prop_table[prop].pd_numdefault);
156 zpool_prop_string_to_index(zpool_prop_t prop, const char *string,
159 return (zprop_string_to_index(prop, string, index, ZFS_TYPE_POOL));
163 zpool_prop_index_to_string(zpool_prop_t prop, uint64_t index,
166 return (zprop_index_to_string(prop, index, string, ZFS_TYPE_POOL));
172 zpool_prop_values(zpool_prop_t prop)
174 return (zpool_prop_table[prop].pd_values);
178 zpool_prop_column_name(zpool_prop_t prop)
180 return (zpool_prop_table[prop].pd_colname);
184 zpool_prop_align_right(zpool_prop_t prop)
186 return (zpool_prop_table[prop].pd_rightalign);