xref: /freebsd/sbin/routed/radix.h (revision 734e82fe33aa764367791a7d603b383996c6b40b)
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  *	@(#)radix.h	8.2 (Berkeley) 10/31/94
32  */
33 
34 #ifndef __RADIX_H_
35 #define	__RADIX_H_
36 
37 #include <sys/cdefs.h>
38 struct walkarg;
39 
40 /*
41  * Radix search tree node layout.
42  */
43 
44 struct radix_node {
45 	struct	radix_mask *rn_mklist;	/* list of masks contained in subtree */
46 	struct	radix_node *rn_p;	/* parent */
47 	short	rn_b;			/* bit offset; -1-index(netmask) */
48 	char	rn_bmask;		/* node: mask for bit test*/
49 	u_char	rn_flags;		/* enumerated next */
50 #define RNF_NORMAL	1		/* leaf contains normal route */
51 #define RNF_ROOT	2		/* leaf is root leaf for tree */
52 #define RNF_ACTIVE	4		/* This node is alive (for rtfree) */
53 	union {
54 		struct {			/* leaf only data: */
55 			caddr_t	rn_Key;	/* object of search */
56 			caddr_t	rn_Mask;	/* netmask, if present */
57 			struct	radix_node *rn_Dupedkey;
58 		} rn_leaf;
59 		struct {			/* node only data: */
60 			int	rn_Off;		/* where to start compare */
61 			struct	radix_node *rn_L;/* progeny */
62 			struct	radix_node *rn_R;/* progeny */
63 		}rn_node;
64 	}		rn_u;
65 #ifdef RN_DEBUG
66 	int rn_info;
67 	struct radix_node *rn_twin;
68 	struct radix_node *rn_ybro;
69 #endif
70 };
71 
72 #define rn_dupedkey rn_u.rn_leaf.rn_Dupedkey
73 #define rn_key rn_u.rn_leaf.rn_Key
74 #define rn_mask rn_u.rn_leaf.rn_Mask
75 #define rn_off rn_u.rn_node.rn_Off
76 #define rn_l rn_u.rn_node.rn_L
77 #define rn_r rn_u.rn_node.rn_R
78 
79 /*
80  * Annotations to tree concerning potential routes applying to subtrees.
81  */
82 
83 struct radix_mask {
84 	short	rm_b;			/* bit offset; -1-index(netmask) */
85 	char	rm_unused;		/* cf. rn_bmask */
86 	u_char	rm_flags;		/* cf. rn_flags */
87 	struct	radix_mask *rm_mklist;	/* more masks to try */
88 	union	{
89 		caddr_t	rmu_mask;		/* the mask */
90 		struct	radix_node *rmu_leaf;	/* for normal routes */
91 	}	rm_rmu;
92 	int	rm_refs;		/* # of references to this struct */
93 };
94 
95 #define rm_mask rm_rmu.rmu_mask
96 #define rm_leaf rm_rmu.rmu_leaf		/* extra field would make 32 bytes */
97 
98 #define MKGet(m) {\
99 	if (rn_mkfreelist) {\
100 		m = rn_mkfreelist; \
101 		rn_mkfreelist = (m)->rm_mklist; \
102 	} else \
103 		m = (struct radix_mask *)rtmalloc(sizeof(*(m)), "MKGet"); }\
104 
105 #define MKFree(m) { (m)->rm_mklist = rn_mkfreelist; rn_mkfreelist = (m);}
106 
107 struct radix_node_head {
108 	struct	radix_node *rnh_treetop;
109 	int	rnh_addrsize;		/* permit, but not require fixed keys */
110 	int	rnh_pktsize;		/* permit, but not require fixed keys */
111 	struct	radix_node *(*rnh_addaddr)	/* add based on sockaddr */
112 		(void *v, void *mask,
113 		     struct radix_node_head *head, struct radix_node nodes[]);
114 	struct	radix_node *(*rnh_addpkt)	/* add based on packet hdr */
115 		(void *v, void *mask,
116 		     struct radix_node_head *head, struct radix_node nodes[]);
117 	struct	radix_node *(*rnh_deladdr)	/* remove based on sockaddr */
118 		(void *v, void *mask, struct radix_node_head *head);
119 	struct	radix_node *(*rnh_delpkt)	/* remove based on packet hdr */
120 		(void *v, void *mask, struct radix_node_head *head);
121 	struct	radix_node *(*rnh_matchaddr)	/* locate based on sockaddr */
122 		(void *v, struct radix_node_head *head);
123 	struct	radix_node *(*rnh_lookup)	/* locate based on sockaddr */
124 		(void *v, void *mask, struct radix_node_head *head);
125 	struct	radix_node *(*rnh_matchpkt)	/* locate based on packet hdr */
126 		(void *v, struct radix_node_head *head);
127 	int	(*rnh_walktree)			/* traverse tree */
128 			(struct radix_node_head *head,
129 			 int (*f)(struct radix_node *, struct walkarg *),
130 			 struct walkarg *w);
131 	struct	radix_node rnh_nodes[3];	/* empty tree for common case */
132 };
133 
134 
135 #define Bcopy(a, b, n) memmove(((void *)(b)), ((void *)(a)), (size_t)(n))
136 #define Bzero(p, n) memset((void *)(p), 0, (size_t)(n));
137 #define Free(p) free((void *)p);
138 
139 void	 rn_init(void);
140 int	 rn_inithead(struct radix_node_head **head, int off);
141 int	 rn_walktree(struct radix_node_head *,
142 		     int (*)(struct radix_node *, struct walkarg *),
143 		     struct walkarg *);
144 
145 #endif /* __RADIX_H_ */
146