if_bridgevar.h revision 156328
1/* $NetBSD: if_bridgevar.h,v 1.4 2003/07/08 07:13:50 itojun 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@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 * $FreeBSD: head/sys/net/if_bridgevar.h 156328 2006-03-06 02:28:41Z thompsa $ 71 */ 72 73/* 74 * Data structure and control definitions for bridge interfaces. 75 */ 76 77#include <sys/callout.h> 78#include <sys/queue.h> 79#include <sys/condvar.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 BRDGADDS 23 /* add bridge span member (ifbreq) */ 110#define BRDGDELS 24 /* delete bridge span member (ifbreq) */ 111 112/* 113 * Generic bridge control request. 114 */ 115struct 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#define IFBIF_SPAN 0x08 /* if is a span port */ 129 130#define IFBIFBITS "\020\1LEARNING\2DISCOVER\3STP\4SPAN" 131 132/* BRDGFLUSH */ 133#define IFBF_FLUSHDYN 0x00 /* flush learned addresses only */ 134#define IFBF_FLUSHALL 0x01 /* flush all addresses */ 135 136/* STP port states */ 137#define BSTP_IFSTATE_DISABLED 0 138#define BSTP_IFSTATE_LISTENING 1 139#define BSTP_IFSTATE_LEARNING 2 140#define BSTP_IFSTATE_FORWARDING 3 141#define BSTP_IFSTATE_BLOCKING 4 142 143/* 144 * Interface list structure. 145 */ 146struct ifbifconf { 147 uint32_t ifbic_len; /* buffer size */ 148 union { 149 caddr_t ifbicu_buf; 150 struct ifbreq *ifbicu_req; 151 } ifbic_ifbicu; 152#define ifbic_buf ifbic_ifbicu.ifbicu_buf 153#define ifbic_req ifbic_ifbicu.ifbicu_req 154}; 155 156/* 157 * Bridge address request. 158 */ 159struct ifbareq { 160 char ifba_ifsname[IFNAMSIZ]; /* member if name */ 161 unsigned long ifba_expire; /* address expire time */ 162 uint8_t ifba_flags; /* address flags */ 163 uint8_t ifba_dst[ETHER_ADDR_LEN];/* destination address */ 164}; 165 166#define IFBAF_TYPEMASK 0x03 /* address type mask */ 167#define IFBAF_DYNAMIC 0x00 /* dynamically learned address */ 168#define IFBAF_STATIC 0x01 /* static address */ 169 170#define IFBAFBITS "\020\1STATIC" 171 172/* 173 * Address list structure. 174 */ 175struct ifbaconf { 176 uint32_t ifbac_len; /* buffer size */ 177 union { 178 caddr_t ifbacu_buf; 179 struct ifbareq *ifbacu_req; 180 } ifbac_ifbacu; 181#define ifbac_buf ifbac_ifbacu.ifbacu_buf 182#define ifbac_req ifbac_ifbacu.ifbacu_req 183}; 184 185/* 186 * Bridge parameter structure. 187 */ 188struct ifbrparam { 189 union { 190 uint32_t ifbrpu_int32; 191 uint16_t ifbrpu_int16; 192 uint8_t ifbrpu_int8; 193 } ifbrp_ifbrpu; 194}; 195#define ifbrp_csize ifbrp_ifbrpu.ifbrpu_int32 /* cache size */ 196#define ifbrp_ctime ifbrp_ifbrpu.ifbrpu_int32 /* cache time (sec) */ 197#define ifbrp_prio ifbrp_ifbrpu.ifbrpu_int16 /* bridge priority */ 198#define ifbrp_hellotime ifbrp_ifbrpu.ifbrpu_int8 /* hello time (sec) */ 199#define ifbrp_fwddelay ifbrp_ifbrpu.ifbrpu_int8 /* fwd time (sec) */ 200#define ifbrp_maxage ifbrp_ifbrpu.ifbrpu_int8 /* max age (sec) */ 201 202#ifdef _KERNEL 203/* 204 * Timekeeping structure used in spanning tree code. 205 */ 206struct bridge_timer { 207 uint16_t active; 208 uint16_t value; 209}; 210 211struct bstp_config_unit { 212 uint64_t cu_rootid; 213 uint64_t cu_bridge_id; 214 uint32_t cu_root_path_cost; 215 uint16_t cu_message_age; 216 uint16_t cu_max_age; 217 uint16_t cu_hello_time; 218 uint16_t cu_forward_delay; 219 uint16_t cu_port_id; 220 uint8_t cu_message_type; 221 uint8_t cu_topology_change_acknowledgment; 222 uint8_t cu_topology_change; 223}; 224 225struct bstp_tcn_unit { 226 uint8_t tu_message_type; 227}; 228 229/* 230 * Bridge interface list entry. 231 */ 232struct bridge_iflist { 233 LIST_ENTRY(bridge_iflist) bif_next; 234 uint64_t bif_designated_root; 235 uint64_t bif_designated_bridge; 236 uint32_t bif_path_cost; 237 uint32_t bif_designated_cost; 238 struct bridge_timer bif_hold_timer; 239 struct bridge_timer bif_message_age_timer; 240 struct bridge_timer bif_forward_delay_timer; 241 struct bstp_config_unit bif_config_bpdu; 242 uint16_t bif_port_id; 243 uint16_t bif_designated_port; 244 uint8_t bif_state; 245 uint8_t bif_topology_change_acknowledge; 246 uint8_t bif_config_pending; 247 uint8_t bif_change_detection_enabled; 248 uint8_t bif_priority; 249 struct ifnet *bif_ifp; /* member if */ 250 uint32_t bif_flags; /* member if flags */ 251 int bif_mutecap; /* member muted caps */ 252}; 253 254/* 255 * Bridge route node. 256 */ 257struct bridge_rtnode { 258 LIST_ENTRY(bridge_rtnode) brt_hash; /* hash table linkage */ 259 LIST_ENTRY(bridge_rtnode) brt_list; /* list linkage */ 260 struct ifnet *brt_ifp; /* destination if */ 261 unsigned long brt_expire; /* expiration time */ 262 uint8_t brt_flags; /* address flags */ 263 uint8_t brt_addr[ETHER_ADDR_LEN]; 264}; 265 266/* 267 * Software state for each bridge. 268 */ 269struct bridge_softc { 270 struct ifnet *sc_ifp; /* make this an interface */ 271 LIST_ENTRY(bridge_softc) sc_list; 272 struct mtx sc_mtx; 273 struct cv sc_cv; 274 uint64_t sc_designated_root; 275 uint64_t sc_bridge_id; 276 struct bridge_iflist *sc_root_port; 277 uint32_t sc_root_path_cost; 278 uint16_t sc_max_age; 279 uint16_t sc_hello_time; 280 uint16_t sc_forward_delay; 281 uint16_t sc_bridge_max_age; 282 uint16_t sc_bridge_hello_time; 283 uint16_t sc_bridge_forward_delay; 284 uint16_t sc_topology_change_time; 285 uint16_t sc_hold_time; 286 uint16_t sc_bridge_priority; 287 uint8_t sc_topology_change_detected; 288 uint8_t sc_topology_change; 289 struct bridge_timer sc_hello_timer; 290 struct bridge_timer sc_topology_change_timer; 291 struct bridge_timer sc_tcn_timer; 292 uint32_t sc_brtmax; /* max # of addresses */ 293 uint32_t sc_brtcnt; /* cur. # of addresses */ 294 uint32_t sc_brttimeout; /* rt timeout in seconds */ 295 struct callout sc_brcallout; /* bridge callout */ 296 struct callout sc_bstpcallout; /* STP callout */ 297 uint32_t sc_iflist_ref; /* refcount for sc_iflist */ 298 uint32_t sc_iflist_xcnt; /* refcount for sc_iflist */ 299 LIST_HEAD(, bridge_iflist) sc_iflist; /* member interface list */ 300 LIST_HEAD(, bridge_rtnode) *sc_rthash; /* our forwarding table */ 301 LIST_HEAD(, bridge_rtnode) sc_rtlist; /* list version of above */ 302 uint32_t sc_rthash_key; /* key for hash */ 303 LIST_HEAD(, bridge_iflist) sc_spanlist; /* span ports list */ 304 struct bridge_timer sc_link_timer; 305}; 306 307#define BRIDGE_LOCK_INIT(_sc) do { \ 308 mtx_init(&(_sc)->sc_mtx, "if_bridge", NULL, MTX_DEF); \ 309 cv_init(&(_sc)->sc_cv, "if_bridge_cv"); \ 310} while (0) 311#define BRIDGE_LOCK_DESTROY(_sc) do { \ 312 mtx_destroy(&(_sc)->sc_mtx); \ 313 cv_destroy(&(_sc)->sc_cv); \ 314} while (0) 315#define BRIDGE_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx) 316#define BRIDGE_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx) 317#define BRIDGE_LOCKED(_sc) mtx_owned(&(_sc)->sc_mtx) 318#define BRIDGE_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->sc_mtx, MA_OWNED) 319#define BRIDGE_LOCK2REF(_sc, _err) do { \ 320 mtx_assert(&(_sc)->sc_mtx, MA_OWNED); \ 321 if ((_sc)->sc_iflist_xcnt > 0) \ 322 (_err) = EBUSY; \ 323 else \ 324 (_sc)->sc_iflist_ref++; \ 325 mtx_unlock(&(_sc)->sc_mtx); \ 326} while (0) 327#define BRIDGE_UNREF(_sc) do { \ 328 mtx_lock(&(_sc)->sc_mtx); \ 329 (_sc)->sc_iflist_ref--; \ 330 if (((_sc)->sc_iflist_xcnt > 0) && ((_sc)->sc_iflist_ref == 0)) \ 331 cv_broadcast(&(_sc)->sc_cv); \ 332 mtx_unlock(&(_sc)->sc_mtx); \ 333} while (0) 334#define BRIDGE_XLOCK(_sc) do { \ 335 mtx_assert(&(_sc)->sc_mtx, MA_OWNED); \ 336 (_sc)->sc_iflist_xcnt++; \ 337 while ((_sc)->sc_iflist_ref > 0) \ 338 cv_wait(&(_sc)->sc_cv, &(_sc)->sc_mtx); \ 339} while (0) 340#define BRIDGE_XDROP(_sc) do { \ 341 mtx_assert(&(_sc)->sc_mtx, MA_OWNED); \ 342 (_sc)->sc_iflist_xcnt--; \ 343} while (0) 344 345#define BRIDGE_INPUT(_ifp, _m) do { \ 346 KASSERT(bridge_input_p != NULL, \ 347 ("%s: if_bridge not loaded!", __func__)); \ 348 _m = (*bridge_input_p)(_ifp, _m); \ 349 if (_m != NULL) \ 350 _ifp = _m->m_pkthdr.rcvif; \ 351} while (0) 352 353#define BRIDGE_OUTPUT(_ifp, _m, _err) do { \ 354 KASSERT(bridge_output_p != NULL, \ 355 ("%s: if_bridge not loaded!", __func__)); \ 356 _err = (*bridge_output_p)(_ifp, _m, NULL, NULL); \ 357} while (0) 358 359extern const uint8_t bstp_etheraddr[]; 360 361void bridge_enqueue(struct bridge_softc *, struct ifnet *, struct mbuf *); 362void bridge_rtdelete(struct bridge_softc *, struct ifnet *ifp, int); 363 364extern struct mbuf *(*bridge_input_p)(struct ifnet *, struct mbuf *); 365extern int (*bridge_output_p)(struct ifnet *, struct mbuf *, 366 struct sockaddr *, struct rtentry *); 367extern void (*bridge_dn_p)(struct mbuf *, struct ifnet *); 368extern void (*bstp_linkstate_p)(struct ifnet *ifp, int state); 369 370void bstp_initialization(struct bridge_softc *); 371void bstp_linkstate(struct ifnet *, int); 372void bstp_stop(struct bridge_softc *); 373struct mbuf *bstp_input(struct ifnet *, struct mbuf *); 374 375 376#endif /* _KERNEL */ 377