sys/sys/cnv.h

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