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 /*
22 * Copyright 2010 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
24 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
25 */
26
27 #ifndef _ZFS_PROP_H
28 #define _ZFS_PROP_H
29
30 #include <sys/fs/zfs.h>
31 #include <sys/types.h>
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 /*
38 * For index types (e.g. compression and checksum), we want the numeric value
39 * in the kernel, but the string value in userland.
40 */
41 typedef enum {
42 PROP_TYPE_NUMBER, /* numeric value */
43 PROP_TYPE_STRING, /* string value */
44 PROP_TYPE_INDEX /* numeric value indexed by string */
45 } zprop_type_t;
46
47 typedef enum {
48 PROP_DEFAULT,
49 PROP_READONLY,
50 PROP_INHERIT,
51 /*
52 * ONETIME properties are a sort of conglomeration of READONLY
53 * and INHERIT. They can be set only during object creation,
54 * after that they are READONLY. If not explicitly set during
55 * creation, they can be inherited.
56 */
57 PROP_ONETIME
58 } zprop_attr_t;
59
60 typedef struct zfs_index {
61 const char *pi_name;
62 uint64_t pi_value;
63 } zprop_index_t;
64
65 typedef struct {
66 const char *pd_name; /* human-readable property name */
67 int pd_propnum; /* property number */
68 zprop_type_t pd_proptype; /* string, boolean, index, number */
69 const char *pd_strdefault; /* default for strings */
70 uint64_t pd_numdefault; /* for boolean / index / number */
71 zprop_attr_t pd_attr; /* default, readonly, inherit */
72 int pd_types; /* bitfield of valid dataset types */
73 /* fs | vol | snap; or pool */
74 const char *pd_values; /* string telling acceptable values */
75 const char *pd_colname; /* column header for "zfs list" */
76 boolean_t pd_rightalign; /* column alignment for "zfs list" */
77 boolean_t pd_visible; /* do we list this property with the */
78 /* "zfs get" help message */
79 const zprop_index_t *pd_table; /* for index properties, a table */
80 /* defining the possible values */
81 size_t pd_table_size; /* number of entries in pd_table[] */
82 } zprop_desc_t;
83
84 /*
85 * zfs dataset property functions
86 */
87 void zfs_prop_init(void);
88 zprop_type_t zfs_prop_get_type(zfs_prop_t);
89 boolean_t zfs_prop_delegatable(zfs_prop_t prop);
90 boolean_t zfs_prop_cacheable(zfs_prop_t prop);
91 zprop_desc_t *zfs_prop_get_table(void);
92
93 /*
94 * zpool property functions
95 */
96 void zpool_prop_init(void);
97 zprop_type_t zpool_prop_get_type(zpool_prop_t);
98 zprop_desc_t *zpool_prop_get_table(void);
99
100 /*
101 * Common routines to initialize property tables
102 */
103 void zprop_register_impl(int, const char *, zprop_type_t, uint64_t,
104 const char *, zprop_attr_t, int, const char *, const char *,
105 boolean_t, boolean_t, const zprop_index_t *);
106 void zprop_register_string(int, const char *, const char *,
107 zprop_attr_t attr, int, const char *, const char *);
108 void zprop_register_number(int, const char *, uint64_t, zprop_attr_t, int,
109 const char *, const char *);
110 void zprop_register_index(int, const char *, uint64_t, zprop_attr_t, int,
111 const char *, const char *, const zprop_index_t *);
112 void zprop_register_hidden(int, const char *, zprop_type_t, zprop_attr_t,
113 int, const char *);
114
115 /*
116 * Common routines for zfs and zpool property management
117 */
118 int zprop_iter_common(zprop_func, void *, boolean_t, boolean_t, zfs_type_t);
119 int zprop_name_to_prop(const char *, zfs_type_t);
120 int zprop_string_to_index(int, const char *, uint64_t *, zfs_type_t);
121 int zprop_index_to_string(int, uint64_t, const char **, zfs_type_t);
122 uint64_t zprop_random_value(int, uint64_t, zfs_type_t);
123 const char *zprop_values(int, zfs_type_t);
124 size_t zprop_width(int, boolean_t *, zfs_type_t);
125 boolean_t zprop_valid_for_type(int, zfs_type_t);
126
127 #ifdef __cplusplus
128 }
129 #endif
130
131 #endif /* _ZFS_PROP_H */