sys/sys/dnv.h

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