[mirror_zfs-debian.git] / include / sys / nvpair.h

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright (c) 2000, 2010, Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2012 by Delphix. All rights reserved.
 */

#ifndef	_SYS_NVPAIR_H
#define	_SYS_NVPAIR_H

#include <sys/types.h>
#include <sys/time.h>
#include <sys/errno.h>
#include <sys/va_list.h>

#if defined(_KERNEL) && !defined(_BOOT)
#include <sys/kmem.h>
#endif

#ifdef	__cplusplus
extern "C" {
#endif

typedef enum {
	DATA_TYPE_UNKNOWN = 0,
	DATA_TYPE_BOOLEAN,
	DATA_TYPE_BYTE,
	DATA_TYPE_INT16,
	DATA_TYPE_UINT16,
	DATA_TYPE_INT32,
	DATA_TYPE_UINT32,
	DATA_TYPE_INT64,
	DATA_TYPE_UINT64,
	DATA_TYPE_STRING,
	DATA_TYPE_BYTE_ARRAY,
	DATA_TYPE_INT16_ARRAY,
	DATA_TYPE_UINT16_ARRAY,
	DATA_TYPE_INT32_ARRAY,
	DATA_TYPE_UINT32_ARRAY,
	DATA_TYPE_INT64_ARRAY,
	DATA_TYPE_UINT64_ARRAY,
	DATA_TYPE_STRING_ARRAY,
	DATA_TYPE_HRTIME,
	DATA_TYPE_NVLIST,
	DATA_TYPE_NVLIST_ARRAY,
	DATA_TYPE_BOOLEAN_VALUE,
	DATA_TYPE_INT8,
	DATA_TYPE_UINT8,
	DATA_TYPE_BOOLEAN_ARRAY,
	DATA_TYPE_INT8_ARRAY,
#if !defined(_KERNEL)
	DATA_TYPE_UINT8_ARRAY,
	DATA_TYPE_DOUBLE
#else
	DATA_TYPE_UINT8_ARRAY
#endif
} data_type_t;

typedef struct nvpair {
	int32_t nvp_size;	/* size of this nvpair */
	int16_t	nvp_name_sz;	/* length of name string */
	int16_t	nvp_reserve;	/* not used */
	int32_t	nvp_value_elem;	/* number of elements for array types */
	data_type_t nvp_type;	/* type of value */
	/* name string */
	/* aligned ptr array for string arrays */
	/* aligned array of data for value */
} nvpair_t;

/* nvlist header */
typedef struct nvlist {
	int32_t		nvl_version;
	uint32_t	nvl_nvflag;	/* persistent flags */
	uint64_t	nvl_priv;	/* ptr to private data if not packed */
	uint32_t	nvl_flag;
	int32_t		nvl_pad;	/* currently not used, for alignment */
} nvlist_t;

/* nvp implementation version */
#define	NV_VERSION	0

/* nvlist pack encoding */
#define	NV_ENCODE_NATIVE	0
#define	NV_ENCODE_XDR		1

/* nvlist persistent unique name flags, stored in nvl_nvflags */
#define	NV_UNIQUE_NAME		0x1
#define	NV_UNIQUE_NAME_TYPE	0x2

/* nvlist lookup pairs related flags */
#define	NV_FLAG_NOENTOK		0x1

/* convenience macros */
#define	NV_ALIGN(x)		(((ulong_t)(x) + 7ul) & ~7ul)
#define	NV_ALIGN4(x)		(((x) + 3) & ~3)

#define	NVP_SIZE(nvp)		((nvp)->nvp_size)
#define	NVP_NAME(nvp)		((char *)(nvp) + sizeof (nvpair_t))
#define	NVP_TYPE(nvp)		((nvp)->nvp_type)
#define	NVP_NELEM(nvp)		((nvp)->nvp_value_elem)
#define	NVP_VALUE(nvp)		((char *)(nvp) + NV_ALIGN(sizeof (nvpair_t) \
				+ (nvp)->nvp_name_sz))

#define	NVL_VERSION(nvl)	((nvl)->nvl_version)
#define	NVL_SIZE(nvl)		((nvl)->nvl_size)
#define	NVL_FLAG(nvl)		((nvl)->nvl_flag)

/* NV allocator framework */
typedef struct nv_alloc_ops nv_alloc_ops_t;

typedef struct nv_alloc {
	const nv_alloc_ops_t *nva_ops;
	void *nva_arg;
} nv_alloc_t;

struct nv_alloc_ops {
	int (*nv_ao_init)(nv_alloc_t *, __va_list);
	void (*nv_ao_fini)(nv_alloc_t *);
	void *(*nv_ao_alloc)(nv_alloc_t *, size_t);
	void (*nv_ao_free)(nv_alloc_t *, void *, size_t);
	void (*nv_ao_reset)(nv_alloc_t *);
};

extern const nv_alloc_ops_t *nv_fixed_ops;
extern nv_alloc_t *nv_alloc_nosleep;

#if defined(_KERNEL) && !defined(_BOOT)
extern nv_alloc_t *nv_alloc_sleep;
#endif

