Add cnv API.

cnv API is a set of functions for managing name/value pairs by cookie.
The cookie can be obtained by nvlist_next(), nvlist_get_parent() or
nvlist_get_pararr() function. This patch also includes unit tests.

Submitted by:	Adam Starak <starak.adam@gmail.com>
This commit is contained in:
Mariusz Zaborski 2016-08-27 13:37:30 +00:00
parent acbeb22d01
commit 5ef231f6f7
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=304908
7 changed files with 1708 additions and 2 deletions

View File

@ -11,7 +11,8 @@ SHLIB_MAJOR= 0
.PATH: ${.CURDIR}/../../sys/contrib/libnv ${.CURDIR}/../../sys/sys
CFLAGS+=-I${.CURDIR}/../../sys -I${.CURDIR}
SRCS= dnvlist.c
SRCS= cnvlist.c
SRCS+= dnvlist.c
SRCS+= msgio.c
SRCS+= nvlist.c
SRCS+= nvpair.c

View File

@ -1,6 +1,7 @@
# $FreeBSD$
ATF_TESTS_CXX= \
cnv_tests\
dnv_tests \
nv_array_tests \
nv_tests \

1509
lib/libnv/tests/cnv_tests.cc Normal file

File diff suppressed because it is too large Load Diff

View File

@ -526,6 +526,7 @@ contrib/libfdt/fdt_rw.c optional fdt
contrib/libfdt/fdt_strerror.c optional fdt
contrib/libfdt/fdt_sw.c optional fdt
contrib/libfdt/fdt_wip.c optional fdt
contrib/libnv/cnvlist.c standard
contrib/libnv/dnvlist.c standard
contrib/libnv/nvlist.c standard
contrib/libnv/nvpair.c standard

193
sys/contrib/libnv/cnvlist.c Normal file
View File

