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