]>
Commit | Line | Data |
---|---|---|
34dc7c2f BB |
1 | /* |
2 | * CDDL HEADER START | |
3 | * | |
4 | * The contents of this file are subject to the terms of the | |
b128c09f BB |
5 | * Common Development and Distribution License (the "License"). |
6 | * You may not use this file except in compliance with the License. | |
34dc7c2f BB |
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 | /* | |
572e2857 | 22 | * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved. |
34dc7c2f BB |
23 | */ |
24 | ||
25 | #ifndef _LIBUUTIL_H | |
26 | #define _LIBUUTIL_H | |
27 | ||
34dc7c2f BB |
28 | #include <sys/types.h> |
29 | #include <stdarg.h> | |
572e2857 | 30 | #include <stdio.h> |
34dc7c2f BB |
31 | |
32 | #ifdef __cplusplus | |
33 | extern "C" { | |
34 | #endif | |
35 | ||
36 | /* | |
37 | * Standard flags codes. | |
38 | */ | |
39 | #define UU_DEFAULT 0 | |
40 | ||
41 | /* | |
42 | * Standard error codes. | |
43 | */ | |
44 | #define UU_ERROR_NONE 0 /* no error */ | |
45 | #define UU_ERROR_INVALID_ARGUMENT 1 /* invalid argument */ | |
46 | #define UU_ERROR_UNKNOWN_FLAG 2 /* passed flag invalid */ | |
47 | #define UU_ERROR_NO_MEMORY 3 /* out of memory */ | |
48 | #define UU_ERROR_CALLBACK_FAILED 4 /* callback-initiated error */ | |
49 | #define UU_ERROR_NOT_SUPPORTED 5 /* operation not supported */ | |
50 | #define UU_ERROR_EMPTY 6 /* no value provided */ | |
51 | #define UU_ERROR_UNDERFLOW 7 /* value is too small */ | |
52 | #define UU_ERROR_OVERFLOW 8 /* value is too value */ | |
53 | #define UU_ERROR_INVALID_CHAR 9 /* value contains unexpected char */ | |
54 | #define UU_ERROR_INVALID_DIGIT 10 /* value contains digit not in base */ | |
55 | ||
56 | #define UU_ERROR_SYSTEM 99 /* underlying system error */ | |
57 | #define UU_ERROR_UNKNOWN 100 /* error status not known */ | |
58 | ||
59 | /* | |
60 | * Standard program exit codes. | |
61 | */ | |
62 | #define UU_EXIT_OK (*(uu_exit_ok())) | |
63 | #define UU_EXIT_FATAL (*(uu_exit_fatal())) | |
64 | #define UU_EXIT_USAGE (*(uu_exit_usage())) | |
65 | ||
66 | /* | |
67 | * Exit status profiles. | |
68 | */ | |
69 | #define UU_PROFILE_DEFAULT 0 | |
70 | #define UU_PROFILE_LAUNCHER 1 | |
71 | ||
72 | /* | |
73 | * Error reporting functions. | |
74 | */ | |
75 | uint32_t uu_error(void); | |
76 | const char *uu_strerror(uint32_t); | |
77 | ||
78 | /* | |
79 | * Program notification functions. | |
80 | */ | |
81 | extern void uu_alt_exit(int); | |
82 | extern const char *uu_setpname(char *); | |
83 | extern const char *uu_getpname(void); | |
84 | /*PRINTFLIKE1*/ | |
85 | extern void uu_warn(const char *, ...); | |
86 | extern void uu_vwarn(const char *, va_list); | |
87 | /*PRINTFLIKE1*/ | |
88 | extern void uu_die(const char *, ...) __NORETURN; | |
89 | extern void uu_vdie(const char *, va_list) __NORETURN; | |
90 | /*PRINTFLIKE2*/ | |
91 | extern void uu_xdie(int, const char *, ...) __NORETURN; | |
92 | extern void uu_vxdie(int, const char *, va_list) __NORETURN; | |
93 | ||
94 | /* | |
95 | * Exit status functions (not to be used directly) | |
96 | */ | |
97 | extern int *uu_exit_ok(void); | |
98 | extern int *uu_exit_fatal(void); | |
99 | extern int *uu_exit_usage(void); | |
100 | ||
34dc7c2f BB |
101 | /* |
102 | * Debug print facility functions. | |
103 | */ | |
104 | typedef struct uu_dprintf uu_dprintf_t; | |
105 | ||
106 | typedef enum { | |
107 | UU_DPRINTF_SILENT, | |
108 | UU_DPRINTF_FATAL, | |
109 | UU_DPRINTF_WARNING, | |
110 | UU_DPRINTF_NOTICE, | |
111 | UU_DPRINTF_INFO, | |
112 | UU_DPRINTF_DEBUG | |
113 | } uu_dprintf_severity_t; | |
114 | ||
115 | extern uu_dprintf_t *uu_dprintf_create(const char *, uu_dprintf_severity_t, | |
116 | uint_t); | |
117 | /*PRINTFLIKE3*/ | |
118 | extern void uu_dprintf(uu_dprintf_t *, uu_dprintf_severity_t, | |
119 | const char *, ...); | |
120 | extern void uu_dprintf_destroy(uu_dprintf_t *); | |
121 | extern const char *uu_dprintf_getname(uu_dprintf_t *); | |
122 | ||
123 | /* | |
124 | * Identifier test flags and function. | |
125 | */ | |
126 | #define UU_NAME_DOMAIN 0x1 /* allow SUNW, or com.sun, prefix */ | |
127 | #define UU_NAME_PATH 0x2 /* allow '/'-delimited paths */ | |
128 | ||
129 | int uu_check_name(const char *, uint_t); | |
130 | ||
131 | /* | |
132 | * File creation functions. | |
133 | */ | |
134 | extern int uu_open_tmp(const char *dir, uint_t uflags); | |
135 | ||
136 | /* | |
137 | * Convenience functions. | |
138 | */ | |
572e2857 BB |
139 | #define UU_NELEM(a) (sizeof (a) / sizeof ((a)[0])) |
140 | ||
34dc7c2f BB |
141 | /*PRINTFLIKE1*/ |
142 | extern char *uu_msprintf(const char *format, ...); | |
143 | extern void *uu_zalloc(size_t); | |
b128c09f | 144 | extern char *uu_strdup(const char *); |
34dc7c2f BB |
145 | extern void uu_free(void *); |
146 | ||
572e2857 BB |
147 | extern boolean_t uu_strcaseeq(const char *a, const char *b); |
148 | extern boolean_t uu_streq(const char *a, const char *b); | |
149 | extern char *uu_strndup(const char *s, size_t n); | |
150 | extern boolean_t uu_strbw(const char *a, const char *b); | |
151 | extern void *uu_memdup(const void *buf, size_t sz); | |
152 | extern void uu_dump(FILE *out, const char *prefix, const void *buf, size_t len); | |
153 | ||
34dc7c2f BB |
154 | /* |
155 | * Comparison function type definition. | |
156 | * Developers should be careful in their use of the _private argument. If you | |
157 | * break interface guarantees, you get undefined behavior. | |
158 | */ | |
159 | typedef int uu_compare_fn_t(const void *__left, const void *__right, | |
160 | void *__private); | |
161 | ||
162 | /* | |
163 | * Walk variant flags. | |
164 | * A data structure need not provide support for all variants and | |
165 | * combinations. Refer to the appropriate documentation. | |
166 | */ | |
167 | #define UU_WALK_ROBUST 0x00000001 /* walk can survive removes */ | |
168 | #define UU_WALK_REVERSE 0x00000002 /* reverse walk order */ | |
169 | ||
170 | #define UU_WALK_PREORDER 0x00000010 /* walk tree in pre-order */ | |
171 | #define UU_WALK_POSTORDER 0x00000020 /* walk tree in post-order */ | |
172 | ||
173 | /* | |
174 | * Walk callback function return codes. | |
175 | */ | |
176 | #define UU_WALK_ERROR -1 | |
177 | #define UU_WALK_NEXT 0 | |
178 | #define UU_WALK_DONE 1 | |
179 | ||
180 | /* | |
181 | * Walk callback function type definition. | |
182 | */ | |
183 | typedef int uu_walk_fn_t(void *_elem, void *_private); | |
184 | ||
185 | /* | |
186 | * lists: opaque structures | |
187 | */ | |
188 | typedef struct uu_list_pool uu_list_pool_t; | |
189 | typedef struct uu_list uu_list_t; | |
190 | ||
191 | typedef struct uu_list_node { | |
192 | uintptr_t uln_opaque[2]; | |
193 | } uu_list_node_t; | |
194 | ||
195 | typedef struct uu_list_walk uu_list_walk_t; | |
196 | ||
197 | typedef uintptr_t uu_list_index_t; | |
198 | ||
199 | /* | |
200 | * lists: interface | |
201 | * | |
202 | * basic usage: | |
203 | * typedef struct foo { | |
204 | * ... | |
205 | * uu_list_node_t foo_node; | |
206 | * ... | |
207 | * } foo_t; | |
208 | * | |
209 | * static int | |
210 | * foo_compare(void *l_arg, void *r_arg, void *private) | |
211 | * { | |
212 | * foo_t *l = l_arg; | |
213 | * foo_t *r = r_arg; | |
214 | * | |
215 | * if (... l greater than r ...) | |
216 | * return (1); | |
217 | * if (... l less than r ...) | |
218 | * return (-1); | |
219 | * return (0); | |
220 | * } | |
221 | * | |
222 | * ... | |
223 | * // at initialization time | |
224 | * foo_pool = uu_list_pool_create("foo_pool", | |
225 | * sizeof (foo_t), offsetof(foo_t, foo_node), foo_compare, | |
226 | * debugging? 0 : UU_AVL_POOL_DEBUG); | |
227 | * ... | |
228 | */ | |
229 | uu_list_pool_t *uu_list_pool_create(const char *, size_t, size_t, | |
230 | uu_compare_fn_t *, uint32_t); | |
231 | #define UU_LIST_POOL_DEBUG 0x00000001 | |
232 | ||
233 | void uu_list_pool_destroy(uu_list_pool_t *); | |
234 | ||
235 | /* | |
236 | * usage: | |
237 | * | |
238 | * foo_t *a; | |
b5256303 | 239 | * a = malloc(sizeof (*a)); |
34dc7c2f BB |
240 | * uu_list_node_init(a, &a->foo_list, pool); |
241 | * ... | |
242 | * uu_list_node_fini(a, &a->foo_list, pool); | |
243 | * free(a); | |
244 | */ | |
245 | void uu_list_node_init(void *, uu_list_node_t *, uu_list_pool_t *); | |
246 | void uu_list_node_fini(void *, uu_list_node_t *, uu_list_pool_t *); | |
247 | ||
248 | uu_list_t *uu_list_create(uu_list_pool_t *, void *_parent, uint32_t); | |
249 | #define UU_LIST_DEBUG 0x00000001 | |
250 | #define UU_LIST_SORTED 0x00000002 /* list is sorted */ | |
251 | ||
252 | void uu_list_destroy(uu_list_t *); /* list must be empty */ | |
253 | ||
254 | size_t uu_list_numnodes(uu_list_t *); | |
255 | ||
256 | void *uu_list_first(uu_list_t *); | |
257 | void *uu_list_last(uu_list_t *); | |
258 | ||
259 | void *uu_list_next(uu_list_t *, void *); | |
260 | void *uu_list_prev(uu_list_t *, void *); | |
261 | ||
262 | int uu_list_walk(uu_list_t *, uu_walk_fn_t *, void *, uint32_t); | |
263 | ||
264 | uu_list_walk_t *uu_list_walk_start(uu_list_t *, uint32_t); | |
265 | void *uu_list_walk_next(uu_list_walk_t *); | |
266 | void uu_list_walk_end(uu_list_walk_t *); | |
267 | ||
268 | void *uu_list_find(uu_list_t *, void *, void *, uu_list_index_t *); | |
269 | void uu_list_insert(uu_list_t *, void *, uu_list_index_t); | |
270 | ||
271 | void *uu_list_nearest_next(uu_list_t *, uu_list_index_t); | |
272 | void *uu_list_nearest_prev(uu_list_t *, uu_list_index_t); | |
273 | ||
274 | void *uu_list_teardown(uu_list_t *, void **); | |
275 | ||
276 | void uu_list_remove(uu_list_t *, void *); | |
277 | ||
278 | /* | |
279 | * lists: interfaces for non-sorted lists only | |
280 | */ | |
281 | int uu_list_insert_before(uu_list_t *, void *_target, void *_elem); | |
282 | int uu_list_insert_after(uu_list_t *, void *_target, void *_elem); | |
283 | ||
284 | /* | |
285 | * avl trees: opaque structures | |
286 | */ | |
287 | typedef struct uu_avl_pool uu_avl_pool_t; | |
288 | typedef struct uu_avl uu_avl_t; | |
289 | ||
290 | typedef struct uu_avl_node { | |
291 | #ifdef _LP64 | |
292 | uintptr_t uan_opaque[3]; | |
293 | #else | |
294 | uintptr_t uan_opaque[4]; | |
295 | #endif | |
296 | } uu_avl_node_t; | |
297 | ||
298 | typedef struct uu_avl_walk uu_avl_walk_t; | |
299 | ||
300 | typedef uintptr_t uu_avl_index_t; | |
301 | ||
302 | /* | |
303 | * avl trees: interface | |
304 | * | |
305 | * basic usage: | |
306 | * typedef struct foo { | |
307 | * ... | |
308 | * uu_avl_node_t foo_node; | |
309 | * ... | |
310 | * } foo_t; | |
311 | * | |
312 | * static int | |
313 | * foo_compare(void *l_arg, void *r_arg, void *private) | |
314 | * { | |
315 | * foo_t *l = l_arg; | |
316 | * foo_t *r = r_arg; | |
317 | * | |
318 | * if (... l greater than r ...) | |
319 | * return (1); | |
320 | * if (... l less than r ...) | |
321 | * return (-1); | |
322 | * return (0); | |
323 | * } | |
324 | * | |
325 | * ... | |
326 | * // at initialization time | |
327 | * foo_pool = uu_avl_pool_create("foo_pool", | |
328 | * sizeof (foo_t), offsetof(foo_t, foo_node), foo_compare, | |
329 | * debugging? 0 : UU_AVL_POOL_DEBUG); | |
330 | * ... | |
331 | */ | |
332 | uu_avl_pool_t *uu_avl_pool_create(const char *, size_t, size_t, | |
333 | uu_compare_fn_t *, uint32_t); | |
334 | #define UU_AVL_POOL_DEBUG 0x00000001 | |
335 | ||
336 | void uu_avl_pool_destroy(uu_avl_pool_t *); | |
337 | ||
338 | /* | |
339 | * usage: | |
340 | * | |
341 | * foo_t *a; | |
b5256303 | 342 | * a = malloc(sizeof (*a)); |
34dc7c2f BB |
343 | * uu_avl_node_init(a, &a->foo_avl, pool); |
344 | * ... | |
345 | * uu_avl_node_fini(a, &a->foo_avl, pool); | |
346 | * free(a); | |
347 | */ | |
348 | void uu_avl_node_init(void *, uu_avl_node_t *, uu_avl_pool_t *); | |
349 | void uu_avl_node_fini(void *, uu_avl_node_t *, uu_avl_pool_t *); | |
350 | ||
351 | uu_avl_t *uu_avl_create(uu_avl_pool_t *, void *_parent, uint32_t); | |
352 | #define UU_AVL_DEBUG 0x00000001 | |
353 | ||
354 | void uu_avl_destroy(uu_avl_t *); /* list must be empty */ | |
355 | ||
356 | size_t uu_avl_numnodes(uu_avl_t *); | |
357 | ||
358 | void *uu_avl_first(uu_avl_t *); | |
359 | void *uu_avl_last(uu_avl_t *); | |
360 | ||
361 | void *uu_avl_next(uu_avl_t *, void *); | |
362 | void *uu_avl_prev(uu_avl_t *, void *); | |
363 | ||
364 | int uu_avl_walk(uu_avl_t *, uu_walk_fn_t *, void *, uint32_t); | |
365 | ||
366 | uu_avl_walk_t *uu_avl_walk_start(uu_avl_t *, uint32_t); | |
367 | void *uu_avl_walk_next(uu_avl_walk_t *); | |
368 | void uu_avl_walk_end(uu_avl_walk_t *); | |
369 | ||
370 | void *uu_avl_find(uu_avl_t *, void *, void *, uu_avl_index_t *); | |
371 | void uu_avl_insert(uu_avl_t *, void *, uu_avl_index_t); | |
372 | ||
373 | void *uu_avl_nearest_next(uu_avl_t *, uu_avl_index_t); | |
374 | void *uu_avl_nearest_prev(uu_avl_t *, uu_avl_index_t); | |
375 | ||
376 | void *uu_avl_teardown(uu_avl_t *, void **); | |
377 | ||
378 | void uu_avl_remove(uu_avl_t *, void *); | |
379 | ||
380 | #ifdef __cplusplus | |
381 | } | |
382 | #endif | |
383 | ||
384 | #endif /* _LIBUUTIL_H */ |