int nv_alloc_init(nv_alloc_t *, const nv_alloc_ops_t *, /* args */ ...);
void nv_alloc_reset(nv_alloc_t *);
void nv_alloc_fini(nv_alloc_t *);

/* list management */
int nvlist_alloc(nvlist_t **, uint_t, int);
void nvlist_free(nvlist_t *);
int nvlist_size(nvlist_t *, size_t *, int);
int nvlist_pack(nvlist_t *, char **, size_t *, int, int);
int nvlist_unpack(char *, size_t, nvlist_t **, int);
int nvlist_dup(nvlist_t *, nvlist_t **, int);
int nvlist_merge(nvlist_t *, nvlist_t *, int);

uint_t nvlist_nvflag(nvlist_t *);

int nvlist_xalloc(nvlist_t **, uint_t, nv_alloc_t *);
int nvlist_xpack(nvlist_t *, char **, size_t *, int, nv_alloc_t *);
int nvlist_xunpack(char *, size_t, nvlist_t **, nv_alloc_t *);
int nvlist_xdup(nvlist_t *, nvlist_t **, nv_alloc_t *);
nv_alloc_t *nvlist_lookup_nv_alloc(nvlist_t *);

int nvlist_add_nvpair(nvlist_t *, nvpair_t *);
int nvlist_add_boolean(nvlist_t *, const char *);
int nvlist_add_boolean_value(nvlist_t *, const char *, boolean_t);
int nvlist_add_byte(nvlist_t *, const char *, uchar_t);
int nvlist_add_int8(nvlist_t *, const char *, int8_t);
int nvlist_add_uint8(nvlist_t *, const char *, uint8_t);
int nvlist_add_int16(nvlist_t *, const char *, int16_t);
int nvlist_add_uint16(nvlist_t *, const char *, uint16_t);
int nvlist_add_int32(nvlist_t *, const char *, int32_t);
int nvlist_add_uint32(nvlist_t *, const char *, uint32_t);
int nvlist_add_int64(nvlist_t *, const char *, int64_t);
int nvlist_add_uint64(nvlist_t *, const char *, uint64_t);
int nvlist_add_string(nvlist_t *, const char *, const char *);
int nvlist_add_nvlist(nvlist_t *, const char *, nvlist_t *);
int nvlist_add_boolean_array(nvlist_t *, const char *, boolean_t *, uint_t);
int nvlist_add_byte_array(nvlist_t *, const char *, uchar_t *, uint_t);
int nvlist_add_int8_array(nvlist_t *, const char *, int8_t *, uint_t);
int nvlist_add_uint8_array(nvlist_t *, const char *, uint8_t *, uint_t);
int nvlist_add_int16_array(nvlist_t *, const char *, int16_t *, uint_t);
int nvlist_add_uint16_array(nvlist_t *, const char *, uint16_t *, uint_t);
int nvlist_add_int32_array(nvlist_t *, const char *, int32_t *, uint_t);
int nvlist_add_uint32_array(nvlist_t *, const char *, uint32_t *, uint_t);
int nvlist_add_int64_array(nvlist_t *, const char *, int64_t *, uint_t);
int nvlist_add_uint64_array(nvlist_t *, const char *, uint64_t *, uint_t);
int nvlist_add_string_array(nvlist_t *, const char *, char *const *, uint_t);
int nvlist_add_nvlist_array(nvlist_t *, const char *, nvlist_t **, uint_t);
int nvlist_add_hrtime(nvlist_t *, const char *, hrtime_t);
#if !defined(_KERNEL)
int nvlist_add_double(nvlist_t *, const char *, double);
#endif

int nvlist_remove(nvlist_t *, const char *, data_type_t);
int nvlist_remove_all(nvlist_t *, const char *);
int nvlist_remove_nvpair(nvlist_t *, nvpair_t *);

int nvlist_lookup_boolean(nvlist_t *, const char *);
int nvlist_lookup_boolean_value(nvlist_t *, const char *, boolean_t *);
int nvlist_lookup_byte(nvlist_t *, const char *, uchar_t *);
int nvlist_lookup_int8(nvlist_t *, const char *, int8_t *);
int nvlist_lookup_uint8(nvlist_t *, const char *, uint8_t *);
int nvlist_lookup_int16(nvlist_t *, const char *, int16_t *);
int nvlist_lookup_uint16(nvlist_t *, const char *, uint16_t *);
int nvlist_lookup_int32(nvlist_t *, const char *, int32_t *);
int nvlist_lookup_uint32(nvlist_t *, const char *, uint32_t *);
int nvlist_lookup_int64(nvlist_t *, const char *, int64_t *);
int nvlist_lookup_uint64(nvlist_t *, const char *, uint64_t *);
int nvlist_lookup_string(nvlist_t *, const char *, char **);
int nvlist_lookup_nvlist(nvlist_t *, const char *, nvlist_t **);
int nvlist_lookup_boolean_array(nvlist_t *, const char *,
    boolean_t **, uint_t *);
