1/*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 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 * $FreeBSD$ 29 */ 30 31#ifndef _CNV_H_ 32#define _CNV_H_ 33 34#include <sys/cdefs.h> 35 36#ifndef _KERNEL 37#include <stdarg.h> 38#include <stdbool.h> 39#include <stdint.h> 40#include <stdio.h> 41#endif 42 43#ifndef _NVLIST_T_DECLARED 44#define _NVLIST_T_DECLARED 45struct nvlist; 46 47typedef struct nvlist nvlist_t; 48#endif 49 50__BEGIN_DECLS 51 52/* 53 * Functions which returns information about the given cookie. 54 */ 55const char *cnvlist_name(const void *cookie); 56int cnvlist_type(const void *cookie); 57 58/* 59 * The cnvlist_get functions returns value associated with the given cookie. 60 * If it returns a pointer, the pointer represents internal buffer and should 61 * not be freed by the caller. 62 */ 63 64bool cnvlist_get_bool(const void *cookie); 65uint64_t cnvlist_get_number(const void *cookie); 66const char *cnvlist_get_string(const void *cookie); 67const nvlist_t *cnvlist_get_nvlist(const void *cookie); 68const void *cnvlist_get_binary(const void *cookie, size_t *sizep); 69const bool *cnvlist_get_bool_array(const void *cookie, size_t *nitemsp); 70const uint64_t *cnvlist_get_number_array(const void *cookie, size_t *nitemsp); 71const char * const *cnvlist_get_string_array(const void *cookie, size_t *nitemsp); 72const nvlist_t * const *cnvlist_get_nvlist_array(const void *cookie, size_t *nitemsp); 73#ifndef _KERNEL 74int cnvlist_get_descriptor(const void *cookie); 75const int *cnvlist_get_descriptor_array(const void *cookie, size_t *nitemsp); 76#endif 77 78/* 79 * The cnvlist_take functions returns value associated with the given cookie and 80 * remove the given entry from the nvlist. 81 * The caller is responsible for freeing received data. 82 */ 83 84bool cnvlist_take_bool(void *cookie); 85uint64_t cnvlist_take_number(void *cookie); 86char *cnvlist_take_string(void *cookie); 87nvlist_t *cnvlist_take_nvlist(void *cookie); 88void *cnvlist_take_binary(void *cookie, size_t *sizep); 89bool *cnvlist_take_bool_array(void *cookie, size_t *nitemsp); 90uint64_t *cnvlist_take_number_array(void *cookie, size_t *nitemsp); 91char **cnvlist_take_string_array(void *cookie, size_t *nitemsp); 92nvlist_t **cnvlist_take_nvlist_array(void *cookie, size_t *nitemsp); 93#ifndef _KERNEL 94int cnvlist_take_descriptor(void *cookie); 95int *cnvlist_take_descriptor_array(void *cookie, size_t *nitemsp); 96#endif 97 98/* 99 * The cnvlist_free functions removes the given name/value pair from the nvlist based on cookie 100 * and frees memory associated with it. 101 */ 102 103void cnvlist_free_bool(void *cookie); 104void cnvlist_free_number(void *cookie); 105void cnvlist_free_string(void *cookie); 106void cnvlist_free_nvlist(void *cookie); 107void cnvlist_free_binary(void *cookie); 108void cnvlist_free_bool_array(void *cookie); 109void cnvlist_free_number_array(void *cookie); 110void cnvlist_free_string_array(void *cookie); 111void cnvlist_free_nvlist_array(void *cookie); 112#ifndef _KERNEL 113void cnvlist_free_descriptor(void *cookie); 114void cnvlist_free_descriptor_array(void *cookie); 115#endif 116 117__END_DECLS 118 119#endif /* !_CNV_H_ */ 120