1 /* $NetBSD: bridgestp.c,v 1.5 2003/11/28 08:56:48 keihan Exp $ */
4 * SPDX-License-Identifier: BSD-2-Clause-NetBSD
6 * Copyright (c) 2000 Jason L. Wright (jason@thought.net)
7 * Copyright (c) 2006 Andrew Thompson (thompsa@FreeBSD.org)
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
23 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
28 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
31 * OpenBSD: bridgestp.c,v 1.5 2001/03/22 03:48:29 jason Exp
35 * Implementation of the spanning tree protocol as defined in
36 * ISO/IEC 802.1D-2004, June 9, 2004.
39 #include <sys/cdefs.h>
40 __FBSDID("$FreeBSD$");
42 #include <sys/param.h>
43 #include <sys/systm.h>
45 #include <sys/socket.h>
46 #include <sys/sockio.h>
47 #include <sys/kernel.h>
48 #include <sys/malloc.h>
49 #include <sys/callout.h>
50 #include <sys/module.h>
53 #include <sys/mutex.h>
54 #include <sys/taskqueue.h>
57 #include <net/if_var.h>
58 #include <net/if_dl.h>
59 #include <net/if_types.h>
60 #include <net/if_llc.h>
61 #include <net/if_media.h>
64 #include <netinet/in.h>
65 #include <netinet/in_systm.h>
66 #include <netinet/in_var.h>
67 #include <netinet/if_ether.h>
68 #include <net/bridgestp.h>
70 #ifdef BRIDGESTP_DEBUG
71 #define DPRINTF(fmt, arg...) printf("bstp: " fmt, ##arg)
73 #define DPRINTF(fmt, arg...) (void)0
76 #define PV2ADDR(pv, eaddr) do { \
77 eaddr[0] = pv >> 40; \
78 eaddr[1] = pv >> 32; \
79 eaddr[2] = pv >> 24; \
80 eaddr[3] = pv >> 16; \
89 const uint8_t bstp_etheraddr[] = { 0x01, 0x80, 0xc2, 0x00, 0x00, 0x00 };
91 LIST_HEAD(, bstp_state) bstp_list;
92 static struct mtx bstp_list_mtx;
94 static void bstp_transmit(struct bstp_state *, struct bstp_port *);
95 static void bstp_transmit_bpdu(struct bstp_state *, struct bstp_port *);
96 static void bstp_transmit_tcn(struct bstp_state *, struct bstp_port *);
97 static void bstp_decode_bpdu(struct bstp_port *, struct bstp_cbpdu *,
98 struct bstp_config_unit *);
99 static void bstp_send_bpdu(struct bstp_state *, struct bstp_port *,
100 struct bstp_cbpdu *);
101 static int bstp_pdu_flags(struct bstp_port *);
102 static void bstp_received_stp(struct bstp_state *, struct bstp_port *,
103 struct mbuf **, struct bstp_tbpdu *);
104 static void bstp_received_rstp(struct bstp_state *, struct bstp_port *,
105 struct mbuf **, struct bstp_tbpdu *);
106 static void bstp_received_tcn(struct bstp_state *, struct bstp_port *,
107 struct bstp_tcn_unit *);
108 static void bstp_received_bpdu(struct bstp_state *, struct bstp_port *,
109 struct bstp_config_unit *);
110 static int bstp_pdu_rcvtype(struct bstp_port *, struct bstp_config_unit *);
111 static int bstp_pdu_bettersame(struct bstp_port *, int);
112 static int bstp_info_cmp(struct bstp_pri_vector *,
113 struct bstp_pri_vector *);
114 static int bstp_info_superior(struct bstp_pri_vector *,
115 struct bstp_pri_vector *);
116 static void bstp_assign_roles(struct bstp_state *);
117 static void bstp_update_roles(struct bstp_state *, struct bstp_port *);
118 static void bstp_update_state(struct bstp_state *, struct bstp_port *);
119 static void bstp_update_tc(struct bstp_port *);
120 static void bstp_update_info(struct bstp_port *);
121 static void bstp_set_other_tcprop(struct bstp_port *);
122 static void bstp_set_all_reroot(struct bstp_state *);
123 static void bstp_set_all_sync(struct bstp_state *);
124 static void bstp_set_port_state(struct bstp_port *, int);
125 static void bstp_set_port_role(struct bstp_port *, int);
126 static void bstp_set_port_proto(struct bstp_port *, int);
127 static void bstp_set_port_tc(struct bstp_port *, int);
128 static void bstp_set_timer_tc(struct bstp_port *);
129 static void bstp_set_timer_msgage(struct bstp_port *);
130 static int bstp_rerooted(struct bstp_state *, struct bstp_port *);
131 static uint32_t bstp_calc_path_cost(struct bstp_port *);
132 static void bstp_notify_state(void *, int);
133 static void bstp_notify_rtage(void *, int);
134 static void bstp_ifupdstatus(void *, int);
135 static void bstp_enable_port(struct bstp_state *, struct bstp_port *);
136 static void bstp_disable_port(struct bstp_state *, struct bstp_port *);
137 static void bstp_tick(void *);
138 static void bstp_timer_start(struct bstp_timer *, uint16_t);
139 static void bstp_timer_stop(struct bstp_timer *);
140 static void bstp_timer_latch(struct bstp_timer *);
141 static int bstp_timer_dectest(struct bstp_timer *);
142 static void bstp_hello_timer_expiry(struct bstp_state *,
144 static void bstp_message_age_expiry(struct bstp_state *,
146 static void bstp_migrate_delay_expiry(struct bstp_state *,
148 static void bstp_edge_delay_expiry(struct bstp_state *,
150 static int bstp_addr_cmp(const uint8_t *, const uint8_t *);
151 static int bstp_same_bridgeid(uint64_t, uint64_t);
152 static void bstp_reinit(struct bstp_state *);
155 bstp_transmit(struct bstp_state *bs, struct bstp_port *bp)
157 if (bs->bs_running == 0)
161 * a PDU can only be sent if we have tx quota left and the
162 * hello timer is running.
164 if (bp->bp_hello_timer.active == 0) {
165 /* Test if it needs to be reset */
166 bstp_hello_timer_expiry(bs, bp);
169 if (bp->bp_txcount > bs->bs_txholdcount)
170 /* Ran out of karma */
173 if (bp->bp_protover == BSTP_PROTO_RSTP) {
174 bstp_transmit_bpdu(bs, bp);
177 switch (bp->bp_role) {
178 case BSTP_ROLE_DESIGNATED:
179 bstp_transmit_bpdu(bs, bp);
184 bstp_transmit_tcn(bs, bp);
188 bstp_timer_start(&bp->bp_hello_timer, bp->bp_desg_htime);
189 bp->bp_flags &= ~BSTP_PORT_NEWINFO;
193 bstp_transmit_bpdu(struct bstp_state *bs, struct bstp_port *bp)
195 struct bstp_cbpdu bpdu;
197 BSTP_LOCK_ASSERT(bs);
199 bpdu.cbu_rootpri = htons(bp->bp_desg_pv.pv_root_id >> 48);
200 PV2ADDR(bp->bp_desg_pv.pv_root_id, bpdu.cbu_rootaddr);
202 bpdu.cbu_rootpathcost = htonl(bp->bp_desg_pv.pv_cost);
204 bpdu.cbu_bridgepri = htons(bp->bp_desg_pv.pv_dbridge_id >> 48);
205 PV2ADDR(bp->bp_desg_pv.pv_dbridge_id, bpdu.cbu_bridgeaddr);
207 bpdu.cbu_portid = htons(bp->bp_port_id);
208 bpdu.cbu_messageage = htons(bp->bp_desg_msg_age);
209 bpdu.cbu_maxage = htons(bp->bp_desg_max_age);
210 bpdu.cbu_hellotime = htons(bp->bp_desg_htime);
211 bpdu.cbu_forwarddelay = htons(bp->bp_desg_fdelay);
213 bpdu.cbu_flags = bstp_pdu_flags(bp);
215 switch (bp->bp_protover) {
217 bpdu.cbu_bpdutype = BSTP_MSGTYPE_CFG;
220 case BSTP_PROTO_RSTP:
221 bpdu.cbu_bpdutype = BSTP_MSGTYPE_RSTP;
225 bstp_send_bpdu(bs, bp, &bpdu);
229 bstp_transmit_tcn(struct bstp_state *bs, struct bstp_port *bp)
231 struct bstp_tbpdu bpdu;
232 struct ifnet *ifp = bp->bp_ifp;
233 struct ether_header *eh;
236 KASSERT(bp == bs->bs_root_port, ("%s: bad root port\n", __func__));
238 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
241 m = m_gethdr(M_NOWAIT, MT_DATA);
245 m->m_pkthdr.rcvif = ifp;
246 m->m_pkthdr.len = sizeof(*eh) + sizeof(bpdu);
247 m->m_len = m->m_pkthdr.len;
249 eh = mtod(m, struct ether_header *);
251 memcpy(eh->ether_shost, IF_LLADDR(ifp), ETHER_ADDR_LEN);
252 memcpy(eh->ether_dhost, bstp_etheraddr, ETHER_ADDR_LEN);
253 eh->ether_type = htons(sizeof(bpdu));
255 bpdu.tbu_ssap = bpdu.tbu_dsap = LLC_8021D_LSAP;
256 bpdu.tbu_ctl = LLC_UI;
257 bpdu.tbu_protoid = 0;
258 bpdu.tbu_protover = 0;
259 bpdu.tbu_bpdutype = BSTP_MSGTYPE_TCN;
261 memcpy(mtod(m, caddr_t) + sizeof(*eh), &bpdu, sizeof(bpdu));
264 ifp->if_transmit(ifp, m);
268 bstp_decode_bpdu(struct bstp_port *bp, struct bstp_cbpdu *cpdu,
269 struct bstp_config_unit *cu)
273 cu->cu_pv.pv_root_id =
274 (((uint64_t)ntohs(cpdu->cbu_rootpri)) << 48) |
275 (((uint64_t)cpdu->cbu_rootaddr[0]) << 40) |
276 (((uint64_t)cpdu->cbu_rootaddr[1]) << 32) |
277 (((uint64_t)cpdu->cbu_rootaddr[2]) << 24) |
278 (((uint64_t)cpdu->cbu_rootaddr[3]) << 16) |
279 (((uint64_t)cpdu->cbu_rootaddr[4]) << 8) |
280 (((uint64_t)cpdu->cbu_rootaddr[5]) << 0);
282 cu->cu_pv.pv_dbridge_id =
283 (((uint64_t)ntohs(cpdu->cbu_bridgepri)) << 48) |
284 (((uint64_t)cpdu->cbu_bridgeaddr[0]) << 40) |
285 (((uint64_t)cpdu->cbu_bridgeaddr[1]) << 32) |
286 (((uint64_t)cpdu->cbu_bridgeaddr[2]) << 24) |
287 (((uint64_t)cpdu->cbu_bridgeaddr[3]) << 16) |
288 (((uint64_t)cpdu->cbu_bridgeaddr[4]) << 8) |
289 (((uint64_t)cpdu->cbu_bridgeaddr[5]) << 0);
291 cu->cu_pv.pv_cost = ntohl(cpdu->cbu_rootpathcost);
292 cu->cu_message_age = ntohs(cpdu->cbu_messageage);
293 cu->cu_max_age = ntohs(cpdu->cbu_maxage);
294 cu->cu_hello_time = ntohs(cpdu->cbu_hellotime);
295 cu->cu_forward_delay = ntohs(cpdu->cbu_forwarddelay);
296 cu->cu_pv.pv_dport_id = ntohs(cpdu->cbu_portid);
297 cu->cu_pv.pv_port_id = bp->bp_port_id;
298 cu->cu_message_type = cpdu->cbu_bpdutype;
300 /* Strip off unused flags in STP mode */
301 flags = cpdu->cbu_flags;
302 switch (cpdu->cbu_protover) {
304 flags &= BSTP_PDU_STPMASK;
305 /* A STP BPDU explicitly conveys a Designated Port */
306 cu->cu_role = BSTP_ROLE_DESIGNATED;
309 case BSTP_PROTO_RSTP:
310 flags &= BSTP_PDU_RSTPMASK;
314 cu->cu_topology_change_ack =
315 (flags & BSTP_PDU_F_TCA) ? 1 : 0;
317 (flags & BSTP_PDU_F_P) ? 1 : 0;
319 (flags & BSTP_PDU_F_A) ? 1 : 0;
321 (flags & BSTP_PDU_F_L) ? 1 : 0;
323 (flags & BSTP_PDU_F_F) ? 1 : 0;
324 cu->cu_topology_change =
325 (flags & BSTP_PDU_F_TC) ? 1 : 0;
327 switch ((flags & BSTP_PDU_PRMASK) >> BSTP_PDU_PRSHIFT) {
328 case BSTP_PDU_F_ROOT:
329 cu->cu_role = BSTP_ROLE_ROOT;
332 cu->cu_role = BSTP_ROLE_ALTERNATE;
334 case BSTP_PDU_F_DESG:
335 cu->cu_role = BSTP_ROLE_DESIGNATED;
341 bstp_send_bpdu(struct bstp_state *bs, struct bstp_port *bp,
342 struct bstp_cbpdu *bpdu)
346 struct ether_header *eh;
348 BSTP_LOCK_ASSERT(bs);
352 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
355 m = m_gethdr(M_NOWAIT, MT_DATA);
359 eh = mtod(m, struct ether_header *);
361 bpdu->cbu_ssap = bpdu->cbu_dsap = LLC_8021D_LSAP;
362 bpdu->cbu_ctl = LLC_UI;
363 bpdu->cbu_protoid = htons(BSTP_PROTO_ID);
365 memcpy(eh->ether_shost, IF_LLADDR(ifp), ETHER_ADDR_LEN);
366 memcpy(eh->ether_dhost, bstp_etheraddr, ETHER_ADDR_LEN);
368 switch (bpdu->cbu_bpdutype) {
369 case BSTP_MSGTYPE_CFG:
370 bpdu->cbu_protover = BSTP_PROTO_STP;
371 m->m_pkthdr.len = sizeof(*eh) + BSTP_BPDU_STP_LEN;
372 eh->ether_type = htons(BSTP_BPDU_STP_LEN);
373 memcpy(mtod(m, caddr_t) + sizeof(*eh), bpdu,
377 case BSTP_MSGTYPE_RSTP:
378 bpdu->cbu_protover = BSTP_PROTO_RSTP;
379 bpdu->cbu_versionlen = htons(0);
380 m->m_pkthdr.len = sizeof(*eh) + BSTP_BPDU_RSTP_LEN;
381 eh->ether_type = htons(BSTP_BPDU_RSTP_LEN);
382 memcpy(mtod(m, caddr_t) + sizeof(*eh), bpdu,
387 panic("not implemented");
389 m->m_pkthdr.rcvif = ifp;
390 m->m_len = m->m_pkthdr.len;
393 ifp->if_transmit(ifp, m);
397 bstp_pdu_flags(struct bstp_port *bp)
401 if (bp->bp_proposing && bp->bp_state != BSTP_IFSTATE_FORWARDING)
402 flags |= BSTP_PDU_F_P;
405 flags |= BSTP_PDU_F_A;
407 if (bp->bp_tc_timer.active)
408 flags |= BSTP_PDU_F_TC;
411 flags |= BSTP_PDU_F_TCA;
413 switch (bp->bp_state) {
414 case BSTP_IFSTATE_LEARNING:
415 flags |= BSTP_PDU_F_L;
418 case BSTP_IFSTATE_FORWARDING:
419 flags |= (BSTP_PDU_F_L | BSTP_PDU_F_F);
423 switch (bp->bp_role) {
426 (BSTP_PDU_F_ROOT << BSTP_PDU_PRSHIFT);
429 case BSTP_ROLE_ALTERNATE:
430 case BSTP_ROLE_BACKUP: /* fall through */
432 (BSTP_PDU_F_ALT << BSTP_PDU_PRSHIFT);
435 case BSTP_ROLE_DESIGNATED:
437 (BSTP_PDU_F_DESG << BSTP_PDU_PRSHIFT);
441 /* Strip off unused flags in either mode */
442 switch (bp->bp_protover) {
444 flags &= BSTP_PDU_STPMASK;
446 case BSTP_PROTO_RSTP:
447 flags &= BSTP_PDU_RSTPMASK;
454 bstp_input(struct bstp_port *bp, struct ifnet *ifp, struct mbuf *m)
456 struct bstp_state *bs = bp->bp_bs;
457 struct ether_header *eh;
458 struct bstp_tbpdu tpdu;
461 if (bp->bp_active == 0) {
468 eh = mtod(m, struct ether_header *);
470 len = ntohs(eh->ether_type);
471 if (len < sizeof(tpdu))
474 m_adj(m, ETHER_HDR_LEN);
476 if (m->m_pkthdr.len > len)
477 m_adj(m, len - m->m_pkthdr.len);
478 if (m->m_len < sizeof(tpdu) &&
479 (m = m_pullup(m, sizeof(tpdu))) == NULL)
482 memcpy(&tpdu, mtod(m, caddr_t), sizeof(tpdu));
484 /* basic packet checks */
485 if (tpdu.tbu_dsap != LLC_8021D_LSAP ||
486 tpdu.tbu_ssap != LLC_8021D_LSAP ||
487 tpdu.tbu_ctl != LLC_UI)
489 if (tpdu.tbu_protoid != BSTP_PROTO_ID)
493 * We can treat later versions of the PDU as the same as the maximum
494 * version we implement. All additional parameters/flags are ignored.
496 if (tpdu.tbu_protover > BSTP_PROTO_MAX)
497 tpdu.tbu_protover = BSTP_PROTO_MAX;
499 if (tpdu.tbu_protover != bp->bp_protover) {
501 * Wait for the migration delay timer to expire before changing
502 * protocol version to avoid flip-flops.
504 if (bp->bp_flags & BSTP_PORT_CANMIGRATE)
505 bstp_set_port_proto(bp, tpdu.tbu_protover);
510 /* Clear operedge upon receiving a PDU on the port */
512 bstp_timer_start(&bp->bp_edge_delay_timer,
513 BSTP_DEFAULT_MIGRATE_DELAY);
515 switch (tpdu.tbu_protover) {
517 bstp_received_stp(bs, bp, &m, &tpdu);
520 case BSTP_PROTO_RSTP:
521 bstp_received_rstp(bs, bp, &m, &tpdu);
531 bstp_received_stp(struct bstp_state *bs, struct bstp_port *bp,
532 struct mbuf **mp, struct bstp_tbpdu *tpdu)
534 struct bstp_cbpdu cpdu;
535 struct bstp_config_unit *cu = &bp->bp_msg_cu;
536 struct bstp_tcn_unit tu;
538 switch (tpdu->tbu_bpdutype) {
539 case BSTP_MSGTYPE_TCN:
540 tu.tu_message_type = tpdu->tbu_bpdutype;
541 bstp_received_tcn(bs, bp, &tu);
543 case BSTP_MSGTYPE_CFG:
544 if ((*mp)->m_len < BSTP_BPDU_STP_LEN &&
545 (*mp = m_pullup(*mp, BSTP_BPDU_STP_LEN)) == NULL)
547 memcpy(&cpdu, mtod(*mp, caddr_t), BSTP_BPDU_STP_LEN);
549 bstp_decode_bpdu(bp, &cpdu, cu);
550 bstp_received_bpdu(bs, bp, cu);
556 bstp_received_rstp(struct bstp_state *bs, struct bstp_port *bp,
557 struct mbuf **mp, struct bstp_tbpdu *tpdu)
559 struct bstp_cbpdu cpdu;
560 struct bstp_config_unit *cu = &bp->bp_msg_cu;
562 if (tpdu->tbu_bpdutype != BSTP_MSGTYPE_RSTP)
565 if ((*mp)->m_len < BSTP_BPDU_RSTP_LEN &&
566 (*mp = m_pullup(*mp, BSTP_BPDU_RSTP_LEN)) == NULL)
568 memcpy(&cpdu, mtod(*mp, caddr_t), BSTP_BPDU_RSTP_LEN);
570 bstp_decode_bpdu(bp, &cpdu, cu);
571 bstp_received_bpdu(bs, bp, cu);
575 bstp_received_tcn(struct bstp_state *bs, struct bstp_port *bp,
576 struct bstp_tcn_unit *tcn)
583 bstp_received_bpdu(struct bstp_state *bs, struct bstp_port *bp,
584 struct bstp_config_unit *cu)
588 BSTP_LOCK_ASSERT(bs);
590 /* We need to have transitioned to INFO_MINE before proceeding */
591 switch (bp->bp_infois) {
592 case BSTP_INFO_DISABLED:
597 type = bstp_pdu_rcvtype(bp, cu);
600 case BSTP_PDU_SUPERIOR:
601 bs->bs_allsynced = 0;
603 bp->bp_proposing = 0;
605 if (cu->cu_proposal && cu->cu_forwarding == 0)
607 if (cu->cu_topology_change)
609 if (cu->cu_topology_change_ack)
613 !bstp_pdu_bettersame(bp, BSTP_INFO_RECEIVED))
616 /* copy the received priority and timers to the port */
617 bp->bp_port_pv = cu->cu_pv;
618 bp->bp_port_msg_age = cu->cu_message_age;
619 bp->bp_port_max_age = cu->cu_max_age;
620 bp->bp_port_fdelay = cu->cu_forward_delay;
622 (cu->cu_hello_time > BSTP_MIN_HELLO_TIME ?
623 cu->cu_hello_time : BSTP_MIN_HELLO_TIME);
625 /* set expiry for the new info */
626 bstp_set_timer_msgage(bp);
628 bp->bp_infois = BSTP_INFO_RECEIVED;
629 bstp_assign_roles(bs);
632 case BSTP_PDU_REPEATED:
633 if (cu->cu_proposal && cu->cu_forwarding == 0)
635 if (cu->cu_topology_change)
637 if (cu->cu_topology_change_ack)
640 /* rearm the age timer */
641 bstp_set_timer_msgage(bp);
644 case BSTP_PDU_INFERIOR:
645 if (cu->cu_learning) {
647 bp->bp_proposing = 0;
651 case BSTP_PDU_INFERIORALT:
653 * only point to point links are allowed fast
654 * transitions to forwarding.
656 if (cu->cu_agree && bp->bp_ptp_link) {
658 bp->bp_proposing = 0;
662 if (cu->cu_topology_change)
664 if (cu->cu_topology_change_ack)
669 return; /* do nothing */
671 /* update the state machines with the new data */
672 bstp_update_state(bs, bp);
676 bstp_pdu_rcvtype(struct bstp_port *bp, struct bstp_config_unit *cu)
680 /* default return type */
681 type = BSTP_PDU_OTHER;
683 switch (cu->cu_role) {
684 case BSTP_ROLE_DESIGNATED:
685 if (bstp_info_superior(&bp->bp_port_pv, &cu->cu_pv))
686 /* bpdu priority is superior */
687 type = BSTP_PDU_SUPERIOR;
688 else if (bstp_info_cmp(&bp->bp_port_pv, &cu->cu_pv) ==
690 if (bp->bp_port_msg_age != cu->cu_message_age ||
691 bp->bp_port_max_age != cu->cu_max_age ||
692 bp->bp_port_fdelay != cu->cu_forward_delay ||
693 bp->bp_port_htime != cu->cu_hello_time)
694 /* bpdu priority is equal and timers differ */
695 type = BSTP_PDU_SUPERIOR;
698 type = BSTP_PDU_REPEATED;
700 /* bpdu priority is worse */
701 type = BSTP_PDU_INFERIOR;
706 case BSTP_ROLE_ALTERNATE:
707 case BSTP_ROLE_BACKUP:
708 if (bstp_info_cmp(&bp->bp_port_pv, &cu->cu_pv) <= INFO_SAME)
710 * not a designated port and priority is the same or
713 type = BSTP_PDU_INFERIORALT;
721 bstp_pdu_bettersame(struct bstp_port *bp, int newinfo)
723 if (newinfo == BSTP_INFO_RECEIVED &&
724 bp->bp_infois == BSTP_INFO_RECEIVED &&
725 bstp_info_cmp(&bp->bp_port_pv, &bp->bp_msg_cu.cu_pv) >= INFO_SAME)
728 if (newinfo == BSTP_INFO_MINE &&
729 bp->bp_infois == BSTP_INFO_MINE &&
730 bstp_info_cmp(&bp->bp_port_pv, &bp->bp_desg_pv) >= INFO_SAME)
737 bstp_info_cmp(struct bstp_pri_vector *pv,
738 struct bstp_pri_vector *cpv)
740 if (cpv->pv_root_id < pv->pv_root_id)
741 return (INFO_BETTER);
742 if (cpv->pv_root_id > pv->pv_root_id)
745 if (cpv->pv_cost < pv->pv_cost)
746 return (INFO_BETTER);
747 if (cpv->pv_cost > pv->pv_cost)
750 if (cpv->pv_dbridge_id < pv->pv_dbridge_id)
751 return (INFO_BETTER);
752 if (cpv->pv_dbridge_id > pv->pv_dbridge_id)
755 if (cpv->pv_dport_id < pv->pv_dport_id)
756 return (INFO_BETTER);
757 if (cpv->pv_dport_id > pv->pv_dport_id)
764 * This message priority vector is superior to the port priority vector and
765 * will replace it if, and only if, the message priority vector is better than
766 * the port priority vector, or the message has been transmitted from the same
767 * designated bridge and designated port as the port priority vector.
770 bstp_info_superior(struct bstp_pri_vector *pv,
771 struct bstp_pri_vector *cpv)
773 if (bstp_info_cmp(pv, cpv) == INFO_BETTER ||
774 (bstp_same_bridgeid(pv->pv_dbridge_id, cpv->pv_dbridge_id) &&
775 (cpv->pv_dport_id & 0xfff) == (pv->pv_dport_id & 0xfff)))
781 bstp_assign_roles(struct bstp_state *bs)
783 struct bstp_port *bp, *rbp = NULL;
784 struct bstp_pri_vector pv;
786 /* default to our priority vector */
787 bs->bs_root_pv = bs->bs_bridge_pv;
788 bs->bs_root_msg_age = 0;
789 bs->bs_root_max_age = bs->bs_bridge_max_age;
790 bs->bs_root_fdelay = bs->bs_bridge_fdelay;
791 bs->bs_root_htime = bs->bs_bridge_htime;
792 bs->bs_root_port = NULL;
794 /* check if any received info supersedes us */
795 LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
796 if (bp->bp_infois != BSTP_INFO_RECEIVED)
800 pv.pv_cost += bp->bp_path_cost;
803 * The root priority vector is the best of the set comprising
804 * the bridge priority vector plus all root path priority
805 * vectors whose bridge address is not equal to us.
807 if (bstp_same_bridgeid(pv.pv_dbridge_id,
808 bs->bs_bridge_pv.pv_dbridge_id) == 0 &&
809 bstp_info_cmp(&bs->bs_root_pv, &pv) == INFO_BETTER) {
810 /* the port vector replaces the root */
812 bs->bs_root_msg_age = bp->bp_port_msg_age +
813 BSTP_MESSAGE_AGE_INCR;
814 bs->bs_root_max_age = bp->bp_port_max_age;
815 bs->bs_root_fdelay = bp->bp_port_fdelay;
816 bs->bs_root_htime = bp->bp_port_htime;
821 LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
822 /* calculate the port designated vector */
823 bp->bp_desg_pv.pv_root_id = bs->bs_root_pv.pv_root_id;
824 bp->bp_desg_pv.pv_cost = bs->bs_root_pv.pv_cost;
825 bp->bp_desg_pv.pv_dbridge_id = bs->bs_bridge_pv.pv_dbridge_id;
826 bp->bp_desg_pv.pv_dport_id = bp->bp_port_id;
827 bp->bp_desg_pv.pv_port_id = bp->bp_port_id;
829 /* calculate designated times */
830 bp->bp_desg_msg_age = bs->bs_root_msg_age;
831 bp->bp_desg_max_age = bs->bs_root_max_age;
832 bp->bp_desg_fdelay = bs->bs_root_fdelay;
833 bp->bp_desg_htime = bs->bs_bridge_htime;
835 switch (bp->bp_infois) {
836 case BSTP_INFO_DISABLED:
837 bstp_set_port_role(bp, BSTP_ROLE_DISABLED);
841 bstp_set_port_role(bp, BSTP_ROLE_DESIGNATED);
842 bstp_update_info(bp);
846 bstp_set_port_role(bp, BSTP_ROLE_DESIGNATED);
847 /* update the port info if stale */
848 if (bstp_info_cmp(&bp->bp_port_pv,
849 &bp->bp_desg_pv) != INFO_SAME ||
851 (bp->bp_port_msg_age != rbp->bp_port_msg_age ||
852 bp->bp_port_max_age != rbp->bp_port_max_age ||
853 bp->bp_port_fdelay != rbp->bp_port_fdelay ||
854 bp->bp_port_htime != rbp->bp_port_htime)))
855 bstp_update_info(bp);
858 case BSTP_INFO_RECEIVED:
861 * root priority is derived from this
862 * port, make it the root port.
864 bstp_set_port_role(bp, BSTP_ROLE_ROOT);
865 bs->bs_root_port = bp;
866 } else if (bstp_info_cmp(&bp->bp_port_pv,
867 &bp->bp_desg_pv) == INFO_BETTER) {
869 * the port priority is lower than the root
872 bstp_set_port_role(bp, BSTP_ROLE_DESIGNATED);
873 bstp_update_info(bp);
875 if (bstp_same_bridgeid(
876 bp->bp_port_pv.pv_dbridge_id,
877 bs->bs_bridge_pv.pv_dbridge_id)) {
879 * the designated bridge refers to
880 * another port on this bridge.
882 bstp_set_port_role(bp,
886 * the port is an inferior path to the
889 bstp_set_port_role(bp,
890 BSTP_ROLE_ALTERNATE);
899 bstp_update_state(struct bstp_state *bs, struct bstp_port *bp)
901 struct bstp_port *bp2;
904 BSTP_LOCK_ASSERT(bs);
906 /* check if all the ports have syncronised again */
907 if (!bs->bs_allsynced) {
909 LIST_FOREACH(bp2, &bs->bs_bplist, bp_next) {
910 if (!(bp2->bp_synced ||
911 bp2->bp_role == BSTP_ROLE_ROOT)) {
916 bs->bs_allsynced = synced;
919 bstp_update_roles(bs, bp);
924 bstp_update_roles(struct bstp_state *bs, struct bstp_port *bp)
926 switch (bp->bp_role) {
927 case BSTP_ROLE_DISABLED:
928 /* Clear any flags if set */
929 if (bp->bp_sync || !bp->bp_synced || bp->bp_reroot) {
936 case BSTP_ROLE_ALTERNATE:
937 case BSTP_ROLE_BACKUP:
938 if ((bs->bs_allsynced && !bp->bp_agree) ||
939 (bp->bp_proposed && bp->bp_agree)) {
942 bp->bp_flags |= BSTP_PORT_NEWINFO;
943 DPRINTF("%s -> ALTERNATE_AGREED\n",
944 bp->bp_ifp->if_xname);
947 if (bp->bp_proposed && !bp->bp_agree) {
948 bstp_set_all_sync(bs);
950 DPRINTF("%s -> ALTERNATE_PROPOSED\n",
951 bp->bp_ifp->if_xname);
954 /* Clear any flags if set */
955 if (bp->bp_sync || !bp->bp_synced || bp->bp_reroot) {
959 DPRINTF("%s -> ALTERNATE_PORT\n", bp->bp_ifp->if_xname);
964 if (bp->bp_state != BSTP_IFSTATE_FORWARDING && !bp->bp_reroot) {
965 bstp_set_all_reroot(bs);
966 DPRINTF("%s -> ROOT_REROOT\n", bp->bp_ifp->if_xname);
969 if ((bs->bs_allsynced && !bp->bp_agree) ||
970 (bp->bp_proposed && bp->bp_agree)) {
974 bp->bp_flags |= BSTP_PORT_NEWINFO;
975 DPRINTF("%s -> ROOT_AGREED\n", bp->bp_ifp->if_xname);
978 if (bp->bp_proposed && !bp->bp_agree) {
979 bstp_set_all_sync(bs);
981 DPRINTF("%s -> ROOT_PROPOSED\n", bp->bp_ifp->if_xname);
984 if (bp->bp_state != BSTP_IFSTATE_FORWARDING &&
985 (bp->bp_forward_delay_timer.active == 0 ||
986 (bstp_rerooted(bs, bp) &&
987 bp->bp_recent_backup_timer.active == 0 &&
988 bp->bp_protover == BSTP_PROTO_RSTP))) {
989 switch (bp->bp_state) {
990 case BSTP_IFSTATE_DISCARDING:
991 bstp_set_port_state(bp, BSTP_IFSTATE_LEARNING);
993 case BSTP_IFSTATE_LEARNING:
994 bstp_set_port_state(bp,
995 BSTP_IFSTATE_FORWARDING);
1000 if (bp->bp_state == BSTP_IFSTATE_FORWARDING && bp->bp_reroot) {
1002 DPRINTF("%s -> ROOT_REROOTED\n", bp->bp_ifp->if_xname);
1006 case BSTP_ROLE_DESIGNATED:
1007 if (bp->bp_recent_root_timer.active == 0 && bp->bp_reroot) {
1009 DPRINTF("%s -> DESIGNATED_RETIRED\n",
1010 bp->bp_ifp->if_xname);
1013 if ((bp->bp_state == BSTP_IFSTATE_DISCARDING &&
1014 !bp->bp_synced) || (bp->bp_agreed && !bp->bp_synced) ||
1015 (bp->bp_operedge && !bp->bp_synced) ||
1016 (bp->bp_sync && bp->bp_synced)) {
1017 bstp_timer_stop(&bp->bp_recent_root_timer);
1020 DPRINTF("%s -> DESIGNATED_SYNCED\n",
1021 bp->bp_ifp->if_xname);
1024 if (bp->bp_state != BSTP_IFSTATE_FORWARDING &&
1025 !bp->bp_agreed && !bp->bp_proposing &&
1027 bp->bp_proposing = 1;
1028 bp->bp_flags |= BSTP_PORT_NEWINFO;
1029 bstp_timer_start(&bp->bp_edge_delay_timer,
1030 (bp->bp_ptp_link ? BSTP_DEFAULT_MIGRATE_DELAY :
1031 bp->bp_desg_max_age));
1032 DPRINTF("%s -> DESIGNATED_PROPOSE\n",
1033 bp->bp_ifp->if_xname);
1036 if (bp->bp_state != BSTP_IFSTATE_FORWARDING &&
1037 (bp->bp_forward_delay_timer.active == 0 || bp->bp_agreed ||
1039 (bp->bp_recent_root_timer.active == 0 || !bp->bp_reroot) &&
1042 DPRINTF("%s -> AGREED\n", bp->bp_ifp->if_xname);
1044 * If agreed|operedge then go straight to forwarding,
1045 * otherwise follow discard -> learn -> forward.
1047 if (bp->bp_agreed || bp->bp_operedge ||
1048 bp->bp_state == BSTP_IFSTATE_LEARNING) {
1049 bstp_set_port_state(bp,
1050 BSTP_IFSTATE_FORWARDING);
1051 bp->bp_agreed = bp->bp_protover;
1052 } else if (bp->bp_state == BSTP_IFSTATE_DISCARDING)
1053 bstp_set_port_state(bp, BSTP_IFSTATE_LEARNING);
1056 if (((bp->bp_sync && !bp->bp_synced) ||
1057 (bp->bp_reroot && bp->bp_recent_root_timer.active) ||
1058 (bp->bp_flags & BSTP_PORT_DISPUTED)) && !bp->bp_operedge &&
1059 bp->bp_state != BSTP_IFSTATE_DISCARDING) {
1060 bstp_set_port_state(bp, BSTP_IFSTATE_DISCARDING);
1061 bp->bp_flags &= ~BSTP_PORT_DISPUTED;
1062 bstp_timer_start(&bp->bp_forward_delay_timer,
1063 bp->bp_protover == BSTP_PROTO_RSTP ?
1064 bp->bp_desg_htime : bp->bp_desg_fdelay);
1065 DPRINTF("%s -> DESIGNATED_DISCARD\n",
1066 bp->bp_ifp->if_xname);
1071 if (bp->bp_flags & BSTP_PORT_NEWINFO)
1072 bstp_transmit(bs, bp);
1076 bstp_update_tc(struct bstp_port *bp)
1078 switch (bp->bp_tcstate) {
1079 case BSTP_TCSTATE_ACTIVE:
1080 if ((bp->bp_role != BSTP_ROLE_DESIGNATED &&
1081 bp->bp_role != BSTP_ROLE_ROOT) || bp->bp_operedge)
1082 bstp_set_port_tc(bp, BSTP_TCSTATE_LEARNING);
1085 bstp_set_port_tc(bp, BSTP_TCSTATE_TCN);
1087 bstp_set_port_tc(bp, BSTP_TCSTATE_TC);
1089 if (bp->bp_tc_prop && !bp->bp_operedge)
1090 bstp_set_port_tc(bp, BSTP_TCSTATE_PROPAG);
1093 bstp_set_port_tc(bp, BSTP_TCSTATE_ACK);
1096 case BSTP_TCSTATE_INACTIVE:
1097 if ((bp->bp_state == BSTP_IFSTATE_LEARNING ||
1098 bp->bp_state == BSTP_IFSTATE_FORWARDING) &&
1099 bp->bp_fdbflush == 0)
1100 bstp_set_port_tc(bp, BSTP_TCSTATE_LEARNING);
1103 case BSTP_TCSTATE_LEARNING:
1104 if (bp->bp_rcvdtc || bp->bp_rcvdtcn || bp->bp_rcvdtca ||
1106 bstp_set_port_tc(bp, BSTP_TCSTATE_LEARNING);
1107 else if (bp->bp_role != BSTP_ROLE_DESIGNATED &&
1108 bp->bp_role != BSTP_ROLE_ROOT &&
1109 bp->bp_state == BSTP_IFSTATE_DISCARDING)
1110 bstp_set_port_tc(bp, BSTP_TCSTATE_INACTIVE);
1112 if ((bp->bp_role == BSTP_ROLE_DESIGNATED ||
1113 bp->bp_role == BSTP_ROLE_ROOT) &&
1114 bp->bp_state == BSTP_IFSTATE_FORWARDING &&
1116 bstp_set_port_tc(bp, BSTP_TCSTATE_DETECTED);
1119 /* these are transient states and go straight back to ACTIVE */
1120 case BSTP_TCSTATE_DETECTED:
1121 case BSTP_TCSTATE_TCN:
1122 case BSTP_TCSTATE_TC:
1123 case BSTP_TCSTATE_PROPAG:
1124 case BSTP_TCSTATE_ACK:
1125 DPRINTF("Invalid TC state for %s\n",
1126 bp->bp_ifp->if_xname);
1133 bstp_update_info(struct bstp_port *bp)
1135 struct bstp_state *bs = bp->bp_bs;
1137 bp->bp_proposing = 0;
1138 bp->bp_proposed = 0;
1140 if (bp->bp_agreed && !bstp_pdu_bettersame(bp, BSTP_INFO_MINE))
1143 if (bp->bp_synced && !bp->bp_agreed) {
1145 bs->bs_allsynced = 0;
1148 /* copy the designated pv to the port */
1149 bp->bp_port_pv = bp->bp_desg_pv;
1150 bp->bp_port_msg_age = bp->bp_desg_msg_age;
1151 bp->bp_port_max_age = bp->bp_desg_max_age;
1152 bp->bp_port_fdelay = bp->bp_desg_fdelay;
1153 bp->bp_port_htime = bp->bp_desg_htime;
1154 bp->bp_infois = BSTP_INFO_MINE;
1156 /* Set transmit flag but do not immediately send */
1157 bp->bp_flags |= BSTP_PORT_NEWINFO;
1160 /* set tcprop on every port other than the caller */
1162 bstp_set_other_tcprop(struct bstp_port *bp)
1164 struct bstp_state *bs = bp->bp_bs;
1165 struct bstp_port *bp2;
1167 BSTP_LOCK_ASSERT(bs);
1169 LIST_FOREACH(bp2, &bs->bs_bplist, bp_next) {
1172 bp2->bp_tc_prop = 1;
1177 bstp_set_all_reroot(struct bstp_state *bs)
1179 struct bstp_port *bp;
1181 BSTP_LOCK_ASSERT(bs);
1183 LIST_FOREACH(bp, &bs->bs_bplist, bp_next)
1188 bstp_set_all_sync(struct bstp_state *bs)
1190 struct bstp_port *bp;
1192 BSTP_LOCK_ASSERT(bs);
1194 LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
1196 bp->bp_synced = 0; /* Not explicit in spec */
1199 bs->bs_allsynced = 0;
1203 bstp_set_port_state(struct bstp_port *bp, int state)
1205 if (bp->bp_state == state)
1208 bp->bp_state = state;
1210 switch (bp->bp_state) {
1211 case BSTP_IFSTATE_DISCARDING:
1212 DPRINTF("state changed to DISCARDING on %s\n",
1213 bp->bp_ifp->if_xname);
1216 case BSTP_IFSTATE_LEARNING:
1217 DPRINTF("state changed to LEARNING on %s\n",
1218 bp->bp_ifp->if_xname);
1220 bstp_timer_start(&bp->bp_forward_delay_timer,
1221 bp->bp_protover == BSTP_PROTO_RSTP ?
1222 bp->bp_desg_htime : bp->bp_desg_fdelay);
1225 case BSTP_IFSTATE_FORWARDING:
1226 DPRINTF("state changed to FORWARDING on %s\n",
1227 bp->bp_ifp->if_xname);
1229 bstp_timer_stop(&bp->bp_forward_delay_timer);
1230 /* Record that we enabled forwarding */
1231 bp->bp_forward_transitions++;
1235 /* notify the parent bridge */
1236 taskqueue_enqueue(taskqueue_swi, &bp->bp_statetask);
1240 bstp_set_port_role(struct bstp_port *bp, int role)
1242 struct bstp_state *bs = bp->bp_bs;
1244 if (bp->bp_role == role)
1247 /* perform pre-change tasks */
1248 switch (bp->bp_role) {
1249 case BSTP_ROLE_DISABLED:
1250 bstp_timer_start(&bp->bp_forward_delay_timer,
1251 bp->bp_desg_max_age);
1254 case BSTP_ROLE_BACKUP:
1255 bstp_timer_start(&bp->bp_recent_backup_timer,
1256 bp->bp_desg_htime * 2);
1258 case BSTP_ROLE_ALTERNATE:
1259 bstp_timer_start(&bp->bp_forward_delay_timer,
1260 bp->bp_desg_fdelay);
1266 case BSTP_ROLE_ROOT:
1267 bstp_timer_start(&bp->bp_recent_root_timer,
1268 BSTP_DEFAULT_FORWARD_DELAY);
1273 /* clear values not carried between roles */
1274 bp->bp_proposing = 0;
1275 bs->bs_allsynced = 0;
1277 /* initialise the new role */
1278 switch (bp->bp_role) {
1279 case BSTP_ROLE_DISABLED:
1280 case BSTP_ROLE_ALTERNATE:
1281 case BSTP_ROLE_BACKUP:
1282 DPRINTF("%s role -> ALT/BACK/DISABLED\n",
1283 bp->bp_ifp->if_xname);
1284 bstp_set_port_state(bp, BSTP_IFSTATE_DISCARDING);
1285 bstp_timer_stop(&bp->bp_recent_root_timer);
1286 bstp_timer_latch(&bp->bp_forward_delay_timer);
1292 case BSTP_ROLE_ROOT:
1293 DPRINTF("%s role -> ROOT\n",
1294 bp->bp_ifp->if_xname);
1295 bstp_set_port_state(bp, BSTP_IFSTATE_DISCARDING);
1296 bstp_timer_latch(&bp->bp_recent_root_timer);
1297 bp->bp_proposing = 0;
1300 case BSTP_ROLE_DESIGNATED:
1301 DPRINTF("%s role -> DESIGNATED\n",
1302 bp->bp_ifp->if_xname);
1303 bstp_timer_start(&bp->bp_hello_timer,
1309 /* let the TC state know that the role changed */
1314 bstp_set_port_proto(struct bstp_port *bp, int proto)
1316 struct bstp_state *bs = bp->bp_bs;
1318 /* supported protocol versions */
1320 case BSTP_PROTO_STP:
1321 /* we can downgrade protocols only */
1322 bstp_timer_stop(&bp->bp_migrate_delay_timer);
1323 /* clear unsupported features */
1324 bp->bp_operedge = 0;
1325 /* STP compat mode only uses 16 bits of the 32 */
1326 if (bp->bp_path_cost > 65535)
1327 bp->bp_path_cost = 65535;
1330 case BSTP_PROTO_RSTP:
1331 bstp_timer_start(&bp->bp_migrate_delay_timer,
1332 bs->bs_migration_delay);
1336 DPRINTF("Unsupported STP version %d\n", proto);
1340 bp->bp_protover = proto;
1341 bp->bp_flags &= ~BSTP_PORT_CANMIGRATE;
1345 bstp_set_port_tc(struct bstp_port *bp, int state)
1347 struct bstp_state *bs = bp->bp_bs;
1349 bp->bp_tcstate = state;
1351 /* initialise the new state */
1352 switch (bp->bp_tcstate) {
1353 case BSTP_TCSTATE_ACTIVE:
1354 DPRINTF("%s -> TC_ACTIVE\n", bp->bp_ifp->if_xname);
1358 case BSTP_TCSTATE_INACTIVE:
1359 bstp_timer_stop(&bp->bp_tc_timer);
1360 /* flush routes on the parent bridge */
1361 bp->bp_fdbflush = 1;
1362 taskqueue_enqueue(taskqueue_swi, &bp->bp_rtagetask);
1364 DPRINTF("%s -> TC_INACTIVE\n", bp->bp_ifp->if_xname);
1367 case BSTP_TCSTATE_LEARNING:
1372 DPRINTF("%s -> TC_LEARNING\n", bp->bp_ifp->if_xname);
1375 case BSTP_TCSTATE_DETECTED:
1376 bstp_set_timer_tc(bp);
1377 bstp_set_other_tcprop(bp);
1378 /* send out notification */
1379 bp->bp_flags |= BSTP_PORT_NEWINFO;
1380 bstp_transmit(bs, bp);
1381 getmicrotime(&bs->bs_last_tc_time);
1382 DPRINTF("%s -> TC_DETECTED\n", bp->bp_ifp->if_xname);
1383 bp->bp_tcstate = BSTP_TCSTATE_ACTIVE; /* UCT */
1386 case BSTP_TCSTATE_TCN:
1387 bstp_set_timer_tc(bp);
1388 DPRINTF("%s -> TC_TCN\n", bp->bp_ifp->if_xname);
1390 case BSTP_TCSTATE_TC:
1393 if (bp->bp_role == BSTP_ROLE_DESIGNATED)
1396 bstp_set_other_tcprop(bp);
1397 DPRINTF("%s -> TC_TC\n", bp->bp_ifp->if_xname);
1398 bp->bp_tcstate = BSTP_TCSTATE_ACTIVE; /* UCT */
1401 case BSTP_TCSTATE_PROPAG:
1402 /* flush routes on the parent bridge */
1403 bp->bp_fdbflush = 1;
1404 taskqueue_enqueue(taskqueue_swi, &bp->bp_rtagetask);
1406 bstp_set_timer_tc(bp);
1407 DPRINTF("%s -> TC_PROPAG\n", bp->bp_ifp->if_xname);
1408 bp->bp_tcstate = BSTP_TCSTATE_ACTIVE; /* UCT */
1411 case BSTP_TCSTATE_ACK:
1412 bstp_timer_stop(&bp->bp_tc_timer);
1414 DPRINTF("%s -> TC_ACK\n", bp->bp_ifp->if_xname);
1415 bp->bp_tcstate = BSTP_TCSTATE_ACTIVE; /* UCT */
1421 bstp_set_timer_tc(struct bstp_port *bp)
1423 struct bstp_state *bs = bp->bp_bs;
1425 if (bp->bp_tc_timer.active)
1428 switch (bp->bp_protover) {
1429 case BSTP_PROTO_RSTP:
1430 bstp_timer_start(&bp->bp_tc_timer,
1431 bp->bp_desg_htime + BSTP_TICK_VAL);
1432 bp->bp_flags |= BSTP_PORT_NEWINFO;
1435 case BSTP_PROTO_STP:
1436 bstp_timer_start(&bp->bp_tc_timer,
1437 bs->bs_root_max_age + bs->bs_root_fdelay);
1443 bstp_set_timer_msgage(struct bstp_port *bp)
1445 if (bp->bp_port_msg_age + BSTP_MESSAGE_AGE_INCR <=
1446 bp->bp_port_max_age) {
1447 bstp_timer_start(&bp->bp_message_age_timer,
1448 bp->bp_port_htime * 3);
1450 /* expires immediately */
1451 bstp_timer_start(&bp->bp_message_age_timer, 0);
1455 bstp_rerooted(struct bstp_state *bs, struct bstp_port *bp)
1457 struct bstp_port *bp2;
1460 LIST_FOREACH(bp2, &bs->bs_bplist, bp_next) {
1463 if (bp2->bp_recent_root_timer.active) {
1472 bstp_set_htime(struct bstp_state *bs, int t)
1474 /* convert seconds to ticks */
1477 /* value can only be changed in leagacy stp mode */
1478 if (bs->bs_protover != BSTP_PROTO_STP)
1481 if (t < BSTP_MIN_HELLO_TIME || t > BSTP_MAX_HELLO_TIME)
1485 bs->bs_bridge_htime = t;
1492 bstp_set_fdelay(struct bstp_state *bs, int t)
1494 /* convert seconds to ticks */
1497 if (t < BSTP_MIN_FORWARD_DELAY || t > BSTP_MAX_FORWARD_DELAY)
1501 bs->bs_bridge_fdelay = t;
1508 bstp_set_maxage(struct bstp_state *bs, int t)
1510 /* convert seconds to ticks */
1513 if (t < BSTP_MIN_MAX_AGE || t > BSTP_MAX_MAX_AGE)
1517 bs->bs_bridge_max_age = t;
1524 bstp_set_holdcount(struct bstp_state *bs, int count)
1526 struct bstp_port *bp;
1528 if (count < BSTP_MIN_HOLD_COUNT ||
1529 count > BSTP_MAX_HOLD_COUNT)
1533 bs->bs_txholdcount = count;
1534 LIST_FOREACH(bp, &bs->bs_bplist, bp_next)
1541 bstp_set_protocol(struct bstp_state *bs, int proto)
1543 struct bstp_port *bp;
1546 /* Supported protocol versions */
1547 case BSTP_PROTO_STP:
1548 case BSTP_PROTO_RSTP:
1556 bs->bs_protover = proto;
1557 bs->bs_bridge_htime = BSTP_DEFAULT_HELLO_TIME;
1558 LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
1560 bp->bp_infois = BSTP_INFO_DISABLED;
1562 bstp_set_port_proto(bp, bs->bs_protover);
1563 bstp_set_port_role(bp, BSTP_ROLE_DISABLED);
1564 bstp_set_port_tc(bp, BSTP_TCSTATE_INACTIVE);
1565 bstp_timer_stop(&bp->bp_recent_backup_timer);
1573 bstp_set_priority(struct bstp_state *bs, int pri)
1575 if (pri < 0 || pri > BSTP_MAX_PRIORITY)
1578 /* Limit to steps of 4096 */
1582 bs->bs_bridge_priority = pri;
1589 bstp_set_port_priority(struct bstp_port *bp, int pri)
1591 struct bstp_state *bs = bp->bp_bs;
1593 if (pri < 0 || pri > BSTP_MAX_PORT_PRIORITY)
1596 /* Limit to steps of 16 */
1600 bp->bp_priority = pri;
1607 bstp_set_path_cost(struct bstp_port *bp, uint32_t path_cost)
1609 struct bstp_state *bs = bp->bp_bs;
1611 if (path_cost > BSTP_MAX_PATH_COST)
1614 /* STP compat mode only uses 16 bits of the 32 */
1615 if (bp->bp_protover == BSTP_PROTO_STP && path_cost > 65535)
1620 if (path_cost == 0) { /* use auto */
1621 bp->bp_flags &= ~BSTP_PORT_ADMCOST;
1622 bp->bp_path_cost = bstp_calc_path_cost(bp);
1624 bp->bp_path_cost = path_cost;
1625 bp->bp_flags |= BSTP_PORT_ADMCOST;
1633 bstp_set_edge(struct bstp_port *bp, int set)
1635 struct bstp_state *bs = bp->bp_bs;
1638 if ((bp->bp_operedge = set) == 0)
1639 bp->bp_flags &= ~BSTP_PORT_ADMEDGE;
1641 bp->bp_flags |= BSTP_PORT_ADMEDGE;
1647 bstp_set_autoedge(struct bstp_port *bp, int set)
1649 struct bstp_state *bs = bp->bp_bs;
1653 bp->bp_flags |= BSTP_PORT_AUTOEDGE;
1654 /* we may be able to transition straight to edge */
1655 if (bp->bp_edge_delay_timer.active == 0)
1656 bstp_edge_delay_expiry(bs, bp);
1658 bp->bp_flags &= ~BSTP_PORT_AUTOEDGE;
1664 bstp_set_ptp(struct bstp_port *bp, int set)
1666 struct bstp_state *bs = bp->bp_bs;
1669 bp->bp_ptp_link = set;
1675 bstp_set_autoptp(struct bstp_port *bp, int set)
1677 struct bstp_state *bs = bp->bp_bs;
1681 bp->bp_flags |= BSTP_PORT_AUTOPTP;
1682 if (bp->bp_role != BSTP_ROLE_DISABLED)
1683 taskqueue_enqueue(taskqueue_swi, &bp->bp_mediatask);
1685 bp->bp_flags &= ~BSTP_PORT_AUTOPTP;
1691 * Calculate the path cost according to the link speed.
1694 bstp_calc_path_cost(struct bstp_port *bp)
1696 struct ifnet *ifp = bp->bp_ifp;
1699 /* If the priority has been manually set then retain the value */
1700 if (bp->bp_flags & BSTP_PORT_ADMCOST)
1701 return bp->bp_path_cost;
1703 if (ifp->if_link_state == LINK_STATE_DOWN) {
1704 /* Recalc when the link comes up again */
1705 bp->bp_flags |= BSTP_PORT_PNDCOST;
1706 return (BSTP_DEFAULT_PATH_COST);
1709 if (ifp->if_baudrate < 1000)
1710 return (BSTP_DEFAULT_PATH_COST);
1712 /* formula from section 17.14, IEEE Std 802.1D-2004 */
1713 path_cost = 20000000000ULL / (ifp->if_baudrate / 1000);
1715 if (path_cost > BSTP_MAX_PATH_COST)
1716 path_cost = BSTP_MAX_PATH_COST;
1718 /* STP compat mode only uses 16 bits of the 32 */
1719 if (bp->bp_protover == BSTP_PROTO_STP && path_cost > 65535)
1726 * Notify the bridge that a port state has changed, we need to do this from a
1727 * taskqueue to avoid a LOR.
1730 bstp_notify_state(void *arg, int pending)
1732 struct bstp_port *bp = (struct bstp_port *)arg;
1733 struct bstp_state *bs = bp->bp_bs;
1735 if (bp->bp_active == 1 && bs->bs_state_cb != NULL)
1736 (*bs->bs_state_cb)(bp->bp_ifp, bp->bp_state);
1740 * Flush the routes on the bridge port, we need to do this from a
1741 * taskqueue to avoid a LOR.
1744 bstp_notify_rtage(void *arg, int pending)
1746 struct bstp_port *bp = (struct bstp_port *)arg;
1747 struct bstp_state *bs = bp->bp_bs;
1751 switch (bp->bp_protover) {
1752 case BSTP_PROTO_STP:
1753 /* convert to seconds */
1754 age = bp->bp_desg_fdelay / BSTP_TICK_VAL;
1757 case BSTP_PROTO_RSTP:
1763 if (bp->bp_active == 1 && bs->bs_rtage_cb != NULL)
1764 (*bs->bs_rtage_cb)(bp->bp_ifp, age);
1766 /* flush is complete */
1768 bp->bp_fdbflush = 0;
1773 bstp_linkstate(struct bstp_port *bp)
1775 struct bstp_state *bs = bp->bp_bs;
1780 bstp_ifupdstatus(bp, 0);
1782 bstp_update_state(bs, bp);
1787 bstp_ifupdstatus(void *arg, int pending)
1789 struct bstp_port *bp = (struct bstp_port *)arg;
1790 struct bstp_state *bs = bp->bp_bs;
1791 struct ifnet *ifp = bp->bp_ifp;
1792 struct ifmediareq ifmr;
1798 bzero((char *)&ifmr, sizeof(ifmr));
1799 error = (*ifp->if_ioctl)(ifp, SIOCGIFMEDIA, (caddr_t)&ifmr);
1803 if ((error == 0) && (ifp->if_flags & IFF_UP)) {
1804 if (ifmr.ifm_status & IFM_ACTIVE) {
1805 /* A full-duplex link is assumed to be point to point */
1806 if (bp->bp_flags & BSTP_PORT_AUTOPTP) {
1809 fdx = ifmr.ifm_active & IFM_FDX ? 1 : 0;
1810 if (bp->bp_ptp_link ^ fdx) {
1811 bp->bp_ptp_link = fdx;
1816 /* Calc the cost if the link was down previously */
1817 if (bp->bp_flags & BSTP_PORT_PNDCOST) {
1820 cost = bstp_calc_path_cost(bp);
1821 if (bp->bp_path_cost != cost) {
1822 bp->bp_path_cost = cost;
1825 bp->bp_flags &= ~BSTP_PORT_PNDCOST;
1828 if (bp->bp_role == BSTP_ROLE_DISABLED) {
1829 bstp_enable_port(bs, bp);
1833 if (bp->bp_role != BSTP_ROLE_DISABLED) {
1834 bstp_disable_port(bs, bp);
1836 if ((bp->bp_flags & BSTP_PORT_ADMEDGE) &&
1837 bp->bp_protover == BSTP_PROTO_RSTP)
1838 bp->bp_operedge = 1;
1841 } else if (bp->bp_infois != BSTP_INFO_DISABLED) {
1842 bstp_disable_port(bs, bp);
1846 bstp_assign_roles(bs);
1851 bstp_enable_port(struct bstp_state *bs, struct bstp_port *bp)
1853 bp->bp_infois = BSTP_INFO_AGED;
1857 bstp_disable_port(struct bstp_state *bs, struct bstp_port *bp)
1859 bp->bp_infois = BSTP_INFO_DISABLED;
1863 bstp_tick(void *arg)
1865 struct bstp_state *bs = arg;
1866 struct bstp_port *bp;
1868 BSTP_LOCK_ASSERT(bs);
1870 if (bs->bs_running == 0)
1873 CURVNET_SET(bs->bs_vnet);
1875 /* poll link events on interfaces that do not support linkstate */
1876 if (bstp_timer_dectest(&bs->bs_link_timer)) {
1877 LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
1878 if (!(bp->bp_ifp->if_capabilities & IFCAP_LINKSTATE))
1879 taskqueue_enqueue(taskqueue_swi, &bp->bp_mediatask);
1881 bstp_timer_start(&bs->bs_link_timer, BSTP_LINK_TIMER);
1884 LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
1885 /* no events need to happen for these */
1886 bstp_timer_dectest(&bp->bp_tc_timer);
1887 bstp_timer_dectest(&bp->bp_recent_root_timer);
1888 bstp_timer_dectest(&bp->bp_forward_delay_timer);
1889 bstp_timer_dectest(&bp->bp_recent_backup_timer);
1891 if (bstp_timer_dectest(&bp->bp_hello_timer))
1892 bstp_hello_timer_expiry(bs, bp);
1894 if (bstp_timer_dectest(&bp->bp_message_age_timer))
1895 bstp_message_age_expiry(bs, bp);
1897 if (bstp_timer_dectest(&bp->bp_migrate_delay_timer))
1898 bstp_migrate_delay_expiry(bs, bp);
1900 if (bstp_timer_dectest(&bp->bp_edge_delay_timer))
1901 bstp_edge_delay_expiry(bs, bp);
1903 /* update the various state machines for the port */
1904 bstp_update_state(bs, bp);
1906 if (bp->bp_txcount > 0)
1912 callout_reset(&bs->bs_bstpcallout, hz, bstp_tick, bs);
1916 bstp_timer_start(struct bstp_timer *t, uint16_t v)
1924 bstp_timer_stop(struct bstp_timer *t)
1932 bstp_timer_latch(struct bstp_timer *t)
1939 bstp_timer_dectest(struct bstp_timer *t)
1941 if (t->active == 0 || t->latched)
1943 t->value -= BSTP_TICK_VAL;
1944 if (t->value <= 0) {
1952 bstp_hello_timer_expiry(struct bstp_state *bs, struct bstp_port *bp)
1954 if ((bp->bp_flags & BSTP_PORT_NEWINFO) ||
1955 bp->bp_role == BSTP_ROLE_DESIGNATED ||
1956 (bp->bp_role == BSTP_ROLE_ROOT &&
1957 bp->bp_tc_timer.active == 1)) {
1958 bstp_timer_start(&bp->bp_hello_timer, bp->bp_desg_htime);
1959 bp->bp_flags |= BSTP_PORT_NEWINFO;
1960 bstp_transmit(bs, bp);
1965 bstp_message_age_expiry(struct bstp_state *bs, struct bstp_port *bp)
1967 if (bp->bp_infois == BSTP_INFO_RECEIVED) {
1968 bp->bp_infois = BSTP_INFO_AGED;
1969 bstp_assign_roles(bs);
1970 DPRINTF("aged info on %s\n", bp->bp_ifp->if_xname);
1975 bstp_migrate_delay_expiry(struct bstp_state *bs, struct bstp_port *bp)
1977 bp->bp_flags |= BSTP_PORT_CANMIGRATE;
1981 bstp_edge_delay_expiry(struct bstp_state *bs, struct bstp_port *bp)
1983 if ((bp->bp_flags & BSTP_PORT_AUTOEDGE) &&
1984 bp->bp_protover == BSTP_PROTO_RSTP && bp->bp_proposing &&
1985 bp->bp_role == BSTP_ROLE_DESIGNATED) {
1986 bp->bp_operedge = 1;
1987 DPRINTF("%s -> edge port\n", bp->bp_ifp->if_xname);
1992 bstp_addr_cmp(const uint8_t *a, const uint8_t *b)
1996 for (i = 0, d = 0; i < ETHER_ADDR_LEN && d == 0; i++) {
1997 d = ((int)a[i]) - ((int)b[i]);
2004 * compare the bridge address component of the bridgeid
2007 bstp_same_bridgeid(uint64_t id1, uint64_t id2)
2009 u_char addr1[ETHER_ADDR_LEN];
2010 u_char addr2[ETHER_ADDR_LEN];
2012 PV2ADDR(id1, addr1);
2013 PV2ADDR(id2, addr2);
2015 if (bstp_addr_cmp(addr1, addr2) == 0)
2022 bstp_reinit(struct bstp_state *bs)
2024 struct epoch_tracker et;
2025 struct bstp_port *bp;
2026 struct ifnet *ifp, *mif;
2029 static const u_char llzero[ETHER_ADDR_LEN]; /* 00:00:00:00:00:00 */
2031 BSTP_LOCK_ASSERT(bs);
2033 if (LIST_EMPTY(&bs->bs_bplist))
2037 bridgeptr = LIST_FIRST(&bs->bs_bplist)->bp_ifp->if_bridge;
2038 KASSERT(bridgeptr != NULL, ("Invalid bridge pointer"));
2040 * Search through the Ethernet adapters and find the one with the
2041 * lowest value. Make sure the adapter which we take the MAC address
2042 * from is part of this bridge, so we can have more than one independent
2043 * bridges in the same STP domain.
2045 NET_EPOCH_ENTER(et);
2046 CK_STAILQ_FOREACH(ifp, &V_ifnet, if_link) {
2047 if (ifp->if_type != IFT_ETHER)
2048 continue; /* Not Ethernet */
2050 if (ifp->if_bridge != bridgeptr)
2051 continue; /* Not part of our bridge */
2053 if (bstp_addr_cmp(IF_LLADDR(ifp), llzero) == 0)
2054 continue; /* No mac address set */
2060 if (bstp_addr_cmp(IF_LLADDR(ifp), IF_LLADDR(mif)) < 0) {
2069 e_addr = IF_LLADDR(mif);
2070 bs->bs_bridge_pv.pv_dbridge_id =
2071 (((uint64_t)bs->bs_bridge_priority) << 48) |
2072 (((uint64_t)e_addr[0]) << 40) |
2073 (((uint64_t)e_addr[1]) << 32) |
2074 (((uint64_t)e_addr[2]) << 24) |
2075 (((uint64_t)e_addr[3]) << 16) |
2076 (((uint64_t)e_addr[4]) << 8) |
2077 (((uint64_t)e_addr[5]));
2079 bs->bs_bridge_pv.pv_root_id = bs->bs_bridge_pv.pv_dbridge_id;
2080 bs->bs_bridge_pv.pv_cost = 0;
2081 bs->bs_bridge_pv.pv_dport_id = 0;
2082 bs->bs_bridge_pv.pv_port_id = 0;
2084 if (bs->bs_running && callout_pending(&bs->bs_bstpcallout) == 0)
2085 callout_reset(&bs->bs_bstpcallout, hz, bstp_tick, bs);
2087 LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
2088 bp->bp_port_id = (bp->bp_priority << 8) |
2089 (bp->bp_ifp->if_index & 0xfff);
2090 taskqueue_enqueue(taskqueue_swi, &bp->bp_mediatask);
2093 bstp_assign_roles(bs);
2094 bstp_timer_start(&bs->bs_link_timer, BSTP_LINK_TIMER);
2098 /* Set the bridge and root id (lower bits) to zero */
2099 bs->bs_bridge_pv.pv_dbridge_id =
2100 ((uint64_t)bs->bs_bridge_priority) << 48;
2101 bs->bs_bridge_pv.pv_root_id = bs->bs_bridge_pv.pv_dbridge_id;
2102 bs->bs_root_pv = bs->bs_bridge_pv;
2103 /* Disable any remaining ports, they will have no MAC address */
2104 LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
2105 bp->bp_infois = BSTP_INFO_DISABLED;
2106 bstp_set_port_role(bp, BSTP_ROLE_DISABLED);
2108 callout_stop(&bs->bs_bstpcallout);
2112 bstp_modevent(module_t mod, int type, void *data)
2116 mtx_init(&bstp_list_mtx, "bridgestp list", NULL, MTX_DEF);
2117 LIST_INIT(&bstp_list);
2120 mtx_destroy(&bstp_list_mtx);
2123 return (EOPNOTSUPP);
2128 static moduledata_t bstp_mod = {
2134 DECLARE_MODULE(bridgestp, bstp_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
2135 MODULE_VERSION(bridgestp, 1);
2138 bstp_attach(struct bstp_state *bs, struct bstp_cb_ops *cb)
2141 callout_init_mtx(&bs->bs_bstpcallout, &bs->bs_mtx, 0);
2142 LIST_INIT(&bs->bs_bplist);
2144 bs->bs_bridge_max_age = BSTP_DEFAULT_MAX_AGE;
2145 bs->bs_bridge_htime = BSTP_DEFAULT_HELLO_TIME;
2146 bs->bs_bridge_fdelay = BSTP_DEFAULT_FORWARD_DELAY;
2147 bs->bs_bridge_priority = BSTP_DEFAULT_BRIDGE_PRIORITY;
2148 bs->bs_hold_time = BSTP_DEFAULT_HOLD_TIME;
2149 bs->bs_migration_delay = BSTP_DEFAULT_MIGRATE_DELAY;
2150 bs->bs_txholdcount = BSTP_DEFAULT_HOLD_COUNT;
2151 bs->bs_protover = BSTP_PROTO_RSTP;
2152 bs->bs_state_cb = cb->bcb_state;
2153 bs->bs_rtage_cb = cb->bcb_rtage;
2154 bs->bs_vnet = curvnet;
2156 getmicrotime(&bs->bs_last_tc_time);
2158 mtx_lock(&bstp_list_mtx);
2159 LIST_INSERT_HEAD(&bstp_list, bs, bs_list);
2160 mtx_unlock(&bstp_list_mtx);
2164 bstp_detach(struct bstp_state *bs)
2166 KASSERT(LIST_EMPTY(&bs->bs_bplist), ("bstp still active"));
2168 mtx_lock(&bstp_list_mtx);
2169 LIST_REMOVE(bs, bs_list);
2170 mtx_unlock(&bstp_list_mtx);
2171 callout_drain(&bs->bs_bstpcallout);
2172 BSTP_LOCK_DESTROY(bs);
2176 bstp_init(struct bstp_state *bs)
2179 callout_reset(&bs->bs_bstpcallout, hz, bstp_tick, bs);
2186 bstp_stop(struct bstp_state *bs)
2188 struct bstp_port *bp;
2192 LIST_FOREACH(bp, &bs->bs_bplist, bp_next)
2193 bstp_set_port_state(bp, BSTP_IFSTATE_DISCARDING);
2196 callout_stop(&bs->bs_bstpcallout);
2201 bstp_create(struct bstp_state *bs, struct bstp_port *bp, struct ifnet *ifp)
2203 bzero(bp, sizeof(struct bstp_port));
2208 bp->bp_priority = BSTP_DEFAULT_PORT_PRIORITY;
2209 TASK_INIT(&bp->bp_statetask, 0, bstp_notify_state, bp);
2210 TASK_INIT(&bp->bp_rtagetask, 0, bstp_notify_rtage, bp);
2211 TASK_INIT(&bp->bp_mediatask, 0, bstp_ifupdstatus, bp);
2214 bp->bp_infois = BSTP_INFO_DISABLED;
2215 bp->bp_flags = BSTP_PORT_AUTOEDGE|BSTP_PORT_AUTOPTP;
2216 bstp_set_port_state(bp, BSTP_IFSTATE_DISCARDING);
2217 bstp_set_port_proto(bp, bs->bs_protover);
2218 bstp_set_port_role(bp, BSTP_ROLE_DISABLED);
2219 bstp_set_port_tc(bp, BSTP_TCSTATE_INACTIVE);
2220 bp->bp_path_cost = bstp_calc_path_cost(bp);
2226 bstp_enable(struct bstp_port *bp)
2228 struct bstp_state *bs = bp->bp_bs;
2229 struct ifnet *ifp = bp->bp_ifp;
2231 KASSERT(bp->bp_active == 0, ("already a bstp member"));
2233 switch (ifp->if_type) {
2234 case IFT_ETHER: /* These can do spanning tree. */
2237 /* Nothing else can. */
2242 LIST_INSERT_HEAD(&bs->bs_bplist, bp, bp_next);
2244 bp->bp_flags |= BSTP_PORT_NEWINFO;
2246 bstp_update_roles(bs, bp);
2252 bstp_disable(struct bstp_port *bp)
2254 struct bstp_state *bs = bp->bp_bs;
2256 KASSERT(bp->bp_active == 1, ("not a bstp member"));
2259 bstp_disable_port(bs, bp);
2260 LIST_REMOVE(bp, bp_next);
2267 * The bstp_port structure is about to be freed by the parent bridge.
2270 bstp_destroy(struct bstp_port *bp)
2272 KASSERT(bp->bp_active == 0, ("port is still attached"));
2273 taskqueue_drain(taskqueue_swi, &bp->bp_statetask);
2274 taskqueue_drain(taskqueue_swi, &bp->bp_rtagetask);
2275 taskqueue_drain(taskqueue_swi, &bp->bp_mediatask);
2277 if (bp->bp_bs->bs_root_port == bp)
2278 bstp_assign_roles(bp->bp_bs);