int nvlist_lookup_byte_array(nvlist_t *, const char *, uchar_t **, uint_t *);
int nvlist_lookup_int8_array(nvlist_t *, const char *, int8_t **, uint_t *);
int nvlist_lookup_uint8_array(nvlist_t *, const char *, uint8_t **, uint_t *);
int nvlist_lookup_int16_array(nvlist_t *, const char *, int16_t **, uint_t *);
int nvlist_lookup_uint16_array(nvlist_t *, const char *, uint16_t **, uint_t *);
int nvlist_lookup_int32_array(nvlist_t *, const char *, int32_t **, uint_t *);
int nvlist_lookup_uint32_array(nvlist_t *, const char *, uint32_t **, uint_t *);
int nvlist_lookup_int64_array(nvlist_t *, const char *, int64_t **, uint_t *);
int nvlist_lookup_uint64_array(nvlist_t *, const char *, uint64_t **, uint_t *);
int nvlist_lookup_string_array(nvlist_t *, const char *, char ***, uint_t *);
int nvlist_lookup_nvlist_array(nvlist_t *, const char *,
    nvlist_t ***, uint_t *);
int nvlist_lookup_hrtime(nvlist_t *, const char *, hrtime_t *);
int nvlist_lookup_pairs(nvlist_t *, int, ...);
#if !defined(_KERNEL)
int nvlist_lookup_double(nvlist_t *, const char *, double *);
#endif

int nvlist_lookup_nvpair(nvlist_t *, const char *, nvpair_t **);
int nvlist_lookup_nvpair_embedded_index(nvlist_t *, const char *, nvpair_t **,
    int *, char **);
boolean_t nvlist_exists(nvlist_t *, const char *);
boolean_t nvlist_empty(nvlist_t *);

/* processing nvpair */
nvpair_t *nvlist_next_nvpair(nvlist_t *, nvpair_t *);
nvpair_t *nvlist_prev_nvpair(nvlist_t *, nvpair_t *);
char *nvpair_name(nvpair_t *);
data_type_t nvpair_type(nvpair_t *);
int nvpair_type_is_array(nvpair_t *);
int nvpair_value_boolean_value(nvpair_t *, boolean_t *);
int nvpair_value_byte(nvpair_t *, uchar_t *);
int nvpair_value_int8(nvpair_t *, int8_t *);
int nvpair_value_uint8(nvpair_t *, uint8_t *);
int nvpair_value_int16(nvpair_t *, int16_t *);
int nvpair_value_uint16(nvpair_t *, uint16_t *);
int nvpair_value_int32(nvpair_t *, int32_t *);
int nvpair_value_uint32(nvpair_t *, uint32_t *);
int nvpair_value_int64(nvpair_t *, int64_t *);
int nvpair_value_uint64(nvpair_t *, uint64_t *);
int nvpair_value_string(nvpair_t *, char **);
int nvpair_value_nvlist(nvpair_t *, nvlist_t **);
int nvpair_value_boolean_array(nvpair_t *, boolean_t **, uint_t *);
int nvpair_value_byte_array(nvpair_t *, uchar_t **, uint_t *);
int nvpair_value_int8_array(nvpair_t *, int8_t **, uint_t *);
int nvpair_value_uint8_array(nvpair_t *, uint8_t **, uint_t *);
int nvpair_value_int16_array(nvpair_t *, int16_t **, uint_t *);
int nvpair_value_uint16_array(nvpair_t *, uint16_t **, uint_t *);
int nvpair_value_int32_array(nvpair_t *, int32_t **, uint_t *);
int nvpair_value_uint32_array(nvpair_t *, uint32_t **, uint_t *);
int nvpair_value_int64_array(nvpair_t *, int64_t **, uint_t *);
int nvpair_value_uint64_array(nvpair_t *, uint64_t **, uint_t *);
int nvpair_value_string_array(nvpair_t *, char ***, uint_t *);
int nvpair_value_nvlist_array(nvpair_t *, nvlist_t ***, uint_t *);
int nvpair_value_hrtime(nvpair_t *, hrtime_t *);
#if !defined(_KERNEL)
int nvpair_value_double(nvpair_t *, double *);
#endif

nvlist_t *fnvlist_alloc(void);
void fnvlist_free(nvlist_t *);
size_t fnvlist_size(nvlist_t *);
char *fnvlist_pack(nvlist_t *, size_t *);
void fnvlist_pack_free(char *, size_t);
nvlist_t *fnvlist_unpack(char *, size_t);
nvlist_t *fnvlist_dup(nvlist_t *);
void fnvlist_merge(nvlist_t *, nvlist_t *);

