xref: /freebsd/sys/contrib/openzfs/include/libuutil_impl.h (revision 38a52bd3b5cac3da6f7f6eef3dd050e6aa08ebb3)
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, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or https://opensource.org/licenses/CDDL-1.0.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
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]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef	_LIBUUTIL_IMPL_H
28 #define	_LIBUUTIL_IMPL_H
29 
30 
31 
32 #include <libuutil.h>
33 #include <pthread.h>
34 
35 #include <sys/avl_impl.h>
36 #include <sys/byteorder.h>
37 
38 #ifdef	__cplusplus
39 extern "C" {
40 #endif
41 
42 void uu_set_error(uint_t);
43 
44 
45 __attribute__((format(printf, 1, 2), __noreturn__))
46 void uu_panic(const char *format, ...);
47 
48 
49 /*
50  * For debugging purposes, libuutil keeps around linked lists of all uu_lists
51  * and uu_avls, along with pointers to their parents.  These can cause false
52  * negatives when looking for memory leaks, so we encode the pointers by
53  * storing them with swapped endianness;  this is not perfect, but it's about
54  * the best we can do without wasting a lot of space.
55  */
56 #ifdef _LP64
57 #define	UU_PTR_ENCODE(ptr)		BSWAP_64((uintptr_t)(void *)(ptr))
58 #else
59 #define	UU_PTR_ENCODE(ptr)		BSWAP_32((uintptr_t)(void *)(ptr))
60 #endif
61 
62 #define	UU_PTR_DECODE(ptr)		((void *)UU_PTR_ENCODE(ptr))
63 
64 /*
65  * uu_list structures
66  */
67 typedef struct uu_list_node_impl {
68 	struct uu_list_node_impl *uln_next;
69 	struct uu_list_node_impl *uln_prev;
70 } uu_list_node_impl_t;
71 
72 struct uu_list_walk {
73 	uu_list_walk_t	*ulw_next;
74 	uu_list_walk_t	*ulw_prev;
75 
76 	uu_list_t	*ulw_list;
77 	int8_t		ulw_dir;
78 	uint8_t		ulw_robust;
79 	uu_list_node_impl_t *ulw_next_result;
80 };
81 
82 struct uu_list {
83 	uintptr_t	ul_next_enc;
84 	uintptr_t	ul_prev_enc;
85 
86 	uu_list_pool_t	*ul_pool;
87 	uintptr_t	ul_parent_enc;	/* encoded parent pointer */
88 	size_t		ul_offset;
89 	size_t		ul_numnodes;
90 	uint8_t		ul_debug;
91 	uint8_t		ul_sorted;
92 	uint8_t		ul_index;	/* mark for uu_list_index_ts */
93 
94 	uu_list_node_impl_t ul_null_node;
95 	uu_list_walk_t	ul_null_walk;	/* for robust walkers */
96 };
97 
98 #define	UU_LIST_PTR(ptr)		((uu_list_t *)UU_PTR_DECODE(ptr))
99 
100 #define	UU_LIST_POOL_MAXNAME	64
101 
102 struct uu_list_pool {
103 	uu_list_pool_t	*ulp_next;
104 	uu_list_pool_t	*ulp_prev;
105 
106 	char		ulp_name[UU_LIST_POOL_MAXNAME];
107 	size_t		ulp_nodeoffset;
108 	size_t		ulp_objsize;
109 	uu_compare_fn_t	*ulp_cmp;
110 	uint8_t		ulp_debug;
111 	uint8_t		ulp_last_index;
112 	pthread_mutex_t	ulp_lock;		/* protects null_list */
113 	uu_list_t	ulp_null_list;
114 };
115 
116 /*
117  * uu_avl structures
118  */
119 typedef struct avl_node		uu_avl_node_impl_t;
120 
121 struct uu_avl_walk {
122 	uu_avl_walk_t	*uaw_next;
123 	uu_avl_walk_t	*uaw_prev;
124 
125 	uu_avl_t	*uaw_avl;
126 	void		*uaw_next_result;
127 	int8_t		uaw_dir;
128 	uint8_t		uaw_robust;
129 };
130 
131 struct uu_avl {
132 	uintptr_t	ua_next_enc;
133 	uintptr_t	ua_prev_enc;
134 
135 	uu_avl_pool_t	*ua_pool;
136 	uintptr_t	ua_parent_enc;
137 	uint8_t		ua_debug;
138 	uint8_t		ua_index;	/* mark for uu_avl_index_ts */
139 
140 	struct avl_tree	ua_tree;
141 	uu_avl_walk_t	ua_null_walk;
142 };
143 
144 #define	UU_AVL_PTR(x)		((uu_avl_t *)UU_PTR_DECODE(x))
145 
146 #define	UU_AVL_POOL_MAXNAME	64
147 
148 struct uu_avl_pool {
149 	uu_avl_pool_t	*uap_next;
150 	uu_avl_pool_t	*uap_prev;
151 
152 	char		uap_name[UU_AVL_POOL_MAXNAME];
153 	size_t		uap_nodeoffset;
154 	size_t		uap_objsize;
155 	uu_compare_fn_t	*uap_cmp;
156 	uint8_t		uap_debug;
157 	uint8_t		uap_last_index;
158 	pthread_mutex_t	uap_lock;		/* protects null_avl */
159 	uu_avl_t	uap_null_avl;
160 };
161 
162 /*
163  * atfork() handlers
164  */
165 void uu_avl_lockup(void);
166 void uu_avl_release(void);
167 
168 void uu_list_lockup(void);
169 void uu_list_release(void);
170 
171 #ifdef	__cplusplus
172 }
173 #endif
174 
175 #endif	/* _LIBUUTIL_IMPL_H */
176