1 /* $NetBSD: ieee8023ad_lacp.c,v 1.3 2005/12/11 12:24:54 christos Exp $ */
4 * Copyright (c)2005 YAMAMOTO Takashi,
5 * Copyright (c)2008 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 AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/param.h>
34 #include <sys/callout.h>
35 #include <sys/eventhandler.h>
37 #include <sys/systm.h>
38 #include <sys/malloc.h>
39 #include <sys/kernel.h> /* hz */
40 #include <sys/socket.h> /* for net/if.h */
41 #include <sys/sockio.h>
42 #include <sys/sysctl.h>
43 #include <machine/stdarg.h>
45 #include <sys/rwlock.h>
46 #include <sys/taskqueue.h>
49 #include <net/if_var.h>
50 #include <net/if_dl.h>
51 #include <net/ethernet.h>
52 #include <net/if_media.h>
53 #include <net/if_types.h>
55 #include <net/if_lagg.h>
56 #include <net/ieee8023ad_lacp.h>
59 * actor system priority and port priority.
60 * XXX should be configurable.
63 #define LACP_SYSTEM_PRIO 0x8000
64 #define LACP_PORT_PRIO 0x8000
66 const uint8_t ethermulticastaddr_slowprotocols[ETHER_ADDR_LEN] =
67 { 0x01, 0x80, 0xc2, 0x00, 0x00, 0x02 };
69 static const struct tlv_template lacp_info_tlv_template[] = {
70 { LACP_TYPE_ACTORINFO,
71 sizeof(struct tlvhdr) + sizeof(struct lacp_peerinfo) },
72 { LACP_TYPE_PARTNERINFO,
73 sizeof(struct tlvhdr) + sizeof(struct lacp_peerinfo) },
74 { LACP_TYPE_COLLECTORINFO,
75 sizeof(struct tlvhdr) + sizeof(struct lacp_collectorinfo) },
79 static const struct tlv_template marker_info_tlv_template[] = {
81 sizeof(struct tlvhdr) + sizeof(struct lacp_markerinfo) },
85 static const struct tlv_template marker_response_tlv_template[] = {
86 { MARKER_TYPE_RESPONSE,
87 sizeof(struct tlvhdr) + sizeof(struct lacp_markerinfo) },
91 typedef void (*lacp_timer_func_t)(struct lacp_port *);
93 static void lacp_fill_actorinfo(struct lacp_port *, struct lacp_peerinfo *);
94 static void lacp_fill_markerinfo(struct lacp_port *,
95 struct lacp_markerinfo *);
97 static uint64_t lacp_aggregator_bandwidth(struct lacp_aggregator *);
98 static void lacp_suppress_distributing(struct lacp_softc *,
99 struct lacp_aggregator *);
100 static void lacp_transit_expire(void *);
101 static void lacp_update_portmap(struct lacp_softc *);
102 static void lacp_select_active_aggregator(struct lacp_softc *);
103 static uint16_t lacp_compose_key(struct lacp_port *);
104 static int tlv_check(const void *, size_t, const struct tlvhdr *,
105 const struct tlv_template *, boolean_t);
106 static void lacp_tick(void *);
108 static void lacp_fill_aggregator_id(struct lacp_aggregator *,
109 const struct lacp_port *);
110 static void lacp_fill_aggregator_id_peer(struct lacp_peerinfo *,
111 const struct lacp_peerinfo *);
112 static int lacp_aggregator_is_compatible(const struct lacp_aggregator *,
113 const struct lacp_port *);
114 static int lacp_peerinfo_is_compatible(const struct lacp_peerinfo *,
115 const struct lacp_peerinfo *);
117 static struct lacp_aggregator *lacp_aggregator_get(struct lacp_softc *,
119 static void lacp_aggregator_addref(struct lacp_softc *,
120 struct lacp_aggregator *);
121 static void lacp_aggregator_delref(struct lacp_softc *,
122 struct lacp_aggregator *);
124 /* receive machine */
126 static int lacp_pdu_input(struct lacp_port *, struct mbuf *);
127 static int lacp_marker_input(struct lacp_port *, struct mbuf *);
128 static void lacp_sm_rx(struct lacp_port *, const struct lacpdu *);
129 static void lacp_sm_rx_timer(struct lacp_port *);
130 static void lacp_sm_rx_set_expired(struct lacp_port *);
131 static void lacp_sm_rx_update_ntt(struct lacp_port *,
132 const struct lacpdu *);
133 static void lacp_sm_rx_record_pdu(struct lacp_port *,
134 const struct lacpdu *);
135 static void lacp_sm_rx_update_selected(struct lacp_port *,
136 const struct lacpdu *);
137 static void lacp_sm_rx_record_default(struct lacp_port *);
138 static void lacp_sm_rx_update_default_selected(struct lacp_port *);
139 static void lacp_sm_rx_update_selected_from_peerinfo(struct lacp_port *,
140 const struct lacp_peerinfo *);
144 static void lacp_sm_mux(struct lacp_port *);
145 static void lacp_set_mux(struct lacp_port *, enum lacp_mux_state);
146 static void lacp_sm_mux_timer(struct lacp_port *);
148 /* periodic transmit machine */
150 static void lacp_sm_ptx_update_timeout(struct lacp_port *, uint8_t);
151 static void lacp_sm_ptx_tx_schedule(struct lacp_port *);
152 static void lacp_sm_ptx_timer(struct lacp_port *);
154 /* transmit machine */
156 static void lacp_sm_tx(struct lacp_port *);
157 static void lacp_sm_assert_ntt(struct lacp_port *);
159 static void lacp_run_timers(struct lacp_port *);
160 static int lacp_compare_peerinfo(const struct lacp_peerinfo *,
161 const struct lacp_peerinfo *);
162 static int lacp_compare_systemid(const struct lacp_systemid *,
163 const struct lacp_systemid *);
164 static void lacp_port_enable(struct lacp_port *);
165 static void lacp_port_disable(struct lacp_port *);
166 static void lacp_select(struct lacp_port *);
167 static void lacp_unselect(struct lacp_port *);
168 static void lacp_disable_collecting(struct lacp_port *);
169 static void lacp_enable_collecting(struct lacp_port *);
170 static void lacp_disable_distributing(struct lacp_port *);
171 static void lacp_enable_distributing(struct lacp_port *);
172 static int lacp_xmit_lacpdu(struct lacp_port *);
173 static int lacp_xmit_marker(struct lacp_port *);
177 static void lacp_dump_lacpdu(const struct lacpdu *);
178 static const char *lacp_format_partner(const struct lacp_peerinfo *, char *,
180 static const char *lacp_format_lagid(const struct lacp_peerinfo *,
181 const struct lacp_peerinfo *, char *, size_t);
182 static const char *lacp_format_lagid_aggregator(const struct lacp_aggregator *,
184 static const char *lacp_format_state(uint8_t, char *, size_t);
185 static const char *lacp_format_mac(const uint8_t *, char *, size_t);
186 static const char *lacp_format_systemid(const struct lacp_systemid *, char *,
188 static const char *lacp_format_portid(const struct lacp_portid *, char *,
190 static void lacp_dprintf(const struct lacp_port *, const char *, ...)
191 __attribute__((__format__(__printf__, 2, 3)));
193 static int lacp_debug = 0;
194 SYSCTL_NODE(_net_link_lagg, OID_AUTO, lacp, CTLFLAG_RD, 0, "ieee802.3ad");
195 SYSCTL_INT(_net_link_lagg_lacp, OID_AUTO, debug, CTLFLAG_RWTUN,
196 &lacp_debug, 0, "Enable LACP debug logging (1=debug, 2=trace)");
198 #define LACP_DPRINTF(a) if (lacp_debug & 0x01) { lacp_dprintf a ; }
199 #define LACP_TRACE(a) if (lacp_debug & 0x02) { lacp_dprintf(a,"%s\n",__func__); }
200 #define LACP_TPRINTF(a) if (lacp_debug & 0x04) { lacp_dprintf a ; }
203 * partner administration variables.
204 * XXX should be configurable.
207 static const struct lacp_peerinfo lacp_partner_admin_optimistic = {
208 .lip_systemid = { .lsi_prio = 0xffff },
209 .lip_portid = { .lpi_prio = 0xffff },
210 .lip_state = LACP_STATE_SYNC | LACP_STATE_AGGREGATION |
211 LACP_STATE_COLLECTING | LACP_STATE_DISTRIBUTING,
214 static const struct lacp_peerinfo lacp_partner_admin_strict = {
215 .lip_systemid = { .lsi_prio = 0xffff },
216 .lip_portid = { .lpi_prio = 0xffff },
220 static const lacp_timer_func_t lacp_timer_funcs[LACP_NTIMER] = {
221 [LACP_TIMER_CURRENT_WHILE] = lacp_sm_rx_timer,
222 [LACP_TIMER_PERIODIC] = lacp_sm_ptx_timer,
223 [LACP_TIMER_WAIT_WHILE] = lacp_sm_mux_timer,
227 lacp_input(struct lagg_port *lgp, struct mbuf *m)
229 struct lacp_port *lp = LACP_PORT(lgp);
232 if (m->m_pkthdr.len < sizeof(struct ether_header) + sizeof(subtype)) {
237 m_copydata(m, sizeof(struct ether_header), sizeof(subtype), &subtype);
239 case SLOWPROTOCOLS_SUBTYPE_LACP:
240 lacp_pdu_input(lp, m);
243 case SLOWPROTOCOLS_SUBTYPE_MARKER:
244 lacp_marker_input(lp, m);
248 /* Not a subtype we are interested in */
253 * lacp_pdu_input: process lacpdu
256 lacp_pdu_input(struct lacp_port *lp, struct mbuf *m)
258 struct lacp_softc *lsc = lp->lp_lsc;
262 if (m->m_pkthdr.len != sizeof(*du)) {
266 if ((m->m_flags & M_MCAST) == 0) {
270 if (m->m_len < sizeof(*du)) {
271 m = m_pullup(m, sizeof(*du));
277 du = mtod(m, struct lacpdu *);
279 if (memcmp(&du->ldu_eh.ether_dhost,
280 ðermulticastaddr_slowprotocols, ETHER_ADDR_LEN)) {
285 * ignore the version for compatibility with
286 * the future protocol revisions.
289 if (du->ldu_sph.sph_version != 1) {
295 * ignore tlv types for compatibility with
296 * the future protocol revisions.
298 if (tlv_check(du, sizeof(*du), &du->ldu_tlv_actor,
299 lacp_info_tlv_template, FALSE)) {
303 if (lacp_debug > 0) {
304 lacp_dprintf(lp, "lacpdu receive\n");
305 lacp_dump_lacpdu(du);
308 if ((1 << lp->lp_ifp->if_dunit) & lp->lp_lsc->lsc_debug.lsc_rx_test) {
309 LACP_TPRINTF((lp, "Dropping RX PDU\n"));
326 lacp_fill_actorinfo(struct lacp_port *lp, struct lacp_peerinfo *info)
328 struct lagg_port *lgp = lp->lp_lagg;
329 struct lagg_softc *sc = lgp->lp_softc;
331 info->lip_systemid.lsi_prio = htons(LACP_SYSTEM_PRIO);
332 memcpy(&info->lip_systemid.lsi_mac,
333 IF_LLADDR(sc->sc_ifp), ETHER_ADDR_LEN);
334 info->lip_portid.lpi_prio = htons(LACP_PORT_PRIO);
335 info->lip_portid.lpi_portno = htons(lp->lp_ifp->if_index);
336 info->lip_state = lp->lp_state;
340 lacp_fill_markerinfo(struct lacp_port *lp, struct lacp_markerinfo *info)
342 struct ifnet *ifp = lp->lp_ifp;
344 /* Fill in the port index and system id (encoded as the MAC) */
345 info->mi_rq_port = htons(ifp->if_index);
346 memcpy(&info->mi_rq_system, lp->lp_systemid.lsi_mac, ETHER_ADDR_LEN);
347 info->mi_rq_xid = htonl(0);
351 lacp_xmit_lacpdu(struct lacp_port *lp)
353 struct lagg_port *lgp = lp->lp_lagg;
358 LACP_LOCK_ASSERT(lp->lp_lsc);
360 m = m_gethdr(M_NOWAIT, MT_DATA);
364 m->m_len = m->m_pkthdr.len = sizeof(*du);
366 du = mtod(m, struct lacpdu *);
367 memset(du, 0, sizeof(*du));
369 memcpy(&du->ldu_eh.ether_dhost, ethermulticastaddr_slowprotocols,
371 memcpy(&du->ldu_eh.ether_shost, lgp->lp_lladdr, ETHER_ADDR_LEN);
372 du->ldu_eh.ether_type = htons(ETHERTYPE_SLOW);
374 du->ldu_sph.sph_subtype = SLOWPROTOCOLS_SUBTYPE_LACP;
375 du->ldu_sph.sph_version = 1;
377 TLV_SET(&du->ldu_tlv_actor, LACP_TYPE_ACTORINFO, sizeof(du->ldu_actor));
378 du->ldu_actor = lp->lp_actor;
380 TLV_SET(&du->ldu_tlv_partner, LACP_TYPE_PARTNERINFO,
381 sizeof(du->ldu_partner));
382 du->ldu_partner = lp->lp_partner;
384 TLV_SET(&du->ldu_tlv_collector, LACP_TYPE_COLLECTORINFO,
385 sizeof(du->ldu_collector));
386 du->ldu_collector.lci_maxdelay = 0;
388 if (lacp_debug > 0) {
389 lacp_dprintf(lp, "lacpdu transmit\n");
390 lacp_dump_lacpdu(du);
393 m->m_flags |= M_MCAST;
396 * XXX should use higher priority queue.
397 * otherwise network congestion can break aggregation.
400 error = lagg_enqueue(lp->lp_ifp, m);
405 lacp_xmit_marker(struct lacp_port *lp)
407 struct lagg_port *lgp = lp->lp_lagg;
409 struct markerdu *mdu;
412 LACP_LOCK_ASSERT(lp->lp_lsc);
414 m = m_gethdr(M_NOWAIT, MT_DATA);
418 m->m_len = m->m_pkthdr.len = sizeof(*mdu);
420 mdu = mtod(m, struct markerdu *);
421 memset(mdu, 0, sizeof(*mdu));
423 memcpy(&mdu->mdu_eh.ether_dhost, ethermulticastaddr_slowprotocols,
425 memcpy(&mdu->mdu_eh.ether_shost, lgp->lp_lladdr, ETHER_ADDR_LEN);
426 mdu->mdu_eh.ether_type = htons(ETHERTYPE_SLOW);
428 mdu->mdu_sph.sph_subtype = SLOWPROTOCOLS_SUBTYPE_MARKER;
429 mdu->mdu_sph.sph_version = 1;
431 /* Bump the transaction id and copy over the marker info */
432 lp->lp_marker.mi_rq_xid = htonl(ntohl(lp->lp_marker.mi_rq_xid) + 1);
433 TLV_SET(&mdu->mdu_tlv, MARKER_TYPE_INFO, sizeof(mdu->mdu_info));
434 mdu->mdu_info = lp->lp_marker;
436 LACP_DPRINTF((lp, "marker transmit, port=%u, sys=%6D, id=%u\n",
437 ntohs(mdu->mdu_info.mi_rq_port), mdu->mdu_info.mi_rq_system, ":",
438 ntohl(mdu->mdu_info.mi_rq_xid)));
440 m->m_flags |= M_MCAST;
441 error = lagg_enqueue(lp->lp_ifp, m);
446 lacp_linkstate(struct lagg_port *lgp)
448 struct lacp_port *lp = LACP_PORT(lgp);
449 struct lacp_softc *lsc = lp->lp_lsc;
450 struct ifnet *ifp = lgp->lp_ifp;
451 struct ifmediareq ifmr;
457 bzero((char *)&ifmr, sizeof(ifmr));
458 error = (*ifp->if_ioctl)(ifp, SIOCGIFMEDIA, (caddr_t)&ifmr);
463 media = ifmr.ifm_active;
464 LACP_DPRINTF((lp, "media changed 0x%x -> 0x%x, ether = %d, fdx = %d, "
465 "link = %d\n", lp->lp_media, media, IFM_TYPE(media) == IFM_ETHER,
466 (media & IFM_FDX) != 0, ifp->if_link_state == LINK_STATE_UP));
467 old_state = lp->lp_state;
468 old_key = lp->lp_key;
470 lp->lp_media = media;
472 * If the port is not an active full duplex Ethernet link then it can
475 if (IFM_TYPE(media) != IFM_ETHER || (media & IFM_FDX) == 0 ||
476 ifp->if_link_state != LINK_STATE_UP) {
477 lacp_port_disable(lp);
479 lacp_port_enable(lp);
481 lp->lp_key = lacp_compose_key(lp);
483 if (old_state != lp->lp_state || old_key != lp->lp_key) {
484 LACP_DPRINTF((lp, "-> UNSELECTED\n"));
485 lp->lp_selected = LACP_UNSELECTED;
493 struct lacp_softc *lsc = arg;
494 struct lacp_port *lp;
496 LIST_FOREACH(lp, &lsc->lsc_ports, lp_next) {
497 if ((lp->lp_state & LACP_STATE_AGGREGATION) == 0)
505 lacp_sm_ptx_tx_schedule(lp);
507 callout_reset(&lsc->lsc_callout, hz, lacp_tick, lsc);
511 lacp_port_create(struct lagg_port *lgp)
513 struct lagg_softc *sc = lgp->lp_softc;
514 struct lacp_softc *lsc = LACP_SOFTC(sc);
515 struct lacp_port *lp;
516 struct ifnet *ifp = lgp->lp_ifp;
517 struct sockaddr_dl sdl;
518 struct ifmultiaddr *rifma = NULL;
521 boolean_t active = TRUE; /* XXX should be configurable */
522 boolean_t fast = FALSE; /* XXX should be configurable */
524 link_init_sdl(ifp, (struct sockaddr *)&sdl, IFT_ETHER);
525 sdl.sdl_alen = ETHER_ADDR_LEN;
527 bcopy(ðermulticastaddr_slowprotocols,
528 LLADDR(&sdl), ETHER_ADDR_LEN);
529 error = if_addmulti(ifp, (struct sockaddr *)&sdl, &rifma);
531 printf("%s: ADDMULTI failed on %s\n", __func__, lgp->lp_ifname);
535 lp = malloc(sizeof(struct lacp_port),
536 M_DEVBUF, M_NOWAIT|M_ZERO);
541 lgp->lp_psc = (caddr_t)lp;
547 LIST_INSERT_HEAD(&lsc->lsc_ports, lp, lp_next);
549 lacp_fill_actorinfo(lp, &lp->lp_actor);
550 lacp_fill_markerinfo(lp, &lp->lp_marker);
552 (active ? LACP_STATE_ACTIVITY : 0) |
553 (fast ? LACP_STATE_TIMEOUT : 0);
554 lp->lp_aggregator = NULL;
555 lacp_sm_rx_set_expired(lp);
563 lacp_port_destroy(struct lagg_port *lgp)
565 struct lacp_port *lp = LACP_PORT(lgp);
566 struct lacp_softc *lsc = lp->lp_lsc;
570 for (i = 0; i < LACP_NTIMER; i++) {
571 LACP_TIMER_DISARM(lp, i);
574 lacp_disable_collecting(lp);
575 lacp_disable_distributing(lp);
578 /* The address may have already been removed by if_purgemaddrs() */
579 if (!lgp->lp_detaching)
580 if_delmulti_ifma(lp->lp_ifma);
582 LIST_REMOVE(lp, lp_next);
588 lacp_req(struct lagg_softc *sc, caddr_t data)
590 struct lacp_opreq *req = (struct lacp_opreq *)data;
591 struct lacp_softc *lsc = LACP_SOFTC(sc);
592 struct lacp_aggregator *la;
594 bzero(req, sizeof(struct lacp_opreq));
597 * If the LACP softc is NULL, return with the opreq structure full of
598 * zeros. It is normal for the softc to be NULL while the lagg is
604 la = lsc->lsc_active_aggregator;
607 req->actor_prio = ntohs(la->la_actor.lip_systemid.lsi_prio);
608 memcpy(&req->actor_mac, &la->la_actor.lip_systemid.lsi_mac,
610 req->actor_key = ntohs(la->la_actor.lip_key);
611 req->actor_portprio = ntohs(la->la_actor.lip_portid.lpi_prio);
612 req->actor_portno = ntohs(la->la_actor.lip_portid.lpi_portno);
613 req->actor_state = la->la_actor.lip_state;
615 req->partner_prio = ntohs(la->la_partner.lip_systemid.lsi_prio);
616 memcpy(&req->partner_mac, &la->la_partner.lip_systemid.lsi_mac,
618 req->partner_key = ntohs(la->la_partner.lip_key);
619 req->partner_portprio = ntohs(la->la_partner.lip_portid.lpi_prio);
620 req->partner_portno = ntohs(la->la_partner.lip_portid.lpi_portno);
621 req->partner_state = la->la_partner.lip_state;
627 lacp_portreq(struct lagg_port *lgp, caddr_t data)
629 struct lacp_opreq *req = (struct lacp_opreq *)data;
630 struct lacp_port *lp = LACP_PORT(lgp);
631 struct lacp_softc *lsc = lp->lp_lsc;
634 req->actor_prio = ntohs(lp->lp_actor.lip_systemid.lsi_prio);
635 memcpy(&req->actor_mac, &lp->lp_actor.lip_systemid.lsi_mac,
637 req->actor_key = ntohs(lp->lp_actor.lip_key);
638 req->actor_portprio = ntohs(lp->lp_actor.lip_portid.lpi_prio);
639 req->actor_portno = ntohs(lp->lp_actor.lip_portid.lpi_portno);
640 req->actor_state = lp->lp_actor.lip_state;
642 req->partner_prio = ntohs(lp->lp_partner.lip_systemid.lsi_prio);
643 memcpy(&req->partner_mac, &lp->lp_partner.lip_systemid.lsi_mac,
645 req->partner_key = ntohs(lp->lp_partner.lip_key);
646 req->partner_portprio = ntohs(lp->lp_partner.lip_portid.lpi_prio);
647 req->partner_portno = ntohs(lp->lp_partner.lip_portid.lpi_portno);
648 req->partner_state = lp->lp_partner.lip_state;
653 lacp_disable_collecting(struct lacp_port *lp)
655 LACP_DPRINTF((lp, "collecting disabled\n"));
656 lp->lp_state &= ~LACP_STATE_COLLECTING;
660 lacp_enable_collecting(struct lacp_port *lp)
662 LACP_DPRINTF((lp, "collecting enabled\n"));
663 lp->lp_state |= LACP_STATE_COLLECTING;
667 lacp_disable_distributing(struct lacp_port *lp)
669 struct lacp_aggregator *la = lp->lp_aggregator;
670 struct lacp_softc *lsc = lp->lp_lsc;
671 struct lagg_softc *sc = lsc->lsc_softc;
672 char buf[LACP_LAGIDSTR_MAX+1];
674 LACP_LOCK_ASSERT(lsc);
676 if (la == NULL || (lp->lp_state & LACP_STATE_DISTRIBUTING) == 0) {
680 KASSERT(!TAILQ_EMPTY(&la->la_ports), ("no aggregator ports"));
681 KASSERT(la->la_nports > 0, ("nports invalid (%d)", la->la_nports));
682 KASSERT(la->la_refcnt >= la->la_nports, ("aggregator refcnt invalid"));
684 LACP_DPRINTF((lp, "disable distributing on aggregator %s, "
686 lacp_format_lagid_aggregator(la, buf, sizeof(buf)),
687 la->la_nports, la->la_nports - 1));
689 TAILQ_REMOVE(&la->la_ports, lp, lp_dist_q);
691 sc->sc_active = la->la_nports;
693 if (lsc->lsc_active_aggregator == la) {
694 lacp_suppress_distributing(lsc, la);
695 lacp_select_active_aggregator(lsc);
696 /* regenerate the port map, the active aggregator has changed */
697 lacp_update_portmap(lsc);
700 lp->lp_state &= ~LACP_STATE_DISTRIBUTING;
704 lacp_enable_distributing(struct lacp_port *lp)
706 struct lacp_aggregator *la = lp->lp_aggregator;
707 struct lacp_softc *lsc = lp->lp_lsc;
708 struct lagg_softc *sc = lsc->lsc_softc;
709 char buf[LACP_LAGIDSTR_MAX+1];
711 LACP_LOCK_ASSERT(lsc);
713 if ((lp->lp_state & LACP_STATE_DISTRIBUTING) != 0) {
717 LACP_DPRINTF((lp, "enable distributing on aggregator %s, "
719 lacp_format_lagid_aggregator(la, buf, sizeof(buf)),
720 la->la_nports, la->la_nports + 1));
722 KASSERT(la->la_refcnt > la->la_nports, ("aggregator refcnt invalid"));
723 TAILQ_INSERT_HEAD(&la->la_ports, lp, lp_dist_q);
725 sc->sc_active = la->la_nports;
727 lp->lp_state |= LACP_STATE_DISTRIBUTING;
729 if (lsc->lsc_active_aggregator == la) {
730 lacp_suppress_distributing(lsc, la);
731 lacp_update_portmap(lsc);
733 /* try to become the active aggregator */
734 lacp_select_active_aggregator(lsc);
738 lacp_transit_expire(void *vp)
740 struct lacp_softc *lsc = vp;
742 LACP_LOCK_ASSERT(lsc);
746 lsc->lsc_suppress_distributing = FALSE;
750 lacp_attach_sysctl(struct lacp_softc *lsc, struct sysctl_oid *p_oid)
752 struct lagg_softc *sc = lsc->lsc_softc;
754 SYSCTL_ADD_UINT(&sc->ctx, SYSCTL_CHILDREN(p_oid), OID_AUTO,
757 &lsc->lsc_strict_mode,
758 lsc->lsc_strict_mode,
759 "Enable LACP strict mode");
763 lacp_attach_sysctl_debug(struct lacp_softc *lsc, struct sysctl_oid *p_oid)
765 struct lagg_softc *sc = lsc->lsc_softc;
766 struct sysctl_oid *oid;
768 /* Create a child of the parent lagg interface */
769 oid = SYSCTL_ADD_NODE(&sc->ctx, SYSCTL_CHILDREN(p_oid),
770 OID_AUTO, "debug", CTLFLAG_RD, NULL, "DEBUG");
772 SYSCTL_ADD_UINT(&sc->ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
775 &lsc->lsc_debug.lsc_rx_test,
776 lsc->lsc_debug.lsc_rx_test,
777 "Bitmap of if_dunit entries to drop RX frames for");
778 SYSCTL_ADD_UINT(&sc->ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
781 &lsc->lsc_debug.lsc_tx_test,
782 lsc->lsc_debug.lsc_tx_test,
783 "Bitmap of if_dunit entries to drop TX frames for");
787 lacp_attach(struct lagg_softc *sc)
789 struct lacp_softc *lsc;
790 struct sysctl_oid *oid;
792 lsc = malloc(sizeof(struct lacp_softc),
793 M_DEVBUF, M_NOWAIT|M_ZERO);
797 sc->sc_psc = (caddr_t)lsc;
800 lsc->lsc_hashkey = arc4random();
801 lsc->lsc_active_aggregator = NULL;
802 lsc->lsc_strict_mode = 1;
804 TAILQ_INIT(&lsc->lsc_aggregators);
805 LIST_INIT(&lsc->lsc_ports);
807 /* Create a child of the parent lagg interface */
808 oid = SYSCTL_ADD_NODE(&sc->ctx, SYSCTL_CHILDREN(sc->sc_oid),
809 OID_AUTO, "lacp", CTLFLAG_RD, NULL, "LACP");
811 /* Attach sysctl nodes */
812 lacp_attach_sysctl(lsc, oid);
813 lacp_attach_sysctl_debug(lsc, oid);
815 callout_init_mtx(&lsc->lsc_transit_callout, &lsc->lsc_mtx, 0);
816 callout_init_mtx(&lsc->lsc_callout, &lsc->lsc_mtx, 0);
818 /* if the lagg is already up then do the same */
819 if (sc->sc_ifp->if_drv_flags & IFF_DRV_RUNNING)
826 lacp_detach(struct lagg_softc *sc)
828 struct lacp_softc *lsc = LACP_SOFTC(sc);
830 KASSERT(TAILQ_EMPTY(&lsc->lsc_aggregators),
831 ("aggregators still active"));
832 KASSERT(lsc->lsc_active_aggregator == NULL,
833 ("aggregator still attached"));
836 callout_drain(&lsc->lsc_transit_callout);
837 callout_drain(&lsc->lsc_callout);
839 LACP_LOCK_DESTROY(lsc);
845 lacp_init(struct lagg_softc *sc)
847 struct lacp_softc *lsc = LACP_SOFTC(sc);
850 callout_reset(&lsc->lsc_callout, hz, lacp_tick, lsc);
855 lacp_stop(struct lagg_softc *sc)
857 struct lacp_softc *lsc = LACP_SOFTC(sc);
860 callout_stop(&lsc->lsc_transit_callout);
861 callout_stop(&lsc->lsc_callout);
866 lacp_select_tx_port(struct lagg_softc *sc, struct mbuf *m)
868 struct lacp_softc *lsc = LACP_SOFTC(sc);
869 struct lacp_portmap *pm;
870 struct lacp_port *lp;
873 if (__predict_false(lsc->lsc_suppress_distributing)) {
874 LACP_DPRINTF((NULL, "%s: waiting transit\n", __func__));
878 pm = &lsc->lsc_pmap[lsc->lsc_activemap];
879 if (pm->pm_count == 0) {
880 LACP_DPRINTF((NULL, "%s: no active aggregator\n", __func__));
884 if (sc->use_flowid && (m->m_flags & M_FLOWID))
885 hash = m->m_pkthdr.flowid >> sc->flowid_shift;
887 hash = lagg_hashmbuf(sc, m, lsc->lsc_hashkey);
888 hash %= pm->pm_count;
889 lp = pm->pm_map[hash];
891 KASSERT((lp->lp_state & LACP_STATE_DISTRIBUTING) != 0,
892 ("aggregated port is not distributing"));
894 return (lp->lp_lagg);
897 * lacp_suppress_distributing: drop transmit packets for a while
898 * to preserve packet ordering.
902 lacp_suppress_distributing(struct lacp_softc *lsc, struct lacp_aggregator *la)
904 struct lacp_port *lp;
906 if (lsc->lsc_active_aggregator != la) {
912 lsc->lsc_suppress_distributing = TRUE;
914 /* send a marker frame down each port to verify the queues are empty */
915 LIST_FOREACH(lp, &lsc->lsc_ports, lp_next) {
916 lp->lp_flags |= LACP_PORT_MARK;
917 lacp_xmit_marker(lp);
920 /* set a timeout for the marker frames */
921 callout_reset(&lsc->lsc_transit_callout,
922 LACP_TRANSIT_DELAY * hz / 1000, lacp_transit_expire, lsc);
926 lacp_compare_peerinfo(const struct lacp_peerinfo *a,
927 const struct lacp_peerinfo *b)
929 return (memcmp(a, b, offsetof(struct lacp_peerinfo, lip_state)));
933 lacp_compare_systemid(const struct lacp_systemid *a,
934 const struct lacp_systemid *b)
936 return (memcmp(a, b, sizeof(*a)));
941 lacp_compare_portid(const struct lacp_portid *a,
942 const struct lacp_portid *b)
944 return (memcmp(a, b, sizeof(*a)));
949 lacp_aggregator_bandwidth(struct lacp_aggregator *la)
951 struct lacp_port *lp;
954 lp = TAILQ_FIRST(&la->la_ports);
959 speed = ifmedia_baudrate(lp->lp_media);
960 speed *= la->la_nports;
962 LACP_DPRINTF((lp, "speed 0? media=0x%x nports=%d\n",
963 lp->lp_media, la->la_nports));
970 * lacp_select_active_aggregator: select an aggregator to be used to transmit
971 * packets from lagg(4) interface.
975 lacp_select_active_aggregator(struct lacp_softc *lsc)
977 struct lacp_aggregator *la;
978 struct lacp_aggregator *best_la = NULL;
979 uint64_t best_speed = 0;
980 char buf[LACP_LAGIDSTR_MAX+1];
984 TAILQ_FOREACH(la, &lsc->lsc_aggregators, la_q) {
987 if (la->la_nports == 0) {
991 speed = lacp_aggregator_bandwidth(la);
992 LACP_DPRINTF((NULL, "%s, speed=%jd, nports=%d\n",
993 lacp_format_lagid_aggregator(la, buf, sizeof(buf)),
994 speed, la->la_nports));
996 /* This aggregator is chosen if
997 * the partner has a better system priority
998 * or, the total aggregated speed is higher
999 * or, it is already the chosen aggregator
1001 if ((best_la != NULL && LACP_SYS_PRI(la->la_partner) <
1002 LACP_SYS_PRI(best_la->la_partner)) ||
1003 speed > best_speed ||
1004 (speed == best_speed &&
1005 la == lsc->lsc_active_aggregator)) {
1011 KASSERT(best_la == NULL || best_la->la_nports > 0,
1012 ("invalid aggregator refcnt"));
1013 KASSERT(best_la == NULL || !TAILQ_EMPTY(&best_la->la_ports),
1014 ("invalid aggregator list"));
1016 if (lsc->lsc_active_aggregator != best_la) {
1017 LACP_DPRINTF((NULL, "active aggregator changed\n"));
1018 LACP_DPRINTF((NULL, "old %s\n",
1019 lacp_format_lagid_aggregator(lsc->lsc_active_aggregator,
1020 buf, sizeof(buf))));
1022 LACP_DPRINTF((NULL, "active aggregator not changed\n"));
1024 LACP_DPRINTF((NULL, "new %s\n",
1025 lacp_format_lagid_aggregator(best_la, buf, sizeof(buf))));
1027 if (lsc->lsc_active_aggregator != best_la) {
1028 lsc->lsc_active_aggregator = best_la;
1029 lacp_update_portmap(lsc);
1031 lacp_suppress_distributing(lsc, best_la);
1037 * Updated the inactive portmap array with the new list of ports and
1041 lacp_update_portmap(struct lacp_softc *lsc)
1043 struct lagg_softc *sc = lsc->lsc_softc;
1044 struct lacp_aggregator *la;
1045 struct lacp_portmap *p;
1046 struct lacp_port *lp;
1051 newmap = lsc->lsc_activemap == 0 ? 1 : 0;
1052 p = &lsc->lsc_pmap[newmap];
1053 la = lsc->lsc_active_aggregator;
1055 bzero(p, sizeof(struct lacp_portmap));
1057 if (la != NULL && la->la_nports > 0) {
1058 p->pm_count = la->la_nports;
1060 TAILQ_FOREACH(lp, &la->la_ports, lp_dist_q)
1061 p->pm_map[i++] = lp;
1062 KASSERT(i == p->pm_count, ("Invalid port count"));
1063 speed = lacp_aggregator_bandwidth(la);
1065 sc->sc_ifp->if_baudrate = speed;
1067 /* switch the active portmap over */
1068 atomic_store_rel_int(&lsc->lsc_activemap, newmap);
1069 LACP_DPRINTF((NULL, "Set table %d with %d ports\n",
1071 lsc->lsc_pmap[lsc->lsc_activemap].pm_count));
1075 lacp_compose_key(struct lacp_port *lp)
1077 struct lagg_port *lgp = lp->lp_lagg;
1078 struct lagg_softc *sc = lgp->lp_softc;
1079 u_int media = lp->lp_media;
1082 if ((lp->lp_state & LACP_STATE_AGGREGATION) == 0) {
1085 * non-aggregatable links should have unique keys.
1087 * XXX this isn't really unique as if_index is 16 bit.
1090 /* bit 0..14: (some bits of) if_index of this port */
1091 key = lp->lp_ifp->if_index;
1095 u_int subtype = IFM_SUBTYPE(media);
1097 KASSERT(IFM_TYPE(media) == IFM_ETHER, ("invalid media type"));
1098 KASSERT((media & IFM_FDX) != 0, ("aggregating HDX interface"));
1100 /* bit 0..4: IFM_SUBTYPE modulo speed */
1125 case IFM_10G_TWINAX:
1126 case IFM_10G_TWINAX_LONG:
1139 /* bit 5..14: (some bits of) if_index of lagg device */
1140 key |= 0x7fe0 & ((sc->sc_ifp->if_index) << 5);
1143 return (htons(key));
1147 lacp_aggregator_addref(struct lacp_softc *lsc, struct lacp_aggregator *la)
1149 char buf[LACP_LAGIDSTR_MAX+1];
1151 LACP_DPRINTF((NULL, "%s: lagid=%s, refcnt %d -> %d\n",
1153 lacp_format_lagid(&la->la_actor, &la->la_partner,
1155 la->la_refcnt, la->la_refcnt + 1));
1157 KASSERT(la->la_refcnt > 0, ("refcount <= 0"));
1159 KASSERT(la->la_refcnt > la->la_nports, ("invalid refcount"));
1163 lacp_aggregator_delref(struct lacp_softc *lsc, struct lacp_aggregator *la)
1165 char buf[LACP_LAGIDSTR_MAX+1];
1167 LACP_DPRINTF((NULL, "%s: lagid=%s, refcnt %d -> %d\n",
1169 lacp_format_lagid(&la->la_actor, &la->la_partner,
1171 la->la_refcnt, la->la_refcnt - 1));
1173 KASSERT(la->la_refcnt > la->la_nports, ("invalid refcnt"));
1175 if (la->la_refcnt > 0) {
1179 KASSERT(la->la_refcnt == 0, ("refcount not zero"));
1180 KASSERT(lsc->lsc_active_aggregator != la, ("aggregator active"));
1182 TAILQ_REMOVE(&lsc->lsc_aggregators, la, la_q);
1188 * lacp_aggregator_get: allocate an aggregator.
1191 static struct lacp_aggregator *
1192 lacp_aggregator_get(struct lacp_softc *lsc, struct lacp_port *lp)
1194 struct lacp_aggregator *la;
1196 la = malloc(sizeof(*la), M_DEVBUF, M_NOWAIT);
1200 TAILQ_INIT(&la->la_ports);
1202 TAILQ_INSERT_TAIL(&lsc->lsc_aggregators, la, la_q);
1209 * lacp_fill_aggregator_id: setup a newly allocated aggregator from a port.
1213 lacp_fill_aggregator_id(struct lacp_aggregator *la, const struct lacp_port *lp)
1215 lacp_fill_aggregator_id_peer(&la->la_partner, &lp->lp_partner);
1216 lacp_fill_aggregator_id_peer(&la->la_actor, &lp->lp_actor);
1218 la->la_actor.lip_state = lp->lp_state & LACP_STATE_AGGREGATION;
1222 lacp_fill_aggregator_id_peer(struct lacp_peerinfo *lpi_aggr,
1223 const struct lacp_peerinfo *lpi_port)
1225 memset(lpi_aggr, 0, sizeof(*lpi_aggr));
1226 lpi_aggr->lip_systemid = lpi_port->lip_systemid;
1227 lpi_aggr->lip_key = lpi_port->lip_key;
1231 * lacp_aggregator_is_compatible: check if a port can join to an aggregator.
1235 lacp_aggregator_is_compatible(const struct lacp_aggregator *la,
1236 const struct lacp_port *lp)
1238 if (!(lp->lp_state & LACP_STATE_AGGREGATION) ||
1239 !(lp->lp_partner.lip_state & LACP_STATE_AGGREGATION)) {
1243 if (!(la->la_actor.lip_state & LACP_STATE_AGGREGATION)) {
1247 if (!lacp_peerinfo_is_compatible(&la->la_partner, &lp->lp_partner)) {
1251 if (!lacp_peerinfo_is_compatible(&la->la_actor, &lp->lp_actor)) {
1259 lacp_peerinfo_is_compatible(const struct lacp_peerinfo *a,
1260 const struct lacp_peerinfo *b)
1262 if (memcmp(&a->lip_systemid, &b->lip_systemid,
1263 sizeof(a->lip_systemid))) {
1267 if (memcmp(&a->lip_key, &b->lip_key, sizeof(a->lip_key))) {
1275 lacp_port_enable(struct lacp_port *lp)
1277 lp->lp_state |= LACP_STATE_AGGREGATION;
1281 lacp_port_disable(struct lacp_port *lp)
1283 lacp_set_mux(lp, LACP_MUX_DETACHED);
1285 lp->lp_state &= ~LACP_STATE_AGGREGATION;
1286 lp->lp_selected = LACP_UNSELECTED;
1287 lacp_sm_rx_record_default(lp);
1288 lp->lp_partner.lip_state &= ~LACP_STATE_AGGREGATION;
1289 lp->lp_state &= ~LACP_STATE_EXPIRED;
1293 * lacp_select: select an aggregator. create one if necessary.
1296 lacp_select(struct lacp_port *lp)
1298 struct lacp_softc *lsc = lp->lp_lsc;
1299 struct lacp_aggregator *la;
1300 char buf[LACP_LAGIDSTR_MAX+1];
1302 if (lp->lp_aggregator) {
1306 KASSERT(!LACP_TIMER_ISARMED(lp, LACP_TIMER_WAIT_WHILE),
1307 ("timer_wait_while still active"));
1309 LACP_DPRINTF((lp, "port lagid=%s\n",
1310 lacp_format_lagid(&lp->lp_actor, &lp->lp_partner,
1311 buf, sizeof(buf))));
1313 TAILQ_FOREACH(la, &lsc->lsc_aggregators, la_q) {
1314 if (lacp_aggregator_is_compatible(la, lp)) {
1320 la = lacp_aggregator_get(lsc, lp);
1322 LACP_DPRINTF((lp, "aggregator creation failed\n"));
1325 * will retry on the next tick.
1330 lacp_fill_aggregator_id(la, lp);
1331 LACP_DPRINTF((lp, "aggregator created\n"));
1333 LACP_DPRINTF((lp, "compatible aggregator found\n"));
1334 if (la->la_refcnt == LACP_MAX_PORTS)
1336 lacp_aggregator_addref(lsc, la);
1339 LACP_DPRINTF((lp, "aggregator lagid=%s\n",
1340 lacp_format_lagid(&la->la_actor, &la->la_partner,
1341 buf, sizeof(buf))));
1343 lp->lp_aggregator = la;
1344 lp->lp_selected = LACP_SELECTED;
1348 * lacp_unselect: finish unselect/detach process.
1352 lacp_unselect(struct lacp_port *lp)
1354 struct lacp_softc *lsc = lp->lp_lsc;
1355 struct lacp_aggregator *la = lp->lp_aggregator;
1357 KASSERT(!LACP_TIMER_ISARMED(lp, LACP_TIMER_WAIT_WHILE),
1358 ("timer_wait_while still active"));
1364 lp->lp_aggregator = NULL;
1365 lacp_aggregator_delref(lsc, la);
1371 lacp_sm_mux(struct lacp_port *lp)
1373 struct lagg_port *lgp = lp->lp_lagg;
1374 struct lagg_softc *sc = lgp->lp_softc;
1375 enum lacp_mux_state new_state;
1377 (lp->lp_partner.lip_state & LACP_STATE_SYNC) != 0;
1378 boolean_t p_collecting =
1379 (lp->lp_partner.lip_state & LACP_STATE_COLLECTING) != 0;
1380 enum lacp_selected selected = lp->lp_selected;
1381 struct lacp_aggregator *la;
1384 lacp_dprintf(lp, "%s: state= 0x%x, selected= 0x%x, "
1385 "p_sync= 0x%x, p_collecting= 0x%x\n", __func__,
1386 lp->lp_mux_state, selected, p_sync, p_collecting);
1389 la = lp->lp_aggregator;
1390 KASSERT(lp->lp_mux_state == LACP_MUX_DETACHED || la != NULL,
1391 ("MUX not detached"));
1392 new_state = lp->lp_mux_state;
1393 switch (lp->lp_mux_state) {
1394 case LACP_MUX_DETACHED:
1395 if (selected != LACP_UNSELECTED) {
1396 new_state = LACP_MUX_WAITING;
1399 case LACP_MUX_WAITING:
1400 KASSERT(la->la_pending > 0 ||
1401 !LACP_TIMER_ISARMED(lp, LACP_TIMER_WAIT_WHILE),
1402 ("timer_wait_while still active"));
1403 if (selected == LACP_SELECTED && la->la_pending == 0) {
1404 new_state = LACP_MUX_ATTACHED;
1405 } else if (selected == LACP_UNSELECTED) {
1406 new_state = LACP_MUX_DETACHED;
1409 case LACP_MUX_ATTACHED:
1410 if (selected == LACP_SELECTED && p_sync) {
1411 new_state = LACP_MUX_COLLECTING;
1412 } else if (selected != LACP_SELECTED) {
1413 new_state = LACP_MUX_DETACHED;
1416 case LACP_MUX_COLLECTING:
1417 if (selected == LACP_SELECTED && p_sync && p_collecting) {
1418 new_state = LACP_MUX_DISTRIBUTING;
1419 } else if (selected != LACP_SELECTED || !p_sync) {
1420 new_state = LACP_MUX_ATTACHED;
1423 case LACP_MUX_DISTRIBUTING:
1424 if (selected != LACP_SELECTED || !p_sync || !p_collecting) {
1425 new_state = LACP_MUX_COLLECTING;
1426 lacp_dprintf(lp, "Interface stopped DISTRIBUTING, possible flapping\n");
1431 panic("%s: unknown state", __func__);
1434 if (lp->lp_mux_state == new_state) {
1438 lacp_set_mux(lp, new_state);
1443 lacp_set_mux(struct lacp_port *lp, enum lacp_mux_state new_state)
1445 struct lacp_aggregator *la = lp->lp_aggregator;
1447 if (lp->lp_mux_state == new_state) {
1451 switch (new_state) {
1452 case LACP_MUX_DETACHED:
1453 lp->lp_state &= ~LACP_STATE_SYNC;
1454 lacp_disable_distributing(lp);
1455 lacp_disable_collecting(lp);
1456 lacp_sm_assert_ntt(lp);
1458 if (LACP_TIMER_ISARMED(lp, LACP_TIMER_WAIT_WHILE)) {
1459 KASSERT(la->la_pending > 0,
1460 ("timer_wait_while not active"));
1463 LACP_TIMER_DISARM(lp, LACP_TIMER_WAIT_WHILE);
1466 case LACP_MUX_WAITING:
1467 LACP_TIMER_ARM(lp, LACP_TIMER_WAIT_WHILE,
1468 LACP_AGGREGATE_WAIT_TIME);
1471 case LACP_MUX_ATTACHED:
1472 lp->lp_state |= LACP_STATE_SYNC;
1473 lacp_disable_collecting(lp);
1474 lacp_sm_assert_ntt(lp);
1476 case LACP_MUX_COLLECTING:
1477 lacp_enable_collecting(lp);
1478 lacp_disable_distributing(lp);
1479 lacp_sm_assert_ntt(lp);
1481 case LACP_MUX_DISTRIBUTING:
1482 lacp_enable_distributing(lp);
1485 panic("%s: unknown state", __func__);
1488 LACP_DPRINTF((lp, "mux_state %d -> %d\n", lp->lp_mux_state, new_state));
1490 lp->lp_mux_state = new_state;
1494 lacp_sm_mux_timer(struct lacp_port *lp)
1496 struct lacp_aggregator *la = lp->lp_aggregator;
1497 char buf[LACP_LAGIDSTR_MAX+1];
1499 KASSERT(la->la_pending > 0, ("no pending event"));
1501 LACP_DPRINTF((lp, "%s: aggregator %s, pending %d -> %d\n", __func__,
1502 lacp_format_lagid(&la->la_actor, &la->la_partner,
1504 la->la_pending, la->la_pending - 1));
1509 /* periodic transmit machine */
1512 lacp_sm_ptx_update_timeout(struct lacp_port *lp, uint8_t oldpstate)
1514 if (LACP_STATE_EQ(oldpstate, lp->lp_partner.lip_state,
1515 LACP_STATE_TIMEOUT)) {
1519 LACP_DPRINTF((lp, "partner timeout changed\n"));
1522 * FAST_PERIODIC -> SLOW_PERIODIC
1524 * SLOW_PERIODIC (-> PERIODIC_TX) -> FAST_PERIODIC
1526 * let lacp_sm_ptx_tx_schedule to update timeout.
1529 LACP_TIMER_DISARM(lp, LACP_TIMER_PERIODIC);
1532 * if timeout has been shortened, assert NTT.
1535 if ((lp->lp_partner.lip_state & LACP_STATE_TIMEOUT)) {
1536 lacp_sm_assert_ntt(lp);
1541 lacp_sm_ptx_tx_schedule(struct lacp_port *lp)
1545 if (!(lp->lp_state & LACP_STATE_ACTIVITY) &&
1546 !(lp->lp_partner.lip_state & LACP_STATE_ACTIVITY)) {
1552 LACP_TIMER_DISARM(lp, LACP_TIMER_PERIODIC);
1556 if (LACP_TIMER_ISARMED(lp, LACP_TIMER_PERIODIC)) {
1560 timeout = (lp->lp_partner.lip_state & LACP_STATE_TIMEOUT) ?
1561 LACP_FAST_PERIODIC_TIME : LACP_SLOW_PERIODIC_TIME;
1563 LACP_TIMER_ARM(lp, LACP_TIMER_PERIODIC, timeout);
1567 lacp_sm_ptx_timer(struct lacp_port *lp)
1569 lacp_sm_assert_ntt(lp);
1573 lacp_sm_rx(struct lacp_port *lp, const struct lacpdu *du)
1578 * check LACP_DISABLED first
1581 if (!(lp->lp_state & LACP_STATE_AGGREGATION)) {
1586 * check loopback condition.
1589 if (!lacp_compare_systemid(&du->ldu_actor.lip_systemid,
1590 &lp->lp_actor.lip_systemid)) {
1595 * EXPIRED, DEFAULTED, CURRENT -> CURRENT
1598 lacp_sm_rx_update_selected(lp, du);
1599 lacp_sm_rx_update_ntt(lp, du);
1600 lacp_sm_rx_record_pdu(lp, du);
1602 timeout = (lp->lp_state & LACP_STATE_TIMEOUT) ?
1603 LACP_SHORT_TIMEOUT_TIME : LACP_LONG_TIMEOUT_TIME;
1604 LACP_TIMER_ARM(lp, LACP_TIMER_CURRENT_WHILE, timeout);
1606 lp->lp_state &= ~LACP_STATE_EXPIRED;
1609 * kick transmit machine without waiting the next tick.
1616 lacp_sm_rx_set_expired(struct lacp_port *lp)
1618 lp->lp_partner.lip_state &= ~LACP_STATE_SYNC;
1619 lp->lp_partner.lip_state |= LACP_STATE_TIMEOUT;
1620 LACP_TIMER_ARM(lp, LACP_TIMER_CURRENT_WHILE, LACP_SHORT_TIMEOUT_TIME);
1621 lp->lp_state |= LACP_STATE_EXPIRED;
1625 lacp_sm_rx_timer(struct lacp_port *lp)
1627 if ((lp->lp_state & LACP_STATE_EXPIRED) == 0) {
1628 /* CURRENT -> EXPIRED */
1629 LACP_DPRINTF((lp, "%s: CURRENT -> EXPIRED\n", __func__));
1630 lacp_sm_rx_set_expired(lp);
1632 /* EXPIRED -> DEFAULTED */
1633 LACP_DPRINTF((lp, "%s: EXPIRED -> DEFAULTED\n", __func__));
1634 lacp_sm_rx_update_default_selected(lp);
1635 lacp_sm_rx_record_default(lp);
1636 lp->lp_state &= ~LACP_STATE_EXPIRED;
1641 lacp_sm_rx_record_pdu(struct lacp_port *lp, const struct lacpdu *du)
1645 char buf[LACP_STATESTR_MAX+1];
1649 oldpstate = lp->lp_partner.lip_state;
1651 active = (du->ldu_actor.lip_state & LACP_STATE_ACTIVITY)
1652 || ((lp->lp_state & LACP_STATE_ACTIVITY) &&
1653 (du->ldu_partner.lip_state & LACP_STATE_ACTIVITY));
1655 lp->lp_partner = du->ldu_actor;
1657 ((LACP_STATE_EQ(lp->lp_state, du->ldu_partner.lip_state,
1658 LACP_STATE_AGGREGATION) &&
1659 !lacp_compare_peerinfo(&lp->lp_actor, &du->ldu_partner))
1660 || (du->ldu_partner.lip_state & LACP_STATE_AGGREGATION) == 0)) {
1663 lp->lp_partner.lip_state &= ~LACP_STATE_SYNC;
1666 lp->lp_state &= ~LACP_STATE_DEFAULTED;
1668 if (oldpstate != lp->lp_partner.lip_state) {
1669 LACP_DPRINTF((lp, "old pstate %s\n",
1670 lacp_format_state(oldpstate, buf, sizeof(buf))));
1671 LACP_DPRINTF((lp, "new pstate %s\n",
1672 lacp_format_state(lp->lp_partner.lip_state, buf,
1676 /* XXX Hack, still need to implement 5.4.9 para 2,3,4 */
1677 if (lp->lp_lsc->lsc_strict_mode)
1678 lp->lp_partner.lip_state |= LACP_STATE_SYNC;
1680 lacp_sm_ptx_update_timeout(lp, oldpstate);
1684 lacp_sm_rx_update_ntt(struct lacp_port *lp, const struct lacpdu *du)
1689 if (lacp_compare_peerinfo(&lp->lp_actor, &du->ldu_partner) ||
1690 !LACP_STATE_EQ(lp->lp_state, du->ldu_partner.lip_state,
1691 LACP_STATE_ACTIVITY | LACP_STATE_SYNC | LACP_STATE_AGGREGATION)) {
1692 LACP_DPRINTF((lp, "%s: assert ntt\n", __func__));
1693 lacp_sm_assert_ntt(lp);
1698 lacp_sm_rx_record_default(struct lacp_port *lp)
1704 oldpstate = lp->lp_partner.lip_state;
1705 if (lp->lp_lsc->lsc_strict_mode)
1706 lp->lp_partner = lacp_partner_admin_strict;
1708 lp->lp_partner = lacp_partner_admin_optimistic;;
1709 lp->lp_state |= LACP_STATE_DEFAULTED;
1710 lacp_sm_ptx_update_timeout(lp, oldpstate);
1714 lacp_sm_rx_update_selected_from_peerinfo(struct lacp_port *lp,
1715 const struct lacp_peerinfo *info)
1720 if (lacp_compare_peerinfo(&lp->lp_partner, info) ||
1721 !LACP_STATE_EQ(lp->lp_partner.lip_state, info->lip_state,
1722 LACP_STATE_AGGREGATION)) {
1723 lp->lp_selected = LACP_UNSELECTED;
1724 /* mux machine will clean up lp->lp_aggregator */
1729 lacp_sm_rx_update_selected(struct lacp_port *lp, const struct lacpdu *du)
1734 lacp_sm_rx_update_selected_from_peerinfo(lp, &du->ldu_actor);
1738 lacp_sm_rx_update_default_selected(struct lacp_port *lp)
1743 if (lp->lp_lsc->lsc_strict_mode)
1744 lacp_sm_rx_update_selected_from_peerinfo(lp,
1745 &lacp_partner_admin_strict);
1747 lacp_sm_rx_update_selected_from_peerinfo(lp,
1748 &lacp_partner_admin_optimistic);
1751 /* transmit machine */
1754 lacp_sm_tx(struct lacp_port *lp)
1758 if (!(lp->lp_state & LACP_STATE_AGGREGATION)
1760 || (!(lp->lp_state & LACP_STATE_ACTIVITY)
1761 && !(lp->lp_partner.lip_state & LACP_STATE_ACTIVITY))
1764 lp->lp_flags &= ~LACP_PORT_NTT;
1767 if (!(lp->lp_flags & LACP_PORT_NTT)) {
1771 /* Rate limit to 3 PDUs per LACP_FAST_PERIODIC_TIME */
1772 if (ppsratecheck(&lp->lp_last_lacpdu, &lp->lp_lacpdu_sent,
1773 (3 / LACP_FAST_PERIODIC_TIME)) == 0) {
1774 LACP_DPRINTF((lp, "rate limited pdu\n"));
1778 if (((1 << lp->lp_ifp->if_dunit) & lp->lp_lsc->lsc_debug.lsc_tx_test) == 0) {
1779 error = lacp_xmit_lacpdu(lp);
1781 LACP_TPRINTF((lp, "Dropping TX PDU\n"));
1785 lp->lp_flags &= ~LACP_PORT_NTT;
1787 LACP_DPRINTF((lp, "lacpdu transmit failure, error %d\n",
1793 lacp_sm_assert_ntt(struct lacp_port *lp)
1796 lp->lp_flags |= LACP_PORT_NTT;
1800 lacp_run_timers(struct lacp_port *lp)
1804 for (i = 0; i < LACP_NTIMER; i++) {
1805 KASSERT(lp->lp_timer[i] >= 0,
1806 ("invalid timer value %d", lp->lp_timer[i]));
1807 if (lp->lp_timer[i] == 0) {
1809 } else if (--lp->lp_timer[i] <= 0) {
1810 if (lacp_timer_funcs[i]) {
1811 (*lacp_timer_funcs[i])(lp);
1818 lacp_marker_input(struct lacp_port *lp, struct mbuf *m)
1820 struct lacp_softc *lsc = lp->lp_lsc;
1821 struct lagg_port *lgp = lp->lp_lagg;
1822 struct lacp_port *lp2;
1823 struct markerdu *mdu;
1827 if (m->m_pkthdr.len != sizeof(*mdu)) {
1831 if ((m->m_flags & M_MCAST) == 0) {
1835 if (m->m_len < sizeof(*mdu)) {
1836 m = m_pullup(m, sizeof(*mdu));
1842 mdu = mtod(m, struct markerdu *);
1844 if (memcmp(&mdu->mdu_eh.ether_dhost,
1845 ðermulticastaddr_slowprotocols, ETHER_ADDR_LEN)) {
1849 if (mdu->mdu_sph.sph_version != 1) {
1853 switch (mdu->mdu_tlv.tlv_type) {
1854 case MARKER_TYPE_INFO:
1855 if (tlv_check(mdu, sizeof(*mdu), &mdu->mdu_tlv,
1856 marker_info_tlv_template, TRUE)) {
1859 mdu->mdu_tlv.tlv_type = MARKER_TYPE_RESPONSE;
1860 memcpy(&mdu->mdu_eh.ether_dhost,
1861 ðermulticastaddr_slowprotocols, ETHER_ADDR_LEN);
1862 memcpy(&mdu->mdu_eh.ether_shost,
1863 lgp->lp_lladdr, ETHER_ADDR_LEN);
1864 error = lagg_enqueue(lp->lp_ifp, m);
1867 case MARKER_TYPE_RESPONSE:
1868 if (tlv_check(mdu, sizeof(*mdu), &mdu->mdu_tlv,
1869 marker_response_tlv_template, TRUE)) {
1872 LACP_DPRINTF((lp, "marker response, port=%u, sys=%6D, id=%u\n",
1873 ntohs(mdu->mdu_info.mi_rq_port), mdu->mdu_info.mi_rq_system,
1874 ":", ntohl(mdu->mdu_info.mi_rq_xid)));
1876 /* Verify that it is the last marker we sent out */
1877 if (memcmp(&mdu->mdu_info, &lp->lp_marker,
1878 sizeof(struct lacp_markerinfo)))
1882 lp->lp_flags &= ~LACP_PORT_MARK;
1884 if (lsc->lsc_suppress_distributing) {
1885 /* Check if any ports are waiting for a response */
1886 LIST_FOREACH(lp2, &lsc->lsc_ports, lp_next) {
1887 if (lp2->lp_flags & LACP_PORT_MARK) {
1894 /* All interface queues are clear */
1895 LACP_DPRINTF((NULL, "queue flush complete\n"));
1896 lsc->lsc_suppress_distributing = FALSE;
1910 LACP_DPRINTF((lp, "bad marker frame\n"));
1916 tlv_check(const void *p, size_t size, const struct tlvhdr *tlv,
1917 const struct tlv_template *tmpl, boolean_t check_type)
1919 while (/* CONSTCOND */ 1) {
1920 if ((const char *)tlv - (const char *)p + sizeof(*tlv) > size) {
1923 if ((check_type && tlv->tlv_type != tmpl->tmpl_type) ||
1924 tlv->tlv_length != tmpl->tmpl_length) {
1927 if (tmpl->tmpl_type == 0) {
1930 tlv = (const struct tlvhdr *)
1931 ((const char *)tlv + tlv->tlv_length);
1940 lacp_format_mac(const uint8_t *mac, char *buf, size_t buflen)
1942 snprintf(buf, buflen, "%02X-%02X-%02X-%02X-%02X-%02X",
1954 lacp_format_systemid(const struct lacp_systemid *sysid,
1955 char *buf, size_t buflen)
1957 char macbuf[LACP_MACSTR_MAX+1];
1959 snprintf(buf, buflen, "%04X,%s",
1960 ntohs(sysid->lsi_prio),
1961 lacp_format_mac(sysid->lsi_mac, macbuf, sizeof(macbuf)));
1967 lacp_format_portid(const struct lacp_portid *portid, char *buf, size_t buflen)
1969 snprintf(buf, buflen, "%04X,%04X",
1970 ntohs(portid->lpi_prio),
1971 ntohs(portid->lpi_portno));
1977 lacp_format_partner(const struct lacp_peerinfo *peer, char *buf, size_t buflen)
1979 char sysid[LACP_SYSTEMIDSTR_MAX+1];
1980 char portid[LACP_PORTIDSTR_MAX+1];
1982 snprintf(buf, buflen, "(%s,%04X,%s)",
1983 lacp_format_systemid(&peer->lip_systemid, sysid, sizeof(sysid)),
1984 ntohs(peer->lip_key),
1985 lacp_format_portid(&peer->lip_portid, portid, sizeof(portid)));
1991 lacp_format_lagid(const struct lacp_peerinfo *a,
1992 const struct lacp_peerinfo *b, char *buf, size_t buflen)
1994 char astr[LACP_PARTNERSTR_MAX+1];
1995 char bstr[LACP_PARTNERSTR_MAX+1];
1999 * there's a convention to display small numbered peer
2003 if (lacp_compare_peerinfo(a, b) > 0) {
2004 const struct lacp_peerinfo *t;
2012 snprintf(buf, buflen, "[%s,%s]",
2013 lacp_format_partner(a, astr, sizeof(astr)),
2014 lacp_format_partner(b, bstr, sizeof(bstr)));
2020 lacp_format_lagid_aggregator(const struct lacp_aggregator *la,
2021 char *buf, size_t buflen)
2027 return (lacp_format_lagid(&la->la_actor, &la->la_partner, buf, buflen));
2031 lacp_format_state(uint8_t state, char *buf, size_t buflen)
2033 snprintf(buf, buflen, "%b", state, LACP_STATE_BITS);
2038 lacp_dump_lacpdu(const struct lacpdu *du)
2040 char buf[LACP_PARTNERSTR_MAX+1];
2041 char buf2[LACP_STATESTR_MAX+1];
2043 printf("actor=%s\n",
2044 lacp_format_partner(&du->ldu_actor, buf, sizeof(buf)));
2045 printf("actor.state=%s\n",
2046 lacp_format_state(du->ldu_actor.lip_state, buf2, sizeof(buf2)));
2047 printf("partner=%s\n",
2048 lacp_format_partner(&du->ldu_partner, buf, sizeof(buf)));
2049 printf("partner.state=%s\n",
2050 lacp_format_state(du->ldu_partner.lip_state, buf2, sizeof(buf2)));
2052 printf("maxdelay=%d\n", ntohs(du->ldu_collector.lci_maxdelay));
2056 lacp_dprintf(const struct lacp_port *lp, const char *fmt, ...)
2061 printf("%s: ", lp->lp_ifp->if_xname);