1 /* 2 * Copyright 2006 Sun Microsystems, Inc. All rights reserved. 3 * Use is subject to license terms. 4 * 5 * Copyright (c) 1988, 1989, 1993 6 * The Regents of the University of California. All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 4. Neither the name of the University nor the names of its contributors 17 * may be used to endorse or promote products derived from this software 18 * without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * @(#)radix.h 8.2 (Berkeley) 10/31/94 33 * $FreeBSD: /repoman/r/ncvs/src/sys/net/radix.h,v 1.25.2.1 2005/01/31 23:26:23 34 * imp Exp $ 35 */ 36 37 #ifndef _RADIX_H_ 38 #define _RADIX_H_ 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 #ifdef _KERNEL 45 #include <sys/mutex.h> 46 #include <netinet/in.h> 47 #endif 48 #include <sys/sysmacros.h> 49 50 #ifdef MALLOC_DECLARE 51 MALLOC_DECLARE(M_RTABLE); 52 #endif 53 54 /* 55 * Radix search tree node layout. 56 */ 57 58 struct radix_node { 59 struct radix_mask *rn_mklist; /* list of masks contained in subtree */ 60 struct radix_node *rn_parent; /* parent */ 61 short rn_bit; /* bit offset; -1-index(netmask) */ 62 char rn_bmask; /* node: mask for bit test */ 63 uchar_t rn_flags; /* enumerated next */ 64 #define RNF_NORMAL 1 /* leaf contains normal route */ 65 #define RNF_ROOT 2 /* leaf is root leaf for tree */ 66 #define RNF_ACTIVE 4 /* This node is alive (for rtfree) */ 67 union { 68 struct { /* leaf only data: */ 69 caddr_t rn_Key; /* object of search */ 70 caddr_t rn_Mask; /* netmask, if present */ 71 struct radix_node *rn_Dupedkey; 72 } rn_leaf; 73 struct { /* node only data: */ 74 int rn_Off; /* where to start compare */ 75 struct radix_node *rn_L; /* progeny */ 76 struct radix_node *rn_R; /* progeny */ 77 } rn_node; 78 } rn_u; 79 }; 80 81 82 #define rn_dupedkey rn_u.rn_leaf.rn_Dupedkey 83 #define rn_key rn_u.rn_leaf.rn_Key 84 #define rn_mask rn_u.rn_leaf.rn_Mask 85 #define rn_offset rn_u.rn_node.rn_Off 86 #define rn_left rn_u.rn_node.rn_L 87 #define rn_right rn_u.rn_node.rn_R 88 89 /* 90 * Annotations to tree concerning potential routes applying to subtrees. 91 */ 92 93 struct radix_mask { 94 short rm_bit; /* bit offset; -1-index(netmask) */ 95 char rm_unused; /* cf. rn_bmask */ 96 uchar_t rm_flags; /* cf. rn_flags */ 97 struct radix_mask *rm_mklist; /* more masks to try */ 98 union { 99 caddr_t rmu_mask; /* the mask */ 100 struct radix_node *rmu_leaf; /* for normal routes */ 101 } rm_rmu; 102 int rm_refs; /* # of references to this struct */ 103 }; 104 105 #define rm_mask rm_rmu.rmu_mask 106 #define rm_leaf rm_rmu.rmu_leaf /* extra field would make 32 bytes */ 107 108 typedef int walktree_f_t(struct radix_node *, void *); 109 typedef boolean_t match_leaf_t(struct radix_node *, void *); 110 typedef void (*lockf_t)(struct radix_node *); 111 112 struct radix_node_head { 113 struct radix_node *rnh_treetop; 114 int rnh_addrsize; /* permit, but not require fixed keys */ 115 int rnh_pktsize; /* permit, but not require fixed keys */ 116 struct radix_node *(*rnh_addaddr) /* add based on sockaddr */ 117 (void *v, void *mask, 118 struct radix_node_head *head, struct radix_node nodes[]); 119 struct radix_node *(*rnh_addpkt) /* add based on packet hdr */ 120 (void *v, void *mask, 121 struct radix_node_head *head, struct radix_node nodes[]); 122 struct radix_node *(*rnh_deladdr) /* remove based on sockaddr */ 123 (void *v, void *mask, struct radix_node_head *head); 124 struct radix_node *(*rnh_delpkt) /* remove based on packet hdr */ 125 (void *v, void *mask, struct radix_node_head *head); 126 struct radix_node *(*rnh_matchaddr) /* locate based on sockaddr */ 127 (void *v, struct radix_node_head *head); 128 /* rnh_matchaddr_args: locate based on sockaddr and match_leaf_t() */ 129 struct radix_node *(*rnh_matchaddr_args) 130 (void *v, struct radix_node_head *head, 131 match_leaf_t *f, void *w); 132 struct radix_node *(*rnh_lookup) /* locate based on sockaddr */ 133 (void *v, void *mask, struct radix_node_head *head); 134 struct radix_node *(*rnh_matchpkt) /* locate based on packet hdr */ 135 (void *v, struct radix_node_head *head); 136 int (*rnh_walktree) /* traverse tree */ 137 (struct radix_node_head *head, walktree_f_t *f, void *w); 138 int (*rnh_walktree_mt) /* traverse tree */ 139 (struct radix_node_head *head, walktree_f_t *f, void *w, 140 lockf_t lockf, lockf_t unlockf); 141 /* rn_walktree_mt: MT safe version of rn_walktree */ 142 int (*rnh_walktree_from) /* traverse tree below a */ 143 (struct radix_node_head *head, void *a, void *m, 144 walktree_f_t *f, void *w); 145 void (*rnh_close) /* do something when the last ref drops */ 146 (struct radix_node *rn, struct radix_node_head *head); 147 struct radix_node rnh_nodes[3]; /* empty tree for common case */ 148 #ifdef _KERNEL 149 krwlock_t rnh_lock; /* locks entire radix tree */ 150 #endif 151 }; 152 153 #ifdef _KERNEL 154 /* 155 * BSD's sockaddr_in and sockadr have a sin_len and an sa_len 156 * field respectively, as the first field in the structure, and 157 * everything in radix.c assumes that the first byte of the "varg" 158 * passed in tells the length of the key (the sockaddr). 159 * 160 * Since Solaris' sockaddr_in and sockadr, do not have these fields, we 161 * define a BSD4-like sockaddr_in structure with rt_sin_len field to 162 * make LEN macro wn radix.c to work correctly for Solaris 163 * See comments around LEN() macro in ip/radix.c 164 * The callers of functions of radix.c have to use this data structure 165 */ 166 struct rt_sockaddr { 167 uint8_t rt_sin_len; 168 uint8_t rt_sin_family; 169 uint16_t rt_sin_port; 170 struct in_addr rt_sin_addr; 171 char rt_sin_zero[8]; 172 }; 173 174 175 #define R_Malloc(p, c, n) p = kmem_cache_alloc((c), KM_NOSLEEP) 176 #define R_Zalloc(p, c, n) \ 177 if (p = kmem_cache_alloc((c), KM_NOSLEEP)) {\ 178 bzero(p, n); \ 179 } 180 #define R_ZallocSleep(p, t, n) p = (t) kmem_zalloc(n, KM_SLEEP) 181 #define Free(p, c) kmem_cache_free(c, p) 182 #define FreeHead(p, n) kmem_free(p, n) 183 184 typedef struct radix_node rn_t; 185 typedef struct radix_mask rmsk_t; 186 typedef struct radix_node_head rnh_t; 187 typedef struct rt_sockaddr rt_sa_t; 188 189 #define RADIX_NODE_HEAD_LOCK_INIT(rnh) \ 190 rw_init(&(rnh)->rnh_lock, NULL, RW_DEFAULT, NULL) 191 #define RADIX_NODE_HEAD_RLOCK(rnh) rw_enter(&(rnh)->rnh_lock, RW_READER) 192 #define RADIX_NODE_HEAD_WLOCK(rnh) rw_enter(&(rnh)->rnh_lock, RW_WRITER) 193 #define RADIX_NODE_HEAD_UNLOCK(rnh) rw_exit(&(rnh)->rnh_lock) 194 #define RADIX_NODE_HEAD_DESTROY(rnh) rw_destroy(&(rnh)->rnh_lock) 195 #define RADIX_NODE_HEAD_LOCK_ASSERT(rnh) RW_WRITE_HELD(&(rnh)->rnh_lock) 196 197 #else /* _KERNEL */ 198 199 #define R_Malloc(p, t, n) (p = malloc((unsigned int)(n))) 200 #define R_Zalloc(p, t, n) (p = calloc(1, (unsigned int)(n))) 201 #define R_ZallocSleep(p, t, n) R_Zalloc(p, t, n) 202 #define Free(p, c) free((char *)p); /* c is ignored */ 203 #ifndef RADIX_NODE_HEAD_RLOCK 204 #define RADIX_NODE_HEAD_RLOCK(x) /* */ 205 #endif 206 #ifndef RADIX_NODE_HEAD_WLOCK 207 #define RADIX_NODE_HEAD_WLOCK(x) /* */ 208 #endif 209 #ifndef RADIX_NODE_HEAD_UNLOCK 210 #define RADIX_NODE_HEAD_UNLOCK(x) /* */ 211 #endif 212 213 #endif /* _KERNEL */ 214 215 #ifndef min 216 #define min MIN 217 #endif 218 #ifndef max 219 #define max MAX 220 #endif 221 222 void rn_init(void); 223 void rn_fini(void); 224 int rn_inithead(void **, int); 225 int rn_freenode(struct radix_node *, void *); 226 void rn_freehead(struct radix_node_head *); 227 228 #ifdef __cplusplus 229 } 230 #endif 231 232 #endif /* _RADIX_H_ */ 233