sys/sys/dnv.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 _DNV_H_
  33 #define _DNV_H_
  34
  35 #include <sys/cdefs.h>
  36
  37 #ifndef _KERNEL
  38 #include <stdarg.h>
  39 #include <stdbool.h>
  40 #include <stddef.h>
  41 #include <stdint.h>
  42 #endif
  43
  44 #ifndef _NVLIST_T_DECLARED
  45 #define _NVLIST_T_DECLARED
  46 struct nvlist;
  47
  48 typedef struct nvlist nvlist_t;
  49 #endif
  50
  51 __BEGIN_DECLS
  52
  53 /*
  54  * The dnvlist_get functions returns value associated with the given name.
  55  * If it returns a pointer, the pointer represents internal buffer and should
  56  * not be freed by the caller.
  57  * If no element of the given name and type exists, the function will return
  58  * provided default value.
  59  */
  60
  61 bool dnvlist_get_bool(const nvlist_t *nvl, const char *name, bool defval);
  62 uint64_t dnvlist_get_number(const nvlist_t *nvl, const char *name, uint64_t defval);
  63 const char *dnvlist_get_string(const nvlist_t *nvl, const char *name, const char *defval);
  64 const nvlist_t *dnvlist_get_nvlist(const nvlist_t *nvl, const char *name, const nvlist_t *defval);
  65 int dnvlist_get_descriptor(const nvlist_t *nvl, const char *name, int defval);
  66 const void *dnvlist_get_binary(const nvlist_t *nvl, const char *name, size_t *sizep, const void *defval, size_t defsize);
  67
  68 /*
  69  * The dnvlist_take functions returns value associated with the given name and
  70  * remove corresponding nvpair.
  71  * If it returns a pointer, the caller has to free it.
  72  * If no element of the given name and type exists, the function will return
  73  * provided default value.
  74  */
  75
  76 bool dnvlist_take_bool(nvlist_t *nvl, const char *name, bool defval);
  77 uint64_t dnvlist_take_number(nvlist_t *nvl, const char *name, uint64_t defval);
  78 char *dnvlist_take_string(nvlist_t *nvl, const char *name, char *defval);
  79 nvlist_t *dnvlist_take_nvlist(nvlist_t *nvl, const char *name, nvlist_t *defval);
  80 int dnvlist_take_descriptor(nvlist_t *nvl, const char *name, int defval);
  81 void *dnvlist_take_binary(nvlist_t *nvl, const char *name, size_t *sizep, void *defval, size_t defsize);
  82
  83 __END_DECLS
  84
  85 #endif  /* !_DNV_H_ */