2 * Copyright (c) 1988, 1989, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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 * 4. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * @(#)radix.h 8.2 (Berkeley) 10/31/94
37 #include <sys/_lock.h>
38 #include <sys/_mutex.h>
39 #include <sys/_rwlock.h>
43 MALLOC_DECLARE(M_RTABLE);
47 * Radix search tree node layout.
51 struct radix_mask *rn_mklist; /* list of masks contained in subtree */
52 struct radix_node *rn_parent; /* parent */
53 short rn_bit; /* bit offset; -1-index(netmask) */
54 char rn_bmask; /* node: mask for bit test*/
55 u_char rn_flags; /* enumerated next */
56 #define RNF_NORMAL 1 /* leaf contains normal route */
57 #define RNF_ROOT 2 /* leaf is root leaf for tree */
58 #define RNF_ACTIVE 4 /* This node is alive (for rtfree) */
60 struct { /* leaf only data: */
61 caddr_t rn_Key; /* object of search */
62 caddr_t rn_Mask; /* netmask, if present */
63 struct radix_node *rn_Dupedkey;
65 struct { /* node only data: */
66 int rn_Off; /* where to start compare */
67 struct radix_node *rn_L;/* progeny */
68 struct radix_node *rn_R;/* progeny */
73 struct radix_node *rn_twin;
74 struct radix_node *rn_ybro;
78 #define rn_dupedkey rn_u.rn_leaf.rn_Dupedkey
79 #define rn_key rn_u.rn_leaf.rn_Key
80 #define rn_mask rn_u.rn_leaf.rn_Mask
81 #define rn_offset rn_u.rn_node.rn_Off
82 #define rn_left rn_u.rn_node.rn_L
83 #define rn_right rn_u.rn_node.rn_R
86 * Annotations to tree concerning potential routes applying to subtrees.
90 short rm_bit; /* bit offset; -1-index(netmask) */
91 char rm_unused; /* cf. rn_bmask */
92 u_char rm_flags; /* cf. rn_flags */
93 struct radix_mask *rm_mklist; /* more masks to try */
95 caddr_t rmu_mask; /* the mask */
96 struct radix_node *rmu_leaf; /* for normal routes */
98 int rm_refs; /* # of references to this struct */
101 #define rm_mask rm_rmu.rmu_mask
102 #define rm_leaf rm_rmu.rmu_leaf /* extra field would make 32 bytes */
104 typedef int walktree_f_t(struct radix_node *, void *);
106 struct radix_node_head {
107 struct radix_node *rnh_treetop;
108 int rnh_addrsize; /* permit, but not require fixed keys */
109 int rnh_pktsize; /* permit, but not require fixed keys */
110 struct radix_node *(*rnh_addaddr) /* add based on sockaddr */
111 (void *v, void *mask,
112 struct radix_node_head *head, struct radix_node nodes[]);
113 struct radix_node *(*rnh_addpkt) /* add based on packet hdr */
114 (void *v, void *mask,
115 struct radix_node_head *head, struct radix_node nodes[]);
116 struct radix_node *(*rnh_deladdr) /* remove based on sockaddr */
117 (void *v, void *mask, struct radix_node_head *head);
118 struct radix_node *(*rnh_delpkt) /* remove based on packet hdr */
119 (void *v, void *mask, struct radix_node_head *head);
120 struct radix_node *(*rnh_matchaddr) /* locate based on sockaddr */
121 (void *v, struct radix_node_head *head);
122 struct radix_node *(*rnh_lookup) /* locate based on sockaddr */
123 (void *v, void *mask, struct radix_node_head *head);
124 struct radix_node *(*rnh_matchpkt) /* locate based on packet hdr */
125 (void *v, struct radix_node_head *head);
126 int (*rnh_walktree) /* traverse tree */
127 (struct radix_node_head *head, walktree_f_t *f, void *w);
128 int (*rnh_walktree_from) /* traverse tree below a */
129 (struct radix_node_head *head, void *a, void *m,
130 walktree_f_t *f, void *w);
131 void (*rnh_close) /* do something when the last ref drops */
132 (struct radix_node *rn, struct radix_node_head *head);
133 struct radix_node rnh_nodes[3]; /* empty tree for common case */
134 int rnh_multipath; /* multipath capable ? */
136 struct rwlock rnh_lock; /* locks entire radix tree */
141 #define R_Malloc(p, t, n) (p = (t) malloc((unsigned int)(n)))
142 #define R_Zalloc(p, t, n) (p = (t) calloc(1,(unsigned int)(n)))
143 #define Free(p) free((char *)p);
145 #define R_Malloc(p, t, n) (p = (t) malloc((unsigned long)(n), M_RTABLE, M_NOWAIT))
146 #define R_Zalloc(p, t, n) (p = (t) malloc((unsigned long)(n), M_RTABLE, M_NOWAIT | M_ZERO))
147 #define Free(p) free((caddr_t)p, M_RTABLE);
149 #define RADIX_NODE_HEAD_LOCK_INIT(rnh) \
150 rw_init_flags(&(rnh)->rnh_lock, "radix node head", 0)
151 #define RADIX_NODE_HEAD_LOCK(rnh) rw_wlock(&(rnh)->rnh_lock)
152 #define RADIX_NODE_HEAD_UNLOCK(rnh) rw_wunlock(&(rnh)->rnh_lock)
153 #define RADIX_NODE_HEAD_RLOCK(rnh) rw_rlock(&(rnh)->rnh_lock)
154 #define RADIX_NODE_HEAD_RUNLOCK(rnh) rw_runlock(&(rnh)->rnh_lock)
155 #define RADIX_NODE_HEAD_LOCK_TRY_UPGRADE(rnh) rw_try_upgrade(&(rnh)->rnh_lock)
158 #define RADIX_NODE_HEAD_DESTROY(rnh) rw_destroy(&(rnh)->rnh_lock)
159 #define RADIX_NODE_HEAD_LOCK_ASSERT(rnh) rw_assert(&(rnh)->rnh_lock, RA_LOCKED)
160 #define RADIX_NODE_HEAD_WLOCK_ASSERT(rnh) rw_assert(&(rnh)->rnh_lock, RA_WLOCKED)
164 int rn_inithead(void **, int);
165 int rn_detachhead(void **);
166 int rn_refines(void *, void *);
168 *rn_addmask(void *, int, int),
169 *rn_addroute (void *, void *, struct radix_node_head *,
170 struct radix_node [2]),
171 *rn_delete(void *, void *, struct radix_node_head *),
172 *rn_lookup (void *v_arg, void *m_arg,
173 struct radix_node_head *head),
174 *rn_match(void *, struct radix_node_head *);
176 #endif /* _RADIX_H_ */