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$ 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 #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 114 * (ifbpstpconf) */ 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) */ 119 120 /* 121 * Generic bridge control request. 122 */ 123 struct ifbreq { 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 */ 136 }; 137 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 */ 143 #define IFBIF_STICKY 0x10 /* if learned addresses stick */ 144 145 #define IFBIFBITS "\020\1LEARNING\2DISCOVER\3STP\4SPAN\5STICKY" 146 147 /* BRDGFLUSH */ 148 #define IFBF_FLUSHDYN 0x00 /* flush learned addresses only */ 149 #define IFBF_FLUSHALL 0x01 /* flush all addresses */ 150 151 /* 152 * Interface list structure. 153 */ 154 struct ifbifconf { 155 uint32_t ifbic_len; /* buffer size */ 156 union { 157 caddr_t ifbicu_buf; 158 struct ifbreq *ifbicu_req; 159 } ifbic_ifbicu; 160 #define ifbic_buf ifbic_ifbicu.ifbicu_buf 161 #define ifbic_req ifbic_ifbicu.ifbicu_req 162 }; 163 164 /* 165 * Bridge address request. 166 */ 167 struct ifbareq { 168 char ifba_ifsname[IFNAMSIZ]; /* member if name */ 169 unsigned long ifba_expire; /* address expire time */ 170 uint8_t ifba_flags; /* address flags */ 171 uint8_t ifba_dst[ETHER_ADDR_LEN];/* destination address */ 172 }; 173 174 #define IFBAF_TYPEMASK 0x03 /* address type mask */ 175 #define IFBAF_DYNAMIC 0x00 /* dynamically learned address */ 176 #define IFBAF_STATIC 0x01 /* static address */ 177 #define IFBAF_STICKY 0x02 /* sticky address */ 178 179 #define IFBAFBITS "\020\1STATIC\2STICKY" 180 181 /* 182 * Address list structure. 183 */ 184 struct ifbaconf { 185 uint32_t ifbac_len; /* buffer size */ 186 union { 187 caddr_t ifbacu_buf; 188 struct ifbareq *ifbacu_req; 189 } ifbac_ifbacu; 190 #define ifbac_buf ifbac_ifbacu.ifbacu_buf 191 #define ifbac_req ifbac_ifbacu.ifbacu_req 192 }; 193 194 /* 195 * Bridge parameter structure. 196 */ 197 struct ifbrparam { 198 union { 199 uint32_t ifbrpu_int32; 200 uint16_t ifbrpu_int16; 201 uint8_t ifbrpu_int8; 202 } ifbrp_ifbrpu; 203 }; 204 #define ifbrp_csize ifbrp_ifbrpu.ifbrpu_int32 /* cache size */ 205 #define ifbrp_ctime ifbrp_ifbrpu.ifbrpu_int32 /* cache time (sec) */ 206 #define ifbrp_prio ifbrp_ifbrpu.ifbrpu_int16 /* bridge priority */ 207 #define ifbrp_proto ifbrp_ifbrpu.ifbrpu_int8 /* bridge protocol */ 208 #define ifbrp_txhc ifbrp_ifbrpu.ifbrpu_int8 /* bpdu tx holdcount */ 209 #define ifbrp_hellotime ifbrp_ifbrpu.ifbrpu_int8 /* hello time (sec) */ 210 #define ifbrp_fwddelay ifbrp_ifbrpu.ifbrpu_int8 /* fwd time (sec) */ 211 #define ifbrp_maxage ifbrp_ifbrpu.ifbrpu_int8 /* max age (sec) */ 212 #define ifbrp_cexceeded ifbrp_ifbrpu.ifbrpu_int32 /* # of cache dropped 213 * adresses */ 214 /* 215 * Bridge current operational parameters structure. 216 */ 217 struct ifbropreq { 218 uint8_t ifbop_holdcount; 219 uint8_t ifbop_maxage; 220 uint8_t ifbop_hellotime; 221 uint8_t ifbop_fwddelay; 222 uint8_t ifbop_protocol; 223 uint16_t ifbop_priority; 224 uint16_t ifbop_root_port; 225 uint32_t ifbop_root_path_cost; 226 uint64_t ifbop_designated_root; 227 struct timeval ifbop_last_tc_time; 228 }; 229 230 /* 231 * Bridge member operational STP params structure. 232 */ 233 struct ifbpstpreq { 234 uint8_t ifbp_portno; /* bp STP port number */ 235 uint32_t ifbp_fwd_trans; /* bp STP fwd transitions */ 236 uint32_t ifbp_design_cost; /* bp STP designated cost */ 237 uint32_t ifbp_design_port; /* bp STP designated port */ 238 uint64_t ifbp_design_bridge; /* bp STP designated bridge */ 239 uint64_t ifbp_design_root; /* bp STP designated root */ 240 }; 241 242 /* 243 * Bridge STP ports list structure. 244 */ 245 struct ifbpstpconf { 246 uint32_t ifbpstp_len; /* buffer size */ 247 union { 248 caddr_t ifbpstpu_buf; 249 struct ifbpstpreq *ifbpstpu_req; 250 } ifbpstp_ifbpstpu; 251 #define ifbpstp_buf ifbpstp_ifbpstpu.ifbpstpu_buf 252 #define ifbpstp_req ifbpstp_ifbpstpu.ifbpstpu_req 253 }; 254 255 #ifdef _KERNEL 256 257 #define BRIDGE_LOCK_INIT(_sc) do { \ 258 mtx_init(&(_sc)->sc_mtx, "if_bridge", NULL, MTX_DEF); \ 259 cv_init(&(_sc)->sc_cv, "if_bridge_cv"); \ 260 } while (0) 261 #define BRIDGE_LOCK_DESTROY(_sc) do { \ 262 mtx_destroy(&(_sc)->sc_mtx); \ 263 cv_destroy(&(_sc)->sc_cv); \ 264 } while (0) 265 #define BRIDGE_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx) 266 #define BRIDGE_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx) 267 #define BRIDGE_LOCKED(_sc) mtx_owned(&(_sc)->sc_mtx) 268 #define BRIDGE_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->sc_mtx, MA_OWNED) 269 #define BRIDGE_LOCK2REF(_sc, _err) do { \ 270 mtx_assert(&(_sc)->sc_mtx, MA_OWNED); \ 271 if ((_sc)->sc_iflist_xcnt > 0) \ 272 (_err) = EBUSY; \ 273 else \ 274 (_sc)->sc_iflist_ref++; \ 275 mtx_unlock(&(_sc)->sc_mtx); \ 276 } while (0) 277 #define BRIDGE_UNREF(_sc) do { \ 278 mtx_lock(&(_sc)->sc_mtx); \ 279 (_sc)->sc_iflist_ref--; \ 280 if (((_sc)->sc_iflist_xcnt > 0) && ((_sc)->sc_iflist_ref == 0)) \ 281 cv_broadcast(&(_sc)->sc_cv); \ 282 mtx_unlock(&(_sc)->sc_mtx); \ 283 } while (0) 284 #define BRIDGE_XLOCK(_sc) do { \ 285 mtx_assert(&(_sc)->sc_mtx, MA_OWNED); \ 286 (_sc)->sc_iflist_xcnt++; \ 287 while ((_sc)->sc_iflist_ref > 0) \ 288 cv_wait(&(_sc)->sc_cv, &(_sc)->sc_mtx); \ 289 } while (0) 290 #define BRIDGE_XDROP(_sc) do { \ 291 mtx_assert(&(_sc)->sc_mtx, MA_OWNED); \ 292 (_sc)->sc_iflist_xcnt--; \ 293 } while (0) 294 295 #define BRIDGE_INPUT(_ifp, _m) do { \ 296 KASSERT(bridge_input_p != NULL, \ 297 ("%s: if_bridge not loaded!", __func__)); \ 298 _m = (*bridge_input_p)(_ifp, _m); \ 299 if (_m != NULL) \ 300 _ifp = _m->m_pkthdr.rcvif; \ 301 } while (0) 302 303 #define BRIDGE_OUTPUT(_ifp, _m, _err) do { \ 304 KASSERT(bridge_output_p != NULL, \ 305 ("%s: if_bridge not loaded!", __func__)); \ 306 _err = (*bridge_output_p)(_ifp, _m, NULL, NULL); \ 307 } while (0) 308 309 extern struct mbuf *(*bridge_input_p)(struct ifnet *, struct mbuf *); 310 extern int (*bridge_output_p)(struct ifnet *, struct mbuf *, 311 struct sockaddr *, struct rtentry *); 312 extern void (*bridge_dn_p)(struct mbuf *, struct ifnet *); 313 314 #endif /* _KERNEL */ 315