1 /*
2 * Copyright (c) 2000-2008 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28 /*
29 * Copyright (c) 1988, 1989, 1993
30 * The Regents of the University of California. All rights reserved.
31 *
32 * Redistribution and use in source and binary forms, with or without
33 * modification, are permitted provided that the following conditions
34 * are met:
35 * 1. Redistributions of source code must retain the above copyright
36 * notice, this list of conditions and the following disclaimer.
37 * 2. Redistributions in binary form must reproduce the above copyright
38 * notice, this list of conditions and the following disclaimer in the
39 * documentation and/or other materials provided with the distribution.
40 * 3. All advertising materials mentioning features or use of this software
41 * must display the following acknowledgement:
42 * This product includes software developed by the University of
43 * California, Berkeley and its contributors.
44 * 4. Neither the name of the University nor the names of its contributors
45 * may be used to endorse or promote products derived from this software
46 * without specific prior written permission.
47 *
48 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
49 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
52 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58 * SUCH DAMAGE.
59 *
60 * @(#)radix.h 8.2 (Berkeley) 10/31/94
61 * $FreeBSD: src/sys/net/radix.h,v 1.16.2.1 2000/05/03 19:17:11 wollman Exp $
62 */
63
64 #ifndef _RADIX_H_
65 #define _RADIX_H_
66
67 #include <sys/appleapiopts.h>
68 #if KERNEL_PRIVATE
69 #include <kern/kalloc.h>
70 #endif /* KERNEL_PRIVATE */
71
72 #ifdef PRIVATE
73
74 #ifdef MALLOC_DECLARE
75 MALLOC_DECLARE(M_RTABLE);
76 #endif
77
78 /*
79 * Radix search tree node layout.
80 */
81
82 struct radix_node {
83 struct radix_mask *rn_mklist; /* list of masks contained in subtree */
84 struct radix_node *rn_parent; /* parent */
85 short rn_bit; /* bit offset; -1-index(netmask) */
86 char rn_bmask; /* node: mask for bit test*/
87 u_char rn_flags; /* enumerated next */
88 #define RNF_NORMAL 1 /* leaf contains normal route */
89 #define RNF_ROOT 2 /* leaf is root leaf for tree */
90 #define RNF_ACTIVE 4 /* This node is alive (for rtfree) */
91 union {
92 struct { /* leaf only data: */
93 caddr_t rn_Key; /* object of search */
94 caddr_t rn_Mask; /* netmask, if present */
95 struct radix_node *rn_Dupedkey;
96 } rn_leaf;
97 struct { /* node only data: */
98 int rn_Off; /* where to start compare */
99 struct radix_node *rn_L;/* progeny */
100 struct radix_node *rn_R;/* progeny */
101 } rn_node;
102 } rn_u;
103 #ifdef RN_DEBUG
104 int rn_info;
105 struct radix_node *rn_twin;
106 struct radix_node *rn_ybro;
107 #endif
108
109 #if __arm__ && (__BIGGEST_ALIGNMENT__ > 4)
110 /* For the newer ARMv7k ABI where 64-bit types are 64-bit aligned, but pointers
111 * are 32-bit:
112 * Aligned to 64-bit since this is cast to rtentry, which is 64-bit aligned.
113 */
114 } __attribute__ ((aligned(8)));
115 #else
116 };
117 #endif
118
119 #define rn_dupedkey rn_u.rn_leaf.rn_Dupedkey
120 #define rn_key rn_u.rn_leaf.rn_Key
121 #define rn_mask rn_u.rn_leaf.rn_Mask
122 #define rn_offset rn_u.rn_node.rn_Off
123 #define rn_left rn_u.rn_node.rn_L
124 #define rn_right rn_u.rn_node.rn_R
125
126 /*
127 * Key storage for radix nodes.
128 */
129 #if __has_ptrcheck
130 typedef char * __indexable rn_addr_storage_t;
131 #define __RN_ADDR_STORAGE_MAX 255
132 #define __RN_GET_STORAGE(p) \
133 __unsafe_forge_bidi_indexable(char *, (p), __RN_ADDR_STORAGE_MAX)
134 #else /* !__has_ptrcheck */
135 typedef char * rn_addr_storage_t;
136 #define __RN_GET_STORAGE(p) (rn_addr_storage_t)(p)
137 #endif /* __has_ptrcheck */
138
139 __attribute__((always_inline))
140 static inline __stateful_pure
141 rn_addr_storage_t
rn_get_key(struct radix_node * rn)142 rn_get_key(struct radix_node *rn)
143 {
144 return __RN_GET_STORAGE(rn->rn_u.rn_leaf.rn_Key);
145 }
146
147 __attribute__((always_inline))
148 static inline __stateful_pure
149 rn_addr_storage_t
rn_get_mask(struct radix_node * rn)150 rn_get_mask(struct radix_node *rn)
151 {
152 return __RN_GET_STORAGE(rn->rn_u.rn_leaf.rn_Mask);
153 }
154
155 /*
156 * Annotations to tree concerning potential routes applying to subtrees.
157 */
158
159 struct radix_mask {
160 short rm_bit; /* bit offset; -1-index(netmask) */
161 char rm_unused; /* cf. rn_bmask */
162 u_char rm_flags; /* cf. rn_flags */
163 struct radix_mask *rm_mklist; /* more masks to try */
164 union {
165 caddr_t rm_mask; /* the mask */
166 struct radix_node *rm_leaf; /* for normal routes */
167 };
168 int rm_refs; /* # of references to this struct */
169 };
170
171 __attribute__((always_inline))
172 static inline __stateful_pure
173 rn_addr_storage_t
rm_get_mask(struct radix_mask * rm)174 rm_get_mask(struct radix_mask *rm)
175 {
176 return __RN_GET_STORAGE(rm->rm_mask);
177 }
178
179 #define MKGet(m) {\
180 if (rn_mkfreelist) {\
181 m = rn_mkfreelist; \
182 rn_mkfreelist = (m)->rm_mklist; \
183 } else { \
184 m = kalloc_type(struct radix_mask, Z_WAITOK_ZERO_NOFAIL); \
185 } \
186 }
187
188 #define MKFree(m) { (m)->rm_mklist = rn_mkfreelist; rn_mkfreelist = (m);}
189
190 typedef int walktree_f_t(struct radix_node *, void *);
191 typedef int rn_matchf_t(struct radix_node *, void *);
192
193 #if KERNEL_PRIVATE
194 KALLOC_TYPE_DECLARE(radix_node_head_zone);
195 #endif
196
197 struct radix_node_head {
198 struct radix_node *rnh_treetop;
199 int rnh_addrsize; /* permit, but not require fixed keys */
200 int rnh_pktsize; /* permit, but not require fixed keys */
201 struct radix_node *(*rnh_addaddr) /* add based on sockaddr */
202 (void *v, void *mask,
203 struct radix_node_head *head, struct radix_node nodes[]);
204 struct radix_node *(*rnh_addpkt) /* add based on packet hdr */
205 (void *v, void *mask,
206 struct radix_node_head *head, struct radix_node nodes[]);
207 struct radix_node *(*rnh_deladdr) /* remove based on sockaddr */
208 (void *v, void *mask, struct radix_node_head *head);
209 struct radix_node *(*rnh_delpkt) /* remove based on packet hdr */
210 (void *v, void *mask, struct radix_node_head *head);
211 struct radix_node *(*rnh_matchaddr) /* locate based on sockaddr */
212 (void *v, struct radix_node_head *head);
213 /* locate based on sockaddr and rn_matchf_t() */
214 struct radix_node *(*rnh_matchaddr_args)
215 (void *v, struct radix_node_head *head,
216 rn_matchf_t *f, void *w);
217 struct radix_node *(*rnh_lookup) /* locate based on sockaddr */
218 (void *v, void *mask, struct radix_node_head *head);
219 /* locate based on sockaddr, mask and rn_matchf_t() */
220 struct radix_node *(*rnh_lookup_args)
221 (void *v, void *mask, struct radix_node_head *head,
222 rn_matchf_t *f, void *);
223 struct radix_node *(*rnh_matchpkt) /* locate based on packet hdr */
224 (void *v, struct radix_node_head *head);
225 int (*rnh_walktree) /* traverse tree */
226 (struct radix_node_head *head, walktree_f_t *f, void *w);
227 int (*rnh_walktree_from) /* traverse tree below a */
228 (struct radix_node_head *head, void *a, void *m,
229 walktree_f_t *f, void *w);
230 void (*rnh_close) /* do something when the last ref drops */
231 (struct radix_node *rn, struct radix_node_head *head);
232 struct radix_node rnh_nodes[3]; /* empty tree for common case */
233 int rnh_cnt; /* tree dimension */
234 };
235
236 #ifndef KERNEL
237 #define Bcmp(a, b, n) bcmp(((char *)(a)), ((char *)(b)), (n))
238 #define Bcopy(a, b, n) bcopy(((char *)(a)), ((char *)(b)), (unsigned)(n))
239 #define Bzero(p, n) bzero((char *)(p), (int)(n));
240 #else
241 #define Bcmp(a, b, n) bcmp(((caddr_t)(a)), ((caddr_t)(b)), (unsigned)(n))
242 #define Bcopy(a, b, n) bcopy(((caddr_t)(a)), ((caddr_t)(b)), (unsigned)(n))
243 #define Bzero(p, n) bzero((caddr_t)(p), (unsigned)(n));
244 #endif /*KERNEL*/
245
246 void rn_init(void);
247 int rn_inithead(void **, int);
248 int rn_refines(void *, void *);
249 struct radix_node *rn_addmask(void *, int, int);
250 struct radix_node *rn_addroute(void *, void *, struct radix_node_head *,
251 struct radix_node [2]);
252 struct radix_node *rn_delete(void *, void *, struct radix_node_head *);
253 struct radix_node *rn_lookup(void *v_arg, void *m_arg, struct radix_node_head *head);
254 struct radix_node *rn_lookup_args(void *v_arg, void *m_arg, struct radix_node_head *head,
255 rn_matchf_t *, void *);
256 struct radix_node *rn_match(void *, struct radix_node_head *);
257 struct radix_node *rn_match_args(void *, struct radix_node_head *, rn_matchf_t *, void *);
258
259 #endif /* PRIVATE */
260 #endif /* _RADIX_H_ */
261