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) */
112 #define BRDGSBONDWGHT 25 /* set bonding weighting (ifbreq) */
115 * Generic bridge control request.
118 char ifbr_ifsname[IFNAMSIZ]; /* member if name */
119 uint32_t ifbr_ifsflags; /* member if flags */
120 uint8_t ifbr_state; /* member if STP state */
121 uint8_t ifbr_priority; /* member if STP priority */
122 uint8_t ifbr_path_cost; /* member if STP cost */
123 uint8_t ifbr_portno; /* member if port number */
124 uint64_t ifbr_designated_root; /* synthesized */
125 uint64_t ifbr_designated_bridge;
126 uint32_t ifbr_designated_cost;
127 uint16_t ifbr_designated_port;
129 uint64_t ifbr_peer_root; /* from peer */
130 uint64_t ifbr_peer_bridge; /* from peer */
131 uint32_t ifbr_peer_cost; /* from peer */
132 uint16_t ifbr_peer_port; /* from peer */
134 uint16_t ifbr_bond_weight;
136 uint32_t unused04[8];
139 /* BRDGGIFFLAGS, BRDGSIFFLAGS */
140 #define IFBIF_LEARNING 0x01 /* if can learn */
141 #define IFBIF_DISCOVER 0x02 /* if sends packets w/ unknown dest. */
142 #define IFBIF_STP 0x04 /* if participates in spanning tree */
143 #define IFBIF_SPAN 0x08 /* if is a span port */
144 #define IFBIF_DESIGNATED 0x10 /* mostly age timer expired */
145 #define IFBIF_ROOT 0x20 /* selected root or near-root */
147 #define IFBIF_KEEPMASK (IFBIF_SPAN | IFBIF_DESIGNATED | IFBIF_ROOT)
149 #define IFBIFBITS "\020\1LEARNING\2DISCOVER\3STP\4SPAN\5DESIGNATED" \
153 #define IFBF_FLUSHDYN 0x00 /* flush learned addresses only */
154 #define IFBF_FLUSHALL 0x01 /* flush all addresses */
155 #define IFBF_FLUSHSYNC 0x02 /* synchronized flush */
157 /* STP port states */
158 #define BSTP_IFSTATE_DISABLED 0
159 #define BSTP_IFSTATE_LISTENING 1
160 #define BSTP_IFSTATE_LEARNING 2
161 #define BSTP_IFSTATE_FORWARDING 3
162 #define BSTP_IFSTATE_BLOCKING 4
163 #define BSTP_IFSTATE_BONDED 5 /* link2 bonding mode */
164 #define BSTP_IFSTATE_L1BLOCKING 6 /* link1 blocking mode no-activity */
167 * Interface list structure.
170 uint32_t ifbic_len; /* buffer size */
173 struct ifbreq *ifbicu_req;
175 #define ifbic_buf ifbic_ifbicu.ifbicu_buf
176 #define ifbic_req ifbic_ifbicu.ifbicu_req
180 * Bridge address request.
183 char ifba_ifsname[IFNAMSIZ]; /* member if name */
184 unsigned long ifba_expire; /* address expire time */
185 uint8_t ifba_flags; /* address flags */
186 uint8_t ifba_dst[ETHER_ADDR_LEN];/* destination address */
189 #define IFBAF_TYPEMASK 0x03 /* address type mask */
190 #define IFBAF_DYNAMIC 0x00 /* dynamically learned address */
191 #define IFBAF_STATIC 0x01 /* static address */
193 #define IFBAFBITS "\020\1STATIC"
196 * Address list structure.
199 uint32_t ifbac_len; /* buffer size */
202 struct ifbareq *ifbacu_req;
204 #define ifbac_buf ifbac_ifbacu.ifbacu_buf
205 #define ifbac_req ifbac_ifbacu.ifbacu_req
209 * Bridge parameter structure.
213 uint32_t ifbrpu_int32;
214 uint16_t ifbrpu_int16;
218 #define ifbrp_csize ifbrp_ifbrpu.ifbrpu_int32 /* cache size */
219 #define ifbrp_ctime ifbrp_ifbrpu.ifbrpu_int32 /* cache time (sec) */
220 #define ifbrp_prio ifbrp_ifbrpu.ifbrpu_int16 /* bridge priority */
221 #define ifbrp_hellotime ifbrp_ifbrpu.ifbrpu_int8 /* hello time (sec) */
222 #define ifbrp_fwddelay ifbrp_ifbrpu.ifbrpu_int8 /* fwd time (sec) */
223 #define ifbrp_maxage ifbrp_ifbrpu.ifbrpu_int8 /* max age (sec) */
227 * Timekeeping structure used in spanning tree code.
229 struct bridge_timer {
234 struct bstp_config_unit {
236 uint64_t cu_bridge_id;
237 uint32_t cu_root_path_cost;
238 uint16_t cu_message_age;
240 uint16_t cu_hello_time;
241 uint16_t cu_forward_delay;
243 uint8_t cu_message_type;
244 uint8_t cu_topology_change_acknowledgment;
245 uint8_t cu_topology_change;
248 struct bstp_tcn_unit {
249 uint8_t tu_message_type;
253 * Bridge interface entry.
255 struct bridge_ifinfo {
256 uint64_t bifi_peer_root;
257 uint64_t bifi_peer_bridge;
258 uint32_t bifi_peer_cost;
259 uint16_t bifi_peer_port;
260 uint16_t bifi_unused02;
261 uint16_t bifi_port_id;
262 uint32_t bifi_path_cost;
263 struct bridge_timer bifi_hold_timer;
264 struct bridge_timer bifi_message_age_timer;
265 struct bridge_timer bifi_forward_delay_timer;
266 struct bridge_timer bifi_link1_timer;
267 struct bstp_config_unit bifi_config_bpdu;
268 uint32_t bifi_flags; /* member if flags */
270 uint8_t bifi_topology_change_acknowledge;
271 uint8_t bifi_config_pending;
272 uint8_t bifi_change_detection_enabled;
273 uint8_t bifi_priority;
274 struct ifnet *bifi_ifp; /* member if */
275 int bifi_mutecap; /* member muted caps */
276 int bifi_bond_weight; /* when link2 active */
279 #define bif_peer_root bif_info->bifi_peer_root
280 #define bif_peer_bridge bif_info->bifi_peer_bridge
281 #define bif_peer_cost bif_info->bifi_peer_cost
282 #define bif_peer_port bif_info->bifi_peer_port
283 #define bif_path_cost bif_info->bifi_path_cost
284 #define bif_hold_timer bif_info->bifi_hold_timer
285 #define bif_message_age_timer bif_info->bifi_message_age_timer
286 #define bif_forward_delay_timer bif_info->bifi_forward_delay_timer
287 #define bif_link1_timer bif_info->bifi_link1_timer
288 #define bif_config_bpdu bif_info->bifi_config_bpdu
289 #define bif_port_id bif_info->bifi_port_id
290 #define bif_state bif_info->bifi_state
291 #define bif_flags bif_info->bifi_flags
292 #define bif_topology_change_acknowledge \
293 bif_info->bifi_topology_change_acknowledge
294 #define bif_config_pending bif_info->bifi_config_pending
295 #define bif_change_detection_enabled bif_info->bifi_change_detection_enabled
296 #define bif_priority bif_info->bifi_priority
297 #define bif_message_age_timer bif_info->bifi_message_age_timer
298 #define bif_bond_weight bif_info->bifi_bond_weight
301 * Bridge interface list entry.
303 struct bridge_iflist {
304 TAILQ_ENTRY(bridge_iflist) bif_next;
305 struct ifnet *bif_ifp; /* member if */
307 struct bridge_ifinfo *bif_info;
308 int bif_bond_count; /* when link2 active */
310 TAILQ_HEAD(bridge_iflist_head, bridge_iflist);
315 struct bridge_rtinfo {
316 struct ifnet *bri_ifp; /* destination if */
317 unsigned long bri_expire; /* expiration time */
318 uint8_t bri_flags; /* address flags */
326 struct bridge_rtnode {
327 LIST_ENTRY(bridge_rtnode) brt_hash; /* hash table linkage */
328 LIST_ENTRY(bridge_rtnode) brt_list; /* list linkage */
329 uint8_t brt_addr[ETHER_ADDR_LEN];
331 struct bridge_rtinfo *brt_info;
333 LIST_HEAD(bridge_rtnode_head, bridge_rtnode);
336 * Software state for each bridge.
338 struct bridge_softc {
339 struct arpcom sc_arp;
340 struct ifnet *sc_ifp; /* make this an interface */
341 LIST_ENTRY(bridge_softc) sc_list;
342 uint64_t sc_bridge_id;
343 uint64_t sc_designated_root;
344 uint64_t sc_designated_bridge;
345 uint32_t sc_designated_cost; /* root path cost */
346 uint16_t sc_designated_port;
347 uint16_t sc_unused01;
348 struct bridge_iflist *sc_root_port;
350 uint16_t sc_hello_time;
351 uint16_t sc_forward_delay;
352 uint16_t sc_bridge_max_age;
353 uint16_t sc_bridge_hello_time;
354 uint16_t sc_bridge_forward_delay;
355 uint16_t sc_topology_change_time;
356 uint16_t sc_hold_time;
357 uint16_t sc_bridge_priority;
358 uint8_t sc_topology_change_detected;
359 uint8_t sc_topology_change;
360 struct bridge_timer sc_hello_timer;
361 struct bridge_timer sc_topology_change_timer;
362 struct bridge_timer sc_tcn_timer;
363 uint32_t sc_brtmax; /* max # of addresses */
364 uint32_t sc_brtcnt; /* cur. # of addresses */
365 uint32_t sc_brttimeout; /* rt timeout in seconds */
366 struct callout sc_brcallout; /* bridge callout */
367 struct netmsg_base sc_brtimemsg; /* bridge callout msg */
368 struct callout sc_bstpcallout; /* STP callout */
369 struct netmsg_base sc_bstptimemsg; /* STP callout msg */
370 struct bridge_iflist_head *sc_iflists; /* percpu member if lists */
371 struct bridge_rtnode_head **sc_rthashs; /* percpu forwarding tables */
372 struct bridge_rtnode_head *sc_rtlists; /* percpu lists of the above */
373 uint32_t sc_rthash_key; /* key for hash */
374 struct bridge_iflist_head sc_spanlist; /* span ports list */
375 int sc_span; /* has span ports */
376 struct bridge_timer sc_link_timer;
377 int sc_copy_flags; /* copy if_flags */
379 #define sc_if sc_arp.ac_if
381 #define BRIDGE_CFGCPU 0
382 #define BRIDGE_CFGPORT netisr_portfn(BRIDGE_CFGCPU)
384 extern const uint8_t bstp_etheraddr[];
386 void bridge_rtdelete(struct bridge_softc *, struct ifnet *ifp, int);
388 extern void (*bstp_linkstate_p)(struct ifnet *ifp, int state);
390 void bstp_initialization(struct bridge_softc *);
391 void bstp_linkstate(struct ifnet *, int);
392 void bstp_stop(struct bridge_softc *);
393 void bstp_input(struct bridge_softc *, struct bridge_iflist *,
395 void bstp_tick_handler(netmsg_t);
396 int bstp_supersedes_port_info(struct bridge_softc *,
397 struct bridge_iflist *);
400 void bridge_enqueue(struct ifnet *, struct mbuf *);
404 #endif /* !_NET_IF_BRIDGEVAR_H */