xref: /f-stack/tools/compat/include/net/radix.h (revision ebf5cedb)
1 /*-
2  * Copyright (c) 1988, 1989, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 4. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *	@(#)radix.h	8.2 (Berkeley) 10/31/94
30  * $FreeBSD$
31  */
32 
33 #ifndef _RADIX_H_
34 #define	_RADIX_H_
35 
36 /*
37  * Radix search tree node layout.
38  */
39 
40 struct radix_node {
41 	struct	radix_mask *rn_mklist;	/* list of masks contained in subtree */
42 	struct	radix_node *rn_parent;	/* parent */
43 	short	rn_bit;			/* bit offset; -1-index(netmask) */
44 	char	rn_bmask;		/* node: mask for bit test*/
45 	u_char	rn_flags;		/* enumerated next */
46 #define RNF_NORMAL	1		/* leaf contains normal route */
47 #define RNF_ROOT	2		/* leaf is root leaf for tree */
48 #define RNF_ACTIVE	4		/* This node is alive (for rtfree) */
49 	union {
50 		struct {			/* leaf only data: */
51 			caddr_t	rn_Key;		/* object of search */
52 			caddr_t	rn_Mask;	/* netmask, if present */
53 			struct	radix_node *rn_Dupedkey;
54 		} rn_leaf;
55 		struct {			/* node only data: */
56 			int	rn_Off;		/* where to start compare */
57 			struct	radix_node *rn_L;/* progeny */
58 			struct	radix_node *rn_R;/* progeny */
59 		} rn_node;
60 	}		rn_u;
61 #ifdef RN_DEBUG
62 	int rn_info;
63 	struct radix_node *rn_twin;
64 	struct radix_node *rn_ybro;
65 #endif
66 };
67 
68 #define	rn_dupedkey	rn_u.rn_leaf.rn_Dupedkey
69 #define	rn_key		rn_u.rn_leaf.rn_Key
70 #define	rn_mask		rn_u.rn_leaf.rn_Mask
71 #define	rn_offset	rn_u.rn_node.rn_Off
72 #define	rn_left		rn_u.rn_node.rn_L
73 #define	rn_right	rn_u.rn_node.rn_R
74 
75 /*
76  * Annotations to tree concerning potential routes applying to subtrees.
77  */
78 
79 struct radix_mask {
80 	short	rm_bit;			/* bit offset; -1-index(netmask) */
81 	char	rm_unused;		/* cf. rn_bmask */
82 	u_char	rm_flags;		/* cf. rn_flags */
83 	struct	radix_mask *rm_mklist;	/* more masks to try */
84 	union	{
85 		caddr_t	rmu_mask;		/* the mask */
86 		struct	radix_node *rmu_leaf;	/* for normal routes */
87 	}	rm_rmu;
88 	int	rm_refs;		/* # of references to this struct */
89 };
90 
91 #define	rm_mask rm_rmu.rmu_mask
92 #define	rm_leaf rm_rmu.rmu_leaf		/* extra field would make 32 bytes */
93 
94 struct radix_head;
95 
96 typedef int walktree_f_t(struct radix_node *, void *);
97 typedef struct radix_node *rn_matchaddr_f_t(void *v,
98     struct radix_head *head);
99 typedef struct radix_node *rn_addaddr_f_t(void *v, void *mask,
100     struct radix_head *head, struct radix_node nodes[]);
101 typedef struct radix_node *rn_deladdr_f_t(void *v, void *mask,
102     struct radix_head *head);
103 typedef struct radix_node *rn_lookup_f_t(void *v, void *mask,
104     struct radix_head *head);
105 typedef int rn_walktree_t(struct radix_head *head, walktree_f_t *f,
106     void *w);
107 typedef int rn_walktree_from_t(struct radix_head *head,
108     void *a, void *m, walktree_f_t *f, void *w);
109 typedef void rn_close_t(struct radix_node *rn, struct radix_head *head);
110 
111 struct radix_mask_head;
112 
113 struct radix_head {
114 	struct	radix_node *rnh_treetop;
115 	struct	radix_mask_head *rnh_masks;	/* Storage for our masks */
116 };
117 
118 struct radix_node_head {
119 	struct radix_head rh;
120 	rn_matchaddr_f_t	*rnh_matchaddr;	/* longest match for sockaddr */
121 	rn_addaddr_f_t	*rnh_addaddr;	/* add based on sockaddr*/
122 	rn_deladdr_f_t	*rnh_deladdr;	/* remove based on sockaddr */
123 	rn_lookup_f_t	*rnh_lookup;	/* exact match for sockaddr */
124 	rn_walktree_t	*rnh_walktree;	/* traverse tree */
125 	rn_walktree_from_t	*rnh_walktree_from; /* traverse tree below a */
126 	rn_close_t	*rnh_close;	/*do something when the last ref drops*/
127 	struct	radix_node rnh_nodes[3];	/* empty tree for common case */
128 #ifdef _KERNEL
129 	struct	rwlock rnh_lock;		/* locks entire radix tree */
130 #endif
131 };
132 
133 struct radix_mask_head {
134 	struct radix_head head;
135 	struct radix_node mask_nodes[3];
136 };
137 
138 void rn_inithead_internal(struct radix_head *rh, struct radix_node *base_nodes,
139     int off);
140 
141 #ifndef _KERNEL
142 #define R_Malloc(p, t, n) (p = (t) malloc((unsigned int)(n)))
143 #define R_Zalloc(p, t, n) (p = (t) calloc(1,(unsigned int)(n)))
144 #define R_Free(p) free((char *)p);
145 #else
146 #define R_Malloc(p, t, n) (p = (t) malloc((unsigned long)(n), M_RTABLE, M_NOWAIT))
147 #define R_Zalloc(p, t, n) (p = (t) malloc((unsigned long)(n), M_RTABLE, M_NOWAIT | M_ZERO))
148 #define R_Free(p) free((caddr_t)p, M_RTABLE);
149 
150 #define	RADIX_NODE_HEAD_LOCK_INIT(rnh)	\
151     rw_init_flags(&(rnh)->rnh_lock, "radix node head", 0)
152 #define	RADIX_NODE_HEAD_LOCK(rnh)	rw_wlock(&(rnh)->rnh_lock)
153 #define	RADIX_NODE_HEAD_UNLOCK(rnh)	rw_wunlock(&(rnh)->rnh_lock)
154 #define	RADIX_NODE_HEAD_RLOCK(rnh)	rw_rlock(&(rnh)->rnh_lock)
155 #define	RADIX_NODE_HEAD_RUNLOCK(rnh)	rw_runlock(&(rnh)->rnh_lock)
156 #define	RADIX_NODE_HEAD_LOCK_TRY_UPGRADE(rnh)	rw_try_upgrade(&(rnh)->rnh_lock)
157 
158 
159 #define	RADIX_NODE_HEAD_DESTROY(rnh)	rw_destroy(&(rnh)->rnh_lock)
160 #define	RADIX_NODE_HEAD_LOCK_ASSERT(rnh) rw_assert(&(rnh)->rnh_lock, RA_LOCKED)
161 #define	RADIX_NODE_HEAD_WLOCK_ASSERT(rnh) rw_assert(&(rnh)->rnh_lock, RA_WLOCKED)
162 #endif /* _KERNEL */
163 
164 #endif /* _RADIX_H_ */
165