Home | History | Annotate | Line # | Download | only in dist
cnv.h revision 1.1 
      1 /*-
      2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
      3  *
      4  * Copyright (c) 2016 Adam Starak <starak.adam (at) 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: head/sys/sys/cnv.h 335343 2018-06-18 21:26:58Z oshogbo $
     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
     45 struct nvlist;
     46 
     47 typedef struct nvlist nvlist_t;
     48 #endif
     49 
     50 __BEGIN_DECLS
     51 
     52 /*
     53  * Functions which returns information about the given cookie.
     54  */
     55 const char	*cnvlist_name(const void *cookie);
     56 int		 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 
     64 bool			 cnvlist_get_bool(const void *cookie);
     65 uint64_t		 cnvlist_get_number(const void *cookie);
     66 const char		*cnvlist_get_string(const void *cookie);
     67 const nvlist_t		*cnvlist_get_nvlist(const void *cookie);
     68 const void		*cnvlist_get_binary(const void *cookie, size_t *sizep);
     69 const bool		*cnvlist_get_bool_array(const void *cookie, size_t *nitemsp);
     70 const uint64_t		*cnvlist_get_number_array(const void *cookie, size_t *nitemsp);
     71 const char * const	*cnvlist_get_string_array(const void *cookie, size_t *nitemsp);
     72 const nvlist_t * const	*cnvlist_get_nvlist_array(const void *cookie, size_t *nitemsp);
     73 #ifndef _KERNEL
     74 int			 cnvlist_get_descriptor(const void *cookie);
     75 const int		*cnvlist_get_descriptor_array(const void *cookie, size_t *nitemsp);
     76 #endif
     77 
     78 
     79 /*
     80  * The cnvlist_take functions returns value associated with the given cookie and
     81  * remove the given entry from the nvlist.
     82  * The caller is responsible for freeing received data.
     83  */
     84 
     85 bool			  cnvlist_take_bool(void *cookie);
     86 uint64_t		  cnvlist_take_number(void *cookie);
     87 char			 *cnvlist_take_string(void *cookie);
     88 nvlist_t		 *cnvlist_take_nvlist(void *cookie);
     89 void			 *cnvlist_take_binary(void *cookie, size_t *sizep);
     90 bool			 *cnvlist_take_bool_array(void *cookie, size_t *nitemsp);
     91 uint64_t		 *cnvlist_take_number_array(void *cookie, size_t *nitemsp);
     92 char			**cnvlist_take_string_array(void *cookie, size_t *nitemsp);
     93 nvlist_t		**cnvlist_take_nvlist_array(void *cookie, size_t *nitemsp);
     94 #ifndef _KERNEL
     95 int			  cnvlist_take_descriptor(void *cookie);
     96 int			 *cnvlist_take_descriptor_array(void *cookie, size_t *nitemsp);
     97 #endif
     98 
     99 /*
    100  * The cnvlist_free functions removes the given name/value pair from the nvlist based on cookie
    101  * and frees memory associated with it.
    102  */
    103 
    104 void	cnvlist_free_bool(void *cookie);
    105 void	cnvlist_free_number(void *cookie);
    106 void	cnvlist_free_string(void *cookie);
    107 void	cnvlist_free_nvlist(void *cookie);
    108 void	cnvlist_free_binary(void *cookie);
    109 void	cnvlist_free_bool_array(void *cookie);
    110 void	cnvlist_free_number_array(void *cookie);
    111 void	cnvlist_free_string_array(void *cookie);
    112 void	cnvlist_free_nvlist_array(void *cookie);
    113 #ifndef _KERNEL
    114 void	cnvlist_free_descriptor(void *cookie);
    115 void	cnvlist_free_descriptor_array(void *cookie);
    116 #endif
    117 
    118 __END_DECLS
    119 
    120 #endif	/* !_CNV_H_ */
    121