1/*-
2 * Copyright (c) 2009-2013 The FreeBSD Foundation
3 * Copyright (c) 2013-2015 Mariusz Zaborski <oshogbo@FreeBSD.org>
4 * All rights reserved.
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	_NVPAIR_IMPL_H_
34#define	_NVPAIR_IMPL_H_
35
36#include <sys/nv.h>
37#include <sys/queue.h>
38
39#ifndef _KERNEL
40#include <stdint.h>
41#endif
42
43TAILQ_HEAD(nvl_head, nvpair);
44
45void nvpair_assert(const nvpair_t *nvp);
46nvlist_t *nvpair_nvlist(const nvpair_t *nvp);
47nvpair_t *nvpair_next(const nvpair_t *nvp);
48nvpair_t *nvpair_prev(const nvpair_t *nvp);
49void nvpair_insert(struct nvl_head *head, nvpair_t *nvp, nvlist_t *nvl);
50void nvpair_remove(struct nvl_head *head, nvpair_t *nvp, const nvlist_t *nvl);
51size_t nvpair_header_size(void);
52size_t nvpair_size(const nvpair_t *nvp);
53const unsigned char *nvpair_unpack(bool isbe, const unsigned char *ptr,
54    size_t *leftp, nvpair_t **nvpp);
55void nvpair_free_structure(nvpair_t *nvp);
56void nvpair_init_datasize(nvpair_t *nvp);
57const char *nvpair_type_string(int type);
58
59/* Pack functions. */
60unsigned char *nvpair_pack_header(const nvpair_t *nvp, unsigned char *ptr,
61    size_t *leftp);
62unsigned char *nvpair_pack_null(const nvpair_t *nvp, unsigned char *ptr,
63    size_t *leftp);
64unsigned char *nvpair_pack_bool(const nvpair_t *nvp, unsigned char *ptr,
65    size_t *leftp);
66unsigned char *nvpair_pack_number(const nvpair_t *nvp, unsigned char *ptr,
67    size_t *leftp);
68unsigned char *nvpair_pack_string(const nvpair_t *nvp, unsigned char *ptr,
69    size_t *leftp);
70unsigned char *nvpair_pack_descriptor(const nvpair_t *nvp, unsigned char *ptr,
71    int64_t *fdidxp, size_t *leftp);
72unsigned char *nvpair_pack_binary(const nvpair_t *nvp, unsigned char *ptr,
73    size_t *leftp);
74unsigned char *nvpair_pack_nvlist_up(unsigned char *ptr, size_t *leftp);
75unsigned char *nvpair_pack_bool_array(const nvpair_t *nvp, unsigned char *ptr,
76    size_t *leftp);
77unsigned char *nvpair_pack_number_array(const nvpair_t *nvp, unsigned char *ptr,
78    size_t *leftp);
79unsigned char *nvpair_pack_string_array(const nvpair_t *nvp, unsigned char *ptr,
80    size_t *leftp);
81unsigned char *nvpair_pack_descriptor_array(const nvpair_t *nvp,
82    unsigned char *ptr, int64_t *fdidxp, size_t *leftp);
83unsigned char *nvpair_pack_nvlist_array_next(unsigned char *ptr, size_t *leftp);
84
85/* Unpack data functions. */
86const unsigned char *nvpair_unpack_header(bool isbe, nvpair_t *nvp,
87    const unsigned char *ptr, size_t *leftp);
88const unsigned char *nvpair_unpack_null(bool isbe, nvpair_t *nvp,
89    const unsigned char *ptr, size_t *leftp);
90const unsigned char *nvpair_unpack_bool(bool isbe, nvpair_t *nvp,
91    const unsigned char *ptr, size_t *leftp);
92const unsigned char *nvpair_unpack_number(bool isbe, nvpair_t *nvp,
93    const unsigned char *ptr, size_t *leftp);
94const unsigned char *nvpair_unpack_string(bool isbe, nvpair_t *nvp,
95    const unsigned char *ptr, size_t *leftp);
96const unsigned char *nvpair_unpack_nvlist(bool isbe, nvpair_t *nvp,
97    const unsigned char *ptr, size_t *leftp, size_t nfds, nvlist_t **child);
98const unsigned char *nvpair_unpack_descriptor(bool isbe, nvpair_t *nvp,
99    const unsigned char *ptr, size_t *leftp, const int *fds, size_t nfds);
100const unsigned char *nvpair_unpack_binary(bool isbe, nvpair_t *nvp,
101    const unsigned char *ptr, size_t *leftp);
102const unsigned char *nvpair_unpack_bool_array(bool isbe, nvpair_t *nvp,
103    const unsigned char *ptr, size_t *leftp);
104const unsigned char *nvpair_unpack_number_array(bool isbe, nvpair_t *nvp,
105    const unsigned char *ptr, size_t *leftp);
106const unsigned char *nvpair_unpack_string_array(bool isbe, nvpair_t *nvp,
107    const unsigned char *ptr, size_t *leftp);
108const unsigned char *nvpair_unpack_descriptor_array(bool isbe, nvpair_t *nvp,
109    const unsigned char *ptr, size_t *leftp, const int *fds, size_t nfds);
110const unsigned char *nvpair_unpack_nvlist_array(bool isbe, nvpair_t *nvp,
111    const unsigned char *ptr, size_t *leftp, nvlist_t **firstel);
112
113#endif	/* !_NVPAIR_IMPL_H_ */
114