lib/libnv/nv_impl.h

   1 /*-
   2  * Copyright (c) 2013 The FreeBSD Foundation
   3  * All rights reserved.
   4  *
   5  * This software was developed by Pawel Jakub Dawidek under sponsorship from
   6  * the FreeBSD Foundation.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * $FreeBSD$
  30  */
  31
  32 #ifndef _NV_IMPL_H_
  33 #define _NV_IMPL_H_
  34
  35 #ifndef _NVPAIR_T_DECLARED
  36 #define _NVPAIR_T_DECLARED
  37 struct nvpair;
  38
  39 typedef struct nvpair nvpair_t;
  40 #endif
  41
  42 #define NV_TYPE_NVLIST_UP               255
  43
  44 #define NV_TYPE_FIRST           NV_TYPE_NULL
  45 #define NV_TYPE_LAST            NV_TYPE_BINARY
  46
  47 #define NV_FLAG_BIG_ENDIAN              0x80
  48
  49 int     *nvlist_descriptors(const nvlist_t *nvl, size_t *nitemsp);
  50 size_t   nvlist_ndescriptors(const nvlist_t *nvl);
  51
  52 nvpair_t *nvlist_first_nvpair(const nvlist_t *nvl);
  53 nvpair_t *nvlist_next_nvpair(const nvlist_t *nvl, const nvpair_t *nvp);
  54 nvpair_t *nvlist_prev_nvpair(const nvlist_t *nvl, const nvpair_t *nvp);
  55
  56 void nvlist_add_nvpair(nvlist_t *nvl, const nvpair_t *nvp);
  57
  58 void nvlist_move_nvpair(nvlist_t *nvl, nvpair_t *nvp);
  59
  60 void nvlist_set_parent(nvlist_t *nvl, nvpair_t *parent);
  61
  62 const nvpair_t *nvlist_get_nvpair(const nvlist_t *nvl, const char *name);
  63
  64 nvpair_t *nvlist_take_nvpair(nvlist_t *nvl, const char *name);
  65
  66 /* Function removes the given nvpair from the nvlist. */
  67 void nvlist_remove_nvpair(nvlist_t *nvl, nvpair_t *nvp);
  68
  69 void nvlist_free_nvpair(nvlist_t *nvl, nvpair_t *nvp);
  70
  71 int nvpair_type(const nvpair_t *nvp);
  72 const char *nvpair_name(const nvpair_t *nvp);
  73
  74 nvpair_t *nvpair_clone(const nvpair_t *nvp);
  75
  76 nvpair_t *nvpair_create_null(const char *name);
  77 nvpair_t *nvpair_create_bool(const char *name, bool value);
  78 nvpair_t *nvpair_create_number(const char *name, uint64_t value);
  79 nvpair_t *nvpair_create_string(const char *name, const char *value);
  80 nvpair_t *nvpair_create_stringf(const char *name, const char *valuefmt, ...) __printflike(2, 3);
  81 nvpair_t *nvpair_create_stringv(const char *name, const char *valuefmt, va_list valueap) __printflike(2, 0);
  82 nvpair_t *nvpair_create_nvlist(const char *name, const nvlist_t *value);
  83 nvpair_t *nvpair_create_descriptor(const char *name, int value);
  84 nvpair_t *nvpair_create_binary(const char *name, const void *value, size_t size);
  85
  86 nvpair_t *nvpair_move_string(const char *name, char *value);
  87 nvpair_t *nvpair_move_nvlist(const char *name, nvlist_t *value);
  88 nvpair_t *nvpair_move_descriptor(const char *name, int value);
  89 nvpair_t *nvpair_move_binary(const char *name, void *value, size_t size);
  90
  91 bool             nvpair_get_bool(const nvpair_t *nvp);
  92 uint64_t         nvpair_get_number(const nvpair_t *nvp);
  93 const char      *nvpair_get_string(const nvpair_t *nvp);
  94 const nvlist_t  *nvpair_get_nvlist(const nvpair_t *nvp);
  95 int              nvpair_get_descriptor(const nvpair_t *nvp);
  96 const void      *nvpair_get_binary(const nvpair_t *nvp, size_t *sizep);
  97
  98 void nvpair_free(nvpair_t *nvp);
  99
 100 const nvpair_t *nvlist_getf_nvpair(const nvlist_t *nvl, const char *namefmt, ...) __printflike(2, 3);
 101
 102 const nvpair_t *nvlist_getv_nvpair(const nvlist_t *nvl, const char *namefmt, va_list nameap) __printflike(2, 0);
 103
 104 nvpair_t *nvlist_takef_nvpair(nvlist_t *nvl, const char *namefmt, ...) __printflike(2, 3);
 105
 106 nvpair_t *nvlist_takev_nvpair(nvlist_t *nvl, const char *namefmt, va_list nameap) __printflike(2, 0);
 107
 108 nvpair_t *nvpair_createf_null(const char *namefmt, ...) __printflike(1, 2);
 109 nvpair_t *nvpair_createf_bool(bool value, const char *namefmt, ...) __printflike(2, 3);
 110 nvpair_t *nvpair_createf_number(uint64_t value, const char *namefmt, ...) __printflike(2, 3);
 111 nvpair_t *nvpair_createf_string(const char *value, const char *namefmt, ...) __printflike(2, 3);
 112 nvpair_t *nvpair_createf_nvlist(const nvlist_t *value, const char *namefmt, ...) __printflike(2, 3);
 113 nvpair_t *nvpair_createf_descriptor(int value, const char *namefmt, ...) __printflike(2, 3);
 114 nvpair_t *nvpair_createf_binary(const void *value, size_t size, const char *namefmt, ...) __printflike(3, 4);
 115
 116 nvpair_t *nvpair_createv_null(const char *namefmt, va_list nameap) __printflike(1, 0);
 117 nvpair_t *nvpair_createv_bool(bool value, const char *namefmt, va_list nameap) __printflike(2, 0);
 118 nvpair_t *nvpair_createv_number(uint64_t value, const char *namefmt, va_list nameap) __printflike(2, 0);
 119 nvpair_t *nvpair_createv_string(const char *value, const char *namefmt, va_list nameap) __printflike(2, 0);
 120 nvpair_t *nvpair_createv_nvlist(const nvlist_t *value, const char *namefmt, va_list nameap) __printflike(2, 0);
 121 nvpair_t *nvpair_createv_descriptor(int value, const char *namefmt, va_list nameap) __printflike(2, 0);
 122 nvpair_t *nvpair_createv_binary(const void *value, size_t size, const char *namefmt, va_list nameap) __printflike(3, 0);
 123
 124 nvpair_t *nvpair_movef_string(char *value, const char *namefmt, ...) __printflike(2, 3);
 125 nvpair_t *nvpair_movef_nvlist(nvlist_t *value, const char *namefmt, ...) __printflike(2, 3);
 126 nvpair_t *nvpair_movef_descriptor(int value, const char *namefmt, ...) __printflike(2, 3);
 127 nvpair_t *nvpair_movef_binary(void *value, size_t size, const char *namefmt, ...) __printflike(3, 4);
 128
 129 nvpair_t *nvpair_movev_string(char *value, const char *namefmt, va_list nameap) __printflike(2, 0);
 130 nvpair_t *nvpair_movev_nvlist(nvlist_t *value, const char *namefmt, va_list nameap) __printflike(2, 0);
 131 nvpair_t *nvpair_movev_descriptor(int value, const char *namefmt, va_list nameap) __printflike(2, 0);
 132 nvpair_t *nvpair_movev_binary(void *value, size_t size, const char *namefmt, va_list nameap) __printflike(3, 0);
 133
 134 #endif  /* !_NV_IMPL_H_ */