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.
23 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
24 * Copyright (c) 2012 by Delphix. All rights reserved.
29 #include <sys/zfs_acl.h>
30 #include <sys/zfs_ioctl.h>
31 #include <sys/fs/zfs.h>
36 #include <sys/systm.h>
43 static zprop_desc_t zpool_prop_table
[ZPOOL_NUM_PROPS
];
46 zpool_prop_get_table(void)
48 return (zpool_prop_table
);
54 static zprop_index_t boolean_table
[] = {
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
},
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");
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_ALLOCATED
, "allocated", 0,
85 PROP_READONLY
, ZFS_TYPE_POOL
, "<size>", "ALLOC");
86 zprop_register_number(ZPOOL_PROP_EXPANDSZ
, "expandsize", 0,
87 PROP_READONLY
, ZFS_TYPE_POOL
, "<size>", "EXPANDSZ");
88 zprop_register_number(ZPOOL_PROP_CAPACITY
, "capacity", 0, PROP_READONLY
,
89 ZFS_TYPE_POOL
, "<size>", "CAP");
90 zprop_register_number(ZPOOL_PROP_GUID
, "guid", 0, PROP_READONLY
,
91 ZFS_TYPE_POOL
, "<guid>", "GUID");
92 zprop_register_number(ZPOOL_PROP_HEALTH
, "health", 0, PROP_READONLY
,
93 ZFS_TYPE_POOL
, "<state>", "HEALTH");
94 zprop_register_number(ZPOOL_PROP_DEDUPRATIO
, "dedupratio", 0,
95 PROP_READONLY
, ZFS_TYPE_POOL
, "<1.00x or higher if deduped>",
98 /* readonly onetime number properties */
99 zprop_register_number(ZPOOL_PROP_ASHIFT
, "ashift", 0, PROP_ONETIME
,
100 ZFS_TYPE_POOL
, "<ashift, 9-13, or 0=default>", "ASHIFT");
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");
108 /* default index (boolean) properties */
109 zprop_register_index(ZPOOL_PROP_DELEGATION
, "delegation", 1,
110 PROP_DEFAULT
, ZFS_TYPE_POOL
, "on | off", "DELEGATION",
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",
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
);
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
);
127 /* hidden properties */
128 zprop_register_hidden(ZPOOL_PROP_NAME
, "name", PROP_TYPE_STRING
,
129 PROP_READONLY
, ZFS_TYPE_POOL
, "NAME");
133 * Given a property name and its type, returns the corresponding property ID.
136 zpool_name_to_prop(const char *propname
)
138 return (zprop_name_to_prop(propname
, ZFS_TYPE_POOL
));
142 * Given a pool property ID, returns the corresponding name.
143 * Assuming the pool propety ID is valid.
146 zpool_prop_to_name(zpool_prop_t prop
)
148 return (zpool_prop_table
[prop
].pd_name
);
152 zpool_prop_get_type(zpool_prop_t prop
)
154 return (zpool_prop_table
[prop
].pd_proptype
);
158 zpool_prop_readonly(zpool_prop_t prop
)
160 return (zpool_prop_table
[prop
].pd_attr
== PROP_READONLY
);
164 zpool_prop_default_string(zpool_prop_t prop
)
166 return (zpool_prop_table
[prop
].pd_strdefault
);
170 zpool_prop_default_numeric(zpool_prop_t prop
)
172 return (zpool_prop_table
[prop
].pd_numdefault
);
176 * Returns true if this is a valid feature@ property.
179 zpool_prop_feature(const char *name
)
181 static const char *prefix
= "feature@";
182 return (strncmp(name
, prefix
, strlen(prefix
)) == 0);
186 * Returns true if this is a valid unsupported@ property.
189 zpool_prop_unsupported(const char *name
)
191 static const char *prefix
= "unsupported@";
192 return (strncmp(name
, prefix
, strlen(prefix
)) == 0);
196 zpool_prop_string_to_index(zpool_prop_t prop
, const char *string
,
199 return (zprop_string_to_index(prop
, string
, index
, ZFS_TYPE_POOL
));
203 zpool_prop_index_to_string(zpool_prop_t prop
, uint64_t index
,
206 return (zprop_index_to_string(prop
, index
, string
, ZFS_TYPE_POOL
));
210 zpool_prop_random_value(zpool_prop_t prop
, uint64_t seed
)
212 return (zprop_random_value(prop
, seed
, ZFS_TYPE_POOL
));
218 zpool_prop_values(zpool_prop_t prop
)
220 return (zpool_prop_table
[prop
].pd_values
);
224 zpool_prop_column_name(zpool_prop_t prop
)
226 return (zpool_prop_table
[prop
].pd_colname
);
230 zpool_prop_align_right(zpool_prop_t prop
)
232 return (zpool_prop_table
[prop
].pd_rightalign
);
236 #if defined(_KERNEL) && defined(HAVE_SPL)
237 /* zpool property functions */
238 EXPORT_SYMBOL(zpool_prop_init
);
239 EXPORT_SYMBOL(zpool_prop_get_type
);
240 EXPORT_SYMBOL(zpool_prop_get_table
);
242 /* Pool property functions shared between libzfs and kernel. */
243 EXPORT_SYMBOL(zpool_name_to_prop
);
244 EXPORT_SYMBOL(zpool_prop_to_name
);
245 EXPORT_SYMBOL(zpool_prop_default_string
);
246 EXPORT_SYMBOL(zpool_prop_default_numeric
);
247 EXPORT_SYMBOL(zpool_prop_readonly
);
248 EXPORT_SYMBOL(zpool_prop_feature
);
249 EXPORT_SYMBOL(zpool_prop_unsupported
);
250 EXPORT_SYMBOL(zpool_prop_index_to_string
);
251 EXPORT_SYMBOL(zpool_prop_string_to_index
);