2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2016 Adam Starak <starak.adam@gmail.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #include <sys/cdefs.h>
39 #include <sys/nv_namespace.h>
42 #ifndef _NVLIST_T_DECLARED
43 #define _NVLIST_T_DECLARED
46 typedef struct nvlist nvlist_t;
52 * Functions which returns information about the given cookie.
54 const char *cnvlist_name(const void *cookie);
55 int cnvlist_type(const void *cookie);
58 * The cnvlist_get functions returns value associated with the given cookie.
59 * If it returns a pointer, the pointer represents internal buffer and should
60 * not be freed by the caller.
63 bool cnvlist_get_bool(const void *cookie);
64 uint64_t cnvlist_get_number(const void *cookie);
65 const char *cnvlist_get_string(const void *cookie);
66 const nvlist_t *cnvlist_get_nvlist(const void *cookie);
67 const void *cnvlist_get_binary(const void *cookie, size_t *sizep);
68 const bool *cnvlist_get_bool_array(const void *cookie, size_t *nitemsp);
69 const uint64_t *cnvlist_get_number_array(const void *cookie, size_t *nitemsp);
70 const char * const *cnvlist_get_string_array(const void *cookie, size_t *nitemsp);
71 const nvlist_t * const *cnvlist_get_nvlist_array(const void *cookie, size_t *nitemsp);
73 int cnvlist_get_descriptor(const void *cookie);
74 const int *cnvlist_get_descriptor_array(const void *cookie, size_t *nitemsp);
78 * The cnvlist_take functions returns value associated with the given cookie and
79 * remove the given entry from the nvlist.
80 * The caller is responsible for freeing received data.
83 bool cnvlist_take_bool(void *cookie);
84 uint64_t cnvlist_take_number(void *cookie);
85 char *cnvlist_take_string(void *cookie);
86 nvlist_t *cnvlist_take_nvlist(void *cookie);
87 void *cnvlist_take_binary(void *cookie, size_t *sizep);
88 bool *cnvlist_take_bool_array(void *cookie, size_t *nitemsp);
89 uint64_t *cnvlist_take_number_array(void *cookie, size_t *nitemsp);
90 char **cnvlist_take_string_array(void *cookie, size_t *nitemsp);
91 nvlist_t **cnvlist_take_nvlist_array(void *cookie, size_t *nitemsp);
93 int cnvlist_take_descriptor(void *cookie);
94 int *cnvlist_take_descriptor_array(void *cookie, size_t *nitemsp);
98 * The cnvlist_free functions removes the given name/value pair from the nvlist based on cookie
99 * and frees memory associated with it.
102 void cnvlist_free_bool(void *cookie);
103 void cnvlist_free_number(void *cookie);
104 void cnvlist_free_string(void *cookie);
105 void cnvlist_free_nvlist(void *cookie);
106 void cnvlist_free_binary(void *cookie);
107 void cnvlist_free_bool_array(void *cookie);
108 void cnvlist_free_number_array(void *cookie);
109 void cnvlist_free_string_array(void *cookie);
110 void cnvlist_free_nvlist_array(void *cookie);
112 void cnvlist_free_descriptor(void *cookie);
113 void cnvlist_free_descriptor_array(void *cookie);
118 #endif /* !_CNV_H_ */