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. 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. 16 * 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 27 * SUCH DAMAGE. 28 * 29 * @(#)radix.h 8.2 (Berkeley) 10/31/94 30 * $FreeBSD: src/sys/net/radix.h,v 1.16.2.1 2000/05/03 19:17:11 wollman Exp $ 31 * $DragonFly: src/sys/net/radix.h,v 1.12 2006/09/05 03:48:12 dillon Exp $ 32 */ 33 34 #ifndef _NET_RADIX_H_ 35 #define _NET_RADIX_H_ 36 37 #ifndef _SYS_TYPES_H_ 38 #include <sys/types.h> 39 #endif 40 41 #ifdef MALLOC_DECLARE 42 MALLOC_DECLARE(M_RTABLE); 43 #endif 44 45 /* 46 * Radix search tree node layout. 47 */ 48 49 struct radix_node { 50 struct radix_mask *rn_mklist; /* masks contained in subtree */ 51 struct radix_node *rn_parent; /* parent */ 52 short rn_bit; /* bit offset; -1-index(netmask) */ 53 char rn_bmask; /* node: mask for bit test*/ 54 u_char rn_flags; /* enumerated next */ 55 #define RNF_NORMAL 1 /* leaf contains normal route */ 56 #define RNF_ROOT 2 /* leaf is root leaf for tree */ 57 #define RNF_ACTIVE 4 /* This node is alive (for rtfree) */ 58 union { 59 struct { /* leaf only data: */ 60 char *rn_Key; /* object of search */ 61 char *rn_Mask; /* netmask, if present */ 62 struct radix_node *rn_Dupedkey; 63 } rn_leaf; 64 struct { /* node only data: */ 65 int rn_Off; /* where to start compare */ 66 struct radix_node *rn_L;/* progeny */ 67 struct radix_node *rn_R;/* progeny */ 68 } rn_node; 69 } rn_u; 70 #ifdef RN_DEBUG 71 int rn_info; 72 struct radix_node *rn_twin; 73 struct radix_node *rn_ybro; 74 #endif 75 }; 76 77 #define rn_dupedkey rn_u.rn_leaf.rn_Dupedkey 78 #define rn_key rn_u.rn_leaf.rn_Key 79 #define rn_mask rn_u.rn_leaf.rn_Mask 80 #define rn_offset rn_u.rn_node.rn_Off 81 #define rn_left rn_u.rn_node.rn_L 82 #define rn_right rn_u.rn_node.rn_R 83 84 /* 85 * We do this statically now because the dynamic initialization 86 * occurs too late and has an ordering problem w/ pf preloads 87 * vs protocol domains. 88 */ 89 #define RN_MAXKEYLEN 32 90 #define RN_MAXKEYONES { -1, -1, -1, -1, -1, -1, -1, -1, \ 91 -1, -1, -1, -1, -1, -1, -1, -1, \ 92 -1, -1, -1, -1, -1, -1, -1, -1, \ 93 -1, -1, -1, -1, -1, -1, -1, -1 } 94 95 /* 96 * Annotations to tree concerning potential routes applying to subtrees. 97 */ 98 99 struct radix_mask { 100 short rm_bit; /* bit offset; -1-index(netmask) */ 101 char rm_unused; /* cf. rn_bmask */ 102 u_char rm_flags; /* cf. rn_flags */ 103 struct radix_mask *rm_next; /* list of more masks to try */ 104 union { 105 caddr_t rmu_mask; /* the mask */ 106 struct radix_node *rmu_leaf; /* for normal routes */ 107 } rm_rmu; 108 int rm_refs; /* # of references to this struct */ 109 }; 110 111 #define rm_mask rm_rmu.rmu_mask 112 #define rm_leaf rm_rmu.rmu_leaf /* extra field would make 32 bytes */ 113 114 typedef int walktree_f_t (struct radix_node *, void *); 115 116 struct radix_node_head { 117 struct radix_node *rnh_treetop; 118 119 /* add based on sockaddr */ 120 struct radix_node *(*rnh_addaddr) 121 (char *key, char *mask, 122 struct radix_node_head *head, struct radix_node nodes[]); 123 124 /* remove based on sockaddr */ 125 struct radix_node *(*rnh_deladdr) 126 (char *key, char *mask, struct radix_node_head *head); 127 128 /* locate based on sockaddr */ 129 struct radix_node *(*rnh_matchaddr) 130 (char *key, struct radix_node_head *head); 131 132 /* locate based on sockaddr */ 133 struct radix_node *(*rnh_lookup) 134 (char *key, char *mask, struct radix_node_head *head); 135 136 /* traverse tree */ 137 int (*rnh_walktree) 138 (struct radix_node_head *head, walktree_f_t *f, void *w); 139 140 /* traverse tree below a */ 141 int (*rnh_walktree_from) 142 (struct radix_node_head *head, char *a, char *m, 143 walktree_f_t *f, void *w); 144 145 /* 146 * Do something when the last ref drops. 147 * A (*rnh_close)() routine 148 * can clear RTF_UP 149 * can remove a route from the radix tree 150 * cannot change the reference count 151 * cannot deallocate the route 152 */ 153 void (*rnh_close) 154 (struct radix_node *rn, struct radix_node_head *head); 155 156 struct radix_node rnh_nodes[3]; /* empty tree for common case */ 157 158 int rnh_last_zeroed; /* mask last zeroed length */ 159 160 /* unused entries */ 161 int rnh_pktsize; /* permit, but not require fixed keys */ 162 struct radix_node *(*rnh_addpkt) /* add based on packet hdr */ 163 (void *v, char *mask, 164 struct radix_node_head *head, struct radix_node nodes[]); 165 struct radix_node *(*rnh_delpkt) /* remove based on packet hdr */ 166 (void *v, char *mask, struct radix_node_head *head); 167 168 /* traverse tree starting from a */ 169 int (*rnh_walktree_at) 170 (struct radix_node_head *head, const char *a, const char *m, 171 walktree_f_t *f, void *w); 172 173 struct radix_node_head *rnh_maskhead; 174 }; 175 176 #ifndef _KERNEL 177 #define R_Malloc(p, t, n) (p = (t) malloc((n))) 178 #define Free(p) free(p); 179 #else 180 #define R_Malloc(p, t, n) (p = (t) kmalloc((n), M_RTABLE, M_INTWAIT | M_NULLOK)) 181 #define Free(p) kfree(p, M_RTABLE); 182 #endif 183 184 void rn_init (void); 185 int rn_inithead (void **, struct radix_node_head *, int); 186 struct radix_node_head *rn_cpumaskhead(int cpu); 187 __boolean_t rn_refines (char *, char *); 188 struct radix_node *rn_addmask (char *, __boolean_t, int, 189 struct radix_node_head *), 190 *rn_addroute (char *, char *, struct radix_node_head *, 191 struct radix_node [2]), 192 *rn_delete (char *, char *, struct radix_node_head *), 193 *rn_lookup (char *key, char *mask, 194 struct radix_node_head *head), 195 *rn_match (char *, struct radix_node_head *); 196 197 #endif /* _NET_RADIX_H_ */ 198