1 /*- 2 * Copyright (c) 2009-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 _NVPAIR_IMPL_H_ 33 #define _NVPAIR_IMPL_H_ 34 35 #include <sys/nv.h> 36 #include <sys/queue.h> 37 38 #ifndef _KERNEL 39 #include <stdint.h> 40 #endif 41 42 TAILQ_HEAD(nvl_head, nvpair); 43 44 void nvpair_assert(const nvpair_t *nvp); 45 nvlist_t *nvpair_nvlist(const nvpair_t *nvp); 46 nvpair_t *nvpair_next(const nvpair_t *nvp); 47 nvpair_t *nvpair_prev(const nvpair_t *nvp); 48 void nvpair_insert(struct nvl_head *head, nvpair_t *nvp, nvlist_t *nvl); 49 void nvpair_remove(struct nvl_head *head, nvpair_t *nvp, const nvlist_t *nvl); 50 size_t nvpair_header_size(void); 51 size_t nvpair_size(const nvpair_t *nvp); 52 const unsigned char *nvpair_unpack(bool isbe, const unsigned char *ptr, 53 size_t *leftp, nvpair_t **nvpp); 54 void nvpair_free_structure(nvpair_t *nvp); 55 void nvpair_init_datasize(nvpair_t *nvp); 56 const char *nvpair_type_string(int type); 57 58 /* Pack functions. */ 59 unsigned char *nvpair_pack_header(const nvpair_t *nvp, unsigned char *ptr, 60 size_t *leftp); 61 unsigned char *nvpair_pack_null(const nvpair_t *nvp, unsigned char *ptr, 62 size_t *leftp); 63 unsigned char *nvpair_pack_bool(const nvpair_t *nvp, unsigned char *ptr, 64 size_t *leftp); 65 unsigned char *nvpair_pack_number(const nvpair_t *nvp, unsigned char *ptr, 66 size_t *leftp); 67 unsigned char *nvpair_pack_string(const nvpair_t *nvp, unsigned char *ptr, 68 size_t *leftp); 69 unsigned char *nvpair_pack_descriptor(const nvpair_t *nvp, unsigned char *ptr, 70 int64_t *fdidxp, size_t *leftp); 71 unsigned char *nvpair_pack_binary(const nvpair_t *nvp, unsigned char *ptr, 72 size_t *leftp); 73 unsigned char *nvpair_pack_nvlist_up(unsigned char *ptr, size_t *leftp); 74 75 /* Unpack data functions. */ 76 const unsigned char *nvpair_unpack_header(bool isbe, nvpair_t *nvp, 77 const unsigned char *ptr, size_t *leftp); 78 const unsigned char *nvpair_unpack_null(bool isbe, nvpair_t *nvp, 79 const unsigned char *ptr, size_t *leftp); 80 const unsigned char *nvpair_unpack_bool(bool isbe, nvpair_t *nvp, 81 const unsigned char *ptr, size_t *leftp); 82 const unsigned char *nvpair_unpack_number(bool isbe, nvpair_t *nvp, 83 const unsigned char *ptr, size_t *leftp); 84 const unsigned char *nvpair_unpack_string(bool isbe, nvpair_t *nvp, 85 const unsigned char *ptr, size_t *leftp); 86 const unsigned char *nvpair_unpack_nvlist(bool isbe, nvpair_t *nvp, 87 const unsigned char *ptr, size_t *leftp, size_t nfds, nvlist_t **child); 88 const unsigned char *nvpair_unpack_descriptor(bool isbe, nvpair_t *nvp, 89 const unsigned char *ptr, size_t *leftp, const int *fds, size_t nfds); 90 const unsigned char *nvpair_unpack_binary(bool isbe, nvpair_t *nvp, 91 const unsigned char *ptr, size_t *leftp); 92 93 #endif /* !_NVPAIR_IMPL_H_ */ 94