1/*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1988, 1989, 1993 5 * The Regents of the University of California. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. Neither the name of the University nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 */ 31 32#ifndef _RADIX_H_ 33#define _RADIX_H_ 34 35#ifdef _KERNEL 36#include <sys/_lock.h> 37#include <sys/_mutex.h> 38#include <sys/_rmlock.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 103struct radix_head; 104 105typedef int walktree_f_t(struct radix_node *, void *); 106typedef struct radix_node *rn_matchaddr_f_t(const void *v, 107 struct radix_head *head); 108typedef struct radix_node *rn_addaddr_f_t(void *v, const void *mask, 109 struct radix_head *head, struct radix_node nodes[]); 110typedef struct radix_node *rn_deladdr_f_t(const void *v, const void *mask, 111 struct radix_head *head); 112typedef struct radix_node *rn_lookup_f_t(const void *v, const void *mask, 113 struct radix_head *head); 114typedef int rn_walktree_t(struct radix_head *head, walktree_f_t *f, 115 void *w); 116typedef int rn_walktree_from_t(struct radix_head *head, 117 void *a, void *m, walktree_f_t *f, void *w); 118typedef void rn_close_t(struct radix_node *rn, struct radix_head *head); 119struct radix_node *rn_nextprefix(struct radix_node *rn); 120 121struct radix_mask_head; 122 123struct radix_head { 124 struct radix_node *rnh_treetop; 125 struct radix_mask_head *rnh_masks; /* Storage for our masks */ 126}; 127 128struct radix_node_head { 129 struct radix_head rh; 130 rn_matchaddr_f_t *rnh_matchaddr; /* longest match for sockaddr */ 131 rn_addaddr_f_t *rnh_addaddr; /* add based on sockaddr*/ 132 rn_deladdr_f_t *rnh_deladdr; /* remove based on sockaddr */ 133 rn_lookup_f_t *rnh_lookup; /* exact match for sockaddr */ 134 rn_walktree_t *rnh_walktree; /* traverse tree */ 135 rn_walktree_from_t *rnh_walktree_from; /* traverse tree below a */ 136 rn_close_t *rnh_close; /*do something when the last ref drops*/ 137 struct radix_node rnh_nodes[3]; /* empty tree for common case */ 138#ifdef _KERNEL 139 struct rmlock rnh_lock; /* locks entire radix tree */ 140#endif 141}; 142 143struct radix_mask_head { 144 struct radix_head head; 145 struct radix_node mask_nodes[3]; 146}; 147 148void rn_inithead_internal(struct radix_head *rh, struct radix_node *base_nodes, 149 int off); 150 151#ifndef _KERNEL 152#define R_Malloc(p, t, n) (p = (t) malloc((unsigned int)(n))) 153#define R_Zalloc(p, t, n) (p = (t) calloc(1,(unsigned int)(n))) 154#define R_Free(p) free((char *)p); 155#else 156#define R_Malloc(p, t, n) (p = (t) malloc((unsigned long)(n), M_RTABLE, M_NOWAIT)) 157#define R_Zalloc(p, t, n) (p = (t) malloc((unsigned long)(n), M_RTABLE, M_NOWAIT | M_ZERO)) 158#define R_Free(p) free((caddr_t)p, M_RTABLE); 159 160#define RADIX_NODE_HEAD_RLOCK_TRACKER struct rm_priotracker _rnh_tracker 161#define RADIX_NODE_HEAD_LOCK_INIT(rnh) \ 162 rm_init(&(rnh)->rnh_lock, "radix node head") 163#define RADIX_NODE_HEAD_LOCK(rnh) rm_wlock(&(rnh)->rnh_lock) 164#define RADIX_NODE_HEAD_UNLOCK(rnh) rm_wunlock(&(rnh)->rnh_lock) 165#define RADIX_NODE_HEAD_RLOCK(rnh) rm_rlock(&(rnh)->rnh_lock,\ 166 &_rnh_tracker) 167#define RADIX_NODE_HEAD_RUNLOCK(rnh) rm_runlock(&(rnh)->rnh_lock,\ 168 &_rnh_tracker) 169#define RADIX_NODE_HEAD_DESTROY(rnh) rm_destroy(&(rnh)->rnh_lock) 170#define RADIX_NODE_HEAD_LOCK_ASSERT(rnh) rm_assert(&(rnh)->rnh_lock, RA_LOCKED) 171#define RADIX_NODE_HEAD_WLOCK_ASSERT(rnh) rm_assert(&(rnh)->rnh_lock, RA_WLOCKED) 172#endif /* _KERNEL */ 173 174int rn_inithead(void **, int); 175int rn_detachhead(void **); 176int rn_refines(const void *, const void *); 177struct radix_node *rn_addroute(void *, const void *, struct radix_head *, 178 struct radix_node[2]); 179struct radix_node *rn_delete(const void *, const void *, struct radix_head *); 180struct radix_node *rn_lookup (const void *v_arg, const void *m_arg, 181 struct radix_head *head); 182struct radix_node *rn_match(const void *, struct radix_head *); 183int rn_walktree_from(struct radix_head *h, void *a, void *m, 184 walktree_f_t *f, void *w); 185int rn_walktree(struct radix_head *, walktree_f_t *, void *); 186 187#endif /* _RADIX_H_ */ 188