]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * CDDL HEADER START | |
3 | * | |
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. | |
7 | * | |
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. | |
12 | * | |
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] | |
18 | * | |
19 | * CDDL HEADER END | |
20 | */ | |
21 | /* | |
22 | * Copyright (c) 2000, 2010, Oracle and/or its affiliates. All rights reserved. | |
23 | */ | |
24 | ||
25 | #ifndef _LIBNVPAIR_H | |
26 | #define _LIBNVPAIR_H | |
27 | ||
28 | #include <sys/nvpair.h> | |
29 | #include <stdlib.h> | |
30 | #include <stdio.h> | |
31 | #include <regex.h> | |
32 | ||
33 | #ifdef __cplusplus | |
34 | extern "C" { | |
35 | #endif | |
36 | ||
37 | /* | |
38 | * All interfaces described in this file are private to Solaris, and | |
39 | * are subject to change at any time and without notice. The public | |
40 | * nvlist/nvpair interfaces, as documented in manpage sections 3NVPAIR, | |
41 | * are all imported from <sys/nvpair.h> included above. | |
42 | */ | |
43 | ||
44 | extern int nvpair_value_match(nvpair_t *, int, char *, char **); | |
45 | extern int nvpair_value_match_regex(nvpair_t *, int, char *, regex_t *, | |
46 | char **); | |
47 | ||
48 | extern void nvlist_print(FILE *, nvlist_t *); | |
49 | extern void dump_nvlist(nvlist_t *, int); | |
50 | ||
51 | /* | |
52 | * Private nvlist printing interface that allows the caller some control | |
53 | * over output rendering (as opposed to nvlist_print and dump_nvlist). | |
54 | * | |
55 | * Obtain an opaque nvlist_prtctl_t cookie using nvlist_prtctl_alloc | |
56 | * (NULL on failure); on return the cookie is set up for default formatting | |
57 | * and rendering. Quote the cookie in subsequent customisation functions and | |
58 | * then pass the cookie to nvlist_prt to render the nvlist. Finally, | |
59 | * use nvlist_prtctl_free to release the cookie. | |
60 | * | |
61 | * For all nvlist_lookup_xxx and nvlist_lookup_xxx_array functions | |
62 | * we have a corresponding brace of functions that appoint replacement | |
63 | * rendering functions: | |
64 | * | |
65 | * extern void nvlist_prtctl_xxx(nvlist_prtctl_t, | |
66 | * void (*)(nvlist_prtctl_t ctl, void *private, const char *name, | |
67 | * xxxtype value)) | |
68 | * | |
69 | * and | |
70 | * | |
71 | * extern void nvlist_prtctl_xxx_array(nvlist_prtctl_t, | |
72 | * void (*)(nvlist_prtctl_t ctl, void *private, const char *name, | |
73 | * xxxtype value, uint_t count)) | |
74 | * | |
75 | * where xxxtype is the C datatype corresponding to xxx, eg int8_t for "int8" | |
76 | * and char * for "string". The function that is appointed to render the | |
77 | * specified datatype receives as arguments the cookie, the nvlist | |
78 | * member name, the value of that member (or a pointer for array function), | |
79 | * and (for array rendering functions) a count of the number of elements. | |
80 | */ | |
81 | ||
82 | typedef struct nvlist_prtctl *nvlist_prtctl_t; /* opaque */ | |
83 | ||
84 | enum nvlist_indent_mode { | |
85 | NVLIST_INDENT_ABS, /* Absolute indentation */ | |
86 | NVLIST_INDENT_TABBED /* Indent with tabstops */ | |
87 | }; | |
88 | ||
89 | extern nvlist_prtctl_t nvlist_prtctl_alloc(void); | |
90 | extern void nvlist_prtctl_free(nvlist_prtctl_t); | |
91 | extern void nvlist_prt(nvlist_t *, nvlist_prtctl_t); | |
92 | ||
93 | /* Output stream */ | |
94 | extern void nvlist_prtctl_setdest(nvlist_prtctl_t, FILE *); | |
95 | extern FILE *nvlist_prtctl_getdest(nvlist_prtctl_t); | |
96 | ||
97 | /* Indentation mode, start indent, indent increment; default tabbed/0/1 */ | |
98 | extern void nvlist_prtctl_setindent(nvlist_prtctl_t, enum nvlist_indent_mode, | |
99 | int, int); | |
100 | extern void nvlist_prtctl_doindent(nvlist_prtctl_t, int); | |
101 | ||
102 | enum nvlist_prtctl_fmt { | |
103 | NVLIST_FMT_MEMBER_NAME, /* name fmt; default "%s = " */ | |
104 | NVLIST_FMT_MEMBER_POSTAMBLE, /* after nvlist member; default "\n" */ | |
105 | NVLIST_FMT_BTWN_ARRAY /* between array members; default " " */ | |
106 | }; | |
107 | ||
108 | extern void nvlist_prtctl_setfmt(nvlist_prtctl_t, enum nvlist_prtctl_fmt, | |
109 | const char *); | |
110 | extern void nvlist_prtctl_dofmt(nvlist_prtctl_t, enum nvlist_prtctl_fmt, ...); | |
111 | ||
112 | /* | |
113 | * Function prototypes for interfaces that appoint a new rendering function | |
114 | * for single-valued nvlist members. | |
115 | * | |
116 | * A replacement function receives arguments as follows: | |
117 | * | |
118 | * nvlist_prtctl_t Print control structure; do not change preferences | |
119 | * for this object from a print callback function. | |
120 | * | |
121 | * void * The function-private cookie argument registered | |
122 | * when the replacement function was appointed. | |
123 | * | |
124 | * nvlist_t * The full nvlist that is being processed. The | |
125 | * rendering function is called to render a single | |
126 | * member (name and value passed as below) but it may | |
127 | * want to reference or incorporate other aspects of | |
128 | * the full nvlist. | |
129 | * | |
130 | * const char * Member name to render | |
131 | * | |
132 | * valtype Value of the member to render | |
133 | * | |
134 | * The function must return non-zero if it has rendered output for this | |
135 | * member, or 0 if it wants to default to standard rendering for this | |
136 | * one member. | |
137 | */ | |
138 | ||
139 | #define NVLIST_PRINTCTL_SVDECL(funcname, valtype) \ | |
140 | extern void funcname(nvlist_prtctl_t, \ | |
141 | int (*)(nvlist_prtctl_t, void *, nvlist_t *, const char *, valtype), \ | |
142 | void *) | |
143 | ||
144 | NVLIST_PRINTCTL_SVDECL(nvlist_prtctlop_boolean, int); | |
145 | NVLIST_PRINTCTL_SVDECL(nvlist_prtctlop_boolean_value, boolean_t); | |
146 | NVLIST_PRINTCTL_SVDECL(nvlist_prtctlop_byte, uchar_t); | |
147 | NVLIST_PRINTCTL_SVDECL(nvlist_prtctlop_int8, int8_t); | |
148 | NVLIST_PRINTCTL_SVDECL(nvlist_prtctlop_uint8, uint8_t); | |
149 | NVLIST_PRINTCTL_SVDECL(nvlist_prtctlop_int16, int16_t); | |
150 | NVLIST_PRINTCTL_SVDECL(nvlist_prtctlop_uint16, uint16_t); | |
151 | NVLIST_PRINTCTL_SVDECL(nvlist_prtctlop_int32, int32_t); | |
152 | NVLIST_PRINTCTL_SVDECL(nvlist_prtctlop_uint32, uint32_t); | |
153 | NVLIST_PRINTCTL_SVDECL(nvlist_prtctlop_int64, int64_t); | |
154 | NVLIST_PRINTCTL_SVDECL(nvlist_prtctlop_uint64, uint64_t); | |
155 | NVLIST_PRINTCTL_SVDECL(nvlist_prtctlop_double, double); | |
156 | NVLIST_PRINTCTL_SVDECL(nvlist_prtctlop_string, char *); | |
157 | NVLIST_PRINTCTL_SVDECL(nvlist_prtctlop_hrtime, hrtime_t); | |
158 | NVLIST_PRINTCTL_SVDECL(nvlist_prtctlop_nvlist, nvlist_t *); | |
159 | ||
160 | #undef NVLIST_PRINTCTL_SVDECL /* was just for "clarity" above */ | |
161 | ||
162 | /* | |
163 | * Function prototypes for interfaces that appoint a new rendering function | |
164 | * for array-valued nvlist members. | |
165 | * | |
166 | * One additional argument is taken: uint_t for the number of array elements | |
167 | * | |
168 | * Return values as above. | |
169 | */ | |
170 | #define NVLIST_PRINTCTL_AVDECL(funcname, vtype) \ | |
171 | extern void funcname(nvlist_prtctl_t, \ | |
172 | int (*)(nvlist_prtctl_t, void *, nvlist_t *, const char *, vtype, uint_t), \ | |
173 | void *) | |
174 | ||
175 | NVLIST_PRINTCTL_AVDECL(nvlist_prtctlop_boolean_array, boolean_t *); | |
176 | NVLIST_PRINTCTL_AVDECL(nvlist_prtctlop_byte_array, uchar_t *); | |
177 | NVLIST_PRINTCTL_AVDECL(nvlist_prtctlop_int8_array, int8_t *); | |
178 | NVLIST_PRINTCTL_AVDECL(nvlist_prtctlop_uint8_array, uint8_t *); | |
179 | NVLIST_PRINTCTL_AVDECL(nvlist_prtctlop_int16_array, int16_t *); | |
180 | NVLIST_PRINTCTL_AVDECL(nvlist_prtctlop_uint16_array, uint16_t *); | |
181 | NVLIST_PRINTCTL_AVDECL(nvlist_prtctlop_int32_array, int32_t *); | |
182 | NVLIST_PRINTCTL_AVDECL(nvlist_prtctlop_uint32_array, uint32_t *); | |
183 | NVLIST_PRINTCTL_AVDECL(nvlist_prtctlop_int64_array, int64_t *); | |
184 | NVLIST_PRINTCTL_AVDECL(nvlist_prtctlop_uint64_array, uint64_t *); | |
185 | NVLIST_PRINTCTL_AVDECL(nvlist_prtctlop_string_array, char **); | |
186 | NVLIST_PRINTCTL_AVDECL(nvlist_prtctlop_nvlist_array, nvlist_t **); | |
187 | ||
188 | #undef NVLIST_PRINTCTL_AVDECL /* was just for "clarity" above */ | |
189 | ||
190 | #ifdef __cplusplus | |
191 | } | |
192 | #endif | |
193 | ||
194 | #endif /* _LIBNVPAIR_H */ |