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.
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.
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]
23 * Copyright (c) 2000, 2010, Oracle and/or its affiliates. All rights reserved.
26 #include <sys/debug.h>
27 #include <sys/nvpair.h>
28 #include <sys/nvpair_impl.h>
29 #include <rpc/types.h>
32 #if defined(_KERNEL) && !defined(_BOOT)
33 #include <sys/varargs.h>
34 #include <sys/sunddi.h>
43 #define offsetof(s, m) ((size_t)(&(((s *)0)->m)))
45 #define skip_whitespace(p) while ((*(p) == ' ') || (*(p) == '\t')) p++
47 #if defined(__FreeBSD__) && !defined(_KERNEL)
49 * libnvpair is the lowest commen denominator for ZFS related libraries,
50 * defining aok here makes it usable by all ZFS related libraries
56 * nvpair.c - Provides kernel & userland interfaces for manipulating
71 * +--------------+ last i_nvp in list
72 * | nvpriv_t | +--------------------->
74 * +--+- nvp_list | | +------------+
75 * | | nvp_last -+--+ + nv_alloc_t |
76 * | | nvp_curr | |------------|
77 * | | nvp_nva -+----> | nva_ops |
78 * | | nvp_stat | | nva_arg |
79 * | +--------------+ +------------+
83 * +---------------------+ +-------------------+
84 * | i_nvp_t | +-->| i_nvp_t | +-->
85 * |---------------------| | |-------------------| |
86 * | nvi_next -+--+ | nvi_next -+--+
87 * | nvi_prev (NULL) | <----+ nvi_prev |
88 * | . . . . . . . . . . | | . . . . . . . . . |
89 * | nvp (nvpair_t) | | nvp (nvpair_t) |
90 * | - nvp_size | | - nvp_size |
91 * | - nvp_name_sz | | - nvp_name_sz |
92 * | - nvp_value_elem | | - nvp_value_elem |
93 * | - nvp_type | | - nvp_type |
94 * | - data ... | | - data ... |
95 * +---------------------+ +-------------------+
99 * +---------------------+ +---------------------+
100 * | i_nvp_t | +--> +-->| i_nvp_t (last) |
101 * |---------------------| | | |---------------------|
102 * | nvi_next -+--+ ... --+ | nvi_next (NULL) |
103 * <-+- nvi_prev |<-- ... <----+ nvi_prev |
104 * | . . . . . . . . . | | . . . . . . . . . |
105 * | nvp (nvpair_t) | | nvp (nvpair_t) |
106 * | - nvp_size | | - nvp_size |
107 * | - nvp_name_sz | | - nvp_name_sz |
108 * | - nvp_value_elem | | - nvp_value_elem |
109 * | - DATA_TYPE_NVLIST | | - nvp_type |
110 * | - data (embedded) | | - data ... |
111 * | nvlist name | +---------------------+
112 * | +--------------+ |
114 * | |--------------| |
115 * | | nvl_version | |
117 * | | nvl_priv --+---+---->
120 * | +--------------+ |
121 * +---------------------+
124 * N.B. nvpair_t may be aligned on 4 byte boundary, so +4 will
125 * allow value to be aligned on 8 byte boundary
127 * name_len is the length of the name string including the null terminator
130 #define NVP_SIZE_CALC(name_len, data_len) \
131 (NV_ALIGN((sizeof (nvpair_t)) + name_len) + NV_ALIGN(data_len))
133 static int i_get_value_size(data_type_t type, const void *data, uint_t nelem);
134 static int nvlist_add_common(nvlist_t *nvl, const char *name, data_type_t type,
135 uint_t nelem, const void *data);
137 #define NV_STAT_EMBEDDED 0x1
138 #define EMBEDDED_NVL(nvp) ((nvlist_t *)(void *)NVP_VALUE(nvp))
139 #define EMBEDDED_NVL_ARRAY(nvp) ((nvlist_t **)(void *)NVP_VALUE(nvp))
141 #define NVP_VALOFF(nvp) (NV_ALIGN(sizeof (nvpair_t) + (nvp)->nvp_name_sz))
142 #define NVPAIR2I_NVP(nvp) \
143 ((i_nvp_t *)((size_t)(nvp) - offsetof(i_nvp_t, nvi_nvp)))
147 nv_alloc_init(nv_alloc_t *nva, const nv_alloc_ops_t *nvo, /* args */ ...)
155 va_start(valist, nvo);
156 if (nva->nva_ops->nv_ao_init != NULL)
157 err = nva->nva_ops->nv_ao_init(nva, valist);
164 nv_alloc_reset(nv_alloc_t *nva)
166 if (nva->nva_ops->nv_ao_reset != NULL)
167 nva->nva_ops->nv_ao_reset(nva);
171 nv_alloc_fini(nv_alloc_t *nva)
173 if (nva->nva_ops->nv_ao_fini != NULL)
174 nva->nva_ops->nv_ao_fini(nva);
178 nvlist_lookup_nv_alloc(nvlist_t *nvl)
183 (priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv) == NULL)
186 return (priv->nvp_nva);
190 nv_mem_zalloc(nvpriv_t *nvp, size_t size)
192 nv_alloc_t *nva = nvp->nvp_nva;
195 if ((buf = nva->nva_ops->nv_ao_alloc(nva, size)) != NULL)
202 nv_mem_free(nvpriv_t *nvp, void *buf, size_t size)
204 nv_alloc_t *nva = nvp->nvp_nva;
206 nva->nva_ops->nv_ao_free(nva, buf, size);
210 nv_priv_init(nvpriv_t *priv, nv_alloc_t *nva, uint32_t stat)
212 bzero(priv, sizeof (nvpriv_t));
215 priv->nvp_stat = stat;
219 nv_priv_alloc(nv_alloc_t *nva)
224 * nv_mem_alloc() cannot called here because it needs the priv
227 if ((priv = nva->nva_ops->nv_ao_alloc(nva, sizeof (nvpriv_t))) == NULL)
230 nv_priv_init(priv, nva, 0);
236 * Embedded lists need their own nvpriv_t's. We create a new
237 * nvpriv_t using the parameters and allocator from the parent
241 nv_priv_alloc_embedded(nvpriv_t *priv)
245 if ((emb_priv = nv_mem_zalloc(priv, sizeof (nvpriv_t))) == NULL)
248 nv_priv_init(emb_priv, priv->nvp_nva, NV_STAT_EMBEDDED);
254 nvlist_init(nvlist_t *nvl, uint32_t nvflag, nvpriv_t *priv)
256 nvl->nvl_version = NV_VERSION;
257 nvl->nvl_nvflag = nvflag & (NV_UNIQUE_NAME|NV_UNIQUE_NAME_TYPE);
258 nvl->nvl_priv = (uint64_t)(uintptr_t)priv;
264 nvlist_nvflag(nvlist_t *nvl)
266 return (nvl->nvl_nvflag);
270 * nvlist_alloc - Allocate nvlist.
274 nvlist_alloc(nvlist_t **nvlp, uint_t nvflag, int kmflag)
276 #if defined(_KERNEL) && !defined(_BOOT)
277 return (nvlist_xalloc(nvlp, nvflag,
278 (kmflag == KM_SLEEP ? nv_alloc_sleep : nv_alloc_nosleep)));
280 return (nvlist_xalloc(nvlp, nvflag, nv_alloc_nosleep));
285 nvlist_xalloc(nvlist_t **nvlp, uint_t nvflag, nv_alloc_t *nva)
289 if (nvlp == NULL || nva == NULL)
292 if ((priv = nv_priv_alloc(nva)) == NULL)
295 if ((*nvlp = nv_mem_zalloc(priv,
296 NV_ALIGN(sizeof (nvlist_t)))) == NULL) {
297 nv_mem_free(priv, priv, sizeof (nvpriv_t));
301 nvlist_init(*nvlp, nvflag, priv);
307 * nvp_buf_alloc - Allocate i_nvp_t for storing a new nv pair.
310 nvp_buf_alloc(nvlist_t *nvl, size_t len)
312 nvpriv_t *priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv;
318 * Allocate the buffer
320 nvsize = len + offsetof(i_nvp_t, nvi_nvp);
322 if ((buf = nv_mem_zalloc(priv, nvsize)) == NULL)
332 * nvp_buf_free - de-Allocate an i_nvp_t.
335 nvp_buf_free(nvlist_t *nvl, nvpair_t *nvp)
337 nvpriv_t *priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv;
338 size_t nvsize = nvp->nvp_size + offsetof(i_nvp_t, nvi_nvp);
340 nv_mem_free(priv, NVPAIR2I_NVP(nvp), nvsize);
344 * nvp_buf_link - link a new nv pair into the nvlist.
347 nvp_buf_link(nvlist_t *nvl, nvpair_t *nvp)
349 nvpriv_t *priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv;
350 i_nvp_t *curr = NVPAIR2I_NVP(nvp);
352 /* Put element at end of nvlist */
353 if (priv->nvp_list == NULL) {
354 priv->nvp_list = priv->nvp_last = curr;
356 curr->nvi_prev = priv->nvp_last;
357 priv->nvp_last->nvi_next = curr;
358 priv->nvp_last = curr;
363 * nvp_buf_unlink - unlink an removed nvpair out of the nvlist.
366 nvp_buf_unlink(nvlist_t *nvl, nvpair_t *nvp)
368 nvpriv_t *priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv;
369 i_nvp_t *curr = NVPAIR2I_NVP(nvp);
372 * protect nvlist_next_nvpair() against walking on freed memory.
374 if (priv->nvp_curr == curr)
375 priv->nvp_curr = curr->nvi_next;
377 if (curr == priv->nvp_list)
378 priv->nvp_list = curr->nvi_next;
380 curr->nvi_prev->nvi_next = curr->nvi_next;
382 if (curr == priv->nvp_last)
383 priv->nvp_last = curr->nvi_prev;
385 curr->nvi_next->nvi_prev = curr->nvi_prev;
389 * take a nvpair type and number of elements and make sure the are valid
392 i_validate_type_nelem(data_type_t type, uint_t nelem)
395 case DATA_TYPE_BOOLEAN:
399 case DATA_TYPE_BOOLEAN_VALUE:
402 case DATA_TYPE_UINT8:
403 case DATA_TYPE_INT16:
404 case DATA_TYPE_UINT16:
405 case DATA_TYPE_INT32:
406 case DATA_TYPE_UINT32:
407 case DATA_TYPE_INT64:
408 case DATA_TYPE_UINT64:
409 case DATA_TYPE_STRING:
410 case DATA_TYPE_HRTIME:
411 case DATA_TYPE_NVLIST:
412 #if !defined(_KERNEL)
413 case DATA_TYPE_DOUBLE:
418 case DATA_TYPE_BOOLEAN_ARRAY:
419 case DATA_TYPE_BYTE_ARRAY:
420 case DATA_TYPE_INT8_ARRAY:
421 case DATA_TYPE_UINT8_ARRAY:
422 case DATA_TYPE_INT16_ARRAY:
423 case DATA_TYPE_UINT16_ARRAY:
424 case DATA_TYPE_INT32_ARRAY:
425 case DATA_TYPE_UINT32_ARRAY:
426 case DATA_TYPE_INT64_ARRAY:
427 case DATA_TYPE_UINT64_ARRAY:
428 case DATA_TYPE_STRING_ARRAY:
429 case DATA_TYPE_NVLIST_ARRAY:
430 /* we allow arrays with 0 elements */
439 * Verify nvp_name_sz and check the name string length.
442 i_validate_nvpair_name(nvpair_t *nvp)
444 if ((nvp->nvp_name_sz <= 0) ||
445 (nvp->nvp_size < NVP_SIZE_CALC(nvp->nvp_name_sz, 0)))
448 /* verify the name string, make sure its terminated */
449 if (NVP_NAME(nvp)[nvp->nvp_name_sz - 1] != '\0')
452 return (strlen(NVP_NAME(nvp)) == nvp->nvp_name_sz - 1 ? 0 : EFAULT);
456 i_validate_nvpair_value(data_type_t type, uint_t nelem, const void *data)
459 case DATA_TYPE_BOOLEAN_VALUE:
460 if (*(boolean_t *)data != B_TRUE &&
461 *(boolean_t *)data != B_FALSE)
464 case DATA_TYPE_BOOLEAN_ARRAY: {
467 for (i = 0; i < nelem; i++)
468 if (((boolean_t *)data)[i] != B_TRUE &&
469 ((boolean_t *)data)[i] != B_FALSE)
481 * This function takes a pointer to what should be a nvpair and it's size
482 * and then verifies that all the nvpair fields make sense and can be
483 * trusted. This function is used when decoding packed nvpairs.
486 i_validate_nvpair(nvpair_t *nvp)
488 data_type_t type = NVP_TYPE(nvp);
491 /* verify nvp_name_sz, check the name string length */
492 if (i_validate_nvpair_name(nvp) != 0)
495 if (i_validate_nvpair_value(type, NVP_NELEM(nvp), NVP_VALUE(nvp)) != 0)
499 * verify nvp_type, nvp_value_elem, and also possibly
500 * verify string values and get the value size.
502 size2 = i_get_value_size(type, NVP_VALUE(nvp), NVP_NELEM(nvp));
503 size1 = nvp->nvp_size - NVP_VALOFF(nvp);
504 if (size2 < 0 || size1 != NV_ALIGN(size2))
511 nvlist_copy_pairs(nvlist_t *snvl, nvlist_t *dnvl)
516 if ((priv = (nvpriv_t *)(uintptr_t)snvl->nvl_priv) == NULL)
519 for (curr = priv->nvp_list; curr != NULL; curr = curr->nvi_next) {
520 nvpair_t *nvp = &curr->nvi_nvp;
523 if ((err = nvlist_add_common(dnvl, NVP_NAME(nvp), NVP_TYPE(nvp),
524 NVP_NELEM(nvp), NVP_VALUE(nvp))) != 0)
532 * Frees all memory allocated for an nvpair (like embedded lists) with
533 * the exception of the nvpair buffer itself.
536 nvpair_free(nvpair_t *nvp)
538 switch (NVP_TYPE(nvp)) {
539 case DATA_TYPE_NVLIST:
540 nvlist_free(EMBEDDED_NVL(nvp));
542 case DATA_TYPE_NVLIST_ARRAY: {
543 nvlist_t **nvlp = EMBEDDED_NVL_ARRAY(nvp);
546 for (i = 0; i < NVP_NELEM(nvp); i++)
548 nvlist_free(nvlp[i]);
557 * nvlist_free - free an unpacked nvlist
560 nvlist_free(nvlist_t *nvl)
566 (priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv) == NULL)
570 * Unpacked nvlist are linked through i_nvp_t
572 curr = priv->nvp_list;
573 while (curr != NULL) {
574 nvpair_t *nvp = &curr->nvi_nvp;
575 curr = curr->nvi_next;
578 nvp_buf_free(nvl, nvp);
581 if (!(priv->nvp_stat & NV_STAT_EMBEDDED))
582 nv_mem_free(priv, nvl, NV_ALIGN(sizeof (nvlist_t)));
586 nv_mem_free(priv, priv, sizeof (nvpriv_t));
590 nvlist_contains_nvp(nvlist_t *nvl, nvpair_t *nvp)
592 nvpriv_t *priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv;
598 for (curr = priv->nvp_list; curr != NULL; curr = curr->nvi_next)
599 if (&curr->nvi_nvp == nvp)
606 * Make a copy of nvlist
610 nvlist_dup(nvlist_t *nvl, nvlist_t **nvlp, int kmflag)
612 #if defined(_KERNEL) && !defined(_BOOT)
613 return (nvlist_xdup(nvl, nvlp,
614 (kmflag == KM_SLEEP ? nv_alloc_sleep : nv_alloc_nosleep)));
616 return (nvlist_xdup(nvl, nvlp, nv_alloc_nosleep));
621 nvlist_xdup(nvlist_t *nvl, nvlist_t **nvlp, nv_alloc_t *nva)
626 if (nvl == NULL || nvlp == NULL)
629 if ((err = nvlist_xalloc(&ret, nvl->nvl_nvflag, nva)) != 0)
632 if ((err = nvlist_copy_pairs(nvl, ret)) != 0)
641 * Remove all with matching name
644 nvlist_remove_all(nvlist_t *nvl, const char *name)
650 if (nvl == NULL || name == NULL ||
651 (priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv) == NULL)
654 curr = priv->nvp_list;
655 while (curr != NULL) {
656 nvpair_t *nvp = &curr->nvi_nvp;
658 curr = curr->nvi_next;
659 if (strcmp(name, NVP_NAME(nvp)) != 0)
662 nvp_buf_unlink(nvl, nvp);
664 nvp_buf_free(nvl, nvp);
673 * Remove first one with matching name and type
676 nvlist_remove(nvlist_t *nvl, const char *name, data_type_t type)
681 if (nvl == NULL || name == NULL ||
682 (priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv) == NULL)
685 curr = priv->nvp_list;
686 while (curr != NULL) {
687 nvpair_t *nvp = &curr->nvi_nvp;
689 if (strcmp(name, NVP_NAME(nvp)) == 0 && NVP_TYPE(nvp) == type) {
690 nvp_buf_unlink(nvl, nvp);
692 nvp_buf_free(nvl, nvp);
696 curr = curr->nvi_next;
703 nvlist_remove_nvpair(nvlist_t *nvl, nvpair_t *nvp)
705 if (nvl == NULL || nvp == NULL)
708 nvp_buf_unlink(nvl, nvp);
710 nvp_buf_free(nvl, nvp);
715 * This function calculates the size of an nvpair value.
717 * The data argument controls the behavior in case of the data types
718 * DATA_TYPE_STRING and
719 * DATA_TYPE_STRING_ARRAY
720 * Is data == NULL then the size of the string(s) is excluded.
723 i_get_value_size(data_type_t type, const void *data, uint_t nelem)
727 if (i_validate_type_nelem(type, nelem) != 0)
730 /* Calculate required size for holding value */
732 case DATA_TYPE_BOOLEAN:
735 case DATA_TYPE_BOOLEAN_VALUE:
736 value_sz = sizeof (boolean_t);
739 value_sz = sizeof (uchar_t);
742 value_sz = sizeof (int8_t);
744 case DATA_TYPE_UINT8:
745 value_sz = sizeof (uint8_t);
747 case DATA_TYPE_INT16:
748 value_sz = sizeof (int16_t);
750 case DATA_TYPE_UINT16:
751 value_sz = sizeof (uint16_t);
753 case DATA_TYPE_INT32:
754 value_sz = sizeof (int32_t);
756 case DATA_TYPE_UINT32:
757 value_sz = sizeof (uint32_t);
759 case DATA_TYPE_INT64:
760 value_sz = sizeof (int64_t);
762 case DATA_TYPE_UINT64:
763 value_sz = sizeof (uint64_t);
765 #if !defined(_KERNEL)
766 case DATA_TYPE_DOUBLE:
767 value_sz = sizeof (double);
770 case DATA_TYPE_STRING:
774 value_sz = strlen(data) + 1;
776 case DATA_TYPE_BOOLEAN_ARRAY:
777 value_sz = (uint64_t)nelem * sizeof (boolean_t);
779 case DATA_TYPE_BYTE_ARRAY:
780 value_sz = (uint64_t)nelem * sizeof (uchar_t);
782 case DATA_TYPE_INT8_ARRAY:
783 value_sz = (uint64_t)nelem * sizeof (int8_t);
785 case DATA_TYPE_UINT8_ARRAY:
786 value_sz = (uint64_t)nelem * sizeof (uint8_t);
788 case DATA_TYPE_INT16_ARRAY:
789 value_sz = (uint64_t)nelem * sizeof (int16_t);
791 case DATA_TYPE_UINT16_ARRAY:
792 value_sz = (uint64_t)nelem * sizeof (uint16_t);
794 case DATA_TYPE_INT32_ARRAY:
795 value_sz = (uint64_t)nelem * sizeof (int32_t);
797 case DATA_TYPE_UINT32_ARRAY:
798 value_sz = (uint64_t)nelem * sizeof (uint32_t);
800 case DATA_TYPE_INT64_ARRAY:
801 value_sz = (uint64_t)nelem * sizeof (int64_t);
803 case DATA_TYPE_UINT64_ARRAY:
804 value_sz = (uint64_t)nelem * sizeof (uint64_t);
806 case DATA_TYPE_STRING_ARRAY:
807 value_sz = (uint64_t)nelem * sizeof (uint64_t);
810 char *const *strs = data;
813 /* no alignment requirement for strings */
814 for (i = 0; i < nelem; i++) {
817 value_sz += strlen(strs[i]) + 1;
821 case DATA_TYPE_HRTIME:
822 value_sz = sizeof (hrtime_t);
824 case DATA_TYPE_NVLIST:
825 value_sz = NV_ALIGN(sizeof (nvlist_t));
827 case DATA_TYPE_NVLIST_ARRAY:
828 value_sz = (uint64_t)nelem * sizeof (uint64_t) +
829 (uint64_t)nelem * NV_ALIGN(sizeof (nvlist_t));
835 return (value_sz > INT32_MAX ? -1 : (int)value_sz);
839 nvlist_copy_embedded(nvlist_t *nvl, nvlist_t *onvl, nvlist_t *emb_nvl)
844 if ((priv = nv_priv_alloc_embedded((nvpriv_t *)(uintptr_t)
845 nvl->nvl_priv)) == NULL)
848 nvlist_init(emb_nvl, onvl->nvl_nvflag, priv);
850 if ((err = nvlist_copy_pairs(onvl, emb_nvl)) != 0) {
851 nvlist_free(emb_nvl);
852 emb_nvl->nvl_priv = 0;
859 * nvlist_add_common - Add new <name,value> pair to nvlist
862 nvlist_add_common(nvlist_t *nvl, const char *name,
863 data_type_t type, uint_t nelem, const void *data)
868 int nvp_sz, name_sz, value_sz;
871 if (name == NULL || nvl == NULL || nvl->nvl_priv == 0)
874 if (nelem != 0 && data == NULL)
878 * Verify type and nelem and get the value size.
879 * In case of data types DATA_TYPE_STRING and DATA_TYPE_STRING_ARRAY
880 * is the size of the string(s) included.
882 if ((value_sz = i_get_value_size(type, data, nelem)) < 0)
885 if (i_validate_nvpair_value(type, nelem, data) != 0)
889 * If we're adding an nvlist or nvlist array, ensure that we are not
890 * adding the input nvlist to itself, which would cause recursion,
891 * and ensure that no NULL nvlist pointers are present.
894 case DATA_TYPE_NVLIST:
895 if (data == nvl || data == NULL)
898 case DATA_TYPE_NVLIST_ARRAY: {
899 nvlist_t **onvlp = (nvlist_t **)data;
900 for (i = 0; i < nelem; i++) {
901 if (onvlp[i] == nvl || onvlp[i] == NULL)
910 /* calculate sizes of the nvpair elements and the nvpair itself */
911 name_sz = strlen(name) + 1;
913 nvp_sz = NVP_SIZE_CALC(name_sz, value_sz);
915 if ((nvp = nvp_buf_alloc(nvl, nvp_sz)) == NULL)
918 ASSERT(nvp->nvp_size == nvp_sz);
919 nvp->nvp_name_sz = name_sz;
920 nvp->nvp_value_elem = nelem;
921 nvp->nvp_type = type;
922 bcopy(name, NVP_NAME(nvp), name_sz);
925 case DATA_TYPE_BOOLEAN:
927 case DATA_TYPE_STRING_ARRAY: {
928 char *const *strs = data;
929 char *buf = NVP_VALUE(nvp);
930 char **cstrs = (void *)buf;
932 /* skip pre-allocated space for pointer array */
933 buf += nelem * sizeof (uint64_t);
934 for (i = 0; i < nelem; i++) {
935 int slen = strlen(strs[i]) + 1;
936 bcopy(strs[i], buf, slen);
942 case DATA_TYPE_NVLIST: {
943 nvlist_t *nnvl = EMBEDDED_NVL(nvp);
944 nvlist_t *onvl = (nvlist_t *)data;
946 if ((err = nvlist_copy_embedded(nvl, onvl, nnvl)) != 0) {
947 nvp_buf_free(nvl, nvp);
952 case DATA_TYPE_NVLIST_ARRAY: {
953 nvlist_t **onvlp = (nvlist_t **)data;
954 nvlist_t **nvlp = EMBEDDED_NVL_ARRAY(nvp);
955 nvlist_t *embedded = (nvlist_t *)
956 ((uintptr_t)nvlp + nelem * sizeof (uint64_t));
958 for (i = 0; i < nelem; i++) {
959 if ((err = nvlist_copy_embedded(nvl,
960 onvlp[i], embedded)) != 0) {
962 * Free any successfully created lists
965 nvp_buf_free(nvl, nvp);
969 nvlp[i] = embedded++;
974 bcopy(data, NVP_VALUE(nvp), value_sz);
977 /* if unique name, remove before add */
978 if (nvl->nvl_nvflag & NV_UNIQUE_NAME)
979 (void) nvlist_remove_all(nvl, name);
980 else if (nvl->nvl_nvflag & NV_UNIQUE_NAME_TYPE)
981 (void) nvlist_remove(nvl, name, type);
983 nvp_buf_link(nvl, nvp);
989 nvlist_add_boolean(nvlist_t *nvl, const char *name)
991 return (nvlist_add_common(nvl, name, DATA_TYPE_BOOLEAN, 0, NULL));
995 nvlist_add_boolean_value(nvlist_t *nvl, const char *name, boolean_t val)
997 return (nvlist_add_common(nvl, name, DATA_TYPE_BOOLEAN_VALUE, 1, &val));
1001 nvlist_add_byte(nvlist_t *nvl, const char *name, uchar_t val)
1003 return (nvlist_add_common(nvl, name, DATA_TYPE_BYTE, 1, &val));
1007 nvlist_add_int8(nvlist_t *nvl, const char *name, int8_t val)
1009 return (nvlist_add_common(nvl, name, DATA_TYPE_INT8, 1, &val));
1013 nvlist_add_uint8(nvlist_t *nvl, const char *name, uint8_t val)
1015 return (nvlist_add_common(nvl, name, DATA_TYPE_UINT8, 1, &val));
1019 nvlist_add_int16(nvlist_t *nvl, const char *name, int16_t val)
1021 return (nvlist_add_common(nvl, name, DATA_TYPE_INT16, 1, &val));
1025 nvlist_add_uint16(nvlist_t *nvl, const char *name, uint16_t val)
1027 return (nvlist_add_common(nvl, name, DATA_TYPE_UINT16, 1, &val));
1031 nvlist_add_int32(nvlist_t *nvl, const char *name, int32_t val)
1033 return (nvlist_add_common(nvl, name, DATA_TYPE_INT32, 1, &val));
1037 nvlist_add_uint32(nvlist_t *nvl, const char *name, uint32_t val)
1039 return (nvlist_add_common(nvl, name, DATA_TYPE_UINT32, 1, &val));
1043 nvlist_add_int64(nvlist_t *nvl, const char *name, int64_t val)
1045 return (nvlist_add_common(nvl, name, DATA_TYPE_INT64, 1, &val));
1049 nvlist_add_uint64(nvlist_t *nvl, const char *name, uint64_t val)
1051 return (nvlist_add_common(nvl, name, DATA_TYPE_UINT64, 1, &val));
1054 #if !defined(_KERNEL)
1056 nvlist_add_double(nvlist_t *nvl, const char *name, double val)
1058 return (nvlist_add_common(nvl, name, DATA_TYPE_DOUBLE, 1, &val));
1063 nvlist_add_string(nvlist_t *nvl, const char *name, const char *val)
1065 return (nvlist_add_common(nvl, name, DATA_TYPE_STRING, 1, (void *)val));
1069 nvlist_add_boolean_array(nvlist_t *nvl, const char *name,
1070 boolean_t *a, uint_t n)
1072 return (nvlist_add_common(nvl, name, DATA_TYPE_BOOLEAN_ARRAY, n, a));
1076 nvlist_add_byte_array(nvlist_t *nvl, const char *name, uchar_t *a, uint_t n)
1078 return (nvlist_add_common(nvl, name, DATA_TYPE_BYTE_ARRAY, n, a));
1082 nvlist_add_int8_array(nvlist_t *nvl, const char *name, int8_t *a, uint_t n)
1084 return (nvlist_add_common(nvl, name, DATA_TYPE_INT8_ARRAY, n, a));
1088 nvlist_add_uint8_array(nvlist_t *nvl, const char *name, uint8_t *a, uint_t n)
1090 return (nvlist_add_common(nvl, name, DATA_TYPE_UINT8_ARRAY, n, a));
1094 nvlist_add_int16_array(nvlist_t *nvl, const char *name, int16_t *a, uint_t n)
1096 return (nvlist_add_common(nvl, name, DATA_TYPE_INT16_ARRAY, n, a));
1100 nvlist_add_uint16_array(nvlist_t *nvl, const char *name, uint16_t *a, uint_t n)
1102 return (nvlist_add_common(nvl, name, DATA_TYPE_UINT16_ARRAY, n, a));
1106 nvlist_add_int32_array(nvlist_t *nvl, const char *name, int32_t *a, uint_t n)
1108 return (nvlist_add_common(nvl, name, DATA_TYPE_INT32_ARRAY, n, a));
1112 nvlist_add_uint32_array(nvlist_t *nvl, const char *name, uint32_t *a, uint_t n)
1114 return (nvlist_add_common(nvl, name, DATA_TYPE_UINT32_ARRAY, n, a));
1118 nvlist_add_int64_array(nvlist_t *nvl, const char *name, int64_t *a, uint_t n)
1120 return (nvlist_add_common(nvl, name, DATA_TYPE_INT64_ARRAY, n, a));
1124 nvlist_add_uint64_array(nvlist_t *nvl, const char *name, uint64_t *a, uint_t n)
1126 return (nvlist_add_common(nvl, name, DATA_TYPE_UINT64_ARRAY, n, a));
1130 nvlist_add_string_array(nvlist_t *nvl, const char *name,
1131 char *const *a, uint_t n)
1133 return (nvlist_add_common(nvl, name, DATA_TYPE_STRING_ARRAY, n, a));
1137 nvlist_add_hrtime(nvlist_t *nvl, const char *name, hrtime_t val)
1139 return (nvlist_add_common(nvl, name, DATA_TYPE_HRTIME, 1, &val));
1143 nvlist_add_nvlist(nvlist_t *nvl, const char *name, nvlist_t *val)
1145 return (nvlist_add_common(nvl, name, DATA_TYPE_NVLIST, 1, val));
1149 nvlist_add_nvlist_array(nvlist_t *nvl, const char *name, nvlist_t **a, uint_t n)
1151 return (nvlist_add_common(nvl, name, DATA_TYPE_NVLIST_ARRAY, n, a));
1154 /* reading name-value pairs */
1156 nvlist_next_nvpair(nvlist_t *nvl, nvpair_t *nvp)
1162 (priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv) == NULL)
1165 curr = NVPAIR2I_NVP(nvp);
1168 * Ensure that nvp is a valid nvpair on this nvlist.
1169 * NB: nvp_curr is used only as a hint so that we don't always
1170 * have to walk the list to determine if nvp is still on the list.
1173 curr = priv->nvp_list;
1174 else if (priv->nvp_curr == curr || nvlist_contains_nvp(nvl, nvp))
1175 curr = curr->nvi_next;
1179 priv->nvp_curr = curr;
1181 return (curr != NULL ? &curr->nvi_nvp : NULL);
1185 nvlist_prev_nvpair(nvlist_t *nvl, nvpair_t *nvp)
1191 (priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv) == NULL)
1194 curr = NVPAIR2I_NVP(nvp);
1197 curr = priv->nvp_last;
1198 else if (priv->nvp_curr == curr || nvlist_contains_nvp(nvl, nvp))
1199 curr = curr->nvi_prev;
1203 priv->nvp_curr = curr;
1205 return (curr != NULL ? &curr->nvi_nvp : NULL);
1209 nvlist_empty(nvlist_t *nvl)
1214 (priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv) == NULL)
1217 return (priv->nvp_list == NULL);
1221 nvpair_name(nvpair_t *nvp)
1223 return (NVP_NAME(nvp));
1227 nvpair_type(nvpair_t *nvp)
1229 return (NVP_TYPE(nvp));
1233 nvpair_type_is_array(nvpair_t *nvp)
1235 data_type_t type = NVP_TYPE(nvp);
1237 if ((type == DATA_TYPE_BYTE_ARRAY) ||
1238 (type == DATA_TYPE_INT8_ARRAY) ||
1239 (type == DATA_TYPE_UINT8_ARRAY) ||
1240 (type == DATA_TYPE_INT16_ARRAY) ||
1241 (type == DATA_TYPE_UINT16_ARRAY) ||
1242 (type == DATA_TYPE_INT32_ARRAY) ||
1243 (type == DATA_TYPE_UINT32_ARRAY) ||
1244 (type == DATA_TYPE_INT64_ARRAY) ||
1245 (type == DATA_TYPE_UINT64_ARRAY) ||
1246 (type == DATA_TYPE_BOOLEAN_ARRAY) ||
1247 (type == DATA_TYPE_STRING_ARRAY) ||
1248 (type == DATA_TYPE_NVLIST_ARRAY))
1255 nvpair_value_common(nvpair_t *nvp, data_type_t type, uint_t *nelem, void *data)
1257 if (nvp == NULL || nvpair_type(nvp) != type)
1261 * For non-array types, we copy the data.
1262 * For array types (including string), we set a pointer.
1265 case DATA_TYPE_BOOLEAN:
1270 case DATA_TYPE_BOOLEAN_VALUE:
1271 case DATA_TYPE_BYTE:
1272 case DATA_TYPE_INT8:
1273 case DATA_TYPE_UINT8:
1274 case DATA_TYPE_INT16:
1275 case DATA_TYPE_UINT16:
1276 case DATA_TYPE_INT32:
1277 case DATA_TYPE_UINT32:
1278 case DATA_TYPE_INT64:
1279 case DATA_TYPE_UINT64:
1280 case DATA_TYPE_HRTIME:
1281 #if !defined(_KERNEL)
1282 case DATA_TYPE_DOUBLE:
1286 bcopy(NVP_VALUE(nvp), data,
1287 (size_t)i_get_value_size(type, NULL, 1));
1292 case DATA_TYPE_NVLIST:
1293 case DATA_TYPE_STRING:
1296 *(void **)data = (void *)NVP_VALUE(nvp);
1301 case DATA_TYPE_BOOLEAN_ARRAY:
1302 case DATA_TYPE_BYTE_ARRAY:
1303 case DATA_TYPE_INT8_ARRAY:
1304 case DATA_TYPE_UINT8_ARRAY:
1305 case DATA_TYPE_INT16_ARRAY:
1306 case DATA_TYPE_UINT16_ARRAY:
1307 case DATA_TYPE_INT32_ARRAY:
1308 case DATA_TYPE_UINT32_ARRAY:
1309 case DATA_TYPE_INT64_ARRAY:
1310 case DATA_TYPE_UINT64_ARRAY:
1311 case DATA_TYPE_STRING_ARRAY:
1312 case DATA_TYPE_NVLIST_ARRAY:
1313 if (nelem == NULL || data == NULL)
1315 if ((*nelem = NVP_NELEM(nvp)) != 0)
1316 *(void **)data = (void *)NVP_VALUE(nvp);
1318 *(void **)data = NULL;
1329 nvlist_lookup_common(nvlist_t *nvl, const char *name, data_type_t type,
1330 uint_t *nelem, void *data)
1336 if (name == NULL || nvl == NULL ||
1337 (priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv) == NULL)
1340 if (!(nvl->nvl_nvflag & (NV_UNIQUE_NAME | NV_UNIQUE_NAME_TYPE)))
1343 for (curr = priv->nvp_list; curr != NULL; curr = curr->nvi_next) {
1344 nvp = &curr->nvi_nvp;
1346 if (strcmp(name, NVP_NAME(nvp)) == 0 && NVP_TYPE(nvp) == type)
1347 return (nvpair_value_common(nvp, type, nelem, data));
1354 nvlist_lookup_boolean(nvlist_t *nvl, const char *name)
1356 return (nvlist_lookup_common(nvl, name, DATA_TYPE_BOOLEAN, NULL, NULL));
1360 nvlist_lookup_boolean_value(nvlist_t *nvl, const char *name, boolean_t *val)
1362 return (nvlist_lookup_common(nvl, name,
1363 DATA_TYPE_BOOLEAN_VALUE, NULL, val));
1367 nvlist_lookup_byte(nvlist_t *nvl, const char *name, uchar_t *val)
1369 return (nvlist_lookup_common(nvl, name, DATA_TYPE_BYTE, NULL, val));
1373 nvlist_lookup_int8(nvlist_t *nvl, const char *name, int8_t *val)
1375 return (nvlist_lookup_common(nvl, name, DATA_TYPE_INT8, NULL, val));
1379 nvlist_lookup_uint8(nvlist_t *nvl, const char *name, uint8_t *val)
1381 return (nvlist_lookup_common(nvl, name, DATA_TYPE_UINT8, NULL, val));
1385 nvlist_lookup_int16(nvlist_t *nvl, const char *name, int16_t *val)
1387 return (nvlist_lookup_common(nvl, name, DATA_TYPE_INT16, NULL, val));
1391 nvlist_lookup_uint16(nvlist_t *nvl, const char *name, uint16_t *val)
1393 return (nvlist_lookup_common(nvl, name, DATA_TYPE_UINT16, NULL, val));
1397 nvlist_lookup_int32(nvlist_t *nvl, const char *name, int32_t *val)
1399 return (nvlist_lookup_common(nvl, name, DATA_TYPE_INT32, NULL, val));
1403 nvlist_lookup_uint32(nvlist_t *nvl, const char *name, uint32_t *val)
1405 return (nvlist_lookup_common(nvl, name, DATA_TYPE_UINT32, NULL, val));
1409 nvlist_lookup_int64(nvlist_t *nvl, const char *name, int64_t *val)
1411 return (nvlist_lookup_common(nvl, name, DATA_TYPE_INT64, NULL, val));
1415 nvlist_lookup_uint64(nvlist_t *nvl, const char *name, uint64_t *val)
1417 return (nvlist_lookup_common(nvl, name, DATA_TYPE_UINT64, NULL, val));
1420 #if !defined(_KERNEL)
1422 nvlist_lookup_double(nvlist_t *nvl, const char *name, double *val)
1424 return (nvlist_lookup_common(nvl, name, DATA_TYPE_DOUBLE, NULL, val));
1429 nvlist_lookup_string(nvlist_t *nvl, const char *name, char **val)
1431 return (nvlist_lookup_common(nvl, name, DATA_TYPE_STRING, NULL, val));
1435 nvlist_lookup_nvlist(nvlist_t *nvl, const char *name, nvlist_t **val)
1437 return (nvlist_lookup_common(nvl, name, DATA_TYPE_NVLIST, NULL, val));
1441 nvlist_lookup_boolean_array(nvlist_t *nvl, const char *name,
1442 boolean_t **a, uint_t *n)
1444 return (nvlist_lookup_common(nvl, name,
1445 DATA_TYPE_BOOLEAN_ARRAY, n, a));
1449 nvlist_lookup_byte_array(nvlist_t *nvl, const char *name,
1450 uchar_t **a, uint_t *n)
1452 return (nvlist_lookup_common(nvl, name, DATA_TYPE_BYTE_ARRAY, n, a));
1456 nvlist_lookup_int8_array(nvlist_t *nvl, const char *name, int8_t **a, uint_t *n)
1458 return (nvlist_lookup_common(nvl, name, DATA_TYPE_INT8_ARRAY, n, a));
1462 nvlist_lookup_uint8_array(nvlist_t *nvl, const char *name,
1463 uint8_t **a, uint_t *n)
1465 return (nvlist_lookup_common(nvl, name, DATA_TYPE_UINT8_ARRAY, n, a));
1469 nvlist_lookup_int16_array(nvlist_t *nvl, const char *name,
1470 int16_t **a, uint_t *n)
1472 return (nvlist_lookup_common(nvl, name, DATA_TYPE_INT16_ARRAY, n, a));
1476 nvlist_lookup_uint16_array(nvlist_t *nvl, const char *name,
1477 uint16_t **a, uint_t *n)
1479 return (nvlist_lookup_common(nvl, name, DATA_TYPE_UINT16_ARRAY, n, a));
1483 nvlist_lookup_int32_array(nvlist_t *nvl, const char *name,
1484 int32_t **a, uint_t *n)
1486 return (nvlist_lookup_common(nvl, name, DATA_TYPE_INT32_ARRAY, n, a));
1490 nvlist_lookup_uint32_array(nvlist_t *nvl, const char *name,
1491 uint32_t **a, uint_t *n)
1493 return (nvlist_lookup_common(nvl, name, DATA_TYPE_UINT32_ARRAY, n, a));
1497 nvlist_lookup_int64_array(nvlist_t *nvl, const char *name,
1498 int64_t **a, uint_t *n)
1500 return (nvlist_lookup_common(nvl, name, DATA_TYPE_INT64_ARRAY, n, a));
1504 nvlist_lookup_uint64_array(nvlist_t *nvl, const char *name,
1505 uint64_t **a, uint_t *n)
1507 return (nvlist_lookup_common(nvl, name, DATA_TYPE_UINT64_ARRAY, n, a));
1511 nvlist_lookup_string_array(nvlist_t *nvl, const char *name,
1512 char ***a, uint_t *n)
1514 return (nvlist_lookup_common(nvl, name, DATA_TYPE_STRING_ARRAY, n, a));
1518 nvlist_lookup_nvlist_array(nvlist_t *nvl, const char *name,
1519 nvlist_t ***a, uint_t *n)
1521 return (nvlist_lookup_common(nvl, name, DATA_TYPE_NVLIST_ARRAY, n, a));
1525 nvlist_lookup_hrtime(nvlist_t *nvl, const char *name, hrtime_t *val)
1527 return (nvlist_lookup_common(nvl, name, DATA_TYPE_HRTIME, NULL, val));
1531 nvlist_lookup_pairs(nvlist_t *nvl, int flag, ...)
1535 int noentok = (flag & NV_FLAG_NOENTOK ? 1 : 0);
1539 while (ret == 0 && (name = va_arg(ap, char *)) != NULL) {
1544 switch (type = va_arg(ap, data_type_t)) {
1545 case DATA_TYPE_BOOLEAN:
1546 ret = nvlist_lookup_common(nvl, name, type, NULL, NULL);
1549 case DATA_TYPE_BOOLEAN_VALUE:
1550 case DATA_TYPE_BYTE:
1551 case DATA_TYPE_INT8:
1552 case DATA_TYPE_UINT8:
1553 case DATA_TYPE_INT16:
1554 case DATA_TYPE_UINT16:
1555 case DATA_TYPE_INT32:
1556 case DATA_TYPE_UINT32:
1557 case DATA_TYPE_INT64:
1558 case DATA_TYPE_UINT64:
1559 case DATA_TYPE_HRTIME:
1560 case DATA_TYPE_STRING:
1561 case DATA_TYPE_NVLIST:
1562 #if !defined(_KERNEL)
1563 case DATA_TYPE_DOUBLE:
1565 val = va_arg(ap, void *);
1566 ret = nvlist_lookup_common(nvl, name, type, NULL, val);
1569 case DATA_TYPE_BYTE_ARRAY:
1570 case DATA_TYPE_BOOLEAN_ARRAY:
1571 case DATA_TYPE_INT8_ARRAY:
1572 case DATA_TYPE_UINT8_ARRAY:
1573 case DATA_TYPE_INT16_ARRAY:
1574 case DATA_TYPE_UINT16_ARRAY:
1575 case DATA_TYPE_INT32_ARRAY:
1576 case DATA_TYPE_UINT32_ARRAY:
1577 case DATA_TYPE_INT64_ARRAY:
1578 case DATA_TYPE_UINT64_ARRAY:
1579 case DATA_TYPE_STRING_ARRAY:
1580 case DATA_TYPE_NVLIST_ARRAY:
1581 val = va_arg(ap, void *);
1582 nelem = va_arg(ap, uint_t *);
1583 ret = nvlist_lookup_common(nvl, name, type, nelem, val);
1590 if (ret == ENOENT && noentok)
1599 * Find the 'name'ed nvpair in the nvlist 'nvl'. If 'name' found, the function
1600 * returns zero and a pointer to the matching nvpair is returned in '*ret'
1601 * (given 'ret' is non-NULL). If 'sep' is specified then 'name' will penitrate
1602 * multiple levels of embedded nvlists, with 'sep' as the separator. As an
1603 * example, if sep is '.', name might look like: "a" or "a.b" or "a.c[3]" or
1604 * "a.d[3].e[1]". This matches the C syntax for array embed (for convience,
1605 * code also supports "a.d[3]e[1]" syntax).
1607 * If 'ip' is non-NULL and the last name component is an array, return the
1608 * value of the "...[index]" array index in *ip. For an array reference that
1609 * is not indexed, *ip will be returned as -1. If there is a syntax error in
1610 * 'name', and 'ep' is non-NULL then *ep will be set to point to the location
1611 * inside the 'name' string where the syntax error was detected.
1614 nvlist_lookup_nvpair_ei_sep(nvlist_t *nvl, const char *name, const char sep,
1615 nvpair_t **ret, int *ip, char **ep)
1626 *ip = -1; /* not indexed */
1630 if ((nvl == NULL) || (name == NULL))
1633 /* step through components of name */
1634 for (np = name; np && *np; np = sepp) {
1635 /* ensure unique names */
1636 if (!(nvl->nvl_nvflag & NV_UNIQUE_NAME))
1639 /* skip white space */
1640 skip_whitespace(np);
1644 /* set 'sepp' to end of current component 'np' */
1646 sepp = strchr(np, sep);
1650 /* find start of next "[ index ]..." */
1651 idxp = strchr(np, '[');
1653 /* if sepp comes first, set idxp to NULL */
1654 if (sepp && idxp && (sepp < idxp))
1658 * At this point 'idxp' is set if there is an index
1659 * expected for the current component.
1662 /* set 'n' to length of current 'np' name component */
1665 /* keep sepp up to date for *ep use as we advance */
1666 skip_whitespace(idxp);
1669 /* determine the index value */
1670 #if defined(_KERNEL) && !defined(_BOOT)
1671 if (ddi_strtol(idxp, &idxep, 0, &idx))
1674 idx = strtol(idxp, &idxep, 0);
1679 /* keep sepp up to date for *ep use as we advance */
1682 /* skip white space index value and check for ']' */
1683 skip_whitespace(sepp);
1687 /* for embedded arrays, support C syntax: "a[1].b" */
1688 skip_whitespace(sepp);
1689 if (sep && (*sepp == sep))
1697 /* trim trailing whitespace by reducing length of 'np' */
1700 for (n--; (np[n] == ' ') || (np[n] == '\t'); n--)
1704 /* skip whitespace, and set sepp to NULL if complete */
1706 skip_whitespace(sepp);
1713 * o 'n' is the length of current 'np' component.
1714 * o 'idxp' is set if there was an index, and value 'idx'.
1715 * o 'sepp' is set to the beginning of the next component,
1716 * and set to NULL if we have no more components.
1718 * Search for nvpair with matching component name.
1720 for (nvp = nvlist_next_nvpair(nvl, NULL); nvp != NULL;
1721 nvp = nvlist_next_nvpair(nvl, nvp)) {
1723 /* continue if no match on name */
1724 if (strncmp(np, nvpair_name(nvp), n) ||
1725 (strlen(nvpair_name(nvp)) != n))
1728 /* if indexed, verify type is array oriented */
1729 if (idxp && !nvpair_type_is_array(nvp))
1733 * Full match found, return nvp and idx if this
1734 * was the last component.
1740 *ip = (int)idx; /* return index */
1741 return (0); /* found */
1745 * More components: current match must be
1746 * of DATA_TYPE_NVLIST or DATA_TYPE_NVLIST_ARRAY
1747 * to support going deeper.
1749 if (nvpair_type(nvp) == DATA_TYPE_NVLIST) {
1750 nvl = EMBEDDED_NVL(nvp);
1752 } else if (nvpair_type(nvp) == DATA_TYPE_NVLIST_ARRAY) {
1753 (void) nvpair_value_nvlist_array(nvp,
1754 &nva, (uint_t *)&n);
1755 if ((n < 0) || (idx >= n))
1761 /* type does not support more levels */
1765 goto fail; /* 'name' not found */
1767 /* search for match of next component in embedded 'nvl' list */
1770 fail: if (ep && sepp)
1776 * Return pointer to nvpair with specified 'name'.
1779 nvlist_lookup_nvpair(nvlist_t *nvl, const char *name, nvpair_t **ret)
1781 return (nvlist_lookup_nvpair_ei_sep(nvl, name, 0, ret, NULL, NULL));
1785 * Determine if named nvpair exists in nvlist (use embedded separator of '.'
1786 * and return array index). See nvlist_lookup_nvpair_ei_sep for more detailed
1789 int nvlist_lookup_nvpair_embedded_index(nvlist_t *nvl,
1790 const char *name, nvpair_t **ret, int *ip, char **ep)
1792 return (nvlist_lookup_nvpair_ei_sep(nvl, name, '.', ret, ip, ep));
1796 nvlist_exists(nvlist_t *nvl, const char *name)
1802 if (name == NULL || nvl == NULL ||
1803 (priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv) == NULL)
1806 for (curr = priv->nvp_list; curr != NULL; curr = curr->nvi_next) {
1807 nvp = &curr->nvi_nvp;
1809 if (strcmp(name, NVP_NAME(nvp)) == 0)
1817 nvpair_value_boolean_value(nvpair_t *nvp, boolean_t *val)
1819 return (nvpair_value_common(nvp, DATA_TYPE_BOOLEAN_VALUE, NULL, val));
1823 nvpair_value_byte(nvpair_t *nvp, uchar_t *val)
1825 return (nvpair_value_common(nvp, DATA_TYPE_BYTE, NULL, val));
1829 nvpair_value_int8(nvpair_t *nvp, int8_t *val)
1831 return (nvpair_value_common(nvp, DATA_TYPE_INT8, NULL, val));
1835 nvpair_value_uint8(nvpair_t *nvp, uint8_t *val)
1837 return (nvpair_value_common(nvp, DATA_TYPE_UINT8, NULL, val));
1841 nvpair_value_int16(nvpair_t *nvp, int16_t *val)
1843 return (nvpair_value_common(nvp, DATA_TYPE_INT16, NULL, val));
1847 nvpair_value_uint16(nvpair_t *nvp, uint16_t *val)
1849 return (nvpair_value_common(nvp, DATA_TYPE_UINT16, NULL, val));
1853 nvpair_value_int32(nvpair_t *nvp, int32_t *val)
1855 return (nvpair_value_common(nvp, DATA_TYPE_INT32, NULL, val));
1859 nvpair_value_uint32(nvpair_t *nvp, uint32_t *val)
1861 return (nvpair_value_common(nvp, DATA_TYPE_UINT32, NULL, val));
1865 nvpair_value_int64(nvpair_t *nvp, int64_t *val)
1867 return (nvpair_value_common(nvp, DATA_TYPE_INT64, NULL, val));
1871 nvpair_value_uint64(nvpair_t *nvp, uint64_t *val)
1873 return (nvpair_value_common(nvp, DATA_TYPE_UINT64, NULL, val));
1876 #if !defined(_KERNEL)
1878 nvpair_value_double(nvpair_t *nvp, double *val)
1880 return (nvpair_value_common(nvp, DATA_TYPE_DOUBLE, NULL, val));
1885 nvpair_value_string(nvpair_t *nvp, char **val)
1887 return (nvpair_value_common(nvp, DATA_TYPE_STRING, NULL, val));
1891 nvpair_value_nvlist(nvpair_t *nvp, nvlist_t **val)
1893 return (nvpair_value_common(nvp, DATA_TYPE_NVLIST, NULL, val));
1897 nvpair_value_boolean_array(nvpair_t *nvp, boolean_t **val, uint_t *nelem)
1899 return (nvpair_value_common(nvp, DATA_TYPE_BOOLEAN_ARRAY, nelem, val));
1903 nvpair_value_byte_array(nvpair_t *nvp, uchar_t **val, uint_t *nelem)
1905 return (nvpair_value_common(nvp, DATA_TYPE_BYTE_ARRAY, nelem, val));
1909 nvpair_value_int8_array(nvpair_t *nvp, int8_t **val, uint_t *nelem)
1911 return (nvpair_value_common(nvp, DATA_TYPE_INT8_ARRAY, nelem, val));
1915 nvpair_value_uint8_array(nvpair_t *nvp, uint8_t **val, uint_t *nelem)
1917 return (nvpair_value_common(nvp, DATA_TYPE_UINT8_ARRAY, nelem, val));
1921 nvpair_value_int16_array(nvpair_t *nvp, int16_t **val, uint_t *nelem)
1923 return (nvpair_value_common(nvp, DATA_TYPE_INT16_ARRAY, nelem, val));
1927 nvpair_value_uint16_array(nvpair_t *nvp, uint16_t **val, uint_t *nelem)
1929 return (nvpair_value_common(nvp, DATA_TYPE_UINT16_ARRAY, nelem, val));
1933 nvpair_value_int32_array(nvpair_t *nvp, int32_t **val, uint_t *nelem)
1935 return (nvpair_value_common(nvp, DATA_TYPE_INT32_ARRAY, nelem, val));
1939 nvpair_value_uint32_array(nvpair_t *nvp, uint32_t **val, uint_t *nelem)
1941 return (nvpair_value_common(nvp, DATA_TYPE_UINT32_ARRAY, nelem, val));
1945 nvpair_value_int64_array(nvpair_t *nvp, int64_t **val, uint_t *nelem)
1947 return (nvpair_value_common(nvp, DATA_TYPE_INT64_ARRAY, nelem, val));
1951 nvpair_value_uint64_array(nvpair_t *nvp, uint64_t **val, uint_t *nelem)
1953 return (nvpair_value_common(nvp, DATA_TYPE_UINT64_ARRAY, nelem, val));
1957 nvpair_value_string_array(nvpair_t *nvp, char ***val, uint_t *nelem)
1959 return (nvpair_value_common(nvp, DATA_TYPE_STRING_ARRAY, nelem, val));
1963 nvpair_value_nvlist_array(nvpair_t *nvp, nvlist_t ***val, uint_t *nelem)
1965 return (nvpair_value_common(nvp, DATA_TYPE_NVLIST_ARRAY, nelem, val));
1969 nvpair_value_hrtime(nvpair_t *nvp, hrtime_t *val)
1971 return (nvpair_value_common(nvp, DATA_TYPE_HRTIME, NULL, val));
1975 * Add specified pair to the list.
1978 nvlist_add_nvpair(nvlist_t *nvl, nvpair_t *nvp)
1980 if (nvl == NULL || nvp == NULL)
1983 return (nvlist_add_common(nvl, NVP_NAME(nvp), NVP_TYPE(nvp),
1984 NVP_NELEM(nvp), NVP_VALUE(nvp)));
1988 * Merge the supplied nvlists and put the result in dst.
1989 * The merged list will contain all names specified in both lists,
1990 * the values are taken from nvl in the case of duplicates.
1991 * Return 0 on success.
1995 nvlist_merge(nvlist_t *dst, nvlist_t *nvl, int flag)
1997 if (nvl == NULL || dst == NULL)
2001 return (nvlist_copy_pairs(nvl, dst));
2007 * Encoding related routines
2009 #define NVS_OP_ENCODE 0
2010 #define NVS_OP_DECODE 1
2011 #define NVS_OP_GETSIZE 2
2013 typedef struct nvs_ops nvs_ops_t;
2017 const nvs_ops_t *nvs_ops;
2023 * nvs operations are:
2025 * encoding / decoding of a nvlist header (nvlist_t)
2026 * calculates the size used for header and end detection
2029 * responsible for the first part of encoding / decoding of an nvpair
2030 * calculates the decoded size of an nvpair
2033 * second part of encoding / decoding of an nvpair
2036 * calculates the encoding size of an nvpair
2039 * encodes the end detection mark (zeros).
2042 int (*nvs_nvlist)(nvstream_t *, nvlist_t *, size_t *);
2043 int (*nvs_nvpair)(nvstream_t *, nvpair_t *, size_t *);
2044 int (*nvs_nvp_op)(nvstream_t *, nvpair_t *);
2045 int (*nvs_nvp_size)(nvstream_t *, nvpair_t *, size_t *);
2046 int (*nvs_nvl_fini)(nvstream_t *);
2050 char nvh_encoding; /* nvs encoding method */
2051 char nvh_endian; /* nvs endian */
2052 char nvh_reserved1; /* reserved for future use */
2053 char nvh_reserved2; /* reserved for future use */
2057 nvs_encode_pairs(nvstream_t *nvs, nvlist_t *nvl)
2059 nvpriv_t *priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv;
2063 * Walk nvpair in list and encode each nvpair
2065 for (curr = priv->nvp_list; curr != NULL; curr = curr->nvi_next)
2066 if (nvs->nvs_ops->nvs_nvpair(nvs, &curr->nvi_nvp, NULL) != 0)
2069 return (nvs->nvs_ops->nvs_nvl_fini(nvs));
2073 nvs_decode_pairs(nvstream_t *nvs, nvlist_t *nvl)
2080 * Get decoded size of next pair in stream, alloc
2081 * memory for nvpair_t, then decode the nvpair
2083 while ((err = nvs->nvs_ops->nvs_nvpair(nvs, NULL, &nvsize)) == 0) {
2084 if (nvsize == 0) /* end of list */
2087 /* make sure len makes sense */
2088 if (nvsize < NVP_SIZE_CALC(1, 0))
2091 if ((nvp = nvp_buf_alloc(nvl, nvsize)) == NULL)
2094 if ((err = nvs->nvs_ops->nvs_nvp_op(nvs, nvp)) != 0) {
2095 nvp_buf_free(nvl, nvp);
2099 if (i_validate_nvpair(nvp) != 0) {
2101 nvp_buf_free(nvl, nvp);
2105 nvp_buf_link(nvl, nvp);
2111 nvs_getsize_pairs(nvstream_t *nvs, nvlist_t *nvl, size_t *buflen)
2113 nvpriv_t *priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv;
2115 uint64_t nvsize = *buflen;
2119 * Get encoded size of nvpairs in nvlist
2121 for (curr = priv->nvp_list; curr != NULL; curr = curr->nvi_next) {
2122 if (nvs->nvs_ops->nvs_nvp_size(nvs, &curr->nvi_nvp, &size) != 0)
2125 if ((nvsize += size) > INT32_MAX)
2134 nvs_operation(nvstream_t *nvs, nvlist_t *nvl, size_t *buflen)
2138 if (nvl->nvl_priv == 0)
2142 * Perform the operation, starting with header, then each nvpair
2144 if ((err = nvs->nvs_ops->nvs_nvlist(nvs, nvl, buflen)) != 0)
2147 switch (nvs->nvs_op) {
2149 err = nvs_encode_pairs(nvs, nvl);
2153 err = nvs_decode_pairs(nvs, nvl);
2156 case NVS_OP_GETSIZE:
2157 err = nvs_getsize_pairs(nvs, nvl, buflen);
2168 nvs_embedded(nvstream_t *nvs, nvlist_t *embedded)
2170 switch (nvs->nvs_op) {
2172 return (nvs_operation(nvs, embedded, NULL));
2174 case NVS_OP_DECODE: {
2178 if (embedded->nvl_version != NV_VERSION)
2181 if ((priv = nv_priv_alloc_embedded(nvs->nvs_priv)) == NULL)
2184 nvlist_init(embedded, embedded->nvl_nvflag, priv);
2186 if ((err = nvs_operation(nvs, embedded, NULL)) != 0)
2187 nvlist_free(embedded);
2198 nvs_embedded_nvl_array(nvstream_t *nvs, nvpair_t *nvp, size_t *size)
2200 size_t nelem = NVP_NELEM(nvp);
2201 nvlist_t **nvlp = EMBEDDED_NVL_ARRAY(nvp);
2204 switch (nvs->nvs_op) {
2206 for (i = 0; i < nelem; i++)
2207 if (nvs_embedded(nvs, nvlp[i]) != 0)
2211 case NVS_OP_DECODE: {
2212 size_t len = nelem * sizeof (uint64_t);
2213 nvlist_t *embedded = (nvlist_t *)((uintptr_t)nvlp + len);
2215 bzero(nvlp, len); /* don't trust packed data */
2216 for (i = 0; i < nelem; i++) {
2217 if (nvs_embedded(nvs, embedded) != 0) {
2222 nvlp[i] = embedded++;
2226 case NVS_OP_GETSIZE: {
2227 uint64_t nvsize = 0;
2229 for (i = 0; i < nelem; i++) {
2232 if (nvs_operation(nvs, nvlp[i], &nvp_sz) != 0)
2235 if ((nvsize += nvp_sz) > INT32_MAX)
2249 static int nvs_native(nvstream_t *, nvlist_t *, char *, size_t *);
2250 static int nvs_xdr(nvstream_t *, nvlist_t *, char *, size_t *);
2253 * Common routine for nvlist operations:
2254 * encode, decode, getsize (encoded size).
2257 nvlist_common(nvlist_t *nvl, char *buf, size_t *buflen, int encoding,
2263 #if BYTE_ORDER == _LITTLE_ENDIAN
2264 int host_endian = 1;
2266 int host_endian = 0;
2267 #endif /* _LITTLE_ENDIAN */
2268 nvs_header_t *nvh = (void *)buf;
2270 if (buflen == NULL || nvl == NULL ||
2271 (nvs.nvs_priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv) == NULL)
2274 nvs.nvs_op = nvs_op;
2277 * For NVS_OP_ENCODE and NVS_OP_DECODE make sure an nvlist and
2278 * a buffer is allocated. The first 4 bytes in the buffer are
2279 * used for encoding method and host endian.
2283 if (buf == NULL || *buflen < sizeof (nvs_header_t))
2286 nvh->nvh_encoding = encoding;
2287 nvh->nvh_endian = nvl_endian = host_endian;
2288 nvh->nvh_reserved1 = 0;
2289 nvh->nvh_reserved2 = 0;
2293 if (buf == NULL || *buflen < sizeof (nvs_header_t))
2296 /* get method of encoding from first byte */
2297 encoding = nvh->nvh_encoding;
2298 nvl_endian = nvh->nvh_endian;
2301 case NVS_OP_GETSIZE:
2302 nvl_endian = host_endian;
2305 * add the size for encoding
2307 *buflen = sizeof (nvs_header_t);
2315 * Create an nvstream with proper encoding method
2318 case NV_ENCODE_NATIVE:
2320 * check endianness, in case we are unpacking
2323 if (nvl_endian != host_endian)
2325 err = nvs_native(&nvs, nvl, buf, buflen);
2328 err = nvs_xdr(&nvs, nvl, buf, buflen);
2339 nvlist_size(nvlist_t *nvl, size_t *size, int encoding)
2341 return (nvlist_common(nvl, NULL, size, encoding, NVS_OP_GETSIZE));
2345 * Pack nvlist into contiguous memory
2349 nvlist_pack(nvlist_t *nvl, char **bufp, size_t *buflen, int encoding,
2352 #if defined(_KERNEL) && !defined(_BOOT)
2353 return (nvlist_xpack(nvl, bufp, buflen, encoding,
2354 (kmflag == KM_SLEEP ? nv_alloc_sleep : nv_alloc_nosleep)));
2356 return (nvlist_xpack(nvl, bufp, buflen, encoding, nv_alloc_nosleep));
2361 nvlist_xpack(nvlist_t *nvl, char **bufp, size_t *buflen, int encoding,
2369 if (nva == NULL || nvl == NULL || bufp == NULL || buflen == NULL)
2373 return (nvlist_common(nvl, *bufp, buflen, encoding,
2377 * Here is a difficult situation:
2378 * 1. The nvlist has fixed allocator properties.
2379 * All other nvlist routines (like nvlist_add_*, ...) use
2381 * 2. When using nvlist_pack() the user can specify his own
2382 * allocator properties (e.g. by using KM_NOSLEEP).
2384 * We use the user specified properties (2). A clearer solution
2385 * will be to remove the kmflag from nvlist_pack(), but we will
2386 * not change the interface.
2388 nv_priv_init(&nvpriv, nva, 0);
2390 if (err = nvlist_size(nvl, &alloc_size, encoding))
2393 if ((buf = nv_mem_zalloc(&nvpriv, alloc_size)) == NULL)
2396 if ((err = nvlist_common(nvl, buf, &alloc_size, encoding,
2397 NVS_OP_ENCODE)) != 0) {
2398 nv_mem_free(&nvpriv, buf, alloc_size);
2400 *buflen = alloc_size;
2408 * Unpack buf into an nvlist_t
2412 nvlist_unpack(char *buf, size_t buflen, nvlist_t **nvlp, int kmflag)
2414 #if defined(_KERNEL) && !defined(_BOOT)
2415 return (nvlist_xunpack(buf, buflen, nvlp,
2416 (kmflag == KM_SLEEP ? nv_alloc_sleep : nv_alloc_nosleep)));
2418 return (nvlist_xunpack(buf, buflen, nvlp, nv_alloc_nosleep));
2423 nvlist_xunpack(char *buf, size_t buflen, nvlist_t **nvlp, nv_alloc_t *nva)
2431 if ((err = nvlist_xalloc(&nvl, 0, nva)) != 0)
2434 if ((err = nvlist_common(nvl, buf, &buflen, 0, NVS_OP_DECODE)) != 0)
2443 * Native encoding functions
2447 * This structure is used when decoding a packed nvpair in
2448 * the native format. n_base points to a buffer containing the
2449 * packed nvpair. n_end is a pointer to the end of the buffer.
2450 * (n_end actually points to the first byte past the end of the
2451 * buffer.) n_curr is a pointer that lies between n_base and n_end.
2452 * It points to the current data that we are decoding.
2453 * The amount of data left in the buffer is equal to n_end - n_curr.
2454 * n_flag is used to recognize a packed embedded list.
2463 nvs_native_create(nvstream_t *nvs, nvs_native_t *native, char *buf,
2466 switch (nvs->nvs_op) {
2469 nvs->nvs_private = native;
2470 native->n_curr = native->n_base = buf;
2471 native->n_end = buf + buflen;
2475 case NVS_OP_GETSIZE:
2476 nvs->nvs_private = native;
2477 native->n_curr = native->n_base = native->n_end = NULL;
2487 nvs_native_destroy(nvstream_t *nvs)
2492 native_cp(nvstream_t *nvs, void *buf, size_t size)
2494 nvs_native_t *native = (nvs_native_t *)nvs->nvs_private;
2496 if (native->n_curr + size > native->n_end)
2500 * The bcopy() below eliminates alignment requirement
2501 * on the buffer (stream) and is preferred over direct access.
2503 switch (nvs->nvs_op) {
2505 bcopy(buf, native->n_curr, size);
2508 bcopy(native->n_curr, buf, size);
2514 native->n_curr += size;
2519 * operate on nvlist_t header
2522 nvs_native_nvlist(nvstream_t *nvs, nvlist_t *nvl, size_t *size)
2524 nvs_native_t *native = nvs->nvs_private;
2526 switch (nvs->nvs_op) {
2530 return (0); /* packed embedded list */
2534 /* copy version and nvflag of the nvlist_t */
2535 if (native_cp(nvs, &nvl->nvl_version, sizeof (int32_t)) != 0 ||
2536 native_cp(nvs, &nvl->nvl_nvflag, sizeof (int32_t)) != 0)
2541 case NVS_OP_GETSIZE:
2543 * if calculate for packed embedded list
2544 * 4 for end of the embedded list
2546 * 2 * sizeof (int32_t) for nvl_version and nvl_nvflag
2547 * and 4 for end of the entire list
2549 if (native->n_flag) {
2553 *size += 2 * sizeof (int32_t) + 4;
2564 nvs_native_nvl_fini(nvstream_t *nvs)
2566 if (nvs->nvs_op == NVS_OP_ENCODE) {
2567 nvs_native_t *native = (nvs_native_t *)nvs->nvs_private;
2569 * Add 4 zero bytes at end of nvlist. They are used
2570 * for end detection by the decode routine.
2572 if (native->n_curr + sizeof (int) > native->n_end)
2575 bzero(native->n_curr, sizeof (int));
2576 native->n_curr += sizeof (int);
2583 nvpair_native_embedded(nvstream_t *nvs, nvpair_t *nvp)
2585 if (nvs->nvs_op == NVS_OP_ENCODE) {
2586 nvs_native_t *native = (nvs_native_t *)nvs->nvs_private;
2587 char *packed = (void *)
2588 (native->n_curr - nvp->nvp_size + NVP_VALOFF(nvp));
2590 * Null out the pointer that is meaningless in the packed
2591 * structure. The address may not be aligned, so we have
2594 bzero(packed + offsetof(nvlist_t, nvl_priv),
2595 sizeof(((nvlist_t *)NULL)->nvl_priv));
2598 return (nvs_embedded(nvs, EMBEDDED_NVL(nvp)));
2602 nvpair_native_embedded_array(nvstream_t *nvs, nvpair_t *nvp)
2604 if (nvs->nvs_op == NVS_OP_ENCODE) {
2605 nvs_native_t *native = (nvs_native_t *)nvs->nvs_private;
2606 char *value = native->n_curr - nvp->nvp_size + NVP_VALOFF(nvp);
2607 size_t len = NVP_NELEM(nvp) * sizeof (uint64_t);
2610 * Null out pointers that are meaningless in the packed
2611 * structure. The addresses may not be aligned, so we have
2617 for (i = 0; i < NVP_NELEM(nvp); i++) {
2619 * Null out the pointer that is meaningless in the
2620 * packed structure. The address may not be aligned,
2621 * so we have to use bzero.
2623 bzero(value + offsetof(nvlist_t, nvl_priv),
2624 sizeof(((nvlist_t *)NULL)->nvl_priv));
2625 value += sizeof(nvlist_t);
2629 return (nvs_embedded_nvl_array(nvs, nvp, NULL));
2633 nvpair_native_string_array(nvstream_t *nvs, nvpair_t *nvp)
2635 switch (nvs->nvs_op) {
2636 case NVS_OP_ENCODE: {
2637 nvs_native_t *native = (nvs_native_t *)nvs->nvs_private;
2638 uint64_t *strp = (void *)
2639 (native->n_curr - nvp->nvp_size + NVP_VALOFF(nvp));
2641 * Null out pointers that are meaningless in the packed
2642 * structure. The addresses may not be aligned, so we have
2645 bzero(strp, NVP_NELEM(nvp) * sizeof (uint64_t));
2648 case NVS_OP_DECODE: {
2649 char **strp = (void *)NVP_VALUE(nvp);
2650 char *buf = ((char *)strp + NVP_NELEM(nvp) * sizeof (uint64_t));
2653 for (i = 0; i < NVP_NELEM(nvp); i++) {
2655 buf += strlen(buf) + 1;
2663 nvs_native_nvp_op(nvstream_t *nvs, nvpair_t *nvp)
2670 * We do the initial bcopy of the data before we look at
2671 * the nvpair type, because when we're decoding, we won't
2672 * have the correct values for the pair until we do the bcopy.
2674 switch (nvs->nvs_op) {
2677 if (native_cp(nvs, nvp, nvp->nvp_size) != 0)
2684 /* verify nvp_name_sz, check the name string length */
2685 if (i_validate_nvpair_name(nvp) != 0)
2688 type = NVP_TYPE(nvp);
2691 * Verify type and nelem and get the value size.
2692 * In case of data types DATA_TYPE_STRING and DATA_TYPE_STRING_ARRAY
2693 * is the size of the string(s) excluded.
2695 if ((value_sz = i_get_value_size(type, NULL, NVP_NELEM(nvp))) < 0)
2698 if (NVP_SIZE_CALC(nvp->nvp_name_sz, value_sz) > nvp->nvp_size)
2702 case DATA_TYPE_NVLIST:
2703 ret = nvpair_native_embedded(nvs, nvp);
2705 case DATA_TYPE_NVLIST_ARRAY:
2706 ret = nvpair_native_embedded_array(nvs, nvp);
2708 case DATA_TYPE_STRING_ARRAY:
2709 nvpair_native_string_array(nvs, nvp);
2719 nvs_native_nvp_size(nvstream_t *nvs, nvpair_t *nvp, size_t *size)
2721 uint64_t nvp_sz = nvp->nvp_size;
2723 switch (NVP_TYPE(nvp)) {
2724 case DATA_TYPE_NVLIST: {
2727 if (nvs_operation(nvs, EMBEDDED_NVL(nvp), &nvsize) != 0)
2733 case DATA_TYPE_NVLIST_ARRAY: {
2736 if (nvs_embedded_nvl_array(nvs, nvp, &nvsize) != 0)
2746 if (nvp_sz > INT32_MAX)
2755 nvs_native_nvpair(nvstream_t *nvs, nvpair_t *nvp, size_t *size)
2757 switch (nvs->nvs_op) {
2759 return (nvs_native_nvp_op(nvs, nvp));
2761 case NVS_OP_DECODE: {
2762 nvs_native_t *native = (nvs_native_t *)nvs->nvs_private;
2765 /* try to read the size value from the stream */
2766 if (native->n_curr + sizeof (int32_t) > native->n_end)
2768 bcopy(native->n_curr, &decode_len, sizeof (int32_t));
2770 /* sanity check the size value */
2771 if (decode_len < 0 ||
2772 decode_len > native->n_end - native->n_curr)
2778 * If at the end of the stream then move the cursor
2779 * forward, otherwise nvpair_native_op() will read
2780 * the entire nvpair at the same cursor position.
2783 native->n_curr += sizeof (int32_t);
2794 static const nvs_ops_t nvs_native_ops = {
2798 nvs_native_nvp_size,
2803 nvs_native(nvstream_t *nvs, nvlist_t *nvl, char *buf, size_t *buflen)
2805 nvs_native_t native;
2808 nvs->nvs_ops = &nvs_native_ops;
2810 if ((err = nvs_native_create(nvs, &native, buf + sizeof (nvs_header_t),
2811 *buflen - sizeof (nvs_header_t))) != 0)
2814 err = nvs_operation(nvs, nvl, buflen);
2816 nvs_native_destroy(nvs);
2822 * XDR encoding functions
2824 * An xdr packed nvlist is encoded as:
2826 * - encoding methode and host endian (4 bytes)
2827 * - nvl_version (4 bytes)
2828 * - nvl_nvflag (4 bytes)
2830 * - encoded nvpairs, the format of one xdr encoded nvpair is:
2831 * - encoded size of the nvpair (4 bytes)
2832 * - decoded size of the nvpair (4 bytes)
2833 * - name string, (4 + sizeof(NV_ALIGN4(string))
2834 * a string is coded as size (4 bytes) and data
2835 * - data type (4 bytes)
2836 * - number of elements in the nvpair (4 bytes)
2839 * - 2 zero's for end of the entire list (8 bytes)
2842 nvs_xdr_create(nvstream_t *nvs, XDR *xdr, char *buf, size_t buflen)
2844 /* xdr data must be 4 byte aligned */
2845 if ((ulong_t)buf % 4 != 0)
2848 switch (nvs->nvs_op) {
2850 xdrmem_create(xdr, buf, (uint_t)buflen, XDR_ENCODE);
2851 nvs->nvs_private = xdr;
2854 xdrmem_create(xdr, buf, (uint_t)buflen, XDR_DECODE);
2855 nvs->nvs_private = xdr;
2857 case NVS_OP_GETSIZE:
2858 nvs->nvs_private = NULL;
2866 nvs_xdr_destroy(nvstream_t *nvs)
2868 switch (nvs->nvs_op) {
2871 xdr_destroy((XDR *)nvs->nvs_private);
2879 nvs_xdr_nvlist(nvstream_t *nvs, nvlist_t *nvl, size_t *size)
2881 switch (nvs->nvs_op) {
2883 case NVS_OP_DECODE: {
2884 XDR *xdr = nvs->nvs_private;
2886 if (!xdr_int(xdr, &nvl->nvl_version) ||
2887 !xdr_u_int(xdr, &nvl->nvl_nvflag))
2891 case NVS_OP_GETSIZE: {
2893 * 2 * 4 for nvl_version + nvl_nvflag
2894 * and 8 for end of the entire list
2906 nvs_xdr_nvl_fini(nvstream_t *nvs)
2908 if (nvs->nvs_op == NVS_OP_ENCODE) {
2909 XDR *xdr = nvs->nvs_private;
2912 if (!xdr_int(xdr, &zero) || !xdr_int(xdr, &zero))
2920 * The format of xdr encoded nvpair is:
2921 * encode_size, decode_size, name string, data type, nelem, data
2924 nvs_xdr_nvp_op(nvstream_t *nvs, nvpair_t *nvp)
2928 char *buf_end = (char *)nvp + nvp->nvp_size;
2930 uint_t nelem, buflen;
2932 XDR *xdr = nvs->nvs_private;
2934 ASSERT(xdr != NULL && nvp != NULL);
2937 if ((buf = NVP_NAME(nvp)) >= buf_end)
2939 buflen = buf_end - buf;
2941 if (!xdr_string(xdr, &buf, buflen - 1))
2943 nvp->nvp_name_sz = strlen(buf) + 1;
2945 /* type and nelem */
2946 if (!xdr_int(xdr, (int *)&nvp->nvp_type) ||
2947 !xdr_int(xdr, &nvp->nvp_value_elem))
2950 type = NVP_TYPE(nvp);
2951 nelem = nvp->nvp_value_elem;
2954 * Verify type and nelem and get the value size.
2955 * In case of data types DATA_TYPE_STRING and DATA_TYPE_STRING_ARRAY
2956 * is the size of the string(s) excluded.
2958 if ((value_sz = i_get_value_size(type, NULL, nelem)) < 0)
2961 /* if there is no data to extract then return */
2966 if ((buf = NVP_VALUE(nvp)) >= buf_end)
2968 buflen = buf_end - buf;
2970 if (buflen < value_sz)
2974 case DATA_TYPE_NVLIST:
2975 if (nvs_embedded(nvs, (void *)buf) == 0)
2979 case DATA_TYPE_NVLIST_ARRAY:
2980 if (nvs_embedded_nvl_array(nvs, nvp, NULL) == 0)
2984 case DATA_TYPE_BOOLEAN:
2988 case DATA_TYPE_BYTE:
2989 case DATA_TYPE_INT8:
2990 case DATA_TYPE_UINT8:
2991 ret = xdr_char(xdr, buf);
2994 case DATA_TYPE_INT16:
2995 ret = xdr_short(xdr, (void *)buf);
2998 case DATA_TYPE_UINT16:
2999 ret = xdr_u_short(xdr, (void *)buf);
3002 case DATA_TYPE_BOOLEAN_VALUE:
3003 case DATA_TYPE_INT32:
3004 ret = xdr_int(xdr, (void *)buf);
3007 case DATA_TYPE_UINT32:
3008 ret = xdr_u_int(xdr, (void *)buf);
3011 case DATA_TYPE_INT64:
3012 ret = xdr_longlong_t(xdr, (void *)buf);
3015 case DATA_TYPE_UINT64:
3016 ret = xdr_u_longlong_t(xdr, (void *)buf);
3019 case DATA_TYPE_HRTIME:
3021 * NOTE: must expose the definition of hrtime_t here
3023 ret = xdr_longlong_t(xdr, (void *)buf);
3025 #if !defined(_KERNEL)
3026 case DATA_TYPE_DOUBLE:
3027 ret = xdr_double(xdr, (void *)buf);
3030 case DATA_TYPE_STRING:
3031 ret = xdr_string(xdr, &buf, buflen - 1);
3034 case DATA_TYPE_BYTE_ARRAY:
3035 ret = xdr_opaque(xdr, buf, nelem);
3038 case DATA_TYPE_INT8_ARRAY:
3039 case DATA_TYPE_UINT8_ARRAY:
3040 ret = xdr_array(xdr, &buf, &nelem, buflen, sizeof (int8_t),
3041 (xdrproc_t)xdr_char);
3044 case DATA_TYPE_INT16_ARRAY:
3045 ret = xdr_array(xdr, &buf, &nelem, buflen / sizeof (int16_t),
3046 sizeof (int16_t), (xdrproc_t)xdr_short);
3049 case DATA_TYPE_UINT16_ARRAY:
3050 ret = xdr_array(xdr, &buf, &nelem, buflen / sizeof (uint16_t),
3051 sizeof (uint16_t), (xdrproc_t)xdr_u_short);
3054 case DATA_TYPE_BOOLEAN_ARRAY:
3055 case DATA_TYPE_INT32_ARRAY:
3056 ret = xdr_array(xdr, &buf, &nelem, buflen / sizeof (int32_t),
3057 sizeof (int32_t), (xdrproc_t)xdr_int);
3060 case DATA_TYPE_UINT32_ARRAY:
3061 ret = xdr_array(xdr, &buf, &nelem, buflen / sizeof (uint32_t),
3062 sizeof (uint32_t), (xdrproc_t)xdr_u_int);
3065 case DATA_TYPE_INT64_ARRAY:
3066 ret = xdr_array(xdr, &buf, &nelem, buflen / sizeof (int64_t),
3067 sizeof (int64_t), (xdrproc_t)xdr_longlong_t);
3070 case DATA_TYPE_UINT64_ARRAY:
3071 ret = xdr_array(xdr, &buf, &nelem, buflen / sizeof (uint64_t),
3072 sizeof (uint64_t), (xdrproc_t)xdr_u_longlong_t);
3075 case DATA_TYPE_STRING_ARRAY: {
3076 size_t len = nelem * sizeof (uint64_t);
3077 char **strp = (void *)buf;
3080 if (nvs->nvs_op == NVS_OP_DECODE)
3081 bzero(buf, len); /* don't trust packed data */
3083 for (i = 0; i < nelem; i++) {
3090 if (xdr_string(xdr, &buf, buflen - 1) != TRUE)
3093 if (nvs->nvs_op == NVS_OP_DECODE)
3095 len = strlen(buf) + 1;
3104 return (ret == TRUE ? 0 : EFAULT);
3108 nvs_xdr_nvp_size(nvstream_t *nvs, nvpair_t *nvp, size_t *size)
3110 data_type_t type = NVP_TYPE(nvp);
3112 * encode_size + decode_size + name string size + data type + nelem
3113 * where name string size = 4 + NV_ALIGN4(strlen(NVP_NAME(nvp)))
3115 uint64_t nvp_sz = 4 + 4 + 4 + NV_ALIGN4(strlen(NVP_NAME(nvp))) + 4 + 4;
3118 case DATA_TYPE_BOOLEAN:
3121 case DATA_TYPE_BOOLEAN_VALUE:
3122 case DATA_TYPE_BYTE:
3123 case DATA_TYPE_INT8:
3124 case DATA_TYPE_UINT8:
3125 case DATA_TYPE_INT16:
3126 case DATA_TYPE_UINT16:
3127 case DATA_TYPE_INT32:
3128 case DATA_TYPE_UINT32:
3129 nvp_sz += 4; /* 4 is the minimum xdr unit */
3132 case DATA_TYPE_INT64:
3133 case DATA_TYPE_UINT64:
3134 case DATA_TYPE_HRTIME:
3135 #if !defined(_KERNEL)
3136 case DATA_TYPE_DOUBLE:
3141 case DATA_TYPE_STRING:
3142 nvp_sz += 4 + NV_ALIGN4(strlen((char *)NVP_VALUE(nvp)));
3145 case DATA_TYPE_BYTE_ARRAY:
3146 nvp_sz += NV_ALIGN4(NVP_NELEM(nvp));
3149 case DATA_TYPE_BOOLEAN_ARRAY:
3150 case DATA_TYPE_INT8_ARRAY:
3151 case DATA_TYPE_UINT8_ARRAY:
3152 case DATA_TYPE_INT16_ARRAY:
3153 case DATA_TYPE_UINT16_ARRAY:
3154 case DATA_TYPE_INT32_ARRAY:
3155 case DATA_TYPE_UINT32_ARRAY:
3156 nvp_sz += 4 + 4 * (uint64_t)NVP_NELEM(nvp);
3159 case DATA_TYPE_INT64_ARRAY:
3160 case DATA_TYPE_UINT64_ARRAY:
3161 nvp_sz += 4 + 8 * (uint64_t)NVP_NELEM(nvp);
3164 case DATA_TYPE_STRING_ARRAY: {
3166 char **strs = (void *)NVP_VALUE(nvp);
3168 for (i = 0; i < NVP_NELEM(nvp); i++)
3169 nvp_sz += 4 + NV_ALIGN4(strlen(strs[i]));
3174 case DATA_TYPE_NVLIST:
3175 case DATA_TYPE_NVLIST_ARRAY: {
3177 int old_nvs_op = nvs->nvs_op;
3180 nvs->nvs_op = NVS_OP_GETSIZE;
3181 if (type == DATA_TYPE_NVLIST)
3182 err = nvs_operation(nvs, EMBEDDED_NVL(nvp), &nvsize);
3184 err = nvs_embedded_nvl_array(nvs, nvp, &nvsize);
3185 nvs->nvs_op = old_nvs_op;
3198 if (nvp_sz > INT32_MAX)
3208 * The NVS_XDR_MAX_LEN macro takes a packed xdr buffer of size x and estimates
3209 * the largest nvpair that could be encoded in the buffer.
3211 * See comments above nvpair_xdr_op() for the format of xdr encoding.
3212 * The size of a xdr packed nvpair without any data is 5 words.
3214 * Using the size of the data directly as an estimate would be ok
3215 * in all cases except one. If the data type is of DATA_TYPE_STRING_ARRAY
3216 * then the actual nvpair has space for an array of pointers to index
3217 * the strings. These pointers are not encoded into the packed xdr buffer.
3219 * If the data is of type DATA_TYPE_STRING_ARRAY and all the strings are
3220 * of length 0, then each string is endcoded in xdr format as a single word.
3221 * Therefore when expanded to an nvpair there will be 2.25 word used for
3222 * each string. (a int64_t allocated for pointer usage, and a single char
3223 * for the null termination.)
3225 * This is the calculation performed by the NVS_XDR_MAX_LEN macro.
3227 #define NVS_XDR_HDR_LEN ((size_t)(5 * 4))
3228 #define NVS_XDR_DATA_LEN(y) (((size_t)(y) <= NVS_XDR_HDR_LEN) ? \
3229 0 : ((size_t)(y) - NVS_XDR_HDR_LEN))
3230 #define NVS_XDR_MAX_LEN(x) (NVP_SIZE_CALC(1, 0) + \
3231 (NVS_XDR_DATA_LEN(x) * 2) + \
3232 NV_ALIGN4((NVS_XDR_DATA_LEN(x) / 4)))
3235 nvs_xdr_nvpair(nvstream_t *nvs, nvpair_t *nvp, size_t *size)
3237 XDR *xdr = nvs->nvs_private;
3238 int32_t encode_len, decode_len;
3240 switch (nvs->nvs_op) {
3241 case NVS_OP_ENCODE: {
3244 if (nvs_xdr_nvp_size(nvs, nvp, &nvsize) != 0)
3247 decode_len = nvp->nvp_size;
3248 encode_len = nvsize;
3249 if (!xdr_int(xdr, &encode_len) || !xdr_int(xdr, &decode_len))
3252 return (nvs_xdr_nvp_op(nvs, nvp));
3254 case NVS_OP_DECODE: {
3255 struct xdr_bytesrec bytesrec;
3257 /* get the encode and decode size */
3258 if (!xdr_int(xdr, &encode_len) || !xdr_int(xdr, &decode_len))
3262 /* are we at the end of the stream? */
3266 /* sanity check the size parameter */
3267 if (!xdr_control(xdr, XDR_GET_BYTES_AVAIL, &bytesrec))
3270 if (*size > NVS_XDR_MAX_LEN(bytesrec.xc_num_avail))
3281 static const struct nvs_ops nvs_xdr_ops = {
3290 nvs_xdr(nvstream_t *nvs, nvlist_t *nvl, char *buf, size_t *buflen)
3295 nvs->nvs_ops = &nvs_xdr_ops;
3297 if ((err = nvs_xdr_create(nvs, &xdr, buf + sizeof (nvs_header_t),
3298 *buflen - sizeof (nvs_header_t))) != 0)
3301 err = nvs_operation(nvs, nvl, buflen);
3303 nvs_xdr_destroy(nvs);