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>
36 #include <sys/systm.h>
37 #include <sys/malloc.h>
38 #include <sys/kernel.h> /* hz */
39 #include <sys/socket.h> /* for net/if.h */
40 #include <sys/sockio.h>
41 #include <sys/sysctl.h>
42 #include <machine/stdarg.h>
44 #include <sys/rwlock.h>
47 #include <net/if_dl.h>
48 #include <net/ethernet.h>
49 #include <net/if_media.h>
50 #include <net/if_types.h>
52 #include <net/if_lagg.h>
53 #include <net/ieee8023ad_lacp.h>
56 * actor system priority and port priority.
57 * XXX should be configurable.
60 #define LACP_SYSTEM_PRIO 0x8000
61 #define LACP_PORT_PRIO 0x8000
63 const uint8_t ethermulticastaddr_slowprotocols[ETHER_ADDR_LEN] =
64 { 0x01, 0x80, 0xc2, 0x00, 0x00, 0x02 };
66 static const struct tlv_template lacp_info_tlv_template[] = {
67 { LACP_TYPE_ACTORINFO,
68 sizeof(struct tlvhdr) + sizeof(struct lacp_peerinfo) },
69 { LACP_TYPE_PARTNERINFO,
70 sizeof(struct tlvhdr) + sizeof(struct lacp_peerinfo) },
71 { LACP_TYPE_COLLECTORINFO,
72 sizeof(struct tlvhdr) + sizeof(struct lacp_collectorinfo) },
76 static const struct tlv_template marker_info_tlv_template[] = {
78 sizeof(struct tlvhdr) + sizeof(struct lacp_markerinfo) },
82 static const struct tlv_template marker_response_tlv_template[] = {
83 { MARKER_TYPE_RESPONSE,
84 sizeof(struct tlvhdr) + sizeof(struct lacp_markerinfo) },
88 typedef void (*lacp_timer_func_t)(struct lacp_port *);
90 static void lacp_fill_actorinfo(struct lacp_port *, struct lacp_peerinfo *);
91 static void lacp_fill_markerinfo(struct lacp_port *,
92 struct lacp_markerinfo *);
94 static uint64_t lacp_aggregator_bandwidth(struct lacp_aggregator *);
95 static void lacp_suppress_distributing(struct lacp_softc *,
96 struct lacp_aggregator *);
97 static void lacp_transit_expire(void *);
98 static void lacp_update_portmap(struct lacp_softc *);
99 static void lacp_select_active_aggregator(struct lacp_softc *);
100 static uint16_t lacp_compose_key(struct lacp_port *);
101 static int tlv_check(const void *, size_t, const struct tlvhdr *,
102 const struct tlv_template *, boolean_t);
103 static void lacp_tick(void *);
105 static void lacp_fill_aggregator_id(struct lacp_aggregator *,
106 const struct lacp_port *);
107 static void lacp_fill_aggregator_id_peer(struct lacp_peerinfo *,
108 const struct lacp_peerinfo *);
109 static int lacp_aggregator_is_compatible(const struct lacp_aggregator *,
110 const struct lacp_port *);
111 static int lacp_peerinfo_is_compatible(const struct lacp_peerinfo *,
112 const struct lacp_peerinfo *);
114 static struct lacp_aggregator *lacp_aggregator_get(struct lacp_softc *,
116 static void lacp_aggregator_addref(struct lacp_softc *,
117 struct lacp_aggregator *);
118 static void lacp_aggregator_delref(struct lacp_softc *,
119 struct lacp_aggregator *);
121 /* receive machine */
123 static int lacp_pdu_input(struct lacp_port *, struct mbuf *);
124 static int lacp_marker_input(struct lacp_port *, struct mbuf *);
125 static void lacp_sm_rx(struct lacp_port *, const struct lacpdu *);
126 static void lacp_sm_rx_timer(struct lacp_port *);
127 static void lacp_sm_rx_set_expired(struct lacp_port *);
128 static void lacp_sm_rx_update_ntt(struct lacp_port *,
129 const struct lacpdu *);
130 static void lacp_sm_rx_record_pdu(struct lacp_port *,
131 const struct lacpdu *);
132 static void lacp_sm_rx_update_selected(struct lacp_port *,
133 const struct lacpdu *);
134 static void lacp_sm_rx_record_default(struct lacp_port *);
135 static void lacp_sm_rx_update_default_selected(struct lacp_port *);
136 static void lacp_sm_rx_update_selected_from_peerinfo(struct lacp_port *,
137 const struct lacp_peerinfo *);
141 static void lacp_sm_mux(struct lacp_port *);
142 static void lacp_set_mux(struct lacp_port *, enum lacp_mux_state);
143 static void lacp_sm_mux_timer(struct lacp_port *);
145 /* periodic transmit machine */
147 static void lacp_sm_ptx_update_timeout(struct lacp_port *, uint8_t);
148 static void lacp_sm_ptx_tx_schedule(struct lacp_port *);
149 static void lacp_sm_ptx_timer(struct lacp_port *);
151 /* transmit machine */
153 static void lacp_sm_tx(struct lacp_port *);
154 static void lacp_sm_assert_ntt(struct lacp_port *);
156 static void lacp_run_timers(struct lacp_port *);
157 static int lacp_compare_peerinfo(const struct lacp_peerinfo *,
158 const struct lacp_peerinfo *);
159 static int lacp_compare_systemid(const struct lacp_systemid *,
160 const struct lacp_systemid *);
161 static void lacp_port_enable(struct lacp_port *);
162 static void lacp_port_disable(struct lacp_port *);
163 static void lacp_select(struct lacp_port *);
164 static void lacp_unselect(struct lacp_port *);
165 static void lacp_disable_collecting(struct lacp_port *);
166 static void lacp_enable_collecting(struct lacp_port *);
167 static void lacp_disable_distributing(struct lacp_port *);
168 static void lacp_enable_distributing(struct lacp_port *);
169 static int lacp_xmit_lacpdu(struct lacp_port *);
170 static int lacp_xmit_marker(struct lacp_port *);
174 static void lacp_dump_lacpdu(const struct lacpdu *);
175 static const char *lacp_format_partner(const struct lacp_peerinfo *, char *,
177 static const char *lacp_format_lagid(const struct lacp_peerinfo *,
178 const struct lacp_peerinfo *, char *, size_t);
179 static const char *lacp_format_lagid_aggregator(const struct lacp_aggregator *,
181 static const char *lacp_format_state(uint8_t, char *, size_t);
182 static const char *lacp_format_mac(const uint8_t *, char *, size_t);
183 static const char *lacp_format_systemid(const struct lacp_systemid *, char *,
185 static const char *lacp_format_portid(const struct lacp_portid *, char *,
187 static void lacp_dprintf(const struct lacp_port *, const char *, ...)
188 __attribute__((__format__(__printf__, 2, 3)));
190 static VNET_DEFINE(int, lacp_debug);
191 #define V_lacp_debug VNET(lacp_debug)
192 SYSCTL_NODE(_net_link_lagg, OID_AUTO, lacp, CTLFLAG_RD, 0, "ieee802.3ad");
193 SYSCTL_INT(_net_link_lagg_lacp, OID_AUTO, debug, CTLFLAG_RWTUN | CTLFLAG_VNET,
194 &VNET_NAME(lacp_debug), 0, "Enable LACP debug logging (1=debug, 2=trace)");
196 static VNET_DEFINE(int, lacp_default_strict_mode) = 1;
197 SYSCTL_INT(_net_link_lagg_lacp, OID_AUTO, default_strict_mode, CTLFLAG_RWTUN,
198 &VNET_NAME(lacp_default_strict_mode), 0,
199 "LACP strict protocol compliance default");
201 #define LACP_DPRINTF(a) if (V_lacp_debug & 0x01) { lacp_dprintf a ; }
202 #define LACP_TRACE(a) if (V_lacp_debug & 0x02) { lacp_dprintf(a,"%s\n",__func__); }
203 #define LACP_TPRINTF(a) if (V_lacp_debug & 0x04) { lacp_dprintf a ; }
206 * partner administration variables.
207 * XXX should be configurable.
210 static const struct lacp_peerinfo lacp_partner_admin_optimistic = {
211 .lip_systemid = { .lsi_prio = 0xffff },
212 .lip_portid = { .lpi_prio = 0xffff },
213 .lip_state = LACP_STATE_SYNC | LACP_STATE_AGGREGATION |
214 LACP_STATE_COLLECTING | LACP_STATE_DISTRIBUTING,
217 static const struct lacp_peerinfo lacp_partner_admin_strict = {
218 .lip_systemid = { .lsi_prio = 0xffff },
219 .lip_portid = { .lpi_prio = 0xffff },
223 static const lacp_timer_func_t lacp_timer_funcs[LACP_NTIMER] = {
224 [LACP_TIMER_CURRENT_WHILE] = lacp_sm_rx_timer,
225 [LACP_TIMER_PERIODIC] = lacp_sm_ptx_timer,
226 [LACP_TIMER_WAIT_WHILE] = lacp_sm_mux_timer,
230 lacp_input(struct lagg_port *lgp, struct mbuf *m)
232 struct lacp_port *lp = LACP_PORT(lgp);
235 if (m->m_pkthdr.len < sizeof(struct ether_header) + sizeof(subtype)) {
240 m_copydata(m, sizeof(struct ether_header), sizeof(subtype), &subtype);
242 case SLOWPROTOCOLS_SUBTYPE_LACP:
243 lacp_pdu_input(lp, m);
246 case SLOWPROTOCOLS_SUBTYPE_MARKER:
247 lacp_marker_input(lp, m);
251 /* Not a subtype we are interested in */
256 * lacp_pdu_input: process lacpdu
259 lacp_pdu_input(struct lacp_port *lp, struct mbuf *m)
261 struct lacp_softc *lsc = lp->lp_lsc;
265 if (m->m_pkthdr.len != sizeof(*du)) {
269 if ((m->m_flags & M_MCAST) == 0) {
273 if (m->m_len < sizeof(*du)) {
274 m = m_pullup(m, sizeof(*du));
280 du = mtod(m, struct lacpdu *);
282 if (memcmp(&du->ldu_eh.ether_dhost,
283 ðermulticastaddr_slowprotocols, ETHER_ADDR_LEN)) {
288 * ignore the version for compatibility with
289 * the future protocol revisions.
292 if (du->ldu_sph.sph_version != 1) {
298 * ignore tlv types for compatibility with
299 * the future protocol revisions.
301 if (tlv_check(du, sizeof(*du), &du->ldu_tlv_actor,
302 lacp_info_tlv_template, FALSE)) {
306 if (V_lacp_debug > 0) {
307 lacp_dprintf(lp, "lacpdu receive\n");
308 lacp_dump_lacpdu(du);
311 if ((1 << lp->lp_ifp->if_dunit) & lp->lp_lsc->lsc_debug.lsc_rx_test) {
312 LACP_TPRINTF((lp, "Dropping RX PDU\n"));
329 lacp_fill_actorinfo(struct lacp_port *lp, struct lacp_peerinfo *info)
331 struct lagg_port *lgp = lp->lp_lagg;
332 struct lagg_softc *sc = lgp->lp_softc;
334 info->lip_systemid.lsi_prio = htons(LACP_SYSTEM_PRIO);
335 memcpy(&info->lip_systemid.lsi_mac,
336 IF_LLADDR(sc->sc_ifp), ETHER_ADDR_LEN);
337 info->lip_portid.lpi_prio = htons(LACP_PORT_PRIO);
338 info->lip_portid.lpi_portno = htons(lp->lp_ifp->if_index);
339 info->lip_state = lp->lp_state;
343 lacp_fill_markerinfo(struct lacp_port *lp, struct lacp_markerinfo *info)
345 struct ifnet *ifp = lp->lp_ifp;
347 /* Fill in the port index and system id (encoded as the MAC) */
348 info->mi_rq_port = htons(ifp->if_index);
349 memcpy(&info->mi_rq_system, lp->lp_systemid.lsi_mac, ETHER_ADDR_LEN);
350 info->mi_rq_xid = htonl(0);
354 lacp_xmit_lacpdu(struct lacp_port *lp)
356 struct lagg_port *lgp = lp->lp_lagg;
361 LACP_LOCK_ASSERT(lp->lp_lsc);
363 m = m_gethdr(M_NOWAIT, MT_DATA);
367 m->m_len = m->m_pkthdr.len = sizeof(*du);
369 du = mtod(m, struct lacpdu *);
370 memset(du, 0, sizeof(*du));
372 memcpy(&du->ldu_eh.ether_dhost, ethermulticastaddr_slowprotocols,
374 memcpy(&du->ldu_eh.ether_shost, lgp->lp_lladdr, ETHER_ADDR_LEN);
375 du->ldu_eh.ether_type = htons(ETHERTYPE_SLOW);
377 du->ldu_sph.sph_subtype = SLOWPROTOCOLS_SUBTYPE_LACP;
378 du->ldu_sph.sph_version = 1;
380 TLV_SET(&du->ldu_tlv_actor, LACP_TYPE_ACTORINFO, sizeof(du->ldu_actor));
381 du->ldu_actor = lp->lp_actor;
383 TLV_SET(&du->ldu_tlv_partner, LACP_TYPE_PARTNERINFO,
384 sizeof(du->ldu_partner));
385 du->ldu_partner = lp->lp_partner;
387 TLV_SET(&du->ldu_tlv_collector, LACP_TYPE_COLLECTORINFO,
388 sizeof(du->ldu_collector));
389 du->ldu_collector.lci_maxdelay = 0;
391 if (V_lacp_debug > 0) {
392 lacp_dprintf(lp, "lacpdu transmit\n");
393 lacp_dump_lacpdu(du);
396 m->m_flags |= M_MCAST;
399 * XXX should use higher priority queue.
400 * otherwise network congestion can break aggregation.
403 error = lagg_enqueue(lp->lp_ifp, m);
408 lacp_xmit_marker(struct lacp_port *lp)
410 struct lagg_port *lgp = lp->lp_lagg;
412 struct markerdu *mdu;
415 LACP_LOCK_ASSERT(lp->lp_lsc);
417 m = m_gethdr(M_NOWAIT, MT_DATA);
421 m->m_len = m->m_pkthdr.len = sizeof(*mdu);
423 mdu = mtod(m, struct markerdu *);
424 memset(mdu, 0, sizeof(*mdu));
426 memcpy(&mdu->mdu_eh.ether_dhost, ethermulticastaddr_slowprotocols,
428 memcpy(&mdu->mdu_eh.ether_shost, lgp->lp_lladdr, ETHER_ADDR_LEN);
429 mdu->mdu_eh.ether_type = htons(ETHERTYPE_SLOW);
431 mdu->mdu_sph.sph_subtype = SLOWPROTOCOLS_SUBTYPE_MARKER;
432 mdu->mdu_sph.sph_version = 1;
434 /* Bump the transaction id and copy over the marker info */
435 lp->lp_marker.mi_rq_xid = htonl(ntohl(lp->lp_marker.mi_rq_xid) + 1);
436 TLV_SET(&mdu->mdu_tlv, MARKER_TYPE_INFO, sizeof(mdu->mdu_info));
437 mdu->mdu_info = lp->lp_marker;
439 LACP_DPRINTF((lp, "marker transmit, port=%u, sys=%6D, id=%u\n",
440 ntohs(mdu->mdu_info.mi_rq_port), mdu->mdu_info.mi_rq_system, ":",
441 ntohl(mdu->mdu_info.mi_rq_xid)));
443 m->m_flags |= M_MCAST;
444 error = lagg_enqueue(lp->lp_ifp, m);
449 lacp_linkstate(struct lagg_port *lgp)
451 struct lacp_port *lp = LACP_PORT(lgp);
452 struct lacp_softc *lsc = lp->lp_lsc;
453 struct ifnet *ifp = lgp->lp_ifp;
454 struct ifmediareq ifmr;
460 bzero((char *)&ifmr, sizeof(ifmr));
461 error = (*ifp->if_ioctl)(ifp, SIOCGIFMEDIA, (caddr_t)&ifmr);
466 media = ifmr.ifm_active;
467 LACP_DPRINTF((lp, "media changed 0x%x -> 0x%x, ether = %d, fdx = %d, "
468 "link = %d\n", lp->lp_media, media, IFM_TYPE(media) == IFM_ETHER,
469 (media & IFM_FDX) != 0, ifp->if_link_state == LINK_STATE_UP));
470 old_state = lp->lp_state;
471 old_key = lp->lp_key;
473 lp->lp_media = media;
475 * If the port is not an active full duplex Ethernet link then it can
478 if (IFM_TYPE(media) != IFM_ETHER || (media & IFM_FDX) == 0 ||
479 ifp->if_link_state != LINK_STATE_UP) {
480 lacp_port_disable(lp);
482 lacp_port_enable(lp);
484 lp->lp_key = lacp_compose_key(lp);
486 if (old_state != lp->lp_state || old_key != lp->lp_key) {
487 LACP_DPRINTF((lp, "-> UNSELECTED\n"));
488 lp->lp_selected = LACP_UNSELECTED;
496 struct lacp_softc *lsc = arg;
497 struct lacp_port *lp;
499 LIST_FOREACH(lp, &lsc->lsc_ports, lp_next) {
500 if ((lp->lp_state & LACP_STATE_AGGREGATION) == 0)
503 CURVNET_SET(lp->lp_ifp->if_vnet);
509 lacp_sm_ptx_tx_schedule(lp);
512 callout_reset(&lsc->lsc_callout, hz, lacp_tick, lsc);
516 lacp_port_create(struct lagg_port *lgp)
518 struct lagg_softc *sc = lgp->lp_softc;
519 struct lacp_softc *lsc = LACP_SOFTC(sc);
520 struct lacp_port *lp;
521 struct ifnet *ifp = lgp->lp_ifp;
522 struct sockaddr_dl sdl;
523 struct ifmultiaddr *rifma = NULL;
526 boolean_t active = TRUE; /* XXX should be configurable */
527 boolean_t fast = FALSE; /* Configurable via ioctl */
529 bzero((char *)&sdl, sizeof(sdl));
530 sdl.sdl_len = sizeof(sdl);
531 sdl.sdl_family = AF_LINK;
532 sdl.sdl_index = ifp->if_index;
533 sdl.sdl_type = IFT_ETHER;
534 sdl.sdl_alen = ETHER_ADDR_LEN;
536 bcopy(ðermulticastaddr_slowprotocols,
537 LLADDR(&sdl), ETHER_ADDR_LEN);
538 error = if_addmulti(ifp, (struct sockaddr *)&sdl, &rifma);
540 printf("%s: ADDMULTI failed on %s\n", __func__, lgp->lp_ifname);
544 lp = malloc(sizeof(struct lacp_port),
545 M_DEVBUF, M_NOWAIT|M_ZERO);
550 lgp->lp_psc = (caddr_t)lp;
556 LIST_INSERT_HEAD(&lsc->lsc_ports, lp, lp_next);
558 lacp_fill_actorinfo(lp, &lp->lp_actor);
559 lacp_fill_markerinfo(lp, &lp->lp_marker);
561 (active ? LACP_STATE_ACTIVITY : 0) |
562 (fast ? LACP_STATE_TIMEOUT : 0);
563 lp->lp_aggregator = NULL;
564 lacp_sm_rx_set_expired(lp);
572 lacp_port_destroy(struct lagg_port *lgp)
574 struct lacp_port *lp = LACP_PORT(lgp);
575 struct lacp_softc *lsc = lp->lp_lsc;
579 for (i = 0; i < LACP_NTIMER; i++) {
580 LACP_TIMER_DISARM(lp, i);
583 lacp_disable_collecting(lp);
584 lacp_disable_distributing(lp);
587 LIST_REMOVE(lp, lp_next);
590 /* The address may have already been removed by if_purgemaddrs() */
591 if (!lgp->lp_detaching)
592 if_delmulti_ifma(lp->lp_ifma);
598 lacp_req(struct lagg_softc *sc, caddr_t data)
600 struct lacp_opreq *req = (struct lacp_opreq *)data;
601 struct lacp_softc *lsc = LACP_SOFTC(sc);
602 struct lacp_aggregator *la;
604 bzero(req, sizeof(struct lacp_opreq));
607 * If the LACP softc is NULL, return with the opreq structure full of
608 * zeros. It is normal for the softc to be NULL while the lagg is
614 la = lsc->lsc_active_aggregator;
617 req->actor_prio = ntohs(la->la_actor.lip_systemid.lsi_prio);
618 memcpy(&req->actor_mac, &la->la_actor.lip_systemid.lsi_mac,
620 req->actor_key = ntohs(la->la_actor.lip_key);
621 req->actor_portprio = ntohs(la->la_actor.lip_portid.lpi_prio);
622 req->actor_portno = ntohs(la->la_actor.lip_portid.lpi_portno);
623 req->actor_state = la->la_actor.lip_state;
625 req->partner_prio = ntohs(la->la_partner.lip_systemid.lsi_prio);
626 memcpy(&req->partner_mac, &la->la_partner.lip_systemid.lsi_mac,
628 req->partner_key = ntohs(la->la_partner.lip_key);
629 req->partner_portprio = ntohs(la->la_partner.lip_portid.lpi_prio);
630 req->partner_portno = ntohs(la->la_partner.lip_portid.lpi_portno);
631 req->partner_state = la->la_partner.lip_state;
637 lacp_portreq(struct lagg_port *lgp, caddr_t data)
639 struct lacp_opreq *req = (struct lacp_opreq *)data;
640 struct lacp_port *lp = LACP_PORT(lgp);
641 struct lacp_softc *lsc = lp->lp_lsc;
644 req->actor_prio = ntohs(lp->lp_actor.lip_systemid.lsi_prio);
645 memcpy(&req->actor_mac, &lp->lp_actor.lip_systemid.lsi_mac,
647 req->actor_key = ntohs(lp->lp_actor.lip_key);
648 req->actor_portprio = ntohs(lp->lp_actor.lip_portid.lpi_prio);
649 req->actor_portno = ntohs(lp->lp_actor.lip_portid.lpi_portno);
650 req->actor_state = lp->lp_actor.lip_state;
652 req->partner_prio = ntohs(lp->lp_partner.lip_systemid.lsi_prio);
653 memcpy(&req->partner_mac, &lp->lp_partner.lip_systemid.lsi_mac,
655 req->partner_key = ntohs(lp->lp_partner.lip_key);
656 req->partner_portprio = ntohs(lp->lp_partner.lip_portid.lpi_prio);
657 req->partner_portno = ntohs(lp->lp_partner.lip_portid.lpi_portno);
658 req->partner_state = lp->lp_partner.lip_state;
663 lacp_disable_collecting(struct lacp_port *lp)
665 LACP_DPRINTF((lp, "collecting disabled\n"));
666 lp->lp_state &= ~LACP_STATE_COLLECTING;
670 lacp_enable_collecting(struct lacp_port *lp)
672 LACP_DPRINTF((lp, "collecting enabled\n"));
673 lp->lp_state |= LACP_STATE_COLLECTING;
677 lacp_disable_distributing(struct lacp_port *lp)
679 struct lacp_aggregator *la = lp->lp_aggregator;
680 struct lacp_softc *lsc = lp->lp_lsc;
681 struct lagg_softc *sc = lsc->lsc_softc;
682 char buf[LACP_LAGIDSTR_MAX+1];
684 LACP_LOCK_ASSERT(lsc);
686 if (la == NULL || (lp->lp_state & LACP_STATE_DISTRIBUTING) == 0) {
690 KASSERT(!TAILQ_EMPTY(&la->la_ports), ("no aggregator ports"));
691 KASSERT(la->la_nports > 0, ("nports invalid (%d)", la->la_nports));
692 KASSERT(la->la_refcnt >= la->la_nports, ("aggregator refcnt invalid"));
694 LACP_DPRINTF((lp, "disable distributing on aggregator %s, "
696 lacp_format_lagid_aggregator(la, buf, sizeof(buf)),
697 la->la_nports, la->la_nports - 1));
699 TAILQ_REMOVE(&la->la_ports, lp, lp_dist_q);
701 sc->sc_active = la->la_nports;
703 if (lsc->lsc_active_aggregator == la) {
704 lacp_suppress_distributing(lsc, la);
705 lacp_select_active_aggregator(lsc);
706 /* regenerate the port map, the active aggregator has changed */
707 lacp_update_portmap(lsc);
710 lp->lp_state &= ~LACP_STATE_DISTRIBUTING;
714 lacp_enable_distributing(struct lacp_port *lp)
716 struct lacp_aggregator *la = lp->lp_aggregator;
717 struct lacp_softc *lsc = lp->lp_lsc;
718 struct lagg_softc *sc = lsc->lsc_softc;
719 char buf[LACP_LAGIDSTR_MAX+1];
721 LACP_LOCK_ASSERT(lsc);
723 if ((lp->lp_state & LACP_STATE_DISTRIBUTING) != 0) {
727 LACP_DPRINTF((lp, "enable distributing on aggregator %s, "
729 lacp_format_lagid_aggregator(la, buf, sizeof(buf)),
730 la->la_nports, la->la_nports + 1));
732 KASSERT(la->la_refcnt > la->la_nports, ("aggregator refcnt invalid"));
733 TAILQ_INSERT_HEAD(&la->la_ports, lp, lp_dist_q);
735 sc->sc_active = la->la_nports;
737 lp->lp_state |= LACP_STATE_DISTRIBUTING;
739 if (lsc->lsc_active_aggregator == la) {
740 lacp_suppress_distributing(lsc, la);
741 lacp_update_portmap(lsc);
743 /* try to become the active aggregator */
744 lacp_select_active_aggregator(lsc);
748 lacp_transit_expire(void *vp)
750 struct lacp_softc *lsc = vp;
752 LACP_LOCK_ASSERT(lsc);
754 CURVNET_SET(lsc->lsc_softc->sc_ifp->if_vnet);
758 lsc->lsc_suppress_distributing = FALSE;
762 lacp_attach(struct lagg_softc *sc)
764 struct lacp_softc *lsc;
766 lsc = malloc(sizeof(struct lacp_softc), M_DEVBUF, M_WAITOK | M_ZERO);
768 sc->sc_psc = (caddr_t)lsc;
771 lsc->lsc_hashkey = arc4random();
772 lsc->lsc_active_aggregator = NULL;
773 lsc->lsc_strict_mode = VNET(lacp_default_strict_mode);
775 TAILQ_INIT(&lsc->lsc_aggregators);
776 LIST_INIT(&lsc->lsc_ports);
778 callout_init_mtx(&lsc->lsc_transit_callout, &lsc->lsc_mtx, 0);
779 callout_init_mtx(&lsc->lsc_callout, &lsc->lsc_mtx, 0);
781 /* if the lagg is already up then do the same */
782 if (sc->sc_ifp->if_drv_flags & IFF_DRV_RUNNING)
787 lacp_detach(void *psc)
789 struct lacp_softc *lsc = (struct lacp_softc *)psc;
791 KASSERT(TAILQ_EMPTY(&lsc->lsc_aggregators),
792 ("aggregators still active"));
793 KASSERT(lsc->lsc_active_aggregator == NULL,
794 ("aggregator still attached"));
796 callout_drain(&lsc->lsc_transit_callout);
797 callout_drain(&lsc->lsc_callout);
799 LACP_LOCK_DESTROY(lsc);
805 lacp_init(struct lagg_softc *sc)
807 struct lacp_softc *lsc = LACP_SOFTC(sc);
810 callout_reset(&lsc->lsc_callout, hz, lacp_tick, lsc);
815 lacp_stop(struct lagg_softc *sc)
817 struct lacp_softc *lsc = LACP_SOFTC(sc);
820 callout_stop(&lsc->lsc_transit_callout);
821 callout_stop(&lsc->lsc_callout);
826 lacp_select_tx_port(struct lagg_softc *sc, struct mbuf *m)
828 struct lacp_softc *lsc = LACP_SOFTC(sc);
829 struct lacp_portmap *pm;
830 struct lacp_port *lp;
833 if (__predict_false(lsc->lsc_suppress_distributing)) {
834 LACP_DPRINTF((NULL, "%s: waiting transit\n", __func__));
838 pm = &lsc->lsc_pmap[lsc->lsc_activemap];
839 if (pm->pm_count == 0) {
840 LACP_DPRINTF((NULL, "%s: no active aggregator\n", __func__));
844 if ((sc->sc_opts & LAGG_OPT_USE_FLOWID) &&
845 M_HASHTYPE_GET(m) != M_HASHTYPE_NONE)
846 hash = m->m_pkthdr.flowid >> sc->flowid_shift;
848 hash = lagg_hashmbuf(sc, m, lsc->lsc_hashkey);
849 hash %= pm->pm_count;
850 lp = pm->pm_map[hash];
852 KASSERT((lp->lp_state & LACP_STATE_DISTRIBUTING) != 0,
853 ("aggregated port is not distributing"));
855 return (lp->lp_lagg);
858 * lacp_suppress_distributing: drop transmit packets for a while
859 * to preserve packet ordering.
863 lacp_suppress_distributing(struct lacp_softc *lsc, struct lacp_aggregator *la)
865 struct lacp_port *lp;
867 if (lsc->lsc_active_aggregator != la) {
873 lsc->lsc_suppress_distributing = TRUE;
875 /* send a marker frame down each port to verify the queues are empty */
876 LIST_FOREACH(lp, &lsc->lsc_ports, lp_next) {
877 lp->lp_flags |= LACP_PORT_MARK;
878 lacp_xmit_marker(lp);
881 /* set a timeout for the marker frames */
882 callout_reset(&lsc->lsc_transit_callout,
883 LACP_TRANSIT_DELAY * hz / 1000, lacp_transit_expire, lsc);
887 lacp_compare_peerinfo(const struct lacp_peerinfo *a,
888 const struct lacp_peerinfo *b)
890 return (memcmp(a, b, offsetof(struct lacp_peerinfo, lip_state)));
894 lacp_compare_systemid(const struct lacp_systemid *a,
895 const struct lacp_systemid *b)
897 return (memcmp(a, b, sizeof(*a)));
902 lacp_compare_portid(const struct lacp_portid *a,
903 const struct lacp_portid *b)
905 return (memcmp(a, b, sizeof(*a)));
910 lacp_aggregator_bandwidth(struct lacp_aggregator *la)
912 struct lacp_port *lp;
915 lp = TAILQ_FIRST(&la->la_ports);
920 speed = ifmedia_baudrate(lp->lp_media);
921 speed *= la->la_nports;
923 LACP_DPRINTF((lp, "speed 0? media=0x%x nports=%d\n",
924 lp->lp_media, la->la_nports));
931 * lacp_select_active_aggregator: select an aggregator to be used to transmit
932 * packets from lagg(4) interface.
936 lacp_select_active_aggregator(struct lacp_softc *lsc)
938 struct lacp_aggregator *la;
939 struct lacp_aggregator *best_la = NULL;
940 uint64_t best_speed = 0;
941 char buf[LACP_LAGIDSTR_MAX+1];
945 TAILQ_FOREACH(la, &lsc->lsc_aggregators, la_q) {
948 if (la->la_nports == 0) {
952 speed = lacp_aggregator_bandwidth(la);
953 LACP_DPRINTF((NULL, "%s, speed=%jd, nports=%d\n",
954 lacp_format_lagid_aggregator(la, buf, sizeof(buf)),
955 speed, la->la_nports));
957 /* This aggregator is chosen if
958 * the partner has a better system priority
959 * or, the total aggregated speed is higher
960 * or, it is already the chosen aggregator
962 if ((best_la != NULL && LACP_SYS_PRI(la->la_partner) <
963 LACP_SYS_PRI(best_la->la_partner)) ||
964 speed > best_speed ||
965 (speed == best_speed &&
966 la == lsc->lsc_active_aggregator)) {
972 KASSERT(best_la == NULL || best_la->la_nports > 0,
973 ("invalid aggregator refcnt"));
974 KASSERT(best_la == NULL || !TAILQ_EMPTY(&best_la->la_ports),
975 ("invalid aggregator list"));
977 if (lsc->lsc_active_aggregator != best_la) {
978 LACP_DPRINTF((NULL, "active aggregator changed\n"));
979 LACP_DPRINTF((NULL, "old %s\n",
980 lacp_format_lagid_aggregator(lsc->lsc_active_aggregator,
983 LACP_DPRINTF((NULL, "active aggregator not changed\n"));
985 LACP_DPRINTF((NULL, "new %s\n",
986 lacp_format_lagid_aggregator(best_la, buf, sizeof(buf))));
988 if (lsc->lsc_active_aggregator != best_la) {
989 lsc->lsc_active_aggregator = best_la;
990 lacp_update_portmap(lsc);
992 lacp_suppress_distributing(lsc, best_la);
998 * Updated the inactive portmap array with the new list of ports and
1002 lacp_update_portmap(struct lacp_softc *lsc)
1004 struct lagg_softc *sc = lsc->lsc_softc;
1005 struct lacp_aggregator *la;
1006 struct lacp_portmap *p;
1007 struct lacp_port *lp;
1012 newmap = lsc->lsc_activemap == 0 ? 1 : 0;
1013 p = &lsc->lsc_pmap[newmap];
1014 la = lsc->lsc_active_aggregator;
1016 bzero(p, sizeof(struct lacp_portmap));
1018 if (la != NULL && la->la_nports > 0) {
1019 p->pm_count = la->la_nports;
1021 TAILQ_FOREACH(lp, &la->la_ports, lp_dist_q)
1022 p->pm_map[i++] = lp;
1023 KASSERT(i == p->pm_count, ("Invalid port count"));
1024 speed = lacp_aggregator_bandwidth(la);
1026 sc->sc_ifp->if_baudrate = speed;
1028 /* switch the active portmap over */
1029 atomic_store_rel_int(&lsc->lsc_activemap, newmap);
1030 LACP_DPRINTF((NULL, "Set table %d with %d ports\n",
1032 lsc->lsc_pmap[lsc->lsc_activemap].pm_count));
1036 lacp_compose_key(struct lacp_port *lp)
1038 struct lagg_port *lgp = lp->lp_lagg;
1039 struct lagg_softc *sc = lgp->lp_softc;
1040 u_int media = lp->lp_media;
1043 if ((lp->lp_state & LACP_STATE_AGGREGATION) == 0) {
1046 * non-aggregatable links should have unique keys.
1048 * XXX this isn't really unique as if_index is 16 bit.
1051 /* bit 0..14: (some bits of) if_index of this port */
1052 key = lp->lp_ifp->if_index;
1056 u_int subtype = IFM_SUBTYPE(media);
1058 KASSERT(IFM_TYPE(media) == IFM_ETHER, ("invalid media type"));
1059 KASSERT((media & IFM_FDX) != 0, ("aggregating HDX interface"));
1061 /* bit 0..4: IFM_SUBTYPE modulo speed */
1083 case IFM_1000_SGMII:
1084 case IFM_1000_CX_SGMII:
1090 case IFM_10G_TWINAX:
1091 case IFM_10G_TWINAX_LONG:
1142 /* bit 5..14: (some bits of) if_index of lagg device */
1143 key |= 0x7fe0 & ((sc->sc_ifp->if_index) << 5);
1146 return (htons(key));
1150 lacp_aggregator_addref(struct lacp_softc *lsc, struct lacp_aggregator *la)
1152 char buf[LACP_LAGIDSTR_MAX+1];
1154 LACP_DPRINTF((NULL, "%s: lagid=%s, refcnt %d -> %d\n",
1156 lacp_format_lagid(&la->la_actor, &la->la_partner,
1158 la->la_refcnt, la->la_refcnt + 1));
1160 KASSERT(la->la_refcnt > 0, ("refcount <= 0"));
1162 KASSERT(la->la_refcnt > la->la_nports, ("invalid refcount"));
1166 lacp_aggregator_delref(struct lacp_softc *lsc, struct lacp_aggregator *la)
1168 char buf[LACP_LAGIDSTR_MAX+1];
1170 LACP_DPRINTF((NULL, "%s: lagid=%s, refcnt %d -> %d\n",
1172 lacp_format_lagid(&la->la_actor, &la->la_partner,
1174 la->la_refcnt, la->la_refcnt - 1));
1176 KASSERT(la->la_refcnt > la->la_nports, ("invalid refcnt"));
1178 if (la->la_refcnt > 0) {
1182 KASSERT(la->la_refcnt == 0, ("refcount not zero"));
1183 KASSERT(lsc->lsc_active_aggregator != la, ("aggregator active"));
1185 TAILQ_REMOVE(&lsc->lsc_aggregators, la, la_q);
1191 * lacp_aggregator_get: allocate an aggregator.
1194 static struct lacp_aggregator *
1195 lacp_aggregator_get(struct lacp_softc *lsc, struct lacp_port *lp)
1197 struct lacp_aggregator *la;
1199 la = malloc(sizeof(*la), M_DEVBUF, M_NOWAIT);
1203 TAILQ_INIT(&la->la_ports);
1205 TAILQ_INSERT_TAIL(&lsc->lsc_aggregators, la, la_q);
1212 * lacp_fill_aggregator_id: setup a newly allocated aggregator from a port.
1216 lacp_fill_aggregator_id(struct lacp_aggregator *la, const struct lacp_port *lp)
1218 lacp_fill_aggregator_id_peer(&la->la_partner, &lp->lp_partner);
1219 lacp_fill_aggregator_id_peer(&la->la_actor, &lp->lp_actor);
1221 la->la_actor.lip_state = lp->lp_state & LACP_STATE_AGGREGATION;
1225 lacp_fill_aggregator_id_peer(struct lacp_peerinfo *lpi_aggr,
1226 const struct lacp_peerinfo *lpi_port)
1228 memset(lpi_aggr, 0, sizeof(*lpi_aggr));
1229 lpi_aggr->lip_systemid = lpi_port->lip_systemid;
1230 lpi_aggr->lip_key = lpi_port->lip_key;
1234 * lacp_aggregator_is_compatible: check if a port can join to an aggregator.
1238 lacp_aggregator_is_compatible(const struct lacp_aggregator *la,
1239 const struct lacp_port *lp)
1241 if (!(lp->lp_state & LACP_STATE_AGGREGATION) ||
1242 !(lp->lp_partner.lip_state & LACP_STATE_AGGREGATION)) {
1246 if (!(la->la_actor.lip_state & LACP_STATE_AGGREGATION)) {
1250 if (!lacp_peerinfo_is_compatible(&la->la_partner, &lp->lp_partner)) {
1254 if (!lacp_peerinfo_is_compatible(&la->la_actor, &lp->lp_actor)) {
1262 lacp_peerinfo_is_compatible(const struct lacp_peerinfo *a,
1263 const struct lacp_peerinfo *b)
1265 if (memcmp(&a->lip_systemid, &b->lip_systemid,
1266 sizeof(a->lip_systemid))) {
1270 if (memcmp(&a->lip_key, &b->lip_key, sizeof(a->lip_key))) {
1278 lacp_port_enable(struct lacp_port *lp)
1280 lp->lp_state |= LACP_STATE_AGGREGATION;
1284 lacp_port_disable(struct lacp_port *lp)
1286 lacp_set_mux(lp, LACP_MUX_DETACHED);
1288 lp->lp_state &= ~LACP_STATE_AGGREGATION;
1289 lp->lp_selected = LACP_UNSELECTED;
1290 lacp_sm_rx_record_default(lp);
1291 lp->lp_partner.lip_state &= ~LACP_STATE_AGGREGATION;
1292 lp->lp_state &= ~LACP_STATE_EXPIRED;
1296 * lacp_select: select an aggregator. create one if necessary.
1299 lacp_select(struct lacp_port *lp)
1301 struct lacp_softc *lsc = lp->lp_lsc;
1302 struct lacp_aggregator *la;
1303 char buf[LACP_LAGIDSTR_MAX+1];
1305 if (lp->lp_aggregator) {
1309 KASSERT(!LACP_TIMER_ISARMED(lp, LACP_TIMER_WAIT_WHILE),
1310 ("timer_wait_while still active"));
1312 LACP_DPRINTF((lp, "port lagid=%s\n",
1313 lacp_format_lagid(&lp->lp_actor, &lp->lp_partner,
1314 buf, sizeof(buf))));
1316 TAILQ_FOREACH(la, &lsc->lsc_aggregators, la_q) {
1317 if (lacp_aggregator_is_compatible(la, lp)) {
1323 la = lacp_aggregator_get(lsc, lp);
1325 LACP_DPRINTF((lp, "aggregator creation failed\n"));
1328 * will retry on the next tick.
1333 lacp_fill_aggregator_id(la, lp);
1334 LACP_DPRINTF((lp, "aggregator created\n"));
1336 LACP_DPRINTF((lp, "compatible aggregator found\n"));
1337 if (la->la_refcnt == LACP_MAX_PORTS)
1339 lacp_aggregator_addref(lsc, la);
1342 LACP_DPRINTF((lp, "aggregator lagid=%s\n",
1343 lacp_format_lagid(&la->la_actor, &la->la_partner,
1344 buf, sizeof(buf))));
1346 lp->lp_aggregator = la;
1347 lp->lp_selected = LACP_SELECTED;
1351 * lacp_unselect: finish unselect/detach process.
1355 lacp_unselect(struct lacp_port *lp)
1357 struct lacp_softc *lsc = lp->lp_lsc;
1358 struct lacp_aggregator *la = lp->lp_aggregator;
1360 KASSERT(!LACP_TIMER_ISARMED(lp, LACP_TIMER_WAIT_WHILE),
1361 ("timer_wait_while still active"));
1367 lp->lp_aggregator = NULL;
1368 lacp_aggregator_delref(lsc, la);
1374 lacp_sm_mux(struct lacp_port *lp)
1376 struct lagg_port *lgp = lp->lp_lagg;
1377 struct lagg_softc *sc = lgp->lp_softc;
1378 enum lacp_mux_state new_state;
1380 (lp->lp_partner.lip_state & LACP_STATE_SYNC) != 0;
1381 boolean_t p_collecting =
1382 (lp->lp_partner.lip_state & LACP_STATE_COLLECTING) != 0;
1383 enum lacp_selected selected = lp->lp_selected;
1384 struct lacp_aggregator *la;
1386 if (V_lacp_debug > 1)
1387 lacp_dprintf(lp, "%s: state= 0x%x, selected= 0x%x, "
1388 "p_sync= 0x%x, p_collecting= 0x%x\n", __func__,
1389 lp->lp_mux_state, selected, p_sync, p_collecting);
1392 la = lp->lp_aggregator;
1393 KASSERT(lp->lp_mux_state == LACP_MUX_DETACHED || la != NULL,
1394 ("MUX not detached"));
1395 new_state = lp->lp_mux_state;
1396 switch (lp->lp_mux_state) {
1397 case LACP_MUX_DETACHED:
1398 if (selected != LACP_UNSELECTED) {
1399 new_state = LACP_MUX_WAITING;
1402 case LACP_MUX_WAITING:
1403 KASSERT(la->la_pending > 0 ||
1404 !LACP_TIMER_ISARMED(lp, LACP_TIMER_WAIT_WHILE),
1405 ("timer_wait_while still active"));
1406 if (selected == LACP_SELECTED && la->la_pending == 0) {
1407 new_state = LACP_MUX_ATTACHED;
1408 } else if (selected == LACP_UNSELECTED) {
1409 new_state = LACP_MUX_DETACHED;
1412 case LACP_MUX_ATTACHED:
1413 if (selected == LACP_SELECTED && p_sync) {
1414 new_state = LACP_MUX_COLLECTING;
1415 } else if (selected != LACP_SELECTED) {
1416 new_state = LACP_MUX_DETACHED;
1419 case LACP_MUX_COLLECTING:
1420 if (selected == LACP_SELECTED && p_sync && p_collecting) {
1421 new_state = LACP_MUX_DISTRIBUTING;
1422 } else if (selected != LACP_SELECTED || !p_sync) {
1423 new_state = LACP_MUX_ATTACHED;
1426 case LACP_MUX_DISTRIBUTING:
1427 if (selected != LACP_SELECTED || !p_sync || !p_collecting) {
1428 new_state = LACP_MUX_COLLECTING;
1429 lacp_dprintf(lp, "Interface stopped DISTRIBUTING, possible flapping\n");
1434 panic("%s: unknown state", __func__);
1437 if (lp->lp_mux_state == new_state) {
1441 lacp_set_mux(lp, new_state);
1446 lacp_set_mux(struct lacp_port *lp, enum lacp_mux_state new_state)
1448 struct lacp_aggregator *la = lp->lp_aggregator;
1450 if (lp->lp_mux_state == new_state) {
1454 switch (new_state) {
1455 case LACP_MUX_DETACHED:
1456 lp->lp_state &= ~LACP_STATE_SYNC;
1457 lacp_disable_distributing(lp);
1458 lacp_disable_collecting(lp);
1459 lacp_sm_assert_ntt(lp);
1461 if (LACP_TIMER_ISARMED(lp, LACP_TIMER_WAIT_WHILE)) {
1462 KASSERT(la->la_pending > 0,
1463 ("timer_wait_while not active"));
1466 LACP_TIMER_DISARM(lp, LACP_TIMER_WAIT_WHILE);
1469 case LACP_MUX_WAITING:
1470 LACP_TIMER_ARM(lp, LACP_TIMER_WAIT_WHILE,
1471 LACP_AGGREGATE_WAIT_TIME);
1474 case LACP_MUX_ATTACHED:
1475 lp->lp_state |= LACP_STATE_SYNC;
1476 lacp_disable_collecting(lp);
1477 lacp_sm_assert_ntt(lp);
1479 case LACP_MUX_COLLECTING:
1480 lacp_enable_collecting(lp);
1481 lacp_disable_distributing(lp);
1482 lacp_sm_assert_ntt(lp);
1484 case LACP_MUX_DISTRIBUTING:
1485 lacp_enable_distributing(lp);
1488 panic("%s: unknown state", __func__);
1491 LACP_DPRINTF((lp, "mux_state %d -> %d\n", lp->lp_mux_state, new_state));
1493 lp->lp_mux_state = new_state;
1497 lacp_sm_mux_timer(struct lacp_port *lp)
1499 struct lacp_aggregator *la = lp->lp_aggregator;
1500 char buf[LACP_LAGIDSTR_MAX+1];
1502 KASSERT(la->la_pending > 0, ("no pending event"));
1504 LACP_DPRINTF((lp, "%s: aggregator %s, pending %d -> %d\n", __func__,
1505 lacp_format_lagid(&la->la_actor, &la->la_partner,
1507 la->la_pending, la->la_pending - 1));
1512 /* periodic transmit machine */
1515 lacp_sm_ptx_update_timeout(struct lacp_port *lp, uint8_t oldpstate)
1517 if (LACP_STATE_EQ(oldpstate, lp->lp_partner.lip_state,
1518 LACP_STATE_TIMEOUT)) {
1522 LACP_DPRINTF((lp, "partner timeout changed\n"));
1525 * FAST_PERIODIC -> SLOW_PERIODIC
1527 * SLOW_PERIODIC (-> PERIODIC_TX) -> FAST_PERIODIC
1529 * let lacp_sm_ptx_tx_schedule to update timeout.
1532 LACP_TIMER_DISARM(lp, LACP_TIMER_PERIODIC);
1535 * if timeout has been shortened, assert NTT.
1538 if ((lp->lp_partner.lip_state & LACP_STATE_TIMEOUT)) {
1539 lacp_sm_assert_ntt(lp);
1544 lacp_sm_ptx_tx_schedule(struct lacp_port *lp)
1548 if (!(lp->lp_state & LACP_STATE_ACTIVITY) &&
1549 !(lp->lp_partner.lip_state & LACP_STATE_ACTIVITY)) {
1555 LACP_TIMER_DISARM(lp, LACP_TIMER_PERIODIC);
1559 if (LACP_TIMER_ISARMED(lp, LACP_TIMER_PERIODIC)) {
1563 timeout = (lp->lp_partner.lip_state & LACP_STATE_TIMEOUT) ?
1564 LACP_FAST_PERIODIC_TIME : LACP_SLOW_PERIODIC_TIME;
1566 LACP_TIMER_ARM(lp, LACP_TIMER_PERIODIC, timeout);
1570 lacp_sm_ptx_timer(struct lacp_port *lp)
1572 lacp_sm_assert_ntt(lp);
1576 lacp_sm_rx(struct lacp_port *lp, const struct lacpdu *du)
1581 * check LACP_DISABLED first
1584 if (!(lp->lp_state & LACP_STATE_AGGREGATION)) {
1589 * check loopback condition.
1592 if (!lacp_compare_systemid(&du->ldu_actor.lip_systemid,
1593 &lp->lp_actor.lip_systemid)) {
1598 * EXPIRED, DEFAULTED, CURRENT -> CURRENT
1601 lacp_sm_rx_update_selected(lp, du);
1602 lacp_sm_rx_update_ntt(lp, du);
1603 lacp_sm_rx_record_pdu(lp, du);
1605 timeout = (lp->lp_state & LACP_STATE_TIMEOUT) ?
1606 LACP_SHORT_TIMEOUT_TIME : LACP_LONG_TIMEOUT_TIME;
1607 LACP_TIMER_ARM(lp, LACP_TIMER_CURRENT_WHILE, timeout);
1609 lp->lp_state &= ~LACP_STATE_EXPIRED;
1612 * kick transmit machine without waiting the next tick.
1619 lacp_sm_rx_set_expired(struct lacp_port *lp)
1621 lp->lp_partner.lip_state &= ~LACP_STATE_SYNC;
1622 lp->lp_partner.lip_state |= LACP_STATE_TIMEOUT;
1623 LACP_TIMER_ARM(lp, LACP_TIMER_CURRENT_WHILE, LACP_SHORT_TIMEOUT_TIME);
1624 lp->lp_state |= LACP_STATE_EXPIRED;
1628 lacp_sm_rx_timer(struct lacp_port *lp)
1630 if ((lp->lp_state & LACP_STATE_EXPIRED) == 0) {
1631 /* CURRENT -> EXPIRED */
1632 LACP_DPRINTF((lp, "%s: CURRENT -> EXPIRED\n", __func__));
1633 lacp_sm_rx_set_expired(lp);
1635 /* EXPIRED -> DEFAULTED */
1636 LACP_DPRINTF((lp, "%s: EXPIRED -> DEFAULTED\n", __func__));
1637 lacp_sm_rx_update_default_selected(lp);
1638 lacp_sm_rx_record_default(lp);
1639 lp->lp_state &= ~LACP_STATE_EXPIRED;
1644 lacp_sm_rx_record_pdu(struct lacp_port *lp, const struct lacpdu *du)
1648 char buf[LACP_STATESTR_MAX+1];
1652 oldpstate = lp->lp_partner.lip_state;
1654 active = (du->ldu_actor.lip_state & LACP_STATE_ACTIVITY)
1655 || ((lp->lp_state & LACP_STATE_ACTIVITY) &&
1656 (du->ldu_partner.lip_state & LACP_STATE_ACTIVITY));
1658 lp->lp_partner = du->ldu_actor;
1660 ((LACP_STATE_EQ(lp->lp_state, du->ldu_partner.lip_state,
1661 LACP_STATE_AGGREGATION) &&
1662 !lacp_compare_peerinfo(&lp->lp_actor, &du->ldu_partner))
1663 || (du->ldu_partner.lip_state & LACP_STATE_AGGREGATION) == 0)) {
1666 lp->lp_partner.lip_state &= ~LACP_STATE_SYNC;
1669 lp->lp_state &= ~LACP_STATE_DEFAULTED;
1671 if (oldpstate != lp->lp_partner.lip_state) {
1672 LACP_DPRINTF((lp, "old pstate %s\n",
1673 lacp_format_state(oldpstate, buf, sizeof(buf))));
1674 LACP_DPRINTF((lp, "new pstate %s\n",
1675 lacp_format_state(lp->lp_partner.lip_state, buf,
1679 /* XXX Hack, still need to implement 5.4.9 para 2,3,4 */
1680 if (lp->lp_lsc->lsc_strict_mode)
1681 lp->lp_partner.lip_state |= LACP_STATE_SYNC;
1683 lacp_sm_ptx_update_timeout(lp, oldpstate);
1687 lacp_sm_rx_update_ntt(struct lacp_port *lp, const struct lacpdu *du)
1692 if (lacp_compare_peerinfo(&lp->lp_actor, &du->ldu_partner) ||
1693 !LACP_STATE_EQ(lp->lp_state, du->ldu_partner.lip_state,
1694 LACP_STATE_ACTIVITY | LACP_STATE_SYNC | LACP_STATE_AGGREGATION)) {
1695 LACP_DPRINTF((lp, "%s: assert ntt\n", __func__));
1696 lacp_sm_assert_ntt(lp);
1701 lacp_sm_rx_record_default(struct lacp_port *lp)
1707 oldpstate = lp->lp_partner.lip_state;
1708 if (lp->lp_lsc->lsc_strict_mode)
1709 lp->lp_partner = lacp_partner_admin_strict;
1711 lp->lp_partner = lacp_partner_admin_optimistic;
1712 lp->lp_state |= LACP_STATE_DEFAULTED;
1713 lacp_sm_ptx_update_timeout(lp, oldpstate);
1717 lacp_sm_rx_update_selected_from_peerinfo(struct lacp_port *lp,
1718 const struct lacp_peerinfo *info)
1723 if (lacp_compare_peerinfo(&lp->lp_partner, info) ||
1724 !LACP_STATE_EQ(lp->lp_partner.lip_state, info->lip_state,
1725 LACP_STATE_AGGREGATION)) {
1726 lp->lp_selected = LACP_UNSELECTED;
1727 /* mux machine will clean up lp->lp_aggregator */
1732 lacp_sm_rx_update_selected(struct lacp_port *lp, const struct lacpdu *du)
1737 lacp_sm_rx_update_selected_from_peerinfo(lp, &du->ldu_actor);
1741 lacp_sm_rx_update_default_selected(struct lacp_port *lp)
1746 if (lp->lp_lsc->lsc_strict_mode)
1747 lacp_sm_rx_update_selected_from_peerinfo(lp,
1748 &lacp_partner_admin_strict);
1750 lacp_sm_rx_update_selected_from_peerinfo(lp,
1751 &lacp_partner_admin_optimistic);
1754 /* transmit machine */
1757 lacp_sm_tx(struct lacp_port *lp)
1761 if (!(lp->lp_state & LACP_STATE_AGGREGATION)
1763 || (!(lp->lp_state & LACP_STATE_ACTIVITY)
1764 && !(lp->lp_partner.lip_state & LACP_STATE_ACTIVITY))
1767 lp->lp_flags &= ~LACP_PORT_NTT;
1770 if (!(lp->lp_flags & LACP_PORT_NTT)) {
1774 /* Rate limit to 3 PDUs per LACP_FAST_PERIODIC_TIME */
1775 if (ppsratecheck(&lp->lp_last_lacpdu, &lp->lp_lacpdu_sent,
1776 (3 / LACP_FAST_PERIODIC_TIME)) == 0) {
1777 LACP_DPRINTF((lp, "rate limited pdu\n"));
1781 if (((1 << lp->lp_ifp->if_dunit) & lp->lp_lsc->lsc_debug.lsc_tx_test) == 0) {
1782 error = lacp_xmit_lacpdu(lp);
1784 LACP_TPRINTF((lp, "Dropping TX PDU\n"));
1788 lp->lp_flags &= ~LACP_PORT_NTT;
1790 LACP_DPRINTF((lp, "lacpdu transmit failure, error %d\n",
1796 lacp_sm_assert_ntt(struct lacp_port *lp)
1799 lp->lp_flags |= LACP_PORT_NTT;
1803 lacp_run_timers(struct lacp_port *lp)
1807 for (i = 0; i < LACP_NTIMER; i++) {
1808 KASSERT(lp->lp_timer[i] >= 0,
1809 ("invalid timer value %d", lp->lp_timer[i]));
1810 if (lp->lp_timer[i] == 0) {
1812 } else if (--lp->lp_timer[i] <= 0) {
1813 if (lacp_timer_funcs[i]) {
1814 (*lacp_timer_funcs[i])(lp);
1821 lacp_marker_input(struct lacp_port *lp, struct mbuf *m)
1823 struct lacp_softc *lsc = lp->lp_lsc;
1824 struct lagg_port *lgp = lp->lp_lagg;
1825 struct lacp_port *lp2;
1826 struct markerdu *mdu;
1830 if (m->m_pkthdr.len != sizeof(*mdu)) {
1834 if ((m->m_flags & M_MCAST) == 0) {
1838 if (m->m_len < sizeof(*mdu)) {
1839 m = m_pullup(m, sizeof(*mdu));
1845 mdu = mtod(m, struct markerdu *);
1847 if (memcmp(&mdu->mdu_eh.ether_dhost,
1848 ðermulticastaddr_slowprotocols, ETHER_ADDR_LEN)) {
1852 if (mdu->mdu_sph.sph_version != 1) {
1856 switch (mdu->mdu_tlv.tlv_type) {
1857 case MARKER_TYPE_INFO:
1858 if (tlv_check(mdu, sizeof(*mdu), &mdu->mdu_tlv,
1859 marker_info_tlv_template, TRUE)) {
1862 mdu->mdu_tlv.tlv_type = MARKER_TYPE_RESPONSE;
1863 memcpy(&mdu->mdu_eh.ether_dhost,
1864 ðermulticastaddr_slowprotocols, ETHER_ADDR_LEN);
1865 memcpy(&mdu->mdu_eh.ether_shost,
1866 lgp->lp_lladdr, ETHER_ADDR_LEN);
1867 error = lagg_enqueue(lp->lp_ifp, m);
1870 case MARKER_TYPE_RESPONSE:
1871 if (tlv_check(mdu, sizeof(*mdu), &mdu->mdu_tlv,
1872 marker_response_tlv_template, TRUE)) {
1875 LACP_DPRINTF((lp, "marker response, port=%u, sys=%6D, id=%u\n",
1876 ntohs(mdu->mdu_info.mi_rq_port), mdu->mdu_info.mi_rq_system,
1877 ":", ntohl(mdu->mdu_info.mi_rq_xid)));
1879 /* Verify that it is the last marker we sent out */
1880 if (memcmp(&mdu->mdu_info, &lp->lp_marker,
1881 sizeof(struct lacp_markerinfo)))
1885 lp->lp_flags &= ~LACP_PORT_MARK;
1887 if (lsc->lsc_suppress_distributing) {
1888 /* Check if any ports are waiting for a response */
1889 LIST_FOREACH(lp2, &lsc->lsc_ports, lp_next) {
1890 if (lp2->lp_flags & LACP_PORT_MARK) {
1897 /* All interface queues are clear */
1898 LACP_DPRINTF((NULL, "queue flush complete\n"));
1899 lsc->lsc_suppress_distributing = FALSE;
1913 LACP_DPRINTF((lp, "bad marker frame\n"));
1919 tlv_check(const void *p, size_t size, const struct tlvhdr *tlv,
1920 const struct tlv_template *tmpl, boolean_t check_type)
1922 while (/* CONSTCOND */ 1) {
1923 if ((const char *)tlv - (const char *)p + sizeof(*tlv) > size) {
1926 if ((check_type && tlv->tlv_type != tmpl->tmpl_type) ||
1927 tlv->tlv_length != tmpl->tmpl_length) {
1930 if (tmpl->tmpl_type == 0) {
1933 tlv = (const struct tlvhdr *)
1934 ((const char *)tlv + tlv->tlv_length);
1943 lacp_format_mac(const uint8_t *mac, char *buf, size_t buflen)
1945 snprintf(buf, buflen, "%02X-%02X-%02X-%02X-%02X-%02X",
1957 lacp_format_systemid(const struct lacp_systemid *sysid,
1958 char *buf, size_t buflen)
1960 char macbuf[LACP_MACSTR_MAX+1];
1962 snprintf(buf, buflen, "%04X,%s",
1963 ntohs(sysid->lsi_prio),
1964 lacp_format_mac(sysid->lsi_mac, macbuf, sizeof(macbuf)));
1970 lacp_format_portid(const struct lacp_portid *portid, char *buf, size_t buflen)
1972 snprintf(buf, buflen, "%04X,%04X",
1973 ntohs(portid->lpi_prio),
1974 ntohs(portid->lpi_portno));
1980 lacp_format_partner(const struct lacp_peerinfo *peer, char *buf, size_t buflen)
1982 char sysid[LACP_SYSTEMIDSTR_MAX+1];
1983 char portid[LACP_PORTIDSTR_MAX+1];
1985 snprintf(buf, buflen, "(%s,%04X,%s)",
1986 lacp_format_systemid(&peer->lip_systemid, sysid, sizeof(sysid)),
1987 ntohs(peer->lip_key),
1988 lacp_format_portid(&peer->lip_portid, portid, sizeof(portid)));
1994 lacp_format_lagid(const struct lacp_peerinfo *a,
1995 const struct lacp_peerinfo *b, char *buf, size_t buflen)
1997 char astr[LACP_PARTNERSTR_MAX+1];
1998 char bstr[LACP_PARTNERSTR_MAX+1];
2002 * there's a convention to display small numbered peer
2006 if (lacp_compare_peerinfo(a, b) > 0) {
2007 const struct lacp_peerinfo *t;
2015 snprintf(buf, buflen, "[%s,%s]",
2016 lacp_format_partner(a, astr, sizeof(astr)),
2017 lacp_format_partner(b, bstr, sizeof(bstr)));
2023 lacp_format_lagid_aggregator(const struct lacp_aggregator *la,
2024 char *buf, size_t buflen)
2030 return (lacp_format_lagid(&la->la_actor, &la->la_partner, buf, buflen));
2034 lacp_format_state(uint8_t state, char *buf, size_t buflen)
2036 snprintf(buf, buflen, "%b", state, LACP_STATE_BITS);
2041 lacp_dump_lacpdu(const struct lacpdu *du)
2043 char buf[LACP_PARTNERSTR_MAX+1];
2044 char buf2[LACP_STATESTR_MAX+1];
2046 printf("actor=%s\n",
2047 lacp_format_partner(&du->ldu_actor, buf, sizeof(buf)));
2048 printf("actor.state=%s\n",
2049 lacp_format_state(du->ldu_actor.lip_state, buf2, sizeof(buf2)));
2050 printf("partner=%s\n",
2051 lacp_format_partner(&du->ldu_partner, buf, sizeof(buf)));
2052 printf("partner.state=%s\n",
2053 lacp_format_state(du->ldu_partner.lip_state, buf2, sizeof(buf2)));
2055 printf("maxdelay=%d\n", ntohs(du->ldu_collector.lci_maxdelay));
2059 lacp_dprintf(const struct lacp_port *lp, const char *fmt, ...)
2064 printf("%s: ", lp->lp_ifp->if_xname);