master
1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2009-2013 The FreeBSD Foundation
5 * Copyright (c) 2013-2015 Mariusz Zaborski <oshogbo@FreeBSD.org>
6 * All rights reserved.
7 *
8 * This software was developed by Pawel Jakub Dawidek under sponsorship from
9 * the FreeBSD Foundation.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 */
32
33#ifndef _NV_H_
34#define _NV_H_
35
36#include <sys/cdefs.h>
37
38#ifndef _KERNEL
39#include <stdarg.h>
40#include <stdbool.h>
41#include <stdint.h>
42#include <stdio.h>
43#include <sys/nv_namespace.h>
44#endif
45
46#ifndef _NVLIST_T_DECLARED
47#define _NVLIST_T_DECLARED
48struct nvlist;
49
50typedef struct nvlist nvlist_t;
51#endif
52
53#define NV_NAME_MAX 2048
54
55#define NV_TYPE_NONE 0
56
57#define NV_TYPE_NULL 1
58#define NV_TYPE_BOOL 2
59#define NV_TYPE_NUMBER 3
60#define NV_TYPE_STRING 4
61#define NV_TYPE_NVLIST 5
62#define NV_TYPE_DESCRIPTOR 6
63#define NV_TYPE_BINARY 7
64#define NV_TYPE_BOOL_ARRAY 8
65#define NV_TYPE_NUMBER_ARRAY 9
66#define NV_TYPE_STRING_ARRAY 10
67#define NV_TYPE_NVLIST_ARRAY 11
68#define NV_TYPE_DESCRIPTOR_ARRAY 12
69
70/*
71 * Perform case-insensitive lookups of provided names.
72 */
73#define NV_FLAG_IGNORE_CASE 0x01
74/*
75 * Names don't have to be unique.
76 */
77#define NV_FLAG_NO_UNIQUE 0x02
78
79#if defined(_KERNEL) && defined(MALLOC_DECLARE)
80MALLOC_DECLARE(M_NVLIST);
81#endif
82
83__BEGIN_DECLS
84
85nvlist_t *nvlist_create(int flags);
86void nvlist_destroy(nvlist_t *nvl);
87int nvlist_error(const nvlist_t *nvl);
88bool nvlist_empty(const nvlist_t *nvl);
89int nvlist_flags(const nvlist_t *nvl);
90void nvlist_set_error(nvlist_t *nvl, int error);
91
92nvlist_t *nvlist_clone(const nvlist_t *nvl);
93
94#ifndef _KERNEL
95void nvlist_dump(const nvlist_t *nvl, int fd);
96void nvlist_fdump(const nvlist_t *nvl, FILE *fp);
97#endif
98
99size_t nvlist_size(const nvlist_t *nvl);
100void *nvlist_pack(const nvlist_t *nvl, size_t *sizep);
101nvlist_t *nvlist_unpack(const void *buf, size_t size, int flags);
102
103int nvlist_send(int sock, const nvlist_t *nvl);
104nvlist_t *nvlist_recv(int sock, int flags);
105nvlist_t *nvlist_xfer(int sock, nvlist_t *nvl, int flags);
106
107const char *nvlist_next(const nvlist_t *nvl, int *typep, void **cookiep);
108
109const nvlist_t *nvlist_get_parent(const nvlist_t *nvl, void **cookiep);
110
111const nvlist_t *nvlist_get_array_next(const nvlist_t *nvl);
112bool nvlist_in_array(const nvlist_t *nvl);
113
114const nvlist_t *nvlist_get_pararr(const nvlist_t *nvl, void **cookiep);
115
116/*
117 * The nvlist_exists functions check if the given name (optionally of the given
118 * type) exists on nvlist.
119 */
120
121bool nvlist_exists(const nvlist_t *nvl, const char *name);
122bool nvlist_exists_type(const nvlist_t *nvl, const char *name, int type);
123
124bool nvlist_exists_null(const nvlist_t *nvl, const char *name);
125bool nvlist_exists_bool(const nvlist_t *nvl, const char *name);
126bool nvlist_exists_number(const nvlist_t *nvl, const char *name);
127bool nvlist_exists_string(const nvlist_t *nvl, const char *name);
128bool nvlist_exists_nvlist(const nvlist_t *nvl, const char *name);
129bool nvlist_exists_binary(const nvlist_t *nvl, const char *name);
130bool nvlist_exists_bool_array(const nvlist_t *nvl, const char *name);
131bool nvlist_exists_number_array(const nvlist_t *nvl, const char *name);
132bool nvlist_exists_string_array(const nvlist_t *nvl, const char *name);
133bool nvlist_exists_nvlist_array(const nvlist_t *nvl, const char *name);
134#ifndef _KERNEL
135bool nvlist_exists_descriptor(const nvlist_t *nvl, const char *name);
136bool nvlist_exists_descriptor_array(const nvlist_t *nvl, const char *name);
137#endif
138
139/*
140 * The nvlist_add functions add the given name/value pair.
141 * If a pointer is provided, nvlist_add will internally allocate memory for the
142 * given data (in other words it won't consume provided buffer).
143 */
144
145void nvlist_add_null(nvlist_t *nvl, const char *name);
146void nvlist_add_bool(nvlist_t *nvl, const char *name, bool value);
147void nvlist_add_number(nvlist_t *nvl, const char *name, uint64_t value);
148void nvlist_add_string(nvlist_t *nvl, const char *name, const char *value);
149void nvlist_add_stringf(nvlist_t *nvl, const char *name, const char *valuefmt, ...) __printflike(3, 4);
150#if !defined(_KERNEL) || defined(_VA_LIST_DECLARED)
151void nvlist_add_stringv(nvlist_t *nvl, const char *name, const char *valuefmt, va_list valueap) __printflike(3, 0);
152#endif
153void nvlist_add_nvlist(nvlist_t *nvl, const char *name, const nvlist_t *value);
154void nvlist_add_binary(nvlist_t *nvl, const char *name, const void *value, size_t size);
155void nvlist_add_bool_array(nvlist_t *nvl, const char *name, const bool *value, size_t nitems);
156void nvlist_add_number_array(nvlist_t *nvl, const char *name, const uint64_t *value, size_t nitems);
157void nvlist_add_string_array(nvlist_t *nvl, const char *name, const char * const *value, size_t nitems);
158void nvlist_add_nvlist_array(nvlist_t *nvl, const char *name, const nvlist_t * const *value, size_t nitems);
159#ifndef _KERNEL
160void nvlist_add_descriptor(nvlist_t *nvl, const char *name, int value);
161void nvlist_add_descriptor_array(nvlist_t *nvl, const char *name, const int *value, size_t nitems);
162#endif
163
164void nvlist_append_bool_array(nvlist_t *nvl, const char *name, const bool value);
165void nvlist_append_number_array(nvlist_t *nvl, const char *name, const uint64_t value);
166void nvlist_append_string_array(nvlist_t *nvl, const char *name, const char * const value);
167void nvlist_append_nvlist_array(nvlist_t *nvl, const char *name, const nvlist_t * const value);
168#ifndef _KERNEL
169void nvlist_append_descriptor_array(nvlist_t *nvl, const char *name, int value);
170#endif
171
172/*
173 * The nvlist_move functions add the given name/value pair.
174 * The functions consumes provided buffer.
175 */
176
177void nvlist_move_string(nvlist_t *nvl, const char *name, char *value);
178void nvlist_move_nvlist(nvlist_t *nvl, const char *name, nvlist_t *value);
179void nvlist_move_binary(nvlist_t *nvl, const char *name, void *value, size_t size);
180void nvlist_move_bool_array(nvlist_t *nvl, const char *name, bool *value, size_t nitems);
181void nvlist_move_string_array(nvlist_t *nvl, const char *name, char **value, size_t nitems);
182void nvlist_move_nvlist_array(nvlist_t *nvl, const char *name, nvlist_t **value, size_t nitems);
183void nvlist_move_number_array(nvlist_t *nvl, const char *name, uint64_t *value, size_t nitems);
184#ifndef _KERNEL
185void nvlist_move_descriptor(nvlist_t *nvl, const char *name, int value);
186void nvlist_move_descriptor_array(nvlist_t *nvl, const char *name, int *value, size_t nitems);
187#endif
188
189/*
190 * The nvlist_get functions returns value associated with the given name.
191 * If it returns a pointer, the pointer represents internal buffer and should
192 * not be freed by the caller.
193 */
194
195bool nvlist_get_bool(const nvlist_t *nvl, const char *name);
196uint64_t nvlist_get_number(const nvlist_t *nvl, const char *name);
197const char *nvlist_get_string(const nvlist_t *nvl, const char *name);
198const nvlist_t *nvlist_get_nvlist(const nvlist_t *nvl, const char *name);
199const void *nvlist_get_binary(const nvlist_t *nvl, const char *name, size_t *sizep);
200const bool *nvlist_get_bool_array(const nvlist_t *nvl, const char *name, size_t *nitemsp);
201const uint64_t *nvlist_get_number_array(const nvlist_t *nvl, const char *name, size_t *nitemsp);
202const char * const *nvlist_get_string_array(const nvlist_t *nvl, const char *name, size_t *nitemsp);
203const nvlist_t * const *nvlist_get_nvlist_array(const nvlist_t *nvl, const char *name, size_t *nitemsp);
204#ifndef _KERNEL
205int nvlist_get_descriptor(const nvlist_t *nvl, const char *name);
206const int *nvlist_get_descriptor_array(const nvlist_t *nvl, const char *name, size_t *nitemsp);
207#endif
208
209/*
210 * The nvlist_take functions returns value associated with the given name and
211 * remove the given entry from the nvlist.
212 * The caller is responsible for freeing received data.
213 */
214
215bool nvlist_take_bool(nvlist_t *nvl, const char *name);
216uint64_t nvlist_take_number(nvlist_t *nvl, const char *name);
217char *nvlist_take_string(nvlist_t *nvl, const char *name);
218nvlist_t *nvlist_take_nvlist(nvlist_t *nvl, const char *name);
219void *nvlist_take_binary(nvlist_t *nvl, const char *name, size_t *sizep);
220bool *nvlist_take_bool_array(nvlist_t *nvl, const char *name, size_t *nitemsp);
221uint64_t *nvlist_take_number_array(nvlist_t *nvl, const char *name, size_t *nitemsp);
222char **nvlist_take_string_array(nvlist_t *nvl, const char *name, size_t *nitemsp);
223nvlist_t **nvlist_take_nvlist_array(nvlist_t *nvl, const char *name, size_t *nitemsp);
224#ifndef _KERNEL
225int nvlist_take_descriptor(nvlist_t *nvl, const char *name);
226int *nvlist_take_descriptor_array(nvlist_t *nvl, const char *name, size_t *nitemsp);
227#endif
228
229/*
230 * The nvlist_free functions removes the given name/value pair from the nvlist
231 * and frees memory associated with it.
232 */
233
234void nvlist_free(nvlist_t *nvl, const char *name);
235void nvlist_free_type(nvlist_t *nvl, const char *name, int type);
236
237void nvlist_free_null(nvlist_t *nvl, const char *name);
238void nvlist_free_bool(nvlist_t *nvl, const char *name);
239void nvlist_free_number(nvlist_t *nvl, const char *name);
240void nvlist_free_string(nvlist_t *nvl, const char *name);
241void nvlist_free_nvlist(nvlist_t *nvl, const char *name);
242void nvlist_free_binary(nvlist_t *nvl, const char *name);
243void nvlist_free_bool_array(nvlist_t *nvl, const char *name);
244void nvlist_free_number_array(nvlist_t *nvl, const char *name);
245void nvlist_free_string_array(nvlist_t *nvl, const char *name);
246void nvlist_free_nvlist_array(nvlist_t *nvl, const char *name);
247void nvlist_free_binary_array(nvlist_t *nvl, const char *name);
248#ifndef _KERNEL
249void nvlist_free_descriptor(nvlist_t *nvl, const char *name);
250void nvlist_free_descriptor_array(nvlist_t *nvl, const char *name);
251#endif
252
253__END_DECLS
254
255#endif /* !_NV_H_ */