2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2009-2013 The FreeBSD Foundation
5 * Copyright (c) 2013-2015 Mariusz Zaborski <oshogbo@FreeBSD.org>
8 * This software was developed by Pawel Jakub Dawidek under sponsorship from
9 * the FreeBSD Foundation.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #include <sys/param.h>
37 #include <sys/endian.h>
38 #include <sys/queue.h>
42 #include <sys/errno.h>
44 #include <sys/malloc.h>
45 #include <sys/systm.h>
47 #include <machine/stdarg.h>
59 #include "common_impl.h"
69 #include "nvlist_impl.h"
70 #include "nvpair_impl.h"
74 #define PJDLOG_ASSERT(...) MPASS(__VA_ARGS__)
75 #define PJDLOG_RASSERT(expr, ...) KASSERT(expr, (__VA_ARGS__))
76 #define PJDLOG_ABORT(...) panic(__VA_ARGS__)
79 #define PJDLOG_ASSERT(...) assert(__VA_ARGS__)
80 #define PJDLOG_RASSERT(expr, ...) assert(expr)
81 #define PJDLOG_ABORT(...) abort()
85 #define NVPAIR_MAGIC 0x6e7670 /* "nvp" */
92 size_t nvp_nitems; /* Used only for array types. */
94 TAILQ_ENTRY(nvpair) nvp_next;
97 #define NVPAIR_ASSERT(nvp) do { \
98 PJDLOG_ASSERT((nvp) != NULL); \
99 PJDLOG_ASSERT((nvp)->nvp_magic == NVPAIR_MAGIC); \
102 struct nvpair_header {
104 uint16_t nvph_namesize;
105 uint64_t nvph_datasize;
106 uint64_t nvph_nitems;
111 nvpair_assert(const nvpair_t *nvp)
118 nvpair_allocv(const char *name, int type, uint64_t data, size_t datasize,
124 PJDLOG_ASSERT(type >= NV_TYPE_FIRST && type <= NV_TYPE_LAST);
126 namelen = strlen(name);
127 if (namelen >= NV_NAME_MAX) {
128 ERRNO_SET(ENAMETOOLONG);
132 nvp = nv_calloc(1, sizeof(*nvp) + namelen + 1);
134 nvp->nvp_name = (char *)(nvp + 1);
135 memcpy(nvp->nvp_name, name, namelen);
136 nvp->nvp_name[namelen] = '\0';
137 nvp->nvp_type = type;
138 nvp->nvp_data = data;
139 nvp->nvp_datasize = datasize;
140 nvp->nvp_nitems = nitems;
141 nvp->nvp_magic = NVPAIR_MAGIC;
148 nvpair_append(nvpair_t *nvp, const void *value, size_t valsize, size_t datasize)
150 void *olddata, *data, *valp;
153 oldlen = nvp->nvp_nitems * valsize;
154 olddata = (void *)(uintptr_t)nvp->nvp_data;
155 data = nv_realloc(olddata, oldlen + valsize);
160 valp = (unsigned char *)data + oldlen;
161 memcpy(valp, value, valsize);
163 nvp->nvp_data = (uint64_t)(uintptr_t)data;
164 nvp->nvp_datasize += datasize;
170 nvpair_nvlist(const nvpair_t *nvp)
175 return (nvp->nvp_list);
179 nvpair_next(const nvpair_t *nvp)
183 PJDLOG_ASSERT(nvp->nvp_list != NULL);
185 return (TAILQ_NEXT(nvp, nvp_next));
189 nvpair_prev(const nvpair_t *nvp)
193 PJDLOG_ASSERT(nvp->nvp_list != NULL);
195 return (TAILQ_PREV(nvp, nvl_head, nvp_next));
199 nvpair_insert(struct nvl_head *head, nvpair_t *nvp, nvlist_t *nvl)
203 PJDLOG_ASSERT(nvp->nvp_list == NULL);
204 PJDLOG_ASSERT((nvlist_flags(nvl) & NV_FLAG_NO_UNIQUE) != 0 ||
205 !nvlist_exists(nvl, nvpair_name(nvp)));
207 TAILQ_INSERT_TAIL(head, nvp, nvp_next);
212 nvpair_remove_nvlist(nvpair_t *nvp)
216 /* XXX: DECONST is bad, mkay? */
217 nvl = __DECONST(nvlist_t *, nvpair_get_nvlist(nvp));
218 PJDLOG_ASSERT(nvl != NULL);
219 nvlist_set_parent(nvl, NULL);
223 nvpair_remove_nvlist_array(nvpair_t *nvp)
228 /* XXX: DECONST is bad, mkay? */
229 nvlarray = __DECONST(nvlist_t **,
230 nvpair_get_nvlist_array(nvp, &count));
231 for (i = 0; i < count; i++) {
232 nvlist_set_array_next(nvlarray[i], NULL);
233 nvlist_set_parent(nvlarray[i], NULL);
238 nvpair_remove(struct nvl_head *head, nvpair_t *nvp, const nvlist_t *nvl)
242 PJDLOG_ASSERT(nvp->nvp_list == nvl);
244 if (nvpair_type(nvp) == NV_TYPE_NVLIST)
245 nvpair_remove_nvlist(nvp);
246 else if (nvpair_type(nvp) == NV_TYPE_NVLIST_ARRAY)
247 nvpair_remove_nvlist_array(nvp);
249 TAILQ_REMOVE(head, nvp, nvp_next);
250 nvp->nvp_list = NULL;
254 nvpair_clone(const nvpair_t *nvp)
263 name = nvpair_name(nvp);
265 switch (nvpair_type(nvp)) {
267 newnvp = nvpair_create_null(name);
270 newnvp = nvpair_create_bool(name, nvpair_get_bool(nvp));
273 newnvp = nvpair_create_number(name, nvpair_get_number(nvp));
276 newnvp = nvpair_create_string(name, nvpair_get_string(nvp));
279 newnvp = nvpair_create_nvlist(name, nvpair_get_nvlist(nvp));
282 data = nvpair_get_binary(nvp, &datasize);
283 newnvp = nvpair_create_binary(name, data, datasize);
285 case NV_TYPE_BOOL_ARRAY:
286 data = nvpair_get_bool_array(nvp, &datasize);
287 newnvp = nvpair_create_bool_array(name, data, datasize);
289 case NV_TYPE_NUMBER_ARRAY:
290 data = nvpair_get_number_array(nvp, &datasize);
291 newnvp = nvpair_create_number_array(name, data, datasize);
293 case NV_TYPE_STRING_ARRAY:
294 data = nvpair_get_string_array(nvp, &datasize);
295 newnvp = nvpair_create_string_array(name, data, datasize);
297 case NV_TYPE_NVLIST_ARRAY:
298 data = nvpair_get_nvlist_array(nvp, &datasize);
299 newnvp = nvpair_create_nvlist_array(name, data, datasize);
302 case NV_TYPE_DESCRIPTOR:
303 newnvp = nvpair_create_descriptor(name,
304 nvpair_get_descriptor(nvp));
306 case NV_TYPE_DESCRIPTOR_ARRAY:
307 data = nvpair_get_descriptor_array(nvp, &datasize);
308 newnvp = nvpair_create_descriptor_array(name, data, datasize);
312 PJDLOG_ABORT("Unknown type: %d.", nvpair_type(nvp));
319 nvpair_header_size(void)
322 return (sizeof(struct nvpair_header));
326 nvpair_size(const nvpair_t *nvp)
331 return (nvp->nvp_datasize);
335 nvpair_pack_header(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
337 struct nvpair_header nvphdr;
342 nvphdr.nvph_type = nvp->nvp_type;
343 namesize = strlen(nvp->nvp_name) + 1;
344 PJDLOG_ASSERT(namesize > 0 && namesize <= UINT16_MAX);
345 nvphdr.nvph_namesize = namesize;
346 nvphdr.nvph_datasize = nvp->nvp_datasize;
347 nvphdr.nvph_nitems = nvp->nvp_nitems;
348 PJDLOG_ASSERT(*leftp >= sizeof(nvphdr));
349 memcpy(ptr, &nvphdr, sizeof(nvphdr));
350 ptr += sizeof(nvphdr);
351 *leftp -= sizeof(nvphdr);
353 PJDLOG_ASSERT(*leftp >= namesize);
354 memcpy(ptr, nvp->nvp_name, namesize);
362 nvpair_pack_null(const nvpair_t *nvp, unsigned char *ptr,
363 size_t *leftp __unused)
367 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NULL);
373 nvpair_pack_bool(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
378 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BOOL);
380 value = (uint8_t)nvp->nvp_data;
382 PJDLOG_ASSERT(*leftp >= sizeof(value));
383 memcpy(ptr, &value, sizeof(value));
384 ptr += sizeof(value);
385 *leftp -= sizeof(value);
391 nvpair_pack_number(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
396 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NUMBER);
398 value = (uint64_t)nvp->nvp_data;
400 PJDLOG_ASSERT(*leftp >= sizeof(value));
401 memcpy(ptr, &value, sizeof(value));
402 ptr += sizeof(value);
403 *leftp -= sizeof(value);
409 nvpair_pack_string(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
413 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_STRING);
415 PJDLOG_ASSERT(*leftp >= nvp->nvp_datasize);
416 memcpy(ptr, (const void *)(intptr_t)nvp->nvp_data, nvp->nvp_datasize);
417 ptr += nvp->nvp_datasize;
418 *leftp -= nvp->nvp_datasize;
424 nvpair_pack_nvlist_up(unsigned char *ptr, size_t *leftp)
426 struct nvpair_header nvphdr;
428 const char *name = "";
431 nvphdr.nvph_type = NV_TYPE_NVLIST_UP;
432 nvphdr.nvph_namesize = namesize;
433 nvphdr.nvph_datasize = 0;
434 nvphdr.nvph_nitems = 0;
435 PJDLOG_ASSERT(*leftp >= sizeof(nvphdr));
436 memcpy(ptr, &nvphdr, sizeof(nvphdr));
437 ptr += sizeof(nvphdr);
438 *leftp -= sizeof(nvphdr);
440 PJDLOG_ASSERT(*leftp >= namesize);
441 memcpy(ptr, name, namesize);
449 nvpair_pack_nvlist_array_next(unsigned char *ptr, size_t *leftp)
451 struct nvpair_header nvphdr;
453 const char *name = "";
456 nvphdr.nvph_type = NV_TYPE_NVLIST_ARRAY_NEXT;
457 nvphdr.nvph_namesize = namesize;
458 nvphdr.nvph_datasize = 0;
459 nvphdr.nvph_nitems = 0;
460 PJDLOG_ASSERT(*leftp >= sizeof(nvphdr));
461 memcpy(ptr, &nvphdr, sizeof(nvphdr));
462 ptr += sizeof(nvphdr);
463 *leftp -= sizeof(nvphdr);
465 PJDLOG_ASSERT(*leftp >= namesize);
466 memcpy(ptr, name, namesize);
475 nvpair_pack_descriptor(const nvpair_t *nvp, unsigned char *ptr, int64_t *fdidxp,
481 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_DESCRIPTOR);
483 value = (int64_t)nvp->nvp_data;
486 * If there is a real descriptor here, we change its number
487 * to position in the array of descriptors send via control
490 PJDLOG_ASSERT(fdidxp != NULL);
496 PJDLOG_ASSERT(*leftp >= sizeof(value));
497 memcpy(ptr, &value, sizeof(value));
498 ptr += sizeof(value);
499 *leftp -= sizeof(value);
506 nvpair_pack_binary(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
510 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BINARY);
512 PJDLOG_ASSERT(*leftp >= nvp->nvp_datasize);
513 memcpy(ptr, (const void *)(intptr_t)nvp->nvp_data, nvp->nvp_datasize);
514 ptr += nvp->nvp_datasize;
515 *leftp -= nvp->nvp_datasize;
521 nvpair_pack_bool_array(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
525 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BOOL_ARRAY);
526 PJDLOG_ASSERT(*leftp >= nvp->nvp_datasize);
528 memcpy(ptr, (const void *)(intptr_t)nvp->nvp_data, nvp->nvp_datasize);
529 ptr += nvp->nvp_datasize;
530 *leftp -= nvp->nvp_datasize;
536 nvpair_pack_number_array(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
540 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NUMBER_ARRAY);
541 PJDLOG_ASSERT(*leftp >= nvp->nvp_datasize);
543 memcpy(ptr, (const void *)(intptr_t)nvp->nvp_data, nvp->nvp_datasize);
544 ptr += nvp->nvp_datasize;
545 *leftp -= nvp->nvp_datasize;
551 nvpair_pack_string_array(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
555 const char * const *array;
558 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_STRING_ARRAY);
559 PJDLOG_ASSERT(*leftp >= nvp->nvp_datasize);
562 array = nvpair_get_string_array(nvp, NULL);
563 PJDLOG_ASSERT(array != NULL);
565 for (ii = 0; ii < nvp->nvp_nitems; ii++) {
566 len = strlen(array[ii]) + 1;
567 PJDLOG_ASSERT(*leftp >= len);
569 memcpy(ptr, (const void *)array[ii], len);
575 PJDLOG_ASSERT(size == nvp->nvp_datasize);
582 nvpair_pack_descriptor_array(const nvpair_t *nvp, unsigned char *ptr,
583 int64_t *fdidxp, size_t *leftp)
590 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_DESCRIPTOR_ARRAY);
591 PJDLOG_ASSERT(*leftp >= nvp->nvp_datasize);
593 array = nvpair_get_descriptor_array(nvp, NULL);
594 PJDLOG_ASSERT(array != NULL);
596 for (ii = 0; ii < nvp->nvp_nitems; ii++) {
597 PJDLOG_ASSERT(*leftp >= sizeof(value));
602 * If there is a real descriptor here, we change its
603 * number to position in the array of descriptors send
604 * via control message.
606 PJDLOG_ASSERT(fdidxp != NULL);
611 memcpy(ptr, &value, sizeof(value));
612 ptr += sizeof(value);
613 *leftp -= sizeof(value);
621 nvpair_init_datasize(nvpair_t *nvp)
626 if (nvp->nvp_type == NV_TYPE_NVLIST) {
627 if (nvp->nvp_data == 0) {
628 nvp->nvp_datasize = 0;
631 nvlist_size((const nvlist_t *)(intptr_t)nvp->nvp_data);
636 const unsigned char *
637 nvpair_unpack_header(bool isbe, nvpair_t *nvp, const unsigned char *ptr,
640 struct nvpair_header nvphdr;
642 if (*leftp < sizeof(nvphdr))
645 memcpy(&nvphdr, ptr, sizeof(nvphdr));
646 ptr += sizeof(nvphdr);
647 *leftp -= sizeof(nvphdr);
649 #if NV_TYPE_FIRST > 0
650 if (nvphdr.nvph_type < NV_TYPE_FIRST)
653 if (nvphdr.nvph_type > NV_TYPE_LAST &&
654 nvphdr.nvph_type != NV_TYPE_NVLIST_UP &&
655 nvphdr.nvph_type != NV_TYPE_NVLIST_ARRAY_NEXT) {
659 #if BYTE_ORDER == BIG_ENDIAN
661 nvphdr.nvph_namesize = le16toh(nvphdr.nvph_namesize);
662 nvphdr.nvph_datasize = le64toh(nvphdr.nvph_datasize);
666 nvphdr.nvph_namesize = be16toh(nvphdr.nvph_namesize);
667 nvphdr.nvph_datasize = be64toh(nvphdr.nvph_datasize);
671 if (nvphdr.nvph_namesize > NV_NAME_MAX)
673 if (*leftp < nvphdr.nvph_namesize)
675 if (nvphdr.nvph_namesize < 1)
677 if (strnlen((const char *)ptr, nvphdr.nvph_namesize) !=
678 (size_t)(nvphdr.nvph_namesize - 1)) {
682 memcpy(nvp->nvp_name, ptr, nvphdr.nvph_namesize);
683 ptr += nvphdr.nvph_namesize;
684 *leftp -= nvphdr.nvph_namesize;
686 if (*leftp < nvphdr.nvph_datasize)
689 nvp->nvp_type = nvphdr.nvph_type;
691 nvp->nvp_datasize = nvphdr.nvph_datasize;
692 nvp->nvp_nitems = nvphdr.nvph_nitems;
700 const unsigned char *
701 nvpair_unpack_null(bool isbe __unused, nvpair_t *nvp, const unsigned char *ptr,
702 size_t *leftp __unused)
705 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NULL);
707 if (nvp->nvp_datasize != 0) {
715 const unsigned char *
716 nvpair_unpack_bool(bool isbe __unused, nvpair_t *nvp, const unsigned char *ptr,
721 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BOOL);
723 if (nvp->nvp_datasize != sizeof(value)) {
727 if (*leftp < sizeof(value)) {
732 memcpy(&value, ptr, sizeof(value));
733 ptr += sizeof(value);
734 *leftp -= sizeof(value);
736 if (value != 0 && value != 1) {
741 nvp->nvp_data = (uint64_t)value;
746 const unsigned char *
747 nvpair_unpack_number(bool isbe, nvpair_t *nvp, const unsigned char *ptr,
751 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NUMBER);
753 if (nvp->nvp_datasize != sizeof(uint64_t)) {
757 if (*leftp < sizeof(uint64_t)) {
763 nvp->nvp_data = be64dec(ptr);
765 nvp->nvp_data = le64dec(ptr);
767 ptr += sizeof(uint64_t);
768 *leftp -= sizeof(uint64_t);
773 const unsigned char *
774 nvpair_unpack_string(bool isbe __unused, nvpair_t *nvp,
775 const unsigned char *ptr, size_t *leftp)
778 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_STRING);
780 if (*leftp < nvp->nvp_datasize || nvp->nvp_datasize == 0) {
785 if (strnlen((const char *)ptr, nvp->nvp_datasize) !=
786 nvp->nvp_datasize - 1) {
791 nvp->nvp_data = (uint64_t)(uintptr_t)nv_strdup((const char *)ptr);
792 if (nvp->nvp_data == 0)
795 ptr += nvp->nvp_datasize;
796 *leftp -= nvp->nvp_datasize;
801 const unsigned char *
802 nvpair_unpack_nvlist(bool isbe __unused, nvpair_t *nvp,
803 const unsigned char *ptr, size_t *leftp, size_t nfds, nvlist_t **child)
807 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NVLIST);
809 if (*leftp < nvp->nvp_datasize || nvp->nvp_datasize == 0) {
814 value = nvlist_create(0);
818 ptr = nvlist_unpack_header(value, ptr, nfds, NULL, leftp);
822 nvp->nvp_data = (uint64_t)(uintptr_t)value;
829 const unsigned char *
830 nvpair_unpack_descriptor(bool isbe, nvpair_t *nvp, const unsigned char *ptr,
831 size_t *leftp, const int *fds, size_t nfds)
835 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_DESCRIPTOR);
837 if (nvp->nvp_datasize != sizeof(idx)) {
841 if (*leftp < sizeof(idx)) {
856 if ((size_t)idx >= nfds) {
861 nvp->nvp_data = (uint64_t)fds[idx];
864 *leftp -= sizeof(idx);
870 const unsigned char *
871 nvpair_unpack_binary(bool isbe __unused, nvpair_t *nvp,
872 const unsigned char *ptr, size_t *leftp)
876 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BINARY);
878 if (*leftp < nvp->nvp_datasize || nvp->nvp_datasize == 0) {
883 value = nv_malloc(nvp->nvp_datasize);
887 memcpy(value, ptr, nvp->nvp_datasize);
888 ptr += nvp->nvp_datasize;
889 *leftp -= nvp->nvp_datasize;
891 nvp->nvp_data = (uint64_t)(uintptr_t)value;
896 const unsigned char *
897 nvpair_unpack_bool_array(bool isbe __unused, nvpair_t *nvp,
898 const unsigned char *ptr, size_t *leftp)
904 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BOOL_ARRAY);
906 size = sizeof(*value) * nvp->nvp_nitems;
907 if (nvp->nvp_datasize != size || *leftp < size ||
908 nvp->nvp_nitems == 0 || size < nvp->nvp_nitems) {
913 value = nv_malloc(size);
917 for (i = 0; i < nvp->nvp_nitems; i++) {
918 value[i] = *(const uint8_t *)ptr;
920 ptr += sizeof(*value);
921 *leftp -= sizeof(*value);
924 nvp->nvp_data = (uint64_t)(uintptr_t)value;
929 const unsigned char *
930 nvpair_unpack_number_array(bool isbe, nvpair_t *nvp, const unsigned char *ptr,
937 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NUMBER_ARRAY);
939 size = sizeof(*value) * nvp->nvp_nitems;
940 if (nvp->nvp_datasize != size || *leftp < size ||
941 nvp->nvp_nitems == 0 || size < nvp->nvp_nitems) {
946 value = nv_malloc(size);
950 for (i = 0; i < nvp->nvp_nitems; i++) {
952 value[i] = be64dec(ptr);
954 value[i] = le64dec(ptr);
956 ptr += sizeof(*value);
957 *leftp -= sizeof(*value);
960 nvp->nvp_data = (uint64_t)(uintptr_t)value;
965 const unsigned char *
966 nvpair_unpack_string_array(bool isbe __unused, nvpair_t *nvp,
967 const unsigned char *ptr, size_t *leftp)
975 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_STRING_ARRAY);
977 if (*leftp < nvp->nvp_datasize || nvp->nvp_datasize == 0 ||
978 nvp->nvp_nitems == 0) {
983 size = nvp->nvp_datasize;
984 tmp = (const char *)ptr;
985 for (ii = 0; ii < nvp->nvp_nitems; ii++) {
986 len = strnlen(tmp, size - 1) + 1;
999 value = nv_malloc(sizeof(*value) * nvp->nvp_nitems);
1003 for (ii = 0; ii < nvp->nvp_nitems; ii++) {
1004 value[ii] = nv_strdup((const char *)ptr);
1005 if (value[ii] == NULL)
1007 len = strlen(value[ii]) + 1;
1011 nvp->nvp_data = (uint64_t)(uintptr_t)value;
1015 for (j = 0; j < ii; j++)
1022 const unsigned char *
1023 nvpair_unpack_descriptor_array(bool isbe, nvpair_t *nvp,
1024 const unsigned char *ptr, size_t *leftp, const int *fds, size_t nfds)
1031 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_DESCRIPTOR_ARRAY);
1033 size = sizeof(idx) * nvp->nvp_nitems;
1034 if (nvp->nvp_datasize != size || *leftp < size ||
1035 nvp->nvp_nitems == 0 || size < nvp->nvp_nitems) {
1040 array = (int *)nv_malloc(size);
1044 for (ii = 0; ii < nvp->nvp_nitems; ii++) {
1056 if ((size_t)idx >= nfds) {
1062 array[ii] = (uint64_t)fds[idx];
1065 *leftp -= sizeof(idx);
1068 nvp->nvp_data = (uint64_t)(uintptr_t)array;
1074 const unsigned char *
1075 nvpair_unpack_nvlist_array(bool isbe __unused, nvpair_t *nvp,
1076 const unsigned char *ptr, size_t *leftp, nvlist_t **firstel)
1083 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NVLIST_ARRAY);
1085 sizeup = sizeof(struct nvpair_header) * nvp->nvp_nitems;
1086 if (nvp->nvp_nitems == 0 || sizeup < nvp->nvp_nitems ||
1092 value = nv_malloc(nvp->nvp_nitems * sizeof(*value));
1096 for (ii = 0; ii < nvp->nvp_nitems; ii++) {
1097 value[ii] = nvlist_create(0);
1098 if (value[ii] == NULL)
1101 tmpnvp = nvpair_allocv(" ", NV_TYPE_NVLIST,
1102 (uint64_t)(uintptr_t)value[ii], 0, 0);
1105 nvlist_set_array_next(value[ii - 1], tmpnvp);
1108 nvlist_set_flags(value[nvp->nvp_nitems - 1], NV_FLAG_IN_ARRAY);
1110 nvp->nvp_data = (uint64_t)(uintptr_t)value;
1111 *firstel = value[0];
1116 for (j = 0; j <= ii; j++)
1117 nvlist_destroy(value[j]);
1124 const unsigned char *
1125 nvpair_unpack(bool isbe, const unsigned char *ptr, size_t *leftp,
1128 nvpair_t *nvp, *tmp;
1130 nvp = nv_calloc(1, sizeof(*nvp) + NV_NAME_MAX);
1133 nvp->nvp_name = (char *)(nvp + 1);
1135 ptr = nvpair_unpack_header(isbe, nvp, ptr, leftp);
1138 tmp = nv_realloc(nvp, sizeof(*nvp) + strlen(nvp->nvp_name) + 1);
1143 /* Update nvp_name after realloc(). */
1144 nvp->nvp_name = (char *)(nvp + 1);
1145 nvp->nvp_data = 0x00;
1146 nvp->nvp_magic = NVPAIR_MAGIC;
1155 nvpair_type(const nvpair_t *nvp)
1160 return (nvp->nvp_type);
1164 nvpair_name(const nvpair_t *nvp)
1169 return (nvp->nvp_name);
1173 nvpair_create_stringf(const char *name, const char *valuefmt, ...)
1178 va_start(valueap, valuefmt);
1179 nvp = nvpair_create_stringv(name, valuefmt, valueap);
1186 nvpair_create_stringv(const char *name, const char *valuefmt, va_list valueap)
1192 len = nv_vasprintf(&str, valuefmt, valueap);
1195 nvp = nvpair_create_string(name, str);
1202 nvpair_create_null(const char *name)
1205 return (nvpair_allocv(name, NV_TYPE_NULL, 0, 0, 0));
1209 nvpair_create_bool(const char *name, bool value)
1212 return (nvpair_allocv(name, NV_TYPE_BOOL, value ? 1 : 0,
1213 sizeof(uint8_t), 0));
1217 nvpair_create_number(const char *name, uint64_t value)
1220 return (nvpair_allocv(name, NV_TYPE_NUMBER, value, sizeof(value), 0));
1224 nvpair_create_string(const char *name, const char *value)
1230 if (value == NULL) {
1235 data = nv_strdup(value);
1238 size = strlen(value) + 1;
1240 nvp = nvpair_allocv(name, NV_TYPE_STRING, (uint64_t)(uintptr_t)data,
1249 nvpair_create_nvlist(const char *name, const nvlist_t *value)
1254 if (value == NULL) {
1259 nvl = nvlist_clone(value);
1263 nvp = nvpair_allocv(name, NV_TYPE_NVLIST, (uint64_t)(uintptr_t)nvl, 0,
1266 nvlist_destroy(nvl);
1268 nvlist_set_parent(nvl, nvp);
1275 nvpair_create_descriptor(const char *name, int value)
1279 if (value < 0 || !fd_is_valid(value)) {
1284 value = fcntl(value, F_DUPFD_CLOEXEC, 0);
1288 nvp = nvpair_allocv(name, NV_TYPE_DESCRIPTOR, (uint64_t)value,
1289 sizeof(int64_t), 0);
1301 nvpair_create_binary(const char *name, const void *value, size_t size)
1306 if (value == NULL || size == 0) {
1311 data = nv_malloc(size);
1314 memcpy(data, value, size);
1316 nvp = nvpair_allocv(name, NV_TYPE_BINARY, (uint64_t)(uintptr_t)data,
1325 nvpair_create_bool_array(const char *name, const bool *value, size_t nitems)
1331 if (value == NULL || nitems == 0) {
1336 size = sizeof(value[0]) * nitems;
1337 data = nv_malloc(size);
1341 memcpy(data, value, size);
1342 nvp = nvpair_allocv(name, NV_TYPE_BOOL_ARRAY, (uint64_t)(uintptr_t)data,
1354 nvpair_create_number_array(const char *name, const uint64_t *value,
1361 if (value == NULL || nitems == 0) {
1366 size = sizeof(value[0]) * nitems;
1367 data = nv_malloc(size);
1371 memcpy(data, value, size);
1372 nvp = nvpair_allocv(name, NV_TYPE_NUMBER_ARRAY,
1373 (uint64_t)(uintptr_t)data, size, nitems);
1384 nvpair_create_string_array(const char *name, const char * const *value,
1389 size_t datasize, size;
1392 if (value == NULL || nitems == 0) {
1399 data = nv_malloc(sizeof(value[0]) * nitems);
1403 for (ii = 0; ii < nitems; ii++) {
1404 if (value[ii] == NULL) {
1409 size = strlen(value[ii]) + 1;
1411 data[ii] = nv_strdup(value[ii]);
1412 if (data[ii] == NULL)
1415 nvp = nvpair_allocv(name, NV_TYPE_STRING_ARRAY,
1416 (uint64_t)(uintptr_t)data, datasize, nitems);
1421 for (; ii > 0; ii--)
1422 nv_free(data[ii - 1]);
1431 nvpair_create_nvlist_array(const char *name, const nvlist_t * const *value,
1441 if (value == NULL || nitems == 0) {
1446 nvls = nv_malloc(sizeof(value[0]) * nitems);
1450 for (ii = 0; ii < nitems; ii++) {
1451 if (value[ii] == NULL) {
1456 nvls[ii] = nvlist_clone(value[ii]);
1457 if (nvls[ii] == NULL)
1463 nvp = nvpair_allocv(" ", NV_TYPE_NVLIST,
1464 (uint64_t)(uintptr_t)nvls[ii], 0, 0);
1467 nvlist_destroy(nvls[ii]);
1471 nvlist_set_array_next(nvls[ii - 1], nvp);
1474 flags = nvlist_flags(nvls[nitems - 1]) | NV_FLAG_IN_ARRAY;
1475 nvlist_set_flags(nvls[nitems - 1], flags);
1477 parent = nvpair_allocv(name, NV_TYPE_NVLIST_ARRAY,
1478 (uint64_t)(uintptr_t)nvls, 0, nitems);
1482 for (ii = 0; ii < nitems; ii++)
1483 nvlist_set_parent(nvls[ii], parent);
1489 for (; ii > 0; ii--)
1490 nvlist_destroy(nvls[ii - 1]);
1499 nvpair_create_descriptor_array(const char *name, const int *value,
1506 if (value == NULL) {
1513 fds = nv_malloc(sizeof(value[0]) * nitems);
1516 for (ii = 0; ii < nitems; ii++) {
1517 if (value[ii] == -1) {
1520 if (!fd_is_valid(value[ii])) {
1525 fds[ii] = fcntl(value[ii], F_DUPFD_CLOEXEC, 0);
1531 nvp = nvpair_allocv(name, NV_TYPE_DESCRIPTOR_ARRAY,
1532 (uint64_t)(uintptr_t)fds, sizeof(int64_t) * nitems, nitems);
1537 for (; ii > 0; ii--) {
1538 if (fds[ii - 1] != -1)
1550 nvpair_move_string(const char *name, char *value)
1554 if (value == NULL) {
1559 nvp = nvpair_allocv(name, NV_TYPE_STRING, (uint64_t)(uintptr_t)value,
1560 strlen(value) + 1, 0);
1571 nvpair_move_nvlist(const char *name, nvlist_t *value)
1575 if (value == NULL || nvlist_get_nvpair_parent(value) != NULL) {
1580 if (nvlist_error(value) != 0) {
1581 ERRNO_SET(nvlist_error(value));
1582 nvlist_destroy(value);
1586 nvp = nvpair_allocv(name, NV_TYPE_NVLIST, (uint64_t)(uintptr_t)value,
1589 nvlist_destroy(value);
1591 nvlist_set_parent(value, nvp);
1598 nvpair_move_descriptor(const char *name, int value)
1602 if (value < 0 || !fd_is_valid(value)) {
1607 nvp = nvpair_allocv(name, NV_TYPE_DESCRIPTOR, (uint64_t)value,
1608 sizeof(int64_t), 0);
1620 nvpair_move_binary(const char *name, void *value, size_t size)
1624 if (value == NULL || size == 0) {
1629 nvp = nvpair_allocv(name, NV_TYPE_BINARY, (uint64_t)(uintptr_t)value,
1641 nvpair_move_bool_array(const char *name, bool *value, size_t nitems)
1645 if (value == NULL || nitems == 0) {
1650 nvp = nvpair_allocv(name, NV_TYPE_BOOL_ARRAY,
1651 (uint64_t)(uintptr_t)value, sizeof(value[0]) * nitems, nitems);
1662 nvpair_move_string_array(const char *name, char **value, size_t nitems)
1667 if (value == NULL || nitems == 0) {
1673 for (i = 0; i < nitems; i++) {
1674 if (value[i] == NULL) {
1679 size += strlen(value[i]) + 1;
1682 nvp = nvpair_allocv(name, NV_TYPE_STRING_ARRAY,
1683 (uint64_t)(uintptr_t)value, size, nitems);
1686 for (i = 0; i < nitems; i++)
1696 nvpair_move_number_array(const char *name, uint64_t *value, size_t nitems)
1700 if (value == NULL || nitems == 0) {
1705 nvp = nvpair_allocv(name, NV_TYPE_NUMBER_ARRAY,
1706 (uint64_t)(uintptr_t)value, sizeof(value[0]) * nitems, nitems);
1717 nvpair_move_nvlist_array(const char *name, nvlist_t **value, size_t nitems)
1723 if (value == NULL || nitems == 0) {
1728 for (ii = 0; ii < nitems; ii++) {
1729 if (value == NULL || nvlist_error(value[ii]) != 0 ||
1730 nvlist_get_pararr(value[ii], NULL) != NULL) {
1737 nvp = nvpair_allocv(" ", NV_TYPE_NVLIST,
1738 (uint64_t)(uintptr_t)value[ii], 0, 0);
1741 nvlist_set_array_next(value[ii - 1], nvp);
1744 flags = nvlist_flags(value[nitems - 1]) | NV_FLAG_IN_ARRAY;
1745 nvlist_set_flags(value[nitems - 1], flags);
1747 parent = nvpair_allocv(name, NV_TYPE_NVLIST_ARRAY,
1748 (uint64_t)(uintptr_t)value, 0, nitems);
1752 for (ii = 0; ii < nitems; ii++)
1753 nvlist_set_parent(value[ii], parent);
1758 for (ii = 0; ii < nitems; ii++) {
1759 if (value[ii] != NULL &&
1760 nvlist_get_pararr(value[ii], NULL) != NULL) {
1761 nvlist_destroy(value[ii]);
1772 nvpair_move_descriptor_array(const char *name, int *value, size_t nitems)
1777 if (value == NULL || nitems == 0) {
1782 for (i = 0; i < nitems; i++) {
1783 if (value[i] != -1 && !fd_is_valid(value[i])) {
1789 nvp = nvpair_allocv(name, NV_TYPE_DESCRIPTOR_ARRAY,
1790 (uint64_t)(uintptr_t)value, sizeof(value[0]) * nitems, nitems);
1797 for (i = 0; i < nitems; i++) {
1798 if (fd_is_valid(value[i]))
1809 nvpair_get_bool(const nvpair_t *nvp)
1814 return (nvp->nvp_data == 1);
1818 nvpair_get_number(const nvpair_t *nvp)
1823 return (nvp->nvp_data);
1827 nvpair_get_string(const nvpair_t *nvp)
1831 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_STRING);
1833 return ((const char *)(intptr_t)nvp->nvp_data);
1837 nvpair_get_nvlist(const nvpair_t *nvp)
1841 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NVLIST);
1843 return ((const nvlist_t *)(intptr_t)nvp->nvp_data);
1848 nvpair_get_descriptor(const nvpair_t *nvp)
1852 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_DESCRIPTOR);
1854 return ((int)nvp->nvp_data);
1859 nvpair_get_binary(const nvpair_t *nvp, size_t *sizep)
1863 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BINARY);
1866 *sizep = nvp->nvp_datasize;
1868 return ((const void *)(intptr_t)nvp->nvp_data);
1872 nvpair_get_bool_array(const nvpair_t *nvp, size_t *nitems)
1876 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BOOL_ARRAY);
1879 *nitems = nvp->nvp_nitems;
1881 return ((const bool *)(intptr_t)nvp->nvp_data);
1885 nvpair_get_number_array(const nvpair_t *nvp, size_t *nitems)
1889 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NUMBER_ARRAY);
1892 *nitems = nvp->nvp_nitems;
1894 return ((const uint64_t *)(intptr_t)nvp->nvp_data);
1897 const char * const *
1898 nvpair_get_string_array(const nvpair_t *nvp, size_t *nitems)
1902 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_STRING_ARRAY);
1905 *nitems = nvp->nvp_nitems;
1907 return ((const char * const *)(intptr_t)nvp->nvp_data);
1910 const nvlist_t * const *
1911 nvpair_get_nvlist_array(const nvpair_t *nvp, size_t *nitems)
1915 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NVLIST_ARRAY);
1918 *nitems = nvp->nvp_nitems;
1920 return ((const nvlist_t * const *)((intptr_t)nvp->nvp_data));
1925 nvpair_get_descriptor_array(const nvpair_t *nvp, size_t *nitems)
1929 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_DESCRIPTOR_ARRAY);
1932 *nitems = nvp->nvp_nitems;
1934 return ((const int *)(intptr_t)nvp->nvp_data);
1939 nvpair_append_bool_array(nvpair_t *nvp, const bool value)
1943 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BOOL_ARRAY);
1944 return (nvpair_append(nvp, &value, sizeof(value), sizeof(value)));
1948 nvpair_append_number_array(nvpair_t *nvp, const uint64_t value)
1952 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NUMBER_ARRAY);
1953 return (nvpair_append(nvp, &value, sizeof(value), sizeof(value)));
1957 nvpair_append_string_array(nvpair_t *nvp, const char *value)
1962 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_STRING_ARRAY);
1963 if (value == NULL) {
1967 str = nv_strdup(value);
1971 if (nvpair_append(nvp, &str, sizeof(str), strlen(str) + 1) == -1) {
1979 nvpair_append_nvlist_array(nvpair_t *nvp, const nvlist_t *value)
1982 nvlist_t *nvl, *prev;
1986 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NVLIST_ARRAY);
1987 if (value == NULL || nvlist_error(value) != 0 ||
1988 nvlist_get_pararr(value, NULL) != NULL) {
1992 nvl = nvlist_clone(value);
1996 flags = nvlist_flags(nvl) | NV_FLAG_IN_ARRAY;
1997 nvlist_set_flags(nvl, flags);
2001 if (nvp->nvp_nitems > 0) {
2002 nvlist_t **nvls = (void *)(uintptr_t)nvp->nvp_data;
2004 prev = nvls[nvp->nvp_nitems - 1];
2005 PJDLOG_ASSERT(prev != NULL);
2007 tmpnvp = nvpair_allocv(" ", NV_TYPE_NVLIST,
2008 (uint64_t)(uintptr_t)nvl, 0, 0);
2009 if (tmpnvp == NULL) {
2013 if (nvpair_append(nvp, &nvl, sizeof(nvl), 0) == -1) {
2017 NVPAIR_ASSERT(tmpnvp);
2018 nvlist_set_array_next(prev, tmpnvp);
2020 nvlist_set_parent(nvl, nvp);
2024 nvpair_free(tmpnvp);
2026 nvlist_destroy(nvl);
2032 nvpair_append_descriptor_array(nvpair_t *nvp, const int value)
2037 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_DESCRIPTOR_ARRAY);
2038 if (value < 0 || !fd_is_valid(value)) {
2042 fd = fcntl(value, F_DUPFD_CLOEXEC, 0);
2046 if (nvpair_append(nvp, &fd, sizeof(fd), sizeof(fd)) == -1) {
2055 nvpair_free(nvpair_t *nvp)
2060 PJDLOG_ASSERT(nvp->nvp_list == NULL);
2063 switch (nvp->nvp_type) {
2065 case NV_TYPE_DESCRIPTOR:
2066 close((int)nvp->nvp_data);
2068 case NV_TYPE_DESCRIPTOR_ARRAY:
2069 for (i = 0; i < nvp->nvp_nitems; i++)
2070 close(((int *)(intptr_t)nvp->nvp_data)[i]);
2073 case NV_TYPE_NVLIST:
2074 nvlist_destroy((nvlist_t *)(intptr_t)nvp->nvp_data);
2076 case NV_TYPE_STRING:
2077 nv_free((char *)(intptr_t)nvp->nvp_data);
2079 case NV_TYPE_BINARY:
2080 nv_free((void *)(intptr_t)nvp->nvp_data);
2082 case NV_TYPE_NVLIST_ARRAY:
2083 for (i = 0; i < nvp->nvp_nitems; i++) {
2085 ((nvlist_t **)(intptr_t)nvp->nvp_data)[i]);
2087 nv_free(((nvlist_t **)(intptr_t)nvp->nvp_data));
2089 case NV_TYPE_NUMBER_ARRAY:
2090 nv_free((uint64_t *)(intptr_t)nvp->nvp_data);
2092 case NV_TYPE_BOOL_ARRAY:
2093 nv_free((bool *)(intptr_t)nvp->nvp_data);
2095 case NV_TYPE_STRING_ARRAY:
2096 for (i = 0; i < nvp->nvp_nitems; i++)
2097 nv_free(((char **)(intptr_t)nvp->nvp_data)[i]);
2098 nv_free((char **)(intptr_t)nvp->nvp_data);
2105 nvpair_free_structure(nvpair_t *nvp)
2109 PJDLOG_ASSERT(nvp->nvp_list == NULL);
2116 nvpair_type_string(int type)
2124 case NV_TYPE_NUMBER:
2126 case NV_TYPE_STRING:
2128 case NV_TYPE_NVLIST:
2130 case NV_TYPE_DESCRIPTOR:
2131 return ("DESCRIPTOR");
2132 case NV_TYPE_BINARY:
2134 case NV_TYPE_BOOL_ARRAY:
2135 return ("BOOL ARRAY");
2136 case NV_TYPE_NUMBER_ARRAY:
2137 return ("NUMBER ARRAY");
2138 case NV_TYPE_STRING_ARRAY:
2139 return ("STRING ARRAY");
2140 case NV_TYPE_NVLIST_ARRAY:
2141 return ("NVLIST ARRAY");
2142 case NV_TYPE_DESCRIPTOR_ARRAY:
2143 return ("DESCRIPTOR ARRAY");
2145 return ("<UNKNOWN>");