if_bridgevar.h revision 160769
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 160769 2006-07-27 21:01:48Z 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/* 137 * Interface list structure. 138 */ 139struct ifbifconf { 140 uint32_t ifbic_len; /* buffer size */ 141 union { 142 caddr_t ifbicu_buf; 143 struct ifbreq *ifbicu_req; 144 } ifbic_ifbicu; 145#define ifbic_buf ifbic_ifbicu.ifbicu_buf 146#define ifbic_req ifbic_ifbicu.ifbicu_req 147}; 148 149/* 150 * Bridge address request. 151 */ 152struct ifbareq { 153 char ifba_ifsname[IFNAMSIZ]; /* member if name */ 154 unsigned long ifba_expire; /* address expire time */ 155 uint8_t ifba_flags; /* address flags */ 156 uint8_t ifba_dst[ETHER_ADDR_LEN];/* destination address */ 157}; 158 159#define IFBAF_TYPEMASK 0x03 /* address type mask */ 160#define IFBAF_DYNAMIC 0x00 /* dynamically learned address */ 161#define IFBAF_STATIC 0x01 /* static address */ 162 163#define IFBAFBITS "\020\1STATIC" 164 165/* 166 * Address list structure. 167 */ 168struct ifbaconf { 169 uint32_t ifbac_len; /* buffer size */ 170 union { 171 caddr_t ifbacu_buf; 172 struct ifbareq *ifbacu_req; 173 } ifbac_ifbacu; 174#define ifbac_buf ifbac_ifbacu.ifbacu_buf 175#define ifbac_req ifbac_ifbacu.ifbacu_req 176}; 177 178/* 179 * Bridge parameter structure. 180 */ 181struct ifbrparam { 182 union { 183 uint32_t ifbrpu_int32; 184 uint16_t ifbrpu_int16; 185 uint8_t ifbrpu_int8; 186 } ifbrp_ifbrpu; 187}; 188#define ifbrp_csize ifbrp_ifbrpu.ifbrpu_int32 /* cache size */ 189#define ifbrp_ctime ifbrp_ifbrpu.ifbrpu_int32 /* cache time (sec) */ 190#define ifbrp_prio ifbrp_ifbrpu.ifbrpu_int16 /* bridge priority */ 191#define ifbrp_hellotime ifbrp_ifbrpu.ifbrpu_int8 /* hello time (sec) */ 192#define ifbrp_fwddelay ifbrp_ifbrpu.ifbrpu_int8 /* fwd time (sec) */ 193#define ifbrp_maxage ifbrp_ifbrpu.ifbrpu_int8 /* max age (sec) */ 194 195#ifdef _KERNEL 196 197#define BRIDGE_LOCK_INIT(_sc) do { \ 198 mtx_init(&(_sc)->sc_mtx, "if_bridge", NULL, MTX_DEF); \ 199 cv_init(&(_sc)->sc_cv, "if_bridge_cv"); \ 200} while (0) 201#define BRIDGE_LOCK_DESTROY(_sc) do { \ 202 mtx_destroy(&(_sc)->sc_mtx); \ 203 cv_destroy(&(_sc)->sc_cv); \ 204} while (0) 205#define BRIDGE_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx) 206#define BRIDGE_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx) 207#define BRIDGE_LOCKED(_sc) mtx_owned(&(_sc)->sc_mtx) 208#define BRIDGE_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->sc_mtx, MA_OWNED) 209#define BRIDGE_LOCK2REF(_sc, _err) do { \ 210 mtx_assert(&(_sc)->sc_mtx, MA_OWNED); \ 211 if ((_sc)->sc_iflist_xcnt > 0) \ 212 (_err) = EBUSY; \ 213 else \ 214 (_sc)->sc_iflist_ref++; \ 215 mtx_unlock(&(_sc)->sc_mtx); \ 216} while (0) 217#define BRIDGE_UNREF(_sc) do { \ 218 mtx_lock(&(_sc)->sc_mtx); \ 219 (_sc)->sc_iflist_ref--; \ 220 if (((_sc)->sc_iflist_xcnt > 0) && ((_sc)->sc_iflist_ref == 0)) \ 221 cv_broadcast(&(_sc)->sc_cv); \ 222 mtx_unlock(&(_sc)->sc_mtx); \ 223} while (0) 224#define BRIDGE_XLOCK(_sc) do { \ 225 mtx_assert(&(_sc)->sc_mtx, MA_OWNED); \ 226 (_sc)->sc_iflist_xcnt++; \ 227 while ((_sc)->sc_iflist_ref > 0) \ 228 cv_wait(&(_sc)->sc_cv, &(_sc)->sc_mtx); \ 229} while (0) 230#define BRIDGE_XDROP(_sc) do { \ 231 mtx_assert(&(_sc)->sc_mtx, MA_OWNED); \ 232 (_sc)->sc_iflist_xcnt--; \ 233} while (0) 234 235#define BRIDGE_INPUT(_ifp, _m) do { \ 236 KASSERT(bridge_input_p != NULL, \ 237 ("%s: if_bridge not loaded!", __func__)); \ 238 _m = (*bridge_input_p)(_ifp, _m); \ 239 if (_m != NULL) \ 240 _ifp = _m->m_pkthdr.rcvif; \ 241} while (0) 242 243#define BRIDGE_OUTPUT(_ifp, _m, _err) do { \ 244 KASSERT(bridge_output_p != NULL, \ 245 ("%s: if_bridge not loaded!", __func__)); \ 246 _err = (*bridge_output_p)(_ifp, _m, NULL, NULL); \ 247} while (0) 248 249extern struct mbuf *(*bridge_input_p)(struct ifnet *, struct mbuf *); 250extern int (*bridge_output_p)(struct ifnet *, struct mbuf *, 251 struct sockaddr *, struct rtentry *); 252extern void (*bridge_dn_p)(struct mbuf *, struct ifnet *); 253 254#endif /* _KERNEL */ 255