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 __unused)
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,
239 const nvlist_t *nvl __unused)
243 PJDLOG_ASSERT(nvp->nvp_list == nvl);
245 if (nvpair_type(nvp) == NV_TYPE_NVLIST)
246 nvpair_remove_nvlist(nvp);
247 else if (nvpair_type(nvp) == NV_TYPE_NVLIST_ARRAY)
248 nvpair_remove_nvlist_array(nvp);
250 TAILQ_REMOVE(head, nvp, nvp_next);
251 nvp->nvp_list = NULL;
255 nvpair_clone(const nvpair_t *nvp)
264 name = nvpair_name(nvp);
266 switch (nvpair_type(nvp)) {
268 newnvp = nvpair_create_null(name);
271 newnvp = nvpair_create_bool(name, nvpair_get_bool(nvp));
274 newnvp = nvpair_create_number(name, nvpair_get_number(nvp));
277 newnvp = nvpair_create_string(name, nvpair_get_string(nvp));
280 newnvp = nvpair_create_nvlist(name, nvpair_get_nvlist(nvp));
283 data = nvpair_get_binary(nvp, &datasize);
284 newnvp = nvpair_create_binary(name, data, datasize);
286 case NV_TYPE_BOOL_ARRAY:
287 data = nvpair_get_bool_array(nvp, &datasize);
288 newnvp = nvpair_create_bool_array(name, data, datasize);
290 case NV_TYPE_NUMBER_ARRAY:
291 data = nvpair_get_number_array(nvp, &datasize);
292 newnvp = nvpair_create_number_array(name, data, datasize);
294 case NV_TYPE_STRING_ARRAY:
295 data = nvpair_get_string_array(nvp, &datasize);
296 newnvp = nvpair_create_string_array(name, data, datasize);
298 case NV_TYPE_NVLIST_ARRAY:
299 data = nvpair_get_nvlist_array(nvp, &datasize);
300 newnvp = nvpair_create_nvlist_array(name, data, datasize);
303 case NV_TYPE_DESCRIPTOR:
304 newnvp = nvpair_create_descriptor(name,
305 nvpair_get_descriptor(nvp));
307 case NV_TYPE_DESCRIPTOR_ARRAY:
308 data = nvpair_get_descriptor_array(nvp, &datasize);
309 newnvp = nvpair_create_descriptor_array(name, data, datasize);
313 PJDLOG_ABORT("Unknown type: %d.", nvpair_type(nvp));
320 nvpair_header_size(void)
323 return (sizeof(struct nvpair_header));
327 nvpair_size(const nvpair_t *nvp)
332 return (nvp->nvp_datasize);
336 nvpair_pack_header(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
338 struct nvpair_header nvphdr;
343 nvphdr.nvph_type = nvp->nvp_type;
344 namesize = strlen(nvp->nvp_name) + 1;
345 PJDLOG_ASSERT(namesize > 0 && namesize <= UINT16_MAX);
346 nvphdr.nvph_namesize = namesize;
347 nvphdr.nvph_datasize = nvp->nvp_datasize;
348 nvphdr.nvph_nitems = nvp->nvp_nitems;
349 PJDLOG_ASSERT(*leftp >= sizeof(nvphdr));
350 memcpy(ptr, &nvphdr, sizeof(nvphdr));
351 ptr += sizeof(nvphdr);
352 *leftp -= sizeof(nvphdr);
354 PJDLOG_ASSERT(*leftp >= namesize);
355 memcpy(ptr, nvp->nvp_name, namesize);
363 nvpair_pack_null(const nvpair_t *nvp __unused, unsigned char *ptr,
364 size_t *leftp __unused)
368 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NULL);
374 nvpair_pack_bool(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
379 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BOOL);
381 value = (uint8_t)nvp->nvp_data;
383 PJDLOG_ASSERT(*leftp >= sizeof(value));
384 memcpy(ptr, &value, sizeof(value));
385 ptr += sizeof(value);
386 *leftp -= sizeof(value);
392 nvpair_pack_number(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
397 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NUMBER);
399 value = (uint64_t)nvp->nvp_data;
401 PJDLOG_ASSERT(*leftp >= sizeof(value));
402 memcpy(ptr, &value, sizeof(value));
403 ptr += sizeof(value);
404 *leftp -= sizeof(value);
410 nvpair_pack_string(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
414 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_STRING);
416 PJDLOG_ASSERT(*leftp >= nvp->nvp_datasize);
417 memcpy(ptr, (const void *)(intptr_t)nvp->nvp_data, nvp->nvp_datasize);
418 ptr += nvp->nvp_datasize;
419 *leftp -= nvp->nvp_datasize;
425 nvpair_pack_nvlist_up(unsigned char *ptr, size_t *leftp)
427 struct nvpair_header nvphdr;
429 const char *name = "";
432 nvphdr.nvph_type = NV_TYPE_NVLIST_UP;
433 nvphdr.nvph_namesize = namesize;
434 nvphdr.nvph_datasize = 0;
435 nvphdr.nvph_nitems = 0;
436 PJDLOG_ASSERT(*leftp >= sizeof(nvphdr));
437 memcpy(ptr, &nvphdr, sizeof(nvphdr));
438 ptr += sizeof(nvphdr);
439 *leftp -= sizeof(nvphdr);
441 PJDLOG_ASSERT(*leftp >= namesize);
442 memcpy(ptr, name, namesize);
450 nvpair_pack_nvlist_array_next(unsigned char *ptr, size_t *leftp)
452 struct nvpair_header nvphdr;
454 const char *name = "";
457 nvphdr.nvph_type = NV_TYPE_NVLIST_ARRAY_NEXT;
458 nvphdr.nvph_namesize = namesize;
459 nvphdr.nvph_datasize = 0;
460 nvphdr.nvph_nitems = 0;
461 PJDLOG_ASSERT(*leftp >= sizeof(nvphdr));
462 memcpy(ptr, &nvphdr, sizeof(nvphdr));
463 ptr += sizeof(nvphdr);
464 *leftp -= sizeof(nvphdr);
466 PJDLOG_ASSERT(*leftp >= namesize);
467 memcpy(ptr, name, namesize);
476 nvpair_pack_descriptor(const nvpair_t *nvp, unsigned char *ptr, int64_t *fdidxp,
482 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_DESCRIPTOR);
484 value = (int64_t)nvp->nvp_data;
487 * If there is a real descriptor here, we change its number
488 * to position in the array of descriptors send via control
491 PJDLOG_ASSERT(fdidxp != NULL);
497 PJDLOG_ASSERT(*leftp >= sizeof(value));
498 memcpy(ptr, &value, sizeof(value));
499 ptr += sizeof(value);
500 *leftp -= sizeof(value);
507 nvpair_pack_binary(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
511 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BINARY);
513 PJDLOG_ASSERT(*leftp >= nvp->nvp_datasize);
514 memcpy(ptr, (const void *)(intptr_t)nvp->nvp_data, nvp->nvp_datasize);
515 ptr += nvp->nvp_datasize;
516 *leftp -= nvp->nvp_datasize;
522 nvpair_pack_bool_array(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
526 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BOOL_ARRAY);
527 PJDLOG_ASSERT(*leftp >= nvp->nvp_datasize);
529 memcpy(ptr, (const void *)(intptr_t)nvp->nvp_data, nvp->nvp_datasize);
530 ptr += nvp->nvp_datasize;
531 *leftp -= nvp->nvp_datasize;
537 nvpair_pack_number_array(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
541 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NUMBER_ARRAY);
542 PJDLOG_ASSERT(*leftp >= nvp->nvp_datasize);
544 memcpy(ptr, (const void *)(intptr_t)nvp->nvp_data, nvp->nvp_datasize);
545 ptr += nvp->nvp_datasize;
546 *leftp -= nvp->nvp_datasize;
552 nvpair_pack_string_array(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
556 const char * const *array;
559 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_STRING_ARRAY);
560 PJDLOG_ASSERT(*leftp >= nvp->nvp_datasize);
563 array = nvpair_get_string_array(nvp, NULL);
564 PJDLOG_ASSERT(array != NULL);
566 for (ii = 0; ii < nvp->nvp_nitems; ii++) {
567 len = strlen(array[ii]) + 1;
568 PJDLOG_ASSERT(*leftp >= len);
570 memcpy(ptr, (const void *)array[ii], len);
576 PJDLOG_ASSERT(size == nvp->nvp_datasize);
583 nvpair_pack_descriptor_array(const nvpair_t *nvp, unsigned char *ptr,
584 int64_t *fdidxp, size_t *leftp)
591 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_DESCRIPTOR_ARRAY);
592 PJDLOG_ASSERT(*leftp >= nvp->nvp_datasize);
594 array = nvpair_get_descriptor_array(nvp, NULL);
595 PJDLOG_ASSERT(array != NULL);
597 for (ii = 0; ii < nvp->nvp_nitems; ii++) {
598 PJDLOG_ASSERT(*leftp >= sizeof(value));
603 * If there is a real descriptor here, we change its
604 * number to position in the array of descriptors send
605 * via control message.
607 PJDLOG_ASSERT(fdidxp != NULL);
612 memcpy(ptr, &value, sizeof(value));
613 ptr += sizeof(value);
614 *leftp -= sizeof(value);
622 nvpair_init_datasize(nvpair_t *nvp)
627 if (nvp->nvp_type == NV_TYPE_NVLIST) {
628 if (nvp->nvp_data == 0) {
629 nvp->nvp_datasize = 0;
632 nvlist_size((const nvlist_t *)(intptr_t)nvp->nvp_data);
637 const unsigned char *
638 nvpair_unpack_header(bool isbe, nvpair_t *nvp, const unsigned char *ptr,
641 struct nvpair_header nvphdr;
643 if (*leftp < sizeof(nvphdr))
646 memcpy(&nvphdr, ptr, sizeof(nvphdr));
647 ptr += sizeof(nvphdr);
648 *leftp -= sizeof(nvphdr);
650 #if NV_TYPE_FIRST > 0
651 if (nvphdr.nvph_type < NV_TYPE_FIRST)
654 if (nvphdr.nvph_type > NV_TYPE_LAST &&
655 nvphdr.nvph_type != NV_TYPE_NVLIST_UP &&
656 nvphdr.nvph_type != NV_TYPE_NVLIST_ARRAY_NEXT) {
660 #if BYTE_ORDER == BIG_ENDIAN
662 nvphdr.nvph_namesize = le16toh(nvphdr.nvph_namesize);
663 nvphdr.nvph_datasize = le64toh(nvphdr.nvph_datasize);
667 nvphdr.nvph_namesize = be16toh(nvphdr.nvph_namesize);
668 nvphdr.nvph_datasize = be64toh(nvphdr.nvph_datasize);
672 if (nvphdr.nvph_namesize > NV_NAME_MAX)
674 if (*leftp < nvphdr.nvph_namesize)
676 if (nvphdr.nvph_namesize < 1)
678 if (strnlen((const char *)ptr, nvphdr.nvph_namesize) !=
679 (size_t)(nvphdr.nvph_namesize - 1)) {
683 memcpy(nvp->nvp_name, ptr, nvphdr.nvph_namesize);
684 ptr += nvphdr.nvph_namesize;
685 *leftp -= nvphdr.nvph_namesize;
687 if (*leftp < nvphdr.nvph_datasize)
690 nvp->nvp_type = nvphdr.nvph_type;
692 nvp->nvp_datasize = nvphdr.nvph_datasize;
693 nvp->nvp_nitems = nvphdr.nvph_nitems;
701 const unsigned char *
702 nvpair_unpack_null(bool isbe __unused, nvpair_t *nvp, const unsigned char *ptr,
703 size_t *leftp __unused)
706 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NULL);
708 if (nvp->nvp_datasize != 0) {
716 const unsigned char *
717 nvpair_unpack_bool(bool isbe __unused, nvpair_t *nvp, const unsigned char *ptr,
722 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BOOL);
724 if (nvp->nvp_datasize != sizeof(value)) {
728 if (*leftp < sizeof(value)) {
733 memcpy(&value, ptr, sizeof(value));
734 ptr += sizeof(value);
735 *leftp -= sizeof(value);
737 if (value != 0 && value != 1) {
742 nvp->nvp_data = (uint64_t)value;
747 const unsigned char *
748 nvpair_unpack_number(bool isbe, nvpair_t *nvp, const unsigned char *ptr,
752 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NUMBER);
754 if (nvp->nvp_datasize != sizeof(uint64_t)) {
758 if (*leftp < sizeof(uint64_t)) {
764 nvp->nvp_data = be64dec(ptr);
766 nvp->nvp_data = le64dec(ptr);
768 ptr += sizeof(uint64_t);
769 *leftp -= sizeof(uint64_t);
774 const unsigned char *
775 nvpair_unpack_string(bool isbe __unused, nvpair_t *nvp,
776 const unsigned char *ptr, size_t *leftp)
779 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_STRING);
781 if (*leftp < nvp->nvp_datasize || nvp->nvp_datasize == 0) {
786 if (strnlen((const char *)ptr, nvp->nvp_datasize) !=
787 nvp->nvp_datasize - 1) {
792 nvp->nvp_data = (uint64_t)(uintptr_t)nv_strdup((const char *)ptr);
793 if (nvp->nvp_data == 0)
796 ptr += nvp->nvp_datasize;
797 *leftp -= nvp->nvp_datasize;
802 const unsigned char *
803 nvpair_unpack_nvlist(bool isbe __unused, nvpair_t *nvp,
804 const unsigned char *ptr, size_t *leftp, size_t nfds, nvlist_t **child)
808 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NVLIST);
810 if (*leftp < nvp->nvp_datasize || nvp->nvp_datasize == 0) {
815 value = nvlist_create(0);
819 ptr = nvlist_unpack_header(value, ptr, nfds, NULL, leftp);
823 nvp->nvp_data = (uint64_t)(uintptr_t)value;
830 const unsigned char *
831 nvpair_unpack_descriptor(bool isbe, nvpair_t *nvp, const unsigned char *ptr,
832 size_t *leftp, const int *fds, size_t nfds)
836 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_DESCRIPTOR);
838 if (nvp->nvp_datasize != sizeof(idx)) {
842 if (*leftp < sizeof(idx)) {
857 if ((size_t)idx >= nfds) {
862 nvp->nvp_data = (uint64_t)fds[idx];
865 *leftp -= sizeof(idx);
871 const unsigned char *
872 nvpair_unpack_binary(bool isbe __unused, nvpair_t *nvp,
873 const unsigned char *ptr, size_t *leftp)
877 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BINARY);
879 if (*leftp < nvp->nvp_datasize || nvp->nvp_datasize == 0) {
884 value = nv_malloc(nvp->nvp_datasize);
888 memcpy(value, ptr, nvp->nvp_datasize);
889 ptr += nvp->nvp_datasize;
890 *leftp -= nvp->nvp_datasize;
892 nvp->nvp_data = (uint64_t)(uintptr_t)value;
897 const unsigned char *
898 nvpair_unpack_bool_array(bool isbe __unused, nvpair_t *nvp,
899 const unsigned char *ptr, size_t *leftp)
905 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BOOL_ARRAY);
907 size = sizeof(*value) * nvp->nvp_nitems;
908 if (nvp->nvp_datasize != size || *leftp < size ||
909 nvp->nvp_nitems == 0 || size < nvp->nvp_nitems) {
914 value = nv_malloc(size);
918 for (i = 0; i < nvp->nvp_nitems; i++) {
919 value[i] = *(const uint8_t *)ptr;
921 ptr += sizeof(*value);
922 *leftp -= sizeof(*value);
925 nvp->nvp_data = (uint64_t)(uintptr_t)value;
930 const unsigned char *
931 nvpair_unpack_number_array(bool isbe, nvpair_t *nvp, const unsigned char *ptr,
938 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NUMBER_ARRAY);
940 size = sizeof(*value) * nvp->nvp_nitems;
941 if (nvp->nvp_datasize != size || *leftp < size ||
942 nvp->nvp_nitems == 0 || size < nvp->nvp_nitems) {
947 value = nv_malloc(size);
951 for (i = 0; i < nvp->nvp_nitems; i++) {
953 value[i] = be64dec(ptr);
955 value[i] = le64dec(ptr);
957 ptr += sizeof(*value);
958 *leftp -= sizeof(*value);
961 nvp->nvp_data = (uint64_t)(uintptr_t)value;
966 const unsigned char *
967 nvpair_unpack_string_array(bool isbe __unused, nvpair_t *nvp,
968 const unsigned char *ptr, size_t *leftp)
976 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_STRING_ARRAY);
978 if (*leftp < nvp->nvp_datasize || nvp->nvp_datasize == 0 ||
979 nvp->nvp_nitems == 0) {
984 size = nvp->nvp_datasize;
985 tmp = (const char *)ptr;
986 for (ii = 0; ii < nvp->nvp_nitems; ii++) {
987 len = strnlen(tmp, size - 1) + 1;
1000 value = nv_malloc(sizeof(*value) * nvp->nvp_nitems);
1004 for (ii = 0; ii < nvp->nvp_nitems; ii++) {
1005 value[ii] = nv_strdup((const char *)ptr);
1006 if (value[ii] == NULL)
1008 len = strlen(value[ii]) + 1;
1012 nvp->nvp_data = (uint64_t)(uintptr_t)value;
1016 for (j = 0; j < ii; j++)
1023 const unsigned char *
1024 nvpair_unpack_descriptor_array(bool isbe, nvpair_t *nvp,
1025 const unsigned char *ptr, size_t *leftp, const int *fds, size_t nfds)
1032 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_DESCRIPTOR_ARRAY);
1034 size = sizeof(idx) * nvp->nvp_nitems;
1035 if (nvp->nvp_datasize != size || *leftp < size ||
1036 nvp->nvp_nitems == 0 || size < nvp->nvp_nitems) {
1041 array = (int *)nv_malloc(size);
1045 for (ii = 0; ii < nvp->nvp_nitems; ii++) {
1057 if ((size_t)idx >= nfds) {
1063 array[ii] = (uint64_t)fds[idx];
1066 *leftp -= sizeof(idx);
1069 nvp->nvp_data = (uint64_t)(uintptr_t)array;
1075 const unsigned char *
1076 nvpair_unpack_nvlist_array(bool isbe __unused, nvpair_t *nvp,
1077 const unsigned char *ptr, size_t *leftp, nvlist_t **firstel)
1084 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NVLIST_ARRAY);
1086 sizeup = sizeof(struct nvpair_header) * nvp->nvp_nitems;
1087 if (nvp->nvp_nitems == 0 || sizeup < nvp->nvp_nitems ||
1093 value = nv_malloc(nvp->nvp_nitems * sizeof(*value));
1097 for (ii = 0; ii < nvp->nvp_nitems; ii++) {
1098 value[ii] = nvlist_create(0);
1099 if (value[ii] == NULL)
1102 tmpnvp = nvpair_allocv(" ", NV_TYPE_NVLIST,
1103 (uint64_t)(uintptr_t)value[ii], 0, 0);
1106 nvlist_set_array_next(value[ii - 1], tmpnvp);
1109 nvlist_set_flags(value[nvp->nvp_nitems - 1], NV_FLAG_IN_ARRAY);
1111 nvp->nvp_data = (uint64_t)(uintptr_t)value;
1112 *firstel = value[0];
1117 for (j = 0; j <= ii; j++)
1118 nvlist_destroy(value[j]);
1125 const unsigned char *
1126 nvpair_unpack(bool isbe, const unsigned char *ptr, size_t *leftp,
1129 nvpair_t *nvp, *tmp;
1131 nvp = nv_calloc(1, sizeof(*nvp) + NV_NAME_MAX);
1134 nvp->nvp_name = (char *)(nvp + 1);
1136 ptr = nvpair_unpack_header(isbe, nvp, ptr, leftp);
1139 tmp = nv_realloc(nvp, sizeof(*nvp) + strlen(nvp->nvp_name) + 1);
1144 /* Update nvp_name after realloc(). */
1145 nvp->nvp_name = (char *)(nvp + 1);
1146 nvp->nvp_data = 0x00;
1147 nvp->nvp_magic = NVPAIR_MAGIC;
1156 nvpair_type(const nvpair_t *nvp)
1161 return (nvp->nvp_type);
1165 nvpair_name(const nvpair_t *nvp)
1170 return (nvp->nvp_name);
1174 nvpair_create_stringf(const char *name, const char *valuefmt, ...)
1179 va_start(valueap, valuefmt);
1180 nvp = nvpair_create_stringv(name, valuefmt, valueap);
1187 nvpair_create_stringv(const char *name, const char *valuefmt, va_list valueap)
1193 len = nv_vasprintf(&str, valuefmt, valueap);
1196 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 value = fcntl(value, F_DUPFD_CLOEXEC, 0);
1283 nvp = nvpair_allocv(name, NV_TYPE_DESCRIPTOR, (uint64_t)value,
1284 sizeof(int64_t), 0);
1296 nvpair_create_binary(const char *name, const void *value, size_t size)
1301 if (value == NULL || size == 0) {
1306 data = nv_malloc(size);
1309 memcpy(data, value, size);
1311 nvp = nvpair_allocv(name, NV_TYPE_BINARY, (uint64_t)(uintptr_t)data,
1320 nvpair_create_bool_array(const char *name, const bool *value, size_t nitems)
1326 if (value == NULL || nitems == 0) {
1331 size = sizeof(value[0]) * nitems;
1332 data = nv_malloc(size);
1336 memcpy(data, value, size);
1337 nvp = nvpair_allocv(name, NV_TYPE_BOOL_ARRAY, (uint64_t)(uintptr_t)data,
1349 nvpair_create_number_array(const char *name, const uint64_t *value,
1356 if (value == NULL || nitems == 0) {
1361 size = sizeof(value[0]) * nitems;
1362 data = nv_malloc(size);
1366 memcpy(data, value, size);
1367 nvp = nvpair_allocv(name, NV_TYPE_NUMBER_ARRAY,
1368 (uint64_t)(uintptr_t)data, size, nitems);
1379 nvpair_create_string_array(const char *name, const char * const *value,
1384 size_t datasize, size;
1387 if (value == NULL || nitems == 0) {
1394 data = nv_malloc(sizeof(value[0]) * nitems);
1398 for (ii = 0; ii < nitems; ii++) {
1399 if (value[ii] == NULL) {
1404 size = strlen(value[ii]) + 1;
1406 data[ii] = nv_strdup(value[ii]);
1407 if (data[ii] == NULL)
1410 nvp = nvpair_allocv(name, NV_TYPE_STRING_ARRAY,
1411 (uint64_t)(uintptr_t)data, datasize, nitems);
1416 for (; ii > 0; ii--)
1417 nv_free(data[ii - 1]);
1426 nvpair_create_nvlist_array(const char *name, const nvlist_t * const *value,
1436 if (value == NULL || nitems == 0) {
1441 nvls = nv_malloc(sizeof(value[0]) * nitems);
1445 for (ii = 0; ii < nitems; ii++) {
1446 if (value[ii] == NULL) {
1451 nvls[ii] = nvlist_clone(value[ii]);
1452 if (nvls[ii] == NULL)
1458 nvp = nvpair_allocv(" ", NV_TYPE_NVLIST,
1459 (uint64_t)(uintptr_t)nvls[ii], 0, 0);
1462 nvlist_destroy(nvls[ii]);
1466 nvlist_set_array_next(nvls[ii - 1], nvp);
1469 flags = nvlist_flags(nvls[nitems - 1]) | NV_FLAG_IN_ARRAY;
1470 nvlist_set_flags(nvls[nitems - 1], flags);
1472 parent = nvpair_allocv(name, NV_TYPE_NVLIST_ARRAY,
1473 (uint64_t)(uintptr_t)nvls, 0, nitems);
1477 for (ii = 0; ii < nitems; ii++)
1478 nvlist_set_parent(nvls[ii], parent);
1484 for (; ii > 0; ii--)
1485 nvlist_destroy(nvls[ii - 1]);
1494 nvpair_create_descriptor_array(const char *name, const int *value,
1501 if (value == NULL) {
1508 fds = nv_malloc(sizeof(value[0]) * nitems);
1511 for (ii = 0; ii < nitems; ii++) {
1512 if (value[ii] == -1) {
1515 fds[ii] = fcntl(value[ii], F_DUPFD_CLOEXEC, 0);
1521 nvp = nvpair_allocv(name, NV_TYPE_DESCRIPTOR_ARRAY,
1522 (uint64_t)(uintptr_t)fds, sizeof(int64_t) * nitems, nitems);
1527 for (; ii > 0; ii--) {
1528 if (fds[ii - 1] != -1)
1540 nvpair_move_string(const char *name, char *value)
1544 if (value == NULL) {
1549 nvp = nvpair_allocv(name, NV_TYPE_STRING, (uint64_t)(uintptr_t)value,
1550 strlen(value) + 1, 0);
1561 nvpair_move_nvlist(const char *name, nvlist_t *value)
1565 if (value == NULL || nvlist_get_nvpair_parent(value) != NULL) {
1570 if (nvlist_error(value) != 0) {
1571 ERRNO_SET(nvlist_error(value));
1572 nvlist_destroy(value);
1576 nvp = nvpair_allocv(name, NV_TYPE_NVLIST, (uint64_t)(uintptr_t)value,
1579 nvlist_destroy(value);
1581 nvlist_set_parent(value, nvp);
1588 nvpair_move_descriptor(const char *name, int value)
1592 if (value < 0 || !fd_is_valid(value)) {
1597 nvp = nvpair_allocv(name, NV_TYPE_DESCRIPTOR, (uint64_t)value,
1598 sizeof(int64_t), 0);
1610 nvpair_move_binary(const char *name, void *value, size_t size)
1614 if (value == NULL || size == 0) {
1619 nvp = nvpair_allocv(name, NV_TYPE_BINARY, (uint64_t)(uintptr_t)value,
1631 nvpair_move_bool_array(const char *name, bool *value, size_t nitems)
1635 if (value == NULL || nitems == 0) {
1640 nvp = nvpair_allocv(name, NV_TYPE_BOOL_ARRAY,
1641 (uint64_t)(uintptr_t)value, sizeof(value[0]) * nitems, nitems);
1652 nvpair_move_string_array(const char *name, char **value, size_t nitems)
1657 if (value == NULL || nitems == 0) {
1663 for (i = 0; i < nitems; i++) {
1664 if (value[i] == NULL) {
1669 size += strlen(value[i]) + 1;
1672 nvp = nvpair_allocv(name, NV_TYPE_STRING_ARRAY,
1673 (uint64_t)(uintptr_t)value, size, nitems);
1676 for (i = 0; i < nitems; i++)
1686 nvpair_move_number_array(const char *name, uint64_t *value, size_t nitems)
1690 if (value == NULL || nitems == 0) {
1695 nvp = nvpair_allocv(name, NV_TYPE_NUMBER_ARRAY,
1696 (uint64_t)(uintptr_t)value, sizeof(value[0]) * nitems, nitems);
1707 nvpair_move_nvlist_array(const char *name, nvlist_t **value, size_t nitems)
1713 if (value == NULL || nitems == 0) {
1718 for (ii = 0; ii < nitems; ii++) {
1719 if (value == NULL || nvlist_error(value[ii]) != 0 ||
1720 nvlist_get_pararr(value[ii], NULL) != NULL) {
1727 nvp = nvpair_allocv(" ", NV_TYPE_NVLIST,
1728 (uint64_t)(uintptr_t)value[ii], 0, 0);
1731 nvlist_set_array_next(value[ii - 1], nvp);
1734 flags = nvlist_flags(value[nitems - 1]) | NV_FLAG_IN_ARRAY;
1735 nvlist_set_flags(value[nitems - 1], flags);
1737 parent = nvpair_allocv(name, NV_TYPE_NVLIST_ARRAY,
1738 (uint64_t)(uintptr_t)value, 0, nitems);
1742 for (ii = 0; ii < nitems; ii++)
1743 nvlist_set_parent(value[ii], parent);
1748 for (ii = 0; ii < nitems; ii++) {
1749 if (value[ii] != NULL &&
1750 nvlist_get_pararr(value[ii], NULL) != NULL) {
1751 nvlist_destroy(value[ii]);
1762 nvpair_move_descriptor_array(const char *name, int *value, size_t nitems)
1767 if (value == NULL || nitems == 0) {
1772 for (i = 0; i < nitems; i++) {
1773 if (value[i] != -1 && !fd_is_valid(value[i])) {
1779 nvp = nvpair_allocv(name, NV_TYPE_DESCRIPTOR_ARRAY,
1780 (uint64_t)(uintptr_t)value, sizeof(value[0]) * nitems, nitems);
1787 for (i = 0; i < nitems; i++) {
1788 if (fd_is_valid(value[i]))
1799 nvpair_get_bool(const nvpair_t *nvp)
1804 return (nvp->nvp_data == 1);
1808 nvpair_get_number(const nvpair_t *nvp)
1813 return (nvp->nvp_data);
1817 nvpair_get_string(const nvpair_t *nvp)
1821 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_STRING);
1823 return ((const char *)(intptr_t)nvp->nvp_data);
1827 nvpair_get_nvlist(const nvpair_t *nvp)
1831 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NVLIST);
1833 return ((const nvlist_t *)(intptr_t)nvp->nvp_data);
1838 nvpair_get_descriptor(const nvpair_t *nvp)
1842 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_DESCRIPTOR);
1844 return ((int)nvp->nvp_data);
1849 nvpair_get_binary(const nvpair_t *nvp, size_t *sizep)
1853 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BINARY);
1856 *sizep = nvp->nvp_datasize;
1858 return ((const void *)(intptr_t)nvp->nvp_data);
1862 nvpair_get_bool_array(const nvpair_t *nvp, size_t *nitems)
1866 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BOOL_ARRAY);
1869 *nitems = nvp->nvp_nitems;
1871 return ((const bool *)(intptr_t)nvp->nvp_data);
1875 nvpair_get_number_array(const nvpair_t *nvp, size_t *nitems)
1879 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NUMBER_ARRAY);
1882 *nitems = nvp->nvp_nitems;
1884 return ((const uint64_t *)(intptr_t)nvp->nvp_data);
1887 const char * const *
1888 nvpair_get_string_array(const nvpair_t *nvp, size_t *nitems)
1892 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_STRING_ARRAY);
1895 *nitems = nvp->nvp_nitems;
1897 return ((const char * const *)(intptr_t)nvp->nvp_data);
1900 const nvlist_t * const *
1901 nvpair_get_nvlist_array(const nvpair_t *nvp, size_t *nitems)
1905 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NVLIST_ARRAY);
1908 *nitems = nvp->nvp_nitems;
1910 return ((const nvlist_t * const *)((intptr_t)nvp->nvp_data));
1915 nvpair_get_descriptor_array(const nvpair_t *nvp, size_t *nitems)
1919 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_DESCRIPTOR_ARRAY);
1922 *nitems = nvp->nvp_nitems;
1924 return ((const int *)(intptr_t)nvp->nvp_data);
1929 nvpair_append_bool_array(nvpair_t *nvp, const bool value)
1933 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BOOL_ARRAY);
1934 return (nvpair_append(nvp, &value, sizeof(value), sizeof(value)));
1938 nvpair_append_number_array(nvpair_t *nvp, const uint64_t value)
1942 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NUMBER_ARRAY);
1943 return (nvpair_append(nvp, &value, sizeof(value), sizeof(value)));
1947 nvpair_append_string_array(nvpair_t *nvp, const char *value)
1952 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_STRING_ARRAY);
1953 if (value == NULL) {
1957 str = nv_strdup(value);
1961 if (nvpair_append(nvp, &str, sizeof(str), strlen(str) + 1) == -1) {
1969 nvpair_append_nvlist_array(nvpair_t *nvp, const nvlist_t *value)
1972 nvlist_t *nvl, *prev;
1976 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NVLIST_ARRAY);
1977 if (value == NULL || nvlist_error(value) != 0 ||
1978 nvlist_get_pararr(value, NULL) != NULL) {
1982 nvl = nvlist_clone(value);
1986 flags = nvlist_flags(nvl) | NV_FLAG_IN_ARRAY;
1987 nvlist_set_flags(nvl, flags);
1991 if (nvp->nvp_nitems > 0) {
1992 nvlist_t **nvls = (void *)(uintptr_t)nvp->nvp_data;
1994 prev = nvls[nvp->nvp_nitems - 1];
1995 PJDLOG_ASSERT(prev != NULL);
1997 tmpnvp = nvpair_allocv(" ", NV_TYPE_NVLIST,
1998 (uint64_t)(uintptr_t)nvl, 0, 0);
1999 if (tmpnvp == NULL) {
2003 if (nvpair_append(nvp, &nvl, sizeof(nvl), 0) == -1) {
2007 NVPAIR_ASSERT(tmpnvp);
2008 nvlist_set_array_next(prev, tmpnvp);
2010 nvlist_set_parent(nvl, nvp);
2014 nvpair_free(tmpnvp);
2016 nvlist_destroy(nvl);
2022 nvpair_append_descriptor_array(nvpair_t *nvp, const int value)
2027 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_DESCRIPTOR_ARRAY);
2028 fd = fcntl(value, F_DUPFD_CLOEXEC, 0);
2032 if (nvpair_append(nvp, &fd, sizeof(fd), sizeof(fd)) == -1) {
2041 nvpair_free(nvpair_t *nvp)
2046 PJDLOG_ASSERT(nvp->nvp_list == NULL);
2049 switch (nvp->nvp_type) {
2051 case NV_TYPE_DESCRIPTOR:
2052 close((int)nvp->nvp_data);
2054 case NV_TYPE_DESCRIPTOR_ARRAY:
2055 for (i = 0; i < nvp->nvp_nitems; i++)
2056 close(((int *)(intptr_t)nvp->nvp_data)[i]);
2057 nv_free((int *)(intptr_t)nvp->nvp_data);
2060 case NV_TYPE_NVLIST:
2061 nvlist_destroy((nvlist_t *)(intptr_t)nvp->nvp_data);
2063 case NV_TYPE_STRING:
2064 nv_free((char *)(intptr_t)nvp->nvp_data);
2066 case NV_TYPE_BINARY:
2067 nv_free((void *)(intptr_t)nvp->nvp_data);
2069 case NV_TYPE_NVLIST_ARRAY:
2070 for (i = 0; i < nvp->nvp_nitems; i++) {
2072 ((nvlist_t **)(intptr_t)nvp->nvp_data)[i]);
2074 nv_free(((nvlist_t **)(intptr_t)nvp->nvp_data));
2076 case NV_TYPE_NUMBER_ARRAY:
2077 nv_free((uint64_t *)(intptr_t)nvp->nvp_data);
2079 case NV_TYPE_BOOL_ARRAY:
2080 nv_free((bool *)(intptr_t)nvp->nvp_data);
2082 case NV_TYPE_STRING_ARRAY:
2083 for (i = 0; i < nvp->nvp_nitems; i++)
2084 nv_free(((char **)(intptr_t)nvp->nvp_data)[i]);
2085 nv_free((char **)(intptr_t)nvp->nvp_data);
2092 nvpair_free_structure(nvpair_t *nvp)
2096 PJDLOG_ASSERT(nvp->nvp_list == NULL);
2103 nvpair_type_string(int type)
2111 case NV_TYPE_NUMBER:
2113 case NV_TYPE_STRING:
2115 case NV_TYPE_NVLIST:
2117 case NV_TYPE_DESCRIPTOR:
2118 return ("DESCRIPTOR");
2119 case NV_TYPE_BINARY:
2121 case NV_TYPE_BOOL_ARRAY:
2122 return ("BOOL ARRAY");
2123 case NV_TYPE_NUMBER_ARRAY:
2124 return ("NUMBER ARRAY");
2125 case NV_TYPE_STRING_ARRAY:
2126 return ("STRING ARRAY");
2127 case NV_TYPE_NVLIST_ARRAY:
2128 return ("NVLIST ARRAY");
2129 case NV_TYPE_DESCRIPTOR_ARRAY:
2130 return ("DESCRIPTOR ARRAY");
2132 return ("<UNKNOWN>");