void fnvlist_add_boolean(nvlist_t *, const char *);
void fnvlist_add_boolean_value(nvlist_t *, const char *, boolean_t);
void fnvlist_add_byte(nvlist_t *, const char *, uchar_t);
void fnvlist_add_int8(nvlist_t *, const char *, int8_t);
void fnvlist_add_uint8(nvlist_t *, const char *, uint8_t);
void fnvlist_add_int16(nvlist_t *, const char *, int16_t);
void fnvlist_add_uint16(nvlist_t *, const char *, uint16_t);
void fnvlist_add_int32(nvlist_t *, const char *, int32_t);
void fnvlist_add_uint32(nvlist_t *, const char *, uint32_t);
void fnvlist_add_int64(nvlist_t *, const char *, int64_t);
void fnvlist_add_uint64(nvlist_t *, const char *, uint64_t);
void fnvlist_add_string(nvlist_t *, const char *, const char *);
void fnvlist_add_nvlist(nvlist_t *, const char *, nvlist_t *);
void fnvlist_add_nvpair(nvlist_t *, nvpair_t *);
void fnvlist_add_boolean_array(nvlist_t *, const char *, boolean_t *, uint_t);
void fnvlist_add_byte_array(nvlist_t *, const char *, uchar_t *, uint_t);
void fnvlist_add_int8_array(nvlist_t *, const char *, int8_t *, uint_t);
void fnvlist_add_uint8_array(nvlist_t *, const char *, uint8_t *, uint_t);
void fnvlist_add_int16_array(nvlist_t *, const char *, int16_t *, uint_t);
void fnvlist_add_uint16_array(nvlist_t *, const char *, uint16_t *, uint_t);
void fnvlist_add_int32_array(nvlist_t *, const char *, int32_t *, uint_t);
void fnvlist_add_uint32_array(nvlist_t *, const char *, uint32_t *, uint_t);
void fnvlist_add_int64_array(nvlist_t *, const char *, int64_t *, uint_t);
void fnvlist_add_uint64_array(nvlist_t *, const char *, uint64_t *, uint_t);
void fnvlist_add_string_array(nvlist_t *, const char *, char * const *, uint_t);
void fnvlist_add_nvlist_array(nvlist_t *, const char *, nvlist_t **, uint_t);

void fnvlist_remove(nvlist_t *, const char *);
void fnvlist_remove_nvpair(nvlist_t *, nvpair_t *);

nvpair_t *fnvlist_lookup_nvpair(nvlist_t *nvl, const char *name);
boolean_t fnvlist_lookup_boolean(nvlist_t *nvl, const char *name);
boolean_t fnvlist_lookup_boolean_value(nvlist_t *nvl, const char *name);
uchar_t fnvlist_lookup_byte(nvlist_t *nvl, const char *name);
int8_t fnvlist_lookup_int8(nvlist_t *nvl, const char *name);
int16_t fnvlist_lookup_int16(nvlist_t *nvl, const char *name);
int32_t fnvlist_lookup_int32(nvlist_t *nvl, const char *name);
int64_t fnvlist_lookup_int64(nvlist_t *nvl, const char *name);
uint8_t fnvlist_lookup_uint8(nvlist_t *nvl, const char *name);
uint16_t fnvlist_lookup_uint16(nvlist_t *nvl, const char *name);
uint32_t fnvlist_lookup_uint32(nvlist_t *nvl, const char *name);
uint64_t fnvlist_lookup_uint64(nvlist_t *nvl, const char *name);
char *fnvlist_lookup_string(nvlist_t *nvl, const char *name);
nvlist_t *fnvlist_lookup_nvlist(nvlist_t *nvl, const char *name);

boolean_t fnvpair_value_boolean_value(nvpair_t *nvp);
uchar_t fnvpair_value_byte(nvpair_t *nvp);
int8_t fnvpair_value_int8(nvpair_t *nvp);
int16_t fnvpair_value_int16(nvpair_t *nvp);
int32_t fnvpair_value_int32(nvpair_t *nvp);
int64_t fnvpair_value_int64(nvpair_t *nvp);
uint8_t fnvpair_value_uint8(nvpair_t *nvp);
uint16_t fnvpair_value_uint16(nvpair_t *nvp);
uint32_t fnvpair_value_uint32(nvpair_t *nvp);
uint64_t fnvpair_value_uint64(nvpair_t *nvp);
char *fnvpair_value_string(nvpair_t *nvp);
nvlist_t *fnvpair_value_nvlist(nvpair_t *nvp);

#ifdef	__cplusplus
}
#endif

#endif	/* _SYS_NVPAIR_H */
Commit	Line	Data
34dc7c2f BB	1	/*
	2	* CDDL HEADER START
	3	*
	4	* The contents of this file are subject to the terms of the
	5	* Common Development and Distribution License (the "License").
	6	* You may not use this file except in compliance with the License.
	7	*
	8	* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
	9	* or http://www.opensolaris.org/os/licensing.
	10	* See the License for the specific language governing permissions
	11	* and limitations under the License.
	12	*
	13	* When distributing Covered Code, include this CDDL HEADER in each
	14	* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
	15	* If applicable, add the following below this CDDL HEADER, with the
	16	* fields enclosed by brackets "[]" replaced with your own identifying
	17	* information: Portions Copyright [yyyy] [name of copyright owner]
	18	*
	19	* CDDL HEADER END
	20	*/
	21	/*
572e2857	22	* Copyright (c) 2000, 2010, Oracle and/or its affiliates. All rights reserved.
9ae529ec	23	* Copyright (c) 2012 by Delphix. All rights reserved.
34dc7c2f BB	24	*/
	25
	26	#ifndef _SYS_NVPAIR_H
	27	#define _SYS_NVPAIR_H
	28
