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