FreeBSD/Linux Kernel Cross Reference
sys/net/radix.h
1 /*
2 * Copyright (c) 1988, 1989, 1993
3 * The Regents of the University of California. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by the University of
16 * California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 * @(#)radix.h 8.2 (Berkeley) 10/31/94
34 * $FreeBSD: releng/5.1/sys/net/radix.h 110527 2003-02-08 01:44:09Z hsu $
35 */
36
37 #ifndef _RADIX_H_
38 #define _RADIX_H_
39
40 #ifdef _KERNEL
41 #include <sys/_lock.h>
42 #include <sys/_mutex.h>
43 #endif
44
45 #ifdef MALLOC_DECLARE
46 MALLOC_DECLARE(M_RTABLE);
47 #endif
48
49 /*
50 * Radix search tree node layout.
51 */
52
53 struct radix_node {
54 struct radix_mask *rn_mklist; /* list of masks contained in subtree */
55 struct radix_node *rn_parent; /* parent */
56 short rn_bit; /* bit offset; -1-index(netmask) */
57 char rn_bmask; /* node: mask for bit test*/
58 u_char rn_flags; /* enumerated next */
59 #define RNF_NORMAL 1 /* leaf contains normal route */
60 #define RNF_ROOT 2 /* leaf is root leaf for tree */
61 #define RNF_ACTIVE 4 /* This node is alive (for rtfree) */
62 union {
63 struct { /* leaf only data: */
64 caddr_t rn_Key; /* object of search */
65 caddr_t rn_Mask; /* netmask, if present */
66 struct radix_node *rn_Dupedkey;
67 } rn_leaf;
68 struct { /* node only data: */
69 int rn_Off; /* where to start compare */
70 struct radix_node *rn_L;/* progeny */
71 struct radix_node *rn_R;/* progeny */
72 } rn_node;
73 } rn_u;
74 #ifdef RN_DEBUG
75 int rn_info;
76 struct radix_node *rn_twin;
77 struct radix_node *rn_ybro;
78 #endif
79 };
80
81 #define rn_dupedkey rn_u.rn_leaf.rn_Dupedkey
82 #define rn_key rn_u.rn_leaf.rn_Key
83 #define rn_mask rn_u.rn_leaf.rn_Mask
84 #define rn_offset rn_u.rn_node.rn_Off
85 #define rn_left rn_u.rn_node.rn_L
86 #define rn_right rn_u.rn_node.rn_R
87
88 /*
89 * Annotations to tree concerning potential routes applying to subtrees.
90 */
91
92 struct radix_mask {
93 short rm_bit; /* bit offset; -1-index(netmask) */
94 char rm_unused; /* cf. rn_bmask */
95 u_char rm_flags; /* cf. rn_flags */
96 struct radix_mask *rm_mklist; /* more masks to try */
97 union {
98 caddr_t rmu_mask; /* the mask */
99 struct radix_node *rmu_leaf; /* for normal routes */
100 } rm_rmu;
101 int rm_refs; /* # of references to this struct */
102 };
103
104 #define rm_mask rm_rmu.rmu_mask
105 #define rm_leaf rm_rmu.rmu_leaf /* extra field would make 32 bytes */
106
107 #define MKGet(m) {\
108 if (rn_mkfreelist) {\
109 m = rn_mkfreelist; \
110 rn_mkfreelist = (m)->rm_mklist; \
111 } else \
112 R_Malloc(m, struct radix_mask *, sizeof (*(m))); }\
113
114 #define MKFree(m) { (m)->rm_mklist = rn_mkfreelist; rn_mkfreelist = (m);}
115
116 typedef int walktree_f_t(struct radix_node *, void *);
117
118 struct radix_node_head {
119 struct radix_node *rnh_treetop;
120 int rnh_addrsize; /* permit, but not require fixed keys */
121 int rnh_pktsize; /* permit, but not require fixed keys */
122 struct radix_node *(*rnh_addaddr) /* add based on sockaddr */
123 (void *v, void *mask,
124 struct radix_node_head *head, struct radix_node nodes[]);
125 struct radix_node *(*rnh_addpkt) /* add based on packet hdr */
126 (void *v, void *mask,
127 struct radix_node_head *head, struct radix_node nodes[]);
128 struct radix_node *(*rnh_deladdr) /* remove based on sockaddr */
129 (void *v, void *mask, struct radix_node_head *head);
130 struct radix_node *(*rnh_delpkt) /* remove based on packet hdr */
131 (void *v, void *mask, struct radix_node_head *head);
132 struct radix_node *(*rnh_matchaddr) /* locate based on sockaddr */
133 (void *v, struct radix_node_head *head);
134 struct radix_node *(*rnh_lookup) /* locate based on sockaddr */
135 (void *v, void *mask, struct radix_node_head *head);
136 struct radix_node *(*rnh_matchpkt) /* locate based on packet hdr */
137 (void *v, struct radix_node_head *head);
138 int (*rnh_walktree) /* traverse tree */
139 (struct radix_node_head *head, walktree_f_t *f, void *w);
140 int (*rnh_walktree_from) /* traverse tree below a */
141 (struct radix_node_head *head, void *a, void *m,
142 walktree_f_t *f, void *w);
143 void (*rnh_close) /* do something when the last ref drops */
144 (struct radix_node *rn, struct radix_node_head *head);
145 struct radix_node rnh_nodes[3]; /* empty tree for common case */
146 #ifdef _KERNEL
147 struct mtx rnh_mtx; /* locks entire radix tree */
148 #endif
149 };
150
151 #ifndef _KERNEL
152 #define Bcmp(a, b, n) bcmp(((char *)(a)), ((char *)(b)), (n))
153 #define Bcopy(a, b, n) bcopy(((char *)(a)), ((char *)(b)), (unsigned)(n))
154 #define Bzero(p, n) bzero((char *)(p), (int)(n));
155 #define R_Malloc(p, t, n) (p = (t) malloc((unsigned int)(n)))
156 #define Free(p) free((char *)p);
157 #else
158 #define Bcmp(a, b, n) bcmp(((caddr_t)(a)), ((caddr_t)(b)), (unsigned)(n))
159 #define Bcopy(a, b, n) bcopy(((caddr_t)(a)), ((caddr_t)(b)), (unsigned)(n))
160 #define Bzero(p, n) bzero((caddr_t)(p), (unsigned)(n));
161 #define R_Malloc(p, t, n) (p = (t) malloc((unsigned long)(n), M_RTABLE, M_NOWAIT))
162 #define Free(p) free((caddr_t)p, M_RTABLE);
163
164 #define RADIX_NODE_HEAD_LOCK_INIT(rnh) \
165 mtx_init(&(rnh)->rnh_mtx, "radix node head", NULL, MTX_DEF | MTX_RECURSE)
166 #define RADIX_NODE_HEAD_LOCK(rnh) mtx_lock(&(rnh)->rnh_mtx)
167 #define RADIX_NODE_HEAD_UNLOCK(rnh) mtx_unlock(&(rnh)->rnh_mtx)
168 #define RADIX_NODE_HEAD_DESTROY(rnh) mtx_destroy(&(rnh)->rnh_mtx)
169 #define RADIX_NODE_HEAD_LOCK_ASSERT(rnh) mtx_assert(&(rnh)->rnh_mtx, MA_OWNED)
170 #endif /* _KERNEL */
171
172 void rn_init(void);
173 int rn_inithead(void **, int);
174 int rn_refines(void *, void *);
175 struct radix_node
176 *rn_addmask(void *, int, int),
177 *rn_addroute (void *, void *, struct radix_node_head *,
178 struct radix_node [2]),
179 *rn_delete(void *, void *, struct radix_node_head *),
180 *rn_lookup (void *v_arg, void *m_arg,
181 struct radix_node_head *head),
182 *rn_match(void *, struct radix_node_head *);
183
184 #endif /* _RADIX_H_ */
Cache object: 801016f633628c2ea4db4a47c543aa21
|