1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2016 Adam Starak <starak.adam@gmail.com> 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 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. 15 * 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 26 * SUCH DAMAGE. 27 */ 28 29 #ifndef _CNV_H_ 30 #define _CNV_H_ 31 32 #include <sys/cdefs.h> 33 #include <sys/_nv.h> 34 35 #ifndef _KERNEL 36 #include <stdarg.h> 37 #include <stdbool.h> 38 #include <stdint.h> 39 #include <stdio.h> 40 #include <sys/nv_namespace.h> 41 #endif 42 43 __BEGIN_DECLS 44 45 /* 46 * Functions which returns information about the given cookie. 47 */ 48 const char *cnvlist_name(const void *cookie); 49 int cnvlist_type(const void *cookie); 50 51 /* 52 * The cnvlist_get functions returns value associated with the given cookie. 53 * If it returns a pointer, the pointer represents internal buffer and should 54 * not be freed by the caller. 55 */ 56 57 bool cnvlist_get_bool(const void *cookie); 58 uint64_t cnvlist_get_number(const void *cookie); 59 const char *cnvlist_get_string(const void *cookie); 60 const nvlist_t *cnvlist_get_nvlist(const void *cookie); 61 const void *cnvlist_get_binary(const void *cookie, size_t *sizep); 62 const bool *cnvlist_get_bool_array(const void *cookie, size_t *nitemsp); 63 const uint64_t *cnvlist_get_number_array(const void *cookie, size_t *nitemsp); 64 const char * const *cnvlist_get_string_array(const void *cookie, size_t *nitemsp); 65 const nvlist_t * const *cnvlist_get_nvlist_array(const void *cookie, size_t *nitemsp); 66 #ifndef _KERNEL 67 int cnvlist_get_descriptor(const void *cookie); 68 const int *cnvlist_get_descriptor_array(const void *cookie, size_t *nitemsp); 69 #endif 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(void *cookie); 78 uint64_t cnvlist_take_number(void *cookie); 79 char *cnvlist_take_string(void *cookie); 80 nvlist_t *cnvlist_take_nvlist(void *cookie); 81 void *cnvlist_take_binary(void *cookie, size_t *sizep); 82 bool *cnvlist_take_bool_array(void *cookie, size_t *nitemsp); 83 uint64_t *cnvlist_take_number_array(void *cookie, size_t *nitemsp); 84 char **cnvlist_take_string_array(void *cookie, size_t *nitemsp); 85 nvlist_t **cnvlist_take_nvlist_array(void *cookie, size_t *nitemsp); 86 #ifndef _KERNEL 87 int cnvlist_take_descriptor(void *cookie); 88 int *cnvlist_take_descriptor_array(void *cookie, 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(void *cookie); 97 void cnvlist_free_number(void *cookie); 98 void cnvlist_free_string(void *cookie); 99 void cnvlist_free_nvlist(void *cookie); 100 void cnvlist_free_binary(void *cookie); 101 void cnvlist_free_bool_array(void *cookie); 102 void cnvlist_free_number_array(void *cookie); 103 void cnvlist_free_string_array(void *cookie); 104 void cnvlist_free_nvlist_array(void *cookie); 105 #ifndef _KERNEL 106 void cnvlist_free_descriptor(void *cookie); 107 void cnvlist_free_descriptor_array(void *cookie); 108 #endif 109 110 __END_DECLS 111 112 #endif /* !_CNV_H_ */ 113