2 * Copyright 2001 Wasabi Systems, Inc.
5 * Written by Jason R. Thorpe for Wasabi Systems, Inc.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed for the NetBSD Project by
18 * Wasabi Systems, Inc.
19 * 4. The name of Wasabi Systems, Inc. may not be used to endorse
20 * or promote products derived from this software without specific prior
23 * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
25 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC
27 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGE.
37 * Copyright (c) 1999, 2000 Jason L. Wright (jason@thought.net)
38 * All rights reserved.
40 * Redistribution and use in source and binary forms, with or without
41 * modification, are permitted provided that the following conditions
43 * 1. Redistributions of source code must retain the above copyright
44 * notice, this list of conditions and the following disclaimer.
45 * 2. Redistributions in binary form must reproduce the above copyright
46 * notice, this list of conditions and the following disclaimer in the
47 * documentation and/or other materials provided with the distribution.
48 * 3. All advertising materials mentioning features or use of this software
49 * must display the following acknowledgement:
50 * This product includes software developed by Jason L. Wright
51 * 4. The name of the author may not be used to endorse or promote products
52 * derived from this software without specific prior written permission.
54 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
55 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
56 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
57 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
58 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
59 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
60 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
61 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
62 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
63 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
64 * POSSIBILITY OF SUCH DAMAGE.
66 * $OpenBSD: if_bridge.h,v 1.14 2001/03/22 03:48:29 jason Exp $
67 * $NetBSD: if_bridgevar.h,v 1.4 2003/07/08 07:13:50 itojun Exp $
68 * $FreeBSD: src/sys/net/if_bridgevar.h,v 1.4 2005/07/06 01:24:45 thompsa Exp $
69 * $DragonFly: src/sys/net/bridge/if_bridgevar.h,v 1.10 2008/11/26 12:49:43 sephe Exp $
72 #ifndef _NET_IF_BRIDGEVAR_H
73 #define _NET_IF_BRIDGEVAR_H
76 * Data structure and control definitions for bridge interfaces.
79 #include <sys/callout.h>
80 #include <sys/queue.h>
83 * Commands used in the SIOCSDRVSPEC ioctl. Note the lookup of the
84 * bridge interface itself is keyed off the ifdrv structure.
86 #define BRDGADD 0 /* add bridge member (ifbreq) */
87 #define BRDGDEL 1 /* delete bridge member (ifbreq) */
88 #define BRDGGIFFLGS 2 /* get member if flags (ifbreq) */
89 #define BRDGSIFFLGS 3 /* set member if flags (ifbreq) */
90 #define BRDGSCACHE 4 /* set cache size (ifbrparam) */
91 #define BRDGGCACHE 5 /* get cache size (ifbrparam) */
92 #define BRDGGIFS 6 /* get member list (ifbifconf) */
93 #define BRDGRTS 7 /* get address list (ifbaconf) */
94 #define BRDGSADDR 8 /* set static address (ifbareq) */
95 #define BRDGSTO 9 /* set cache timeout (ifbrparam) */
96 #define BRDGGTO 10 /* get cache timeout (ifbrparam) */
97 #define BRDGDADDR 11 /* delete address (ifbareq) */
98 #define BRDGFLUSH 12 /* flush address cache (ifbreq) */
100 #define BRDGGPRI 13 /* get priority (ifbrparam) */
101 #define BRDGSPRI 14 /* set priority (ifbrparam) */
102 #define BRDGGHT 15 /* get hello time (ifbrparam) */
103 #define BRDGSHT 16 /* set hello time (ifbrparam) */
104 #define BRDGGFD 17 /* get forward delay (ifbrparam) */
105 #define BRDGSFD 18 /* set forward delay (ifbrparam) */
106 #define BRDGGMA 19 /* get max age (ifbrparam) */
107 #define BRDGSMA 20 /* set max age (ifbrparam) */
108 #define BRDGSIFPRIO 21 /* set if priority (ifbreq) */
109 #define BRDGSIFCOST 22 /* set if path cost (ifbreq) */
110 #define BRDGADDS 23 /* add bridge span member (ifbreq) */
111 #define BRDGDELS 24 /* delete bridge span member (ifbreq) */
114 * Generic bridge control request.
117 char ifbr_ifsname
[IFNAMSIZ
]; /* member if name */
118 uint32_t ifbr_ifsflags
; /* member if flags */
119 uint8_t ifbr_state
; /* member if STP state */
120 uint8_t ifbr_priority
; /* member if STP priority */
121 uint8_t ifbr_path_cost
; /* member if STP cost */
122 uint8_t ifbr_portno
; /* member if port number */
125 /* BRDGGIFFLAGS, BRDGSIFFLAGS */
126 #define IFBIF_LEARNING 0x01 /* if can learn */
127 #define IFBIF_DISCOVER 0x02 /* if sends packets w/ unknown dest. */
128 #define IFBIF_STP 0x04 /* if participates in spanning tree */
129 #define IFBIF_SPAN 0x08 /* if is a span port */
131 #define IFBIFBITS "\020\1LEARNING\2DISCOVER\3STP\4SPAN"
134 #define IFBF_FLUSHDYN 0x00 /* flush learned addresses only */
135 #define IFBF_FLUSHALL 0x01 /* flush all addresses */
136 #define IFBF_FLUSHSYNC 0x02 /* synchronized flush */
138 /* STP port states */
139 #define BSTP_IFSTATE_DISABLED 0
140 #define BSTP_IFSTATE_LISTENING 1
141 #define BSTP_IFSTATE_LEARNING 2
142 #define BSTP_IFSTATE_FORWARDING 3
143 #define BSTP_IFSTATE_BLOCKING 4
146 * Interface list structure.
149 uint32_t ifbic_len
; /* buffer size */
152 struct ifbreq
*ifbicu_req
;
154 #define ifbic_buf ifbic_ifbicu.ifbicu_buf
155 #define ifbic_req ifbic_ifbicu.ifbicu_req
159 * Bridge address request.
162 char ifba_ifsname
[IFNAMSIZ
]; /* member if name */
163 unsigned long ifba_expire
; /* address expire time */
164 uint8_t ifba_flags
; /* address flags */
165 uint8_t ifba_dst
[ETHER_ADDR_LEN
];/* destination address */
168 #define IFBAF_TYPEMASK 0x03 /* address type mask */
169 #define IFBAF_DYNAMIC 0x00 /* dynamically learned address */
170 #define IFBAF_STATIC 0x01 /* static address */
172 #define IFBAFBITS "\020\1STATIC"
175 * Address list structure.
178 uint32_t ifbac_len
; /* buffer size */
181 struct ifbareq
*ifbacu_req
;
183 #define ifbac_buf ifbac_ifbacu.ifbacu_buf
184 #define ifbac_req ifbac_ifbacu.ifbacu_req
188 * Bridge parameter structure.
192 uint32_t ifbrpu_int32
;
193 uint16_t ifbrpu_int16
;
197 #define ifbrp_csize ifbrp_ifbrpu.ifbrpu_int32 /* cache size */
198 #define ifbrp_ctime ifbrp_ifbrpu.ifbrpu_int32 /* cache time (sec) */
199 #define ifbrp_prio ifbrp_ifbrpu.ifbrpu_int16 /* bridge priority */
200 #define ifbrp_hellotime ifbrp_ifbrpu.ifbrpu_int8 /* hello time (sec) */
201 #define ifbrp_fwddelay ifbrp_ifbrpu.ifbrpu_int8 /* fwd time (sec) */
202 #define ifbrp_maxage ifbrp_ifbrpu.ifbrpu_int8 /* max age (sec) */
206 * Timekeeping structure used in spanning tree code.
208 struct bridge_timer
{
213 struct bstp_config_unit
{
215 uint64_t cu_bridge_id
;
216 uint32_t cu_root_path_cost
;
217 uint16_t cu_message_age
;
219 uint16_t cu_hello_time
;
220 uint16_t cu_forward_delay
;
222 uint8_t cu_message_type
;
223 uint8_t cu_topology_change_acknowledgment
;
224 uint8_t cu_topology_change
;
227 struct bstp_tcn_unit
{
228 uint8_t tu_message_type
;
232 * Bridge interface entry.
234 struct bridge_ifinfo
{
235 uint64_t bifi_designated_root
;
236 uint64_t bifi_designated_bridge
;
237 uint32_t bifi_path_cost
;
238 uint32_t bifi_designated_cost
;
239 struct bridge_timer bifi_hold_timer
;
240 struct bridge_timer bifi_message_age_timer
;
241 struct bridge_timer bifi_forward_delay_timer
;
242 struct bstp_config_unit bifi_config_bpdu
;
243 uint16_t bifi_port_id
;
244 uint16_t bifi_designated_port
;
246 uint8_t bifi_topology_change_acknowledge
;
247 uint8_t bifi_config_pending
;
248 uint8_t bifi_change_detection_enabled
;
249 uint8_t bifi_priority
;
250 struct ifnet
*bifi_ifp
; /* member if */
251 int bifi_mutecap
; /* member muted caps */
254 #define bif_designated_root bif_info->bifi_designated_root
255 #define bif_designated_bridge bif_info->bifi_designated_bridge
256 #define bif_path_cost bif_info->bifi_path_cost
257 #define bif_designated_cost bif_info->bifi_designated_cost
258 #define bif_hold_timer bif_info->bifi_hold_timer
259 #define bif_message_age_timer bif_info->bifi_message_age_timer
260 #define bif_forward_delay_timer bif_info->bifi_forward_delay_timer
261 #define bif_config_bpdu bif_info->bifi_config_bpdu
262 #define bif_port_id bif_info->bifi_port_id
263 #define bif_designated_port bif_info->bifi_designated_port
264 #define bif_state bif_info->bifi_state
265 #define bif_topology_change_acknowledge \
266 bif_info->bifi_topology_change_acknowledge
267 #define bif_config_pending bif_info->bifi_config_pending
268 #define bif_change_detection_enabled bif_info->bifi_change_detection_enabled
269 #define bif_priority bif_info->bifi_priority
272 * Bridge interface list entry.
274 struct bridge_iflist
{
275 LIST_ENTRY(bridge_iflist
) bif_next
;
276 struct ifnet
*bif_ifp
; /* member if */
277 uint32_t bif_flags
; /* member if flags */
279 struct bridge_ifinfo
*bif_info
;
281 LIST_HEAD(bridge_iflist_head
, bridge_iflist
);
286 struct bridge_rtinfo
{
287 struct ifnet
*bri_ifp
; /* destination if */
288 unsigned long bri_expire
; /* expiration time */
289 uint8_t bri_flags
; /* address flags */
297 struct bridge_rtnode
{
298 LIST_ENTRY(bridge_rtnode
) brt_hash
; /* hash table linkage */
299 LIST_ENTRY(bridge_rtnode
) brt_list
; /* list linkage */
300 uint8_t brt_addr
[ETHER_ADDR_LEN
];
302 struct bridge_rtinfo
*brt_info
;
304 LIST_HEAD(bridge_rtnode_head
, bridge_rtnode
);
307 * Software state for each bridge.
309 struct bridge_softc
{
310 struct arpcom sc_arp
;
311 struct ifnet
*sc_ifp
; /* make this an interface */
312 LIST_ENTRY(bridge_softc
) sc_list
;
313 uint64_t sc_designated_root
;
314 uint64_t sc_bridge_id
;
315 struct bridge_ifinfo
*sc_root_port
;
316 uint32_t sc_root_path_cost
;
318 uint16_t sc_hello_time
;
319 uint16_t sc_forward_delay
;
320 uint16_t sc_bridge_max_age
;
321 uint16_t sc_bridge_hello_time
;
322 uint16_t sc_bridge_forward_delay
;
323 uint16_t sc_topology_change_time
;
324 uint16_t sc_hold_time
;
325 uint16_t sc_bridge_priority
;
326 uint8_t sc_topology_change_detected
;
327 uint8_t sc_topology_change
;
328 struct bridge_timer sc_hello_timer
;
329 struct bridge_timer sc_topology_change_timer
;
330 struct bridge_timer sc_tcn_timer
;
331 uint32_t sc_brtmax
; /* max # of addresses */
332 uint32_t sc_brtcnt
; /* cur. # of addresses */
333 uint32_t sc_brttimeout
; /* rt timeout in seconds */
334 struct callout sc_brcallout
; /* bridge callout */
335 struct netmsg sc_brtimemsg
; /* bridge callout msg */
336 struct callout sc_bstpcallout
; /* STP callout */
337 struct netmsg sc_bstptimemsg
; /* STP callout msg */
338 struct bridge_iflist_head
*sc_iflists
; /* percpu member if lists */
339 struct bridge_rtnode_head
**sc_rthashs
; /* percpu forwarding tables */
340 struct bridge_rtnode_head
*sc_rtlists
; /* percpu lists of the above */
341 uint32_t sc_rthash_key
; /* key for hash */
342 struct bridge_iflist_head sc_spanlist
; /* span ports list */
343 int sc_span
; /* has span ports */
344 struct bridge_timer sc_link_timer
;
346 #define sc_if sc_arp.ac_if
348 #define BRIDGE_CFGCPU 0
349 #define BRIDGE_CFGPORT cpu_portfn(BRIDGE_CFGCPU)
351 extern const uint8_t bstp_etheraddr
[];
353 void bridge_rtdelete(struct bridge_softc
*, struct ifnet
*ifp
, int);
355 extern void (*bstp_linkstate_p
)(struct ifnet
*ifp
, int state
);
357 void bstp_initialization(struct bridge_softc
*);
358 void bstp_linkstate(struct ifnet
*, int);
359 void bstp_stop(struct bridge_softc
*);
360 void bstp_input(struct bridge_softc
*, struct bridge_iflist
*,
362 void bstp_tick_handler(struct netmsg
*);
364 void bridge_enqueue(struct ifnet
*, struct mbuf
*);
368 #endif /* !_NET_IF_BRIDGEVAR_H */