34dc7c2f	29	#include <sys/types.h>
9ae529ec	30	#include <sys/time.h>
34dc7c2f BB	31	#include <sys/errno.h>
	32	#include <sys/va_list.h>
	33
	34	#if defined(_KERNEL) && !defined(_BOOT)
	35	#include <sys/kmem.h>
	36	#endif
	37
	38	#ifdef __cplusplus
	39	extern "C" {
	40	#endif
	41
	42	typedef enum {
	43	DATA_TYPE_UNKNOWN = 0,
	44	DATA_TYPE_BOOLEAN,
	45	DATA_TYPE_BYTE,
	46	DATA_TYPE_INT16,
	47	DATA_TYPE_UINT16,
	48	DATA_TYPE_INT32,
	49	DATA_TYPE_UINT32,
	50	DATA_TYPE_INT64,
	51	DATA_TYPE_UINT64,
	52	DATA_TYPE_STRING,
	53	DATA_TYPE_BYTE_ARRAY,
	54	DATA_TYPE_INT16_ARRAY,
	55	DATA_TYPE_UINT16_ARRAY,
	56	DATA_TYPE_INT32_ARRAY,
	57	DATA_TYPE_UINT32_ARRAY,
	58	DATA_TYPE_INT64_ARRAY,
	59	DATA_TYPE_UINT64_ARRAY,
	60	DATA_TYPE_STRING_ARRAY,
	61	DATA_TYPE_HRTIME,
	62	DATA_TYPE_NVLIST,
	63	DATA_TYPE_NVLIST_ARRAY,
	64	DATA_TYPE_BOOLEAN_VALUE,
	65	DATA_TYPE_INT8,
	66	DATA_TYPE_UINT8,
	67	DATA_TYPE_BOOLEAN_ARRAY,
	68	DATA_TYPE_INT8_ARRAY,
b128c09f BB	69	#if !defined(_KERNEL)
	70	DATA_TYPE_UINT8_ARRAY,
	71	DATA_TYPE_DOUBLE
	72	#else
34dc7c2f	73	DATA_TYPE_UINT8_ARRAY
b128c09f	74	#endif
34dc7c2f BB	75	} data_type_t;
	76
	77	typedef struct nvpair {
	78	int32_t nvp_size; /* size of this nvpair */
	79	int16_t nvp_name_sz; /* length of name string */
	80	int16_t nvp_reserve; /* not used */
	81	int32_t nvp_value_elem; /* number of elements for array types */
	82	data_type_t nvp_type; /* type of value */
	83	/* name string */
	84	/* aligned ptr array for string arrays */
	85	/* aligned array of data for value */
	86	} nvpair_t;
	87
	88	/* nvlist header */
	89	typedef struct nvlist {
	90	int32_t nvl_version;
	91	uint32_t nvl_nvflag; /* persistent flags */
	92	uint64_t nvl_priv; /* ptr to private data if not packed */
	93	uint32_t nvl_flag;
	94	int32_t nvl_pad; /* currently not used, for alignment */
	95	} nvlist_t;
	96
	97	/* nvp implementation version */
	98	#define NV_VERSION 0
	99
	100	/* nvlist pack encoding */
	101	#define NV_ENCODE_NATIVE 0
	102	#define NV_ENCODE_XDR 1
	103
	104	/* nvlist persistent unique name flags, stored in nvl_nvflags */
	105	#define NV_UNIQUE_NAME 0x1
	106	#define NV_UNIQUE_NAME_TYPE 0x2
	107
	108	/* nvlist lookup pairs related flags */
	109	#define NV_FLAG_NOENTOK 0x1
	110
	111	/* convenience macros */
	112	#define NV_ALIGN(x) (((ulong_t)(x) + 7ul) & ~7ul)
	113	#define NV_ALIGN4(x) (((x) + 3) & ~3)
	114
	115	#define NVP_SIZE(nvp) ((nvp)->nvp_size)
	116	#define NVP_NAME(nvp) ((char *)(nvp) + sizeof (nvpair_t))
	117	#define NVP_TYPE(nvp) ((nvp)->nvp_type)
	118	#define NVP_NELEM(nvp) ((nvp)->nvp_value_elem)
	119	#define NVP_VALUE(nvp) ((char *)(nvp) + NV_ALIGN(sizeof (nvpair_t) \
	120	+ (nvp)->nvp_name_sz))
	121
	122	#define NVL_VERSION(nvl) ((nvl)->nvl_version)
	123	#define NVL_SIZE(nvl) ((nvl)->nvl_size)
	124	#define NVL_FLAG(nvl) ((nvl)->nvl_flag)
	125
	126	/* NV allocator framework */
	127	typedef struct nv_alloc_ops nv_alloc_ops_t;
	128
	129	typedef struct nv_alloc {
	130	const nv_alloc_ops_t *nva_ops;
	131	void *nva_arg;
	132	} nv_alloc_t;
	133
	134	struct nv_alloc_ops {
	135	int (nv_ao_init)(nv_alloc_t , __va_list);
	136	void (nv_ao_fini)(nv_alloc_t );
	137	void (nv_ao_alloc)(nv_alloc_t *, size_t);
	138	void (nv_ao_free)(nv_alloc_t , void *, size_t);
139	void (nv_ao_reset)(nv_alloc_t );
140	};
141
142	extern const nv_alloc_ops_t *nv_fixed_ops;
143	extern nv_alloc_t *nv_alloc_nosleep;
144
145	#if defined(_KERNEL) && !defined(_BOOT)
146	extern nv_alloc_t *nv_alloc_sleep;
147	#endif
148
149	int nv_alloc_init(nv_alloc_t , const nv_alloc_ops_t , /* args */ ...);
150	void nv_alloc_reset(nv_alloc_t *);
151	void nv_alloc_fini(nv_alloc_t *);
152
153	/* list management */
154	int nvlist_alloc(nvlist_t **, uint_t, int);
155	void nvlist_free(nvlist_t *);
156	int nvlist_size(nvlist_t , size_t , int);
157	int nvlist_pack(nvlist_t , char , size_t , int, int);
158	int nvlist_unpack(char , size_t, nvlist_t *, int);
159	int nvlist_dup(nvlist_t , nvlist_t *, int);
160	int nvlist_merge(nvlist_t , nvlist_t , int);
161
572e2857 BB	162	uint_t nvlist_nvflag(nvlist_t *);
572e2857 BB	163
34dc7c2f BB	164	int nvlist_xalloc(nvlist_t *, uint_t, nv_alloc_t );
	165	int nvlist_xpack(nvlist_t , char , size_t , int, nv_alloc_t *);
	166	int nvlist_xunpack(char , size_t, nvlist_t , nv_alloc_t );
	167	int nvlist_xdup(nvlist_t , nvlist_t , nv_alloc_t );
	168	nv_alloc_t nvlist_lookup_nv_alloc(nvlist_t );
	169
	170	int nvlist_add_nvpair(nvlist_t , nvpair_t );
	171	int nvlist_add_boolean(nvlist_t , const char );
	172	int nvlist_add_boolean_value(nvlist_t , const char , boolean_t);
	173	int nvlist_add_byte(nvlist_t , const char , uchar_t);
	174	int nvlist_add_int8(nvlist_t , const char , int8_t);
	175	int nvlist_add_uint8(nvlist_t , const char , uint8_t);
	176	int nvlist_add_int16(nvlist_t , const char , int16_t);
	177	int nvlist_add_uint16(nvlist_t , const char , uint16_t);
	178	int nvlist_add_int32(nvlist_t , const char , int32_t);
	179	int nvlist_add_uint32(nvlist_t , const char , uint32_t);
	180	int nvlist_add_int64(nvlist_t , const char , int64_t);
	181	int nvlist_add_uint64(nvlist_t , const char , uint64_t);
	182	int nvlist_add_string(nvlist_t , const char , const char *);
	183	int nvlist_add_nvlist(nvlist_t , const char , nvlist_t *);
	184	int nvlist_add_boolean_array(nvlist_t , const char , boolean_t *, uint_t);
	185	int nvlist_add_byte_array(nvlist_t , const char , uchar_t *, uint_t);
	186	int nvlist_add_int8_array(nvlist_t , const char , int8_t *, uint_t);
	187	int nvlist_add_uint8_array(nvlist_t , const char , uint8_t *, uint_t);
	188	int nvlist_add_int16_array(nvlist_t , const char , int16_t *, uint_t);
	189	int nvlist_add_uint16_array(nvlist_t , const char , uint16_t *, uint_t);
	190	int nvlist_add_int32_array(nvlist_t , const char , int32_t *, uint_t);
	191	int nvlist_add_uint32_array(nvlist_t , const char , uint32_t *, uint_t);
	192	int nvlist_add_int64_array(nvlist_t , const char , int64_t *, uint_t);
	193	int nvlist_add_uint64_array(nvlist_t , const char , uint64_t *, uint_t);
	194	int nvlist_add_string_array(nvlist_t , const char , char const , uint_t);
	195	int nvlist_add_nvlist_array(nvlist_t , const char , nvlist_t **, uint_t);
	196	int nvlist_add_hrtime(nvlist_t , const char , hrtime_t);
