xref: /titanic_51/usr/src/uts/common/inet/ipf/radix_ipf.h (revision f808c858fa61e7769218966759510a8b1190dfcf)
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  *
14  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  *	@(#)radix.h	8.2 (Berkeley) 10/31/94
27  */
28 
29 #if !defined(_NET_RADIX_H_) && !defined(_RADIX_H_)
30 #define	_NET_RADIX_H_
31 #ifndef _RADIX_H_
32 #define	_RADIX_H_
33 #endif /* _RADIX_H_ */
34 
35 #ifndef __P
36 # ifdef __STDC__
37 #  define	__P(x)  x
38 # else
39 #  define	__P(x)  ()
40 # endif
41 #endif
42 
43 #if defined(__sgi)
44 # define	radix_mask	ipf_radix_mask
45 # define	radix_node	ipf_radix_node
46 # define	radix_node_head	ipf_radix_node_head
47 #endif
48 
49 /*
50  * Radix search tree node layout.
51  */
52 
53 struct radix_node {
54 	struct	radix_mask *rn_mklist;	/* list of masks contained in subtree */
55 	struct	radix_node *rn_p;	/* parent */
56 	short	rn_b;			/* bit offset; -1-index(netmask) */
57 	char	rn_bmask;		/* node: mask for bit test*/
58 	u_char	rn_flags;		/* enumerated next */
59 #define RNF_NORMAL	1		/* leaf contains normal route */
60 #define RNF_ROOT	2		/* leaf is root leaf for tree */
61 #define RNF_ACTIVE	4		/* This node is alive (for rtfree) */
62 	union {
63 		struct {			/* leaf only data: */
64 			caddr_t rn_Key;		/* object of search */
65 			caddr_t rn_Mask;	/* netmask, if present */
66 			struct	radix_node *rn_Dupedkey;
67 		} rn_leaf;
68 		struct {			/* node only data: */
69 			int	rn_Off;		/* where to start compare */
70 			struct	radix_node *rn_L;/* progeny */
71 			struct	radix_node *rn_R;/* progeny */
72 		} rn_node;
73 	} rn_u;
74 #ifdef RN_DEBUG
75 	int rn_info;
76 	struct radix_node *rn_twin;
77 	struct radix_node *rn_ybro;
78 #endif
79 };
80 
81 #define rn_dupedkey rn_u.rn_leaf.rn_Dupedkey
82 #define rn_key rn_u.rn_leaf.rn_Key
83 #define rn_mask rn_u.rn_leaf.rn_Mask
84 #define rn_off rn_u.rn_node.rn_Off
85 #define rn_l rn_u.rn_node.rn_L
86 #define rn_r rn_u.rn_node.rn_R
87 
88 /*
89  * Annotations to tree concerning potential routes applying to subtrees.
90  */
91 
92 struct radix_mask {
93 	short	rm_b;			/* bit offset; -1-index(netmask) */
94 	char	rm_unused;		/* cf. rn_bmask */
95 	u_char	rm_flags;		/* cf. rn_flags */
96 	struct	radix_mask *rm_mklist;	/* more masks to try */
97 	union	{
98 		caddr_t	rmu_mask;		/* the mask */
99 		struct	radix_node *rmu_leaf;	/* for normal routes */
100 	}	rm_rmu;
101 	int	rm_refs;		/* # of references to this struct */
102 };
103 
104 #define rm_mask rm_rmu.rmu_mask
105 #define rm_leaf rm_rmu.rmu_leaf		/* extra field would make 32 bytes */
106 
107 #define MKGet(m) {\
108 	if (rn_mkfreelist) {\
109 		m = rn_mkfreelist; \
110 		rn_mkfreelist = (m)->rm_mklist; \
111 	} else \
112 		R_Malloc(m, struct radix_mask *, sizeof (*(m))); }\
113 
114 #define MKFree(m) { (m)->rm_mklist = rn_mkfreelist; rn_mkfreelist = (m);}
115 
116 struct radix_node_head {
117 	struct	radix_node *rnh_treetop;
118 	struct	radix_node *rnh_leaflist;
119 	u_long	rnh_hits;
120 	u_int	rnh_number;
121 	u_int	rnh_ref;
122 	int	rnh_addrsize;		/* permit, but not require fixed keys */
123 	int	rnh_pktsize;		/* permit, but not require fixed keys */
124 	struct	radix_node *(*rnh_addaddr)	/* add based on sockaddr */
125 		__P((void *v, void *mask,
126 		     struct radix_node_head *head, struct radix_node nodes[]));
127 	struct	radix_node *(*rnh_addpkt)	/* add based on packet hdr */
128 		__P((void *v, void *mask,
129 		     struct radix_node_head *head, struct radix_node nodes[]));
130 	struct	radix_node *(*rnh_deladdr)	/* remove based on sockaddr */
131 		__P((void *v, void *mask, struct radix_node_head *head));
132 	struct	radix_node *(*rnh_delpkt)	/* remove based on packet hdr */
133 		__P((void *v, void *mask, struct radix_node_head *head));
134 	struct	radix_node *(*rnh_matchaddr)	/* locate based on sockaddr */
135 		__P((void *v, struct radix_node_head *head));
136 	struct	radix_node *(*rnh_lookup)	/* locate based on sockaddr */
137 		__P((void *v, void *mask, struct radix_node_head *head));
138 	struct	radix_node *(*rnh_matchpkt)	/* locate based on packet hdr */
139 		__P((void *v, struct radix_node_head *head));
140 	int	(*rnh_walktree)			/* traverse tree */
141 		__P((struct radix_node_head *,
142 		     int (*)(struct radix_node *, void *), void *));
143 	struct	radix_node rnh_nodes[3];	/* empty tree for common case */
144 };
145 
146 
147 #if defined(AIX)
148 # undef Bcmp
149 # undef Bzero
150 # undef R_Malloc
151 # undef Free
152 #endif
153 #define Bcmp(a, b, n)	bcmp(((caddr_t)(a)), ((caddr_t)(b)), (unsigned)(n))
154 #if defined(linux) && defined(_KERNEL)
155 # define Bcopy(a, b, n)	memmove(((caddr_t)(b)), ((caddr_t)(a)), (unsigned)(n))
156 #else
157 # define Bcopy(a, b, n)	bcopy(((caddr_t)(a)), ((caddr_t)(b)), (unsigned)(n))
158 #endif
159 #define Bzero(p, n)		bzero((caddr_t)(p), (unsigned)(n));
160 #define R_Malloc(p, t, n)	KMALLOCS(p, t, n)
161 #define FreeS(p, z)		KFREES(p, z)
162 #define Free(p)			KFREE(p)
163 
164 #if (defined(__osf__) || defined(AIX) || (IRIX >= 60516)) && defined(_KERNEL)
165 # define	rn_init		ipf_rn_init
166 # define	rn_fini		ipf_rn_fini
167 # define	rn_inithead	ipf_rn_inithead
168 # define	rn_freehead	ipf_rn_freehead
169 # define	rn_inithead0	ipf_rn_inithead0
170 # define	rn_refines	ipf_rn_refines
171 # define	rn_walktree	ipf_rn_walktree
172 # define	rn_addmask	ipf_rn_addmask
173 # define	rn_addroute	ipf_rn_addroute
174 # define	rn_delete	ipf_rn_delete
175 # define	rn_insert	ipf_rn_insert
176 # define	rn_lookup	ipf_rn_lookup
177 # define	rn_match	ipf_rn_match
178 # define	rn_newpair	ipf_rn_newpair
179 # define	rn_search	ipf_rn_search
180 # define	rn_search_m	ipf_rn_search_m
181 # define	max_keylen	ipf_maxkeylen
182 # define	rn_mkfreelist	ipf_rn_mkfreelist
183 # define	rn_zeros	ipf_rn_zeros
184 # define	rn_ones		ipf_rn_ones
185 # define	rn_satisfies_leaf	ipf_rn_satisfies_leaf
186 # define	rn_lexobetter	ipf_rn_lexobetter
187 # define	rn_new_radix_mask	ipf_rn_new_radix_mask
188 # define	rn_freenode	ipf_rn_freenode
189 #endif
190 
191 void	 rn_init __P((void));
192 void	 rn_fini __P((void));
193 int	 rn_inithead __P((void **, int));
194 void	 rn_freehead __P((struct radix_node_head *));
195 int	 rn_inithead0 __P((struct radix_node_head *, int));
196 int	 rn_refines __P((void *, void *));
197 int	 rn_walktree __P((struct radix_node_head *,
198 			  int (*)(struct radix_node *, void *), void *));
199 struct radix_node
200 	 *rn_addmask __P((void *, int, int)),
201 	 *rn_addroute __P((void *, void *, struct radix_node_head *,
202 			struct radix_node [2])),
203 	 *rn_delete __P((void *, void *, struct radix_node_head *)),
204 	 *rn_insert __P((void *, struct radix_node_head *, int *,
205 			struct radix_node [2])),
206 	 *rn_lookup __P((void *, void *, struct radix_node_head *)),
207 	 *rn_match __P((void *, struct radix_node_head *)),
208 	 *rn_newpair __P((void *, int, struct radix_node[2])),
209 	 *rn_search __P((void *, struct radix_node *)),
210 	 *rn_search_m __P((void *, struct radix_node *, void *));
211 
212 #endif /* _NET_RADIX_H_ */
213