1 /* $NetBSD: bridgestp.c,v 1.5 2003/11/28 08:56:48 keihan Exp $ */
4 * Copyright (c) 2000 Jason L. Wright (jason@thought.net)
5 * Copyright (c) 2006 Andrew Thompson (thompsa@FreeBSD.org)
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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.
29 * OpenBSD: bridgestp.c,v 1.5 2001/03/22 03:48:29 jason Exp
33 * Implementation of the spanning tree protocol as defined in
34 * ISO/IEC 802.1D-2004, June 9, 2004.
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
40 #include <sys/param.h>
41 #include <sys/systm.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>
50 #include <sys/mutex.h>
51 #include <sys/taskqueue.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>
60 #include <netinet/in.h>
61 #include <netinet/in_systm.h>
62 #include <netinet/in_var.h>
63 #include <netinet/if_ether.h>
64 #include <net/bridgestp.h>
66 #ifdef BRIDGESTP_DEBUG
67 #define DPRINTF(fmt, arg...) printf("bstp: " fmt, ##arg)
69 #define DPRINTF(fmt, arg...) (void)0
72 #define PV2ADDR(pv, eaddr) do { \
73 eaddr[0] = pv >> 40; \
74 eaddr[1] = pv >> 32; \
75 eaddr[2] = pv >> 24; \
76 eaddr[3] = pv >> 16; \
85 const uint8_t bstp_etheraddr[] = { 0x01, 0x80, 0xc2, 0x00, 0x00, 0x00 };
87 LIST_HEAD(, bstp_state) bstp_list;
88 static struct mtx bstp_list_mtx;
90 static void bstp_transmit(struct bstp_state *, struct bstp_port *);
91 static void bstp_transmit_bpdu(struct bstp_state *, struct bstp_port *);
92 static void bstp_transmit_tcn(struct bstp_state *, struct bstp_port *);
93 static void bstp_decode_bpdu(struct bstp_port *, struct bstp_cbpdu *,
94 struct bstp_config_unit *);
95 static void bstp_send_bpdu(struct bstp_state *, struct bstp_port *,
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(void *, int);
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_dectest(struct bstp_timer *);
138 static void bstp_hello_timer_expiry(struct bstp_state *,
140 static void bstp_message_age_expiry(struct bstp_state *,
142 static void bstp_migrate_delay_expiry(struct bstp_state *,
144 static void bstp_edge_delay_expiry(struct bstp_state *,
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 *);
151 bstp_transmit(struct bstp_state *bs, struct bstp_port *bp)
153 if (bs->bs_running == 0)
157 * a PDU can only be sent if we have tx quota left and the
158 * hello timer is running.
160 if (bp->bp_hello_timer.active == 0) {
161 /* Test if it needs to be reset */
162 bstp_hello_timer_expiry(bs, bp);
165 if (bp->bp_txcount > bs->bs_txholdcount)
166 /* Ran out of karma */
169 if (bp->bp_protover == BSTP_PROTO_RSTP) {
170 bstp_transmit_bpdu(bs, bp);
173 switch (bp->bp_role) {
174 case BSTP_ROLE_DESIGNATED:
175 bstp_transmit_bpdu(bs, bp);
180 bstp_transmit_tcn(bs, bp);
184 bstp_timer_start(&bp->bp_hello_timer, bp->bp_desg_htime);
185 bp->bp_flags &= ~BSTP_PORT_NEWINFO;
189 bstp_transmit_bpdu(struct bstp_state *bs, struct bstp_port *bp)
191 struct bstp_cbpdu bpdu;
193 BSTP_LOCK_ASSERT(bs);
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);
198 bpdu.cbu_rootpathcost = htonl(bp->bp_desg_pv.pv_cost);
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);
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);
209 bpdu.cbu_flags = bstp_pdu_flags(bp);
211 switch (bp->bp_protover) {
213 bpdu.cbu_bpdutype = BSTP_MSGTYPE_CFG;
216 case BSTP_PROTO_RSTP:
217 bpdu.cbu_bpdutype = BSTP_MSGTYPE_RSTP;
221 bstp_send_bpdu(bs, bp, &bpdu);
225 bstp_transmit_tcn(struct bstp_state *bs, struct bstp_port *bp)
227 struct bstp_tbpdu bpdu;
228 struct ifnet *ifp = bp->bp_ifp;
229 struct ether_header *eh;
232 KASSERT(bp == bs->bs_root_port, ("%s: bad root port\n", __func__));
234 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
237 MGETHDR(m, M_DONTWAIT, MT_DATA);
241 m->m_pkthdr.rcvif = ifp;
242 m->m_pkthdr.len = sizeof(*eh) + sizeof(bpdu);
243 m->m_len = m->m_pkthdr.len;
245 eh = mtod(m, struct ether_header *);
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));
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;
257 memcpy(mtod(m, caddr_t) + sizeof(*eh), &bpdu, sizeof(bpdu));
260 ifp->if_transmit(ifp, m);
264 bstp_decode_bpdu(struct bstp_port *bp, struct bstp_cbpdu *cpdu,
265 struct bstp_config_unit *cu)
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);
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);
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;
296 /* Strip off unused flags in STP mode */
297 flags = cpdu->cbu_flags;
298 switch (cpdu->cbu_protover) {
300 flags &= BSTP_PDU_STPMASK;
301 /* A STP BPDU explicitly conveys a Designated Port */
302 cu->cu_role = BSTP_ROLE_DESIGNATED;
305 case BSTP_PROTO_RSTP:
306 flags &= BSTP_PDU_RSTPMASK;
310 cu->cu_topology_change_ack =
311 (flags & BSTP_PDU_F_TCA) ? 1 : 0;
313 (flags & BSTP_PDU_F_P) ? 1 : 0;
315 (flags & BSTP_PDU_F_A) ? 1 : 0;
317 (flags & BSTP_PDU_F_L) ? 1 : 0;
319 (flags & BSTP_PDU_F_F) ? 1 : 0;
320 cu->cu_topology_change =
321 (flags & BSTP_PDU_F_TC) ? 1 : 0;
323 switch ((flags & BSTP_PDU_PRMASK) >> BSTP_PDU_PRSHIFT) {
324 case BSTP_PDU_F_ROOT:
325 cu->cu_role = BSTP_ROLE_ROOT;
328 cu->cu_role = BSTP_ROLE_ALTERNATE;
330 case BSTP_PDU_F_DESG:
331 cu->cu_role = BSTP_ROLE_DESIGNATED;
337 bstp_send_bpdu(struct bstp_state *bs, struct bstp_port *bp,
338 struct bstp_cbpdu *bpdu)
342 struct ether_header *eh;
344 BSTP_LOCK_ASSERT(bs);
348 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
351 MGETHDR(m, M_DONTWAIT, MT_DATA);
355 eh = mtod(m, struct ether_header *);
357 bpdu->cbu_ssap = bpdu->cbu_dsap = LLC_8021D_LSAP;
358 bpdu->cbu_ctl = LLC_UI;
359 bpdu->cbu_protoid = htons(BSTP_PROTO_ID);
361 memcpy(eh->ether_shost, IF_LLADDR(ifp), ETHER_ADDR_LEN);
362 memcpy(eh->ether_dhost, bstp_etheraddr, ETHER_ADDR_LEN);
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,
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,
383 panic("not implemented");
385 m->m_pkthdr.rcvif = ifp;
386 m->m_len = m->m_pkthdr.len;
389 ifp->if_transmit(ifp, m);
393 bstp_pdu_flags(struct bstp_port *bp)
397 if (bp->bp_proposing && bp->bp_state != BSTP_IFSTATE_FORWARDING)
398 flags |= BSTP_PDU_F_P;
401 flags |= BSTP_PDU_F_A;
403 if (bp->bp_tc_timer.active)
404 flags |= BSTP_PDU_F_TC;
407 flags |= BSTP_PDU_F_TCA;
409 switch (bp->bp_state) {
410 case BSTP_IFSTATE_LEARNING:
411 flags |= BSTP_PDU_F_L;
414 case BSTP_IFSTATE_FORWARDING:
415 flags |= (BSTP_PDU_F_L | BSTP_PDU_F_F);
419 switch (bp->bp_role) {
422 (BSTP_PDU_F_ROOT << BSTP_PDU_PRSHIFT);
425 case BSTP_ROLE_ALTERNATE:
426 case BSTP_ROLE_BACKUP: /* fall through */
428 (BSTP_PDU_F_ALT << BSTP_PDU_PRSHIFT);
431 case BSTP_ROLE_DESIGNATED:
433 (BSTP_PDU_F_DESG << BSTP_PDU_PRSHIFT);
437 /* Strip off unused flags in either mode */
438 switch (bp->bp_protover) {
440 flags &= BSTP_PDU_STPMASK;
442 case BSTP_PROTO_RSTP:
443 flags &= BSTP_PDU_RSTPMASK;
450 bstp_input(struct bstp_port *bp, struct ifnet *ifp, struct mbuf *m)
452 struct bstp_state *bs = bp->bp_bs;
453 struct ether_header *eh;
454 struct bstp_tbpdu tpdu;
457 if (bp->bp_active == 0) {
464 eh = mtod(m, struct ether_header *);
466 len = ntohs(eh->ether_type);
467 if (len < sizeof(tpdu))
470 m_adj(m, ETHER_HDR_LEN);
472 if (m->m_pkthdr.len > len)
473 m_adj(m, len - m->m_pkthdr.len);
474 if (m->m_len < sizeof(tpdu) &&
475 (m = m_pullup(m, sizeof(tpdu))) == NULL)
478 memcpy(&tpdu, mtod(m, caddr_t), sizeof(tpdu));
480 /* basic packet checks */
481 if (tpdu.tbu_dsap != LLC_8021D_LSAP ||
482 tpdu.tbu_ssap != LLC_8021D_LSAP ||
483 tpdu.tbu_ctl != LLC_UI)
485 if (tpdu.tbu_protoid != BSTP_PROTO_ID)
489 * We can treat later versions of the PDU as the same as the maximum
490 * version we implement. All additional parameters/flags are ignored.
492 if (tpdu.tbu_protover > BSTP_PROTO_MAX)
493 tpdu.tbu_protover = BSTP_PROTO_MAX;
495 if (tpdu.tbu_protover != bp->bp_protover) {
497 * Wait for the migration delay timer to expire before changing
498 * protocol version to avoid flip-flops.
500 if (bp->bp_flags & BSTP_PORT_CANMIGRATE)
501 bstp_set_port_proto(bp, tpdu.tbu_protover);
506 /* Clear operedge upon receiving a PDU on the port */
508 bstp_timer_start(&bp->bp_edge_delay_timer,
509 BSTP_DEFAULT_MIGRATE_DELAY);
511 switch (tpdu.tbu_protover) {
513 bstp_received_stp(bs, bp, &m, &tpdu);
516 case BSTP_PROTO_RSTP:
517 bstp_received_rstp(bs, bp, &m, &tpdu);
527 bstp_received_stp(struct bstp_state *bs, struct bstp_port *bp,
528 struct mbuf **mp, struct bstp_tbpdu *tpdu)
530 struct bstp_cbpdu cpdu;
531 struct bstp_config_unit *cu = &bp->bp_msg_cu;
532 struct bstp_tcn_unit tu;
534 switch (tpdu->tbu_bpdutype) {
535 case BSTP_MSGTYPE_TCN:
536 tu.tu_message_type = tpdu->tbu_bpdutype;
537 bstp_received_tcn(bs, bp, &tu);
539 case BSTP_MSGTYPE_CFG:
540 if ((*mp)->m_len < BSTP_BPDU_STP_LEN &&
541 (*mp = m_pullup(*mp, BSTP_BPDU_STP_LEN)) == NULL)
543 memcpy(&cpdu, mtod(*mp, caddr_t), BSTP_BPDU_STP_LEN);
545 bstp_decode_bpdu(bp, &cpdu, cu);
546 bstp_received_bpdu(bs, bp, cu);
552 bstp_received_rstp(struct bstp_state *bs, struct bstp_port *bp,
553 struct mbuf **mp, struct bstp_tbpdu *tpdu)
555 struct bstp_cbpdu cpdu;
556 struct bstp_config_unit *cu = &bp->bp_msg_cu;
558 if (tpdu->tbu_bpdutype != BSTP_MSGTYPE_RSTP)
561 if ((*mp)->m_len < BSTP_BPDU_RSTP_LEN &&
562 (*mp = m_pullup(*mp, BSTP_BPDU_RSTP_LEN)) == NULL)
564 memcpy(&cpdu, mtod(*mp, caddr_t), BSTP_BPDU_RSTP_LEN);
566 bstp_decode_bpdu(bp, &cpdu, cu);
567 bstp_received_bpdu(bs, bp, cu);
571 bstp_received_tcn(struct bstp_state *bs, struct bstp_port *bp,
572 struct bstp_tcn_unit *tcn)
579 bstp_received_bpdu(struct bstp_state *bs, struct bstp_port *bp,
580 struct bstp_config_unit *cu)
584 BSTP_LOCK_ASSERT(bs);
586 /* We need to have transitioned to INFO_MINE before proceeding */
587 switch (bp->bp_infois) {
588 case BSTP_INFO_DISABLED:
593 type = bstp_pdu_rcvtype(bp, cu);
596 case BSTP_PDU_SUPERIOR:
597 bs->bs_allsynced = 0;
599 bp->bp_proposing = 0;
601 if (cu->cu_proposal && cu->cu_forwarding == 0)
603 if (cu->cu_topology_change)
605 if (cu->cu_topology_change_ack)
609 !bstp_pdu_bettersame(bp, BSTP_INFO_RECEIVED))
612 /* copy the received priority and timers to the port */
613 bp->bp_port_pv = cu->cu_pv;
614 bp->bp_port_msg_age = cu->cu_message_age;
615 bp->bp_port_max_age = cu->cu_max_age;
616 bp->bp_port_fdelay = cu->cu_forward_delay;
618 (cu->cu_hello_time > BSTP_MIN_HELLO_TIME ?
619 cu->cu_hello_time : BSTP_MIN_HELLO_TIME);
621 /* set expiry for the new info */
622 bstp_set_timer_msgage(bp);
624 bp->bp_infois = BSTP_INFO_RECEIVED;
625 bstp_assign_roles(bs);
628 case BSTP_PDU_REPEATED:
629 if (cu->cu_proposal && cu->cu_forwarding == 0)
631 if (cu->cu_topology_change)
633 if (cu->cu_topology_change_ack)
636 /* rearm the age timer */
637 bstp_set_timer_msgage(bp);
640 case BSTP_PDU_INFERIOR:
641 if (cu->cu_learning) {
643 bp->bp_proposing = 0;
647 case BSTP_PDU_INFERIORALT:
649 * only point to point links are allowed fast
650 * transitions to forwarding.
652 if (cu->cu_agree && bp->bp_ptp_link) {
654 bp->bp_proposing = 0;
658 if (cu->cu_topology_change)
660 if (cu->cu_topology_change_ack)
665 return; /* do nothing */
667 /* update the state machines with the new data */
668 bstp_update_state(bs, bp);
672 bstp_pdu_rcvtype(struct bstp_port *bp, struct bstp_config_unit *cu)
676 /* default return type */
677 type = BSTP_PDU_OTHER;
679 switch (cu->cu_role) {
680 case BSTP_ROLE_DESIGNATED:
681 if (bstp_info_superior(&bp->bp_port_pv, &cu->cu_pv))
682 /* bpdu priority is superior */
683 type = BSTP_PDU_SUPERIOR;
684 else if (bstp_info_cmp(&bp->bp_port_pv, &cu->cu_pv) ==
686 if (bp->bp_port_msg_age != cu->cu_message_age ||
687 bp->bp_port_max_age != cu->cu_max_age ||
688 bp->bp_port_fdelay != cu->cu_forward_delay ||
689 bp->bp_port_htime != cu->cu_hello_time)
690 /* bpdu priority is equal and timers differ */
691 type = BSTP_PDU_SUPERIOR;
694 type = BSTP_PDU_REPEATED;
696 /* bpdu priority is worse */
697 type = BSTP_PDU_INFERIOR;
702 case BSTP_ROLE_ALTERNATE:
703 case BSTP_ROLE_BACKUP:
704 if (bstp_info_cmp(&bp->bp_port_pv, &cu->cu_pv) <= INFO_SAME)
706 * not a designated port and priority is the same or
709 type = BSTP_PDU_INFERIORALT;
717 bstp_pdu_bettersame(struct bstp_port *bp, int newinfo)
719 if (newinfo == BSTP_INFO_RECEIVED &&
720 bp->bp_infois == BSTP_INFO_RECEIVED &&
721 bstp_info_cmp(&bp->bp_port_pv, &bp->bp_msg_cu.cu_pv) >= INFO_SAME)
724 if (newinfo == BSTP_INFO_MINE &&
725 bp->bp_infois == BSTP_INFO_MINE &&
726 bstp_info_cmp(&bp->bp_port_pv, &bp->bp_desg_pv) >= INFO_SAME)
733 bstp_info_cmp(struct bstp_pri_vector *pv,
734 struct bstp_pri_vector *cpv)
736 if (cpv->pv_root_id < pv->pv_root_id)
737 return (INFO_BETTER);
738 if (cpv->pv_root_id > pv->pv_root_id)
741 if (cpv->pv_cost < pv->pv_cost)
742 return (INFO_BETTER);
743 if (cpv->pv_cost > pv->pv_cost)
746 if (cpv->pv_dbridge_id < pv->pv_dbridge_id)
747 return (INFO_BETTER);
748 if (cpv->pv_dbridge_id > pv->pv_dbridge_id)
751 if (cpv->pv_dport_id < pv->pv_dport_id)
752 return (INFO_BETTER);
753 if (cpv->pv_dport_id > pv->pv_dport_id)
760 * This message priority vector is superior to the port priority vector and
761 * will replace it if, and only if, the message priority vector is better than
762 * the port priority vector, or the message has been transmitted from the same
763 * designated bridge and designated port as the port priority vector.
766 bstp_info_superior(struct bstp_pri_vector *pv,
767 struct bstp_pri_vector *cpv)
769 if (bstp_info_cmp(pv, cpv) == INFO_BETTER ||
770 (bstp_same_bridgeid(pv->pv_dbridge_id, cpv->pv_dbridge_id) &&
771 (cpv->pv_dport_id & 0xfff) == (pv->pv_dport_id & 0xfff)))
777 bstp_assign_roles(struct bstp_state *bs)
779 struct bstp_port *bp, *rbp = NULL;
780 struct bstp_pri_vector pv;
782 /* default to our priority vector */
783 bs->bs_root_pv = bs->bs_bridge_pv;
784 bs->bs_root_msg_age = 0;
785 bs->bs_root_max_age = bs->bs_bridge_max_age;
786 bs->bs_root_fdelay = bs->bs_bridge_fdelay;
787 bs->bs_root_htime = bs->bs_bridge_htime;
788 bs->bs_root_port = NULL;
790 /* check if any recieved info supersedes us */
791 LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
792 if (bp->bp_infois != BSTP_INFO_RECEIVED)
796 pv.pv_cost += bp->bp_path_cost;
799 * The root priority vector is the best of the set comprising
800 * the bridge priority vector plus all root path priority
801 * vectors whose bridge address is not equal to us.
803 if (bstp_same_bridgeid(pv.pv_dbridge_id,
804 bs->bs_bridge_pv.pv_dbridge_id) == 0 &&
805 bstp_info_cmp(&bs->bs_root_pv, &pv) == INFO_BETTER) {
806 /* the port vector replaces the root */
808 bs->bs_root_msg_age = bp->bp_port_msg_age +
809 BSTP_MESSAGE_AGE_INCR;
810 bs->bs_root_max_age = bp->bp_port_max_age;
811 bs->bs_root_fdelay = bp->bp_port_fdelay;
812 bs->bs_root_htime = bp->bp_port_htime;
817 LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
818 /* calculate the port designated vector */
819 bp->bp_desg_pv.pv_root_id = bs->bs_root_pv.pv_root_id;
820 bp->bp_desg_pv.pv_cost = bs->bs_root_pv.pv_cost;
821 bp->bp_desg_pv.pv_dbridge_id = bs->bs_bridge_pv.pv_dbridge_id;
822 bp->bp_desg_pv.pv_dport_id = bp->bp_port_id;
823 bp->bp_desg_pv.pv_port_id = bp->bp_port_id;
825 /* calculate designated times */
826 bp->bp_desg_msg_age = bs->bs_root_msg_age;
827 bp->bp_desg_max_age = bs->bs_root_max_age;
828 bp->bp_desg_fdelay = bs->bs_root_fdelay;
829 bp->bp_desg_htime = bs->bs_bridge_htime;
832 switch (bp->bp_infois) {
833 case BSTP_INFO_DISABLED:
834 bstp_set_port_role(bp, BSTP_ROLE_DISABLED);
838 bstp_set_port_role(bp, BSTP_ROLE_DESIGNATED);
839 bstp_update_info(bp);
843 bstp_set_port_role(bp, BSTP_ROLE_DESIGNATED);
844 /* update the port info if stale */
845 if (bstp_info_cmp(&bp->bp_port_pv,
846 &bp->bp_desg_pv) != INFO_SAME ||
848 (bp->bp_port_msg_age != rbp->bp_port_msg_age ||
849 bp->bp_port_max_age != rbp->bp_port_max_age ||
850 bp->bp_port_fdelay != rbp->bp_port_fdelay ||
851 bp->bp_port_htime != rbp->bp_port_htime)))
852 bstp_update_info(bp);
855 case BSTP_INFO_RECEIVED:
858 * root priority is derived from this
859 * port, make it the root port.
861 bstp_set_port_role(bp, BSTP_ROLE_ROOT);
862 bs->bs_root_port = bp;
863 } else if (bstp_info_cmp(&bp->bp_port_pv,
864 &bp->bp_desg_pv) == INFO_BETTER) {
866 * the port priority is lower than the root
869 bstp_set_port_role(bp, BSTP_ROLE_DESIGNATED);
870 bstp_update_info(bp);
872 if (bstp_same_bridgeid(
873 bp->bp_port_pv.pv_dbridge_id,
874 bs->bs_bridge_pv.pv_dbridge_id)) {
876 * the designated bridge refers to
877 * another port on this bridge.
879 bstp_set_port_role(bp,
883 * the port is an inferior path to the
886 bstp_set_port_role(bp,
887 BSTP_ROLE_ALTERNATE);
896 bstp_update_state(struct bstp_state *bs, struct bstp_port *bp)
898 struct bstp_port *bp2;
901 BSTP_LOCK_ASSERT(bs);
903 /* check if all the ports have syncronised again */
904 if (!bs->bs_allsynced) {
906 LIST_FOREACH(bp2, &bs->bs_bplist, bp_next) {
907 if (!(bp2->bp_synced ||
908 bp2->bp_role == BSTP_ROLE_ROOT)) {
913 bs->bs_allsynced = synced;
916 bstp_update_roles(bs, bp);
921 bstp_update_roles(struct bstp_state *bs, struct bstp_port *bp)
923 switch (bp->bp_role) {
924 case BSTP_ROLE_DISABLED:
925 /* Clear any flags if set */
926 if (bp->bp_sync || !bp->bp_synced || bp->bp_reroot) {
933 case BSTP_ROLE_ALTERNATE:
934 case BSTP_ROLE_BACKUP:
935 if ((bs->bs_allsynced && !bp->bp_agree) ||
936 (bp->bp_proposed && bp->bp_agree)) {
939 bp->bp_flags |= BSTP_PORT_NEWINFO;
940 DPRINTF("%s -> ALTERNATE_AGREED\n",
941 bp->bp_ifp->if_xname);
944 if (bp->bp_proposed && !bp->bp_agree) {
945 bstp_set_all_sync(bs);
947 DPRINTF("%s -> ALTERNATE_PROPOSED\n",
948 bp->bp_ifp->if_xname);
951 /* Clear any flags if set */
952 if (bp->bp_sync || !bp->bp_synced || bp->bp_reroot) {
956 DPRINTF("%s -> ALTERNATE_PORT\n", bp->bp_ifp->if_xname);
961 if (bp->bp_state != BSTP_IFSTATE_FORWARDING && !bp->bp_reroot) {
962 bstp_set_all_reroot(bs);
963 DPRINTF("%s -> ROOT_REROOT\n", bp->bp_ifp->if_xname);
966 if ((bs->bs_allsynced && !bp->bp_agree) ||
967 (bp->bp_proposed && bp->bp_agree)) {
971 bp->bp_flags |= BSTP_PORT_NEWINFO;
972 DPRINTF("%s -> ROOT_AGREED\n", bp->bp_ifp->if_xname);
975 if (bp->bp_proposed && !bp->bp_agree) {
976 bstp_set_all_sync(bs);
978 DPRINTF("%s -> ROOT_PROPOSED\n", bp->bp_ifp->if_xname);
981 if (bp->bp_state != BSTP_IFSTATE_FORWARDING &&
982 (bp->bp_forward_delay_timer.active == 0 ||
983 (bstp_rerooted(bs, bp) &&
984 bp->bp_recent_backup_timer.active == 0 &&
985 bp->bp_protover == BSTP_PROTO_RSTP))) {
986 switch (bp->bp_state) {
987 case BSTP_IFSTATE_DISCARDING:
988 bstp_set_port_state(bp, BSTP_IFSTATE_LEARNING);
990 case BSTP_IFSTATE_LEARNING:
991 bstp_set_port_state(bp,
992 BSTP_IFSTATE_FORWARDING);
997 if (bp->bp_state == BSTP_IFSTATE_FORWARDING && bp->bp_reroot) {
999 DPRINTF("%s -> ROOT_REROOTED\n", bp->bp_ifp->if_xname);
1003 case BSTP_ROLE_DESIGNATED:
1004 if (bp->bp_recent_root_timer.active == 0 && bp->bp_reroot) {
1006 DPRINTF("%s -> DESIGNATED_RETIRED\n",
1007 bp->bp_ifp->if_xname);
1010 if ((bp->bp_state == BSTP_IFSTATE_DISCARDING &&
1011 !bp->bp_synced) || (bp->bp_agreed && !bp->bp_synced) ||
1012 (bp->bp_operedge && !bp->bp_synced) ||
1013 (bp->bp_sync && bp->bp_synced)) {
1014 bstp_timer_stop(&bp->bp_recent_root_timer);
1017 DPRINTF("%s -> DESIGNATED_SYNCED\n",
1018 bp->bp_ifp->if_xname);
1021 if (bp->bp_state != BSTP_IFSTATE_FORWARDING &&
1022 !bp->bp_agreed && !bp->bp_proposing &&
1024 bp->bp_proposing = 1;
1025 bp->bp_flags |= BSTP_PORT_NEWINFO;
1026 bstp_timer_start(&bp->bp_edge_delay_timer,
1027 (bp->bp_ptp_link ? BSTP_DEFAULT_MIGRATE_DELAY :
1028 bp->bp_desg_max_age));
1029 DPRINTF("%s -> DESIGNATED_PROPOSE\n",
1030 bp->bp_ifp->if_xname);
1033 if (bp->bp_state != BSTP_IFSTATE_FORWARDING &&
1034 (bp->bp_forward_delay_timer.active == 0 || bp->bp_agreed ||
1036 (bp->bp_recent_root_timer.active == 0 || !bp->bp_reroot) &&
1039 DPRINTF("%s -> AGREED\n", bp->bp_ifp->if_xname);
1041 * If agreed|operedge then go straight to forwarding,
1042 * otherwise follow discard -> learn -> forward.
1044 if (bp->bp_agreed || bp->bp_operedge ||
1045 bp->bp_state == BSTP_IFSTATE_LEARNING) {
1046 bstp_set_port_state(bp,
1047 BSTP_IFSTATE_FORWARDING);
1048 bp->bp_agreed = bp->bp_protover;
1049 } else if (bp->bp_state == BSTP_IFSTATE_DISCARDING)
1050 bstp_set_port_state(bp, BSTP_IFSTATE_LEARNING);
1053 if (((bp->bp_sync && !bp->bp_synced) ||
1054 (bp->bp_reroot && bp->bp_recent_root_timer.active) ||
1055 (bp->bp_flags & BSTP_PORT_DISPUTED)) && !bp->bp_operedge &&
1056 bp->bp_state != BSTP_IFSTATE_DISCARDING) {
1057 bstp_set_port_state(bp, BSTP_IFSTATE_DISCARDING);
1058 bp->bp_flags &= ~BSTP_PORT_DISPUTED;
1059 bstp_timer_start(&bp->bp_forward_delay_timer,
1060 bp->bp_protover == BSTP_PROTO_RSTP ?
1061 bp->bp_desg_htime : bp->bp_desg_fdelay);
1062 DPRINTF("%s -> DESIGNATED_DISCARD\n",
1063 bp->bp_ifp->if_xname);
1068 if (bp->bp_flags & BSTP_PORT_NEWINFO)
1069 bstp_transmit(bs, bp);
1073 bstp_update_tc(struct bstp_port *bp)
1075 switch (bp->bp_tcstate) {
1076 case BSTP_TCSTATE_ACTIVE:
1077 if ((bp->bp_role != BSTP_ROLE_DESIGNATED &&
1078 bp->bp_role != BSTP_ROLE_ROOT) || bp->bp_operedge)
1079 bstp_set_port_tc(bp, BSTP_TCSTATE_LEARNING);
1082 bstp_set_port_tc(bp, BSTP_TCSTATE_TCN);
1084 bstp_set_port_tc(bp, BSTP_TCSTATE_TC);
1086 if (bp->bp_tc_prop && !bp->bp_operedge)
1087 bstp_set_port_tc(bp, BSTP_TCSTATE_PROPAG);
1090 bstp_set_port_tc(bp, BSTP_TCSTATE_ACK);
1093 case BSTP_TCSTATE_INACTIVE:
1094 if ((bp->bp_state == BSTP_IFSTATE_LEARNING ||
1095 bp->bp_state == BSTP_IFSTATE_FORWARDING) &&
1096 bp->bp_fdbflush == 0)
1097 bstp_set_port_tc(bp, BSTP_TCSTATE_LEARNING);
1100 case BSTP_TCSTATE_LEARNING:
1101 if (bp->bp_rcvdtc || bp->bp_rcvdtcn || bp->bp_rcvdtca ||
1103 bstp_set_port_tc(bp, BSTP_TCSTATE_LEARNING);
1104 else if (bp->bp_role != BSTP_ROLE_DESIGNATED &&
1105 bp->bp_role != BSTP_ROLE_ROOT &&
1106 bp->bp_state == BSTP_IFSTATE_DISCARDING)
1107 bstp_set_port_tc(bp, BSTP_TCSTATE_INACTIVE);
1109 if ((bp->bp_role == BSTP_ROLE_DESIGNATED ||
1110 bp->bp_role == BSTP_ROLE_ROOT) &&
1111 bp->bp_state == BSTP_IFSTATE_FORWARDING &&
1113 bstp_set_port_tc(bp, BSTP_TCSTATE_DETECTED);
1116 /* these are transient states and go straight back to ACTIVE */
1117 case BSTP_TCSTATE_DETECTED:
1118 case BSTP_TCSTATE_TCN:
1119 case BSTP_TCSTATE_TC:
1120 case BSTP_TCSTATE_PROPAG:
1121 case BSTP_TCSTATE_ACK:
1122 DPRINTF("Invalid TC state for %s\n",
1123 bp->bp_ifp->if_xname);
1130 bstp_update_info(struct bstp_port *bp)
1132 struct bstp_state *bs = bp->bp_bs;
1134 bp->bp_proposing = 0;
1135 bp->bp_proposed = 0;
1137 if (bp->bp_agreed && !bstp_pdu_bettersame(bp, BSTP_INFO_MINE))
1140 if (bp->bp_synced && !bp->bp_agreed) {
1142 bs->bs_allsynced = 0;
1145 /* copy the designated pv to the port */
1146 bp->bp_port_pv = bp->bp_desg_pv;
1147 bp->bp_port_msg_age = bp->bp_desg_msg_age;
1148 bp->bp_port_max_age = bp->bp_desg_max_age;
1149 bp->bp_port_fdelay = bp->bp_desg_fdelay;
1150 bp->bp_port_htime = bp->bp_desg_htime;
1151 bp->bp_infois = BSTP_INFO_MINE;
1153 /* Set transmit flag but do not immediately send */
1154 bp->bp_flags |= BSTP_PORT_NEWINFO;
1157 /* set tcprop on every port other than the caller */
1159 bstp_set_other_tcprop(struct bstp_port *bp)
1161 struct bstp_state *bs = bp->bp_bs;
1162 struct bstp_port *bp2;
1164 BSTP_LOCK_ASSERT(bs);
1166 LIST_FOREACH(bp2, &bs->bs_bplist, bp_next) {
1169 bp2->bp_tc_prop = 1;
1174 bstp_set_all_reroot(struct bstp_state *bs)
1176 struct bstp_port *bp;
1178 BSTP_LOCK_ASSERT(bs);
1180 LIST_FOREACH(bp, &bs->bs_bplist, bp_next)
1185 bstp_set_all_sync(struct bstp_state *bs)
1187 struct bstp_port *bp;
1189 BSTP_LOCK_ASSERT(bs);
1191 LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
1193 bp->bp_synced = 0; /* Not explicit in spec */
1196 bs->bs_allsynced = 0;
1200 bstp_set_port_state(struct bstp_port *bp, int state)
1202 if (bp->bp_state == state)
1205 bp->bp_state = state;
1207 switch (bp->bp_state) {
1208 case BSTP_IFSTATE_DISCARDING:
1209 DPRINTF("state changed to DISCARDING on %s\n",
1210 bp->bp_ifp->if_xname);
1213 case BSTP_IFSTATE_LEARNING:
1214 DPRINTF("state changed to LEARNING on %s\n",
1215 bp->bp_ifp->if_xname);
1217 bstp_timer_start(&bp->bp_forward_delay_timer,
1218 bp->bp_protover == BSTP_PROTO_RSTP ?
1219 bp->bp_desg_htime : bp->bp_desg_fdelay);
1222 case BSTP_IFSTATE_FORWARDING:
1223 DPRINTF("state changed to FORWARDING on %s\n",
1224 bp->bp_ifp->if_xname);
1226 bstp_timer_stop(&bp->bp_forward_delay_timer);
1227 /* Record that we enabled forwarding */
1228 bp->bp_forward_transitions++;
1232 /* notify the parent bridge */
1233 taskqueue_enqueue(taskqueue_swi, &bp->bp_statetask);
1237 bstp_set_port_role(struct bstp_port *bp, int role)
1239 struct bstp_state *bs = bp->bp_bs;
1241 if (bp->bp_role == role)
1244 /* perform pre-change tasks */
1245 switch (bp->bp_role) {
1246 case BSTP_ROLE_DISABLED:
1247 bstp_timer_start(&bp->bp_forward_delay_timer,
1248 bp->bp_desg_max_age);
1251 case BSTP_ROLE_BACKUP:
1252 bstp_timer_start(&bp->bp_recent_backup_timer,
1253 bp->bp_desg_htime * 2);
1255 case BSTP_ROLE_ALTERNATE:
1256 bstp_timer_start(&bp->bp_forward_delay_timer,
1257 bp->bp_desg_fdelay);
1263 case BSTP_ROLE_ROOT:
1264 bstp_timer_start(&bp->bp_recent_root_timer,
1265 BSTP_DEFAULT_FORWARD_DELAY);
1270 /* clear values not carried between roles */
1271 bp->bp_proposing = 0;
1272 bs->bs_allsynced = 0;
1274 /* initialise the new role */
1275 switch (bp->bp_role) {
1276 case BSTP_ROLE_DISABLED:
1277 case BSTP_ROLE_ALTERNATE:
1278 case BSTP_ROLE_BACKUP:
1279 DPRINTF("%s role -> ALT/BACK/DISABLED\n",
1280 bp->bp_ifp->if_xname);
1281 bstp_set_port_state(bp, BSTP_IFSTATE_DISCARDING);
1282 bstp_timer_stop(&bp->bp_recent_root_timer);
1283 bstp_timer_latch(&bp->bp_forward_delay_timer);
1289 case BSTP_ROLE_ROOT:
1290 DPRINTF("%s role -> ROOT\n",
1291 bp->bp_ifp->if_xname);
1292 bstp_set_port_state(bp, BSTP_IFSTATE_DISCARDING);
1293 bstp_timer_latch(&bp->bp_recent_root_timer);
1294 bp->bp_proposing = 0;
1297 case BSTP_ROLE_DESIGNATED:
1298 DPRINTF("%s role -> DESIGNATED\n",
1299 bp->bp_ifp->if_xname);
1300 bstp_timer_start(&bp->bp_hello_timer,
1306 /* let the TC state know that the role changed */
1311 bstp_set_port_proto(struct bstp_port *bp, int proto)
1313 struct bstp_state *bs = bp->bp_bs;
1315 /* supported protocol versions */
1317 case BSTP_PROTO_STP:
1318 /* we can downgrade protocols only */
1319 bstp_timer_stop(&bp->bp_migrate_delay_timer);
1320 /* clear unsupported features */
1321 bp->bp_operedge = 0;
1322 /* STP compat mode only uses 16 bits of the 32 */
1323 if (bp->bp_path_cost > 65535)
1324 bp->bp_path_cost = 65535;
1327 case BSTP_PROTO_RSTP:
1328 bstp_timer_start(&bp->bp_migrate_delay_timer,
1329 bs->bs_migration_delay);
1333 DPRINTF("Unsupported STP version %d\n", proto);
1337 bp->bp_protover = proto;
1338 bp->bp_flags &= ~BSTP_PORT_CANMIGRATE;
1342 bstp_set_port_tc(struct bstp_port *bp, int state)
1344 struct bstp_state *bs = bp->bp_bs;
1346 bp->bp_tcstate = state;
1348 /* initialise the new state */
1349 switch (bp->bp_tcstate) {
1350 case BSTP_TCSTATE_ACTIVE:
1351 DPRINTF("%s -> TC_ACTIVE\n", bp->bp_ifp->if_xname);
1355 case BSTP_TCSTATE_INACTIVE:
1356 bstp_timer_stop(&bp->bp_tc_timer);
1357 /* flush routes on the parent bridge */
1358 bp->bp_fdbflush = 1;
1359 taskqueue_enqueue(taskqueue_swi, &bp->bp_rtagetask);
1361 DPRINTF("%s -> TC_INACTIVE\n", bp->bp_ifp->if_xname);
1364 case BSTP_TCSTATE_LEARNING:
1369 DPRINTF("%s -> TC_LEARNING\n", bp->bp_ifp->if_xname);
1372 case BSTP_TCSTATE_DETECTED:
1373 bstp_set_timer_tc(bp);
1374 bstp_set_other_tcprop(bp);
1375 /* send out notification */
1376 bp->bp_flags |= BSTP_PORT_NEWINFO;
1377 bstp_transmit(bs, bp);
1378 getmicrotime(&bs->bs_last_tc_time);
1379 DPRINTF("%s -> TC_DETECTED\n", bp->bp_ifp->if_xname);
1380 bp->bp_tcstate = BSTP_TCSTATE_ACTIVE; /* UCT */
1383 case BSTP_TCSTATE_TCN:
1384 bstp_set_timer_tc(bp);
1385 DPRINTF("%s -> TC_TCN\n", bp->bp_ifp->if_xname);
1387 case BSTP_TCSTATE_TC:
1390 if (bp->bp_role == BSTP_ROLE_DESIGNATED)
1393 bstp_set_other_tcprop(bp);
1394 DPRINTF("%s -> TC_TC\n", bp->bp_ifp->if_xname);
1395 bp->bp_tcstate = BSTP_TCSTATE_ACTIVE; /* UCT */
1398 case BSTP_TCSTATE_PROPAG:
1399 /* flush routes on the parent bridge */
1400 bp->bp_fdbflush = 1;
1401 taskqueue_enqueue(taskqueue_swi, &bp->bp_rtagetask);
1403 bstp_set_timer_tc(bp);
1404 DPRINTF("%s -> TC_PROPAG\n", bp->bp_ifp->if_xname);
1405 bp->bp_tcstate = BSTP_TCSTATE_ACTIVE; /* UCT */
1408 case BSTP_TCSTATE_ACK:
1409 bstp_timer_stop(&bp->bp_tc_timer);
1411 DPRINTF("%s -> TC_ACK\n", bp->bp_ifp->if_xname);
1412 bp->bp_tcstate = BSTP_TCSTATE_ACTIVE; /* UCT */
1418 bstp_set_timer_tc(struct bstp_port *bp)
1420 struct bstp_state *bs = bp->bp_bs;
1422 if (bp->bp_tc_timer.active)
1425 switch (bp->bp_protover) {
1426 case BSTP_PROTO_RSTP:
1427 bstp_timer_start(&bp->bp_tc_timer,
1428 bp->bp_desg_htime + BSTP_TICK_VAL);
1429 bp->bp_flags |= BSTP_PORT_NEWINFO;
1432 case BSTP_PROTO_STP:
1433 bstp_timer_start(&bp->bp_tc_timer,
1434 bs->bs_root_max_age + bs->bs_root_fdelay);
1440 bstp_set_timer_msgage(struct bstp_port *bp)
1442 if (bp->bp_port_msg_age + BSTP_MESSAGE_AGE_INCR <=
1443 bp->bp_port_max_age) {
1444 bstp_timer_start(&bp->bp_message_age_timer,
1445 bp->bp_port_htime * 3);
1447 /* expires immediately */
1448 bstp_timer_start(&bp->bp_message_age_timer, 0);
1452 bstp_rerooted(struct bstp_state *bs, struct bstp_port *bp)
1454 struct bstp_port *bp2;
1457 LIST_FOREACH(bp2, &bs->bs_bplist, bp_next) {
1460 if (bp2->bp_recent_root_timer.active) {
1469 bstp_set_htime(struct bstp_state *bs, int t)
1471 /* convert seconds to ticks */
1474 /* value can only be changed in leagacy stp mode */
1475 if (bs->bs_protover != BSTP_PROTO_STP)
1478 if (t < BSTP_MIN_HELLO_TIME || t > BSTP_MAX_HELLO_TIME)
1482 bs->bs_bridge_htime = t;
1489 bstp_set_fdelay(struct bstp_state *bs, int t)
1491 /* convert seconds to ticks */
1494 if (t < BSTP_MIN_FORWARD_DELAY || t > BSTP_MAX_FORWARD_DELAY)
1498 bs->bs_bridge_fdelay = t;
1505 bstp_set_maxage(struct bstp_state *bs, int t)
1507 /* convert seconds to ticks */
1510 if (t < BSTP_MIN_MAX_AGE || t > BSTP_MAX_MAX_AGE)
1514 bs->bs_bridge_max_age = t;
1521 bstp_set_holdcount(struct bstp_state *bs, int count)
1523 struct bstp_port *bp;
1525 if (count < BSTP_MIN_HOLD_COUNT ||
1526 count > BSTP_MAX_HOLD_COUNT)
1530 bs->bs_txholdcount = count;
1531 LIST_FOREACH(bp, &bs->bs_bplist, bp_next)
1538 bstp_set_protocol(struct bstp_state *bs, int proto)
1540 struct bstp_port *bp;
1543 /* Supported protocol versions */
1544 case BSTP_PROTO_STP:
1545 case BSTP_PROTO_RSTP:
1553 bs->bs_protover = proto;
1554 bs->bs_bridge_htime = BSTP_DEFAULT_HELLO_TIME;
1555 LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
1557 bp->bp_infois = BSTP_INFO_DISABLED;
1559 bstp_set_port_proto(bp, bs->bs_protover);
1560 bstp_set_port_role(bp, BSTP_ROLE_DISABLED);
1561 bstp_set_port_tc(bp, BSTP_TCSTATE_INACTIVE);
1562 bstp_timer_stop(&bp->bp_recent_backup_timer);
1570 bstp_set_priority(struct bstp_state *bs, int pri)
1572 if (pri < 0 || pri > BSTP_MAX_PRIORITY)
1575 /* Limit to steps of 4096 */
1579 bs->bs_bridge_priority = pri;
1586 bstp_set_port_priority(struct bstp_port *bp, int pri)
1588 struct bstp_state *bs = bp->bp_bs;
1590 if (pri < 0 || pri > BSTP_MAX_PORT_PRIORITY)
1593 /* Limit to steps of 16 */
1597 bp->bp_priority = pri;
1604 bstp_set_path_cost(struct bstp_port *bp, uint32_t path_cost)
1606 struct bstp_state *bs = bp->bp_bs;
1608 if (path_cost > BSTP_MAX_PATH_COST)
1611 /* STP compat mode only uses 16 bits of the 32 */
1612 if (bp->bp_protover == BSTP_PROTO_STP && path_cost > 65535)
1617 if (path_cost == 0) { /* use auto */
1618 bp->bp_flags &= ~BSTP_PORT_ADMCOST;
1619 bp->bp_path_cost = bstp_calc_path_cost(bp);
1621 bp->bp_path_cost = path_cost;
1622 bp->bp_flags |= BSTP_PORT_ADMCOST;
1630 bstp_set_edge(struct bstp_port *bp, int set)
1632 struct bstp_state *bs = bp->bp_bs;
1635 if ((bp->bp_operedge = set) == 0)
1636 bp->bp_flags &= ~BSTP_PORT_ADMEDGE;
1638 bp->bp_flags |= BSTP_PORT_ADMEDGE;
1644 bstp_set_autoedge(struct bstp_port *bp, int set)
1646 struct bstp_state *bs = bp->bp_bs;
1650 bp->bp_flags |= BSTP_PORT_AUTOEDGE;
1651 /* we may be able to transition straight to edge */
1652 if (bp->bp_edge_delay_timer.active == 0)
1653 bstp_edge_delay_expiry(bs, bp);
1655 bp->bp_flags &= ~BSTP_PORT_AUTOEDGE;
1661 bstp_set_ptp(struct bstp_port *bp, int set)
1663 struct bstp_state *bs = bp->bp_bs;
1666 bp->bp_ptp_link = set;
1672 bstp_set_autoptp(struct bstp_port *bp, int set)
1674 struct bstp_state *bs = bp->bp_bs;
1678 bp->bp_flags |= BSTP_PORT_AUTOPTP;
1679 if (bp->bp_role != BSTP_ROLE_DISABLED)
1680 taskqueue_enqueue(taskqueue_swi, &bp->bp_mediatask);
1682 bp->bp_flags &= ~BSTP_PORT_AUTOPTP;
1688 * Calculate the path cost according to the link speed.
1691 bstp_calc_path_cost(struct bstp_port *bp)
1693 struct ifnet *ifp = bp->bp_ifp;
1696 /* If the priority has been manually set then retain the value */
1697 if (bp->bp_flags & BSTP_PORT_ADMCOST)
1698 return bp->bp_path_cost;
1700 if (ifp->if_link_state == LINK_STATE_DOWN) {
1701 /* Recalc when the link comes up again */
1702 bp->bp_flags |= BSTP_PORT_PNDCOST;
1703 return (BSTP_DEFAULT_PATH_COST);
1706 if (ifp->if_baudrate < 1000)
1707 return (BSTP_DEFAULT_PATH_COST);
1709 /* formula from section 17.14, IEEE Std 802.1D-2004 */
1710 path_cost = 20000000000ULL / (ifp->if_baudrate / 1000);
1712 if (path_cost > BSTP_MAX_PATH_COST)
1713 path_cost = BSTP_MAX_PATH_COST;
1715 /* STP compat mode only uses 16 bits of the 32 */
1716 if (bp->bp_protover == BSTP_PROTO_STP && path_cost > 65535)
1723 * Notify the bridge that a port state has changed, we need to do this from a
1724 * taskqueue to avoid a LOR.
1727 bstp_notify_state(void *arg, int pending)
1729 struct bstp_port *bp = (struct bstp_port *)arg;
1730 struct bstp_state *bs = bp->bp_bs;
1732 if (bp->bp_active == 1 && bs->bs_state_cb != NULL)
1733 (*bs->bs_state_cb)(bp->bp_ifp, bp->bp_state);
1737 * Flush the routes on the bridge port, we need to do this from a
1738 * taskqueue to avoid a LOR.
1741 bstp_notify_rtage(void *arg, int pending)
1743 struct bstp_port *bp = (struct bstp_port *)arg;
1744 struct bstp_state *bs = bp->bp_bs;
1748 switch (bp->bp_protover) {
1749 case BSTP_PROTO_STP:
1750 /* convert to seconds */
1751 age = bp->bp_desg_fdelay / BSTP_TICK_VAL;
1754 case BSTP_PROTO_RSTP:
1760 if (bp->bp_active == 1 && bs->bs_rtage_cb != NULL)
1761 (*bs->bs_rtage_cb)(bp->bp_ifp, age);
1763 /* flush is complete */
1765 bp->bp_fdbflush = 0;
1770 bstp_linkstate(struct bstp_port *bp)
1772 struct bstp_state *bs = bp->bp_bs;
1777 bstp_ifupdstatus(bp, 0);
1779 bstp_update_state(bs, bp);
1784 bstp_ifupdstatus(void *arg, int pending)
1786 struct bstp_port *bp = (struct bstp_port *)arg;
1787 struct bstp_state *bs = bp->bp_bs;
1788 struct ifnet *ifp = bp->bp_ifp;
1789 struct ifmediareq ifmr;
1795 bzero((char *)&ifmr, sizeof(ifmr));
1796 error = (*ifp->if_ioctl)(ifp, SIOCGIFMEDIA, (caddr_t)&ifmr);
1800 if ((error == 0) && (ifp->if_flags & IFF_UP)) {
1801 if (ifmr.ifm_status & IFM_ACTIVE) {
1802 /* A full-duplex link is assumed to be point to point */
1803 if (bp->bp_flags & BSTP_PORT_AUTOPTP) {
1806 fdx = ifmr.ifm_active & IFM_FDX ? 1 : 0;
1807 if (bp->bp_ptp_link ^ fdx) {
1808 bp->bp_ptp_link = fdx;
1813 /* Calc the cost if the link was down previously */
1814 if (bp->bp_flags & BSTP_PORT_PNDCOST) {
1817 cost = bstp_calc_path_cost(bp);
1818 if (bp->bp_path_cost != cost) {
1819 bp->bp_path_cost = cost;
1822 bp->bp_flags &= ~BSTP_PORT_PNDCOST;
1825 if (bp->bp_role == BSTP_ROLE_DISABLED) {
1826 bstp_enable_port(bs, bp);
1830 if (bp->bp_role != BSTP_ROLE_DISABLED) {
1831 bstp_disable_port(bs, bp);
1833 if ((bp->bp_flags & BSTP_PORT_ADMEDGE) &&
1834 bp->bp_protover == BSTP_PROTO_RSTP)
1835 bp->bp_operedge = 1;
1838 } else if (bp->bp_infois != BSTP_INFO_DISABLED) {
1839 bstp_disable_port(bs, bp);
1843 bstp_assign_roles(bs);
1848 bstp_enable_port(struct bstp_state *bs, struct bstp_port *bp)
1850 bp->bp_infois = BSTP_INFO_AGED;
1854 bstp_disable_port(struct bstp_state *bs, struct bstp_port *bp)
1856 bp->bp_infois = BSTP_INFO_DISABLED;
1860 bstp_tick(void *arg)
1862 struct bstp_state *bs = arg;
1863 struct bstp_port *bp;
1865 BSTP_LOCK_ASSERT(bs);
1867 if (bs->bs_running == 0)
1870 CURVNET_SET(bs->bs_vnet);
1872 /* poll link events on interfaces that do not support linkstate */
1873 if (bstp_timer_dectest(&bs->bs_link_timer)) {
1874 LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
1875 if (!(bp->bp_ifp->if_capabilities & IFCAP_LINKSTATE))
1876 taskqueue_enqueue(taskqueue_swi, &bp->bp_mediatask);
1878 bstp_timer_start(&bs->bs_link_timer, BSTP_LINK_TIMER);
1881 LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
1882 /* no events need to happen for these */
1883 bstp_timer_dectest(&bp->bp_tc_timer);
1884 bstp_timer_dectest(&bp->bp_recent_root_timer);
1885 bstp_timer_dectest(&bp->bp_forward_delay_timer);
1886 bstp_timer_dectest(&bp->bp_recent_backup_timer);
1888 if (bstp_timer_dectest(&bp->bp_hello_timer))
1889 bstp_hello_timer_expiry(bs, bp);
1891 if (bstp_timer_dectest(&bp->bp_message_age_timer))
1892 bstp_message_age_expiry(bs, bp);
1894 if (bstp_timer_dectest(&bp->bp_migrate_delay_timer))
1895 bstp_migrate_delay_expiry(bs, bp);
1897 if (bstp_timer_dectest(&bp->bp_edge_delay_timer))
1898 bstp_edge_delay_expiry(bs, bp);
1900 /* update the various state machines for the port */
1901 bstp_update_state(bs, bp);
1903 if (bp->bp_txcount > 0)
1909 callout_reset(&bs->bs_bstpcallout, hz, bstp_tick, bs);
1913 bstp_timer_start(struct bstp_timer *t, uint16_t v)
1921 bstp_timer_stop(struct bstp_timer *t)
1929 bstp_timer_latch(struct bstp_timer *t)
1936 bstp_timer_dectest(struct bstp_timer *t)
1938 if (t->active == 0 || t->latched)
1940 t->value -= BSTP_TICK_VAL;
1941 if (t->value <= 0) {
1949 bstp_hello_timer_expiry(struct bstp_state *bs, struct bstp_port *bp)
1951 if ((bp->bp_flags & BSTP_PORT_NEWINFO) ||
1952 bp->bp_role == BSTP_ROLE_DESIGNATED ||
1953 (bp->bp_role == BSTP_ROLE_ROOT &&
1954 bp->bp_tc_timer.active == 1)) {
1955 bstp_timer_start(&bp->bp_hello_timer, bp->bp_desg_htime);
1956 bp->bp_flags |= BSTP_PORT_NEWINFO;
1957 bstp_transmit(bs, bp);
1962 bstp_message_age_expiry(struct bstp_state *bs, struct bstp_port *bp)
1964 if (bp->bp_infois == BSTP_INFO_RECEIVED) {
1965 bp->bp_infois = BSTP_INFO_AGED;
1966 bstp_assign_roles(bs);
1967 DPRINTF("aged info on %s\n", bp->bp_ifp->if_xname);
1972 bstp_migrate_delay_expiry(struct bstp_state *bs, struct bstp_port *bp)
1974 bp->bp_flags |= BSTP_PORT_CANMIGRATE;
1978 bstp_edge_delay_expiry(struct bstp_state *bs, struct bstp_port *bp)
1980 if ((bp->bp_flags & BSTP_PORT_AUTOEDGE) &&
1981 bp->bp_protover == BSTP_PROTO_RSTP && bp->bp_proposing &&
1982 bp->bp_role == BSTP_ROLE_DESIGNATED) {
1983 bp->bp_operedge = 1;
1984 DPRINTF("%s -> edge port\n", bp->bp_ifp->if_xname);
1989 bstp_addr_cmp(const uint8_t *a, const uint8_t *b)
1993 for (i = 0, d = 0; i < ETHER_ADDR_LEN && d == 0; i++) {
1994 d = ((int)a[i]) - ((int)b[i]);
2001 * compare the bridge address component of the bridgeid
2004 bstp_same_bridgeid(uint64_t id1, uint64_t id2)
2006 u_char addr1[ETHER_ADDR_LEN];
2007 u_char addr2[ETHER_ADDR_LEN];
2009 PV2ADDR(id1, addr1);
2010 PV2ADDR(id2, addr2);
2012 if (bstp_addr_cmp(addr1, addr2) == 0)
2019 bstp_reinit(struct bstp_state *bs)
2021 struct bstp_port *bp;
2022 struct ifnet *ifp, *mif;
2025 static const u_char llzero[ETHER_ADDR_LEN]; /* 00:00:00:00:00:00 */
2027 BSTP_LOCK_ASSERT(bs);
2029 if (LIST_EMPTY(&bs->bs_bplist))
2033 bridgeptr = LIST_FIRST(&bs->bs_bplist)->bp_ifp->if_bridge;
2034 KASSERT(bridgeptr != NULL, ("Invalid bridge pointer"));
2036 * Search through the Ethernet adapters and find the one with the
2037 * lowest value. Make sure the adapter which we take the MAC address
2038 * from is part of this bridge, so we can have more than one independent
2039 * bridges in the same STP domain.
2041 IFNET_RLOCK_NOSLEEP();
2042 TAILQ_FOREACH(ifp, &V_ifnet, if_link) {
2043 if (ifp->if_type != IFT_ETHER)
2044 continue; /* Not Ethernet */
2046 if (ifp->if_bridge != bridgeptr)
2047 continue; /* Not part of our bridge */
2049 if (bstp_addr_cmp(IF_LLADDR(ifp), llzero) == 0)
2050 continue; /* No mac address set */
2056 if (bstp_addr_cmp(IF_LLADDR(ifp), IF_LLADDR(mif)) < 0) {
2061 IFNET_RUNLOCK_NOSLEEP();
2065 e_addr = IF_LLADDR(mif);
2066 bs->bs_bridge_pv.pv_dbridge_id =
2067 (((uint64_t)bs->bs_bridge_priority) << 48) |
2068 (((uint64_t)e_addr[0]) << 40) |
2069 (((uint64_t)e_addr[1]) << 32) |
2070 (((uint64_t)e_addr[2]) << 24) |
2071 (((uint64_t)e_addr[3]) << 16) |
2072 (((uint64_t)e_addr[4]) << 8) |
2073 (((uint64_t)e_addr[5]));
2075 bs->bs_bridge_pv.pv_root_id = bs->bs_bridge_pv.pv_dbridge_id;
2076 bs->bs_bridge_pv.pv_cost = 0;
2077 bs->bs_bridge_pv.pv_dport_id = 0;
2078 bs->bs_bridge_pv.pv_port_id = 0;
2080 if (bs->bs_running && callout_pending(&bs->bs_bstpcallout) == 0)
2081 callout_reset(&bs->bs_bstpcallout, hz, bstp_tick, bs);
2083 LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
2084 bp->bp_port_id = (bp->bp_priority << 8) |
2085 (bp->bp_ifp->if_index & 0xfff);
2086 taskqueue_enqueue(taskqueue_swi, &bp->bp_mediatask);
2089 bstp_assign_roles(bs);
2090 bstp_timer_start(&bs->bs_link_timer, BSTP_LINK_TIMER);
2094 /* Set the bridge and root id (lower bits) to zero */
2095 bs->bs_bridge_pv.pv_dbridge_id =
2096 ((uint64_t)bs->bs_bridge_priority) << 48;
2097 bs->bs_bridge_pv.pv_root_id = bs->bs_bridge_pv.pv_dbridge_id;
2098 bs->bs_root_pv = bs->bs_bridge_pv;
2099 /* Disable any remaining ports, they will have no MAC address */
2100 LIST_FOREACH(bp, &bs->bs_bplist, bp_next) {
2101 bp->bp_infois = BSTP_INFO_DISABLED;
2102 bstp_set_port_role(bp, BSTP_ROLE_DISABLED);
2104 callout_stop(&bs->bs_bstpcallout);
2108 bstp_modevent(module_t mod, int type, void *data)
2112 mtx_init(&bstp_list_mtx, "bridgestp list", NULL, MTX_DEF);
2113 LIST_INIT(&bstp_list);
2116 mtx_destroy(&bstp_list_mtx);
2119 return (EOPNOTSUPP);
2124 static moduledata_t bstp_mod = {
2130 DECLARE_MODULE(bridgestp, bstp_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
2131 MODULE_VERSION(bridgestp, 1);
2134 bstp_attach(struct bstp_state *bs, struct bstp_cb_ops *cb)
2137 callout_init_mtx(&bs->bs_bstpcallout, &bs->bs_mtx, 0);
2138 LIST_INIT(&bs->bs_bplist);
2140 bs->bs_bridge_max_age = BSTP_DEFAULT_MAX_AGE;
2141 bs->bs_bridge_htime = BSTP_DEFAULT_HELLO_TIME;
2142 bs->bs_bridge_fdelay = BSTP_DEFAULT_FORWARD_DELAY;
2143 bs->bs_bridge_priority = BSTP_DEFAULT_BRIDGE_PRIORITY;
2144 bs->bs_hold_time = BSTP_DEFAULT_HOLD_TIME;
2145 bs->bs_migration_delay = BSTP_DEFAULT_MIGRATE_DELAY;
2146 bs->bs_txholdcount = BSTP_DEFAULT_HOLD_COUNT;
2147 bs->bs_protover = BSTP_PROTO_RSTP;
2148 bs->bs_state_cb = cb->bcb_state;
2149 bs->bs_rtage_cb = cb->bcb_rtage;
2150 bs->bs_vnet = curvnet;
2152 getmicrotime(&bs->bs_last_tc_time);
2154 mtx_lock(&bstp_list_mtx);
2155 LIST_INSERT_HEAD(&bstp_list, bs, bs_list);
2156 mtx_unlock(&bstp_list_mtx);
2160 bstp_detach(struct bstp_state *bs)
2162 KASSERT(LIST_EMPTY(&bs->bs_bplist), ("bstp still active"));
2164 mtx_lock(&bstp_list_mtx);
2165 LIST_REMOVE(bs, bs_list);
2166 mtx_unlock(&bstp_list_mtx);
2167 callout_drain(&bs->bs_bstpcallout);
2168 BSTP_LOCK_DESTROY(bs);
2172 bstp_init(struct bstp_state *bs)
2175 callout_reset(&bs->bs_bstpcallout, hz, bstp_tick, bs);
2182 bstp_stop(struct bstp_state *bs)
2184 struct bstp_port *bp;
2188 LIST_FOREACH(bp, &bs->bs_bplist, bp_next)
2189 bstp_set_port_state(bp, BSTP_IFSTATE_DISCARDING);
2192 callout_stop(&bs->bs_bstpcallout);
2197 bstp_create(struct bstp_state *bs, struct bstp_port *bp, struct ifnet *ifp)
2199 bzero(bp, sizeof(struct bstp_port));
2204 bp->bp_priority = BSTP_DEFAULT_PORT_PRIORITY;
2205 TASK_INIT(&bp->bp_statetask, 0, bstp_notify_state, bp);
2206 TASK_INIT(&bp->bp_rtagetask, 0, bstp_notify_rtage, bp);
2207 TASK_INIT(&bp->bp_mediatask, 0, bstp_ifupdstatus, bp);
2210 bp->bp_infois = BSTP_INFO_DISABLED;
2211 bp->bp_flags = BSTP_PORT_AUTOEDGE|BSTP_PORT_AUTOPTP;
2212 bstp_set_port_state(bp, BSTP_IFSTATE_DISCARDING);
2213 bstp_set_port_proto(bp, bs->bs_protover);
2214 bstp_set_port_role(bp, BSTP_ROLE_DISABLED);
2215 bstp_set_port_tc(bp, BSTP_TCSTATE_INACTIVE);
2216 bp->bp_path_cost = bstp_calc_path_cost(bp);
2222 bstp_enable(struct bstp_port *bp)
2224 struct bstp_state *bs = bp->bp_bs;
2225 struct ifnet *ifp = bp->bp_ifp;
2227 KASSERT(bp->bp_active == 0, ("already a bstp member"));
2229 switch (ifp->if_type) {
2230 case IFT_ETHER: /* These can do spanning tree. */
2233 /* Nothing else can. */
2238 LIST_INSERT_HEAD(&bs->bs_bplist, bp, bp_next);
2240 bp->bp_flags |= BSTP_PORT_NEWINFO;
2242 bstp_update_roles(bs, bp);
2248 bstp_disable(struct bstp_port *bp)
2250 struct bstp_state *bs = bp->bp_bs;
2252 KASSERT(bp->bp_active == 1, ("not a bstp member"));
2255 bstp_disable_port(bs, bp);
2256 LIST_REMOVE(bp, bp_next);
2263 * The bstp_port structure is about to be freed by the parent bridge.
2266 bstp_destroy(struct bstp_port *bp)
2268 KASSERT(bp->bp_active == 0, ("port is still attached"));
2269 taskqueue_drain(taskqueue_swi, &bp->bp_statetask);
2270 taskqueue_drain(taskqueue_swi, &bp->bp_rtagetask);
2271 taskqueue_drain(taskqueue_swi, &bp->bp_mediatask);