]> git.proxmox.com Git - mirror_zfs.git/blame - module/zcommon/zpool_prop.c
Implement large_dnode pool feature
[mirror_zfs.git] / module / zcommon / zpool_prop.c
CommitLineData
34dc7c2f
BB
1/*
2 * CDDL HEADER START
3 *
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.
7 *
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.
12 *
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]
18 *
19 * CDDL HEADER END
20 */
21/*
572e2857 22 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
d96eb2b1 23 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
f3a7f661 24 * Copyright (c) 2012, 2014 by Delphix. All rights reserved.
34dc7c2f
BB
25 */
26
34dc7c2f
BB
27#include <sys/zio.h>
28#include <sys/spa.h>
29#include <sys/zfs_acl.h>
30#include <sys/zfs_ioctl.h>
31#include <sys/fs/zfs.h>
32
33#include "zfs_prop.h"
34
35#if defined(_KERNEL)
36#include <sys/systm.h>
37#else
38#include <stdlib.h>
39#include <string.h>
40#include <ctype.h>
41#endif
42
43static zprop_desc_t zpool_prop_table[ZPOOL_NUM_PROPS];
44
45zprop_desc_t *
46zpool_prop_get_table(void)
47{
48 return (zpool_prop_table);
49}
50
51void
52zpool_prop_init(void)
53{
54 static zprop_index_t boolean_table[] = {
55 { "off", 0},
56 { "on", 1},
57 { NULL }
58 };
59
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 },
64 { NULL }
65 };
66
67 /* string properties */
428870ff 68 zprop_register_string(ZPOOL_PROP_ALTROOT, "altroot", NULL, PROP_DEFAULT,
34dc7c2f 69 ZFS_TYPE_POOL, "<path>", "ALTROOT");
428870ff 70 zprop_register_string(ZPOOL_PROP_BOOTFS, "bootfs", NULL, PROP_DEFAULT,
34dc7c2f 71 ZFS_TYPE_POOL, "<filesystem>", "BOOTFS");
428870ff
BB
72 zprop_register_string(ZPOOL_PROP_CACHEFILE, "cachefile", NULL,
73 PROP_DEFAULT, ZFS_TYPE_POOL, "<file> | none", "CACHEFILE");
d96eb2b1
DM
74 zprop_register_string(ZPOOL_PROP_COMMENT, "comment", NULL,
75 PROP_DEFAULT, ZFS_TYPE_POOL, "<comment-string>", "COMMENT");
34dc7c2f
BB
76
77 /* readonly number properties */
428870ff 78 zprop_register_number(ZPOOL_PROP_SIZE, "size", 0, PROP_READONLY,
34dc7c2f 79 ZFS_TYPE_POOL, "<size>", "SIZE");
428870ff
BB
80 zprop_register_number(ZPOOL_PROP_FREE, "free", 0, PROP_READONLY,
81 ZFS_TYPE_POOL, "<size>", "FREE");
9ae529ec
CS
82 zprop_register_number(ZPOOL_PROP_FREEING, "freeing", 0, PROP_READONLY,
83 ZFS_TYPE_POOL, "<size>", "FREEING");
fbeddd60
MA
84 zprop_register_number(ZPOOL_PROP_LEAKED, "leaked", 0, PROP_READONLY,
85 ZFS_TYPE_POOL, "<size>", "LEAKED");
428870ff
BB
86 zprop_register_number(ZPOOL_PROP_ALLOCATED, "allocated", 0,
87 PROP_READONLY, ZFS_TYPE_POOL, "<size>", "ALLOC");
1bd201e7
CS
88 zprop_register_number(ZPOOL_PROP_EXPANDSZ, "expandsize", 0,
89 PROP_READONLY, ZFS_TYPE_POOL, "<size>", "EXPANDSZ");
f3a7f661
GW
90 zprop_register_number(ZPOOL_PROP_FRAGMENTATION, "fragmentation", 0,
91 PROP_READONLY, ZFS_TYPE_POOL, "<percent>", "FRAG");
428870ff 92 zprop_register_number(ZPOOL_PROP_CAPACITY, "capacity", 0, PROP_READONLY,
34dc7c2f 93 ZFS_TYPE_POOL, "<size>", "CAP");
428870ff 94 zprop_register_number(ZPOOL_PROP_GUID, "guid", 0, PROP_READONLY,
34dc7c2f 95 ZFS_TYPE_POOL, "<guid>", "GUID");
428870ff 96 zprop_register_number(ZPOOL_PROP_HEALTH, "health", 0, PROP_READONLY,
34dc7c2f 97 ZFS_TYPE_POOL, "<state>", "HEALTH");
428870ff
BB
98 zprop_register_number(ZPOOL_PROP_DEDUPRATIO, "dedupratio", 0,
99 PROP_READONLY, ZFS_TYPE_POOL, "<1.00x or higher if deduped>",
100 "DEDUP");
34dc7c2f 101
df30f566
CK
102 /* readonly onetime number properties */
103 zprop_register_number(ZPOOL_PROP_ASHIFT, "ashift", 0, PROP_ONETIME,
b41c9906 104 ZFS_TYPE_POOL, "<ashift, 9-13, or 0=default>", "ASHIFT");
df30f566 105
34dc7c2f 106 /* default number properties */
428870ff 107 zprop_register_number(ZPOOL_PROP_VERSION, "version", SPA_VERSION,
34dc7c2f 108 PROP_DEFAULT, ZFS_TYPE_POOL, "<version>", "VERSION");
428870ff
BB
109 zprop_register_number(ZPOOL_PROP_DEDUPDITTO, "dedupditto", 0,
110 PROP_DEFAULT, ZFS_TYPE_POOL, "<threshold (min 100)>", "DEDUPDITTO");
34dc7c2f
BB
111
112 /* default index (boolean) properties */
428870ff
BB
113 zprop_register_index(ZPOOL_PROP_DELEGATION, "delegation", 1,
114 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "DELEGATION",
115 boolean_table);
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",
120 boolean_table);
121 zprop_register_index(ZPOOL_PROP_AUTOEXPAND, "autoexpand", 0,
122 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "EXPAND", boolean_table);
572e2857
BB
123 zprop_register_index(ZPOOL_PROP_READONLY, "readonly", 0,
124 PROP_DEFAULT, ZFS_TYPE_POOL, "on | off", "RDONLY", boolean_table);
34dc7c2f
BB
125
126 /* default index properties */
428870ff 127 zprop_register_index(ZPOOL_PROP_FAILUREMODE, "failmode",
34dc7c2f
BB
128 ZIO_FAILURE_MODE_WAIT, PROP_DEFAULT, ZFS_TYPE_POOL,
129 "wait | continue | panic", "FAILMODE", failuremode_table);
130
131 /* hidden properties */
428870ff 132 zprop_register_hidden(ZPOOL_PROP_NAME, "name", PROP_TYPE_STRING,
34dc7c2f 133 PROP_READONLY, ZFS_TYPE_POOL, "NAME");
f1512ee6
MA
134 zprop_register_hidden(ZPOOL_PROP_MAXBLOCKSIZE, "maxblocksize",
135 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_POOL, "MAXBLOCKSIZE");
83e9986f
RY
136 zprop_register_hidden(ZPOOL_PROP_TNAME, "tname", PROP_TYPE_STRING,
137 PROP_ONETIME, ZFS_TYPE_POOL, "TNAME");
50c957f7
NB
138 zprop_register_hidden(ZPOOL_PROP_MAXDNODESIZE, "maxdnodesize",
139 PROP_TYPE_NUMBER, PROP_READONLY, ZFS_TYPE_POOL, "MAXDNODESIZE");
34dc7c2f
BB
140}
141
142/*
143 * Given a property name and its type, returns the corresponding property ID.
144 */
145zpool_prop_t
146zpool_name_to_prop(const char *propname)
147{
148 return (zprop_name_to_prop(propname, ZFS_TYPE_POOL));
149}
150
151/*
152 * Given a pool property ID, returns the corresponding name.
153 * Assuming the pool propety ID is valid.
154 */
155const char *
156zpool_prop_to_name(zpool_prop_t prop)
157{
158 return (zpool_prop_table[prop].pd_name);
159}
160
161zprop_type_t
162zpool_prop_get_type(zpool_prop_t prop)
163{
164 return (zpool_prop_table[prop].pd_proptype);
165}
166
167boolean_t
168zpool_prop_readonly(zpool_prop_t prop)
169{
170 return (zpool_prop_table[prop].pd_attr == PROP_READONLY);
171}
172
173const char *
174zpool_prop_default_string(zpool_prop_t prop)
175{
176 return (zpool_prop_table[prop].pd_strdefault);
177}
178
179uint64_t
180zpool_prop_default_numeric(zpool_prop_t prop)
181{
182 return (zpool_prop_table[prop].pd_numdefault);
183}
184
9ae529ec
CS
185/*
186 * Returns true if this is a valid feature@ property.
187 */
188boolean_t
189zpool_prop_feature(const char *name)
190{
191 static const char *prefix = "feature@";
192 return (strncmp(name, prefix, strlen(prefix)) == 0);
193}
194
195/*
196 * Returns true if this is a valid unsupported@ property.
197 */
198boolean_t
199zpool_prop_unsupported(const char *name)
200{
201 static const char *prefix = "unsupported@";
202 return (strncmp(name, prefix, strlen(prefix)) == 0);
203}
204
34dc7c2f
BB
205int
206zpool_prop_string_to_index(zpool_prop_t prop, const char *string,
207 uint64_t *index)
208{
209 return (zprop_string_to_index(prop, string, index, ZFS_TYPE_POOL));
210}
211
212int
213zpool_prop_index_to_string(zpool_prop_t prop, uint64_t index,
214 const char **string)
215{
216 return (zprop_index_to_string(prop, index, string, ZFS_TYPE_POOL));
217}
218
428870ff
BB
219uint64_t
220zpool_prop_random_value(zpool_prop_t prop, uint64_t seed)
221{
222 return (zprop_random_value(prop, seed, ZFS_TYPE_POOL));
223}
224
34dc7c2f
BB
225#ifndef _KERNEL
226
227const char *
228zpool_prop_values(zpool_prop_t prop)
229{
230 return (zpool_prop_table[prop].pd_values);
231}
232
233const char *
234zpool_prop_column_name(zpool_prop_t prop)
235{
236 return (zpool_prop_table[prop].pd_colname);
237}
238
239boolean_t
240zpool_prop_align_right(zpool_prop_t prop)
241{
242 return (zpool_prop_table[prop].pd_rightalign);
243}
244#endif
c28b2279
BB
245
246#if defined(_KERNEL) && defined(HAVE_SPL)
247/* zpool property functions */
248EXPORT_SYMBOL(zpool_prop_init);
249EXPORT_SYMBOL(zpool_prop_get_type);
250EXPORT_SYMBOL(zpool_prop_get_table);
251
252/* Pool property functions shared between libzfs and kernel. */
253EXPORT_SYMBOL(zpool_name_to_prop);
254EXPORT_SYMBOL(zpool_prop_to_name);
255EXPORT_SYMBOL(zpool_prop_default_string);
256EXPORT_SYMBOL(zpool_prop_default_numeric);
257EXPORT_SYMBOL(zpool_prop_readonly);
9ae529ec
CS
258EXPORT_SYMBOL(zpool_prop_feature);
259EXPORT_SYMBOL(zpool_prop_unsupported);
c28b2279
BB
260EXPORT_SYMBOL(zpool_prop_index_to_string);
261EXPORT_SYMBOL(zpool_prop_string_to_index);
262#endif