initial commit
[freebsd-arm:freebsd-arm.git] / cddl / contrib / opensolaris / uts / common / sys / nvpair.h
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 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25
26 #ifndef _SYS_NVPAIR_H
27 #define _SYS_NVPAIR_H
28
29 #pragma ident   "%Z%%M% %I%     %E% SMI"
30
31 #include <sys/types.h>
32 #include <sys/time.h>
33 #include <sys/errno.h>
34
35 #if defined(_KERNEL) && !defined(_BOOT)
36 #include <sys/kmem.h>
37 #endif
38
39 #ifdef  __cplusplus
40 extern "C" {
41 #endif
42
43 typedef enum {
44         DATA_TYPE_UNKNOWN = 0,
45         DATA_TYPE_BOOLEAN,
46         DATA_TYPE_BYTE,
47         DATA_TYPE_INT16,
48         DATA_TYPE_UINT16,
49         DATA_TYPE_INT32,
50         DATA_TYPE_UINT32,
51         DATA_TYPE_INT64,
52         DATA_TYPE_UINT64,
53         DATA_TYPE_STRING,
54         DATA_TYPE_BYTE_ARRAY,
55         DATA_TYPE_INT16_ARRAY,
56         DATA_TYPE_UINT16_ARRAY,
57         DATA_TYPE_INT32_ARRAY,
58         DATA_TYPE_UINT32_ARRAY,
59         DATA_TYPE_INT64_ARRAY,
60         DATA_TYPE_UINT64_ARRAY,
61         DATA_TYPE_STRING_ARRAY,
62         DATA_TYPE_HRTIME,
63         DATA_TYPE_NVLIST,
64         DATA_TYPE_NVLIST_ARRAY,
65         DATA_TYPE_BOOLEAN_VALUE,
66         DATA_TYPE_INT8,
67         DATA_TYPE_UINT8,
68         DATA_TYPE_BOOLEAN_ARRAY,
69         DATA_TYPE_INT8_ARRAY,
70 #if !defined(_KERNEL)
71         DATA_TYPE_UINT8_ARRAY,
72         DATA_TYPE_DOUBLE
73 #else
74         DATA_TYPE_UINT8_ARRAY
75 #endif
76 } data_type_t;
77
78 typedef struct nvpair {
79         int32_t nvp_size;       /* size of this nvpair */
80         int16_t nvp_name_sz;    /* length of name string */
81         int16_t nvp_reserve;    /* not used */
82         int32_t nvp_value_elem; /* number of elements for array types */
83         data_type_t nvp_type;   /* type of value */
84         /* name string */
85         /* aligned ptr array for string arrays */
86         /* aligned array of data for value */
87 } nvpair_t;
88
89 /* nvlist header */
90 typedef struct nvlist {
91         int32_t         nvl_version;
92         uint32_t        nvl_nvflag;     /* persistent flags */
93         uint64_t        nvl_priv;       /* ptr to private data if not packed */
94         uint32_t        nvl_flag;
95         int32_t         nvl_pad;        /* currently not used, for alignment */
96 } nvlist_t;
97
98 /* nvp implementation version */
99 #define NV_VERSION      0
100
101 /* nvlist pack encoding */
102 #define NV_ENCODE_NATIVE        0
103 #define NV_ENCODE_XDR           1
104
105 /* nvlist persistent unique name flags, stored in nvl_nvflags */
106 #define NV_UNIQUE_NAME          0x1
107 #define NV_UNIQUE_NAME_TYPE     0x2
108
109 /* nvlist lookup pairs related flags */
110 #define NV_FLAG_NOENTOK         0x1
111
112 /* convenience macros */
113 #define NV_ALIGN(x)             (((ulong_t)(x) + 7ul) & ~7ul)
114 #define NV_ALIGN4(x)            (((x) + 3) & ~3)
115
116 #define NVP_SIZE(nvp)           ((nvp)->nvp_size)
117 #define NVP_NAME(nvp)           ((char *)(nvp) + sizeof (nvpair_t))
118 #define NVP_TYPE(nvp)           ((nvp)->nvp_type)
119 #define NVP_NELEM(nvp)          ((nvp)->nvp_value_elem)
120 #define NVP_VALUE(nvp)          ((char *)(nvp) + NV_ALIGN(sizeof (nvpair_t) \
121                                 + (nvp)->nvp_name_sz))
122
123 #define NVL_VERSION(nvl)        ((nvl)->nvl_version)
124 #define NVL_SIZE(nvl)           ((nvl)->nvl_size)
125 #define NVL_FLAG(nvl)           ((nvl)->nvl_flag)
126
127 /* NV allocator framework */
128 typedef struct nv_alloc_ops nv_alloc_ops_t;
129
130 typedef struct nv_alloc {
131         const nv_alloc_ops_t *nva_ops;
132         void *nva_arg;
133 } nv_alloc_t;
134
135 struct nv_alloc_ops {
136         int (*nv_ao_init)(nv_alloc_t *, __va_list);
137         void (*nv_ao_fini)(nv_alloc_t *);
138         void *(*nv_ao_alloc)(nv_alloc_t *, size_t);
139         void (*nv_ao_free)(nv_alloc_t *, void *, size_t);
140         void (*nv_ao_reset)(nv_alloc_t *);
141 };
142
143 extern const nv_alloc_ops_t *nv_fixed_ops;
144 extern nv_alloc_t *nv_alloc_nosleep;
145
146 #if defined(_KERNEL) && !defined(_BOOT)
147 extern nv_alloc_t *nv_alloc_sleep;
148 #endif
149
150 int nv_alloc_init(nv_alloc_t *, const nv_alloc_ops_t *, /* args */ ...);
151 void nv_alloc_reset(nv_alloc_t *);
152 void nv_alloc_fini(nv_alloc_t *);
153
154 /* list management */
155 int nvlist_alloc(nvlist_t **, uint_t, int);
156 void nvlist_free(nvlist_t *);
157 int nvlist_size(nvlist_t *, size_t *, int);
158 int nvlist_pack(nvlist_t *, char **, size_t *, int, int);
159 int nvlist_unpack(char *, size_t, nvlist_t **, int);
160 int nvlist_dup(nvlist_t *, nvlist_t **, int);
161 int nvlist_merge(nvlist_t *, nvlist_t *, int);
162
163 int nvlist_xalloc(nvlist_t **, uint_t, nv_alloc_t *);
164 int nvlist_xpack(nvlist_t *, char **, size_t *, int, nv_alloc_t *);
165 int nvlist_xunpack(char *, size_t, nvlist_t **, nv_alloc_t *);
166 int nvlist_xdup(nvlist_t *, nvlist_t **, nv_alloc_t *);
167 nv_alloc_t *nvlist_lookup_nv_alloc(nvlist_t *);
168
169 int nvlist_add_nvpair(nvlist_t *, nvpair_t *);
170 int nvlist_add_boolean(nvlist_t *, const char *);
171 int nvlist_add_boolean_value(nvlist_t *, const char *, boolean_t);
172 int nvlist_add_byte(nvlist_t *, const char *, uchar_t);
173 int nvlist_add_int8(nvlist_t *, const char *, int8_t);
174 int nvlist_add_uint8(nvlist_t *, const char *, uint8_t);
175 int nvlist_add_int16(nvlist_t *, const char *, int16_t);
176 int nvlist_add_uint16(nvlist_t *, const char *, uint16_t);
177 int nvlist_add_int32(nvlist_t *, const char *, int32_t);
178 int nvlist_add_uint32(nvlist_t *, const char *, uint32_t);
179 int nvlist_add_int64(nvlist_t *, const char *, int64_t);
180 int nvlist_add_uint64(nvlist_t *, const char *, uint64_t);
181 int nvlist_add_string(nvlist_t *, const char *, const char *);
182 int nvlist_add_nvlist(nvlist_t *, const char *, nvlist_t *);
183 int nvlist_add_boolean_array(nvlist_t *, const char *, boolean_t *, uint_t);
184 int nvlist_add_byte_array(nvlist_t *, const char *, uchar_t *, uint_t);
185 int nvlist_add_int8_array(nvlist_t *, const char *, int8_t *, uint_t);
186 int nvlist_add_uint8_array(nvlist_t *, const char *, uint8_t *, uint_t);
187 int nvlist_add_int16_array(nvlist_t *, const char *, int16_t *, uint_t);
188 int nvlist_add_uint16_array(nvlist_t *, const char *, uint16_t *, uint_t);
189 int nvlist_add_int32_array(nvlist_t *, const char *, int32_t *, uint_t);
190 int nvlist_add_uint32_array(nvlist_t *, const char *, uint32_t *, uint_t);
191 int nvlist_add_int64_array(nvlist_t *, const char *, int64_t *, uint_t);
192 int nvlist_add_uint64_array(nvlist_t *, const char *, uint64_t *, uint_t);
193 int nvlist_add_string_array(nvlist_t *, const char *, char *const *, uint_t);
194 int nvlist_add_nvlist_array(nvlist_t *, const char *, nvlist_t **, uint_t);
195 int nvlist_add_hrtime(nvlist_t *, const char *, hrtime_t);
196 #if !defined(_KERNEL)
197 int nvlist_add_double(nvlist_t *, const char *, double);
198 #endif
199
200 int nvlist_remove(nvlist_t *, const char *, data_type_t);
201 int nvlist_remove_all(nvlist_t *, const char *);
202
203 int nvlist_lookup_boolean(nvlist_t *, const char *);
204 int nvlist_lookup_boolean_value(nvlist_t *, const char *, boolean_t *);
205 int nvlist_lookup_byte(nvlist_t *, const char *, uchar_t *);
206 int nvlist_lookup_int8(nvlist_t *, const char *, int8_t *);
207 int nvlist_lookup_uint8(nvlist_t *, const char *, uint8_t *);
208 int nvlist_lookup_int16(nvlist_t *, const char *, int16_t *);
209 int nvlist_lookup_uint16(nvlist_t *, const char *, uint16_t *);
210 int nvlist_lookup_int32(nvlist_t *, const char *, int32_t *);
211 int nvlist_lookup_uint32(nvlist_t *, const char *, uint32_t *);
212 int nvlist_lookup_int64(nvlist_t *, const char *, int64_t *);
213 int nvlist_lookup_uint64(nvlist_t *, const char *, uint64_t *);
214 int nvlist_lookup_string(nvlist_t *, const char *, char **);
215 int nvlist_lookup_nvlist(nvlist_t *, const char *, nvlist_t **);
216 int nvlist_lookup_boolean_array(nvlist_t *, const char *,
217     boolean_t **, uint_t *);
218 int nvlist_lookup_byte_array(nvlist_t *, const char *, uchar_t **, uint_t *);
219 int nvlist_lookup_int8_array(nvlist_t *, const char *, int8_t **, uint_t *);
220 int nvlist_lookup_uint8_array(nvlist_t *, const char *, uint8_t **, uint_t *);
221 int nvlist_lookup_int16_array(nvlist_t *, const char *, int16_t **, uint_t *);
222 int nvlist_lookup_uint16_array(nvlist_t *, const char *, uint16_t **, uint_t *);
223 int nvlist_lookup_int32_array(nvlist_t *, const char *, int32_t **, uint_t *);
224 int nvlist_lookup_uint32_array(nvlist_t *, const char *, uint32_t **, uint_t *);
225 int nvlist_lookup_int64_array(nvlist_t *, const char *, int64_t **, uint_t *);
226 int nvlist_lookup_uint64_array(nvlist_t *, const char *, uint64_t **, uint_t *);
227 int nvlist_lookup_string_array(nvlist_t *, const char *, char ***, uint_t *);
228 int nvlist_lookup_nvlist_array(nvlist_t *, const char *,
229     nvlist_t ***, uint_t *);
230 int nvlist_lookup_hrtime(nvlist_t *, const char *, hrtime_t *);
231 int nvlist_lookup_pairs(nvlist_t *, int, ...);
232 #if !defined(_KERNEL)
233 int nvlist_lookup_double(nvlist_t *, const char *, double *);
234 #endif
235
236 int nvlist_lookup_nvpair(nvlist_t *, const char *, nvpair_t **);
237 int nvlist_lookup_nvpair_embedded_index(nvlist_t *, const char *, nvpair_t **,
238     int *, char **);
239 boolean_t nvlist_exists(nvlist_t *, const char *);
240
241 /* processing nvpair */
242 nvpair_t *nvlist_next_nvpair(nvlist_t *, nvpair_t *);
243 char *nvpair_name(nvpair_t *);
244 data_type_t nvpair_type(nvpair_t *);
245 int nvpair_type_is_array(nvpair_t *);
246 int nvpair_value_boolean_value(nvpair_t *, boolean_t *);
247 int nvpair_value_byte(nvpair_t *, uchar_t *);
248 int nvpair_value_int8(nvpair_t *, int8_t *);
249 int nvpair_value_uint8(nvpair_t *, uint8_t *);
250 int nvpair_value_int16(nvpair_t *, int16_t *);
251 int nvpair_value_uint16(nvpair_t *, uint16_t *);
252 int nvpair_value_int32(nvpair_t *, int32_t *);
253 int nvpair_value_uint32(nvpair_t *, uint32_t *);
254 int nvpair_value_int64(nvpair_t *, int64_t *);
255 int nvpair_value_uint64(nvpair_t *, uint64_t *);
256 int nvpair_value_string(nvpair_t *, char **);
257 int nvpair_value_nvlist(nvpair_t *, nvlist_t **);
258 int nvpair_value_boolean_array(nvpair_t *, boolean_t **, uint_t *);
259 int nvpair_value_byte_array(nvpair_t *, uchar_t **, uint_t *);
260 int nvpair_value_int8_array(nvpair_t *, int8_t **, uint_t *);
261 int nvpair_value_uint8_array(nvpair_t *, uint8_t **, uint_t *);
262 int nvpair_value_int16_array(nvpair_t *, int16_t **, uint_t *);
263 int nvpair_value_uint16_array(nvpair_t *, uint16_t **, uint_t *);
264 int nvpair_value_int32_array(nvpair_t *, int32_t **, uint_t *);
265 int nvpair_value_uint32_array(nvpair_t *, uint32_t **, uint_t *);
266 int nvpair_value_int64_array(nvpair_t *, int64_t **, uint_t *);
267 int nvpair_value_uint64_array(nvpair_t *, uint64_t **, uint_t *);
268 int nvpair_value_string_array(nvpair_t *, char ***, uint_t *);
269 int nvpair_value_nvlist_array(nvpair_t *, nvlist_t ***, uint_t *);
270 int nvpair_value_hrtime(nvpair_t *, hrtime_t *);
271 #if !defined(_KERNEL)
272 int nvpair_value_double(nvpair_t *, double *);
273 #endif
274
275 #ifdef  __cplusplus
276 }
277 #endif
278
279 #endif  /* _SYS_NVPAIR_H */