1 /*- 2 * Copyright (c) 2016 Adam Starak <starak.adam@gmail.com> 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 * 26 * $FreeBSD$ 27 */ 28 29 #ifndef _CNV_H_ 30 #define _CNV_H_ 31 32 #include <sys/cdefs.h> 33 34 #ifndef _KERNEL 35 #include <stdarg.h> 36 #include <stdbool.h> 37 #include <stdint.h> 38 #include <stdio.h> 39 #endif 40 41 #ifndef _NVLIST_T_DECLARED 42 #define _NVLIST_T_DECLARED 43 struct nvlist; 44 45 typedef struct nvlist nvlist_t; 46 #endif 47 48 __BEGIN_DECLS 49 50 /* 51 * The cnvlist_get functions returns value associated with the given cookie. 52 * If it returns a pointer, the pointer represents internal buffer and should 53 * not be freed by the caller. 54 */ 55 56 bool cnvlist_get_bool(void *cookiep); 57 uint64_t cnvlist_get_number(void *cookiep); 58 const char *cnvlist_get_string(void *cookiep); 59 const nvlist_t *cnvlist_get_nvlist(void *cookiep); 60 const void *cnvlist_get_binary(void *cookiep, size_t *sizep); 61 const bool *cnvlist_get_bool_array(void *cookiep, size_t *nitemsp); 62 const uint64_t *cnvlist_get_number_array(void *cookiep, size_t *nitemsp); 63 const char * const *cnvlist_get_string_array(void *cookiep, size_t *nitemsp); 64 const nvlist_t * const *cnvlist_get_nvlist_array(void *cookiep, size_t *nitemsp); 65 #ifndef _KERNEL 66 int cnvlist_get_descriptor(void *cookiep); 67 const int *cnvlist_get_descriptor_array(void *cookiep, size_t *nitemsp); 68 #endif 69 70 71 /* 72 * The cnvlist_take functions returns value associated with the given cookie and 73 * remove the given entry from the nvlist. 74 * The caller is responsible for freeing received data. 75 */ 76 77 bool cnvlist_take_bool(nvlist_t *nvl, void *cookiep); 78 uint64_t cnvlist_take_number(nvlist_t *nvl, void *cookiep); 79 char *cnvlist_take_string(nvlist_t *nvl, void *cookiep); 80 nvlist_t *cnvlist_take_nvlist(nvlist_t *nvl, void *cookiep); 81 void *cnvlist_take_binary(nvlist_t *nvl, void *cookiep, size_t *sizep); 82 bool *cnvlist_take_bool_array(nvlist_t *nvl, void *cookiep, size_t *nitemsp); 83 uint64_t *cnvlist_take_number_array(nvlist_t *nvl, void *cookiep, size_t *nitemsp); 84 char **cnvlist_take_string_array(nvlist_t *nvl, void *cookiep, size_t *nitemsp); 85 nvlist_t **cnvlist_take_nvlist_array(nvlist_t *nvl, void *cookiep, size_t *nitemsp); 86 #ifndef _KERNEL 87 int cnvlist_take_descriptor(nvlist_t *nvl, void *cookiep); 88 int *cnvlist_take_descriptor_array(nvlist_t *nvl, void *cookiep, size_t *nitemsp); 89 #endif 90 91 /* 92 * The cnvlist_free functions removes the given name/value pair from the nvlist based on cookie 93 * and frees memory associated with it. 94 */ 95 96 void cnvlist_free_bool(nvlist_t *nvl, void *cookiep); 97 void cnvlist_free_number(nvlist_t *nvl, void *cookiep); 98 void cnvlist_free_string(nvlist_t *nvl, void *cookiep); 99 void cnvlist_free_nvlist(nvlist_t *nvl, void *cookiep); 100 void cnvlist_free_binary(nvlist_t *nvl, void *cookiep); 101 void cnvlist_free_bool_array(nvlist_t *nvl, void *cookiep); 102 void cnvlist_free_number_array(nvlist_t *nvl, void *cookiep); 103 void cnvlist_free_string_array(nvlist_t *nvl, void *cookiep); 104 void cnvlist_free_nvlist_array(nvlist_t *nvl, void *cookiep); 105 #ifndef _KERNEL 106 void cnvlist_free_descriptor(nvlist_t *nvl, void *cookiep); 107 void cnvlist_free_descriptor_array(nvlist_t *nvl, void *cookiep); 108 #endif 109 110 __END_DECLS 111 112 #endif /* !_CNV_H_ */ 113