]>
Commit | Line | Data |
---|---|---|
87d546d8 TG |
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) 2004, 2010, Oracle and/or its affiliates. All rights reserved. | |
23 | */ | |
24 | ||
25 | #ifndef _LIBUUTIL_H | |
26 | #define _LIBUUTIL_H | |
27 | ||
28 | #include <sys/types.h> | |
29 | #include <stdarg.h> | |
30 | #include <stdio.h> | |
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 | ||
101 | /* | |
102 | * string->number conversions | |
103 | */ | |
104 | extern int uu_strtoint(const char *, void *, size_t, int, int64_t, int64_t); | |
105 | extern int uu_strtouint(const char *, void *, size_t, int, uint64_t, uint64_t); | |
106 | ||
107 | /* | |
108 | * Debug print facility functions. | |
109 | */ | |
110 | typedef struct uu_dprintf uu_dprintf_t; | |
111 | ||
112 | typedef enum { | |
113 | UU_DPRINTF_SILENT, | |
114 | UU_DPRINTF_FATAL, | |
115 | UU_DPRINTF_WARNING, | |
116 | UU_DPRINTF_NOTICE, | |
117 | UU_DPRINTF_INFO, | |
118 | UU_DPRINTF_DEBUG | |
119 | } uu_dprintf_severity_t; | |
120 | ||
121 | extern uu_dprintf_t *uu_dprintf_create(const char *, uu_dprintf_severity_t, | |
122 | uint_t); | |
123 | /*PRINTFLIKE3*/ | |
124 | extern void uu_dprintf(uu_dprintf_t *, uu_dprintf_severity_t, | |
125 | const char *, ...); | |
126 | extern void uu_dprintf_destroy(uu_dprintf_t *); | |
127 | extern const char *uu_dprintf_getname(uu_dprintf_t *); | |
128 | ||
129 | /* | |
130 | * Identifier test flags and function. | |
131 | */ | |
132 | #define UU_NAME_DOMAIN 0x1 /* allow SUNW, or com.sun, prefix */ | |
133 | #define UU_NAME_PATH 0x2 /* allow '/'-delimited paths */ | |
134 | ||
135 | int uu_check_name(const char *, uint_t); | |
136 | ||
137 | /* | |
138 | * File creation functions. | |
139 | */ | |
140 | extern int uu_open_tmp(const char *dir, uint_t uflags); | |
141 | ||
142 | /* | |
143 | * Convenience functions. | |
144 | */ | |
145 | #define UU_NELEM(a) (sizeof (a) / sizeof ((a)[0])) | |
146 | ||
147 | /*PRINTFLIKE1*/ | |
148 | extern char *uu_msprintf(const char *format, ...); | |
149 | extern void *uu_zalloc(size_t); | |
150 | extern char *uu_strdup(const char *); | |
151 | extern void uu_free(void *); | |
152 | ||
153 | extern boolean_t uu_strcaseeq(const char *a, const char *b); | |
154 | extern boolean_t uu_streq(const char *a, const char *b); | |
155 | extern char *uu_strndup(const char *s, size_t n); | |
156 | extern boolean_t uu_strbw(const char *a, const char *b); | |
157 | extern void *uu_memdup(const void *buf, size_t sz); | |
158 | extern void uu_dump(FILE *out, const char *prefix, const void *buf, size_t len); | |
159 | ||
160 | /* | |
161 | * Comparison function type definition. | |
162 | * Developers should be careful in their use of the _private argument. If you | |
163 | * break interface guarantees, you get undefined behavior. | |
164 | */ | |
165 | typedef int uu_compare_fn_t(const void *__left, const void *__right, | |
166 | void *__private); | |
167 | ||
168 | /* | |
169 | * Walk variant flags. | |
170 | * A data structure need not provide support for all variants and | |
171 | * combinations. Refer to the appropriate documentation. | |
172 | */ | |
173 | #define UU_WALK_ROBUST 0x00000001 /* walk can survive removes */ | |
174 | #define UU_WALK_REVERSE 0x00000002 /* reverse walk order */ | |
175 | ||
176 | #define UU_WALK_PREORDER 0x00000010 /* walk tree in pre-order */ | |
177 | #define UU_WALK_POSTORDER 0x00000020 /* walk tree in post-order */ | |
178 | ||
179 | /* | |
180 | * Walk callback function return codes. | |
181 | */ | |
182 | #define UU_WALK_ERROR -1 | |
183 | #define UU_WALK_NEXT 0 | |
184 | #define UU_WALK_DONE 1 | |
185 | ||
186 | /* | |
187 | * Walk callback function type definition. | |
188 | */ | |
189 | typedef int uu_walk_fn_t(void *_elem, void *_private); | |
190 | ||
191 | /* | |
192 | * lists: opaque structures | |
193 | */ | |
194 | typedef struct uu_list_pool uu_list_pool_t; | |
195 | typedef struct uu_list uu_list_t; | |
196 | ||
197 | typedef struct uu_list_node { | |
198 | uintptr_t uln_opaque[2]; | |
199 | } uu_list_node_t; | |
200 | ||
201 | typedef struct uu_list_walk uu_list_walk_t; | |
202 | ||
203 | typedef uintptr_t uu_list_index_t; | |
204 | ||
205 | /* | |
206 | * lists: interface | |
207 | * | |
208 | * basic usage: | |
209 | * typedef struct foo { | |
210 | * ... | |
211 | * uu_list_node_t foo_node; | |
212 | * ... | |
213 | * } foo_t; | |
214 | * | |
215 | * static int | |
216 | * foo_compare(void *l_arg, void *r_arg, void *private) | |
217 | * { | |
218 | * foo_t *l = l_arg; | |
219 | * foo_t *r = r_arg; | |
220 | * | |
221 | * if (... l greater than r ...) | |
222 | * return (1); | |
223 | * if (... l less than r ...) | |
224 | * return (-1); | |
225 | * return (0); | |
226 | * } | |
227 | * | |
228 | * ... | |
229 | * // at initialization time | |
230 | * foo_pool = uu_list_pool_create("foo_pool", | |
231 | * sizeof (foo_t), offsetof(foo_t, foo_node), foo_compare, | |
232 | * debugging? 0 : UU_AVL_POOL_DEBUG); | |
233 | * ... | |
234 | */ | |
235 | uu_list_pool_t *uu_list_pool_create(const char *, size_t, size_t, | |
236 | uu_compare_fn_t *, uint32_t); | |
237 | #define UU_LIST_POOL_DEBUG 0x00000001 | |
238 | ||
239 | void uu_list_pool_destroy(uu_list_pool_t *); | |
240 | ||
241 | /* | |
242 | * usage: | |
243 | * | |
244 | * foo_t *a; | |
245 | * a = malloc(sizeof(*a)); | |
246 | * uu_list_node_init(a, &a->foo_list, pool); | |
247 | * ... | |
248 | * uu_list_node_fini(a, &a->foo_list, pool); | |
249 | * free(a); | |
250 | */ | |
251 | void uu_list_node_init(void *, uu_list_node_t *, uu_list_pool_t *); | |
252 | void uu_list_node_fini(void *, uu_list_node_t *, uu_list_pool_t *); | |
253 | ||
254 | uu_list_t *uu_list_create(uu_list_pool_t *, void *_parent, uint32_t); | |
255 | #define UU_LIST_DEBUG 0x00000001 | |
256 | #define UU_LIST_SORTED 0x00000002 /* list is sorted */ | |
257 | ||
258 | void uu_list_destroy(uu_list_t *); /* list must be empty */ | |
259 | ||
260 | size_t uu_list_numnodes(uu_list_t *); | |
261 | ||
262 | void *uu_list_first(uu_list_t *); | |
263 | void *uu_list_last(uu_list_t *); | |
264 | ||
265 | void *uu_list_next(uu_list_t *, void *); | |
266 | void *uu_list_prev(uu_list_t *, void *); | |
267 | ||
268 | int uu_list_walk(uu_list_t *, uu_walk_fn_t *, void *, uint32_t); | |
269 | ||
270 | uu_list_walk_t *uu_list_walk_start(uu_list_t *, uint32_t); | |
271 | void *uu_list_walk_next(uu_list_walk_t *); | |
272 | void uu_list_walk_end(uu_list_walk_t *); | |
273 | ||
274 | void *uu_list_find(uu_list_t *, void *, void *, uu_list_index_t *); | |
275 | void uu_list_insert(uu_list_t *, void *, uu_list_index_t); | |
276 | ||
277 | void *uu_list_nearest_next(uu_list_t *, uu_list_index_t); | |
278 | void *uu_list_nearest_prev(uu_list_t *, uu_list_index_t); | |
279 | ||
280 | void *uu_list_teardown(uu_list_t *, void **); | |
281 | ||
282 | void uu_list_remove(uu_list_t *, void *); | |
283 | ||
284 | /* | |
285 | * lists: interfaces for non-sorted lists only | |
286 | */ | |
287 | int uu_list_insert_before(uu_list_t *, void *_target, void *_elem); | |
288 | int uu_list_insert_after(uu_list_t *, void *_target, void *_elem); | |
289 | ||
290 | /* | |
291 | * avl trees: opaque structures | |
292 | */ | |
293 | typedef struct uu_avl_pool uu_avl_pool_t; | |
294 | typedef struct uu_avl uu_avl_t; | |
295 | ||
296 | typedef struct uu_avl_node { | |
297 | #ifdef _LP64 | |
298 | uintptr_t uan_opaque[3]; | |
299 | #else | |
300 | uintptr_t uan_opaque[4]; | |
301 | #endif | |
302 | } uu_avl_node_t; | |
303 | ||
304 | typedef struct uu_avl_walk uu_avl_walk_t; | |
305 | ||
306 | typedef uintptr_t uu_avl_index_t; | |
307 | ||
308 | /* | |
309 | * avl trees: interface | |
310 | * | |
311 | * basic usage: | |
312 | * typedef struct foo { | |
313 | * ... | |
314 | * uu_avl_node_t foo_node; | |
315 | * ... | |
316 | * } foo_t; | |
317 | * | |
318 | * static int | |
319 | * foo_compare(void *l_arg, void *r_arg, void *private) | |
320 | * { | |
321 | * foo_t *l = l_arg; | |
322 | * foo_t *r = r_arg; | |
323 | * | |
324 | * if (... l greater than r ...) | |
325 | * return (1); | |
326 | * if (... l less than r ...) | |
327 | * return (-1); | |
328 | * return (0); | |
329 | * } | |
330 | * | |
331 | * ... | |
332 | * // at initialization time | |
333 | * foo_pool = uu_avl_pool_create("foo_pool", | |
334 | * sizeof (foo_t), offsetof(foo_t, foo_node), foo_compare, | |
335 | * debugging? 0 : UU_AVL_POOL_DEBUG); | |
336 | * ... | |
337 | */ | |
338 | uu_avl_pool_t *uu_avl_pool_create(const char *, size_t, size_t, | |
339 | uu_compare_fn_t *, uint32_t); | |
340 | #define UU_AVL_POOL_DEBUG 0x00000001 | |
341 | ||
342 | void uu_avl_pool_destroy(uu_avl_pool_t *); | |
343 | ||
344 | /* | |
345 | * usage: | |
346 | * | |
347 | * foo_t *a; | |
348 | * a = malloc(sizeof(*a)); | |
349 | * uu_avl_node_init(a, &a->foo_avl, pool); | |
350 | * ... | |
351 | * uu_avl_node_fini(a, &a->foo_avl, pool); | |
352 | * free(a); | |
353 | */ | |
354 | void uu_avl_node_init(void *, uu_avl_node_t *, uu_avl_pool_t *); | |
355 | void uu_avl_node_fini(void *, uu_avl_node_t *, uu_avl_pool_t *); | |
356 | ||
357 | uu_avl_t *uu_avl_create(uu_avl_pool_t *, void *_parent, uint32_t); | |
358 | #define UU_AVL_DEBUG 0x00000001 | |
359 | ||
360 | void uu_avl_destroy(uu_avl_t *); /* list must be empty */ | |
361 | ||
362 | size_t uu_avl_numnodes(uu_avl_t *); | |
363 | ||
364 | void *uu_avl_first(uu_avl_t *); | |
365 | void *uu_avl_last(uu_avl_t *); | |
366 | ||
367 | void *uu_avl_next(uu_avl_t *, void *); | |
368 | void *uu_avl_prev(uu_avl_t *, void *); | |
369 | ||
370 | int uu_avl_walk(uu_avl_t *, uu_walk_fn_t *, void *, uint32_t); | |
371 | ||
372 | uu_avl_walk_t *uu_avl_walk_start(uu_avl_t *, uint32_t); | |
373 | void *uu_avl_walk_next(uu_avl_walk_t *); | |
374 | void uu_avl_walk_end(uu_avl_walk_t *); | |
375 | ||
376 | void *uu_avl_find(uu_avl_t *, void *, void *, uu_avl_index_t *); | |
377 | void uu_avl_insert(uu_avl_t *, void *, uu_avl_index_t); | |
378 | ||
379 | void *uu_avl_nearest_next(uu_avl_t *, uu_avl_index_t); | |
380 | void *uu_avl_nearest_prev(uu_avl_t *, uu_avl_index_t); | |
381 | ||
382 | void *uu_avl_teardown(uu_avl_t *, void **); | |
383 | ||
384 | void uu_avl_remove(uu_avl_t *, void *); | |
385 | ||
386 | #ifdef __cplusplus | |
387 | } | |
388 | #endif | |
389 | ||
390 | #endif /* _LIBUUTIL_H */ |