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_ALLOCATED
, "allocated", 0,
83 PROP_READONLY
, ZFS_TYPE_POOL
, "<size>", "ALLOC");
84 zprop_register_number(ZPOOL_PROP_EXPANDSZ
, "expandsize", 0,
85 PROP_READONLY
, ZFS_TYPE_POOL
, "<size>", "EXPANDSZ");
86 zprop_register_number(ZPOOL_PROP_CAPACITY
, "capacity", 0, PROP_READONLY
,
87 ZFS_TYPE_POOL
, "<size>", "CAP");
88 zprop_register_number(ZPOOL_PROP_GUID
, "guid", 0, PROP_READONLY
,
89 ZFS_TYPE_POOL
, "<guid>", "GUID");
90 zprop_register_number(ZPOOL_PROP_HEALTH
, "health", 0, PROP_READONLY
,
91 ZFS_TYPE_POOL
, "<state>", "HEALTH");
92 zprop_register_number(ZPOOL_PROP_DEDUPRATIO
, "dedupratio", 0,
93 PROP_READONLY
, ZFS_TYPE_POOL
, "<1.00x or higher if deduped>",
96 /* readonly onetime number properties */
97 zprop_register_number(ZPOOL_PROP_ASHIFT
, "ashift", 0, PROP_ONETIME
,
98 ZFS_TYPE_POOL
, "<ashift, 9-13, or 0=default>", "ASHIFT");
100 /* default number properties */
101 zprop_register_number(ZPOOL_PROP_VERSION
, "version", SPA_VERSION
,
102 PROP_DEFAULT
, ZFS_TYPE_POOL
, "<version>", "VERSION");
103 zprop_register_number(ZPOOL_PROP_DEDUPDITTO
, "dedupditto", 0,
104 PROP_DEFAULT
, ZFS_TYPE_POOL
, "<threshold (min 100)>", "DEDUPDITTO");
106 /* default index (boolean) properties */
107 zprop_register_index(ZPOOL_PROP_DELEGATION
, "delegation", 1,
108 PROP_DEFAULT
, ZFS_TYPE_POOL
, "on | off", "DELEGATION",
110 zprop_register_index(ZPOOL_PROP_AUTOREPLACE
, "autoreplace", 0,
111 PROP_DEFAULT
, ZFS_TYPE_POOL
, "on | off", "REPLACE", boolean_table
);
112 zprop_register_index(ZPOOL_PROP_LISTSNAPS
, "listsnapshots", 0,
113 PROP_DEFAULT
, ZFS_TYPE_POOL
, "on | off", "LISTSNAPS",
115 zprop_register_index(ZPOOL_PROP_AUTOEXPAND
, "autoexpand", 0,
116 PROP_DEFAULT
, ZFS_TYPE_POOL
, "on | off", "EXPAND", boolean_table
);
117 zprop_register_index(ZPOOL_PROP_READONLY
, "readonly", 0,
118 PROP_DEFAULT
, ZFS_TYPE_POOL
, "on | off", "RDONLY", boolean_table
);
120 /* default index properties */
121 zprop_register_index(ZPOOL_PROP_FAILUREMODE
, "failmode",
122 ZIO_FAILURE_MODE_WAIT
, PROP_DEFAULT
, ZFS_TYPE_POOL
,
123 "wait | continue | panic", "FAILMODE", failuremode_table
);
125 /* hidden properties */
126 zprop_register_hidden(ZPOOL_PROP_NAME
, "name", PROP_TYPE_STRING
,
127 PROP_READONLY
, ZFS_TYPE_POOL
, "NAME");
131 * Given a property name and its type, returns the corresponding property ID.
134 zpool_name_to_prop(const char *propname
)
136 return (zprop_name_to_prop(propname
, ZFS_TYPE_POOL
));
140 * Given a pool property ID, returns the corresponding name.
141 * Assuming the pool propety ID is valid.
144 zpool_prop_to_name(zpool_prop_t prop
)
146 return (zpool_prop_table
[prop
].pd_name
);
150 zpool_prop_get_type(zpool_prop_t prop
)
152 return (zpool_prop_table
[prop
].pd_proptype
);
156 zpool_prop_readonly(zpool_prop_t prop
)
158 return (zpool_prop_table
[prop
].pd_attr
== PROP_READONLY
);
162 zpool_prop_default_string(zpool_prop_t prop
)
164 return (zpool_prop_table
[prop
].pd_strdefault
);
168 zpool_prop_default_numeric(zpool_prop_t prop
)
170 return (zpool_prop_table
[prop
].pd_numdefault
);
174 zpool_prop_string_to_index(zpool_prop_t prop
, const char *string
,
177 return (zprop_string_to_index(prop
, string
, index
, ZFS_TYPE_POOL
));
181 zpool_prop_index_to_string(zpool_prop_t prop
, uint64_t index
,
184 return (zprop_index_to_string(prop
, index
, string
, ZFS_TYPE_POOL
));
188 zpool_prop_random_value(zpool_prop_t prop
, uint64_t seed
)
190 return (zprop_random_value(prop
, seed
, ZFS_TYPE_POOL
));
196 zpool_prop_values(zpool_prop_t prop
)
198 return (zpool_prop_table
[prop
].pd_values
);
202 zpool_prop_column_name(zpool_prop_t prop
)
204 return (zpool_prop_table
[prop
].pd_colname
);
208 zpool_prop_align_right(zpool_prop_t prop
)
210 return (zpool_prop_table
[prop
].pd_rightalign
);
214 #if defined(_KERNEL) && defined(HAVE_SPL)
215 /* zpool property functions */
216 EXPORT_SYMBOL(zpool_prop_init
);
217 EXPORT_SYMBOL(zpool_prop_get_type
);
218 EXPORT_SYMBOL(zpool_prop_get_table
);
220 /* Pool property functions shared between libzfs and kernel. */
221 EXPORT_SYMBOL(zpool_name_to_prop
);
222 EXPORT_SYMBOL(zpool_prop_to_name
);
223 EXPORT_SYMBOL(zpool_prop_default_string
);
224 EXPORT_SYMBOL(zpool_prop_default_numeric
);
225 EXPORT_SYMBOL(zpool_prop_readonly
);
226 EXPORT_SYMBOL(zpool_prop_index_to_string
);
227 EXPORT_SYMBOL(zpool_prop_string_to_index
);