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