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