if_bridgevar.h revision 1.17 1 /* $NetBSD: if_bridgevar.h,v 1.17 2014/06/16 03:43:10 ozaki-r Exp $ */
2
3 /*
4 * Copyright 2001 Wasabi Systems, Inc.
5 * All rights reserved.
6 *
7 * Written by Jason R. Thorpe for Wasabi Systems, Inc.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. All advertising materials mentioning features or use of this software
18 * must display the following acknowledgement:
19 * This product includes software developed for the NetBSD Project by
20 * Wasabi Systems, Inc.
21 * 4. The name of Wasabi Systems, Inc. may not be used to endorse
22 * or promote products derived from this software without specific prior
23 * written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC
29 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 * POSSIBILITY OF SUCH DAMAGE.
36 */
37
38 /*
39 * Copyright (c) 1999, 2000 Jason L. Wright (jason (at) thought.net)
40 * All rights reserved.
41 *
42 * Redistribution and use in source and binary forms, with or without
43 * modification, are permitted provided that the following conditions
44 * are met:
45 * 1. Redistributions of source code must retain the above copyright
46 * notice, this list of conditions and the following disclaimer.
47 * 2. Redistributions in binary form must reproduce the above copyright
48 * notice, this list of conditions and the following disclaimer in the
49 * documentation and/or other materials provided with the distribution.
50 * 3. All advertising materials mentioning features or use of this software
51 * must display the following acknowledgement:
52 * This product includes software developed by Jason L. Wright
53 * 4. The name of the author may not be used to endorse or promote products
54 * derived from this software without specific prior written permission.
55 *
56 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
57 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
58 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
59 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
60 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
61 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
62 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
63 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
64 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
65 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
66 * POSSIBILITY OF SUCH DAMAGE.
67 *
68 * OpenBSD: if_bridge.h,v 1.14 2001/03/22 03:48:29 jason Exp
69 */
70
71 /*
72 * Data structure and control definitions for bridge interfaces.
73 */
74
75 #ifndef _NET_IF_BRIDGEVAR_H_
76 #define _NET_IF_BRIDGEVAR_H_
77
78 #include <sys/callout.h>
79 #include <sys/queue.h>
80
81 /*
82 * Commands used in the SIOCSDRVSPEC ioctl. Note the lookup of the
83 * bridge interface itself is keyed off the ifdrv structure.
84 */
85 #define BRDGADD 0 /* add bridge member (ifbreq) */
86 #define BRDGDEL 1 /* delete bridge member (ifbreq) */
87 #define BRDGGIFFLGS 2 /* get member if flags (ifbreq) */
88 #define BRDGSIFFLGS 3 /* set member if flags (ifbreq) */
89 #define BRDGSCACHE 4 /* set cache size (ifbrparam) */
90 #define BRDGGCACHE 5 /* get cache size (ifbrparam) */
91 #define BRDGGIFS 6 /* get member list (ifbifconf) */
92 #define BRDGRTS 7 /* get address list (ifbaconf) */
93 #define BRDGSADDR 8 /* set static address (ifbareq) */
94 #define BRDGSTO 9 /* set cache timeout (ifbrparam) */
95 #define BRDGGTO 10 /* get cache timeout (ifbrparam) */
96 #define BRDGDADDR 11 /* delete address (ifbareq) */
97 #define BRDGFLUSH 12 /* flush address cache (ifbreq) */
98
99 #define BRDGGPRI 13 /* get priority (ifbrparam) */
100 #define BRDGSPRI 14 /* set priority (ifbrparam) */
101 #define BRDGGHT 15 /* get hello time (ifbrparam) */
102 #define BRDGSHT 16 /* set hello time (ifbrparam) */
103 #define BRDGGFD 17 /* get forward delay (ifbrparam) */
104 #define BRDGSFD 18 /* set forward delay (ifbrparam) */
105 #define BRDGGMA 19 /* get max age (ifbrparam) */
106 #define BRDGSMA 20 /* set max age (ifbrparam) */
107 #define BRDGSIFPRIO 21 /* set if priority (ifbreq) */
108 #define BRDGSIFCOST 22 /* set if path cost (ifbreq) */
109 #define BRDGGFILT 23 /* get filter flags (ifbrparam) */
110 #define BRDGSFILT 24 /* set filter flags (ifbrparam) */
111
112 /*
113 * Generic bridge control request.
114 */
115 struct ifbreq {
116 char ifbr_ifsname[IFNAMSIZ]; /* member if name */
117 uint32_t ifbr_ifsflags; /* member if flags */
118 uint8_t ifbr_state; /* member if STP state */
119 uint8_t ifbr_priority; /* member if STP priority */
120 uint8_t ifbr_path_cost; /* member if STP cost */
121 uint8_t ifbr_portno; /* member if port number */
122 };
123
124 /* BRDGGIFFLAGS, BRDGSIFFLAGS */
125 #define IFBIF_LEARNING 0x01 /* if can learn */
126 #define IFBIF_DISCOVER 0x02 /* if sends packets w/ unknown dest. */
127 #define IFBIF_STP 0x04 /* if participates in spanning tree */
128
129 #define IFBIFBITS "\020\1LEARNING\2DISCOVER\3STP"
130
131 /* BRDGFLUSH */
132 #define IFBF_FLUSHDYN 0x00 /* flush learned addresses only */
133 #define IFBF_FLUSHALL 0x01 /* flush all addresses */
134
135 /* BRDGSFILT */
136 #define IFBF_FILT_USEIPF 0x00000001 /* enable ipf on bridge */
137 #define IFBF_FILT_MASK 0x00000001 /* mask of valid values */
138
139 /* STP port states */
140 #define BSTP_IFSTATE_DISABLED 0
141 #define BSTP_IFSTATE_LISTENING 1
142 #define BSTP_IFSTATE_LEARNING 2
143 #define BSTP_IFSTATE_FORWARDING 3
144 #define BSTP_IFSTATE_BLOCKING 4
145
146 /*
147 * Interface list structure.
148 */
149 struct ifbifconf {
150 uint32_t ifbic_len; /* buffer size */
151 union {
152 void * ifbicu_buf;
153 struct ifbreq *ifbicu_req;
154 } ifbic_ifbicu;
155 #define ifbic_buf ifbic_ifbicu.ifbicu_buf
156 #define ifbic_req ifbic_ifbicu.ifbicu_req
157 };
158
159 /*
160 * Bridge address request.
161 */
162 struct ifbareq {
163 char ifba_ifsname[IFNAMSIZ]; /* member if name */
164 /*XXX: time_t */
165 long ifba_expire; /* address expire time */
166 uint8_t ifba_flags; /* address flags */
167 uint8_t ifba_dst[ETHER_ADDR_LEN];/* destination address */
168 };
169
170 #define IFBAF_TYPEMASK 0x03 /* address type mask */
171 #define IFBAF_DYNAMIC 0x00 /* dynamically learned address */
172 #define IFBAF_STATIC 0x01 /* static address */
173
174 #define IFBAFBITS "\020\1STATIC"
175
176 /*
177 * Address list structure.
178 */
179 struct ifbaconf {
180 uint32_t ifbac_len; /* buffer size */
181 union {
182 void *ifbacu_buf;
183 struct ifbareq *ifbacu_req;
184 } ifbac_ifbacu;
185 #define ifbac_buf ifbac_ifbacu.ifbacu_buf
186 #define ifbac_req ifbac_ifbacu.ifbacu_req
187 };
188
189 /*
190 * Bridge parameter structure.
191 */
192 struct ifbrparam {
193 union {
194 uint32_t ifbrpu_int32;
195 uint16_t ifbrpu_int16;
196 uint8_t ifbrpu_int8;
197 } ifbrp_ifbrpu;
198 };
199 #define ifbrp_csize ifbrp_ifbrpu.ifbrpu_int32 /* cache size */
200 #define ifbrp_ctime ifbrp_ifbrpu.ifbrpu_int32 /* cache time (sec) */
201 #define ifbrp_prio ifbrp_ifbrpu.ifbrpu_int16 /* bridge priority */
202 #define ifbrp_hellotime ifbrp_ifbrpu.ifbrpu_int8 /* hello time (sec) */
203 #define ifbrp_fwddelay ifbrp_ifbrpu.ifbrpu_int8 /* fwd time (sec) */
204 #define ifbrp_maxage ifbrp_ifbrpu.ifbrpu_int8 /* max age (sec) */
205 #define ifbrp_filter ifbrp_ifbrpu.ifbrpu_int32 /* filtering flags */
206
207 #ifdef _KERNEL
208 #include <net/pktqueue.h>
209
210 /*
211 * Timekeeping structure used in spanning tree code.
212 */
213 struct bridge_timer {
214 uint16_t active;
215 uint16_t value;
216 };
217
218 struct bstp_config_unit {
219 uint64_t cu_rootid;
220 uint64_t cu_bridge_id;
221 uint32_t cu_root_path_cost;
222 uint16_t cu_message_age;
223 uint16_t cu_max_age;
224 uint16_t cu_hello_time;
225 uint16_t cu_forward_delay;
226 uint16_t cu_port_id;
227 uint8_t cu_message_type;
228 uint8_t cu_topology_change_acknowledgment;
229 uint8_t cu_topology_change;
230 };
231
232 struct bstp_tcn_unit {
233 uint8_t tu_message_type;
234 };
235
236 /*
237 * Bridge interface list entry.
238 */
239 struct bridge_iflist {
240 LIST_ENTRY(bridge_iflist) bif_next;
241 uint64_t bif_designated_root;
242 uint64_t bif_designated_bridge;
243 uint32_t bif_path_cost;
244 uint32_t bif_designated_cost;
245 struct bridge_timer bif_hold_timer;
246 struct bridge_timer bif_message_age_timer;
247 struct bridge_timer bif_forward_delay_timer;
248 uint16_t bif_port_id;
249 uint16_t bif_designated_port;
250 struct bstp_config_unit bif_config_bpdu;
251 uint8_t bif_state;
252 uint8_t bif_topology_change_acknowledge;
253 uint8_t bif_config_pending;
254 uint8_t bif_change_detection_enabled;
255 uint8_t bif_priority;
256 struct ifnet *bif_ifp; /* member if */
257 uint32_t bif_flags; /* member if flags */
258 };
259
260 /*
261 * Bridge route node.
262 */
263 struct bridge_rtnode {
264 LIST_ENTRY(bridge_rtnode) brt_hash; /* hash table linkage */
265 LIST_ENTRY(bridge_rtnode) brt_list; /* list linkage */
266 struct ifnet *brt_ifp; /* destination if */
267 time_t brt_expire; /* expiration time */
268 uint8_t brt_flags; /* address flags */
269 uint8_t brt_addr[ETHER_ADDR_LEN];
270 };
271
272 /*
273 * Software state for each bridge.
274 */
275 struct bridge_softc {
276 struct ifnet sc_if;
277 LIST_ENTRY(bridge_softc) sc_list;
278 uint64_t sc_designated_root;
279 uint64_t sc_bridge_id;
280 struct bridge_iflist *sc_root_port;
281 uint32_t sc_root_path_cost;
282 uint16_t sc_max_age;
283 uint16_t sc_hello_time;
284 uint16_t sc_forward_delay;
285 uint16_t sc_bridge_max_age;
286 uint16_t sc_bridge_hello_time;
287 uint16_t sc_bridge_forward_delay;
288 uint16_t sc_topology_change_time;
289 uint16_t sc_hold_time;
290 uint16_t sc_bridge_priority;
291 uint8_t sc_topology_change_detected;
292 uint8_t sc_topology_change;
293 struct bridge_timer sc_hello_timer;
294 struct bridge_timer sc_topology_change_timer;
295 struct bridge_timer sc_tcn_timer;
296 uint32_t sc_brtmax; /* max # of addresses */
297 uint32_t sc_brtcnt; /* cur. # of addresses */
298 uint32_t sc_brttimeout; /* rt timeout in seconds */
299 callout_t sc_brcallout; /* bridge callout */
300 callout_t sc_bstpcallout; /* STP callout */
301 LIST_HEAD(, bridge_iflist) sc_iflist; /* member interface list */
302 LIST_HEAD(, bridge_rtnode) *sc_rthash; /* our forwarding table */
303 LIST_HEAD(, bridge_rtnode) sc_rtlist; /* list version of above */
304 uint32_t sc_rthash_key; /* key for hash */
305 uint32_t sc_filter_flags; /* ipf and flags */
306 void *sc_softintr;
307 pktqueue_t * sc_fwd_pktq;
308 };
309
310 extern const uint8_t bstp_etheraddr[];
311
312 void bridge_ifdetach(struct ifnet *);
313
314 int bridge_output(struct ifnet *, struct mbuf *, const struct sockaddr *,
315 struct rtentry *);
316 struct mbuf *bridge_input(struct ifnet *, struct mbuf *);
317
318 void bstp_initialization(struct bridge_softc *);
319 void bstp_stop(struct bridge_softc *);
320 struct mbuf *bstp_input(struct bridge_softc *, struct bridge_iflist *, struct mbuf *);
321
322 void bridge_enqueue(struct bridge_softc *, struct ifnet *, struct mbuf *,
323 int);
324
325 #endif /* _KERNEL */
326 #endif /* !_NET_IF_BRIDGEVAR_H_ */
327