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 #include <sys/cdefs.h> 36 struct walkarg; 37 38 /* 39 * Radix search tree node layout. 40 */ 41 42 struct radix_node { 43 struct radix_mask *rn_mklist; /* list of masks contained in subtree */ 44 struct radix_node *rn_p; /* parent */ 45 short rn_b; /* bit offset; -1-index(netmask) */ 46 char rn_bmask; /* node: mask for bit test*/ 47 u_char rn_flags; /* enumerated next */ 48 #define RNF_NORMAL 1 /* leaf contains normal route */ 49 #define RNF_ROOT 2 /* leaf is root leaf for tree */ 50 #define RNF_ACTIVE 4 /* This node is alive (for rtfree) */ 51 union { 52 struct { /* leaf only data: */ 53 caddr_t rn_Key; /* object of search */ 54 caddr_t rn_Mask; /* netmask, if present */ 55 struct radix_node *rn_Dupedkey; 56 } rn_leaf; 57 struct { /* node only data: */ 58 int rn_Off; /* where to start compare */ 59 struct radix_node *rn_L;/* progeny */ 60 struct radix_node *rn_R;/* progeny */ 61 }rn_node; 62 } rn_u; 63 #ifdef RN_DEBUG 64 int rn_info; 65 struct radix_node *rn_twin; 66 struct radix_node *rn_ybro; 67 #endif 68 }; 69 70 #define rn_dupedkey rn_u.rn_leaf.rn_Dupedkey 71 #define rn_key rn_u.rn_leaf.rn_Key 72 #define rn_mask rn_u.rn_leaf.rn_Mask 73 #define rn_off rn_u.rn_node.rn_Off 74 #define rn_l rn_u.rn_node.rn_L 75 #define rn_r rn_u.rn_node.rn_R 76 77 /* 78 * Annotations to tree concerning potential routes applying to subtrees. 79 */ 80 81 struct radix_mask { 82 short rm_b; /* bit offset; -1-index(netmask) */ 83 char rm_unused; /* cf. rn_bmask */ 84 u_char rm_flags; /* cf. rn_flags */ 85 struct radix_mask *rm_mklist; /* more masks to try */ 86 union { 87 caddr_t rmu_mask; /* the mask */ 88 struct radix_node *rmu_leaf; /* for normal routes */ 89 } rm_rmu; 90 int rm_refs; /* # of references to this struct */ 91 }; 92 93 #define rm_mask rm_rmu.rmu_mask 94 #define rm_leaf rm_rmu.rmu_leaf /* extra field would make 32 bytes */ 95 96 #define MKGet(m) {\ 97 if (rn_mkfreelist) {\ 98 m = rn_mkfreelist; \ 99 rn_mkfreelist = (m)->rm_mklist; \ 100 } else \ 101 m = (struct radix_mask *)rtmalloc(sizeof(*(m)), "MKGet"); }\ 102 103 #define MKFree(m) { (m)->rm_mklist = rn_mkfreelist; rn_mkfreelist = (m);} 104 105 struct 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, 127 int (*f)(struct radix_node *, struct walkarg *), 128 struct walkarg *w); 129 struct radix_node rnh_nodes[3]; /* empty tree for common case */ 130 }; 131 132 133 #define Bcopy(a, b, n) memmove(((void *)(b)), ((void *)(a)), (size_t)(n)) 134 #define Bzero(p, n) memset((void *)(p), 0, (size_t)(n)); 135 #define Free(p) free((void *)p); 136 137 void rn_init(void); 138 int rn_inithead(struct radix_node_head **head, int off); 139 int rn_walktree(struct radix_node_head *, 140 int (*)(struct radix_node *, struct walkarg *), 141 struct walkarg *); 142 143 #endif /* __RADIX_H_ */ 144