4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License, Version 1.0 only
6 * (the "License"). You may not use this file except in compliance
9 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10 * or http://www.opensolaris.org/os/licensing.
11 * See the License for the specific language governing permissions
12 * and limitations under the License.
14 * When distributing Covered Code, include this CDDL HEADER in each
15 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16 * If applicable, add the following below this CDDL HEADER, with the
17 * fields enclosed by brackets "[]" replaced with your own identifying
18 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright 2005 Sun Microsystems, Inc. All rights reserved.
24 * Use is subject to license terms.
30 #pragma ident "%Z%%M% %I% %E% SMI"
33 #include <sys/types.h>
41 * Standard flags codes.
46 * Standard error codes.
48 #define UU_ERROR_NONE 0 /* no error */
49 #define UU_ERROR_INVALID_ARGUMENT 1 /* invalid argument */
50 #define UU_ERROR_UNKNOWN_FLAG 2 /* passed flag invalid */
51 #define UU_ERROR_NO_MEMORY 3 /* out of memory */
52 #define UU_ERROR_CALLBACK_FAILED 4 /* callback-initiated error */
53 #define UU_ERROR_NOT_SUPPORTED 5 /* operation not supported */
54 #define UU_ERROR_EMPTY 6 /* no value provided */
55 #define UU_ERROR_UNDERFLOW 7 /* value is too small */
56 #define UU_ERROR_OVERFLOW 8 /* value is too value */
57 #define UU_ERROR_INVALID_CHAR 9 /* value contains unexpected char */
58 #define UU_ERROR_INVALID_DIGIT 10 /* value contains digit not in base */
60 #define UU_ERROR_SYSTEM 99 /* underlying system error */
61 #define UU_ERROR_UNKNOWN 100 /* error status not known */
64 * Standard program exit codes.
66 #define UU_EXIT_OK (*(uu_exit_ok()))
67 #define UU_EXIT_FATAL (*(uu_exit_fatal()))
68 #define UU_EXIT_USAGE (*(uu_exit_usage()))
71 * Exit status profiles.
73 #define UU_PROFILE_DEFAULT 0
74 #define UU_PROFILE_LAUNCHER 1
77 * Error reporting functions.
79 uint32_t uu_error(void);
80 const char *uu_strerror(uint32_t);
83 * Program notification functions.
85 extern void uu_alt_exit(int);
86 extern const char *uu_setpname(char *);
87 extern const char *uu_getpname(void);
89 extern void uu_warn(const char *, ...);
90 extern void uu_vwarn(const char *, va_list);
92 extern void uu_die(const char *, ...) __NORETURN;
93 extern void uu_vdie(const char *, va_list) __NORETURN;
95 extern void uu_xdie(int, const char *, ...) __NORETURN;
96 extern void uu_vxdie(int, const char *, va_list) __NORETURN;
99 * Exit status functions (not to be used directly)
101 extern int *uu_exit_ok(void);
102 extern int *uu_exit_fatal(void);
103 extern int *uu_exit_usage(void);
106 * string->number conversions
108 extern int uu_strtoint(const char *, void *, size_t, int, int64_t, int64_t);
109 extern int uu_strtouint(const char *, void *, size_t, int, uint64_t, uint64_t);
112 * Debug print facility functions.
114 typedef struct uu_dprintf uu_dprintf_t;
123 } uu_dprintf_severity_t;
125 extern uu_dprintf_t *uu_dprintf_create(const char *, uu_dprintf_severity_t,
128 extern void uu_dprintf(uu_dprintf_t *, uu_dprintf_severity_t,
130 extern void uu_dprintf_destroy(uu_dprintf_t *);
131 extern const char *uu_dprintf_getname(uu_dprintf_t *);
134 * Identifier test flags and function.
136 #define UU_NAME_DOMAIN 0x1 /* allow SUNW, or com.sun, prefix */
137 #define UU_NAME_PATH 0x2 /* allow '/'-delimited paths */
139 int uu_check_name(const char *, uint_t);
142 * File creation functions.
144 extern int uu_open_tmp(const char *dir, uint_t uflags);
147 * Convenience functions.
150 extern char *uu_msprintf(const char *format, ...);
151 extern void *uu_zalloc(size_t);
152 extern void uu_free(void *);
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.
159 typedef int uu_compare_fn_t(const void *__left, const void *__right,
163 * Walk variant flags.
164 * A data structure need not provide support for all variants and
165 * combinations. Refer to the appropriate documentation.
167 #define UU_WALK_ROBUST 0x00000001 /* walk can survive removes */
168 #define UU_WALK_REVERSE 0x00000002 /* reverse walk order */
170 #define UU_WALK_PREORDER 0x00000010 /* walk tree in pre-order */
171 #define UU_WALK_POSTORDER 0x00000020 /* walk tree in post-order */
174 * Walk callback function return codes.
176 #define UU_WALK_ERROR -1
177 #define UU_WALK_NEXT 0
178 #define UU_WALK_DONE 1
181 * Walk callback function type definition.
183 typedef int uu_walk_fn_t(void *_elem, void *_private);
186 * lists: opaque structures
188 typedef struct uu_list_pool uu_list_pool_t;
189 typedef struct uu_list uu_list_t;
191 typedef struct uu_list_node {
192 uintptr_t uln_opaque[2];
195 typedef struct uu_list_walk uu_list_walk_t;
197 typedef uintptr_t uu_list_index_t;
203 * typedef struct foo {
205 * uu_list_node_t foo_node;
210 * foo_compare(void *l_arg, void *r_arg, void *private)
215 * if (... l greater than r ...)
217 * if (... l less than r ...)
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);
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
233 void uu_list_pool_destroy(uu_list_pool_t *);
239 * a = malloc(sizeof(*a));
240 * uu_list_node_init(a, &a->foo_list, pool);
242 * uu_list_node_fini(a, &a->foo_list, pool);
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 *);
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 */
252 void uu_list_destroy(uu_list_t *); /* list must be empty */
254 size_t uu_list_numnodes(uu_list_t *);
256 void *uu_list_first(uu_list_t *);
257 void *uu_list_last(uu_list_t *);
259 void *uu_list_next(uu_list_t *, void *);
260 void *uu_list_prev(uu_list_t *, void *);
262 int uu_list_walk(uu_list_t *, uu_walk_fn_t *, void *, uint32_t);
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 *);
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);
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);
274 void *uu_list_teardown(uu_list_t *, void **);
276 void uu_list_remove(uu_list_t *, void *);
279 * lists: interfaces for non-sorted lists only
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);
285 * avl trees: opaque structures
287 typedef struct uu_avl_pool uu_avl_pool_t;
288 typedef struct uu_avl uu_avl_t;
290 typedef struct uu_avl_node {
292 uintptr_t uan_opaque[3];
294 uintptr_t uan_opaque[4];
298 typedef struct uu_avl_walk uu_avl_walk_t;
300 typedef uintptr_t uu_avl_index_t;
303 * avl trees: interface
306 * typedef struct foo {
308 * uu_avl_node_t foo_node;
313 * foo_compare(void *l_arg, void *r_arg, void *private)
318 * if (... l greater than r ...)
320 * if (... l less than r ...)
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);
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
336 void uu_avl_pool_destroy(uu_avl_pool_t *);
342 * a = malloc(sizeof(*a));
343 * uu_avl_node_init(a, &a->foo_avl, pool);
345 * uu_avl_node_fini(a, &a->foo_avl, pool);
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 *);
351 uu_avl_t *uu_avl_create(uu_avl_pool_t *, void *_parent, uint32_t);
352 #define UU_AVL_DEBUG 0x00000001
354 void uu_avl_destroy(uu_avl_t *); /* list must be empty */
356 size_t uu_avl_numnodes(uu_avl_t *);
358 void *uu_avl_first(uu_avl_t *);
359 void *uu_avl_last(uu_avl_t *);
361 void *uu_avl_next(uu_avl_t *, void *);
362 void *uu_avl_prev(uu_avl_t *, void *);
364 int uu_avl_walk(uu_avl_t *, uu_walk_fn_t *, void *, uint32_t);
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 *);
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);
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);
376 void *uu_avl_teardown(uu_avl_t *, void **);
378 void uu_avl_remove(uu_avl_t *, void *);
384 #endif /* _LIBUUTIL_H */