sys/net/bridge/if_bridgevar.h

   1 /*
   2  * Copyright 2001 Wasabi Systems, Inc.
   3  * All rights reserved.
   4  *
   5  * Written by Jason R. Thorpe for Wasabi Systems, Inc.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. All advertising materials mentioning features or use of this software
  16  *    must display the following acknowledgement:
  17  *      This product includes software developed for the NetBSD Project by
  18  *      Wasabi Systems, Inc.
  19  * 4. The name of Wasabi Systems, Inc. may not be used to endorse
  20  *    or promote products derived from this software without specific prior
  21  *    written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  25  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  26  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
  27  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  30  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  31  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  32  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  33  * POSSIBILITY OF SUCH DAMAGE.
  34  */
  35
  36 /*
  37  * Copyright (c) 1999, 2000 Jason L. Wright (jason@thought.net)
  38  * All rights reserved.
  39  *
  40  * Redistribution and use in source and binary forms, with or without
  41  * modification, are permitted provided that the following conditions
  42  * are met:
  43  * 1. Redistributions of source code must retain the above copyright
  44  *    notice, this list of conditions and the following disclaimer.
  45  * 2. Redistributions in binary form must reproduce the above copyright
  46  *    notice, this list of conditions and the following disclaimer in the
  47  *    documentation and/or other materials provided with the distribution.
  48  * 3. All advertising materials mentioning features or use of this software
  49  *    must display the following acknowledgement:
  50  *      This product includes software developed by Jason L. Wright
  51  * 4. The name of the author may not be used to endorse or promote products
  52  *    derived from this software without specific prior written permission.
  53  *
  54  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  55  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  56  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  57  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
  58  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  59  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  60  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  61  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  62  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  63  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  64  * POSSIBILITY OF SUCH DAMAGE.
  65  *
  66  * $OpenBSD: if_bridge.h,v 1.14 2001/03/22 03:48:29 jason Exp $
  67  * $NetBSD: if_bridgevar.h,v 1.4 2003/07/08 07:13:50 itojun Exp $
  68  * $FreeBSD: src/sys/net/if_bridgevar.h,v 1.4 2005/07/06 01:24:45 thompsa Exp $
  69  */
  70
  71 #ifndef _NET_IF_BRIDGEVAR_H
  72 #define _NET_IF_BRIDGEVAR_H
  73
  74 /*
  75  * Data structure and control definitions for bridge interfaces.
  76  */
  77
  78 #include <sys/callout.h>
  79 #include <sys/queue.h>
  80 #ifdef _KERNEL
  81 #include <net/netisr2.h>
  82 #endif
  83
  84 /*
  85  * Commands used in the SIOCSDRVSPEC ioctl.  Note the lookup of the
  86  * bridge interface itself is keyed off the ifdrv structure.
  87  */
  88 #define BRDGADD                 0       /* add bridge member (ifbreq) */
  89 #define BRDGDEL                 1       /* delete bridge member (ifbreq) */
  90 #define BRDGGIFFLGS             2       /* get member if flags (ifbreq) */
  91 #define BRDGSIFFLGS             3       /* set member if flags (ifbreq) */
  92 #define BRDGSCACHE              4       /* set cache size (ifbrparam) */
  93 #define BRDGGCACHE              5       /* get cache size (ifbrparam) */
  94 #define BRDGGIFS                6       /* get member list (ifbifconf) */
  95 #define BRDGRTS                 7       /* get address list (ifbaconf) */
  96 #define BRDGSADDR               8       /* set static address (ifbareq) */
  97 #define BRDGSTO                 9       /* set cache timeout (ifbrparam) */
  98 #define BRDGGTO                 10      /* get cache timeout (ifbrparam) */
  99 #define BRDGDADDR               11      /* delete address (ifbareq) */
 100 #define BRDGFLUSH               12      /* flush address cache (ifbreq) */
 101
 102 #define BRDGGPRI                13      /* get priority (ifbrparam) */
 103 #define BRDGSPRI                14      /* set priority (ifbrparam) */
 104 #define BRDGGHT                 15      /* get hello time (ifbrparam) */
 105 #define BRDGSHT                 16      /* set hello time (ifbrparam) */
 106 #define BRDGGFD                 17      /* get forward delay (ifbrparam) */
 107 #define BRDGSFD                 18      /* set forward delay (ifbrparam) */
 108 #define BRDGGMA                 19      /* get max age (ifbrparam) */
 109 #define BRDGSMA                 20      /* set max age (ifbrparam) */
 110 #define BRDGSIFPRIO             21      /* set if priority (ifbreq) */
 111 #define BRDGSIFCOST             22      /* set if path cost (ifbreq) */
 112 #define BRDGADDS                23      /* add bridge span member (ifbreq) */
 113 #define BRDGDELS                24      /* delete bridge span member (ifbreq) */
 114 #define BRDGSBONDWGHT           25      /* set bonding weighting (ifbreq) */
 115
 116 /*
 117  * Generic bridge control request.
 118  */
 119 struct ifbreq {
 120         char            ifbr_ifsname[IFNAMSIZ]; /* member if name */
 121         uint32_t        ifbr_ifsflags;          /* member if flags */
 122         uint8_t         ifbr_state;             /* member if STP state */
 123         uint8_t         ifbr_priority;          /* member if STP priority */
 124         uint8_t         ifbr_path_cost;         /* member if STP cost */
 125         uint8_t         ifbr_portno;            /* member if port number */
 126         uint64_t        ifbr_designated_root;   /* synthesized */
 127         uint64_t        ifbr_designated_bridge;
 128         uint32_t        ifbr_designated_cost;
 129         uint16_t        ifbr_designated_port;
 130         uint16_t        unused01;
 131         uint64_t        ifbr_peer_root;         /* from peer */
 132         uint64_t        ifbr_peer_bridge;       /* from peer */
 133         uint32_t        ifbr_peer_cost;         /* from peer */
 134         uint16_t        ifbr_peer_port;         /* from peer */
 135         uint16_t        unused02;
 136         uint16_t        ifbr_bond_weight;
 137         uint16_t        unused03;
 138         uint32_t        unused04[8];
 139 };
 140
 141 /* BRDGGIFFLAGS, BRDGSIFFLAGS */
 142 #define IFBIF_LEARNING          0x01    /* if can learn */
 143 #define IFBIF_DISCOVER          0x02    /* if sends packets w/ unknown dest. */
 144 #define IFBIF_STP               0x04    /* if participates in spanning tree */
 145 #define IFBIF_SPAN              0x08    /* if is a span port */
 146 #define IFBIF_DESIGNATED        0x10    /* mostly age timer expired */
 147 #define IFBIF_ROOT              0x20    /* selected root or near-root */
 148
 149 #define IFBIF_KEEPMASK          (IFBIF_SPAN | IFBIF_DESIGNATED | IFBIF_ROOT)
 150
 151 #define IFBIFBITS       "\020\1LEARNING\2DISCOVER\3STP\4SPAN\5DESIGNATED" \
 152                         "\6ROOT"
 153
 154 /* BRDGFLUSH */
 155 #define IFBF_FLUSHDYN           0x00    /* flush learned addresses only */
 156 #define IFBF_FLUSHALL           0x01    /* flush all addresses */
 157 #define IFBF_FLUSHSYNC          0x02    /* synchronized flush */
 158
 159 /* STP port states */
 160 #define BSTP_IFSTATE_DISABLED   0
 161 #define BSTP_IFSTATE_LISTENING  1
 162 #define BSTP_IFSTATE_LEARNING   2
 163 #define BSTP_IFSTATE_FORWARDING 3
 164 #define BSTP_IFSTATE_BLOCKING   4
 165 #define BSTP_IFSTATE_BONDED     5       /* link2 bonding mode */
 166 #define BSTP_IFSTATE_L1BLOCKING 6       /* link1 blocking mode no-activity */
 167
 168 /*
 169  * Interface list structure.
 170  */
 171 struct ifbifconf {
 172         uint32_t        ifbic_len;      /* buffer size */
 173         union {
 174                 caddr_t ifbicu_buf;
 175                 struct ifbreq *ifbicu_req;
 176         } ifbic_ifbicu;
 177 #define ifbic_buf       ifbic_ifbicu.ifbicu_buf
 178 #define ifbic_req       ifbic_ifbicu.ifbicu_req
 179 };
 180
 181 /*
 182  * Bridge address request.
 183  */
 184 struct ifbareq {
 185         char            ifba_ifsname[IFNAMSIZ]; /* member if name */
 186         time_t          ifba_expire;            /* address expire time */
 187         uint8_t         ifba_flags;             /* address flags */
 188         uint8_t         ifba_dst[ETHER_ADDR_LEN];/* destination address */
 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
 195 #define IFBAFBITS       "\020\1STATIC"
 196
 197 /*
 198  * Address list structure.
 199  */
 200 struct ifbaconf {
 201         uint32_t        ifbac_len;      /* buffer size */
 202         union {
 203                 caddr_t ifbacu_buf;
 204                 struct ifbareq *ifbacu_req;
 205         } ifbac_ifbacu;
 206 #define ifbac_buf       ifbac_ifbacu.ifbacu_buf
 207 #define ifbac_req       ifbac_ifbacu.ifbacu_req
 208 };
 209
 210 /*
 211  * Bridge parameter structure.
 212  */
 213 struct ifbrparam {
 214         union {
 215                 uint32_t ifbrpu_int32;
 216                 uint16_t ifbrpu_int16;
 217                 uint8_t ifbrpu_int8;
 218         } ifbrp_ifbrpu;
 219 };
 220 #define ifbrp_csize     ifbrp_ifbrpu.ifbrpu_int32       /* cache size */
 221 #define ifbrp_ctime     ifbrp_ifbrpu.ifbrpu_int32       /* cache time (sec) */
 222 #define ifbrp_prio      ifbrp_ifbrpu.ifbrpu_int16       /* bridge priority */
 223 #define ifbrp_hellotime ifbrp_ifbrpu.ifbrpu_int8        /* hello time (sec) */
 224 #define ifbrp_fwddelay  ifbrp_ifbrpu.ifbrpu_int8        /* fwd time (sec) */
 225 #define ifbrp_maxage    ifbrp_ifbrpu.ifbrpu_int8        /* max age (sec) */
 226
 227 #ifdef _KERNEL
 228 /*
 229  * Timekeeping structure used in spanning tree code.
 230  */
 231 struct bridge_timer {
 232         uint16_t        active;
 233         uint16_t        value;
 234 };
 235
 236 struct bstp_config_unit {
 237         uint64_t        cu_rootid;
 238         uint64_t        cu_bridge_id;
 239         uint32_t        cu_root_path_cost;
 240         uint16_t        cu_message_age;
 241         uint16_t        cu_max_age;
 242         uint16_t        cu_hello_time;
 243         uint16_t        cu_forward_delay;
 244         uint16_t        cu_port_id;
 245         uint8_t         cu_message_type;
 246         uint8_t         cu_topology_change_acknowledgment;
 247         uint8_t         cu_topology_change;
 248 };
 249
 250 struct bstp_tcn_unit {
 251         uint8_t         tu_message_type;
 252 };
 253
 254 /*
 255  * Bridge interface entry.
 256  */
 257 struct bridge_ifinfo {
 258         uint64_t                bifi_peer_root;
 259         uint64_t                bifi_peer_bridge;
 260         uint32_t                bifi_peer_cost;
 261         uint16_t                bifi_peer_port;
 262         uint16_t                bifi_unused02;
 263         uint16_t                bifi_port_id;
 264         uint32_t                bifi_path_cost;
 265         struct bridge_timer     bifi_hold_timer;
 266         struct bridge_timer     bifi_message_age_timer;
 267         struct bridge_timer     bifi_forward_delay_timer;
 268         struct bridge_timer     bifi_link1_timer;
 269         struct bstp_config_unit bifi_config_bpdu;
 270         uint32_t                bifi_flags;     /* member if flags */
 271         uint8_t                 bifi_state;
 272         uint8_t                 bifi_topology_change_acknowledge;
 273         uint8_t                 bifi_config_pending;
 274         uint8_t                 bifi_change_detection_enabled;
 275         uint8_t                 bifi_priority;
 276         struct ifnet            *bifi_ifp;      /* member if */
 277         int                     bifi_mutecap;   /* member muted caps */
 278         int                     bifi_bond_weight; /* when link2 active */
 279 };
 280
 281 #define bif_peer_root                   bif_info->bifi_peer_root
 282 #define bif_peer_bridge                 bif_info->bifi_peer_bridge
 283 #define bif_peer_cost                   bif_info->bifi_peer_cost
 284 #define bif_peer_port                   bif_info->bifi_peer_port
 285 #define bif_path_cost                   bif_info->bifi_path_cost
 286 #define bif_hold_timer                  bif_info->bifi_hold_timer
 287 #define bif_message_age_timer           bif_info->bifi_message_age_timer
 288 #define bif_forward_delay_timer         bif_info->bifi_forward_delay_timer
 289 #define bif_link1_timer                 bif_info->bifi_link1_timer
 290 #define bif_config_bpdu                 bif_info->bifi_config_bpdu
 291 #define bif_port_id                     bif_info->bifi_port_id
 292 #define bif_state                       bif_info->bifi_state
 293 #define bif_flags                       bif_info->bifi_flags
 294 #define bif_topology_change_acknowledge \
 295         bif_info->bifi_topology_change_acknowledge
 296 #define bif_config_pending              bif_info->bifi_config_pending
 297 #define bif_change_detection_enabled    bif_info->bifi_change_detection_enabled
 298 #define bif_priority                    bif_info->bifi_priority
 299 #define bif_message_age_timer           bif_info->bifi_message_age_timer
 300 #define bif_bond_weight                 bif_info->bifi_bond_weight
 301
 302 /*
 303  * Bridge interface list entry.
 304  */
 305 struct bridge_iflist {
 306         TAILQ_ENTRY(bridge_iflist) bif_next;
 307         struct ifnet            *bif_ifp;       /* member if */
 308         int                     bif_onlist;
 309         struct bridge_ifinfo    *bif_info;
 310         int                     bif_bond_count; /* when link2 active */
 311 };
 312 TAILQ_HEAD(bridge_iflist_head, bridge_iflist);
 313
 314 /*
 315  * Bridge route info.
 316  */
 317 struct bridge_rtinfo {
 318         struct ifnet            *bri_ifp;       /* destination if */
 319         time_t                  bri_expire;     /* expiration time */
 320         uint8_t                 bri_flags;      /* address flags */
 321         uint8_t                 bri_dead;
 322         uint8_t                 bri_pad[2];
 323 };
 324
 325 /*
 326  * Bridge route node.
 327  */
 328 struct bridge_rtnode {
 329         LIST_ENTRY(bridge_rtnode) brt_hash;     /* hash table linkage */
 330         LIST_ENTRY(bridge_rtnode) brt_list;     /* list linkage */
 331         uint8_t                 brt_addr[ETHER_ADDR_LEN];
 332         uint8_t                 brt_pad[2];
 333         struct bridge_rtinfo    *brt_info;
 334 };
 335 LIST_HEAD(bridge_rtnode_head, bridge_rtnode);
 336
 337 /*
 338  * Software state for each bridge.
 339  */
 340 struct bridge_softc {
 341         struct arpcom           sc_arp;
 342         struct ifnet            *sc_ifp;        /* make this an interface */
 343         LIST_ENTRY(bridge_softc) sc_list;
 344         uint64_t                sc_bridge_id;
 345         uint64_t                sc_designated_root;
 346         uint64_t                sc_designated_bridge;
 347         uint32_t                sc_designated_cost;     /* root path cost */
 348         uint16_t                sc_designated_port;
 349         uint16_t                sc_unused01;
 350         struct bridge_iflist    *sc_root_port;
 351         uint16_t                sc_max_age;
 352         uint16_t                sc_hello_time;
 353         uint16_t                sc_forward_delay;
 354         uint16_t                sc_bridge_max_age;
 355         uint16_t                sc_bridge_hello_time;
 356         uint16_t                sc_bridge_forward_delay;
 357         uint16_t                sc_topology_change_time;
 358         uint16_t                sc_hold_time;
 359         uint16_t                sc_bridge_priority;
 360         uint8_t                 sc_topology_change_detected;
 361         uint8_t                 sc_topology_change;
 362         struct bridge_timer     sc_hello_timer;
 363         struct bridge_timer     sc_topology_change_timer;
 364         struct bridge_timer     sc_tcn_timer;
 365         uint32_t                sc_brtmax;      /* max # of addresses */
 366         uint32_t                sc_brtcnt;      /* cur. # of addresses */
 367         uint32_t                sc_brttimeout;  /* rt timeout in seconds */
 368         struct callout          sc_brcallout;   /* bridge callout */
 369         struct netmsg_base      sc_brtimemsg;   /* bridge callout msg */
 370         struct callout          sc_bstpcallout; /* STP callout */
 371         struct netmsg_base      sc_bstptimemsg; /* STP callout msg */
 372         struct bridge_iflist_head *sc_iflists;  /* percpu member if lists */
 373         struct bridge_rtnode_head **sc_rthashs; /* percpu forwarding tables */
 374         struct bridge_rtnode_head *sc_rtlists;  /* percpu lists of the above */
 375         uint32_t                sc_rthash_key;  /* key for hash */
 376         struct bridge_iflist_head sc_spanlist;  /* span ports list */
 377         int                     sc_span;        /* has span ports */
 378         struct bridge_timer     sc_link_timer;
 379         int                     sc_copy_flags;  /* copy if_flags */
 380 };
 381 #define sc_if                   sc_arp.ac_if
 382
 383 #define BRIDGE_CFGCPU           0
 384 #define BRIDGE_CFGPORT          netisr_cpuport(BRIDGE_CFGCPU)
 385
 386 extern const uint8_t bstp_etheraddr[];
 387
 388 void    bridge_rtdelete(struct bridge_softc *, struct ifnet *ifp, int);
 389
 390 extern  void    (*bstp_linkstate_p)(struct ifnet *ifp, int state);
 391
 392 void    bstp_initialization(struct bridge_softc *);
 393 void    bstp_linkstate(struct ifnet *, int);
 394 void    bstp_stop(struct bridge_softc *);
 395 void    bstp_input(struct bridge_softc *, struct bridge_iflist *,
 396                    struct mbuf *);
 397 void    bstp_tick_handler(netmsg_t);
 398 int     bstp_supersedes_port_info(struct bridge_softc *,
 399                    struct bridge_iflist *);
 400
 401
 402 void    bridge_enqueue(struct ifnet *, struct mbuf *);
 403
 404 #endif /* _KERNEL */
 405
 406 #endif  /* !_NET_IF_BRIDGEVAR_H */