4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
22 * Copyright (c) 2000, 2010, Oracle and/or its affiliates. All rights reserved.
28 #include <sys/types.h>
29 #include <sys/inttypes.h>
32 #include "libnvpair.h"
35 * libnvpair - A tools library for manipulating <name, value> pairs.
37 * This library provides routines packing an unpacking nv pairs
38 * for transporting data across process boundaries, transporting
39 * between kernel and userland, and possibly saving onto disk files.
43 * Print control structure.
46 #define DEFINEOP(opname, vtype) \
48 int (*op)(struct nvlist_prtctl *, void *, nvlist_t *, \
49 const char *, vtype); \
53 #define DEFINEARROP(opname, vtype) \
55 int (*op)(struct nvlist_prtctl *, void *, nvlist_t *, \
56 const char *, vtype, uint_t); \
60 struct nvlist_printops {
61 DEFINEOP(print_boolean, int);
62 DEFINEOP(print_boolean_value, boolean_t);
63 DEFINEOP(print_byte, uchar_t);
64 DEFINEOP(print_int8, int8_t);
65 DEFINEOP(print_uint8, uint8_t);
66 DEFINEOP(print_int16, int16_t);
67 DEFINEOP(print_uint16, uint16_t);
68 DEFINEOP(print_int32, int32_t);
69 DEFINEOP(print_uint32, uint32_t);
70 DEFINEOP(print_int64, int64_t);
71 DEFINEOP(print_uint64, uint64_t);
72 DEFINEOP(print_double, double);
73 DEFINEOP(print_string, char *);
74 DEFINEOP(print_hrtime, hrtime_t);
75 DEFINEOP(print_nvlist, nvlist_t *);
76 DEFINEARROP(print_boolean_array, boolean_t *);
77 DEFINEARROP(print_byte_array, uchar_t *);
78 DEFINEARROP(print_int8_array, int8_t *);
79 DEFINEARROP(print_uint8_array, uint8_t *);
80 DEFINEARROP(print_int16_array, int16_t *);
81 DEFINEARROP(print_uint16_array, uint16_t *);
82 DEFINEARROP(print_int32_array, int32_t *);
83 DEFINEARROP(print_uint32_array, uint32_t *);
84 DEFINEARROP(print_int64_array, int64_t *);
85 DEFINEARROP(print_uint64_array, uint64_t *);
86 DEFINEARROP(print_string_array, char **);
87 DEFINEARROP(print_nvlist_array, nvlist_t **);
90 struct nvlist_prtctl {
91 FILE *nvprt_fp; /* output destination */
92 enum nvlist_indent_mode nvprt_indent_mode; /* see above */
93 int nvprt_indent; /* absolute indent, or tab depth */
94 int nvprt_indentinc; /* indent or tab increment */
95 const char *nvprt_nmfmt; /* member name format, max one %s */
96 const char *nvprt_eomfmt; /* after member format, e.g. "\n" */
97 const char *nvprt_btwnarrfmt; /* between array members */
98 int nvprt_btwnarrfmt_nl; /* nvprt_eoamfmt includes newline? */
99 struct nvlist_printops *nvprt_dfltops;
100 struct nvlist_printops *nvprt_custops;
103 #define DFLTPRTOP(pctl, type) \
104 ((pctl)->nvprt_dfltops->print_##type.op)
106 #define DFLTPRTOPARG(pctl, type) \
107 ((pctl)->nvprt_dfltops->print_##type.arg)
109 #define CUSTPRTOP(pctl, type) \
110 ((pctl)->nvprt_custops->print_##type.op)
112 #define CUSTPRTOPARG(pctl, type) \
113 ((pctl)->nvprt_custops->print_##type.arg)
115 #define RENDER(pctl, type, nvl, name, val) \
118 if ((pctl)->nvprt_custops && CUSTPRTOP(pctl, type)) { \
119 done = CUSTPRTOP(pctl, type)(pctl, \
120 CUSTPRTOPARG(pctl, type), nvl, name, val); \
123 (void) DFLTPRTOP(pctl, type)(pctl, \
124 DFLTPRTOPARG(pctl, type), nvl, name, val); \
126 (void) fprintf(pctl->nvprt_fp, pctl->nvprt_eomfmt); \
129 #define ARENDER(pctl, type, nvl, name, arrp, count) \
132 if ((pctl)->nvprt_custops && CUSTPRTOP(pctl, type)) { \
133 done = CUSTPRTOP(pctl, type)(pctl, \
134 CUSTPRTOPARG(pctl, type), nvl, name, arrp, count); \
137 (void) DFLTPRTOP(pctl, type)(pctl, \
138 DFLTPRTOPARG(pctl, type), nvl, name, arrp, count); \
140 (void) fprintf(pctl->nvprt_fp, pctl->nvprt_eomfmt); \
143 static void nvlist_print_with_indent(nvlist_t *, nvlist_prtctl_t);
146 * ======================================================================
150 * ======================================================================
154 indent(nvlist_prtctl_t pctl, int onemore)
158 switch (pctl->nvprt_indent_mode) {
159 case NVLIST_INDENT_ABS:
160 (void) fprintf(pctl->nvprt_fp, "%*s",
161 pctl->nvprt_indent + onemore * pctl->nvprt_indentinc, "");
164 case NVLIST_INDENT_TABBED:
165 depth = pctl->nvprt_indent + onemore;
167 (void) fprintf(pctl->nvprt_fp, "\t");
172 * ======================================================================
174 * | Default nvlist member rendering functions. |
176 * ======================================================================
180 * Generate functions to print single-valued nvlist members.
182 * type_and_variant - suffix to form function name
183 * vtype - C type for the member value
184 * ptype - C type to cast value to for printing
185 * vfmt - format string for pair value, e.g "%d" or "0x%llx"
188 #define NVLIST_PRTFUNC(type_and_variant, vtype, ptype, vfmt) \
190 nvprint_##type_and_variant(nvlist_prtctl_t pctl, void *private, \
191 nvlist_t *nvl, const char *name, vtype value) \
193 FILE *fp = pctl->nvprt_fp; \
194 NOTE(ARGUNUSED(private)) \
195 NOTE(ARGUNUSED(nvl)) \
197 (void) fprintf(fp, pctl->nvprt_nmfmt, name); \
198 (void) fprintf(fp, vfmt, (ptype)value); \
202 NVLIST_PRTFUNC(boolean, int, int, "%d")
203 NVLIST_PRTFUNC(boolean_value, boolean_t, int, "%d")
204 NVLIST_PRTFUNC(byte, uchar_t, uchar_t, "0x%2.2x")
205 NVLIST_PRTFUNC(int8, int8_t, int, "%d")
206 NVLIST_PRTFUNC(uint8, uint8_t, uint8_t, "0x%x")
207 NVLIST_PRTFUNC(int16, int16_t, int16_t, "%d")
208 NVLIST_PRTFUNC(uint16, uint16_t, uint16_t, "0x%x")
209 NVLIST_PRTFUNC(int32, int32_t, int32_t, "%d")
210 NVLIST_PRTFUNC(uint32, uint32_t, uint32_t, "0x%x")
211 NVLIST_PRTFUNC(int64, int64_t, longlong_t, "%lld")
212 NVLIST_PRTFUNC(uint64, uint64_t, u_longlong_t, "0x%llx")
213 NVLIST_PRTFUNC(double, double, double, "0x%f")
214 NVLIST_PRTFUNC(string, char *, char *, "%s")
215 NVLIST_PRTFUNC(hrtime, hrtime_t, hrtime_t, "0x%llx")
218 * Generate functions to print array-valued nvlist members.
221 #define NVLIST_ARRPRTFUNC(type_and_variant, vtype, ptype, vfmt) \
223 nvaprint_##type_and_variant(nvlist_prtctl_t pctl, void *private, \
224 nvlist_t *nvl, const char *name, vtype *valuep, uint_t count) \
226 FILE *fp = pctl->nvprt_fp; \
228 NOTE(ARGUNUSED(private)) \
229 NOTE(ARGUNUSED(nvl)) \
230 for (i = 0; i < count; i++) { \
231 if (i == 0 || pctl->nvprt_btwnarrfmt_nl) { \
233 (void) fprintf(fp, pctl->nvprt_nmfmt, name); \
234 if (pctl->nvprt_btwnarrfmt_nl) \
235 (void) fprintf(fp, "[%d]: ", i); \
238 (void) fprintf(fp, pctl->nvprt_btwnarrfmt); \
239 (void) fprintf(fp, vfmt, (ptype)valuep[i]); \
244 NVLIST_ARRPRTFUNC(boolean_array, boolean_t, boolean_t, "%d")
245 NVLIST_ARRPRTFUNC(byte_array, uchar_t, uchar_t, "0x%2.2x")
246 NVLIST_ARRPRTFUNC(int8_array, int8_t, int8_t, "%d")
247 NVLIST_ARRPRTFUNC(uint8_array, uint8_t, uint8_t, "0x%x")
248 NVLIST_ARRPRTFUNC(int16_array, int16_t, int16_t, "%d")
249 NVLIST_ARRPRTFUNC(uint16_array, uint16_t, uint16_t, "0x%x")
250 NVLIST_ARRPRTFUNC(int32_array, int32_t, int32_t, "%d")
251 NVLIST_ARRPRTFUNC(uint32_array, uint32_t, uint32_t, "0x%x")
252 NVLIST_ARRPRTFUNC(int64_array, int64_t, longlong_t, "%lld")
253 NVLIST_ARRPRTFUNC(uint64_array, uint64_t, u_longlong_t, "0x%llx")
254 NVLIST_ARRPRTFUNC(string_array, char *, char *, "%s")
258 nvprint_nvlist(nvlist_prtctl_t pctl, void *private,
259 nvlist_t *nvl, const char *name, nvlist_t *value)
261 FILE *fp = pctl->nvprt_fp;
264 (void) fprintf(fp, "%s = (embedded nvlist)\n", name);
266 pctl->nvprt_indent += pctl->nvprt_indentinc;
267 nvlist_print_with_indent(value, pctl);
268 pctl->nvprt_indent -= pctl->nvprt_indentinc;
271 (void) fprintf(fp, "(end %s)\n", name);
278 nvaprint_nvlist_array(nvlist_prtctl_t pctl, void *private,
279 nvlist_t *nvl, const char *name, nvlist_t **valuep, uint_t count)
281 FILE *fp = pctl->nvprt_fp;
285 (void) fprintf(fp, "%s = (array of embedded nvlists)\n", name);
287 for (i = 0; i < count; i++) {
289 (void) fprintf(fp, "(start %s[%d])\n", name, i);
291 pctl->nvprt_indent += pctl->nvprt_indentinc;
292 nvlist_print_with_indent(valuep[i], pctl);
293 pctl->nvprt_indent -= pctl->nvprt_indentinc;
296 (void) fprintf(fp, "(end %s[%d])\n", name, i);
303 * ======================================================================
305 * | Interfaces that allow control over formatting. |
307 * ======================================================================
311 nvlist_prtctl_setdest(nvlist_prtctl_t pctl, FILE *fp)
317 nvlist_prtctl_getdest(nvlist_prtctl_t pctl)
319 return (pctl->nvprt_fp);
324 nvlist_prtctl_setindent(nvlist_prtctl_t pctl, enum nvlist_indent_mode mode,
327 if (mode < NVLIST_INDENT_ABS || mode > NVLIST_INDENT_TABBED)
328 mode = NVLIST_INDENT_TABBED;
336 pctl->nvprt_indent_mode = mode;
337 pctl->nvprt_indent = start;
338 pctl->nvprt_indentinc = inc;
342 nvlist_prtctl_doindent(nvlist_prtctl_t pctl, int onemore)
344 indent(pctl, onemore);
349 nvlist_prtctl_setfmt(nvlist_prtctl_t pctl, enum nvlist_prtctl_fmt which,
353 case NVLIST_FMT_MEMBER_NAME:
356 pctl->nvprt_nmfmt = fmt;
359 case NVLIST_FMT_MEMBER_POSTAMBLE:
362 pctl->nvprt_eomfmt = fmt;
365 case NVLIST_FMT_BTWN_ARRAY:
367 pctl->nvprt_btwnarrfmt = " ";
368 pctl->nvprt_btwnarrfmt_nl = 0;
370 pctl->nvprt_btwnarrfmt = fmt;
371 pctl->nvprt_btwnarrfmt_nl = (strstr(fmt, "\n") != NULL);
382 nvlist_prtctl_dofmt(nvlist_prtctl_t pctl, enum nvlist_prtctl_fmt which, ...)
384 FILE *fp = pctl->nvprt_fp;
391 case NVLIST_FMT_MEMBER_NAME:
392 name = va_arg(ap, char *);
393 (void) fprintf(fp, pctl->nvprt_nmfmt, name);
396 case NVLIST_FMT_MEMBER_POSTAMBLE:
397 (void) fprintf(fp, pctl->nvprt_eomfmt);
400 case NVLIST_FMT_BTWN_ARRAY:
401 (void) fprintf(fp, pctl->nvprt_btwnarrfmt); \
412 * ======================================================================
414 * | Interfaces to allow appointment of replacement rendering functions.|
416 * ======================================================================
419 #define NVLIST_PRINTCTL_REPLACE(type, vtype) \
421 nvlist_prtctlop_##type(nvlist_prtctl_t pctl, \
422 int (*func)(nvlist_prtctl_t, void *, nvlist_t *, const char *, vtype), \
425 CUSTPRTOP(pctl, type) = func; \
426 CUSTPRTOPARG(pctl, type) = private; \
429 NVLIST_PRINTCTL_REPLACE(boolean, int)
430 NVLIST_PRINTCTL_REPLACE(boolean_value, boolean_t)
431 NVLIST_PRINTCTL_REPLACE(byte, uchar_t)
432 NVLIST_PRINTCTL_REPLACE(int8, int8_t)
433 NVLIST_PRINTCTL_REPLACE(uint8, uint8_t)
434 NVLIST_PRINTCTL_REPLACE(int16, int16_t)
435 NVLIST_PRINTCTL_REPLACE(uint16, uint16_t)
436 NVLIST_PRINTCTL_REPLACE(int32, int32_t)
437 NVLIST_PRINTCTL_REPLACE(uint32, uint32_t)
438 NVLIST_PRINTCTL_REPLACE(int64, int64_t)
439 NVLIST_PRINTCTL_REPLACE(uint64, uint64_t)
440 NVLIST_PRINTCTL_REPLACE(double, double)
441 NVLIST_PRINTCTL_REPLACE(string, char *)
442 NVLIST_PRINTCTL_REPLACE(hrtime, hrtime_t)
443 NVLIST_PRINTCTL_REPLACE(nvlist, nvlist_t *)
445 #define NVLIST_PRINTCTL_AREPLACE(type, vtype) \
447 nvlist_prtctlop_##type(nvlist_prtctl_t pctl, \
448 int (*func)(nvlist_prtctl_t, void *, nvlist_t *, const char *, vtype, \
449 uint_t), void *private) \
451 CUSTPRTOP(pctl, type) = func; \
452 CUSTPRTOPARG(pctl, type) = private; \
455 NVLIST_PRINTCTL_AREPLACE(boolean_array, boolean_t *)
456 NVLIST_PRINTCTL_AREPLACE(byte_array, uchar_t *)
457 NVLIST_PRINTCTL_AREPLACE(int8_array, int8_t *)
458 NVLIST_PRINTCTL_AREPLACE(uint8_array, uint8_t *)
459 NVLIST_PRINTCTL_AREPLACE(int16_array, int16_t *)
460 NVLIST_PRINTCTL_AREPLACE(uint16_array, uint16_t *)
461 NVLIST_PRINTCTL_AREPLACE(int32_array, int32_t *)
462 NVLIST_PRINTCTL_AREPLACE(uint32_array, uint32_t *)
463 NVLIST_PRINTCTL_AREPLACE(int64_array, int64_t *)
464 NVLIST_PRINTCTL_AREPLACE(uint64_array, uint64_t *)
465 NVLIST_PRINTCTL_AREPLACE(string_array, char **)
466 NVLIST_PRINTCTL_AREPLACE(nvlist_array, nvlist_t **)
469 * ======================================================================
471 * | Interfaces to manage nvlist_prtctl_t cookies. |
473 * ======================================================================
477 static const struct nvlist_printops defprtops = {
478 { nvprint_boolean, NULL },
479 { nvprint_boolean_value, NULL },
480 { nvprint_byte, NULL },
481 { nvprint_int8, NULL },
482 { nvprint_uint8, NULL },
483 { nvprint_int16, NULL },
484 { nvprint_uint16, NULL },
485 { nvprint_int32, NULL },
486 { nvprint_uint32, NULL },
487 { nvprint_int64, NULL },
488 { nvprint_uint64, NULL },
489 { nvprint_double, NULL },
490 { nvprint_string, NULL },
491 { nvprint_hrtime, NULL },
492 { nvprint_nvlist, NULL },
493 { nvaprint_boolean_array, NULL },
494 { nvaprint_byte_array, NULL },
495 { nvaprint_int8_array, NULL },
496 { nvaprint_uint8_array, NULL },
497 { nvaprint_int16_array, NULL },
498 { nvaprint_uint16_array, NULL },
499 { nvaprint_int32_array, NULL },
500 { nvaprint_uint32_array, NULL },
501 { nvaprint_int64_array, NULL },
502 { nvaprint_uint64_array, NULL },
503 { nvaprint_string_array, NULL },
504 { nvaprint_nvlist_array, NULL },
508 prtctl_defaults(FILE *fp, struct nvlist_prtctl *pctl,
509 struct nvlist_printops *ops)
512 pctl->nvprt_indent_mode = NVLIST_INDENT_TABBED;
513 pctl->nvprt_indent = 0;
514 pctl->nvprt_indentinc = 1;
515 pctl->nvprt_nmfmt = "%s = ";
516 pctl->nvprt_eomfmt = "\n";
517 pctl->nvprt_btwnarrfmt = " ";
518 pctl->nvprt_btwnarrfmt_nl = 0;
520 pctl->nvprt_dfltops = (struct nvlist_printops *)&defprtops;
521 pctl->nvprt_custops = ops;
525 nvlist_prtctl_alloc(void)
527 struct nvlist_prtctl *pctl;
528 struct nvlist_printops *ops;
530 if ((pctl = malloc(sizeof (*pctl))) == NULL)
533 if ((ops = calloc(1, sizeof (*ops))) == NULL) {
538 prtctl_defaults(stdout, pctl, ops);
544 nvlist_prtctl_free(nvlist_prtctl_t pctl)
547 free(pctl->nvprt_custops);
553 * ======================================================================
555 * | Top-level print request interfaces. |
557 * ======================================================================
561 * nvlist_print - Prints elements in an event buffer
564 nvlist_print_with_indent(nvlist_t *nvl, nvlist_prtctl_t pctl)
566 FILE *fp = pctl->nvprt_fp;
575 (void) fprintf(fp, "nvlist version: %d\n", NVL_VERSION(nvl));
577 nvp = nvlist_next_nvpair(nvl, NULL);
580 data_type_t type = nvpair_type(nvp);
582 name = nvpair_name(nvp);
586 case DATA_TYPE_BOOLEAN: {
587 RENDER(pctl, boolean, nvl, name, 1);
590 case DATA_TYPE_BOOLEAN_VALUE: {
592 (void) nvpair_value_boolean_value(nvp, &val);
593 RENDER(pctl, boolean_value, nvl, name, val);
596 case DATA_TYPE_BYTE: {
598 (void) nvpair_value_byte(nvp, &val);
599 RENDER(pctl, byte, nvl, name, val);
602 case DATA_TYPE_INT8: {
604 (void) nvpair_value_int8(nvp, &val);
605 RENDER(pctl, int8, nvl, name, val);
608 case DATA_TYPE_UINT8: {
610 (void) nvpair_value_uint8(nvp, &val);
611 RENDER(pctl, uint8, nvl, name, val);
614 case DATA_TYPE_INT16: {
616 (void) nvpair_value_int16(nvp, &val);
617 RENDER(pctl, int16, nvl, name, val);
620 case DATA_TYPE_UINT16: {
622 (void) nvpair_value_uint16(nvp, &val);
623 RENDER(pctl, uint16, nvl, name, val);
626 case DATA_TYPE_INT32: {
628 (void) nvpair_value_int32(nvp, &val);
629 RENDER(pctl, int32, nvl, name, val);
632 case DATA_TYPE_UINT32: {
634 (void) nvpair_value_uint32(nvp, &val);
635 RENDER(pctl, uint32, nvl, name, val);
638 case DATA_TYPE_INT64: {
640 (void) nvpair_value_int64(nvp, &val);
641 RENDER(pctl, int64, nvl, name, val);
644 case DATA_TYPE_UINT64: {
646 (void) nvpair_value_uint64(nvp, &val);
647 RENDER(pctl, uint64, nvl, name, val);
650 case DATA_TYPE_DOUBLE: {
652 (void) nvpair_value_double(nvp, &val);
653 RENDER(pctl, double, nvl, name, val);
656 case DATA_TYPE_STRING: {
658 (void) nvpair_value_string(nvp, &val);
659 RENDER(pctl, string, nvl, name, val);
662 case DATA_TYPE_BOOLEAN_ARRAY: {
664 (void) nvpair_value_boolean_array(nvp, &val, &nelem);
665 ARENDER(pctl, boolean_array, nvl, name, val, nelem);
668 case DATA_TYPE_BYTE_ARRAY: {
670 (void) nvpair_value_byte_array(nvp, &val, &nelem);
671 ARENDER(pctl, byte_array, nvl, name, val, nelem);
674 case DATA_TYPE_INT8_ARRAY: {
676 (void) nvpair_value_int8_array(nvp, &val, &nelem);
677 ARENDER(pctl, int8_array, nvl, name, val, nelem);
680 case DATA_TYPE_UINT8_ARRAY: {
682 (void) nvpair_value_uint8_array(nvp, &val, &nelem);
683 ARENDER(pctl, uint8_array, nvl, name, val, nelem);
686 case DATA_TYPE_INT16_ARRAY: {
688 (void) nvpair_value_int16_array(nvp, &val, &nelem);
689 ARENDER(pctl, int16_array, nvl, name, val, nelem);
692 case DATA_TYPE_UINT16_ARRAY: {
694 (void) nvpair_value_uint16_array(nvp, &val, &nelem);
695 ARENDER(pctl, uint16_array, nvl, name, val, nelem);
698 case DATA_TYPE_INT32_ARRAY: {
700 (void) nvpair_value_int32_array(nvp, &val, &nelem);
701 ARENDER(pctl, int32_array, nvl, name, val, nelem);
704 case DATA_TYPE_UINT32_ARRAY: {
706 (void) nvpair_value_uint32_array(nvp, &val, &nelem);
707 ARENDER(pctl, uint32_array, nvl, name, val, nelem);
710 case DATA_TYPE_INT64_ARRAY: {
712 (void) nvpair_value_int64_array(nvp, &val, &nelem);
713 ARENDER(pctl, int64_array, nvl, name, val, nelem);
716 case DATA_TYPE_UINT64_ARRAY: {
718 (void) nvpair_value_uint64_array(nvp, &val, &nelem);
719 ARENDER(pctl, uint64_array, nvl, name, val, nelem);
722 case DATA_TYPE_STRING_ARRAY: {
724 (void) nvpair_value_string_array(nvp, &val, &nelem);
725 ARENDER(pctl, string_array, nvl, name, val, nelem);
728 case DATA_TYPE_HRTIME: {
730 (void) nvpair_value_hrtime(nvp, &val);
731 RENDER(pctl, hrtime, nvl, name, val);
734 case DATA_TYPE_NVLIST: {
736 (void) nvpair_value_nvlist(nvp, &val);
737 RENDER(pctl, nvlist, nvl, name, val);
740 case DATA_TYPE_NVLIST_ARRAY: {
742 (void) nvpair_value_nvlist_array(nvp, &val, &nelem);
743 ARENDER(pctl, nvlist_array, nvl, name, val, nelem);
747 (void) fprintf(fp, " unknown data type (%d)", type);
750 nvp = nvlist_next_nvpair(nvl, nvp);
755 nvlist_print(FILE *fp, nvlist_t *nvl)
757 struct nvlist_prtctl pc;
759 prtctl_defaults(fp, &pc, NULL);
760 nvlist_print_with_indent(nvl, &pc);
764 nvlist_prt(nvlist_t *nvl, nvlist_prtctl_t pctl)
766 nvlist_print_with_indent(nvl, pctl);
769 #define NVP(elem, type, vtype, ptype, format) { \
772 (void) nvpair_value_##type(elem, &value); \
773 (void) printf("%*s%s: " format "\n", indent, "", \
774 nvpair_name(elem), (ptype)value); \
777 #define NVPA(elem, type, vtype, ptype, format) { \
781 (void) nvpair_value_##type(elem, &value, &count); \
782 for (i = 0; i < count; i++) { \
783 (void) printf("%*s%s[%d]: " format "\n", indent, "", \
784 nvpair_name(elem), i, (ptype)value[i]); \
789 * Similar to nvlist_print() but handles arrays slightly differently.
792 dump_nvlist(nvlist_t *list, int indent)
794 nvpair_t *elem = NULL;
795 boolean_t bool_value;
796 nvlist_t *nvlist_value;
797 nvlist_t **nvlist_array_value;
804 while ((elem = nvlist_next_nvpair(list, elem)) != NULL) {
805 switch (nvpair_type(elem)) {
806 case DATA_TYPE_BOOLEAN_VALUE:
807 (void) nvpair_value_boolean_value(elem, &bool_value);
808 (void) printf("%*s%s: %s\n", indent, "",
809 nvpair_name(elem), bool_value ? "true" : "false");
813 NVP(elem, byte, uchar_t, int, "%u");
817 NVP(elem, int8, int8_t, int, "%d");
820 case DATA_TYPE_UINT8:
821 NVP(elem, uint8, uint8_t, int, "%u");
824 case DATA_TYPE_INT16:
825 NVP(elem, int16, int16_t, int, "%d");
828 case DATA_TYPE_UINT16:
829 NVP(elem, uint16, uint16_t, int, "%u");
832 case DATA_TYPE_INT32:
833 NVP(elem, int32, int32_t, long, "%ld");
836 case DATA_TYPE_UINT32:
837 NVP(elem, uint32, uint32_t, ulong_t, "%lu");
840 case DATA_TYPE_INT64:
841 NVP(elem, int64, int64_t, longlong_t, "%lld");
844 case DATA_TYPE_UINT64:
845 NVP(elem, uint64, uint64_t, u_longlong_t, "%llu");
848 case DATA_TYPE_STRING:
849 NVP(elem, string, char *, char *, "'%s'");
852 case DATA_TYPE_BYTE_ARRAY:
853 NVPA(elem, byte_array, uchar_t, int, "%u");
856 case DATA_TYPE_INT8_ARRAY:
857 NVPA(elem, int8_array, int8_t, int, "%d");
860 case DATA_TYPE_UINT8_ARRAY:
861 NVPA(elem, uint8_array, uint8_t, int, "%u");
864 case DATA_TYPE_INT16_ARRAY:
865 NVPA(elem, int16_array, int16_t, int, "%d");
868 case DATA_TYPE_UINT16_ARRAY:
869 NVPA(elem, uint16_array, uint16_t, int, "%u");
872 case DATA_TYPE_INT32_ARRAY:
873 NVPA(elem, int32_array, int32_t, long, "%ld");
876 case DATA_TYPE_UINT32_ARRAY:
877 NVPA(elem, uint32_array, uint32_t, ulong_t, "%lu");
880 case DATA_TYPE_INT64_ARRAY:
881 NVPA(elem, int64_array, int64_t, longlong_t, "%lld");
884 case DATA_TYPE_UINT64_ARRAY:
885 NVPA(elem, uint64_array, uint64_t, u_longlong_t,
889 case DATA_TYPE_STRING_ARRAY:
890 NVPA(elem, string_array, char *, char *, "'%s'");
893 case DATA_TYPE_NVLIST:
894 (void) nvpair_value_nvlist(elem, &nvlist_value);
895 (void) printf("%*s%s:\n", indent, "",
897 dump_nvlist(nvlist_value, indent + 4);
900 case DATA_TYPE_NVLIST_ARRAY:
901 (void) nvpair_value_nvlist_array(elem,
902 &nvlist_array_value, &count);
903 for (i = 0; i < count; i++) {
904 (void) printf("%*s%s[%u]:\n", indent, "",
905 nvpair_name(elem), i);
906 dump_nvlist(nvlist_array_value[i], indent + 4);
911 (void) printf(dgettext(TEXT_DOMAIN, "bad config type "
912 "%d for %s\n"), nvpair_type(elem),
919 * ======================================================================
921 * | Misc private interface. |
923 * ======================================================================
927 * Determine if string 'value' matches 'nvp' value. The 'value' string is
928 * converted, depending on the type of 'nvp', prior to match. For numeric
929 * types, a radix independent sscanf conversion of 'value' is used. If 'nvp'
930 * is an array type, 'ai' is the index into the array against which we are
931 * checking for match. If nvp is of DATA_TYPE_STRING*, the caller can pass
932 * in a regex_t compilation of value in 'value_regex' to trigger regular
933 * expression string match instead of simple strcmp().
935 * Return 1 on match, 0 on no-match, and -1 on error. If the error is
936 * related to value syntax error and 'ep' is non-NULL, *ep will point into
937 * the 'value' string at the location where the error exists.
939 * NOTE: It may be possible to move the non-regex_t version of this into
940 * common code used by library/kernel/boot.
943 nvpair_value_match_regex(nvpair_t *nvp, int ai,
944 char *value, regex_t *value_regex, char **ep)
953 if ((nvp == NULL) || (value == NULL))
954 return (-1); /* error fail match - invalid args */
956 /* make sure array and index combination make sense */
957 if ((nvpair_type_is_array(nvp) && (ai < 0)) ||
958 (!nvpair_type_is_array(nvp) && (ai >= 0)))
959 return (-1); /* error fail match - bad index */
961 /* non-string values should be single 'chunk' */
962 if ((nvpair_type(nvp) != DATA_TYPE_STRING) &&
963 (nvpair_type(nvp) != DATA_TYPE_STRING_ARRAY)) {
964 value += strspn(value, " \t");
965 evalue = value + strcspn(value, " \t");
969 return (-1); /* error fail match - syntax */
974 switch (nvpair_type(nvp)) {
975 case DATA_TYPE_STRING: {
978 /* check string value for match */
979 if (nvpair_value_string(nvp, &val) == 0) {
981 if (regexec(value_regex, val,
982 (size_t)0, NULL, 0) == 0)
983 return (1); /* match */
985 if (strcmp(value, val) == 0)
986 return (1); /* match */
991 case DATA_TYPE_STRING_ARRAY: {
994 /* check indexed string value of array for match */
995 if ((nvpair_value_string_array(nvp, &val_array, &a_len) == 0) &&
998 if (regexec(value_regex, val_array[ai],
999 (size_t)0, NULL, 0) == 0)
1002 if (strcmp(value, val_array[ai]) == 0)
1008 case DATA_TYPE_BYTE: {
1009 uchar_t val, val_arg;
1011 /* scanf uchar_t from value and check for match */
1012 sr = sscanf(value, "%c", &val_arg);
1013 if ((sr == 1) && (nvpair_value_byte(nvp, &val) == 0) &&
1018 case DATA_TYPE_BYTE_ARRAY: {
1019 uchar_t *val_array, val_arg;
1022 /* check indexed value of array for match */
1023 sr = sscanf(value, "%c", &val_arg);
1025 (nvpair_value_byte_array(nvp, &val_array, &a_len) == 0) &&
1027 (val_array[ai] == val_arg))
1031 case DATA_TYPE_INT8: {
1032 int8_t val, val_arg;
1034 /* scanf int8_t from value and check for match */
1035 sr = sscanf(value, "%"SCNi8, &val_arg);
1037 (nvpair_value_int8(nvp, &val) == 0) &&
1042 case DATA_TYPE_INT8_ARRAY: {
1043 int8_t *val_array, val_arg;
1045 /* check indexed value of array for match */
1046 sr = sscanf(value, "%"SCNi8, &val_arg);
1048 (nvpair_value_int8_array(nvp, &val_array, &a_len) == 0) &&
1050 (val_array[ai] == val_arg))
1054 case DATA_TYPE_UINT8: {
1055 uint8_t val, val_arg;
1057 /* scanf uint8_t from value and check for match */
1058 sr = sscanf(value, "%"SCNi8, (int8_t *)&val_arg);
1060 (nvpair_value_uint8(nvp, &val) == 0) &&
1065 case DATA_TYPE_UINT8_ARRAY: {
1066 uint8_t *val_array, val_arg;
1068 /* check indexed value of array for match */
1069 sr = sscanf(value, "%"SCNi8, (int8_t *)&val_arg);
1071 (nvpair_value_uint8_array(nvp, &val_array, &a_len) == 0) &&
1073 (val_array[ai] == val_arg))
1077 case DATA_TYPE_INT16: {
1078 int16_t val, val_arg;
1080 /* scanf int16_t from value and check for match */
1081 sr = sscanf(value, "%"SCNi16, &val_arg);
1083 (nvpair_value_int16(nvp, &val) == 0) &&
1088 case DATA_TYPE_INT16_ARRAY: {
1089 int16_t *val_array, val_arg;
1091 /* check indexed value of array for match */
1092 sr = sscanf(value, "%"SCNi16, &val_arg);
1094 (nvpair_value_int16_array(nvp, &val_array, &a_len) == 0) &&
1096 (val_array[ai] == val_arg))
1100 case DATA_TYPE_UINT16: {
1101 uint16_t val, val_arg;
1103 /* scanf uint16_t from value and check for match */
1104 sr = sscanf(value, "%"SCNi16, (int16_t *)&val_arg);
1106 (nvpair_value_uint16(nvp, &val) == 0) &&
1111 case DATA_TYPE_UINT16_ARRAY: {
1112 uint16_t *val_array, val_arg;
1114 /* check indexed value of array for match */
1115 sr = sscanf(value, "%"SCNi16, (int16_t *)&val_arg);
1117 (nvpair_value_uint16_array(nvp, &val_array, &a_len) == 0) &&
1119 (val_array[ai] == val_arg))
1123 case DATA_TYPE_INT32: {
1124 int32_t val, val_arg;
1126 /* scanf int32_t from value and check for match */
1127 sr = sscanf(value, "%"SCNi32, &val_arg);
1129 (nvpair_value_int32(nvp, &val) == 0) &&
1134 case DATA_TYPE_INT32_ARRAY: {
1135 int32_t *val_array, val_arg;
1137 /* check indexed value of array for match */
1138 sr = sscanf(value, "%"SCNi32, &val_arg);
1140 (nvpair_value_int32_array(nvp, &val_array, &a_len) == 0) &&
1142 (val_array[ai] == val_arg))
1146 case DATA_TYPE_UINT32: {
1147 uint32_t val, val_arg;
1149 /* scanf uint32_t from value and check for match */
1150 sr = sscanf(value, "%"SCNi32, (int32_t *)&val_arg);
1152 (nvpair_value_uint32(nvp, &val) == 0) &&
1157 case DATA_TYPE_UINT32_ARRAY: {
1158 uint32_t *val_array, val_arg;
1160 /* check indexed value of array for match */
1161 sr = sscanf(value, "%"SCNi32, (int32_t *)&val_arg);
1163 (nvpair_value_uint32_array(nvp, &val_array, &a_len) == 0) &&
1165 (val_array[ai] == val_arg))
1169 case DATA_TYPE_INT64: {
1170 int64_t val, val_arg;
1172 /* scanf int64_t from value and check for match */
1173 sr = sscanf(value, "%"SCNi64, &val_arg);
1175 (nvpair_value_int64(nvp, &val) == 0) &&
1180 case DATA_TYPE_INT64_ARRAY: {
1181 int64_t *val_array, val_arg;
1183 /* check indexed value of array for match */
1184 sr = sscanf(value, "%"SCNi64, &val_arg);
1186 (nvpair_value_int64_array(nvp, &val_array, &a_len) == 0) &&
1188 (val_array[ai] == val_arg))
1192 case DATA_TYPE_UINT64: {
1193 uint64_t val_arg, val;
1195 /* scanf uint64_t from value and check for match */
1196 sr = sscanf(value, "%"SCNi64, (int64_t *)&val_arg);
1198 (nvpair_value_uint64(nvp, &val) == 0) &&
1203 case DATA_TYPE_UINT64_ARRAY: {
1204 uint64_t *val_array, val_arg;
1206 /* check indexed value of array for match */
1207 sr = sscanf(value, "%"SCNi64, (int64_t *)&val_arg);
1209 (nvpair_value_uint64_array(nvp, &val_array, &a_len) == 0) &&
1211 (val_array[ai] == val_arg))
1215 case DATA_TYPE_BOOLEAN_VALUE: {
1216 boolean_t val, val_arg;
1218 /* scanf boolean_t from value and check for match */
1219 sr = sscanf(value, "%"SCNi32, (int32_t *)&val_arg);
1221 (nvpair_value_boolean_value(nvp, &val) == 0) &&
1226 case DATA_TYPE_BOOLEAN_ARRAY: {
1227 boolean_t *val_array, val_arg;
1229 /* check indexed value of array for match */
1230 sr = sscanf(value, "%"SCNi32, (int32_t *)&val_arg);
1232 (nvpair_value_boolean_array(nvp,
1233 &val_array, &a_len) == 0) &&
1235 (val_array[ai] == val_arg))
1239 case DATA_TYPE_HRTIME:
1240 case DATA_TYPE_NVLIST:
1241 case DATA_TYPE_NVLIST_ARRAY:
1242 case DATA_TYPE_BOOLEAN:
1243 case DATA_TYPE_DOUBLE:
1244 case DATA_TYPE_UNKNOWN:
1247 * unknown/unsupported data type
1249 return (-1); /* error fail match */
1253 * check to see if sscanf failed conversion, return approximate
1254 * pointer to problem
1259 return (-1); /* error fail match - syntax */
1262 return (0); /* fail match */
1266 nvpair_value_match(nvpair_t *nvp, int ai, char *value, char **ep)
1268 return (nvpair_value_match_regex(nvp, ai, value, NULL, ep));