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  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgment:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)radix.h	8.2 (Berkeley) 10/31/94
34  *
35  * $FreeBSD: src/sbin/routed/radix.h,v 1.4 1999/08/28 00:14:17 peter Exp $
36  */
37 
38 #ifndef __RADIX_H_
39 #define	__RADIX_H_
40 
41 /* ANSI */
42 #ifndef __P
43 #define __P(protos) protos
44 #endif
45 
46 #include <netinet/in.h>
47 
48 struct radix_sockaddr_in {
49   u_char  sin_len;
50   u_char  sin_family;
51   unsigned short sin_port;
52   struct  in_addr sin_addr;
53   char    sin_zero[8];
54 };
55 
56 
57 struct walkarg;
58 
59 /*
60  * Radix search tree node layout.
61  */
62 
63 struct radix_node {
64 	struct	radix_mask *rn_mklist;	/* list of masks contained in subtree */
65 	struct	radix_node *rn_p;	/* parent */
66 	short	rn_b;			/* bit offset; -1-index(netmask) */
67 	char	rn_bmask;		/* node: mask for bit test*/
68 	u_char	rn_flags;		/* enumerated next */
69 #define RNF_NORMAL	1		/* leaf contains normal route */
70 #define RNF_ROOT	2		/* leaf is root leaf for tree */
71 #define RNF_ACTIVE	4		/* This node is alive (for rtfree) */
72 	union {
73 		struct {			/* leaf only data: */
74 			caddr_t	rn_Key;	/* object of search */
75 			caddr_t	rn_Mask;	/* netmask, if present */
76 			struct	radix_node *rn_Dupedkey;
77 		} rn_leaf;
78 		struct {			/* node only data: */
79 			int	rn_Off;		/* where to start compare */
80 			struct	radix_node *rn_L;/* progeny */
81 			struct	radix_node *rn_R;/* progeny */
82 		}rn_node;
83 	}		rn_u;
84 #ifdef RN_DEBUG
85 	int rn_info;
86 	struct radix_node *rn_twin;
87 	struct radix_node *rn_ybro;
88 #endif
89 };
90 
91 #define rn_dupedkey rn_u.rn_leaf.rn_Dupedkey
92 #define rn_key rn_u.rn_leaf.rn_Key
93 #define rn_mask rn_u.rn_leaf.rn_Mask
94 #define rn_off rn_u.rn_node.rn_Off
95 #define rn_l rn_u.rn_node.rn_L
96 #define rn_r rn_u.rn_node.rn_R
97 
98 /*
99  * Annotations to tree concerning potential routes applying to subtrees.
100  */
101 
102 extern struct radix_mask {
103 	short	rm_b;			/* bit offset; -1-index(netmask) */
104 	char	rm_unused;		/* cf. rn_bmask */
105 	u_char	rm_flags;		/* cf. rn_flags */
106 	struct	radix_mask *rm_mklist;	/* more masks to try */
107 	union	{
108 		caddr_t	rmu_mask;		/* the mask */
109 		struct	radix_node *rmu_leaf;	/* for normal routes */
110 	}	rm_rmu;
111 	int	rm_refs;		/* # of references to this struct */
112 } *rn_mkfreelist;
113 
114 #define rm_mask rm_rmu.rmu_mask
115 #define rm_leaf rm_rmu.rmu_leaf		/* extra field would make 32 bytes */
116 
117 #define MKGet(m) {\
118 	if (rn_mkfreelist) {\
119 		m = rn_mkfreelist; \
120 		rn_mkfreelist = (m)->rm_mklist; \
121 	} else \
122 		m = (struct radix_mask *)rtmalloc(sizeof(*(m)), "MKGet"); }\
123 
124 #define MKFree(m) { (m)->rm_mklist = rn_mkfreelist; rn_mkfreelist = (m);}
125 
126 struct radix_node_head {
127 	struct	radix_node *rnh_treetop;
128 	int	rnh_addrsize;		/* permit, but not require fixed keys */
129 	int	rnh_pktsize;		/* permit, but not require fixed keys */
130 	struct	radix_node *(*rnh_addaddr)	/* add based on sockaddr */
131 		__P((void *v, void *mask,
132 		     struct radix_node_head *head, struct radix_node nodes[]));
133 	struct	radix_node *(*rnh_addpkt)	/* add based on packet hdr */
134 		__P((void *v, void *mask,
135 		     struct radix_node_head *head, struct radix_node nodes[]));
136 	struct	radix_node *(*rnh_deladdr)	/* remove based on sockaddr */
137 		__P((void *v, void *mask, struct radix_node_head *head));
138 	struct	radix_node *(*rnh_delpkt)	/* remove based on packet hdr */
139 		__P((void *v, void *mask, struct radix_node_head *head));
140 	struct	radix_node *(*rnh_matchaddr)	/* locate based on sockaddr */
141 		__P((void *v, struct radix_node_head *head));
142 	struct	radix_node *(*rnh_lookup)	/* locate based on sockaddr */
143 		__P((void *v, void *mask, struct radix_node_head *head));
144 	struct	radix_node *(*rnh_matchpkt)	/* locate based on packet hdr */
145 		__P((void *v, struct radix_node_head *head));
146 	int	(*rnh_walktree)			/* traverse tree */
147 			(struct radix_node_head *head,
148 			 int (*f)(struct radix_node *, struct walkarg *),
149 			 struct walkarg *w);
150 	struct	radix_node rnh_nodes[3];	/* empty tree for common case */
151 };
152 
153 
154 #define Bcmp(a, b, n) memcmp(((void *)(a)), ((void *)(b)), (n))
155 #define Bcopy(a, b, n) memmove(((void *)(b)), ((void *)(a)), (size_t)(n))
156 #define Bzero(p, n) memset((void *)(p), 0, (size_t)(n));
157 #define Free(p) free((void *)p);
158 
159 void	 rn_init __P((void));
160 int	 rn_inithead __P((void **, int));
161 int	 rn_refines __P((void *, void *));
162 int	 rn_walktree __P((struct radix_node_head *,
163 		     int (*)__P((struct radix_node *, struct walkarg *)),
164 		     struct walkarg *));
165 
166 struct radix_node
167 	 *rn_addmask __P((void *, int, int)),
168 	 *rn_addroute __P((void *, void *, struct radix_node_head *,
169 			struct radix_node [2])),
170 	 *rn_delete __P((void *, void *, struct radix_node_head *)),
171 	 *rn_insert __P((void *, struct radix_node_head *, int *,
172 			struct radix_node [2])),
173 	 *rn_match __P((void *, struct radix_node_head *)),
174 	 *rn_newpair __P((void *, int, struct radix_node[2])),
175 	 *rn_search __P((void *, struct radix_node *)),
176 	 *rn_search_m __P((void *, struct radix_node *, void *));
177 
178 struct radix_node *rn_lookup __P((void *, void *, struct radix_node_head *));
179 
180 #endif /* __RADIX_H_ */
181