b128c09f BB	197	#if !defined(_KERNEL)
	198	int nvlist_add_double(nvlist_t , const char , double);
	199	#endif
34dc7c2f BB	200
	201	int nvlist_remove(nvlist_t , const char , data_type_t);
	202	int nvlist_remove_all(nvlist_t , const char );
428870ff	203	int nvlist_remove_nvpair(nvlist_t , nvpair_t );
34dc7c2f BB	204
	205	int nvlist_lookup_boolean(nvlist_t , const char );
	206	int nvlist_lookup_boolean_value(nvlist_t , const char , boolean_t *);
	207	int nvlist_lookup_byte(nvlist_t , const char , uchar_t *);
	208	int nvlist_lookup_int8(nvlist_t , const char , int8_t *);
	209	int nvlist_lookup_uint8(nvlist_t , const char , uint8_t *);
	210	int nvlist_lookup_int16(nvlist_t , const char , int16_t *);
	211	int nvlist_lookup_uint16(nvlist_t , const char , uint16_t *);
	212	int nvlist_lookup_int32(nvlist_t , const char , int32_t *);
	213	int nvlist_lookup_uint32(nvlist_t , const char , uint32_t *);
	214	int nvlist_lookup_int64(nvlist_t , const char , int64_t *);
	215	int nvlist_lookup_uint64(nvlist_t , const char , uint64_t *);
	216	int nvlist_lookup_string(nvlist_t , const char , char **);
	217	int nvlist_lookup_nvlist(nvlist_t , const char , nvlist_t **);
	218	int nvlist_lookup_boolean_array(nvlist_t , const char ,
	219	boolean_t *, uint_t );
	220	int nvlist_lookup_byte_array(nvlist_t , const char , uchar_t *, uint_t );
	221	int nvlist_lookup_int8_array(nvlist_t , const char , int8_t *, uint_t );
	222	int nvlist_lookup_uint8_array(nvlist_t , const char , uint8_t *, uint_t );
	223	int nvlist_lookup_int16_array(nvlist_t , const char , int16_t *, uint_t );
	224	int nvlist_lookup_uint16_array(nvlist_t , const char , uint16_t *, uint_t );
	225	int nvlist_lookup_int32_array(nvlist_t , const char , int32_t *, uint_t );
	226	int nvlist_lookup_uint32_array(nvlist_t , const char , uint32_t *, uint_t );
	227	int nvlist_lookup_int64_array(nvlist_t , const char , int64_t *, uint_t );
	228	int nvlist_lookup_uint64_array(nvlist_t , const char , uint64_t *, uint_t );
	229	int nvlist_lookup_string_array(nvlist_t , const char , char **, uint_t );
	230	int nvlist_lookup_nvlist_array(nvlist_t , const char ,
	231	nvlist_t **, uint_t );
	232	int nvlist_lookup_hrtime(nvlist_t , const char , hrtime_t *);
