Home | History | Annotate | Line # | Download | only in dist
      1 /*	$NetBSD: nvpair_impl.h,v 1.2 2018/09/08 14:02:15 christos Exp $	*/
      2 
      3 /*-
      4  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
      5  *
      6  * Copyright (c) 2009-2013 The FreeBSD Foundation
      7  * Copyright (c) 2013-2015 Mariusz Zaborski <oshogbo (at) FreeBSD.org>
      8  * All rights reserved.
      9  *
     10  * This software was developed by Pawel Jakub Dawidek under sponsorship from
     11  * the FreeBSD Foundation.
     12  *
     13  * Redistribution and use in source and binary forms, with or without
     14  * modification, are permitted provided that the following conditions
     15  * are met:
     16  * 1. Redistributions of source code must retain the above copyright
     17  *    notice, this list of conditions and the following disclaimer.
     18  * 2. Redistributions in binary form must reproduce the above copyright
     19  *    notice, this list of conditions and the following disclaimer in the
     20  *    documentation and/or other materials provided with the distribution.
     21  *
     22  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
     23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
     26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     32  * SUCH DAMAGE.
     33  *
     34  * $FreeBSD: head/sys/contrib/libnv/nvpair_impl.h 328474 2018-01-27 12:58:21Z oshogbo $
     35  */
     36 
     37 #ifndef	_NVPAIR_IMPL_H_
     38 #define	_NVPAIR_IMPL_H_
     39 
     40 #ifdef __FreeBSD__
     41 #include <sys/nv.h>
     42 #else
     43 #include "nv.h"
     44 #endif
     45 #include <sys/queue.h>
     46 
     47 #if !defined(_KERNEL) && !defined(_STANDALONE)
     48 #include <stdint.h>
     49 #endif
     50 
     51 TAILQ_HEAD(nvl_head, nvpair);
     52 
     53 void nvpair_assert(const nvpair_t *nvp);
     54 nvlist_t *nvpair_nvlist(const nvpair_t *nvp);
     55 nvpair_t *nvpair_next(const nvpair_t *nvp);
     56 nvpair_t *nvpair_prev(const nvpair_t *nvp);
     57 void nvpair_insert(struct nvl_head *head, nvpair_t *nvp, nvlist_t *nvl);
     58 void nvpair_remove(struct nvl_head *head, nvpair_t *nvp, const nvlist_t *nvl);
     59 size_t nvpair_header_size(void);
     60 size_t nvpair_size(const nvpair_t *nvp);
     61 const unsigned char *nvpair_unpack(bool isbe, const unsigned char *ptr,
     62     size_t *leftp, nvpair_t **nvpp);
     63 void nvpair_free_structure(nvpair_t *nvp);
     64 void nvpair_init_datasize(nvpair_t *nvp);
     65 const char *nvpair_type_string(int type);
     66 
     67 /* Pack functions. */
     68 unsigned char *nvpair_pack_header(const nvpair_t *nvp, unsigned char *ptr,
     69     size_t *leftp);
     70 unsigned char *nvpair_pack_null(const nvpair_t *nvp, unsigned char *ptr,
     71     size_t *leftp);
     72 unsigned char *nvpair_pack_bool(const nvpair_t *nvp, unsigned char *ptr,
     73     size_t *leftp);
     74 unsigned char *nvpair_pack_number(const nvpair_t *nvp, unsigned char *ptr,
     75     size_t *leftp);
     76 unsigned char *nvpair_pack_string(const nvpair_t *nvp, unsigned char *ptr,
     77     size_t *leftp);
     78 unsigned char *nvpair_pack_descriptor(const nvpair_t *nvp, unsigned char *ptr,
     79     int64_t *fdidxp, size_t *leftp);
     80 unsigned char *nvpair_pack_binary(const nvpair_t *nvp, unsigned char *ptr,
     81     size_t *leftp);
     82 unsigned char *nvpair_pack_nvlist_up(unsigned char *ptr, size_t *leftp);
     83 unsigned char *nvpair_pack_bool_array(const nvpair_t *nvp, unsigned char *ptr,
     84     size_t *leftp);
     85 unsigned char *nvpair_pack_number_array(const nvpair_t *nvp, unsigned char *ptr,
     86     size_t *leftp);
     87 unsigned char *nvpair_pack_string_array(const nvpair_t *nvp, unsigned char *ptr,
     88     size_t *leftp);
     89 unsigned char *nvpair_pack_descriptor_array(const nvpair_t *nvp,
     90     unsigned char *ptr, int64_t *fdidxp, size_t *leftp);
     91 unsigned char *nvpair_pack_nvlist_array_next(unsigned char *ptr, size_t *leftp);
     92 
     93 /* Unpack data functions. */
     94 const unsigned char *nvpair_unpack_header(bool isbe, nvpair_t *nvp,
     95     const unsigned char *ptr, size_t *leftp);
     96 const unsigned char *nvpair_unpack_null(bool isbe, nvpair_t *nvp,
     97     const unsigned char *ptr, size_t *leftp);
     98 const unsigned char *nvpair_unpack_bool(bool isbe, nvpair_t *nvp,
     99     const unsigned char *ptr, size_t *leftp);
    100 const unsigned char *nvpair_unpack_number(bool isbe, nvpair_t *nvp,
    101     const unsigned char *ptr, size_t *leftp);
    102 const unsigned char *nvpair_unpack_string(bool isbe, nvpair_t *nvp,
    103     const unsigned char *ptr, size_t *leftp);
    104 const unsigned char *nvpair_unpack_nvlist(bool isbe, nvpair_t *nvp,
    105     const unsigned char *ptr, size_t *leftp, size_t nfds, nvlist_t **child);
    106 const unsigned char *nvpair_unpack_descriptor(bool isbe, nvpair_t *nvp,
    107     const unsigned char *ptr, size_t *leftp, const int *fds, size_t nfds);
    108 const unsigned char *nvpair_unpack_binary(bool isbe, nvpair_t *nvp,
    109     const unsigned char *ptr, size_t *leftp);
    110 const unsigned char *nvpair_unpack_bool_array(bool isbe, nvpair_t *nvp,
    111     const unsigned char *ptr, size_t *leftp);
    112 const unsigned char *nvpair_unpack_number_array(bool isbe, nvpair_t *nvp,
    113     const unsigned char *ptr, size_t *leftp);
    114 const unsigned char *nvpair_unpack_string_array(bool isbe, nvpair_t *nvp,
    115     const unsigned char *ptr, size_t *leftp);
    116 const unsigned char *nvpair_unpack_descriptor_array(bool isbe, nvpair_t *nvp,
    117     const unsigned char *ptr, size_t *leftp, const int *fds, size_t nfds);
    118 const unsigned char *nvpair_unpack_nvlist_array(bool isbe, nvpair_t *nvp,
    119     const unsigned char *ptr, size_t *leftp, nvlist_t **firstel);
    120 
    121 #endif	/* !_NVPAIR_IMPL_H_ */
    122