sys/sys/dnv.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause
   3  *
   4  * Copyright (c) 2013 The FreeBSD Foundation
   5  *
   6  * This software was developed by Pawel Jakub Dawidek under sponsorship from
   7  * the FreeBSD Foundation.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  */
  30
  31 #ifndef _DNV_H_
  32 #define _DNV_H_
  33
  34 #include <sys/cdefs.h>
  35
  36 #ifndef _KERNEL
  37 #include <stdarg.h>
  38 #include <stdbool.h>
  39 #include <stddef.h>
  40 #include <stdint.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  * The dnvlist_get functions returns value associated with the given name.
  54  * If it returns a pointer, the pointer represents internal buffer and should
  55  * not be freed by the caller.
  56  * If no element of the given name and type exists, the function will return
  57  * provided default value.
  58  */
  59
  60 bool dnvlist_get_bool(const nvlist_t *nvl, const char *name, bool defval);
  61 uint64_t dnvlist_get_number(const nvlist_t *nvl, const char *name, uint64_t defval);
  62 const char *dnvlist_get_string(const nvlist_t *nvl, const char *name, const char *defval);
  63 const nvlist_t *dnvlist_get_nvlist(const nvlist_t *nvl, const char *name, const nvlist_t *defval);
  64 int dnvlist_get_descriptor(const nvlist_t *nvl, const char *name, int defval);
  65 const void *dnvlist_get_binary(const nvlist_t *nvl, const char *name, size_t *sizep, const void *defval, size_t defsize);
  66
  67 /*
  68  * The dnvlist_take functions returns value associated with the given name and
  69  * remove corresponding nvpair.
  70  * If it returns a pointer, the caller has to free it.
  71  * If no element of the given name and type exists, the function will return
  72  * provided default value.
  73  */
  74
  75 bool dnvlist_take_bool(nvlist_t *nvl, const char *name, bool defval);
  76 uint64_t dnvlist_take_number(nvlist_t *nvl, const char *name, uint64_t defval);
  77 char *dnvlist_take_string(nvlist_t *nvl, const char *name, char *defval);
  78 nvlist_t *dnvlist_take_nvlist(nvlist_t *nvl, const char *name, nvlist_t *defval);
  79 int dnvlist_take_descriptor(nvlist_t *nvl, const char *name, int defval);
  80 void *dnvlist_take_binary(nvlist_t *nvl, const char *name, size_t *sizep, void *defval, size_t defsize);
  81
  82 __END_DECLS
  83
  84 #endif  /* !_DNV_H_ */