1 /* $NetBSD: if_bridgevar.h,v 1.4 2003/07/08 07:13:50 itojun Exp $ */
4 * Copyright 2001 Wasabi Systems, Inc.
7 * Written by Jason R. Thorpe for Wasabi Systems, Inc.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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
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.
39 * Copyright (c) 1999, 2000 Jason L. Wright (jason@thought.net)
40 * All rights reserved.
42 * Redistribution and use in source and binary forms, with or without
43 * modification, are permitted provided that the following conditions
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.
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.
68 * OpenBSD: if_bridge.h,v 1.14 2001/03/22 03:48:29 jason Exp
74 * Data structure and control definitions for bridge interfaces.
77 #include <sys/callout.h>
78 #include <sys/queue.h>
79 #include <sys/condvar.h>
82 * Commands used in the SIOCSDRVSPEC ioctl. Note the lookup of the
83 * bridge interface itself is keyed off the ifdrv structure.
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) */
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 BRDGADDS 23 /* add bridge span member (ifbreq) */
110 #define BRDGDELS 24 /* delete bridge span member (ifbreq) */
111 #define BRDGPARAM 25 /* get bridge STP params (ifbropreq) */
112 #define BRDGGRTE 26 /* get cache drops (ifbrparam) */
113 #define BRDGGIFSSTP 27 /* get member STP params list
115 #define BRDGSPROTO 28 /* set protocol (ifbrparam) */
116 #define BRDGSTXHC 29 /* set tx hold count (ifbrparam) */
117 #define BRDGSEDGE 30 /* set edge status (ifbreq) */
118 #define BRDGSAEDGE 31 /* set autoedge status (ifbreq) */
121 * Generic bridge control request.
124 char ifbr_ifsname[IFNAMSIZ]; /* member if name */
125 uint32_t ifbr_ifsflags; /* member if flags */
126 uint32_t ifbr_stpflags; /* member if STP flags */
127 uint8_t ifbr_edge; /* member if STP edge */
128 uint8_t ifbr_autoedge; /* member if STP autoedge */
129 uint8_t ifbr_p2p; /* member if STP p2p */
130 uint32_t ifbr_path_cost; /* member if STP cost */
131 uint8_t ifbr_portno; /* member if port number */
132 uint8_t ifbr_priority; /* member if STP priority */
133 uint8_t ifbr_proto; /* member if STP protocol */
134 uint8_t ifbr_role; /* member if STP role */
135 uint8_t ifbr_state; /* member if STP state */
138 /* BRDGGIFFLAGS, BRDGSIFFLAGS */
139 #define IFBIF_LEARNING 0x01 /* if can learn */
140 #define IFBIF_DISCOVER 0x02 /* if sends packets w/ unknown dest. */
141 #define IFBIF_STP 0x04 /* if participates in spanning tree */
142 #define IFBIF_SPAN 0x08 /* if is a span port */
144 #define IFBIFBITS "\020\1LEARNING\2DISCOVER\3STP\4SPAN"
147 #define IFBF_FLUSHDYN 0x00 /* flush learned addresses only */
148 #define IFBF_FLUSHALL 0x01 /* flush all addresses */
151 * Interface list structure.
154 uint32_t ifbic_len; /* buffer size */
157 struct ifbreq *ifbicu_req;
159 #define ifbic_buf ifbic_ifbicu.ifbicu_buf
160 #define ifbic_req ifbic_ifbicu.ifbicu_req
164 * Bridge address request.
167 char ifba_ifsname[IFNAMSIZ]; /* member if name */
168 unsigned long ifba_expire; /* address expire time */
169 uint8_t ifba_flags; /* address flags */
170 uint8_t ifba_dst[ETHER_ADDR_LEN];/* destination address */
173 #define IFBAF_TYPEMASK 0x03 /* address type mask */
174 #define IFBAF_DYNAMIC 0x00 /* dynamically learned address */
175 #define IFBAF_STATIC 0x01 /* static address */
177 #define IFBAFBITS "\020\1STATIC"
180 * Address list structure.
183 uint32_t ifbac_len; /* buffer size */
186 struct ifbareq *ifbacu_req;
188 #define ifbac_buf ifbac_ifbacu.ifbacu_buf
189 #define ifbac_req ifbac_ifbacu.ifbacu_req
193 * Bridge parameter structure.
197 uint32_t ifbrpu_int32;
198 uint16_t ifbrpu_int16;
202 #define ifbrp_csize ifbrp_ifbrpu.ifbrpu_int32 /* cache size */
203 #define ifbrp_ctime ifbrp_ifbrpu.ifbrpu_int32 /* cache time (sec) */
204 #define ifbrp_prio ifbrp_ifbrpu.ifbrpu_int16 /* bridge priority */
205 #define ifbrp_proto ifbrp_ifbrpu.ifbrpu_int8 /* bridge protocol */
206 #define ifbrp_txhc ifbrp_ifbrpu.ifbrpu_int8 /* bpdu tx holdcount */
207 #define ifbrp_hellotime ifbrp_ifbrpu.ifbrpu_int8 /* hello time (sec) */
208 #define ifbrp_fwddelay ifbrp_ifbrpu.ifbrpu_int8 /* fwd time (sec) */
209 #define ifbrp_maxage ifbrp_ifbrpu.ifbrpu_int8 /* max age (sec) */
210 #define ifbrp_cexceeded ifbrp_ifbrpu.ifbrpu_int32 /* # of cache dropped
213 * Bridge current operational parameters structure.
216 uint8_t ifbop_holdcount;
217 uint8_t ifbop_maxage;
218 uint8_t ifbop_hellotime;
219 uint8_t ifbop_fwddelay;
220 uint8_t ifbop_protocol;
221 uint16_t ifbop_priority;
222 uint16_t ifbop_root_port;
223 uint32_t ifbop_root_path_cost;
224 uint64_t ifbop_designated_root;
225 struct timeval ifbop_last_tc_time;
229 * Bridge member operational STP params structure.
232 uint8_t ifbp_portno; /* bp STP port number */
233 uint32_t ifbp_fwd_trans; /* bp STP fwd transitions */
234 uint32_t ifbp_design_cost; /* bp STP designated cost */
235 uint32_t ifbp_design_port; /* bp STP designated port */
236 uint64_t ifbp_design_bridge; /* bp STP designated bridge */
237 uint64_t ifbp_design_root; /* bp STP designated root */
241 * Bridge STP ports list structure.
244 uint32_t ifbpstp_len; /* buffer size */
246 caddr_t ifbpstpu_buf;
247 struct ifbpstpreq *ifbpstpu_req;
249 #define ifbpstp_buf ifbpstp_ifbpstpu.ifbpstpu_buf
250 #define ifbpstp_req ifbpstp_ifbpstpu.ifbpstpu_req
255 #define BRIDGE_LOCK_INIT(_sc) do { \
256 mtx_init(&(_sc)->sc_mtx, "if_bridge", NULL, MTX_DEF); \
257 cv_init(&(_sc)->sc_cv, "if_bridge_cv"); \
259 #define BRIDGE_LOCK_DESTROY(_sc) do { \
260 mtx_destroy(&(_sc)->sc_mtx); \
261 cv_destroy(&(_sc)->sc_cv); \
263 #define BRIDGE_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx)
264 #define BRIDGE_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx)
265 #define BRIDGE_LOCKED(_sc) mtx_owned(&(_sc)->sc_mtx)
266 #define BRIDGE_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->sc_mtx, MA_OWNED)
267 #define BRIDGE_LOCK2REF(_sc, _err) do { \
268 mtx_assert(&(_sc)->sc_mtx, MA_OWNED); \
269 if ((_sc)->sc_iflist_xcnt > 0) \
272 (_sc)->sc_iflist_ref++; \
273 mtx_unlock(&(_sc)->sc_mtx); \
275 #define BRIDGE_UNREF(_sc) do { \
276 mtx_lock(&(_sc)->sc_mtx); \
277 (_sc)->sc_iflist_ref--; \
278 if (((_sc)->sc_iflist_xcnt > 0) && ((_sc)->sc_iflist_ref == 0)) \
279 cv_broadcast(&(_sc)->sc_cv); \
280 mtx_unlock(&(_sc)->sc_mtx); \
282 #define BRIDGE_XLOCK(_sc) do { \
283 mtx_assert(&(_sc)->sc_mtx, MA_OWNED); \
284 (_sc)->sc_iflist_xcnt++; \
285 while ((_sc)->sc_iflist_ref > 0) \
286 cv_wait(&(_sc)->sc_cv, &(_sc)->sc_mtx); \
288 #define BRIDGE_XDROP(_sc) do { \
289 mtx_assert(&(_sc)->sc_mtx, MA_OWNED); \
290 (_sc)->sc_iflist_xcnt--; \
293 #define BRIDGE_INPUT(_ifp, _m) do { \
294 KASSERT(bridge_input_p != NULL, \
295 ("%s: if_bridge not loaded!", __func__)); \
296 _m = (*bridge_input_p)(_ifp, _m); \
298 _ifp = _m->m_pkthdr.rcvif; \
301 #define BRIDGE_OUTPUT(_ifp, _m, _err) do { \
302 KASSERT(bridge_output_p != NULL, \
303 ("%s: if_bridge not loaded!", __func__)); \
304 _err = (*bridge_output_p)(_ifp, _m, NULL, NULL); \
307 extern struct mbuf *(*bridge_input_p)(struct ifnet *, struct mbuf *);
308 extern int (*bridge_output_p)(struct ifnet *, struct mbuf *,
309 struct sockaddr *, struct rtentry *);
310 extern void (*bridge_dn_p)(struct mbuf *, struct ifnet *);