@ -0,0 +1,193 @@
/*-
* Copyright (c) 2016 Adam Starak <starak.adam@gmail.com>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* $FreeBSD$
*/
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
#ifdef _KERNEL
#include <sys/types.h>
#include <sys/param.h>
#include <sys/kernel.h>
#include <sys/systm.h>
#include <sys/malloc.h>
#include <machine/stdarg.h>
#else
#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
#endif
#include <sys/cnv.h>
#include <sys/nv.h>
#include "nv_impl.h"
#include "nvlist_impl.h"
#include "nvpair_impl.h"
#define CNVLIST_GET(ftype, type, nvtype) \
ftype \
cnvlist_get_##type(void *cookiep) \
{ \
\
if (nvpair_type(cookiep) != NV_TYPE_##nvtype) \
nvlist_report_missing(NV_TYPE_##nvtype, \
nvpair_name(cookiep)); \
return (nvpair_get_##type(cookiep)); \
}
CNVLIST_GET(bool, bool, BOOL)
CNVLIST_GET(uint64_t, number, NUMBER)
CNVLIST_GET(const char *, string, STRING)
CNVLIST_GET(const nvlist_t *, nvlist, NVLIST)
#ifndef _KERNEL
CNVLIST_GET(int, descriptor, DESCRIPTOR)
#endif
#undef CNVLIST_GET
#define CNVLIST_GET_ARRAY(ftype, type, nvtype) \
ftype \
cnvlist_get_##type(void *cookiep, size_t *nitemsp) \
{ \
\
if (nvpair_type(cookiep) != NV_TYPE_##nvtype) \
nvlist_report_missing(NV_TYPE_##nvtype, \
nvpair_name(cookiep)); \
return (nvpair_get_##type(cookiep, nitemsp)); \
}
CNVLIST_GET_ARRAY(const bool *, bool_array, BOOL_ARRAY)
CNVLIST_GET_ARRAY(const uint64_t *, number_array, NUMBER_ARRAY)
CNVLIST_GET_ARRAY(const char * const *, string_array, STRING_ARRAY)
CNVLIST_GET_ARRAY(const nvlist_t * const *, nvlist_array, NVLIST_ARRAY)
#ifndef _KERNEL
CNVLIST_GET_ARRAY(const int *, descriptor_array, DESCRIPTOR_ARRAY)
#endif
#undef CNVLIST_GET_ARRAY
const void *
cnvlist_get_binary(void *cookiep, size_t *sizep)
{
if (nvpair_type(cookiep) != NV_TYPE_BINARY)
nvlist_report_missing(NV_TYPE_BINARY, nvpair_name(cookiep));
return (nvpair_get_binary(cookiep, sizep));
}
#define CNVLIST_TAKE(ftype, type, nvtype) \
ftype \
cnvlist_take_##type(nvlist_t *nvl, void *cookiep) \
{ \
ftype value; \
\
if (nvpair_type(cookiep) != NV_TYPE_##nvtype) \
nvlist_report_missing(NV_TYPE_##nvtype, \
nvpair_name(cookiep)); \
value = (ftype)(intptr_t)nvpair_get_##type(cookiep); \
nvlist_remove_nvpair(nvl, cookiep); \
nvpair_free_structure(cookiep); \
return (value); \
}
CNVLIST_TAKE(bool, bool, BOOL)
CNVLIST_TAKE(uint64_t, number, NUMBER)
CNVLIST_TAKE(char *, string, STRING)
CNVLIST_TAKE(nvlist_t *, nvlist, NVLIST)
#ifndef _KERNEL
CNVLIST_TAKE(int, descriptor, DESCRIPTOR)
#endif
#undef CNVLIST_TAKE
#define CNVLIST_TAKE_ARRAY(ftype, type, nvtype) \
ftype \
cnvlist_take_##type(nvlist_t *nvl, void *cookiep, size_t *nitemsp) \
{ \
ftype value; \
\
if (nvpair_type(cookiep) != NV_TYPE_##nvtype) \
nvlist_report_missing(NV_TYPE_##nvtype, \
nvpair_name(cookiep)); \
value = (ftype)(intptr_t)nvpair_get_##type(cookiep, nitemsp); \
nvlist_remove_nvpair(nvl, cookiep); \
nvpair_free_structure(cookiep); \
return (value); \
}
CNVLIST_TAKE_ARRAY(bool *, bool_array, BOOL_ARRAY)
CNVLIST_TAKE_ARRAY(uint64_t *, number_array, NUMBER_ARRAY)
CNVLIST_TAKE_ARRAY(char **, string_array, STRING_ARRAY)
CNVLIST_TAKE_ARRAY(nvlist_t **, nvlist_array, NVLIST_ARRAY)
#ifndef _KERNEL
CNVLIST_TAKE_ARRAY(int *, descriptor_array, DESCRIPTOR_ARRAY);
#endif
#undef CNVLIST_TAKE_ARRAY
void *
cnvlist_take_binary(nvlist_t *nvl, void *cookiep, size_t *sizep)
{
void * value;
if (nvpair_type(cookiep) != NV_TYPE_BINARY)
nvlist_report_missing(NV_TYPE_BINARY, nvpair_name(cookiep));
value = (void *)(intptr_t)nvpair_get_binary(cookiep, sizep);
nvlist_remove_nvpair(nvl, cookiep);
nvpair_free_structure(cookiep);
return (value);
}
#define CNVLIST_FREE(type, nvtype) \
void \
cnvlist_free_##type(nvlist_t *nvl, void *cookiep) \
{ \
\
nvlist_free_nvpair(nvl, cookiep); \
}
CNVLIST_FREE(bool, BOOL)
CNVLIST_FREE(number, NUMBER)
CNVLIST_FREE(string, STRING)
CNVLIST_FREE(nvlist, NVLIST)
CNVLIST_FREE(binary, BINARY);
CNVLIST_FREE(bool_array, BOOL_ARRAY)
CNVLIST_FREE(number_array, NUMBER_ARRAY)
CNVLIST_FREE(string_array, STRING_ARRAY)
CNVLIST_FREE(nvlist_array, NVLIST_ARRAY)
#ifndef _KERNEL
CNVLIST_FREE(descriptor, DESCRIPTOR)
CNVLIST_FREE(descriptor_array, DESCRIPTOR_ARRAY)
#endif
#undef CNVLIST_FREE

View File

@ -314,7 +314,7 @@ nvlist_set_flags(nvlist_t *nvl, int flags)
nvl->nvl_flags = flags;
}
static void
void
nvlist_report_missing(int type, const char *name)
{

View File

@ -39,6 +39,7 @@
#include <stdint.h>
#endif
void nvlist_report_missing(int type, const char *name);
nvpair_t *nvlist_get_nvpair_parent(const nvlist_t *nvl);
const unsigned char *nvlist_unpack_header(nvlist_t *nvl,
const unsigned char *ptr, size_t nfds, bool *isbep, size_t *leftp);