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 int lacp_debug = 0;
191 SYSCTL_NODE(_net_link_lagg, OID_AUTO, lacp, CTLFLAG_RD, 0, "ieee802.3ad");
192 SYSCTL_INT(_net_link_lagg_lacp, OID_AUTO, debug, CTLFLAG_RW | CTLFLAG_TUN,
193 &lacp_debug, 0, "Enable LACP debug logging (1=debug, 2=trace)");
194 TUNABLE_INT("net.link.lagg.lacp.debug", &lacp_debug);
196 #define LACP_DPRINTF(a) if (lacp_debug & 0x01) { lacp_dprintf a ; }
197 #define LACP_TRACE(a) if (lacp_debug & 0x02) { lacp_dprintf(a,"%s\n",__func__); }
198 #define LACP_TPRINTF(a) if (lacp_debug & 0x04) { lacp_dprintf a ; }
201 * partner administration variables.
202 * XXX should be configurable.
205 static const struct lacp_peerinfo lacp_partner_admin_optimistic = {
206 .lip_systemid = { .lsi_prio = 0xffff },
207 .lip_portid = { .lpi_prio = 0xffff },
208 .lip_state = LACP_STATE_SYNC | LACP_STATE_AGGREGATION |
209 LACP_STATE_COLLECTING | LACP_STATE_DISTRIBUTING,
212 static const struct lacp_peerinfo lacp_partner_admin_strict = {
213 .lip_systemid = { .lsi_prio = 0xffff },
214 .lip_portid = { .lpi_prio = 0xffff },
218 static const lacp_timer_func_t lacp_timer_funcs[LACP_NTIMER] = {
219 [LACP_TIMER_CURRENT_WHILE] = lacp_sm_rx_timer,
220 [LACP_TIMER_PERIODIC] = lacp_sm_ptx_timer,
221 [LACP_TIMER_WAIT_WHILE] = lacp_sm_mux_timer,
225 lacp_input(struct lagg_port *lgp, struct mbuf *m)
227 struct lacp_port *lp = LACP_PORT(lgp);
230 if (m->m_pkthdr.len < sizeof(struct ether_header) + sizeof(subtype)) {
235 m_copydata(m, sizeof(struct ether_header), sizeof(subtype), &subtype);
237 case SLOWPROTOCOLS_SUBTYPE_LACP:
238 lacp_pdu_input(lp, m);
241 case SLOWPROTOCOLS_SUBTYPE_MARKER:
242 lacp_marker_input(lp, m);
246 /* Not a subtype we are interested in */
251 * lacp_pdu_input: process lacpdu
254 lacp_pdu_input(struct lacp_port *lp, struct mbuf *m)
256 struct lacp_softc *lsc = lp->lp_lsc;
260 if (m->m_pkthdr.len != sizeof(*du)) {
264 if ((m->m_flags & M_MCAST) == 0) {
268 if (m->m_len < sizeof(*du)) {
269 m = m_pullup(m, sizeof(*du));
275 du = mtod(m, struct lacpdu *);
277 if (memcmp(&du->ldu_eh.ether_dhost,
278 ðermulticastaddr_slowprotocols, ETHER_ADDR_LEN)) {
283 * ignore the version for compatibility with
284 * the future protocol revisions.
287 if (du->ldu_sph.sph_version != 1) {
293 * ignore tlv types for compatibility with
294 * the future protocol revisions.
296 if (tlv_check(du, sizeof(*du), &du->ldu_tlv_actor,
297 lacp_info_tlv_template, FALSE)) {
301 if (lacp_debug > 0) {
302 lacp_dprintf(lp, "lacpdu receive\n");
303 lacp_dump_lacpdu(du);
306 if ((1 << lp->lp_ifp->if_dunit) & lp->lp_lsc->lsc_debug.lsc_rx_test) {
307 LACP_TPRINTF((lp, "Dropping RX PDU\n"));
324 lacp_fill_actorinfo(struct lacp_port *lp, struct lacp_peerinfo *info)
326 struct lagg_port *lgp = lp->lp_lagg;
327 struct lagg_softc *sc = lgp->lp_softc;
329 info->lip_systemid.lsi_prio = htons(LACP_SYSTEM_PRIO);
330 memcpy(&info->lip_systemid.lsi_mac,
331 IF_LLADDR(sc->sc_ifp), ETHER_ADDR_LEN);
332 info->lip_portid.lpi_prio = htons(LACP_PORT_PRIO);
333 info->lip_portid.lpi_portno = htons(lp->lp_ifp->if_index);
334 info->lip_state = lp->lp_state;
338 lacp_fill_markerinfo(struct lacp_port *lp, struct lacp_markerinfo *info)
340 struct ifnet *ifp = lp->lp_ifp;
342 /* Fill in the port index and system id (encoded as the MAC) */
343 info->mi_rq_port = htons(ifp->if_index);
344 memcpy(&info->mi_rq_system, lp->lp_systemid.lsi_mac, ETHER_ADDR_LEN);
345 info->mi_rq_xid = htonl(0);
349 lacp_xmit_lacpdu(struct lacp_port *lp)
351 struct lagg_port *lgp = lp->lp_lagg;
356 LACP_LOCK_ASSERT(lp->lp_lsc);
358 m = m_gethdr(M_NOWAIT, MT_DATA);
362 m->m_len = m->m_pkthdr.len = sizeof(*du);
364 du = mtod(m, struct lacpdu *);
365 memset(du, 0, sizeof(*du));
367 memcpy(&du->ldu_eh.ether_dhost, ethermulticastaddr_slowprotocols,
369 memcpy(&du->ldu_eh.ether_shost, lgp->lp_lladdr, ETHER_ADDR_LEN);
370 du->ldu_eh.ether_type = htons(ETHERTYPE_SLOW);
372 du->ldu_sph.sph_subtype = SLOWPROTOCOLS_SUBTYPE_LACP;
373 du->ldu_sph.sph_version = 1;
375 TLV_SET(&du->ldu_tlv_actor, LACP_TYPE_ACTORINFO, sizeof(du->ldu_actor));
376 du->ldu_actor = lp->lp_actor;
378 TLV_SET(&du->ldu_tlv_partner, LACP_TYPE_PARTNERINFO,
379 sizeof(du->ldu_partner));
380 du->ldu_partner = lp->lp_partner;
382 TLV_SET(&du->ldu_tlv_collector, LACP_TYPE_COLLECTORINFO,
383 sizeof(du->ldu_collector));
384 du->ldu_collector.lci_maxdelay = 0;
386 if (lacp_debug > 0) {
387 lacp_dprintf(lp, "lacpdu transmit\n");
388 lacp_dump_lacpdu(du);
391 m->m_flags |= M_MCAST;
394 * XXX should use higher priority queue.
395 * otherwise network congestion can break aggregation.
398 error = lagg_enqueue(lp->lp_ifp, m);
403 lacp_xmit_marker(struct lacp_port *lp)
405 struct lagg_port *lgp = lp->lp_lagg;
407 struct markerdu *mdu;
410 LACP_LOCK_ASSERT(lp->lp_lsc);
412 m = m_gethdr(M_NOWAIT, MT_DATA);
416 m->m_len = m->m_pkthdr.len = sizeof(*mdu);
418 mdu = mtod(m, struct markerdu *);
419 memset(mdu, 0, sizeof(*mdu));
421 memcpy(&mdu->mdu_eh.ether_dhost, ethermulticastaddr_slowprotocols,
423 memcpy(&mdu->mdu_eh.ether_shost, lgp->lp_lladdr, ETHER_ADDR_LEN);
424 mdu->mdu_eh.ether_type = htons(ETHERTYPE_SLOW);
426 mdu->mdu_sph.sph_subtype = SLOWPROTOCOLS_SUBTYPE_MARKER;
427 mdu->mdu_sph.sph_version = 1;
429 /* Bump the transaction id and copy over the marker info */
430 lp->lp_marker.mi_rq_xid = htonl(ntohl(lp->lp_marker.mi_rq_xid) + 1);
431 TLV_SET(&mdu->mdu_tlv, MARKER_TYPE_INFO, sizeof(mdu->mdu_info));
432 mdu->mdu_info = lp->lp_marker;
434 LACP_DPRINTF((lp, "marker transmit, port=%u, sys=%6D, id=%u\n",
435 ntohs(mdu->mdu_info.mi_rq_port), mdu->mdu_info.mi_rq_system, ":",
436 ntohl(mdu->mdu_info.mi_rq_xid)));
438 m->m_flags |= M_MCAST;
439 error = lagg_enqueue(lp->lp_ifp, m);
444 lacp_linkstate(struct lagg_port *lgp)
446 struct lacp_port *lp = LACP_PORT(lgp);
447 struct lacp_softc *lsc = lp->lp_lsc;
448 struct ifnet *ifp = lgp->lp_ifp;
449 struct ifmediareq ifmr;
455 bzero((char *)&ifmr, sizeof(ifmr));
456 error = (*ifp->if_ioctl)(ifp, SIOCGIFMEDIA, (caddr_t)&ifmr);
461 media = ifmr.ifm_active;
462 LACP_DPRINTF((lp, "media changed 0x%x -> 0x%x, ether = %d, fdx = %d, "
463 "link = %d\n", lp->lp_media, media, IFM_TYPE(media) == IFM_ETHER,
464 (media & IFM_FDX) != 0, ifp->if_link_state == LINK_STATE_UP));
465 old_state = lp->lp_state;
466 old_key = lp->lp_key;
468 lp->lp_media = media;
470 * If the port is not an active full duplex Ethernet link then it can
473 if (IFM_TYPE(media) != IFM_ETHER || (media & IFM_FDX) == 0 ||
474 ifp->if_link_state != LINK_STATE_UP) {
475 lacp_port_disable(lp);
477 lacp_port_enable(lp);
479 lp->lp_key = lacp_compose_key(lp);
481 if (old_state != lp->lp_state || old_key != lp->lp_key) {
482 LACP_DPRINTF((lp, "-> UNSELECTED\n"));
483 lp->lp_selected = LACP_UNSELECTED;
491 struct lacp_softc *lsc = arg;
492 struct lacp_port *lp;
494 LIST_FOREACH(lp, &lsc->lsc_ports, lp_next) {
495 if ((lp->lp_state & LACP_STATE_AGGREGATION) == 0)
503 lacp_sm_ptx_tx_schedule(lp);
505 callout_reset(&lsc->lsc_callout, hz, lacp_tick, lsc);
509 lacp_port_create(struct lagg_port *lgp)
511 struct lagg_softc *sc = lgp->lp_softc;
512 struct lacp_softc *lsc = LACP_SOFTC(sc);
513 struct lacp_port *lp;
514 struct ifnet *ifp = lgp->lp_ifp;
515 struct sockaddr_dl sdl;
516 struct ifmultiaddr *rifma = NULL;
519 boolean_t active = TRUE; /* XXX should be configurable */
520 boolean_t fast = FALSE; /* XXX should be configurable */
522 bzero((char *)&sdl, sizeof(sdl));
523 sdl.sdl_len = sizeof(sdl);
524 sdl.sdl_family = AF_LINK;
525 sdl.sdl_index = ifp->if_index;
526 sdl.sdl_type = IFT_ETHER;
527 sdl.sdl_alen = ETHER_ADDR_LEN;
529 bcopy(ðermulticastaddr_slowprotocols,
530 LLADDR(&sdl), ETHER_ADDR_LEN);
531 error = if_addmulti(ifp, (struct sockaddr *)&sdl, &rifma);
533 printf("%s: ADDMULTI failed on %s\n", __func__, lgp->lp_ifname);
537 lp = malloc(sizeof(struct lacp_port),
538 M_DEVBUF, M_NOWAIT|M_ZERO);
543 lgp->lp_psc = (caddr_t)lp;
549 LIST_INSERT_HEAD(&lsc->lsc_ports, lp, lp_next);
551 lacp_fill_actorinfo(lp, &lp->lp_actor);
552 lacp_fill_markerinfo(lp, &lp->lp_marker);
554 (active ? LACP_STATE_ACTIVITY : 0) |
555 (fast ? LACP_STATE_TIMEOUT : 0);
556 lp->lp_aggregator = NULL;
557 lacp_sm_rx_set_expired(lp);
565 lacp_port_destroy(struct lagg_port *lgp)
567 struct lacp_port *lp = LACP_PORT(lgp);
568 struct lacp_softc *lsc = lp->lp_lsc;
572 for (i = 0; i < LACP_NTIMER; i++) {
573 LACP_TIMER_DISARM(lp, i);
576 lacp_disable_collecting(lp);
577 lacp_disable_distributing(lp);
580 /* The address may have already been removed by if_purgemaddrs() */
581 if (!lgp->lp_detaching)
582 if_delmulti_ifma(lp->lp_ifma);
584 LIST_REMOVE(lp, lp_next);
590 lacp_req(struct lagg_softc *sc, caddr_t data)
592 struct lacp_opreq *req = (struct lacp_opreq *)data;
593 struct lacp_softc *lsc = LACP_SOFTC(sc);
594 struct lacp_aggregator *la = lsc->lsc_active_aggregator;
597 bzero(req, sizeof(struct lacp_opreq));
599 req->actor_prio = ntohs(la->la_actor.lip_systemid.lsi_prio);
600 memcpy(&req->actor_mac, &la->la_actor.lip_systemid.lsi_mac,
602 req->actor_key = ntohs(la->la_actor.lip_key);
603 req->actor_portprio = ntohs(la->la_actor.lip_portid.lpi_prio);
604 req->actor_portno = ntohs(la->la_actor.lip_portid.lpi_portno);
605 req->actor_state = la->la_actor.lip_state;
607 req->partner_prio = ntohs(la->la_partner.lip_systemid.lsi_prio);
608 memcpy(&req->partner_mac, &la->la_partner.lip_systemid.lsi_mac,
610 req->partner_key = ntohs(la->la_partner.lip_key);
611 req->partner_portprio = ntohs(la->la_partner.lip_portid.lpi_prio);
612 req->partner_portno = ntohs(la->la_partner.lip_portid.lpi_portno);
613 req->partner_state = la->la_partner.lip_state;
619 lacp_portreq(struct lagg_port *lgp, caddr_t data)
621 struct lacp_opreq *req = (struct lacp_opreq *)data;
622 struct lacp_port *lp = LACP_PORT(lgp);
623 struct lacp_softc *lsc = lp->lp_lsc;
626 req->actor_prio = ntohs(lp->lp_actor.lip_systemid.lsi_prio);
627 memcpy(&req->actor_mac, &lp->lp_actor.lip_systemid.lsi_mac,
629 req->actor_key = ntohs(lp->lp_actor.lip_key);
630 req->actor_portprio = ntohs(lp->lp_actor.lip_portid.lpi_prio);
631 req->actor_portno = ntohs(lp->lp_actor.lip_portid.lpi_portno);
632 req->actor_state = lp->lp_actor.lip_state;
634 req->partner_prio = ntohs(lp->lp_partner.lip_systemid.lsi_prio);
635 memcpy(&req->partner_mac, &lp->lp_partner.lip_systemid.lsi_mac,
637 req->partner_key = ntohs(lp->lp_partner.lip_key);
638 req->partner_portprio = ntohs(lp->lp_partner.lip_portid.lpi_prio);
639 req->partner_portno = ntohs(lp->lp_partner.lip_portid.lpi_portno);
640 req->partner_state = lp->lp_partner.lip_state;
645 lacp_disable_collecting(struct lacp_port *lp)
647 LACP_DPRINTF((lp, "collecting disabled\n"));
648 lp->lp_state &= ~LACP_STATE_COLLECTING;
652 lacp_enable_collecting(struct lacp_port *lp)
654 LACP_DPRINTF((lp, "collecting enabled\n"));
655 lp->lp_state |= LACP_STATE_COLLECTING;
659 lacp_disable_distributing(struct lacp_port *lp)
661 struct lacp_aggregator *la = lp->lp_aggregator;
662 struct lacp_softc *lsc = lp->lp_lsc;
663 struct lagg_softc *sc = lsc->lsc_softc;
664 char buf[LACP_LAGIDSTR_MAX+1];
666 LACP_LOCK_ASSERT(lsc);
668 if (la == NULL || (lp->lp_state & LACP_STATE_DISTRIBUTING) == 0) {
672 KASSERT(!TAILQ_EMPTY(&la->la_ports), ("no aggregator ports"));
673 KASSERT(la->la_nports > 0, ("nports invalid (%d)", la->la_nports));
674 KASSERT(la->la_refcnt >= la->la_nports, ("aggregator refcnt invalid"));
676 LACP_DPRINTF((lp, "disable distributing on aggregator %s, "
678 lacp_format_lagid_aggregator(la, buf, sizeof(buf)),
679 la->la_nports, la->la_nports - 1));
681 TAILQ_REMOVE(&la->la_ports, lp, lp_dist_q);
683 sc->sc_active = la->la_nports;
685 if (lsc->lsc_active_aggregator == la) {
686 lacp_suppress_distributing(lsc, la);
687 lacp_select_active_aggregator(lsc);
688 /* regenerate the port map, the active aggregator has changed */
689 lacp_update_portmap(lsc);
692 lp->lp_state &= ~LACP_STATE_DISTRIBUTING;
696 lacp_enable_distributing(struct lacp_port *lp)
698 struct lacp_aggregator *la = lp->lp_aggregator;
699 struct lacp_softc *lsc = lp->lp_lsc;
700 struct lagg_softc *sc = lsc->lsc_softc;
701 char buf[LACP_LAGIDSTR_MAX+1];
703 LACP_LOCK_ASSERT(lsc);
705 if ((lp->lp_state & LACP_STATE_DISTRIBUTING) != 0) {
709 LACP_DPRINTF((lp, "enable distributing on aggregator %s, "
711 lacp_format_lagid_aggregator(la, buf, sizeof(buf)),
712 la->la_nports, la->la_nports + 1));
714 KASSERT(la->la_refcnt > la->la_nports, ("aggregator refcnt invalid"));
715 TAILQ_INSERT_HEAD(&la->la_ports, lp, lp_dist_q);
717 sc->sc_active = la->la_nports;
719 lp->lp_state |= LACP_STATE_DISTRIBUTING;
721 if (lsc->lsc_active_aggregator == la) {
722 lacp_suppress_distributing(lsc, la);
723 lacp_update_portmap(lsc);
725 /* try to become the active aggregator */
726 lacp_select_active_aggregator(lsc);
730 lacp_transit_expire(void *vp)
732 struct lacp_softc *lsc = vp;
734 LACP_LOCK_ASSERT(lsc);
738 lsc->lsc_suppress_distributing = FALSE;
742 lacp_attach_sysctl(struct lacp_softc *lsc, struct sysctl_oid *p_oid)
744 struct lagg_softc *sc = lsc->lsc_softc;
746 SYSCTL_ADD_UINT(&sc->ctx, SYSCTL_CHILDREN(p_oid), OID_AUTO,
749 &lsc->lsc_strict_mode,
750 lsc->lsc_strict_mode,
751 "Enable LACP strict mode");
755 lacp_attach_sysctl_debug(struct lacp_softc *lsc, struct sysctl_oid *p_oid)
757 struct lagg_softc *sc = lsc->lsc_softc;
758 struct sysctl_oid *oid;
760 /* Create a child of the parent lagg interface */
761 oid = SYSCTL_ADD_NODE(&sc->ctx, SYSCTL_CHILDREN(p_oid),
762 OID_AUTO, "debug", CTLFLAG_RD, NULL, "DEBUG");
764 SYSCTL_ADD_UINT(&sc->ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
767 &lsc->lsc_debug.lsc_rx_test,
768 lsc->lsc_debug.lsc_rx_test,
769 "Bitmap of if_dunit entries to drop RX frames for");
770 SYSCTL_ADD_UINT(&sc->ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
773 &lsc->lsc_debug.lsc_tx_test,
774 lsc->lsc_debug.lsc_tx_test,
775 "Bitmap of if_dunit entries to drop TX frames for");
779 lacp_attach(struct lagg_softc *sc)
781 struct lacp_softc *lsc;
782 struct sysctl_oid *oid;
784 lsc = malloc(sizeof(struct lacp_softc),
785 M_DEVBUF, M_NOWAIT|M_ZERO);
789 sc->sc_psc = (caddr_t)lsc;
792 lsc->lsc_hashkey = arc4random();
793 lsc->lsc_active_aggregator = NULL;
794 lsc->lsc_strict_mode = 1;
796 TAILQ_INIT(&lsc->lsc_aggregators);
797 LIST_INIT(&lsc->lsc_ports);
799 /* Create a child of the parent lagg interface */
800 oid = SYSCTL_ADD_NODE(&sc->ctx, SYSCTL_CHILDREN(sc->sc_oid),
801 OID_AUTO, "lacp", CTLFLAG_RD, NULL, "LACP");
803 /* Attach sysctl nodes */
804 lacp_attach_sysctl(lsc, oid);
805 lacp_attach_sysctl_debug(lsc, oid);
807 callout_init_mtx(&lsc->lsc_transit_callout, &lsc->lsc_mtx, 0);
808 callout_init_mtx(&lsc->lsc_callout, &lsc->lsc_mtx, 0);
810 /* if the lagg is already up then do the same */
811 if (sc->sc_ifp->if_drv_flags & IFF_DRV_RUNNING)
818 lacp_detach(struct lagg_softc *sc)
820 struct lacp_softc *lsc = LACP_SOFTC(sc);
822 KASSERT(TAILQ_EMPTY(&lsc->lsc_aggregators),
823 ("aggregators still active"));
824 KASSERT(lsc->lsc_active_aggregator == NULL,
825 ("aggregator still attached"));
828 callout_drain(&lsc->lsc_transit_callout);
829 callout_drain(&lsc->lsc_callout);
831 LACP_LOCK_DESTROY(lsc);
837 lacp_init(struct lagg_softc *sc)
839 struct lacp_softc *lsc = LACP_SOFTC(sc);
842 callout_reset(&lsc->lsc_callout, hz, lacp_tick, lsc);
847 lacp_stop(struct lagg_softc *sc)
849 struct lacp_softc *lsc = LACP_SOFTC(sc);
852 callout_stop(&lsc->lsc_transit_callout);
853 callout_stop(&lsc->lsc_callout);
858 lacp_select_tx_port(struct lagg_softc *sc, struct mbuf *m)
860 struct lacp_softc *lsc = LACP_SOFTC(sc);
861 struct lacp_portmap *pm;
862 struct lacp_port *lp;
865 if (__predict_false(lsc->lsc_suppress_distributing)) {
866 LACP_DPRINTF((NULL, "%s: waiting transit\n", __func__));
870 pm = &lsc->lsc_pmap[lsc->lsc_activemap];
871 if (pm->pm_count == 0) {
872 LACP_DPRINTF((NULL, "%s: no active aggregator\n", __func__));
876 if (sc->use_flowid && (m->m_flags & M_FLOWID))
877 hash = m->m_pkthdr.flowid >> sc->flowid_shift;
879 hash = lagg_hashmbuf(sc, m, lsc->lsc_hashkey);
880 hash %= pm->pm_count;
881 lp = pm->pm_map[hash];
883 KASSERT((lp->lp_state & LACP_STATE_DISTRIBUTING) != 0,
884 ("aggregated port is not distributing"));
886 return (lp->lp_lagg);
889 * lacp_suppress_distributing: drop transmit packets for a while
890 * to preserve packet ordering.
894 lacp_suppress_distributing(struct lacp_softc *lsc, struct lacp_aggregator *la)
896 struct lacp_port *lp;
898 if (lsc->lsc_active_aggregator != la) {
904 lsc->lsc_suppress_distributing = TRUE;
906 /* send a marker frame down each port to verify the queues are empty */
907 LIST_FOREACH(lp, &lsc->lsc_ports, lp_next) {
908 lp->lp_flags |= LACP_PORT_MARK;
909 lacp_xmit_marker(lp);
912 /* set a timeout for the marker frames */
913 callout_reset(&lsc->lsc_transit_callout,
914 LACP_TRANSIT_DELAY * hz / 1000, lacp_transit_expire, lsc);
918 lacp_compare_peerinfo(const struct lacp_peerinfo *a,
919 const struct lacp_peerinfo *b)
921 return (memcmp(a, b, offsetof(struct lacp_peerinfo, lip_state)));
925 lacp_compare_systemid(const struct lacp_systemid *a,
926 const struct lacp_systemid *b)
928 return (memcmp(a, b, sizeof(*a)));
933 lacp_compare_portid(const struct lacp_portid *a,
934 const struct lacp_portid *b)
936 return (memcmp(a, b, sizeof(*a)));
941 lacp_aggregator_bandwidth(struct lacp_aggregator *la)
943 struct lacp_port *lp;
946 lp = TAILQ_FIRST(&la->la_ports);
951 speed = ifmedia_baudrate(lp->lp_media);
952 speed *= la->la_nports;
954 LACP_DPRINTF((lp, "speed 0? media=0x%x nports=%d\n",
955 lp->lp_media, la->la_nports));
962 * lacp_select_active_aggregator: select an aggregator to be used to transmit
963 * packets from lagg(4) interface.
967 lacp_select_active_aggregator(struct lacp_softc *lsc)
969 struct lacp_aggregator *la;
970 struct lacp_aggregator *best_la = NULL;
971 uint64_t best_speed = 0;
972 char buf[LACP_LAGIDSTR_MAX+1];
976 TAILQ_FOREACH(la, &lsc->lsc_aggregators, la_q) {
979 if (la->la_nports == 0) {
983 speed = lacp_aggregator_bandwidth(la);
984 LACP_DPRINTF((NULL, "%s, speed=%jd, nports=%d\n",
985 lacp_format_lagid_aggregator(la, buf, sizeof(buf)),
986 speed, la->la_nports));
988 /* This aggregator is chosen if
989 * the partner has a better system priority
990 * or, the total aggregated speed is higher
991 * or, it is already the chosen aggregator
993 if ((best_la != NULL && LACP_SYS_PRI(la->la_partner) <
994 LACP_SYS_PRI(best_la->la_partner)) ||
995 speed > best_speed ||
996 (speed == best_speed &&
997 la == lsc->lsc_active_aggregator)) {
1003 KASSERT(best_la == NULL || best_la->la_nports > 0,
1004 ("invalid aggregator refcnt"));
1005 KASSERT(best_la == NULL || !TAILQ_EMPTY(&best_la->la_ports),
1006 ("invalid aggregator list"));
1008 if (lsc->lsc_active_aggregator != best_la) {
1009 LACP_DPRINTF((NULL, "active aggregator changed\n"));
1010 LACP_DPRINTF((NULL, "old %s\n",
1011 lacp_format_lagid_aggregator(lsc->lsc_active_aggregator,
1012 buf, sizeof(buf))));
1014 LACP_DPRINTF((NULL, "active aggregator not changed\n"));
1016 LACP_DPRINTF((NULL, "new %s\n",
1017 lacp_format_lagid_aggregator(best_la, buf, sizeof(buf))));
1019 if (lsc->lsc_active_aggregator != best_la) {
1020 lsc->lsc_active_aggregator = best_la;
1021 lacp_update_portmap(lsc);
1023 lacp_suppress_distributing(lsc, best_la);
1029 * Updated the inactive portmap array with the new list of ports and
1033 lacp_update_portmap(struct lacp_softc *lsc)
1035 struct lagg_softc *sc = lsc->lsc_softc;
1036 struct lacp_aggregator *la;
1037 struct lacp_portmap *p;
1038 struct lacp_port *lp;
1043 newmap = lsc->lsc_activemap == 0 ? 1 : 0;
1044 p = &lsc->lsc_pmap[newmap];
1045 la = lsc->lsc_active_aggregator;
1047 bzero(p, sizeof(struct lacp_portmap));
1049 if (la != NULL && la->la_nports > 0) {
1050 p->pm_count = la->la_nports;
1052 TAILQ_FOREACH(lp, &la->la_ports, lp_dist_q)
1053 p->pm_map[i++] = lp;
1054 KASSERT(i == p->pm_count, ("Invalid port count"));
1055 speed = lacp_aggregator_bandwidth(la);
1057 sc->sc_ifp->if_baudrate = speed;
1059 /* switch the active portmap over */
1060 atomic_store_rel_int(&lsc->lsc_activemap, newmap);
1061 LACP_DPRINTF((NULL, "Set table %d with %d ports\n",
1063 lsc->lsc_pmap[lsc->lsc_activemap].pm_count));
1067 lacp_compose_key(struct lacp_port *lp)
1069 struct lagg_port *lgp = lp->lp_lagg;
1070 struct lagg_softc *sc = lgp->lp_softc;
1071 u_int media = lp->lp_media;
1074 if ((lp->lp_state & LACP_STATE_AGGREGATION) == 0) {
1077 * non-aggregatable links should have unique keys.
1079 * XXX this isn't really unique as if_index is 16 bit.
1082 /* bit 0..14: (some bits of) if_index of this port */
1083 key = lp->lp_ifp->if_index;
1087 u_int subtype = IFM_SUBTYPE(media);
1089 KASSERT(IFM_TYPE(media) == IFM_ETHER, ("invalid media type"));
1090 KASSERT((media & IFM_FDX) != 0, ("aggregating HDX interface"));
1092 /* bit 0..4: IFM_SUBTYPE modulo speed */
1117 case IFM_10G_TWINAX:
1118 case IFM_10G_TWINAX_LONG:
1131 /* bit 5..14: (some bits of) if_index of lagg device */
1132 key |= 0x7fe0 & ((sc->sc_ifp->if_index) << 5);
1135 return (htons(key));
1139 lacp_aggregator_addref(struct lacp_softc *lsc, struct lacp_aggregator *la)
1141 char buf[LACP_LAGIDSTR_MAX+1];
1143 LACP_DPRINTF((NULL, "%s: lagid=%s, refcnt %d -> %d\n",
1145 lacp_format_lagid(&la->la_actor, &la->la_partner,
1147 la->la_refcnt, la->la_refcnt + 1));
1149 KASSERT(la->la_refcnt > 0, ("refcount <= 0"));
1151 KASSERT(la->la_refcnt > la->la_nports, ("invalid refcount"));
1155 lacp_aggregator_delref(struct lacp_softc *lsc, struct lacp_aggregator *la)
1157 char buf[LACP_LAGIDSTR_MAX+1];
1159 LACP_DPRINTF((NULL, "%s: lagid=%s, refcnt %d -> %d\n",
1161 lacp_format_lagid(&la->la_actor, &la->la_partner,
1163 la->la_refcnt, la->la_refcnt - 1));
1165 KASSERT(la->la_refcnt > la->la_nports, ("invalid refcnt"));
1167 if (la->la_refcnt > 0) {
1171 KASSERT(la->la_refcnt == 0, ("refcount not zero"));
1172 KASSERT(lsc->lsc_active_aggregator != la, ("aggregator active"));
1174 TAILQ_REMOVE(&lsc->lsc_aggregators, la, la_q);
1180 * lacp_aggregator_get: allocate an aggregator.
1183 static struct lacp_aggregator *
1184 lacp_aggregator_get(struct lacp_softc *lsc, struct lacp_port *lp)
1186 struct lacp_aggregator *la;
1188 la = malloc(sizeof(*la), M_DEVBUF, M_NOWAIT);
1192 TAILQ_INIT(&la->la_ports);
1194 TAILQ_INSERT_TAIL(&lsc->lsc_aggregators, la, la_q);
1201 * lacp_fill_aggregator_id: setup a newly allocated aggregator from a port.
1205 lacp_fill_aggregator_id(struct lacp_aggregator *la, const struct lacp_port *lp)
1207 lacp_fill_aggregator_id_peer(&la->la_partner, &lp->lp_partner);
1208 lacp_fill_aggregator_id_peer(&la->la_actor, &lp->lp_actor);
1210 la->la_actor.lip_state = lp->lp_state & LACP_STATE_AGGREGATION;
1214 lacp_fill_aggregator_id_peer(struct lacp_peerinfo *lpi_aggr,
1215 const struct lacp_peerinfo *lpi_port)
1217 memset(lpi_aggr, 0, sizeof(*lpi_aggr));
1218 lpi_aggr->lip_systemid = lpi_port->lip_systemid;
1219 lpi_aggr->lip_key = lpi_port->lip_key;
1223 * lacp_aggregator_is_compatible: check if a port can join to an aggregator.
1227 lacp_aggregator_is_compatible(const struct lacp_aggregator *la,
1228 const struct lacp_port *lp)
1230 if (!(lp->lp_state & LACP_STATE_AGGREGATION) ||
1231 !(lp->lp_partner.lip_state & LACP_STATE_AGGREGATION)) {
1235 if (!(la->la_actor.lip_state & LACP_STATE_AGGREGATION)) {
1239 if (!lacp_peerinfo_is_compatible(&la->la_partner, &lp->lp_partner)) {
1243 if (!lacp_peerinfo_is_compatible(&la->la_actor, &lp->lp_actor)) {
1251 lacp_peerinfo_is_compatible(const struct lacp_peerinfo *a,
1252 const struct lacp_peerinfo *b)
1254 if (memcmp(&a->lip_systemid, &b->lip_systemid,
1255 sizeof(a->lip_systemid))) {
1259 if (memcmp(&a->lip_key, &b->lip_key, sizeof(a->lip_key))) {
1267 lacp_port_enable(struct lacp_port *lp)
1269 lp->lp_state |= LACP_STATE_AGGREGATION;
1273 lacp_port_disable(struct lacp_port *lp)
1275 lacp_set_mux(lp, LACP_MUX_DETACHED);
1277 lp->lp_state &= ~LACP_STATE_AGGREGATION;
1278 lp->lp_selected = LACP_UNSELECTED;
1279 lacp_sm_rx_record_default(lp);
1280 lp->lp_partner.lip_state &= ~LACP_STATE_AGGREGATION;
1281 lp->lp_state &= ~LACP_STATE_EXPIRED;
1285 * lacp_select: select an aggregator. create one if necessary.
1288 lacp_select(struct lacp_port *lp)
1290 struct lacp_softc *lsc = lp->lp_lsc;
1291 struct lacp_aggregator *la;
1292 char buf[LACP_LAGIDSTR_MAX+1];
1294 if (lp->lp_aggregator) {
1298 KASSERT(!LACP_TIMER_ISARMED(lp, LACP_TIMER_WAIT_WHILE),
1299 ("timer_wait_while still active"));
1301 LACP_DPRINTF((lp, "port lagid=%s\n",
1302 lacp_format_lagid(&lp->lp_actor, &lp->lp_partner,
1303 buf, sizeof(buf))));
1305 TAILQ_FOREACH(la, &lsc->lsc_aggregators, la_q) {
1306 if (lacp_aggregator_is_compatible(la, lp)) {
1312 la = lacp_aggregator_get(lsc, lp);
1314 LACP_DPRINTF((lp, "aggregator creation failed\n"));
1317 * will retry on the next tick.
1322 lacp_fill_aggregator_id(la, lp);
1323 LACP_DPRINTF((lp, "aggregator created\n"));
1325 LACP_DPRINTF((lp, "compatible aggregator found\n"));
1326 if (la->la_refcnt == LACP_MAX_PORTS)
1328 lacp_aggregator_addref(lsc, la);
1331 LACP_DPRINTF((lp, "aggregator lagid=%s\n",
1332 lacp_format_lagid(&la->la_actor, &la->la_partner,
1333 buf, sizeof(buf))));
1335 lp->lp_aggregator = la;
1336 lp->lp_selected = LACP_SELECTED;
1340 * lacp_unselect: finish unselect/detach process.
1344 lacp_unselect(struct lacp_port *lp)
1346 struct lacp_softc *lsc = lp->lp_lsc;
1347 struct lacp_aggregator *la = lp->lp_aggregator;
1349 KASSERT(!LACP_TIMER_ISARMED(lp, LACP_TIMER_WAIT_WHILE),
1350 ("timer_wait_while still active"));
1356 lp->lp_aggregator = NULL;
1357 lacp_aggregator_delref(lsc, la);
1363 lacp_sm_mux(struct lacp_port *lp)
1365 struct lagg_port *lgp = lp->lp_lagg;
1366 struct lagg_softc *sc = lgp->lp_softc;
1367 enum lacp_mux_state new_state;
1369 (lp->lp_partner.lip_state & LACP_STATE_SYNC) != 0;
1370 boolean_t p_collecting =
1371 (lp->lp_partner.lip_state & LACP_STATE_COLLECTING) != 0;
1372 enum lacp_selected selected = lp->lp_selected;
1373 struct lacp_aggregator *la;
1376 lacp_dprintf(lp, "%s: state= 0x%x, selected= 0x%x, "
1377 "p_sync= 0x%x, p_collecting= 0x%x\n", __func__,
1378 lp->lp_mux_state, selected, p_sync, p_collecting);
1381 la = lp->lp_aggregator;
1382 KASSERT(lp->lp_mux_state == LACP_MUX_DETACHED || la != NULL,
1383 ("MUX not detached"));
1384 new_state = lp->lp_mux_state;
1385 switch (lp->lp_mux_state) {
1386 case LACP_MUX_DETACHED:
1387 if (selected != LACP_UNSELECTED) {
1388 new_state = LACP_MUX_WAITING;
1391 case LACP_MUX_WAITING:
1392 KASSERT(la->la_pending > 0 ||
1393 !LACP_TIMER_ISARMED(lp, LACP_TIMER_WAIT_WHILE),
1394 ("timer_wait_while still active"));
1395 if (selected == LACP_SELECTED && la->la_pending == 0) {
1396 new_state = LACP_MUX_ATTACHED;
1397 } else if (selected == LACP_UNSELECTED) {
1398 new_state = LACP_MUX_DETACHED;
1401 case LACP_MUX_ATTACHED:
1402 if (selected == LACP_SELECTED && p_sync) {
1403 new_state = LACP_MUX_COLLECTING;
1404 } else if (selected != LACP_SELECTED) {
1405 new_state = LACP_MUX_DETACHED;
1408 case LACP_MUX_COLLECTING:
1409 if (selected == LACP_SELECTED && p_sync && p_collecting) {
1410 new_state = LACP_MUX_DISTRIBUTING;
1411 } else if (selected != LACP_SELECTED || !p_sync) {
1412 new_state = LACP_MUX_ATTACHED;
1415 case LACP_MUX_DISTRIBUTING:
1416 if (selected != LACP_SELECTED || !p_sync || !p_collecting) {
1417 new_state = LACP_MUX_COLLECTING;
1418 lacp_dprintf(lp, "Interface stopped DISTRIBUTING, possible flapping\n");
1423 panic("%s: unknown state", __func__);
1426 if (lp->lp_mux_state == new_state) {
1430 lacp_set_mux(lp, new_state);
1435 lacp_set_mux(struct lacp_port *lp, enum lacp_mux_state new_state)
1437 struct lacp_aggregator *la = lp->lp_aggregator;
1439 if (lp->lp_mux_state == new_state) {
1443 switch (new_state) {
1444 case LACP_MUX_DETACHED:
1445 lp->lp_state &= ~LACP_STATE_SYNC;
1446 lacp_disable_distributing(lp);
1447 lacp_disable_collecting(lp);
1448 lacp_sm_assert_ntt(lp);
1450 if (LACP_TIMER_ISARMED(lp, LACP_TIMER_WAIT_WHILE)) {
1451 KASSERT(la->la_pending > 0,
1452 ("timer_wait_while not active"));
1455 LACP_TIMER_DISARM(lp, LACP_TIMER_WAIT_WHILE);
1458 case LACP_MUX_WAITING:
1459 LACP_TIMER_ARM(lp, LACP_TIMER_WAIT_WHILE,
1460 LACP_AGGREGATE_WAIT_TIME);
1463 case LACP_MUX_ATTACHED:
1464 lp->lp_state |= LACP_STATE_SYNC;
1465 lacp_disable_collecting(lp);
1466 lacp_sm_assert_ntt(lp);
1468 case LACP_MUX_COLLECTING:
1469 lacp_enable_collecting(lp);
1470 lacp_disable_distributing(lp);
1471 lacp_sm_assert_ntt(lp);
1473 case LACP_MUX_DISTRIBUTING:
1474 lacp_enable_distributing(lp);
1477 panic("%s: unknown state", __func__);
1480 LACP_DPRINTF((lp, "mux_state %d -> %d\n", lp->lp_mux_state, new_state));
1482 lp->lp_mux_state = new_state;
1486 lacp_sm_mux_timer(struct lacp_port *lp)
1488 struct lacp_aggregator *la = lp->lp_aggregator;
1489 char buf[LACP_LAGIDSTR_MAX+1];
1491 KASSERT(la->la_pending > 0, ("no pending event"));
1493 LACP_DPRINTF((lp, "%s: aggregator %s, pending %d -> %d\n", __func__,
1494 lacp_format_lagid(&la->la_actor, &la->la_partner,
1496 la->la_pending, la->la_pending - 1));
1501 /* periodic transmit machine */
1504 lacp_sm_ptx_update_timeout(struct lacp_port *lp, uint8_t oldpstate)
1506 if (LACP_STATE_EQ(oldpstate, lp->lp_partner.lip_state,
1507 LACP_STATE_TIMEOUT)) {
1511 LACP_DPRINTF((lp, "partner timeout changed\n"));
1514 * FAST_PERIODIC -> SLOW_PERIODIC
1516 * SLOW_PERIODIC (-> PERIODIC_TX) -> FAST_PERIODIC
1518 * let lacp_sm_ptx_tx_schedule to update timeout.
1521 LACP_TIMER_DISARM(lp, LACP_TIMER_PERIODIC);
1524 * if timeout has been shortened, assert NTT.
1527 if ((lp->lp_partner.lip_state & LACP_STATE_TIMEOUT)) {
1528 lacp_sm_assert_ntt(lp);
1533 lacp_sm_ptx_tx_schedule(struct lacp_port *lp)
1537 if (!(lp->lp_state & LACP_STATE_ACTIVITY) &&
1538 !(lp->lp_partner.lip_state & LACP_STATE_ACTIVITY)) {
1544 LACP_TIMER_DISARM(lp, LACP_TIMER_PERIODIC);
1548 if (LACP_TIMER_ISARMED(lp, LACP_TIMER_PERIODIC)) {
1552 timeout = (lp->lp_partner.lip_state & LACP_STATE_TIMEOUT) ?
1553 LACP_FAST_PERIODIC_TIME : LACP_SLOW_PERIODIC_TIME;
1555 LACP_TIMER_ARM(lp, LACP_TIMER_PERIODIC, timeout);
1559 lacp_sm_ptx_timer(struct lacp_port *lp)
1561 lacp_sm_assert_ntt(lp);
1565 lacp_sm_rx(struct lacp_port *lp, const struct lacpdu *du)
1570 * check LACP_DISABLED first
1573 if (!(lp->lp_state & LACP_STATE_AGGREGATION)) {
1578 * check loopback condition.
1581 if (!lacp_compare_systemid(&du->ldu_actor.lip_systemid,
1582 &lp->lp_actor.lip_systemid)) {
1587 * EXPIRED, DEFAULTED, CURRENT -> CURRENT
1590 lacp_sm_rx_update_selected(lp, du);
1591 lacp_sm_rx_update_ntt(lp, du);
1592 lacp_sm_rx_record_pdu(lp, du);
1594 timeout = (lp->lp_state & LACP_STATE_TIMEOUT) ?
1595 LACP_SHORT_TIMEOUT_TIME : LACP_LONG_TIMEOUT_TIME;
1596 LACP_TIMER_ARM(lp, LACP_TIMER_CURRENT_WHILE, timeout);
1598 lp->lp_state &= ~LACP_STATE_EXPIRED;
1601 * kick transmit machine without waiting the next tick.
1608 lacp_sm_rx_set_expired(struct lacp_port *lp)
1610 lp->lp_partner.lip_state &= ~LACP_STATE_SYNC;
1611 lp->lp_partner.lip_state |= LACP_STATE_TIMEOUT;
1612 LACP_TIMER_ARM(lp, LACP_TIMER_CURRENT_WHILE, LACP_SHORT_TIMEOUT_TIME);
1613 lp->lp_state |= LACP_STATE_EXPIRED;
1617 lacp_sm_rx_timer(struct lacp_port *lp)
1619 if ((lp->lp_state & LACP_STATE_EXPIRED) == 0) {
1620 /* CURRENT -> EXPIRED */
1621 LACP_DPRINTF((lp, "%s: CURRENT -> EXPIRED\n", __func__));
1622 lacp_sm_rx_set_expired(lp);
1624 /* EXPIRED -> DEFAULTED */
1625 LACP_DPRINTF((lp, "%s: EXPIRED -> DEFAULTED\n", __func__));
1626 lacp_sm_rx_update_default_selected(lp);
1627 lacp_sm_rx_record_default(lp);
1628 lp->lp_state &= ~LACP_STATE_EXPIRED;
1633 lacp_sm_rx_record_pdu(struct lacp_port *lp, const struct lacpdu *du)
1637 char buf[LACP_STATESTR_MAX+1];
1641 oldpstate = lp->lp_partner.lip_state;
1643 active = (du->ldu_actor.lip_state & LACP_STATE_ACTIVITY)
1644 || ((lp->lp_state & LACP_STATE_ACTIVITY) &&
1645 (du->ldu_partner.lip_state & LACP_STATE_ACTIVITY));
1647 lp->lp_partner = du->ldu_actor;
1649 ((LACP_STATE_EQ(lp->lp_state, du->ldu_partner.lip_state,
1650 LACP_STATE_AGGREGATION) &&
1651 !lacp_compare_peerinfo(&lp->lp_actor, &du->ldu_partner))
1652 || (du->ldu_partner.lip_state & LACP_STATE_AGGREGATION) == 0)) {
1655 lp->lp_partner.lip_state &= ~LACP_STATE_SYNC;
1658 lp->lp_state &= ~LACP_STATE_DEFAULTED;
1660 if (oldpstate != lp->lp_partner.lip_state) {
1661 LACP_DPRINTF((lp, "old pstate %s\n",
1662 lacp_format_state(oldpstate, buf, sizeof(buf))));
1663 LACP_DPRINTF((lp, "new pstate %s\n",
1664 lacp_format_state(lp->lp_partner.lip_state, buf,
1668 /* XXX Hack, still need to implement 5.4.9 para 2,3,4 */
1669 if (lp->lp_lsc->lsc_strict_mode)
1670 lp->lp_partner.lip_state |= LACP_STATE_SYNC;
1672 lacp_sm_ptx_update_timeout(lp, oldpstate);
1676 lacp_sm_rx_update_ntt(struct lacp_port *lp, const struct lacpdu *du)
1681 if (lacp_compare_peerinfo(&lp->lp_actor, &du->ldu_partner) ||
1682 !LACP_STATE_EQ(lp->lp_state, du->ldu_partner.lip_state,
1683 LACP_STATE_ACTIVITY | LACP_STATE_SYNC | LACP_STATE_AGGREGATION)) {
1684 LACP_DPRINTF((lp, "%s: assert ntt\n", __func__));
1685 lacp_sm_assert_ntt(lp);
1690 lacp_sm_rx_record_default(struct lacp_port *lp)
1696 oldpstate = lp->lp_partner.lip_state;
1697 if (lp->lp_lsc->lsc_strict_mode)
1698 lp->lp_partner = lacp_partner_admin_strict;
1700 lp->lp_partner = lacp_partner_admin_optimistic;;
1701 lp->lp_state |= LACP_STATE_DEFAULTED;
1702 lacp_sm_ptx_update_timeout(lp, oldpstate);
1706 lacp_sm_rx_update_selected_from_peerinfo(struct lacp_port *lp,
1707 const struct lacp_peerinfo *info)
1712 if (lacp_compare_peerinfo(&lp->lp_partner, info) ||
1713 !LACP_STATE_EQ(lp->lp_partner.lip_state, info->lip_state,
1714 LACP_STATE_AGGREGATION)) {
1715 lp->lp_selected = LACP_UNSELECTED;
1716 /* mux machine will clean up lp->lp_aggregator */
1721 lacp_sm_rx_update_selected(struct lacp_port *lp, const struct lacpdu *du)
1726 lacp_sm_rx_update_selected_from_peerinfo(lp, &du->ldu_actor);
1730 lacp_sm_rx_update_default_selected(struct lacp_port *lp)
1735 if (lp->lp_lsc->lsc_strict_mode)
1736 lacp_sm_rx_update_selected_from_peerinfo(lp,
1737 &lacp_partner_admin_strict);
1739 lacp_sm_rx_update_selected_from_peerinfo(lp,
1740 &lacp_partner_admin_optimistic);
1743 /* transmit machine */
1746 lacp_sm_tx(struct lacp_port *lp)
1750 if (!(lp->lp_state & LACP_STATE_AGGREGATION)
1752 || (!(lp->lp_state & LACP_STATE_ACTIVITY)
1753 && !(lp->lp_partner.lip_state & LACP_STATE_ACTIVITY))
1756 lp->lp_flags &= ~LACP_PORT_NTT;
1759 if (!(lp->lp_flags & LACP_PORT_NTT)) {
1763 /* Rate limit to 3 PDUs per LACP_FAST_PERIODIC_TIME */
1764 if (ppsratecheck(&lp->lp_last_lacpdu, &lp->lp_lacpdu_sent,
1765 (3 / LACP_FAST_PERIODIC_TIME)) == 0) {
1766 LACP_DPRINTF((lp, "rate limited pdu\n"));
1770 if (((1 << lp->lp_ifp->if_dunit) & lp->lp_lsc->lsc_debug.lsc_tx_test) == 0) {
1771 error = lacp_xmit_lacpdu(lp);
1773 LACP_TPRINTF((lp, "Dropping TX PDU\n"));
1777 lp->lp_flags &= ~LACP_PORT_NTT;
1779 LACP_DPRINTF((lp, "lacpdu transmit failure, error %d\n",
1785 lacp_sm_assert_ntt(struct lacp_port *lp)
1788 lp->lp_flags |= LACP_PORT_NTT;
1792 lacp_run_timers(struct lacp_port *lp)
1796 for (i = 0; i < LACP_NTIMER; i++) {
1797 KASSERT(lp->lp_timer[i] >= 0,
1798 ("invalid timer value %d", lp->lp_timer[i]));
1799 if (lp->lp_timer[i] == 0) {
1801 } else if (--lp->lp_timer[i] <= 0) {
1802 if (lacp_timer_funcs[i]) {
1803 (*lacp_timer_funcs[i])(lp);
1810 lacp_marker_input(struct lacp_port *lp, struct mbuf *m)
1812 struct lacp_softc *lsc = lp->lp_lsc;
1813 struct lagg_port *lgp = lp->lp_lagg;
1814 struct lacp_port *lp2;
1815 struct markerdu *mdu;
1819 if (m->m_pkthdr.len != sizeof(*mdu)) {
1823 if ((m->m_flags & M_MCAST) == 0) {
1827 if (m->m_len < sizeof(*mdu)) {
1828 m = m_pullup(m, sizeof(*mdu));
1834 mdu = mtod(m, struct markerdu *);
1836 if (memcmp(&mdu->mdu_eh.ether_dhost,
1837 ðermulticastaddr_slowprotocols, ETHER_ADDR_LEN)) {
1841 if (mdu->mdu_sph.sph_version != 1) {
1845 switch (mdu->mdu_tlv.tlv_type) {
1846 case MARKER_TYPE_INFO:
1847 if (tlv_check(mdu, sizeof(*mdu), &mdu->mdu_tlv,
1848 marker_info_tlv_template, TRUE)) {
1851 mdu->mdu_tlv.tlv_type = MARKER_TYPE_RESPONSE;
1852 memcpy(&mdu->mdu_eh.ether_dhost,
1853 ðermulticastaddr_slowprotocols, ETHER_ADDR_LEN);
1854 memcpy(&mdu->mdu_eh.ether_shost,
1855 lgp->lp_lladdr, ETHER_ADDR_LEN);
1856 error = lagg_enqueue(lp->lp_ifp, m);
1859 case MARKER_TYPE_RESPONSE:
1860 if (tlv_check(mdu, sizeof(*mdu), &mdu->mdu_tlv,
1861 marker_response_tlv_template, TRUE)) {
1864 LACP_DPRINTF((lp, "marker response, port=%u, sys=%6D, id=%u\n",
1865 ntohs(mdu->mdu_info.mi_rq_port), mdu->mdu_info.mi_rq_system,
1866 ":", ntohl(mdu->mdu_info.mi_rq_xid)));
1868 /* Verify that it is the last marker we sent out */
1869 if (memcmp(&mdu->mdu_info, &lp->lp_marker,
1870 sizeof(struct lacp_markerinfo)))
1874 lp->lp_flags &= ~LACP_PORT_MARK;
1876 if (lsc->lsc_suppress_distributing) {
1877 /* Check if any ports are waiting for a response */
1878 LIST_FOREACH(lp2, &lsc->lsc_ports, lp_next) {
1879 if (lp2->lp_flags & LACP_PORT_MARK) {
1886 /* All interface queues are clear */
1887 LACP_DPRINTF((NULL, "queue flush complete\n"));
1888 lsc->lsc_suppress_distributing = FALSE;
1902 LACP_DPRINTF((lp, "bad marker frame\n"));
1908 tlv_check(const void *p, size_t size, const struct tlvhdr *tlv,
1909 const struct tlv_template *tmpl, boolean_t check_type)
1911 while (/* CONSTCOND */ 1) {
1912 if ((const char *)tlv - (const char *)p + sizeof(*tlv) > size) {
1915 if ((check_type && tlv->tlv_type != tmpl->tmpl_type) ||
1916 tlv->tlv_length != tmpl->tmpl_length) {
1919 if (tmpl->tmpl_type == 0) {
1922 tlv = (const struct tlvhdr *)
1923 ((const char *)tlv + tlv->tlv_length);
1932 lacp_format_mac(const uint8_t *mac, char *buf, size_t buflen)
1934 snprintf(buf, buflen, "%02X-%02X-%02X-%02X-%02X-%02X",
1946 lacp_format_systemid(const struct lacp_systemid *sysid,
1947 char *buf, size_t buflen)
1949 char macbuf[LACP_MACSTR_MAX+1];
1951 snprintf(buf, buflen, "%04X,%s",
1952 ntohs(sysid->lsi_prio),
1953 lacp_format_mac(sysid->lsi_mac, macbuf, sizeof(macbuf)));
1959 lacp_format_portid(const struct lacp_portid *portid, char *buf, size_t buflen)
1961 snprintf(buf, buflen, "%04X,%04X",
1962 ntohs(portid->lpi_prio),
1963 ntohs(portid->lpi_portno));
1969 lacp_format_partner(const struct lacp_peerinfo *peer, char *buf, size_t buflen)
1971 char sysid[LACP_SYSTEMIDSTR_MAX+1];
1972 char portid[LACP_PORTIDSTR_MAX+1];
1974 snprintf(buf, buflen, "(%s,%04X,%s)",
1975 lacp_format_systemid(&peer->lip_systemid, sysid, sizeof(sysid)),
1976 ntohs(peer->lip_key),
1977 lacp_format_portid(&peer->lip_portid, portid, sizeof(portid)));
1983 lacp_format_lagid(const struct lacp_peerinfo *a,
1984 const struct lacp_peerinfo *b, char *buf, size_t buflen)
1986 char astr[LACP_PARTNERSTR_MAX+1];
1987 char bstr[LACP_PARTNERSTR_MAX+1];
1991 * there's a convention to display small numbered peer
1995 if (lacp_compare_peerinfo(a, b) > 0) {
1996 const struct lacp_peerinfo *t;
2004 snprintf(buf, buflen, "[%s,%s]",
2005 lacp_format_partner(a, astr, sizeof(astr)),
2006 lacp_format_partner(b, bstr, sizeof(bstr)));
2012 lacp_format_lagid_aggregator(const struct lacp_aggregator *la,
2013 char *buf, size_t buflen)
2019 return (lacp_format_lagid(&la->la_actor, &la->la_partner, buf, buflen));
2023 lacp_format_state(uint8_t state, char *buf, size_t buflen)
2025 snprintf(buf, buflen, "%b", state, LACP_STATE_BITS);
2030 lacp_dump_lacpdu(const struct lacpdu *du)
2032 char buf[LACP_PARTNERSTR_MAX+1];
2033 char buf2[LACP_STATESTR_MAX+1];
2035 printf("actor=%s\n",
2036 lacp_format_partner(&du->ldu_actor, buf, sizeof(buf)));
2037 printf("actor.state=%s\n",
2038 lacp_format_state(du->ldu_actor.lip_state, buf2, sizeof(buf2)));
2039 printf("partner=%s\n",
2040 lacp_format_partner(&du->ldu_partner, buf, sizeof(buf)));
2041 printf("partner.state=%s\n",
2042 lacp_format_state(du->ldu_partner.lip_state, buf2, sizeof(buf2)));
2044 printf("maxdelay=%d\n", ntohs(du->ldu_collector.lci_maxdelay));
2048 lacp_dprintf(const struct lacp_port *lp, const char *fmt, ...)
2053 printf("%s: ", lp->lp_ifp->if_xname);