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