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++) {
236 nnvp = nvlist_get_array_next_nvpair(nvl);
238 nvpair_free_structure(nnvp);
240 nvlist_set_array_next(nvl, NULL);
241 nvlist_set_parent(nvl, NULL);
246 nvpair_remove(struct nvl_head *head, nvpair_t *nvp, const nvlist_t *nvl)
250 PJDLOG_ASSERT(nvp->nvp_list == nvl);
252 if (nvpair_type(nvp) == NV_TYPE_NVLIST)
253 nvpair_remove_nvlist(nvp);
254 else if (nvpair_type(nvp) == NV_TYPE_NVLIST_ARRAY)
255 nvpair_remove_nvlist_array(nvp);
257 TAILQ_REMOVE(head, nvp, nvp_next);
258 nvp->nvp_list = NULL;
262 nvpair_clone(const nvpair_t *nvp)
271 name = nvpair_name(nvp);
273 switch (nvpair_type(nvp)) {
275 newnvp = nvpair_create_null(name);
278 newnvp = nvpair_create_bool(name, nvpair_get_bool(nvp));
281 newnvp = nvpair_create_number(name, nvpair_get_number(nvp));
284 newnvp = nvpair_create_string(name, nvpair_get_string(nvp));
287 newnvp = nvpair_create_nvlist(name, nvpair_get_nvlist(nvp));
290 data = nvpair_get_binary(nvp, &datasize);
291 newnvp = nvpair_create_binary(name, data, datasize);
293 case NV_TYPE_BOOL_ARRAY:
294 data = nvpair_get_bool_array(nvp, &datasize);
295 newnvp = nvpair_create_bool_array(name, data, datasize);
297 case NV_TYPE_NUMBER_ARRAY:
298 data = nvpair_get_number_array(nvp, &datasize);
299 newnvp = nvpair_create_number_array(name, data, datasize);
301 case NV_TYPE_STRING_ARRAY:
302 data = nvpair_get_string_array(nvp, &datasize);
303 newnvp = nvpair_create_string_array(name, data, datasize);
305 case NV_TYPE_NVLIST_ARRAY:
306 data = nvpair_get_nvlist_array(nvp, &datasize);
307 newnvp = nvpair_create_nvlist_array(name, data, datasize);
310 case NV_TYPE_DESCRIPTOR:
311 newnvp = nvpair_create_descriptor(name,
312 nvpair_get_descriptor(nvp));
314 case NV_TYPE_DESCRIPTOR_ARRAY:
315 data = nvpair_get_descriptor_array(nvp, &datasize);
316 newnvp = nvpair_create_descriptor_array(name, data, datasize);
320 PJDLOG_ABORT("Unknown type: %d.", nvpair_type(nvp));
327 nvpair_header_size(void)
330 return (sizeof(struct nvpair_header));
334 nvpair_size(const nvpair_t *nvp)
339 return (nvp->nvp_datasize);
343 nvpair_pack_header(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
345 struct nvpair_header nvphdr;
350 nvphdr.nvph_type = nvp->nvp_type;
351 namesize = strlen(nvp->nvp_name) + 1;
352 PJDLOG_ASSERT(namesize > 0 && namesize <= UINT16_MAX);
353 nvphdr.nvph_namesize = namesize;
354 nvphdr.nvph_datasize = nvp->nvp_datasize;
355 nvphdr.nvph_nitems = nvp->nvp_nitems;
356 PJDLOG_ASSERT(*leftp >= sizeof(nvphdr));
357 memcpy(ptr, &nvphdr, sizeof(nvphdr));
358 ptr += sizeof(nvphdr);
359 *leftp -= sizeof(nvphdr);
361 PJDLOG_ASSERT(*leftp >= namesize);
362 memcpy(ptr, nvp->nvp_name, namesize);
370 nvpair_pack_null(const nvpair_t *nvp, unsigned char *ptr,
371 size_t *leftp __unused)
375 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NULL);
381 nvpair_pack_bool(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
386 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BOOL);
388 value = (uint8_t)nvp->nvp_data;
390 PJDLOG_ASSERT(*leftp >= sizeof(value));
391 memcpy(ptr, &value, sizeof(value));
392 ptr += sizeof(value);
393 *leftp -= sizeof(value);
399 nvpair_pack_number(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
404 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NUMBER);
406 value = (uint64_t)nvp->nvp_data;
408 PJDLOG_ASSERT(*leftp >= sizeof(value));
409 memcpy(ptr, &value, sizeof(value));
410 ptr += sizeof(value);
411 *leftp -= sizeof(value);
417 nvpair_pack_string(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
421 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_STRING);
423 PJDLOG_ASSERT(*leftp >= nvp->nvp_datasize);
424 memcpy(ptr, (const void *)(intptr_t)nvp->nvp_data, nvp->nvp_datasize);
425 ptr += nvp->nvp_datasize;
426 *leftp -= nvp->nvp_datasize;
432 nvpair_pack_nvlist_up(unsigned char *ptr, size_t *leftp)
434 struct nvpair_header nvphdr;
436 const char *name = "";
439 nvphdr.nvph_type = NV_TYPE_NVLIST_UP;
440 nvphdr.nvph_namesize = namesize;
441 nvphdr.nvph_datasize = 0;
442 nvphdr.nvph_nitems = 0;
443 PJDLOG_ASSERT(*leftp >= sizeof(nvphdr));
444 memcpy(ptr, &nvphdr, sizeof(nvphdr));
445 ptr += sizeof(nvphdr);
446 *leftp -= sizeof(nvphdr);
448 PJDLOG_ASSERT(*leftp >= namesize);
449 memcpy(ptr, name, namesize);
457 nvpair_pack_nvlist_array_next(unsigned char *ptr, size_t *leftp)
459 struct nvpair_header nvphdr;
461 const char *name = "";
464 nvphdr.nvph_type = NV_TYPE_NVLIST_ARRAY_NEXT;
465 nvphdr.nvph_namesize = namesize;
466 nvphdr.nvph_datasize = 0;
467 nvphdr.nvph_nitems = 0;
468 PJDLOG_ASSERT(*leftp >= sizeof(nvphdr));
469 memcpy(ptr, &nvphdr, sizeof(nvphdr));
470 ptr += sizeof(nvphdr);
471 *leftp -= sizeof(nvphdr);
473 PJDLOG_ASSERT(*leftp >= namesize);
474 memcpy(ptr, name, namesize);
483 nvpair_pack_descriptor(const nvpair_t *nvp, unsigned char *ptr, int64_t *fdidxp,
489 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_DESCRIPTOR);
491 value = (int64_t)nvp->nvp_data;
494 * If there is a real descriptor here, we change its number
495 * to position in the array of descriptors send via control
498 PJDLOG_ASSERT(fdidxp != NULL);
504 PJDLOG_ASSERT(*leftp >= sizeof(value));
505 memcpy(ptr, &value, sizeof(value));
506 ptr += sizeof(value);
507 *leftp -= sizeof(value);
514 nvpair_pack_binary(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
518 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BINARY);
520 PJDLOG_ASSERT(*leftp >= nvp->nvp_datasize);
521 memcpy(ptr, (const void *)(intptr_t)nvp->nvp_data, nvp->nvp_datasize);
522 ptr += nvp->nvp_datasize;
523 *leftp -= nvp->nvp_datasize;
529 nvpair_pack_bool_array(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
533 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BOOL_ARRAY);
534 PJDLOG_ASSERT(*leftp >= nvp->nvp_datasize);
536 memcpy(ptr, (const void *)(intptr_t)nvp->nvp_data, nvp->nvp_datasize);
537 ptr += nvp->nvp_datasize;
538 *leftp -= nvp->nvp_datasize;
544 nvpair_pack_number_array(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
548 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NUMBER_ARRAY);
549 PJDLOG_ASSERT(*leftp >= nvp->nvp_datasize);
551 memcpy(ptr, (const void *)(intptr_t)nvp->nvp_data, nvp->nvp_datasize);
552 ptr += nvp->nvp_datasize;
553 *leftp -= nvp->nvp_datasize;
559 nvpair_pack_string_array(const nvpair_t *nvp, unsigned char *ptr, size_t *leftp)
563 const char * const *array;
566 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_STRING_ARRAY);
567 PJDLOG_ASSERT(*leftp >= nvp->nvp_datasize);
570 array = nvpair_get_string_array(nvp, NULL);
571 PJDLOG_ASSERT(array != NULL);
573 for (ii = 0; ii < nvp->nvp_nitems; ii++) {
574 len = strlen(array[ii]) + 1;
575 PJDLOG_ASSERT(*leftp >= len);
577 memcpy(ptr, (const void *)array[ii], len);
583 PJDLOG_ASSERT(size == nvp->nvp_datasize);
590 nvpair_pack_descriptor_array(const nvpair_t *nvp, unsigned char *ptr,
591 int64_t *fdidxp, size_t *leftp)
598 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_DESCRIPTOR_ARRAY);
599 PJDLOG_ASSERT(*leftp >= nvp->nvp_datasize);
601 array = nvpair_get_descriptor_array(nvp, NULL);
602 PJDLOG_ASSERT(array != NULL);
604 for (ii = 0; ii < nvp->nvp_nitems; ii++) {
605 PJDLOG_ASSERT(*leftp >= sizeof(value));
610 * If there is a real descriptor here, we change its
611 * number to position in the array of descriptors send
612 * via control message.
614 PJDLOG_ASSERT(fdidxp != NULL);
619 memcpy(ptr, &value, sizeof(value));
620 ptr += sizeof(value);
621 *leftp -= sizeof(value);
629 nvpair_init_datasize(nvpair_t *nvp)
634 if (nvp->nvp_type == NV_TYPE_NVLIST) {
635 if (nvp->nvp_data == 0) {
636 nvp->nvp_datasize = 0;
639 nvlist_size((const nvlist_t *)(intptr_t)nvp->nvp_data);
644 const unsigned char *
645 nvpair_unpack_header(bool isbe, nvpair_t *nvp, const unsigned char *ptr,
648 struct nvpair_header nvphdr;
650 if (*leftp < sizeof(nvphdr))
653 memcpy(&nvphdr, ptr, sizeof(nvphdr));
654 ptr += sizeof(nvphdr);
655 *leftp -= sizeof(nvphdr);
657 #if NV_TYPE_FIRST > 0
658 if (nvphdr.nvph_type < NV_TYPE_FIRST)
661 if (nvphdr.nvph_type > NV_TYPE_LAST &&
662 nvphdr.nvph_type != NV_TYPE_NVLIST_UP &&
663 nvphdr.nvph_type != NV_TYPE_NVLIST_ARRAY_NEXT) {
667 #if BYTE_ORDER == BIG_ENDIAN
669 nvphdr.nvph_namesize = le16toh(nvphdr.nvph_namesize);
670 nvphdr.nvph_datasize = le64toh(nvphdr.nvph_datasize);
674 nvphdr.nvph_namesize = be16toh(nvphdr.nvph_namesize);
675 nvphdr.nvph_datasize = be64toh(nvphdr.nvph_datasize);
679 if (nvphdr.nvph_namesize > NV_NAME_MAX)
681 if (*leftp < nvphdr.nvph_namesize)
683 if (nvphdr.nvph_namesize < 1)
685 if (strnlen((const char *)ptr, nvphdr.nvph_namesize) !=
686 (size_t)(nvphdr.nvph_namesize - 1)) {
690 memcpy(nvp->nvp_name, ptr, nvphdr.nvph_namesize);
691 ptr += nvphdr.nvph_namesize;
692 *leftp -= nvphdr.nvph_namesize;
694 if (*leftp < nvphdr.nvph_datasize)
697 nvp->nvp_type = nvphdr.nvph_type;
699 nvp->nvp_datasize = nvphdr.nvph_datasize;
700 nvp->nvp_nitems = nvphdr.nvph_nitems;
708 const unsigned char *
709 nvpair_unpack_null(bool isbe __unused, nvpair_t *nvp, const unsigned char *ptr,
710 size_t *leftp __unused)
713 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NULL);
715 if (nvp->nvp_datasize != 0) {
723 const unsigned char *
724 nvpair_unpack_bool(bool isbe __unused, nvpair_t *nvp, const unsigned char *ptr,
729 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BOOL);
731 if (nvp->nvp_datasize != sizeof(value)) {
735 if (*leftp < sizeof(value)) {
740 memcpy(&value, ptr, sizeof(value));
741 ptr += sizeof(value);
742 *leftp -= sizeof(value);
744 if (value != 0 && value != 1) {
749 nvp->nvp_data = (uint64_t)value;
754 const unsigned char *
755 nvpair_unpack_number(bool isbe, nvpair_t *nvp, const unsigned char *ptr,
759 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NUMBER);
761 if (nvp->nvp_datasize != sizeof(uint64_t)) {
765 if (*leftp < sizeof(uint64_t)) {
771 nvp->nvp_data = be64dec(ptr);
773 nvp->nvp_data = le64dec(ptr);
775 ptr += sizeof(uint64_t);
776 *leftp -= sizeof(uint64_t);
781 const unsigned char *
782 nvpair_unpack_string(bool isbe __unused, nvpair_t *nvp,
783 const unsigned char *ptr, size_t *leftp)
786 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_STRING);
788 if (*leftp < nvp->nvp_datasize || nvp->nvp_datasize == 0) {
793 if (strnlen((const char *)ptr, nvp->nvp_datasize) !=
794 nvp->nvp_datasize - 1) {
799 nvp->nvp_data = (uint64_t)(uintptr_t)nv_strdup((const char *)ptr);
800 if (nvp->nvp_data == 0)
803 ptr += nvp->nvp_datasize;
804 *leftp -= nvp->nvp_datasize;
809 const unsigned char *
810 nvpair_unpack_nvlist(bool isbe __unused, nvpair_t *nvp,
811 const unsigned char *ptr, size_t *leftp, size_t nfds, nvlist_t **child)
815 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NVLIST);
817 if (*leftp < nvp->nvp_datasize || nvp->nvp_datasize == 0) {
822 value = nvlist_create(0);
826 ptr = nvlist_unpack_header(value, ptr, nfds, NULL, leftp);
830 nvp->nvp_data = (uint64_t)(uintptr_t)value;
837 const unsigned char *
838 nvpair_unpack_descriptor(bool isbe, nvpair_t *nvp, const unsigned char *ptr,
839 size_t *leftp, const int *fds, size_t nfds)
843 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_DESCRIPTOR);
845 if (nvp->nvp_datasize != sizeof(idx)) {
849 if (*leftp < sizeof(idx)) {
864 if ((size_t)idx >= nfds) {
869 nvp->nvp_data = (uint64_t)fds[idx];
872 *leftp -= sizeof(idx);
878 const unsigned char *
879 nvpair_unpack_binary(bool isbe __unused, nvpair_t *nvp,
880 const unsigned char *ptr, size_t *leftp)
884 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BINARY);
886 if (*leftp < nvp->nvp_datasize || nvp->nvp_datasize == 0) {
891 value = nv_malloc(nvp->nvp_datasize);
895 memcpy(value, ptr, nvp->nvp_datasize);
896 ptr += nvp->nvp_datasize;
897 *leftp -= nvp->nvp_datasize;
899 nvp->nvp_data = (uint64_t)(uintptr_t)value;
904 const unsigned char *
905 nvpair_unpack_bool_array(bool isbe __unused, nvpair_t *nvp,
906 const unsigned char *ptr, size_t *leftp)
912 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BOOL_ARRAY);
914 size = sizeof(*value) * nvp->nvp_nitems;
915 if (nvp->nvp_datasize != size || *leftp < size ||
916 nvp->nvp_nitems == 0 || size < nvp->nvp_nitems) {
921 value = nv_malloc(size);
925 for (i = 0; i < nvp->nvp_nitems; i++) {
926 value[i] = *(const uint8_t *)ptr;
928 ptr += sizeof(*value);
929 *leftp -= sizeof(*value);
932 nvp->nvp_data = (uint64_t)(uintptr_t)value;
937 const unsigned char *
938 nvpair_unpack_number_array(bool isbe, nvpair_t *nvp, const unsigned char *ptr,
945 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NUMBER_ARRAY);
947 size = sizeof(*value) * nvp->nvp_nitems;
948 if (nvp->nvp_datasize != size || *leftp < size ||
949 nvp->nvp_nitems == 0 || size < nvp->nvp_nitems) {
954 value = nv_malloc(size);
958 for (i = 0; i < nvp->nvp_nitems; i++) {
960 value[i] = be64dec(ptr);
962 value[i] = le64dec(ptr);
964 ptr += sizeof(*value);
965 *leftp -= sizeof(*value);
968 nvp->nvp_data = (uint64_t)(uintptr_t)value;
973 const unsigned char *
974 nvpair_unpack_string_array(bool isbe __unused, nvpair_t *nvp,
975 const unsigned char *ptr, size_t *leftp)
983 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_STRING_ARRAY);
985 if (*leftp < nvp->nvp_datasize || nvp->nvp_datasize == 0 ||
986 nvp->nvp_nitems == 0) {
991 size = nvp->nvp_datasize;
992 tmp = (const char *)ptr;
993 for (ii = 0; ii < nvp->nvp_nitems; ii++) {
994 len = strnlen(tmp, size - 1) + 1;
1007 value = nv_malloc(sizeof(*value) * nvp->nvp_nitems);
1011 for (ii = 0; ii < nvp->nvp_nitems; ii++) {
1012 value[ii] = nv_strdup((const char *)ptr);
1013 if (value[ii] == NULL)
1015 len = strlen(value[ii]) + 1;
1019 nvp->nvp_data = (uint64_t)(uintptr_t)value;
1023 for (j = 0; j < ii; j++)
1030 const unsigned char *
1031 nvpair_unpack_descriptor_array(bool isbe, nvpair_t *nvp,
1032 const unsigned char *ptr, size_t *leftp, const int *fds, size_t nfds)
1039 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_DESCRIPTOR_ARRAY);
1041 size = sizeof(idx) * nvp->nvp_nitems;
1042 if (nvp->nvp_datasize != size || *leftp < size ||
1043 nvp->nvp_nitems == 0 || size < nvp->nvp_nitems) {
1048 array = (int *)nv_malloc(size);
1052 for (ii = 0; ii < nvp->nvp_nitems; ii++) {
1064 if ((size_t)idx >= nfds) {
1070 array[ii] = (uint64_t)fds[idx];
1073 *leftp -= sizeof(idx);
1076 nvp->nvp_data = (uint64_t)(uintptr_t)array;
1082 const unsigned char *
1083 nvpair_unpack_nvlist_array(bool isbe __unused, nvpair_t *nvp,
1084 const unsigned char *ptr, size_t *leftp, nvlist_t **firstel)
1091 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NVLIST_ARRAY);
1093 sizeup = sizeof(struct nvpair_header) * nvp->nvp_nitems;
1094 if (nvp->nvp_nitems == 0 || sizeup < nvp->nvp_nitems ||
1100 value = nv_malloc(nvp->nvp_nitems * sizeof(*value));
1104 for (ii = 0; ii < nvp->nvp_nitems; ii++) {
1105 value[ii] = nvlist_create(0);
1106 if (value[ii] == NULL)
1109 tmpnvp = nvpair_allocv(" ", NV_TYPE_NVLIST,
1110 (uint64_t)(uintptr_t)value[ii], 0, 0);
1113 nvlist_set_array_next(value[ii - 1], tmpnvp);
1116 nvlist_set_flags(value[nvp->nvp_nitems - 1], NV_FLAG_IN_ARRAY);
1118 nvp->nvp_data = (uint64_t)(uintptr_t)value;
1119 *firstel = value[0];
1124 for (j = 0; j <= ii; j++)
1125 nvlist_destroy(value[j]);
1132 const unsigned char *
1133 nvpair_unpack(bool isbe, const unsigned char *ptr, size_t *leftp,
1136 nvpair_t *nvp, *tmp;
1138 nvp = nv_calloc(1, sizeof(*nvp) + NV_NAME_MAX);
1141 nvp->nvp_name = (char *)(nvp + 1);
1143 ptr = nvpair_unpack_header(isbe, nvp, ptr, leftp);
1146 tmp = nv_realloc(nvp, sizeof(*nvp) + strlen(nvp->nvp_name) + 1);
1151 /* Update nvp_name after realloc(). */
1152 nvp->nvp_name = (char *)(nvp + 1);
1153 nvp->nvp_data = 0x00;
1154 nvp->nvp_magic = NVPAIR_MAGIC;
1163 nvpair_type(const nvpair_t *nvp)
1168 return (nvp->nvp_type);
1172 nvpair_name(const nvpair_t *nvp)
1177 return (nvp->nvp_name);
1181 nvpair_create_stringf(const char *name, const char *valuefmt, ...)
1186 va_start(valueap, valuefmt);
1187 nvp = nvpair_create_stringv(name, valuefmt, valueap);
1194 nvpair_create_stringv(const char *name, const char *valuefmt, va_list valueap)
1200 len = nv_vasprintf(&str, valuefmt, valueap);
1203 nvp = nvpair_create_string(name, str);
1209 nvpair_create_null(const char *name)
1212 return (nvpair_allocv(name, NV_TYPE_NULL, 0, 0, 0));
1216 nvpair_create_bool(const char *name, bool value)
1219 return (nvpair_allocv(name, NV_TYPE_BOOL, value ? 1 : 0,
1220 sizeof(uint8_t), 0));
1224 nvpair_create_number(const char *name, uint64_t value)
1227 return (nvpair_allocv(name, NV_TYPE_NUMBER, value, sizeof(value), 0));
1231 nvpair_create_string(const char *name, const char *value)
1237 if (value == NULL) {
1242 data = nv_strdup(value);
1245 size = strlen(value) + 1;
1247 nvp = nvpair_allocv(name, NV_TYPE_STRING, (uint64_t)(uintptr_t)data,
1256 nvpair_create_nvlist(const char *name, const nvlist_t *value)
1261 if (value == NULL) {
1266 nvl = nvlist_clone(value);
1270 nvp = nvpair_allocv(name, NV_TYPE_NVLIST, (uint64_t)(uintptr_t)nvl, 0,
1273 nvlist_destroy(nvl);
1275 nvlist_set_parent(nvl, nvp);
1282 nvpair_create_descriptor(const char *name, int value)
1286 value = fcntl(value, F_DUPFD_CLOEXEC, 0);
1290 nvp = nvpair_allocv(name, NV_TYPE_DESCRIPTOR, (uint64_t)value,
1291 sizeof(int64_t), 0);
1303 nvpair_create_binary(const char *name, const void *value, size_t size)
1308 if (value == NULL || size == 0) {
1313 data = nv_malloc(size);
1316 memcpy(data, value, size);
1318 nvp = nvpair_allocv(name, NV_TYPE_BINARY, (uint64_t)(uintptr_t)data,
1327 nvpair_create_bool_array(const char *name, const bool *value, size_t nitems)
1333 if (value == NULL || nitems == 0) {
1338 size = sizeof(value[0]) * nitems;
1339 data = nv_malloc(size);
1343 memcpy(data, value, size);
1344 nvp = nvpair_allocv(name, NV_TYPE_BOOL_ARRAY, (uint64_t)(uintptr_t)data,
1356 nvpair_create_number_array(const char *name, const uint64_t *value,
1363 if (value == NULL || nitems == 0) {
1368 size = sizeof(value[0]) * nitems;
1369 data = nv_malloc(size);
1373 memcpy(data, value, size);
1374 nvp = nvpair_allocv(name, NV_TYPE_NUMBER_ARRAY,
1375 (uint64_t)(uintptr_t)data, size, nitems);
1386 nvpair_create_string_array(const char *name, const char * const *value,
1391 size_t datasize, size;
1394 if (value == NULL || nitems == 0) {
1401 data = nv_malloc(sizeof(value[0]) * nitems);
1405 for (ii = 0; ii < nitems; ii++) {
1406 if (value[ii] == NULL) {
1411 size = strlen(value[ii]) + 1;
1413 data[ii] = nv_strdup(value[ii]);
1414 if (data[ii] == NULL)
1417 nvp = nvpair_allocv(name, NV_TYPE_STRING_ARRAY,
1418 (uint64_t)(uintptr_t)data, datasize, nitems);
1423 for (; ii > 0; ii--)
1424 nv_free(data[ii - 1]);
1433 nvpair_create_nvlist_array(const char *name, const nvlist_t * const *value,
1443 if (value == NULL || nitems == 0) {
1448 nvls = nv_malloc(sizeof(value[0]) * nitems);
1452 for (ii = 0; ii < nitems; ii++) {
1453 if (value[ii] == NULL) {
1458 nvls[ii] = nvlist_clone(value[ii]);
1459 if (nvls[ii] == NULL)
1465 nvp = nvpair_allocv(" ", NV_TYPE_NVLIST,
1466 (uint64_t)(uintptr_t)nvls[ii], 0, 0);
1469 nvlist_destroy(nvls[ii]);
1473 nvlist_set_array_next(nvls[ii - 1], nvp);
1476 flags = nvlist_flags(nvls[nitems - 1]) | NV_FLAG_IN_ARRAY;
1477 nvlist_set_flags(nvls[nitems - 1], flags);
1479 parent = nvpair_allocv(name, NV_TYPE_NVLIST_ARRAY,
1480 (uint64_t)(uintptr_t)nvls, 0, nitems);
1484 for (ii = 0; ii < nitems; ii++)
1485 nvlist_set_parent(nvls[ii], parent);
1491 for (; ii > 0; ii--)
1492 nvlist_destroy(nvls[ii - 1]);
1501 nvpair_create_descriptor_array(const char *name, const int *value,
1508 if (value == NULL) {
1515 fds = nv_malloc(sizeof(value[0]) * nitems);
1518 for (ii = 0; ii < nitems; ii++) {
1519 if (value[ii] == -1) {
1522 fds[ii] = fcntl(value[ii], F_DUPFD_CLOEXEC, 0);
1528 nvp = nvpair_allocv(name, NV_TYPE_DESCRIPTOR_ARRAY,
1529 (uint64_t)(uintptr_t)fds, sizeof(int64_t) * nitems, nitems);
1534 for (; ii > 0; ii--) {
1535 if (fds[ii - 1] != -1)
1547 nvpair_move_string(const char *name, char *value)
1551 if (value == NULL) {
1556 nvp = nvpair_allocv(name, NV_TYPE_STRING, (uint64_t)(uintptr_t)value,
1557 strlen(value) + 1, 0);
1568 nvpair_move_nvlist(const char *name, nvlist_t *value)
1572 if (value == NULL || nvlist_get_nvpair_parent(value) != NULL) {
1577 if (nvlist_error(value) != 0) {
1578 ERRNO_SET(nvlist_error(value));
1579 nvlist_destroy(value);
1583 nvp = nvpair_allocv(name, NV_TYPE_NVLIST, (uint64_t)(uintptr_t)value,
1586 nvlist_destroy(value);
1588 nvlist_set_parent(value, nvp);
1595 nvpair_move_descriptor(const char *name, int value)
1599 if (value < 0 || !fd_is_valid(value)) {
1604 nvp = nvpair_allocv(name, NV_TYPE_DESCRIPTOR, (uint64_t)value,
1605 sizeof(int64_t), 0);
1617 nvpair_move_binary(const char *name, void *value, size_t size)
1621 if (value == NULL || size == 0) {
1626 nvp = nvpair_allocv(name, NV_TYPE_BINARY, (uint64_t)(uintptr_t)value,
1638 nvpair_move_bool_array(const char *name, bool *value, size_t nitems)
1642 if (value == NULL || nitems == 0) {
1647 nvp = nvpair_allocv(name, NV_TYPE_BOOL_ARRAY,
1648 (uint64_t)(uintptr_t)value, sizeof(value[0]) * nitems, nitems);
1659 nvpair_move_string_array(const char *name, char **value, size_t nitems)
1664 if (value == NULL || nitems == 0) {
1670 for (i = 0; i < nitems; i++) {
1671 if (value[i] == NULL) {
1676 size += strlen(value[i]) + 1;
1679 nvp = nvpair_allocv(name, NV_TYPE_STRING_ARRAY,
1680 (uint64_t)(uintptr_t)value, size, nitems);
1683 for (i = 0; i < nitems; i++)
1693 nvpair_move_number_array(const char *name, uint64_t *value, size_t nitems)
1697 if (value == NULL || nitems == 0) {
1702 nvp = nvpair_allocv(name, NV_TYPE_NUMBER_ARRAY,
1703 (uint64_t)(uintptr_t)value, sizeof(value[0]) * nitems, nitems);
1714 nvpair_move_nvlist_array(const char *name, nvlist_t **value, size_t nitems)
1720 if (value == NULL || nitems == 0) {
1725 for (ii = 0; ii < nitems; ii++) {
1726 if (value == NULL || nvlist_error(value[ii]) != 0 ||
1727 nvlist_get_pararr(value[ii], NULL) != NULL) {
1734 nvp = nvpair_allocv(" ", NV_TYPE_NVLIST,
1735 (uint64_t)(uintptr_t)value[ii], 0, 0);
1738 nvlist_set_array_next(value[ii - 1], nvp);
1741 flags = nvlist_flags(value[nitems - 1]) | NV_FLAG_IN_ARRAY;
1742 nvlist_set_flags(value[nitems - 1], flags);
1744 parent = nvpair_allocv(name, NV_TYPE_NVLIST_ARRAY,
1745 (uint64_t)(uintptr_t)value, 0, nitems);
1749 for (ii = 0; ii < nitems; ii++)
1750 nvlist_set_parent(value[ii], parent);
1755 for (ii = 0; ii < nitems; ii++) {
1756 if (value[ii] != NULL &&
1757 nvlist_get_pararr(value[ii], NULL) != NULL) {
1758 nvlist_destroy(value[ii]);
1769 nvpair_move_descriptor_array(const char *name, int *value, size_t nitems)
1774 if (value == NULL || nitems == 0) {
1779 for (i = 0; i < nitems; i++) {
1780 if (value[i] != -1 && !fd_is_valid(value[i])) {
1786 nvp = nvpair_allocv(name, NV_TYPE_DESCRIPTOR_ARRAY,
1787 (uint64_t)(uintptr_t)value, sizeof(value[0]) * nitems, nitems);
1794 for (i = 0; i < nitems; i++) {
1795 if (fd_is_valid(value[i]))
1806 nvpair_get_bool(const nvpair_t *nvp)
1811 return (nvp->nvp_data == 1);
1815 nvpair_get_number(const nvpair_t *nvp)
1820 return (nvp->nvp_data);
1824 nvpair_get_string(const nvpair_t *nvp)
1828 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_STRING);
1830 return ((const char *)(intptr_t)nvp->nvp_data);
1834 nvpair_get_nvlist(const nvpair_t *nvp)
1838 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NVLIST);
1840 return ((const nvlist_t *)(intptr_t)nvp->nvp_data);
1845 nvpair_get_descriptor(const nvpair_t *nvp)
1849 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_DESCRIPTOR);
1851 return ((int)nvp->nvp_data);
1856 nvpair_get_binary(const nvpair_t *nvp, size_t *sizep)
1860 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BINARY);
1863 *sizep = nvp->nvp_datasize;
1865 return ((const void *)(intptr_t)nvp->nvp_data);
1869 nvpair_get_bool_array(const nvpair_t *nvp, size_t *nitems)
1873 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BOOL_ARRAY);
1876 *nitems = nvp->nvp_nitems;
1878 return ((const bool *)(intptr_t)nvp->nvp_data);
1882 nvpair_get_number_array(const nvpair_t *nvp, size_t *nitems)
1886 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NUMBER_ARRAY);
1889 *nitems = nvp->nvp_nitems;
1891 return ((const uint64_t *)(intptr_t)nvp->nvp_data);
1894 const char * const *
1895 nvpair_get_string_array(const nvpair_t *nvp, size_t *nitems)
1899 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_STRING_ARRAY);
1902 *nitems = nvp->nvp_nitems;
1904 return ((const char * const *)(intptr_t)nvp->nvp_data);
1907 const nvlist_t * const *
1908 nvpair_get_nvlist_array(const nvpair_t *nvp, size_t *nitems)
1912 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NVLIST_ARRAY);
1915 *nitems = nvp->nvp_nitems;
1917 return ((const nvlist_t * const *)((intptr_t)nvp->nvp_data));
1922 nvpair_get_descriptor_array(const nvpair_t *nvp, size_t *nitems)
1926 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_DESCRIPTOR_ARRAY);
1929 *nitems = nvp->nvp_nitems;
1931 return ((const int *)(intptr_t)nvp->nvp_data);
1936 nvpair_append_bool_array(nvpair_t *nvp, const bool value)
1940 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_BOOL_ARRAY);
1941 return (nvpair_append(nvp, &value, sizeof(value), sizeof(value)));
1945 nvpair_append_number_array(nvpair_t *nvp, const uint64_t value)
1949 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NUMBER_ARRAY);
1950 return (nvpair_append(nvp, &value, sizeof(value), sizeof(value)));
1954 nvpair_append_string_array(nvpair_t *nvp, const char *value)
1959 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_STRING_ARRAY);
1960 if (value == NULL) {
1964 str = nv_strdup(value);
1968 if (nvpair_append(nvp, &str, sizeof(str), strlen(str) + 1) == -1) {
1976 nvpair_append_nvlist_array(nvpair_t *nvp, const nvlist_t *value)
1979 nvlist_t *nvl, *prev;
1983 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_NVLIST_ARRAY);
1984 if (value == NULL || nvlist_error(value) != 0 ||
1985 nvlist_get_pararr(value, NULL) != NULL) {
1989 nvl = nvlist_clone(value);
1993 flags = nvlist_flags(nvl) | NV_FLAG_IN_ARRAY;
1994 nvlist_set_flags(nvl, flags);
1998 if (nvp->nvp_nitems > 0) {
1999 nvlist_t **nvls = (void *)(uintptr_t)nvp->nvp_data;
2001 prev = nvls[nvp->nvp_nitems - 1];
2002 PJDLOG_ASSERT(prev != NULL);
2004 tmpnvp = nvpair_allocv(" ", NV_TYPE_NVLIST,
2005 (uint64_t)(uintptr_t)nvl, 0, 0);
2006 if (tmpnvp == NULL) {
2010 if (nvpair_append(nvp, &nvl, sizeof(nvl), 0) == -1) {
2014 NVPAIR_ASSERT(tmpnvp);
2015 nvlist_set_array_next(prev, tmpnvp);
2017 nvlist_set_parent(nvl, nvp);
2021 nvpair_free(tmpnvp);
2023 nvlist_destroy(nvl);
2029 nvpair_append_descriptor_array(nvpair_t *nvp, const int value)
2034 PJDLOG_ASSERT(nvp->nvp_type == NV_TYPE_DESCRIPTOR_ARRAY);
2035 fd = fcntl(value, F_DUPFD_CLOEXEC, 0);
2039 if (nvpair_append(nvp, &fd, sizeof(fd), sizeof(fd)) == -1) {
2048 nvpair_free(nvpair_t *nvp)
2053 PJDLOG_ASSERT(nvp->nvp_list == NULL);
2056 switch (nvp->nvp_type) {
2058 case NV_TYPE_DESCRIPTOR:
2059 close((int)nvp->nvp_data);
2061 case NV_TYPE_DESCRIPTOR_ARRAY:
2062 for (i = 0; i < nvp->nvp_nitems; i++)
2063 close(((int *)(intptr_t)nvp->nvp_data)[i]);
2066 case NV_TYPE_NVLIST:
2067 nvlist_destroy((nvlist_t *)(intptr_t)nvp->nvp_data);
2069 case NV_TYPE_STRING:
2070 nv_free((char *)(intptr_t)nvp->nvp_data);
2072 case NV_TYPE_BINARY:
2073 nv_free((void *)(intptr_t)nvp->nvp_data);
2075 case NV_TYPE_NVLIST_ARRAY:
2076 for (i = 0; i < nvp->nvp_nitems; i++) {
2078 ((nvlist_t **)(intptr_t)nvp->nvp_data)[i]);
2080 nv_free(((nvlist_t **)(intptr_t)nvp->nvp_data));
2082 case NV_TYPE_NUMBER_ARRAY:
2083 nv_free((uint64_t *)(intptr_t)nvp->nvp_data);
2085 case NV_TYPE_BOOL_ARRAY:
2086 nv_free((bool *)(intptr_t)nvp->nvp_data);
2088 case NV_TYPE_STRING_ARRAY:
2089 for (i = 0; i < nvp->nvp_nitems; i++)
2090 nv_free(((char **)(intptr_t)nvp->nvp_data)[i]);
2091 nv_free((char **)(intptr_t)nvp->nvp_data);
2098 nvpair_free_structure(nvpair_t *nvp)
2102 PJDLOG_ASSERT(nvp->nvp_list == NULL);
2109 nvpair_type_string(int type)
2117 case NV_TYPE_NUMBER:
2119 case NV_TYPE_STRING:
2121 case NV_TYPE_NVLIST:
2123 case NV_TYPE_DESCRIPTOR:
2124 return ("DESCRIPTOR");
2125 case NV_TYPE_BINARY:
2127 case NV_TYPE_BOOL_ARRAY:
2128 return ("BOOL ARRAY");
2129 case NV_TYPE_NUMBER_ARRAY:
2130 return ("NUMBER ARRAY");
2131 case NV_TYPE_STRING_ARRAY:
2132 return ("STRING ARRAY");
2133 case NV_TYPE_NVLIST_ARRAY:
2134 return ("NVLIST ARRAY");
2135 case NV_TYPE_DESCRIPTOR_ARRAY:
2136 return ("DESCRIPTOR ARRAY");
2138 return ("<UNKNOWN>");