1 /* $NetBSD: if_bridgevar.h,v 1.4 2003/07/08 07:13:50 itojun Exp $ */ 2 3 /* 4 * SPDX-License-Identifier: BSD-4-Clause 5 * 6 * Copyright 2001 Wasabi Systems, Inc. 7 * All rights reserved. 8 * 9 * Written by Jason R. Thorpe for Wasabi Systems, Inc. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. All advertising materials mentioning features or use of this software 20 * must display the following acknowledgement: 21 * This product includes software developed for the NetBSD Project by 22 * Wasabi Systems, Inc. 23 * 4. The name of Wasabi Systems, Inc. may not be used to endorse 24 * or promote products derived from this software without specific prior 25 * written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND 28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC 31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 37 * POSSIBILITY OF SUCH DAMAGE. 38 */ 39 40 /* 41 * Copyright (c) 1999, 2000 Jason L. Wright (jason@thought.net) 42 * All rights reserved. 43 * 44 * Redistribution and use in source and binary forms, with or without 45 * modification, are permitted provided that the following conditions 46 * are met: 47 * 1. Redistributions of source code must retain the above copyright 48 * notice, this list of conditions and the following disclaimer. 49 * 2. Redistributions in binary form must reproduce the above copyright 50 * notice, this list of conditions and the following disclaimer in the 51 * documentation and/or other materials provided with the distribution. 52 * 3. All advertising materials mentioning features or use of this software 53 * must display the following acknowledgement: 54 * This product includes software developed by Jason L. Wright 55 * 4. The name of the author may not be used to endorse or promote products 56 * derived from this software without specific prior written permission. 57 * 58 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 59 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 60 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 61 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, 62 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 63 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 64 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 65 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 66 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 67 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 68 * POSSIBILITY OF SUCH DAMAGE. 69 * 70 * OpenBSD: if_bridge.h,v 1.14 2001/03/22 03:48:29 jason Exp 71 */ 72 73 /* 74 * Data structure and control definitions for bridge interfaces. 75 */ 76 77 #include <sys/types.h> 78 #include <sys/callout.h> 79 #include <sys/queue.h> 80 #include <sys/condvar.h> 81 82 #include <net/ethernet.h> 83 #include <net/if.h> 84 85 /* 86 * Commands used in the SIOCSDRVSPEC ioctl. Note the lookup of the 87 * bridge interface itself is keyed off the ifdrv structure. 88 */ 89 #define BRDGADD 0 /* add bridge member (ifbreq) */ 90 #define BRDGDEL 1 /* delete bridge member (ifbreq) */ 91 #define BRDGGIFFLGS 2 /* get member if flags (ifbreq) */ 92 #define BRDGSIFFLGS 3 /* set member if flags (ifbreq) */ 93 #define BRDGSCACHE 4 /* set cache size (ifbrparam) */ 94 #define BRDGGCACHE 5 /* get cache size (ifbrparam) */ 95 #define BRDGGIFS 6 /* get member list (ifbifconf) */ 96 #define BRDGRTS 7 /* get address list (ifbaconf) */ 97 #define BRDGSADDR 8 /* set static address (ifbareq) */ 98 #define BRDGSTO 9 /* set cache timeout (ifbrparam) */ 99 #define BRDGGTO 10 /* get cache timeout (ifbrparam) */ 100 #define BRDGDADDR 11 /* delete address (ifbareq) */ 101 #define BRDGFLUSH 12 /* flush address cache (ifbreq) */ 102 103 #define BRDGGPRI 13 /* get priority (ifbrparam) */ 104 #define BRDGSPRI 14 /* set priority (ifbrparam) */ 105 #define BRDGGHT 15 /* get hello time (ifbrparam) */ 106 #define BRDGSHT 16 /* set hello time (ifbrparam) */ 107 #define BRDGGFD 17 /* get forward delay (ifbrparam) */ 108 #define BRDGSFD 18 /* set forward delay (ifbrparam) */ 109 #define BRDGGMA 19 /* get max age (ifbrparam) */ 110 #define BRDGSMA 20 /* set max age (ifbrparam) */ 111 #define BRDGSIFPRIO 21 /* set if priority (ifbreq) */ 112 #define BRDGSIFCOST 22 /* set if path cost (ifbreq) */ 113 #define BRDGADDS 23 /* add bridge span member (ifbreq) */ 114 #define BRDGDELS 24 /* delete bridge span member (ifbreq) */ 115 #define BRDGPARAM 25 /* get bridge STP params (ifbropreq) */ 116 #define BRDGGRTE 26 /* get cache drops (ifbrparam) */ 117 #define BRDGGIFSSTP 27 /* get member STP params list 118 * (ifbpstpconf) */ 119 #define BRDGSPROTO 28 /* set protocol (ifbrparam) */ 120 #define BRDGSTXHC 29 /* set tx hold count (ifbrparam) */ 121 #define BRDGSIFAMAX 30 /* set max interface addrs (ifbreq) */ 122 123 /* 124 * Generic bridge control request. 125 */ 126 struct ifbreq { 127 char ifbr_ifsname[IFNAMSIZ]; /* member if name */ 128 uint32_t ifbr_ifsflags; /* member if flags */ 129 uint32_t ifbr_stpflags; /* member if STP flags */ 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 uint32_t ifbr_addrcnt; /* member if addr number */ 137 uint32_t ifbr_addrmax; /* member if addr max */ 138 uint32_t ifbr_addrexceeded; /* member if addr violations */ 139 uint8_t pad[32]; 140 }; 141 142 /* BRDGGIFFLAGS, BRDGSIFFLAGS */ 143 #define IFBIF_LEARNING 0x0001 /* if can learn */ 144 #define IFBIF_DISCOVER 0x0002 /* if sends packets w/ unknown dest. */ 145 #define IFBIF_STP 0x0004 /* if participates in spanning tree */ 146 #define IFBIF_SPAN 0x0008 /* if is a span port */ 147 #define IFBIF_STICKY 0x0010 /* if learned addresses stick */ 148 #define IFBIF_BSTP_EDGE 0x0020 /* member stp edge port */ 149 #define IFBIF_BSTP_AUTOEDGE 0x0040 /* member stp autoedge enabled */ 150 #define IFBIF_BSTP_PTP 0x0080 /* member stp point to point */ 151 #define IFBIF_BSTP_AUTOPTP 0x0100 /* member stp autoptp enabled */ 152 #define IFBIF_BSTP_ADMEDGE 0x0200 /* member stp admin edge enabled */ 153 #define IFBIF_BSTP_ADMCOST 0x0400 /* member stp admin path cost */ 154 #define IFBIF_PRIVATE 0x0800 /* if is a private segment */ 155 156 #define IFBIFBITS "\020\001LEARNING\002DISCOVER\003STP\004SPAN" \ 157 "\005STICKY\014PRIVATE\006EDGE\007AUTOEDGE\010PTP" \ 158 "\011AUTOPTP" 159 #define IFBIFMASK ~(IFBIF_BSTP_EDGE|IFBIF_BSTP_AUTOEDGE|IFBIF_BSTP_PTP| \ 160 IFBIF_BSTP_AUTOPTP|IFBIF_BSTP_ADMEDGE| \ 161 IFBIF_BSTP_ADMCOST) /* not saved */ 162 163 /* BRDGFLUSH */ 164 #define IFBF_FLUSHDYN 0x00 /* flush learned addresses only */ 165 #define IFBF_FLUSHALL 0x01 /* flush all addresses */ 166 167 /* 168 * Interface list structure. 169 */ 170 struct ifbifconf { 171 uint32_t ifbic_len; /* buffer size */ 172 union { 173 caddr_t ifbicu_buf; 174 struct ifbreq *ifbicu_req; 175 } ifbic_ifbicu; 176 #define ifbic_buf ifbic_ifbicu.ifbicu_buf 177 #define ifbic_req ifbic_ifbicu.ifbicu_req 178 }; 179 180 /* 181 * Bridge address request. 182 */ 183 struct ifbareq { 184 char ifba_ifsname[IFNAMSIZ]; /* member if name */ 185 unsigned long ifba_expire; /* address expire time */ 186 uint8_t ifba_flags; /* address flags */ 187 uint8_t ifba_dst[ETHER_ADDR_LEN];/* destination address */ 188 uint16_t ifba_vlan; /* vlan id */ 189 }; 190 191 #define IFBAF_TYPEMASK 0x03 /* address type mask */ 192 #define IFBAF_DYNAMIC 0x00 /* dynamically learned address */ 193 #define IFBAF_STATIC 0x01 /* static address */ 194 #define IFBAF_STICKY 0x02 /* sticky address */ 195 196 #define IFBAFBITS "\020\1STATIC\2STICKY" 197 198 /* 199 * Address list structure. 200 */ 201 struct ifbaconf { 202 uint32_t ifbac_len; /* buffer size */ 203 union { 204 caddr_t ifbacu_buf; 205 struct ifbareq *ifbacu_req; 206 } ifbac_ifbacu; 207 #define ifbac_buf ifbac_ifbacu.ifbacu_buf 208 #define ifbac_req ifbac_ifbacu.ifbacu_req 209 }; 210 211 /* 212 * Bridge parameter structure. 213 */ 214 struct ifbrparam { 215 union { 216 uint32_t ifbrpu_int32; 217 uint16_t ifbrpu_int16; 218 uint8_t ifbrpu_int8; 219 } ifbrp_ifbrpu; 220 }; 221 #define ifbrp_csize ifbrp_ifbrpu.ifbrpu_int32 /* cache size */ 222 #define ifbrp_ctime ifbrp_ifbrpu.ifbrpu_int32 /* cache time (sec) */ 223 #define ifbrp_prio ifbrp_ifbrpu.ifbrpu_int16 /* bridge priority */ 224 #define ifbrp_proto ifbrp_ifbrpu.ifbrpu_int8 /* bridge protocol */ 225 #define ifbrp_txhc ifbrp_ifbrpu.ifbrpu_int8 /* bpdu tx holdcount */ 226 #define ifbrp_hellotime ifbrp_ifbrpu.ifbrpu_int8 /* hello time (sec) */ 227 #define ifbrp_fwddelay ifbrp_ifbrpu.ifbrpu_int8 /* fwd time (sec) */ 228 #define ifbrp_maxage ifbrp_ifbrpu.ifbrpu_int8 /* max age (sec) */ 229 #define ifbrp_cexceeded ifbrp_ifbrpu.ifbrpu_int32 /* # of cache dropped 230 * adresses */ 231 /* 232 * Bridge current operational parameters structure. 233 */ 234 struct ifbropreq { 235 uint8_t ifbop_holdcount; 236 uint8_t ifbop_maxage; 237 uint8_t ifbop_hellotime; 238 uint8_t ifbop_fwddelay; 239 uint8_t ifbop_protocol; 240 uint16_t ifbop_priority; 241 uint16_t ifbop_root_port; 242 uint32_t ifbop_root_path_cost; 243 uint64_t ifbop_bridgeid; 244 uint64_t ifbop_designated_root; 245 uint64_t ifbop_designated_bridge; 246 struct timeval ifbop_last_tc_time; 247 }; 248 249 /* 250 * Bridge member operational STP params structure. 251 */ 252 struct ifbpstpreq { 253 uint8_t ifbp_portno; /* bp STP port number */ 254 uint32_t ifbp_fwd_trans; /* bp STP fwd transitions */ 255 uint32_t ifbp_design_cost; /* bp STP designated cost */ 256 uint32_t ifbp_design_port; /* bp STP designated port */ 257 uint64_t ifbp_design_bridge; /* bp STP designated bridge */ 258 uint64_t ifbp_design_root; /* bp STP designated root */ 259 }; 260 261 /* 262 * Bridge STP ports list structure. 263 */ 264 struct ifbpstpconf { 265 uint32_t ifbpstp_len; /* buffer size */ 266 union { 267 caddr_t ifbpstpu_buf; 268 struct ifbpstpreq *ifbpstpu_req; 269 } ifbpstp_ifbpstpu; 270 #define ifbpstp_buf ifbpstp_ifbpstpu.ifbpstpu_buf 271 #define ifbpstp_req ifbpstp_ifbpstpu.ifbpstpu_req 272 }; 273 274 #define STP_STATES \ 275 "disabled", \ 276 "listening", \ 277 "learning", \ 278 "forwarding", \ 279 "blocking", \ 280 "discarding" 281 282 #define STP_PROTOS \ 283 "stp", \ 284 "-", \ 285 "rstp" 286 287 #define STP_ROLES \ 288 "disabled", \ 289 "root", \ 290 "designated", \ 291 "alternate", \ 292 "backup" 293 294 #define PV2ID(pv, epri, eaddr) do { \ 295 epri = pv >> 48; \ 296 eaddr[0] = pv >> 40; \ 297 eaddr[1] = pv >> 32; \ 298 eaddr[2] = pv >> 24; \ 299 eaddr[3] = pv >> 16; \ 300 eaddr[4] = pv >> 8; \ 301 eaddr[5] = pv >> 0; \ 302 } while (0) 303 304 #ifdef _KERNEL 305 306 #define BRIDGE_INPUT(_ifp, _m) do { \ 307 KASSERT((_ifp)->if_bridge_input != NULL, \ 308 ("%s: if_bridge not loaded!", __func__)); \ 309 _m = (*(_ifp)->if_bridge_input)(_ifp, _m); \ 310 if (_m != NULL) { \ 311 _ifp = _m->m_pkthdr.rcvif; \ 312 m->m_flags &= ~M_BRIDGE_INJECT; \ 313 } \ 314 } while (0) 315 316 #define BRIDGE_OUTPUT(_ifp, _m, _err) do { \ 317 KASSERT((_ifp)->if_bridge_output != NULL, \ 318 ("%s: if_bridge not loaded!", __func__)); \ 319 _err = (*(_ifp)->if_bridge_output)(_ifp, _m, NULL, NULL); \ 320 } while (0) 321 322 extern void (*bridge_dn_p)(struct mbuf *, struct ifnet *); 323 324 #endif /* _KERNEL */ 325