radix.h revision 55205
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: head/sys/net/radix.h 55205 1999-12-29 04:46:21Z peter $ 35 */ 36 37#ifndef _RADIX_H_ 38#define _RADIX_H_ 39 40#ifdef MALLOC_DECLARE 41MALLOC_DECLARE(M_RTABLE); 42#endif 43 44/* 45 * Radix search tree node layout. 46 */ 47 48struct radix_node { 49 struct radix_mask *rn_mklist; /* list of masks contained in subtree */ 50 struct radix_node *rn_p; /* parent */ 51 short rn_b; /* bit offset; -1-index(netmask) */ 52 char rn_bmask; /* node: mask for bit test*/ 53 u_char rn_flags; /* enumerated next */ 54#define RNF_NORMAL 1 /* leaf contains normal route */ 55#define RNF_ROOT 2 /* leaf is root leaf for tree */ 56#define RNF_ACTIVE 4 /* This node is alive (for rtfree) */ 57 union { 58 struct { /* leaf only data: */ 59 caddr_t rn_Key; /* object of search */ 60 caddr_t rn_Mask; /* netmask, if present */ 61 struct radix_node *rn_Dupedkey; 62 } rn_leaf; 63 struct { /* node only data: */ 64 int rn_Off; /* where to start compare */ 65 struct radix_node *rn_L;/* progeny */ 66 struct radix_node *rn_R;/* progeny */ 67 } rn_node; 68 } rn_u; 69#ifdef RN_DEBUG 70 int rn_info; 71 struct radix_node *rn_twin; 72 struct radix_node *rn_ybro; 73#endif 74}; 75 76#define rn_dupedkey rn_u.rn_leaf.rn_Dupedkey 77#define rn_key rn_u.rn_leaf.rn_Key 78#define rn_mask rn_u.rn_leaf.rn_Mask 79#define rn_off rn_u.rn_node.rn_Off 80#define rn_l rn_u.rn_node.rn_L 81#define rn_r rn_u.rn_node.rn_R 82 83/* 84 * Annotations to tree concerning potential routes applying to subtrees. 85 */ 86 87struct radix_mask { 88 short rm_b; /* bit offset; -1-index(netmask) */ 89 char rm_unused; /* cf. rn_bmask */ 90 u_char rm_flags; /* cf. rn_flags */ 91 struct radix_mask *rm_mklist; /* more masks to try */ 92 union { 93 caddr_t rmu_mask; /* the mask */ 94 struct radix_node *rmu_leaf; /* for normal routes */ 95 } rm_rmu; 96 int rm_refs; /* # of references to this struct */ 97}; 98 99#define rm_mask rm_rmu.rmu_mask 100#define rm_leaf rm_rmu.rmu_leaf /* extra field would make 32 bytes */ 101 102#define MKGet(m) {\ 103 if (rn_mkfreelist) {\ 104 m = rn_mkfreelist; \ 105 rn_mkfreelist = (m)->rm_mklist; \ 106 } else \ 107 R_Malloc(m, struct radix_mask *, sizeof (*(m))); }\ 108 109#define MKFree(m) { (m)->rm_mklist = rn_mkfreelist; rn_mkfreelist = (m);} 110 111typedef int walktree_f_t __P((struct radix_node *, void *)); 112 113struct radix_node_head { 114 struct radix_node *rnh_treetop; 115 int rnh_addrsize; /* permit, but not require fixed keys */ 116 int rnh_pktsize; /* permit, but not require fixed keys */ 117 struct radix_node *(*rnh_addaddr) /* add based on sockaddr */ 118 __P((void *v, void *mask, 119 struct radix_node_head *head, struct radix_node nodes[])); 120 struct radix_node *(*rnh_addpkt) /* add based on packet hdr */ 121 __P((void *v, void *mask, 122 struct radix_node_head *head, struct radix_node nodes[])); 123 struct radix_node *(*rnh_deladdr) /* remove based on sockaddr */ 124 __P((void *v, void *mask, struct radix_node_head *head)); 125 struct radix_node *(*rnh_delpkt) /* remove based on packet hdr */ 126 __P((void *v, void *mask, struct radix_node_head *head)); 127 struct radix_node *(*rnh_matchaddr) /* locate based on sockaddr */ 128 __P((void *v, struct radix_node_head *head)); 129 struct radix_node *(*rnh_lookup) /* locate based on sockaddr */ 130 __P((void *v, void *mask, struct radix_node_head *head)); 131 struct radix_node *(*rnh_matchpkt) /* locate based on packet hdr */ 132 __P((void *v, struct radix_node_head *head)); 133 int (*rnh_walktree) /* traverse tree */ 134 __P((struct radix_node_head *head, walktree_f_t *f, void *w)); 135 int (*rnh_walktree_from) /* traverse tree below a */ 136 __P((struct radix_node_head *head, void *a, void *m, 137 walktree_f_t *f, void *w)); 138 void (*rnh_close) /* do something when the last ref drops */ 139 __P((struct radix_node *rn, struct radix_node_head *head)); 140 struct radix_node rnh_nodes[3]; /* empty tree for common case */ 141}; 142 143#ifndef _KERNEL 144#define Bcmp(a, b, n) bcmp(((char *)(a)), ((char *)(b)), (n)) 145#define Bcopy(a, b, n) bcopy(((char *)(a)), ((char *)(b)), (unsigned)(n)) 146#define Bzero(p, n) bzero((char *)(p), (int)(n)); 147#define R_Malloc(p, t, n) (p = (t) malloc((unsigned int)(n))) 148#define Free(p) free((char *)p); 149#else 150#define Bcmp(a, b, n) bcmp(((caddr_t)(a)), ((caddr_t)(b)), (unsigned)(n)) 151#define Bcopy(a, b, n) bcopy(((caddr_t)(a)), ((caddr_t)(b)), (unsigned)(n)) 152#define Bzero(p, n) bzero((caddr_t)(p), (unsigned)(n)); 153#define R_Malloc(p, t, n) (p = (t) malloc((unsigned long)(n), M_RTABLE, M_DONTWAIT)) 154#define Free(p) free((caddr_t)p, M_RTABLE); 155#endif /* _KERNEL */ 156 157void rn_init __P((void)); 158int rn_inithead __P((void **, int)); 159int rn_refines __P((void *, void *)); 160struct radix_node 161 *rn_addmask __P((void *, int, int)), 162 *rn_addroute __P((void *, void *, struct radix_node_head *, 163 struct radix_node [2])), 164 *rn_delete __P((void *, void *, struct radix_node_head *)), 165 *rn_lookup __P((void *v_arg, void *m_arg, 166 struct radix_node_head *head)), 167 *rn_match __P((void *, struct radix_node_head *)); 168 169 170#endif /* _RADIX_H_ */ 171