xref: /openbsd/sys/net/radix.h (revision 2ba78ce9)
1 /*	$OpenBSD: radix.h,v 1.30 2017/06/19 09:42:45 mpi Exp $	*/
2 /*	$NetBSD: radix.h,v 1.8 1996/02/13 22:00:37 christos Exp $	*/
3 
4 /*
5  * Copyright (c) 1988, 1989, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *	@(#)radix.h	8.2 (Berkeley) 10/31/94
33  */
34 
35 #ifndef _NET_RADIX_H_
36 #define	_NET_RADIX_H_
37 
38 /*
39  * Radix search tree node layout.
40  */
41 
42 struct radix_node {
43 	struct	radix_mask *rn_mklist;	/* list of masks contained in subtree */
44 	struct	radix_node *rn_p;	/* parent */
45 	short	rn_b;			/* bit offset; -1-index(netmask) */
46 	char	rn_bmask;		/* node: mask for bit test*/
47 	u_char	rn_flags;		/* enumerated next */
48 #define RNF_NORMAL	1		/* leaf contains normal route */
49 #define RNF_ROOT	2		/* leaf is root leaf for tree */
50 #define RNF_ACTIVE	4		/* This node is alive (for rtfree) */
51 	union {
52 		struct {			/* leaf only data: */
53 			caddr_t	rn_Key;		/* object of search */
54 			caddr_t	rn_Mask;	/* netmask, if present */
55 			struct	radix_node *rn_Dupedkey;
56 		} rn_leaf;
57 		struct {			/* node only data: */
58 			int	rn_Off;		/* where to start compare */
59 			struct	radix_node *rn_L;/* progeny */
60 			struct	radix_node *rn_R;/* progeny */
61 		} rn_node;
62 	} rn_u;
63 };
64 
65 #define rn_dupedkey rn_u.rn_leaf.rn_Dupedkey
66 #define rn_key rn_u.rn_leaf.rn_Key
67 #define rn_mask rn_u.rn_leaf.rn_Mask
68 #define rn_off rn_u.rn_node.rn_Off
69 #define rn_l rn_u.rn_node.rn_L
70 #define rn_r rn_u.rn_node.rn_R
71 
72 /*
73  * Annotations to tree concerning potential routes applying to subtrees.
74  */
75 
76 struct radix_mask {
77 	short	rm_b;			/* bit offset; -1-index(netmask) */
78 	char	rm_unused;		/* cf. rn_bmask */
79 	u_char	rm_flags;		/* cf. rn_flags */
80 	struct	radix_mask *rm_mklist;	/* more masks to try */
81 	union	{
82 		caddr_t	rmu_mask;		/* the mask */
83 		struct	radix_node *rmu_leaf;	/* for normal routes */
84 	}	rm_rmu;
85 	int	rm_refs;		/* # of references to this struct */
86 };
87 
88 #define rm_mask rm_rmu.rmu_mask
89 #define rm_leaf rm_rmu.rmu_leaf		/* extra field would make 32 bytes */
90 
91 struct radix_node_head {
92 	struct	radix_node *rnh_treetop;
93 	int	rnh_addrsize;		/* permit, but not require fixed keys */
94 	int	rnh_pktsize;		/* permit, but not require fixed keys */
95 	struct	radix_node rnh_nodes[3];/* empty tree for common case */
96 	u_int	rnh_rtableid;
97 };
98 
99 void	rn_init(unsigned int);
100 int	rn_inithead(void **, int);
101 
102 int	rn_walktree(struct radix_node_head *,
103 	    int (*)(struct radix_node *, void *, u_int), void *);
104 
105 struct radix_node	*rn_addroute(void *, void *, struct radix_node_head *,
106 			    struct radix_node [2], u_int8_t);
107 struct radix_node	*rn_delete(void *, void *, struct radix_node_head *,
108 			    struct radix_node *);
109 struct radix_node	*rn_lookup(void *, void *, struct radix_node_head *);
110 struct radix_node	*rn_match(void *, struct radix_node_head *);
111 
112 #endif /* _NET_RADIX_H_ */
113