b128c09f BB	233	int nvlist_lookup_pairs(nvlist_t *, int, ...);
	234	#if !defined(_KERNEL)
	235	int nvlist_lookup_double(nvlist_t , const char , double *);
	236	#endif
34dc7c2f	237
b128c09f BB	238	int nvlist_lookup_nvpair(nvlist_t , const char , nvpair_t **);
	239	int nvlist_lookup_nvpair_embedded_index(nvlist_t , const char , nvpair_t **,
	240	int , char *);
	241	boolean_t nvlist_exists(nvlist_t , const char );
428870ff	242	boolean_t nvlist_empty(nvlist_t *);
34dc7c2f BB	243
34dc7c2f BB	244	/* processing nvpair */
b128c09f	245	nvpair_t nvlist_next_nvpair(nvlist_t , nvpair_t *);
428870ff	246	nvpair_t nvlist_prev_nvpair(nvlist_t , nvpair_t *);
34dc7c2f BB	247	char nvpair_name(nvpair_t );
34dc7c2f BB	248	data_type_t nvpair_type(nvpair_t *);
b128c09f	249	int nvpair_type_is_array(nvpair_t *);
34dc7c2f BB	250	int nvpair_value_boolean_value(nvpair_t , boolean_t );
	251	int nvpair_value_byte(nvpair_t , uchar_t );
	252	int nvpair_value_int8(nvpair_t , int8_t );
	253	int nvpair_value_uint8(nvpair_t , uint8_t );
	254	int nvpair_value_int16(nvpair_t , int16_t );
	255	int nvpair_value_uint16(nvpair_t , uint16_t );
	256	int nvpair_value_int32(nvpair_t , int32_t );
	257	int nvpair_value_uint32(nvpair_t , uint32_t );
	258	int nvpair_value_int64(nvpair_t , int64_t );
	259	int nvpair_value_uint64(nvpair_t , uint64_t );
	260	int nvpair_value_string(nvpair_t , char *);
	261	int nvpair_value_nvlist(nvpair_t , nvlist_t *);
	262	int nvpair_value_boolean_array(nvpair_t , boolean_t , uint_t );
	263	int nvpair_value_byte_array(nvpair_t , uchar_t , uint_t );
	264	int nvpair_value_int8_array(nvpair_t , int8_t , uint_t );
	265	int nvpair_value_uint8_array(nvpair_t , uint8_t , uint_t );
	266	int nvpair_value_int16_array(nvpair_t , int16_t , uint_t );
	267	int nvpair_value_uint16_array(nvpair_t , uint16_t , uint_t );
	268	int nvpair_value_int32_array(nvpair_t , int32_t , uint_t );
	269	int nvpair_value_uint32_array(nvpair_t , uint32_t , uint_t );
	270	int nvpair_value_int64_array(nvpair_t , int64_t , uint_t );
	271	int nvpair_value_uint64_array(nvpair_t , uint64_t , uint_t );
	272	int nvpair_value_string_array(nvpair_t , char *, uint_t );
	273	int nvpair_value_nvlist_array(nvpair_t , nvlist_t *, uint_t );
	274	int nvpair_value_hrtime(nvpair_t , hrtime_t );
b128c09f BB	275	#if !defined(_KERNEL)
	276	int nvpair_value_double(nvpair_t , double );
	277	#endif
