radix.h revision 128401
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 * 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. 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: head/sys/net/radix.h 128401 2004-04-18 11:48:35Z luigi $ 31 */ 32 33#ifndef _RADIX_H_ 34#define _RADIX_H_ 35 36#ifdef _KERNEL 37#include <sys/_lock.h> 38#include <sys/_mutex.h> 39#endif 40 41#ifdef MALLOC_DECLARE 42MALLOC_DECLARE(M_RTABLE); 43#endif 44 45/* 46 * Radix search tree node layout. 47 */ 48 49struct radix_node { 50 struct radix_mask *rn_mklist; /* list of 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 caddr_t rn_Key; /* object of search */ 61 caddr_t 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 * Annotations to tree concerning potential routes applying to subtrees. 86 */ 87 88struct radix_mask { 89 short rm_bit; /* bit offset; -1-index(netmask) */ 90 char rm_unused; /* cf. rn_bmask */ 91 u_char rm_flags; /* cf. rn_flags */ 92 struct radix_mask *rm_mklist; /* more masks to try */ 93 union { 94 caddr_t rmu_mask; /* the mask */ 95 struct radix_node *rmu_leaf; /* for normal routes */ 96 } rm_rmu; 97 int rm_refs; /* # of references to this struct */ 98}; 99 100#define rm_mask rm_rmu.rmu_mask 101#define rm_leaf rm_rmu.rmu_leaf /* extra field would make 32 bytes */ 102 103typedef int walktree_f_t(struct radix_node *, void *); 104 105struct radix_node_head { 106 struct radix_node *rnh_treetop; 107 int rnh_addrsize; /* permit, but not require fixed keys */ 108 int rnh_pktsize; /* permit, but not require fixed keys */ 109 struct radix_node *(*rnh_addaddr) /* add based on sockaddr */ 110 (void *v, void *mask, 111 struct radix_node_head *head, struct radix_node nodes[]); 112 struct radix_node *(*rnh_addpkt) /* add based on packet hdr */ 113 (void *v, void *mask, 114 struct radix_node_head *head, struct radix_node nodes[]); 115 struct radix_node *(*rnh_deladdr) /* remove based on sockaddr */ 116 (void *v, void *mask, struct radix_node_head *head); 117 struct radix_node *(*rnh_delpkt) /* remove based on packet hdr */ 118 (void *v, void *mask, struct radix_node_head *head); 119 struct radix_node *(*rnh_matchaddr) /* locate based on sockaddr */ 120 (void *v, struct radix_node_head *head); 121 struct radix_node *(*rnh_lookup) /* locate based on sockaddr */ 122 (void *v, void *mask, struct radix_node_head *head); 123 struct radix_node *(*rnh_matchpkt) /* locate based on packet hdr */ 124 (void *v, struct radix_node_head *head); 125 int (*rnh_walktree) /* traverse tree */ 126 (struct radix_node_head *head, walktree_f_t *f, void *w); 127 int (*rnh_walktree_from) /* traverse tree below a */ 128 (struct radix_node_head *head, void *a, void *m, 129 walktree_f_t *f, void *w); 130 void (*rnh_close) /* do something when the last ref drops */ 131 (struct radix_node *rn, struct radix_node_head *head); 132 struct radix_node rnh_nodes[3]; /* empty tree for common case */ 133#ifdef _KERNEL 134 struct mtx rnh_mtx; /* locks entire radix tree */ 135#endif 136}; 137 138#ifndef _KERNEL 139#define R_Malloc(p, t, n) (p = (t) malloc((unsigned int)(n))) 140#define R_Zalloc(p, t, n) (p = (t) calloc(1,(unsigned int)(n))) 141#define Free(p) free((char *)p); 142#else 143#define R_Malloc(p, t, n) (p = (t) malloc((unsigned long)(n), M_RTABLE, M_NOWAIT)) 144#define R_Zalloc(p, t, n) (p = (t) malloc((unsigned long)(n), M_RTABLE, M_NOWAIT | M_ZERO)) 145#define Free(p) free((caddr_t)p, M_RTABLE); 146 147#define RADIX_NODE_HEAD_LOCK_INIT(rnh) \ 148 mtx_init(&(rnh)->rnh_mtx, "radix node head", NULL, MTX_DEF | MTX_RECURSE) 149#define RADIX_NODE_HEAD_LOCK(rnh) mtx_lock(&(rnh)->rnh_mtx) 150#define RADIX_NODE_HEAD_UNLOCK(rnh) mtx_unlock(&(rnh)->rnh_mtx) 151#define RADIX_NODE_HEAD_DESTROY(rnh) mtx_destroy(&(rnh)->rnh_mtx) 152#define RADIX_NODE_HEAD_LOCK_ASSERT(rnh) mtx_assert(&(rnh)->rnh_mtx, MA_OWNED) 153#endif /* _KERNEL */ 154 155void rn_init(void); 156int rn_inithead(void **, int); 157int rn_refines(void *, void *); 158struct radix_node 159 *rn_addmask(void *, int, int), 160 *rn_addroute (void *, void *, struct radix_node_head *, 161 struct radix_node [2]), 162 *rn_delete(void *, void *, struct radix_node_head *), 163 *rn_lookup (void *v_arg, void *m_arg, 164 struct radix_node_head *head), 165 *rn_match(void *, struct radix_node_head *); 166 167#endif /* _RADIX_H_ */ 168