sys/net/bridgestp.c

   1 /*      $NetBSD: bridgestp.c,v 1.5 2003/11/28 08:56:48 keihan Exp $     */
   2
   3 /*
   4  * Copyright (c) 2000 Jason L. Wright (jason@thought.net)
   5  * Copyright (c) 2006 Andrew Thompson (thompsa@FreeBSD.org)
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
  21  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  23  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  25  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  26  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  27  * POSSIBILITY OF SUCH DAMAGE.
  28  *
  29  * OpenBSD: bridgestp.c,v 1.5 2001/03/22 03:48:29 jason Exp
  30  */
  31
  32 /*
  33  * Implementation of the spanning tree protocol as defined in
  34  * ISO/IEC 802.1D-2004, June 9, 2004.
  35  */
  36
  37 #include <sys/cdefs.h>
  38 __FBSDID("$FreeBSD$");
  39
  40 #include <sys/param.h>
  41 #include <sys/systm.h>
  42 #include <sys/mbuf.h>
  43 #include <sys/socket.h>
  44 #include <sys/sockio.h>
  45 #include <sys/kernel.h>
  46 #include <sys/callout.h>
  47 #include <sys/module.h>
  48 #include <sys/proc.h>
  49 #include <sys/lock.h>
  50 #include <sys/mutex.h>
  51 #include <sys/taskqueue.h>
  52
  53 #include <net/if.h>
  54 #include <net/if_dl.h>
  55 #include <net/if_types.h>
  56 #include <net/if_llc.h>
  57 #include <net/if_media.h>
  58
  59 #include <netinet/in.h>
  60 #include <netinet/in_systm.h>
  61 #include <netinet/in_var.h>
  62 #include <netinet/if_ether.h>
  63 #include <net/bridgestp.h>
  64
  65 #ifdef  BRIDGESTP_DEBUG
  66 #define DPRINTF(fmt, arg...)    printf("bstp: " fmt, ##arg)
  67 #else
  68 #define DPRINTF(fmt, arg...)
  69 #endif
  70
  71 #define PV2ADDR(pv, eaddr)      do {            \
  72         eaddr[0] = pv >> 40;                    \
  73         eaddr[1] = pv >> 32;                    \
  74         eaddr[2] = pv >> 24;                    \
  75         eaddr[3] = pv >> 16;                    \
  76         eaddr[4] = pv >> 8;                     \
  77         eaddr[5] = pv >> 0;                     \
  78 } while (0)
  79
  80 #define INFO_BETTER     1
  81 #define INFO_SAME       0
  82 #define INFO_WORSE      -1
  83
  84 const uint8_t bstp_etheraddr[] = { 0x01, 0x80, 0xc2, 0x00, 0x00, 0x00 };
  85
  86 LIST_HEAD(, bstp_state) bstp_list;
  87 static struct mtx       bstp_list_mtx;
  88
  89 static void     bstp_transmit(struct bstp_state *, struct bstp_port *);
  90 static void     bstp_transmit_bpdu(struct bstp_state *, struct bstp_port *);
  91 static void     bstp_transmit_tcn(struct bstp_state *, struct bstp_port *);
  92 static void     bstp_decode_bpdu(struct bstp_port *, struct bstp_cbpdu *,
  93                     struct bstp_config_unit *);
  94 static void     bstp_send_bpdu(struct bstp_state *, struct bstp_port *,
  95                     struct bstp_cbpdu *);
  96 static void     bstp_enqueue(struct ifnet *, struct mbuf *);
  97 static int      bstp_pdu_flags(struct bstp_port *);
  98 static void     bstp_received_stp(struct bstp_state *, struct bstp_port *,
  99                     struct mbuf **, struct bstp_tbpdu *);
 100 static void     bstp_received_rstp(struct bstp_state *, struct bstp_port *,
 101                     struct mbuf **, struct bstp_tbpdu *);
 102 static void     bstp_received_tcn(struct bstp_state *, struct bstp_port *,
 103                     struct bstp_tcn_unit *);
 104 static void     bstp_received_bpdu(struct bstp_state *, struct bstp_port *,
 105                     struct bstp_config_unit *);
 106 static int      bstp_pdu_rcvtype(struct bstp_port *, struct bstp_config_unit *);
 107 static int      bstp_pdu_bettersame(struct bstp_port *, int);
 108 static int      bstp_info_cmp(struct bstp_pri_vector *,
 109                     struct bstp_pri_vector *);
 110 static int      bstp_info_superior(struct bstp_pri_vector *,
 111                     struct bstp_pri_vector *);
 112 static void     bstp_assign_roles(struct bstp_state *);
 113 static void     bstp_update_roles(struct bstp_state *, struct bstp_port *);
 114 static void     bstp_update_state(struct bstp_state *, struct bstp_port *);
 115 static void     bstp_update_tc(struct bstp_port *);
 116 static void     bstp_update_info(struct bstp_port *);
 117 static void     bstp_set_other_tcprop(struct bstp_port *);
 118 static void     bstp_set_all_reroot(struct bstp_state *);
 119 static void     bstp_set_all_sync(struct bstp_state *);
 120 static void     bstp_set_port_state(struct bstp_port *, int);
 121 static void     bstp_set_port_role(struct bstp_port *, int);
 122 static void     bstp_set_port_proto(struct bstp_port *, int);
 123 static void     bstp_set_port_tc(struct bstp_port *, int);
 124 static void     bstp_set_timer_tc(struct bstp_port *);
 125 static void     bstp_set_timer_msgage(struct bstp_port *);
 126 static int      bstp_rerooted(struct bstp_state *, struct bstp_port *);
 127 static uint32_t bstp_calc_path_cost(struct bstp_port *);
 128 static void     bstp_notify_state(void *, int);
 129 static void     bstp_notify_rtage(void *, int);
 130 static void     bstp_ifupdstatus(struct bstp_state *, struct bstp_port *);
 131 static void     bstp_enable_port(struct bstp_state *, struct bstp_port *);
 132 static void     bstp_disable_port(struct bstp_state *, struct bstp_port *);
 133 static void     bstp_tick(void *);
 134 static void     bstp_timer_start(struct bstp_timer *, uint16_t);
 135 static void     bstp_timer_stop(struct bstp_timer *);
 136 static void     bstp_timer_latch(struct bstp_timer *);
 137 static int      bstp_timer_expired(struct bstp_timer *);
 138 static void     bstp_hello_timer_expiry(struct bstp_state *,
 139                     struct bstp_port *);
 140 static void     bstp_message_age_expiry(struct bstp_state *,
 141                     struct bstp_port *);
 142 static void     bstp_migrate_delay_expiry(struct bstp_state *,
 143                     struct bstp_port *);
 144 static void     bstp_edge_delay_expiry(struct bstp_state *,
 145                     struct bstp_port *);
 146 static int      bstp_addr_cmp(const uint8_t *, const uint8_t *);
 147 static int      bstp_same_bridgeid(uint64_t, uint64_t);
 148 static void     bstp_reinit(struct bstp_state *);
 149
 150 static void
 151 bstp_transmit(struct bstp_state *bs, struct bstp_port *bp)
 152 {
 153         if (bs->bs_running == 0)
 154                 return;
 155
 156         /*
 157          * a PDU can only be sent if we have tx quota left and the
 158          * hello timer is running.
 159          */
 160         if (bp->bp_hello_timer.active == 0) {
 161                 /* Test if it needs to be reset */
 162                 bstp_hello_timer_expiry(bs, bp);
 163                 return;
 164         }
 165         if (bp->bp_txcount > bs->bs_txholdcount)
 166                 /* Ran out of karma */
 167                 return;
 168
 169         if (bp->bp_protover == BSTP_PROTO_RSTP) {
 170                 bstp_transmit_bpdu(bs, bp);
 171                 bp->bp_tc_ack = 0;
 172         } else { /* STP */
 173                 switch (bp->bp_role) {
 174                         case BSTP_ROLE_DESIGNATED:
 175                                 bstp_transmit_bpdu(bs, bp);
 176                                 bp->bp_tc_ack = 0;
 177                                 break;
 178
 179                         case BSTP_ROLE_ROOT:
 180                                 bstp_transmit_tcn(bs, bp);
 181                                 break;
 182                 }
 183         }
 184         bstp_timer_start(&bp->bp_hello_timer, bp->bp_desg_htime);
 185         bp->bp_flags &= ~BSTP_PORT_NEWINFO;
 186 }
 187
 188 static void
 189 bstp_transmit_bpdu(struct bstp_state *bs, struct bstp_port *bp)
 190 {
 191         struct bstp_cbpdu bpdu;
 192
 193         BSTP_LOCK_ASSERT(bs);
 194
 195         bpdu.cbu_rootpri = htons(bp->bp_desg_pv.pv_root_id >> 48);
 196         PV2ADDR(bp->bp_desg_pv.pv_root_id, bpdu.cbu_rootaddr);
 197
 198         bpdu.cbu_rootpathcost = htonl(bp->bp_desg_pv.pv_cost);
 199
 200         bpdu.cbu_bridgepri = htons(bp->bp_desg_pv.pv_dbridge_id >> 48);
 201         PV2ADDR(bp->bp_desg_pv.pv_dbridge_id, bpdu.cbu_bridgeaddr);
 202
 203         bpdu.cbu_portid = htons(bp->bp_port_id);
 204         bpdu.cbu_messageage = htons(bp->bp_desg_msg_age);
 205         bpdu.cbu_maxage = htons(bp->bp_desg_max_age);
 206         bpdu.cbu_hellotime = htons(bp->bp_desg_htime);
 207         bpdu.cbu_forwarddelay = htons(bp->bp_desg_fdelay);
 208
 209         bpdu.cbu_flags = bstp_pdu_flags(bp);
 210
 211         switch (bp->bp_protover) {
 212                 case BSTP_PROTO_STP:
 213                         bpdu.cbu_bpdutype = BSTP_MSGTYPE_CFG;
 214                         break;
 215
 216                 case BSTP_PROTO_RSTP:
 217                         bpdu.cbu_bpdutype = BSTP_MSGTYPE_RSTP;
 218                         break;
 219         }
 220
 221         bstp_send_bpdu(bs, bp, &bpdu);
 222 }
 223
 224 static void
 225 bstp_transmit_tcn(struct bstp_state *bs, struct bstp_port *bp)
 226 {
 227         struct bstp_tbpdu bpdu;
 228         struct ifnet *ifp = bp->bp_ifp;
 229         struct ether_header *eh;
 230         struct mbuf *m;
 231
 232         KASSERT(bp == bs->bs_root_port, ("%s: bad root port\n", __func__));
 233
 234         if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
 235                 return;
 236
 237         MGETHDR(m, M_DONTWAIT, MT_DATA);
 238         if (m == NULL)
 239                 return;
 240
 241         m->m_pkthdr.rcvif = ifp;
 242         m->m_pkthdr.len = sizeof(*eh) + sizeof(bpdu);
 243         m->m_len = m->m_pkthdr.len;
 244
 245         eh = mtod(m, struct ether_header *);
 246
 247         memcpy(eh->ether_shost, IF_LLADDR(ifp), ETHER_ADDR_LEN);
 248         memcpy(eh->ether_dhost, bstp_etheraddr, ETHER_ADDR_LEN);
 249         eh->ether_type = htons(sizeof(bpdu));
 250
 251         bpdu.tbu_ssap = bpdu.tbu_dsap = LLC_8021D_LSAP;
 252         bpdu.tbu_ctl = LLC_UI;
 253         bpdu.tbu_protoid = 0;
 254         bpdu.tbu_protover = 0;
 255         bpdu.tbu_bpdutype = BSTP_MSGTYPE_TCN;
 256
 257         memcpy(mtod(m, caddr_t) + sizeof(*eh), &bpdu, sizeof(bpdu));
 258
 259         bp->bp_txcount++;
 260         bstp_enqueue(ifp, m);
 261 }
 262
 263 static void
 264 bstp_decode_bpdu(struct bstp_port *bp, struct bstp_cbpdu *cpdu,
 265     struct bstp_config_unit *cu)
 266 {
 267         int flags;
 268
 269         cu->cu_pv.pv_root_id =
 270             (((uint64_t)ntohs(cpdu->cbu_rootpri)) << 48) |
 271             (((uint64_t)cpdu->cbu_rootaddr[0]) << 40) |
 272             (((uint64_t)cpdu->cbu_rootaddr[1]) << 32) |
 273             (((uint64_t)cpdu->cbu_rootaddr[2]) << 24) |
 274             (((uint64_t)cpdu->cbu_rootaddr[3]) << 16) |
 275             (((uint64_t)cpdu->cbu_rootaddr[4]) << 8) |
 276             (((uint64_t)cpdu->cbu_rootaddr[5]) << 0);
 277
 278         cu->cu_pv.pv_dbridge_id =
 279             (((uint64_t)ntohs(cpdu->cbu_bridgepri)) << 48) |
 280             (((uint64_t)cpdu->cbu_bridgeaddr[0]) << 40) |
 281             (((uint64_t)cpdu->cbu_bridgeaddr[1]) << 32) |
 282             (((uint64_t)cpdu->cbu_bridgeaddr[2]) << 24) |
 283             (((uint64_t)cpdu->cbu_bridgeaddr[3]) << 16) |
 284             (((uint64_t)cpdu->cbu_bridgeaddr[4]) << 8) |
 285             (((uint64_t)cpdu->cbu_bridgeaddr[5]) << 0);
 286
 287         cu->cu_pv.pv_cost = ntohl(cpdu->cbu_rootpathcost);
 288         cu->cu_message_age = ntohs(cpdu->cbu_messageage);
 289         cu->cu_max_age = ntohs(cpdu->cbu_maxage);
 290         cu->cu_hello_time = ntohs(cpdu->cbu_hellotime);
 291         cu->cu_forward_delay = ntohs(cpdu->cbu_forwarddelay);
 292         cu->cu_pv.pv_dport_id = ntohs(cpdu->cbu_portid);
 293         cu->cu_pv.pv_port_id = bp->bp_port_id;
 294         cu->cu_message_type = cpdu->cbu_bpdutype;
 295
 296         /* Strip off unused flags in STP mode */
 297         flags = cpdu->cbu_flags;
 298         switch (cpdu->cbu_protover) {
 299                 case BSTP_PROTO_STP:
 300                         flags &= BSTP_PDU_STPMASK;
 301                         /* A STP BPDU explicitly conveys a Designated Port */
 302                         cu->cu_role = BSTP_ROLE_DESIGNATED;
 303                         break;
 304
 305                 case BSTP_PROTO_RSTP:
 306                         flags &= BSTP_PDU_RSTPMASK;
 307                         break;
 308         }
 309
 310         cu->cu_topology_change_ack =
 311                 (flags & BSTP_PDU_F_TCA) ? 1 : 0;
 312         cu->cu_proposal =
 313                 (flags & BSTP_PDU_F_P) ? 1 : 0;
 314         cu->cu_agree =
 315                 (flags & BSTP_PDU_F_A) ? 1 : 0;
 316         cu->cu_learning =
 317                 (flags & BSTP_PDU_F_L) ? 1 : 0;
 318         cu->cu_forwarding =
 319                 (flags & BSTP_PDU_F_F) ? 1 : 0;
 320         cu->cu_topology_change =
 321                 (flags & BSTP_PDU_F_TC) ? 1 : 0;
 322
 323         switch ((flags & BSTP_PDU_PRMASK) >> BSTP_PDU_PRSHIFT) {
 324                 case BSTP_PDU_F_ROOT:
 325                         cu->cu_role = BSTP_ROLE_ROOT;
 326                         break;
 327                 case BSTP_PDU_F_ALT:
 328                         cu->cu_role = BSTP_ROLE_ALTERNATE;
 329                         break;
 330                 case BSTP_PDU_F_DESG:
 331                         cu->cu_role = BSTP_ROLE_DESIGNATED;
 332                         break;
 333         }
 334 }
 335
 336 static void
 337 bstp_send_bpdu(struct bstp_state *bs, struct bstp_port *bp,
 338     struct bstp_cbpdu *bpdu)
 339 {
 340         struct ifnet *ifp;
 341         struct mbuf *m;
 342         struct ether_header *eh;
 343
 344         BSTP_LOCK_ASSERT(bs);
 345
 346         ifp = bp->bp_ifp;
 347
 348         if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
 349                 return;
 350
 351         MGETHDR(m, M_DONTWAIT, MT_DATA);
 352         if (m == NULL)
 353                 return;
 354
 355         eh = mtod(m, struct ether_header *);
 356
 357         bpdu->cbu_ssap = bpdu->cbu_dsap = LLC_8021D_LSAP;
 358         bpdu->cbu_ctl = LLC_UI;
 359         bpdu->cbu_protoid = htons(BSTP_PROTO_ID);
 360
 361         memcpy(eh->ether_shost, IF_LLADDR(ifp), ETHER_ADDR_LEN);
 362         memcpy(eh->ether_dhost, bstp_etheraddr, ETHER_ADDR_LEN);
 363
 364         switch (bpdu->cbu_bpdutype) {
 365                 case BSTP_MSGTYPE_CFG:
 366                         bpdu->cbu_protover = BSTP_PROTO_STP;
 367                         m->m_pkthdr.len = sizeof(*eh) + BSTP_BPDU_STP_LEN;
 368                         eh->ether_type = htons(BSTP_BPDU_STP_LEN);
 369                         memcpy(mtod(m, caddr_t) + sizeof(*eh), bpdu,
 370                             BSTP_BPDU_STP_LEN);
 371                         break;
 372
 373                 case BSTP_MSGTYPE_RSTP:
 374                         bpdu->cbu_protover = BSTP_PROTO_RSTP;
 375                         bpdu->cbu_versionlen = htons(0);
 376                         m->m_pkthdr.len = sizeof(*eh) + BSTP_BPDU_RSTP_LEN;
 377                         eh->ether_type = htons(BSTP_BPDU_RSTP_LEN);
 378                         memcpy(mtod(m, caddr_t) + sizeof(*eh), bpdu,
 379                             BSTP_BPDU_RSTP_LEN);
 380                         break;
 381
 382                 default:
 383                         panic("not implemented");
 384         }
 385         m->m_pkthdr.rcvif = ifp;
 386         m->m_len = m->m_pkthdr.len;
 387
 388         bp->bp_txcount++;
 389         bstp_enqueue(ifp, m);
 390 }
 391
 392 static void
 393 bstp_enqueue(struct ifnet *dst_ifp, struct mbuf *m)
 394 {
 395         int err = 0;
 396
 397         IFQ_ENQUEUE(&dst_ifp->if_snd, m, err);
 398
 399         if ((dst_ifp->if_drv_flags & IFF_DRV_OACTIVE) == 0)
 400                 (*dst_ifp->if_start)(dst_ifp);
 401 }
 402
 403 static int
 404 bstp_pdu_flags(struct bstp_port *bp)
 405 {
 406         int flags = 0;
 407
 408         if (bp->bp_proposing && bp->bp_state != BSTP_IFSTATE_FORWARDING)
 409                 flags |= BSTP_PDU_F_P;
 410
 411         if (bp->bp_agree)
 412                 flags |= BSTP_PDU_F_A;
 413
 414         if (bp->bp_tc_timer.active)
 415                 flags |= BSTP_PDU_F_TC;
 416
 417         if (bp->bp_tc_ack)
 418                 flags |= BSTP_PDU_F_TCA;
 419
 420         switch (bp->bp_state) {
 421                 case BSTP_IFSTATE_LEARNING:
 422                         flags |= BSTP_PDU_F_L;
 423                         break;
 424
 425                 case BSTP_IFSTATE_FORWARDING:
 426                         flags |= (BSTP_PDU_F_L | BSTP_PDU_F_F);
 427                         break;
 428         }
 429
 430         switch (bp->bp_role) {
 431                 case BSTP_ROLE_ROOT:
 432                         flags |=
 433                                 (BSTP_PDU_F_ROOT << BSTP_PDU_PRSHIFT);
 434                         break;
 435
 436                 case BSTP_ROLE_ALTERNATE:
 437                 case BSTP_ROLE_BACKUP:  /* fall through */
 438                         flags |=
 439                                 (BSTP_PDU_F_ALT << BSTP_PDU_PRSHIFT);
 440                         break;
 441
 442                 case BSTP_ROLE_DESIGNATED:
 443                         flags |=
 444                                 (BSTP_PDU_F_DESG << BSTP_PDU_PRSHIFT);
 445                         break;
 446         }
 447
 448         /* Strip off unused flags in either mode */
 449         switch (bp->bp_protover) {
 450                 case BSTP_PROTO_STP:
 451                         flags &= BSTP_PDU_STPMASK;
 452                         break;
 453                 case BSTP_PROTO_RSTP:
 454                         flags &= BSTP_PDU_RSTPMASK;
 455                         break;
 456         }
 457         return (flags);
 458 }
 459
 460 struct mbuf *
 461 bstp_input(struct bstp_port *bp, struct ifnet *ifp, struct mbuf *m)
 462 {
 463         struct bstp_state *bs = bp->bp_bs;
 464         struct ether_header *eh;
 465         struct bstp_tbpdu tpdu;
 466         uint16_t len;
 467
 468         if (bp->bp_active == 0) {
 469                 m_freem(m);
 470                 return (NULL);
 471         }
 472
 473         BSTP_LOCK(bs);
 474
 475         eh = mtod(m, struct ether_header *);
 476
 477         len = ntohs(eh->ether_type);
 478         if (len < sizeof(tpdu))
 479                 goto out;
 480
 481         m_adj(m, ETHER_HDR_LEN);
 482
 483         if (m->m_pkthdr.len > len)
 484                 m_adj(m, len - m->m_pkthdr.len);
 485         if (m->m_len < sizeof(tpdu) &&
 486             (m = m_pullup(m, sizeof(tpdu))) == NULL)
 487                 goto out;
 488
 489         memcpy(&tpdu, mtod(m, caddr_t), sizeof(tpdu));
 490
 491         /* basic packet checks */
 492         if (tpdu.tbu_dsap != LLC_8021D_LSAP ||
 493             tpdu.tbu_ssap != LLC_8021D_LSAP ||
 494             tpdu.tbu_ctl != LLC_UI)
 495                 goto out;
 496         if (tpdu.tbu_protoid != BSTP_PROTO_ID)
 497                 goto out;
 498
 499         /*
 500          * We can treat later versions of the PDU as the same as the maximum
 501          * version we implement. All additional parameters/flags are ignored.
 502          */
 503         if (tpdu.tbu_protover > BSTP_PROTO_MAX)
 504                 tpdu.tbu_protover = BSTP_PROTO_MAX;
 505
 506         if (tpdu.tbu_protover != bp->bp_protover) {
 507                 /*
 508                  * Wait for the migration delay timer to expire before changing
 509                  * protocol version to avoid flip-flops.
 510                  */
 511                 if (bp->bp_flags & BSTP_PORT_CANMIGRATE)
 512                         bstp_set_port_proto(bp, tpdu.tbu_protover);
 513                 else
 514                         goto out;
 515         }
 516
 517         /* Clear operedge upon receiving a PDU on the port */
 518         bp->bp_operedge = 0;
 519         bstp_timer_start(&bp->bp_edge_delay_timer,
 520             BSTP_DEFAULT_MIGRATE_DELAY);
 521
 522         switch (tpdu.tbu_protover) {
 523                 case BSTP_PROTO_STP:
 524                         bstp_received_stp(bs, bp, &m, &tpdu);
 525                         break;
 526
 527                 case BSTP_PROTO_RSTP:
 528                         bstp_received_rstp(bs, bp, &m, &tpdu);
 529                         break;
 530         }
 531 out:
 532         BSTP_UNLOCK(bs);
 533         if (m)
 534                 m_freem(m);
 535         return (NULL);
 536 }
 537
 538 static void
 539 bstp_received_stp(struct bstp_state *bs, struct bstp_port *bp,
 540     struct mbuf **mp, struct bstp_tbpdu *tpdu)
 541 {
 542         struct bstp_cbpdu cpdu;
 543         struct bstp_config_unit *cu = &bp->bp_msg_cu;
 544         struct bstp_tcn_unit tu;
 545
 546         switch (tpdu->tbu_bpdutype) {
 547         case BSTP_MSGTYPE_TCN:
 548                 tu.tu_message_type = tpdu->tbu_bpdutype;
 549                 bstp_received_tcn(bs, bp, &tu);
 550                 break;
 551         case BSTP_MSGTYPE_CFG:
 552                 if ((*mp)->m_len < BSTP_BPDU_STP_LEN &&
 553                     (*mp = m_pullup(*mp, BSTP_BPDU_STP_LEN)) == NULL)
 554                         return;
 555                 memcpy(&cpdu, mtod(*mp, caddr_t), BSTP_BPDU_STP_LEN);
 556
 557                 bstp_decode_bpdu(bp, &cpdu, cu);
 558                 bstp_received_bpdu(bs, bp, cu);
 559                 break;
 560         }
 561 }
 562
 563 static void
 564 bstp_received_rstp(struct bstp_state *bs, struct bstp_port *bp,
 565     struct mbuf **mp, struct bstp_tbpdu *tpdu)
 566 {
 567         struct bstp_cbpdu cpdu;
 568         struct bstp_config_unit *cu = &bp->bp_msg_cu;
 569
 570         if (tpdu->tbu_bpdutype != BSTP_MSGTYPE_RSTP)
 571                 return;
 572
 573         if ((*mp)->m_len < BSTP_BPDU_RSTP_LEN &&
 574             (*mp = m_pullup(*mp, BSTP_BPDU_RSTP_LEN)) == NULL)
 575                 return;
 576         memcpy(&cpdu, mtod(*mp, caddr_t), BSTP_BPDU_RSTP_LEN);
 577
 578         bstp_decode_bpdu(bp, &cpdu, cu);
 579         bstp_received_bpdu(bs, bp, cu);
 580 }
 581
 582 static void
 583 bstp_received_tcn(struct bstp_state *bs, struct bstp_port *bp,
 584     struct bstp_tcn_unit *tcn)
 585 {
 586         bp->bp_rcvdtcn = 1;
 587         bstp_update_tc(bp);
 588 }
 589
 590 static void
 591 bstp_received_bpdu(struct bstp_state *bs, struct bstp_port *bp,
 592     struct bstp_config_unit *cu)
 593 {
 594         int type;
 595
 596         BSTP_LOCK_ASSERT(bs);
 597
 598         /* We need to have transitioned to INFO_MINE before proceeding */
 599         switch (bp->bp_infois) {
 600                 case BSTP_INFO_DISABLED:
 601                 case BSTP_INFO_AGED:
 602                         return;
 603         }
 604
 605         type = bstp_pdu_rcvtype(bp, cu);
 606
 607         switch (type) {
 608                 case BSTP_PDU_SUPERIOR:
 609                         bs->bs_allsynced = 0;
 610                         bp->bp_agreed = 0;
 611                         bp->bp_proposing = 0;
 612
 613                         if (cu->cu_proposal && cu->cu_forwarding == 0)
 614                                 bp->bp_proposed = 1;
 615                         if (cu->cu_topology_change)
 616                                 bp->bp_rcvdtc = 1;
 617                         if (cu->cu_topology_change_ack)
 618                                 bp->bp_rcvdtca = 1;
 619
 620                         if (bp->bp_agree &&
 621                             !bstp_pdu_bettersame(bp, BSTP_INFO_RECIEVED))
 622                                 bp->bp_agree = 0;
 623
 624                         /* copy the received priority and timers to the port */
 625                         bp->bp_port_pv = cu->cu_pv;
 626                         bp->bp_port_msg_age = cu->cu_message_age;
 627                         bp->bp_port_max_age = cu->cu_max_age;
 628                         bp->bp_port_fdelay = cu->cu_forward_delay;
 629                         bp->bp_port_htime =
 630                                 (cu->cu_hello_time > BSTP_MIN_HELLO_TIME ?
 631                                  cu->cu_hello_time : BSTP_MIN_HELLO_TIME);
 632
 633                         /* set expiry for the new info */
 634                         bstp_set_timer_msgage(bp);
 635
 636                         bp->bp_infois = BSTP_INFO_RECIEVED;
 637                         bstp_assign_roles(bs);
 638                         break;
 639
 640                 case BSTP_PDU_REPEATED:
 641                         if (cu->cu_proposal && cu->cu_forwarding == 0)
 642                                 bp->bp_proposed = 1;
 643                         if (cu->cu_topology_change)
 644                                 bp->bp_rcvdtc = 1;
 645                         if (cu->cu_topology_change_ack)
 646                                 bp->bp_rcvdtca = 1;
 647
 648                         /* rearm the age timer */
 649                         bstp_set_timer_msgage(bp);
 650                         break;
 651
 652                 case BSTP_PDU_INFERIOR:
 653                         if (cu->cu_learning) {
 654                                 bp->bp_agreed = 1;
 655                                 bp->bp_proposing = 0;
 656                         }
 657                         break;
 658
 659                 case BSTP_PDU_INFERIORALT:
 660                         /*
 661                          * only point to point links are allowed fast
 662                          * transitions to forwarding.
 663                          */
 664                         if (cu->cu_agree && bp->bp_ptp_link) {
 665                                 bp->bp_agreed = 1;
 666                                 bp->bp_proposing = 0;
 667                         } else
 668                                 bp->bp_agreed = 0;
 669
 670                         if (cu->cu_topology_change)
 671                                 bp->bp_rcvdtc = 1;
 672                         if (cu->cu_topology_change_ack)
 673                                 bp->bp_rcvdtca = 1;
 674                         break;
 675
 676                 case BSTP_PDU_OTHER:
 677                         return; /* do nothing */
 678         }
 679         /* update the state machines with the new data */
 680         bstp_update_state(bs, bp);
 681 }
 682
 683 static int
 684 bstp_pdu_rcvtype(struct bstp_port *bp, struct bstp_config_unit *cu)
 685 {
 686         int type;
 687
 688         /* default return type */
 689         type = BSTP_PDU_OTHER;
 690
 691         switch (cu->cu_role) {
 692         case BSTP_ROLE_DESIGNATED:
 693                 if (bstp_info_superior(&bp->bp_port_pv, &cu->cu_pv))
 694                         /* bpdu priority is superior */
 695                         type = BSTP_PDU_SUPERIOR;
 696                 else if (bstp_info_cmp(&bp->bp_port_pv, &cu->cu_pv) ==
 697                     INFO_SAME) {
 698                         if (bp->bp_port_msg_age != cu->cu_message_age ||
 699                             bp->bp_port_max_age != cu->cu_max_age ||
 700                             bp->bp_port_fdelay != cu->cu_forward_delay ||
 701                             bp->bp_port_htime != cu->cu_hello_time)
 702                                 /* bpdu priority is equal and timers differ */
 703                                 type = BSTP_PDU_SUPERIOR;
 704                         else
 705                                 /* bpdu is equal */
 706                                 type = BSTP_PDU_REPEATED;
 707                 } else
 708                         /* bpdu priority is worse */
 709                         type = BSTP_PDU_INFERIOR;
 710
 711                 break;
 712
 713         case BSTP_ROLE_ROOT:
 714         case BSTP_ROLE_ALTERNATE:
 715         case BSTP_ROLE_BACKUP:
 716                 if (bstp_info_cmp(&bp->bp_port_pv, &cu->cu_pv) <= INFO_SAME)
 717                         /*
 718                          * not a designated port and priority is the same or
 719                          * worse
 720                          */
 721                         type = BSTP_PDU_INFERIORALT;
 722                 break;
 723         }
 724
 725         return (type);
 726 }
 727
 728 static int
 729 bstp_pdu_bettersame(struct bstp_port *bp, int newinfo)
 730 {
 731         if (newinfo == BSTP_INFO_RECIEVED &&
 732             bp->bp_infois == BSTP_INFO_RECIEVED &&
 733             bstp_info_cmp(&bp->bp_port_pv, &bp->bp_msg_cu.cu_pv) >= INFO_SAME)
 734                 return (1);
 735
 736         if (newinfo == BSTP_INFO_MINE &&
 737             bp->bp_infois == BSTP_INFO_MINE &&
 738             bstp_info_cmp(&bp->bp_port_pv, &bp->bp_desg_pv) >= INFO_SAME)
 739                 return (1);
 740
 741         return (0);
 742 }
 743
 744 static int
 745 bstp_info_cmp(struct bstp_pri_vector *pv,
 746     struct bstp_pri_vector *cpv)
 747 {
 748         if (cpv->pv_root_id < pv->pv_root_id)
 749                 return (INFO_BETTER);
 750         if (cpv->pv_root_id > pv->pv_root_id)
 751                 return (INFO_WORSE);
 752
 753         if (cpv->pv_cost < pv->pv_cost)
 754                 return (INFO_BETTER);
 755         if (cpv->pv_cost > pv->pv_cost)
 756                 return (INFO_WORSE);
 757
 758         if (cpv->pv_dbridge_id < pv->pv_dbridge_id)
 759                 return (INFO_BETTER);
 760         if (cpv->pv_dbridge_id > pv->pv_dbridge_id)
 761                 return (INFO_WORSE);
 762
 763         if (cpv->pv_dport_id < pv->pv_dport_id)
 764                 return (INFO_BETTER);
 765         if (cpv->pv_dport_id > pv->pv_dport_id)
 766                 return (INFO_WORSE);
 767
 768         return (INFO_SAME);
 769 }
 770
 771 /*
 772  * This message priority vector is superior to the port priority vector and
 773  * will replace it if, and only if, the message priority vector is better than
 774  * the port priority vector, or the message has been transmitted from the same
 775  * designated bridge and designated port as the port priority vector.
 776  */
 777 static int
 778 bstp_info_superior(struct bstp_pri_vector *pv,
 779     struct bstp_pri_vector *cpv)
 780 {
 781         if (bstp_info_cmp(pv, cpv) == INFO_BETTER ||
 782             (bstp_same_bridgeid(pv->pv_dbridge_id, cpv->pv_dbridge_id) &&
 783             (cpv->pv_dport_id & 0xfff) == (pv->pv_dport_id & 0xfff)))
 784                 return (1);
 785         return (0);
 786 }
 787
 788 static void
 789 bstp_assign_roles(struct bstp_state *bs)
 790 {
 791         struct bstp_port *bp, *rbp = NULL;
 792         struct bstp_pri_vector pv;
 793
 794         /* default to our priority vector */
 795         bs->bs_root_pv = bs->bs_bridge_pv;
 796         bs->bs_root_msg_age = 0;
 797         bs->bs_root_max_age = bs->bs_bridge_max_age;
 798         bs->bs_root_fdelay = bs->bs_bridge_fdelay;
 799         bs->bs_root_htime = bs->bs_bridge_htime;
 800         bs->bs_root_port = NULL;
 801
 802         /* check if any recieved info supersedes us */
 803         LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
 804                 if (bp->bp_infois != BSTP_INFO_RECIEVED)
 805                         continue;
 806
 807                 pv = bp->bp_port_pv;
 808                 pv.pv_cost += bp->bp_path_cost;
 809
 810                 /*
 811                  * The root priority vector is the best of the set comprising
 812                  * the bridge priority vector plus all root path priority
 813                  * vectors whose bridge address is not equal to us.
 814                  */
 815                 if (bstp_same_bridgeid(pv.pv_dbridge_id,
 816                     bs->bs_bridge_pv.pv_dbridge_id) == 0 &&
 817                     bstp_info_cmp(&bs->bs_root_pv, &pv) == INFO_BETTER) {
 818                         /* the port vector replaces the root */
 819                         bs->bs_root_pv = pv;
 820                         bs->bs_root_msg_age = bp->bp_port_msg_age +
 821                             BSTP_MESSAGE_AGE_INCR;
 822                         bs->bs_root_max_age = bp->bp_port_max_age;
 823                         bs->bs_root_fdelay = bp->bp_port_fdelay;
 824                         bs->bs_root_htime = bp->bp_port_htime;
 825                         rbp = bp;
 826                 }
 827         }
 828
 829         LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
 830                 /* calculate the port designated vector */
 831                 bp->bp_desg_pv.pv_root_id = bs->bs_root_pv.pv_root_id;
 832                 bp->bp_desg_pv.pv_cost = bs->bs_root_pv.pv_cost;
 833                 bp->bp_desg_pv.pv_dbridge_id = bs->bs_bridge_pv.pv_dbridge_id;
 834                 bp->bp_desg_pv.pv_dport_id = bp->bp_port_id;
 835                 bp->bp_desg_pv.pv_port_id = bp->bp_port_id;
 836
 837                 /* calculate designated times */
 838                 bp->bp_desg_msg_age = bs->bs_root_msg_age;
 839                 bp->bp_desg_max_age = bs->bs_root_max_age;
 840                 bp->bp_desg_fdelay = bs->bs_root_fdelay;
 841                 bp->bp_desg_htime = bs->bs_bridge_htime;
 842
 843
 844                 switch (bp->bp_infois) {
 845                 case BSTP_INFO_DISABLED:
 846                         bstp_set_port_role(bp, BSTP_ROLE_DISABLED);
 847                         break;
 848
 849                 case BSTP_INFO_AGED:
 850                         bstp_set_port_role(bp, BSTP_ROLE_DESIGNATED);
 851                         bstp_update_info(bp);
 852                         break;
 853
 854                 case BSTP_INFO_MINE:
 855                         bstp_set_port_role(bp, BSTP_ROLE_DESIGNATED);
 856                         /* update the port info if stale */
 857                         if (bstp_info_cmp(&bp->bp_port_pv,
 858                             &bp->bp_desg_pv) != INFO_SAME ||
 859                             (rbp != NULL &&
 860                             (bp->bp_port_msg_age != rbp->bp_port_msg_age ||
 861                             bp->bp_port_max_age != rbp->bp_port_max_age ||
 862                             bp->bp_port_fdelay != rbp->bp_port_fdelay ||
 863                             bp->bp_port_htime != rbp->bp_port_htime)))
 864                                 bstp_update_info(bp);
 865                         break;
 866
 867                 case BSTP_INFO_RECIEVED:
 868                         if (bp == rbp) {
 869                                 /*
 870                                  * root priority is derived from this
 871                                  * port, make it the root port.
 872                                  */
 873                                 bstp_set_port_role(bp, BSTP_ROLE_ROOT);
 874                                 bs->bs_root_port = bp;
 875                         } else if (bstp_info_cmp(&bp->bp_port_pv,
 876                                     &bp->bp_desg_pv) == INFO_BETTER) {
 877                                 /*
 878                                  * the port priority is lower than the root
 879                                  * port.
 880                                  */
 881                                 bstp_set_port_role(bp, BSTP_ROLE_DESIGNATED);
 882                                 bstp_update_info(bp);
 883                         } else {
 884                                 if (bstp_same_bridgeid(
 885                                     bp->bp_port_pv.pv_dbridge_id,
 886                                     bs->bs_bridge_pv.pv_dbridge_id)) {
 887                                         /*
 888                                          * the designated bridge refers to
 889                                          * another port on this bridge.
 890                                          */
 891                                         bstp_set_port_role(bp,
 892                                             BSTP_ROLE_BACKUP);
 893                                 } else {
 894                                         /*
 895                                          * the port is an inferior path to the
 896                                          * root bridge.
 897                                          */
 898                                         bstp_set_port_role(bp,
 899                                             BSTP_ROLE_ALTERNATE);
 900                                 }
 901                         }
 902                         break;
 903                 }
 904         }
 905 }
 906
 907 static void
 908 bstp_update_state(struct bstp_state *bs, struct bstp_port *bp)
 909 {
 910         struct bstp_port *bp2;
 911         int synced;
 912
 913         BSTP_LOCK_ASSERT(bs);
 914
 915         /* check if all the ports have syncronised again */
 916         if (!bs->bs_allsynced) {
 917                 synced = 1;
 918                 LIST_FOREACH(bp2, &bs->bs_bplist, bp_next) {
 919                         if (!(bp->bp_synced ||
 920                              bp->bp_role == BSTP_ROLE_ROOT)) {
 921                                 synced = 0;
 922                                 break;
 923                         }
 924                 }
 925                 bs->bs_allsynced = synced;
 926         }
 927
 928         bstp_update_roles(bs, bp);
 929         bstp_update_tc(bp);
 930 }
 931
 932 static void
 933 bstp_update_roles(struct bstp_state *bs, struct bstp_port *bp)
 934 {
 935         switch (bp->bp_role) {
 936         case BSTP_ROLE_DISABLED:
 937                 /* Clear any flags if set */
 938                 if (bp->bp_sync || !bp->bp_synced || bp->bp_reroot) {
 939                         bp->bp_sync = 0;
 940                         bp->bp_synced = 1;
 941                         bp->bp_reroot = 0;
 942                 }
 943                 break;
 944
 945         case BSTP_ROLE_ALTERNATE:
 946         case BSTP_ROLE_BACKUP:
 947                 if ((bs->bs_allsynced && !bp->bp_agree) ||
 948                     (bp->bp_proposed && bp->bp_agree)) {
 949                         bp->bp_proposed = 0;
 950                         bp->bp_agree = 1;
 951                         bp->bp_flags |= BSTP_PORT_NEWINFO;
 952                         DPRINTF("%s -> ALTERNATE_AGREED\n",
 953                             bp->bp_ifp->if_xname);
 954                 }
 955
 956                 if (bp->bp_proposed && !bp->bp_agree) {
 957                         bstp_set_all_sync(bs);
 958                         bp->bp_proposed = 0;
 959                         DPRINTF("%s -> ALTERNATE_PROPOSED\n",
 960                             bp->bp_ifp->if_xname);
 961                 }
 962
 963                 /* Clear any flags if set */
 964                 if (bp->bp_sync || !bp->bp_synced || bp->bp_reroot) {
 965                         bp->bp_sync = 0;
 966                         bp->bp_synced = 1;
 967                         bp->bp_reroot = 0;
 968                         DPRINTF("%s -> ALTERNATE_PORT\n", bp->bp_ifp->if_xname);
 969                 }
 970                 break;
 971
 972         case BSTP_ROLE_ROOT:
 973                 if (bp->bp_state != BSTP_IFSTATE_FORWARDING && !bp->bp_reroot) {
 974                         bstp_set_all_reroot(bs);
 975                         DPRINTF("%s -> ROOT_REROOT\n", bp->bp_ifp->if_xname);
 976                 }
 977
 978                 if ((bs->bs_allsynced && !bp->bp_agree) ||
 979                     (bp->bp_proposed && bp->bp_agree)) {
 980                         bp->bp_proposed = 0;
 981                         bp->bp_sync = 0;
 982                         bp->bp_agree = 1;
 983                         bp->bp_flags |= BSTP_PORT_NEWINFO;
 984                         DPRINTF("%s -> ROOT_AGREED\n", bp->bp_ifp->if_xname);
 985                 }
 986
 987                 if (bp->bp_proposed && !bp->bp_agree) {
 988                         bstp_set_all_sync(bs);
 989                         bp->bp_proposed = 0;
 990                         DPRINTF("%s -> ROOT_PROPOSED\n", bp->bp_ifp->if_xname);
 991                 }
 992
 993                 if (bp->bp_state != BSTP_IFSTATE_FORWARDING &&
 994                     (bp->bp_forward_delay_timer.active == 0 ||
 995                     (bstp_rerooted(bs, bp) &&
 996                     bp->bp_recent_backup_timer.active == 0 &&
 997                     bp->bp_protover == BSTP_PROTO_RSTP))) {
 998                         switch (bp->bp_state) {
 999                         case BSTP_IFSTATE_DISCARDING:
1000                                 bstp_set_port_state(bp, BSTP_IFSTATE_LEARNING);
1001                                 break;
1002                         case BSTP_IFSTATE_LEARNING:
1003                                 bstp_set_port_state(bp,
1004                                     BSTP_IFSTATE_FORWARDING);
1005                                 break;
1006                         }
1007                 }
1008
1009                 if (bp->bp_state == BSTP_IFSTATE_FORWARDING && bp->bp_reroot) {
1010                         bp->bp_reroot = 0;
1011                         DPRINTF("%s -> ROOT_REROOTED\n", bp->bp_ifp->if_xname);
1012                 }
1013                 break;
1014
1015         case BSTP_ROLE_DESIGNATED:
1016                 if (bp->bp_recent_root_timer.active == 0 && bp->bp_reroot) {
1017                         bp->bp_reroot = 0;
1018                         DPRINTF("%s -> DESIGNATED_RETIRED\n",
1019                             bp->bp_ifp->if_xname);
1020                 }
1021
1022                 if ((bp->bp_state == BSTP_IFSTATE_DISCARDING &&
1023                     !bp->bp_synced) || (bp->bp_agreed && !bp->bp_synced) ||
1024                     (bp->bp_operedge && !bp->bp_synced) ||
1025                     (bp->bp_sync && bp->bp_synced)) {
1026                         bstp_timer_stop(&bp->bp_recent_root_timer);
1027                         bp->bp_synced = 1;
1028                         bp->bp_sync = 0;
1029                         DPRINTF("%s -> DESIGNATED_SYNCED\n",
1030                             bp->bp_ifp->if_xname);
1031                 }
1032
1033                 if (bp->bp_state != BSTP_IFSTATE_FORWARDING &&
1034                     !bp->bp_agreed && !bp->bp_proposing &&
1035                     !bp->bp_operedge) {
1036                         bp->bp_proposing = 1;
1037                         bp->bp_flags |= BSTP_PORT_NEWINFO;
1038                         bstp_timer_start(&bp->bp_edge_delay_timer,
1039                             (bp->bp_ptp_link ? BSTP_DEFAULT_MIGRATE_DELAY :
1040                              bp->bp_desg_max_age));
1041                         DPRINTF("%s -> DESIGNATED_PROPOSE\n",
1042                             bp->bp_ifp->if_xname);
1043                 }
1044
1045                 if (bp->bp_state != BSTP_IFSTATE_FORWARDING &&
1046                     (bp->bp_forward_delay_timer.active == 0 || bp->bp_agreed ||
1047                     bp->bp_operedge) &&
1048                     (bp->bp_recent_root_timer.active == 0 || !bp->bp_reroot) &&
1049                     !bp->bp_sync) {
1050                         if (bp->bp_agreed)
1051                                 DPRINTF("%s -> AGREED\n", bp->bp_ifp->if_xname);
1052                         /*
1053                          * If agreed|operedge then go straight to forwarding,
1054                          * otherwise follow discard -> learn -> forward.
1055                          */
1056                         if (bp->bp_agreed || bp->bp_operedge ||
1057                             bp->bp_state == BSTP_IFSTATE_LEARNING) {
1058                                 bstp_set_port_state(bp,
1059                                     BSTP_IFSTATE_FORWARDING);
1060                                 bp->bp_agreed = bp->bp_protover;
1061                         } else if (bp->bp_state == BSTP_IFSTATE_DISCARDING)
1062                                 bstp_set_port_state(bp, BSTP_IFSTATE_LEARNING);
1063                 }
1064
1065                 if (((bp->bp_sync && !bp->bp_synced) ||
1066                     (bp->bp_reroot && bp->bp_recent_root_timer.active) ||
1067                     (bp->bp_flags & BSTP_PORT_DISPUTED)) && !bp->bp_operedge &&
1068                     bp->bp_state != BSTP_IFSTATE_DISCARDING) {
1069                         bstp_set_port_state(bp, BSTP_IFSTATE_DISCARDING);
1070                         bp->bp_flags &= ~BSTP_PORT_DISPUTED;
1071                         bstp_timer_start(&bp->bp_forward_delay_timer,
1072                             bp->bp_protover == BSTP_PROTO_RSTP ?
1073                             bp->bp_desg_htime : bp->bp_desg_fdelay);
1074                         DPRINTF("%s -> DESIGNATED_DISCARD\n",
1075                             bp->bp_ifp->if_xname);
1076                 }
1077                 break;
1078         }
1079
1080         if (bp->bp_flags & BSTP_PORT_NEWINFO)
1081                 bstp_transmit(bs, bp);
1082 }
1083
1084 static void
1085 bstp_update_tc(struct bstp_port *bp)
1086 {
1087         switch (bp->bp_tcstate) {
1088                 case BSTP_TCSTATE_ACTIVE:
1089                         if ((bp->bp_role != BSTP_ROLE_DESIGNATED &&
1090                             bp->bp_role != BSTP_ROLE_ROOT) || bp->bp_operedge)
1091                                 bstp_set_port_tc(bp, BSTP_TCSTATE_LEARNING);
1092
1093                         if (bp->bp_rcvdtcn)
1094                                 bstp_set_port_tc(bp, BSTP_TCSTATE_TCN);
1095                         if (bp->bp_rcvdtc)
1096                                 bstp_set_port_tc(bp, BSTP_TCSTATE_TC);
1097
1098                         if (bp->bp_tc_prop && !bp->bp_operedge)
1099                                 bstp_set_port_tc(bp, BSTP_TCSTATE_PROPAG);
1100
1101                         if (bp->bp_rcvdtca)
1102                                 bstp_set_port_tc(bp, BSTP_TCSTATE_ACK);
1103                         break;
1104
1105                 case BSTP_TCSTATE_INACTIVE:
1106                         if ((bp->bp_state == BSTP_IFSTATE_LEARNING ||
1107                             bp->bp_state == BSTP_IFSTATE_FORWARDING) &&
1108                             bp->bp_fdbflush == 0)
1109                                 bstp_set_port_tc(bp, BSTP_TCSTATE_LEARNING);
1110                         break;
1111
1112                 case BSTP_TCSTATE_LEARNING:
1113                         if (bp->bp_rcvdtc || bp->bp_rcvdtcn || bp->bp_rcvdtca ||
1114                             bp->bp_tc_prop)
1115                                 bstp_set_port_tc(bp, BSTP_TCSTATE_LEARNING);
1116                         else if (bp->bp_role != BSTP_ROLE_DESIGNATED &&
1117                                  bp->bp_role != BSTP_ROLE_ROOT &&
1118                                  bp->bp_state == BSTP_IFSTATE_DISCARDING)
1119                                 bstp_set_port_tc(bp, BSTP_TCSTATE_INACTIVE);
1120
1121                         if ((bp->bp_role == BSTP_ROLE_DESIGNATED ||
1122                             bp->bp_role == BSTP_ROLE_ROOT) &&
1123                             bp->bp_state == BSTP_IFSTATE_FORWARDING &&
1124                             !bp->bp_operedge)
1125                                 bstp_set_port_tc(bp, BSTP_TCSTATE_DETECTED);
1126                         break;
1127
1128                 /* these are transient states and go straight back to ACTIVE */
1129                 case BSTP_TCSTATE_DETECTED:
1130                 case BSTP_TCSTATE_TCN:
1131                 case BSTP_TCSTATE_TC:
1132                 case BSTP_TCSTATE_PROPAG:
1133                 case BSTP_TCSTATE_ACK:
1134                         DPRINTF("Invalid TC state for %s\n",
1135                             bp->bp_ifp->if_xname);
1136                         break;
1137         }
1138
1139 }
1140
1141 static void
1142 bstp_update_info(struct bstp_port *bp)
1143 {
1144         struct bstp_state *bs = bp->bp_bs;
1145
1146         bp->bp_proposing = 0;
1147         bp->bp_proposed = 0;
1148
1149         if (bp->bp_agreed && !bstp_pdu_bettersame(bp, BSTP_INFO_MINE))
1150                 bp->bp_agreed = 0;
1151
1152         if (bp->bp_synced && !bp->bp_agreed) {
1153                 bp->bp_synced = 0;
1154                 bs->bs_allsynced = 0;
1155         }
1156
1157         /* copy the designated pv to the port */
1158         bp->bp_port_pv = bp->bp_desg_pv;
1159         bp->bp_port_msg_age = bp->bp_desg_msg_age;
1160         bp->bp_port_max_age = bp->bp_desg_max_age;
1161         bp->bp_port_fdelay = bp->bp_desg_fdelay;
1162         bp->bp_port_htime = bp->bp_desg_htime;
1163         bp->bp_infois = BSTP_INFO_MINE;
1164
1165         /* Set transmit flag but do not immediately send */
1166         bp->bp_flags |= BSTP_PORT_NEWINFO;
1167 }
1168
1169 /* set tcprop on every port other than the caller */
1170 static void
1171 bstp_set_other_tcprop(struct bstp_port *bp)
1172 {
1173         struct bstp_state *bs = bp->bp_bs;
1174         struct bstp_port *bp2;
1175
1176         BSTP_LOCK_ASSERT(bs);
1177
1178         LIST_FOREACH(bp2, &bs->bs_bplist, bp_next) {
1179                 if (bp2 == bp)
1180                         continue;
1181                 bp->bp_tc_prop = 1;
1182         }
1183 }
1184
1185 static void
1186 bstp_set_all_reroot(struct bstp_state *bs)
1187 {
1188         struct bstp_port *bp;
1189
1190         BSTP_LOCK_ASSERT(bs);
1191
1192         LIST_FOREACH(bp, &bs->bs_bplist, bp_next)
1193                 bp->bp_reroot = 1;
1194 }
1195
1196 static void
1197 bstp_set_all_sync(struct bstp_state *bs)
1198 {
1199         struct bstp_port *bp;
1200
1201         BSTP_LOCK_ASSERT(bs);
1202
1203         LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
1204                 bp->bp_sync = 1;
1205                 bp->bp_synced = 0;      /* Not explicit in spec */
1206         }
1207
1208         bs->bs_allsynced = 0;
1209 }
1210
1211 static void
1212 bstp_set_port_state(struct bstp_port *bp, int state)
1213 {
1214         if (bp->bp_state == state)
1215                 return;
1216
1217         bp->bp_state = state;
1218
1219         switch (bp->bp_state) {
1220                 case BSTP_IFSTATE_DISCARDING:
1221                         DPRINTF("state changed to DISCARDING on %s\n",
1222                             bp->bp_ifp->if_xname);
1223                         break;
1224
1225                 case BSTP_IFSTATE_LEARNING:
1226                         DPRINTF("state changed to LEARNING on %s\n",
1227                             bp->bp_ifp->if_xname);
1228
1229                         bstp_timer_start(&bp->bp_forward_delay_timer,
1230                             bp->bp_protover == BSTP_PROTO_RSTP ?
1231                             bp->bp_desg_htime : bp->bp_desg_fdelay);
1232                         break;
1233
1234                 case BSTP_IFSTATE_FORWARDING:
1235                         DPRINTF("state changed to FORWARDING on %s\n",
1236                             bp->bp_ifp->if_xname);
1237
1238                         bstp_timer_stop(&bp->bp_forward_delay_timer);
1239                         /* Record that we enabled forwarding */
1240                         bp->bp_forward_transitions++;
1241                         break;
1242         }
1243
1244         /* notify the parent bridge */
1245         taskqueue_enqueue(taskqueue_swi, &bp->bp_statetask);
1246 }
1247
1248 static void
1249 bstp_set_port_role(struct bstp_port *bp, int role)
1250 {
1251         struct bstp_state *bs = bp->bp_bs;
1252
1253         if (bp->bp_role == role)
1254                 return;
1255
1256         /* perform pre-change tasks */
1257         switch (bp->bp_role) {
1258                 case BSTP_ROLE_DISABLED:
1259                         bstp_timer_start(&bp->bp_forward_delay_timer,
1260                             bp->bp_desg_max_age);
1261                         break;
1262
1263                 case BSTP_ROLE_BACKUP:
1264                         bstp_timer_start(&bp->bp_recent_backup_timer,
1265                             bp->bp_desg_htime * 2);
1266                         /* fall through */
1267                 case BSTP_ROLE_ALTERNATE:
1268                         bstp_timer_start(&bp->bp_forward_delay_timer,
1269                             bp->bp_desg_fdelay);
1270                         bp->bp_sync = 0;
1271                         bp->bp_synced = 1;
1272                         bp->bp_reroot = 0;
1273                         break;
1274
1275                 case BSTP_ROLE_ROOT:
1276                         bstp_timer_start(&bp->bp_recent_root_timer,
1277                             BSTP_DEFAULT_FORWARD_DELAY);
1278                         break;
1279         }
1280
1281         bp->bp_role = role;
1282         /* clear values not carried between roles */
1283         bp->bp_proposing = 0;
1284         bs->bs_allsynced = 0;
1285
1286         /* initialise the new role */
1287         switch (bp->bp_role) {
1288                 case BSTP_ROLE_DISABLED:
1289                 case BSTP_ROLE_ALTERNATE:
1290                 case BSTP_ROLE_BACKUP:
1291                         DPRINTF("%s role -> ALT/BACK/DISABLED\n",
1292                             bp->bp_ifp->if_xname);
1293                         bstp_set_port_state(bp, BSTP_IFSTATE_DISCARDING);
1294                         bstp_timer_stop(&bp->bp_recent_root_timer);
1295                         bstp_timer_latch(&bp->bp_forward_delay_timer);
1296                         bp->bp_sync = 0;
1297                         bp->bp_synced = 1;
1298                         bp->bp_reroot = 0;
1299                         break;
1300
1301                 case BSTP_ROLE_ROOT:
1302                         DPRINTF("%s role -> ROOT\n",
1303                             bp->bp_ifp->if_xname);
1304                         bstp_set_port_state(bp, BSTP_IFSTATE_DISCARDING);
1305                         bstp_timer_latch(&bp->bp_recent_root_timer);
1306                         bp->bp_proposing = 0;
1307                         break;
1308
1309                 case BSTP_ROLE_DESIGNATED:
1310                         DPRINTF("%s role -> DESIGNATED\n",
1311                             bp->bp_ifp->if_xname);
1312                         bstp_timer_start(&bp->bp_hello_timer,
1313                             bp->bp_desg_htime);
1314                         bp->bp_agree = 0;
1315                         break;
1316         }
1317
1318         /* let the TC state know that the role changed */
1319         bstp_update_tc(bp);
1320 }
1321
1322 static void
1323 bstp_set_port_proto(struct bstp_port *bp, int proto)
1324 {
1325         struct bstp_state *bs = bp->bp_bs;
1326
1327         /* supported protocol versions */
1328         switch (proto) {
1329                 case BSTP_PROTO_STP:
1330                         /* we can downgrade protocols only */
1331                         bstp_timer_stop(&bp->bp_migrate_delay_timer);
1332                         /* clear unsupported features */
1333                         bp->bp_operedge = 0;
1334                         break;
1335
1336                 case BSTP_PROTO_RSTP:
1337                         bstp_timer_start(&bp->bp_migrate_delay_timer,
1338                             bs->bs_migration_delay);
1339                         break;
1340
1341                 default:
1342                         DPRINTF("Unsupported STP version %d\n", proto);
1343                         return;
1344         }
1345
1346         bp->bp_protover = proto;
1347         bp->bp_flags &= ~BSTP_PORT_CANMIGRATE;
1348 }
1349
1350 static void
1351 bstp_set_port_tc(struct bstp_port *bp, int state)
1352 {
1353         struct bstp_state *bs = bp->bp_bs;
1354
1355         bp->bp_tcstate = state;
1356
1357         /* initialise the new state */
1358         switch (bp->bp_tcstate) {
1359                 case BSTP_TCSTATE_ACTIVE:
1360                         DPRINTF("%s -> TC_ACTIVE\n", bp->bp_ifp->if_xname);
1361                         /* nothing to do */
1362                         break;
1363
1364                 case BSTP_TCSTATE_INACTIVE:
1365                         bstp_timer_stop(&bp->bp_tc_timer);
1366                         /* flush routes on the parent bridge */
1367                         bp->bp_fdbflush = 1;
1368                         taskqueue_enqueue(taskqueue_swi, &bp->bp_rtagetask);
1369                         bp->bp_tc_ack = 0;
1370                         DPRINTF("%s -> TC_INACTIVE\n", bp->bp_ifp->if_xname);
1371                         break;
1372
1373                 case BSTP_TCSTATE_LEARNING:
1374                         bp->bp_rcvdtc = 0;
1375                         bp->bp_rcvdtcn = 0;
1376                         bp->bp_rcvdtca = 0;
1377                         bp->bp_tc_prop = 0;
1378                         DPRINTF("%s -> TC_LEARNING\n", bp->bp_ifp->if_xname);
1379                         break;
1380
1381                 case BSTP_TCSTATE_DETECTED:
1382                         bstp_set_timer_tc(bp);
1383                         bstp_set_other_tcprop(bp);
1384                         /* send out notification */
1385                         bp->bp_flags |= BSTP_PORT_NEWINFO;
1386                         bstp_transmit(bs, bp);
1387                         getmicrotime(&bs->bs_last_tc_time);
1388                         DPRINTF("%s -> TC_DETECTED\n", bp->bp_ifp->if_xname);
1389                         bp->bp_tcstate = BSTP_TCSTATE_ACTIVE; /* UCT */
1390                         break;
1391
1392                 case BSTP_TCSTATE_TCN:
1393                         bstp_set_timer_tc(bp);
1394                         DPRINTF("%s -> TC_TCN\n", bp->bp_ifp->if_xname);
1395                         /* fall through */
1396                 case BSTP_TCSTATE_TC:
1397                         bp->bp_rcvdtc = 0;
1398                         bp->bp_rcvdtcn = 0;
1399                         if (bp->bp_role == BSTP_ROLE_DESIGNATED)
1400                                 bp->bp_tc_ack = 1;
1401
1402                         bstp_set_other_tcprop(bp);
1403                         DPRINTF("%s -> TC_TC\n", bp->bp_ifp->if_xname);
1404                         bp->bp_tcstate = BSTP_TCSTATE_ACTIVE; /* UCT */
1405                         break;
1406
1407                 case BSTP_TCSTATE_PROPAG:
1408                         /* flush routes on the parent bridge */
1409                         bp->bp_fdbflush = 1;
1410                         taskqueue_enqueue(taskqueue_swi, &bp->bp_rtagetask);
1411                         bp->bp_tc_prop = 0;
1412                         bstp_set_timer_tc(bp);
1413                         DPRINTF("%s -> TC_PROPAG\n", bp->bp_ifp->if_xname);
1414                         bp->bp_tcstate = BSTP_TCSTATE_ACTIVE; /* UCT */
1415                         break;
1416
1417                 case BSTP_TCSTATE_ACK:
1418                         bstp_timer_stop(&bp->bp_tc_timer);
1419                         bp->bp_rcvdtca = 0;
1420                         DPRINTF("%s -> TC_ACK\n", bp->bp_ifp->if_xname);
1421                         bp->bp_tcstate = BSTP_TCSTATE_ACTIVE; /* UCT */
1422                         break;
1423         }
1424 }
1425
1426 static void
1427 bstp_set_timer_tc(struct bstp_port *bp)
1428 {
1429         struct bstp_state *bs = bp->bp_bs;
1430
1431         if (bp->bp_tc_timer.active)
1432                 return;
1433
1434         switch (bp->bp_protover) {
1435                 case BSTP_PROTO_RSTP:
1436                         bstp_timer_start(&bp->bp_tc_timer,
1437                             bp->bp_desg_htime + BSTP_TICK_VAL);
1438                         bp->bp_flags |= BSTP_PORT_NEWINFO;
1439                         break;
1440
1441                 case BSTP_PROTO_STP:
1442                         bstp_timer_start(&bp->bp_tc_timer,
1443                             bs->bs_root_max_age + bs->bs_root_fdelay);
1444                         break;
1445         }
1446 }
1447
1448 static void
1449 bstp_set_timer_msgage(struct bstp_port *bp)
1450 {
1451         if (bp->bp_port_msg_age + BSTP_MESSAGE_AGE_INCR <=
1452             bp->bp_port_max_age) {
1453                 bstp_timer_start(&bp->bp_message_age_timer,
1454                     bp->bp_port_htime * 3);
1455         } else
1456                 /* expires immediately */
1457                 bstp_timer_start(&bp->bp_message_age_timer, 0);
1458 }
1459
1460 static int
1461 bstp_rerooted(struct bstp_state *bs, struct bstp_port *bp)
1462 {
1463         struct bstp_port *bp2;
1464         int rr_set = 0;
1465
1466         LIST_FOREACH(bp2, &bs->bs_bplist, bp_next) {
1467                 if (bp2 == bp)
1468                         continue;
1469                 if (bp2->bp_recent_root_timer.active) {
1470                         rr_set = 1;
1471                         break;
1472                 }
1473         }
1474         return (!rr_set);
1475 }
1476
1477 int
1478 bstp_set_htime(struct bstp_state *bs, int t)
1479 {
1480         /* convert seconds to ticks */
1481         t *=  BSTP_TICK_VAL;
1482
1483         /* value can only be changed in leagacy stp mode */
1484         if (bs->bs_protover != BSTP_PROTO_STP)
1485                 return (EPERM);
1486
1487         if (t < BSTP_MIN_HELLO_TIME || t > BSTP_MAX_HELLO_TIME)
1488                 return (EINVAL);
1489
1490         BSTP_LOCK(bs);
1491         bs->bs_bridge_htime = t;
1492         bstp_reinit(bs);
1493         BSTP_UNLOCK(bs);
1494         return (0);
1495 }
1496
1497 int
1498 bstp_set_fdelay(struct bstp_state *bs, int t)
1499 {
1500         /* convert seconds to ticks */
1501         t *= BSTP_TICK_VAL;
1502
1503         if (t < BSTP_MIN_FORWARD_DELAY || t > BSTP_MAX_FORWARD_DELAY)
1504                 return (EINVAL);
1505
1506         BSTP_LOCK(bs);
1507         bs->bs_bridge_fdelay = t;
1508         bstp_reinit(bs);
1509         BSTP_UNLOCK(bs);
1510         return (0);
1511 }
1512
1513 int
1514 bstp_set_maxage(struct bstp_state *bs, int t)
1515 {
1516         /* convert seconds to ticks */
1517         t *= BSTP_TICK_VAL;
1518
1519         if (t < BSTP_MIN_MAX_AGE || t > BSTP_MAX_MAX_AGE)
1520                 return (EINVAL);
1521
1522         BSTP_LOCK(bs);
1523         bs->bs_bridge_max_age = t;
1524         bstp_reinit(bs);
1525         BSTP_UNLOCK(bs);
1526         return (0);
1527 }
1528
1529 int
1530 bstp_set_holdcount(struct bstp_state *bs, int count)
1531 {
1532         struct bstp_port *bp;
1533
1534         if (count < BSTP_MIN_HOLD_COUNT ||
1535             count > BSTP_MAX_HOLD_COUNT)
1536                 return (EINVAL);
1537
1538         BSTP_LOCK(bs);
1539         bs->bs_txholdcount = count;
1540         LIST_FOREACH(bp, &bs->bs_bplist, bp_next)
1541                 bp->bp_txcount = 0;
1542         BSTP_UNLOCK(bs);
1543         return (0);
1544 }
1545
1546 int
1547 bstp_set_protocol(struct bstp_state *bs, int proto)
1548 {
1549         struct bstp_port *bp;
1550
1551         switch (proto) {
1552                 /* Supported protocol versions */
1553                 case BSTP_PROTO_STP:
1554                 case BSTP_PROTO_RSTP:
1555                         break;
1556
1557                 default:
1558                         return (EINVAL);
1559         }
1560
1561         BSTP_LOCK(bs);
1562         bs->bs_protover = proto;
1563         bs->bs_bridge_htime = BSTP_DEFAULT_HELLO_TIME;
1564         LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
1565                 /* reinit state */
1566                 bp->bp_infois = BSTP_INFO_DISABLED;
1567                 bp->bp_txcount = 0;
1568                 bstp_set_port_proto(bp, bs->bs_protover);
1569                 bstp_set_port_role(bp, BSTP_ROLE_DISABLED);
1570                 bstp_set_port_tc(bp, BSTP_TCSTATE_INACTIVE);
1571                 bstp_timer_stop(&bp->bp_recent_backup_timer);
1572         }
1573         bstp_reinit(bs);
1574         BSTP_UNLOCK(bs);
1575         return (0);
1576 }
1577
1578 int
1579 bstp_set_priority(struct bstp_state *bs, int pri)
1580 {
1581         if (pri < 0 || pri > BSTP_MAX_PRIORITY)
1582                 return (EINVAL);
1583
1584         /* Limit to steps of 4096 */
1585         pri -= pri % 4096;
1586
1587         BSTP_LOCK(bs);
1588         bs->bs_bridge_priority = pri;
1589         bstp_reinit(bs);
1590         BSTP_UNLOCK(bs);
1591         return (0);
1592 }
1593
1594 int
1595 bstp_set_port_priority(struct bstp_port *bp, int pri)
1596 {
1597         struct bstp_state *bs = bp->bp_bs;
1598
1599         if (pri < 0 || pri > BSTP_MAX_PORT_PRIORITY)
1600                 return (EINVAL);
1601
1602         /* Limit to steps of 16 */
1603         pri -= pri % 16;
1604
1605         BSTP_LOCK(bs);
1606         bp->bp_priority = pri;
1607         bstp_reinit(bs);
1608         BSTP_UNLOCK(bs);
1609         return (0);
1610 }
1611
1612 int
1613 bstp_set_path_cost(struct bstp_port *bp, uint32_t path_cost)
1614 {
1615         struct bstp_state *bs = bp->bp_bs;
1616
1617         if (path_cost > BSTP_MAX_PATH_COST)
1618                 return (EINVAL);
1619
1620         BSTP_LOCK(bs);
1621
1622         if (path_cost == 0) {   /* use auto */
1623                 bp->bp_flags &= ~BSTP_PORT_ADMCOST;
1624                 bp->bp_path_cost = bstp_calc_path_cost(bp);
1625         } else {
1626                 bp->bp_path_cost = path_cost;
1627                 bp->bp_flags |= BSTP_PORT_ADMCOST;
1628         }
1629         bstp_reinit(bs);
1630         BSTP_UNLOCK(bs);
1631         return (0);
1632 }
1633
1634 int
1635 bstp_set_edge(struct bstp_port *bp, int set)
1636 {
1637         struct bstp_state *bs = bp->bp_bs;
1638
1639         BSTP_LOCK(bs);
1640         if ((bp->bp_operedge = set) == 0)
1641                 bp->bp_flags &= ~BSTP_PORT_ADMEDGE;
1642         else
1643                 bp->bp_flags |= BSTP_PORT_ADMEDGE;
1644         BSTP_UNLOCK(bs);
1645         return (0);
1646 }
1647
1648 int
1649 bstp_set_autoedge(struct bstp_port *bp, int set)
1650 {
1651         struct bstp_state *bs = bp->bp_bs;
1652
1653         BSTP_LOCK(bs);
1654         if (set) {
1655                 bp->bp_flags |= BSTP_PORT_AUTOEDGE;
1656                 /* we may be able to transition straight to edge */
1657                 if (bp->bp_edge_delay_timer.active == 0)
1658                         bstp_edge_delay_expiry(bs, bp);
1659         } else
1660                 bp->bp_flags &= ~BSTP_PORT_AUTOEDGE;
1661         BSTP_UNLOCK(bs);
1662         return (0);
1663 }
1664
1665 int
1666 bstp_set_ptp(struct bstp_port *bp, int set)
1667 {
1668         struct bstp_state *bs = bp->bp_bs;
1669
1670         BSTP_LOCK(bs);
1671         bp->bp_ptp_link = set;
1672         BSTP_UNLOCK(bs);
1673         return (0);
1674 }
1675
1676 int
1677 bstp_set_autoptp(struct bstp_port *bp, int set)
1678 {
1679         struct bstp_state *bs = bp->bp_bs;
1680
1681         BSTP_LOCK(bs);
1682         if (set) {
1683                 bp->bp_flags |= BSTP_PORT_AUTOPTP;
1684                 bstp_ifupdstatus(bs, bp);
1685         } else
1686                 bp->bp_flags &= ~BSTP_PORT_AUTOPTP;
1687         BSTP_UNLOCK(bs);
1688         return (0);
1689 }
1690
1691 /*
1692  * Calculate the path cost according to the link speed.
1693  */
1694 static uint32_t
1695 bstp_calc_path_cost(struct bstp_port *bp)
1696 {
1697         struct ifnet *ifp = bp->bp_ifp;
1698         uint32_t path_cost;
1699
1700         /* If the priority has been manually set then retain the value */
1701         if (bp->bp_flags & BSTP_PORT_ADMCOST)
1702                 return bp->bp_path_cost;
1703
1704         if (ifp->if_baudrate < 1000)
1705                 return (BSTP_DEFAULT_PATH_COST);
1706
1707         /* formula from section 17.14, IEEE Std 802.1D-2004 */
1708         path_cost = 20000000000ULL / (ifp->if_baudrate / 1000);
1709
1710         if (path_cost > BSTP_MAX_PATH_COST)
1711                 path_cost = BSTP_MAX_PATH_COST;
1712
1713         /* STP compat mode only uses 16 bits of the 32 */
1714         if (bp->bp_protover == BSTP_PROTO_STP && path_cost > 65535)
1715                 path_cost = 65535;
1716
1717         return (path_cost);
1718 }
1719
1720 /*
1721  * Notify the bridge that a port state has changed, we need to do this from a
1722  * taskqueue to avoid a LOR.
1723  */
1724 static void
1725 bstp_notify_state(void *arg, int pending)
1726 {
1727         struct bstp_port *bp = (struct bstp_port *)arg;
1728         struct bstp_state *bs = bp->bp_bs;
1729
1730         if (bp->bp_active == 1 && bs->bs_state_cb != NULL)
1731                 (*bs->bs_state_cb)(bp->bp_ifp, bp->bp_state);
1732 }
1733
1734 /*
1735  * Flush the routes on the bridge port, we need to do this from a
1736  * taskqueue to avoid a LOR.
1737  */
1738 static void
1739 bstp_notify_rtage(void *arg, int pending)
1740 {
1741         struct bstp_port *bp = (struct bstp_port *)arg;
1742         struct bstp_state *bs = bp->bp_bs;
1743         int age = 0;
1744
1745         BSTP_LOCK(bs);
1746         switch (bp->bp_protover) {
1747                 case BSTP_PROTO_STP:
1748                         /* convert to seconds */
1749                         age = bp->bp_desg_fdelay / BSTP_TICK_VAL;
1750                         break;
1751
1752                 case BSTP_PROTO_RSTP:
1753                         age = 0;
1754                         break;
1755         }
1756         BSTP_UNLOCK(bs);
1757
1758         if (bp->bp_active == 1 && bs->bs_rtage_cb != NULL)
1759                 (*bs->bs_rtage_cb)(bp->bp_ifp, age);
1760
1761         /* flush is complete */
1762         BSTP_LOCK(bs);
1763         bp->bp_fdbflush = 0;
1764         BSTP_UNLOCK(bs);
1765 }
1766
1767 void
1768 bstp_linkstate(struct ifnet *ifp, int state)
1769 {
1770         struct bstp_state *bs;
1771         struct bstp_port *bp;
1772
1773         /* search for the stp port */
1774         mtx_lock(&bstp_list_mtx);
1775         LIST_FOREACH(bs, &bstp_list, bs_list) {
1776                 BSTP_LOCK(bs);
1777                 LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
1778                         if (bp->bp_ifp == ifp) {
1779                                 bstp_ifupdstatus(bs, bp);
1780                                 bstp_update_state(bs, bp);
1781                                 /* it only exists once so return */
1782                                 BSTP_UNLOCK(bs);
1783                                 mtx_unlock(&bstp_list_mtx);
1784                                 return;
1785                         }
1786                 }
1787                 BSTP_UNLOCK(bs);
1788         }
1789         mtx_unlock(&bstp_list_mtx);
1790 }
1791
1792 static void
1793 bstp_ifupdstatus(struct bstp_state *bs, struct bstp_port *bp)
1794 {
1795         struct ifnet *ifp = bp->bp_ifp;
1796         struct ifmediareq ifmr;
1797         int error = 0;
1798
1799         BSTP_LOCK_ASSERT(bs);
1800
1801         bzero((char *)&ifmr, sizeof(ifmr));
1802         error = (*ifp->if_ioctl)(ifp, SIOCGIFMEDIA, (caddr_t)&ifmr);
1803
1804         if ((error == 0) && (ifp->if_flags & IFF_UP)) {
1805                 if (ifmr.ifm_status & IFM_ACTIVE) {
1806                         /* A full-duplex link is assumed to be point to point */
1807                         if (bp->bp_flags & BSTP_PORT_AUTOPTP) {
1808                                 bp->bp_ptp_link =
1809                                     ifmr.ifm_active & IFM_FDX ? 1 : 0;
1810                         }
1811
1812                         if (bp->bp_role == BSTP_ROLE_DISABLED)
1813                                 bstp_enable_port(bs, bp);
1814                 } else {
1815                         if (bp->bp_role != BSTP_ROLE_DISABLED) {
1816                                 bstp_disable_port(bs, bp);
1817                                 if ((bp->bp_flags & BSTP_PORT_ADMEDGE) &&
1818                                     bp->bp_protover == BSTP_PROTO_RSTP)
1819                                         bp->bp_operedge = 1;
1820                         }
1821                 }
1822                 return;
1823         }
1824
1825         if (bp->bp_infois != BSTP_INFO_DISABLED)
1826                 bstp_disable_port(bs, bp);
1827 }
1828
1829 static void
1830 bstp_enable_port(struct bstp_state *bs, struct bstp_port *bp)
1831 {
1832         bp->bp_infois = BSTP_INFO_AGED;
1833         bstp_assign_roles(bs);
1834 }
1835
1836 static void
1837 bstp_disable_port(struct bstp_state *bs, struct bstp_port *bp)
1838 {
1839         bp->bp_infois = BSTP_INFO_DISABLED;
1840         bstp_assign_roles(bs);
1841 }
1842
1843 static void
1844 bstp_tick(void *arg)
1845 {
1846         struct bstp_state *bs = arg;
1847         struct bstp_port *bp;
1848
1849         BSTP_LOCK_ASSERT(bs);
1850
1851         if (bs->bs_running == 0)
1852                 return;
1853
1854         /* slow timer to catch missed link events */
1855         if (bstp_timer_expired(&bs->bs_link_timer)) {
1856                 LIST_FOREACH(bp, &bs->bs_bplist, bp_next)
1857                         bstp_ifupdstatus(bs, bp);
1858                 bstp_timer_start(&bs->bs_link_timer, BSTP_LINK_TIMER);
1859         }
1860
1861         LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
1862                 /* no events need to happen for these */
1863                 bstp_timer_expired(&bp->bp_tc_timer);
1864                 bstp_timer_expired(&bp->bp_recent_root_timer);
1865                 bstp_timer_expired(&bp->bp_forward_delay_timer);
1866                 bstp_timer_expired(&bp->bp_recent_backup_timer);
1867
1868                 if (bstp_timer_expired(&bp->bp_hello_timer))
1869                         bstp_hello_timer_expiry(bs, bp);
1870
1871                 if (bstp_timer_expired(&bp->bp_message_age_timer))
1872                         bstp_message_age_expiry(bs, bp);
1873
1874                 if (bstp_timer_expired(&bp->bp_migrate_delay_timer))
1875                         bstp_migrate_delay_expiry(bs, bp);
1876
1877                 if (bstp_timer_expired(&bp->bp_edge_delay_timer))
1878                         bstp_edge_delay_expiry(bs, bp);
1879
1880                 /* update the various state machines for the port */
1881                 bstp_update_state(bs, bp);
1882
1883                 if (bp->bp_txcount > 0)
1884                         bp->bp_txcount--;
1885         }
1886
1887         callout_reset(&bs->bs_bstpcallout, hz, bstp_tick, bs);
1888 }
1889
1890 static void
1891 bstp_timer_start(struct bstp_timer *t, uint16_t v)
1892 {
1893         t->value = v;
1894         t->active = 1;
1895         t->latched = 0;
1896 }
1897
1898 static void
1899 bstp_timer_stop(struct bstp_timer *t)
1900 {
1901         t->value = 0;
1902         t->active = 0;
1903         t->latched = 0;
1904 }
1905
1906 static void
1907 bstp_timer_latch(struct bstp_timer *t)
1908 {
1909         t->latched = 1;
1910         t->active = 1;
1911 }
1912
1913 static int
1914 bstp_timer_expired(struct bstp_timer *t)
1915 {
1916         if (t->active == 0 || t->latched)
1917                 return (0);
1918         t->value -= BSTP_TICK_VAL;
1919         if (t->value <= 0) {
1920                 bstp_timer_stop(t);
1921                 return (1);
1922         }
1923         return (0);
1924 }
1925
1926 static void
1927 bstp_hello_timer_expiry(struct bstp_state *bs, struct bstp_port *bp)
1928 {
1929         if ((bp->bp_flags & BSTP_PORT_NEWINFO) ||
1930             bp->bp_role == BSTP_ROLE_DESIGNATED ||
1931             (bp->bp_role == BSTP_ROLE_ROOT &&
1932              bp->bp_tc_timer.active == 1)) {
1933                 bstp_timer_start(&bp->bp_hello_timer, bp->bp_desg_htime);
1934                 bp->bp_flags |= BSTP_PORT_NEWINFO;
1935                 bstp_transmit(bs, bp);
1936         }
1937 }
1938
1939 static void
1940 bstp_message_age_expiry(struct bstp_state *bs, struct bstp_port *bp)
1941 {
1942         if (bp->bp_infois == BSTP_INFO_RECIEVED) {
1943                 bp->bp_infois = BSTP_INFO_AGED;
1944                 bstp_assign_roles(bs);
1945                 DPRINTF("aged info on %s\n", bp->bp_ifp->if_xname);
1946         }
1947 }
1948
1949 static void
1950 bstp_migrate_delay_expiry(struct bstp_state *bs, struct bstp_port *bp)
1951 {
1952         bp->bp_flags |= BSTP_PORT_CANMIGRATE;
1953 }
1954
1955 static void
1956 bstp_edge_delay_expiry(struct bstp_state *bs, struct bstp_port *bp)
1957 {
1958         if ((bp->bp_flags & BSTP_PORT_AUTOEDGE) &&
1959             bp->bp_protover == BSTP_PROTO_RSTP && bp->bp_proposing &&
1960             bp->bp_role == BSTP_ROLE_DESIGNATED) {
1961                 bp->bp_operedge = 1;
1962                 DPRINTF("%s -> edge port\n", bp->bp_ifp->if_xname);
1963         }
1964 }
1965
1966 static int
1967 bstp_addr_cmp(const uint8_t *a, const uint8_t *b)
1968 {
1969         int i, d;
1970
1971         for (i = 0, d = 0; i < ETHER_ADDR_LEN && d == 0; i++) {
1972                 d = ((int)a[i]) - ((int)b[i]);
1973         }
1974
1975         return (d);
1976 }
1977
1978 /*
1979  * compare the bridge address component of the bridgeid
1980  */
1981 static int
1982 bstp_same_bridgeid(uint64_t id1, uint64_t id2)
1983 {
1984         u_char addr1[ETHER_ADDR_LEN];
1985         u_char addr2[ETHER_ADDR_LEN];
1986
1987         PV2ADDR(id1, addr1);
1988         PV2ADDR(id2, addr2);
1989
1990         if (bstp_addr_cmp(addr1, addr2) == 0)
1991                 return (1);
1992
1993         return (0);
1994 }
1995
1996 void
1997 bstp_reinit(struct bstp_state *bs)
1998 {
1999         struct bstp_port *bp;
2000         struct ifnet *ifp, *mif;
2001         u_char *e_addr;
2002
2003         BSTP_LOCK_ASSERT(bs);
2004
2005         if (LIST_EMPTY(&bs->bs_bplist)) {
2006                 callout_stop(&bs->bs_bstpcallout);
2007                 return;
2008         }
2009
2010         mif = NULL;
2011         /*
2012          * Search through the Ethernet adapters and find the one with the
2013          * lowest value. The adapter which we take the MAC address from does
2014          * not need to be part of the bridge, it just needs to be a unique
2015          * value. It is not possible for mif to be null, at this point we have
2016          * at least one stp port and hence at least one NIC.
2017          */
2018         IFNET_RLOCK();
2019         TAILQ_FOREACH(ifp, &ifnet, if_link) {
2020                 if (ifp->if_type != IFT_ETHER)
2021                         continue;
2022
2023                 if (mif == NULL) {
2024                         mif = ifp;
2025                         continue;
2026                 }
2027                 if (bstp_addr_cmp(IF_LLADDR(ifp), IF_LLADDR(mif)) < 0) {
2028                         mif = ifp;
2029                         continue;
2030                 }
2031         }
2032         IFNET_RUNLOCK();
2033
2034         e_addr = IF_LLADDR(mif);
2035         bs->bs_bridge_pv.pv_dbridge_id =
2036             (((uint64_t)bs->bs_bridge_priority) << 48) |
2037             (((uint64_t)e_addr[0]) << 40) |
2038             (((uint64_t)e_addr[1]) << 32) |
2039             (((uint64_t)e_addr[2]) << 24) |
2040             (((uint64_t)e_addr[3]) << 16) |
2041             (((uint64_t)e_addr[4]) << 8) |
2042             (((uint64_t)e_addr[5]));
2043
2044         bs->bs_bridge_pv.pv_root_id = bs->bs_bridge_pv.pv_dbridge_id;
2045         bs->bs_bridge_pv.pv_cost = 0;
2046         bs->bs_bridge_pv.pv_dport_id = 0;
2047         bs->bs_bridge_pv.pv_port_id = 0;
2048
2049         if (bs->bs_running && callout_pending(&bs->bs_bstpcallout) == 0)
2050                 callout_reset(&bs->bs_bstpcallout, hz, bstp_tick, bs);
2051
2052         LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
2053                 bp->bp_port_id = (bp->bp_priority << 8) |
2054                     (bp->bp_ifp->if_index  & 0xfff);
2055                 bstp_ifupdstatus(bs, bp);
2056         }
2057
2058         bstp_assign_roles(bs);
2059         bstp_timer_start(&bs->bs_link_timer, BSTP_LINK_TIMER);
2060 }
2061
2062 static int
2063 bstp_modevent(module_t mod, int type, void *data)
2064 {
2065         switch (type) {
2066         case MOD_LOAD:
2067                 mtx_init(&bstp_list_mtx, "bridgestp list", NULL, MTX_DEF);
2068                 LIST_INIT(&bstp_list);
2069                 bstp_linkstate_p = bstp_linkstate;
2070                 break;
2071         case MOD_UNLOAD:
2072                 mtx_destroy(&bstp_list_mtx);
2073                 break;
2074         default:
2075                 return (EOPNOTSUPP);
2076         }
2077         return (0);
2078 }
2079
2080 static moduledata_t bstp_mod = {
2081         "bridgestp",
2082         bstp_modevent,
2083         0
2084 };
2085
2086 DECLARE_MODULE(bridgestp, bstp_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
2087 MODULE_VERSION(bridgestp, 1);
2088
2089 void
2090 bstp_attach(struct bstp_state *bs, bstp_state_cb_t state_callback,
2091     bstp_rtage_cb_t rtage_callback)
2092 {
2093         BSTP_LOCK_INIT(bs);
2094         callout_init_mtx(&bs->bs_bstpcallout, &bs->bs_mtx, 0);
2095         LIST_INIT(&bs->bs_bplist);
2096
2097         bs->bs_bridge_max_age = BSTP_DEFAULT_MAX_AGE;
2098         bs->bs_bridge_htime = BSTP_DEFAULT_HELLO_TIME;
2099         bs->bs_bridge_fdelay = BSTP_DEFAULT_FORWARD_DELAY;
2100         bs->bs_bridge_priority = BSTP_DEFAULT_BRIDGE_PRIORITY;
2101         bs->bs_hold_time = BSTP_DEFAULT_HOLD_TIME;
2102         bs->bs_migration_delay = BSTP_DEFAULT_MIGRATE_DELAY;
2103         bs->bs_txholdcount = BSTP_DEFAULT_HOLD_COUNT;
2104         bs->bs_protover = BSTP_PROTO_RSTP;
2105         bs->bs_state_cb = state_callback;
2106         bs->bs_rtage_cb = rtage_callback;
2107
2108         getmicrotime(&bs->bs_last_tc_time);
2109
2110         mtx_lock(&bstp_list_mtx);
2111         LIST_INSERT_HEAD(&bstp_list, bs, bs_list);
2112         mtx_unlock(&bstp_list_mtx);
2113 }
2114
2115 void
2116 bstp_detach(struct bstp_state *bs)
2117 {
2118         KASSERT(LIST_EMPTY(&bs->bs_bplist), ("bstp still active"));
2119
2120         mtx_lock(&bstp_list_mtx);
2121         LIST_REMOVE(bs, bs_list);
2122         mtx_unlock(&bstp_list_mtx);
2123         callout_drain(&bs->bs_bstpcallout);
2124         BSTP_LOCK_DESTROY(bs);
2125 }
2126
2127 void
2128 bstp_init(struct bstp_state *bs)
2129 {
2130         BSTP_LOCK(bs);
2131         callout_reset(&bs->bs_bstpcallout, hz, bstp_tick, bs);
2132         bs->bs_running = 1;
2133         bstp_reinit(bs);
2134         BSTP_UNLOCK(bs);
2135 }
2136
2137 void
2138 bstp_stop(struct bstp_state *bs)
2139 {
2140         struct bstp_port *bp;
2141
2142         BSTP_LOCK(bs);
2143
2144         LIST_FOREACH(bp, &bs->bs_bplist, bp_next)
2145                 bstp_set_port_state(bp, BSTP_IFSTATE_DISCARDING);
2146
2147         bs->bs_running = 0;
2148         callout_stop(&bs->bs_bstpcallout);
2149         BSTP_UNLOCK(bs);
2150 }
2151
2152 int
2153 bstp_create(struct bstp_state *bs, struct bstp_port *bp, struct ifnet *ifp)
2154 {
2155         bzero(bp, sizeof(struct bstp_port));
2156
2157         BSTP_LOCK(bs);
2158         bp->bp_ifp = ifp;
2159         bp->bp_bs = bs;
2160         bp->bp_priority = BSTP_DEFAULT_PORT_PRIORITY;
2161         TASK_INIT(&bp->bp_statetask, 0, bstp_notify_state, bp);
2162         TASK_INIT(&bp->bp_rtagetask, 0, bstp_notify_rtage, bp);
2163
2164         /* Init state */
2165         bp->bp_infois = BSTP_INFO_DISABLED;
2166         bp->bp_flags = BSTP_PORT_AUTOEDGE|BSTP_PORT_AUTOPTP;
2167         bstp_set_port_state(bp, BSTP_IFSTATE_DISCARDING);
2168         bstp_set_port_proto(bp, bs->bs_protover);
2169         bstp_set_port_role(bp, BSTP_ROLE_DISABLED);
2170         bstp_set_port_tc(bp, BSTP_TCSTATE_INACTIVE);
2171         bp->bp_path_cost = bstp_calc_path_cost(bp);
2172         BSTP_UNLOCK(bs);
2173         return (0);
2174 }
2175
2176 int
2177 bstp_enable(struct bstp_port *bp)
2178 {
2179         struct bstp_state *bs = bp->bp_bs;
2180         struct ifnet *ifp = bp->bp_ifp;
2181
2182         KASSERT(bp->bp_active == 0, ("already a bstp member"));
2183
2184         switch (ifp->if_type) {
2185                 case IFT_ETHER: /* These can do spanning tree. */
2186                         break;
2187                 default:
2188                         /* Nothing else can. */
2189                         return (EINVAL);
2190         }
2191
2192         BSTP_LOCK(bs);
2193         LIST_INSERT_HEAD(&bs->bs_bplist, bp, bp_next);
2194         bp->bp_active = 1;
2195         bp->bp_flags |= BSTP_PORT_NEWINFO;
2196         bstp_reinit(bs);
2197         bstp_update_roles(bs, bp);
2198         BSTP_UNLOCK(bs);
2199         return (0);
2200 }
2201
2202 void
2203 bstp_disable(struct bstp_port *bp)
2204 {
2205         struct bstp_state *bs = bp->bp_bs;
2206
2207         KASSERT(bp->bp_active == 1, ("not a bstp member"));
2208
2209         BSTP_LOCK(bs);
2210         bstp_disable_port(bs, bp);
2211         LIST_REMOVE(bp, bp_next);
2212         bp->bp_active = 0;
2213         bstp_reinit(bs);
2214         BSTP_UNLOCK(bs);
2215 }
2216
2217 /*
2218  * The bstp_port structure is about to be freed by the parent bridge.
2219  */
2220 void
2221 bstp_destroy(struct bstp_port *bp)
2222 {
2223         KASSERT(bp->bp_active == 0, ("port is still attached"));
2224         taskqueue_drain(taskqueue_swi, &bp->bp_statetask);
2225         taskqueue_drain(taskqueue_swi, &bp->bp_rtagetask);
2226 }