X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/b7266188b87f3620ec3f9f717e57194a7dd989fe..a39ff7e25e19b3a8c3020042a3872ca9ec9659f1:/bsd/net/bridgestp.c diff --git a/bsd/net/bridgestp.c b/bsd/net/bridgestp.c index 1c895828e..972a1ae14 100644 --- a/bsd/net/bridgestp.c +++ b/bsd/net/bridgestp.c @@ -1,5 +1,7 @@ +/* $NetBSD: bridgestp.c,v 1.5 2003/11/28 08:56:48 keihan Exp $ */ + /* - * Copyright (c) 2007-2009 Apple Inc. All rights reserved. + * Copyright (c) 2009-2012 Apple Inc. All rights reserved. * * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ * @@ -26,11 +28,9 @@ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ */ -/* $fpwf: Revision 1.2 2007/05/17 03:38:46 rnewberry Exp $ */ -/* $NetBSD: bridgestp.c,v 1.10 2006/11/16 01:33:40 christos Exp $ */ - /* * Copyright (c) 2000 Jason L. Wright (jason@thought.net) + * Copyright (c) 2006 Andrew Thompson (thompsa@FreeBSD.org) * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -41,11 +41,6 @@ * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. - * 3. All advertising materials mentioning features or use of this software - * must display the following acknowledgement: - * This product includes software developed by Jason L. Wright - * 4. The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED @@ -64,332 +59,244 @@ /* * Implementation of the spanning tree protocol as defined in - * ISO/IEC Final DIS 15802-3 (IEEE P802.1D/D17), May 25, 1998. - * (In English: IEEE 802.1D, Draft 17, 1998) + * ISO/IEC 802.1D-2004, June 9, 2004. */ -/* $NetBSD: if_bridgevar.h,v 1.8 2005/12/10 23:21:38 elad Exp $ */ - #include +//__FBSDID("$FreeBSD$"); #include #include #include #include -#include +#include #include -#include +//#include +//#include +#include +#include +//#include +//#include #include #include #include #include - -#include -#include #include #include -/* BPDU message types */ -#define BSTP_MSGTYPE_CFG 0x00 /* Configuration */ -#define BSTP_MSGTYPE_TCN 0x80 /* Topology chg notification */ - -/* BPDU flags */ -#define BSTP_FLAG_TC 0x01 /* Topology change */ -#define BSTP_FLAG_TCA 0x80 /* Topology change ack */ - -#define BSTP_MESSAGE_AGE_INCR (1 * 256) /* in 256ths of a second */ -#define BSTP_TICK_VAL (1 * 256) /* in 256ths of a second */ - -/* - * Because BPDU's do not make nicely aligned structures, two different - * declarations are used: bstp_?bpdu (wire representation, packed) and - * bstp_*_unit (internal, nicely aligned version). - */ - -/* configuration bridge protocol data unit */ -struct bstp_cbpdu { - uint8_t cbu_dsap; /* LLC: destination sap */ - uint8_t cbu_ssap; /* LLC: source sap */ - uint8_t cbu_ctl; /* LLC: control */ - uint16_t cbu_protoid; /* protocol id */ - uint8_t cbu_protover; /* protocol version */ - uint8_t cbu_bpdutype; /* message type */ - uint8_t cbu_flags; /* flags (below) */ - - /* root id */ - uint16_t cbu_rootpri; /* root priority */ - uint8_t cbu_rootaddr[6]; /* root address */ - - uint32_t cbu_rootpathcost; /* root path cost */ - - /* bridge id */ - uint16_t cbu_bridgepri; /* bridge priority */ - uint8_t cbu_bridgeaddr[6]; /* bridge address */ - - uint16_t cbu_portid; /* port id */ - uint16_t cbu_messageage; /* current message age */ - uint16_t cbu_maxage; /* maximum age */ - uint16_t cbu_hellotime; /* hello time */ - uint16_t cbu_forwarddelay; /* forwarding delay */ -} __attribute__((__packed__)); - -/* topology change notification bridge protocol data unit */ -struct bstp_tbpdu { - uint8_t tbu_dsap; /* LLC: destination sap */ - uint8_t tbu_ssap; /* LLC: source sap */ - uint8_t tbu_ctl; /* LLC: control */ - uint16_t tbu_protoid; /* protocol id */ - uint8_t tbu_protover; /* protocol version */ - uint8_t tbu_bpdutype; /* message type */ -} __attribute__((__packed__)); - -const uint8_t bstp_etheraddr[] = { 0x01, 0x80, 0xc2, 0x00, 0x00, 0x00 }; - -void bstp_initialize_port(struct bridge_softc *, struct bridge_iflist *); -void bstp_ifupdstatus(struct bridge_softc *, struct bridge_iflist *); -void bstp_enable_port(struct bridge_softc *, struct bridge_iflist *); -void bstp_disable_port(struct bridge_softc *, struct bridge_iflist *); -void bstp_enable_change_detection(struct bridge_iflist *); -void bstp_disable_change_detection(struct bridge_iflist *); -int bstp_root_bridge(struct bridge_softc *sc); -int bstp_supersedes_port_info(struct bridge_softc *, - struct bridge_iflist *, struct bstp_config_unit *); -int bstp_designated_port(struct bridge_softc *, struct bridge_iflist *); -int bstp_designated_for_some_port(struct bridge_softc *); -void bstp_transmit_config(struct bridge_softc *, struct bridge_iflist *); -void bstp_transmit_tcn(struct bridge_softc *); -void bstp_received_config_bpdu(struct bridge_softc *, - struct bridge_iflist *, struct bstp_config_unit *); -void bstp_received_tcn_bpdu(struct bridge_softc *, struct bridge_iflist *, - struct bstp_tcn_unit *); -void bstp_record_config_information(struct bridge_softc *, - struct bridge_iflist *, struct bstp_config_unit *); -void bstp_record_config_timeout_values(struct bridge_softc *, - struct bstp_config_unit *); -void bstp_config_bpdu_generation(struct bridge_softc *); -void bstp_send_config_bpdu(struct bridge_softc *, struct bridge_iflist *, - struct bstp_config_unit *); -void bstp_configuration_update(struct bridge_softc *); -void bstp_root_selection(struct bridge_softc *); -void bstp_designated_port_selection(struct bridge_softc *); -void bstp_become_designated_port(struct bridge_softc *, - struct bridge_iflist *); -void bstp_port_state_selection(struct bridge_softc *); -void bstp_make_forwarding(struct bridge_softc *, struct bridge_iflist *); -void bstp_make_blocking(struct bridge_softc *, struct bridge_iflist *); -void bstp_set_port_state(struct bridge_iflist *, uint8_t); -void bstp_set_bridge_priority(struct bridge_softc *, uint64_t); -void bstp_set_port_priority(struct bridge_softc *, struct bridge_iflist *, - uint16_t); -void bstp_set_path_cost(struct bridge_softc *, struct bridge_iflist *, - uint32_t); -void bstp_topology_change_detection(struct bridge_softc *); -void bstp_topology_change_acknowledged(struct bridge_softc *); -void bstp_acknowledge_topology_change(struct bridge_softc *, - struct bridge_iflist *); - -void bstp_tick(void *); -void bstp_timer_start(struct bridge_timer *, uint16_t); -void bstp_timer_stop(struct bridge_timer *); -int bstp_timer_expired(struct bridge_timer *, uint16_t); - -void bstp_hold_timer_expiry(struct bridge_softc *, struct bridge_iflist *); -void bstp_message_age_timer_expiry(struct bridge_softc *, - struct bridge_iflist *); -void bstp_forward_delay_timer_expiry(struct bridge_softc *, - struct bridge_iflist *); -void bstp_topology_change_timer_expiry(struct bridge_softc *); -void bstp_tcn_timer_expiry(struct bridge_softc *); -void bstp_hello_timer_expiry(struct bridge_softc *); - -void -bstp_transmit_config(struct bridge_softc *sc, struct bridge_iflist *bif) +#include +#include +#include +#include +#include + +#include + +decl_lck_mtx_data(static, bstp_task_mtx_data); +static lck_mtx_t *bstp_task_mtx = &bstp_task_mtx_data; +static lck_grp_t *bstp_task_grp = NULL; +static lck_attr_t *bstp_task_attr = NULL; +static thread_t bstp_task_thread; +static TAILQ_HEAD(bstp_task_queue, bstp_task) + bstp_task_queue = TAILQ_HEAD_INITIALIZER(bstp_task_queue); +static struct bstp_task *bstp_task_queue_running = NULL; + +static void bstp_create_task_thread(void); +static void bstp_task_thread_func(void); + +static void bstp_task_enqueue(struct bstp_task *); +static void bstp_task_drain(struct bstp_task *); + +#define BSTP_TASK_INIT(bt, func, context) do { \ + (bt)->bt_count = 0; \ + (bt)->bt_func = func; \ + (bt)->bt_context = context; \ +} while(0) + + + +#define BSTP_LOCK_INIT(_bs) (_bs)->bs_mtx = lck_mtx_alloc_init(bstp_lock_grp, bstp_lock_attr) +#define BSTP_LOCK_DESTROY(_bs) lck_mtx_free((_bs)->bs_mtx, bstp_lock_grp) +#define BSTP_LOCK(_bs) lck_mtx_lock((_bs)->bs_mtx) +#define BSTP_UNLOCK(_bs) lck_mtx_unlock((_bs)->bs_mtx) +#define BSTP_LOCK_ASSERT(_bs) LCK_MTX_ASSERT((_bs)->bs_mtx, LCK_MTX_ASSERT_OWNED) + + +#ifdef BRIDGESTP_DEBUG +#define DPRINTF(fmt, arg...) printf("bstp: " fmt, ##arg) +#else +#define DPRINTF(fmt, arg...) +#endif + +#define PV2ADDR(pv, eaddr) do { \ + eaddr[0] = pv >> 40; \ + eaddr[1] = pv >> 32; \ + eaddr[2] = pv >> 24; \ + eaddr[3] = pv >> 16; \ + eaddr[4] = pv >> 8; \ + eaddr[5] = pv >> 0; \ +} while (0) + +#define INFO_BETTER 1 +#define INFO_SAME 0 +#define INFO_WORSE -1 + +LIST_HEAD(, bstp_state) bstp_list; +decl_lck_mtx_data(static, bstp_list_mtx_data); +static lck_mtx_t *bstp_list_mtx = &bstp_list_mtx_data; +static lck_grp_t *bstp_lock_grp = NULL; +static lck_attr_t *bstp_lock_attr = NULL; + +static void bstp_transmit(struct bstp_state *, struct bstp_port *); +static void bstp_transmit_bpdu(struct bstp_state *, struct bstp_port *); +static void bstp_transmit_tcn(struct bstp_state *, struct bstp_port *); +static void bstp_decode_bpdu(struct bstp_port *, struct bstp_cbpdu *, + struct bstp_config_unit *); +static void bstp_send_bpdu(struct bstp_state *, struct bstp_port *, + struct bstp_cbpdu *); +static void bstp_enqueue(struct ifnet *, struct mbuf *); +static int bstp_pdu_flags(struct bstp_port *); +static void bstp_received_stp(struct bstp_state *, struct bstp_port *, + struct mbuf **, struct bstp_tbpdu *); +static void bstp_received_rstp(struct bstp_state *, struct bstp_port *, + struct mbuf **, struct bstp_tbpdu *); +static void bstp_received_tcn(struct bstp_state *, struct bstp_port *, + struct bstp_tcn_unit *); +static void bstp_received_bpdu(struct bstp_state *, struct bstp_port *, + struct bstp_config_unit *); +static int bstp_pdu_rcvtype(struct bstp_port *, struct bstp_config_unit *); +static int bstp_pdu_bettersame(struct bstp_port *, int); +static int bstp_info_cmp(struct bstp_pri_vector *, + struct bstp_pri_vector *); +static int bstp_info_superior(struct bstp_pri_vector *, + struct bstp_pri_vector *); +static void bstp_assign_roles(struct bstp_state *); +static void bstp_update_roles(struct bstp_state *, struct bstp_port *); +static void bstp_update_state(struct bstp_state *, struct bstp_port *); +static void bstp_update_tc(struct bstp_port *); +static void bstp_update_info(struct bstp_port *); +static void bstp_set_other_tcprop(struct bstp_port *); +static void bstp_set_all_reroot(struct bstp_state *); +static void bstp_set_all_sync(struct bstp_state *); +static void bstp_set_port_state(struct bstp_port *, int); +static void bstp_set_port_role(struct bstp_port *, int); +static void bstp_set_port_proto(struct bstp_port *, int); +static void bstp_set_port_tc(struct bstp_port *, int); +static void bstp_set_timer_tc(struct bstp_port *); +static void bstp_set_timer_msgage(struct bstp_port *); +static int bstp_rerooted(struct bstp_state *, struct bstp_port *); +static uint32_t bstp_calc_path_cost(struct bstp_port *); +static void bstp_notify_state(void *, int); +static void bstp_notify_rtage(void *, int); +static void bstp_ifupdstatus(struct bstp_state *, struct bstp_port *); +static void bstp_enable_port(struct bstp_state *, struct bstp_port *); +static void bstp_disable_port(struct bstp_state *, struct bstp_port *); +static void bstp_tick(void *); +static void bstp_timer_start(struct bstp_timer *, uint16_t); +static void bstp_timer_stop(struct bstp_timer *); +static void bstp_timer_latch(struct bstp_timer *); +static int bstp_timer_expired(struct bstp_timer *); +static void bstp_hello_timer_expiry(struct bstp_state *, + struct bstp_port *); +static void bstp_message_age_expiry(struct bstp_state *, + struct bstp_port *); +static void bstp_migrate_delay_expiry(struct bstp_state *, + struct bstp_port *); +static void bstp_edge_delay_expiry(struct bstp_state *, + struct bstp_port *); +static int bstp_addr_cmp(const uint8_t *, const uint8_t *); +static int bstp_same_bridgeid(uint64_t, uint64_t); +static void bstp_reinit(struct bstp_state *); + +static void +bstp_transmit(struct bstp_state *bs, struct bstp_port *bp) { - if (bif->bif_hold_timer.active) { - bif->bif_config_pending = 1; + if (bs->bs_running == 0) return; - } - - bif->bif_config_bpdu.cu_message_type = BSTP_MSGTYPE_CFG; - bif->bif_config_bpdu.cu_rootid = sc->sc_designated_root; - bif->bif_config_bpdu.cu_root_path_cost = sc->sc_root_path_cost; - bif->bif_config_bpdu.cu_bridge_id = sc->sc_bridge_id; - bif->bif_config_bpdu.cu_port_id = bif->bif_port_id; - - if (bstp_root_bridge(sc)) - bif->bif_config_bpdu.cu_message_age = 0; - else - bif->bif_config_bpdu.cu_message_age = - sc->sc_root_port->bif_message_age_timer.value + - BSTP_MESSAGE_AGE_INCR; - - bif->bif_config_bpdu.cu_max_age = sc->sc_max_age; - bif->bif_config_bpdu.cu_hello_time = sc->sc_hello_time; - bif->bif_config_bpdu.cu_forward_delay = sc->sc_forward_delay; - bif->bif_config_bpdu.cu_topology_change_acknowledgment - = bif->bif_topology_change_acknowledge; - bif->bif_config_bpdu.cu_topology_change = sc->sc_topology_change; - - if (bif->bif_config_bpdu.cu_message_age < sc->sc_max_age) { - bif->bif_topology_change_acknowledge = 0; - bif->bif_config_pending = 0; - bstp_send_config_bpdu(sc, bif, &bif->bif_config_bpdu); - bstp_timer_start(&bif->bif_hold_timer, 0); - } -} - -void -bstp_send_config_bpdu(struct bridge_softc *sc, struct bridge_iflist *bif, - struct bstp_config_unit *cu) -{ - struct ifnet *ifp; - struct mbuf *m; - struct ether_header *eh; - struct bstp_cbpdu bpdu; - ifp = bif->bif_ifp; - - if ((ifp->if_flags & IFF_RUNNING) == 0) + /* + * a PDU can only be sent if we have tx quota left and the + * hello timer is running. + */ + if (bp->bp_hello_timer.active == 0) { + /* Test if it needs to be reset */ + bstp_hello_timer_expiry(bs, bp); return; - - MGETHDR(m, M_DONTWAIT, MT_DATA); - if (m == NULL) + } + if (bp->bp_txcount > bs->bs_txholdcount) + /* Ran out of karma */ return; - eh = mtod(m, struct ether_header *); - - m->m_pkthdr.rcvif = ifp; - m->m_pkthdr.len = sizeof(*eh) + sizeof(bpdu); - m->m_len = m->m_pkthdr.len; - - bpdu.cbu_ssap = bpdu.cbu_dsap = LLC_8021D_LSAP; - bpdu.cbu_ctl = LLC_UI; - bpdu.cbu_protoid = htons(0); - bpdu.cbu_protover = 0; - bpdu.cbu_bpdutype = cu->cu_message_type; - bpdu.cbu_flags = (cu->cu_topology_change ? BSTP_FLAG_TC : 0) | - (cu->cu_topology_change_acknowledgment ? BSTP_FLAG_TCA : 0); - - bpdu.cbu_rootpri = htons(cu->cu_rootid >> 48); - bpdu.cbu_rootaddr[0] = cu->cu_rootid >> 40; - bpdu.cbu_rootaddr[1] = cu->cu_rootid >> 32; - bpdu.cbu_rootaddr[2] = cu->cu_rootid >> 24; - bpdu.cbu_rootaddr[3] = cu->cu_rootid >> 16; - bpdu.cbu_rootaddr[4] = cu->cu_rootid >> 8; - bpdu.cbu_rootaddr[5] = cu->cu_rootid >> 0; - - bpdu.cbu_rootpathcost = htonl(cu->cu_root_path_cost); - - bpdu.cbu_bridgepri = htons(cu->cu_rootid >> 48); - bpdu.cbu_bridgeaddr[0] = cu->cu_rootid >> 40; - bpdu.cbu_bridgeaddr[1] = cu->cu_rootid >> 32; - bpdu.cbu_bridgeaddr[2] = cu->cu_rootid >> 24; - bpdu.cbu_bridgeaddr[3] = cu->cu_rootid >> 16; - bpdu.cbu_bridgeaddr[4] = cu->cu_rootid >> 8; - bpdu.cbu_bridgeaddr[5] = cu->cu_rootid >> 0; - - bpdu.cbu_portid = htons(cu->cu_port_id); - bpdu.cbu_messageage = htons(cu->cu_message_age); - bpdu.cbu_maxage = htons(cu->cu_max_age); - bpdu.cbu_hellotime = htons(cu->cu_hello_time); - bpdu.cbu_forwarddelay = htons(cu->cu_forward_delay); - - memcpy(eh->ether_shost, ifnet_lladdr(ifp), ETHER_ADDR_LEN); - memcpy(eh->ether_dhost, bstp_etheraddr, ETHER_ADDR_LEN); - eh->ether_type = htons(sizeof(bpdu)); - - memcpy(mtod(m, caddr_t) + sizeof(*eh), &bpdu, sizeof(bpdu)); - - bridge_enqueue(sc, ifp, m); // APPLE MODIFICATION - no flags param + if (bp->bp_protover == BSTP_PROTO_RSTP) { + bstp_transmit_bpdu(bs, bp); + bp->bp_tc_ack = 0; + } else { /* STP */ + switch (bp->bp_role) { + case BSTP_ROLE_DESIGNATED: + bstp_transmit_bpdu(bs, bp); + bp->bp_tc_ack = 0; + break; + + case BSTP_ROLE_ROOT: + bstp_transmit_tcn(bs, bp); + break; + } + } + bstp_timer_start(&bp->bp_hello_timer, bp->bp_desg_htime); + bp->bp_flags &= ~BSTP_PORT_NEWINFO; } -int -bstp_root_bridge(struct bridge_softc *sc) +static void +bstp_transmit_bpdu(struct bstp_state *bs, struct bstp_port *bp) { - return (sc->sc_designated_root == sc->sc_bridge_id); -} + struct bstp_cbpdu bpdu; -int -bstp_supersedes_port_info(struct bridge_softc *sc, struct bridge_iflist *bif, - struct bstp_config_unit *cu) -{ - if (cu->cu_rootid < bif->bif_designated_root) - return (1); - if (cu->cu_rootid > bif->bif_designated_root) - return (0); + BSTP_LOCK_ASSERT(bs); - if (cu->cu_root_path_cost < bif->bif_designated_cost) - return (1); - if (cu->cu_root_path_cost > bif->bif_designated_cost) - return (0); + bpdu.cbu_rootpri = htons(bp->bp_desg_pv.pv_root_id >> 48); + PV2ADDR(bp->bp_desg_pv.pv_root_id, bpdu.cbu_rootaddr); - if (cu->cu_bridge_id < bif->bif_designated_bridge) - return (1); - if (cu->cu_bridge_id > bif->bif_designated_bridge) - return (0); + bpdu.cbu_rootpathcost = htonl(bp->bp_desg_pv.pv_cost); - if (sc->sc_bridge_id != cu->cu_bridge_id) - return (1); - if (cu->cu_port_id <= bif->bif_designated_port) - return (1); - return (0); -} + bpdu.cbu_bridgepri = htons(bp->bp_desg_pv.pv_dbridge_id >> 48); + PV2ADDR(bp->bp_desg_pv.pv_dbridge_id, bpdu.cbu_bridgeaddr); -void -bstp_record_config_information(__unused struct bridge_softc *sc, - struct bridge_iflist *bif, struct bstp_config_unit *cu) -{ - bif->bif_designated_root = cu->cu_rootid; - bif->bif_designated_cost = cu->cu_root_path_cost; - bif->bif_designated_bridge = cu->cu_bridge_id; - bif->bif_designated_port = cu->cu_port_id; - bstp_timer_start(&bif->bif_message_age_timer, cu->cu_message_age); -} + bpdu.cbu_portid = htons(bp->bp_port_id); + bpdu.cbu_messageage = htons(bp->bp_desg_msg_age); + bpdu.cbu_maxage = htons(bp->bp_desg_max_age); + bpdu.cbu_hellotime = htons(bp->bp_desg_htime); + bpdu.cbu_forwarddelay = htons(bp->bp_desg_fdelay); -void -bstp_record_config_timeout_values(struct bridge_softc *sc, - struct bstp_config_unit *config) -{ - sc->sc_max_age = config->cu_max_age; - sc->sc_hello_time = config->cu_hello_time; - sc->sc_forward_delay = config->cu_forward_delay; - sc->sc_topology_change = config->cu_topology_change; -} + bpdu.cbu_flags = bstp_pdu_flags(bp); -void -bstp_config_bpdu_generation(struct bridge_softc *sc) -{ - struct bridge_iflist *bif; + switch (bp->bp_protover) { + case BSTP_PROTO_STP: + bpdu.cbu_bpdutype = BSTP_MSGTYPE_CFG; + break; - LIST_FOREACH(bif, &sc->sc_iflist, bif_next) { - if ((bif->bif_flags & IFBIF_STP) == 0) - continue; - if (bstp_designated_port(sc, bif) && - (bif->bif_state != BSTP_IFSTATE_DISABLED)) - bstp_transmit_config(sc, bif); + case BSTP_PROTO_RSTP: + bpdu.cbu_bpdutype = BSTP_MSGTYPE_RSTP; + break; } -} -int -bstp_designated_port(struct bridge_softc *sc, struct bridge_iflist *bif) -{ - return ((bif->bif_designated_bridge == sc->sc_bridge_id) - && (bif->bif_designated_port == bif->bif_port_id)); + bstp_send_bpdu(bs, bp, &bpdu); } -void -bstp_transmit_tcn(struct bridge_softc *sc) +static void +bstp_transmit_tcn(struct bstp_state *bs, struct bstp_port *bp) { struct bstp_tbpdu bpdu; - struct bridge_iflist *bif = sc->sc_root_port; - struct ifnet *ifp; + struct ifnet *ifp = bp->bp_ifp; struct ether_header *eh; struct mbuf *m; + int touched = bs ? 1 : 0; + + touched++; + + KASSERT(bp == bs->bs_root_port, ("%s: bad root port\n", __func__)); - KASSERT(bif != NULL, "bstp_transmit_tcn bif NULL"); - ifp = bif->bif_ifp; if ((ifp->if_flags & IFF_RUNNING) == 0) return; @@ -403,7 +310,7 @@ bstp_transmit_tcn(struct bridge_softc *sc) eh = mtod(m, struct ether_header *); - memcpy(eh->ether_shost, ifnet_lladdr(ifp), ETHER_ADDR_LEN); + memcpy(eh->ether_shost, IF_LLADDR(ifp), ETHER_ADDR_LEN); memcpy(eh->ether_dhost, bstp_etheraddr, ETHER_ADDR_LEN); eh->ether_type = htons(sizeof(bpdu)); @@ -415,217 +322,228 @@ bstp_transmit_tcn(struct bridge_softc *sc) memcpy(mtod(m, caddr_t) + sizeof(*eh), &bpdu, sizeof(bpdu)); - bridge_enqueue(sc, ifp, m); // APPLE MODIFICATION - no flags param + bp->bp_txcount++; + bstp_enqueue(ifp, m); } -void -bstp_configuration_update(struct bridge_softc *sc) +static void +bstp_decode_bpdu(struct bstp_port *bp, struct bstp_cbpdu *cpdu, + struct bstp_config_unit *cu) { - bstp_root_selection(sc); - bstp_designated_port_selection(sc); + int flags; + + cu->cu_pv.pv_root_id = + (((uint64_t)ntohs(cpdu->cbu_rootpri)) << 48) | + (((uint64_t)cpdu->cbu_rootaddr[0]) << 40) | + (((uint64_t)cpdu->cbu_rootaddr[1]) << 32) | + (((uint64_t)cpdu->cbu_rootaddr[2]) << 24) | + (((uint64_t)cpdu->cbu_rootaddr[3]) << 16) | + (((uint64_t)cpdu->cbu_rootaddr[4]) << 8) | + (((uint64_t)cpdu->cbu_rootaddr[5]) << 0); + + cu->cu_pv.pv_dbridge_id = + (((uint64_t)ntohs(cpdu->cbu_bridgepri)) << 48) | + (((uint64_t)cpdu->cbu_bridgeaddr[0]) << 40) | + (((uint64_t)cpdu->cbu_bridgeaddr[1]) << 32) | + (((uint64_t)cpdu->cbu_bridgeaddr[2]) << 24) | + (((uint64_t)cpdu->cbu_bridgeaddr[3]) << 16) | + (((uint64_t)cpdu->cbu_bridgeaddr[4]) << 8) | + (((uint64_t)cpdu->cbu_bridgeaddr[5]) << 0); + + cu->cu_pv.pv_cost = ntohl(cpdu->cbu_rootpathcost); + cu->cu_message_age = ntohs(cpdu->cbu_messageage); + cu->cu_max_age = ntohs(cpdu->cbu_maxage); + cu->cu_hello_time = ntohs(cpdu->cbu_hellotime); + cu->cu_forward_delay = ntohs(cpdu->cbu_forwarddelay); + cu->cu_pv.pv_dport_id = ntohs(cpdu->cbu_portid); + cu->cu_pv.pv_port_id = bp->bp_port_id; + cu->cu_message_type = cpdu->cbu_bpdutype; + + /* Strip off unused flags in STP mode */ + flags = cpdu->cbu_flags; + switch (cpdu->cbu_protover) { + case BSTP_PROTO_STP: + flags &= BSTP_PDU_STPMASK; + /* A STP BPDU explicitly conveys a Designated Port */ + cu->cu_role = BSTP_ROLE_DESIGNATED; + break; + + case BSTP_PROTO_RSTP: + flags &= BSTP_PDU_RSTPMASK; + break; + } + + cu->cu_topology_change_ack = + (flags & BSTP_PDU_F_TCA) ? 1 : 0; + cu->cu_proposal = + (flags & BSTP_PDU_F_P) ? 1 : 0; + cu->cu_agree = + (flags & BSTP_PDU_F_A) ? 1 : 0; + cu->cu_learning = + (flags & BSTP_PDU_F_L) ? 1 : 0; + cu->cu_forwarding = + (flags & BSTP_PDU_F_F) ? 1 : 0; + cu->cu_topology_change = + (flags & BSTP_PDU_F_TC) ? 1 : 0; + + switch ((flags & BSTP_PDU_PRMASK) >> BSTP_PDU_PRSHIFT) { + case BSTP_PDU_F_ROOT: + cu->cu_role = BSTP_ROLE_ROOT; + break; + case BSTP_PDU_F_ALT: + cu->cu_role = BSTP_ROLE_ALTERNATE; + break; + case BSTP_PDU_F_DESG: + cu->cu_role = BSTP_ROLE_DESIGNATED; + break; + } } -void -bstp_root_selection(struct bridge_softc *sc) +static void +bstp_send_bpdu(struct bstp_state *bs, struct bstp_port *bp, + struct bstp_cbpdu *bpdu) { - struct bridge_iflist *root_port = NULL, *bif; - - LIST_FOREACH(bif, &sc->sc_iflist, bif_next) { - if ((bif->bif_flags & IFBIF_STP) == 0) - continue; - if (bstp_designated_port(sc, bif)) - continue; - if (bif->bif_state == BSTP_IFSTATE_DISABLED) - continue; - if (bif->bif_designated_root >= sc->sc_bridge_id) - continue; - if (root_port == NULL) - goto set_port; + struct ifnet *ifp; + struct mbuf *m; + struct ether_header *eh; - if (bif->bif_designated_root < root_port->bif_designated_root) - goto set_port; - if (bif->bif_designated_root > root_port->bif_designated_root) - continue; + BSTP_LOCK_ASSERT(bs); - if ((bif->bif_designated_cost + bif->bif_path_cost) < - (root_port->bif_designated_cost + root_port->bif_path_cost)) - goto set_port; - if ((bif->bif_designated_cost + bif->bif_path_cost) > - (root_port->bif_designated_cost + root_port->bif_path_cost)) - continue; + ifp = bp->bp_ifp; - if (bif->bif_designated_bridge < - root_port->bif_designated_bridge) - goto set_port; - if (bif->bif_designated_bridge > - root_port->bif_designated_bridge) - continue; + if ((ifp->if_flags & IFF_RUNNING) == 0) + return; - if (bif->bif_designated_port < root_port->bif_designated_port) - goto set_port; - if (bif->bif_designated_port > root_port->bif_designated_port) - continue; + MGETHDR(m, M_DONTWAIT, MT_DATA); + if (m == NULL) + return; - if (bif->bif_port_id >= root_port->bif_port_id) - continue; -set_port: - root_port = bif; - } + eh = mtod(m, struct ether_header *); - sc->sc_root_port = root_port; - if (root_port == NULL) { - sc->sc_designated_root = sc->sc_bridge_id; - sc->sc_root_path_cost = 0; - } else { - sc->sc_designated_root = root_port->bif_designated_root; - sc->sc_root_path_cost = root_port->bif_designated_cost + - root_port->bif_path_cost; - } -} + bpdu->cbu_ssap = bpdu->cbu_dsap = LLC_8021D_LSAP; + bpdu->cbu_ctl = LLC_UI; + bpdu->cbu_protoid = htons(BSTP_PROTO_ID); -void -bstp_designated_port_selection(struct bridge_softc *sc) -{ - struct bridge_iflist *bif; + memcpy(eh->ether_shost, IF_LLADDR(ifp), ETHER_ADDR_LEN); + memcpy(eh->ether_dhost, bstp_etheraddr, ETHER_ADDR_LEN); - LIST_FOREACH(bif, &sc->sc_iflist, bif_next) { - if ((bif->bif_flags & IFBIF_STP) == 0) - continue; - if (bstp_designated_port(sc, bif)) - goto designated; - if (bif->bif_designated_root != sc->sc_designated_root) - goto designated; - - if (sc->sc_root_path_cost < bif->bif_designated_cost) - goto designated; - if (sc->sc_root_path_cost > bif->bif_designated_cost) - continue; + switch (bpdu->cbu_bpdutype) { + case BSTP_MSGTYPE_CFG: + bpdu->cbu_protover = BSTP_PROTO_STP; + m->m_pkthdr.len = sizeof(*eh) + BSTP_BPDU_STP_LEN; + eh->ether_type = htons(BSTP_BPDU_STP_LEN); + memcpy(mtod(m, caddr_t) + sizeof(*eh), bpdu, + BSTP_BPDU_STP_LEN); + break; - if (sc->sc_bridge_id < bif->bif_designated_bridge) - goto designated; - if (sc->sc_bridge_id > bif->bif_designated_bridge) - continue; + case BSTP_MSGTYPE_RSTP: + bpdu->cbu_protover = BSTP_PROTO_RSTP; + bpdu->cbu_versionlen = htons(0); + m->m_pkthdr.len = sizeof(*eh) + BSTP_BPDU_RSTP_LEN; + eh->ether_type = htons(BSTP_BPDU_RSTP_LEN); + memcpy(mtod(m, caddr_t) + sizeof(*eh), bpdu, + BSTP_BPDU_RSTP_LEN); + break; - if (bif->bif_port_id > bif->bif_designated_port) - continue; -designated: - bstp_become_designated_port(sc, bif); + default: + panic("not implemented"); } -} + m->m_pkthdr.rcvif = ifp; + m->m_len = m->m_pkthdr.len; -void -bstp_become_designated_port(struct bridge_softc *sc, struct bridge_iflist *bif) -{ - bif->bif_designated_root = sc->sc_designated_root; - bif->bif_designated_cost = sc->sc_root_path_cost; - bif->bif_designated_bridge = sc->sc_bridge_id; - bif->bif_designated_port = bif->bif_port_id; + bp->bp_txcount++; + bstp_enqueue(ifp, m); } -void -bstp_port_state_selection(struct bridge_softc *sc) +static void +bstp_enqueue(struct ifnet *dst_ifp, struct mbuf *m) { - struct bridge_iflist *bif; - - LIST_FOREACH(bif, &sc->sc_iflist, bif_next) { - if ((bif->bif_flags & IFBIF_STP) == 0) - continue; - if (bif == sc->sc_root_port) { - bif->bif_config_pending = 0; - bif->bif_topology_change_acknowledge = 0; - bstp_make_forwarding(sc, bif); - } else if (bstp_designated_port(sc, bif)) { - bstp_timer_stop(&bif->bif_message_age_timer); - bstp_make_forwarding(sc, bif); - } else { - bif->bif_config_pending = 0; - bif->bif_topology_change_acknowledge = 0; - bstp_make_blocking(sc, bif); - } + errno_t error = 0; + u_int32_t len = m->m_pkthdr.len; + + m->m_flags |= M_PROTO1; //set to avoid loops + + error = ifnet_output_raw(dst_ifp, 0, m); + if (error == 0) { + (void) ifnet_stat_increment_out(dst_ifp, 1, len, 0); + } else { + (void) ifnet_stat_increment_out(dst_ifp, 0, 0, 1); } } -void -bstp_make_forwarding(__unused struct bridge_softc *sc, - struct bridge_iflist *bif) +static int +bstp_pdu_flags(struct bstp_port *bp) { - if (bif->bif_state == BSTP_IFSTATE_BLOCKING) { - bstp_set_port_state(bif, BSTP_IFSTATE_LISTENING); - bstp_timer_start(&bif->bif_forward_delay_timer, 0); - } -} + int flags = 0; -void -bstp_make_blocking(struct bridge_softc *sc, struct bridge_iflist *bif) -{ - if ((bif->bif_state != BSTP_IFSTATE_DISABLED) && - (bif->bif_state != BSTP_IFSTATE_BLOCKING)) { - if ((bif->bif_state == BSTP_IFSTATE_FORWARDING) || - (bif->bif_state == BSTP_IFSTATE_LEARNING)) { - if (bif->bif_change_detection_enabled) { - bstp_topology_change_detection(sc); - } - } - bstp_set_port_state(bif, BSTP_IFSTATE_BLOCKING); - bstp_timer_stop(&bif->bif_forward_delay_timer); - } -} + if (bp->bp_proposing && bp->bp_state != BSTP_IFSTATE_FORWARDING) + flags |= BSTP_PDU_F_P; -void -bstp_set_port_state(struct bridge_iflist *bif, uint8_t state) -{ - bif->bif_state = state; -} + if (bp->bp_agree) + flags |= BSTP_PDU_F_A; -void -bstp_topology_change_detection(struct bridge_softc *sc) -{ - if (bstp_root_bridge(sc)) { - sc->sc_topology_change = 1; - bstp_timer_start(&sc->sc_topology_change_timer, 0); - } else if (!sc->sc_topology_change_detected) { - bstp_transmit_tcn(sc); - bstp_timer_start(&sc->sc_tcn_timer, 0); + if (bp->bp_tc_timer.active) + flags |= BSTP_PDU_F_TC; + + if (bp->bp_tc_ack) + flags |= BSTP_PDU_F_TCA; + + switch (bp->bp_state) { + case BSTP_IFSTATE_LEARNING: + flags |= BSTP_PDU_F_L; + break; + + case BSTP_IFSTATE_FORWARDING: + flags |= (BSTP_PDU_F_L | BSTP_PDU_F_F); + break; } - sc->sc_topology_change_detected = 1; -} -void -bstp_topology_change_acknowledged(struct bridge_softc *sc) -{ - sc->sc_topology_change_detected = 0; - bstp_timer_stop(&sc->sc_tcn_timer); -} + switch (bp->bp_role) { + case BSTP_ROLE_ROOT: + flags |= + (BSTP_PDU_F_ROOT << BSTP_PDU_PRSHIFT); + break; -void -bstp_acknowledge_topology_change(struct bridge_softc *sc, - struct bridge_iflist *bif) -{ - bif->bif_topology_change_acknowledge = 1; - bstp_transmit_config(sc, bif); + case BSTP_ROLE_ALTERNATE: + case BSTP_ROLE_BACKUP: /* fall through */ + flags |= + (BSTP_PDU_F_ALT << BSTP_PDU_PRSHIFT); + break; + + case BSTP_ROLE_DESIGNATED: + flags |= + (BSTP_PDU_F_DESG << BSTP_PDU_PRSHIFT); + break; + } + + /* Strip off unused flags in either mode */ + switch (bp->bp_protover) { + case BSTP_PROTO_STP: + flags &= BSTP_PDU_STPMASK; + break; + case BSTP_PROTO_RSTP: + flags &= BSTP_PDU_RSTPMASK; + break; + } + return (flags); } -__private_extern__ struct mbuf * -bstp_input(struct bridge_softc *sc, struct ifnet *ifp, struct mbuf *m) +struct mbuf * +bstp_input(struct bstp_port *bp, __unused struct ifnet *ifp, struct mbuf *m) { - struct bridge_iflist *bif = NULL; + struct bstp_state *bs = bp->bp_bs; struct ether_header *eh; struct bstp_tbpdu tpdu; - struct bstp_cbpdu cpdu; - struct bstp_config_unit cu; - struct bstp_tcn_unit tu; uint16_t len; - eh = mtod(m, struct ether_header *); - - LIST_FOREACH(bif, &sc->sc_iflist, bif_next) { - if ((bif->bif_flags & IFBIF_STP) == 0) - continue; - if (bif->bif_ifp == ifp) - break; + if (bp->bp_active == 0) { + m_freem(m); + return (NULL); } - if (bif == NULL) - goto out; + + BSTP_LOCK(bs); + + eh = mtod(m, struct ether_header *); len = ntohs(eh->ether_type); if (len < sizeof(tpdu)) @@ -635,519 +553,1873 @@ bstp_input(struct bridge_softc *sc, struct ifnet *ifp, struct mbuf *m) if (m->m_pkthdr.len > len) m_adj(m, len - m->m_pkthdr.len); - if ((size_t)m->m_len < sizeof(tpdu) && + if ((unsigned int)m->m_len < sizeof(tpdu) && (m = m_pullup(m, sizeof(tpdu))) == NULL) goto out; memcpy(&tpdu, mtod(m, caddr_t), sizeof(tpdu)); + /* basic packet checks */ if (tpdu.tbu_dsap != LLC_8021D_LSAP || tpdu.tbu_ssap != LLC_8021D_LSAP || tpdu.tbu_ctl != LLC_UI) goto out; - if (tpdu.tbu_protoid != 0 || tpdu.tbu_protover != 0) + if (tpdu.tbu_protoid != BSTP_PROTO_ID) goto out; - switch (tpdu.tbu_bpdutype) { - case BSTP_MSGTYPE_TCN: - tu.tu_message_type = tpdu.tbu_bpdutype; - bstp_received_tcn_bpdu(sc, bif, &tu); - break; - case BSTP_MSGTYPE_CFG: - if ((size_t)m->m_len < sizeof(cpdu) && - (m = m_pullup(m, sizeof(cpdu))) == NULL) + /* + * We can treat later versions of the PDU as the same as the maximum + * version we implement. All additional parameters/flags are ignored. + */ + if (tpdu.tbu_protover > BSTP_PROTO_MAX) + tpdu.tbu_protover = BSTP_PROTO_MAX; + + if (tpdu.tbu_protover != bp->bp_protover) { + /* + * Wait for the migration delay timer to expire before changing + * protocol version to avoid flip-flops. + */ + if (bp->bp_flags & BSTP_PORT_CANMIGRATE) + bstp_set_port_proto(bp, tpdu.tbu_protover); + else goto out; - memcpy(&cpdu, mtod(m, caddr_t), sizeof(cpdu)); - - cu.cu_rootid = - (((uint64_t)ntohs(cpdu.cbu_rootpri)) << 48) | - (((uint64_t)cpdu.cbu_rootaddr[0]) << 40) | - (((uint64_t)cpdu.cbu_rootaddr[1]) << 32) | - (((uint64_t)cpdu.cbu_rootaddr[2]) << 24) | - (((uint64_t)cpdu.cbu_rootaddr[3]) << 16) | - (((uint64_t)cpdu.cbu_rootaddr[4]) << 8) | - (((uint64_t)cpdu.cbu_rootaddr[5]) << 0); - - cu.cu_bridge_id = - (((uint64_t)ntohs(cpdu.cbu_bridgepri)) << 48) | - (((uint64_t)cpdu.cbu_bridgeaddr[0]) << 40) | - (((uint64_t)cpdu.cbu_bridgeaddr[1]) << 32) | - (((uint64_t)cpdu.cbu_bridgeaddr[2]) << 24) | - (((uint64_t)cpdu.cbu_bridgeaddr[3]) << 16) | - (((uint64_t)cpdu.cbu_bridgeaddr[4]) << 8) | - (((uint64_t)cpdu.cbu_bridgeaddr[5]) << 0); - - cu.cu_root_path_cost = ntohl(cpdu.cbu_rootpathcost); - cu.cu_message_age = ntohs(cpdu.cbu_messageage); - cu.cu_max_age = ntohs(cpdu.cbu_maxage); - cu.cu_hello_time = ntohs(cpdu.cbu_hellotime); - cu.cu_forward_delay = ntohs(cpdu.cbu_forwarddelay); - cu.cu_port_id = ntohs(cpdu.cbu_portid); - cu.cu_message_type = cpdu.cbu_bpdutype; - cu.cu_topology_change_acknowledgment = - (cpdu.cbu_flags & BSTP_FLAG_TCA) ? 1 : 0; - cu.cu_topology_change = - (cpdu.cbu_flags & BSTP_FLAG_TC) ? 1 : 0; - bstp_received_config_bpdu(sc, bif, &cu); - break; - default: - goto out; } - out: + /* Clear operedge upon receiving a PDU on the port */ + bp->bp_operedge = 0; + bstp_timer_start(&bp->bp_edge_delay_timer, + BSTP_DEFAULT_MIGRATE_DELAY); + + switch (tpdu.tbu_protover) { + case BSTP_PROTO_STP: + bstp_received_stp(bs, bp, &m, &tpdu); + break; + + case BSTP_PROTO_RSTP: + bstp_received_rstp(bs, bp, &m, &tpdu); + break; + } +out: + BSTP_UNLOCK(bs); if (m) m_freem(m); return (NULL); } -void -bstp_received_config_bpdu(struct bridge_softc *sc, struct bridge_iflist *bif, - struct bstp_config_unit *cu) +static void +bstp_received_stp(struct bstp_state *bs, struct bstp_port *bp, + struct mbuf **mp, struct bstp_tbpdu *tpdu) { - int root; + struct bstp_cbpdu cpdu; + struct bstp_config_unit *cu = &bp->bp_msg_cu; + struct bstp_tcn_unit tu; - root = bstp_root_bridge(sc); + switch (tpdu->tbu_bpdutype) { + case BSTP_MSGTYPE_TCN: + tu.tu_message_type = tpdu->tbu_bpdutype; + bstp_received_tcn(bs, bp, &tu); + break; + case BSTP_MSGTYPE_CFG: + if ((*mp)->m_len < BSTP_BPDU_STP_LEN && + (*mp = m_pullup(*mp, BSTP_BPDU_STP_LEN)) == NULL) + return; + memcpy(&cpdu, mtod(*mp, caddr_t), BSTP_BPDU_STP_LEN); - if (bif->bif_state != BSTP_IFSTATE_DISABLED) { - if (bstp_supersedes_port_info(sc, bif, cu)) { - bstp_record_config_information(sc, bif, cu); - bstp_configuration_update(sc); - bstp_port_state_selection(sc); + bstp_decode_bpdu(bp, &cpdu, cu); + bstp_received_bpdu(bs, bp, cu); + break; + } +} - if ((bstp_root_bridge(sc) == 0) && root) { - bstp_timer_stop(&sc->sc_hello_timer); +static void +bstp_received_rstp(struct bstp_state *bs, struct bstp_port *bp, + struct mbuf **mp, struct bstp_tbpdu *tpdu) +{ + struct bstp_cbpdu cpdu; + struct bstp_config_unit *cu = &bp->bp_msg_cu; - if (sc->sc_topology_change_detected) { - bstp_timer_stop( - &sc->sc_topology_change_timer); - bstp_transmit_tcn(sc); - bstp_timer_start(&sc->sc_tcn_timer, 0); - } - } + if (tpdu->tbu_bpdutype != BSTP_MSGTYPE_RSTP) + return; - if (bif == sc->sc_root_port) { - bstp_record_config_timeout_values(sc, cu); - bstp_config_bpdu_generation(sc); + if ((*mp)->m_len < BSTP_BPDU_RSTP_LEN && + (*mp = m_pullup(*mp, BSTP_BPDU_RSTP_LEN)) == NULL) + return; + memcpy(&cpdu, mtod(*mp, caddr_t), BSTP_BPDU_RSTP_LEN); - if (cu->cu_topology_change_acknowledgment) - bstp_topology_change_acknowledged(sc); - } - } else if (bstp_designated_port(sc, bif)) - bstp_transmit_config(sc, bif); - } + bstp_decode_bpdu(bp, &cpdu, cu); + bstp_received_bpdu(bs, bp, cu); } -void -bstp_received_tcn_bpdu(struct bridge_softc *sc, struct bridge_iflist *bif, +static void +bstp_received_tcn(__unused struct bstp_state *bs, struct bstp_port *bp, __unused struct bstp_tcn_unit *tcn) { - if (bif->bif_state != BSTP_IFSTATE_DISABLED && - bstp_designated_port(sc, bif)) { - bstp_topology_change_detection(sc); - bstp_acknowledge_topology_change(sc, bif); - } + bp->bp_rcvdtcn = 1; + bstp_update_tc(bp); } -void -bstp_hello_timer_expiry(struct bridge_softc *sc) +static void +bstp_received_bpdu(struct bstp_state *bs, struct bstp_port *bp, + struct bstp_config_unit *cu) { - bstp_config_bpdu_generation(sc); - bstp_timer_start(&sc->sc_hello_timer, 0); -} + int type; -void -bstp_message_age_timer_expiry(struct bridge_softc *sc, - struct bridge_iflist *bif) -{ - int root; + BSTP_LOCK_ASSERT(bs); + + /* We need to have transitioned to INFO_MINE before proceeding */ + switch (bp->bp_infois) { + case BSTP_INFO_DISABLED: + case BSTP_INFO_AGED: + return; + } - root = bstp_root_bridge(sc); - bstp_become_designated_port(sc, bif); - bstp_configuration_update(sc); - bstp_port_state_selection(sc); + type = bstp_pdu_rcvtype(bp, cu); + + switch (type) { + case BSTP_PDU_SUPERIOR: + bs->bs_allsynced = 0; + bp->bp_agreed = 0; + bp->bp_proposing = 0; + + if (cu->cu_proposal && cu->cu_forwarding == 0) + bp->bp_proposed = 1; + if (cu->cu_topology_change) + bp->bp_rcvdtc = 1; + if (cu->cu_topology_change_ack) + bp->bp_rcvdtca = 1; + + if (bp->bp_agree && + !bstp_pdu_bettersame(bp, BSTP_INFO_RECEIVED)) + bp->bp_agree = 0; + + /* copy the received priority and timers to the port */ + bp->bp_port_pv = cu->cu_pv; + bp->bp_port_msg_age = cu->cu_message_age; + bp->bp_port_max_age = cu->cu_max_age; + bp->bp_port_fdelay = cu->cu_forward_delay; + bp->bp_port_htime = + (cu->cu_hello_time > BSTP_MIN_HELLO_TIME ? + cu->cu_hello_time : BSTP_MIN_HELLO_TIME); + + /* set expiry for the new info */ + bstp_set_timer_msgage(bp); + + bp->bp_infois = BSTP_INFO_RECEIVED; + bstp_assign_roles(bs); + break; - if ((bstp_root_bridge(sc)) && (root == 0)) { - sc->sc_max_age = sc->sc_bridge_max_age; - sc->sc_hello_time = sc->sc_bridge_hello_time; - sc->sc_forward_delay = sc->sc_bridge_forward_delay; + case BSTP_PDU_REPEATED: + if (cu->cu_proposal && cu->cu_forwarding == 0) + bp->bp_proposed = 1; + if (cu->cu_topology_change) + bp->bp_rcvdtc = 1; + if (cu->cu_topology_change_ack) + bp->bp_rcvdtca = 1; - bstp_topology_change_detection(sc); - bstp_timer_stop(&sc->sc_tcn_timer); - bstp_config_bpdu_generation(sc); - bstp_timer_start(&sc->sc_hello_timer, 0); - } -} + /* rearm the age timer */ + bstp_set_timer_msgage(bp); + break; -void -bstp_forward_delay_timer_expiry(struct bridge_softc *sc, - struct bridge_iflist *bif) -{ - if (bif->bif_state == BSTP_IFSTATE_LISTENING) { - bstp_set_port_state(bif, BSTP_IFSTATE_LEARNING); - bstp_timer_start(&bif->bif_forward_delay_timer, 0); - } else if (bif->bif_state == BSTP_IFSTATE_LEARNING) { - bstp_set_port_state(bif, BSTP_IFSTATE_FORWARDING); - if (bstp_designated_for_some_port(sc) && - bif->bif_change_detection_enabled) - bstp_topology_change_detection(sc); + case BSTP_PDU_INFERIOR: + if (cu->cu_learning) { + bp->bp_agreed = 1; + bp->bp_proposing = 0; + } + break; + + case BSTP_PDU_INFERIORALT: + /* + * only point to point links are allowed fast + * transitions to forwarding. + */ + if (cu->cu_agree && bp->bp_ptp_link) { + bp->bp_agreed = 1; + bp->bp_proposing = 0; + } else + bp->bp_agreed = 0; + + if (cu->cu_topology_change) + bp->bp_rcvdtc = 1; + if (cu->cu_topology_change_ack) + bp->bp_rcvdtca = 1; + break; + + case BSTP_PDU_OTHER: + return; /* do nothing */ } + /* update the state machines with the new data */ + bstp_update_state(bs, bp); } -int -bstp_designated_for_some_port(struct bridge_softc *sc) +static int +bstp_pdu_rcvtype(struct bstp_port *bp, struct bstp_config_unit *cu) { + int type; + + /* default return type */ + type = BSTP_PDU_OTHER; + + switch (cu->cu_role) { + case BSTP_ROLE_DESIGNATED: + if (bstp_info_superior(&bp->bp_port_pv, &cu->cu_pv)) + /* bpdu priority is superior */ + type = BSTP_PDU_SUPERIOR; + else if (bstp_info_cmp(&bp->bp_port_pv, &cu->cu_pv) == + INFO_SAME) { + if (bp->bp_port_msg_age != cu->cu_message_age || + bp->bp_port_max_age != cu->cu_max_age || + bp->bp_port_fdelay != cu->cu_forward_delay || + bp->bp_port_htime != cu->cu_hello_time) + /* bpdu priority is equal and timers differ */ + type = BSTP_PDU_SUPERIOR; + else + /* bpdu is equal */ + type = BSTP_PDU_REPEATED; + } else + /* bpdu priority is worse */ + type = BSTP_PDU_INFERIOR; - struct bridge_iflist *bif; + break; - LIST_FOREACH(bif, &sc->sc_iflist, bif_next) { - if ((bif->bif_flags & IFBIF_STP) == 0) - continue; - if (bif->bif_designated_bridge == sc->sc_bridge_id) - return (1); + case BSTP_ROLE_ROOT: + case BSTP_ROLE_ALTERNATE: + case BSTP_ROLE_BACKUP: + if (bstp_info_cmp(&bp->bp_port_pv, &cu->cu_pv) <= INFO_SAME) + /* + * not a designated port and priority is the same or + * worse + */ + type = BSTP_PDU_INFERIORALT; + break; } - return (0); + + return (type); } -void -bstp_tcn_timer_expiry(struct bridge_softc *sc) +static int +bstp_pdu_bettersame(struct bstp_port *bp, int newinfo) { - bstp_transmit_tcn(sc); - bstp_timer_start(&sc->sc_tcn_timer, 0); + if (newinfo == BSTP_INFO_RECEIVED && + bp->bp_infois == BSTP_INFO_RECEIVED && + bstp_info_cmp(&bp->bp_port_pv, &bp->bp_msg_cu.cu_pv) >= INFO_SAME) + return (1); + + if (newinfo == BSTP_INFO_MINE && + bp->bp_infois == BSTP_INFO_MINE && + bstp_info_cmp(&bp->bp_port_pv, &bp->bp_desg_pv) >= INFO_SAME) + return (1); + + return (0); } -void -bstp_topology_change_timer_expiry(struct bridge_softc *sc) +static int +bstp_info_cmp(struct bstp_pri_vector *pv, + struct bstp_pri_vector *cpv) { - sc->sc_topology_change_detected = 0; - sc->sc_topology_change = 0; + if (cpv->pv_root_id < pv->pv_root_id) + return (INFO_BETTER); + if (cpv->pv_root_id > pv->pv_root_id) + return (INFO_WORSE); + + if (cpv->pv_cost < pv->pv_cost) + return (INFO_BETTER); + if (cpv->pv_cost > pv->pv_cost) + return (INFO_WORSE); + + if (cpv->pv_dbridge_id < pv->pv_dbridge_id) + return (INFO_BETTER); + if (cpv->pv_dbridge_id > pv->pv_dbridge_id) + return (INFO_WORSE); + + if (cpv->pv_dport_id < pv->pv_dport_id) + return (INFO_BETTER); + if (cpv->pv_dport_id > pv->pv_dport_id) + return (INFO_WORSE); + + return (INFO_SAME); } -void -bstp_hold_timer_expiry(struct bridge_softc *sc, struct bridge_iflist *bif) +/* + * This message priority vector is superior to the port priority vector and + * will replace it if, and only if, the message priority vector is better than + * the port priority vector, or the message has been transmitted from the same + * designated bridge and designated port as the port priority vector. + */ +static int +bstp_info_superior(struct bstp_pri_vector *pv, + struct bstp_pri_vector *cpv) { - if (bif->bif_config_pending) - bstp_transmit_config(sc, bif); + if (bstp_info_cmp(pv, cpv) == INFO_BETTER || + (bstp_same_bridgeid(pv->pv_dbridge_id, cpv->pv_dbridge_id) && + (cpv->pv_dport_id & 0xfff) == (pv->pv_dport_id & 0xfff))) + return (1); + return (0); } -__private_extern__ void -bstp_initialization(struct bridge_softc *sc) +static void +bstp_assign_roles(struct bstp_state *bs) { - struct bridge_iflist *bif, *mif; - struct timespec ts; - unsigned char *lladdr; - - lck_mtx_assert(sc->sc_mtx, LCK_MTX_ASSERT_OWNED); - - mif = NULL; - LIST_FOREACH(bif, &sc->sc_iflist, bif_next) { - if ((bif->bif_flags & IFBIF_STP) == 0) + struct bstp_port *bp, *rbp = NULL; + struct bstp_pri_vector pv; + + /* default to our priority vector */ + bs->bs_root_pv = bs->bs_bridge_pv; + bs->bs_root_msg_age = 0; + bs->bs_root_max_age = bs->bs_bridge_max_age; + bs->bs_root_fdelay = bs->bs_bridge_fdelay; + bs->bs_root_htime = bs->bs_bridge_htime; + bs->bs_root_port = NULL; + + /* check if any recieved info supersedes us */ + LIST_FOREACH(bp, &bs->bs_bplist, bp_next) { + if (bp->bp_infois != BSTP_INFO_RECEIVED) continue; - if (bif->bif_ifp->if_type != IFT_ETHER) - continue; - bif->bif_port_id = (bif->bif_priority << 8) | - (bif->bif_ifp->if_index & 0xff); - if (mif == NULL) { - mif = bif; - continue; + pv = bp->bp_port_pv; + pv.pv_cost += bp->bp_path_cost; + + /* + * The root priority vector is the best of the set comprising + * the bridge priority vector plus all root path priority + * vectors whose bridge address is not equal to us. + */ + if (bstp_same_bridgeid(pv.pv_dbridge_id, + bs->bs_bridge_pv.pv_dbridge_id) == 0 && + bstp_info_cmp(&bs->bs_root_pv, &pv) == INFO_BETTER) { + /* the port vector replaces the root */ + bs->bs_root_pv = pv; + bs->bs_root_msg_age = bp->bp_port_msg_age + + BSTP_MESSAGE_AGE_INCR; + bs->bs_root_max_age = bp->bp_port_max_age; + bs->bs_root_fdelay = bp->bp_port_fdelay; + bs->bs_root_htime = bp->bp_port_htime; + rbp = bp; } - if (memcmp(ifnet_lladdr(bif->bif_ifp), - ifnet_lladdr(mif->bif_ifp), ETHER_ADDR_LEN) < 0) { - mif = bif; - continue; + } + + LIST_FOREACH(bp, &bs->bs_bplist, bp_next) { + /* calculate the port designated vector */ + bp->bp_desg_pv.pv_root_id = bs->bs_root_pv.pv_root_id; + bp->bp_desg_pv.pv_cost = bs->bs_root_pv.pv_cost; + bp->bp_desg_pv.pv_dbridge_id = bs->bs_bridge_pv.pv_dbridge_id; + bp->bp_desg_pv.pv_dport_id = bp->bp_port_id; + bp->bp_desg_pv.pv_port_id = bp->bp_port_id; + + /* calculate designated times */ + bp->bp_desg_msg_age = bs->bs_root_msg_age; + bp->bp_desg_max_age = bs->bs_root_max_age; + bp->bp_desg_fdelay = bs->bs_root_fdelay; + bp->bp_desg_htime = bs->bs_bridge_htime; + + + switch (bp->bp_infois) { + case BSTP_INFO_DISABLED: + bstp_set_port_role(bp, BSTP_ROLE_DISABLED); + break; + + case BSTP_INFO_AGED: + bstp_set_port_role(bp, BSTP_ROLE_DESIGNATED); + bstp_update_info(bp); + break; + + case BSTP_INFO_MINE: + bstp_set_port_role(bp, BSTP_ROLE_DESIGNATED); + /* update the port info if stale */ + if (bstp_info_cmp(&bp->bp_port_pv, + &bp->bp_desg_pv) != INFO_SAME || + (rbp != NULL && + (bp->bp_port_msg_age != rbp->bp_port_msg_age || + bp->bp_port_max_age != rbp->bp_port_max_age || + bp->bp_port_fdelay != rbp->bp_port_fdelay || + bp->bp_port_htime != rbp->bp_port_htime))) + bstp_update_info(bp); + break; + + case BSTP_INFO_RECEIVED: + if (bp == rbp) { + /* + * root priority is derived from this + * port, make it the root port. + */ + bstp_set_port_role(bp, BSTP_ROLE_ROOT); + bs->bs_root_port = bp; + } else if (bstp_info_cmp(&bp->bp_port_pv, + &bp->bp_desg_pv) == INFO_BETTER) { + /* + * the port priority is lower than the root + * port. + */ + bstp_set_port_role(bp, BSTP_ROLE_DESIGNATED); + bstp_update_info(bp); + } else { + if (bstp_same_bridgeid( + bp->bp_port_pv.pv_dbridge_id, + bs->bs_bridge_pv.pv_dbridge_id)) { + /* + * the designated bridge refers to + * another port on this bridge. + */ + bstp_set_port_role(bp, + BSTP_ROLE_BACKUP); + } else { + /* + * the port is an inferior path to the + * root bridge. + */ + bstp_set_port_role(bp, + BSTP_ROLE_ALTERNATE); + } + } + break; } } - if (mif == NULL) { - bstp_stop(sc); - return; +} + +static void +bstp_update_state(struct bstp_state *bs, struct bstp_port *bp) +{ + struct bstp_port *bp2; + int synced; + + BSTP_LOCK_ASSERT(bs); + + /* check if all the ports have syncronised again */ + if (!bs->bs_allsynced) { + synced = 1; + LIST_FOREACH(bp2, &bs->bs_bplist, bp_next) { + if (!(bp2->bp_synced || + bp2->bp_role == BSTP_ROLE_ROOT)) { + synced = 0; + break; + } + } + bs->bs_allsynced = synced; } - lladdr = ifnet_lladdr(mif->bif_ifp); - sc->sc_bridge_id = - (((uint64_t)sc->sc_bridge_priority) << 48) | - (((uint64_t)lladdr[0]) << 40) | - (((uint64_t)lladdr[1]) << 32) | - (lladdr[2] << 24) | - (lladdr[3] << 16) | - (lladdr[4] << 8) | - (lladdr[5]); - - sc->sc_designated_root = sc->sc_bridge_id; - sc->sc_root_path_cost = 0; - sc->sc_root_port = NULL; - - sc->sc_max_age = sc->sc_bridge_max_age; - sc->sc_hello_time = sc->sc_bridge_hello_time; - sc->sc_forward_delay = sc->sc_bridge_forward_delay; - sc->sc_topology_change_detected = 0; - sc->sc_topology_change = 0; - bstp_timer_stop(&sc->sc_tcn_timer); - bstp_timer_stop(&sc->sc_topology_change_timer); - - bsd_untimeout(bstp_tick, sc); - ts.tv_sec = 1; - ts.tv_nsec = 0; - bsd_timeout(bstp_tick, sc, &ts); + bstp_update_roles(bs, bp); + bstp_update_tc(bp); +} - LIST_FOREACH(bif, &sc->sc_iflist, bif_next) { - if (bif->bif_flags & IFBIF_STP) - bstp_enable_port(sc, bif); - else - bstp_disable_port(sc, bif); +static void +bstp_update_roles(struct bstp_state *bs, struct bstp_port *bp) +{ + switch (bp->bp_role) { + case BSTP_ROLE_DISABLED: + /* Clear any flags if set */ + if (bp->bp_sync || !bp->bp_synced || bp->bp_reroot) { + bp->bp_sync = 0; + bp->bp_synced = 1; + bp->bp_reroot = 0; + } + break; + + case BSTP_ROLE_ALTERNATE: + case BSTP_ROLE_BACKUP: + if ((bs->bs_allsynced && !bp->bp_agree) || + (bp->bp_proposed && bp->bp_agree)) { + bp->bp_proposed = 0; + bp->bp_agree = 1; + bp->bp_flags |= BSTP_PORT_NEWINFO; + DPRINTF("%s -> ALTERNATE_AGREED\n", + bp->bp_ifp->if_xname); + } + + if (bp->bp_proposed && !bp->bp_agree) { + bstp_set_all_sync(bs); + bp->bp_proposed = 0; + DPRINTF("%s -> ALTERNATE_PROPOSED\n", + bp->bp_ifp->if_xname); + } + + /* Clear any flags if set */ + if (bp->bp_sync || !bp->bp_synced || bp->bp_reroot) { + bp->bp_sync = 0; + bp->bp_synced = 1; + bp->bp_reroot = 0; + DPRINTF("%s -> ALTERNATE_PORT\n", bp->bp_ifp->if_xname); + } + break; + + case BSTP_ROLE_ROOT: + if (bp->bp_state != BSTP_IFSTATE_FORWARDING && !bp->bp_reroot) { + bstp_set_all_reroot(bs); + DPRINTF("%s -> ROOT_REROOT\n", bp->bp_ifp->if_xname); + } + + if ((bs->bs_allsynced && !bp->bp_agree) || + (bp->bp_proposed && bp->bp_agree)) { + bp->bp_proposed = 0; + bp->bp_sync = 0; + bp->bp_agree = 1; + bp->bp_flags |= BSTP_PORT_NEWINFO; + DPRINTF("%s -> ROOT_AGREED\n", bp->bp_ifp->if_xname); + } + + if (bp->bp_proposed && !bp->bp_agree) { + bstp_set_all_sync(bs); + bp->bp_proposed = 0; + DPRINTF("%s -> ROOT_PROPOSED\n", bp->bp_ifp->if_xname); + } + + if (bp->bp_state != BSTP_IFSTATE_FORWARDING && + (bp->bp_forward_delay_timer.active == 0 || + (bstp_rerooted(bs, bp) && + bp->bp_recent_backup_timer.active == 0 && + bp->bp_protover == BSTP_PROTO_RSTP))) { + switch (bp->bp_state) { + case BSTP_IFSTATE_DISCARDING: + bstp_set_port_state(bp, BSTP_IFSTATE_LEARNING); + break; + case BSTP_IFSTATE_LEARNING: + bstp_set_port_state(bp, + BSTP_IFSTATE_FORWARDING); + break; + } + } + + if (bp->bp_state == BSTP_IFSTATE_FORWARDING && bp->bp_reroot) { + bp->bp_reroot = 0; + DPRINTF("%s -> ROOT_REROOTED\n", bp->bp_ifp->if_xname); + } + break; + + case BSTP_ROLE_DESIGNATED: + if (bp->bp_recent_root_timer.active == 0 && bp->bp_reroot) { + bp->bp_reroot = 0; + DPRINTF("%s -> DESIGNATED_RETIRED\n", + bp->bp_ifp->if_xname); + } + + if ((bp->bp_state == BSTP_IFSTATE_DISCARDING && + !bp->bp_synced) || (bp->bp_agreed && !bp->bp_synced) || + (bp->bp_operedge && !bp->bp_synced) || + (bp->bp_sync && bp->bp_synced)) { + bstp_timer_stop(&bp->bp_recent_root_timer); + bp->bp_synced = 1; + bp->bp_sync = 0; + DPRINTF("%s -> DESIGNATED_SYNCED\n", + bp->bp_ifp->if_xname); + } + + if (bp->bp_state != BSTP_IFSTATE_FORWARDING && + !bp->bp_agreed && !bp->bp_proposing && + !bp->bp_operedge) { + bp->bp_proposing = 1; + bp->bp_flags |= BSTP_PORT_NEWINFO; + bstp_timer_start(&bp->bp_edge_delay_timer, + (bp->bp_ptp_link ? BSTP_DEFAULT_MIGRATE_DELAY : + bp->bp_desg_max_age)); + DPRINTF("%s -> DESIGNATED_PROPOSE\n", + bp->bp_ifp->if_xname); + } + + if (bp->bp_state != BSTP_IFSTATE_FORWARDING && + (bp->bp_forward_delay_timer.active == 0 || bp->bp_agreed || + bp->bp_operedge) && + (bp->bp_recent_root_timer.active == 0 || !bp->bp_reroot) && + !bp->bp_sync) { +#ifdef BRIDGESTP_DEBUG + if (bp->bp_agreed) + DPRINTF("%s -> AGREED\n", bp->bp_ifp->if_xname); +#endif /* BRIDGESTP_DEBUG */ + /* + * If agreed|operedge then go straight to forwarding, + * otherwise follow discard -> learn -> forward. + */ + if (bp->bp_agreed || bp->bp_operedge || + bp->bp_state == BSTP_IFSTATE_LEARNING) { + bstp_set_port_state(bp, + BSTP_IFSTATE_FORWARDING); + bp->bp_agreed = bp->bp_protover; + } else if (bp->bp_state == BSTP_IFSTATE_DISCARDING) + bstp_set_port_state(bp, BSTP_IFSTATE_LEARNING); + } + + if (((bp->bp_sync && !bp->bp_synced) || + (bp->bp_reroot && bp->bp_recent_root_timer.active) || + (bp->bp_flags & BSTP_PORT_DISPUTED)) && !bp->bp_operedge && + bp->bp_state != BSTP_IFSTATE_DISCARDING) { + bstp_set_port_state(bp, BSTP_IFSTATE_DISCARDING); + bp->bp_flags &= ~BSTP_PORT_DISPUTED; + bstp_timer_start(&bp->bp_forward_delay_timer, + bp->bp_protover == BSTP_PROTO_RSTP ? + bp->bp_desg_htime : bp->bp_desg_fdelay); + DPRINTF("%s -> DESIGNATED_DISCARD\n", + bp->bp_ifp->if_xname); + } + break; } - bstp_port_state_selection(sc); - bstp_config_bpdu_generation(sc); - bstp_timer_start(&sc->sc_hello_timer, 0); + if (bp->bp_flags & BSTP_PORT_NEWINFO) + bstp_transmit(bs, bp); } -__private_extern__ void -bstp_stop(struct bridge_softc *sc) +static void +bstp_update_tc(struct bstp_port *bp) { - struct bridge_iflist *bif; + switch (bp->bp_tcstate) { + case BSTP_TCSTATE_ACTIVE: + if ((bp->bp_role != BSTP_ROLE_DESIGNATED && + bp->bp_role != BSTP_ROLE_ROOT) || bp->bp_operedge) + bstp_set_port_tc(bp, BSTP_TCSTATE_LEARNING); + + if (bp->bp_rcvdtcn) + bstp_set_port_tc(bp, BSTP_TCSTATE_TCN); + if (bp->bp_rcvdtc) + bstp_set_port_tc(bp, BSTP_TCSTATE_TC); + + if (bp->bp_tc_prop && !bp->bp_operedge) + bstp_set_port_tc(bp, BSTP_TCSTATE_PROPAG); + + if (bp->bp_rcvdtca) + bstp_set_port_tc(bp, BSTP_TCSTATE_ACK); + break; + + case BSTP_TCSTATE_INACTIVE: + if ((bp->bp_state == BSTP_IFSTATE_LEARNING || + bp->bp_state == BSTP_IFSTATE_FORWARDING) && + bp->bp_fdbflush == 0) + bstp_set_port_tc(bp, BSTP_TCSTATE_LEARNING); + break; - LIST_FOREACH(bif, &sc->sc_iflist, bif_next) { - bstp_set_port_state(bif, BSTP_IFSTATE_DISABLED); - bstp_timer_stop(&bif->bif_hold_timer); - bstp_timer_stop(&bif->bif_message_age_timer); - bstp_timer_stop(&bif->bif_forward_delay_timer); + case BSTP_TCSTATE_LEARNING: + if (bp->bp_rcvdtc || bp->bp_rcvdtcn || bp->bp_rcvdtca || + bp->bp_tc_prop) + bstp_set_port_tc(bp, BSTP_TCSTATE_LEARNING); + else if (bp->bp_role != BSTP_ROLE_DESIGNATED && + bp->bp_role != BSTP_ROLE_ROOT && + bp->bp_state == BSTP_IFSTATE_DISCARDING) + bstp_set_port_tc(bp, BSTP_TCSTATE_INACTIVE); + + if ((bp->bp_role == BSTP_ROLE_DESIGNATED || + bp->bp_role == BSTP_ROLE_ROOT) && + bp->bp_state == BSTP_IFSTATE_FORWARDING && + !bp->bp_operedge) + bstp_set_port_tc(bp, BSTP_TCSTATE_DETECTED); + break; + + /* these are transient states and go straight back to ACTIVE */ + case BSTP_TCSTATE_DETECTED: + case BSTP_TCSTATE_TCN: + case BSTP_TCSTATE_TC: + case BSTP_TCSTATE_PROPAG: + case BSTP_TCSTATE_ACK: + DPRINTF("Invalid TC state for %s\n", + bp->bp_ifp->if_xname); + break; } - bsd_untimeout(bstp_tick, sc); +} + +static void +bstp_update_info(struct bstp_port *bp) +{ + struct bstp_state *bs = bp->bp_bs; + + bp->bp_proposing = 0; + bp->bp_proposed = 0; - bstp_timer_stop(&sc->sc_topology_change_timer); - bstp_timer_stop(&sc->sc_tcn_timer); - bstp_timer_stop(&sc->sc_hello_timer); + if (bp->bp_agreed && !bstp_pdu_bettersame(bp, BSTP_INFO_MINE)) + bp->bp_agreed = 0; + if (bp->bp_synced && !bp->bp_agreed) { + bp->bp_synced = 0; + bs->bs_allsynced = 0; + } + + /* copy the designated pv to the port */ + bp->bp_port_pv = bp->bp_desg_pv; + bp->bp_port_msg_age = bp->bp_desg_msg_age; + bp->bp_port_max_age = bp->bp_desg_max_age; + bp->bp_port_fdelay = bp->bp_desg_fdelay; + bp->bp_port_htime = bp->bp_desg_htime; + bp->bp_infois = BSTP_INFO_MINE; + + /* Set transmit flag but do not immediately send */ + bp->bp_flags |= BSTP_PORT_NEWINFO; } -void -bstp_initialize_port(struct bridge_softc *sc, struct bridge_iflist *bif) +/* set tcprop on every port other than the caller */ +static void +bstp_set_other_tcprop(struct bstp_port *bp) { - bstp_become_designated_port(sc, bif); - bstp_set_port_state(bif, BSTP_IFSTATE_BLOCKING); - bif->bif_topology_change_acknowledge = 0; - bif->bif_config_pending = 0; - bif->bif_change_detection_enabled = 1; - bstp_timer_stop(&bif->bif_message_age_timer); - bstp_timer_stop(&bif->bif_forward_delay_timer); - bstp_timer_stop(&bif->bif_hold_timer); + struct bstp_state *bs = bp->bp_bs; + struct bstp_port *bp2; + + BSTP_LOCK_ASSERT(bs); + + LIST_FOREACH(bp2, &bs->bs_bplist, bp_next) { + if (bp2 == bp) + continue; + bp2->bp_tc_prop = 1; + } } -void -bstp_enable_port(struct bridge_softc *sc, struct bridge_iflist *bif) +static void +bstp_set_all_reroot(struct bstp_state *bs) { - bstp_initialize_port(sc, bif); - bstp_port_state_selection(sc); + struct bstp_port *bp; + + BSTP_LOCK_ASSERT(bs); + + LIST_FOREACH(bp, &bs->bs_bplist, bp_next) + bp->bp_reroot = 1; } -void -bstp_disable_port(struct bridge_softc *sc, struct bridge_iflist *bif) -{ - int root; - - root = bstp_root_bridge(sc); - bstp_become_designated_port(sc, bif); - bstp_set_port_state(bif, BSTP_IFSTATE_DISABLED); - bif->bif_topology_change_acknowledge = 0; - bif->bif_config_pending = 0; - bstp_timer_stop(&bif->bif_message_age_timer); - bstp_timer_stop(&bif->bif_forward_delay_timer); - bstp_configuration_update(sc); - bstp_port_state_selection(sc); - - if (bstp_root_bridge(sc) && (root == 0)) { - sc->sc_max_age = sc->sc_bridge_max_age; - sc->sc_hello_time = sc->sc_bridge_hello_time; - sc->sc_forward_delay = sc->sc_bridge_forward_delay; - - bstp_topology_change_detection(sc); - bstp_timer_stop(&sc->sc_tcn_timer); - bstp_config_bpdu_generation(sc); - bstp_timer_start(&sc->sc_hello_timer, 0); +static void +bstp_set_all_sync(struct bstp_state *bs) +{ + struct bstp_port *bp; + + BSTP_LOCK_ASSERT(bs); + + LIST_FOREACH(bp, &bs->bs_bplist, bp_next) { + bp->bp_sync = 1; + bp->bp_synced = 0; /* Not explicit in spec */ } + + bs->bs_allsynced = 0; } -void -bstp_set_bridge_priority(struct bridge_softc *sc, uint64_t new_bridge_id) +static void +bstp_set_port_state(struct bstp_port *bp, int state) +{ + if (bp->bp_state == state) + return; + + bp->bp_state = state; + + switch (bp->bp_state) { + case BSTP_IFSTATE_DISCARDING: + DPRINTF("state changed to DISCARDING on %s\n", + bp->bp_ifp->if_xname); + break; + + case BSTP_IFSTATE_LEARNING: + DPRINTF("state changed to LEARNING on %s\n", + bp->bp_ifp->if_xname); + + bstp_timer_start(&bp->bp_forward_delay_timer, + bp->bp_protover == BSTP_PROTO_RSTP ? + bp->bp_desg_htime : bp->bp_desg_fdelay); + break; + + case BSTP_IFSTATE_FORWARDING: + DPRINTF("state changed to FORWARDING on %s\n", + bp->bp_ifp->if_xname); + + bstp_timer_stop(&bp->bp_forward_delay_timer); + /* Record that we enabled forwarding */ + bp->bp_forward_transitions++; + break; + } + + /* notify the parent bridge */ + bstp_task_enqueue(&bp->bp_statetask); +} + +static void +bstp_set_port_role(struct bstp_port *bp, int role) { - struct bridge_iflist *bif; - int root; + struct bstp_state *bs = bp->bp_bs; + + if (bp->bp_role == role) + return; + + /* perform pre-change tasks */ + switch (bp->bp_role) { + case BSTP_ROLE_DISABLED: + bstp_timer_start(&bp->bp_forward_delay_timer, + bp->bp_desg_max_age); + break; + + case BSTP_ROLE_BACKUP: + bstp_timer_start(&bp->bp_recent_backup_timer, + bp->bp_desg_htime * 2); + /* fall through */ + case BSTP_ROLE_ALTERNATE: + bstp_timer_start(&bp->bp_forward_delay_timer, + bp->bp_desg_fdelay); + bp->bp_sync = 0; + bp->bp_synced = 1; + bp->bp_reroot = 0; + break; - root = bstp_root_bridge(sc); + case BSTP_ROLE_ROOT: + bstp_timer_start(&bp->bp_recent_root_timer, + BSTP_DEFAULT_FORWARD_DELAY); + break; + } + + bp->bp_role = role; + /* clear values not carried between roles */ + bp->bp_proposing = 0; + bs->bs_allsynced = 0; + + /* initialise the new role */ + switch (bp->bp_role) { + case BSTP_ROLE_DISABLED: + case BSTP_ROLE_ALTERNATE: + case BSTP_ROLE_BACKUP: + DPRINTF("%s role -> ALT/BACK/DISABLED\n", + bp->bp_ifp->if_xname); + bstp_set_port_state(bp, BSTP_IFSTATE_DISCARDING); + bstp_timer_stop(&bp->bp_recent_root_timer); + bstp_timer_latch(&bp->bp_forward_delay_timer); + bp->bp_sync = 0; + bp->bp_synced = 1; + bp->bp_reroot = 0; + break; - LIST_FOREACH(bif, &sc->sc_iflist, bif_next) { - if ((bif->bif_flags & IFBIF_STP) == 0) + case BSTP_ROLE_ROOT: + DPRINTF("%s role -> ROOT\n", + bp->bp_ifp->if_xname); + bstp_set_port_state(bp, BSTP_IFSTATE_DISCARDING); + bstp_timer_latch(&bp->bp_recent_root_timer); + bp->bp_proposing = 0; + break; + + case BSTP_ROLE_DESIGNATED: + DPRINTF("%s role -> DESIGNATED\n", + bp->bp_ifp->if_xname); + bstp_timer_start(&bp->bp_hello_timer, + bp->bp_desg_htime); + bp->bp_agree = 0; + break; + } + + /* let the TC state know that the role changed */ + bstp_update_tc(bp); +} + +static void +bstp_set_port_proto(struct bstp_port *bp, int proto) +{ + struct bstp_state *bs = bp->bp_bs; + + /* supported protocol versions */ + switch (proto) { + case BSTP_PROTO_STP: + /* we can downgrade protocols only */ + bstp_timer_stop(&bp->bp_migrate_delay_timer); + /* clear unsupported features */ + bp->bp_operedge = 0; + /* STP compat mode only uses 16 bits of the 32 */ + if (bp->bp_path_cost > 65535) + bp->bp_path_cost = 65535; + break; + + case BSTP_PROTO_RSTP: + bstp_timer_start(&bp->bp_migrate_delay_timer, + bs->bs_migration_delay); + break; + + default: + DPRINTF("Unsupported STP version %d\n", proto); + return; + } + + bp->bp_protover = proto; + bp->bp_flags &= ~BSTP_PORT_CANMIGRATE; +} + +static void +bstp_set_port_tc(struct bstp_port *bp, int state) +{ + struct bstp_state *bs = bp->bp_bs; + + bp->bp_tcstate = state; + + /* initialise the new state */ + switch (bp->bp_tcstate) { + case BSTP_TCSTATE_ACTIVE: + DPRINTF("%s -> TC_ACTIVE\n", bp->bp_ifp->if_xname); + /* nothing to do */ + break; + + case BSTP_TCSTATE_INACTIVE: + bstp_timer_stop(&bp->bp_tc_timer); + /* flush routes on the parent bridge */ + bp->bp_fdbflush = 1; + bstp_task_enqueue(&bp->bp_rtagetask); + bp->bp_tc_ack = 0; + DPRINTF("%s -> TC_INACTIVE\n", bp->bp_ifp->if_xname); + break; + + case BSTP_TCSTATE_LEARNING: + bp->bp_rcvdtc = 0; + bp->bp_rcvdtcn = 0; + bp->bp_rcvdtca = 0; + bp->bp_tc_prop = 0; + DPRINTF("%s -> TC_LEARNING\n", bp->bp_ifp->if_xname); + break; + + case BSTP_TCSTATE_DETECTED: + bstp_set_timer_tc(bp); + bstp_set_other_tcprop(bp); + /* send out notification */ + bp->bp_flags |= BSTP_PORT_NEWINFO; + bstp_transmit(bs, bp); + /* reviewed for getmicrotime usage */ + getmicrotime(&bs->bs_last_tc_time); + DPRINTF("%s -> TC_DETECTED\n", bp->bp_ifp->if_xname); + bp->bp_tcstate = BSTP_TCSTATE_ACTIVE; /* UCT */ + break; + + case BSTP_TCSTATE_TCN: + bstp_set_timer_tc(bp); + DPRINTF("%s -> TC_TCN\n", bp->bp_ifp->if_xname); + /* fall through */ + case BSTP_TCSTATE_TC: + bp->bp_rcvdtc = 0; + bp->bp_rcvdtcn = 0; + if (bp->bp_role == BSTP_ROLE_DESIGNATED) + bp->bp_tc_ack = 1; + + bstp_set_other_tcprop(bp); + DPRINTF("%s -> TC_TC\n", bp->bp_ifp->if_xname); + bp->bp_tcstate = BSTP_TCSTATE_ACTIVE; /* UCT */ + break; + + case BSTP_TCSTATE_PROPAG: + /* flush routes on the parent bridge */ + bp->bp_fdbflush = 1; + bstp_task_enqueue(&bp->bp_rtagetask); + bp->bp_tc_prop = 0; + bstp_set_timer_tc(bp); + DPRINTF("%s -> TC_PROPAG\n", bp->bp_ifp->if_xname); + bp->bp_tcstate = BSTP_TCSTATE_ACTIVE; /* UCT */ + break; + + case BSTP_TCSTATE_ACK: + bstp_timer_stop(&bp->bp_tc_timer); + bp->bp_rcvdtca = 0; + DPRINTF("%s -> TC_ACK\n", bp->bp_ifp->if_xname); + bp->bp_tcstate = BSTP_TCSTATE_ACTIVE; /* UCT */ + break; + } +} + +static void +bstp_set_timer_tc(struct bstp_port *bp) +{ + struct bstp_state *bs = bp->bp_bs; + + if (bp->bp_tc_timer.active) + return; + + switch (bp->bp_protover) { + case BSTP_PROTO_RSTP: + bstp_timer_start(&bp->bp_tc_timer, + bp->bp_desg_htime + BSTP_TICK_VAL); + bp->bp_flags |= BSTP_PORT_NEWINFO; + break; + + case BSTP_PROTO_STP: + bstp_timer_start(&bp->bp_tc_timer, + bs->bs_root_max_age + bs->bs_root_fdelay); + break; + } +} + +static void +bstp_set_timer_msgage(struct bstp_port *bp) +{ + if (bp->bp_port_msg_age + BSTP_MESSAGE_AGE_INCR <= + bp->bp_port_max_age) { + bstp_timer_start(&bp->bp_message_age_timer, + bp->bp_port_htime * 3); + } else + /* expires immediately */ + bstp_timer_start(&bp->bp_message_age_timer, 0); +} + +static int +bstp_rerooted(struct bstp_state *bs, struct bstp_port *bp) +{ + struct bstp_port *bp2; + int rr_set = 0; + + LIST_FOREACH(bp2, &bs->bs_bplist, bp_next) { + if (bp2 == bp) continue; - if (bstp_designated_port(sc, bif)) - bif->bif_designated_bridge = new_bridge_id; + if (bp2->bp_recent_root_timer.active) { + rr_set = 1; + break; + } } + return (!rr_set); +} - sc->sc_bridge_id = new_bridge_id; +int +bstp_set_htime(struct bstp_state *bs, int t) +{ + /* convert seconds to ticks */ + t *= BSTP_TICK_VAL; - bstp_configuration_update(sc); - bstp_port_state_selection(sc); + /* value can only be changed in leagacy stp mode */ + if (bs->bs_protover != BSTP_PROTO_STP) + return (EPERM); - if (bstp_root_bridge(sc) && (root == 0)) { - sc->sc_max_age = sc->sc_bridge_max_age; - sc->sc_hello_time = sc->sc_bridge_hello_time; - sc->sc_forward_delay = sc->sc_bridge_forward_delay; + if (t < BSTP_MIN_HELLO_TIME || t > BSTP_MAX_HELLO_TIME) + return (EINVAL); - bstp_topology_change_detection(sc); - bstp_timer_stop(&sc->sc_tcn_timer); - bstp_config_bpdu_generation(sc); - bstp_timer_start(&sc->sc_hello_timer, 0); + BSTP_LOCK(bs); + bs->bs_bridge_htime = t; + bstp_reinit(bs); + BSTP_UNLOCK(bs); + return (0); +} + +int +bstp_set_fdelay(struct bstp_state *bs, int t) +{ + /* convert seconds to ticks */ + t *= BSTP_TICK_VAL; + + if (t < BSTP_MIN_FORWARD_DELAY || t > BSTP_MAX_FORWARD_DELAY) + return (EINVAL); + + BSTP_LOCK(bs); + bs->bs_bridge_fdelay = t; + bstp_reinit(bs); + BSTP_UNLOCK(bs); + return (0); +} + +int +bstp_set_maxage(struct bstp_state *bs, int t) +{ + /* convert seconds to ticks */ + t *= BSTP_TICK_VAL; + + if (t < BSTP_MIN_MAX_AGE || t > BSTP_MAX_MAX_AGE) + return (EINVAL); + + BSTP_LOCK(bs); + bs->bs_bridge_max_age = t; + bstp_reinit(bs); + BSTP_UNLOCK(bs); + return (0); +} + +int +bstp_set_holdcount(struct bstp_state *bs, int count) +{ + struct bstp_port *bp; + + if (count < BSTP_MIN_HOLD_COUNT || + count > BSTP_MAX_HOLD_COUNT) + return (EINVAL); + + BSTP_LOCK(bs); + bs->bs_txholdcount = count; + LIST_FOREACH(bp, &bs->bs_bplist, bp_next) + bp->bp_txcount = 0; + BSTP_UNLOCK(bs); + return (0); +} + +int +bstp_set_protocol(struct bstp_state *bs, int proto) +{ + struct bstp_port *bp; + + switch (proto) { + /* Supported protocol versions */ + case BSTP_PROTO_STP: + case BSTP_PROTO_RSTP: + break; + + default: + return (EINVAL); } + + BSTP_LOCK(bs); + bs->bs_protover = proto; + bs->bs_bridge_htime = BSTP_DEFAULT_HELLO_TIME; + LIST_FOREACH(bp, &bs->bs_bplist, bp_next) { + /* reinit state */ + bp->bp_infois = BSTP_INFO_DISABLED; + bp->bp_txcount = 0; + bstp_set_port_proto(bp, bs->bs_protover); + bstp_set_port_role(bp, BSTP_ROLE_DISABLED); + bstp_set_port_tc(bp, BSTP_TCSTATE_INACTIVE); + bstp_timer_stop(&bp->bp_recent_backup_timer); + } + bstp_reinit(bs); + BSTP_UNLOCK(bs); + return (0); } -void -bstp_set_port_priority(struct bridge_softc *sc, struct bridge_iflist *bif, - uint16_t new_port_id) +int +bstp_set_priority(struct bstp_state *bs, int pri) +{ + if (pri < 0 || pri > BSTP_MAX_PRIORITY) + return (EINVAL); + + /* Limit to steps of 4096 */ + pri -= pri % 4096; + + BSTP_LOCK(bs); + bs->bs_bridge_priority = pri; + bstp_reinit(bs); + BSTP_UNLOCK(bs); + return (0); +} + +int +bstp_set_port_priority(struct bstp_port *bp, int pri) { - if (bstp_designated_port(sc, bif)) - bif->bif_designated_port = new_port_id; + struct bstp_state *bs = bp->bp_bs; + + if (pri < 0 || pri > BSTP_MAX_PORT_PRIORITY) + return (EINVAL); - bif->bif_port_id = new_port_id; + /* Limit to steps of 16 */ + pri -= pri % 16; - if ((sc->sc_bridge_id == bif->bif_designated_bridge) && - (bif->bif_port_id < bif->bif_designated_port)) { - bstp_become_designated_port(sc, bif); - bstp_port_state_selection(sc); + BSTP_LOCK(bs); + bp->bp_priority = pri; + bstp_reinit(bs); + BSTP_UNLOCK(bs); + return (0); +} + +int +bstp_set_path_cost(struct bstp_port *bp, uint32_t path_cost) +{ + struct bstp_state *bs = bp->bp_bs; + + if (path_cost > BSTP_MAX_PATH_COST) + return (EINVAL); + + /* STP compat mode only uses 16 bits of the 32 */ + if (bp->bp_protover == BSTP_PROTO_STP && path_cost > 65535) + path_cost = 65535; + + BSTP_LOCK(bs); + + if (path_cost == 0) { /* use auto */ + bp->bp_flags &= ~BSTP_PORT_ADMCOST; + bp->bp_path_cost = bstp_calc_path_cost(bp); + } else { + bp->bp_path_cost = path_cost; + bp->bp_flags |= BSTP_PORT_ADMCOST; } + bstp_reinit(bs); + BSTP_UNLOCK(bs); + return (0); } -void -bstp_set_path_cost(struct bridge_softc *sc, struct bridge_iflist *bif, - uint32_t path_cost) +int +bstp_set_edge(struct bstp_port *bp, int set) +{ + struct bstp_state *bs = bp->bp_bs; + + BSTP_LOCK(bs); + if ((bp->bp_operedge = set) == 0) + bp->bp_flags &= ~BSTP_PORT_ADMEDGE; + else + bp->bp_flags |= BSTP_PORT_ADMEDGE; + BSTP_UNLOCK(bs); + return (0); +} + +int +bstp_set_autoedge(struct bstp_port *bp, int set) { - bif->bif_path_cost = path_cost; - bstp_configuration_update(sc); - bstp_port_state_selection(sc); + struct bstp_state *bs = bp->bp_bs; + + BSTP_LOCK(bs); + if (set) { + bp->bp_flags |= BSTP_PORT_AUTOEDGE; + /* we may be able to transition straight to edge */ + if (bp->bp_edge_delay_timer.active == 0) + bstp_edge_delay_expiry(bs, bp); + } else + bp->bp_flags &= ~BSTP_PORT_AUTOEDGE; + BSTP_UNLOCK(bs); + return (0); } -void -bstp_enable_change_detection(struct bridge_iflist *bif) +int +bstp_set_ptp(struct bstp_port *bp, int set) { - bif->bif_change_detection_enabled = 1; + struct bstp_state *bs = bp->bp_bs; + + BSTP_LOCK(bs); + bp->bp_ptp_link = set; + BSTP_UNLOCK(bs); + return (0); } -void -bstp_disable_change_detection(struct bridge_iflist *bif) +int +bstp_set_autoptp(struct bstp_port *bp, int set) +{ + struct bstp_state *bs = bp->bp_bs; + + BSTP_LOCK(bs); + if (set) { + bp->bp_flags |= BSTP_PORT_AUTOPTP; + if (bp->bp_role != BSTP_ROLE_DISABLED) + bstp_ifupdstatus(bs, bp); + } else + bp->bp_flags &= ~BSTP_PORT_AUTOPTP; + BSTP_UNLOCK(bs); + return (0); +} + +/* + * Calculate the path cost according to the link speed. + */ +static uint32_t +bstp_calc_path_cost(struct bstp_port *bp) +{ + struct ifnet *ifp = bp->bp_ifp; + uint32_t path_cost; + + /* If the priority has been manually set then retain the value */ + if (bp->bp_flags & BSTP_PORT_ADMCOST) + return bp->bp_path_cost; + + if (bp->bp_if_link_state == LINK_STATE_DOWN) { + /* Recalc when the link comes up again */ + bp->bp_flags |= BSTP_PORT_PNDCOST; + return (BSTP_DEFAULT_PATH_COST); + } + + if (ifp->if_baudrate < 1000) + return (BSTP_DEFAULT_PATH_COST); + + /* formula from section 17.14, IEEE Std 802.1D-2004 */ + path_cost = 20000000000ULL / (ifp->if_baudrate / 1000); + + if (path_cost > BSTP_MAX_PATH_COST) + path_cost = BSTP_MAX_PATH_COST; + + /* STP compat mode only uses 16 bits of the 32 */ + if (bp->bp_protover == BSTP_PROTO_STP && path_cost > 65535) + path_cost = 65535; + + return (path_cost); +} + +/* + * Notify the bridge that a port state has changed, we need to do this from a + * taskqueue to avoid a LOR. + */ +static void +bstp_notify_state(void *arg, __unused int pending) +{ + struct bstp_port *bp = (struct bstp_port *)arg; + struct bstp_state *bs = bp->bp_bs; + + if (bp->bp_active == 1 && bs->bs_state_cb != NULL) + (*bs->bs_state_cb)(bp->bp_ifp, bp->bp_state); +} + +/* + * Flush the routes on the bridge port, we need to do this from a + * taskqueue to avoid a LOR. + */ +static void +bstp_notify_rtage(void *arg, __unused int pending) { - bif->bif_change_detection_enabled = 0; + struct bstp_port *bp = (struct bstp_port *)arg; + struct bstp_state *bs = bp->bp_bs; + int age = 0; + + BSTP_LOCK(bs); + switch (bp->bp_protover) { + case BSTP_PROTO_STP: + /* convert to seconds */ + age = bp->bp_desg_fdelay / BSTP_TICK_VAL; + break; + + case BSTP_PROTO_RSTP: + age = 0; + break; + } + BSTP_UNLOCK(bs); + + if (bp->bp_active == 1 && bs->bs_rtage_cb != NULL) + (*bs->bs_rtage_cb)(bp->bp_ifp, age); + + /* flush is complete */ + BSTP_LOCK(bs); + bp->bp_fdbflush = 0; + BSTP_UNLOCK(bs); } void -bstp_ifupdstatus(struct bridge_softc *sc, struct bridge_iflist *bif) -{ - struct ifnet *ifp = bif->bif_ifp; - struct ifmediareq ifmr; - - if ((ifnet_flags(ifp) & IFF_UP)) { - bzero(&ifmr, sizeof(ifmr)); - if (ifnet_ioctl(ifp, 0, SIOCGIFMEDIA, &ifmr) == 0) { - // enable the port when the link is up, or its state is unknown - if ((ifmr.ifm_status & IFM_ACTIVE) || !(ifmr.ifm_status & IFM_AVALID)) { - if (bif->bif_state == BSTP_IFSTATE_DISABLED) - bstp_enable_port(sc, bif); - } else { - if (bif->bif_state != BSTP_IFSTATE_DISABLED) - bstp_disable_port(sc, bif); +bstp_linkstate(struct ifnet *ifp, __unused int state) +{ + struct bstp_state *bs; + struct bstp_port *bp; + + /* search for the stp port */ + lck_mtx_lock(bstp_list_mtx); + LIST_FOREACH(bs, &bstp_list, bs_list) { + BSTP_LOCK(bs); + LIST_FOREACH(bp, &bs->bs_bplist, bp_next) { + if (bp->bp_ifp == ifp) { + bstp_ifupdstatus(bs, bp); + bstp_update_state(bs, bp); + /* it only exists once so return */ + BSTP_UNLOCK(bs); + lck_mtx_unlock(bstp_list_mtx); + return; + } + } + BSTP_UNLOCK(bs); + } + lck_mtx_unlock(bstp_list_mtx); +} + +static void +bstp_ifupdstatus(struct bstp_state *bs, struct bstp_port *bp) +{ + struct ifnet *ifp = bp->bp_ifp; + struct ifmediareq ifmr; + int error = 0; + + BSTP_LOCK_ASSERT(bs); + + bzero((char *)&ifmr, sizeof(ifmr)); + error = (*ifp->if_ioctl)(ifp, SIOCGIFMEDIA, (caddr_t)&ifmr); + + if ((error == 0) && (ifp->if_flags & IFF_UP)) { + if (ifmr.ifm_status & IFM_ACTIVE) { + /* A full-duplex link is assumed to be point to point */ + if (bp->bp_flags & BSTP_PORT_AUTOPTP) { + bp->bp_ptp_link = + ifmr.ifm_active & IFM_FDX ? 1 : 0; + } + + /* Calc the cost if the link was down previously */ + if (bp->bp_flags & BSTP_PORT_PNDCOST) { + bp->bp_path_cost = bstp_calc_path_cost(bp); + bp->bp_flags &= ~BSTP_PORT_PNDCOST; + } + + if (bp->bp_role == BSTP_ROLE_DISABLED) + bstp_enable_port(bs, bp); + } else { + if (bp->bp_role != BSTP_ROLE_DISABLED) { + bstp_disable_port(bs, bp); + if ((bp->bp_flags & BSTP_PORT_ADMEDGE) && + bp->bp_protover == BSTP_PROTO_RSTP) + bp->bp_operedge = 1; } } return; } - if (bif->bif_state != BSTP_IFSTATE_DISABLED) - bstp_disable_port(sc, bif); + if (bp->bp_infois != BSTP_INFO_DISABLED) + bstp_disable_port(bs, bp); } -void +static void +bstp_enable_port(struct bstp_state *bs, struct bstp_port *bp) +{ + bp->bp_infois = BSTP_INFO_AGED; + bstp_assign_roles(bs); +} + +static void +bstp_disable_port(struct bstp_state *bs, struct bstp_port *bp) +{ + bp->bp_infois = BSTP_INFO_DISABLED; + bstp_assign_roles(bs); +} + +static void bstp_tick(void *arg) { - struct bridge_softc *sc = arg; - struct bridge_iflist *bif; + struct bstp_state *bs = arg; + struct bstp_port *bp; struct timespec ts; - lck_mtx_lock(sc->sc_mtx); + BSTP_LOCK(bs); - LIST_FOREACH(bif, &sc->sc_iflist, bif_next) { - if ((bif->bif_flags & IFBIF_STP) == 0) - continue; - /* - * XXX This can cause a lag in "link does away" - * XXX and "spanning tree gets updated". We need - * XXX come sort of callback from the link state - * XXX update code to kick spanning tree. - * XXX --thorpej@NetBSD.org - */ - bstp_ifupdstatus(sc, bif); + if (bs->bs_running == 0) + return; + + /* slow timer to catch missed link events */ + if (bstp_timer_expired(&bs->bs_link_timer)) { + LIST_FOREACH(bp, &bs->bs_bplist, bp_next) + bstp_ifupdstatus(bs, bp); + bstp_timer_start(&bs->bs_link_timer, BSTP_LINK_TIMER); } - if (bstp_timer_expired(&sc->sc_hello_timer, sc->sc_hello_time)) - bstp_hello_timer_expiry(sc); + LIST_FOREACH(bp, &bs->bs_bplist, bp_next) { + /* no events need to happen for these */ + bstp_timer_expired(&bp->bp_tc_timer); + bstp_timer_expired(&bp->bp_recent_root_timer); + bstp_timer_expired(&bp->bp_forward_delay_timer); + bstp_timer_expired(&bp->bp_recent_backup_timer); - if (bstp_timer_expired(&sc->sc_tcn_timer, sc->sc_bridge_hello_time)) - bstp_tcn_timer_expiry(sc); + if (bstp_timer_expired(&bp->bp_hello_timer)) + bstp_hello_timer_expiry(bs, bp); - if (bstp_timer_expired(&sc->sc_topology_change_timer, - sc->sc_topology_change_time)) - bstp_topology_change_timer_expiry(sc); + if (bstp_timer_expired(&bp->bp_message_age_timer)) + bstp_message_age_expiry(bs, bp); - LIST_FOREACH(bif, &sc->sc_iflist, bif_next) { - if ((bif->bif_flags & IFBIF_STP) == 0) - continue; - if (bstp_timer_expired(&bif->bif_message_age_timer, - sc->sc_max_age)) - bstp_message_age_timer_expiry(sc, bif); - } + if (bstp_timer_expired(&bp->bp_migrate_delay_timer)) + bstp_migrate_delay_expiry(bs, bp); - LIST_FOREACH(bif, &sc->sc_iflist, bif_next) { - if ((bif->bif_flags & IFBIF_STP) == 0) - continue; - if (bstp_timer_expired(&bif->bif_forward_delay_timer, - sc->sc_forward_delay)) - bstp_forward_delay_timer_expiry(sc, bif); + if (bstp_timer_expired(&bp->bp_edge_delay_timer)) + bstp_edge_delay_expiry(bs, bp); + + /* update the various state machines for the port */ + bstp_update_state(bs, bp); - if (bstp_timer_expired(&bif->bif_hold_timer, - sc->sc_hold_time)) - bstp_hold_timer_expiry(sc, bif); + if (bp->bp_txcount > 0) + bp->bp_txcount--; } - lck_mtx_unlock(sc->sc_mtx); + BSTP_UNLOCK(bs); - /* APPLE MODIFICATION - bridge changes */ - if (ifnet_flags(sc->sc_if) & IFF_RUNNING) { - ts.tv_sec = 1; - ts.tv_nsec = 0; - bsd_timeout(bstp_tick, sc, &ts); - } + ts.tv_sec = 1; + ts.tv_nsec = 0; + bsd_timeout(bstp_tick, bs, &ts); } -void -bstp_timer_start(struct bridge_timer *t, uint16_t v) +static void +bstp_timer_start(struct bstp_timer *t, uint16_t v) { t->value = v; t->active = 1; + t->latched = 0; } -void -bstp_timer_stop(struct bridge_timer *t) +static void +bstp_timer_stop(struct bstp_timer *t) { t->value = 0; t->active = 0; + t->latched = 0; } -int -bstp_timer_expired(struct bridge_timer *t, uint16_t v) +static void +bstp_timer_latch(struct bstp_timer *t) +{ + t->latched = 1; + t->active = 1; +} + +static int +bstp_timer_expired(struct bstp_timer *t) { - if (t->active == 0) + if (t->active == 0 || t->latched) return (0); - t->value += BSTP_TICK_VAL; - if (t->value >= v) { + t->value -= BSTP_TICK_VAL; + if (t->value <= 0) { bstp_timer_stop(t); return (1); } return (0); +} + +static void +bstp_hello_timer_expiry(struct bstp_state *bs, struct bstp_port *bp) +{ + if ((bp->bp_flags & BSTP_PORT_NEWINFO) || + bp->bp_role == BSTP_ROLE_DESIGNATED || + (bp->bp_role == BSTP_ROLE_ROOT && + bp->bp_tc_timer.active == 1)) { + bstp_timer_start(&bp->bp_hello_timer, bp->bp_desg_htime); + bp->bp_flags |= BSTP_PORT_NEWINFO; + bstp_transmit(bs, bp); + } +} + +static void +bstp_message_age_expiry(struct bstp_state *bs, struct bstp_port *bp) +{ + if (bp->bp_infois == BSTP_INFO_RECEIVED) { + bp->bp_infois = BSTP_INFO_AGED; + bstp_assign_roles(bs); + DPRINTF("aged info on %s\n", bp->bp_ifp->if_xname); + } +} + +static void +bstp_migrate_delay_expiry(__unused struct bstp_state *bs, struct bstp_port *bp) +{ + bp->bp_flags |= BSTP_PORT_CANMIGRATE; +} +static void +bstp_edge_delay_expiry(__unused struct bstp_state *bs, struct bstp_port *bp) +{ + if ((bp->bp_flags & BSTP_PORT_AUTOEDGE) && + bp->bp_protover == BSTP_PROTO_RSTP && bp->bp_proposing && + bp->bp_role == BSTP_ROLE_DESIGNATED) { + bp->bp_operedge = 1; + DPRINTF("%s -> edge port\n", bp->bp_ifp->if_xname); + } +} + +static int +bstp_addr_cmp(const uint8_t *a, const uint8_t *b) +{ + int i, d; + + for (i = 0, d = 0; i < ETHER_ADDR_LEN && d == 0; i++) { + d = ((int)a[i]) - ((int)b[i]); + } + + return (d); } + +/* + * compare the bridge address component of the bridgeid + */ +static int +bstp_same_bridgeid(uint64_t id1, uint64_t id2) +{ + u_char addr1[ETHER_ADDR_LEN]; + u_char addr2[ETHER_ADDR_LEN]; + + PV2ADDR(id1, addr1); + PV2ADDR(id2, addr2); + + if (bstp_addr_cmp(addr1, addr2) == 0) + return (1); + + return (0); +} + +void +bstp_reinit(struct bstp_state *bs) +{ + struct bstp_port *bp; + struct ifnet *ifp, *mif; + u_char *e_addr; + static const u_char llzero[ETHER_ADDR_LEN]; /* 00:00:00:00:00:00 */ + + BSTP_LOCK_ASSERT(bs); + + mif = NULL; + /* + * Search through the Ethernet adapters and find the one with the + * lowest value. The adapter which we take the MAC address from does + * not need to be part of the bridge, it just needs to be a unique + * value. + */ + ifnet_head_lock_shared(); + TAILQ_FOREACH(ifp, &ifnet_head, if_link) { + if (ifp->if_type != IFT_ETHER) + continue; + + if (bstp_addr_cmp(IF_LLADDR(ifp), llzero) == 0) + continue; + + if (mif == NULL) { + mif = ifp; + continue; + } + if (bstp_addr_cmp(IF_LLADDR(ifp), IF_LLADDR(mif)) < 0) { + mif = ifp; + continue; + } + } + ifnet_head_done(); + + if (LIST_EMPTY(&bs->bs_bplist) || mif == NULL) { + /* Set the bridge and root id (lower bits) to zero */ + bs->bs_bridge_pv.pv_dbridge_id = + ((uint64_t)bs->bs_bridge_priority) << 48; + bs->bs_bridge_pv.pv_root_id = bs->bs_bridge_pv.pv_dbridge_id; + bs->bs_root_pv = bs->bs_bridge_pv; + /* Disable any remaining ports, they will have no MAC address */ + LIST_FOREACH(bp, &bs->bs_bplist, bp_next) { + bp->bp_infois = BSTP_INFO_DISABLED; + bstp_set_port_role(bp, BSTP_ROLE_DISABLED); + } + bsd_untimeout(bstp_tick, bs); + return; + } + + e_addr = IF_LLADDR(mif); + bs->bs_bridge_pv.pv_dbridge_id = + (((uint64_t)bs->bs_bridge_priority) << 48) | + (((uint64_t)e_addr[0]) << 40) | + (((uint64_t)e_addr[1]) << 32) | + (((uint64_t)e_addr[2]) << 24) | + (((uint64_t)e_addr[3]) << 16) | + (((uint64_t)e_addr[4]) << 8) | + (((uint64_t)e_addr[5])); + + bs->bs_bridge_pv.pv_root_id = bs->bs_bridge_pv.pv_dbridge_id; + bs->bs_bridge_pv.pv_cost = 0; + bs->bs_bridge_pv.pv_dport_id = 0; + bs->bs_bridge_pv.pv_port_id = 0; + + if (bs->bs_running) + bsd_untimeout(bstp_tick, bs); + + LIST_FOREACH(bp, &bs->bs_bplist, bp_next) { + bp->bp_port_id = (bp->bp_priority << 8) | + (bp->bp_ifp->if_index & 0xfff); + bstp_ifupdstatus(bs, bp); + } + + bstp_assign_roles(bs); + bstp_timer_start(&bs->bs_link_timer, BSTP_LINK_TIMER); +} + +void +bstp_attach(struct bstp_state *bs, struct bstp_cb_ops *cb) +{ + BSTP_LOCK_INIT(bs); + LIST_INIT(&bs->bs_bplist); + + bs->bs_bridge_max_age = BSTP_DEFAULT_MAX_AGE; + bs->bs_bridge_htime = BSTP_DEFAULT_HELLO_TIME; + bs->bs_bridge_fdelay = BSTP_DEFAULT_FORWARD_DELAY; + bs->bs_bridge_priority = BSTP_DEFAULT_BRIDGE_PRIORITY; + bs->bs_hold_time = BSTP_DEFAULT_HOLD_TIME; + bs->bs_migration_delay = BSTP_DEFAULT_MIGRATE_DELAY; + bs->bs_txholdcount = BSTP_DEFAULT_HOLD_COUNT; + bs->bs_protover = BSTP_PROTO_RSTP; + bs->bs_state_cb = cb->bcb_state; + bs->bs_rtage_cb = cb->bcb_rtage; + + /* reviewed for getmicrotime usage */ + getmicrotime(&bs->bs_last_tc_time); + + lck_mtx_lock(bstp_list_mtx); + LIST_INSERT_HEAD(&bstp_list, bs, bs_list); + lck_mtx_unlock(bstp_list_mtx); +} + +void +bstp_detach(struct bstp_state *bs) +{ + KASSERT(LIST_EMPTY(&bs->bs_bplist), ("bstp still active")); + + lck_mtx_lock(bstp_list_mtx); + LIST_REMOVE(bs, bs_list); + lck_mtx_unlock(bstp_list_mtx); + bsd_untimeout(bstp_tick, bs); + BSTP_LOCK_DESTROY(bs); +} + +void +bstp_init(struct bstp_state *bs) +{ + struct timespec ts; + + ts.tv_sec = 1; + ts.tv_nsec = 0; + + BSTP_LOCK(bs); + bsd_timeout(bstp_tick, bs, &ts); + bs->bs_running = 1; + bstp_reinit(bs); + BSTP_UNLOCK(bs); +} + +void +bstp_stop(struct bstp_state *bs) +{ + struct bstp_port *bp; + + BSTP_LOCK(bs); + + LIST_FOREACH(bp, &bs->bs_bplist, bp_next) + bstp_set_port_state(bp, BSTP_IFSTATE_DISCARDING); + + bs->bs_running = 0; + bsd_untimeout(bstp_tick, bs); + BSTP_UNLOCK(bs); +} + +int +bstp_create(struct bstp_state *bs, struct bstp_port *bp, struct ifnet *ifp) +{ + bzero(bp, sizeof(struct bstp_port)); + + BSTP_LOCK(bs); + bp->bp_ifp = ifp; + bp->bp_bs = bs; + bp->bp_priority = BSTP_DEFAULT_PORT_PRIORITY; + BSTP_TASK_INIT(&bp->bp_statetask, bstp_notify_state, bp); + BSTP_TASK_INIT(&bp->bp_rtagetask, bstp_notify_rtage, bp); + + /* Init state */ + bp->bp_infois = BSTP_INFO_DISABLED; + bp->bp_flags = BSTP_PORT_AUTOEDGE|BSTP_PORT_AUTOPTP; + bstp_set_port_state(bp, BSTP_IFSTATE_DISCARDING); + bstp_set_port_proto(bp, bs->bs_protover); + bstp_set_port_role(bp, BSTP_ROLE_DISABLED); + bstp_set_port_tc(bp, BSTP_TCSTATE_INACTIVE); + bp->bp_path_cost = bstp_calc_path_cost(bp); + BSTP_UNLOCK(bs); + return (0); +} + +int +bstp_enable(struct bstp_port *bp) +{ + struct bstp_state *bs = bp->bp_bs; + struct ifnet *ifp = bp->bp_ifp; + + KASSERT(bp->bp_active == 0, ("already a bstp member")); + + switch (ifp->if_type) { + case IFT_ETHER: /* These can do spanning tree. */ + break; + default: + /* Nothing else can. */ + return (EINVAL); + } + + BSTP_LOCK(bs); + LIST_INSERT_HEAD(&bs->bs_bplist, bp, bp_next); + bp->bp_active = 1; + bp->bp_flags |= BSTP_PORT_NEWINFO; + bstp_reinit(bs); + bstp_update_roles(bs, bp); + BSTP_UNLOCK(bs); + return (0); +} + +void +bstp_disable(struct bstp_port *bp) +{ + struct bstp_state *bs = bp->bp_bs; + + KASSERT(bp->bp_active == 1, ("not a bstp member")); + + BSTP_LOCK(bs); + bstp_disable_port(bs, bp); + LIST_REMOVE(bp, bp_next); + bp->bp_active = 0; + bstp_reinit(bs); + BSTP_UNLOCK(bs); +} + +/* + * The bstp_port structure is about to be freed by the parent bridge. + */ +void +bstp_destroy(struct bstp_port *bp) +{ + KASSERT(bp->bp_active == 0, ("port is still attached")); + bstp_task_drain(&bp->bp_statetask); + bstp_task_drain(&bp->bp_rtagetask); +} + + +__private_extern__ void +bstp_sys_init(void) +{ + lck_grp_attr_t *lck_grp_attr = NULL; + + lck_grp_attr = lck_grp_attr_alloc_init(); + bstp_lock_grp = lck_grp_alloc_init("bstp", lck_grp_attr); + bstp_lock_attr = lck_attr_alloc_init(); +#if BRIDGE_DEBUG + lck_attr_setdebug(bstp_lock_attr); +#endif + lck_mtx_init(bstp_list_mtx, bstp_lock_grp, bstp_lock_attr); + lck_grp_attr_free(lck_grp_attr); + + LIST_INIT(&bstp_list); + + bstp_create_task_thread(); +} + + + +static void +bstp_create_task_thread(void) +{ + kern_return_t error; + + lck_grp_attr_t *lck_grp_attr = NULL; + + lck_grp_attr = lck_grp_attr_alloc_init(); + bstp_task_grp = lck_grp_alloc_init("bstp_task", lck_grp_attr); + bstp_task_attr = lck_attr_alloc_init(); +#if BRIDGE_DEBUG + lck_attr_setdebug(bstp_task_attr); +#endif + lck_mtx_init(bstp_task_mtx, bstp_lock_grp, bstp_lock_attr); + lck_grp_attr_free(lck_grp_attr); + + error = kernel_thread_start((thread_continue_t)bstp_task_thread_func, NULL, &bstp_task_thread); +} + + +static void +bstp_task_thread_func(void) +{ + struct bstp_task *bt, *tvar; + + lck_mtx_lock(bstp_task_mtx); + + do { + while(TAILQ_EMPTY(&bstp_task_queue)) { + wakeup(&bstp_task_queue_running); + msleep(&bstp_task_queue, bstp_task_mtx, PZERO, "bstp_task_queue", NULL); + } + + TAILQ_FOREACH_SAFE(bt, &bstp_task_queue, bt_next, tvar) { + int count = bt->bt_count; + + bt->bt_count = 0; + + bstp_task_queue_running = bt; + lck_mtx_unlock(bstp_task_mtx); + + (*bt->bt_func)(bt->bt_context, count); + + lck_mtx_lock(bstp_task_mtx); + bstp_task_queue_running = NULL; + + if (bt->bt_count == 0) + TAILQ_REMOVE(&bstp_task_queue, bt, bt_next); + } + } while (1); + + /* UNREACHED */ +} + +static void +bstp_task_enqueue(struct bstp_task *bt) +{ + lck_mtx_lock(bstp_task_mtx); + + if (bt->bt_count) { + bt->bt_count++; + lck_mtx_unlock(bstp_task_mtx); + wakeup(&bstp_task_queue); + return; + } + + bt->bt_count = 1; + TAILQ_INSERT_TAIL(&bstp_task_queue, bt, bt_next); + + lck_mtx_unlock(bstp_task_mtx); + + wakeup(&bstp_task_queue); +} + +static void +bstp_task_drain(struct bstp_task *bt) +{ + lck_mtx_lock(bstp_task_mtx); + + while (bt->bt_count != 0 || bstp_task_queue_running == bt) { + wakeup(&bstp_task_queue); + msleep(&bstp_task_queue_running, bstp_task_mtx, PZERO, "bstp_task_queue", NULL); + } + lck_mtx_unlock(bstp_task_mtx); +} + +