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, 2014 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_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>",
102 /* readonly onetime number properties */
103 zprop_register_number(ZPOOL_PROP_ASHIFT
, "ashift", 0, PROP_ONETIME
,
104 ZFS_TYPE_POOL
, "<ashift, 9-13, or 0=default>", "ASHIFT");
106 /* default number properties */
107 zprop_register_number(ZPOOL_PROP_VERSION
, "version", SPA_VERSION
,
108 PROP_DEFAULT
, ZFS_TYPE_POOL
, "<version>", "VERSION");
109 zprop_register_number(ZPOOL_PROP_DEDUPDITTO
, "dedupditto", 0,
110 PROP_DEFAULT
, ZFS_TYPE_POOL
, "<threshold (min 100)>", "DEDUPDITTO");
112 /* default index (boolean) properties */
113 zprop_register_index(ZPOOL_PROP_DELEGATION
, "delegation", 1,
114 PROP_DEFAULT
, ZFS_TYPE_POOL
, "on | off", "DELEGATION",
116 zprop_register_index(ZPOOL_PROP_AUTOREPLACE
, "autoreplace", 0,
117 PROP_DEFAULT
, ZFS_TYPE_POOL
, "on | off", "REPLACE", boolean_table
);
118 zprop_register_index(ZPOOL_PROP_LISTSNAPS
, "listsnapshots", 0,
119 PROP_DEFAULT
, ZFS_TYPE_POOL
, "on | off", "LISTSNAPS",
121 zprop_register_index(ZPOOL_PROP_AUTOEXPAND
, "autoexpand", 0,
122 PROP_DEFAULT
, ZFS_TYPE_POOL
, "on | off", "EXPAND", boolean_table
);
123 zprop_register_index(ZPOOL_PROP_READONLY
, "readonly", 0,
124 PROP_DEFAULT
, ZFS_TYPE_POOL
, "on | off", "RDONLY", boolean_table
);
126 /* default index properties */
127 zprop_register_index(ZPOOL_PROP_FAILUREMODE
, "failmode",
128 ZIO_FAILURE_MODE_WAIT
, PROP_DEFAULT
, ZFS_TYPE_POOL
,
129 "wait | continue | panic", "FAILMODE", failuremode_table
);
131 /* hidden properties */
132 zprop_register_hidden(ZPOOL_PROP_NAME
, "name", PROP_TYPE_STRING
,
133 PROP_READONLY
, ZFS_TYPE_POOL
, "NAME");
134 zprop_register_hidden(ZPOOL_PROP_MAXBLOCKSIZE
, "maxblocksize",
135 PROP_TYPE_NUMBER
, PROP_READONLY
, ZFS_TYPE_POOL
, "MAXBLOCKSIZE");
136 zprop_register_hidden(ZPOOL_PROP_TNAME
, "tname", PROP_TYPE_STRING
,
137 PROP_ONETIME
, ZFS_TYPE_POOL
, "TNAME");
141 * Given a property name and its type, returns the corresponding property ID.
144 zpool_name_to_prop(const char *propname
)
146 return (zprop_name_to_prop(propname
, ZFS_TYPE_POOL
));
150 * Given a pool property ID, returns the corresponding name.
151 * Assuming the pool propety ID is valid.
154 zpool_prop_to_name(zpool_prop_t prop
)
156 return (zpool_prop_table
[prop
].pd_name
);
160 zpool_prop_get_type(zpool_prop_t prop
)
162 return (zpool_prop_table
[prop
].pd_proptype
);
166 zpool_prop_readonly(zpool_prop_t prop
)
168 return (zpool_prop_table
[prop
].pd_attr
== PROP_READONLY
);
172 zpool_prop_default_string(zpool_prop_t prop
)
174 return (zpool_prop_table
[prop
].pd_strdefault
);
178 zpool_prop_default_numeric(zpool_prop_t prop
)
180 return (zpool_prop_table
[prop
].pd_numdefault
);
184 * Returns true if this is a valid feature@ property.
187 zpool_prop_feature(const char *name
)
189 static const char *prefix
= "feature@";
190 return (strncmp(name
, prefix
, strlen(prefix
)) == 0);
194 * Returns true if this is a valid unsupported@ property.
197 zpool_prop_unsupported(const char *name
)
199 static const char *prefix
= "unsupported@";
200 return (strncmp(name
, prefix
, strlen(prefix
)) == 0);
204 zpool_prop_string_to_index(zpool_prop_t prop
, const char *string
,
207 return (zprop_string_to_index(prop
, string
, index
, ZFS_TYPE_POOL
));
211 zpool_prop_index_to_string(zpool_prop_t prop
, uint64_t index
,
214 return (zprop_index_to_string(prop
, index
, string
, ZFS_TYPE_POOL
));
218 zpool_prop_random_value(zpool_prop_t prop
, uint64_t seed
)
220 return (zprop_random_value(prop
, seed
, ZFS_TYPE_POOL
));
226 zpool_prop_values(zpool_prop_t prop
)
228 return (zpool_prop_table
[prop
].pd_values
);
232 zpool_prop_column_name(zpool_prop_t prop
)
234 return (zpool_prop_table
[prop
].pd_colname
);
238 zpool_prop_align_right(zpool_prop_t prop
)
240 return (zpool_prop_table
[prop
].pd_rightalign
);
244 #if defined(_KERNEL) && defined(HAVE_SPL)
245 /* zpool property functions */
246 EXPORT_SYMBOL(zpool_prop_init
);
247 EXPORT_SYMBOL(zpool_prop_get_type
);
248 EXPORT_SYMBOL(zpool_prop_get_table
);
250 /* Pool property functions shared between libzfs and kernel. */
251 EXPORT_SYMBOL(zpool_name_to_prop
);
252 EXPORT_SYMBOL(zpool_prop_to_name
);
253 EXPORT_SYMBOL(zpool_prop_default_string
);
254 EXPORT_SYMBOL(zpool_prop_default_numeric
);
255 EXPORT_SYMBOL(zpool_prop_readonly
);
256 EXPORT_SYMBOL(zpool_prop_feature
);
257 EXPORT_SYMBOL(zpool_prop_unsupported
);
258 EXPORT_SYMBOL(zpool_prop_index_to_string
);
259 EXPORT_SYMBOL(zpool_prop_string_to_index
);