xref: /illumos-gate/usr/src/cmd/cmd-inet/usr.sbin/in.routed/radix.h (revision ddb365bfc9e868ad24ccdcb0dc91af18b10df082)
1 /*
2  * Copyright 2001-2002 Sun Microsystems, Inc.  All rights reserved.
3  * Use is subject to license terms.
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. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgment:
18  *	This product includes software developed by the University of
19  *	California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *	@(#)radix.h	8.2 (Berkeley) 10/31/94
37  *
38  * $FreeBSD: src/sbin/routed/radix.h,v 1.5 2000/08/11 08:24:38 sheldonh Exp $
39  */
40 
41 #ifndef ROUTED_RADIX_H
42 #define	ROUTED_RADIX_H
43 
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47 
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 	int16_t	rn_b;			/* bit offset; -1-index(netmask) */
57 	uint8_t	rn_bmask;		/* node: mask for bit test */
58 	uint8_t	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 			uint8_t	*rn_Key;	/* object of search */
65 			uint8_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 	uint8_t	rm_unused;		/* cf. rn_bmask */
95 	uint8_t	rm_flags;		/* cf. rn_flags */
96 	struct	radix_mask *rm_mklist;	/* more masks to try */
97 	union	{
98 		uint8_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 != NULL) {\
109 		m = rn_mkfreelist; \
110 		rn_mkfreelist = (m)->rm_mklist; \
111 	} else \
112 		m = (struct radix_mask *)rtmalloc(sizeof (*(m)), "MKGet"); }
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 	int	rnh_addrsize;		/* permit, but not require fixed keys */
119 	int	rnh_pktsize;		/* permit, but not require fixed keys */
120 	struct	radix_node *(*rnh_addaddr)	/* add based on sockaddr */
121 		(void *v, void *mask, struct radix_node_head *head,
122 			struct radix_node nodes[]);
123 	struct	radix_node *(*rnh_addpkt)	/* add based on packet hdr */
124 		(void *v, void *mask, struct radix_node_head *head,
125 			struct radix_node nodes[]);
126 	struct	radix_node *(*rnh_deladdr)	/* remove based on sockaddr */
127 		(void *v, void *mask, struct radix_node_head *head);
128 	struct	radix_node *(*rnh_delpkt)	/* remove based on packet hdr */
129 		(void *v, void *mask, struct radix_node_head *head);
130 	struct	radix_node *(*rnh_matchaddr)	/* locate based on sockaddr */
131 		(void *v, struct radix_node_head *head);
132 	struct	radix_node *(*rnh_lookup)	/* locate based on sockaddr */
133 		(void *v, void *mask, struct radix_node_head *head);
134 	struct	radix_node *(*rnh_matchpkt)	/* locate based on packet hdr */
135 		(void *v, struct radix_node_head *head);
136 		/* traverse tree */
137 	int	(*rnh_walktree)(struct radix_node_head *head,
138 	    int (*f)(struct radix_node *, void *),
139 	    void *w);
140 	struct	radix_node rnh_nodes[3];	/* empty tree for common case */
141 };
142 
143 
144 void	 rn_init(void);
145 int	 rn_inithead(void **, uint_t);
146 int	 rn_walktree(struct radix_node_head *,
147     int (*)(struct radix_node *, void *),
148     void *);
149 
150 #ifdef __cplusplus
151 }
152 #endif
153 
154 #endif /* ROUTED_RADIX_H */
155