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 * $FreeBSD$ 33 */ 34 35 #ifndef _NV_H_ 36 #define _NV_H_ 37 38 #include <sys/cdefs.h> 39 40 #ifndef _KERNEL 41 #include <stdarg.h> 42 #include <stdbool.h> 43 #include <stdint.h> 44 #include <stdio.h> 45 #include <sys/nv_namespace.h> 46 #endif 47 48 #ifndef _NVLIST_T_DECLARED 49 #define _NVLIST_T_DECLARED 50 struct nvlist; 51 52 typedef struct nvlist nvlist_t; 53 #endif 54 55 #define NV_NAME_MAX 2048 56 57 #define NV_TYPE_NONE 0 58 59 #define NV_TYPE_NULL 1 60 #define NV_TYPE_BOOL 2 61 #define NV_TYPE_NUMBER 3 62 #define NV_TYPE_STRING 4 63 #define NV_TYPE_NVLIST 5 64 #define NV_TYPE_DESCRIPTOR 6 65 #define NV_TYPE_BINARY 7 66 #define NV_TYPE_BOOL_ARRAY 8 67 #define NV_TYPE_NUMBER_ARRAY 9 68 #define NV_TYPE_STRING_ARRAY 10 69 #define NV_TYPE_NVLIST_ARRAY 11 70 #define NV_TYPE_DESCRIPTOR_ARRAY 12 71 72 /* 73 * Perform case-insensitive lookups of provided names. 74 */ 75 #define NV_FLAG_IGNORE_CASE 0x01 76 /* 77 * Names don't have to be unique. 78 */ 79 #define NV_FLAG_NO_UNIQUE 0x02 80 81 #if defined(_KERNEL) && defined(MALLOC_DECLARE) 82 MALLOC_DECLARE(M_NVLIST); 83 #endif 84 85 __BEGIN_DECLS 86 87 nvlist_t *nvlist_create(int flags); 88 void nvlist_destroy(nvlist_t *nvl); 89 int nvlist_error(const nvlist_t *nvl); 90 bool nvlist_empty(const nvlist_t *nvl); 91 int nvlist_flags(const nvlist_t *nvl); 92 void nvlist_set_error(nvlist_t *nvl, int error); 93 94 nvlist_t *nvlist_clone(const nvlist_t *nvl); 95 96 #ifndef _KERNEL 97 void nvlist_dump(const nvlist_t *nvl, int fd); 98 void nvlist_fdump(const nvlist_t *nvl, FILE *fp); 99 #endif 100 101 size_t nvlist_size(const nvlist_t *nvl); 102 void *nvlist_pack(const nvlist_t *nvl, size_t *sizep); 103 nvlist_t *nvlist_unpack(const void *buf, size_t size, int flags); 104 105 int nvlist_send(int sock, const nvlist_t *nvl); 106 nvlist_t *nvlist_recv(int sock, int flags); 107 nvlist_t *nvlist_xfer(int sock, nvlist_t *nvl, int flags); 108 109 const char *nvlist_next(const nvlist_t *nvl, int *typep, void **cookiep); 110 111 const nvlist_t *nvlist_get_parent(const nvlist_t *nvl, void **cookiep); 112 113 const nvlist_t *nvlist_get_array_next(const nvlist_t *nvl); 114 bool nvlist_in_array(const nvlist_t *nvl); 115 116 const nvlist_t *nvlist_get_pararr(const nvlist_t *nvl, void **cookiep); 117 118 /* 119 * The nvlist_exists functions check if the given name (optionally of the given 120 * type) exists on nvlist. 121 */ 122 123 bool nvlist_exists(const nvlist_t *nvl, const char *name); 124 bool nvlist_exists_type(const nvlist_t *nvl, const char *name, int type); 125 126 bool nvlist_exists_null(const nvlist_t *nvl, const char *name); 127 bool nvlist_exists_bool(const nvlist_t *nvl, const char *name); 128 bool nvlist_exists_number(const nvlist_t *nvl, const char *name); 129 bool nvlist_exists_string(const nvlist_t *nvl, const char *name); 130 bool nvlist_exists_nvlist(const nvlist_t *nvl, const char *name); 131 bool nvlist_exists_binary(const nvlist_t *nvl, const char *name); 132 bool nvlist_exists_bool_array(const nvlist_t *nvl, const char *name); 133 bool nvlist_exists_number_array(const nvlist_t *nvl, const char *name); 134 bool nvlist_exists_string_array(const nvlist_t *nvl, const char *name); 135 bool nvlist_exists_nvlist_array(const nvlist_t *nvl, const char *name); 136 #ifndef _KERNEL 137 bool nvlist_exists_descriptor(const nvlist_t *nvl, const char *name); 138 bool nvlist_exists_descriptor_array(const nvlist_t *nvl, const char *name); 139 #endif 140 141 /* 142 * The nvlist_add functions add the given name/value pair. 143 * If a pointer is provided, nvlist_add will internally allocate memory for the 144 * given data (in other words it won't consume provided buffer). 145 */ 146 147 void nvlist_add_null(nvlist_t *nvl, const char *name); 148 void nvlist_add_bool(nvlist_t *nvl, const char *name, bool value); 149 void nvlist_add_number(nvlist_t *nvl, const char *name, uint64_t value); 150 void nvlist_add_string(nvlist_t *nvl, const char *name, const char *value); 151 void nvlist_add_stringf(nvlist_t *nvl, const char *name, const char *valuefmt, ...) __printflike(3, 4); 152 #if !defined(_KERNEL) || defined(_VA_LIST_DECLARED) 153 void nvlist_add_stringv(nvlist_t *nvl, const char *name, const char *valuefmt, va_list valueap) __printflike(3, 0); 154 #endif 155 void nvlist_add_nvlist(nvlist_t *nvl, const char *name, const nvlist_t *value); 156 void nvlist_add_binary(nvlist_t *nvl, const char *name, const void *value, size_t size); 157 void nvlist_add_bool_array(nvlist_t *nvl, const char *name, const bool *value, size_t nitems); 158 void nvlist_add_number_array(nvlist_t *nvl, const char *name, const uint64_t *value, size_t nitems); 159 void nvlist_add_string_array(nvlist_t *nvl, const char *name, const char * const *value, size_t nitems); 160 void nvlist_add_nvlist_array(nvlist_t *nvl, const char *name, const nvlist_t * const *value, size_t nitems); 161 #ifndef _KERNEL 162 void nvlist_add_descriptor(nvlist_t *nvl, const char *name, int value); 163 void nvlist_add_descriptor_array(nvlist_t *nvl, const char *name, const int *value, size_t nitems); 164 #endif 165 166 void nvlist_append_bool_array(nvlist_t *nvl, const char *name, const bool value); 167 void nvlist_append_number_array(nvlist_t *nvl, const char *name, const uint64_t value); 168 void nvlist_append_string_array(nvlist_t *nvl, const char *name, const char * const value); 169 void nvlist_append_nvlist_array(nvlist_t *nvl, const char *name, const nvlist_t * const value); 170 #ifndef _KERNEL 171 void nvlist_append_descriptor_array(nvlist_t *nvl, const char *name, int value); 172 #endif 173 174 /* 175 * The nvlist_move functions add the given name/value pair. 176 * The functions consumes provided buffer. 177 */ 178 179 void nvlist_move_string(nvlist_t *nvl, const char *name, char *value); 180 void nvlist_move_nvlist(nvlist_t *nvl, const char *name, nvlist_t *value); 181 void nvlist_move_binary(nvlist_t *nvl, const char *name, void *value, size_t size); 182 void nvlist_move_bool_array(nvlist_t *nvl, const char *name, bool *value, size_t nitems); 183 void nvlist_move_string_array(nvlist_t *nvl, const char *name, char **value, size_t nitems); 184 void nvlist_move_nvlist_array(nvlist_t *nvl, const char *name, nvlist_t **value, size_t nitems); 185 void nvlist_move_number_array(nvlist_t *nvl, const char *name, uint64_t *value, size_t nitems); 186 #ifndef _KERNEL 187 void nvlist_move_descriptor(nvlist_t *nvl, const char *name, int value); 188 void nvlist_move_descriptor_array(nvlist_t *nvl, const char *name, int *value, size_t nitems); 189 #endif 190 191 /* 192 * The nvlist_get functions returns value associated with the given name. 193 * If it returns a pointer, the pointer represents internal buffer and should 194 * not be freed by the caller. 195 */ 196 197 bool nvlist_get_bool(const nvlist_t *nvl, const char *name); 198 uint64_t nvlist_get_number(const nvlist_t *nvl, const char *name); 199 const char *nvlist_get_string(const nvlist_t *nvl, const char *name); 200 const nvlist_t *nvlist_get_nvlist(const nvlist_t *nvl, const char *name); 201 const void *nvlist_get_binary(const nvlist_t *nvl, const char *name, size_t *sizep); 202 const bool *nvlist_get_bool_array(const nvlist_t *nvl, const char *name, size_t *nitemsp); 203 const uint64_t *nvlist_get_number_array(const nvlist_t *nvl, const char *name, size_t *nitemsp); 204 const char * const *nvlist_get_string_array(const nvlist_t *nvl, const char *name, size_t *nitemsp); 205 const nvlist_t * const *nvlist_get_nvlist_array(const nvlist_t *nvl, const char *name, size_t *nitemsp); 206 #ifndef _KERNEL 207 int nvlist_get_descriptor(const nvlist_t *nvl, const char *name); 208 const int *nvlist_get_descriptor_array(const nvlist_t *nvl, const char *name, size_t *nitemsp); 209 #endif 210 211 /* 212 * The nvlist_take functions returns value associated with the given name and 213 * remove the given entry from the nvlist. 214 * The caller is responsible for freeing received data. 215 */ 216 217 bool nvlist_take_bool(nvlist_t *nvl, const char *name); 218 uint64_t nvlist_take_number(nvlist_t *nvl, const char *name); 219 char *nvlist_take_string(nvlist_t *nvl, const char *name); 220 nvlist_t *nvlist_take_nvlist(nvlist_t *nvl, const char *name); 221 void *nvlist_take_binary(nvlist_t *nvl, const char *name, size_t *sizep); 222 bool *nvlist_take_bool_array(nvlist_t *nvl, const char *name, size_t *nitemsp); 223 uint64_t *nvlist_take_number_array(nvlist_t *nvl, const char *name, size_t *nitemsp); 224 char **nvlist_take_string_array(nvlist_t *nvl, const char *name, size_t *nitemsp); 225 nvlist_t **nvlist_take_nvlist_array(nvlist_t *nvl, const char *name, size_t *nitemsp); 226 #ifndef _KERNEL 227 int nvlist_take_descriptor(nvlist_t *nvl, const char *name); 228 int *nvlist_take_descriptor_array(nvlist_t *nvl, const char *name, size_t *nitemsp); 229 #endif 230 231 /* 232 * The nvlist_free functions removes the given name/value pair from the nvlist 233 * and frees memory associated with it. 234 */ 235 236 void nvlist_free(nvlist_t *nvl, const char *name); 237 void nvlist_free_type(nvlist_t *nvl, const char *name, int type); 238 239 void nvlist_free_null(nvlist_t *nvl, const char *name); 240 void nvlist_free_bool(nvlist_t *nvl, const char *name); 241 void nvlist_free_number(nvlist_t *nvl, const char *name); 242 void nvlist_free_string(nvlist_t *nvl, const char *name); 243 void nvlist_free_nvlist(nvlist_t *nvl, const char *name); 244 void nvlist_free_binary(nvlist_t *nvl, const char *name); 245 void nvlist_free_bool_array(nvlist_t *nvl, const char *name); 246 void nvlist_free_number_array(nvlist_t *nvl, const char *name); 247 void nvlist_free_string_array(nvlist_t *nvl, const char *name); 248 void nvlist_free_nvlist_array(nvlist_t *nvl, const char *name); 249 void nvlist_free_binary_array(nvlist_t *nvl, const char *name); 250 #ifndef _KERNEL 251 void nvlist_free_descriptor(nvlist_t *nvl, const char *name); 252 void nvlist_free_descriptor_array(nvlist_t *nvl, const char *name); 253 #endif 254 255 __END_DECLS 256 257 #endif /* !_NV_H_ */ 258