1 /* $MirOS: src/sys/net/radix.h,v 1.2 2005/03/06 21:28:17 tg Exp $	*/
2 /* $OpenBSD: radix.h,v 1.12 2004/04/25 02:48:03 itojun Exp $	*/
3 /* $NetBSD: radix.h,v 1.8 1996/02/13 22:00:37 christos Exp $	*/
4 
5 /*
6  * Copyright (c) 1988, 1989, 1993
7  *	The Regents of the University of California.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. 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 
36 #ifndef _NET_RADIX_H_
37 #define	_NET_RADIX_H_
38 
39 /*
40  * Radix search tree node layout.
41  */
42 
43 struct radix_node {
44 	struct	radix_mask *rn_mklist;	/* list of masks contained in subtree */
45 	struct	radix_node *rn_p;	/* parent */
46 	short	rn_b;			/* bit offset; -1-index(netmask) */
47 	char	rn_bmask;		/* node: mask for bit test*/
48 	u_char	rn_flags;		/* enumerated next */
49 #define RNF_NORMAL	1		/* leaf contains normal route */
50 #define RNF_ROOT	2		/* leaf is root leaf for tree */
51 #define RNF_ACTIVE	4		/* This node is alive (for rtfree) */
52 	union {
53 		struct {			/* leaf only data: */
54 			caddr_t	rn_Key;		/* object of search */
55 			caddr_t	rn_Mask;	/* netmask, if present */
56 			struct	radix_node *rn_Dupedkey;
57 		} rn_leaf;
58 		struct {			/* node only data: */
59 			int	rn_Off;		/* where to start compare */
60 			struct	radix_node *rn_L;/* progeny */
61 			struct	radix_node *rn_R;/* progeny */
62 		} rn_node;
63 	} rn_u;
64 #ifdef RN_DEBUG
65 	int rn_info;
66 	struct radix_node *rn_twin;
67 	struct radix_node *rn_ybro;
68 #endif
69 };
70 
71 #define rn_dupedkey rn_u.rn_leaf.rn_Dupedkey
72 #define rn_key rn_u.rn_leaf.rn_Key
73 #define rn_mask rn_u.rn_leaf.rn_Mask
74 #define rn_off rn_u.rn_node.rn_Off
75 #define rn_l rn_u.rn_node.rn_L
76 #define rn_r rn_u.rn_node.rn_R
77 
78 /*
79  * Annotations to tree concerning potential routes applying to subtrees.
80  */
81 
82 extern struct radix_mask {
83 	short	rm_b;			/* bit offset; -1-index(netmask) */
84 	char	rm_unused;		/* cf. rn_bmask */
85 	u_char	rm_flags;		/* cf. rn_flags */
86 	struct	radix_mask *rm_mklist;	/* more masks to try */
87 	union	{
88 		caddr_t	rmu_mask;		/* the mask */
89 		struct	radix_node *rmu_leaf;	/* for normal routes */
90 	}	rm_rmu;
91 	int	rm_refs;		/* # of references to this struct */
92 } *rn_mkfreelist;
93 
94 #define rm_mask rm_rmu.rmu_mask
95 #define rm_leaf rm_rmu.rmu_leaf		/* extra field would make 32 bytes */
96 
97 #define MKGet(m) {\
98 	if (rn_mkfreelist) {\
99 		m = rn_mkfreelist; \
100 		rn_mkfreelist = (m)->rm_mklist; \
101 	} else \
102 		R_Malloc(m, struct radix_mask *, sizeof (*(m))); }\
103 
104 #define MKFree(m) { (m)->rm_mklist = rn_mkfreelist; rn_mkfreelist = (m);}
105 
106 struct radix_node_head {
107 	struct	radix_node *rnh_treetop;
108 	int	rnh_addrsize;		/* permit, but not require fixed keys */
109 	int	rnh_pktsize;		/* permit, but not require fixed keys */
110 					/* add based on sockaddr */
111 	struct	radix_node *(*rnh_addaddr)(void *v, void *mask,
112 		     struct radix_node_head *head, struct radix_node nodes[]);
113 					/* add based on packet hdr */
114 	struct	radix_node *(*rnh_addpkt)(void *v, void *mask,
115 		     struct radix_node_head *head, struct radix_node nodes[]);
116 					/* remove based on sockaddr */
117 	struct	radix_node *(*rnh_deladdr)(void *v, void *mask,
118 		    struct radix_node_head *head, struct radix_node *rn);
119 					/* remove based on packet hdr */
120 	struct	radix_node *(*rnh_delpkt)(void *v, void *mask,
121 		    struct radix_node_head *head);
122 					/* locate based on sockaddr */
123 	struct	radix_node *(*rnh_matchaddr)(void *v,
124 		    struct radix_node_head *head);
125 					/* locate based on sockaddr */
126 	struct	radix_node *(*rnh_lookup)(void *v, void *mask,
127 		    struct radix_node_head *head);
128 					/* locate based on packet hdr */
129 	struct	radix_node *(*rnh_matchpkt)(void *v,
130 		    struct radix_node_head *head);
131 					/* traverse tree */
132 	int	(*rnh_walktree)(struct radix_node_head *,
133 		     int (*)(struct radix_node *, void *), void *);
134 	struct	radix_node rnh_nodes[3];/* empty tree for common case */
135 	int	rnh_multipath;		/* multipath? */
136 };
137 
138 
139 #ifndef _KERNEL
140 #define Bcmp(a, b, n) memcmp(((char *)(a)), ((char *)(b)), (n))
141 #define Bcopy(a, b, n) memmove(((char *)(b)), ((char *)(a)), (unsigned)(n))
142 #define Bzero(p, n) memset((char *)(p), 0, (int)(n));
143 #define R_Malloc(p, t, n) (p = (t) malloc((unsigned int)(n)))
144 #define Free(p) free((char *)p);
145 #else
146 #define Bcmp(a, b, n) memcmp(((caddr_t)(a)), ((caddr_t)(b)), (unsigned)(n))
147 #define Bcopy(a, b, n) memmove(((caddr_t)(b)), ((caddr_t)(a)), (unsigned)(n))
148 #define Bzero(p, n) memset((caddr_t)(p), 0, (unsigned)(n));
149 #define R_Malloc(p, t, n) (p = (t) malloc((unsigned long)(n), M_RTABLE, M_DONTWAIT))
150 #define Free(p) free((caddr_t)p, M_RTABLE);
151 #endif /* !_KERNEL */
152 
153 #if defined(_KERNEL) || defined(_ROUTED)
154 void	 rn_init(void);
155 int	 rn_inithead(void **, int);
156 int	 rn_inithead0(struct radix_node_head *, int);
157 int	 rn_refines(void *, void *);
158 int	 rn_walktree(struct radix_node_head *,
159 			  int (*)(struct radix_node *, void *), void *);
160 struct radix_node
161 	 *rn_addmask(void *, int, int),
162 	 *rn_addroute(void *, void *, struct radix_node_head *,
163 			struct radix_node [2]),
164 	 *rn_delete(void *, void *, struct radix_node_head *,
165 			struct radix_node *),
166 	 *rn_insert(void *, struct radix_node_head *, int *,
167 			struct radix_node [2]),
168 	 *rn_lookup(void *, void *, struct radix_node_head *),
169 	 *rn_match(void *, struct radix_node_head *),
170 	 *rn_newpair(void *, int, struct radix_node[2]),
171 	 *rn_search(void *, struct radix_node *),
172 	 *rn_search_m(void *, struct radix_node *, void *);
173 #endif /* define(_KERNEL) || defined(_ROUTED) */
174 #endif /* _NET_RADIX_H_ */
175