| /* |
| * 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, 2018 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> |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| typedef enum { |
| DATA_TYPE_DONTCARE = -1, |
| 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) |
| extern nv_alloc_t *nv_alloc_sleep; |
| extern nv_alloc_t *nv_alloc_pushpage; |
| #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 *); |
| size_t fnvlist_num_pairs(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 *, const char *); |
| boolean_t fnvlist_lookup_boolean(nvlist_t *, const char *); |
| boolean_t fnvlist_lookup_boolean_value(nvlist_t *, const char *); |
| uchar_t fnvlist_lookup_byte(nvlist_t *, const char *); |
| int8_t fnvlist_lookup_int8(nvlist_t *, const char *); |
| int16_t fnvlist_lookup_int16(nvlist_t *, const char *); |
| int32_t fnvlist_lookup_int32(nvlist_t *, const char *); |
| int64_t fnvlist_lookup_int64(nvlist_t *, const char *); |
| uint8_t fnvlist_lookup_uint8(nvlist_t *, const char *); |
| uint16_t fnvlist_lookup_uint16(nvlist_t *, const char *); |
| uint32_t fnvlist_lookup_uint32(nvlist_t *, const char *); |
| uint64_t fnvlist_lookup_uint64(nvlist_t *, const char *); |
| char *fnvlist_lookup_string(nvlist_t *, const char *); |
| nvlist_t *fnvlist_lookup_nvlist(nvlist_t *, const char *); |
| boolean_t *fnvlist_lookup_boolean_array(nvlist_t *, const char *, uint_t *); |
| uchar_t *fnvlist_lookup_byte_array(nvlist_t *, const char *, uint_t *); |
| int8_t *fnvlist_lookup_int8_array(nvlist_t *, const char *, uint_t *); |
| uint8_t *fnvlist_lookup_uint8_array(nvlist_t *, const char *, uint_t *); |
| int16_t *fnvlist_lookup_int16_array(nvlist_t *, const char *, uint_t *); |
| uint16_t *fnvlist_lookup_uint16_array(nvlist_t *, const char *, uint_t *); |
| int32_t *fnvlist_lookup_int32_array(nvlist_t *, const char *, uint_t *); |
| uint32_t *fnvlist_lookup_uint32_array(nvlist_t *, const char *, uint_t *); |
| int64_t *fnvlist_lookup_int64_array(nvlist_t *, const char *, uint_t *); |
| uint64_t *fnvlist_lookup_uint64_array(nvlist_t *, const char *, uint_t *); |
| |
| 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 */ |