sys/net/if_bridgevar.h

   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 BRDGSIFAMAX             30      /* set max interface addrs (ifbreq) */
 118
 119 /*
 120  * Generic bridge control request.
 121  */
 122 struct ifbreq {
 123         char            ifbr_ifsname[IFNAMSIZ]; /* member if name */
 124         uint32_t        ifbr_ifsflags;          /* member if flags */
 125         uint32_t        ifbr_stpflags;          /* member if STP flags */
 126         uint32_t        ifbr_path_cost;         /* member if STP cost */
 127         uint8_t         ifbr_portno;            /* member if port number */
 128         uint8_t         ifbr_priority;          /* member if STP priority */
 129         uint8_t         ifbr_proto;             /* member if STP protocol */
 130         uint8_t         ifbr_role;              /* member if STP role */
 131         uint8_t         ifbr_state;             /* member if STP state */
 132         uint32_t        ifbr_addrcnt;           /* member if addr number */
 133         uint32_t        ifbr_addrmax;           /* member if addr max */
 134         uint32_t        ifbr_addrexceeded;      /* member if addr violations */
 135         uint8_t         pad[32];
 136 };
 137
 138 /* BRDGGIFFLAGS, BRDGSIFFLAGS */
 139 #define IFBIF_LEARNING          0x0001  /* if can learn */
 140 #define IFBIF_DISCOVER          0x0002  /* if sends packets w/ unknown dest. */
 141 #define IFBIF_STP               0x0004  /* if participates in spanning tree */
 142 #define IFBIF_SPAN              0x0008  /* if is a span port */
 143 #define IFBIF_STICKY            0x0010  /* if learned addresses stick */
 144 #define IFBIF_BSTP_EDGE         0x0020  /* member stp edge port */
 145 #define IFBIF_BSTP_AUTOEDGE     0x0040  /* member stp autoedge enabled */
 146 #define IFBIF_BSTP_PTP          0x0080  /* member stp point to point */
 147 #define IFBIF_BSTP_AUTOPTP      0x0100  /* member stp autoptp enabled */
 148 #define IFBIF_BSTP_ADMEDGE      0x0200  /* member stp admin edge enabled */
 149 #define IFBIF_BSTP_ADMCOST      0x0400  /* member stp admin path cost */
 150 #define IFBIF_PRIVATE           0x0800  /* if is a private segment */
 151
 152 #define IFBIFBITS       "\020\001LEARNING\002DISCOVER\003STP\004SPAN" \
 153                         "\005STICKY\014PRIVATE\006EDGE\007AUTOEDGE\010PTP" \
 154                         "\011AUTOPTP"
 155 #define IFBIFMASK       ~(IFBIF_BSTP_EDGE|IFBIF_BSTP_AUTOEDGE|IFBIF_BSTP_PTP| \
 156                         IFBIF_BSTP_AUTOPTP|IFBIF_BSTP_ADMEDGE| \
 157                         IFBIF_BSTP_ADMCOST)     /* not saved */
 158
 159 /* BRDGFLUSH */
 160 #define IFBF_FLUSHDYN           0x00    /* flush learned addresses only */
 161 #define IFBF_FLUSHALL           0x01    /* flush all addresses */
 162
 163 /*
 164  * Interface list structure.
 165  */
 166 struct ifbifconf {
 167         uint32_t        ifbic_len;      /* buffer size */
 168         union {
 169                 caddr_t ifbicu_buf;
 170                 struct ifbreq *ifbicu_req;
 171         } ifbic_ifbicu;
 172 #define ifbic_buf       ifbic_ifbicu.ifbicu_buf
 173 #define ifbic_req       ifbic_ifbicu.ifbicu_req
 174 };
 175
 176 /*
 177  * Bridge address request.
 178  */
 179 struct ifbareq {
 180         char            ifba_ifsname[IFNAMSIZ]; /* member if name */
 181         unsigned long   ifba_expire;            /* address expire time */
 182         uint8_t         ifba_flags;             /* address flags */
 183         uint8_t         ifba_dst[ETHER_ADDR_LEN];/* destination address */
 184         uint16_t        ifba_vlan;              /* vlan id */
 185 };
 186
 187 #define IFBAF_TYPEMASK  0x03    /* address type mask */
 188 #define IFBAF_DYNAMIC   0x00    /* dynamically learned address */
 189 #define IFBAF_STATIC    0x01    /* static address */
 190 #define IFBAF_STICKY    0x02    /* sticky address */
 191
 192 #define IFBAFBITS       "\020\1STATIC\2STICKY"
 193
 194 /*
 195  * Address list structure.
 196  */
 197 struct ifbaconf {
 198         uint32_t        ifbac_len;      /* buffer size */
 199         union {
 200                 caddr_t ifbacu_buf;
 201                 struct ifbareq *ifbacu_req;
 202         } ifbac_ifbacu;
 203 #define ifbac_buf       ifbac_ifbacu.ifbacu_buf
 204 #define ifbac_req       ifbac_ifbacu.ifbacu_req
 205 };
 206
 207 /*
 208  * Bridge parameter structure.
 209  */
 210 struct ifbrparam {
 211         union {
 212                 uint32_t ifbrpu_int32;
 213                 uint16_t ifbrpu_int16;
 214                 uint8_t ifbrpu_int8;
 215         } ifbrp_ifbrpu;
 216 };
 217 #define ifbrp_csize     ifbrp_ifbrpu.ifbrpu_int32       /* cache size */
 218 #define ifbrp_ctime     ifbrp_ifbrpu.ifbrpu_int32       /* cache time (sec) */
 219 #define ifbrp_prio      ifbrp_ifbrpu.ifbrpu_int16       /* bridge priority */
 220 #define ifbrp_proto     ifbrp_ifbrpu.ifbrpu_int8        /* bridge protocol */
 221 #define ifbrp_txhc      ifbrp_ifbrpu.ifbrpu_int8        /* bpdu tx holdcount */
 222 #define ifbrp_hellotime ifbrp_ifbrpu.ifbrpu_int8        /* hello time (sec) */
 223 #define ifbrp_fwddelay  ifbrp_ifbrpu.ifbrpu_int8        /* fwd time (sec) */
 224 #define ifbrp_maxage    ifbrp_ifbrpu.ifbrpu_int8        /* max age (sec) */
 225 #define ifbrp_cexceeded ifbrp_ifbrpu.ifbrpu_int32       /* # of cache dropped
 226                                                          * adresses */
 227 /*
 228  * Bridge current operational parameters structure.
 229  */
 230 struct ifbropreq {
 231         uint8_t         ifbop_holdcount;
 232         uint8_t         ifbop_maxage;
 233         uint8_t         ifbop_hellotime;
 234         uint8_t         ifbop_fwddelay;
 235         uint8_t         ifbop_protocol;
 236         uint16_t        ifbop_priority;
 237         uint16_t        ifbop_root_port;
 238         uint32_t        ifbop_root_path_cost;
 239         uint64_t        ifbop_bridgeid;
 240         uint64_t        ifbop_designated_root;
 241         uint64_t        ifbop_designated_bridge;
 242         struct timeval  ifbop_last_tc_time;
 243 };
 244
 245 /*
 246  * Bridge member operational STP params structure.
 247  */
 248 struct ifbpstpreq {
 249         uint8_t         ifbp_portno;            /* bp STP port number */
 250         uint32_t        ifbp_fwd_trans;         /* bp STP fwd transitions */
 251         uint32_t        ifbp_design_cost;       /* bp STP designated cost */
 252         uint32_t        ifbp_design_port;       /* bp STP designated port */
 253         uint64_t        ifbp_design_bridge;     /* bp STP designated bridge */
 254         uint64_t        ifbp_design_root;       /* bp STP designated root */
 255 };
 256
 257 /*
 258  * Bridge STP ports list structure.
 259  */
 260 struct ifbpstpconf {
 261         uint32_t        ifbpstp_len;    /* buffer size */
 262         union {
 263                 caddr_t ifbpstpu_buf;
 264                 struct ifbpstpreq *ifbpstpu_req;
 265         } ifbpstp_ifbpstpu;
 266 #define ifbpstp_buf     ifbpstp_ifbpstpu.ifbpstpu_buf
 267 #define ifbpstp_req     ifbpstp_ifbpstpu.ifbpstpu_req
 268 };
 269
 270 #ifdef _KERNEL
 271
 272 #define BRIDGE_LOCK_INIT(_sc)           do {                    \
 273         mtx_init(&(_sc)->sc_mtx, "if_bridge", NULL, MTX_DEF);   \
 274         cv_init(&(_sc)->sc_cv, "if_bridge_cv");                 \
 275 } while (0)
 276 #define BRIDGE_LOCK_DESTROY(_sc)        do {    \
 277         mtx_destroy(&(_sc)->sc_mtx);            \
 278         cv_destroy(&(_sc)->sc_cv);              \
 279 } while (0)
 280 #define BRIDGE_LOCK(_sc)                mtx_lock(&(_sc)->sc_mtx)
 281 #define BRIDGE_UNLOCK(_sc)              mtx_unlock(&(_sc)->sc_mtx)
 282 #define BRIDGE_LOCK_ASSERT(_sc)         mtx_assert(&(_sc)->sc_mtx, MA_OWNED)
 283 #define BRIDGE_LOCK2REF(_sc, _err)      do {    \
 284         mtx_assert(&(_sc)->sc_mtx, MA_OWNED);   \
 285         if ((_sc)->sc_iflist_xcnt > 0)          \
 286                 (_err) = EBUSY;                 \
 287         else                                    \
 288                 (_sc)->sc_iflist_ref++;         \
 289         mtx_unlock(&(_sc)->sc_mtx);             \
 290 } while (0)
 291 #define BRIDGE_UNREF(_sc)               do {                            \
 292         mtx_lock(&(_sc)->sc_mtx);                                       \
 293         (_sc)->sc_iflist_ref--;                                         \
 294         if (((_sc)->sc_iflist_xcnt > 0) && ((_sc)->sc_iflist_ref == 0)) \
 295                 cv_broadcast(&(_sc)->sc_cv);                            \
 296         mtx_unlock(&(_sc)->sc_mtx);                                     \
 297 } while (0)
 298 #define BRIDGE_XLOCK(_sc)               do {            \
 299         mtx_assert(&(_sc)->sc_mtx, MA_OWNED);           \
 300         (_sc)->sc_iflist_xcnt++;                        \
 301         while ((_sc)->sc_iflist_ref > 0)                \
 302                 cv_wait(&(_sc)->sc_cv, &(_sc)->sc_mtx); \
 303 } while (0)
 304 #define BRIDGE_XDROP(_sc)               do {    \
 305         mtx_assert(&(_sc)->sc_mtx, MA_OWNED);   \
 306         (_sc)->sc_iflist_xcnt--;                \
 307 } while (0)
 308
 309 #define BRIDGE_INPUT(_ifp, _m)          do {            \
 310         KASSERT(bridge_input_p != NULL,                 \
 311             ("%s: if_bridge not loaded!", __func__));   \
 312         _m = (*bridge_input_p)(_ifp, _m);               \
 313         if (_m != NULL)                                 \
 314                 _ifp = _m->m_pkthdr.rcvif;              \
 315 } while (0)
 316
 317 #define BRIDGE_OUTPUT(_ifp, _m, _err)   do {                    \
 318         KASSERT(bridge_output_p != NULL,                        \
 319             ("%s: if_bridge not loaded!", __func__));           \
 320         _err = (*bridge_output_p)(_ifp, _m, NULL, NULL);        \
 321 } while (0)
 322
 323 extern  struct mbuf *(*bridge_input_p)(struct ifnet *, struct mbuf *);
 324 extern  int (*bridge_output_p)(struct ifnet *, struct mbuf *,
 325                 struct sockaddr *, struct rtentry *);
 326 extern  void (*bridge_dn_p)(struct mbuf *, struct ifnet *);
 327
 328 #endif /* _KERNEL */