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/* 22 * Copyright (c) 2000, 2010, Oracle and/or its affiliates. All rights reserved. 23 * Copyright (c) 2012, 2017 by Delphix. All rights reserved. 24 */ 25 26#ifndef _SYS_NVPAIR_H 27#define _SYS_NVPAIR_H 28 29#include <sys/types.h> 30#include <sys/time.h> 31#include <sys/errno.h> 32 33#if defined(_KERNEL) && !defined(_BOOT) 34#include <sys/kmem.h> 35#endif 36 37#ifdef __cplusplus 38extern "C" { 39#endif 40 41typedef enum { 42 DATA_TYPE_DONTCARE = -1, 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, 69#if !defined(_KERNEL) 70 DATA_TYPE_UINT8_ARRAY, 71 DATA_TYPE_DOUBLE 72#else 73 DATA_TYPE_UINT8_ARRAY 74#endif 75} data_type_t; 76 77typedef 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 */ 89typedef 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 */ 127typedef struct nv_alloc_ops nv_alloc_ops_t; 128 129typedef struct nv_alloc { 130 const nv_alloc_ops_t *nva_ops; 131 void *nva_arg; 132} nv_alloc_t; 133 134struct 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 142extern const nv_alloc_ops_t *nv_fixed_ops; 143extern nv_alloc_t *nv_alloc_nosleep; 144 145#if defined(_KERNEL) && !defined(_BOOT) 146extern nv_alloc_t *nv_alloc_sleep; 147#endif 148 149int nv_alloc_init(nv_alloc_t *, const nv_alloc_ops_t *, /* args */ ...); 150void nv_alloc_reset(nv_alloc_t *); 151void nv_alloc_fini(nv_alloc_t *); 152 153/* list management */ 154int nvlist_alloc(nvlist_t **, uint_t, int); 155void nvlist_free(nvlist_t *); 156int nvlist_size(nvlist_t *, size_t *, int); 157int nvlist_pack(nvlist_t *, char **, size_t *, int, int); 158int nvlist_unpack(char *, size_t, nvlist_t **, int); 159int nvlist_dup(nvlist_t *, nvlist_t **, int); 160int nvlist_merge(nvlist_t *, nvlist_t *, int); 161 162uint_t nvlist_nvflag(nvlist_t *); 163 164int nvlist_xalloc(nvlist_t **, uint_t, nv_alloc_t *); 165int nvlist_xpack(nvlist_t *, char **, size_t *, int, nv_alloc_t *); 166int nvlist_xunpack(char *, size_t, nvlist_t **, nv_alloc_t *); 167int nvlist_xdup(nvlist_t *, nvlist_t **, nv_alloc_t *); 168nv_alloc_t *nvlist_lookup_nv_alloc(nvlist_t *); 169 170int nvlist_add_nvpair(nvlist_t *, nvpair_t *); 171int nvlist_add_boolean(nvlist_t *, const char *); 172int nvlist_add_boolean_value(nvlist_t *, const char *, boolean_t); 173int nvlist_add_byte(nvlist_t *, const char *, uchar_t); 174int nvlist_add_int8(nvlist_t *, const char *, int8_t); 175int nvlist_add_uint8(nvlist_t *, const char *, uint8_t); 176int nvlist_add_int16(nvlist_t *, const char *, int16_t); 177int nvlist_add_uint16(nvlist_t *, const char *, uint16_t); 178int nvlist_add_int32(nvlist_t *, const char *, int32_t); 179int nvlist_add_uint32(nvlist_t *, const char *, uint32_t); 180int nvlist_add_int64(nvlist_t *, const char *, int64_t); 181int nvlist_add_uint64(nvlist_t *, const char *, uint64_t); 182int nvlist_add_string(nvlist_t *, const char *, const char *); 183int nvlist_add_nvlist(nvlist_t *, const char *, nvlist_t *); 184int nvlist_add_boolean_array(nvlist_t *, const char *, boolean_t *, uint_t); 185int nvlist_add_byte_array(nvlist_t *, const char *, uchar_t *, uint_t); 186int nvlist_add_int8_array(nvlist_t *, const char *, int8_t *, uint_t); 187int nvlist_add_uint8_array(nvlist_t *, const char *, uint8_t *, uint_t); 188int nvlist_add_int16_array(nvlist_t *, const char *, int16_t *, uint_t); 189int nvlist_add_uint16_array(nvlist_t *, const char *, uint16_t *, uint_t); 190int nvlist_add_int32_array(nvlist_t *, const char *, int32_t *, uint_t); 191int nvlist_add_uint32_array(nvlist_t *, const char *, uint32_t *, uint_t); 192int nvlist_add_int64_array(nvlist_t *, const char *, int64_t *, uint_t); 193int nvlist_add_uint64_array(nvlist_t *, const char *, uint64_t *, uint_t); 194int nvlist_add_string_array(nvlist_t *, const char *, char *const *, uint_t); 195int nvlist_add_nvlist_array(nvlist_t *, const char *, nvlist_t **, uint_t); 196int nvlist_add_hrtime(nvlist_t *, const char *, hrtime_t); 197#if !defined(_KERNEL) 198int nvlist_add_double(nvlist_t *, const char *, double); 199#endif 200 201int nvlist_remove(nvlist_t *, const char *, data_type_t); 202int nvlist_remove_all(nvlist_t *, const char *); 203int nvlist_remove_nvpair(nvlist_t *, nvpair_t *); 204 205int nvlist_lookup_boolean(nvlist_t *, const char *); 206int nvlist_lookup_boolean_value(nvlist_t *, const char *, boolean_t *); 207int nvlist_lookup_byte(nvlist_t *, const char *, uchar_t *); 208int nvlist_lookup_int8(nvlist_t *, const char *, int8_t *); 209int nvlist_lookup_uint8(nvlist_t *, const char *, uint8_t *); 210int nvlist_lookup_int16(nvlist_t *, const char *, int16_t *); 211int nvlist_lookup_uint16(nvlist_t *, const char *, uint16_t *); 212int nvlist_lookup_int32(nvlist_t *, const char *, int32_t *); 213int nvlist_lookup_uint32(nvlist_t *, const char *, uint32_t *); 214int nvlist_lookup_int64(nvlist_t *, const char *, int64_t *); 215int nvlist_lookup_uint64(nvlist_t *, const char *, uint64_t *); 216int nvlist_lookup_string(nvlist_t *, const char *, char **); 217int nvlist_lookup_nvlist(nvlist_t *, const char *, nvlist_t **); 218int nvlist_lookup_boolean_array(nvlist_t *, const char *, 219 boolean_t **, uint_t *); 220int nvlist_lookup_byte_array(nvlist_t *, const char *, uchar_t **, uint_t *); 221int nvlist_lookup_int8_array(nvlist_t *, const char *, int8_t **, uint_t *); 222int nvlist_lookup_uint8_array(nvlist_t *, const char *, uint8_t **, uint_t *); 223int nvlist_lookup_int16_array(nvlist_t *, const char *, int16_t **, uint_t *); 224int nvlist_lookup_uint16_array(nvlist_t *, const char *, uint16_t **, uint_t *); 225int nvlist_lookup_int32_array(nvlist_t *, const char *, int32_t **, uint_t *); 226int nvlist_lookup_uint32_array(nvlist_t *, const char *, uint32_t **, uint_t *); 227int nvlist_lookup_int64_array(nvlist_t *, const char *, int64_t **, uint_t *); 228int nvlist_lookup_uint64_array(nvlist_t *, const char *, uint64_t **, uint_t *); 229int nvlist_lookup_string_array(nvlist_t *, const char *, char ***, uint_t *); 230int nvlist_lookup_nvlist_array(nvlist_t *, const char *, 231 nvlist_t ***, uint_t *); 232int nvlist_lookup_hrtime(nvlist_t *, const char *, hrtime_t *); 233int nvlist_lookup_pairs(nvlist_t *, int, ...); 234#if !defined(_KERNEL) 235int nvlist_lookup_double(nvlist_t *, const char *, double *); 236#endif 237 238int nvlist_lookup_nvpair(nvlist_t *, const char *, nvpair_t **); 239int nvlist_lookup_nvpair_embedded_index(nvlist_t *, const char *, nvpair_t **, 240 int *, char **); 241boolean_t nvlist_exists(nvlist_t *, const char *); 242boolean_t nvlist_empty(nvlist_t *); 243 244/* processing nvpair */ 245nvpair_t *nvlist_next_nvpair(nvlist_t *, nvpair_t *); 246nvpair_t *nvlist_prev_nvpair(nvlist_t *, nvpair_t *); 247char *nvpair_name(nvpair_t *); 248data_type_t nvpair_type(nvpair_t *); 249int nvpair_type_is_array(nvpair_t *); 250int nvpair_value_boolean_value(nvpair_t *, boolean_t *); 251int nvpair_value_byte(nvpair_t *, uchar_t *); 252int nvpair_value_int8(nvpair_t *, int8_t *); 253int nvpair_value_uint8(nvpair_t *, uint8_t *); 254int nvpair_value_int16(nvpair_t *, int16_t *); 255int nvpair_value_uint16(nvpair_t *, uint16_t *); 256int nvpair_value_int32(nvpair_t *, int32_t *); 257int nvpair_value_uint32(nvpair_t *, uint32_t *); 258int nvpair_value_int64(nvpair_t *, int64_t *); 259int nvpair_value_uint64(nvpair_t *, uint64_t *); 260int nvpair_value_string(nvpair_t *, char **); 261int nvpair_value_nvlist(nvpair_t *, nvlist_t **); 262int nvpair_value_boolean_array(nvpair_t *, boolean_t **, uint_t *); 263int nvpair_value_byte_array(nvpair_t *, uchar_t **, uint_t *); 264int nvpair_value_int8_array(nvpair_t *, int8_t **, uint_t *); 265int nvpair_value_uint8_array(nvpair_t *, uint8_t **, uint_t *); 266int nvpair_value_int16_array(nvpair_t *, int16_t **, uint_t *); 267int nvpair_value_uint16_array(nvpair_t *, uint16_t **, uint_t *); 268int nvpair_value_int32_array(nvpair_t *, int32_t **, uint_t *); 269int nvpair_value_uint32_array(nvpair_t *, uint32_t **, uint_t *); 270int nvpair_value_int64_array(nvpair_t *, int64_t **, uint_t *); 271int nvpair_value_uint64_array(nvpair_t *, uint64_t **, uint_t *); 272int nvpair_value_string_array(nvpair_t *, char ***, uint_t *); 273int nvpair_value_nvlist_array(nvpair_t *, nvlist_t ***, uint_t *); 274int nvpair_value_hrtime(nvpair_t *, hrtime_t *); 275#if !defined(_KERNEL) 276int nvpair_value_double(nvpair_t *, double *); 277#endif 278 279nvlist_t *fnvlist_alloc(void); 280void fnvlist_free(nvlist_t *); 281size_t fnvlist_size(nvlist_t *); 282char *fnvlist_pack(nvlist_t *, size_t *); 283void fnvlist_pack_free(char *, size_t); 284nvlist_t *fnvlist_unpack(char *, size_t); 285nvlist_t *fnvlist_dup(nvlist_t *); 286void fnvlist_merge(nvlist_t *, nvlist_t *); 287size_t fnvlist_num_pairs(nvlist_t *); 288 289void fnvlist_add_boolean(nvlist_t *, const char *); 290void fnvlist_add_boolean_value(nvlist_t *, const char *, boolean_t); 291void fnvlist_add_byte(nvlist_t *, const char *, uchar_t); 292void fnvlist_add_int8(nvlist_t *, const char *, int8_t); 293void fnvlist_add_uint8(nvlist_t *, const char *, uint8_t); 294void fnvlist_add_int16(nvlist_t *, const char *, int16_t); 295void fnvlist_add_uint16(nvlist_t *, const char *, uint16_t); 296void fnvlist_add_int32(nvlist_t *, const char *, int32_t); 297void fnvlist_add_uint32(nvlist_t *, const char *, uint32_t); 298void fnvlist_add_int64(nvlist_t *, const char *, int64_t); 299void fnvlist_add_uint64(nvlist_t *, const char *, uint64_t); 300void fnvlist_add_string(nvlist_t *, const char *, const char *); 301void fnvlist_add_nvlist(nvlist_t *, const char *, nvlist_t *); 302void fnvlist_add_nvpair(nvlist_t *, nvpair_t *); 303void fnvlist_add_boolean_array(nvlist_t *, const char *, boolean_t *, uint_t); 304void fnvlist_add_byte_array(nvlist_t *, const char *, uchar_t *, uint_t); 305void fnvlist_add_int8_array(nvlist_t *, const char *, int8_t *, uint_t); 306void fnvlist_add_uint8_array(nvlist_t *, const char *, uint8_t *, uint_t); 307void fnvlist_add_int16_array(nvlist_t *, const char *, int16_t *, uint_t); 308void fnvlist_add_uint16_array(nvlist_t *, const char *, uint16_t *, uint_t); 309void fnvlist_add_int32_array(nvlist_t *, const char *, int32_t *, uint_t); 310void fnvlist_add_uint32_array(nvlist_t *, const char *, uint32_t *, uint_t); 311void fnvlist_add_int64_array(nvlist_t *, const char *, int64_t *, uint_t); 312void fnvlist_add_uint64_array(nvlist_t *, const char *, uint64_t *, uint_t); 313void fnvlist_add_string_array(nvlist_t *, const char *, char * const *, uint_t); 314void fnvlist_add_nvlist_array(nvlist_t *, const char *, nvlist_t **, uint_t); 315 316void fnvlist_remove(nvlist_t *, const char *); 317void fnvlist_remove_nvpair(nvlist_t *, nvpair_t *); 318 319nvpair_t *fnvlist_lookup_nvpair(nvlist_t *nvl, const char *name); 320boolean_t fnvlist_lookup_boolean(nvlist_t *nvl, const char *name); 321boolean_t fnvlist_lookup_boolean_value(nvlist_t *nvl, const char *name); 322uchar_t fnvlist_lookup_byte(nvlist_t *nvl, const char *name); 323int8_t fnvlist_lookup_int8(nvlist_t *nvl, const char *name); 324int16_t fnvlist_lookup_int16(nvlist_t *nvl, const char *name); 325int32_t fnvlist_lookup_int32(nvlist_t *nvl, const char *name); 326int64_t fnvlist_lookup_int64(nvlist_t *nvl, const char *name); 327uint8_t fnvlist_lookup_uint8_t(nvlist_t *nvl, const char *name); 328uint16_t fnvlist_lookup_uint16(nvlist_t *nvl, const char *name); 329uint32_t fnvlist_lookup_uint32(nvlist_t *nvl, const char *name); 330uint64_t fnvlist_lookup_uint64(nvlist_t *nvl, const char *name); 331char *fnvlist_lookup_string(nvlist_t *nvl, const char *name); 332nvlist_t *fnvlist_lookup_nvlist(nvlist_t *nvl, const char *name); 333 334boolean_t fnvpair_value_boolean_value(nvpair_t *nvp); 335uchar_t fnvpair_value_byte(nvpair_t *nvp); 336int8_t fnvpair_value_int8(nvpair_t *nvp); 337int16_t fnvpair_value_int16(nvpair_t *nvp); 338int32_t fnvpair_value_int32(nvpair_t *nvp); 339int64_t fnvpair_value_int64(nvpair_t *nvp); 340uint8_t fnvpair_value_uint8_t(nvpair_t *nvp); 341uint16_t fnvpair_value_uint16(nvpair_t *nvp); 342uint32_t fnvpair_value_uint32(nvpair_t *nvp); 343uint64_t fnvpair_value_uint64(nvpair_t *nvp); 344char *fnvpair_value_string(nvpair_t *nvp); 345nvlist_t *fnvpair_value_nvlist(nvpair_t *nvp); 346 347#ifdef __cplusplus 348} 349#endif 350 351#endif /* _SYS_NVPAIR_H */ 352