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) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
29 #include <sys/types.h>
38 * Standard flags codes.
43 * Standard error codes.
45 #define UU_ERROR_NONE 0 /* no error */
46 #define UU_ERROR_INVALID_ARGUMENT 1 /* invalid argument */
47 #define UU_ERROR_UNKNOWN_FLAG 2 /* passed flag invalid */
48 #define UU_ERROR_NO_MEMORY 3 /* out of memory */
49 #define UU_ERROR_CALLBACK_FAILED 4 /* callback-initiated error */
50 #define UU_ERROR_NOT_SUPPORTED 5 /* operation not supported */
51 #define UU_ERROR_EMPTY 6 /* no value provided */
52 #define UU_ERROR_UNDERFLOW 7 /* value is too small */
53 #define UU_ERROR_OVERFLOW 8 /* value is too value */
54 #define UU_ERROR_INVALID_CHAR 9 /* value contains unexpected char */
55 #define UU_ERROR_INVALID_DIGIT 10 /* value contains digit not in base */
57 #define UU_ERROR_SYSTEM 99 /* underlying system error */
58 #define UU_ERROR_UNKNOWN 100 /* error status not known */
61 * Standard program exit codes.
63 #define UU_EXIT_OK (*(uu_exit_ok()))
64 #define UU_EXIT_FATAL (*(uu_exit_fatal()))
65 #define UU_EXIT_USAGE (*(uu_exit_usage()))
68 * Exit status profiles.
70 #define UU_PROFILE_DEFAULT 0
71 #define UU_PROFILE_LAUNCHER 1
74 * Error reporting functions.
76 uint32_t uu_error(void);
77 const char *uu_strerror(uint32_t);
80 * Program notification functions.
82 extern void uu_alt_exit(int);
83 extern const char *uu_setpname(char *);
84 extern const char *uu_getpname(void);
86 extern void uu_warn(const char *, ...);
87 extern void uu_vwarn(const char *, va_list);
89 extern void uu_die(const char *, ...) __NORETURN;
90 extern void uu_vdie(const char *, va_list) __NORETURN;
92 extern void uu_xdie(int, const char *, ...) __NORETURN;
93 extern void uu_vxdie(int, const char *, va_list) __NORETURN;
96 * Exit status functions (not to be used directly)
98 extern int *uu_exit_ok(void);
99 extern int *uu_exit_fatal(void);
100 extern int *uu_exit_usage(void);
103 * string->number conversions
105 extern int uu_strtoint(const char *, void *, size_t, int, int64_t, int64_t);
106 extern int uu_strtouint(const char *, void *, size_t, int, uint64_t, uint64_t);
109 * Debug print facility functions.
111 typedef struct uu_dprintf uu_dprintf_t;
120 } uu_dprintf_severity_t;
122 extern uu_dprintf_t *uu_dprintf_create(const char *, uu_dprintf_severity_t,
125 extern void uu_dprintf(uu_dprintf_t *, uu_dprintf_severity_t,
127 extern void uu_dprintf_destroy(uu_dprintf_t *);
128 extern const char *uu_dprintf_getname(uu_dprintf_t *);
131 * Identifier test flags and function.
133 #define UU_NAME_DOMAIN 0x1 /* allow SUNW, or com.sun, prefix */
134 #define UU_NAME_PATH 0x2 /* allow '/'-delimited paths */
136 int uu_check_name(const char *, uint_t);
139 * File creation functions.
141 extern int uu_open_tmp(const char *dir, uint_t uflags);
144 * Convenience functions.
146 #define UU_NELEM(a) (sizeof (a) / sizeof ((a)[0]))
149 extern char *uu_msprintf(const char *format, ...);
150 extern void *uu_zalloc(size_t);
151 extern char *uu_strdup(const char *);
152 extern void uu_free(void *);
154 extern boolean_t uu_strcaseeq(const char *a, const char *b);
155 extern boolean_t uu_streq(const char *a, const char *b);
156 extern char *uu_strndup(const char *s, size_t n);
157 extern boolean_t uu_strbw(const char *a, const char *b);
158 extern void *uu_memdup(const void *buf, size_t sz);
159 extern void uu_dump(FILE *out, const char *prefix, const void *buf, size_t len);
162 * Comparison function type definition.
163 * Developers should be careful in their use of the _private argument. If you
164 * break interface guarantees, you get undefined behavior.
166 typedef int uu_compare_fn_t(const void *__left, const void *__right,
170 * Walk variant flags.
171 * A data structure need not provide support for all variants and
172 * combinations. Refer to the appropriate documentation.
174 #define UU_WALK_ROBUST 0x00000001 /* walk can survive removes */
175 #define UU_WALK_REVERSE 0x00000002 /* reverse walk order */
177 #define UU_WALK_PREORDER 0x00000010 /* walk tree in pre-order */
178 #define UU_WALK_POSTORDER 0x00000020 /* walk tree in post-order */
181 * Walk callback function return codes.
183 #define UU_WALK_ERROR -1
184 #define UU_WALK_NEXT 0
185 #define UU_WALK_DONE 1
188 * Walk callback function type definition.
190 typedef int uu_walk_fn_t(void *_elem, void *_private);
193 * lists: opaque structures
195 typedef struct uu_list_pool uu_list_pool_t;
196 typedef struct uu_list uu_list_t;
198 typedef struct uu_list_node {
199 uintptr_t uln_opaque[2];
202 typedef struct uu_list_walk uu_list_walk_t;
204 typedef uintptr_t uu_list_index_t;
210 * typedef struct foo {
212 * uu_list_node_t foo_node;
217 * foo_compare(void *l_arg, void *r_arg, void *private)
222 * if (... l greater than r ...)
224 * if (... l less than r ...)
230 * // at initialization time
231 * foo_pool = uu_list_pool_create("foo_pool",
232 * sizeof (foo_t), offsetof(foo_t, foo_node), foo_compare,
233 * debugging? 0 : UU_AVL_POOL_DEBUG);
236 uu_list_pool_t *uu_list_pool_create(const char *, size_t, size_t,
237 uu_compare_fn_t *, uint32_t);
238 #define UU_LIST_POOL_DEBUG 0x00000001
240 void uu_list_pool_destroy(uu_list_pool_t *);
246 * a = malloc(sizeof(*a));
247 * uu_list_node_init(a, &a->foo_list, pool);
249 * uu_list_node_fini(a, &a->foo_list, pool);
252 void uu_list_node_init(void *, uu_list_node_t *, uu_list_pool_t *);
253 void uu_list_node_fini(void *, uu_list_node_t *, uu_list_pool_t *);
255 uu_list_t *uu_list_create(uu_list_pool_t *, void *_parent, uint32_t);
256 #define UU_LIST_DEBUG 0x00000001
257 #define UU_LIST_SORTED 0x00000002 /* list is sorted */
259 void uu_list_destroy(uu_list_t *); /* list must be empty */
261 size_t uu_list_numnodes(uu_list_t *);
263 void *uu_list_first(uu_list_t *);
264 void *uu_list_last(uu_list_t *);
266 void *uu_list_next(uu_list_t *, void *);
267 void *uu_list_prev(uu_list_t *, void *);
269 int uu_list_walk(uu_list_t *, uu_walk_fn_t *, void *, uint32_t);
271 uu_list_walk_t *uu_list_walk_start(uu_list_t *, uint32_t);
272 void *uu_list_walk_next(uu_list_walk_t *);
273 void uu_list_walk_end(uu_list_walk_t *);
275 void *uu_list_find(uu_list_t *, void *, void *, uu_list_index_t *);
276 void uu_list_insert(uu_list_t *, void *, uu_list_index_t);
278 void *uu_list_nearest_next(uu_list_t *, uu_list_index_t);
279 void *uu_list_nearest_prev(uu_list_t *, uu_list_index_t);
281 void *uu_list_teardown(uu_list_t *, void **);
283 void uu_list_remove(uu_list_t *, void *);
286 * lists: interfaces for non-sorted lists only
288 int uu_list_insert_before(uu_list_t *, void *_target, void *_elem);
289 int uu_list_insert_after(uu_list_t *, void *_target, void *_elem);
292 * avl trees: opaque structures
294 typedef struct uu_avl_pool uu_avl_pool_t;
295 typedef struct uu_avl uu_avl_t;
297 typedef struct uu_avl_node {
299 uintptr_t uan_opaque[3];
301 uintptr_t uan_opaque[4];
305 typedef struct uu_avl_walk uu_avl_walk_t;
307 typedef uintptr_t uu_avl_index_t;
310 * avl trees: interface
313 * typedef struct foo {
315 * uu_avl_node_t foo_node;
320 * foo_compare(void *l_arg, void *r_arg, void *private)
325 * if (... l greater than r ...)
327 * if (... l less than r ...)
333 * // at initialization time
334 * foo_pool = uu_avl_pool_create("foo_pool",
335 * sizeof (foo_t), offsetof(foo_t, foo_node), foo_compare,
336 * debugging? 0 : UU_AVL_POOL_DEBUG);
339 uu_avl_pool_t *uu_avl_pool_create(const char *, size_t, size_t,
340 uu_compare_fn_t *, uint32_t);
341 #define UU_AVL_POOL_DEBUG 0x00000001
343 void uu_avl_pool_destroy(uu_avl_pool_t *);
349 * a = malloc(sizeof(*a));
350 * uu_avl_node_init(a, &a->foo_avl, pool);
352 * uu_avl_node_fini(a, &a->foo_avl, pool);
355 void uu_avl_node_init(void *, uu_avl_node_t *, uu_avl_pool_t *);
356 void uu_avl_node_fini(void *, uu_avl_node_t *, uu_avl_pool_t *);
358 uu_avl_t *uu_avl_create(uu_avl_pool_t *, void *_parent, uint32_t);
359 #define UU_AVL_DEBUG 0x00000001
361 void uu_avl_destroy(uu_avl_t *); /* list must be empty */
363 size_t uu_avl_numnodes(uu_avl_t *);
365 void *uu_avl_first(uu_avl_t *);
366 void *uu_avl_last(uu_avl_t *);
368 void *uu_avl_next(uu_avl_t *, void *);
369 void *uu_avl_prev(uu_avl_t *, void *);
371 int uu_avl_walk(uu_avl_t *, uu_walk_fn_t *, void *, uint32_t);
373 uu_avl_walk_t *uu_avl_walk_start(uu_avl_t *, uint32_t);
374 void *uu_avl_walk_next(uu_avl_walk_t *);
375 void uu_avl_walk_end(uu_avl_walk_t *);
377 void *uu_avl_find(uu_avl_t *, void *, void *, uu_avl_index_t *);
378 void uu_avl_insert(uu_avl_t *, void *, uu_avl_index_t);
380 void *uu_avl_nearest_next(uu_avl_t *, uu_avl_index_t);
381 void *uu_avl_nearest_prev(uu_avl_t *, uu_avl_index_t);
383 void *uu_avl_teardown(uu_avl_t *, void **);
385 void uu_avl_remove(uu_avl_t *, void *);
391 #endif /* _LIBUUTIL_H */