34dc7c2f	278
9ae529ec CS	279	nvlist_t *fnvlist_alloc(void);
	280	void fnvlist_free(nvlist_t *);
	281	size_t fnvlist_size(nvlist_t *);
	282	char fnvlist_pack(nvlist_t , size_t *);
	283	void fnvlist_pack_free(char *, size_t);
	284	nvlist_t fnvlist_unpack(char , size_t);
	285	nvlist_t fnvlist_dup(nvlist_t );
	286	void fnvlist_merge(nvlist_t , nvlist_t );
	287
	288	void fnvlist_add_boolean(nvlist_t , const char );
	289	void fnvlist_add_boolean_value(nvlist_t , const char , boolean_t);
	290	void fnvlist_add_byte(nvlist_t , const char , uchar_t);
	291	void fnvlist_add_int8(nvlist_t , const char , int8_t);
	292	void fnvlist_add_uint8(nvlist_t , const char , uint8_t);
	293	void fnvlist_add_int16(nvlist_t , const char , int16_t);
	294	void fnvlist_add_uint16(nvlist_t , const char , uint16_t);
	295	void fnvlist_add_int32(nvlist_t , const char , int32_t);
	296	void fnvlist_add_uint32(nvlist_t , const char , uint32_t);
	297	void fnvlist_add_int64(nvlist_t , const char , int64_t);
	298	void fnvlist_add_uint64(nvlist_t , const char , uint64_t);
	299	void fnvlist_add_string(nvlist_t , const char , const char *);
	300	void fnvlist_add_nvlist(nvlist_t , const char , nvlist_t *);
	301	void fnvlist_add_nvpair(nvlist_t , nvpair_t );
	302	void fnvlist_add_boolean_array(nvlist_t , const char , boolean_t *, uint_t);
	303	void fnvlist_add_byte_array(nvlist_t , const char , uchar_t *, uint_t);
	304	void fnvlist_add_int8_array(nvlist_t , const char , int8_t *, uint_t);
	305	void fnvlist_add_uint8_array(nvlist_t , const char , uint8_t *, uint_t);
	306	void fnvlist_add_int16_array(nvlist_t , const char , int16_t *, uint_t);
	307	void fnvlist_add_uint16_array(nvlist_t , const char , uint16_t *, uint_t);
	308	void fnvlist_add_int32_array(nvlist_t , const char , int32_t *, uint_t);
	309	void fnvlist_add_uint32_array(nvlist_t , const char , uint32_t *, uint_t);
	310	void fnvlist_add_int64_array(nvlist_t , const char , int64_t *, uint_t);
	311	void fnvlist_add_uint64_array(nvlist_t , const char , uint64_t *, uint_t);
	312	void fnvlist_add_string_array(nvlist_t , const char , char * const *, uint_t);
	313	void fnvlist_add_nvlist_array(nvlist_t , const char , nvlist_t **, uint_t);
	314
	315	void fnvlist_remove(nvlist_t , const char );
	316	void fnvlist_remove_nvpair(nvlist_t , nvpair_t );
	317
	318	nvpair_t fnvlist_lookup_nvpair(nvlist_t nvl, const char *name);
	319	boolean_t fnvlist_lookup_boolean(nvlist_t nvl, const char name);
	320	boolean_t fnvlist_lookup_boolean_value(nvlist_t nvl, const char name);
	321	uchar_t fnvlist_lookup_byte(nvlist_t nvl, const char name);
	322	int8_t fnvlist_lookup_int8(nvlist_t nvl, const char name);
	323	int16_t fnvlist_lookup_int16(nvlist_t nvl, const char name);
	324	int32_t fnvlist_lookup_int32(nvlist_t nvl, const char name);
	325	int64_t fnvlist_lookup_int64(nvlist_t nvl, const char name);
	326	uint8_t fnvlist_lookup_uint8(nvlist_t nvl, const char name);
	327	uint16_t fnvlist_lookup_uint16(nvlist_t nvl, const char name);
	328	uint32_t fnvlist_lookup_uint32(nvlist_t nvl, const char name);
	329	uint64_t fnvlist_lookup_uint64(nvlist_t nvl, const char name);
	330	char fnvlist_lookup_string(nvlist_t nvl, const char *name);
	331	nvlist_t fnvlist_lookup_nvlist(nvlist_t nvl, const char *name);
	332
	333	boolean_t fnvpair_value_boolean_value(nvpair_t *nvp);
	334	uchar_t fnvpair_value_byte(nvpair_t *nvp);
	335	int8_t fnvpair_value_int8(nvpair_t *nvp);
	336	int16_t fnvpair_value_int16(nvpair_t *nvp);
	337	int32_t fnvpair_value_int32(nvpair_t *nvp);
	338	int64_t fnvpair_value_int64(nvpair_t *nvp);
	339	uint8_t fnvpair_value_uint8(nvpair_t *nvp);
	340	uint16_t fnvpair_value_uint16(nvpair_t *nvp);
	341	uint32_t fnvpair_value_uint32(nvpair_t *nvp);
	342	uint64_t fnvpair_value_uint64(nvpair_t *nvp);
343	char fnvpair_value_string(nvpair_t nvp);
344	nvlist_t fnvpair_value_nvlist(nvpair_t nvp);
345
34dc7c2f BB	346	#ifdef __cplusplus
	347	}
	348	#endif
	349
	350	#endif /* _SYS_NVPAIR_H */