radix.h revision 257330
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: stable/10/sys/net/radix.h 257330 2013-10-29 12:53:23Z melifaro $ 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#include <sys/_rwlock.h> 40#endif 41 42#ifdef MALLOC_DECLARE 43MALLOC_DECLARE(M_RTABLE); 44#endif 45 46/* 47 * Radix search tree node layout. 48 */ 49 50struct radix_node { 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) */ 59 union { 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; 64 } rn_leaf; 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 */ 69 } rn_node; 70 } rn_u; 71#ifdef RN_DEBUG 72 int rn_info; 73 struct radix_node *rn_twin; 74 struct radix_node *rn_ybro; 75#endif 76}; 77 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 84 85/* 86 * Annotations to tree concerning potential routes applying to subtrees. 87 */ 88 89struct radix_mask { 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 */ 94 union { 95 caddr_t rmu_mask; /* the mask */ 96 struct radix_node *rmu_leaf; /* for normal routes */ 97 } rm_rmu; 98 int rm_refs; /* # of references to this struct */ 99}; 100 101#define rm_mask rm_rmu.rmu_mask 102#define rm_leaf rm_rmu.rmu_leaf /* extra field would make 32 bytes */ 103 104typedef int walktree_f_t(struct radix_node *, void *); 105 106struct radix_node_head { 107 struct radix_node *rnh_treetop; 108 u_int rnh_gen; /* generation counter */ 109 int rnh_multipath; /* multipath capable ? */ 110 int rnh_addrsize; /* permit, but not require fixed keys */ 111 int rnh_pktsize; /* permit, but not require fixed keys */ 112 struct radix_node *(*rnh_addaddr) /* add based on sockaddr */ 113 (void *v, void *mask, 114 struct radix_node_head *head, struct radix_node nodes[]); 115 struct radix_node *(*rnh_addpkt) /* add based on packet hdr */ 116 (void *v, void *mask, 117 struct radix_node_head *head, struct radix_node nodes[]); 118 struct radix_node *(*rnh_deladdr) /* remove based on sockaddr */ 119 (void *v, void *mask, struct radix_node_head *head); 120 struct radix_node *(*rnh_delpkt) /* remove based on packet hdr */ 121 (void *v, void *mask, struct radix_node_head *head); 122 struct radix_node *(*rnh_matchaddr) /* locate based on sockaddr */ 123 (void *v, struct radix_node_head *head); 124 struct radix_node *(*rnh_lookup) /* locate based on sockaddr */ 125 (void *v, void *mask, struct radix_node_head *head); 126 struct radix_node *(*rnh_matchpkt) /* locate based on packet hdr */ 127 (void *v, struct radix_node_head *head); 128 int (*rnh_walktree) /* traverse tree */ 129 (struct radix_node_head *head, walktree_f_t *f, void *w); 130 int (*rnh_walktree_from) /* traverse tree below a */ 131 (struct radix_node_head *head, void *a, void *m, 132 walktree_f_t *f, void *w); 133 void (*rnh_close) /* do something when the last ref drops */ 134 (struct radix_node *rn, struct radix_node_head *head); 135 struct radix_node rnh_nodes[3]; /* empty tree for common case */ 136#ifdef _KERNEL 137 struct rwlock rnh_lock; /* locks entire radix tree */ 138#endif 139 struct radix_node_head *rnh_masks; /* Storage for our masks */ 140}; 141 142#ifndef _KERNEL 143#define R_Malloc(p, t, n) (p = (t) malloc((unsigned int)(n))) 144#define R_Zalloc(p, t, n) (p = (t) calloc(1,(unsigned int)(n))) 145#define Free(p) free((char *)p); 146#else 147#define R_Malloc(p, t, n) (p = (t) malloc((unsigned long)(n), M_RTABLE, M_NOWAIT)) 148#define R_Zalloc(p, t, n) (p = (t) malloc((unsigned long)(n), M_RTABLE, M_NOWAIT | M_ZERO)) 149#define Free(p) free((caddr_t)p, M_RTABLE); 150 151#define RADIX_NODE_HEAD_LOCK_INIT(rnh) \ 152 rw_init_flags(&(rnh)->rnh_lock, "radix node head", 0) 153#define RADIX_NODE_HEAD_LOCK(rnh) rw_wlock(&(rnh)->rnh_lock) 154#define RADIX_NODE_HEAD_UNLOCK(rnh) rw_wunlock(&(rnh)->rnh_lock) 155#define RADIX_NODE_HEAD_RLOCK(rnh) rw_rlock(&(rnh)->rnh_lock) 156#define RADIX_NODE_HEAD_RUNLOCK(rnh) rw_runlock(&(rnh)->rnh_lock) 157#define RADIX_NODE_HEAD_LOCK_TRY_UPGRADE(rnh) rw_try_upgrade(&(rnh)->rnh_lock) 158 159 160#define RADIX_NODE_HEAD_DESTROY(rnh) rw_destroy(&(rnh)->rnh_lock) 161#define RADIX_NODE_HEAD_LOCK_ASSERT(rnh) rw_assert(&(rnh)->rnh_lock, RA_LOCKED) 162#define RADIX_NODE_HEAD_WLOCK_ASSERT(rnh) rw_assert(&(rnh)->rnh_lock, RA_WLOCKED) 163#endif /* _KERNEL */ 164 165void rn_init(int); 166int rn_inithead(void **, int); 167int rn_detachhead(void **); 168int rn_refines(void *, void *); 169struct radix_node 170 *rn_addmask(void *, int, int), 171 *rn_addmask_r(void *, struct radix_node_head *, int, int), 172 *rn_addroute (void *, void *, struct radix_node_head *, 173 struct radix_node [2]), 174 *rn_delete(void *, void *, struct radix_node_head *), 175 *rn_lookup (void *v_arg, void *m_arg, 176 struct radix_node_head *head), 177 *rn_match(void *, struct radix_node_head *); 178 179#endif /* _RADIX_H_ */ 180