FreeBSD/Linux Kernel Cross Reference
sys/sys/dnv.h
1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
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 * $FreeBSD$
31 */
32
33 #ifndef _DNV_H_
34 #define _DNV_H_
35
36 #include <sys/cdefs.h>
37
38 #ifndef _KERNEL
39 #include <stdarg.h>
40 #include <stdbool.h>
41 #include <stddef.h>
42 #include <stdint.h>
43 #include <sys/nv_namespace.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_ */
Cache object: 744d7df3dc8315aad5ee3d8216e6d060
|